Get aggregated balances
Returns aggregated balances across all account types for the authenticated user. Optionally filter by account type or specify the display currency for totals.
Headers
A unique request identifier.
"2a284616-e619-4daf-b778-9a6305e36e9a"
API key for authentication.
"lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663"
User-specific authentication key.
"eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_"
Query Parameters
Optional comma-separated list of account types to include. Valid values: Trading, Cash, Options, Crypto, MoneyFarm, Spaceship.
ISO 4217 currency code for totals and conversions. Defaults to USD.
Whether to include accounts with a zero balance in the response. Defaults to false.
Comma-separated list of optional sections to include in the response. Valid values: equityDetails.
Response
Aggregated balances retrieved successfully.
Aggregated balances for the authenticated user.
The user's global customer ID.
Sum of all account balances converted to the requested display currency.
ISO 4217 currency code used for totalBalance and displayBalance values.
Individual account balances.