🔗Connect An Exchange Account

The automation terminal links to supported cryptocurrency exchange accounts via a secure API connection. This segment reviews how to set up a new connection in order to utilize our tools.

Step 1: Navigate To Connections Menu

Access the user dashboard at https://compendium.finance/dashboard and navigate to the "Connections" tab.

After navigating to the correct "Exchange Connections" tab in the "Portfolio" drop down, you will then see the "Connect A New Exchange Account" form.

Step 2: Fetch And Enter Exchange API Keys

You can use the form pictured above. Depending on where you are accessing the ability to add a new connection from, a popup may then display allowing you to enter your exchange API keys in order to interact with our trading tools. Both of these forms (the main form, and the popup) will allow you to manage the addition of new exchange keys.

Before you enter the keys into our platform, it's important to understand how to create the API keys from your supported exchange account. Please follow the links below to ensure the correct creation of these API keys.

It is important that your API keys have the ability to post trades. Some exchanges allow you to toggle the "Read Only" setting. If the "Read Only" setting is set to true then this account will not be able to follow signals sent by our variety of trading tools.

Currently Supported Exchanges

Learn how to create and connect API keys from supported cryptocurrency exchanges.

OKX (Formerly Okex)

Learn how to create and connect API keys from OKX

Exchanges Coming Soon To The Automation Terminal

These exchanges are in no exact order. To view integration schedules visit here.

• Binance

• Binance US

• BitMex

• BitGet

• Bybit

• Kucoin

• Huobi

• MEXC

Integrations: Most exchanges integrated with our open-source PENDAX engine will automatically appear in our consumer-facing automation terminal after the confirmation and debugging stage.

Step 3: Enter API Keys Into The Compendium App

A visual representation of the Exchange API Credential pop-up

It is now time to enter your newly created keys after following the instructions for your selected exchange above.

• Select Exchange: Ensure you select the correct exchange for your API keys from the "Exchange" dropdown menu.

• API Key: Enter the "Key" or "API Key" delivered by the exchange for your account or subaccount. This must be an exact match.

• API Secret: Enter the "Secret" or "API Secret" delivered by the exchange for your account or subaccount. This must be an exact match.

• Subaccount Name: This field is optional but required if you generated an API key for a specific subaccount on an exchange that supports this feature.

• Nickname: This nickname is for the Compendium automation terminal only and is used to distinguish this API key connection from others on your dashboard. It can be labeled however you see fit.

After you have entered these details correctly and confirmed their accuracy you can now click on the "Save" button. Once you click on the save button please allow the page a few seconds to load the "Health Check Confirmation".

The Successful Test parameter should read PASSED in order for the automation terminal tooling to post trades to your connected accounts.

Successful Health Check

If the "Successful Test" parameter retrieves a "Passed" signal during the exchange API credential health check then your connected account is now ready to be utilized on our platform. You can continue by pressing the close button.

Failed Health Check

If the "Successful Test" parameter retrieves a "Fail" signal during the exchange API credential health check then you will need to press the "Edit Details" button and ensure that the entered information is correct.

Please Note: It has been documented in rare instances that exchanges may encounter problems verifying API keys that have been recently created. If for some reason you can not confirm newly created API keys then we recommend users return to the exchange and generate a new API key for their account.