v1

latestOpenAPI 3.0.12026-07-2683220192.3 KB
Funding

Get account balance ledger

Returns historical balance changes for an account.

get/v1/funding/balance-ledger

Query parameters

accountstring required

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

currencystring

Optional. ISO currency code (e.g., USD). Omit to return entries in all currencies for the account.

start_timestring date-time

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

end_timestring date-time

Optional. Inclusive upper bound on update_time (RFC3339).

entry_typesLedgerEntryType[]

Optional. Filter by one or more entry types from the allowlist. Requesting a suppressed type returns Aborted (HTTP 409). Multiple values can be provided. Example: entry_types=DEPOSIT&entry_types=ORDER_EXECUTION.

symbolstring

Optional. Filter by instrument symbol (e.g., for ORDER_EXECUTION entries).

descriptionstring

Optional. Substring filter on the entry description. Maximum 200 Unicode characters (not bytes); longer values return InvalidArgument.

newest_firstboolean

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

page_sizeinteger

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

page_tokenstring

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

Response

A successful response.

nextPageTokenstring

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

eofboolean

true when this response contains the final page of results.