Hummingbot

Hummingbot is an open-source framework that helps you design and deploy automated trading strategies, or bots, that can run on many centralized or decentralized exchanges. Over the past year, Hummingbot users have generated over $34 billion in trading volume across 140+ unique trading venues.

The Hummingbot codebase is free and publicly available under the Apache 2.0 open-source license. Our mission is to democratize high-frequency trading by creating a global community of algorithmic traders and developers that share knowledge and contribute to the codebase.

Quick Links

Website and Docs: Official Hummingbot website and documentation
Installation: Install Hummingbot on various platforms
Discord: The main gathering spot for the global Hummingbot community
YouTube: Videos that teach you how to get the most out of Hummingbot
Twitter: Get the latest announcements about Hummingbot
Reported Volumes: Reported trading volumes across all Hummingbot instances
Newsletter: Get our newsletter whenever we ship a new release

Getting Started

The easiest way to get started with Hummingbot is using Docker:

To install the Telegram Bot Condor, follow the instructions in the Hummingbot Docs site.
To install the CLI-based Hummingbot client, follow the instructions below.

Alternatively, if you are building new connectors/strategies or adding custom code, see the Install from Source section in the documentation.

Install Hummingbot with Docker

Install Docker Compose website.

Clone the repo and use the provided docker-compose.yml file:

# Clone the repository
git clone https://github.com/hummingbot/hummingbot.git
cd hummingbot

# Run Setup & Deploy
make setup
make deploy

# Attach to the running instance
docker attach hummingbot

Install Hummingbot + Gateway DEX Middleware

Gateway provides standardized connectors for interacting with automatic market maker (AMM) decentralized exchanges (DEXs) across different blockchain networks.

To run Hummingbot with Gateway, clone the repo and answer y when prompted after running make setup

# Clone the repository
git clone https://github.com/hummingbot/hummingbot.git
cd hummingbot

make setup

# Answer `y` when prompted
Include Gateway? [y/N]

Then run:

make deploy

# Attach to the running instance
docker attach hummingbot

By default, Gateway will start in development mode with unencrypted HTTP endpoints. To run in production model with encrypted HTTPS, use the DEV=false flag and run gateway generate-certs in Hummingbot to generate the certificates needed. See Development vs Production Modes for more information.

For comprehensive installation instructions and troubleshooting, visit our Installation documentation.

Getting Help

If you encounter issues or have questions, here's how you can get assistance:

Consult our FAQ, Troubleshooting Guide, or Glossary
To report bugs or suggest features, submit a Github issue
Join our Discord community and ask questions in the #support channel

We pledge that we will not use the information/data you provide us for trading purposes nor share them with third parties.

Exchange Connectors

Hummingbot connectors standardize REST and WebSocket API interfaces to different types of exchanges, enabling you to build sophisticated trading strategies that can be deployed across many exchanges with minimal changes.

Connector Types

We classify exchange connectors into three main categories:

CLOB CEX: Centralized exchanges with central limit order books that take custody of your funds. Connect via API keys.
- Spot: Trading spot markets
- Perpetual: Trading perpetual futures markets
CLOB DEX: Decentralized exchanges with on-chain central limit order books. Non-custodial, connect via wallet keys.
- Spot: Trading spot markets on-chain
- Perpetual: Trading perpetual futures on-chain
AMM DEX: Decentralized exchanges using Automated Market Maker protocols. Non-custodial, connect via Gateway middleware.
- Router: DEX aggregators that find optimal swap routes
- AMM: Traditional constant product (x*y=k) pools
- CLMM: Concentrated Liquidity Market Maker pools with custom price ranges

Exchange Sponsors

We are grateful for the following exchanges that support the development and maintenance of Hummingbot via broker partnerships and sponsorships.

| Exchange | Type | Sub-Type(s) | Connector ID(s) | Discount | |------|------|------|-------|----------| | Binance | CLOB CEX | Spot, Perpetual | binance, binance_perpetual | | | BitMart | CLOB CEX | Spot, Perpetual | bitmart, bitmart_perpetual | | | Bitget | CLOB CEX | Spot, Perpetual | bitget, bitget_perpetual | | | Derive | CLOB DEX | Spot, Perpetual | derive, derive_perpetual | | | dYdX | CLOB DEX | Perpetual | dydx_v4_perpetual | - | | Gate.io | CLOB CEX | Spot, Perpetual | gate_io, gate_io_perpetual | | | HTX (Huobi) | CLOB CEX | Spot | htx | | | Hyperliquid | CLOB DEX | Spot, Perpetual | hyperliquid, hyperliquid_perpetual | - | | KuCoin | CLOB CEX | Spot, Perpetual | kucoin, kucoin_perpetual | | | OKX | CLOB CEX | Spot, Perpetual | okx, okx_perpetual | | | XRP Ledger | CLOB DEX | Spot | xrpl | - |

Other Exchange Connectors

Currently, the master branch of Hummingbot also includes the following exchange connectors, which are maintained and updated through the Hummingbot Foundation governance process. See Governance for more information.

| Exchange | Type | Sub-Type(s) | Connector ID(s) | Discount | |------|------|------|-------|----------| | 0x Protocol | AMM DEX | Router | 0x | - | | AscendEx | CLOB CEX | Spot | ascend_ex | - | | Balancer | AMM DEX | AMM | balancer | - | | BingX | CLOB CEX | Spot | bing_x | - | | Bitrue | CLOB CEX | Spot | bitrue | - | | Bitstamp | CLOB CEX | Spot | bitstamp | - | | BTC Markets | CLOB CEX | Spot | btc_markets | - | | Bybit | CLOB CEX | Spot, Perpetual | bybit, bybit_perpetual | - | | [Coinbase](https://hummi