Install Hummingbot

Hummingbot Academy

OverviewQuickstartLiquidity MiningCelo Arbitrage

Install Hummingbot

This is part 1 of the Hummingbot quickstart guide:

  1. Install Hummingbot
  2. Configure a market making bot
  3. Run your bot

System Requirements

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

Operating System

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

Memory

1 GB RAM per instance + 250 MB per additional instance

Storage

  • Install using Docker: 5 GB per instance
  • Install from source: 3 GB per instance
  • Downloadable installer: 3 GB per instance

Network

A stable internet connection is necessary to keeping Hummingbot connected to exchanges when a bot is running.

Tip: If you running Hummingbot on your local machine, make sure to turn off any sleep or energy-saving features that may terminate your network connection.

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.

Installation methods

For new users: We recommend that you download the installer (see below). This lets you try out Hummingbot in only a few minutes.

For experienced traders and developers: We recommend that you install the Docker version on a cloud instance to maximize performance and reliability. See Installation in the User Manual.

Windows

Download the Windows installer from our Downloads page, and click it to start the installation process.

Watch this video that shows you how to complete the installation process:

For more assistance, see this guide in the Hummingbot docs.

macOS

Download the macOS installer from our Downloads page, and click it to start the installation process.

Watch this video that shows you how to complete the installation process:

For more assistance, see this guide in the Hummingbot docs.

Linux/Docker

We recommend that serious users install the Docker version of Hummingbot, which is optimized for running multiple bot simultaenously.

Open a Terminal/Bash window and run the following comamnds. These comamnds download and run the Docker installation scripts.

# 1) Download Hummingbot install, start, and update script
wget https://raw.githubusercontent.com/CoinAlpha/hummingbot/development/installation/docker-commands/create.sh
wget https://raw.githubusercontent.com/CoinAlpha/hummingbot/development/installation/docker-commands/start.sh
wget https://raw.githubusercontent.com/CoinAlpha/hummingbot/development/installation/docker-commands/update.sh

# 2) Enable script permissions
chmod a+x *.sh

# 3) Create a hummingbot instance
./create.sh

Follow the script instructions to create a Hummingbot instance.

For more information about other installation options, see the Installation section of the Hummingbot docs.


After installing Hummingbot, you should see the Hummingbot interface:

Hummingbot CLI
Hummingbot CLI

Proceed to the next part of the Hummingbot quickstart guide: Configure a Market Making Bot

Top liquidity miner interview featuring Vik

· 61 min read

Top trader interview with Harry Yeh of Binary Fintech Group

· 4 min read

Top liquidity miner interview featuring Lorenzo Boyice

· 7 min read

Ask Me Anything: Zcoin

A conversation with Reuben Yap from Zcoin about Hummingbot, market makers, and liquidity mining

· 8 min read

Hummingbot

Home
24/7 Support

Liquidity Mining

Company

Community

Legal

© 2020 CoinAlpha, Inc.