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 20 Sept 2024Updated on 3 Jun 2026139What do I need to do when I change my country of residence?
API domain update Follow OKX API Documentation for the latest API domain updates. Updated login URL Use the correct login site by following the account login flow on the web. There are no changes to the login process for the app version.Tips when entering your address Enter your full address (street, unit number if applicable, city, postal code, etc.) using the required format shown on screen.Published on 10 Apr 2025Updated on 29 May 2026638Why 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 17 Oct 2024Updated on 29 May 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 29 Sept 2023Updated on 29 May 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 4 Dec 2024Updated on 29 May 2026728Event 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 16 Apr 2026Updated on 2 Jun 2026Index 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 14 Dec 2023Updated on 29 May 202613What'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 24 Jun 2025Updated on 29 May 202665What'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 28 May 2024Updated on 29 May 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 1 Oct 2024Updated on 29 May 202612How 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 26 Sept 2023Updated on 29 May 20261,003How 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.Published on 14 May 2026Updated on 29 May 2026How do total Profit and Loss (PnL) and Grid profits work for Spot Grid?
Grid Profits is meant for reference and breakdown purposes.Published on 20 Jun 2025Updated on 29 May 202658OKX AI 101
Historical returns, projected returns, and probability forecasts are for reference only and don't reflect or guarantee future actual performance. AI-related activities may result in the total loss of your invested assets. Terms and conditions apply.Published on 4 May 2026Updated on 29 May 20264How 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.Published on 28 Mar 2024Updated on 29 May 20265