Skip to content

Hummingbot Documentation

Welcome to the official documentation for Hummingbot!

Hummingbot is an open source framework that helps you build crypto trading bots that run on both centralized exchanges (CEX), as well as decentralized exchanges (DEX) on various blockchain networks. Our codebase is free and publicly available on Github under the Apache 2.0 open source license.

Help us democratize high-frequency trading and provide free access to sophisticated algorithms and tooling to everyone!!

🐤 Getting started

New to Hummingbot? Start here!

  • Installation: Install Hummingbot on various platforms
  • Quickstart: Follow the new Quickstart guide to learn how to build a custom market making strategy with Hummingbot!
  • Features: The main commands and configs in Hummingbot

🎓 Learn with Botcamp

⭐ If you'd like to learn algo trading with Hummingbot, check out Hummingbot Botcamp, an intensive, small-batch bootcamp that teaches you how to build your own custom algo trading strategy in only 6 weeks. Each cohort of Botcamp culminates in a Demo Day where students present their custom scripts and compete for HBOT rewards and the glory of victory!

Many of the sample scripts in the /scripts/ folder were contributed by Botcamp students.

📺 Events

Each month, we livestream two community calls on our Discord server. Afterwards, we post recordings on our YouTube channel.

Check out the Foundation calendar for links to these monthly calls and other upcoming events.

Community calls

  • 1st Wednesday of the month, 2pm GMT / 10am EST / 7am PST / 10pm SIN
  • Release highlights, community demos, AMA

"How to" calls

  • 3rd Wednesday of the month, 2pm GMT / 10am EST / 7am PST / 10pm SIN
  • Developer-focused lessons that show you how to build or extend your strategies with Hummingbot.

👩‍💻 Hummingbot components

Hummingbot architecture features modular components that can be maintained and extended by individual community members:

  • Scripts: Python files that define various algorithmic trading strategies. Scripts are the recommended approach for new users to build strategies in Hummingbot.
  • Exchanges: Connectors to various centralized exchanges (CEX) and decentralized exchanges (DEX)
  • Chains: Connectors to various blockchain networks (for DEX connectors)
  • Strategies: Configurable templates for various algorithmic trading strategies. These were Hummingbot's original method of defining strategies and have been superceded by Scripts.

👩‍💻 For developers

Hummingbot is a general source framework for crypto algorithmic trading. We welcome developers to fork the codebase for their own purposes and contribute to the community.

  • Developers: Explanation of Hummingbot's architecture and detailed reference on how to build connectors and strategies
  • Bounties: Get paid for building and maintaining Hummingbot components connector middleware
  • Support Hummingbot!: How you can support our mission to democratize HFT!
  • Contribution Guidelines: Read this before submitting a pull request

👨‍👩‍👧‍👧 About us

Hummingbot Foundation is a not-for-profit foundation that facilitates decentralized maintenance and governance of the Hummingbot codebase, powered by the Hummingbot Governance Token (HBOT).

📬 Newsletter

Sign up for the official Hummingbot newsletter, which is published when each monthly release drops. The newsletter also contains Foundation news, upcoming events, and updates about contributions from the global Hummingbot community!

Get the Hummingbot newsletter

🙋‍♂️ Getting help

Hummingbot features an active, friendly community of users globally! Here are some ways to get help if you're encountering issues:

  • Check out the FAQ, Troubleshooting, and Glossary pages for answers to common questions about Hummingbot
  • To report a bug or request a new feature, post a Github issue.
  • Join the official Discord and post your question on #support

For users using Hummingbot to earn rewards on Miner, the decentralized market making platform operated by CoinAlpha, you can also access Miner support via the following methods:

  • Discord: CoinAlpha maintains 24/7 dedicated technical support for users on the #miner-support channel within the Hummingbot Discord server. They help users install Hummingbot and configure API keys for use with the Miner platform, investigates reports related to missing or duplicate rewards, and other issues.
  • Email: Send CoinAlpha support a message at support@hummingbot.io
  • Live chat: Click the chat widget in the lower right hand corner of the Miner website.

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