All
FAQ
Announcements
Product documents
OKX API FAQ
Never send an API Secret, Passphrase, verification code, or unredacted signature.What should I do if I still have API Inquiry? Or Can I chat with API CS? If you have any further questions, you're welcome to join our API support group: English API Support GroupWhat should I do if Demo Trading API returns error code 50123? Error code 50123 means that the API key does not have permission to trade crypto.Sep 20, 2024Published on Sep 20, 2024Nov 9, 2026Updated on Nov 9, 2026144Simple Earn FAQ (EEA)
Even if you have subscribed to Simple Earn, (a) if your selected minimum APY is higher than the current market APY, your order will not be matched and therefore won’t generate earnings; or (b) if your selected minimum APY is equal to the current market APY, there is also a chance that your order will not be matched due to an oversupply of eligible lending funds, and the unmatched portion won't generate earnings.When can I receive my redeemed funds?Dec 9, 2025Published on Dec 9, 2025Aug 5, 2026Updated on Aug 5, 20262AI Builder Program Integration Guide
API Key, Secret Key, and Passphrase must be stored in a secure local environment or on the Builder backend, encrypted, and isolated by user. They must never be exposed in the frontend, prompts, logs, or code repositories. Step 2 – Complete OAuth and create the Fast API Key After a user completes OAuth authorization, you can create a Fast API Key for them and begin using Fast API.Aug 21, 2026Published on Aug 21, 2026Sep 2, 2026Updated on Sep 2, 20269How do I connect a third-party trading terminal or bot to my OKX account?
The current key settings and steps are in API FAQ.How do I create an API key if I only have the OKX app? You don't need a computer to create an API key. In the OKX app, go to Menu > API > Create API key, then grant the permissions the tool needs and store the key securely. The steps for both the app and the website are in API FAQ.Why does a third-party tool say the symbol isn't tradable?Sep 3, 2026Published on Sep 3, 2026Sep 3, 2026Updated on Sep 3, 20261What should I expect when changing my country of residence to any country within the European Economic Area (EEA) or Australia?
You can restake your assets immediately after the update.API domain update Your API domain will change after the system update. The REST API domain will be updated to eea.okx.com, and the WebSocket domain will be updated to wseea.okx.com.Jul 2, 2025Published on Jul 2, 2025Aug 27, 2026Updated on Aug 27, 2026171How do I automate my trades?
Gather all of the details that you need in regards to the trading bots here.How do I use OKX's API for custom trading strategies? Generate API keys: in your OKX account settings, generate API keys with appropriate permissions. Set up your development environment: use programming languages like Python, JavaScript, or others to create your trading bot. Connect to the API: utilize OKX’s API documentation to connect your bot to the exchange.Oct 1, 2024Published on Oct 1, 2024Sep 3, 2026Updated on Sep 3, 202616USDG on X Layer FAQ
What's the 4.1% APY USDG rewards program and how do I participate? X Layer offers a 4.1% APY rewards program on USDG holdings, where USDG rewards are earned daily and claimable every week. To participate: Hold USDG on X Layer via OKX Wallet Connect your Wallet to Exchange to activate the rewards program Claim your rewards on Wallet under the USDG token page Note: the rewards program isn't available to customers in USA, UK, EEA, Brazil, Australia, UAE, Turkey, and Singapore. 3.Oct 21, 2025Published on Oct 21, 2025Aug 5, 2026Updated on Aug 5, 202618How 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.Sep 29, 2023Published on Sep 29, 2023Aug 5, 2026Updated on Aug 5, 2026583Large Withdrawal Protection FAQ
This is normal behavior and not a sign that your settings are misconfigured.Q: My API withdrawal was blocked. What can I do? API withdrawals that exceed your threshold are blocked automatically and cannot be resumed via facial verification. You can either withdraw through the Web or App instead, or log in and increase your threshold first, then retry the API withdrawal.Q: Do sub-account withdrawals count toward my threshold? Yes.Jul 7, 2026Published on Jul 7, 2026Aug 5, 2026Updated on Aug 5, 20268USDG rewards program FAQ
With USDG rewards, you can earn up to 3.85% APY simply by holding USDG in your OKX Wallet. Your funds remain fully accessible — you can redeem or move them anytime without penalties. Rewards are designed to help users grow their digital dollar holdings passively and securely. Note: We reserve the right to adjust the advertised APY at any time with reasonable notice.3. Is USDG token backed by US dollars? Yes. Each USDG token is backed by high-quality reserves, such as U.S.Oct 13, 2025Published on Oct 13, 2025Aug 5, 2026Updated on Aug 5, 2026539Index components weightage adjustment FAQ
What will be updated on API related to index component weights? No changes to current API endpoints and no new endpoints will be added. The component weight (field name: "wgt") returned by "/api/v5/market/index-components" will be updated to the latest weights automatically.6. How does the updated index weighting method affect my trading strategies? After the weighting adjustments, the components that have higher volume and better liquidity will have higher weights.Dec 14, 2023Published on Dec 14, 2023Aug 5, 2026Updated on Aug 5, 202615What's OKX Web3 Gaming?
You can follow the steps outlined in OKX WaaS-Marketplace API to create a project and generate API keys from the developer portal. Note: if you have any questions, you can always contact our support team via our OKX API Telegram group for real-time support.How do I issue my allowlist and NFT on OKX? You can refer to this article to learn more about issuing your allowlist and NFT assets.How do I enforce the collection of NFT royalties?Jun 18, 2024Published on Jun 18, 2024Aug 5, 2026Updated on Aug 5, 2026279How can I enhance my OKX app security?
Audit your API permissions: head over to Profile > API for the web while select Menu > Tools > API to access via the app, and delete any unauthorized APIs available. Proceed to select API under the Tools section on the Menu page Check your active devices: head over to Profile and settings > Security > Device Management under Advanced security, and remove any unrecognized devices and reset your password.May 14, 2026Published on May 14, 2026Sep 22, 2026Updated on Sep 22, 20262How do Stock and Commodity X-Perps work?
OKX may adjust margin requirements at its discretion based on volatility, liquidity, or regulatory requirements.Can I trade X-Perps via the OKX API? Yes. OKX X-Perps are accessible via the OKX API using the same endpoints as standard expiry futures. Each X-Perp contract includes a dedicated field in API metadata to identify it as such. API users must accept the X-Perp risk disclosure via the OKX web or app interface before API trading is enabled.Jun 9, 2026Published on Jun 9, 2026Sep 4, 2026Updated on Sep 4, 2026How do I level up my trades with Mizar?
That means you don't need to deposit any funds on Mizar to trade, but you can connect to your exchange with API keys.3. How do I connect OKX to Mizar? Learn more on how you can create your OKX API key and how to connect it to the Mizar bot by reading about it here.Mar 28, 2024Published on Mar 28, 2024Aug 5, 2026Updated on Aug 5, 20265