Calculate total balance across all accounts

Use this method to obtain aggregated balance information across all client accounts converted to one or more target currencies. This endpoint calculates the total available balance, current balance, and equity for all active accounts, grouped by account number and converted to the requested currencies using current exchange rates. **Key features:** - Supports multiple target currencies in a single request - Groups accounts by account number - Returns null for values when exchange rate is unavailable - Only includes active (non-archived) accounts

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Header Parameters

accept-language?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

currencies*array<>

An array of alphabetic currency codes to which account balances should be converted.

The response will contain calculations for each specified currency.

Items1 <= items

filter?

Optional filters to narrow down which accounts to include in calculations.

Response Body

`application/json`

curl -X POST "https://example.com/api/v2/my/accounts/total-balance" \  -H "accept-language: ja" \  -H "Content-Type: application/json" \  -d '{    "currencies": [      "USD",      "EUR"    ]  }'

{  "updatedAt": "2025-01-15T12:30:45+00:00",  "calculations": [    {      "totalAvailableBalance": "15234.567800000000000000",      "totalCurrentBalance": "15500.123400000000000000",      "totalEquity": "15450.987600000000000000",      "alphabeticCurrencyCode": "USD",      "data": [        {          "accountNumber": "12345678",          "calculatedAvailableBalance": "10000.000000000000000000",          "calculatedCurrentBalance": "10200.500000000000000000",          "calculatedEquity": "10180.250000000000000000",          "accounts": [            {              "accountId": 101,              "calculatedAvailableBalance": "5000.000000000000000000",              "calculatedCurrentBalance": "5100.250000000000000000",              "calculatedCredit": "0.000000000000000000",              "calculatedEquity": "5090.125000000000000000",              "calculatedFreMargin": "4850.000000000000000000",              "calculatedHold": "150.000000000000000000",              "calculatedMargin": "250.250000000000000000",              "calculatedMarginLevel": 2034.55,              "calculatedPnl": "100.250000000000000000"            }          ]        }      ]    }  ]}

{  "error": {    "message": "Bad Request",    "details": [      {        "issue": "The selected value is invalid.",        "field": "parameter"      }    ]  }}

{  "error": {    "message": "Unauthorized"  }}

{  "error": {    "message": "Forbidden"  }}

{  "error": {    "message": "Too Many Requests"  }}

{  "error": {    "message": "Service Unavailable"  }}

Calculate total balance across all accounts

Authorization

Header Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

429application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`