Collateral Account Summary

Retrieve an overall summary of your collateral account, including equity, margin, and unrealized PnL.

POST /api/v4/collateral-account/summary

Collateral Account Summary

cURL

curl --request POST \
  --url https://whitebit.com/api/v4/collateral-account/summary \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --data '
{
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}
'

200

{
  "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

API Key authentication for private endpoints.

Required headers:

• X-TXC-APIKEY: API key
• X-TXC-PAYLOAD: Base64 encoded JSON payload
• X-TXC-SIGNATURE: HMAC SHA512 signature

Body

application/json

request · string

Example:

"{{request}}"

nonce · string

Example:

"{{nonce}}"

Response

200

application/json

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"