How to Retrieve API Keys

In this section you will find how to connect your favourite exchanges to TWM.

Binance

Note: If you don’t plan to trade live but only want to retrieve data or use the local simulator, you can leave the API key fields blank.

If you want to place trades on Binance using TWM you will need to generate two specific types of API keys on the Binance platform: HMAC and ED25519.

HMAC works for Futures Market Websocket connection and for all REST API requests.
ED25519 keys are used for the Spot Market Websocket connection.

Below is a detailed walkthrough of the process to generate these keys:

It's necessary to download the key generator from Binance's github, visit the following URL: https://github.com/binance/asymmetric-key-generator/releases.
From the releases page, download the latest version of AsymmetricKeyGenerator-setup-vX.X.X.exe and its corresponding checksum file.

And finally, run the Asymmetric Key Generator application.

Generate ED25519 Key:

After opening the Asymmetric Key Generator application:

select "Ed25519" (1)
(Optional) Insert a passphrase (2)
And finally, click on the "Generate Key Pair" button (3)

Once the keys are generated, you will see a Private Key (1) and a Public Key (2), you can copy or save them:

1. Log in to your Binance account. (https://accounts.binance.com/en/login)

2. Navigate to Account (https://www.binance.com/en/my/dashboard), then select API Management (https://www.binance.com/en/my/settings/api-management).

3. Click the Create API button.

4. Choose the Self-Generated option.

5. A window will appear prompting you to insert a public key.

-Paste the Public Key saved earlier from the Asymmetric Key Generator application into the prompt box.

6. You'll need to insert a Label for the API Key (es. "TWM"), and then click next

7. Binance will provide an API Key, copy it

and paste it into TWM connection configurator:

8. From the Asymmetric Key Generator window:

-Copy the Private Key. For this step, copy only the key itself, without the -----BEGIN PRIVATE KEY----- and -----END PRIVATE KEY----- parts.

9. In the TWM Binance connection configurator, paste this into the Websocket Private Key field.

10. To enable Trading, it's necessary to toggle the "Enable Spot & Margin Trading".

It could be necessary to enable the "Restrict access to trusted IP's only"

Note: You can find your IP on https://whatismyipaddress.com/

Generate HMAC Key:

1. Log in to your Binance account. (https://accounts.binance.com/en/login)

2. Navigate to Account (https://www.binance.com/en/my/dashboard), then select API Management (https://www.binance.com/en/my/settings/api-management).

3. Click the Create API button.

4. Choose the System Generated option.

5. You'll need to insert a Label for the API Key (es. "TWM_REST"), and then click next

6. Copy both the API and Secret key

-And paste them into TWM

Notes:

Be cautious if you have a dynamic IP address, which can change frequently (even multiple times a day). Using a dynamic IP with IP whitelisting can lead to connection issues. If you've set up a connection with IP whitelisting and later find you cannot log in or connect, re-check your IP address using the link above. If it has changed, you'll need to update the whitelisted IP address(es) in your Binance API key settings.
IP Filtering for Older Accounts: Some older Binance accounts, particularly those created before futures trading was introduced, might require users to set up an IP filter by default to trade futures.
Enable Futures Account: By default, some Binance accounts may not have their Futures trading account fully enabled. If your API keys are correctly set up but the TWM connection still fails (especially for futures), ensure your Binance Futures account is properly activated. You can find guidance on this here: https://www.binance.com/en/support/faq/detail/360033772992.

Bybit

API Key Requirements

For retrieving market data through TWM, an API key and secret are not required from Bybit. If you only need market data, you do not even need a Bybit account; simply set up a connection in TWM without entering any keys.

However, an API key and secret must be set up if you intend to place orders or read your account information via TWM.

Prerequisite: Unified Trading Account (UTA)
Activate it by going here: https://www.bybit.com/user/assets/home/tradingaccount
And click on "Upgrade Now"

Here you can find additional info about UTA Account: https://www.bybit.com/en/help-center/article/FAQ-Unified-Trading-Account

Before setting up an API key for trading or account access, it is crucial to ensure your Bybit account is configured as an Unified Trading Account (UTA), since TWM does not support the classic Bybit account structure.

Identifying your account type:

If your Bybit dashboard lists "Spot" and "Derivatives" (or Futures) as separate balances or sections, you likely have a classic account. An UTA merges these into a single account.

Upgrading to UTA:

For information on how to upgrade your account to a UTA, please contact Bybit support. Often, this is a straightforward process that can be initiated by clicking an "Upgrade to UTA" button or prompt within the Bybit interface and typically takes only a couple of minutes.

1. You can access Bybit's API management page by logging into your account and navigating to https://www.bybit.com/app/user/api-management.

2. Click on create a New Key

3. Click on "System-generated API Keys"

4. On the next screen

Select API Transaction (1),
Give a name to the API Key (ex. "TWM") (2)
Select "Read-Write"
(Optional) Select "Only IP's…." and insert your IP address, to look up for your IP address, please go to https://whatismyipaddress.com/

5. Give the permission as shown in the image.

- "Unified Trading"

- "Orders"

- "Positions"

- "USDC Derivates Trading"

- "Trade"

These permissions are essential if you want to be able to trade from whitin the TWM software.

And finally, click "Submit" (5)

6. Copy Both the API and Secret Key

6. Paste them into TWM

Crypto.com

Supported Features

Please note that TWM currently supports only SPOT symbols for the Crypto.com connection.

API Key Requirements

To access public data such as historical information, order books, and live data streams from Crypto.com through TWM, you do not need to provide any credentials like an API key or secret.

However, if you wish to trade or receive updates on your user-specific data (like account balances or positions), you will need to create an API key within your Crypto.com account and configure it in TWM.

Creating Your API Key on Crypto.com

1. Navigate to the API Management section. You can typically find this by:

- Clicking on your account avatar (usually located in the top-right corner of the screen).

- Selecting the "Manage Account" option from the dropdown menu.

- Choosing the "API Management" tab.

2. Click on the option to "Create a new API key."

3. A modal window or new page will appear for configuring the API key permissions. Ensure you:

- Check the permission for "Can Read."

- Check the permission to "Enable Trading."

- You must whitelist your IP address for this API key as a security measure.

4. After the API key is successfully created on Crypto.com, make sure to copy your API Key and Secret Key.

- And paste them into TWM

Important Informations

Here are some general tips and important points to keep in mind when setting up and using connections in TWM:

Regional Availability & VPN Usage:

Before setting up a connection, please verify that the services of the chosen exchange are available in your geographical region. If access is restricted, you may need to use a VPN (Virtual Private Network).

Copying API Keys and Secrets:

When copying your API keys and secret keys, be meticulous. Ensure that you do not accidentally include any extra spaces (whitespace) before or after the actual key strings, as this will cause authentication to fail.

Initial Historical Data Download:

The first time you request data for a specific trading instrument (e.g., a currency pair like BTC/USDT) through TWM, the software will attempt to download all available historical data for that instrument from the exchange. This happens regardless of the specific time period you initially request. Please allow this comprehensive first download to complete fully before proceeding with further actions or analysis for that instrument.

Type of API Keys (System-Generated vs. Self-Generated):

During the API key creation process on an exchange, you might be asked to choose between system-generated or self-generated (e.g., HMAC vs. Ed25519) API keys. For TWM's purposes, either type is generally acceptable unless specified otherwise for a particular exchange. For details on the differences between these key types, please refer to the information provided by the exchange itself during the creation process.

Naming Your API Keys:

It's good practice to assign a descriptive name to your API keys when you create them on the exchange. While the specific name doesn't affect TWM's functionality, it helps you identify the key for your personal records and management. Some exchanges may even require you to name the key before you can proceed. Always pay attention to prompts and hints in the exchange's user interface to ensure all required fields are completed.

Troubleshooting Connection Issues & API Key Expiry:

If a connection that was previously working suddenly fails, and you've already ruled out IP address filtering as the cause, check the API key configuration settings on the exchange's website. Some exchanges issue API keys that have an expiration date. If your key has expired, you will need to generate a new one.

Understanding Connection Behavior:

Connections without API Keys: If you set up a connection in TWM without entering an API key and secret, TWM will still attempt to connect to the exchange to access public data (like market data feeds). However, you will not be able to execute trades or retrieve private account information (like balances or positions).

Connections with Incorrect/Expired API Keys:

If you do provide API keys but they are incorrect (e.g., mistyped, contain extra spaces) or have expired, the connection will fail. TWM will typically display a generic error message such as "Check your credentials."

Connections

Market Data