Skip to main content
GET
Get position ledger

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.

start_time
string<date-time>

Optional. Inclusive lower bound on update_time (RFC3339). Clamped upstream to 2026-05-01T00:00:00Z.

end_time
string<date-time>

Optional. Inclusive upper bound on update_time (RFC3339).

page_size
integer<int32>

Optional. Maximum entries to return per page (max 1000). Values above 1000 return InvalidArgument.

Required range: x <= 1000
page_token
string

Optional. Pagination token from a previous response's nextPageToken field. Omit for the first request.

newest_first
boolean

Optional. If true, return entries in descending update_time order. Default is false (oldest first).

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.