0% found this document useful (0 votes)
4 views

api-key-guide

This document provides a comprehensive guide for creating read-only API keys across various cryptocurrency exchanges, including Binance, KuCoin, Bybit, and others. It emphasizes the importance of not sharing write-access keys and outlines specific steps to create the keys while ensuring permissions are set correctly to prevent unauthorized trading or withdrawals. Each exchange has detailed instructions for logging in, navigating to API management, creating the key, setting permissions, and securely storing the keys.

Uploaded by

hilmidemiraslan
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
4 views

api-key-guide

This document provides a comprehensive guide for creating read-only API keys across various cryptocurrency exchanges, including Binance, KuCoin, Bybit, and others. It emphasizes the importance of not sharing write-access keys and outlines specific steps to create the keys while ensuring permissions are set correctly to prevent unauthorized trading or withdrawals. Each exchange has detailed instructions for logging in, navigating to API management, creating the key, setting permissions, and securely storing the keys.

Uploaded by

hilmidemiraslan
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 8

Read-Only API Key Retrieval Guide

Important Please Read First

- You are creating a read-only API key, which allows others to view your account activity but
not make any changes or withdrawals.
- NEVER SHARE write-access API keys. These can allow someone to control your funds.
Always double-check the permissions while creating the key.
- Follow these steps carefully for each exchange.

1. Binance
1. Log In: Access your Binance account on the official website or app.
2. Navigate to API Management:
○ Click your profile icon and select API Management.
3. Enable 2FA (if not already enabled):
○ Set up either Google Authenticator or SMS authentication in the Security
settings.
4. Select ‘System-generated API keys’
5. Create API Key:
○ Enter a name for the key (e.g., “Read-Only Key”).
○ Click Create API and complete the 2FA verification (e.g., Google Authenticator and
email confirmation).
6. Set Permissions:
○ Allow access to:
■ Balances and Account Info: To view holdings and transaction history.
■ Trade History: To see completed trades.
■ Deposit and Withdrawal History: To check deposits and withdrawals.
○ Do not enable permissions for trading or withdrawals.
7. Save the API Key:
○ Copy and store the API key and secret key securely.
8. Share Safely: Provide only the API key and secret key. Never share permissions for trading
or withdrawals.

Source: Binance API Documentation

2. KuCoin
1. Log In: Access your KuCoin account.
2. Navigate to API Management: Click your profile icon and select API Management.
3. Create API Key:
○ Click Create API and name the key (e.g., "Read-Only Key").
○ Set a passphrase as required.
4. Set Permissions:
○ Allow access to:
■ ‘General’ only
■ Balances and Account Info: To see your holdings and transaction details.
■ Trade History: To view all completed trades.
■ Deposit and Withdrawal History: To check your deposits and withdrawals.
○ Do not enable permissions for ‘Trade’ or ‘Transfer’.
5. Input your Trading Password and 2FA code
6. Save the API Key: Store the API key, secret, and passphrase securely.
7. Share Safely: Provide only the API key, secret key and passphrase. Do not share
permissions for trading or withdrawals.

Source: KuCoin API Documentation

