Quickstart - Overview

  1. Overview
  2. Install Hummingbot
  3. Configure a market making bot
  4. Run the bot in paper trading mode


This guide shows you how to install Hummingbot and start running a market making bot (initially in paper trade) in approximately 10 minutes. You'll learn how to:

  • Install the open source Hummingbot client (~3 minutes)
  • Configure a market making bot (~5 minutes)
  • Run the bot in paper trading mode (~2 minutes)

Important: Once you are satisfied that the bot is running properly and you want to proceed with liquidity mining (go live). Ensure your Miner App is setup with the exchange APIs.

What you'll need

Since we'll be running the bot in paper trading mode, you don't need any crypto inventory. However, you will need an account with one of our supported exchanges to create API keys.

System Requirements

If you are installing Hummingbot either locally or on a cloud server, here are the recommended minimum system requirements:

  • Linux: Ubuntu 16.04 or later
  • MacOS: macOS 10.12.6 (Sierra) or later
  • Windows: Windows 10 or later

API Keys

In order to authorize Hummingbot to trade your assets, you will need to enter trade-enabled exchange API keys during the Hummingbot configuration process. Separately, if you would like to participate in Liquidity mining, you will need to provide read-only API keys in the Miner App

For more information on how to get the API keys for each exchange, please see the individual exchange pages in Connectors.

Ready to get started? Proceed to the first step: Install Hummingbot