Developer Portal#
This section covers the features of the development portal and best practices which will help you to build your own apps efficiently.
- 1Sign up / Log in
- Open the Developer portal.
- Click Connect Wallet to create or log in to an account. We recommend the OKX Wallet for a seamless experience, but you can also choose other wallets.
- Click Verify in the developer portal, then confirm the Signature request in your wallet.
Once done, your developer account is created with OKX API and a default project is set up for your convenience.
- 2Link email and phone number
- Click the Get started button.
- Enter your email and phone number.
- Complete the verification code process.
NoteIf you can't find your country in the phone number country selection list, the region is likely restricted from OKX API services.You have successfully linked your email and phone number to your developer account. You can now create OKX API keys on the developer portal and start embedding our advanced trading capabilities into your dApps.
- 3Generate a new API key
- Switch to the project where you want to create an API key. Each developer account supports up to 3 projects, and each project supports up to 3 API keys.
- Navigate to the Home page and click the Create API key button.
- Enter the API key name and passphrase, then click Create to generate the API key.
Keep your passphrase safe and accessible. Without the passphrase, you cannot access your API key in your project. - 4View 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 View details button on the Home page.
General Terms#
- API key: a unique identifier used to authenticate and authorize an application or user when making requests to OKX API.
- Secret key: a system-generated security token that provides 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. The passphrase is also required to view the secret key and modify API key information.
Table of contents