3. Bybit
1. Log In: Access your Bybit account.
2. Navigate to API Management: Click on the ‘Profile’ icon > API.
3. Create API Key:
○ Click Create New Key on the API management page and name it (e.g., "Read-Only
Key").
○ Select ‘System-generated API keys’
4. Set Permissions:
○ Set permissions to ‘Read’ only and NOT ‘Read-Write’
○ Allow access to:
■ ‘Unified Trading’ and ‘Spot’
■ Balances and Account Info: To view your holdings and transaction history.
■ Trade History: To see all your completed trades.
■ Deposit and Withdrawal History: To view deposits and withdrawals.
○ Do not enable permissions for trading or withdrawals.
5. Save the API Key: Store the API key and secret key securely.
6. Share Safely: Provide only the API key and secret key. Do not share permissions for trading
or withdrawals.

Source: Bybit API Documentation

4. OKX
1. Log In: Access your OKX account.
2. Navigate to API Management: Click your profile icon and select API Keys.
3. Create API Key:
○ Click Create New API Key, set a name (e.g., "Read-Only Key"), and create a
passphrase.
4. Set Permissions:
○ Allow access to:
■ Balances and Account Info: To view holdings and transaction history.
■ Trade History: To view completed trades.
■ Deposit and Withdrawal History: To see deposits and withdrawals.
○ Do not enable permissions for trading or withdrawals.
5. Save the API Key: Store the API key, secret key, and passphrase securely.
6. Share Safely: Provide only the API keysecret key and passphrase. Do not share
permissions for trading or withdrawals.

Source: OKX API Documentation

5. Gate.io
1. Log In: Access your Gate.io account.
2. Navigate to API Management: Go to Security Settings > API Keys.
3. Create API Key:
○ Click Create API Key and name it (e.g., "Read-Only Key").
4. Set Permissions:
○ Allow access to:
■ Balances and Account Info: To view holdings and transaction history.
■ Trade History: To see completed trades.
■ Deposit and Withdrawal History: To check deposits and withdrawals.
○ Do not enable permissions for trading or withdrawals.
5. Save the API Key: Store the API key and secret key securely.
6. Share Safely: Provide only the API key and secret key. Do not share permissions for trading
or withdrawals.

Source: Gate.io API Documentation

6. Bitfinex
1. Log In: Access your Bitfinex account.
2. Navigate to API Management: Go to API Keys under Account Settings.
3. Create API Key:
○ Click Create New API Key and name it (e.g., "Read-Only Key").
4. Set Permissions:
○ Allow access to:
■ Balances and Account Info: To view holdings and transaction details.
■ Trade History: To check completed trades.
■ Deposit and Withdrawal History: To see deposits and withdrawals.
○ Do not enable permissions for trading or withdrawals.
5. Save the API Key: Store the API key and secret key securely.
6. Share Safely: Provide only the API key and secret key. Do not share permissions for trading
or withdrawals.

Source: Bitfinex API Documentation

7. Crypto.com
1. Log In: Access your Crypto.com Exchange account.
2. Navigate to API Management: Go to Settings > API Keys.
3. Create API Key:
○ Click Create New API Key and name it (e.g., "Read-Only Key").
4. Set Permissions:
○ Allow access to:
■ Balances and Account Info: To view your holdings and transaction details.
■ Trade History: To see all completed trades.
■ Deposit and Withdrawal History: To check deposits and withdrawals.
○ Do not enable permissions for trading or withdrawals.
5. Save the API Key: Store the API key and secret key securely.
6. Share Safely: Provide only the API key and secret key. Do not share permissions for trading
or withdrawals.

Source: Crypto.com API Documentation

8. MEXC
1. Log In: Access your MEXC account.
2. Navigate to API Management: Go to Account Settings > API Keys.
3. Create API Key:
○ Click Create New API Key and name it (e.g., "Read-Only Key").
4. Set Permissions:
○ Allow access to:
■ Balances and Account Info: To view your holdings and transaction details.
■ Trade History: To see all completed trades.
■ Deposit and Withdrawal History: To check deposits and withdrawals.
○ Do not enable permissions for trading or withdrawals.
5. Save the API Key: Store the API key and secret key securely.
6. Share Safely: Provide only the API key and secret key. Do not share permissions for trading
or withdrawals.
9. Bitget
1. Log In: Access your Bitget account.
2. Navigate to API Management: Go to Settings > API Keys.
3. Create API Key:
○ Click Create API Key and name it (e.g., "Read-Only Key").
4. Set Permissions:
○ Allow access to:
■ Balances and Account Info: To view your holdings and transaction details.
■ Trade History: To see all completed trades.
■ Deposit and Withdrawal History: To check deposits and withdrawals.
○ Do not enable permissions for trading or withdrawals.
5. Save the API Key: Store the API key, secret key and passphrase securely.
6. Share Safely: Provide only the API key secret key and passphrase. Do not share
permissions for trading or withdrawals.

10. Huobi
1. Log In: Access your Huobi account.
2. Navigate to API Management: Go to Account Settings > API Keys.
3. Create API Key:
○ Click Create New API Key and name it (e.g., "Read-Only Key").
4. Set Permissions:
○ Allow access to:
■ Balances and Account Info: To view your holdings and transaction details.
■ Trade History: To see all completed trades.
■ Deposit and Withdrawal History: To check deposits and withdrawals.
○ Do not enable permissions for trading or withdrawals.
5. Save the API Key: Store the API key and secret key securely.
6. Share Safely: Provide only the API key and secret key. Do not share permissions for trading
or withdrawals.

11. OKCoin
1. Log In: Access your OKCoin account.
2. Navigate to API Management: Go to Settings > API Keys.
3. Create API Key:
○ Click Create New API Key and name it (e.g., "Read-Only Key").
4. Set Permissions:
○ Allow access to:
■ Balances and Account Info: To view your holdings and transaction details.
■ Trade History: To see all completed trades.
■ Deposit and Withdrawal History: To check deposits and withdrawals.
○ Do not enable permissions for trading or withdrawals.
5. Save the API Key: Store the API key and secret key securely.
6. Share Safely: Provide only the API key and secret key. Do not share permissions for trading
or withdrawals.

12. Bithumb
1. Log In: Access your Bithumb account.
2. Navigate to API Management: Go to Account Settings > API Keys.
3. Create API Key:
○ Click Create New API Key and name it (e.g., "Read-Only Key").
4. Set Permissions:
○ Allow access to:
■ Balances and Account Info: To view your holdings and transaction details.
■ Trade History: To see all completed trades.
■ Deposit and Withdrawal History: To check deposits and withdrawals.
○ Do not enable permissions for trading or withdrawals.
5. Save the API Key: Store the API key and secret key securely.
6. Share Safely: Provide only the API key and secret key. Do not share permissions for trading
or withdrawals.

13. Gemini
1. Log In: Access your Gemini account by visiting Gemini.com and signing in.
2. Navigate to API Management:
• Click on your profile (or Account) icon.
• Select “API” from the dropdown or navigate to the API settings page.
3. Create a New API Key:
• Click the button to “Create New API Key.”
• Provide a descriptive name (e.g., “Read-Only Key”).
4. Set Permissions:
• In the permissions settings, enable only those options that allow you to:
i. View Balances & Account Information
ii. Access Trade History
iii. View Deposit & Withdrawal History
• Do not enable permissions for trading or withdrawals.
5. Complete Verification:
• Complete any additional security steps (e.g., two-factor authentication) as prompted
by Gemini.
6. Save Your API Key:
• Once generated, copy and securely store the API key and secret.
• Do not share your secret or any key with trading/withdrawal permissions.
14. Binance.US
1. Log In: Sign in to your Binance.US account at Binance.US.
2. Navigate to API Management:
o Click your profile icon in the upper right-hand corner.
o Select “API Management” from the menu.
3. Create API Key:
o Enter a name for your new API key (for example, “Read-Only Key”).
o Click “Create API Key.”
o Complete any two-factor authentication (2FA) steps required.
4. Set Permissions:
o In the permissions settings, enable only those options that allow:
o Viewing Balances & Account Information
o Accessing Trade History
o Checking Deposit & Withdrawal History
o Do not enable any trading or withdrawal options.
5. Save the API Key:
o Copy the generated API key (and secret if provided) and store them securely.
o Never share any key that provides write-access.

15. Bittrex
1. Log In: Sign in to your Bittrex account by visiting Bittrex.com.
2. Navigate to API Settings:
• Click on your account icon and select “API Keys” or navigate to the API management
section under Account Settings.
3. Create a New API Key:
o Click on “Add API Key” (or a similar button).
o Provide a name (e.g., “Read-Only Key”).
4. Configure Permissions:
o Set the permissions to allow only read-only access, which should include:
o Viewing Balances & Account Information
o Accessing Trade/Order History
o Viewing Deposit & Withdrawal History
o Ensure that trading and withdrawal permissions are not enabled.
5. Finalize and Save:
• Complete any security verifications (such as 2FA) required by Bittrex.
• Save your API key and secret securely.
• Do not share keys with elevated permissions.

16. Kraken
1. Log In: Sign in to your account by visiting kraken.com
2. Navigate to API Settings:
• Located at https://pro.kraken.com/app/settings/api
• Or nagivate from your Profile Settings
3. Create an New API Key:
• Provide a name
• Set the following permissions:
i. Funds permissions – Query
ii. Orders and trades - Query open orders & trades
iii. Orders and trades - Query closed orders & trades
iv. Data - Query ledger entries
v. Data - Export data
4. Finalize and Save:
• Complete any security verifications (such as 2FA).
• Save your API key and secret securely.
• Do not share keys with elevated permissions.

17. Coinbase
1. Log In: Sign in to your account by visiting coinbase.com
2. Navigate to API Settings:
a. Located at https://www.coinbase.com/settings/api
b. Or nagivate from your Profile Settings
3. Create an New API Key:
a. Provide a name
i. Select Default for Portfolio
ii. Check the “View (read-only)” checkbox
iii. Leave the rest of the checkboxes unchecked
iv. Leave the IP whitelist field empty
4. Finalize and Save:
a. Complete any security verifications (such as 2FA).
b. Save your API key and secret securely.
c. Do not share keys with elevated permissions.

What if my Exchange is not found on this list?


Please reach out to the support team of your centralised exchange for detailed instructions

You might also like