Skip to main content
GET
Get position ledger

Authorizations

Authorization
string
header
required

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

Query Parameters

account
string
required

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

symbol
string

Optional. Filter by instrument symbol.

startTime
string<date-time>
endTime
string<date-time>
pageSize
integer<int32>
Required range: x <= 1000
pageToken
string
newestFirst
boolean

Response

200 - application/json

A successful response.

entries
object[]

Position ledger entries for the requested account / time window.

nextPageToken
string

Pagination token to fetch the next page. Empty when there are no more results.

eof
boolean

true when this response contains the final page of results.