Skip to main content
Collateral Account 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
request
string
Example:

"{{request}}"

nonce
integer
Example:

1594297865000

Response

Successful response - returns collateral account summary

equity
string

Total equity value of the collateral account

Example:

"15000.50"

margin
string

Total margin used

Example:

"5000.00"

freeMargin
string

Available margin for trading

Example:

"10000.50"

unrealizedFunding
string

Unrealized funding payments

Example:

"25.75"

pnl
string

Unrealized profit and loss

Example:

"150.25"

leverage
integer

Current leverage level

Example:

3

marginFraction
string

Margin fraction ratio (margin / equity)

Example:

"0.3333"