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

Sum of the collateral balances: own funds minus unrealized funding on margin borrowings. Excludes unrealized profit and loss (pnl) and the USDTB bonus balance — see futuresEquity for the value that includes USDTB.

Example:

"15000.50"

margin
string

Total margin in use, returned as a positive value. Covers open positions and open limit orders — placing a limit order increases margin before the order fills.

Example:

"5000.00"

freeMargin
string

Margin available for new orders and positions: freeMargin = equity + pnl − margin. Excludes the USDTB bonus balance — see futuresFreeMargin for the value that includes USDTB.

Example:

"10150.75"

unrealizedFunding
string

Unrealized funding payments

Example:

"25.75"

pnl
string

Unrealized profit and loss across open positions. Not included in equity; included in freeMargin and marginFraction.

Example:

"150.25"

leverage
integer

Current leverage level

Example:

3

marginFraction
string

Ratio of account value (equity + pnl) to the total notional value of open positions. A lower value means higher risk; liquidation starts when marginFraction is strictly below maintenanceMarginFraction. With no open positions, the ratio tends to infinity and the field returns "1000000000000000000000".

Example:

"1.01005"

maintenanceMarginFraction
string

Account-level maintenance margin requirement, as a fraction. The value ranges from 0.005 (0.5%) to 0.03 (3%) and covers both margin and futures positions; the platform weights futures positions by risk bracket. The value is not a flat rate per position, so small deviations from a round percentage are expected, and multiplying it by the summed position notional does not reproduce the account's maintenance margin. Use the returned value as the liquidation threshold for marginFraction.

Example:

"0.03"

futuresEquity
string

equity plus the USDTB bonus balance. Equals equity when the account holds no USDTB.

Example:

"15100.50"

futuresFreeMargin
string

freeMargin plus the USDTB bonus balance. Equals freeMargin when the account holds no USDTB.

Example:

"10250.75"