README

!freqtrade







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

 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 to learn about special configurations that maybe needed for each exchange.

 Supported Spot Exchanges

- [X] Binance
- [X] BingX
- [X] Bitget
- [X] Bybit EU
- [X] Bybit
- [X] Gate EU
- [X] Gate
- [X] HTX
- [X] Hyperliquid (A decentralized exchange, or DEX)
- [X] Kraken
- [X] MyOKX (OKX EEA)
- [X] OKX
- [ ] potentially many others. _(We cannot guarantee they will work)_

 Supported Futures Exchanges

- [X] Binance
- [X] Bitget
- [X] Bybit
- [X] Gate
- [X] Hyperliquid (A decentralized exchange, or DEX)
- [X] Kraken
- [X] OKX

Please make sure to read the exchange specific notes, as well as the trading with leverage documentation before diving in.

 Community tested

Exchanges confirmed working by the community:

- [X] Bitvavo
- [X] Kucoin

 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.

 Features

- [x] Based on Python 3.12+: 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
- [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 on how to get started quickly.

For further (native) installation

Top issues

Latest release

Highlighted changes

- Add Orderbook websocket support.
- Fully Decouple bot from RPC messaging for more reliable bot loop execution.
- Parameter values are now kept per strategy instance. Access them through self..value, not through the class.
- Armv7 (raspberry 32bit)  image updated to python 3.13.
- Dropped support for python 3.11.
- Support changing strategy parameters from Backtesting UI (webserver mode only).
- FreqUI will now use the backtested strategy to plot in backtest mode (webserver mode only).
- backtesting-show --export-params now writes the parameters from a backtest b