Skip to main content
GET
List account positions

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

name
string

Required. Fully qualified resource name of the account. Example: "firms/ISV-Alice/accounts/alice-trading-account"

symbol
string

Symbol to filter (optional).

asOfTime
string<date-time>

Optional. Query positions as of this timestamp. If set, returns historical positions instead of current.

asOfDate.year
integer<int32>
asOfDate.month
integer<int32>
Required range: 1 <= x <= 12
asOfDate.day
integer<int32>
Required range: 1 <= x <= 31
pageSize
integer<int32>

The maximum number of positions to return in one page. If 0/unset the server picks a default and may cap the value. Mirrors GetPositionLedgerRequest.

pageToken
string

Opaque continuation token from a prior ListAccountPositionsResponse.next_page_token. Empty for the first page.

activeOnly
boolean

When true, expired positions are omitted. Default false preserves the current behavior (expired positions are included).

nonZeroOnly
boolean

When true, positions with net_position == 0 are omitted (settled/closed markets that linger as zero-quantity rows). Default false preserves the current behavior (all positions are returned). Unlike active_only this is honored on historical (as_of) queries too, since net_position is always populated.

Response

200 - application/json

A successful response.

Response with account positions.

positions
object[]
availablePosition
string<int64>[]
nextPageToken
string

Continuation token for the next page; empty when this is the last page.

eof
boolean

True when there are no more pages after this one. Mirrors GetPositionLedgerResponse.