All
FAQ
Announcements
Product documents
OKX API FAQ
What does Passphrase refer to? 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: 1. Log in to your OKX account > Select Menu (⋮⋮⋮) > Scroll down and select API > Create API key 2. Fill in the API name > Select Account and Purpose > Enter the IP address allowlist > Select Permissions > Enter the Paraphrase On the Web: 1.Published on Sep 20, 2024Updated on Jun 3, 2026139What 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.Published on Jul 2, 2025Updated on May 29, 2026169Why is my deposit not credited even when all information is correct?
Rest assured, assets that have already been recorded on the blockchain will not be lost. Once the network reopens for deposits, the platform will process it promptly. You can refer to the deposit page for the estimated recovery time and check back later.Published on Oct 17, 2024Updated on May 29, 20262,001How can I do spot trading with the Jupyter Notebook?
Instantiate python variables to save your API details in the notebook for later usage 1 api_key = "xxxxx" 2 secret_key = "xxxxx" 3 passphrase = "xxxxxx"4. How can I import OKX modules? In python-okx, there are several modules based on our REST API modules. Read our guide to learn how to import OKX modules.Published on Sep 29, 2023Updated on May 29, 2026561Affiliate FAQ
How can affiliate access data from the Affiliate Portal via API? Kindly refer to: https://www.okx.com/docs-v5/en/#affiliate-rest-apiPublished on Dec 4, 2024Updated on May 29, 2026728What are the margin modes in X-Perps: selected margin and isolated margin?
With isolated margin, the margin assigned to a position is separated from the rest of your account balance. In practice, this means: risk is limited to the margin allocated to that position (subject to fees and platform mechanics). losses on one position are less likely to affect unrelated balances. liquidation can happen sooner if the isolated margin is insufficient. margin needs to be managed for each position.What's selected margin?Published on Apr 15, 2026Updated on May 29, 2026Event Contracts FAQ
For more details, please refer to Notice on OKX Event Contract Fee UpdateAPI Integration & AI Agent Integration Supported account modes: Futures mode, Multi-currency mode, and Portfolio mode. Spot mode is not supported. Position mode: API access only supports Isolated margin mode.Published on Apr 16, 2026Updated on Jun 2, 2026What's KYC: What to expect and why it matters?
You may be asked to verify again to: Reconfirm your identity for account protection Prevent unauthorized access or financial fraud Maintain compliance with updated local and international regulations Rest assured, your data is encrypted and handled in accordance with data protection laws, including GDPR and other global standards.What’s next for KYC? We’re constantly improving the KYC experience to make it faster, safer, and more user-friendly.Published on Jun 24, 2025Updated on May 29, 202665Index 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.Published on Dec 14, 2023Updated on May 29, 202613What's Satoshi test and how do I complete it?
If you have any withdrawals that are currently on hold due to pending Satoshi test verification, rest assured that these will be processed and sent on-chain immediately following successful verification. This ensures that your transactions aren't unduly delayed once verification is confirmed. In the event that the verification times out, you have the option to re-attempt the verification process.Published on May 28, 2024Updated on May 29, 202667How 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.Published on Oct 1, 2024Updated on May 29, 202612USD-margined futures contracts FAQ
On the API: Please refer to the API changelog On the app: Select More on Trading page > Select Settings > Select USD-M settlement currency Select More and Settings under Features selection USD-M settlement currency is under Trading mode option on the app's settings menu On the web: Select Settings on Trading page > Select USD-M settlement currency USD-M settlement currency is under Settings option on the web's menuWhat happens if I use a different settlement currency than my counterparty?Published on Oct 13, 2025Updated on May 29, 20266How do I verify OKX's ownership and balance of the wallet address?
Please refer to here Use third-party nodes: Infura、Alchemy Example: Alchemy provides ethereum archive node serviceOKLink API balance verification Login to OKLink Go to profile > API Select Create API under On-chain Data to create apiKey Configure parameters related to OKLink open API in the rpc.json file OKLink is a blockchain big data company that provides an open interface to query the address balance of a specified height in the blockchain.Published on Sep 26, 2023Updated on May 29, 20261,003How do total Profit and Loss (PnL) and Grid profits work for Spot Grid?
Grid Profits is meant for reference and breakdown purposes.Published on Jun 20, 2025Updated on May 29, 202658How can I do derivatives trading with the Jupyter Notebook?
If you have any questions about our APIs, you can join our API community and raise them in the community.Published on Sep 28, 2023Updated on May 29, 2026203