Developer Portal#

This section covers the features of the development portal and best practices which will help you to build your own apps efficiently.

Sign up/Log in#

1. Click on the 'Developer portal' under the navigation bar Build.
2. Click 'Connect Wallet' to create or log in to an account. We recommend to use OKX Wallet for a seamless experience.You can also choose other wallets for your project.
3. Click 'Verify' in the developer portal, then confirm Signature request in the extension.

You have successfully created your developer account with OKX DEX API. A default project is also created for your convenience.

Link E-mail and Phone number to your account#

1. Click the 'Link now' Button and switch to the 'Setting' tab
2. Input your E-mail and Phone number correctly
   Note

   If you find you cannot find your country in the Phone number country selection part, that's mainly because some regions are restricted to DEX API services
3. Complete the verification code process

You have successfully linked your E-mail and phone number to your developer account. You can now immediately create DEX API keys on the developer portal and start embedding our advanced trading capability into your dApps.

Generate a New API Key#

1. Switch to the project that you want to create an API key. Note, you can create up to three projects per developer account, and three API keys per project.
2. Navigate to the "API keys" page and click the Create API key button.
3. Enter the name of the API key and passphrase, and click Create to generate the corresponding API Key.
   

Please keep your passphrase safe and accessible. You cannot access your API key in your project without the passphrase

View the Secret Key#

When making API calls with a generated API key, you need to provide both the API passphrase and the secret key. The secret key is system generated, and can be viewed by clicking the Copy button on the right of the Secrete key column.

General Terms#

• API key: a unique identifier used to authenticate and authorize an application or user when making requests to OKX DEX API.
• Secret key: a system generated security token to provide additional security for your API key.
• Passphrase: a phrase supplied by the developer when creating an API key, used to encrypt the secret key on the server to provide additional security. The passphrase is also needed to view the secret key and modify the API information.