Collateral Account Balance

The endpoint returns a current collateral balance.

The API does not cache the response.

Rate limit: 12000 requests/10 sec.

Errors

{
  "code": 30,
  "message": "Validation failed",
  "errors": {
    "ticker": ["ticker is invalid."]
  }
}

POST /api/v4/collateral-account/balance

Collateral Account Balance

cURL

curl --request POST \
  --url https://whitebit.com/api/v4/collateral-account/balance \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --data '
{
  "ticker": "BTC",
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}
'

200

{
  "BTC": 1,
  "USDT": 1000,
  "ETH": 5.5
}

Authorizations

X-TXC-APIKEY · string · header · required

API Key authentication for private endpoints.

Required headers:

• X-TXC-APIKEY: API key
• X-TXC-PAYLOAD: Base64 encoded JSON payload
• X-TXC-SIGNATURE: HMAC SHA512 signature

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

200

application/json

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