All
FAQ
Announcements
Product documents
OKX API FAQ
This is the password you filled in when applying for the API key. You need to remember it yourself. Once you forget it, you can't retrieve it and you'll need to create a new API key.How do I create an API key? On the App: Log in to your OKX account > Select Menu > Scroll down and select API > Create API key On the Web: Log in to your OKX account > Go to your Profile and select API and connections > Create API keyHow do I create a demo disk API key?Published on 20 Sept 2024Updated on 23 Mar 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 5 Jan 2023Updated on 1 Apr 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 9 Nov 2023Updated on 17 Nov 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 8 Dec 2017Updated on 17 Nov 2025AnnouncementsOKX deepens relationship with TradingView to bring trading experience to Mobile.
The collaboration between OKX and TradingView has now made it possible for traders to connect their TradingView account to OKX and place both Spot and Derivatives trades directly within TradingView on mobile. The integration with TradingView aims to provide a more seamless and user-friendly trading experience. Users can connect their OKX account to web and desktop versions of TradingView, as well as its mobile app, eliminating the need to switch between platforms.Published on 21 Mar 2023Updated on 17 Nov 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 27 Mar 2024Updated on 17 Nov 2025AnnouncementsMy mobile phone isn't working, what should I do?
If your mobile phone isn't working properly, or you've lost access to it, or you can't get SMS codes, try the following:My SMS codes aren’t working on OKX Try these fixes first to check if you can get codes working again: Automate your mobile phone time.Published on 22 Aug 2023Updated on 27 Jan 2026FAQ461Changes 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 24 Apr 2023Updated on 17 Nov 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 30 Mar 2023Updated on 17 Nov 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 30 Oct 2019Updated on 17 Nov 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 8 Dec 2017Updated on 17 Nov 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 3 Sept 2020Updated on 17 Nov 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 25 Nov 2019Updated on 17 Nov 2025AnnouncementsHow do I submit my proof of address (POA)?
Unacceptable document types The following documents are not accepted as Proof of Address: Bank account opening certificates Digital driver’s licenses Online third-party payment receipts or screenshots Online shopping records Food delivery orders Mobile phone bill payment records, and similar documents Note: If you obtain a bank or credit card statement, please submit the original PDF file or a photo of the physical statement. Screenshots will not be accepted.Published on 5 Sept 2023Updated on 12 Feb 2026FAQ850OKX x McLaren NFT Sweepstakes Terms & Conditions
Virtual Driver Briefing: This prize includes a virtual driver meet-and-greet via Zoom, which will be available for the winner in 2024 season at a date suitable for both the winner and driver. This prize must be used in 2024 or the winner will automatically forfeit it.Published on 25 Apr 2024Updated on 8 Sept 2025FAQ607