OKX

A comprehensive guide on how to generate your API keys on OKX!

Important Note: This guide will walk through how to create an API Key for the Main account, however this process remains the same if you wish to create an API specific to a sub-account. You would simply need to switch to your desired sub-account in the drop-down menu shown on the image in Step Three, then complete the same steps as described below.

Step One: Log in to your OKX account at https://www.okx.com/account/login

Step Two: After signing in, select your profile icon in the top right corner, then select API from the dropdown.

Step Three: Select the “Create V? API Key” button.

At the time of writing, OKX uses a V5 API key generator, however this method should remain largely consistent if this is updated to V6 and beyond.

This is also where you can select which account or sub-account you wish to run the API Key for. We will continue assuming you wish to generate an API for your main account, however please note the following steps remain consistent if you wish to repeat this process for any sub-accounts.

Step Four: Enter your API key parameter information

You will be prompted to create a new API Key. In "API Name", enter a label for your key. In our example we chose to make it “How To Guide”. We recommend making the label as descriptive as possible to reflect the use case of the specific API.

OKX also requires you to enter an API Passphrase - do NOT enter a passphrase you have used anywhere else, as you will need to enter this into the Hash Data tool later.

Next, verify that API restrictions are correct - by default, OKX will select "Read" which contains all Read-Only functionality. This is perfect, so ensure you do NOT select Trade or Withdraw. It is important to double-check at this stage as the Hash Data tool will deny the API key if any trading functions are enabled.

Finally, ensure the IP Address box is left blank, as otherwise our tool will not be able to pull information from the API. Once you are comfortable with all the information shown, hit "Confirm" and enter your 2FA information when prompted.

Step Five: Record your API keys and verify permissions once more

This next screen will display your API keys - be sure to record your Secret Key in a secure location, as this key will be permanently hidden once the page is refreshed. Also take this time to conduct your final check to ensure that the "API Restrictions" states "Read". Once recorded, be sure to hit "Confirm".

Step Six: Enter your API keys into the Hash Data tool

Log into the Client Portal of the Hash Data tool, then navigate down to Exchange Accounts (1), selected Add Exchange (2), then enter your keys (and passphrase) where prompted (3). As reference, the "API Key" from OKX is the "" in the Hash Data tool.

Step Seven: Click "Test Keys" and let that complete.

If the test sends an error in response, please re-review the information entered and the permissions associated with the API key. The software has a number of checks in place to prevent users from uploading keys with "Edit" capabilities, so this is the most common source of errors.

Once the keys are tested and no errors are noted, click "Submit".

Congratulation - the Hash Data tool is now able to read your exchange account!

If you are looking for information on how to process information from your exchange account and begin running reports from this balance, please proceed to the User Guide!

For any questions, please reach out to [e-mail] for additional assistance.