Hummingbot Dashboard

Collection of data visualization and analysis Hummingbot-related dashboards. The dashboards helps you run and manage Hummingbot, analyze performance, analyze trade data, and much more!

Dashboard is built using StreamLit and uses the Conda environment & package manager to simiplify installation, updates, and manage dependencies.

You will need to install StreamLit. For information about Streamlit installation, see the instructions located at https://docs.streamlit.io/library/get-started/installation.

You will also need to install either Anaconda or Miniconda to get Conda:

• Anaconda is a comprehensive Python distribution that includes a large number of pre-installed data science libraries and packages. It is designed to be an all-in-one solution for data science and machine learning tasks. When you install Anaconda, it comes with a collection of popular Python packages like NumPy, pandas, matplotlib, scikit-learn, and more.
• Miniconda is a minimal version of Anaconda. It includes only the essential components, such as Python interpreter and Conda package manager. Unlike Anaconda, Miniconda doesn't come with pre-installed packages, which makes its download size much smaller.

This repository is maintained by Hummingbot Foundation as a companion for users of Hummingbot, the open source framework for building high-frequency crypto trading bots.

Watch this video to understand how it works: https://www.loom.com/share/72d05bcbaf4048a399e3f9247d756a63

Dashboards

Here are the current dashboards in the collection:

🚀 Strategy Performance (WIP)

Dashboard that helps you analyze the performance of a running Hummingbot instance

🧙 XE Token Analyzer

Dashboard that helps you visualize the bid-ask spread and volume of different tokens across the crypto exchange landscape.

This app is most helpful for Hummingbot users running the Cross-Exchange Market Making and Arbitrage strategies.

🧳 Hummingbot DB

Inspect and analyze the orders and trades data contained in a SQLite database for a strategy or script.

These files are located in the /data folder in Hummingbot, and are named <strategy_name>.sqlite.

🦉 TVL vs MCAP Analysis

Easily compare various DeFi protocols based on their market capitalization and total value locked, using DeFiLlama data.

🗂 Candles Downloader

Download historical exchange data as OHLVC candles. Supports multiple trading pairs and custom time ranges/intervals.

Current Hummingbot connectors supported:

• binance
• binance_perpetual

📋 Data

Reference data for the various apps this collection.

Installation

1. Install Steamlit and Conda packages utilizing their instructions for your specific environment:

• Install StreamLit
• Install Anaconda or Miniconda

2. Clone this repo and navigate to the created directory

git clone https://github.com/hummingbot/dashboard.git
cd dashboard

3. Run conda command to create an isolated conda environment and install dependencies

conda env create -f environment_conda.yml

4. Activate the isoldated 'conda' environment

conda activate dashboard

5. Run the app

streamlit run main.py

Data Feed

Your dashboard environment needs to have access to the database for your Hummingbot environment. This is done by setting up a symbolic link to the 'data' directory of your running Hummingbot instance.

The data directory differs for Docker versus Source installed Hummingbot. Data directory for each is as follows:

• Docker installed: /path/to/hummingbot/hummingbot_files/data
• Source installed: /path/to/hummingbot/data

Create a symlink to your Hummingbot /data directory

# replace `/path/to/hummingbotdata` with the actual path
ln -s /path/to/hummingbotdata data

# if you need to remove the symlink
unlink data

Updates

To update the dashboard environment for new dependencies, run:

conda env update -f environment_conda.yml

To updated the dashboard source for latest version, run:

cd dashboard
git pull

Contributions

We welcome new data dashboards, bug fixes, and improvements by the community!

To submit a contribution, fork a clone of repository, add or make changes, and issue a pull request. See general guidelines for contributing to Hummingbot listed at https://hummingbot.org/developers/contributions.

Participation

We hold bi-weekly livestream Dashboard project meetings. You can participate on our Discord

• Alternating Thursdays, 3pm GMT / 11am EST / 8am PST / 11pm SIN
• Design, Status, Demos, etc