{"slug":"okx-api","name":"OKX API","host":"www.okx.com","site":"https://okx.com","category":"crypto","docsUrl":null,"sources":[{"kind":"changelog","url":"https://www.okx.com/docs-v5/log_en/"}],"url":"https://www.okapi.bot/providers/okx-api/","json":"https://www.okapi.bot/api/v1/providers/okx-api.json","breakingChanges":[{"slug":"iselptakeraccess-on-post-api-v5-trade-stops-working","api":"okx-api","title":"isElpTakerAccess on POST /api/v5/trade/* stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-07-28","effectiveAt":"2026-10-31","scope":null,"calls":["POST /api/v5/trade/*","body parameter isElpTakerAccess"],"method":"POST","path":"/api/v5/trade/*","source":{"url":"https://www.okx.com/docs-v5/log_en/","kind":"archive"},"quote":"ELP name deprecation deadline: October 31, 2026","migration":"Send rpiTakerAccess instead of isElpTakerAccess on place and amend order requests.","migrationChange":null,"needsDecision":null,"text":{"summary":"On October 31, 2026, the body parameter isElpTakerAccess will stop working on POST /api/v5/trade/* endpoints. Requests using this parameter will fail after this date. This aligns with the ELP name deprecation deadline announced on July 28, 2026.","migration":"Send rpiTakerAccess instead of isElpTakerAccess on place and amend order requests.","by":"writer"},"publishedAt":"2026-10-23T10:31:17.211Z","updatedAt":"2026-10-23T10:52:27.444Z","status":"upcoming","tone":"imminent","url":"https://www.okapi.bot/providers/okx-api/breaking-changes/iselptakeraccess-on-post-api-v5-trade-stops-working/"},{"slug":"get-api-v5-finance-stable-rewards-subscribe-redeem-history-stops-working","api":"okx-api","title":"GET /api/v5/finance/stable-rewards/subscribe-redeem-history stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-07-14","effectiveAt":"2026-07-14","scope":null,"calls":["GET /api/v5/finance/stable-rewards/subscribe-redeem-history"],"method":"GET","path":"/api/v5/finance/stable-rewards/subscribe-redeem-history","source":{"url":"https://www.okx.com/docs-v5/log_en/","kind":"archive"},"quote":"The POST /api/v5/finance/stable-rewards/quote, POST /api/v5/finance/stable-rewards/trade, and GET /api/v5/finance/stable-rewards/subscribe-redeem-history endpoints have been decommissioned and removed from the API.","migration":"Trade USDG and other stablecoins with the standard order book trading APIs.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:31:17.211Z","updatedAt":"2026-10-23T10:31:17.211Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/okx-api/breaking-changes/get-api-v5-finance-stable-rewards-subscribe-redeem-history-stops-working/"},{"slug":"post-api-v5-finance-stable-rewards-quote-stops-working","api":"okx-api","title":"POST /api/v5/finance/stable-rewards/quote stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-07-14","effectiveAt":"2026-07-14","scope":null,"calls":["POST /api/v5/finance/stable-rewards/quote"],"method":"POST","path":"/api/v5/finance/stable-rewards/quote","source":{"url":"https://www.okx.com/docs-v5/log_en/","kind":"archive"},"quote":"The POST /api/v5/finance/stable-rewards/quote, POST /api/v5/finance/stable-rewards/trade, and GET /api/v5/finance/stable-rewards/subscribe-redeem-history endpoints have been decommissioned and removed from the API.","migration":"Trade USDG and other stablecoins with the standard order book trading APIs.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:31:17.211Z","updatedAt":"2026-10-23T10:31:17.211Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/okx-api/breaking-changes/post-api-v5-finance-stable-rewards-quote-stops-working/"},{"slug":"post-api-v5-finance-stable-rewards-trade-stops-working","api":"okx-api","title":"POST /api/v5/finance/stable-rewards/trade stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-07-14","effectiveAt":"2026-07-14","scope":null,"calls":["POST /api/v5/finance/stable-rewards/trade"],"method":"POST","path":"/api/v5/finance/stable-rewards/trade","source":{"url":"https://www.okx.com/docs-v5/log_en/","kind":"archive"},"quote":"The POST /api/v5/finance/stable-rewards/quote, POST /api/v5/finance/stable-rewards/trade, and GET /api/v5/finance/stable-rewards/subscribe-redeem-history endpoints have been decommissioned and removed from the API.","migration":"Trade USDG and other stablecoins with the standard order book trading APIs.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:31:17.211Z","updatedAt":"2026-10-23T10:31:17.211Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/okx-api/breaking-changes/post-api-v5-finance-stable-rewards-trade-stops-working/"},{"slug":"api-v5-account-fixed-loan-stops-working","api":"okx-api","title":"/api/v5/account/fixed-loan/* stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":"2024-11-21","effectiveAt":"2025-03-03","scope":null,"calls":["/api/v5/account/fixed-loan/*"],"method":null,"path":"/api/v5/account/fixed-loan/*","source":{"url":"https://www.okx.com/docs-v5/log_en/","kind":"archive"},"quote":"Fixed Loan and Simple Earn Fixed going offline","migration":"Borrow with the flexible loan endpoints (/api/v5/finance/flexible-loan/*) or margin borrowing instead.","migrationChange":null,"needsDecision":"Fixed-term loans and Simple Earn Fixed have no fixed-term replacement: moving to flexible loans or Simple Earn Flexible is a product choice.","text":null,"publishedAt":"2026-10-23T10:31:17.211Z","updatedAt":"2026-10-23T10:31:17.211Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/okx-api/breaking-changes/api-v5-account-fixed-loan-stops-working/"},{"slug":"api-v5-finance-fixed-loan-stops-working","api":"okx-api","title":"/api/v5/finance/fixed-loan/* stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":"2024-11-21","effectiveAt":"2025-03-03","scope":null,"calls":["/api/v5/finance/fixed-loan/*"],"method":null,"path":"/api/v5/finance/fixed-loan/*","source":{"url":"https://www.okx.com/docs-v5/log_en/","kind":"archive"},"quote":"Fixed Loan and Simple Earn Fixed going offline","migration":"Lend through Simple Earn Flexible (/api/v5/finance/savings/*) instead.","migrationChange":null,"needsDecision":"Fixed-term loans and Simple Earn Fixed have no fixed-term replacement: moving to flexible loans or Simple Earn Flexible is a product choice.","text":null,"publishedAt":"2026-10-23T10:31:17.211Z","updatedAt":"2026-10-23T10:31:17.211Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/okx-api/breaking-changes/api-v5-finance-fixed-loan-stops-working/"},{"slug":"post-api-v5-account-set-riskoffset-type-stops-working","api":"okx-api","title":"POST /api/v5/account/set-riskOffset-type stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":"2025-01-17","effectiveAt":"2025-01-17","scope":null,"calls":["POST /api/v5/account/set-riskOffset-type"],"method":"POST","path":"/api/v5/account/set-riskOffset-type","source":{"url":"https://www.okx.com/docs-v5/log_en/","kind":"archive"},"quote":"API offline - Set risk offset type (POST /api/v5/account/set-riskOffset-type)","migration":"Stop calling it; OKX documents no replacement endpoint.","migrationChange":null,"needsDecision":"There is no replacement endpoint.","text":null,"publishedAt":"2026-10-23T10:31:17.211Z","updatedAt":"2026-10-23T10:31:17.211Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/okx-api/breaking-changes/post-api-v5-account-set-riskoffset-type-stops-working/"},{"slug":"get-api-v5-market-open-oracle-stops-working","api":"okx-api","title":"GET /api/v5/market/open-oracle stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":"2025-01-07","effectiveAt":"2025-01-07","scope":null,"calls":["GET /api/v5/market/open-oracle"],"method":"GET","path":"/api/v5/market/open-oracle","source":{"url":"https://www.okx.com/docs-v5/log_en/","kind":"archive"},"quote":"Get oracle API is offline, please use Get token market data instead.","migration":"Read token prices from OKLink's Get token market data API.","migrationChange":null,"needsDecision":"The replacement is OKLink's separate API, with its own key and terms.","text":null,"publishedAt":"2026-10-23T10:31:17.211Z","updatedAt":"2026-10-23T10:31:17.211Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/okx-api/breaking-changes/get-api-v5-market-open-oracle-stops-working/"},{"slug":"post-api-v5-asset-convert-dust-assets-stops-working","api":"okx-api","title":"POST /api/v5/asset/convert-dust-assets stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":"2024-10-17","effectiveAt":"2024-10-17","scope":null,"calls":["POST /api/v5/asset/convert-dust-assets"],"method":"POST","path":"/api/v5/asset/convert-dust-assets","source":{"url":"https://www.okx.com/docs-v5/log_en/","kind":"archive"},"quote":"The API has offline, and it is recommended to use \"Easy convert\".","migration":"Use Easy convert: GET /api/v5/trade/easy-convert-currency-list then POST /api/v5/trade/easy-convert.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:31:17.211Z","updatedAt":"2026-10-23T10:31:17.211Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/okx-api/breaking-changes/post-api-v5-asset-convert-dust-assets-stops-working/"},{"slug":"get-api-v5-market-books-lite-stops-working","api":"okx-api","title":"GET /api/v5/market/books-lite stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":"2024-03-27","effectiveAt":"2024-03-27","scope":null,"calls":["GET /api/v5/market/books-lite"],"method":"GET","path":"/api/v5/market/books-lite","source":{"url":"https://www.okx.com/docs-v5/log_en/","kind":"archive"},"quote":"Decommissioned the order lite book endpoint GET /api/v5/market/books-lite.","migration":"Use GET /api/v5/market/books.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:31:17.211Z","updatedAt":"2026-10-23T10:31:17.211Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/okx-api/breaking-changes/get-api-v5-market-books-lite-stops-working/"},{"slug":"get-api-v5-asset-lending-history-stops-working","api":"okx-api","title":"GET /api/v5/asset/lending-history stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":"2023-03-15","effectiveAt":"2024-01-22","scope":null,"calls":["GET /api/v5/asset/lending-history"],"method":"GET","path":"/api/v5/asset/lending-history","source":{"url":"https://www.okx.com/docs-v5/log_en/","kind":"archive"},"quote":"OKX has migrated savings endpoints to the new. The new endpoints have been released in production on 2023/03/15. The corresponding old endpoints has been offline on 2024/01/22","migration":"Call GET /api/v5/finance/savings/lending-history.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:31:17.211Z","updatedAt":"2026-10-23T10:31:17.211Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/okx-api/breaking-changes/get-api-v5-asset-lending-history-stops-working/"},{"slug":"get-api-v5-asset-lending-rate-history-stops-working","api":"okx-api","title":"GET /api/v5/asset/lending-rate-history stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":"2023-03-15","effectiveAt":"2024-01-22","scope":null,"calls":["GET /api/v5/asset/lending-rate-history"],"method":"GET","path":"/api/v5/asset/lending-rate-history","source":{"url":"https://www.okx.com/docs-v5/log_en/","kind":"archive"},"quote":"OKX has migrated savings endpoints to the new. The new endpoints have been released in production on 2023/03/15. The corresponding old endpoints has been offline on 2024/01/22","migration":"Call GET /api/v5/finance/savings/lending-rate-history.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:31:17.211Z","updatedAt":"2026-10-23T10:31:17.211Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/okx-api/breaking-changes/get-api-v5-asset-lending-rate-history-stops-working/"},{"slug":"get-api-v5-asset-lending-rate-summary-stops-working","api":"okx-api","title":"GET /api/v5/asset/lending-rate-summary stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":"2023-03-15","effectiveAt":"2024-01-22","scope":null,"calls":["GET /api/v5/asset/lending-rate-summary"],"method":"GET","path":"/api/v5/asset/lending-rate-summary","source":{"url":"https://www.okx.com/docs-v5/log_en/","kind":"archive"},"quote":"OKX has migrated savings endpoints to the new. The new endpoints have been released in production on 2023/03/15. The corresponding old endpoints has been offline on 2024/01/22","migration":"Call GET /api/v5/finance/savings/lending-rate-summary.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:31:17.211Z","updatedAt":"2026-10-23T10:31:17.211Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/okx-api/breaking-changes/get-api-v5-asset-lending-rate-summary-stops-working/"},{"slug":"get-api-v5-asset-saving-balance-stops-working","api":"okx-api","title":"GET /api/v5/asset/saving-balance stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":"2023-03-15","effectiveAt":"2024-01-22","scope":null,"calls":["GET /api/v5/asset/saving-balance"],"method":"GET","path":"/api/v5/asset/saving-balance","source":{"url":"https://www.okx.com/docs-v5/log_en/","kind":"archive"},"quote":"OKX has migrated savings endpoints to the new. The new endpoints have been released in production on 2023/03/15. The corresponding old endpoints has been offline on 2024/01/22","migration":"Call GET /api/v5/finance/savings/balance.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:31:17.211Z","updatedAt":"2026-10-23T10:31:17.211Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/okx-api/breaking-changes/get-api-v5-asset-saving-balance-stops-working/"},{"slug":"post-api-v5-asset-purchase-redempt-stops-working","api":"okx-api","title":"POST /api/v5/asset/purchase_redempt stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":"2023-03-15","effectiveAt":"2024-01-22","scope":null,"calls":["POST /api/v5/asset/purchase_redempt"],"method":"POST","path":"/api/v5/asset/purchase_redempt","source":{"url":"https://www.okx.com/docs-v5/log_en/","kind":"archive"},"quote":"OKX has migrated savings endpoints to the new. The new endpoints have been released in production on 2023/03/15. The corresponding old endpoints has been offline on 2024/01/22","migration":"Call POST /api/v5/finance/savings/purchase-redempt.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:31:17.211Z","updatedAt":"2026-10-23T10:31:17.211Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/okx-api/breaking-changes/post-api-v5-asset-purchase-redempt-stops-working/"},{"slug":"post-api-v5-asset-set-lending-rate-stops-working","api":"okx-api","title":"POST /api/v5/asset/set-lending-rate stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":"2023-03-15","effectiveAt":"2024-01-22","scope":null,"calls":["POST /api/v5/asset/set-lending-rate"],"method":"POST","path":"/api/v5/asset/set-lending-rate","source":{"url":"https://www.okx.com/docs-v5/log_en/","kind":"archive"},"quote":"OKX has migrated savings endpoints to the new. The new endpoints have been released in production on 2023/03/15. The corresponding old endpoints has been offline on 2024/01/22","migration":"Call POST /api/v5/finance/savings/set-lending-rate.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:31:17.211Z","updatedAt":"2026-10-23T10:31:17.211Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/okx-api/breaking-changes/post-api-v5-asset-set-lending-rate-stops-working/"},{"slug":"get-api-v5-public-liquidation-orders-stops-working","api":"okx-api","title":"GET /api/v5/public/liquidation-orders stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":"2023-04-03","effectiveAt":"2023-04-30","scope":null,"calls":["GET /api/v5/public/liquidation-orders"],"method":"GET","path":"/api/v5/public/liquidation-orders","source":{"url":"https://www.okx.com/docs-v5/log_en/","kind":"archive"},"quote":"OKX will no longer support users to retrieve platform historical liquidation orders through the REST endpoint by the end of April 2023.","migration":"Subscribe to the liquidation-orders channel on the public WebSocket (wss://ws.okx.com:8443/ws/v5/public).","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:31:17.211Z","updatedAt":"2026-10-23T10:31:17.211Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/okx-api/breaking-changes/get-api-v5-public-liquidation-orders-stops-working/"}]}