Portfolio · Endpoint

Positions

Daily holdings per symbol: quantity, mark price, notional and weight.

GET/v1/alphas/{alpha}/positions

Parameters

Path parameters

Name	Type	Required	Default	Description
`alpha`	string	required	—	alpha_id (e.g. CausalHaarActivityDisplacement_0de63b8678a2_sp500pit_weekly_20260730t000858z_f358d1480d42). Use the value returned by GET /v1/alphas.

Query parameters

Name	Type	Required	Default	Description
`book`	string	optional	long_short	One of the books listed by /books — long_short and long_only, plus their raw_ twins for keys with raw-book access. A book the key may not see is rejected exactly like one that does not exist.
`from`	YYYY-MM-DD	optional	window start	First trading day, inclusive.
`to`	YYYY-MM-DD	optional	window end	Last trading day, inclusive.
`symbol`	string	optional	—	Restrict to one ticker.
`limit`	integer 1–5000	optional	100	Rows per page. Below 1 or above 5000 is a 400 bad_request naming the parameter and the constraint it broke.
`offset`	integer	optional	0	Rows to skip; pagination.has_more is false at the end.

Example request

curl

curl -H "Authorization: Bearer sxk_live_4f9c…" \
  "https://api.simicx.com/v1/alphas/CausalHaarActivityDisplacement_0de63b8678a2_sp500pit_weekly_20260730t000858z_f358d1480d42/positions?book=long_short&from=2026-06-26&to=2026-06-26&symbol=AAPL"

Try it

Execute GET /v1/alphas/{alpha}/positions against the live API using your key. Paste a key below to send without signing in, or sign in to auto-fill from your profile — either way, the call counts towards your rate limits. Whether the route answers depends on your key's endpoint allow-list — /v1/me lists what is in force; a new key starts with only the self-service routes until an administrator grants more.

API key

Remember on this device

Base URL

Sent server-side via a same-origin proxy; only the documented host(s) are allowed.

alphapath · required

Paste an API key above to list alphas your key may access.

bookquery

fromquery

toquery

symbolquery

limitquery

offsetquery

Request

GEThttps://api.simicx.com/v1/alphas/{alpha}/positions?book=long_short&limit=100&offset=0

Example response

JSON · synthetic values, real schema

{
  "data": [
    {
      "book": "long_short",
      "date": "2026-06-26",
      "symbol": "AAPL",
      "quantity": 612,
      "mark_price": 214.30,
      "signed_notional": 131151.60,
      "weight": 0.0102
    }
  ],
  "pagination": { "limit": 100, "offset": 0, "returned": 1, "total": 1, "has_more": false },
  "meta": { "run": "CausalHaarActivityDisplacement_0de63b8678a2_sp500pit_weekly_20260730t000858z_f358d1480d42", "alpha_id": "CausalHaarActivityDisplacement_0de63b8678a2_sp500pit_weekly_20260730t000858z_f358d1480d42", "source_alpha_id": "causal_haar_activity_displacement_reversal_b3874c9db78d", "book": "long_short" }
}

Response fields

Every field the response can carry, what it means, and how it is computed.

Field

Type

Meaning

How it is computed

bookdatesymbol

string

The holding's coordinates.

One row per held name per session; names not held are simply absent.

quantity

number (signed)

Shares held.

Positive long, negative short.

mark_price

number

The close used to value the position.

Official close of the name's primary exchange.

signed_notional

number

Position value in base currency.

quantity × mark_price.

weight

ratio (signed)

Fraction of book equity.

signed_notional ÷ ending_equity of the same day; compares directly with the target weights in the rebalance payload.

pagination.limitoffset

integer

The page window applied.

Echoes the request parameters (or their defaults — 100 rows, 500 on /equity-curve).

pagination.returned

integer

Rows in this page.

data.length — below limit on the last page.

pagination.total

integer

Rows matching the query across all pages.

Server-side count before paging.

pagination.has_more

boolean

Whether another page exists.

offset + returned < total — false on the last page; stop paging there.

meta.run

string

The alpha that served the response.

Echoes the resolved alpha_id. Retain for reproducible analysis.

meta.alpha_id

string

Source label associated with the alpha, when present.

Informational; address data endpoints with alpha_id / meta.run.

bookdatesymbolstring
The holding's coordinates.
How it is computed
One row per held name per session; names not held are simply absent.
quantitynumber (signed)
Shares held.
How it is computed
Positive long, negative short.
mark_pricenumber
The close used to value the position.
How it is computed
Official close of the name's primary exchange.
signed_notionalnumber
Position value in base currency.
How it is computed
quantity × mark_price.
weightratio (signed)
Fraction of book equity.
How it is computed
signed_notional ÷ ending_equity of the same day; compares directly with the target weights in the rebalance payload.
pagination.limitoffsetinteger
The page window applied.
How it is computed
Echoes the request parameters (or their defaults — 100 rows, 500 on /equity-curve).
pagination.returnedinteger
Rows in this page.
How it is computed
data.length — below limit on the last page.
pagination.totalinteger
Rows matching the query across all pages.
How it is computed
Server-side count before paging.
pagination.has_moreboolean
Whether another page exists.
How it is computed
offset + returned < total — false on the last page; stop paging there.
meta.runstring
The alpha that served the response.
How it is computed
Echoes the resolved alpha_id. Retain for reproducible analysis.
meta.alpha_idstring
Source label associated with the alpha, when present.
How it is computed
Informational; address data endpoints with alpha_id / meta.run.