Freqtrade

https://www.freqtrade.io/en/develop/
Admin
Freqtrade is a free and open source cryptocurrency trading bot written in Python that supports major...
Tokens:240,927
Snippets:2,953
Trust Score:8.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Documentation Dependencies and Serve Locally

Source: https://www.freqtrade.io/en/develop/developer?q=

Installs necessary packages for documentation and starts a local server for previewing changes. Ensure you are in the Freqtrade root directory.

```bash
pip install -r docs/requirements-docs.txt
mkdocs serve

```

--------------------------------

### Install Freqtrade with setup.sh Script

Source: https://www.freqtrade.io/en/develop/installation?q=

Installs Freqtrade and its dependencies using the setup script on Linux/MacOS. Ensure you have git and Python 3.11+ installed.

```bash
./setup.sh -i
```

--------------------------------

### Create config interactive example

Source: https://www.freqtrade.io/en/develop/utils?q=

Example of the interactive prompts displayed when running the new-config command.

```bash
$ freqtrade new-config --config user_data/config_binance.json

? Do you want to enable Dry-run (simulated trades)?  Yes
? Please insert your stake currency: BTC
? Please insert your stake amount: 0.05
? Please insert max_open_trades (Integer or -1 for unlimited open trades): 3
? Please insert your desired timeframe (e.g. 5m): 5m
? Please insert your display Currency (for reporting): USD
? Select exchange  binance
? Do you want to enable Telegram?  No
```

--------------------------------

### Install Freqtrade on Raspberry Pi

Source: https://www.freqtrade.io/en/develop/installation?q=

Installs Freqtrade on a Raspberry Pi with Raspbian Buster lite, including dependencies and setting up pip. It clones the repository and runs the setup script.

```bash
sudo apt-get install python3-venv libatlas-base-dev cmake curl libffi-dev
# Use piwheels.org to speed up installation
sudo echo "[global]\nextra-index-url=https://www.piwheels.org/simple" > tee /etc/pip.conf

git clone https://github.com/freqtrade/freqtrade.git
cd freqtrade

bash setup.sh -i

```

--------------------------------

### Install Freqtrade with setup.ps1 Script (Windows)

Source: https://www.freqtrade.io/en/develop/installation?q=

Installs Freqtrade on Windows using the PowerShell script. This script will guide you through the installation process.

```powershell
Set-ExecutionPolicy -ExecutionPolicy Bypass
cd freqtrade
. .\setup.ps1
```

--------------------------------

### List Strategies Examples

Source: https://www.freqtrade.io/en/develop/utils?q=

Examples for searching strategies in default directories, custom user directories, or specific strategy paths.

```bash
freqtrade list-strategies
```

```bash
freqtrade list-strategies --userdir ~/.freqtrade/
```

```bash
freqtrade list-strategies --strategy-path ~/.freqtrade/strategies/
```

--------------------------------

### Install Freqtrade from PyPI

Source: https://www.freqtrade.io/en/develop/installation?q=

Installs Freqtrade using pip. Requires ta-lib to be installed beforehand. This is not the recommended installation method.

```bash
pip install freqtrade
```

--------------------------------

### Run backtesting with custom starting balance

Source: https://www.freqtrade.io/en/develop/backtesting

Sets a specific starting wallet balance in the stake currency.

```bash
freqtrade backtesting --strategy AwesomeStrategy --dry-run-wallet 1000
```

--------------------------------

### Install Development Dependencies

Source: https://www.freqtrade.io/en/develop/developer?q=

Installs all required tools for development, including testing and linting frameworks. This command should be run after cloning the repository.

```bash
pip3 install -r requirements-dev.txt
pip3 install -e .[all]

```

--------------------------------

### Install Python Dependencies and Freqtrade (Manual Install)

Source: https://www.freqtrade.io/en/develop/installation

Upgrades pip, installs project dependencies from requirements.txt, and installs Freqtrade in editable mode.

```bash
python3 -m pip install --upgrade pip
python3 -m pip install -r requirements.txt
# install freqtrade
python3 -m pip install -e .
```

--------------------------------

### Hyperopt Buy Parameters Example

Source: https://www.freqtrade.io/en/develop/hyperopt

Example of buy parameters generated by Hyperopt, including indicators and trigger conditions.

```python
    buy_params = {
        'buy_adx': 44,
        'buy_rsi': 29,
        'buy_adx_enabled': False,
        'buy_rsi_enabled': True,
        'buy_trigger': 'bb_lower'
    }

```

--------------------------------

### Strategy creation examples

Source: https://www.freqtrade.io/en/develop/utils?q=

