search

MontrealTradingGroup / freqtrade

Simple High Frequency Trading Bot for crypto currencies
GNU General Public License v3.0
70 stars 61 forks source link

readme

Freqtrade

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.

freqtrade

Disclaimer

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

Documentation

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.

Features

Quick start

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

sudo apt-get install git
git clone https://github.com/MontrealTradingGroup/freqtrade.git
cd freqtrade
sudo apt-get install make build-essential python3-dev
git checkout develop
./setup.sh --install
source .env/bin/activate
python3.6 ./freqtrade/main.py -c config.json

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

Basic Usage

Bot commands

usage: main.py [-h] [-v] [--version] [-c PATH] [-d PATH] [-s NAME]
               [--strategy-path PATH] [--customhyperopt NAME]
               [--dynamic-whitelist [INT]] [--db-url PATH]
               {backtesting,edge,hyperopt} ...

Free, open source crypto trading bot

positional arguments:
  {backtesting,edge,hyperopt}
    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)
  --version             show program\'s version number and exit
  -c PATH, --config PATH
                        specify configuration file (default: config.json)
  -d PATH, --datadir PATH
                        path to backtest data
  -s NAME, --strategy NAME
                        specify strategy class name (default: DefaultStrategy)
  --strategy-path PATH  specify additional strategy lookup path
  --customhyperopt NAME
                        specify hyperopt class name (default:
                        DefaultHyperOpts)
  --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:
                        None)

Telegram RPC commands

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

Development branches

The project is currently setup in two main branches:

A note on Binance

For Binance, please add "BNB/<STAKE>" to your blacklist to avoid issues. Accounts having BNB accounts use this to pay for fees - if your first trade happens to be on BNB, further trades will consume this position and make the initial BNB order unsellable as the expected amount is not there anymore.

Support

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.

Requirements

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:

Software requirements