Collateral Account Balance Summary

Retrieve a summarized view of your collateral account balance with aggregated asset values.

POST /api/v4/collateral-account/balance-summary

Collateral Account Balance Summary

cURL

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

200

[
  {
    "asset": "BTC",
    "balance": "0.5",
    "borrow": "0",
    "availableWithoutBorrow": "0.5",
    "availableWithBorrow": "123.456"
  },
  {
    "asset": "USDT",
    "balance": "1000",
    "borrow": "0",
    "availableWithoutBorrow": "1000",
    "availableWithBorrow": "5000"
  }
]

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

Filter by requested asset. For example: BTC

If not specified, returns summary 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 detailed balance information per asset

asset · string

Asset ticker symbol

Example:

"BTC"

balance · string

Current balance amount

Example:

"0.5"

borrow · string

Amount currently borrowed

Example:

"0"

availableWithoutBorrow · string

Available balance without using borrow

Example:

"0.5"

availableWithBorrow · string

Available balance including borrowing capacity

Example:

"123.456"