Freqtrade

https://www.freqtrade.io/en/stable
Admin
Freqtrade is a free and open source cryptocurrency trading bot written in Python that supports major...
Tokens:321,088
Snippets:1,961
Trust Score:8.3
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install documentation dependencies and serve locally

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

Run these commands to install the documentation dependencies and start a local MkDocs server. The server typically runs on port 8000, allowing you to preview the documentation.

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

```

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

### Install dependencies and setup on Raspberry Pi (Raspbian)

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

Installs required packages, configures piwheels.org for faster installation, clones the freqtrade repository, and runs setup.sh -i. Installation may take multiple hours on a Raspberry Pi.

```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
```

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

### Update via setup script (./setup.sh --update)

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

Run this command to update an installation done via the setup script. Make sure your virtual environment is disabled before running.

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

```

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

### Install Freqtrade with setup.sh -i

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

Runs the setup.sh script with the -i option to install Freqtrade from scratch on Debian, Ubuntu, or MacOS. Requires git and python3.11+ to be installed beforehand.

```bash
# --install, Install freqtrade from scratch
./setup.sh -i

```

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

### Install Freqtrade from PyPI

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

Alternative installation method using pip. Requires ta-lib to be installed beforehand; not the recommended way to install Freqtrade.

```bash
pip install freqtrade

```

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

### freqtrade new-config example

Source: https://www.freqtrade.io/en/stable/utils

Example interaction of the new-config subcommand, showing the questions asked and the user's responses. This example uses a specific config file and demonstrates the interactive prompts.

```text
$ 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

```

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

### Complete DataProvider sample strategy

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

A full strategy class demonstrating DataProvider usage: current_whitelist() to get pairs, get_pair_dataframe() to fetch informative data, merge_informative_pair() to safely merge timeframes, and populate_entry_trend() to set entry signals based on RSI crossovers. Requires the strategy to have timeframe and other init attributes. The example uses ta.RSI and qtpylib.crossed_above.

```python
from freqtrade.strategy import IStrategy, merge_informative_pair
from pandas import DataFrame

class SampleStrategy(IStrategy):
    # strategy init stuff...

    timeframe = '5m'

    # more strategy init stuff..

    def informative_pairs(self):

        # get access to all pairs available in whitelist.
        pairs = self.dp.current_whitelist()
        # Assign tf to each pair so they can be downloaded and cached for strategy.
        informative_pairs = [(pair, '1d') for pair in pairs]
        # Optionally Add additional "static" pairs
        informative_pairs += [("ETH/USDT", "5m"),
                              ("BTC/TUSD", "15m"),
                            ]
        return informative_pairs

    def populate_indicators(self, dataframe: DataFrame, metadata: dict) -> DataFrame:
        if not self.dp:
            # Don't do anything if DataProvider is not available.
            return dataframe

        inf_tf = '1d'
        # Get the informative pair
        informative = self.dp.get_pair_dataframe(pair=metadata['pair'], timeframe=inf_tf)
        # Get the 14 day rsi
        informative['rsi'] = ta.RSI(informative, timeperiod=14)

        # Use the helper function merge_informative_pair to safely merge the pair
        # Automatically renames the columns and merges a shorter timeframe dataframe and a longer timeframe informative pair
        # use ffill to have the 1d value available in every row throughout the day.
        # Without this, comparisons between columns of the original and the informative pair would only work once per day.
        # Full documentation of this method, see below
        dataframe = merge_informative_pair(dataframe, informative, self.timeframe, inf_tf, ffill=True)

        # Calculate rsi of the original dataframe (5m timeframe)
        dataframe['rsi'] = ta.RSI(dataframe, timeperiod=14)

        # Do other stuff
        # ...

        return dataframe

    def populate_entry_trend(self, dataframe: DataFrame, metadata: dict) -> DataFrame:

        dataframe.loc[
            (
                (qtpylib.crossed_above(dataframe['rsi'], 30)) &  # Signal: RSI crosses above 30
                (dataframe['rsi_1d'] < 30) &                     # Ensure daily RSI is < 30
                (dataframe['volume'] > 0)                        # Ensure this candle had volume (important for backtesting)
            ),
            ['enter_long', 'enter_tag']] = (1, 'rsi_cross')

```

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

### Start freqtrade bot with SampleStrategy

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

Starts the freqtrade bot using the specified configuration file and strategy. It is recommended to start with dry_run: True and verify everything works before enabling real trading.

```bash
freqtrade trade --config user_data/config.json --strategy SampleStrategy

```

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

### Install FreqAI dependencies with pip

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

Run this command to manually install FreqAI dependencies if you did not reply 'yes' during the normal Freqtrade install process. Note that Catboost will not be installed on low-powered arm devices (e.g., Raspberry Pi) because it does not provide wheels for that platform.

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

