Skip to main content
GET
Get account balance 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.

currency
string

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

startTime
string<date-time>
endTime
string<date-time>
entryTypes
enum<string>[]
Available options:
LEDGER_ENTRY_TYPE_BALANCE_DEPOSIT,
LEDGER_ENTRY_TYPE_BALANCE_WITHDRAWAL,
LEDGER_ENTRY_TYPE_BALANCE_ORDER_EXECUTION,
LEDGER_ENTRY_TYPE_BALANCE_CORRECTION,
LEDGER_ENTRY_TYPE_BALANCE_NETTING,
LEDGER_ENTRY_TYPE_BALANCE_RESOLUTION,
LEDGER_ENTRY_TYPE_BALANCE_MANUAL_ADJUSTMENT,
LEDGER_ENTRY_TYPE_BALANCE_SECURITY_BALANCE_ADJUSTMENT,
LEDGER_ENTRY_TYPE_BALANCE_SECURITY_MARK_TO_MARKET,
LEDGER_ENTRY_TYPE_BALANCE_ACCOUNT_PROPERTY_ADJUSTMENT,
LEDGER_ENTRY_TYPE_BALANCE_COMMISSION,
LEDGER_ENTRY_TYPE_BALANCE_CONTRACT_EXPIRATION,
LEDGER_ENTRY_TYPE_BALANCE_PENDING_CREDIT_ADJUSTMENT,
LEDGER_ENTRY_TYPE_BALANCE_BEGINNING_OF_DAY,
LEDGER_ENTRY_TYPE_BALANCE_SECURITY_WITHDRAWAL,
LEDGER_ENTRY_TYPE_BALANCE_WITHDRAWAL_REJECTION,
LEDGER_ENTRY_TYPE_BALANCE_MANUAL_TRANSFER,
LEDGER_ENTRY_TYPE_BALANCE_AVERAGE_PRICE_TRANSFER,
LEDGER_ENTRY_TYPE_BALANCE_GIVE_UP,
LEDGER_ENTRY_TYPE_BALANCE_SYNCHRONIZATION,
LEDGER_ENTRY_TYPE_BALANCE_INTEREST,
LEDGER_ENTRY_TYPE_BALANCE_PENDING_WITHDRAWAL_CREATION,
LEDGER_ENTRY_TYPE_BALANCE_SETTLEMENT_FEE
symbol
string

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

description
string

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

newestFirst
boolean
pageSize
integer<int32>
Required range: x <= 1000
pageToken
string

Response

200 - application/json

A successful response.

entries
object[]

Balance ledger entries for the requested account / time window. Suppressed entry types are filtered out.

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.