BitMEX

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

Step One: Log in to your BitMEX account at https://www.bitmex.com/app/login

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

Step Three (a): Complete the “Create an API Key” section

You will be prompted to create a new API Key. 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.

For the CIDR, Key Permissions, and Withdraw selections, be sure to leave these blank and unselected. This will ensure that all of the Reading functions are enabled, and all functions relating to trading, transfers, and withdrawals are disabled. This should be the case by default, however 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.

Step Three (b): Enter the current code from your Two-Factor Authenticator and select "Create API Key" at the bottom left.

Step Four: Verify your key permissions and record your generated keys

Under the "API Keys" heading, verify that your newly created key has been added to the list. Importantly, ensure the Permissions associated with that key are displayed as "Read" to confirm that no Write functionality had been added during the previous step.

Finally, be sure to record your Secret Key in a secure location, as this key will be permanently hidden once the page is refreshed.

Step Five: 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 where prompted (3). As reference, the "ID" from BitMEX is the "" in the Hash Data tool.

Step Six: 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.