```

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

### Install dependencies for AutoSampler

Source: https://www.freqtrade.io/en/stable/advanced-hyperopt

Install the necessary dependencies to use AutoSampler from Optunahub.

```bash
pip install optunahub cmaes torch scipy
```

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

### Run backtesting with custom starting balance

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

Runs backtesting with a custom starting balance of 1000 in the stake currency using the --dry-run-wallet option.

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

```

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

### freqtrade plot-dataframe example with BTC/ETH and AwesomeStrategy

Source: https://www.freqtrade.io/en/stable/plotting

Example command that plots price and indicators for the BTC/ETH pair using the AwesomeStrategy strategy.

```bash
freqtrade plot-dataframe -p BTC/ETH --strategy AwesomeStrategy

```

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

### Launch freqtrade bot in trading mode

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

Starts the freqtrade container in the background after configuration and strategy setup.

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

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

### Set up freqtrade with Docker Compose

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

Creates a new directory, downloads the docker-compose file, pulls the freqtrade image, creates the user directory structure, and interactively generates a configuration file.

```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
```

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

### Use freqtrade-client programmatically with FtRestClient

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

Programmatic use of the freqtrade-client package. Install it independently with 'pip install freqtrade-client'. It only depends on 'requests' and 'python-rapidjson'. This example shows how to create a client, ping the bot, and add pairs to the blacklist.

```python
from freqtrade_client import FtRestClient


client = FtRestClient(server_url, username, password)

# Get the status of the bot
ping = client.ping()
print(ping)

# Add pairs to blacklist
client.blacklist("BTC/USDT", "ETH/USDT")
# Add pairs to blacklist by supplying a list
client.blacklist(*listPairs)
# ... 

```

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

### Example STRATEGY SUMMARY output for multiple strategies

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

This is the example output table shown after running the backtest with multiple strategies. It compares win/losses and other metrics for each strategy, identical to the 'Total' row in the first table.

```text
================================================== STRATEGY SUMMARY ===================================================================
| Strategy    |  Trades |   Avg Profit % |   Tot Profit BTC |   Tot Profit % | Avg Duration   |  Wins |  Draws | Losses | Drawdown % |
|-------------+---------+----------------+------------------+----------------+----------------+-------+--------+--------+------------|
| Strategy1   |     429 |           0.36 |       0.00762792 |          76.20 | 4:12:00        |   186 |      0 |    243 |       45.2 |
| Strategy2   |    1487 |          -0.13 |      -0.00988917 |         -98.79 | 4:43:00        |   662 |      0 |    825 |     241.68 |

```

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

### Quick start command for PyTorch model

Source: https://www.freqtrade.io/en/stable/freqai-configuration

Run a PyTorch model with FreqAI using the PyTorchMLPRegressor. Requires the PyTorch module to be installed.

```bash
freqtrade trade --config config_examples/config_freqai.example.json --strategy FreqaiExampleStrategy --freqaimodel PyTorchMLPRegressor --strategy-path freqtrade/templates 

```

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

### GET /api/v1/count

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

Example endpoint that uses the access token for authentication. It demonstrates how to include the access token in the Authorization header as a Bearer token.

```APIDOC
## GET /api/v1/count

### Description
Example endpoint that uses the access token for authentication. It demonstrates how to include the access token in the Authorization header as a Bearer token.

### Method
GET

### Endpoint
/api/v1/count

### Authentication
Bearer token (access token) in the Authorization header.

### Request Example
```
curl -X GET --header "Authorization: Bearer ${access_token}" http://localhost:8080/api/v1/count
```

### Response
No response details are provided in the source.
```

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

### Install Freqtrade with setup.ps1 on Windows

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

Runs the setup.ps1 script on Windows. The script asks questions to determine which parts to install. Requires setting the execution policy to Bypass.

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

```

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

### Activate virtual environment for 'command not found' error

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

If you get 'bash: freqtrade: command not found', activate your virtual environment with this command. This is needed for Script or Manual installations.

```bash
# if:
bash: freqtrade: command not found

# then activate your virtual environment
source ./.venv/bin/activate

```

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

### Use current_whitelist() in informative_pairs

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

Example of using `self.dp.current_whitelist()` to dynamically get the current whitelist and create informative pairs with a '1d' timeframe. This is useful when the whitelist is dynamic and you need to download data for all whitelisted pairs.

```python
    def informative_pairs(self):

        # get access to all pairs available in whitelist.
        pairs = self.dp.current_whitelist()
        # Assign timeframe to each pair so they can be downloaded and cached for strategy.
        informative_pairs = [(pair, '1d') for pair in pairs]
        return informative_pairs

```

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

### Initialize freqtrade user folder and configuration

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

Run these commands to create the user_data directory and a new configuration file. The first command initializes the user folder, the second creates a configuration file at user_data/config.json.

```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

```

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

### freqtrade new-strategy basic example

Source: https://www.freqtrade.io/en/stable/utils

Creates a new strategy named `AwesomeStrategy` using the default full template.

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

```

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

