lychiyu/freqtrade_origin
1
0
Fork 0
mirror of https://github.com/freqtrade/freqtrade.git synced 2024-11-15 12:43:56 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
a103da314c
freqtrade_origin/en/2021.4/configuration/index.html

2320 lines
96 KiB
HTML
Raw Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="icon" href="../images/logo.png">
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.3">
<title>Configuration - Freqtrade</title>
<link rel="stylesheet" href="../assets/stylesheets/main.e35208c4.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.ef6f36e2.min.css">
<meta name="theme-color" content="#546d78">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
<style>:root{--md-text-font-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style>
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
</head>
<body dir="ltr" data-md-color-scheme="" data-md-color-primary="blue-grey" data-md-color-accent="tear">
<script>function __prefix(e){return new URL("..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#configure-the-bot" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="Freqtrade" class="md-header__button md-logo"
aria-label="Freqtrade">
<img src="../images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Freqtrade
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Configuration
</span>
</div>
</div>
</div>
<div class="md-header__options">
</div>
<label class="md-header__button 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"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="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" data-md-state="active" 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"/></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"/></svg>
</label>
<button type="reset" class="md-search__icon md-icon" 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"/></svg>
</button>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/freqtrade/freqtrade" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
</nav>
<!-- Place this tag in your head or just before your close body tag. -->
<script async defer src="https://buttons.github.io/buttons.js"></script>
<script src="https://code.jquery.com/jquery-3.4.1.min.js"
integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
</a>
Freqtrade
</label>
<div class="md-nav__source">
<a href="https://github.com/freqtrade/freqtrade" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
Home
</a>
</li>
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
Quickstart with Docker
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3">
Installation
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Installation" data-md-level="1">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Installation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
Linux/MacOS/Raspberry
</a>
</li>
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
Windows
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
Freqtrade Basics
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
Configuration
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
Configuration
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#the-freqtrade-configuration-file" class="md-nav__link">
The Freqtrade configuration file
</a>
</li>
<li class="md-nav__item">
<a href="#configuration-parameters" class="md-nav__link">
Configuration parameters
</a>
<nav class="md-nav" aria-label="Configuration parameters">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters-in-the-strategy" class="md-nav__link">
Parameters in the strategy
</a>
</li>
<li class="md-nav__item">
<a href="#configuring-amount-per-trade" class="md-nav__link">
Configuring amount per trade
</a>
<nav class="md-nav" aria-label="Configuring amount per trade">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#minimum-trade-stake" class="md-nav__link">
Minimum trade stake
</a>
</li>
<li class="md-nav__item">
<a href="#available-balance" class="md-nav__link">
Available balance
</a>
</li>
<li class="md-nav__item">
<a href="#amend-last-stake-amount" class="md-nav__link">
Amend last stake amount
</a>
</li>
<li class="md-nav__item">
<a href="#static-stake-amount" class="md-nav__link">
Static stake amount
</a>
</li>
<li class="md-nav__item">
<a href="#dynamic-stake-amount" class="md-nav__link">
Dynamic stake amount
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#prices-used-for-orders" class="md-nav__link">
Prices used for orders
</a>
<nav class="md-nav" aria-label="Prices used for orders">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#buy-price" class="md-nav__link">
Buy price
</a>
<nav class="md-nav" aria-label="Buy price">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#check-depth-of-market" class="md-nav__link">
Check depth of market
</a>
</li>
<li class="md-nav__item">
<a href="#buy-price-side" class="md-nav__link">
Buy price side
</a>
</li>
<li class="md-nav__item">
<a href="#buy-price-with-orderbook-enabled" class="md-nav__link">
Buy price with Orderbook enabled
</a>
</li>
<li class="md-nav__item">
<a href="#buy-price-without-orderbook-enabled" class="md-nav__link">
Buy price without Orderbook enabled
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#sell-price" class="md-nav__link">
Sell price
</a>
<nav class="md-nav" aria-label="Sell price">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#sell-price-side" class="md-nav__link">
Sell price side
</a>
</li>
<li class="md-nav__item">
<a href="#sell-price-with-orderbook-enabled" class="md-nav__link">
Sell price with Orderbook enabled
</a>
</li>
<li class="md-nav__item">
<a href="#sell-price-without-orderbook-enabled" class="md-nav__link">
Sell price without Orderbook enabled
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#market-order-pricing" class="md-nav__link">
Market order pricing
</a>
</li>
<li class="md-nav__item">
<a href="#understand-minimal_roi" class="md-nav__link">
Understand minimal_roi
</a>
</li>
<li class="md-nav__item">
<a href="#understand-forcebuy_enable" class="md-nav__link">
Understand forcebuy_enable
</a>
</li>
<li class="md-nav__item">
<a href="#ignoring-expired-candles" class="md-nav__link">
Ignoring expired candles
</a>
</li>
<li class="md-nav__item">
<a href="#understand-order_types" class="md-nav__link">
Understand order_types
</a>
</li>
<li class="md-nav__item">
<a href="#understand-order_time_in_force" class="md-nav__link">
Understand order_time_in_force
</a>
</li>
<li class="md-nav__item">
<a href="#exchange-configuration" class="md-nav__link">
Exchange configuration
</a>
<nav class="md-nav" aria-label="Exchange configuration">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#sample-exchange-configuration" class="md-nav__link">
Sample exchange configuration
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#what-values-can-be-used-for-fiat_display_currency" class="md-nav__link">
What values can be used for fiat_display_currency?
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#using-dry-run-mode" class="md-nav__link">
Using Dry-run mode
</a>
<nav class="md-nav" aria-label="Using Dry-run mode">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#considerations-for-dry-run" class="md-nav__link">
Considerations for dry-run
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#switch-to-production-mode" class="md-nav__link">
Switch to production mode
</a>
<nav class="md-nav" aria-label="Switch to production mode">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#setup-your-exchange-account" class="md-nav__link">
Setup your exchange account
</a>
</li>
<li class="md-nav__item">
<a href="#to-switch-your-bot-in-production-mode" class="md-nav__link">
To switch your bot in production mode
</a>
</li>
<li class="md-nav__item">
<a href="#using-proxy-with-freqtrade" class="md-nav__link">
Using proxy with Freqtrade
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#next-step" class="md-nav__link">
Next step
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
Strategy Customization
</a>
</li>
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
Plugins
</a>
</li>
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
Stoploss
</a>
</li>
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
Start the bot
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_10" type="checkbox" id="__nav_10" >
<label class="md-nav__link" for="__nav_10">
Control the bot
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Control the bot" data-md-level="1">
<label class="md-nav__title" for="__nav_10">
<span class="md-nav__icon md-icon"></span>
Control the bot
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
Telegram
</a>
</li>
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
REST API & FreqUI
</a>
</li>
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
Web Hook
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
Data Downloading
</a>
</li>
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
Backtesting
</a>
</li>
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
Hyperopt
</a>
</li>
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
Utility Sub-commands
</a>
</li>
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
Plotting
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_16" type="checkbox" id="__nav_16" >
<label class="md-nav__link" for="__nav_16">
Data Analysis
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Data Analysis" data-md-level="1">
<label class="md-nav__title" for="__nav_16">
<span class="md-nav__icon md-icon"></span>
Data Analysis
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
Jupyter Notebooks
</a>
</li>
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
Strategy analysis
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
Exchange-specific Notes
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_18" type="checkbox" id="__nav_18" >
<label class="md-nav__link" for="__nav_18">
Advanced Topics
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Advanced Topics" data-md-level="1">
<label class="md-nav__title" for="__nav_18">
<span class="md-nav__icon md-icon"></span>
Advanced Topics
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
Advanced Post-installation Tasks
</a>
</li>
<li class="md-nav__item">
<a href="../edge/" class="md-nav__link">
Edge Positioning
</a>
</li>
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
Advanced Strategy
</a>
</li>
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
Advanced Hyperopt
</a>
</li>
<li class="md-nav__item">
<a href="../sandbox-testing/" class="md-nav__link">
Sandbox Testing
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
FAQ
</a>
</li>
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
SQL Cheat-sheet
</a>
</li>
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
Updating Freqtrade
</a>
</li>
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
Deprecated Features
</a>
</li>
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
Contributors Guide
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#the-freqtrade-configuration-file" class="md-nav__link">
The Freqtrade configuration file
</a>
</li>
<li class="md-nav__item">
<a href="#configuration-parameters" class="md-nav__link">
Configuration parameters
</a>
<nav class="md-nav" aria-label="Configuration parameters">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters-in-the-strategy" class="md-nav__link">
Parameters in the strategy
</a>
</li>
<li class="md-nav__item">
<a href="#configuring-amount-per-trade" class="md-nav__link">
Configuring amount per trade
</a>
<nav class="md-nav" aria-label="Configuring amount per trade">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#minimum-trade-stake" class="md-nav__link">
Minimum trade stake
</a>
</li>
<li class="md-nav__item">
<a href="#available-balance" class="md-nav__link">
Available balance
</a>
</li>
<li class="md-nav__item">
<a href="#amend-last-stake-amount" class="md-nav__link">
Amend last stake amount
</a>
</li>
<li class="md-nav__item">
<a href="#static-stake-amount" class="md-nav__link">
Static stake amount
</a>
</li>
<li class="md-nav__item">
<a href="#dynamic-stake-amount" class="md-nav__link">
Dynamic stake amount
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#prices-used-for-orders" class="md-nav__link">
Prices used for orders
</a>
<nav class="md-nav" aria-label="Prices used for orders">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#buy-price" class="md-nav__link">
Buy price
</a>
<nav class="md-nav" aria-label="Buy price">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#check-depth-of-market" class="md-nav__link">
Check depth of market
</a>
</li>
<li class="md-nav__item">
<a href="#buy-price-side" class="md-nav__link">
Buy price side
</a>
</li>
<li class="md-nav__item">
<a href="#buy-price-with-orderbook-enabled" class="md-nav__link">
Buy price with Orderbook enabled
</a>
</li>
<li class="md-nav__item">
<a href="#buy-price-without-orderbook-enabled" class="md-nav__link">
Buy price without Orderbook enabled
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#sell-price" class="md-nav__link">
Sell price
</a>
<nav class="md-nav" aria-label="Sell price">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#sell-price-side" class="md-nav__link">
Sell price side
</a>
</li>
<li class="md-nav__item">
<a href="#sell-price-with-orderbook-enabled" class="md-nav__link">
Sell price with Orderbook enabled
</a>
</li>
<li class="md-nav__item">
<a href="#sell-price-without-orderbook-enabled" class="md-nav__link">
Sell price without Orderbook enabled
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#market-order-pricing" class="md-nav__link">
Market order pricing
</a>
</li>
<li class="md-nav__item">
<a href="#understand-minimal_roi" class="md-nav__link">
Understand minimal_roi
</a>
</li>
<li class="md-nav__item">
<a href="#understand-forcebuy_enable" class="md-nav__link">
Understand forcebuy_enable
</a>
</li>
<li class="md-nav__item">
<a href="#ignoring-expired-candles" class="md-nav__link">
Ignoring expired candles
</a>
</li>
<li class="md-nav__item">
<a href="#understand-order_types" class="md-nav__link">
Understand order_types
</a>
</li>
<li class="md-nav__item">
<a href="#understand-order_time_in_force" class="md-nav__link">
Understand order_time_in_force
</a>
</li>
<li class="md-nav__item">
<a href="#exchange-configuration" class="md-nav__link">
Exchange configuration
</a>
<nav class="md-nav" aria-label="Exchange configuration">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#sample-exchange-configuration" class="md-nav__link">
Sample exchange configuration
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#what-values-can-be-used-for-fiat_display_currency" class="md-nav__link">
What values can be used for fiat_display_currency?
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#using-dry-run-mode" class="md-nav__link">
Using Dry-run mode
</a>
<nav class="md-nav" aria-label="Using Dry-run mode">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#considerations-for-dry-run" class="md-nav__link">
Considerations for dry-run
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#switch-to-production-mode" class="md-nav__link">
Switch to production mode
</a>
<nav class="md-nav" aria-label="Switch to production mode">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#setup-your-exchange-account" class="md-nav__link">
Setup your exchange account
</a>
</li>
<li class="md-nav__item">
<a href="#to-switch-your-bot-in-production-mode" class="md-nav__link">
To switch your bot in production mode
</a>
</li>
<li class="md-nav__item">
<a href="#using-proxy-with-freqtrade" class="md-nav__link">
Using proxy with Freqtrade
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#next-step" class="md-nav__link">
Next step
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<a href="https://github.com/freqtrade/freqtrade/edit/master/docs/configuration.md" title="Edit this page" class="md-content__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
</a>
<h1 id="configure-the-bot">Configure the bot<a class="headerlink" href="#configure-the-bot" title="Permanent link">&para;</a></h1>
<p>Freqtrade has many configurable features and possibilities.
By default, these settings are configured via the configuration file (see below).</p>
<h2 id="the-freqtrade-configuration-file">The Freqtrade configuration file<a class="headerlink" href="#the-freqtrade-configuration-file" title="Permanent link">&para;</a></h2>
<p>The bot uses a set of configuration parameters during its operation that all together conform the bot configuration. It normally reads its configuration from a file (Freqtrade configuration file).</p>
<p>Per default, the bot loads the configuration from the <code>config.json</code> file, located in the current working directory.</p>
<p>You can specify a different configuration file used by the bot with the <code>-c/--config</code> command line option.</p>
<p>Multiple configuration files can be specified and used by the bot or the bot can read its configuration parameters from the process standard input stream.</p>
<div class="admonition tip">
<p class="admonition-title">Use multiple configuration files to keep secrets secret</p>
<p>You can use a 2<sup>nd</sup> configuration file containing your secrets. That way you can share your "primary" configuration file, while still keeping your API keys for yourself.</p>
<p><code>bash
freqtrade trade --config user_data/config.json --config user_data/config-private.json &lt;...&gt;</code>
The 2<sup>nd</sup> file should only specify what you intend to override.
If a key is in more than one of the configurations, then the "last specified configuration" wins (in the above example, <code>config-private.json</code>).</p>
</div>
<p>If you used the <a href="installation.md/#quick-start">Quick start</a> method for installing
the bot, the installation script should have already created the default configuration file (<code>config.json</code>) for you.</p>
<p>If default configuration file is not created we recommend you to use <code>freqtrade new-config --config config.json</code> to generate a basic configuration file.</p>
<p>The Freqtrade configuration file is to be written in the JSON format.</p>
<p>Additionally to the standard JSON syntax, you may use one-line <code>// ...</code> and multi-line <code>/* ... */</code> comments in your configuration files and trailing commas in the lists of parameters.</p>
<p>Do not worry if you are not familiar with JSON format -- simply open the configuration file with an editor of your choice, make some changes to the parameters you need, save your changes and, finally, restart the bot or, if it was previously stopped, run it again with the changes you made to the configuration. The bot validates syntax of the configuration file at startup and will warn you if you made any errors editing it, pointing out problematic lines.</p>
<h2 id="configuration-parameters">Configuration parameters<a class="headerlink" href="#configuration-parameters" title="Permanent link">&para;</a></h2>
<p>The table below will list all configuration parameters available.</p>
<p>Freqtrade can also load many options via command line (CLI) arguments (check out the commands <code>--help</code> output for details).
The prevelance for all Options is as follows:</p>
<ul>
<li>CLI arguments override any other option</li>
<li>Configuration files are used in sequence (last file wins), and override Strategy configurations.</li>
<li>Strategy configurations are only used if they are not set via configuration or via command line arguments. These options are marked with <a href="#parameters-in-the-strategy">Strategy Override</a> in the below table.</li>
</ul>
<p>Mandatory parameters are marked as <strong>Required</strong>, which means that they are required to be set in one of the possible ways.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>max_open_trades</code></td>
<td><strong>Required.</strong> Number of open trades your bot is allowed to have. Only one open trade per pair is possible, so the length of your pairlist is another limitation which can apply. If -1 then it is ignored (i.e. potentially unlimited open trades, limited by the pairlist). <a href="#configuring-amount-per-trade">More information below</a>.<br> <strong>Datatype:</strong> Positive integer or -1.</td>
</tr>
<tr>
<td><code>stake_currency</code></td>
<td><strong>Required.</strong> Crypto-currency used for trading. <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>stake_amount</code></td>
<td><strong>Required.</strong> Amount of crypto-currency your bot will use for each trade. Set it to <code>"unlimited"</code> to allow the bot to use all available balance. <a href="#configuring-amount-per-trade">More information below</a>. <br> <strong>Datatype:</strong> Positive float or <code>"unlimited"</code>.</td>
</tr>
<tr>
<td><code>tradable_balance_ratio</code></td>
<td>Ratio of the total account balance the bot is allowed to trade. <a href="#configuring-amount-per-trade">More information below</a>. <br><em>Defaults to <code>0.99</code> 99%).</em><br> <strong>Datatype:</strong> Positive float between <code>0.1</code> and <code>1.0</code>.</td>
</tr>
<tr>
<td><code>amend_last_stake_amount</code></td>
<td>Use reduced last stake amount if necessary. <a href="#configuring-amount-per-trade">More information below</a>. <br><em>Defaults to <code>false</code>.</em> <br> <strong>Datatype:</strong> Boolean</td>
</tr>
<tr>
<td><code>last_stake_amount_min_ratio</code></td>
<td>Defines minimum stake amount that has to be left and executed. Applies only to the last stake amount when it's amended to a reduced value (i.e. if <code>amend_last_stake_amount</code> is set to <code>true</code>). <a href="#configuring-amount-per-trade">More information below</a>. <br><em>Defaults to <code>0.5</code>.</em> <br> <strong>Datatype:</strong> Float (as ratio)</td>
</tr>
<tr>
<td><code>amount_reserve_percent</code></td>
<td>Reserve some amount in min pair stake amount. The bot will reserve <code>amount_reserve_percent</code> + stoploss value when calculating min pair stake amount in order to avoid possible trade refusals. <br><em>Defaults to <code>0.05</code> (5%).</em> <br> <strong>Datatype:</strong> Positive Float as ratio.</td>
</tr>
<tr>
<td><code>timeframe</code></td>
<td>The timeframe (former ticker interval) to use (e.g <code>1m</code>, <code>5m</code>, <code>15m</code>, <code>30m</code>, <code>1h</code> ...). <a href="#parameters-in-the-strategy">Strategy Override</a>. <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>fiat_display_currency</code></td>
<td>Fiat currency used to show your profits. <a href="#what-values-can-be-used-for-fiat_display_currency">More information below</a>. <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>dry_run</code></td>
<td><strong>Required.</strong> Define if the bot must be in Dry Run or production mode. <br><em>Defaults to <code>true</code>.</em> <br> <strong>Datatype:</strong> Boolean</td>
</tr>
<tr>
<td><code>dry_run_wallet</code></td>
<td>Define the starting amount in stake currency for the simulated wallet used by the bot running in Dry Run mode.<br><em>Defaults to <code>1000</code>.</em> <br> <strong>Datatype:</strong> Float</td>
</tr>
<tr>
<td><code>cancel_open_orders_on_exit</code></td>
<td>Cancel open orders when the <code>/stop</code> RPC command is issued, <code>Ctrl+C</code> is pressed or the bot dies unexpectedly. When set to <code>true</code>, this allows you to use <code>/stop</code> to cancel unfilled and partially filled orders in the event of a market crash. It does not impact open positions. <br><em>Defaults to <code>false</code>.</em> <br> <strong>Datatype:</strong> Boolean</td>
</tr>
<tr>
<td><code>process_only_new_candles</code></td>
<td>Enable processing of indicators only when new candles arrive. If false each loop populates the indicators, this will mean the same candle is processed many times creating system load but can be useful of your strategy depends on tick data not only candle. <a href="#parameters-in-the-strategy">Strategy Override</a>. <br><em>Defaults to <code>false</code>.</em> <br> <strong>Datatype:</strong> Boolean</td>
</tr>
<tr>
<td><code>minimal_roi</code></td>
<td><strong>Required.</strong> Set the threshold as ratio the bot will use to sell a trade. <a href="#understand-minimal_roi">More information below</a>. <a href="#parameters-in-the-strategy">Strategy Override</a>. <br> <strong>Datatype:</strong> Dict</td>
</tr>
<tr>
<td><code>stoploss</code></td>
<td><strong>Required.</strong> Value as ratio of the stoploss used by the bot. More details in the <a href="../stoploss/">stoploss documentation</a>. <a href="#parameters-in-the-strategy">Strategy Override</a>. <br> <strong>Datatype:</strong> Float (as ratio)</td>
</tr>
<tr>
<td><code>trailing_stop</code></td>
<td>Enables trailing stoploss (based on <code>stoploss</code> in either configuration or strategy file). More details in the <a href="../stoploss/#trailing-stop-loss">stoploss documentation</a>. <a href="#parameters-in-the-strategy">Strategy Override</a>. <br> <strong>Datatype:</strong> Boolean</td>
</tr>
<tr>
<td><code>trailing_stop_positive</code></td>
<td>Changes stoploss once profit has been reached. More details in the <a href="../stoploss/#trailing-stop-loss-custom-positive-loss">stoploss documentation</a>. <a href="#parameters-in-the-strategy">Strategy Override</a>. <br> <strong>Datatype:</strong> Float</td>
</tr>
<tr>
<td><code>trailing_stop_positive_offset</code></td>
<td>Offset on when to apply <code>trailing_stop_positive</code>. Percentage value which should be positive. More details in the <a href="../stoploss/#trailing-stop-loss-only-once-the-trade-has-reached-a-certain-offset">stoploss documentation</a>. <a href="#parameters-in-the-strategy">Strategy Override</a>. <br><em>Defaults to <code>0.0</code> (no offset).</em> <br> <strong>Datatype:</strong> Float</td>
</tr>
<tr>
<td><code>trailing_only_offset_is_reached</code></td>
<td>Only apply trailing stoploss when the offset is reached. <a href="../stoploss/">stoploss documentation</a>. <a href="#parameters-in-the-strategy">Strategy Override</a>. <br><em>Defaults to <code>false</code>.</em> <br> <strong>Datatype:</strong> Boolean</td>
</tr>
<tr>
<td><code>fee</code></td>
<td>Fee used during backtesting / dry-runs. Should normally not be configured, which has freqtrade fall back to the exchange default fee. Set as ratio (e.g. 0.001 = 0.1%). Fee is applied twice for each trade, once when buying, once when selling. <br> <strong>Datatype:</strong> Float (as ratio)</td>
</tr>
<tr>
<td><code>unfilledtimeout.buy</code></td>
<td><strong>Required.</strong> How long (in minutes) the bot will wait for an unfilled buy order to complete, after which the order will be cancelled and repeated at current (new) price, as long as there is a signal. <a href="#parameters-in-the-strategy">Strategy Override</a>.<br> <strong>Datatype:</strong> Integer</td>
</tr>
<tr>
<td><code>unfilledtimeout.sell</code></td>
<td><strong>Required.</strong> How long (in minutes) the bot will wait for an unfilled sell order to complete, after which the order will be cancelled and repeated at current (new) price, as long as there is a signal. <a href="#parameters-in-the-strategy">Strategy Override</a>.<br> <strong>Datatype:</strong> Integer</td>
</tr>
<tr>
<td><code>bid_strategy.price_side</code></td>
<td>Select the side of the spread the bot should look at to get the buy rate. <a href="#buy-price-side">More information below</a>.<br> <em>Defaults to <code>bid</code>.</em> <br> <strong>Datatype:</strong> String (either <code>ask</code> or <code>bid</code>).</td>
</tr>
<tr>
<td><code>bid_strategy.ask_last_balance</code></td>
<td><strong>Required.</strong> Interpolate the bidding price. More information <a href="#buy-price-without-orderbook-enabled">below</a>.</td>
</tr>
<tr>
<td><code>bid_strategy.use_order_book</code></td>
<td>Enable buying using the rates in <a href="#buy-price-with-orderbook-enabled">Order Book Bids</a>. <br> <strong>Datatype:</strong> Boolean</td>
</tr>
<tr>
<td><code>bid_strategy.order_book_top</code></td>
<td>Bot will use the top N rate in Order Book Bids to buy. I.e. a value of 2 will allow the bot to pick the 2<sup>nd</sup> bid rate in <a href="#buy-price-with-orderbook-enabled">Order Book Bids</a>. <br><em>Defaults to <code>1</code>.</em> <br> <strong>Datatype:</strong> Positive Integer</td>
</tr>
<tr>
<td><code>bid_strategy. check_depth_of_market.enabled</code></td>
<td>Do not buy if the difference of buy orders and sell orders is met in Order Book. <a href="#check-depth-of-market">Check market depth</a>. <br><em>Defaults to <code>false</code>.</em> <br> <strong>Datatype:</strong> Boolean</td>
</tr>
<tr>
<td><code>bid_strategy. check_depth_of_market.bids_to_ask_delta</code></td>
<td>The difference ratio of buy orders and sell orders found in Order Book. A value below 1 means sell order size is greater, while value greater than 1 means buy order size is higher. <a href="#check-depth-of-market">Check market depth</a> <br> <em>Defaults to <code>0</code>.</em> <br> <strong>Datatype:</strong> Float (as ratio)</td>
</tr>
<tr>
<td><code>ask_strategy.price_side</code></td>
<td>Select the side of the spread the bot should look at to get the sell rate. <a href="#sell-price-side">More information below</a>.<br> <em>Defaults to <code>ask</code>.</em> <br> <strong>Datatype:</strong> String (either <code>ask</code> or <code>bid</code>).</td>
</tr>
<tr>
<td><code>ask_strategy.bid_last_balance</code></td>
<td>Interpolate the selling price. More information <a href="#sell-price-without-orderbook-enabled">below</a>.</td>
</tr>
<tr>
<td><code>ask_strategy.use_order_book</code></td>
<td>Enable selling of open trades using <a href="#sell-price-with-orderbook-enabled">Order Book Asks</a>. <br> <strong>Datatype:</strong> Boolean</td>
</tr>
<tr>
<td><code>ask_strategy.order_book_min</code></td>
<td>Bot will scan from the top min to max Order Book Asks searching for a profitable rate. <br><em>Defaults to <code>1</code>.</em> <br> <strong>Datatype:</strong> Positive Integer</td>
</tr>
<tr>
<td><code>ask_strategy.order_book_max</code></td>
<td>Bot will scan from the top min to max Order Book Asks searching for a profitable rate. <br><em>Defaults to <code>1</code>.</em> <br> <strong>Datatype:</strong> Positive Integer</td>
</tr>
<tr>
<td><code>ask_strategy.use_sell_signal</code></td>
<td>Use sell signals produced by the strategy in addition to the <code>minimal_roi</code>. <a href="#parameters-in-the-strategy">Strategy Override</a>. <br><em>Defaults to <code>true</code>.</em> <br> <strong>Datatype:</strong> Boolean</td>
</tr>
<tr>
<td><code>ask_strategy.sell_profit_only</code></td>
<td>Wait until the bot reaches <code>ask_strategy.sell_profit_offset</code> before taking a sell decision. <a href="#parameters-in-the-strategy">Strategy Override</a>. <br><em>Defaults to <code>false</code>.</em> <br> <strong>Datatype:</strong> Boolean</td>
</tr>
<tr>
<td><code>ask_strategy.sell_profit_offset</code></td>
<td>Sell-signal is only active above this value. <a href="#parameters-in-the-strategy">Strategy Override</a>. <br><em>Defaults to <code>0.0</code>.</em> <br> <strong>Datatype:</strong> Float (as ratio)</td>
</tr>
<tr>
<td><code>ask_strategy.ignore_roi_if_buy_signal</code></td>
<td>Do not sell if the buy signal is still active. This setting takes preference over <code>minimal_roi</code> and <code>use_sell_signal</code>. <a href="#parameters-in-the-strategy">Strategy Override</a>. <br><em>Defaults to <code>false</code>.</em> <br> <strong>Datatype:</strong> Boolean</td>
</tr>
<tr>
<td><code>ask_strategy.ignore_buying_expired_candle_after</code></td>
<td>Specifies the number of seconds until a buy signal is no longer used. <br> <strong>Datatype:</strong> Integer</td>
</tr>
<tr>
<td><code>order_types</code></td>
<td>Configure order-types depending on the action (<code>"buy"</code>, <code>"sell"</code>, <code>"stoploss"</code>, <code>"stoploss_on_exchange"</code>). <a href="#understand-order_types">More information below</a>. <a href="#parameters-in-the-strategy">Strategy Override</a>.<br> <strong>Datatype:</strong> Dict</td>
</tr>
<tr>
<td><code>order_time_in_force</code></td>
<td>Configure time in force for buy and sell orders. <a href="#understand-order_time_in_force">More information below</a>. <a href="#parameters-in-the-strategy">Strategy Override</a>. <br> <strong>Datatype:</strong> Dict</td>
</tr>
<tr>
<td><code>exchange.name</code></td>
<td><strong>Required.</strong> Name of the exchange class to use. <a href="#user-content-what-values-for-exchangename">List below</a>. <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>exchange.sandbox</code></td>
<td>Use the 'sandbox' version of the exchange, where the exchange provides a sandbox for risk-free integration. See <a href="../sandbox-testing/">here</a> in more details.<br> <strong>Datatype:</strong> Boolean</td>
</tr>
<tr>
<td><code>exchange.key</code></td>
<td>API key to use for the exchange. Only required when you are in production mode.<br><strong>Keep it in secret, do not disclose publicly.</strong> <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>exchange.secret</code></td>
<td>API secret to use for the exchange. Only required when you are in production mode.<br><strong>Keep it in secret, do not disclose publicly.</strong> <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>exchange.password</code></td>
<td>API password to use for the exchange. Only required when you are in production mode and for exchanges that use password for API requests.<br><strong>Keep it in secret, do not disclose publicly.</strong> <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>exchange.pair_whitelist</code></td>
<td>List of pairs to use by the bot for trading and to check for potential trades during backtesting. Supports regex pairs as <code>.*/BTC</code>. Not used by VolumePairList. <a href="../plugins/#pairlists-and-pairlist-handlers">More information</a>. <br> <strong>Datatype:</strong> List</td>
</tr>
<tr>
<td><code>exchange.pair_blacklist</code></td>
<td>List of pairs the bot must absolutely avoid for trading and backtesting. <a href="../plugins/#pairlists-and-pairlist-handlers">More information</a>. <br> <strong>Datatype:</strong> List</td>
</tr>
<tr>
<td><code>exchange.ccxt_config</code></td>
<td>Additional CCXT parameters passed to both ccxt instances (sync and async). This is usually the correct place for ccxt configurations. Parameters may differ from exchange to exchange and are documented in the <a href="https://ccxt.readthedocs.io/en/latest/manual.html#instantiation">ccxt documentation</a> <br> <strong>Datatype:</strong> Dict</td>
</tr>
<tr>
<td><code>exchange.ccxt_sync_config</code></td>
<td>Additional CCXT parameters passed to the regular (sync) ccxt instance. Parameters may differ from exchange to exchange and are documented in the <a href="https://ccxt.readthedocs.io/en/latest/manual.html#instantiation">ccxt documentation</a> <br> <strong>Datatype:</strong> Dict</td>
</tr>
<tr>
<td><code>exchange.ccxt_async_config</code></td>
<td>Additional CCXT parameters passed to the async ccxt instance. Parameters may differ from exchange to exchange and are documented in the <a href="https://ccxt.readthedocs.io/en/latest/manual.html#instantiation">ccxt documentation</a> <br> <strong>Datatype:</strong> Dict</td>
</tr>
<tr>
<td><code>exchange.markets_refresh_interval</code></td>
<td>The interval in minutes in which markets are reloaded. <br><em>Defaults to <code>60</code> minutes.</em> <br> <strong>Datatype:</strong> Positive Integer</td>
</tr>
<tr>
<td><code>exchange.skip_pair_validation</code></td>
<td>Skip pairlist validation on startup.<br><em>Defaults to <code>false</code><br> </em><em>Datatype:</em>* Boolean</td>
</tr>
<tr>
<td><code>exchange.skip_open_order_update</code></td>
<td>Skips open order updates on startup should the exchange cause problems. Only relevant in live conditions.<br><em>Defaults to <code>false</code><br> </em><em>Datatype:</em>* Boolean</td>
</tr>
<tr>
<td><code>edge.*</code></td>
<td>Please refer to <a href="../edge/">edge configuration document</a> for detailed explanation.</td>
</tr>
<tr>
<td><code>experimental.block_bad_exchanges</code></td>
<td>Block exchanges known to not work with freqtrade. Leave on default unless you want to test if that exchange works now. <br><em>Defaults to <code>true</code>.</em> <br> <strong>Datatype:</strong> Boolean</td>
</tr>
<tr>
<td><code>pairlists</code></td>
<td>Define one or more pairlists to be used. <a href="../plugins/#pairlists-and-pairlist-handlers">More information</a>. <br><em>Defaults to <code>StaticPairList</code>.</em> <br> <strong>Datatype:</strong> List of Dicts</td>
</tr>
<tr>
<td><code>protections</code></td>
<td>Define one or more protections to be used. <a href="../plugins/#protections">More information</a>. <a href="#parameters-in-the-strategy">Strategy Override</a>. <br> <strong>Datatype:</strong> List of Dicts</td>
</tr>
<tr>
<td><code>telegram.enabled</code></td>
<td>Enable the usage of Telegram. <br> <strong>Datatype:</strong> Boolean</td>
</tr>
<tr>
<td><code>telegram.token</code></td>
<td>Your Telegram bot token. Only required if <code>telegram.enabled</code> is <code>true</code>. <br><strong>Keep it in secret, do not disclose publicly.</strong> <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>telegram.chat_id</code></td>
<td>Your personal Telegram account id. Only required if <code>telegram.enabled</code> is <code>true</code>. <br><strong>Keep it in secret, do not disclose publicly.</strong> <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>telegram.balance_dust_level</code></td>
<td>Dust-level (in stake currency) - currencies with a balance below this will not be shown by <code>/balance</code>. <br> <strong>Datatype:</strong> float</td>
</tr>
<tr>
<td><code>webhook.enabled</code></td>
<td>Enable usage of Webhook notifications <br> <strong>Datatype:</strong> Boolean</td>
</tr>
<tr>
<td><code>webhook.url</code></td>
<td>URL for the webhook. Only required if <code>webhook.enabled</code> is <code>true</code>. See the <a href="../webhook-config/">webhook documentation</a> for more details. <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>webhook.webhookbuy</code></td>
<td>Payload to send on buy. Only required if <code>webhook.enabled</code> is <code>true</code>. See the <a href="../webhook-config/">webhook documentation</a> for more details. <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>webhook.webhookbuycancel</code></td>
<td>Payload to send on buy order cancel. Only required if <code>webhook.enabled</code> is <code>true</code>. See the <a href="../webhook-config/">webhook documentation</a> for more details. <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>webhook.webhooksell</code></td>
<td>Payload to send on sell. Only required if <code>webhook.enabled</code> is <code>true</code>. See the <a href="../webhook-config/">webhook documentation</a> for more details. <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>webhook.webhooksellcancel</code></td>
<td>Payload to send on sell order cancel. Only required if <code>webhook.enabled</code> is <code>true</code>. See the <a href="../webhook-config/">webhook documentation</a> for more details. <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>webhook.webhookstatus</code></td>
<td>Payload to send on status calls. Only required if <code>webhook.enabled</code> is <code>true</code>. See the <a href="../webhook-config/">webhook documentation</a> for more details. <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>api_server.enabled</code></td>
<td>Enable usage of API Server. See the <a href="../rest-api/">API Server documentation</a> for more details. <br> <strong>Datatype:</strong> Boolean</td>
</tr>
<tr>
<td><code>api_server.listen_ip_address</code></td>
<td>Bind IP address. See the <a href="../rest-api/">API Server documentation</a> for more details. <br> <strong>Datatype:</strong> IPv4</td>
</tr>
<tr>
<td><code>api_server.listen_port</code></td>
<td>Bind Port. See the <a href="../rest-api/">API Server documentation</a> for more details. <br><strong>Datatype:</strong> Integer between 1024 and 65535</td>
</tr>
<tr>
<td><code>api_server.verbosity</code></td>
<td>Logging verbosity. <code>info</code> will print all RPC Calls, while "error" will only display errors. <br><strong>Datatype:</strong> Enum, either <code>info</code> or <code>error</code>. Defaults to <code>info</code>.</td>
</tr>
<tr>
<td><code>api_server.username</code></td>
<td>Username for API server. See the <a href="../rest-api/">API Server documentation</a> for more details. <br><strong>Keep it in secret, do not disclose publicly.</strong><br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>api_server.password</code></td>
<td>Password for API server. See the <a href="../rest-api/">API Server documentation</a> for more details. <br><strong>Keep it in secret, do not disclose publicly.</strong><br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>bot_name</code></td>
<td>Name of the bot. Passed via API to a client - can be shown to distinguish / name bots.<br> <em>Defaults to <code>freqtrade</code></em><br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>db_url</code></td>
<td>Declares database URL to use. NOTE: This defaults to <code>sqlite:///tradesv3.dryrun.sqlite</code> if <code>dry_run</code> is <code>true</code>, and to <code>sqlite:///tradesv3.sqlite</code> for production instances. <br> <strong>Datatype:</strong> String, SQLAlchemy connect string</td>
</tr>
<tr>
<td><code>initial_state</code></td>
<td>Defines the initial application state. If set to stopped, then the bot has to be explicitly started via <code>/start</code> RPC command. <br><em>Defaults to <code>stopped</code>.</em> <br> <strong>Datatype:</strong> Enum, either <code>stopped</code> or <code>running</code></td>
</tr>
<tr>
<td><code>forcebuy_enable</code></td>
<td>Enables the RPC Commands to force a buy. More information below. <br> <strong>Datatype:</strong> Boolean</td>
</tr>
<tr>
<td><code>disable_dataframe_checks</code></td>
<td>Disable checking the OHLCV dataframe returned from the strategy methods for correctness. Only use when intentionally changing the dataframe and understand what you are doing. <a href="#parameters-in-the-strategy">Strategy Override</a>.<br> <em>Defaults to <code>False</code></em>. <br> <strong>Datatype:</strong> Boolean</td>
</tr>
<tr>
<td><code>strategy</code></td>
<td><strong>Required</strong> Defines Strategy class to use. Recommended to be set via <code>--strategy NAME</code>. <br> <strong>Datatype:</strong> ClassName</td>
</tr>
<tr>
<td><code>strategy_path</code></td>
<td>Adds an additional strategy lookup path (must be a directory). <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>internals.process_throttle_secs</code></td>
<td>Set the process throttle, or minimum loop duration for one bot iteration loop. Value in second. <br><em>Defaults to <code>5</code> seconds.</em> <br> <strong>Datatype:</strong> Positive Integer</td>
</tr>
<tr>
<td><code>internals.heartbeat_interval</code></td>
<td>Print heartbeat message every N seconds. Set to 0 to disable heartbeat messages. <br><em>Defaults to <code>60</code> seconds.</em> <br> <strong>Datatype:</strong> Positive Integer or 0</td>
</tr>
<tr>
<td><code>internals.sd_notify</code></td>
<td>Enables use of the sd_notify protocol to tell systemd service manager about changes in the bot state and issue keep-alive pings. See <a href="../installation/#7-optional-configure-freqtrade-as-a-systemd-service">here</a> for more details. <br> <strong>Datatype:</strong> Boolean</td>
</tr>
<tr>
<td><code>logfile</code></td>
<td>Specifies logfile name. Uses a rolling strategy for log file rotation for 10 files with the 1MB limit per file. <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>user_data_dir</code></td>
<td>Directory containing user data. <br> <em>Defaults to <code>./user_data/</code></em>. <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>dataformat_ohlcv</code></td>
<td>Data format to use to store historical candle (OHLCV) data. <br> <em>Defaults to <code>json</code></em>. <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>dataformat_trades</code></td>
<td>Data format to use to store historical trades data. <br> <em>Defaults to <code>jsongz</code></em>. <br> <strong>Datatype:</strong> String</td>
</tr>
</tbody>
</table>
<h3 id="parameters-in-the-strategy">Parameters in the strategy<a class="headerlink" href="#parameters-in-the-strategy" title="Permanent link">&para;</a></h3>
<p>The following parameters can be set in either configuration file or strategy.
Values set in the configuration file always overwrite values set in the strategy.</p>
<ul>
<li><code>minimal_roi</code></li>
<li><code>timeframe</code></li>
<li><code>stoploss</code></li>
<li><code>trailing_stop</code></li>
<li><code>trailing_stop_positive</code></li>
<li><code>trailing_stop_positive_offset</code></li>
<li><code>trailing_only_offset_is_reached</code></li>
<li><code>use_custom_stoploss</code></li>
<li><code>process_only_new_candles</code></li>
<li><code>order_types</code></li>
<li><code>order_time_in_force</code></li>
<li><code>unfilledtimeout</code></li>
<li><code>disable_dataframe_checks</code></li>
<li><code>protections</code></li>
<li><code>use_sell_signal</code> (ask_strategy)</li>
<li><code>sell_profit_only</code> (ask_strategy)</li>
<li><code>sell_profit_offset</code> (ask_strategy)</li>
<li><code>ignore_roi_if_buy_signal</code> (ask_strategy)</li>
<li><code>ignore_buying_expired_candle_after</code> (ask_strategy)</li>
</ul>
<h3 id="configuring-amount-per-trade">Configuring amount per trade<a class="headerlink" href="#configuring-amount-per-trade" title="Permanent link">&para;</a></h3>
<p>There are several methods to configure how much of the stake currency the bot will use to enter a trade. All methods respect the <a href="#available-balance">available balance configuration</a> as explained below.</p>
<h4 id="minimum-trade-stake">Minimum trade stake<a class="headerlink" href="#minimum-trade-stake" title="Permanent link">&para;</a></h4>
<p>The minimum stake amount will depend by exchange and pair, and is usually listed in the exchange support pages.
Assuming the minimum tradable amount for XRP/USD is 20 XRP (given by the exchange), and the price is 0.4$.</p>
<p>The minimum stake amount to buy this pair is therefore <code>20 * 0.6 ~= 12</code>.
This exchange has also a limit on USD - where all orders must be &gt; 10$ - which however does not apply in this case.</p>
<p>To guarantee safe execution, freqtrade will not allow buying with a stake-amount of 10.1$, instead, it'll make sure that there's enough space to place a stoploss below the pair (+ an offset, defined by <code>amount_reserve_percent</code>, which defaults to 5%).</p>
<p>With a reserve of 5%, the minimum stake amount would be ~12.6$ (<code>12 * (1 + 0.05)</code>). If we take in account a stoploss of 10% on top of that - we'd end up with a value of ~14$ (<code>12.6 / (1 - 0.1)</code>).</p>
<p>To limit this calculation in case of large stoploss values, the calculated minimum stake-limit will never be more than 50% above the real limit.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Since the limits on exchanges are usually stable and are not updated often, some pairs can show pretty high minimum limits, simply because the price increased a lot since the last limit adjustment by the exchange.</p>
</div>
<h4 id="available-balance">Available balance<a class="headerlink" href="#available-balance" title="Permanent link">&para;</a></h4>
<p>By default, the bot assumes that the <code>complete amount - 1%</code> is at it's disposal, and when using <a href="#dynamic-stake-amount">dynamic stake amount</a>, it will split the complete balance into <code>max_open_trades</code> buckets per trade.
Freqtrade will reserve 1% for eventual fees when entering a trade and will therefore not touch that by default.</p>
<p>You can configure the "untouched" amount by using the <code>tradable_balance_ratio</code> setting.</p>
<p>For example, if you have 10 ETH available in your wallet on the exchange and <code>tradable_balance_ratio=0.5</code> (which is 50%), then the bot will use a maximum amount of 5 ETH for trading and considers this as available balance. The rest of the wallet is untouched by the trades.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>The <code>tradable_balance_ratio</code> setting applies to the current balance (free balance + tied up in trades). Therefore, assuming the starting balance of 1000, a configuration with <code>tradable_balance_ratio=0.99</code> will not guarantee that 10 currency units will always remain available on the exchange. For example, the free amount may reduce to 5 units if the total balance is reduced to 500 (either by a losing streak, or by withdrawing balance).</p>
</div>
<h4 id="amend-last-stake-amount">Amend last stake amount<a class="headerlink" href="#amend-last-stake-amount" title="Permanent link">&para;</a></h4>
<p>Assuming we have the tradable balance of 1000 USDT, <code>stake_amount=400</code>, and <code>max_open_trades=3</code>.
The bot would open 2 trades, and will be unable to fill the last trading slot, since the requested 400 USDT are no longer available, since 800 USDT are already tied in other trades.</p>
<p>To overcome this, the option <code>amend_last_stake_amount</code> can be set to <code>True</code>, which will enable the bot to reduce stake_amount to the available balance in order to fill the last trade slot.</p>
<p>In the example above this would mean:</p>
<ul>
<li>Trade1: 400 USDT</li>
<li>Trade2: 400 USDT</li>
<li>Trade3: 200 USDT</li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This option only applies with <a href="#static-stake-amount">Static stake amount</a> - since <a href="#dynamic-stake-amount">Dynamic stake amount</a> divides the balances evenly.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The minimum last stake amount can be configured using <code>last_stake_amount_min_ratio</code> - which defaults to 0.5 (50%). This means that the minimum stake amount that's ever used is <code>stake_amount * 0.5</code>. This avoids very low stake amounts, that are close to the minimum tradable amount for the pair and can be refused by the exchange.</p>
</div>
<h4 id="static-stake-amount">Static stake amount<a class="headerlink" href="#static-stake-amount" title="Permanent link">&para;</a></h4>
<p>The <code>stake_amount</code> configuration statically configures the amount of stake-currency your bot will use for each trade.</p>
<p>The minimal configuration value is 0.0001, however, please check your exchange's trading minimums for the stake currency you're using to avoid problems.</p>
<p>This setting works in combination with <code>max_open_trades</code>. The maximum capital engaged in trades is <code>stake_amount * max_open_trades</code>.
For example, the bot will at most use (0.05 BTC x 3) = 0.15 BTC, assuming a configuration of <code>max_open_trades=3</code> and <code>stake_amount=0.05</code>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This setting respects the <a href="#available-balance">available balance configuration</a>.</p>
</div>
<h4 id="dynamic-stake-amount">Dynamic stake amount<a class="headerlink" href="#dynamic-stake-amount" title="Permanent link">&para;</a></h4>
<p>Alternatively, you can use a dynamic stake amount, which will use the available balance on the exchange, and divide that equally by the amount of allowed trades (<code>max_open_trades</code>).</p>
<p>To configure this, set <code>stake_amount="unlimited"</code>. We also recommend to set <code>tradable_balance_ratio=0.99</code> (99%) - to keep a minimum balance for eventual fees.</p>
<p>In this case a trade amount is calculated as:</p>
<p><code>python
currency_balance / (max_open_trades - current_open_trades)</code></p>
<p>To allow the bot to trade all the available <code>stake_currency</code> in your account (minus <code>tradable_balance_ratio</code>) set</p>
<p><code>json
"stake_amount" : "unlimited",
"tradable_balance_ratio": 0.99,</code></p>
<div class="admonition tip">
<p class="admonition-title">Compounding profits</p>
<p>This configuration will allow increasing / decreasing stakes depending on the performance of the bot (lower stake if bot is loosing, higher stakes if the bot has a winning record, since higher balances are available), and will result in profit compounding.</p>
</div>
<div class="admonition note">
<p class="admonition-title">When using Dry-Run Mode</p>
<p>When using <code>"stake_amount" : "unlimited",</code> in combination with Dry-Run, Backtesting or Hyperopt, the balance will be simulated starting with a stake of <code>dry_run_wallet</code> which will evolve over time.<br />
It is therefore important to set <code>dry_run_wallet</code> to a sensible value (like 0.05 or 0.01 for BTC and 1000 or 100 for USDT, for example), otherwise it may simulate trades with 100 BTC (or more) or 0.05 USDT (or less) at once - which may not correspond to your real available balance or is less than the exchange minimal limit for the order amount for the stake currency.</p>
</div>
<h2 id="prices-used-for-orders">Prices used for orders<a class="headerlink" href="#prices-used-for-orders" title="Permanent link">&para;</a></h2>
<p>Prices for regular orders can be controlled via the parameter structures <code>bid_strategy</code> for buying and <code>ask_strategy</code> for selling.
Prices are always retrieved right before an order is placed, either by querying the exchange tickers or by using the orderbook data.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Orderbook data used by Freqtrade are the data retrieved from exchange by the ccxt's function <code>fetch_order_book()</code>, i.e. are usually data from the L2-aggregated orderbook, while the ticker data are the structures returned by the ccxt's <code>fetch_ticker()</code>/<code>fetch_tickers()</code> functions. Refer to the ccxt library <a href="https://github.com/ccxt/ccxt/wiki/Manual#market-data">documentation</a> for more details.</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Using market orders</p>
<p>Please read the section <a href="#market-order-pricing">Market order pricing</a> section when using market orders.</p>
</div>
<h3 id="buy-price">Buy price<a class="headerlink" href="#buy-price" title="Permanent link">&para;</a></h3>
<h4 id="check-depth-of-market">Check depth of market<a class="headerlink" href="#check-depth-of-market" title="Permanent link">&para;</a></h4>
<p>When check depth of market is enabled (<code>bid_strategy.check_depth_of_market.enabled=True</code>), the buy signals are filtered based on the orderbook depth (sum of all amounts) for each orderbook side.</p>
<p>Orderbook <code>bid</code> (buy) side depth is then divided by the orderbook <code>ask</code> (sell) side depth and the resulting delta is compared to the value of the <code>bid_strategy.check_depth_of_market.bids_to_ask_delta</code> parameter. The buy order is only executed if the orderbook delta is greater than or equal to the configured delta value.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>A delta value below 1 means that <code>ask</code> (sell) orderbook side depth is greater than the depth of the <code>bid</code> (buy) orderbook side, while a value greater than 1 means opposite (depth of the buy side is higher than the depth of the sell side).</p>
</div>
<h4 id="buy-price-side">Buy price side<a class="headerlink" href="#buy-price-side" title="Permanent link">&para;</a></h4>
<p>The configuration setting <code>bid_strategy.price_side</code> defines the side of the spread the bot looks for when buying.</p>
<p>The following displays an orderbook.</p>
<p><code>explanation
...
103
102
101 # ask
-------------Current spread
99 # bid
98
97
...</code></p>
<p>If <code>bid_strategy.price_side</code> is set to <code>"bid"</code>, then the bot will use 99 as buying price.<br />
In line with that, if <code>bid_strategy.price_side</code> is set to <code>"ask"</code>, then the bot will use 101 as buying price.</p>
<p>Using <code>ask</code> price often guarantees quicker filled orders, but the bot can also end up paying more than what would have been necessary.
Taker fees instead of maker fees will most likely apply even when using limit buy orders.
Also, prices at the "ask" side of the spread are higher than prices at the "bid" side in the orderbook, so the order behaves similar to a market order (however with a maximum price).</p>
<h4 id="buy-price-with-orderbook-enabled">Buy price with Orderbook enabled<a class="headerlink" href="#buy-price-with-orderbook-enabled" title="Permanent link">&para;</a></h4>
<p>When buying with the orderbook enabled (<code>bid_strategy.use_order_book=True</code>), Freqtrade fetches the <code>bid_strategy.order_book_top</code> entries from the orderbook and then uses the entry specified as <code>bid_strategy.order_book_top</code> on the configured side (<code>bid_strategy.price_side</code>) of the orderbook. 1 specifies the topmost entry in the orderbook, while 2 would use the 2<sup>nd</sup> entry in the orderbook, and so on.</p>
<h4 id="buy-price-without-orderbook-enabled">Buy price without Orderbook enabled<a class="headerlink" href="#buy-price-without-orderbook-enabled" title="Permanent link">&para;</a></h4>
<p>The following section uses <code>side</code> as the configured <code>bid_strategy.price_side</code>.</p>
<p>When not using orderbook (<code>bid_strategy.use_order_book=False</code>), Freqtrade uses the best <code>side</code> price from the ticker if it's below the <code>last</code> traded price from the ticker. Otherwise (when the <code>side</code> price is above the <code>last</code> price), it calculates a rate between <code>side</code> and <code>last</code> price.</p>
<p>The <code>bid_strategy.ask_last_balance</code> configuration parameter controls this. A value of <code>0.0</code> will use <code>side</code> price, while <code>1.0</code> will use the <code>last</code> price and values between those interpolate between ask and last price.</p>
<h3 id="sell-price">Sell price<a class="headerlink" href="#sell-price" title="Permanent link">&para;</a></h3>
<h4 id="sell-price-side">Sell price side<a class="headerlink" href="#sell-price-side" title="Permanent link">&para;</a></h4>
<p>The configuration setting <code>ask_strategy.price_side</code> defines the side of the spread the bot looks for when selling.</p>
<p>The following displays an orderbook:</p>
<p><code>explanation
...
103
102
101 # ask
-------------Current spread
99 # bid
98
97
...</code></p>
<p>If <code>ask_strategy.price_side</code> is set to <code>"ask"</code>, then the bot will use 101 as selling price.<br />
In line with that, if <code>ask_strategy.price_side</code> is set to <code>"bid"</code>, then the bot will use 99 as selling price.</p>
<h4 id="sell-price-with-orderbook-enabled">Sell price with Orderbook enabled<a class="headerlink" href="#sell-price-with-orderbook-enabled" title="Permanent link">&para;</a></h4>
<p>When selling with the orderbook enabled (<code>ask_strategy.use_order_book=True</code>), Freqtrade fetches the <code>ask_strategy.order_book_max</code> entries in the orderbook. Then each of the orderbook steps between <code>ask_strategy.order_book_min</code> and <code>ask_strategy.order_book_max</code> on the configured orderbook side are validated for a profitable sell-possibility based on the strategy configuration (<code>minimal_roi</code> conditions) and the sell order is placed at the first profitable spot.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Using <code>order_book_max</code> higher than <code>order_book_min</code> only makes sense when ask_strategy.price_side is set to <code>"ask"</code>.</p>
</div>
<p>The idea here is to place the sell order early, to be ahead in the queue.</p>
<p>A fixed slot (mirroring <code>bid_strategy.order_book_top</code>) can be defined by setting <code>ask_strategy.order_book_min</code> and <code>ask_strategy.order_book_max</code> to the same number.</p>
<div class="admonition warning">
<p class="admonition-title">Order_book_max &gt; 1 - increased risks for stoplosses!</p>
<p>Using <code>ask_strategy.order_book_max</code> higher than 1 will increase the risk the stoploss on exchange is cancelled too early, since an eventual <a href="#understand-order_types">stoploss on exchange</a> will be cancelled as soon as the order is placed.
Also, the sell order will remain on the exchange for <code>unfilledtimeout.sell</code> (or until it's filled) - which can lead to missed stoplosses (with or without using stoploss on exchange).</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Order_book_max &gt; 1 in dry-run</p>
<p>Using <code>ask_strategy.order_book_max</code> higher than 1 will result in improper dry-run results (significantly better than real orders executed on exchange), since dry-run assumes orders to be filled almost instantly.
It is therefore advised to not use this setting for dry-runs.</p>
</div>
<h4 id="sell-price-without-orderbook-enabled">Sell price without Orderbook enabled<a class="headerlink" href="#sell-price-without-orderbook-enabled" title="Permanent link">&para;</a></h4>
<p>When not using orderbook (<code>ask_strategy.use_order_book=False</code>), the price at the <code>ask_strategy.price_side</code> side (defaults to <code>"ask"</code>) from the ticker will be used as the sell price.</p>
<p>When not using orderbook (<code>ask_strategy.use_order_book=False</code>), Freqtrade uses the best <code>side</code> price from the ticker if it's below the <code>last</code> traded price from the ticker. Otherwise (when the <code>side</code> price is above the <code>last</code> price), it calculates a rate between <code>side</code> and <code>last</code> price.</p>
<p>The <code>ask_strategy.bid_last_balance</code> configuration parameter controls this. A value of <code>0.0</code> will use <code>side</code> price, while <code>1.0</code> will use the last price and values between those interpolate between <code>side</code> and last price.</p>
<h3 id="market-order-pricing">Market order pricing<a class="headerlink" href="#market-order-pricing" title="Permanent link">&para;</a></h3>
<p>When using market orders, prices should be configured to use the "correct" side of the orderbook to allow realistic pricing detection.
Assuming both buy and sell are using market orders, a configuration similar to the following might be used</p>
<p><code>jsonc
"order_types": {
"buy": "market",
"sell": "market"
// ...
},
"bid_strategy": {
"price_side": "ask",
// ...
},
"ask_strategy":{
"price_side": "bid",
// ...
},</code></p>
<p>Obviously, if only one side is using limit orders, different pricing combinations can be used.</p>
<h3 id="understand-minimal_roi">Understand minimal_roi<a class="headerlink" href="#understand-minimal_roi" title="Permanent link">&para;</a></h3>
<p>The <code>minimal_roi</code> configuration parameter is a JSON object where the key is a duration
in minutes and the value is the minimum ROI as ratio.
See the example below:</p>
<p><code>json
"minimal_roi": {
"40": 0.0, # Sell after 40 minutes if the profit is not negative
"30": 0.01, # Sell after 30 minutes if there is at least 1% profit
"20": 0.02, # Sell after 20 minutes if there is at least 2% profit
"0": 0.04 # Sell immediately if there is at least 4% profit
},</code></p>
<p>Most of the strategy files already include the optimal <code>minimal_roi</code> value.
This parameter can be set in either Strategy or Configuration file. If you use it in the configuration file, it will override the
<code>minimal_roi</code> value from the strategy file.
If it is not set in either Strategy or Configuration, a default of 1000% <code>{"0": 10}</code> is used, and minimal roi is disabled unless your trade generates 1000% profit.</p>
<div class="admonition note">
<p class="admonition-title">Special case to forcesell after a specific time</p>
<p>A special case presents using <code>"&lt;N&gt;": -1</code> as ROI. This forces the bot to sell a trade after N Minutes, no matter if it's positive or negative, so represents a time-limited force-sell.</p>
</div>
<h3 id="understand-forcebuy_enable">Understand forcebuy_enable<a class="headerlink" href="#understand-forcebuy_enable" title="Permanent link">&para;</a></h3>
<p>The <code>forcebuy_enable</code> configuration parameter enables the usage of forcebuy commands via Telegram and REST API.
For security reasons, it's disabled by default, and freqtrade will show a warning message on startup if enabled.
For example, you can send <code>/forcebuy ETH/BTC</code> to the bot, which will result in freqtrade buying the pair and holds it until a regular sell-signal (ROI, stoploss, /forcesell) appears.</p>
<p>This can be dangerous with some strategies, so use with care.</p>
<p>See <a href="../telegram-usage/">the telegram documentation</a> for details on usage.</p>
<h3 id="ignoring-expired-candles">Ignoring expired candles<a class="headerlink" href="#ignoring-expired-candles" title="Permanent link">&para;</a></h3>
<p>When working with larger timeframes (for example 1h or more) and using a low <code>max_open_trades</code> value, the last candle can be processed as soon as a trade slot becomes available. When processing the last candle, this can lead to a situation where it may not be desirable to use the buy signal on that candle. For example, when using a condition in your strategy where you use a cross-over, that point may have passed too long ago for you to start a trade on it.</p>
<p>In these situations, you can enable the functionality to ignore candles that are beyond a specified period by setting <code>ask_strategy.ignore_buying_expired_candle_after</code> to a positive number, indicating the number of seconds after which the buy signal becomes expired.</p>
<p>For example, if your strategy is using a 1h timeframe, and you only want to buy within the first 5 minutes when a new candle comes in, you can add the following configuration to your strategy:</p>
<p><code>json
"ask_strategy":{
"ignore_buying_expired_candle_after": 300,
"price_side": "bid",
// ...
},</code></p>
<h3 id="understand-order_types">Understand order_types<a class="headerlink" href="#understand-order_types" title="Permanent link">&para;</a></h3>
<p>The <code>order_types</code> configuration parameter maps actions (<code>buy</code>, <code>sell</code>, <code>stoploss</code>, <code>emergencysell</code>, <code>forcesell</code>, <code>forcebuy</code>) to order-types (<code>market</code>, <code>limit</code>, ...) as well as configures stoploss to be on the exchange and defines stoploss on exchange update interval in seconds.</p>
<p>This allows to buy using limit orders, sell using
limit-orders, and create stoplosses using market orders. It also allows to set the
stoploss "on exchange" which means stoploss order would be placed immediately once
the buy order is fulfilled.</p>
<p><code>order_types</code> set in the configuration file overwrites values set in the strategy as a whole, so you need to configure the whole <code>order_types</code> dictionary in one place.</p>
<p>If this is configured, the following 4 values (<code>buy</code>, <code>sell</code>, <code>stoploss</code> and
<code>stoploss_on_exchange</code>) need to be present, otherwise the bot will fail to start.</p>
<p>For information on (<code>emergencysell</code>,<code>forcesell</code>, <code>forcebuy</code>, <code>stoploss_on_exchange</code>,<code>stoploss_on_exchange_interval</code>,<code>stoploss_on_exchange_limit_ratio</code>) please see stop loss documentation <a href="../stoploss/">stop loss on exchange</a></p>
<p>Syntax for Strategy:</p>
<p><code>python
order_types = {
"buy": "limit",
"sell": "limit",
"emergencysell": "market",
"forcebuy": "market",
"forcesell": "market",
"stoploss": "market",
"stoploss_on_exchange": False,
"stoploss_on_exchange_interval": 60,
"stoploss_on_exchange_limit_ratio": 0.99,
}</code></p>
<p>Configuration:</p>
<p><code>json
"order_types": {
"buy": "limit",
"sell": "limit",
"emergencysell": "market",
"forcebuy": "market",
"forcesell": "market",
"stoploss": "market",
"stoploss_on_exchange": false,
"stoploss_on_exchange_interval": 60
}</code></p>
<div class="admonition note">
<p class="admonition-title">Market order support</p>
<p>Not all exchanges support "market" orders.
The following message will be shown if your exchange does not support market orders:
<code>"Exchange &lt;yourexchange&gt; does not support market orders."</code> and the bot will refuse to start.</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Using market orders</p>
<p>Please carefully read the section <a href="#market-order-pricing">Market order pricing</a> section when using market orders.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Stoploss on exchange</p>
<p><code>stoploss_on_exchange_interval</code> is not mandatory. Do not change its value if you are
unsure of what you are doing. For more information about how stoploss works please
refer to <a href="../stoploss/">the stoploss documentation</a>.</p>
<p>If <code>stoploss_on_exchange</code> is enabled and the stoploss is cancelled manually on the exchange, then the bot will create a new stoploss order.</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning: stoploss_on_exchange failures</p>
<p>If stoploss on exchange creation fails for some reason, then an "emergency sell" is initiated. By default, this will sell the asset using a market order. The order-type for the emergency-sell can be changed by setting the <code>emergencysell</code> value in the <code>order_types</code> dictionary - however this is not advised.</p>
</div>
<h3 id="understand-order_time_in_force">Understand order_time_in_force<a class="headerlink" href="#understand-order_time_in_force" title="Permanent link">&para;</a></h3>
<p>The <code>order_time_in_force</code> configuration parameter defines the policy by which the order
is executed on the exchange. Three commonly used time in force are:</p>
<p><strong>GTC (Good Till Canceled):</strong></p>
<p>This is most of the time the default time in force. It means the order will remain
on exchange till it is canceled by user. It can be fully or partially fulfilled.
If partially fulfilled, the remaining will stay on the exchange till cancelled.</p>
<p><strong>FOK (Fill Or Kill):</strong></p>
<p>It means if the order is not executed immediately AND fully then it is canceled by the exchange.</p>
<p><strong>IOC (Immediate Or Canceled):</strong></p>
<p>It is the same as FOK (above) except it can be partially fulfilled. The remaining part
is automatically cancelled by the exchange.</p>
<p>The <code>order_time_in_force</code> parameter contains a dict with buy and sell time in force policy values.
This can be set in the configuration file or in the strategy.
Values set in the configuration file overwrites values set in the strategy.</p>
<p>The possible values are: <code>gtc</code> (default), <code>fok</code> or <code>ioc</code>.</p>
<p><code>python
"order_time_in_force": {
"buy": "gtc",
"sell": "gtc"
},</code></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This is an ongoing work. For now it is supported only for binance and only for buy orders.
Please don't change the default value unless you know what you are doing.</p>
</div>
<h3 id="exchange-configuration">Exchange configuration<a class="headerlink" href="#exchange-configuration" title="Permanent link">&para;</a></h3>
<p>Freqtrade is based on <a href="https://github.com/ccxt/ccxt">CCXT library</a> that supports over 100 cryptocurrency
exchange markets and trading APIs. The complete up-to-date list can be found in the
<a href="https://github.com/ccxt/ccxt/tree/master/python">CCXT repo homepage</a>.
However, the bot was tested by the development team with only Bittrex, Binance and Kraken,
so the these are the only officially supported exchanges:</p>
<ul>
<li><a href="https://bittrex.com/">Bittrex</a>: "bittrex"</li>
<li><a href="https://www.binance.com/">Binance</a>: "binance"</li>
<li><a href="https://kraken.com/">Kraken</a>: "kraken"</li>
</ul>
<p>Feel free to test other exchanges and submit your PR to improve the bot.</p>
<p>Some exchanges require special configuration, which can be found on the <a href="../exchanges/">Exchange-specific Notes</a> documentation page.</p>
<h4 id="sample-exchange-configuration">Sample exchange configuration<a class="headerlink" href="#sample-exchange-configuration" title="Permanent link">&para;</a></h4>
<p>A exchange configuration for "binance" would look as follows:</p>
<p><code>json
"exchange": {
"name": "binance",
"key": "your_exchange_key",
"secret": "your_exchange_secret",
"ccxt_config": {"enableRateLimit": true},
"ccxt_async_config": {
"enableRateLimit": true,
"rateLimit": 200
},</code></p>
<p>This configuration enables binance, as well as rate limiting to avoid bans from the exchange.
<code>"rateLimit": 200</code> defines a wait-event of 0.2s between each call. This can also be completely disabled by setting <code>"enableRateLimit"</code> to false.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Optimal settings for rate limiting depend on the exchange and the size of the whitelist, so an ideal parameter will vary on many other settings.
We try to provide sensible defaults per exchange where possible, if you encounter bans please make sure that <code>"enableRateLimit"</code> is enabled and increase the <code>"rateLimit"</code> parameter step by step.</p>
</div>
<h3 id="what-values-can-be-used-for-fiat_display_currency">What values can be used for fiat_display_currency?<a class="headerlink" href="#what-values-can-be-used-for-fiat_display_currency" title="Permanent link">&para;</a></h3>
<p>The <code>fiat_display_currency</code> configuration parameter sets the base currency to use for the
conversion from coin to fiat in the bot Telegram reports.</p>
<p>The valid values are:</p>
<p><code>json
"AUD", "BRL", "CAD", "CHF", "CLP", "CNY", "CZK", "DKK", "EUR", "GBP", "HKD", "HUF", "IDR", "ILS", "INR", "JPY", "KRW", "MXN", "MYR", "NOK", "NZD", "PHP", "PKR", "PLN", "RUB", "SEK", "SGD", "THB", "TRY", "TWD", "ZAR", "USD"</code></p>
<p>In addition to fiat currencies, a range of cryto currencies are supported.</p>
<p>The valid values are:</p>
<p><code>json
"BTC", "ETH", "XRP", "LTC", "BCH", "USDT"</code></p>
<h2 id="using-dry-run-mode">Using Dry-run mode<a class="headerlink" href="#using-dry-run-mode" title="Permanent link">&para;</a></h2>
<p>We recommend starting the bot in the Dry-run mode to see how your bot will
behave and what is the performance of your strategy. In the Dry-run mode the
bot does not engage your money. It only runs a live simulation without
creating trades on the exchange.</p>
<ol>
<li>Edit your <code>config.json</code> configuration file.</li>
<li>Switch <code>dry-run</code> to <code>true</code> and specify <code>db_url</code> for a persistence database.</li>
</ol>
<p><code>json
"dry_run": true,
"db_url": "sqlite:///tradesv3.dryrun.sqlite",</code></p>
<ol>
<li>Remove your Exchange API key and secret (change them by empty values or fake credentials):</li>
</ol>
<p><code>json
"exchange": {
"name": "bittrex",
"key": "key",
"secret": "secret",
...
}</code></p>
<p>Once you will be happy with your bot performance running in the Dry-run mode, you can switch it to production mode.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>A simulated wallet is available during dry-run mode, and will assume a starting capital of <code>dry_run_wallet</code> (defaults to 1000).</p>
</div>
<h3 id="considerations-for-dry-run">Considerations for dry-run<a class="headerlink" href="#considerations-for-dry-run" title="Permanent link">&para;</a></h3>
<ul>
<li>API-keys may or may not be provided. Only Read-Only operations (i.e. operations that do not alter account state) on the exchange are performed in dry-run mode.</li>
<li>Wallets (<code>/balance</code>) are simulated based on <code>dry_run_wallet</code>.</li>
<li>Orders are simulated, and will not be posted to the exchange.</li>
<li>Orders are assumed to fill immediately, and will never time out.</li>
<li>In combination with <code>stoploss_on_exchange</code>, the stop_loss price is assumed to be filled.</li>
<li>Open orders (not trades, which are stored in the database) are reset on bot restart.</li>
</ul>
<h2 id="switch-to-production-mode">Switch to production mode<a class="headerlink" href="#switch-to-production-mode" title="Permanent link">&para;</a></h2>
<p>In production mode, the bot will engage your money. Be careful, since a wrong
strategy can lose all your money. Be aware of what you are doing when
you run it in production mode.</p>
<h3 id="setup-your-exchange-account">Setup your exchange account<a class="headerlink" href="#setup-your-exchange-account" title="Permanent link">&para;</a></h3>
<p>You will need to create API Keys (usually you get <code>key</code> and <code>secret</code>, some exchanges require an additional <code>password</code>) from the Exchange website and you'll need to insert this into the appropriate fields in the configuration or when asked by the <code>freqtrade new-config</code> command.
API Keys are usually only required for live trading (trading for real money, bot running in "production mode", executing real orders on the exchange) and are not required for the bot running in dry-run (trade simulation) mode. When you setup the bot in dry-run mode, you may fill these fields with empty values.</p>
<h3 id="to-switch-your-bot-in-production-mode">To switch your bot in production mode<a class="headerlink" href="#to-switch-your-bot-in-production-mode" title="Permanent link">&para;</a></h3>
<p><strong>Edit your <code>config.json</code> file.</strong></p>
<p><strong>Switch dry-run to false and don't forget to adapt your database URL if set:</strong></p>
<p><code>json
"dry_run": false,</code></p>
<p><strong>Insert your Exchange API key (change them by fake api keys):</strong></p>
<p><code>json
{
"exchange": {
"name": "bittrex",
"key": "af8ddd35195e9dc500b9a6f799f6f5c93d89193b",
"secret": "08a9dc6db3d7b53e1acebd9275677f4b0a04f1a5",
//"password": "", // Optional, not needed by all exchanges)
// ...
}
//...
}</code></p>
<p>You should also make sure to read the <a href="../exchanges/">Exchanges</a> section of the documentation to be aware of potential configuration details specific to your exchange.</p>
<div class="admonition hint">
<p class="admonition-title">Keep your secrets secret</p>
<p>To keep your secrets secret, we recommend to use a 2<sup>nd</sup> configuration for your API keys.
Simply use the above snippet in a new configuration file (e.g. <code>config-private.json</code>) and keep your settings in this file.
You can then start the bot with <code>freqtrade trade --config user_data/config.json --config user_data/config-private.json &lt;...&gt;</code> to have your keys loaded.</p>
<p><strong>NEVER</strong> share your private configuration file or your exchange keys with anyone!</p>
</div>
<h3 id="using-proxy-with-freqtrade">Using proxy with Freqtrade<a class="headerlink" href="#using-proxy-with-freqtrade" title="Permanent link">&para;</a></h3>
<p>To use a proxy with freqtrade, add the kwarg <code>"aiohttp_trust_env"=true</code> to the <code>"ccxt_async_kwargs"</code> dict in the exchange section of the configuration.</p>
<p>An example for this can be found in <code>config_full.json.example</code></p>
<p><code>json
"ccxt_async_config": {
"aiohttp_trust_env": true
}</code></p>
<p>Then, export your proxy settings using the variables <code>"HTTP_PROXY"</code> and <code>"HTTPS_PROXY"</code> set to the appropriate values</p>
<p><code>bash
export HTTP_PROXY="http://addr:port"
export HTTPS_PROXY="http://addr:port"
freqtrade</code></p>
<h2 id="next-step">Next step<a class="headerlink" href="#next-step" title="Permanent link">&para;</a></h2>
<p>Now you have configured your config.json, the next step is to <a href="../bot-usage/">start your bot</a>.</p>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<nav class="md-footer__inner md-grid" aria-label="Footer">
<a href="../bot-basics/" class="md-footer__link md-footer__link--prev" rel="prev">
<div class="md-footer__button md-icon">
<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"/></svg>
</div>
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Previous
</span>
Freqtrade Basics
</div>
</div>
</a>
<a href="../strategy-customization/" class="md-footer__link md-footer__link--next" rel="next">
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Next
</span>
Strategy Customization
</div>
</div>
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
</div>
</a>
</nav>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-footer-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": [], "search": "../assets/javascripts/workers/search.fe42c31b.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing"}, "version": {"provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.4ea5477f.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink