www.freqtrade.io Open in urlscan Pro
2606:4700:3033::6815:1db0  Public Scan

Form analysis
2 forms found in the DOM

<form class="md-header__option" data-md-component="palette">
  <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="blue-grey" data-md-color-accent="tear" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
  <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path d="M17 6H7c-3.31 0-6 2.69-6 6s2.69 6 6 6h10c3.31 0 6-2.69 6-6s-2.69-6-6-6zm0 10H7c-2.21 0-4-1.79-4-4s1.79-4 4-4h10c2.21 0 4 1.79 4 4s-1.79 4-4 4zM7 9c-1.66 0-3 1.34-3 3s1.34 3 3 3 3-1.34 3-3-1.34-3-3-3z"></path>
    </svg>
  </label>
  <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="blue-grey" data-md-color-accent="tear" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
  <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden="">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path d="M17 7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h10a5 5 0 0 0 5-5 5 5 0 0 0-5-5m0 8a3 3 0 0 1-3-3 3 3 0 0 1 3-3 3 3 0 0 1 3 3 3 3 0 0 1-3 3Z"></path>
    </svg>
  </label>
</form>

Name: search —

<form class="md-search__form" name="search">
  <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required="">
  <label class="md-search__icon md-icon" for="__search">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"></path>
    </svg>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"></path>
    </svg>
  </label>
  <nav class="md-search__options" aria-label="Search">
    <a href="https://www.freqtrade.io/en/stable/?q=" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard="" data-clipboard-text="javascript:void(0)" data-md-component="search-share" tabindex="-1">

            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7 0-.24-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91 1.61 0 2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08Z"></path></svg>
          </a>
    <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
        <path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"></path>
      </svg>
    </button>
  </nav>
</form>

Text Content

Skip to content

Freqtrade
Home

Type to start searching
GitHub
 * 2024.3
 * 25.3k
 * 5.6k

Freqtrade
GitHub
 * 2024.3
 * 25.3k
 * 5.6k

 * Home Home
   Table of contents
    * Introduction
    * Features
    * Supported exchange marketplaces
       * Supported Futures Exchanges (experimental)
       * Community tested
   
    * Community showcase
    * Requirements
       * Hardware requirements
       * Software requirements
   
    * Support
       * Help / Discord
   
    * Ready to try?

 * Quickstart with Docker
 * Installation
   Installation
    * Linux/MacOS/Raspberry
    * Windows

 * Freqtrade Basics
 * Configuration
 * Strategy Customization
 * Strategy Callbacks
 * Stoploss
 * Plugins
 * Start the bot
 * Control the bot
   Control the bot
    * Telegram
    * REST API & FreqUI
    * Web Hook

 * Data Downloading
 * Backtesting
 * Hyperopt
 * FreqAI
   FreqAI
    * Introduction
    * Configuration
    * Parameter table
    * Feature engineering
    * Running FreqAI
    * Reinforcement Learning
    * Developer guide

 * Short / Leverage
 * Utility Sub-commands
 * Plotting
 * Exchange-specific Notes
 * Data Analysis
   Data Analysis
    * Jupyter Notebooks
    * Strategy analysis
    * Backtest analysis

 * Advanced Topics
   Advanced Topics
    * Advanced Post-installation Tasks
    * Trade Object
    * Lookahead analysis
    * Recursive analysis
    * Advanced Strategy
    * Advanced Hyperopt
    * Producer/Consumer mode
    * Edge Positioning

 * FAQ
 * SQL Cheat-sheet
 * Strategy migration
 * Updating Freqtrade
 * Deprecated Features
 * Contributors Guide

Table of contents
 * Introduction
 * Features
 * Supported exchange marketplaces
    * Supported Futures Exchanges (experimental)
    * Community tested

 * Community showcase
 * Requirements
    * Hardware requirements
    * Software requirements

 * Support
    * Help / Discord

 * Ready to try?


HOME








INTRODUCTION¶

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.

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 basic coding skills and Python knowledge. Do
not hesitate to read the source code and understand the mechanisms of this bot,
algorithms and techniques implemented in it.




FEATURES¶

 * Develop your Strategy: Write your strategy in python, using pandas. Example
   strategies to inspire you are available in the strategy repository.
 * Download market data: Download historical data of the exchange and the
   markets your may want to trade with.
 * Backtest: Test your strategy on downloaded historical data.
 * Optimize: Find the best parameters for your strategy using hyperoptimization
   which employs machining learning methods. You can optimize buy, sell, take
   profit (ROI), stop-loss and trailing stop-loss parameters for your strategy.
 * Select markets: Create your static list or use an automatic one based on top
   traded volumes and/or prices (not available during backtesting). You can also
   explicitly blacklist markets you don't want to trade.
 * Run: Test your strategy with simulated money (Dry-Run mode) or deploy it with
   real money (Live-Trade mode).
 * Run using Edge (optional module): The concept is to find the best historical
   trade expectancy by markets based on variation of the stop-loss and then
   allow/reject markets to trade. The sizing of the trade is based on a risk of
   a percentage of your capital.
 * Control/Monitor: Use Telegram or a WebUI (start/stop the bot, show
   profit/loss, daily summary, current open trades results, etc.).
 * Analyze: Further analysis can be performed on either Backtesting data or
   Freqtrade trading history (SQL database), including automated standard plots,
   and methods to load the data into interactive environments.


SUPPORTED EXCHANGE MARKETPLACES¶

Please read the exchange specific notes to learn about eventual, special
configurations needed for each exchange.

 * Binance
 * Bitmart
 * Gate.io
 * HTX (Former Huobi)
 * Kraken
 * OKX (Former OKEX)
 * potentially many others through . (We cannot guarantee they will work)


SUPPORTED FUTURES EXCHANGES (EXPERIMENTAL)¶

 * Binance
 * Gate.io
 * OKX
 * Bybit

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:

 * Bitvavo
 * Kucoin


COMMUNITY SHOWCASE¶

This section will highlight a few projects from members of the community.

Note

The projects below are for the most part not maintained by the freqtrade ,
therefore use your own caution before using them.

 * Example freqtrade strategies
 * FrequentHippo - Grafana dashboard with dry/live runs and backtests (by
   hippocritical).
 * Online pairlist generator (by Blood4rc).
 * Freqtrade Backtesting Project (by Blood4rc).
 * Freqtrade analysis notebook (by Froggleston).
 * TUI for freqtrade (by Froggleston).
 * Bot Academy (by stash86) - Blog about crypto bot projects.


REQUIREMENTS¶


HARDWARE REQUIREMENTS¶

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

 * 2GB RAM
 * 1GB disk space
 * 2vCPU


SOFTWARE REQUIREMENTS¶

 * Docker (Recommended)

Alternatively

 * Python 3.9+
 * pip (pip3)
 * git
 * TA-Lib
 * virtualenv (Recommended)


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.


READY TO TRY?¶

Begin by reading the installation guide for docker (recommended), or for
installation without docker.

Back to top
Next
Quickstart with Docker

Made with Material for MkDocs