> For the complete documentation index, see [llms.txt](https://docs.thevolumeterminal.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.thevolumeterminal.com/exchange-connections/api-key-setup.md).

# API Key Setup

To track your trading volume and achievements, you must connect your exchange account using an API key. Below are detailed, step-by-step setup guides for each supported exchange.

***

### General Connection Settings

When creating your API keys, always apply the following parameters:

1. **Permissions**: **Strictly Read-Only** (to sync trade history). Do not check any trade, write, execution, or withdrawal permissions.
2. **Withdrawals**: **Strictly Disabled / Unchecked**.
3. **Passphrase**: OKX, KuCoin, and Bitget require you to set an API Passphrase during key creation. You will need to enter this passphrase on Volume Terminal to complete the connection.

***

### Exchange-Specific Guides

#### BingX

* **Sign-Up Link**: [Create BingX Account](https://bingx.com/en-us/register/?ref=MIREN) (Referral: `MIREN`)
* **API Page**: [BingX API Management](https://bingx.com/en-us/account/api/)
* **Instructions**:
  1. Log in and navigate to the API Management page.
  2. Click **Create API**.
  3. Enter `Volume Terminal` in the Label field.
  4. Check only the **Read** permission box.
  5. Complete the security verification codes.
  6. Copy the API Key and Secret.

#### Bybit

* **Sign-Up Link**: [Create Bybit Account](https://www.bybit.com/register?affiliate_id=MIREN) 
* **API Page**: [Bybit API Management](https://www.bybit.com/app/user/api-management)
* **Instructions**:
  1. Log in and navigate to API Management.
  2. Click **Create New Key** :arrow\_forward: select **System-generated API Keys**.
  3. Set the API key usage to "API Transactions".
  4. Name the key `Volume Terminal`.
  5. Select **Read-Only** permissions, ensuring **Spot** and **Derivatives** are checked as read-only/query.
  6. Verify that **Withdrawals** are disabled.
  7. Save and copy your API Key and API Secret. *(Note: Bybit also supports OAuth connection for simplified linking).*

#### Binance

* **Sign-Up Link**: [Create Binance Account](https://www.binance.com/en/activity/referral-entry?fromActivityPage=true\&ref=LIMIT_MIREN) 
* **API Page**: [Binance API Management](https://www.binance.com/en/my/settings/api-management)
* **Instructions**:
  1. Log in and go to API Management.
  2. Click **Create API** :arrow\_forward: select **System-Generated**.
  3. Label your key `Volume Terminal`.
  4. Ensure only **Enable Reading** is checked. Do not enable trading, futures, or write permissions.
  5. Confirm that **Enable Withdrawals** is unchecked.
  6. Copy your API Key and Secret.

#### OKX

* **Sign-Up Link**: [Create OKX Account](https://www.okx.com/join/MIREN) 
* **API Page**: [OKX API Keys](https://www.okx.com/account/my-api)
* **Instructions**:
  1. Log in and open the API page.
  2. Click **Create V5 API Key**.
  3. Enter `Volume Terminal` as the API name.
  4. **Set an API Passphrase**. *You must remember this passphrase, as you will need to input it on Volume Terminal.*
  5. Select **Read** only. Ensure **Withdrawal** is disabled.
  6. Copy your API Key, Secret, and keep your Passphrase ready.

#### KuCoin

* **Sign-Up Link**: [Create KuCoin Account](https://www.kucoin.com/ucenter/signup?rcode=MIREN) 
* **API Page**: [KuCoin API Management](https://www.kucoin.com/account/api)
* **Instructions**:
  1. Log in and navigate to API Management.
  2. Click **Create API** $\rightarrow$ select **API Trade/Read**.
  3. Name your API key and **create an API Passphrase**.
  4. Select **General (Read-only)** permissions. Do not select Trade.
  5. Complete security verification and copy the API Key, Secret, and Passphrase.

#### Bitget

* **Sign-Up Link**: [Create Bitget Account](https://www.bitget.com/en/referral/register?clacCode=MIREN) 
* **API Page**: [Bitget API Management](https://www.bitget.com/account/newapi)
* **Instructions**:
  1. Log in and go to the API Keys section.
  2. Click **Create New API** $\rightarrow$ select **System-generated API Key**.
  3. Enter a note (e.g., `Volume Terminal`) and **set a Passphrase**.
  4. Check only **Read-only** permissions. Check that Withdraw is disabled.
  5. Complete 2FA and copy the Key, Secret, and Passphrase.

#### Gate.io

* **Sign-Up Link**: [Create Gate.io Account](https://www.gate.io/signup/MIREN) 
* **API Page**: [Gate.io API Keys](https://www.gate.io/myaccount/api_keys)
* **Instructions**:
  1. Log in and visit the API Key management page.
  2. Click **Create API Key** and select **API v4 Key**.
  3. Set the label to `Volume Terminal`.
  4. Assign **Read-only** permissions to the Spot and/or Contract sections.
  5. Complete security checks and copy the Key and Secret.

#### Kraken

* **Sign-Up Link**: [Create Kraken Account](https://www.kraken.com/sign-up)
* **API Page**: [Kraken API Settings](https://www.kraken.com/u/settings/api)
* **Instructions**:
  1. Log in and open API settings in your security profile.
  2. Click **Generate New Key**.
  3. Set the description to `Volume Terminal`.
  4. Check **Query Funds** and **Query Closed Orders** only. Do not check Modify Orders or other execution permissions.
  5. Copy your API Key and Private Key.

#### Coinbase

* **Sign-Up Link**: [Create Coinbase Account](https://www.coinbase.com/signup)
* **API Page**: [Coinbase API Settings](https://www.coinbase.com/settings/api)
* **Instructions**:
  1. Log in and navigate to the API settings page.
  2. Click **Create API Key** (or use OAuth login if prompted).
  3. Ensure only the **view** permission is enabled for your wallets and trading portfolios.
  4. Copy your API Key and Secret.

#### Crypto.com

* **Sign-Up Link**: [Create Crypto.com Account](https://crypto.com/exchange/signup?ref=MIREN) 
* **API Page**: [Crypto.com API Settings](https://crypto.com/exchange/user/settings/api-management)
* **Instructions**:
  1. Log in to the exchange and go to settings.
  2. Click **Create a new API Key**.
  3. Complete security checks and 2FA.
  4. Set the permission to **Read-only** only.
  5. Copy the API Key and Secret.

#### MEXC

* **Sign-Up Link**: [Create MEXC Account](https://www.mexc.com/acquisition/custom-sign-up?shareCode=mexc-3ukKf) 
* **API Page**: [MEXC API Management](https://www.mexc.com/user/api)
* **Instructions**:
  1. Log in and navigate to the API management page.
  2. Click **Create API**.
  3. Enter a name for the key.
  4. Ensure only **Read-only** permissions are checked.
  5. Copy your API Key and Secret.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.thevolumeterminal.com/exchange-connections/api-key-setup.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.