Skip to content

Dashboard to monitor the performance of your Freqtrade instances

License

Notifications You must be signed in to change notification settings

ecoppen/freqdash

Repository files navigation

A python (3.11+) and Fastapi script to display a dashboard for your Freqtrade instances(s) via SSH.

GitHub Pipenv locked Python version License: GPL v3 FOSSA Status Code style: black

freqdash is a free and open source python (3.11+) script to display a dashboard for your Freqtrade instances(s). It is built on the FastApi framework and connects to local/remote Freqtrade instances via the paramiko SSH library before consuming the local API, storing the data and displaying everything on one dashboard. freqdash also has the ability to connect directly to Exchange APIs for price data and kline information.

Please note that freqdash is currently being developed alongside futuresboard v2 and is therefore a work in progress still

image

Features

  • Monitoring: Each freqtrade instance can be monitored centrally whether hosted locally or remotely
  • Charts: Profit/Loss, portfolio, kline with entries/exits charts available for each instance and exchange
  • Direct exchange data: Spot and futures pair prices and klines accessible directly from the exchange

Exchange support

Exchange Direct data News
Binance
Bybit
Gate.io
Kucoin
Okx

Quickstart

  • Clone the repo git clone https://github.com/ecoppen/freqdash.git
  • Navigate to the repo root cd freqdash
  • Navigate to the config folder cd config
  • Create the config file from template cp config.json.example config.json
  • Populate the config.json files as required using a text editor e.g. nano config.json
  • Navigate back to the repo root cd ..
  • Install pipenv pip install pipenv
  • Install required packages pipenv install
  • Activate the environment pipenv shell
  • Start the webserver in development mode uvicorn freqdash.main:app --reload

Developers

  • Install developer requirements from pipenv pipenv install --dev
  • Install pre-commit hooks pre-commit install

License

FOSSA Status