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 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 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 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 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 2025AnnouncementsAnnouncement 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 15 Mar 2024Updated on 17 Nov 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 5 Jan 2023Updated on 1 Apr 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 20 Feb 2023Updated on 12 Feb 2026Product documentationOptions trading FAQ
What are the API Best Practices? For those connected via API, visit here to learn more about API best practices.Is Market Maker Protection (MMP) available for options trading? We offer Market Maker Protection for options market makers to protect makers from executing too much within a short period of time. Please contact your account manager or institutional@okx.com if you want to have it enabled. Please refer to Market Maker Protection API.Published on 19 Nov 2024Updated on 9 Feb 2026FAQ4OKX and Alertatron goes into the next phase of partnership
[Do view the instructions below] How to connect Alertatron to OKX: Create a set of API keys for Alertatron. This allows you to remove access at a later date without affecting any other services you use that also require API keys. Log into your OKX account, or your OKX Demo Trading account. Go to the Account menu and choose 'API'. Choose 'Create V5 API key for demo trading'. You'll be taken to a form to create your new API keys.Published on 11 Apr 2023Updated on 17 Nov 2025AnnouncementsHow can I do spot trading with the Jupyter Notebook?
How can I create API keys? After signing in to our platform, go to Trade > Demo trading to create API keys for testing purposes Open Demo trading page Go to Profile and select Demo Trading API to create API keys. Open API to create API keys Create API keys for the different master/sub accounts you might have Select Create API key Select Trade in the Permissions to trade with the API key Select Trade in Permissions Now you have access to your API key, your Secret key, and your passphrase.Published on 29 Sept 2023Updated on 10 Sept 2025FAQ544