v1

latestOpenAPI 3.0.12026-07-26171200932.8 KB

Balances

Get aggregated balances

Rate limit: 60 requests per 60 seconds. This is the default shared quota — it is shared with every other endpoint that has no dedicated limit, so requests across those endpoints all draw from the same budget.

Returns aggregated balances across all account types for the authenticated user. Optionally filter by account type or specify the display currency for totals.

get/api/v1/balances

Query parameters

accountTypesstring

Optional comma-separated list of account types to include. Valid values: Trading, Cash, Options, Crypto, MoneyFarm, Spaceship.

displayCurrencystring

ISO 4217 currency code for totals and conversions. Defaults to USD.

includeZeroBalancesboolean

Whether to include accounts with a zero balance in the response. Defaults to false.

expandstring

Comma-separated list of optional sections to include in the response. Valid values: equityDetails.

Headers

x-request-idstring uuid required

Example:66f45dfc-558a-4c8f-95cd-a72aa997229d

A unique request identifier.

x-api-keystring password required

Example:lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

API key for authentication.

x-user-keystring password required

Example:eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

User-specific authentication key.

Response

Aggregated balances retrieved successfully.

gcidinteger

The user's global customer ID.

totalBalancenumber double

Sum of all account balances converted to the requested display currency.

displayCurrencystring nullable

ISO 4217 currency code used for totalBalance and displayBalance values.