How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

WhiteBIT Collateral Trading API

Endpoints for collateral/margin trading operations

WhiteBIT Collateral Trading API is one of 25 APIs that WhiteBIT publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 20 JSON Schema definitions.

Tagged areas include Collateral Trading. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 20 JSON Schemas.

This API exposes 24 operations across 24 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 4.0.0.

Requests are made against 4 base URLs: https://whitebit.com, https://whitebit.eu, https://whitebit.tr, https://whitebit.ge.

24 operations 24 paths 6 schemas 24 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0.0
Servers
https://whitebit.com
https://whitebit.eu
https://whitebit.tr
https://whitebit.ge
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

WhiteBIT Collateral Trading API declares 3 security schemes for authenticating requests. An API key is passed in the header as X-TXC-APIKEY (ApiKeyAuth). An API key is passed in the header as X-TXC-PAYLOAD (PayloadAuth). An API key is passed in the header as X-TXC-SIGNATURE (SignatureAuth). By default, every request must be authenticated.

  • ApiKeyAuth — The public WhiteBIT API key.
  • PayloadAuth — Base64-encoded JSON request body.
  • SignatureAuth — HMAC-SHA512 signature of the payload, hex-encoded. Computed as hex(HMAC-SHA512(payload, apisecret)).

Paths & Operations 24

Across 24 paths, the API surfaces 24 operations — 24 POST. Each is listed below with its method, path, parameters, and response codes.

Collateral Trading 24

Endpoints for collateral/margin trading operations

POST
/api/v4/collateral-account/balance
Collateral Account Balance
collateralAccountBalance body → 200422503
POST
/api/v4/collateral-account/balance-summary
Collateral Account Balance Summary
collateralAccountBalanceSummary body → 200422503
POST
/api/v4/order/collateral/limit
Collateral Limit Order
createCollateralLimitOrder body → 200422503
POST
/api/v4/order/collateral/bulk
Collateral bulk limit order
createCollateralBulkOrder body → 200400422503
POST
/api/v4/order/collateral/market
Collateral Market Order
createCollateralMarketOrder body → 200422503
POST
/api/v4/order/collateral/stop-limit
Collateral Stop-Limit Order
createCollateralStopLimitOrder body → 200400422503
POST
/api/v4/order/collateral/trigger-market
Collateral Trigger Market Order
createCollateralTriggerMarketOrder body → 200422503
POST
/api/v4/collateral-account/summary
Collateral Account Summary
collateralAccountSummary body → 200422503
POST
/api/v4/collateral-account/positions/open
Open Positions
getOpenPositions body → 200422503
POST
/api/v4/collateral-account/position/close
Close Position
closePosition body → 200400422500503
POST
/api/v4/collateral-account/positions/history
Positions History
getPositionsHistory body → 200400422500503
POST
/api/v4/collateral-account/positions/closed-pnl
Closed-position PNL
getClosedPositionsPnl body → 200400422500503
POST
/api/v4/collateral-account/funding-history
Funding History
getFundingHistory body → 200422503
POST
/api/v4/collateral-account/borrow-history
Borrow History
getBorrowHistory body → 200400422500503
POST
/api/v4/collateral-account/leverage
Change Collateral Account Leverage
changeCollateralAccountLeverage body → 200422503
POST
/api/v4/collateral-account/hedge-mode
Collateral Account Hedge Mode
getCollateralHedgeMode body → 200422500503
POST
/api/v4/collateral-account/hedge-mode/update
Update Collateral Account Hedge Mode
updateHedgeMode body → 200422500503
POST
/api/v4/collateral-account/adl-quantile
ADL Quantile
getCollateralAccountAdlQuantile body → 200422503
POST
/api/v4/conditional-orders
Query unexecuted(active) conditional orders
getConditionalOrders body → 200400422503
POST
/api/v4/oco-orders
Query unexecuted(active) OCO orders
getOcoOrders body → 200400422503
POST
/api/v4/order/collateral/oco
Create collateral OCO order
createCollateralOcoOrder body → 200400422503
POST
/api/v4/order/conditional-cancel
Cancel conditional order
cancelConditionalOrder body → 200400422503
POST
/api/v4/order/oco-canceldeprecated
Cancel OCO order
cancelOcoOrder body → 200400422503
POST
/api/v4/order/oto-canceldeprecated
Cancel OTO order
cancelOtoOrder body → 200400422503

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are OrderResponse (25 properties), OcoOrderLeg (22 properties), ConditionalOrderLeg (21 properties), ErrorResponse (3 properties). Each schema is shown below with its type and property counts.

OrderStatus
string
Order lifecycle status. FILLED — fully executed. CANCELED — canceled before execution. PARTIALLYFILLED — partially executed, remainder still active. CANCELEDTA…
OcoOrderLeg
object
OCO order leg as returned by /api/v4/oco-orders and /api/v4/order/oco-cancel. Field names use snakecase (postonly, activationprice) — unlike the camelCase legs…
22 properties
ConditionalOrderLeg
object
Conditional-order leg as returned by /api/v4/conditional-orders. Field names use camelCase (postOnly, activationPrice) — unlike the snakecase legs returned by…
21 properties
ErrorResponse
object
3 properties
ActiveOrderStatus
string
Order status. FILLED — fully executed. PARTIALLYFILLED — partially executed, remainder still active. CANCELED — canceled before full execution. REST uses the s…
OrderResponse
object
Shared order shape returned by the order-creation, cancel, active-orders list, and modify endpoints. Field presence varies by endpoint and order type — see the…
25 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

whitebit-collateral-trading-api-openapi.yml Raw ↑

Other APIs WhiteBIT publishes across the network.

WhiteBIT WebSocket API
WhiteBIT Account Endpoints API
WhiteBIT Address Checker API
WhiteBIT Authentication API
WhiteBIT Codes API
WhiteBIT Convert API
WhiteBIT Credit Line API
WhiteBIT Crypto Lending - Fixed API
WhiteBIT Crypto Lending - Flex API
WhiteBIT Deposit API
WhiteBIT Fees API
WhiteBIT JWT API
Where this information came from

This is an independent, third-party profile of WhiteBIT Collateral Trading API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.