Deribit

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

Important Note: This guide will walk through how to create an API Key for the Master 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, either by clicking on your account name at the top right of the page, or selecting "Subaccounts" on the left side menu (refer to image in Step Three), then complete the same steps as described below.

Step One: Log in to your Deribit account at https://www.deribit.com/

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

Step Three: Select the “Add New Key” button.

You will be prompted to create a new API Key. Enter a label for your key. We recommend making the label as descriptive as possible to reflect the use case of the specific API.

Afterwards, you will need to set "Read" permissions for all of the drop-down activities, otherwise the Hash Data tool will not be able to compile complete information. You want to ensure that Read is enabled, and NOT "Read-Write". 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.

Please leave the IP Whitelist as blank, to enable the tool to read your API.

Once you have a desired label and set the permissions , click the “Next” button at the bottom of the screen.

Step Four: Record your generated keys

Once Step Three is complete, you will be brought back to the API Access page. Click "Load Keys" in the top right and you will see your new key added to the list.

Unlike many exchanges, Deribit does not permanently hide your Secret Key once generated, so you are able to come back to this page and obtain this later if required. However, this can only be retrieved a limited number of times before being permanently hidden.

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 "Client ID" from Deribit is the Public Key in the Hash Data tool, and "Client Secret" is the Secret Key

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.