Skip to main content
Collateral Account Balance Summary

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
integer

Unique request identifier

Example:

1594297865000

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"