Connecting Exchange Accounts with API or Wallet Credentials

Summary

This guide explains how to connect a Hummingbot client to a centralized exchange or a blockchain protocol. Users run the connect command with the connector name, then enter the requested credentials. Exchanges generally ask for API keys, while blockchain protocols may require a private key; some connectors ask for extra account or address details. The guide says Hummingbot stores these credentials locally in encrypted form, using the client password as the key.

It recommends limiting exchange API permissions to reading account data and trading, and says deposit and withdrawal access is not needed for the client’s supported functions. Users can run the connection command again to inspect connector status. The interface distinguishes whether credentials have been added from whether the connection has been confirmed, and may show failures caused by network problems or invalid permissions. The guide covers setup and basic status checks, but does not detail connector-specific credential creation or broader key-management practices.

Key ideas

• Use the connect command followed by the exchange or protocol name to add credentials.
• Centralized exchanges typically require API credentials, while blockchain connections may require a private key.
• Hummingbot stores credentials locally in encrypted form using the client password as the key.
• The guide recommends enabling read and trade permissions without deposit or withdrawal access.
• Connection status separates credentials being present from a successful connection.

Tags

# Connecting to exchanges


The `connect` command lets you add your user credentials in order to connect to an exchange or protocol. For centralized exchanges, this command asks you for your API key, while blockchain protocols asks you for your private key.

Hummingbot stores both API keys and private keys on the local machine in encrypted form, with the Hummingbot client password as the key.

## Connecting to exchanges

1. Run `connect [exchange_name]` command e.g. `connect binance`
1. Enter API and secret keys when prompted
1. Other exchanges may require additional details such as account ID, exchange address, etc.

See [Exchanges](../exchanges/index.md) for more information about how to create API keys for each exchange.

!!! warning "Only enable Read and Trade access"
    For security reasons, Hummingbot does not support deposit and withdrawal functionality. Therefore, we recommend using only **read + trade** enabled API keys. It is not necessary to enable **withdraw**, **transfer**, or anything equivalent to retrieving assets from your wallet.

## Checking connection status

Run the `connect` command to view the status of each connector. It also shows failed connections due to connectivity issues, invalid API key permissions, etc.

![Alt text](../assets/img/connection-status.png)

**Keys Added** column indicates if API keys are added to Hummingbot.

**Keys Confirmed** column shows the status if Hummingbot has successfully connected to the exchange or protocol.

Shown in full with attribution under the source's licence. Licence: Apache-2.0

This summary was written by Stratmill's research agent from the original; it is not a copy of the source.