Skip to main content

Changelog

New API Endpoints (2025-12-05)​

A total of 14 new endpoints have been added, covering Biz-order and Biz-user modules.

🧩 Biz-order​

No.API NameMethodPath
1Get Reverse Plan OrdersGET/future/trade/v1/entrust/reverse-plan-list
2Get Historical Reverse Plan OrdersGET/future/trade/v1/entrust/reverse-plan-list-history
3Get Historical TP/SL OrdersGET/future/trade/v1/entrust/profit-list-history
4Get Historical Orders with TradesGET/future/trade/v1/order/trade-history
5Get All Trade Details (No Pagination)GET/future/trade/v1/order/trade-list-all
6Get All OrdersGET/future/trade/v1/order-entrust/list
7Get Active PositionsGET/future/trade/v1/position/list/active
8Get Leverage InfoGET/future/trade/v1/position/leverage/list
9Get Historical PositionsGET/future/trade/v1/position/list-history
10Get Cross Margin MaintenanceGET/future/trade/v1/position/cross-margin/{symbol}

👤 Biz-user​

No.API NameMethodPath
11Get Auto-Deleveraging HistoryGET/future/user/v1/auto-deleverage/history
12Get Single Coin BalanceGET/future/user/v1/compat/balance/{coin}
13Get Take-Over RecordsGET/future/user/v1/taker-over/list
14Get Historical TP/SL OrdersGET/future/trade/v1/entrust/profit-list-history

2025-11-05​

Optimized documentation structure and added request example (curl)

No change to API behavior or response schema

4 Nov 2025​

Structure changes​

  • Renamed most sub-item/page titles for consistency.
  • Removed the Subscription parameters page.
  • Moved several sub-items into General WebSocket Information.

Added​

  • Kline — kline, klineZh
  • Trades — trades, tradesZh
  • Aggregate ticker — aggTicker, aggTickerZh
  • Index price — indexPrice, indexPriceZh
  • Mark price — markPrice, markPriceZh
  • Incremental depth — depthUpdate, depthUpdateZh
  • Limited depth — depthLimited, depthLimitedZh
  • Funding rate — fundRate, fundRateZh

Conventions​

  • All pages start with frontmatter (id, title, sidebar_label, sidebar_position).
  • Inline comments are vertically aligned within JSON code blocks for readability.
  • Pure Markdown + fenced code blocks only (no Tabs/CodeGroup) to maximize build stability.

3 Nov 2025​

Information architecture​

  • Removed submodules: Rate limit rules, API library, Response format.
  • Added submodule: Changelog.
  • Renamed submodule: Error codes → General error codes.

Added / Restructured​

  • General WebSocket Information — generalWebsocketInfo, generalWebsocketInfoZh
  • Request message format — requestMessageFormat, requestMessageFormatZh
  • Response message format — responseMessageFormat, responseMessageFormatZh
  • Push message format — pushMessageFormat, pushMessageFormatZh
  • Heartbeat — heartbeat, heartbeatZh
  • Error codes — errorCodes, errorCodesZh
  • Order book management — orderBookManagement, orderBookManagementZh

Build hardening​

  • Removed dependency on <Tabs/>/<CodeGroup/>; switched to fenced code blocks with title="..." for examples.
  • Ensured all IDs use camelCase.
  • Normalized sidebar ordering (General info first, then formats, then channels).