Collateral Trading

Collateral Account Summary

The endpoint returns a collateral account summary including total equity, used margin, free margin, unrealized profit and loss, and the current leverage level. The marginFraction field indicates the ratio of used margin to total equity.

<Warning> Rate limit: 12000 requests/10 sec. </Warning>

post/api/v4/collateral-account/summary

Request

Base URL
https://whitebit.com
Auth
API key in header X-TXC-APIKEY and API key in header X-TXC-PAYLOAD and API key in header X-TXC-SIGNATURE
TypeScript
https://skmtc.dev/whitebit/apis/whitebit-private-http-api-v4/docs/api/v4/collateral-account/summary/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

requeststring

nonceinteger

Example request

{
  "request": "{{request}}",
  "nonce": 1594297865000
}

Response

Successful response - returns collateral account summary

equitystring

Total equity value of the collateral account

marginstring

Total margin used

freeMarginstring

Available margin for trading

unrealizedFundingstring

Unrealized funding payments

pnlstring

Unrealized profit and loss

leverageinteger

Current leverage level

marginFractionstring

Margin fraction ratio (margin / equity)

Example response

{
  "equity": "15000.50",
  "margin": "5000.00",
  "freeMargin": "10000.50",
  "unrealizedFunding": "25.75",
  "pnl": "150.25",
  "leverage": 3,
  "marginFraction": "0.3333"
}

Changes

No recorded changes to this operation across all 1 revision of this API.