Common usage patterns for creating new strategies with different options.

```bash
freqtrade new-strategy --strategy AwesomeStrategy
```

```bash
freqtrade new-strategy --userdir ~/.freqtrade/ --strategy AwesomeStrategy
```

```bash
freqtrade new-strategy --strategy AwesomeStrategy --template advanced
```

--------------------------------

### Install FreqAI Dependencies

Source: https://www.freqtrade.io/en/develop/freqai

Install FreqAI dependencies using pip. Ensure you reply 'yes' during the Freqtrade installation or run this command manually.

```bash
pip install -r requirements-freqai.txt
```

--------------------------------

### Install Dependencies on macOS

Source: https://www.freqtrade.io/en/develop/installation?q=

Installs Homebrew if not present, then installs gettext and libomp, which are required for Freqtrade on macOS.

```bash
# install packages
brew install gettext libomp

```

--------------------------------

### Update Freqtrade via Setup Script

Source: https://www.freqtrade.io/en/develop/updating

Run the setup script with the --update flag. Ensure your virtual environment is disabled before running.

```bash
./setup.sh --update
```

--------------------------------

### Install Python Dependencies and Freqtrade

Source: https://www.freqtrade.io/en/develop/installation?q=

Installs Freqtrade and its Python dependencies from the 'requirements.txt' file and installs Freqtrade in editable mode.

```bash
python3 -m pip install --upgrade pip
python3 -m pip install -r requirements.txt
python3 -m pip install -e .
```

--------------------------------

### Start Freqtrade as a Systemd Service

Source: https://www.freqtrade.io/en/develop/advanced-setup?q=

Use this command to start the Freqtrade bot as a systemd user service. Ensure the service file is correctly configured.

```bash
systemctl --user start freqtrade
```

--------------------------------

### Convert trades to OHLCV example

Source: https://www.freqtrade.io/en/develop/data-download?q=

Example command to convert Kraken trade data for specific pairs into 5m, 1h, and 1d OHLCV candles.

```bash
freqtrade trades-to-ohlcv --exchange kraken -t 5m 1h 1d --pairs BTC/EUR ETH/EUR
```

--------------------------------

### Install Web3 dependency

Source: https://www.freqtrade.io/en/develop/exchanges?q=

Install the required web3 package for exchanges like The Ocean that utilize Web3 functionality.

```bash
pip3 install web3
```

--------------------------------

### Example configuration output

Source: https://www.freqtrade.io/en/develop/utils?q=

Shows the structure of the merged configuration output with sensitive values redacted by default.

```json
Your combined configuration is:
{
  "exit_pricing": {
    "price_side": "other",
    "use_order_book": true,
    "order_book_top": 1
  },
  "stake_currency": "USDT",
  "exchange": {
    "name": "binance",
    "key": "REDACTED",
    "secret": "REDACTED",
    "ccxt_config": {},
    "ccxt_async_config": {},
  }
  // ...
}
```

--------------------------------

### Install PostgreSQL Driver for Freqtrade

Source: https://www.freqtrade.io/en/develop/advanced-setup?q=

Install the necessary Python package for PostgreSQL support. Use the provided connection string format for the --db-url argument.

```bash
pip install "psycopg[binary]"
```

--------------------------------

### Show dynamic pairlist whitelist

Source: https://www.freqtrade.io/en/develop/utils?q=

Example command to display the whitelist generated by a dynamic pairlist configuration.

```bash
freqtrade test-pairlist --config config.json --quote USDT BTC
```

--------------------------------

### Install Hyperopt Dependencies

Source: https://www.freqtrade.io/en/develop/installation?q=

Installs the hyperopt dependencies for Freqtrade. This is not recommended on resource-constrained devices like Raspberry Pi.

```bash
python3 -m pip install -e .[hyperopt]

```

--------------------------------

### Docker Compose Webserver Configuration

Source: https://www.freqtrade.io/en/develop/utils?q=

Example configuration snippet for updating the command in a docker-compose file to enable webserver mode.

```yaml
    command: >
      webserver
      --config /freqtrade/user_data/config.json
```

--------------------------------

### Update Bot via Setup Script

Source: https://www.freqtrade.io/en/develop/developer

Updates the Freqtrade bot installation using the setup script. Ensure your virtual environment is deactivated before running.

```bash
# Deactivate venv and run 
./setup.sh --update

```

--------------------------------

### Prepare and Run Backtest

Source: https://www.freqtrade.io/en/develop/developer?q=

Commands to set up a user directory, enable shorting, download data, and run a backtest with specific configurations.

```bash
# Assume a dedicated user directory for this output
freqtrade create-userdir --userdir user_data_bttest/
# set can_short = True
sed -i "s/can_short: bool = False/can_short: bool = True/" user_data_bttest/strategies/sample_strategy.py

freqtrade download-data --timerange 20250625-20250801 --config tests/testdata/config.tests.usdt.json --userdir user_data_bttest/ -t 5m

freqtrade backtesting --config tests/testdata/config.tests.usdt.json -s SampleStrategy --userdir user_data_bttest/ --cache none --timerange 20250701-20250801

```

--------------------------------

### Initialize Freqtrade User Directory and Configuration

Source: https://www.freqtrade.io/en/develop/installation

Create the necessary user directory and generate the initial configuration file for Freqtrade.

```bash
freqtrade create-userdir --userdir user_data
```

```bash
freqtrade new-config --config user_data/config.json
```

--------------------------------

### Initialize bot with custom data using bot_start

Source: https://www.freqtrade.io/en/develop/strategy-callbacks

The bot_start callback is executed once after the strategy is loaded. Use it for one-time setup tasks like fetching external data that will be used throughout the bot's operation.

```python
import requests

class AwesomeStrategy(IStrategy):

    # ... populate_* methods

    def bot_start(self, **kwargs) -> None:
        """
        Called only once after bot instantiation.
        :param **kwargs: Ensure to keep this here so updates to this won't break your strategy.
        """
        if self.config["runmode"].value in ("live", "dry_run"):
            # Assign this to the class by using self.*
            # can then be used by populate_* methods
            self.custom_remote_data = requests.get("https://some_remote_source.example.com")

```

--------------------------------

### Release Update Commands

Source: https://www.freqtrade.io/en/develop/developer?q=

Commands to update the bot using docker-compose, a setup script, or a plain native installation.

```bash
# Deactivate venv and run 
./setup.sh --update

```

```bash
git pull
pip install -U -r requirements.txt

```

```bash
docker-compose pull
docker-compose up -d

```

--------------------------------

### Print Specific Trades as JSON

Source: https://www.freqtrade.io/en/develop/utils?q=

Example command to retrieve trades with IDs 2 and 3 from a specific database file and output the result in JSON format.

```bash
freqtrade show-trades --db-url sqlite:///tradesv3.sqlite --trade-ids 2 3 --print-json
```

--------------------------------

### Funding Rate Data Structure

Source: https://www.freqtrade.io/en/develop/strategy-customization

Example of the dictionary structure returned by the funding_rate method, aligned with CCXT standards.

```json
{
    "info": {
        # ... 
    },
    "symbol": "BTC/USDT:USDT",
    "markPrice": 110730.7,
    "indexPrice": 110782.52,
    "interestRate": 0.0001,
    "estimatedSettlePrice": 110822.67200153,
    "timestamp": 1757146321001,
    "datetime": "2025-09-06T08:12:01.001Z",
    "fundingRate": 5.609e-05,
    "fundingTimestamp": 1757174400000,
    "fundingDatetime": "2025-09-06T16:00:00.000Z",
    "nextFundingRate": None,
    "nextFundingTimestamp": None,
    "nextFundingDatetime": None,
    "previousFundingRate": None,
    "previousFundingTimestamp": None,
    "previousFundingDatetime": None,
    "interval": None,
}
```

--------------------------------

### Get Total Closed Profit Example

Source: https://www.freqtrade.io/en/develop/trade-object?q=

Retrieves the total profit generated by the bot from all closed trades. This provides an aggregate view of profitability.

```python
from freqtrade.persistence import Trade

# ...
profit = Trade.get_total_closed_profit()
```

--------------------------------

### Column Renaming for 1d Informative Timeframe

Source: https://www.freqtrade.io/en/develop/strategy-customization

Example of column naming conventions when using a 1-day informative timeframe.

```text
'date', 'open', 'high', 'low', 'close', 'rsi'                     # from the original dataframe
'date_1d', 'open_1d', 'high_1d', 'low_1d', 'close_1d', 'rsi_1d'   # from the informative dataframe
```

--------------------------------

### Get Open Trade Count Example

Source: https://www.freqtrade.io/en/develop/trade-object?q=

Retrieves the number of currently open trades. This method is useful for monitoring active trading positions.

```python
from freqtrade.persistence import Trade
# ...
open_trades = Trade.get_open_trade_count()
```

--------------------------------

### Column Renaming for 1h Informative Timeframe

Source: https://www.freqtrade.io/en/develop/strategy-customization

Example of column naming conventions when using a 1-hour informative timeframe.

```text
'date', 'open', 'high', 'low', 'close', 'rsi'                     # from the original dataframe
'date_1h', 'open_1h', 'high_1h', 'low_1h', 'close_1h', 'rsi_1h'   # from the informative dataframe
```

--------------------------------

### Launch Freqtrade Bot

Source: https://www.freqtrade.io/en/develop/docker_quickstart

Starts the Freqtrade bot in detached mode after configuration and strategy setup. Ensure your custom strategy is in user_data/strategies/ and referenced in docker-compose.yml.

```bash
docker compose up -d
```

--------------------------------

### Initialize Freqtrade User Directory and Configuration

Source: https://www.freqtrade.io/en/develop/installation?q=

Create the necessary user directory and generate a default configuration file for Freqtrade. This is a required step before running the bot.

```bash
# Step 1 - Initialize user folder
freqtrade create-userdir --userdir user_data

# Step 2 - Create a new configuration file
freqtrade new-config --config user_data/config.json
```

--------------------------------

### Get Trading Volume Example

Source: https://www.freqtrade.io/en/develop/trade-object?q=

Calculates and retrieves the total trading volume based on executed orders. This is useful for analyzing trading activity and exchange fees.

```python
from freqtrade.persistence import Trade

# ...
volume = Trade.get_trading_volume()
```

--------------------------------

### Download Docker Compose and Initialize Freqtrade

Source: https://www.freqtrade.io/en/develop/docker_quickstart?q=

This sequence of commands sets up the Freqtrade environment in Docker. It creates a directory, downloads the `docker-compose.yml` file, pulls the Freqtrade Docker image, and initializes the user data directory and configuration.

```bash
mkdir ft_userdata
cd ft_userdata/
# Download the docker-compose file from the repository
curl https://raw.githubusercontent.com/freqtrade/freqtrade/stable/docker-compose.yml -o docker-compose.yml

# Pull the freqtrade image
docker compose pull

# Create user directory structure
docker compose run --rm freqtrade create-userdir --userdir user_data

# Create configuration - Requires answering interactive questions
docker compose run --rm freqtrade new-config --config user_data/config.json
```

--------------------------------

### Get Weekly Profit Report

Source: https://www.freqtrade.io/en/develop/telegram-usage?q=

Displays weekly profit information for a specified number of past weeks. Defaults to the last 8 weeks, starting from Monday.

```text
/weekly 3
```

--------------------------------

### Get Overall Performance Example

Source: https://www.freqtrade.io/en/develop/trade-object?q=

Retrieves the overall performance metrics of the bot, similar to the `/performance` Telegram command. This method is only supported in live and dry-run modes, not in backtesting or hyperopt.

```python
from freqtrade.persistence import Trade

# ...
if self.config['runmode'].value in ('live', 'dry_run'):
    performance = Trade.get_overall_performance()
```

--------------------------------

### Get Trades Proxy Example

Source: https://www.freqtrade.io/en/develop/trade-object?q=

Retrieves historical trade data. Use this method when your strategy needs information on existing trades. It supports filtering by pair, open/close status, and date ranges. Calling without arguments returns all trades.

```python
from freqtrade.persistence import Trade
from datetime import timedelta

# ...
trade_hist = Trade.get_trades_proxy(pair='ETH/USDT', is_open=False, open_date=current_date - timedelta(days=2))
```

--------------------------------

### Run Hyperopt with Specific Configuration

Source: https://www.freqtrade.io/en/develop/faq

Example command to run hyperopt with a specified config file, strategy, hyperopt file, number of epochs, and timerange.

```bash
freqtrade --config config.json --strategy SampleStrategy --hyperopt SampleHyperopt -e 1000 --timerange 20190601-20200601
```

--------------------------------

### Start Live FreqAI Deployment

Source: https://www.freqtrade.io/en/develop/freqai-running

Use this command to start a live or dry run of FreqAI with a specified strategy, configuration, and model type. FreqAI will automatically train a new model upon launch.

```bash
freqtrade trade --strategy FreqaiExampleStrategy --config config_freqai.example.json --freqaimodel LightGBMRegressor

```

--------------------------------

### Configuration Merging Example

Source: https://www.freqtrade.io/en/develop/configuration?q=

Demonstrates how configuration settings are merged when multiple files are used. The parent configuration file takes precedence over imported files for the same keys.

```json
{
    "max_open_trades": 3,
    "stake_currency": "USDT",
    "add_config_files": [
        "config-import.json"
    ]
}
```

```json
{
    "max_open_trades": 10,
    "stake_amount": "unlimited",
}
```

```json
{
    "max_open_trades": 3,
    "stake_currency": "USDT",
    "stake_amount": "unlimited"
}
```

