All
FAQ
Announcements
Product documents
OKX API FAQ
Note: if you have any other questions or other API-related inquiries, you can reach out to us by scanning the code below via the app.What's "50119 API key doesn't exist" error? This error usually occurs when your account’s domain doesn’t match your region. For EEA users, please change your API request domain name to eea.okx.com instead of www.okx.com. For US users, please change your API request domain name to us.okx.com instead of www.okx.com.Published on Sep 20, 2024Updated on Mar 3, 2026FAQ133Fast API Launch
OKX Broker has launched the Fast API function to provide additional security to the API Key binding process. As a user connecting to trade with OKX on our brokers' platform, Fast API allows users to log in through OAuth mode and authorize the access token to generate API Keys automatically on behalf of the user.Benefits Swift and safe: Users no longer need to copy their OKX API Key and API Secret manually, just log in to the OKX account and connect to the preferred broker.Published on Jan 5, 2023Updated on Apr 1, 2025Product documentationOpen API for ETH Staking
Dear valued customer, OKX released the ETH Staking API on November 08, 2023 (UTC). You can keep track of BETH positions and daily yields, as well as stake and unstake through the API. You can also use it to develop and monitor arbitrage strategies to maximize your profits. API documentation link:https://www.okx.com/docs-v5/en/#financial-product-eth-staking We'll continue working to provide you with better products and services. Sincerely, The OKX team November 08, 2023 (UTC)Published on Nov 9, 2023Updated on Nov 17, 2025AnnouncementsSuspension the FIX API service
Dear Valued Customers, Given to the fact that we have listed quite a number of token trading pairs as well as different type of contracts, in order for us to provide a more stable API, we would need to carry out a major upgrade to our current FIX API. The FIX API suspension the service at 00:00 on December 9, 2017 (Beijing Time). The REST API and WebSocket API are still available. Please add our API customer support WeChat (ID: ApiSupport) for API-related questions.Published on Dec 8, 2017Updated on Nov 17, 2025AnnouncementsIssues with some REST API endpoints
Dear Clients, We are aware of issues that occurred earlier today with some REST API endpoints, including GET/api/v5/account/balance and GET/api/v5/account/positions. The issues have been resolved and OKX will publish an incident report in due course. We sincerely apologize for any inconvenience this incident may have caused. Regards, Team OKXPublished on Mar 27, 2024Updated on Nov 17, 2025AnnouncementsChanges to V5 API WebSocket subscription parameter and URL
Adjustment to V5 API WebSocket subscription parameter Currently the websocket subscription parameter uly is mapped to the parameter instFamily. After the adjustment, the subscription parameter uly will return error and no longer be processed. In API requests, please stop using the subscription parameter "uly" and use the subscription parameter "instFamily" instead. 2. V5 API WebSocket adjusts the service address of some channels.Published on Apr 24, 2023Updated on Nov 17, 2025AnnouncementsChanges to V5 API users as OKX supports USDC index
Get order history (last 7 days) /api/v5/trade/orders-history uly - Get order history (last 3 months) /api/v5/trade/orders-history-archive uly - Get transaction details (last 3 days) /api/v5/trade/fills uly - Get transaction details (last 3 months) /api/v5/trade/fills-history uly - Get mark price /api/v5/public/mark-price uly - Get delivery/exercise history /api/v5/public/delivery-exercise-history uly - Get open interest /api/v5/public/open-interest uly - Get insurance fund /api/v5/public/insurance-fundPublished on Mar 30, 2023Updated on Nov 17, 2025AnnouncementsV3 Open API Supports USDT-margined Futures Trading
Example: GET /api/futures/v3/accounts/BTC = GET /api/futures/v3/accounts/BTC-USD Note: “POST /api/futures/v3/accounts/margin_mode in setting account mode” in restAPI cannot be used interchangeably. Entering the corresponding underlying index is required while using this API. 2.Involved Endpoint: restAPI a. Information on futures accounts of a single currency: GET /api/futures/v3/accounts/ b. Enquiry about account statements: GET /api/futures/v3/accounts//ledger c.Published on Oct 30, 2019Updated on Nov 17, 2025AnnouncementsWebSocket API is now supporting BCH, ETH and ETC contracts
Dear Valued Customers, The WebSocket API has been upgraded and we now support BCH/ETH/ETC futures. OKX Futures WebSocket Address: wss://real.OKX.com:8443/ws/v3 Please add our API customer support WeChat (ID: ApiSupport) for API-related questions Thank you for your support. OKX 8 December 2017 (Sunday) 21:30Published on Dec 8, 2017Updated on Nov 17, 2025AnnouncementsKlaytn (KLAY) and Net Holding Contest with 200% APY Now Available
Dear valued customers, We are pleased to announce that Klaytn(KLAY)is now listed on OKX. Please take note of the following go-live schedule: 1. KLAY Deposit - 11:00 September 3, 2020 (UTC); 2. KLAY Spot Trading - (KLAY/USDT, KLAY/BTC markets) - 09:00 September 10, 2020 (UTC); 3. KLAY Withdrawal – 09:00 September 14, 2020 (UTC) Due to spot system upgrade, the KLAY spot trading would be adjusted as...Published on Sep 3, 2020Updated on Nov 17, 2025AnnouncementsV3 Open API Supports USDT-margined Perpetual Swap Trading
Public - obtain contract information: GET /api/swap/v3/instruments - - - - returning necessary strings with the response After the upgrade, your program will remain unaffected, but new strings will be added to the existing API. Thank you for your understanding. The V3 API offers more stable, efficient experience and more comprehensive functionalities than the V1 API. As V1 Restful API will be terminated as scheduled soon, we suggest you switch to V3 API for trading.Published on Nov 25, 2019Updated on Nov 17, 2025AnnouncementsHow do I prevent self-trade and improve my API trading efficiency and protection?
Visit OKX's API page and explore the extensive API documentation to learn more about how to leverage this powerful tool to enhance your trading journey.Published on Jun 11, 2024Updated on May 14, 2025FAQ11Announcement of historical data services scheduled maintenance
The affected Open API endpoints are: Endpoint name Endpoint path Order details GET /api/v5/trade/order (Only affects canceled and filled orders) Transaction details (last 3 days) GET /api/v5/trade/fills Transaction details (last 3 months) GET /api/v5/trade/fills-history Get bills details (last 7 days) GET /api/v5/account/bills Get bills details (last 3 months) GET /api/v5/account/bills-archive Order history (last 7 days) GET /api/v5/trade/orders-history Order history (last 3 months) GET /api/v5/tradePublished on Mar 15, 2024Updated on Nov 17, 2025AnnouncementsThird Party App IP Whitelist Launch
When users are connecting to an API Broker, the API Key generating and binding process is always the critical step that requires extra caution. In order to mitigate any risk, we have launched the Third Party App IP Whitelist feature to limit the usage of users' API keys to only whitelisted servers.Published on Jan 5, 2023Updated on Apr 1, 2025Product documentationIntroduction of rules on OKX brokers
Brokers can make commission queries, detailed queries, and other functions through their backgrounds, and can also make queries on commission data through API. 6. Broker API integration process Documents required: You are required to use OKX's public API documents and broker API documents 3 steps for API docking: Steps Available for 1. Use public API documents to set up public services, such as trading, query, etc. API broker, OAuth broker 2.Published on Feb 20, 2023Updated on Feb 12, 2026Product documentation