get_aggregated_balances
Get total and per-account balances from Trading, Cash, Options, Crypto, MoneyFarm, and Spaceship accounts, with optional currency conversion and zero-balance filtering.
Instructions
Get current balances aggregated across the user's accounts.
Calls GET /api/v1/balances. Returns totalBalance (in display_currency) plus one entry per account with its native-currency balance, the converted displayBalance, and the exchangeRate used. Account types: Trading, Cash, Options, Crypto, MoneyFarm, Spaceship. Amounts are numbers in the stated currency. Rate limit: 60 requests per 60 seconds (default shared quota).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| account_types | No | Restrict to these account types; omit for all. | |
| display_currency | No | ISO 4217 currency code the display* amounts are converted into. | USD |
| include_zero_balances | No | Include accounts whose balance is zero. | |
| include_equity_details | No | Expand per-account equity details (buying power, frozen cash, current PnL, used margin; crypto spendable balances). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||