Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/freqtrade/freqtrade

Free, open source crypto trading bot
https://github.com/freqtrade/freqtrade

algorithmic-trading bitcoin cryptocurrencies cryptocurrency freqtrade python telegram-bot trade trading-bot

Last synced: 5 days ago
JSON representation

Free, open source crypto trading bot

Awesome Lists containing this project

README 

        
# ![freqtrade](https://raw.githubusercontent.com/freqtrade/freqtrade/develop/docs/assets/freqtrade_poweredby.svg)



[![Freqtrade CI](https://github.com/freqtrade/freqtrade/workflows/Freqtrade%20CI/badge.svg)](https://github.com/freqtrade/freqtrade/actions/)

[![DOI](https://joss.theoj.org/papers/10.21105/joss.04864/status.svg)](https://doi.org/10.21105/joss.04864)

[![Coverage Status](https://coveralls.io/repos/github/freqtrade/freqtrade/badge.svg?branch=develop&service=github)](https://coveralls.io/github/freqtrade/freqtrade?branch=develop)

[![Documentation](https://readthedocs.org/projects/freqtrade/badge/)](https://www.freqtrade.io)

[![Maintainability](https://api.codeclimate.com/v1/badges/5737e6d668200b7518ff/maintainability)](https://codeclimate.com/github/freqtrade/freqtrade/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 or webUI. It contains backtesting, plotting and money management tools as well as strategy optimization by machine learning.



![freqtrade](https://raw.githubusercontent.com/freqtrade/freqtrade/develop/docs/assets/freqtrade-screenshot.png)



## 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.



## Supported Exchange marketplaces



Please read the [exchange specific notes](docs/exchanges.md) to learn about eventual, special configurations needed for each exchange.



- [X] [Binance](https://www.binance.com/)

- [X] [Bitmart](https://bitmart.com/)

- [X] [BingX](https://bingx.com/invite/0EM9RX)

- [X] [Bybit](https://bybit.com/)

- [X] [Gate.io](https://www.gate.io/ref/6266643)

- [X] [HTX](https://www.htx.com/) (Former Huobi)

- [X] [Hyperliquid](https://hyperliquid.xyz/) (A decentralized exchange, or DEX)

- [X] [Kraken](https://kraken.com/)

- [X] [OKX](https://okx.com/) (Former OKEX)

- [ ] [potentially many others](https://github.com/ccxt/ccxt/). _(We cannot guarantee they will work)_



### Supported Futures Exchanges (experimental)



- [X] [Binance](https://www.binance.com/)

- [X] [Gate.io](https://www.gate.io/ref/6266643)

- [X] [Hyperliquid](https://hyperliquid.xyz/) (A decentralized exchange, or DEX)

- [X] [OKX](https://okx.com/)

- [X] [Bybit](https://bybit.com/)



Please make sure to read the [exchange specific notes](docs/exchanges.md), as well as the [trading with leverage](docs/leverage.md) documentation before diving in.



### Community tested



Exchanges confirmed working by the community:



- [X] [Bitvavo](https://bitvavo.com/)

- [X] [Kucoin](https://www.kucoin.com/)



## Documentation



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



Please find the complete documentation on the [freqtrade website](https://www.freqtrade.io).



## Features



- [x] **Based on Python 3.10+**: For botting on any operating system - Windows, macOS and Linux.

- [x] **Persistence**: Persistence is achieved through sqlite.

- [x] **Dry-run**: Run the bot without paying 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] **Adaptive prediction modeling**: Build a smart strategy with FreqAI that self-trains to the market via adaptive machine learning methods. [Learn more](https://www.freqtrade.io/en/stable/freqai/)

- [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](https://www.freqtrade.io/en/stable/edge/).

- [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] **Builtin WebUI**: Builtin web UI to manage your bot.

- [x] **Manageable via Telegram**: Manage the bot with Telegram.

- [x] **Display profit/loss in fiat**: Display your profit/loss in fiat currency.

- [x] **Performance status report**: Provide a performance status of your current trades.



## Quick start



Please refer to the [Docker Quickstart documentation](https://www.freqtrade.io/en/stable/docker_quickstart/) on how to get started quickly.



For further (native) installation methods, please refer to the [Installation documentation page](https://www.freqtrade.io/en/stable/installation/).



## Basic Usage



### Bot commands



```

usage: freqtrade [-h] [-V]

                 {trade,create-userdir,new-config,show-config,new-strategy,download-data,convert-data,convert-trade-data,trades-to-ohlcv,list-data,backtesting,backtesting-show,backtesting-analysis,edge,hyperopt,hyperopt-list,hyperopt-show,list-exchanges,list-markets,list-pairs,list-strategies,list-freqaimodels,list-timeframes,show-trades,test-pairlist,convert-db,install-ui,plot-dataframe,plot-profit,webserver,strategy-updater,lookahead-analysis,recursive-analysis}

                 ...



Free, open source crypto trading bot



positional arguments:

  {trade,create-userdir,new-config,show-config,new-strategy,download-data,convert-data,convert-trade-data,trades-to-ohlcv,list-data,backtesting,backtesting-show,backtesting-analysis,edge,hyperopt,hyperopt-list,hyperopt-show,list-exchanges,list-markets,list-pairs,list-strategies,list-freqaimodels,list-timeframes,show-trades,test-pairlist,convert-db,install-ui,plot-dataframe,plot-profit,webserver,strategy-updater,lookahead-analysis,recursive-analysis}

    trade               Trade module.

    create-userdir      Create user-data directory.

    new-config          Create new config

    show-config         Show resolved config

    new-strategy        Create new strategy

    download-data       Download backtesting data.

    convert-data        Convert candle (OHLCV) data from one format to

                        another.

    convert-trade-data  Convert trade data from one format to another.

    trades-to-ohlcv     Convert trade data to OHLCV data.

    list-data           List downloaded data.

    backtesting         Backtesting module.

    backtesting-show    Show past Backtest results

    backtesting-analysis

                        Backtest Analysis module.

    edge                Edge module.

    hyperopt            Hyperopt module.

    hyperopt-list       List Hyperopt results

    hyperopt-show       Show details of Hyperopt results

    list-exchanges      Print available exchanges.

    list-markets        Print markets on exchange.

    list-pairs          Print pairs on exchange.

    list-strategies     Print available strategies.

    list-freqaimodels   Print available freqAI models.

    list-timeframes     Print available timeframes for the exchange.

    show-trades         Show trades.

    test-pairlist       Test your pairlist configuration.

    convert-db          Migrate database to different system

    install-ui          Install FreqUI

    plot-dataframe      Plot candles with indicators.

    plot-profit         Generate plot showing profits.

    webserver           Webserver module.

    strategy-updater    updates outdated strategy files to the current version

    lookahead-analysis  Check for potential look ahead bias.

    recursive-analysis  Check for potential recursive formula issue.



options:

  -h, --help            show this help message and exit

  -V, --version         show program's version number and exit



```



### 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 the [documentation](https://www.freqtrade.io/en/latest/telegram-usage/)



- `/start`: Starts the trader.

- `/stop`: Stops the trader.

- `/stopentry`: Stop entering new trades.

- `/status |[table]`: Lists all or specific open trades.

- `/profit []`: Lists cumulative profit from all finished trades, over the last n days.

- `/forceexit |all`: Instantly exits the given trade (Ignoring `minimum_roi`).

- `/fx |all`: Alias to `/forceexit`

- `/performance`: Show performance of each finished trade grouped by pair

- `/balance`: Show account balance per currency.

- `/daily `: 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 contain breaking changes. We try hard to keep this branch as stable as possible.

- `stable` - This branch contains the latest stable release. This branch 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.



## Support



### Help / Discord



For any questions not covered by the documentation or for further information about the bot, or to simply engage with like-minded individuals, we encourage you to join the Freqtrade [discord server](https://discord.gg/p7nuUNVfP7).



### [Bugs / Issues](https://github.com/freqtrade/freqtrade/issues?q=is%3Aissue)



If you discover a bug in the bot, please

[search the issue tracker](https://github.com/freqtrade/freqtrade/issues?q=is%3Aissue)

first. If it hasn't been reported, please

[create a new issue](https://github.com/freqtrade/freqtrade/issues/new/choose) and

ensure you follow the template guide so that the team can assist you as

quickly as possible.



For every [issue](https://github.com/freqtrade/freqtrade/issues/new/choose) created, kindly follow up and mark satisfaction or reminder to close issue when equilibrium ground is reached.



--Maintain github's [community policy](https://docs.github.com/en/site-policy/github-terms/github-community-code-of-conduct)--



### [Feature Requests](https://github.com/freqtrade/freqtrade/labels/enhancement)



Have you a great idea to improve the bot you want to share? Please,

first search if this feature was not [already discussed](https://github.com/freqtrade/freqtrade/labels/enhancement).

If it hasn't been requested, please

[create a new request](https://github.com/freqtrade/freqtrade/issues/new/choose)

and ensure you follow the template guide so that it does not get lost

in the bug reports.



### [Pull Requests](https://github.com/freqtrade/freqtrade/pulls)



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



Please read the

[Contributing document](https://github.com/freqtrade/freqtrade/blob/develop/CONTRIBUTING.md)

to understand the requirements before sending your pull-requests.



Coding is not a necessity to contribute - maybe start with improving the documentation?

Issues labeled [good first issue](https://github.com/freqtrade/freqtrade/labels/good%20first%20issue) 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 [discord](https://discord.gg/p7nuUNVfP7) (please use the #dev channel for this). 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 `stable`.



## Requirements



### Up-to-date clock



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



### Minimum 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



- [Python >= 3.10](http://docs.python-guide.org/en/latest/starting/installation/)

- [pip](https://pip.pypa.io/en/stable/installing/)

- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)

- [TA-Lib](https://ta-lib.github.io/ta-lib-python/)

- [virtualenv](https://virtualenv.pypa.io/en/stable/installation.html) (Recommended)

- [Docker](https://www.docker.com/products/docker) (Recommended)