Skip to main content
POST
/
api
/
v4
/
collateral-account
/
balance
Collateral Account Balance
curl --request POST \
  --url https://whitebit.com/api/v4/collateral-account/balance \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --header 'X-TXC-PAYLOAD: <api-key>' \
  --header 'X-TXC-SIGNATURE: <api-key>' \
  --data '
{
  "ticker": "BTC",
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}
'
{
  "BTC": 1,
  "USDT": 1000,
  "ETH": 5.5
}

Authorizations

​
X-TXC-APIKEY
string
header
required

The public WhiteBIT API key.

​
X-TXC-PAYLOAD
string
header
required

Base64-encoded JSON request body.

​
X-TXC-SIGNATURE
string
header
required

HMAC-SHA512 signature of the payload, hex-encoded. Computed as hex(HMAC-SHA512(payload, api_secret)).

Body

application/json
​
ticker
string

Asset to be filtered. For example: BTC

If not specified, returns balances for all assets.

Example:

"BTC"

​
request
string

Request signature

Example:

"{{request}}"

​
nonce
string

Unique request identifier

Example:

"{{nonce}}"

Response

Successful response - returns collateral balances by asset

Object with asset tickers as keys and balance amounts as values

​
{key}
number

Balance amount for the asset