Ctrl+K

Get Account Balance

get/api/prime/trading/v1/accounts/{accountId}/balances

Get balance information about a single trading account.

Path Parameters

  • accountIdstringRequired
    The ID of the account

200 Response

data array[object] required
List of balance entries for a trading account
Example: {"currencyId":"6016e0a9-545a-45fb-8370-caab1680956a","currency":"BTC","balance":"100.0","heldBalance":"10.0","tradableBalance":"90.0"}
currency string required
Currency symbol
balance string <decimal>required
The total balance in the account
heldBalance string <decimal>required
The total balance reserved for some purpose, e.g. a pending withdrawal.
tradableBalance string <decimal>required
The total balance available for trading
withdrawableBalance string <decimal>required
The total balance available for withdrawal

default Response

error string required
errorName string required
reqId string required