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 Name | Method | Path |
|---|---|---|---|
| 1 | Get Reverse Plan Orders | GET | /future/trade/v1/entrust/reverse-plan-list |
| 2 | Get Historical Reverse Plan Orders | GET | /future/trade/v1/entrust/reverse-plan-list-history |
| 3 | Get Historical TP/SL Orders | GET | /future/trade/v1/entrust/profit-list-history |
| 4 | Get Historical Orders with Trades | GET | /future/trade/v1/order/trade-history |
| 5 | Get All Trade Details (No Pagination) | GET | /future/trade/v1/order/trade-list-all |
| 6 | Get All Orders | GET | /future/trade/v1/order-entrust/list |
| 7 | Get Active Positions | GET | /future/trade/v1/position/list/active |
| 8 | Get Leverage Info | GET | /future/trade/v1/position/leverage/list |
| 9 | Get Historical Positions | GET | /future/trade/v1/position/list-history |
| 10 | Get Cross Margin Maintenance | GET | /future/trade/v1/position/cross-margin/{symbol} |
👤 Biz-user
| No. | API Name | Method | Path |
|---|---|---|---|
| 11 | Get Auto-Deleveraging History | GET | /future/user/v1/auto-deleverage/history |
| 12 | Get Single Coin Balance | GET | /future/user/v1/compat/balance/{coin} |
| 13 | Get Take-Over Records | GET | /future/user/v1/taker-over/list |
| 14 | Get Historical TP/SL Orders | GET | /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 withtitle="..."for examples. - Ensured all IDs use camelCase.
- Normalized sidebar ordering (General info first, then formats, then channels).