Skip to content

The Hummingbot Client

Hummingbot uses a command-line interface (CLI) that helps users configure and run the bot, as well as generate logs of the trades performed.

Starting Hummingbot

Installed from Docker

Creating a new instance of Hummingbot with docker run will automatically start the Hummingbot client (see Docker installation guides for Windows and MacOS).

To run a previously created, stopped container where $NAME is the name of your instance of Hummingbot:

1
docker start $NAME && docker attach $NAME

For additional information on useful commands, see the cheatsheet to running Hummingbot on Docker.

Installed from Source

Note

Make sure that you activate the Anaconda environment with conda activate hummingbot prior to running Hummingbot.

Open a Terminal window and go to the root of the directory that contains Hummingbot. From there, run:

1
bin/hummingbot.py

User Interface

Client Layout

Hummingbot CLI

The CLI is divided into three panes:

  • Input pane (lower left): where users enter commands
  • Output pane (upper left): prints the output of the user's commands
  • Log pane (right): log messages
Command Function
help Prints a list of available commands.
start Starts the bot. If any configuration settings are missing, it will automatically prompt you for them.
config Configures or, if a bot is already running, re-configures the bot.
status Get a status report about the current bot status.
list List wallets, exchanges, configs, and completed trades.

Example usage: list [wallets|exchanges|configs|trades]
get_balance Get the balance of an exchange or wallet, or get the balance of a specific currency in an exchange or wallet.

Example usage: get_balance [-c WETH -w|-c ETH -e binance] to show available WETH balance in the Ethereum wallet and ETH balance in Binance, respectively.
exit Cancels all orders, saves the log, and exits Hummingbot.
exit -f Force quit without cancelling orders.
stop Cancels all outstanding orders and stops the bot.
export_private_key Print your ethereum wallet private key.
history Print bot's past trades and performance analytics. For an explanation of how Hummingbot calculates profitability, see our blog here.
export_trades Export your trades to a csv file.
Command Description
bounty --register Register to participate in for liquidity bounties
bounty --status See your accumulated rewards
bounty --terms See the terms & conditions