Skip to main content

Crypto Trading Bot

Project description


Build Status Coverage Status Documentation Maintainability

Freqtrade is a free and open source crypto trading bot written in Python. It is designed to support all major exchanges and be controlled via Telegram. It contains backtesting, plotting and money management tools as well as strategy optimization by machine learning.



This software is for educational purposes only. Do not risk money which you are afraid to lose. USE THE SOFTWARE AT YOUR OWN RISK. THE AUTHORS AND ALL AFFILIATES ASSUME NO RESPONSIBILITY FOR YOUR TRADING RESULTS.

Always start by running a trading bot in Dry-run and do not engage money before you understand how it works and what profit/loss you should expect.

We strongly recommend you to have coding and Python knowledge. Do not hesitate to read the source code and understand the mechanism of this bot.

Exchange marketplaces supported


We invite you to read the bot documentation to ensure you understand how the bot is working.

Please find the complete documentation on our website.


  • [x] Based on Python 3.6+: For botting on any operating system - Windows, macOS and Linux.
  • [x] Persistence: Persistence is achieved through sqlite.
  • [x] Dry-run: Run the bot without playing money.
  • [x] Backtesting: Run a simulation of your buy/sell strategy.
  • [x] Strategy Optimization by machine learning: Use machine learning to optimize your buy/sell strategy parameters with real exchange data.
  • [x] Edge position sizing Calculate your win rate, risk reward ratio, the best stoploss and adjust your position size before taking a position for each specific market. Learn more.
  • [x] Whitelist crypto-currencies: Select which crypto-currency you want to trade or use dynamic whitelists.
  • [x] Blacklist crypto-currencies: Select which crypto-currency you want to avoid.
  • [x] Manageable via Telegram: Manage the bot with Telegram.
  • [x] Display profit/loss in fiat: Display your profit/loss in 33 fiat.
  • [x] Daily summary of profit/loss: Provide a daily summary of your profit/loss.
  • [x] Performance status report: Provide a performance status of your current trades.

Quick start

Freqtrade provides a Linux/macOS script to install all dependencies and help you to configure the bot.

git clone
cd freqtrade
git checkout develop
./ --install

For any other type of installation please refer to Installation doc.

Basic Usage

Bot commands

usage: freqtrade [-h] [-v] [--logfile FILE] [--version] [-c PATH] [-d PATH]
                 [-s NAME] [--strategy-path PATH] [--dynamic-whitelist [INT]]
                 [--db-url PATH] [--sd-notify]
                 {backtesting,edge,hyperopt} ...

Free, open source crypto trading bot

positional arguments:
    backtesting         Backtesting module.
    edge                Edge module.
    hyperopt            Hyperopt module.

optional arguments:
  -h, --help            show this help message and exit
  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
  --logfile FILE        Log to the file specified
  --version             show program's version number and exit
  -c PATH, --config PATH
                        Specify configuration file (default: None). Multiple
                        --config options may be used.
  -d PATH, --datadir PATH
                        Path to backtest data.
  -s NAME, --strategy NAME
                        Specify strategy class name (default:
  --strategy-path PATH  Specify additional strategy lookup path.
  --dynamic-whitelist [INT]
                        Dynamically generate and update whitelist based on 24h
                        BaseVolume (default: 20). DEPRECATED.
  --db-url PATH         Override trades database URL, this is useful if
                        dry_run is enabled or in custom deployments (default:
  --sd-notify           Notify systemd service manager.

Telegram RPC commands

Telegram is not mandatory. However, this is a great way to control your bot. More details and the full command list on our documentation

  • /start: Starts the trader
  • /stop: Stops the trader
  • /status [table]: Lists all open trades
  • /count: Displays number of open trades
  • /profit: Lists cumulative profit from all finished trades
  • /forcesell <trade_id>|all: Instantly sells the given trade (Ignoring minimum_roi).
  • /performance: Show performance of each finished trade grouped by pair
  • /balance: Show account balance per currency
  • /daily <n>: Shows profit or loss per day, over the last n days
  • /help: Show help message
  • /version: Show version

Development branches

The project is currently setup in two main branches:

  • develop - This branch has often new features, but might also cause breaking changes.
  • master - This branch contains the latest stable release. The bot 'should' be stable on this branch, and is generally well tested.
  • feat/* - These are feature branches, which are being worked on heavily. Please don't use these unless you want to test a specific feature.


Help / Slack

For any questions not covered by the documentation or for further information about the bot, we encourage you to join our slack channel.

Bugs / Issues

If you discover a bug in the bot, please search our issue tracker first. If it hasn't been reported, please create a new issue and ensure you follow the template guide so that our team can assist you as quickly as possible.

Feature Requests

Have you a great idea to improve the bot you want to share? Please, first search if this feature was not already discussed. If it hasn't been requested, please create a new request and ensure you follow the template guide so that it does not get lost in the bug reports.

Pull Requests

Feel like our bot is missing a feature? We welcome your pull requests!

Please read our Contributing document to understand the requirements before sending your pull-requests.

Coding is not a neccessity to contribute - maybe start with improving our documentation? Issues labeled good first issue can be good first contributions, and will help get you familiar with the codebase.

Note before starting any major new feature work, please open an issue describing what you are planning to do or talk to us on Slack. This will ensure that interested parties can give valuable feedback on the feature, and let others know that you are working on it.

Important: Always create your PR against the develop branch, not master.


Uptodate clock

The clock must be accurate, syncronized to a NTP server very frequently to avoid problems with communication to the exchanges.

Min hardware required

To run this bot we recommend you a cloud instance with a minimum of:

  • Minimal (advised) system requirements: 2GB RAM, 1GB disk space, 2vCPU

Software requirements

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for freqtrade, version 2020.1
Filename, size File type Python version Upload date Hashes
Filename, size freqtrade-2020.1-py3-none-any.whl (192.9 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size freqtrade-2020.1.tar.gz (161.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page