Hummingbot Documentation

Welcome to the official documentation site for Hummingbot!

Warning: Beta Software

Hummingbot is experimental, open source software that is still in beta, and you use it at your own risk. Please review the Apache 2.0 license.

What is Hummingbot?

Hummingbot is open source software that helps you create, configure and manage high-frequency market making and arbitrage bots that run on both centralized and decentralized crypto exchanges.

How the documentation is organized

  • General: For new users. Learn about how Hummingbot works, install the software, and quickly start running your first bot
  • User Manual: For experienced users who want to get the most of Hummingbot
  • Liquidity Mining: How to earn rewards by running a market making bot for your favorite tokens and exchanges
  • Developer Manual: For developers looking to contribute to Hummingbot or extend its capabilities
  • Release Notes: New features, bug fixes, and other updates from our bi-weekly releases

First steps

New to Hummingbot? Here are some helpful links to get you started!

  • FAQ: Answers to frequently asked questions
  • Whitepaper: Overview about Hummingbot, its strategies, and the technical architecture
  • Quickstart: Guide that walks you through how to install and run Hummingbot

Get help

  • Cheatsheets: Quick reference for common Hummingbot commands
  • Support: Various ways to get support in using Hummingbot
  • Troubleshooting: Common issues and how to resolve them
  • 中文 Github repo: General information about Hummingbot, translated into Mandarin Chinese