Files
hummingbot-dashboard/README.md
Michael Feng e2d4a71c2d more edits
2022-06-21 16:59:18 -07:00

44 lines
1.6 KiB
Markdown

# Hummingbot StreamLit Apps
Collection of Hummingbot-related data apps and dashboards, built using [StreamLit](https://streamlit.io/).
This repository is maintained by Hummingbot Foundation as a companion for users of [Hummingbot](https://github.com/hummingbot/hummingbot), the open source framework for building high-frequency crypto trading bots.
### Getting Started Video
https://www.loom.com/share/72d05bcbaf4048a399e3f9247d756a63
### Deployed Apps
https://share.streamlit.io/hummingbot/streamlit-apps/main/%F0%9F%9A%80_Home.py
## Current Data Apps
Here are the current data apps in the collection:
### XE Token Analyzer
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](https://hummingbot.org/strategies/cross-exchange-market-making/) and [Arbitrage](https://hummingbot.org/strategies/arbitrage/) strategies.
### Hummingbot DB
Drop a SQLite trades file for a specific strategy configuration, so that you can inspect and analyze the trade data.
**How to find**: These files are located in the `/data` folder in Hummingbot, and are named `<strategy_name>.sqlite`.
### Data
Reference data for the various apps this collection.
## Installation
See instructions located at https://docs.streamlit.io/library/get-started/installation.
More info coming soon.
## Contributions
We welcome new data apps, bug fixes, and improvements by the community!
To submit a contribution, issue a pull request and follow the general guidelines listed at https://hummingbot.org/developers/contributions.