--------------------------------

### FreqAI Model File Structure Example

Source: https://www.freqtrade.io/en/develop/freqai-developers

This example illustrates the typical directory and file layout for a FreqAI model, showing configurations, historical data, and sub-train directories containing specific model artifacts.

```bash
├── models
│   └── unique-id
│       ├── config_freqai.example.json
│       ├── historic_predictions.backup.pkl
│       ├── historic_predictions.pkl
│       ├── pair_dictionary.json
│       ├── sub-train-1INCH_1662821319
│       │   ├── cb_1inch_1662821319_metadata.json
│       │   ├── cb_1inch_1662821319_model.joblib
│       │   ├── cb_1inch_1662821319_pca_object.pkl
│       │   ├── cb_1inch_1662821319_svm_model.joblib
│       │   ├── cb_1inch_1662821319_trained_dates_df.pkl
│       │   └── cb_1inch_1662821319_trained_df.pkl
│       ├── sub-train-1INCH_1662821371
│       │   ├── cb_1inch_1662821371_metadata.json
│       │   ├── cb_1inch_1662821371_model.joblib
│       │   ├── cb_1inch_1662821371_pca_object.pkl
│       │   ├── cb_1inch_1662821371_svm_model.joblib
│       │   ├── cb_1inch_1662821371_trained_dates_df.pkl
│       │   └── cb_1inch_1662821371_trained_df.pkl
│       ├── sub-train-ADA_1662821344
│       │   ├── cb_ada_1662821344_metadata.json
│       │   ├── cb_ada_1662821344_model.joblib
│       │   ├── cb_ada_1662821344_pca_object.pkl
│       │   ├── cb_ada_1662821344_svm_model.joblib
│       │   ├── cb_ada_1662821344_trained_dates_df.pkl
│       │   └── cb_ada_1662821344_trained_df.pkl
│       └── sub-train-ADA_1662821399
│           ├── cb_ada_1662821399_metadata.json
│           ├── cb_ada_1662821399_model.joblib
│           ├── cb_ada_1662821399_pca_object.pkl
│           ├── cb_ada_1662821399_svm_model.joblib
│           ├── cb_ada_1662821399_trained_dates_df.pkl
│           └── cb_ada_1662821399_trained_df.pkl

```

--------------------------------

### Install macOS SDK Headers

Source: https://www.freqtrade.io/en/develop/installation?q=

On newer macOS versions, installation errors like 'g++' failing may require explicit installation of SDK headers. This command installs them for macOS 10.14.

```bash
open /Library/Developer/CommandLineTools/Packages/macOS_SDK_headers_for_macOS_10.14.pkg
```

--------------------------------

### Initialize Pairs Directory and File

Source: https://www.freqtrade.io/en/develop/data-download?q=

Create the directory structure and an empty pairs.json file for a specific exchange.

```bash
mkdir -p user_data/data/binance
touch user_data/data/binance/pairs.json
```

--------------------------------

### Show configuration command usage

Source: https://www.freqtrade.io/en/develop/utils?q=

Displays the help menu for the show-config command, which lists available options for viewing merged configuration files.

```text
usage: freqtrade show-config [-h] [--userdir PATH] [-c PATH]
                             [--show-sensitive]

options:
  -h, --help            show this help message and exit
  --userdir, --user-data-dir PATH
                        Path to userdata directory.
  -c, --config PATH     Specify configuration file (default:
                        `userdir/config.json` or `config.json` whichever
                        exists). Multiple --config options may be used. Can be
                        set to `-` to read config from stdin.
  --show-sensitive      Show secrets in the output.
```

--------------------------------

### Understanding and Applying Hyperopt ROI Results

Source: https://www.freqtrade.io/en/develop/hyperopt?q=

This example demonstrates how Hyperopt results for ROI optimization are presented, including a 'minimal_roi' table. You can directly copy this table into your strategy's 'minimal_roi' attribute or use it in your configuration file.

```python
Best result:

    44/100:    135 trades. Avg profit  0.57%. Total profit  0.03871918 BTC (0.7722%). Avg duration 180.4 mins. Objective: 1.94367

    # ROI table:
    minimal_roi = {
        0: 0.10674,
        21: 0.09158,
        78: 0.03634,
        118: 0
    }


```

--------------------------------

### GET /plot_config

Source: https://www.freqtrade.io/en/develop/rest-api

Get plot config from the strategy.

```APIDOC
## GET /plot_config

### Description
Get plot config from the strategy (or nothing if not configured).

### Method
GET

### Endpoint
/plot_config
```
Tokens:
Raw