Skip to main content
GET
Get current positions

Authorizations

Authorization
string
header
required

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

Query Parameters

account_id
string<uuid>

Trading account ID

environment
enum<string>
required

Required. Which environment the read covers. Resolved to the organization's accounts in that environment, including disabled and deleted ones, since the ledger stores no environment of its own. Rejected with 400 when it disagrees with the account named alongside it.

Available options:
paper,
live
symbol
string

Filter positions by symbol. Symbols are normalized to uppercase

limit
integer<int32>

Maximum results; defaults to 100 and is capped at 1000

Required range: x >= 0
sort_by
enum<string>

Sort field; defaults to received_at

Available options:
received_at,
symbol,
quantity,
average_cost
sort_direction
enum<string>

Sort direction. Defaults to Desc. Lowercase asc/desc are also accepted.

Available options:
Asc,
Desc
next_cursor
string

Opaque keyset pagination cursor from a previous response

Response

Positions retrieved

data
object[]
required
next_cursor
string | null