How to apply for the API key of OKEx? What permissions can be set?

To automate trading or access account data on OKEx, apply for an API key, set permissions like read, trade, and withdrawal, and secure it with IP whitelisting and expiration dates.

May 14, 2025 at 09:57 am

Applying for an API key on OKEx and understanding the permissions that can be set are essential steps for users who wish to automate their trading or access their account data programmatically. In this article, we will guide you through the process of applying for an API key on OKEx and explore the various permissions you can set to control what the API key can do.

Accessing the OKEx API Key Application Page

To start the process of applying for an API key on OKEx, you need to log in to your OKEx account. Once logged in, navigate to the API Management section. You can typically find this under the account settings or a similar section on the OKEx platform.

• Click on your profile icon or username at the top right corner of the OKEx website.
• Select API Management from the dropdown menu.

Applying for an API Key

Upon reaching the API Management page, you will see an option to create a new API key. Click on the Create API Key button to begin the application process.

• You will be prompted to enter a name for your API key. This name is for your reference and helps you identify the purpose of the key.
• Next, you will need to set a passphrase. This is an additional layer of security and should be a unique phrase known only to you.

After filling in the required fields, you will need to confirm your identity through a two-factor authentication (2FA) method. OKEx typically supports multiple 2FA methods, such as Google Authenticator or SMS.

• Enter the 2FA code you receive and click Confirm.

Setting Permissions for Your API Key

Once your API key is created, you can set specific permissions to control what actions the key can perform. OKEx offers a range of permissions that can be toggled on or off depending on your needs.

• Read Permission: This allows the API key to access your account data, such as balance, order history, and trade history.
• Trade Permission: This permission enables the API key to execute trades on your behalf, including placing orders, canceling orders, and managing positions.
• Withdrawal Permission: This is the most sensitive permission and allows the API key to withdraw funds from your account. It is recommended to enable this only if absolutely necessary and with extreme caution.

To set these permissions, follow these steps:

• On the API Management page, locate the newly created API key.
• Click on the Edit button next to the API key.
• Toggle the permissions you wish to enable or disable.
• Confirm your changes by entering your 2FA code and clicking Save.

Securing Your API Key

Security is paramount when dealing with API keys, as they grant access to your account. OKEx provides several security features to protect your API key.

• IP Whitelisting: You can restrict the API key to only work from specific IP addresses, adding an extra layer of security.
• API Key Expiration: You can set an expiration date for your API key, which is useful for temporary access or for regularly updating your keys.

To set up IP whitelisting or an expiration date:

• Go to the API Management page.
• Select the API key you wish to secure.
• Click on Edit and navigate to the Security Settings section.
• Enter the IP addresses you want to whitelist and set an expiration date if needed.
• Confirm your changes with a 2FA code and click Save.

Managing and Revoking API Keys

It's important to regularly review and manage your API keys to ensure they are still needed and secure. If you no longer need an API key or suspect it has been compromised, you can revoke it.

• On the API Management page, find the API key you wish to manage.
• Click on Revoke to deactivate the key immediately.
• Confirm the action with your 2FA code.

Using Your API Key

Once your API key is set up with the desired permissions and security measures, you can start using it to interact with the OKEx platform programmatically. You will typically use the API key in conjunction with the API secret and passphrase to authenticate your requests.

• The API Key is used to identify your account.
• The API Secret is used to sign your requests and ensure their authenticity.
• The Passphrase adds an additional layer of security to your requests.

To use your API key, you will need to follow the documentation provided by OKEx for the specific API endpoints you wish to use. Each request will require you to include your API key and a signature generated using your API secret.

---

Frequently Asked Questions

Q: Can I have multiple API keys on OKEx?

A: Yes, you can create multiple API keys on OKEx. This is useful if you need different keys for different purposes or applications. Each key can have its own set of permissions and security settings.

Q: What should I do if I lose my API secret?

A: If you lose your API secret, you should immediately revoke the corresponding API key from the API Management page to prevent unauthorized access to your account. You can then create a new API key with a new secret.

Q: Is it possible to change the permissions of an existing API key?

A: Yes, you can change the permissions of an existing API key at any time. Simply go to the API Management page, select the key, click Edit, and adjust the permissions as needed. Remember to confirm the changes with your 2FA code.

Q: How often should I update my API keys?

A: It's a good practice to update your API keys periodically, such as every few months, to enhance security. If you suspect any compromise or if you no longer need a key, revoke it and generate a new one.