Skip to main content
POST
/
api
/
v4
/
collateral-account
/
balance-summary
Collateral Account Balance Summary
curl --request POST \
  --url https://whitebit.com/api/v4/collateral-account/balance-summary \
  --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}}"
}
'
[
  {
    "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

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

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

Successful response - returns detailed balance information per asset

​
asset
string

Asset ticker symbol

Example:

"BTC"

​
balance
string

Total collateral balance for the asset, in the asset's native units

Example:

"0.5"

​
borrow
string

Amount currently borrowed against the asset, in the asset's native units

Example:

"0"

​
availableWithoutBorrow
string

Balance available for use without additional borrowing, in the asset's native units

Example:

"0.5"

​
availableWithBorrow
string

Maximum balance available when borrowing capacity is included, in the asset's native units

Example:

"123.456"