Skip to main content
POST
/
api
/
v4
/
collateral-account
/
summary
Collateral Account Summary
curl --request POST \
  --url https://whitebit.com/api/v4/collateral-account/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 '
{
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}
'
{
  "equity": "15000.50",
  "margin": "5000.00",
  "freeMargin": "10000.50",
  "unrealizedFunding": "25.75",
  "pnl": "150.25",
  "leverage": 3,
  "marginFraction": "0.3333"
}

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
string
Example:

"{{nonce}}"

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"