### Install dependencies on macOS via Homebrew

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

Installs gettext and libomp using Homebrew. The setup.sh script will install these dependencies automatically if brew is installed.

```bash
# install packages
brew install gettext libomp
```

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

### Install Python dependencies and Freqtrade

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

Upgrades pip, installs dependencies from requirements.txt, and installs Freqtrade in editable mode. After this, the bot is ready to run.

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

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

### GET /trade/<tradeid>

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

Get specific trade.

```APIDOC
## GET /trade/<tradeid>

### Description
Get specific trade.

### Method
GET

### Endpoint
/trade/<tradeid>

### Parameters
#### Path Parameters
- **tradeid** (int) - Required - Trade ID

```

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

### bot_start callback: one-time strategy initialization

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

Called once when the strategy is loaded, after dataprovider and wallet are set. Use it for one-time actions like fetching remote data. During hyperopt, this runs only once at startup.

```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")

```

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

### POST /start

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

Starts the trader.

```APIDOC
## POST /start

### Description
Starts the trader.

### Method
POST

### Endpoint
/start

```

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

### Install Python dependencies in Conda environment

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

Upgrades pip, installs dependencies from requirements.txt, and installs Freqtrade in editable mode within the Conda environment.

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

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

### GET /plot_config

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

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

```APIDOC
## GET /plot_config

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

### Method
GET

### Endpoint
/plot_config

### Response
No response schema documented.
```

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

### minimal_roi configuration example

Source: https://www.freqtrade.io/en/stable/configuration

JSON object mapping duration in minutes to minimum ROI ratio. Keys are minutes, values are profit ratios. The example shows exits after 40, 30, 20, and 0 minutes with respective profit thresholds. This parameter can be set in strategy or configuration file; configuration overrides strategy. Default is {"0": 10} (1000% profit) if not set. Special case "<N>": -1 forces exit after N minutes.

```json
"minimal_roi": {
    "40": 0.0,    # Exit after 40 minutes if the profit is not negative
    "30": 0.01,   # Exit after 30 minutes if there is at least 1% profit
    "20": 0.02,   # Exit after 20 minutes if there is at least 2% profit
    "0":  0.04    # Exit immediately if there is at least 4% profit
},
```

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

### bot_start

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

A callback called once when the strategy is loaded, after dataprovider and wallet are set. Use it for one-time initialization tasks.

```APIDOC
## bot_start

### Description
Called only once after bot instantiation. This callback runs after dataprovider and wallet are set, and can be used to perform actions that must only be performed once. During hyperopt, this runs only once at startup.

### Method
bot_start

### Signature
`def bot_start(self, **kwargs) -> None`

### Parameters
- **kwargs** (dict) - Optional - Ensure to keep this here so updates to this won't break your strategy.

### Example
```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")
```
```

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

### freqtrade webserver CLI usage

Source: https://www.freqtrade.io/en/stable/utils

Shows the command-line interface for the 'freqtrade webserver' command, including common arguments like --config, --datadir, and --userdir. Use this to start the webserver in normal mode.

```text
usage: freqtrade webserver [-h] [-v] [--no-color] [--logfile FILE] [-V]
                           [-c PATH] [-d PATH] [--userdir PATH]

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

Common arguments:
  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
  --no-color            Disable colorization of hyperopt results. May be
                        useful if you are redirecting output to a file.
  --logfile, --log-file FILE
                        Log to the file specified. Special values are:
                        'syslog', 'journald'. See the documentation for more
                        details.
  -V, --version         show program's version number and exit
  -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.
  -d, --datadir, --data-dir PATH
                        Path to the base directory of the exchange with
                        historical backtesting data. To see futures data, use
                        trading-mode additionally.
  --userdir, --user-data-dir PATH
                        Path to userdata directory.

```

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

### freqtrade list-data --show --trades example

Source: https://www.freqtrade.io/en/stable/data-download

Example command to list trades data with the --show and --trades flags. The output shows the pair, type, from/to timerange, and number of trades.

```text
> freqtrade list-data --show --trades
                     Found trades data for 1 pair.                     
┏━━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┓
┃    Pair ┃ Type ┃                From ┃                  To ┃ Trades ┃
┡━━━━━━━━━╇━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━┩
│ XRP/ETH │ spot │ 2019-10-11 00:00:11 │ 2019-10-13 11:19:28 │  12477 │
└─────────┴──────┴─────────────────────┴─────────────────────┴────────┘
```

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

### List timeframes for binance exchange

Source: https://www.freqtrade.io/en/stable/utils

Example command to list timeframes for the 'binance' exchange using a configuration file. The output shows the available timeframes: 1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M.

```bash
$ freqtrade list-timeframes -c config_binance.json
...
Timeframes available for the exchange `binance`: 1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M

```
Tokens:
Raw