Ctrl+K

Get aggregated current account balances

get/das-rest/api/v2/accounts/balances/aggregate

Retrieves current account balances aggregated by currency and type, Supports optional filtering by account prefix, type, currency, and entity name.

Query Parameters

  • prefixesarray[string]Required
    Array of account prefix patterns to match (only PRIME_TRADING and PRIME_MARGIN are allowed)
    Enum: PRIME_TRADING PRIME_MARGIN
  • accountTypesarray[string]
    Array of account types to filter by
    Enum: BG_CLEARING BG_LIABILITY BG_TRADING BG_MARGIN
  • entityNamestringRequired
    Entity name (TrustOrg or PrimeOrg)
    Example: BitGo Trust
  • currenciesarray[string]
    Array of currencies to filter by

200 Response

dictionary<string, object>
Aggregated balances grouped by currency, then by account type. This endpoint sums all matching account balances and returns them grouped by currency and account type, rather than individual account details.
Example: {"ofctusd":{"BG_CLEARING":"15000000","BG_LIABILITY":"-5000000"},"ofctbtc":{"BG_CLEARING":"50000000","BG_LIABILITY":"-10000000"}}
dictionary<string, string>
Balance amounts by account type for this currency
string
Aggregated balance amount as string (sum of all matching accounts)
Example: 1000000