By sending a POST request to balance endpoint you can obtain all available balances for your account. Specify currency parameter to get balance for one currency.

request endpoint: /api/balance


Request parameters

NameTypeDescriptionRequired
nonceLongrepeated number send in the request headerY
currencyStringcurrency shortcut, specify if you want to get balance only for this currency

N

Request example:

{"nonce":10000,  "currency":"BTC"}

Response - JSON Array with available balances, values are represented by JSON:

NameTypeDescription
userIdLonguser ID
symbolStringsymbol
volumeDoubleavailable volume for this currency
lockedVolumeDouble

locekd volume for this currency

Response example for BTC:

{"userId":8000,"symbol":"BTC","volume":12.2,"lockedVolume":1}


Request example for all client's balances:

{"nonce":10000,  "currency":"BTC"}


Response example for all client's balances:

[{"userId":8000,"symbol":"BTC","volume":12.2,"lockedVolume":1},{"userId":8000,"symbol":"USD","volume":9999.74,"lockedVolume":0}]