CTYPTO/freqtrade
1
0
Fork 0
mirror of https://github.com/freqtrade/freqtrade.git synced 2026-01-20 14:00:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Deployed c93c97c to develop in en with MkDocs 1.6.1 and mike 2.1.3

Browse Source
This commit is contained in:
github-actions[bot]
2025-08-02 09:24:55 +00:00
parent 42612350a0
commit 1cb74e1d01
51 changed files with 3428 additions and 3428 deletions
Download Patch File Download Diff File Expand all files Collapse all files

98
en/develop/404.html
View File

@@ -97,7 +97,7 @@
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="/en/stable/." title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<a href="/en/stable/index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="/en/stable/images/logo.png" alt="logo">
@@ -239,7 +239,7 @@
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="/en/stable/." title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<a href="/en/stable/index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="/en/stable/images/logo.png" alt="logo">
@@ -268,7 +268,7 @@
<li class="md-nav__item">
<a href="/en/stable/." class="md-nav__link">
<a href="/en/stable/index.html" class="md-nav__link">
@@ -290,7 +290,7 @@
<li class="md-nav__item">
<a href="/en/stable/docker_quickstart/" class="md-nav__link">
<a href="/en/stable/docker_quickstart.html" class="md-nav__link">
@@ -350,7 +350,7 @@
<li class="md-nav__item">
<a href="/en/stable/installation/" class="md-nav__link">
<a href="/en/stable/installation.html" class="md-nav__link">
@@ -373,7 +373,7 @@
<li class="md-nav__item">
<a href="/en/stable/windows_installation/" class="md-nav__link">
<a href="/en/stable/windows_installation.html" class="md-nav__link">
@@ -403,7 +403,7 @@
<li class="md-nav__item">
<a href="/en/stable/bot-basics/" class="md-nav__link">
<a href="/en/stable/bot-basics.html" class="md-nav__link">
@@ -425,7 +425,7 @@
<li class="md-nav__item">
<a href="/en/stable/configuration/" class="md-nav__link">
<a href="/en/stable/configuration.html" class="md-nav__link">
@@ -447,7 +447,7 @@
<li class="md-nav__item">
<a href="/en/stable/strategy-101/" class="md-nav__link">
<a href="/en/stable/strategy-101.html" class="md-nav__link">
@@ -469,7 +469,7 @@
<li class="md-nav__item">
<a href="/en/stable/strategy-customization/" class="md-nav__link">
<a href="/en/stable/strategy-customization.html" class="md-nav__link">
@@ -491,7 +491,7 @@
<li class="md-nav__item">
<a href="/en/stable/strategy-callbacks/" class="md-nav__link">
<a href="/en/stable/strategy-callbacks.html" class="md-nav__link">
@@ -513,7 +513,7 @@
<li class="md-nav__item">
<a href="/en/stable/stoploss/" class="md-nav__link">
<a href="/en/stable/stoploss.html" class="md-nav__link">
@@ -535,7 +535,7 @@
<li class="md-nav__item">
<a href="/en/stable/plugins/" class="md-nav__link">
<a href="/en/stable/plugins.html" class="md-nav__link">
@@ -557,7 +557,7 @@
<li class="md-nav__item">
<a href="/en/stable/bot-usage/" class="md-nav__link">
<a href="/en/stable/bot-usage.html" class="md-nav__link">
@@ -617,7 +617,7 @@
<li class="md-nav__item">
<a href="/en/stable/telegram-usage/" class="md-nav__link">
<a href="/en/stable/telegram-usage.html" class="md-nav__link">
@@ -640,7 +640,7 @@
<li class="md-nav__item">
<a href="/en/stable/freq-ui/" class="md-nav__link">
<a href="/en/stable/freq-ui.html" class="md-nav__link">
@@ -663,7 +663,7 @@
<li class="md-nav__item">
<a href="/en/stable/rest-api/" class="md-nav__link">
<a href="/en/stable/rest-api.html" class="md-nav__link">
@@ -686,7 +686,7 @@
<li class="md-nav__item">
<a href="/en/stable/webhook-config/" class="md-nav__link">
<a href="/en/stable/webhook-config.html" class="md-nav__link">
@@ -716,7 +716,7 @@
<li class="md-nav__item">
<a href="/en/stable/data-download/" class="md-nav__link">
<a href="/en/stable/data-download.html" class="md-nav__link">
@@ -738,7 +738,7 @@
<li class="md-nav__item">
<a href="/en/stable/backtesting/" class="md-nav__link">
<a href="/en/stable/backtesting.html" class="md-nav__link">
@@ -760,7 +760,7 @@
<li class="md-nav__item">
<a href="/en/stable/hyperopt/" class="md-nav__link">
<a href="/en/stable/hyperopt.html" class="md-nav__link">
@@ -820,7 +820,7 @@
<li class="md-nav__item">
<a href="/en/stable/freqai/" class="md-nav__link">
<a href="/en/stable/freqai.html" class="md-nav__link">
@@ -843,7 +843,7 @@
<li class="md-nav__item">
<a href="/en/stable/freqai-configuration/" class="md-nav__link">
<a href="/en/stable/freqai-configuration.html" class="md-nav__link">
@@ -866,7 +866,7 @@
<li class="md-nav__item">
<a href="/en/stable/freqai-parameter-table/" class="md-nav__link">
<a href="/en/stable/freqai-parameter-table.html" class="md-nav__link">
@@ -889,7 +889,7 @@
<li class="md-nav__item">
<a href="/en/stable/freqai-feature-engineering/" class="md-nav__link">
<a href="/en/stable/freqai-feature-engineering.html" class="md-nav__link">
@@ -912,7 +912,7 @@
<li class="md-nav__item">
<a href="/en/stable/freqai-running/" class="md-nav__link">
<a href="/en/stable/freqai-running.html" class="md-nav__link">
@@ -935,7 +935,7 @@
<li class="md-nav__item">
<a href="/en/stable/freqai-reinforcement-learning/" class="md-nav__link">
<a href="/en/stable/freqai-reinforcement-learning.html" class="md-nav__link">
@@ -958,7 +958,7 @@
<li class="md-nav__item">
<a href="/en/stable/freqai-developers/" class="md-nav__link">
<a href="/en/stable/freqai-developers.html" class="md-nav__link">
@@ -988,7 +988,7 @@
<li class="md-nav__item">
<a href="/en/stable/leverage/" class="md-nav__link">
<a href="/en/stable/leverage.html" class="md-nav__link">
@@ -1010,7 +1010,7 @@
<li class="md-nav__item">
<a href="/en/stable/utils/" class="md-nav__link">
<a href="/en/stable/utils.html" class="md-nav__link">
@@ -1032,7 +1032,7 @@
<li class="md-nav__item">
<a href="/en/stable/plotting/" class="md-nav__link">
<a href="/en/stable/plotting.html" class="md-nav__link">
@@ -1054,7 +1054,7 @@
<li class="md-nav__item">
<a href="/en/stable/exchanges/" class="md-nav__link">
<a href="/en/stable/exchanges.html" class="md-nav__link">
@@ -1114,7 +1114,7 @@
<li class="md-nav__item">
<a href="/en/stable/data-analysis/" class="md-nav__link">
<a href="/en/stable/data-analysis.html" class="md-nav__link">
@@ -1137,7 +1137,7 @@
<li class="md-nav__item">
<a href="/en/stable/strategy_analysis_example/" class="md-nav__link">
<a href="/en/stable/strategy_analysis_example.html" class="md-nav__link">
@@ -1160,7 +1160,7 @@
<li class="md-nav__item">
<a href="/en/stable/advanced-backtesting/" class="md-nav__link">
<a href="/en/stable/advanced-backtesting.html" class="md-nav__link">
@@ -1228,7 +1228,7 @@
<li class="md-nav__item">
<a href="/en/stable/advanced-setup/" class="md-nav__link">
<a href="/en/stable/advanced-setup.html" class="md-nav__link">
@@ -1251,7 +1251,7 @@
<li class="md-nav__item">
<a href="/en/stable/trade-object/" class="md-nav__link">
<a href="/en/stable/trade-object.html" class="md-nav__link">
@@ -1274,7 +1274,7 @@
<li class="md-nav__item">
<a href="/en/stable/lookahead-analysis/" class="md-nav__link">
<a href="/en/stable/lookahead-analysis.html" class="md-nav__link">
@@ -1297,7 +1297,7 @@
<li class="md-nav__item">
<a href="/en/stable/recursive-analysis/" class="md-nav__link">
<a href="/en/stable/recursive-analysis.html" class="md-nav__link">
@@ -1320,7 +1320,7 @@
<li class="md-nav__item">
<a href="/en/stable/strategy-advanced/" class="md-nav__link">
<a href="/en/stable/strategy-advanced.html" class="md-nav__link">
@@ -1343,7 +1343,7 @@
<li class="md-nav__item">
<a href="/en/stable/advanced-hyperopt/" class="md-nav__link">
<a href="/en/stable/advanced-hyperopt.html" class="md-nav__link">
@@ -1366,7 +1366,7 @@
<li class="md-nav__item">
<a href="/en/stable/advanced-orderflow/" class="md-nav__link">
<a href="/en/stable/advanced-orderflow.html" class="md-nav__link">
@@ -1389,7 +1389,7 @@
<li class="md-nav__item">
<a href="/en/stable/producer-consumer/" class="md-nav__link">
<a href="/en/stable/producer-consumer.html" class="md-nav__link">
@@ -1412,7 +1412,7 @@
<li class="md-nav__item">
<a href="/en/stable/sql_cheatsheet/" class="md-nav__link">
<a href="/en/stable/sql_cheatsheet.html" class="md-nav__link">
@@ -1442,7 +1442,7 @@
<li class="md-nav__item">
<a href="/en/stable/faq/" class="md-nav__link">
<a href="/en/stable/faq.html" class="md-nav__link">
@@ -1464,7 +1464,7 @@
<li class="md-nav__item">
<a href="/en/stable/strategy_migration/" class="md-nav__link">
<a href="/en/stable/strategy_migration.html" class="md-nav__link">
@@ -1486,7 +1486,7 @@
<li class="md-nav__item">
<a href="/en/stable/updating/" class="md-nav__link">
<a href="/en/stable/updating.html" class="md-nav__link">
@@ -1508,7 +1508,7 @@
<li class="md-nav__item">
<a href="/en/stable/deprecated/" class="md-nav__link">
<a href="/en/stable/deprecated.html" class="md-nav__link">
@@ -1530,7 +1530,7 @@
<li class="md-nav__item">
<a href="/en/stable/developer/" class="md-nav__link">
<a href="/en/stable/developer.html" class="md-nav__link">

128
en/develop/advanced-backtesting/index.html → en/develop/advanced-backtesting.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/advanced-backtesting/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/advanced-backtesting.html">
<link rel="prev" href="../strategy_analysis_example/">
<link rel="prev" href="strategy_analysis_example.html">
<link rel="next" href="../advanced-setup/">
<link rel="next" href="advanced-setup.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -831,7 +831,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -854,7 +854,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -877,7 +877,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -900,7 +900,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -923,7 +923,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -946,7 +946,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -969,7 +969,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -999,7 +999,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1021,7 +1021,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1043,7 +1043,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1065,7 +1065,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1127,7 +1127,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1150,7 +1150,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1195,7 +1195,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="advanced-backtesting.html" class="md-nav__link md-nav__link--active">
@@ -1376,7 +1376,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1399,7 +1399,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1422,7 +1422,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1445,7 +1445,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1468,7 +1468,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1491,7 +1491,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1514,7 +1514,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1537,7 +1537,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1560,7 +1560,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1590,7 +1590,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1612,7 +1612,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1634,7 +1634,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1656,7 +1656,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1678,7 +1678,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -2059,7 +2059,7 @@ Use the <code>--analysis-to-csv</code> option to disable printing out of tables
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../strategy_analysis_example/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Strategy analysis">
<a href="strategy_analysis_example.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Strategy analysis">
<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 11z"/></svg>
@@ -2076,7 +2076,7 @@ Use the <code>--analysis-to-csv</code> option to disable printing out of tables
<a href="../advanced-setup/" class="md-footer__link md-footer__link--next" aria-label="Next: Advanced Post-installation Tasks">
<a href="advanced-setup.html" class="md-footer__link md-footer__link--next" aria-label="Next: Advanced Post-installation Tasks">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2124,12 +2124,12 @@ Use the <code>--analysis-to-csv</code> option to disable printing out of tables
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

130
en/develop/advanced-hyperopt/index.html → en/develop/advanced-hyperopt.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/advanced-hyperopt/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/advanced-hyperopt.html">
<link rel="prev" href="../strategy-advanced/">
<link rel="prev" href="strategy-advanced.html">
<link rel="next" href="../advanced-orderflow/">
<link rel="next" href="advanced-orderflow.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -831,7 +831,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -854,7 +854,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -877,7 +877,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -900,7 +900,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -923,7 +923,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -946,7 +946,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -969,7 +969,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -999,7 +999,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1021,7 +1021,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1043,7 +1043,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1065,7 +1065,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1125,7 +1125,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1148,7 +1148,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1171,7 +1171,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1241,7 +1241,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1264,7 +1264,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1287,7 +1287,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1310,7 +1310,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1333,7 +1333,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1378,7 +1378,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="advanced-hyperopt.html" class="md-nav__link md-nav__link--active">
@@ -1472,7 +1472,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1495,7 +1495,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1518,7 +1518,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1548,7 +1548,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1570,7 +1570,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1592,7 +1592,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1614,7 +1614,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1636,7 +1636,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -1890,7 +1890,7 @@ For the sample below, you then need to add the command line parameter <code>--hy
<p>All overrides are optional and can be mixed/matched as necessary.</p>
</div>
<h3 id="dynamic-parameters">Dynamic parameters<a class="headerlink" href="#dynamic-parameters" title="Permanent link">&para;</a></h3>
<p>Parameters can also be defined dynamically, but must be available to the instance once the <a href="../strategy-callbacks/#bot-start"><code>bot_start()</code> callback</a> has been called.</p>
<p>Parameters can also be defined dynamically, but must be available to the instance once the <a href="strategy-callbacks.html#bot-start"><code>bot_start()</code> callback</a> has been called.</p>
<div class="highlight"><pre><span></span><code><span class="k">class</span><span class="w"> </span><span class="nc">MyAwesomeStrategy</span><span class="p">(</span><span class="n">IStrategy</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="nf">bot_start</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
@@ -1994,7 +1994,7 @@ Implement <code>generate_estimator()</code> in your strategy</p>
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../strategy-advanced/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Advanced Strategy">
<a href="strategy-advanced.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Advanced Strategy">
<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 11z"/></svg>
@@ -2011,7 +2011,7 @@ Implement <code>generate_estimator()</code> in your strategy</p>
<a href="../advanced-orderflow/" class="md-footer__link md-footer__link--next" aria-label="Next: Orderflow">
<a href="advanced-orderflow.html" class="md-footer__link md-footer__link--next" aria-label="Next: Orderflow">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2059,12 +2059,12 @@ Implement <code>generate_estimator()</code> in your strategy</p>
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

128
en/develop/advanced-orderflow/index.html → en/develop/advanced-orderflow.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/advanced-orderflow/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/advanced-orderflow.html">
<link rel="prev" href="../advanced-hyperopt/">
<link rel="prev" href="advanced-hyperopt.html">
<link rel="next" href="../producer-consumer/">
<link rel="next" href="producer-consumer.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -831,7 +831,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -854,7 +854,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -877,7 +877,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -900,7 +900,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -923,7 +923,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -946,7 +946,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -969,7 +969,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -999,7 +999,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1021,7 +1021,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1043,7 +1043,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1065,7 +1065,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1125,7 +1125,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1148,7 +1148,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1171,7 +1171,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1241,7 +1241,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1264,7 +1264,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1287,7 +1287,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1310,7 +1310,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1333,7 +1333,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1356,7 +1356,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1401,7 +1401,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="advanced-orderflow.html" class="md-nav__link md-nav__link--active">
@@ -1543,7 +1543,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1566,7 +1566,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1596,7 +1596,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1618,7 +1618,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1640,7 +1640,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1662,7 +1662,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1684,7 +1684,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -2009,7 +2009,7 @@ It's also currently not been tested with freqAI - and combining these two featur
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../advanced-hyperopt/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Advanced Hyperopt">
<a href="advanced-hyperopt.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Advanced Hyperopt">
<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 11z"/></svg>
@@ -2026,7 +2026,7 @@ It's also currently not been tested with freqAI - and combining these two featur
<a href="../producer-consumer/" class="md-footer__link md-footer__link--next" aria-label="Next: Producer/Consumer mode">
<a href="producer-consumer.html" class="md-footer__link md-footer__link--next" aria-label="Next: Producer/Consumer mode">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2074,12 +2074,12 @@ It's also currently not been tested with freqAI - and combining these two featur
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

132
en/develop/advanced-setup/index.html → en/develop/advanced-setup.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/advanced-setup/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/advanced-setup.html">
<link rel="prev" href="../advanced-backtesting/">
<link rel="prev" href="advanced-backtesting.html">
<link rel="next" href="../trade-object/">
<link rel="next" href="trade-object.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -831,7 +831,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -854,7 +854,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -877,7 +877,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -900,7 +900,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -923,7 +923,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -946,7 +946,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -969,7 +969,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -999,7 +999,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1021,7 +1021,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1043,7 +1043,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1065,7 +1065,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1125,7 +1125,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1148,7 +1148,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1171,7 +1171,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1263,7 +1263,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="advanced-setup.html" class="md-nav__link md-nav__link--active">
@@ -1456,7 +1456,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1479,7 +1479,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1502,7 +1502,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1525,7 +1525,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1548,7 +1548,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1571,7 +1571,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1594,7 +1594,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1617,7 +1617,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1647,7 +1647,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1669,7 +1669,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1691,7 +1691,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1713,7 +1713,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1735,7 +1735,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -1986,7 +1986,7 @@ freqtrade<span class="w"> </span>trade<span class="w"> </span>-c<span class="w">
<span class="c1"># Terminal 2:</span>
freqtrade<span class="w"> </span>trade<span class="w"> </span>-c<span class="w"> </span>MyConfigUSDT.json<span class="w"> </span>-s<span class="w"> </span>MyCustomStrategy<span class="w"> </span>--db-url<span class="w"> </span>sqlite:///user_data/tradesUSDT.live.sqlite
</code></pre></div>
<p>For more information regarding usage of the sqlite databases, for example to manually enter or remove trades, please refer to the <a href="../sql_cheatsheet/">SQL Cheatsheet</a>.</p>
<p>For more information regarding usage of the sqlite databases, for example to manually enter or remove trades, please refer to the <a href="sql_cheatsheet.html">SQL Cheatsheet</a>.</p>
<h3 id="multiple-instances-using-docker">Multiple instances using docker<a class="headerlink" href="#multiple-instances-using-docker" title="Permanent link">&para;</a></h3>
<p>To run multiple instances of freqtrade using docker you will need to edit the docker-compose.yml file and add all the instances you want as separate services. Remember, you can separate your configuration into multiple files, so it's a good idea to think about making them modular, then if you need to edit something common to all bots, you can do that in a single config file.
<div class="highlight"><pre><span></span><code>---
@@ -2148,7 +2148,7 @@ To actually use a handler, it must be in the "handlers" section inside the "root
If this section is left out, freqtrade will provide no output (in the non-configured handler, anyway).</p>
<div class="admonition tip">
<p class="admonition-title">Explicit log configuration</p>
<p>We recommend to extract the logging configuration from your main freqtrade configuration file, and provide it to your bot via <a href="../configuration/#multiple-configuration-files">multiple configuration files</a> functionality. This will avoid unnecessary code duplication.</p>
<p>We recommend to extract the logging configuration from your main freqtrade configuration file, and provide it to your bot via <a href="configuration.html#multiple-configuration-files">multiple configuration files</a> functionality. This will avoid unnecessary code duplication.</p>
</div>
<hr />
<p>On many Linux systems the bot can be configured to send its log messages to <code>syslog</code> or <code>journald</code> system services. Logging to a remote <code>syslog</code> server is also available on Windows. The special values for the <code>--logfile</code> command line option can be used for this.</p>
@@ -2340,7 +2340,7 @@ We recommend to keep one format in human readable form.</p>
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../advanced-backtesting/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Backtest analysis">
<a href="advanced-backtesting.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Backtest analysis">
<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 11z"/></svg>
@@ -2357,7 +2357,7 @@ We recommend to keep one format in human readable form.</p>
<a href="../trade-object/" class="md-footer__link md-footer__link--next" aria-label="Next: Trade Object">
<a href="trade-object.html" class="md-footer__link md-footer__link--next" aria-label="Next: Trade Object">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2405,12 +2405,12 @@ We recommend to keep one format in human readable form.</p>
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

152
en/develop/backtesting/index.html → en/develop/backtesting.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/backtesting/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/backtesting.html">
<link rel="prev" href="../data-download/">
<link rel="prev" href="data-download.html">
<link rel="next" href="../hyperopt/">
<link rel="next" href="hyperopt.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="backtesting.html" class="md-nav__link md-nav__link--active">
@@ -1017,7 +1017,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -1077,7 +1077,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -1100,7 +1100,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -1123,7 +1123,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -1146,7 +1146,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -1169,7 +1169,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -1192,7 +1192,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -1215,7 +1215,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1245,7 +1245,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1267,7 +1267,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1289,7 +1289,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1311,7 +1311,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1371,7 +1371,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1394,7 +1394,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1417,7 +1417,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1485,7 +1485,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1508,7 +1508,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1531,7 +1531,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1554,7 +1554,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1577,7 +1577,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1600,7 +1600,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1623,7 +1623,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1646,7 +1646,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1669,7 +1669,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1699,7 +1699,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1721,7 +1721,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1743,7 +1743,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1765,7 +1765,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1787,7 +1787,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -2061,8 +2061,8 @@
<h1 id="backtesting">Backtesting<a class="headerlink" href="#backtesting" title="Permanent link">&para;</a></h1>
<p>This page explains how to validate your strategy performance by using Backtesting.</p>
<p>Backtesting requires historic data to be available.
To learn how to get data for the pairs and exchange you're interested in, head over to the <a href="../data-download/">Data Downloading</a> section of the documentation.</p>
<p>Backtesting is also available in <a href="../freq-ui/#backtesting">webserver mode</a>, which allows you to run backtests via the web interface.</p>
To learn how to get data for the pairs and exchange you're interested in, head over to the <a href="data-download.html">Data Downloading</a> section of the documentation.</p>
<p>Backtesting is also available in <a href="freq-ui.html#backtesting">webserver mode</a>, which allows you to run backtests via the web interface.</p>
<h2 id="backtesting-command-reference">Backtesting command reference<a class="headerlink" href="#backtesting-command-reference" title="Permanent link">&para;</a></h2>
<div class="highlight"><pre><span></span><code>usage: freqtrade backtesting [-h] [-v] [--no-color] [--logfile FILE] [-V]
[-c PATH] [-d PATH] [--userdir PATH] [-s NAME]
@@ -2178,26 +2178,26 @@ Strategy arguments:
real data. This is what we call <a href="https://en.wikipedia.org/wiki/Backtesting">backtesting</a>.</p>
<p>Backtesting will use the crypto-currencies (pairs) from your config file and load historical candle (OHLCV) data from <code>user_data/data/&lt;exchange&gt;</code> by default.
If no data is available for the exchange / pair / timeframe combination, backtesting will ask you to download them first using <code>freqtrade download-data</code>.
For details on downloading, please refer to the <a href="../data-download/">Data Downloading</a> section in the documentation.</p>
For details on downloading, please refer to the <a href="data-download.html">Data Downloading</a> section in the documentation.</p>
<p>The result of backtesting will confirm if your bot has better odds of making a profit than a loss.</p>
<p>All profit calculations include fees, and freqtrade will use the exchange's default fees for the calculation.</p>
<div class="admonition warning">
<p class="admonition-title">Using dynamic pairlists for backtesting</p>
<p>Using dynamic pairlists is possible (not all of the handlers are allowed to be used in backtest mode), however it relies on the current market conditions - which will not reflect the historic status of the pairlist.
Also, when using pairlists other than StaticPairlist, reproducibility of backtesting-results cannot be guaranteed.
Please read the <a href="../plugins/#pairlists">pairlists documentation</a> for more information.</p>
<p>To achieve reproducible results, best generate a pairlist via the <a href="../utils/#test-pairlist"><code>test-pairlist</code></a> command and use that as static pairlist.</p>
Please read the <a href="plugins.html#pairlists">pairlists documentation</a> for more information.</p>
<p>To achieve reproducible results, best generate a pairlist via the <a href="utils.html#test-pairlist"><code>test-pairlist</code></a> command and use that as static pairlist.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>By default, Freqtrade will export backtesting results to <code>user_data/backtest_results</code>.
The exported trades can be used for <a href="#further-backtest-result-analysis">further analysis</a> or can be used by the <a href="../plotting/#plot-price-and-indicators">plotting sub-command</a> (<code>freqtrade plot-dataframe</code>) in the scripts directory.</p>
The exported trades can be used for <a href="#further-backtest-result-analysis">further analysis</a> or can be used by the <a href="plotting.html#plot-price-and-indicators">plotting sub-command</a> (<code>freqtrade plot-dataframe</code>) in the scripts directory.</p>
</div>
<h3 id="starting-balance">Starting balance<a class="headerlink" href="#starting-balance" title="Permanent link">&para;</a></h3>
<p>Backtesting will require a starting balance, which can be provided as <code>--dry-run-wallet &lt;balance&gt;</code> or <code>--starting-balance &lt;balance&gt;</code> command line argument, or via <code>dry_run_wallet</code> configuration setting.
This amount must be higher than <code>stake_amount</code>, otherwise the bot will not be able to simulate any trade.</p>
<h3 id="dynamic-stake-amount">Dynamic stake amount<a class="headerlink" href="#dynamic-stake-amount" title="Permanent link">&para;</a></h3>
<p>Backtesting supports <a href="../configuration/#dynamic-stake-amount">dynamic stake amount</a> by configuring <code>stake_amount</code> as <code>"unlimited"</code>, which will split the starting balance into <code>max_open_trades</code> pieces.
<p>Backtesting supports <a href="configuration.html#dynamic-stake-amount">dynamic stake amount</a> by configuring <code>stake_amount</code> as <code>"unlimited"</code>, which will split the starting balance into <code>max_open_trades</code> pieces.
Profits from early trades will result in subsequent higher stake amounts, resulting in compounding of profits over the backtesting period.</p>
<h3 id="example-backtesting-commands">Example backtesting commands<a class="headerlink" href="#example-backtesting-commands" title="Permanent link">&para;</a></h3>
<p>With 5 min candle (OHLCV) data (per default)</p>
@@ -2232,7 +2232,7 @@ You can then use this data for backtesting as follows:</p>
<p>Exporting trades to file specifying a custom filename</p>
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>backtesting<span class="w"> </span>--strategy<span class="w"> </span>backtesting<span class="w"> </span>--export<span class="w"> </span>trades<span class="w"> </span>--export-filename<span class="o">=</span>backtest_samplestrategy.json
</code></pre></div>
<p>Please also read about the <a href="../strategy-customization/#strategy-startup-period">strategy startup period</a>.</p>
<p>Please also read about the <a href="strategy-customization.html#strategy-startup-period">strategy startup period</a>.</p>
<hr />
<p>Supplying custom fee value</p>
<p>Sometimes your account has certain fee rebates (fee reductions starting with a certain account size or monthly volume), which are not visible to ccxt.
@@ -2510,8 +2510,8 @@ In this instance, please use <code>--cache none</code> once to force a fresh bac
</div>
<h3 id="further-backtest-result-analysis">Further backtest-result analysis<a class="headerlink" href="#further-backtest-result-analysis" title="Permanent link">&para;</a></h3>
<p>To further analyze your backtest results, freqtrade will export the trades to file by default.
You can then load the trades to perform further analysis as shown in the <a href="../strategy_analysis_example/#load-backtest-results-to-pandas-dataframe">data analysis</a> backtesting section.</p>
<p>Also, you can use freqtrade in <a href="../freq-ui/#backtesting">webserver mode</a> to visualize the backtest results in a web interface.
You can then load the trades to perform further analysis as shown in the <a href="strategy_analysis_example.html#load-backtest-results-to-pandas-dataframe">data analysis</a> backtesting section.</p>
<p>Also, you can use freqtrade in <a href="freq-ui.html#backtesting">webserver mode</a> to visualize the backtest results in a web interface.
This mode also allows you to load existing backtest results, so you can analyze them without running the backtest again.<br />
For this mode - <code>--notes "&lt;notes&gt;"</code> can be used to add notes to the backtest results, which will be shown in the web interface.</p>
<h3 id="backtest-output-file">Backtest output file<a class="headerlink" href="#backtest-output-file" title="Permanent link">&para;</a></h3>
@@ -2564,7 +2564,7 @@ For this mode - <code>--notes "&lt;notes&gt;"</code> can be used to add notes to
</ul>
<p>Taking these assumptions, backtesting tries to mirror real trading as closely as possible. However, backtesting will <strong>never</strong> replace running a strategy in dry-run mode.
Also, keep in mind that past results don't guarantee future success.</p>
<p>In addition to the above assumptions, strategy authors should carefully read the <a href="../strategy-customization/#common-mistakes-when-developing-strategies">Common Mistakes</a> section, to avoid using data in backtesting which is not available in real market conditions.</p>
<p>In addition to the above assumptions, strategy authors should carefully read the <a href="strategy-customization.html#common-mistakes-when-developing-strategies">Common Mistakes</a> section, to avoid using data in backtesting which is not available in real market conditions.</p>
<h3 id="trading-limits-in-backtesting">Trading limits in backtesting<a class="headerlink" href="#trading-limits-in-backtesting" title="Permanent link">&para;</a></h3>
<p>Exchanges have certain trading limits, like minimum (and maximum) base currency, or minimum/maximum stake (quote) currency.
These limits are usually listed in the exchange documentation as "trading rules" or similar and can be quite different between different pairs.</p>
@@ -2692,7 +2692,7 @@ Detailed output for all strategies one after the other will be available, so mak
</code></pre></div>
<h2 id="next-step">Next step<a class="headerlink" href="#next-step" title="Permanent link">&para;</a></h2>
<p>Great, your strategy is profitable. What if the bot can give your the optimal parameters to use for your strategy?
Your next step is to learn <a href="../hyperopt/">how to find optimal parameters with Hyperopt</a></p>
Your next step is to learn <a href="hyperopt.html">how to find optimal parameters with Hyperopt</a></p>
@@ -2731,7 +2731,7 @@ Your next step is to learn <a href="../hyperopt/">how to find optimal parameters
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../data-download/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Data Downloading">
<a href="data-download.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Data Downloading">
<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 11z"/></svg>
@@ -2748,7 +2748,7 @@ Your next step is to learn <a href="../hyperopt/">how to find optimal parameters
<a href="../hyperopt/" class="md-footer__link md-footer__link--next" aria-label="Next: Hyperopt">
<a href="hyperopt.html" class="md-footer__link md-footer__link--next" aria-label="Next: Hyperopt">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2796,12 +2796,12 @@ Your next step is to learn <a href="../hyperopt/">how to find optimal parameters
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

134
en/develop/bot-basics/index.html → en/develop/bot-basics.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/bot-basics/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/bot-basics.html">
<link rel="prev" href="../windows_installation/">
<link rel="prev" href="windows_installation.html">
<link rel="next" href="../configuration/">
<link rel="next" href="configuration.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="bot-basics.html" class="md-nav__link md-nav__link--active">
@@ -547,7 +547,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -569,7 +569,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -591,7 +591,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -613,7 +613,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -635,7 +635,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -657,7 +657,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -679,7 +679,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -739,7 +739,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -762,7 +762,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -785,7 +785,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -808,7 +808,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -838,7 +838,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -860,7 +860,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -882,7 +882,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -942,7 +942,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -965,7 +965,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -988,7 +988,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -1011,7 +1011,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -1034,7 +1034,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -1057,7 +1057,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -1080,7 +1080,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1110,7 +1110,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1132,7 +1132,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1154,7 +1154,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1176,7 +1176,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1236,7 +1236,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1259,7 +1259,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1282,7 +1282,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1350,7 +1350,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1373,7 +1373,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1396,7 +1396,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1419,7 +1419,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1442,7 +1442,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1465,7 +1465,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1488,7 +1488,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1511,7 +1511,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1534,7 +1534,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1564,7 +1564,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1586,7 +1586,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1608,7 +1608,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1630,7 +1630,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1652,7 +1652,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -1801,7 +1801,7 @@
<li><strong>Limit order</strong>: Limit orders which execute at the defined limit price or better.</li>
<li><strong>Market order</strong>: Guaranteed to fill, may move price depending on the order size.</li>
<li><strong>Current Profit</strong>: Currently pending (unrealized) profit for this trade. This is mainly used throughout the bot and UI.</li>
<li><strong>Realized Profit</strong>: Already realized profit. Only relevant in combination with <a href="../strategy-callbacks/#adjust-trade-position">partial exits</a> - which also explains the calculation logic for this.</li>
<li><strong>Realized Profit</strong>: Already realized profit. Only relevant in combination with <a href="strategy-callbacks.html#adjust-trade-position">partial exits</a> - which also explains the calculation logic for this.</li>
<li><strong>Total Profit</strong>: Combined realized and unrealized profit. The relative number (%) is calculated against the total investment in this trade.</li>
</ul>
<h2 id="fee-handling">Fee handling<a class="headerlink" href="#fee-handling" title="Permanent link">&para;</a></h2>
@@ -1820,7 +1820,7 @@ This will also run the <code>bot_start()</code> callback.</p>
<ul>
<li>Fetch open trades from persistence.</li>
<li>Calculate current list of tradable pairs.</li>
<li>Download OHLCV data for the pairlist including all <a href="../strategy-customization/#get-data-for-non-tradeable-pairs">informative pairs</a><br />
<li>Download OHLCV data for the pairlist including all <a href="strategy-customization.html#get-data-for-non-tradeable-pairs">informative pairs</a><br />
This step is only executed once per Candle to avoid unnecessary network traffic.</li>
<li>Call <code>bot_loop_start()</code> strategy callback.</li>
<li>Analyze strategy per pair.<ul>
@@ -1861,7 +1861,7 @@ This will also run the <code>bot_start()</code> callback.</p>
</ul>
<p>This loop will be repeated again and again until the bot is stopped.</p>
<h2 id="backtesting-hyperopt-execution-logic">Backtesting / Hyperopt execution logic<a class="headerlink" href="#backtesting-hyperopt-execution-logic" title="Permanent link">&para;</a></h2>
<p><a href="../backtesting/">backtesting</a> or <a href="../hyperopt/">hyperopt</a> do only part of the above logic, since most of the trading operations are fully simulated.</p>
<p><a href="backtesting.html">backtesting</a> or <a href="hyperopt.html">hyperopt</a> do only part of the above logic, since most of the trading operations are fully simulated.</p>
<ul>
<li>Load historic data for configured pairlist.</li>
<li>Calls <code>bot_start()</code> once.</li>
@@ -1936,7 +1936,7 @@ Most callbacks will be called once per iteration in live (usually every ~5s) - w
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../windows_installation/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Windows">
<a href="windows_installation.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Windows">
<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 11z"/></svg>
@@ -1953,7 +1953,7 @@ Most callbacks will be called once per iteration in live (usually every ~5s) - w
<a href="../configuration/" class="md-footer__link md-footer__link--next" aria-label="Next: Configuration">
<a href="configuration.html" class="md-footer__link md-footer__link--next" aria-label="Next: Configuration">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2001,12 +2001,12 @@ Most callbacks will be called once per iteration in live (usually every ~5s) - w
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

134
en/develop/bot-usage/index.html → en/develop/bot-usage.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/bot-usage/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/bot-usage.html">
<link rel="prev" href="../plugins/">
<link rel="prev" href="plugins.html">
<link rel="next" href="../telegram-usage/">
<link rel="next" href="telegram-usage.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -590,7 +590,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="bot-usage.html" class="md-nav__link md-nav__link--active">
@@ -772,7 +772,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -795,7 +795,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -818,7 +818,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -841,7 +841,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -871,7 +871,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -893,7 +893,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -915,7 +915,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -975,7 +975,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -998,7 +998,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -1021,7 +1021,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -1044,7 +1044,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -1067,7 +1067,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -1090,7 +1090,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -1113,7 +1113,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1143,7 +1143,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1165,7 +1165,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1187,7 +1187,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1209,7 +1209,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1269,7 +1269,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1292,7 +1292,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1315,7 +1315,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1383,7 +1383,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1406,7 +1406,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1429,7 +1429,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1452,7 +1452,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1475,7 +1475,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1498,7 +1498,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1521,7 +1521,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1544,7 +1544,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1567,7 +1567,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1597,7 +1597,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1619,7 +1619,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1641,7 +1641,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1663,7 +1663,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1685,7 +1685,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -1996,7 +1996,7 @@ by setting appropriate file permissions for the file which contains actual secre
prevent unintended disclosure of sensitive private data when you publish examples
of your configuration in the project issues or in the Internet.</p>
<p>See more details on this technique with examples in the documentation page on
<a href="../configuration/">configuration</a>.</p>
<a href="configuration.html">configuration</a>.</p>
<h3 id="where-to-store-custom-data">Where to store custom data<a class="headerlink" href="#where-to-store-custom-data" title="Permanent link">&para;</a></h3>
<p>Freqtrade allows the creation of a user-data directory using <code>freqtrade create-userdir --userdir someDirectory</code>.
This directory will look as follows:</p>
@@ -2027,7 +2027,7 @@ a strategy class called <code>AwesomeStrategy</code> to load it:</p>
<p>If the bot does not find your strategy file, it will display in an error
message the reason (File not found, or errors in your code).</p>
<p>Learn more about strategy file in
<a href="../strategy-customization/">Strategy Customization</a>.</p>
<a href="strategy-customization.html">Strategy Customization</a>.</p>
<h3 id="how-to-use-strategy-path">How to use <strong>--strategy-path</strong>?<a class="headerlink" href="#how-to-use-strategy-path" title="Permanent link">&para;</a></h3>
<p>This parameter allows you to add an additional strategy lookup path, which gets
checked before the default locations (The passed path must be a directory!):</p>
@@ -2045,7 +2045,7 @@ in production mode. Example command:</p>
</code></pre></div>
<h2 id="next-step">Next step<a class="headerlink" href="#next-step" title="Permanent link">&para;</a></h2>
<p>The optimal strategy of the bot will change with time depending of the market trends. The next step is to
<a href="../strategy-customization/">Strategy Customization</a>.</p>
<a href="strategy-customization.html">Strategy Customization</a>.</p>
@@ -2084,7 +2084,7 @@ in production mode. Example command:</p>
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../plugins/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Plugins">
<a href="plugins.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Plugins">
<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 11z"/></svg>
@@ -2101,7 +2101,7 @@ in production mode. Example command:</p>
<a href="../telegram-usage/" class="md-footer__link md-footer__link--next" aria-label="Next: Telegram">
<a href="telegram-usage.html" class="md-footer__link md-footer__link--next" aria-label="Next: Telegram">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2149,12 +2149,12 @@ in production mode. Example command:</p>
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

208
en/develop/configuration/index.html → en/develop/configuration.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/configuration/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/configuration.html">
<link rel="prev" href="../bot-basics/">
<link rel="prev" href="bot-basics.html">
<link rel="next" href="../strategy-101/">
<link rel="next" href="strategy-101.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="configuration.html" class="md-nav__link md-nav__link--active">
@@ -995,7 +995,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -1017,7 +1017,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -1039,7 +1039,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -1061,7 +1061,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -1083,7 +1083,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -1105,7 +1105,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -1165,7 +1165,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -1188,7 +1188,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -1211,7 +1211,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -1234,7 +1234,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -1264,7 +1264,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -1286,7 +1286,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -1308,7 +1308,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -1368,7 +1368,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -1391,7 +1391,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -1414,7 +1414,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -1437,7 +1437,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -1460,7 +1460,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -1483,7 +1483,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -1506,7 +1506,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1536,7 +1536,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1558,7 +1558,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1580,7 +1580,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1602,7 +1602,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1662,7 +1662,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1685,7 +1685,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1708,7 +1708,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1776,7 +1776,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1799,7 +1799,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1822,7 +1822,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1845,7 +1845,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1868,7 +1868,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1891,7 +1891,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1914,7 +1914,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1937,7 +1937,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1960,7 +1960,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1990,7 +1990,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -2012,7 +2012,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -2034,7 +2034,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -2056,7 +2056,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -2078,7 +2078,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -2647,7 +2647,7 @@ By default, these settings are configured via the configuration file (see below)
<p>The bot uses a set of configuration parameters during its operation that all together conform to 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>If you used the <a href="../docker_quickstart/#docker-quick-start">Quick start</a> method for installing
<p>If you used the <a href="docker_quickstart.html#docker-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 the default configuration file is not created we recommend to use <code>freqtrade new-config --config user_data/config.json</code> to generate a basic configuration file.</p>
<p>The Freqtrade configuration file is to be written in JSON format.</p>
@@ -2677,7 +2677,7 @@ Using this scheme, all configuration settings will also be available as environm
</div>
<div class="admonition tip">
<p class="admonition-title">Validate combined result</p>
<p>You can use the <a href="../utils/#show-config">show-config subcommand</a> to see the final, combined configuration.</p>
<p>You can use the <a href="utils.html#show-config">show-config subcommand</a> to see the final, combined configuration.</p>
</div>
<details class="warning">
<summary>Loading sequence</summary>
@@ -2690,7 +2690,7 @@ This also applies to <code>user_dir</code> to some degree. while the user direct
This is similar to using multiple <code>--config</code> parameters, but simpler in usage as you don't have to specify all files for all commands.</p>
<div class="admonition tip">
<p class="admonition-title">Validate combined result</p>
<p>You can use the <a href="../utils/#show-config">show-config subcommand</a> to see the final, combined configuration.</p>
<p>You can use the <a href="utils.html#show-config">show-config subcommand</a> to see the final, combined configuration.</p>
</div>
<div class="admonition tip">
<p class="admonition-title">Use multiple configuration files to keep secrets secret</p>
@@ -2828,23 +2828,23 @@ In the below case, <code>max_open_trades</code> would be 3 after the merging - a
</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>
<td><strong>Required.</strong> Value as ratio of the stoploss used by the bot. More details in the <a href="stoploss.html">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>
<td>Enables trailing stoploss (based on <code>stoploss</code> in either configuration or strategy file). More details in the <a href="stoploss.html#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-different-positive-loss">stoploss documentation</a>. <a href="#parameters-in-the-strategy">Strategy Override</a>. <br> <strong>Datatype:</strong> Float</td>
<td>Changes stoploss once profit has been reached. More details in the <a href="stoploss.html#trailing-stop-loss-different-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>
<td>Offset on when to apply <code>trailing_stop_positive</code>. Percentage value which should be positive. More details in the <a href="stoploss.html#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>
<td>Only apply trailing stoploss when the offset is reached. <a href="stoploss.html">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>
@@ -2852,19 +2852,19 @@ In the below case, <code>max_open_trades</code> would be 3 after the merging - a
</tr>
<tr>
<td><code>futures_funding_rate</code></td>
<td>User-specified funding rate to be used when historical funding rates are not available from the exchange. This does not overwrite real historical rates. It is recommended that this be set to 0 unless you are testing a specific coin and you understand how the funding rate will affect freqtrade's profit calculations. <a href="../leverage/#unavailable-funding-rates">More information here</a> <br><em>Defaults to <code>None</code>.</em><br> <strong>Datatype:</strong> Float</td>
<td>User-specified funding rate to be used when historical funding rates are not available from the exchange. This does not overwrite real historical rates. It is recommended that this be set to 0 unless you are testing a specific coin and you understand how the funding rate will affect freqtrade's profit calculations. <a href="leverage.html#unavailable-funding-rates">More information here</a> <br><em>Defaults to <code>None</code>.</em><br> <strong>Datatype:</strong> Float</td>
</tr>
<tr>
<td><code>trading_mode</code></td>
<td>Specifies if you want to trade regularly, trade with leverage, or trade contracts whose prices are derived from matching cryptocurrency prices. <a href="../leverage/">leverage documentation</a>. <br><em>Defaults to <code>"spot"</code>.</em> <br> <strong>Datatype:</strong> String</td>
<td>Specifies if you want to trade regularly, trade with leverage, or trade contracts whose prices are derived from matching cryptocurrency prices. <a href="leverage.html">leverage documentation</a>. <br><em>Defaults to <code>"spot"</code>.</em> <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>margin_mode</code></td>
<td>When trading with leverage, this determines if the collateral owned by the trader will be shared or isolated to each trading pair <a href="../leverage/">leverage documentation</a>. <br> <strong>Datatype:</strong> String</td>
<td>When trading with leverage, this determines if the collateral owned by the trader will be shared or isolated to each trading pair <a href="leverage.html">leverage documentation</a>. <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>liquidation_buffer</code></td>
<td>A ratio specifying how large of a safety net to place between the liquidation price and the stoploss to prevent a position from reaching the liquidation price <a href="../leverage/">leverage documentation</a>. <br><em>Defaults to <code>0.05</code>.</em> <br> <strong>Datatype:</strong> Float</td>
<td>A ratio specifying how large of a safety net to place between the liquidation price and the stoploss to prevent a position from reaching the liquidation price <a href="leverage.html">leverage documentation</a>. <br><em>Defaults to <code>0.05</code>.</em> <br> <strong>Datatype:</strong> Float</td>
</tr>
<tr>
<td></td>
@@ -2968,11 +2968,11 @@ In the below case, <code>max_open_trades</code> would be 3 after the merging - a
</tr>
<tr>
<td><code>position_adjustment_enable</code></td>
<td>Enables the strategy to use position adjustments (additional buys or sells). <a href="../strategy-callbacks/#adjust-trade-position">More information here</a>. <br> <a href="#parameters-in-the-strategy">Strategy Override</a>. <br><em>Defaults to <code>false</code>.</em><br> <strong>Datatype:</strong> Boolean</td>
<td>Enables the strategy to use position adjustments (additional buys or sells). <a href="strategy-callbacks.html#adjust-trade-position">More information here</a>. <br> <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>max_entry_position_adjustment</code></td>
<td>Maximum additional order(s) for each open trade on top of the first entry Order. Set it to <code>-1</code> for unlimited additional orders. <a href="../strategy-callbacks/#adjust-trade-position">More information here</a>. <br> <a href="#parameters-in-the-strategy">Strategy Override</a>. <br><em>Defaults to <code>-1</code>.</em><br> <strong>Datatype:</strong> Positive Integer or -1</td>
<td>Maximum additional order(s) for each open trade on top of the first entry Order. Set it to <code>-1</code> for unlimited additional orders. <a href="strategy-callbacks.html#adjust-trade-position">More information here</a>. <br> <a href="#parameters-in-the-strategy">Strategy Override</a>. <br><em>Defaults to <code>-1</code>.</em><br> <strong>Datatype:</strong> Positive Integer or -1</td>
</tr>
<tr>
<td></td>
@@ -3000,11 +3000,11 @@ In the below case, <code>max_open_trades</code> would be 3 after the merging - a
</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>
<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.html#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>
<td>List of pairs the bot must absolutely avoid for trading and backtesting. <a href="plugins.html#pairlists-and-pairlist-handlers">More information</a>. <br> <strong>Datatype:</strong> List</td>
</tr>
<tr>
<td><code>exchange.ccxt_config</code></td>
@@ -3052,7 +3052,7 @@ In the below case, <code>max_open_trades</code> would be 3 after the merging - a
</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>
<td>Define one or more pairlists to be used. <a href="plugins.html#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></td>
@@ -3080,7 +3080,7 @@ In the below case, <code>max_open_trades</code> would be 3 after the merging - a
</tr>
<tr>
<td><code>telegram.notification_settings.*</code></td>
<td>Detailed notification settings. Refer to the <a href="../telegram-usage/">telegram documentation</a> for details.<br> <strong>Datatype:</strong> dictionary</td>
<td>Detailed notification settings. Refer to the <a href="telegram-usage.html">telegram documentation</a> for details.<br> <strong>Datatype:</strong> dictionary</td>
</tr>
<tr>
<td><code>telegram.allow_custom_messages</code></td>
@@ -3096,35 +3096,35 @@ In the below case, <code>max_open_trades</code> would be 3 after the merging - a
</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>
<td>URL for the webhook. Only required if <code>webhook.enabled</code> is <code>true</code>. See the <a href="webhook-config.html">webhook documentation</a> for more details. <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>webhook.entry</code></td>
<td>Payload to send on entry. 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>
<td>Payload to send on entry. Only required if <code>webhook.enabled</code> is <code>true</code>. See the <a href="webhook-config.html">webhook documentation</a> for more details. <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>webhook.entry_cancel</code></td>
<td>Payload to send on entry 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>
<td>Payload to send on entry order cancel. Only required if <code>webhook.enabled</code> is <code>true</code>. See the <a href="webhook-config.html">webhook documentation</a> for more details. <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>webhook.entry_fill</code></td>
<td>Payload to send on entry order filled. 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>
<td>Payload to send on entry order filled. Only required if <code>webhook.enabled</code> is <code>true</code>. See the <a href="webhook-config.html">webhook documentation</a> for more details. <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>webhook.exit</code></td>
<td>Payload to send on exit. 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>
<td>Payload to send on exit. Only required if <code>webhook.enabled</code> is <code>true</code>. See the <a href="webhook-config.html">webhook documentation</a> for more details. <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>webhook.exit_cancel</code></td>
<td>Payload to send on exit 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>
<td>Payload to send on exit order cancel. Only required if <code>webhook.enabled</code> is <code>true</code>. See the <a href="webhook-config.html">webhook documentation</a> for more details. <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>webhook.exit_fill</code></td>
<td>Payload to send on exit order filled. 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>
<td>Payload to send on exit order filled. Only required if <code>webhook.enabled</code> is <code>true</code>. See the <a href="webhook-config.html">webhook documentation</a> for more details. <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>webhook.status</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>
<td>Payload to send on status calls. Only required if <code>webhook.enabled</code> is <code>true</code>. See the <a href="webhook-config.html">webhook documentation</a> for more details. <br> <strong>Datatype:</strong> String</td>
</tr>
<tr>
<td><code>webhook.allow_custom_messages</code></td>
@@ -3136,15 +3136,15 @@ In the below case, <code>max_open_trades</code> would be 3 after the merging - a
</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>
<td>Enable usage of API Server. See the <a href="rest-api.html">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>
<td>Bind IP address. See the <a href="rest-api.html">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>
<td>Bind Port. See the <a href="rest-api.html">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>
@@ -3152,15 +3152,15 @@ In the below case, <code>max_open_trades</code> would be 3 after the merging - a
</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>
<td>Username for API server. See the <a href="rest-api.html">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>
<td>Password for API server. See the <a href="rest-api.html">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.ws_token</code></td>
<td>API token for the Message WebSocket. 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>
<td>API token for the Message WebSocket. See the <a href="rest-api.html">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>
@@ -3168,7 +3168,7 @@ In the below case, <code>max_open_trades</code> would be 3 after the merging - a
</tr>
<tr>
<td><code>external_message_consumer</code></td>
<td>Enable <a href="../producer-consumer/">Producer/Consumer mode</a> for more details. <br> <strong>Datatype:</strong> Dict</td>
<td>Enable <a href="producer-consumer.html">Producer/Consumer mode</a> for more details. <br> <strong>Datatype:</strong> Dict</td>
</tr>
<tr>
<td></td>
@@ -3196,7 +3196,7 @@ In the below case, <code>max_open_trades</code> would be 3 after the merging - a
</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="../advanced-setup/#configure-the-bot-running-as-a-systemd-service">here</a> for more details. <br> <strong>Datatype:</strong> Boolean</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="advanced-setup.html#configure-the-bot-running-as-a-systemd-service">here</a> for more details. <br> <strong>Datatype:</strong> Boolean</td>
</tr>
<tr>
<td><code>strategy</code></td>
@@ -3240,7 +3240,7 @@ In the below case, <code>max_open_trades</code> would be 3 after the merging - a
</tr>
<tr>
<td><code>log_config</code></td>
<td>Dictionary containing the log config for python logging. <a href="../advanced-setup/#advanced-logging">more info</a> <br> <strong>Datatype:</strong> dict. <br> Default: <code>FtRichHandler</code></td>
<td>Dictionary containing the log config for python logging. <a href="advanced-setup.html#advanced-logging">more info</a> <br> <strong>Datatype:</strong> dict. <br> Default: <code>FtRichHandler</code></td>
</tr>
</tbody>
</table>
@@ -3625,7 +3625,7 @@ If it is not set in either Strategy or Configuration, a default of 1000% <code>{
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>/forceenter ETH/BTC</code> to the bot, which will result in freqtrade buying the pair and holds it until a regular exit-signal (ROI, stoploss, /forceexit) 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>
<p>See <a href="telegram-usage.html">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>ignore_buying_expired_candle_after</code> to a positive number, indicating the number of seconds after which the buy signal becomes expired.</p>
@@ -3647,7 +3647,7 @@ 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>entry</code>, <code>exit</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>emergency_exit</code>,<code>force_exit</code>, <code>force_entry</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>For information on (<code>emergency_exit</code>,<code>force_exit</code>, <code>force_entry</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.html">stop loss on exchange</a></p>
<p>Syntax for Strategy:</p>
<div class="highlight"><pre><span></span><code><span class="n">order_types</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">&quot;entry&quot;</span><span class="p">:</span> <span class="s2">&quot;limit&quot;</span><span class="p">,</span>
@@ -3687,7 +3687,7 @@ The following message will be shown if your exchange does not support market ord
<p class="admonition-title">Stoploss on exchange</p>
<p><code>order_types.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>
refer to <a href="stoploss.html">the stoploss documentation</a>.</p>
<p>If <code>order_types.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">
@@ -3832,7 +3832,7 @@ API Keys are usually only required for live trading (trading for real money, bot
<span class="w"> </span><span class="c1">//...</span>
<span class="p">}</span>
</code></pre></div>
<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>
<p>You should also make sure to read the <a href="exchanges.html">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 using a 2<sup>nd</sup> configuration for your API keys.
@@ -3860,7 +3860,7 @@ freqtrade
</code></pre></div>
<p>For more information on available proxy types, please consult the <a href="https://docs.ccxt.com/#/README?id=proxy">ccxt proxy documentation</a>.</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>
<p>Now you have configured your config.json, the next step is to <a href="bot-usage.html">start your bot</a>.</p>
@@ -3899,7 +3899,7 @@ freqtrade
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../bot-basics/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Freqtrade Basics">
<a href="bot-basics.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Freqtrade Basics">
<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 11z"/></svg>
@@ -3916,7 +3916,7 @@ freqtrade
<a href="../strategy-101/" class="md-footer__link md-footer__link--next" aria-label="Next: Strategy Quickstart">
<a href="strategy-101.html" class="md-footer__link md-footer__link--next" aria-label="Next: Strategy Quickstart">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -3964,12 +3964,12 @@ freqtrade
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

136
en/develop/data-analysis/index.html → en/develop/data-analysis.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/data-analysis/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/data-analysis.html">
<link rel="prev" href="../exchanges/">
<link rel="prev" href="exchanges.html">
<link rel="next" href="../strategy_analysis_example/">
<link rel="next" href="strategy_analysis_example.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -831,7 +831,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -854,7 +854,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -877,7 +877,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -900,7 +900,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -923,7 +923,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -946,7 +946,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -969,7 +969,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -999,7 +999,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1021,7 +1021,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1043,7 +1043,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1065,7 +1065,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1149,7 +1149,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="data-analysis.html" class="md-nav__link md-nav__link--active">
@@ -1276,7 +1276,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1299,7 +1299,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1367,7 +1367,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1390,7 +1390,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1413,7 +1413,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1436,7 +1436,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1459,7 +1459,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1482,7 +1482,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1505,7 +1505,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1528,7 +1528,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1551,7 +1551,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1581,7 +1581,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1603,7 +1603,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1625,7 +1625,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1647,7 +1647,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1669,7 +1669,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -1827,7 +1827,7 @@
You can run this server using the following command: <code>docker compose -f docker/docker-compose-jupyter.yml up</code></p>
<p>This will create a dockercontainer running jupyter lab, which will be accessible using <code>https://127.0.0.1:8888/lab</code>.
Please use the link that's printed in the console after startup for simplified login.</p>
<p>For more information, Please visit the <a href="../docker_quickstart/#data-analysis-using-docker-compose">Data analysis with Docker</a> section.</p>
<p>For more information, Please visit the <a href="docker_quickstart.html#data-analysis-using-docker-compose">Data analysis with Docker</a> section.</p>
<h3 id="pro-tips">Pro tips<a class="headerlink" href="#pro-tips" title="Permanent link">&para;</a></h3>
<ul>
<li>See <a href="https://jupyter.org/documentation">jupyter.org</a> for usage instructions.</li>
@@ -1938,9 +1938,9 @@ Best avoid relative paths, since this starts at the storage location of the jupy
</code></pre></div>
<h3 id="further-data-analysis-documentation">Further Data analysis documentation<a class="headerlink" href="#further-data-analysis-documentation" title="Permanent link">&para;</a></h3>
<ul>
<li><a href="../strategy_analysis_example/">Strategy debugging</a> - also available as Jupyter notebook (<code>user_data/notebooks/strategy_analysis_example.ipynb</code>)</li>
<li><a href="../plotting/">Plotting</a></li>
<li><a href="../advanced-backtesting/">Tag Analysis</a></li>
<li><a href="strategy_analysis_example.html">Strategy debugging</a> - also available as Jupyter notebook (<code>user_data/notebooks/strategy_analysis_example.ipynb</code>)</li>
<li><a href="plotting.html">Plotting</a></li>
<li><a href="advanced-backtesting.html">Tag Analysis</a></li>
</ul>
<p>Feel free to submit an issue or Pull Request enhancing this document if you would like to share ideas on how to best analyze the data.</p>
@@ -1981,7 +1981,7 @@ Best avoid relative paths, since this starts at the storage location of the jupy
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../exchanges/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Exchange-specific Notes">
<a href="exchanges.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Exchange-specific Notes">
<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 11z"/></svg>
@@ -1998,7 +1998,7 @@ Best avoid relative paths, since this starts at the storage location of the jupy
<a href="../strategy_analysis_example/" class="md-footer__link md-footer__link--next" aria-label="Next: Strategy analysis">
<a href="strategy_analysis_example.html" class="md-footer__link md-footer__link--next" aria-label="Next: Strategy analysis">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2046,12 +2046,12 @@ Best avoid relative paths, since this starts at the storage location of the jupy
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

132
en/develop/data-download/index.html → en/develop/data-download.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/data-download/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/data-download.html">
<link rel="prev" href="../webhook-config/">
<link rel="prev" href="webhook-config.html">
<link rel="next" href="../backtesting/">
<link rel="next" href="backtesting.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="data-download.html" class="md-nav__link md-nav__link--active">
@@ -989,7 +989,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -1011,7 +1011,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -1071,7 +1071,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -1094,7 +1094,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -1117,7 +1117,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -1140,7 +1140,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -1163,7 +1163,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -1186,7 +1186,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -1209,7 +1209,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1239,7 +1239,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1261,7 +1261,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1283,7 +1283,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1305,7 +1305,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1365,7 +1365,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1388,7 +1388,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1411,7 +1411,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1479,7 +1479,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1502,7 +1502,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1525,7 +1525,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1548,7 +1548,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1571,7 +1571,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1594,7 +1594,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1617,7 +1617,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1640,7 +1640,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1663,7 +1663,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1693,7 +1693,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1715,7 +1715,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1737,7 +1737,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1759,7 +1759,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1781,7 +1781,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -2519,7 +2519,7 @@ Most other exchanges provide OHLCV data with sufficient history, so downloading
</div>
<div class="admonition note">
<p class="admonition-title">Kraken user</p>
<p>Kraken users should read <a href="../exchanges/#historic-kraken-data">this</a> before starting to download data.</p>
<p>Kraken users should read <a href="exchanges.html#historic-kraken-data">this</a> before starting to download data.</p>
</div>
<p>Example call:</p>
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>download-data<span class="w"> </span>--exchange<span class="w"> </span>kraken<span class="w"> </span>--pairs<span class="w"> </span>XRP/EUR<span class="w"> </span>ETH/EUR<span class="w"> </span>--days<span class="w"> </span><span class="m">20</span><span class="w"> </span>--dl-trades
@@ -2529,7 +2529,7 @@ Most other exchanges provide OHLCV data with sufficient history, so downloading
<p>While this method uses async calls, it will be slow, since it requires the result of the previous call to generate the next request to the exchange.</p>
</div>
<h2 id="next-step">Next step<a class="headerlink" href="#next-step" title="Permanent link">&para;</a></h2>
<p>Great, you now have some data downloaded, so you can now start <a href="../backtesting/">backtesting</a> your strategy.</p>
<p>Great, you now have some data downloaded, so you can now start <a href="backtesting.html">backtesting</a> your strategy.</p>
@@ -2568,7 +2568,7 @@ Most other exchanges provide OHLCV data with sufficient history, so downloading
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../webhook-config/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Web Hook">
<a href="webhook-config.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Web Hook">
<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 11z"/></svg>
@@ -2585,7 +2585,7 @@ Most other exchanges provide OHLCV data with sufficient history, so downloading
<a href="../backtesting/" class="md-footer__link md-footer__link--next" aria-label="Next: Backtesting">
<a href="backtesting.html" class="md-footer__link md-footer__link--next" aria-label="Next: Backtesting">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2633,12 +2633,12 @@ Most other exchanges provide OHLCV data with sufficient history, so downloading
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

140
en/develop/deprecated/index.html → en/develop/deprecated.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/deprecated/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/deprecated.html">
<link rel="prev" href="../updating/">
<link rel="prev" href="updating.html">
<link rel="next" href="../developer/">
<link rel="next" href="developer.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -831,7 +831,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -854,7 +854,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -877,7 +877,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -900,7 +900,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -923,7 +923,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -946,7 +946,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -969,7 +969,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -999,7 +999,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1021,7 +1021,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1043,7 +1043,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1065,7 +1065,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1125,7 +1125,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1148,7 +1148,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1171,7 +1171,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1239,7 +1239,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1262,7 +1262,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1285,7 +1285,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1308,7 +1308,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1331,7 +1331,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1354,7 +1354,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1377,7 +1377,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1400,7 +1400,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1423,7 +1423,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1453,7 +1453,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1475,7 +1475,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1497,7 +1497,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1541,7 +1541,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="deprecated.html" class="md-nav__link md-nav__link--active">
@@ -1763,7 +1763,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -2021,7 +2021,7 @@ Since this leads to much confusion, and slows down backtesting (while not being
<p>This command line option was deprecated in 2019.7-dev (develop branch) and removed in 2019.9.</p>
<h3 id="the-dynamic-whitelist-command-line-option">The <strong>--dynamic-whitelist</strong> command line option<a class="headerlink" href="#the-dynamic-whitelist-command-line-option" title="Permanent link">&para;</a></h3>
<p>This command line option was deprecated in 2018 and removed freqtrade 2019.6-dev (develop branch) and in freqtrade 2019.7.
Please refer to <a href="../plugins/#pairlists-and-pairlist-handlers">pairlists</a> instead.</p>
Please refer to <a href="plugins.html#pairlists-and-pairlist-handlers">pairlists</a> instead.</p>
<h3 id="the-live-command-line-option">the <code>--live</code> command line option<a class="headerlink" href="#the-live-command-line-option" title="Permanent link">&para;</a></h3>
<p><code>--live</code> in the context of backtesting allowed to download the latest tick data for backtesting.
Did only download the latest 500 candles, so was ineffective in getting good backtest data.
@@ -2038,12 +2038,12 @@ Removed in 2019-7-dev (develop branch) and in freqtrade 2019.8.</p>
As this does however increase risk and provides no benefit, it's been removed for maintainability purposes in 2021.7.</p>
<h3 id="legacy-hyperopt-mode">Legacy Hyperopt mode<a class="headerlink" href="#legacy-hyperopt-mode" title="Permanent link">&para;</a></h3>
<p>Using separate hyperopt files was deprecated in 2021.4 and was removed in 2021.9.
Please switch to the new <a href="../hyperopt/">Parametrized Strategies</a> to benefit from the new hyperopt interface.</p>
Please switch to the new <a href="hyperopt.html">Parametrized Strategies</a> to benefit from the new hyperopt interface.</p>
<h2 id="strategy-changes-between-v2-and-v3">Strategy changes between V2 and V3<a class="headerlink" href="#strategy-changes-between-v2-and-v3" title="Permanent link">&para;</a></h2>
<p>Isolated Futures / short trading was introduced in 2022.4. This required major changes to configuration settings, strategy interfaces, ...</p>
<p>We have put a great effort into keeping compatibility with existing strategies, so if you just want to continue using freqtrade in spot markets, there are no changes necessary.
While we may drop support for the current interface sometime in the future, we will announce this separately and have an appropriate transition period.</p>
<p>Please follow the <a href="../strategy_migration/">Strategy migration</a> guide to migrate your strategy to the new format to start using the new functionalities.</p>
<p>Please follow the <a href="strategy_migration.html">Strategy migration</a> guide to migrate your strategy to the new format to start using the new functionalities.</p>
<h3 id="webhooks-changes-with-20224">webhooks - changes with 2022.4<a class="headerlink" href="#webhooks-changes-with-20224" title="Permanent link">&para;</a></h3>
<h4 id="buy_tag-has-been-renamed-to-enter_tag"><code>buy_tag</code> has been renamed to <code>enter_tag</code><a class="headerlink" href="#buy_tag-has-been-renamed-to-enter_tag" title="Permanent link">&para;</a></h4>
<p>This should apply only to your strategy and potentially to webhooks.
@@ -2059,15 +2059,15 @@ We will keep a compatibility layer for 1-2 versions (so both <code>buy_tag</code
<li><code>webhooksellcancel</code>, <code>webhookexitcancel</code> -&gt; <code>exit_cancel</code></li>
</ul>
<h2 id="removal-of-populate_any_indicators">Removal of <code>populate_any_indicators</code><a class="headerlink" href="#removal-of-populate_any_indicators" title="Permanent link">&para;</a></h2>
<p>version 2023.3 saw the removal of <code>populate_any_indicators</code> in favor of split methods for feature engineering and targets. Please read the <a href="../strategy_migration/#freqai-strategy">migration document</a> for full details.</p>
<p>version 2023.3 saw the removal of <code>populate_any_indicators</code> in favor of split methods for feature engineering and targets. Please read the <a href="strategy_migration.html#freqai-strategy">migration document</a> for full details.</p>
<h2 id="removal-of-protections-from-configuration">Removal of <code>protections</code> from configuration<a class="headerlink" href="#removal-of-protections-from-configuration" title="Permanent link">&para;</a></h2>
<p>Setting protections from the configuration via <code>"protections": [],</code> has been removed in 2024.10, after having raised deprecation warnings for over 3 years.</p>
<h2 id="hdf5-data-storage">hdf5 data storage<a class="headerlink" href="#hdf5-data-storage" title="Permanent link">&para;</a></h2>
<p>Using hdf5 as data storage has been deprecated in 2024.12 and was removed in 2025.1. We recommend switching to the feather data format.</p>
<p>Please use the <a href="../data-download/#sub-command-convert-data"><code>convert-data</code> subcommand</a> to convert your existing data to one of the supported formats before updating.</p>
<p>Please use the <a href="data-download.html#sub-command-convert-data"><code>convert-data</code> subcommand</a> to convert your existing data to one of the supported formats before updating.</p>
<h2 id="configuring-advanced-logging-via-config">Configuring advanced logging via config<a class="headerlink" href="#configuring-advanced-logging-via-config" title="Permanent link">&para;</a></h2>
<p>Configuring syslog and journald via <code>--logfile systemd</code> and <code>--logfile journald</code> respectively has been deprecated in 2025.3.
Please use configuration based <a href="../advanced-setup/#advanced-logging">log setup</a> instead.</p>
Please use configuration based <a href="advanced-setup.html#advanced-logging">log setup</a> instead.</p>
<h2 id="removal-of-the-edge-module">Removal of the edge module<a class="headerlink" href="#removal-of-the-edge-module" title="Permanent link">&para;</a></h2>
<p>The edge module has been deprecated in 2023.9 and removed in 2025.6.
All functionalities of edge have been removed, and having edge configured will result in an error.</p>
@@ -2109,7 +2109,7 @@ All functionalities of edge have been removed, and having edge configured will r
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../updating/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Updating Freqtrade">
<a href="updating.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Updating Freqtrade">
<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 11z"/></svg>
@@ -2126,7 +2126,7 @@ All functionalities of edge have been removed, and having edge configured will r
<a href="../developer/" class="md-footer__link md-footer__link--next" aria-label="Next: Contributors Guide">
<a href="developer.html" class="md-footer__link md-footer__link--next" aria-label="Next: Contributors Guide">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2174,12 +2174,12 @@ All functionalities of edge have been removed, and having edge configured will r
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

128
en/develop/developer/index.html → en/develop/developer.html
View File

@@ -10,14 +10,14 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/developer/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/developer.html">
<link rel="prev" href="../deprecated/">
<link rel="prev" href="deprecated.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -26,10 +26,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -48,9 +48,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -106,9 +106,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -248,9 +248,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -277,7 +277,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -299,7 +299,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -359,7 +359,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -382,7 +382,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -412,7 +412,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -434,7 +434,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -456,7 +456,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -478,7 +478,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -500,7 +500,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -522,7 +522,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -544,7 +544,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -566,7 +566,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -626,7 +626,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -649,7 +649,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -672,7 +672,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -695,7 +695,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -725,7 +725,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -747,7 +747,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -769,7 +769,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -829,7 +829,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -852,7 +852,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -875,7 +875,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -898,7 +898,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -921,7 +921,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -944,7 +944,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -967,7 +967,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -997,7 +997,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1019,7 +1019,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1041,7 +1041,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1063,7 +1063,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1123,7 +1123,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1146,7 +1146,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1169,7 +1169,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1237,7 +1237,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1260,7 +1260,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1283,7 +1283,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1306,7 +1306,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1329,7 +1329,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1352,7 +1352,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1375,7 +1375,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1398,7 +1398,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1421,7 +1421,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1451,7 +1451,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1473,7 +1473,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1495,7 +1495,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1517,7 +1517,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1561,7 +1561,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="developer.html" class="md-nav__link md-nav__link--active">
@@ -2537,7 +2537,7 @@ This method can also be used to debug a strategy, by setting the breakpoints wit
If your environment has not been detected, you can also pick a path manually.</p>
<h4 id="pycharm">Pycharm<a class="headerlink" href="#pycharm" title="Permanent link">&para;</a></h4>
<p>In pycharm, you can select the appropriate Environment in the "Run/Debug Configurations" window.
<img alt="Pycharm debug configuration" src="../assets/pycharm_debug.png" /></p>
<img alt="Pycharm debug configuration" src="assets/pycharm_debug.png" /></p>
</details>
<div class="admonition note">
<p class="admonition-title">Startup directory</p>
@@ -2619,7 +2619,7 @@ Hopefully you also want to contribute this back upstream.</p>
<span class="k">return</span> <span class="n">pairs</span>
</code></pre></div>
<h3 id="protections">Protections<a class="headerlink" href="#protections" title="Permanent link">&para;</a></h3>
<p>Best read the <a href="../plugins/#protections">Protection documentation</a> to understand protections.
<p>Best read the <a href="plugins.html#protections">Protection documentation</a> to understand protections.
This Guide is directed towards Developers who want to develop a new protection.</p>
<p>No protection should use datetime directly, but use the provided <code>date_now</code> variable for date calculations. This preserves the ability to backtest protections.</p>
<div class="admonition tip">
@@ -2912,7 +2912,7 @@ twine<span class="w"> </span>upload<span class="w"> </span>dist/*
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../deprecated/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Deprecated Features">
<a href="deprecated.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Deprecated Features">
<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 11z"/></svg>
@@ -2961,12 +2961,12 @@ twine<span class="w"> </span>upload<span class="w"> </span>dist/*
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

140
en/develop/docker_quickstart/index.html → en/develop/docker_quickstart.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/docker_quickstart/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/docker_quickstart.html">
<link rel="prev" href="..">
<link rel="prev" href="index.html">
<link rel="next" href="../installation/">
<link rel="next" href="installation.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -323,7 +323,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="docker_quickstart.html" class="md-nav__link md-nav__link--active">
@@ -580,7 +580,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -603,7 +603,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -633,7 +633,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -655,7 +655,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -677,7 +677,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -699,7 +699,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -721,7 +721,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -743,7 +743,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -765,7 +765,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -787,7 +787,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -847,7 +847,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -870,7 +870,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -893,7 +893,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -916,7 +916,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -946,7 +946,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -968,7 +968,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -990,7 +990,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -1050,7 +1050,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -1073,7 +1073,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -1096,7 +1096,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -1119,7 +1119,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -1142,7 +1142,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -1165,7 +1165,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -1188,7 +1188,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1218,7 +1218,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1240,7 +1240,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1262,7 +1262,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1284,7 +1284,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1344,7 +1344,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1367,7 +1367,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1390,7 +1390,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1458,7 +1458,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1481,7 +1481,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1504,7 +1504,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1527,7 +1527,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1550,7 +1550,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1573,7 +1573,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1596,7 +1596,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1619,7 +1619,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1642,7 +1642,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1672,7 +1672,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1694,7 +1694,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1716,7 +1716,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1738,7 +1738,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1760,7 +1760,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -2065,7 +2065,7 @@ The last 2 steps in the snippet create the directory with <code>user_data</code>
<p class="admonition-title"><code>SampleStrategy</code> is just a demo!</p>
<p>The <code>SampleStrategy</code> is there for your reference and give you ideas for your own strategy.
Please always backtest your strategy and use dry-run for some time before risking real money!
You will find more information about Strategy development in the <a href="../strategy-customization/">Strategy documentation</a>.</p>
You will find more information about Strategy development in the <a href="strategy-customization.html">Strategy documentation</a>.</p>
</div>
<p>Once this is done, you're ready to launch the bot in trading mode (Dry-run or Live-trading, depending on your answer to the corresponding question you made above).</p>
<div class="highlight"><pre><span></span><code>docker<span class="w"> </span>compose<span class="w"> </span>up<span class="w"> </span>-d
@@ -2082,7 +2082,7 @@ You will find more information about Strategy development in the <a href="../str
<p>If you're running on a VPS, you should consider using either a ssh tunnel, or setup a VPN (openVPN, wireguard) to connect to your bot.
This will ensure that freqUI is not directly exposed to the internet, which is not recommended for security reasons (freqUI does not support https out of the box).
Setup of these tools is not part of this tutorial, however many good tutorials can be found on the internet.
Please also read the <a href="../rest-api/#configuration-with-docker">API configuration with docker</a> section to learn more about this configuration.</p>
Please also read the <a href="rest-api.html#configuration-with-docker">API configuration with docker</a> section to learn more about this configuration.</p>
</details>
<h4 id="monitoring-the-bot">Monitoring the bot<a class="headerlink" href="#monitoring-the-bot" title="Permanent link">&para;</a></h4>
<p>You can check for running instances with <code>docker compose ps</code>.
@@ -2111,7 +2111,7 @@ docker<span class="w"> </span>compose<span class="w"> </span>up<span class="w">
<p class="admonition-title"><code>docker compose</code> for trade commands</p>
<p>Trade commands (<code>freqtrade trade &lt;...&gt;</code>) should not be ran via <code>docker compose run</code> - but should use <code>docker compose up -d</code> instead.
This makes sure that the container is properly started (including port forwardings) and will make sure that the container will restart after a system reboot.
If you intend to use freqUI, please also ensure to adjust the <a href="../rest-api/#configuration-with-docker">configuration accordingly</a>, otherwise the UI will not be available.</p>
If you intend to use freqUI, please also ensure to adjust the <a href="rest-api.html#configuration-with-docker">configuration accordingly</a>, otherwise the UI will not be available.</p>
</div>
<div class="admonition note">
<p class="admonition-title"><code>docker compose run --rm</code></p>
@@ -2128,12 +2128,12 @@ This can be useful for fetching exchange information to add to your <code>config
<p>Download backtesting data for 5 days for the pair ETH/BTC and 1h timeframe from Binance. The data will be stored in the directory <code>user_data/data/</code> on the host.</p>
<div class="highlight"><pre><span></span><code>docker<span class="w"> </span>compose<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span>freqtrade<span class="w"> </span>download-data<span class="w"> </span>--pairs<span class="w"> </span>ETH/BTC<span class="w"> </span>--exchange<span class="w"> </span>binance<span class="w"> </span>--days<span class="w"> </span><span class="m">5</span><span class="w"> </span>-t<span class="w"> </span>1h
</code></pre></div>
<p>Head over to the <a href="../data-download/">Data Downloading Documentation</a> for more details on downloading data.</p>
<p>Head over to the <a href="data-download.html">Data Downloading Documentation</a> for more details on downloading data.</p>
<h4 id="example-backtest-with-docker">Example: Backtest with docker<a class="headerlink" href="#example-backtest-with-docker" title="Permanent link">&para;</a></h4>
<p>Run backtesting in docker-containers for SampleStrategy and specified timerange of historical data, on 5m timeframe:</p>
<div class="highlight"><pre><span></span><code>docker<span class="w"> </span>compose<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span>freqtrade<span class="w"> </span>backtesting<span class="w"> </span>--config<span class="w"> </span>user_data/config.json<span class="w"> </span>--strategy<span class="w"> </span>SampleStrategy<span class="w"> </span>--timerange<span class="w"> </span><span class="m">20190801</span>-20191001<span class="w"> </span>-i<span class="w"> </span>5m
</code></pre></div>
<p>Head over to the <a href="../backtesting/">Backtesting Documentation</a> to learn more.</p>
<p>Head over to the <a href="backtesting.html">Backtesting Documentation</a> to learn more.</p>
<h3 id="additional-dependencies-with-docker">Additional dependencies with docker<a class="headerlink" href="#additional-dependencies-with-docker" title="Permanent link">&para;</a></h3>
<p>If your strategy requires dependencies not included in the default image - it will be necessary to build the image on your host.
For this, please create a Dockerfile containing installation steps for the additional dependencies (have a look at <a href="https://github.com/freqtrade/freqtrade/blob/develop/docker/Dockerfile.custom">docker/Dockerfile.custom</a> for an example).</p>
@@ -2145,7 +2145,7 @@ For this, please create a Dockerfile containing installation steps for the addit
</code></pre></div>
<p>You can then run <code>docker compose build --pull</code> to build the docker image, and run it using the commands described above.</p>
<h3 id="plotting-with-docker">Plotting with docker<a class="headerlink" href="#plotting-with-docker" title="Permanent link">&para;</a></h3>
<p>Commands <code>freqtrade plot-profit</code> and <code>freqtrade plot-dataframe</code> (<a href="../plotting/">Documentation</a>) are available by changing the image to <code>*_plot</code> in your <code>docker-compose.yml</code> file.
<p>Commands <code>freqtrade plot-profit</code> and <code>freqtrade plot-dataframe</code> (<a href="plotting.html">Documentation</a>) are available by changing the image to <code>*_plot</code> in your <code>docker-compose.yml</code> file.
You can then use these commands as follows:</p>
<div class="highlight"><pre><span></span><code>docker<span class="w"> </span>compose<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span>freqtrade<span class="w"> </span>plot-dataframe<span class="w"> </span>--strategy<span class="w"> </span>AwesomeStrategy<span class="w"> </span>-p<span class="w"> </span>BTC/ETH<span class="w"> </span>--timerange<span class="o">=</span><span class="m">20180801</span>-20180805
</code></pre></div>
@@ -2222,7 +2222,7 @@ Best use a linux-VPS for running freqtrade reliably.</p>
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href=".." class="md-footer__link md-footer__link--prev" aria-label="Previous: Home">
<a href="index.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Home">
<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 11z"/></svg>
@@ -2239,7 +2239,7 @@ Best use a linux-VPS for running freqtrade reliably.</p>
<a href="../installation/" class="md-footer__link md-footer__link--next" aria-label="Next: Linux/MacOS/Raspberry">
<a href="installation.html" class="md-footer__link md-footer__link--next" aria-label="Next: Linux/MacOS/Raspberry">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2287,12 +2287,12 @@ Best use a linux-VPS for running freqtrade reliably.</p>
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

142
en/develop/exchanges/index.html → en/develop/exchanges.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/exchanges/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/exchanges.html">
<link rel="prev" href="../plotting/">
<link rel="prev" href="plotting.html">
<link rel="next" href="../data-analysis/">
<link rel="next" href="data-analysis.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -831,7 +831,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -854,7 +854,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -877,7 +877,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -900,7 +900,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -923,7 +923,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -946,7 +946,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -969,7 +969,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -999,7 +999,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1021,7 +1021,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1043,7 +1043,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1087,7 +1087,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="exchanges.html" class="md-nav__link md-nav__link--active">
@@ -1461,7 +1461,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1484,7 +1484,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1507,7 +1507,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1575,7 +1575,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1598,7 +1598,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1621,7 +1621,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1644,7 +1644,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1667,7 +1667,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1690,7 +1690,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1713,7 +1713,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1736,7 +1736,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1759,7 +1759,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1789,7 +1789,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1811,7 +1811,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1833,7 +1833,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1855,7 +1855,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1877,7 +1877,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -2283,7 +2283,7 @@ We try to provide sensible defaults per exchange where possible, if you encounte
<p class="admonition-title">Server location and geo-ip restrictions</p>
<p>Please be aware that Binance restricts API access regarding the server country. The current and non-exhaustive countries blocked are Canada, Malaysia, Netherlands and United States. Please go to <a href="https://www.binance.com/en/terms">binance terms &gt; b. Eligibility</a> to find up to date list.</p>
</div>
<p>Binance supports <a href="../configuration/#understand-order_time_in_force">time_in_force</a>.</p>
<p>Binance supports <a href="configuration.html#understand-order_time_in_force">time_in_force</a>.</p>
<div class="admonition tip">
<p class="admonition-title">Stoploss on Exchange</p>
<p>Binance supports <code>stoploss_on_exchange</code> and uses <code>stop-loss-limit</code> orders. It provides great advantages, so we recommend to benefit from it by enabling stoploss on exchange.
@@ -2330,7 +2330,7 @@ Violating these rules will result in a trading restriction.</p>
<h4 id="binance-isolated-futures-settings">Binance isolated futures settings<a class="headerlink" href="#binance-isolated-futures-settings" title="Permanent link">&para;</a></h4>
<p>Users will also have to have the futures-setting "Position Mode" set to "One-way Mode", and "Asset Mode" set to "Single-Asset Mode".
These settings will be checked on startup, and freqtrade will show an error if this setting is wrong.</p>
<p><img alt="Binance futures settings" src="../assets/binance_futures_settings.png" /></p>
<p><img alt="Binance futures settings" src="assets/binance_futures_settings.png" /></p>
<p>Freqtrade will not attempt to change these settings.</p>
<h4 id="binance-bnfcr-futures">Binance BNFCR futures<a class="headerlink" href="#binance-bnfcr-futures" title="Permanent link">&para;</a></h4>
<p>BNFCR mode are a special type of futures mode on Binance to work around regulatory issues in Europe.<br />
@@ -2348,13 +2348,13 @@ To use BNFCR futures, you will have to have the following combination of setting
<p>On the exchange, you'll have to use "Multi-asset Mode" - and "Position Mode set to "One-way Mode".<br />
Freqtrade will check these settings on startup, but won't attempt to change them.</p>
<h2 id="bingx">Bingx<a class="headerlink" href="#bingx" title="Permanent link">&para;</a></h2>
<p>BingX supports <a href="../configuration/#understand-order_time_in_force">time_in_force</a> with settings "GTC" (good till cancelled), "IOC" (immediate-or-cancel) and "PO" (Post only) settings.</p>
<p>BingX supports <a href="configuration.html#understand-order_time_in_force">time_in_force</a> with settings "GTC" (good till cancelled), "IOC" (immediate-or-cancel) and "PO" (Post only) settings.</p>
<div class="admonition tip">
<p class="admonition-title">Stoploss on Exchange</p>
<p>Bingx supports <code>stoploss_on_exchange</code> and can use both stop-limit and stop-market orders. It provides great advantages, so we recommend to benefit from it by enabling stoploss on exchange.</p>
</div>
<h2 id="kraken">Kraken<a class="headerlink" href="#kraken" title="Permanent link">&para;</a></h2>
<p>Kraken supports <a href="../configuration/#understand-order_time_in_force">time_in_force</a> with settings "GTC" (good till cancelled), "IOC" (immediate-or-cancel) and "PO" (Post only) settings.</p>
<p>Kraken supports <a href="configuration.html#understand-order_time_in_force">time_in_force</a> with settings "GTC" (good till cancelled), "IOC" (immediate-or-cancel) and "PO" (Post only) settings.</p>
<div class="admonition tip">
<p class="admonition-title">Stoploss on Exchange</p>
<p>Kraken supports <code>stoploss_on_exchange</code> and can use both stop-loss-market and stop-loss-limit orders. It provides great advantages, so we recommend to benefit from it.
@@ -2409,7 +2409,7 @@ So, in order to mitigate Kraken API "Rate limit exceeded" exception, this config
<span class="w"> </span><span class="c1">// ...</span>
<span class="p">}</span>
</code></pre></div>
<p>Kucoin supports <a href="../configuration/#understand-order_time_in_force">time_in_force</a>.</p>
<p>Kucoin supports <a href="configuration.html#understand-order_time_in_force">time_in_force</a>.</p>
<div class="admonition tip">
<p class="admonition-title">Stoploss on Exchange</p>
<p>Kucoin supports <code>stoploss_on_exchange</code> and can use both stop-loss-market and stop-loss-limit orders. It provides great advantages, so we recommend to benefit from it.
@@ -2575,9 +2575,9 @@ To use these with Freqtrade, you will need to use the following configuration pa
<h3 id="getting-latest-price-incomplete-candles">Getting latest price / Incomplete candles<a class="headerlink" href="#getting-latest-price-incomplete-candles" title="Permanent link">&para;</a></h3>
<p>Most exchanges return current incomplete candle via their OHLCV/klines API interface.
By default, Freqtrade assumes that incomplete candle is fetched from the exchange and removes the last candle assuming it's the incomplete candle.</p>
<p>Whether your exchange returns incomplete candles or not can be checked using <a href="../developer/#incomplete-candles">the helper script</a> from the Contributor documentation.</p>
<p>Whether your exchange returns incomplete candles or not can be checked using <a href="developer.html#incomplete-candles">the helper script</a> from the Contributor documentation.</p>
<p>Due to the danger of repainting, Freqtrade does not allow you to use this incomplete candle.</p>
<p>However, if it is based on the need for the latest price for your strategy - then this requirement can be acquired using the <a href="../strategy-customization/#possible-options-for-dataprovider">data provider</a> from within the strategy.</p>
<p>However, if it is based on the need for the latest price for your strategy - then this requirement can be acquired using the <a href="strategy-customization.html#possible-options-for-dataprovider">data provider</a> from within the strategy.</p>
<h3 id="advanced-freqtrade-exchange-configuration">Advanced Freqtrade Exchange configuration<a class="headerlink" href="#advanced-freqtrade-exchange-configuration" title="Permanent link">&para;</a></h3>
<p>Advanced options can be configured using the <code>_ft_has_params</code> setting, which will override Defaults and exchange-specific behavior.</p>
<p>Available options are listed in the exchange-class as <code>_ft_has_default</code>.</p>
@@ -2633,7 +2633,7 @@ By default, Freqtrade assumes that incomplete candle is fetched from the exchang
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../plotting/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Plotting">
<a href="plotting.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Plotting">
<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 11z"/></svg>
@@ -2650,7 +2650,7 @@ By default, Freqtrade assumes that incomplete candle is fetched from the exchang
<a href="../data-analysis/" class="md-footer__link md-footer__link--next" aria-label="Next: Jupyter Notebooks">
<a href="data-analysis.html" class="md-footer__link md-footer__link--next" aria-label="Next: Jupyter Notebooks">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2698,12 +2698,12 @@ By default, Freqtrade assumes that incomplete candle is fetched from the exchang
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

144
en/develop/faq/index.html → en/develop/faq.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/faq/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/faq.html">
<link rel="prev" href="../sql_cheatsheet/">
<link rel="prev" href="sql_cheatsheet.html">
<link rel="next" href="../strategy_migration/">
<link rel="next" href="strategy_migration.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -831,7 +831,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -854,7 +854,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -877,7 +877,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -900,7 +900,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -923,7 +923,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -946,7 +946,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -969,7 +969,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -999,7 +999,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1021,7 +1021,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1043,7 +1043,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1065,7 +1065,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1125,7 +1125,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1148,7 +1148,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1171,7 +1171,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1239,7 +1239,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1262,7 +1262,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1285,7 +1285,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1308,7 +1308,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1331,7 +1331,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1354,7 +1354,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1377,7 +1377,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1400,7 +1400,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1423,7 +1423,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1475,7 +1475,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="faq.html" class="md-nav__link md-nav__link--active">
@@ -1823,7 +1823,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1845,7 +1845,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1867,7 +1867,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1889,7 +1889,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -2264,14 +2264,14 @@
<h1 id="freqtrade-faq">Freqtrade FAQ<a class="headerlink" href="#freqtrade-faq" title="Permanent link">&para;</a></h1>
<h2 id="supported-markets">Supported Markets<a class="headerlink" href="#supported-markets" title="Permanent link">&para;</a></h2>
<p>Freqtrade supports spot trading, as well as (isolated) futures trading for some selected exchanges. Please refer to the <a href="../#supported-futures-exchanges-experimental">documentation start page</a> for an up-to-date list of supported exchanges.</p>
<p>Freqtrade supports spot trading, as well as (isolated) futures trading for some selected exchanges. Please refer to the <a href="index.html#supported-futures-exchanges-experimental">documentation start page</a> for an up-to-date list of supported exchanges.</p>
<h3 id="can-my-bot-open-short-positions">Can my bot open short positions?<a class="headerlink" href="#can-my-bot-open-short-positions" title="Permanent link">&para;</a></h3>
<p>Freqtrade can open short positions in futures markets.
This requires the strategy to be made for this - and <code>"trading_mode": "futures"</code> in the configuration.
Please make sure to read the <a href="../leverage/">relevant documentation page</a> first.</p>
Please make sure to read the <a href="leverage.html">relevant documentation page</a> first.</p>
<p>In spot markets, you can in some cases use leveraged spot tokens, which reflect an inverted pair (eg. BTCUP/USD, BTCDOWN/USD, ETHBULL/USD, ETHBEAR/USD,...) which can be traded with Freqtrade.</p>
<h3 id="can-my-bot-trade-options-or-futures">Can my bot trade options or futures?<a class="headerlink" href="#can-my-bot-trade-options-or-futures" title="Permanent link">&para;</a></h3>
<p>Futures trading is supported for selected exchanges. Please refer to the <a href="../#supported-futures-exchanges-experimental">documentation start page</a> for an up-to-date list of supported exchanges.</p>
<p>Futures trading is supported for selected exchanges. Please refer to the <a href="index.html#supported-futures-exchanges-experimental">documentation start page</a> for an up-to-date list of supported exchanges.</p>
<h2 id="beginner-tips-tricks">Beginner Tips &amp; Tricks<a class="headerlink" href="#beginner-tips-tricks" title="Permanent link">&para;</a></h2>
<ul>
<li>When you work with your strategy &amp; hyperopt file you should use a proper code editor like VSCode or PyCharm. A good code editor will provide syntax highlighting as well as line numbers, making it easy to find syntax errors (most likely pointed out by Freqtrade during startup).</li>
@@ -2279,7 +2279,7 @@ Please make sure to read the <a href="../leverage/">relevant documentation page<
<h2 id="freqtrade-common-questions">Freqtrade common questions<a class="headerlink" href="#freqtrade-common-questions" title="Permanent link">&para;</a></h2>
<h3 id="can-freqtrade-open-multiple-positions-on-the-same-pair-in-parallel">Can freqtrade open multiple positions on the same pair in parallel?<a class="headerlink" href="#can-freqtrade-open-multiple-positions-on-the-same-pair-in-parallel" title="Permanent link">&para;</a></h3>
<p>No. Freqtrade will only open one position per pair at a time.
You can however use the <a href="../strategy-callbacks/#adjust-trade-position"><code>adjust_trade_position()</code> callback</a> to adjust an open position.</p>
You can however use the <a href="strategy-callbacks.html#adjust-trade-position"><code>adjust_trade_position()</code> callback</a> to adjust an open position.</p>
<p>Backtesting provides an option for this in <code>--eps</code> - however this is only there to highlight "hidden" signals, and will not work in live.</p>
<h3 id="the-bot-does-not-start">The bot does not start<a class="headerlink" href="#the-bot-does-not-start" title="Permanent link">&para;</a></h3>
<p>Running the bot with <code>freqtrade trade --config config.json</code> shows the output <code>freqtrade: command not found</code>.</p>
@@ -2290,7 +2290,7 @@ You can however use the <a href="../strategy-callbacks/#adjust-trade-position"><
</ul>
</li>
<li>The installation did not complete successfully.<ul>
<li>Please check the <a href="../installation/">Installation documentation</a>.</li>
<li>Please check the <a href="installation.html">Installation documentation</a>.</li>
</ul>
</li>
</ul>
@@ -2336,7 +2336,7 @@ RPC calls (Telegram's <code>/balance</code>, API calls to <code>/balance</code>)
To force an immediate update, you can use <code>/reload_config</code> - which will restart the bot.</p>
<h3 id="i-want-to-use-incomplete-candles">I want to use incomplete candles<a class="headerlink" href="#i-want-to-use-incomplete-candles" title="Permanent link">&para;</a></h3>
<p>Freqtrade will not provide incomplete candles to strategies. Using incomplete candles will lead to repainting and consequently to strategies with "ghost" buys, which are impossible to both backtest, and verify after they happened.</p>
<p>You can use "current" market data by using the <a href="../strategy-customization/#orderbookpair-maximum">dataprovider</a>'s orderbook or ticker methods - which however cannot be used during backtesting.</p>
<p>You can use "current" market data by using the <a href="strategy-customization.html#orderbookpair-maximum">dataprovider</a>'s orderbook or ticker methods - which however cannot be used during backtesting.</p>
<h3 id="is-there-a-setting-to-only-exit-the-trades-being-held-and-not-perform-any-new-entries">Is there a setting to only Exit the trades being held and not perform any new Entries?<a class="headerlink" href="#is-there-a-setting-to-only-exit-the-trades-being-held-and-not-perform-any-new-entries" title="Permanent link">&para;</a></h3>
<p>You can use the <code>/stopentry</code> command in Telegram to prevent future trade entry, followed by <code>/forceexit all</code> (sell all open trades).</p>
<h3 id="i-sold-the-bots-capital-and-now-theres-errors-in-the-log">I sold the bot's capital and now there's errors in the log<a class="headerlink" href="#i-sold-the-bots-capital-and-now-theres-errors-in-the-log" title="Permanent link">&para;</a></h3>
@@ -2345,7 +2345,7 @@ If you happen to (accidentally) sell the bot's capital, freqtrade will try to re
<p>This is a best-effort approach, and will not work in all cases, especially when using order types that are not supported by freqtrade (OCO, iceberg, etc.), or when working with older trades (where the exchange no longer provides full order information).
The exact limits will vary between exchanges - with the details usually being documented in the exchange's API documentation.</p>
<h3 id="i-want-to-run-multiple-bots-on-the-same-machine">I want to run multiple bots on the same machine<a class="headerlink" href="#i-want-to-run-multiple-bots-on-the-same-machine" title="Permanent link">&para;</a></h3>
<p>Please look at the <a href="../advanced-setup/#running-multiple-instances-of-freqtrade">advanced setup documentation Page</a>.</p>
<p>Please look at the <a href="advanced-setup.html#running-multiple-instances-of-freqtrade">advanced setup documentation Page</a>.</p>
<h3 id="im-getting-impossible-to-load-strategy-when-starting-the-bot">I'm getting "Impossible to load Strategy" when starting the bot<a class="headerlink" href="#im-getting-impossible-to-load-strategy-when-starting-the-bot" title="Permanent link">&para;</a></h3>
<p>This error message is shown when the bot cannot load the strategy.
Usually, you can use <code>freqtrade list-strategies</code> to list all available strategies.
@@ -2385,7 +2385,7 @@ This can happen if there was an interruption to the websocket connection - or if
<p>Freqtrade will handle this gracefully by falling back to the REST api.
While this makes the iteration slightly slower (due to the REST Api call) - it will not cause any problems to the bot's operation.</p>
<h3 id="im-getting-the-exchange-xxx-does-not-support-market-orders-message-and-cannot-run-my-strategy">I'm getting the "Exchange XXX does not support market orders." message and cannot run my strategy<a class="headerlink" href="#im-getting-the-exchange-xxx-does-not-support-market-orders-message-and-cannot-run-my-strategy" title="Permanent link">&para;</a></h3>
<p>As the message says, your exchange does not support market orders and you have one of the <a href="../configuration/#understand-order_types">order types</a> set to "market". Your strategy was probably written with other exchanges in mind and sets "market" orders for "stoploss" orders, which is correct and preferable for most of the exchanges supporting market orders (but not for Gate.io).</p>
<p>As the message says, your exchange does not support market orders and you have one of the <a href="configuration.html#understand-order_types">order types</a> set to "market". Your strategy was probably written with other exchanges in mind and sets "market" orders for "stoploss" orders, which is correct and preferable for most of the exchanges supporting market orders (but not for Gate.io).</p>
<p>To fix this, redefine order types in the strategy to use "limit" instead of "market":</p>
<div class="highlight"><pre><span></span><code> <span class="n">order_types</span> <span class="o">=</span> <span class="p">{</span>
<span class="o">...</span>
@@ -2524,7 +2524,7 @@ Should you be asked to expose your exchange keys or send funds to some random wa
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../sql_cheatsheet/" class="md-footer__link md-footer__link--prev" aria-label="Previous: SQL Cheat-sheet">
<a href="sql_cheatsheet.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: SQL Cheat-sheet">
<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 11z"/></svg>
@@ -2541,7 +2541,7 @@ Should you be asked to expose your exchange keys or send funds to some random wa
<a href="../strategy_migration/" class="md-footer__link md-footer__link--next" aria-label="Next: Strategy migration">
<a href="strategy_migration.html" class="md-footer__link md-footer__link--next" aria-label="Next: Strategy migration">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2589,12 +2589,12 @@ Should you be asked to expose your exchange keys or send funds to some random wa
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

154
en/develop/freq-ui/index.html → en/develop/freq-ui.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/freq-ui/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/freq-ui.html">
<link rel="prev" href="../telegram-usage/">
<link rel="prev" href="telegram-usage.html">
<link rel="next" href="../rest-api/">
<link rel="next" href="rest-api.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -630,7 +630,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -675,7 +675,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="freq-ui.html" class="md-nav__link md-nav__link--active">
@@ -796,7 +796,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -819,7 +819,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -849,7 +849,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -871,7 +871,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -893,7 +893,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -953,7 +953,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -976,7 +976,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -999,7 +999,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -1022,7 +1022,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -1045,7 +1045,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -1068,7 +1068,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -1091,7 +1091,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1121,7 +1121,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1143,7 +1143,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1165,7 +1165,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1187,7 +1187,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1247,7 +1247,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1270,7 +1270,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1293,7 +1293,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1361,7 +1361,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1384,7 +1384,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1407,7 +1407,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1430,7 +1430,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1453,7 +1453,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1476,7 +1476,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1499,7 +1499,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1522,7 +1522,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1545,7 +1545,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1575,7 +1575,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1597,7 +1597,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1619,7 +1619,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1641,7 +1641,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1663,7 +1663,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -1824,7 +1824,7 @@ This same command can also be used to update freqUI to new new releases.</p>
It is a frontend that can be used to monitor the bot and to interact with it - but freqtrade itself will work perfectly fine without it.</p>
</div>
<h2 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">&para;</a></h2>
<p>FreqUI does not have it's own configuration file - but assumes a working setup for the <a href="../rest-api/">rest-api</a> is available.
<p>FreqUI does not have it's own configuration file - but assumes a working setup for the <a href="rest-api.html">rest-api</a> is available.
Please refer to the corresponding documentation page to get setup with freqUI</p>
<h2 id="ui">UI<a class="headerlink" href="#ui" title="Permanent link">&para;</a></h2>
<p>FreqUI is a modern, responsive web application that can be used to monitor and interact with your bot.</p>
@@ -1833,8 +1833,8 @@ Themes can be easily switched via a prominent button at the top of the page.
The theme of the screenshots on this page will adapt to the selected documentation Theme, so to see the dark (or light) version, please switch the theme of the Documentation.</p>
<h3 id="login">Login<a class="headerlink" href="#login" title="Permanent link">&para;</a></h3>
<p>The below screenshot shows the login screen of freqUI.</p>
<p><img alt="FreqUI - login" src="../assets/frequi-login-CORS.png#only-dark" />
<img alt="FreqUI - login" src="../assets/frequi-login-CORS-light.png#only-light" /></p>
<p><img alt="FreqUI - login" src="assets/frequi-login-CORS.png#only-dark" />
<img alt="FreqUI - login" src="assets/frequi-login-CORS-light.png#only-light" /></p>
<div class="admonition hint">
<p class="admonition-title">CORS</p>
<p>The Cors error shown in this screenshot is due to the fact that the UI is running on a different port than the API, and <a href="#cors">CORS</a> has not been setup correctly yet.</p>
@@ -1842,14 +1842,14 @@ The theme of the screenshots on this page will adapt to the selected documentati
<h3 id="trade-view">Trade view<a class="headerlink" href="#trade-view" title="Permanent link">&para;</a></h3>
<p>The trade view allows you to visualize the trades that the bot is making and to interact with the bot.
On this page, you can also interact with the bot by starting and stopping it and - if configured - force trade entries and exits.</p>
<p><img alt="FreqUI - trade view" src="../assets/freqUI-trade-pane-dark.png#only-dark" />
<img alt="FreqUI - trade view" src="../assets/freqUI-trade-pane-light.png#only-light" /></p>
<p><img alt="FreqUI - trade view" src="assets/freqUI-trade-pane-dark.png#only-dark" />
<img alt="FreqUI - trade view" src="assets/freqUI-trade-pane-light.png#only-light" /></p>
<h3 id="plot-configurator">Plot Configurator<a class="headerlink" href="#plot-configurator" title="Permanent link">&para;</a></h3>
<p>FreqUI Plots can be configured either via a <code>plot_config</code> configuration object in the strategy (which can be loaded via "from strategy" button) or via the UI.
Multiple plot configurations can be created and switched at will - allowing for flexible, different views into your charts.</p>
<p>The plot configuration can be accessed via the "Plot Configurator" (Cog icon) button in the top right corner of the trade view.</p>
<p><img alt="FreqUI - plot configuration" src="../assets/freqUI-plot-configurator-dark.png#only-dark" />
<img alt="FreqUI - plot configuration" src="../assets/freqUI-plot-configurator-light.png#only-light" /></p>
<p><img alt="FreqUI - plot configuration" src="assets/freqUI-plot-configurator-dark.png#only-dark" />
<img alt="FreqUI - plot configuration" src="assets/freqUI-plot-configurator-light.png#only-light" /></p>
<h3 id="settings">Settings<a class="headerlink" href="#settings" title="Permanent link">&para;</a></h3>
<p>Several UI related settings can be changed by accessing the settings page.</p>
<p>Things you can change (among others):</p>
@@ -1859,14 +1859,14 @@ Multiple plot configurations can be created and switched at will - allowing for
<li>Candle colors (up/down -&gt; red/green)</li>
<li>Enable / disable in-app notification types</li>
</ul>
<p><img alt="FreqUI - Settings view" src="../assets/frequi-settings-dark.png#only-dark" />
<img alt="FreqUI - Settings view" src="../assets/frequi-settings-light.png#only-light" /></p>
<p><img alt="FreqUI - Settings view" src="assets/frequi-settings-dark.png#only-dark" />
<img alt="FreqUI - Settings view" src="assets/frequi-settings-light.png#only-light" /></p>
<h2 id="backtesting">Backtesting<a class="headerlink" href="#backtesting" title="Permanent link">&para;</a></h2>
<p>When freqtrade is started in <a href="../utils/#webserver-mode">webserver mode</a> (freqtrade started with <code>freqtrade webserver</code>), the backtesting view becomes available.
<p>When freqtrade is started in <a href="utils.html#webserver-mode">webserver mode</a> (freqtrade started with <code>freqtrade webserver</code>), the backtesting view becomes available.
This view allows you to backtest strategies and visualize the results.</p>
<p>You can also load and visualize previous backtest results, as well as compare the results with each other.</p>
<p><img alt="FreqUI - Backtesting" src="../assets/freqUI-backtesting-dark.png#only-dark" />
<img alt="FreqUI - Backtesting" src="../assets/freqUI-backtesting-light.png#only-light" /></p>
<p><img alt="FreqUI - Backtesting" src="assets/freqUI-backtesting-dark.png#only-dark" />
<img alt="FreqUI - Backtesting" src="assets/freqUI-backtesting-light.png#only-light" /></p>
<h2 id="cors">CORS<a class="headerlink" href="#cors" title="Permanent link">&para;</a></h2>
<p>This whole section is only necessary in cross-origin cases (where you multiple bot API's running on <code>localhost:8081</code>, <code>localhost:8082</code>, ...), and want to combine them into one FreqUI instance.</p>
<details class="info">
@@ -1886,7 +1886,7 @@ It consists of a list of allowed URL's that are allowed to consume resources fro
}
</code></pre></div>
<p>In the following (pretty common) case, FreqUI is accessible on <code>http://localhost:8080/trade</code> (this is what you see in your navbar when navigating to freqUI).
<img alt="freqUI url" src="../assets/frequi_url.png" /></p>
<img alt="freqUI url" src="assets/frequi_url.png" /></p>
<p>The correct configuration for this case is <code>http://localhost:8080</code> - the main part of the URL including the port.</p>
<div class="highlight"><pre><span></span><code>{
//...
@@ -1942,7 +1942,7 @@ Such a configuration will not take effect, and the cors errors will remain.</p>
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../telegram-usage/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Telegram">
<a href="telegram-usage.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Telegram">
<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 11z"/></svg>
@@ -1959,7 +1959,7 @@ Such a configuration will not take effect, and the cors errors will remain.</p>
<a href="../rest-api/" class="md-footer__link md-footer__link--next" aria-label="Next: REST API">
<a href="rest-api.html" class="md-footer__link md-footer__link--next" aria-label="Next: REST API">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2007,12 +2007,12 @@ Such a configuration will not take effect, and the cors errors will remain.</p>
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

150
en/develop/freqai-configuration/index.html → en/develop/freqai-configuration.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/freqai-configuration/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/freqai-configuration.html">
<link rel="prev" href="../freqai/">
<link rel="prev" href="freqai.html">
<link rel="next" href="../freqai-parameter-table/">
<link rel="next" href="freqai-parameter-table.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -833,7 +833,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -878,7 +878,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="freqai-configuration.html" class="md-nav__link md-nav__link--active">
@@ -1098,7 +1098,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -1121,7 +1121,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -1144,7 +1144,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -1167,7 +1167,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -1190,7 +1190,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1220,7 +1220,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1242,7 +1242,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1264,7 +1264,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1286,7 +1286,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1346,7 +1346,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1369,7 +1369,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1392,7 +1392,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1460,7 +1460,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1483,7 +1483,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1506,7 +1506,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1529,7 +1529,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1552,7 +1552,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1575,7 +1575,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1598,7 +1598,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1621,7 +1621,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1644,7 +1644,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1674,7 +1674,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1696,7 +1696,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1718,7 +1718,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1740,7 +1740,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1762,7 +1762,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -2007,9 +2007,9 @@
<h1 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">&para;</a></h1>
<p>FreqAI is configured through the typical <a href="../configuration/">Freqtrade config file</a> and the standard <a href="../strategy-customization/">Freqtrade strategy</a>. Examples of FreqAI config and strategy files can be found in <code>config_examples/config_freqai.example.json</code> and <code>freqtrade/templates/FreqaiExampleStrategy.py</code>, respectively.</p>
<p>FreqAI is configured through the typical <a href="configuration.html">Freqtrade config file</a> and the standard <a href="strategy-customization.html">Freqtrade strategy</a>. Examples of FreqAI config and strategy files can be found in <code>config_examples/config_freqai.example.json</code> and <code>freqtrade/templates/FreqaiExampleStrategy.py</code>, respectively.</p>
<h2 id="setting-up-the-configuration-file">Setting up the configuration file<a class="headerlink" href="#setting-up-the-configuration-file" title="Permanent link">&para;</a></h2>
<p>Although there are plenty of additional parameters to choose from, as highlighted in the <a href="../freqai-parameter-table/#parameter-table">parameter table</a>, a FreqAI config must at minimum include the following parameters (the parameter values are only examples):</p>
<p>Although there are plenty of additional parameters to choose from, as highlighted in the <a href="freqai-parameter-table.html#parameter-table">parameter table</a>, a FreqAI config must at minimum include the following parameters (the parameter values are only examples):</p>
<div class="highlight"><pre><span></span><code><span class="w"> </span><span class="nt">&quot;freqai&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;enabled&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;purge_old_models&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span>
@@ -2035,10 +2035,10 @@
<p>A full example config is available in <code>config_examples/config_freqai.example.json</code>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The <code>identifier</code> is commonly overlooked by newcomers, however, this value plays an important role in your configuration. This value is a unique ID that you choose to describe one of your runs. Keeping it the same allows you to maintain crash resilience as well as faster backtesting. As soon as you want to try a new run (new features, new model, etc.), you should change this value (or delete the <code>user_data/models/unique-id</code> folder. More details available in the <a href="../freqai-parameter-table/#feature-parameters">parameter table</a>.</p>
<p>The <code>identifier</code> is commonly overlooked by newcomers, however, this value plays an important role in your configuration. This value is a unique ID that you choose to describe one of your runs. Keeping it the same allows you to maintain crash resilience as well as faster backtesting. As soon as you want to try a new run (new features, new model, etc.), you should change this value (or delete the <code>user_data/models/unique-id</code> folder. More details available in the <a href="freqai-parameter-table.html#feature-parameters">parameter table</a>.</p>
</div>
<h2 id="building-a-freqai-strategy">Building a FreqAI strategy<a class="headerlink" href="#building-a-freqai-strategy" title="Permanent link">&para;</a></h2>
<p>The FreqAI strategy requires including the following lines of code in the standard <a href="../strategy-customization/">Freqtrade strategy</a>:</p>
<p>The FreqAI strategy requires including the following lines of code in the standard <a href="strategy-customization.html">Freqtrade strategy</a>:</p>
<div class="highlight"><pre><span></span><code> <span class="c1"># user should define the maximum startup candle count (the largest number of candles</span>
<span class="c1"># passed to any single indicator)</span>
<span class="n">startup_candle_count</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">20</span>
@@ -2143,7 +2143,7 @@
<span class="p">)</span>
<span class="k">return</span> <span class="n">dataframe</span>
</code></pre></div>
<p>Notice how the <code>feature_engineering_*()</code> is where <a href="../freqai-feature-engineering/#feature-engineering">features</a> are added. Meanwhile <code>set_freqai_targets()</code> adds the labels/targets. A full example strategy is available in <code>templates/FreqaiExampleStrategy.py</code>.</p>
<p>Notice how the <code>feature_engineering_*()</code> is where <a href="freqai-feature-engineering.html#feature-engineering">features</a> are added. Meanwhile <code>set_freqai_targets()</code> adds the labels/targets. A full example strategy is available in <code>templates/FreqaiExampleStrategy.py</code>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The <code>self.freqai.start()</code> function cannot be called outside the <code>populate_indicators()</code>.</p>
@@ -2174,15 +2174,15 @@ will cause the algorithm to fail in live/dry mode. In order to add generalized f
</tr>
<tr>
<td><code>df['do_predict']</code></td>
<td>Indication of an outlier data point. The return value is integer between -2 and 2, which lets you know if the prediction is trustworthy or not. <code>do_predict==1</code> means that the prediction is trustworthy. If the Dissimilarity Index (DI, see details <a href="../freqai-feature-engineering/#identifying-outliers-with-the-dissimilarity-index-di">here</a>) of the input data point is above the threshold defined in the config, FreqAI will subtract 1 from <code>do_predict</code>, resulting in <code>do_predict==0</code>. If <code>use_SVM_to_remove_outliers</code> is active, the Support Vector Machine (SVM, see details <a href="../freqai-feature-engineering/#identifying-outliers-using-a-support-vector-machine-svm">here</a>) may also detect outliers in training and prediction data. In this case, the SVM will also subtract 1 from <code>do_predict</code>. If the input data point was considered an outlier by the SVM but not by the DI, or vice versa, the result will be <code>do_predict==0</code>. If both the DI and the SVM considers the input data point to be an outlier, the result will be <code>do_predict==-1</code>. As with the SVM, if <code>use_DBSCAN_to_remove_outliers</code> is active, DBSCAN (see details <a href="../freqai-feature-engineering/#identifying-outliers-with-dbscan">here</a>) may also detect outliers and subtract 1 from <code>do_predict</code>. Hence, if both the SVM and DBSCAN are active and identify a datapoint that was above the DI threshold as an outlier, the result will be <code>do_predict==-2</code>. A particular case is when <code>do_predict == 2</code>, which means that the model has expired due to exceeding <code>expired_hours</code>. <br> <strong>Datatype:</strong> Integer between -2 and 2.</td>
<td>Indication of an outlier data point. The return value is integer between -2 and 2, which lets you know if the prediction is trustworthy or not. <code>do_predict==1</code> means that the prediction is trustworthy. If the Dissimilarity Index (DI, see details <a href="freqai-feature-engineering.html#identifying-outliers-with-the-dissimilarity-index-di">here</a>) of the input data point is above the threshold defined in the config, FreqAI will subtract 1 from <code>do_predict</code>, resulting in <code>do_predict==0</code>. If <code>use_SVM_to_remove_outliers</code> is active, the Support Vector Machine (SVM, see details <a href="freqai-feature-engineering.html#identifying-outliers-using-a-support-vector-machine-svm">here</a>) may also detect outliers in training and prediction data. In this case, the SVM will also subtract 1 from <code>do_predict</code>. If the input data point was considered an outlier by the SVM but not by the DI, or vice versa, the result will be <code>do_predict==0</code>. If both the DI and the SVM considers the input data point to be an outlier, the result will be <code>do_predict==-1</code>. As with the SVM, if <code>use_DBSCAN_to_remove_outliers</code> is active, DBSCAN (see details <a href="freqai-feature-engineering.html#identifying-outliers-with-dbscan">here</a>) may also detect outliers and subtract 1 from <code>do_predict</code>. Hence, if both the SVM and DBSCAN are active and identify a datapoint that was above the DI threshold as an outlier, the result will be <code>do_predict==-2</code>. A particular case is when <code>do_predict == 2</code>, which means that the model has expired due to exceeding <code>expired_hours</code>. <br> <strong>Datatype:</strong> Integer between -2 and 2.</td>
</tr>
<tr>
<td><code>df['DI_values']</code></td>
<td>Dissimilarity Index (DI) values are proxies for the level of confidence FreqAI has in the prediction. A lower DI means the prediction is close to the training data, i.e., higher prediction confidence. See details about the DI <a href="../freqai-feature-engineering/#identifying-outliers-with-the-dissimilarity-index-di">here</a>. <br> <strong>Datatype:</strong> Float.</td>
<td>Dissimilarity Index (DI) values are proxies for the level of confidence FreqAI has in the prediction. A lower DI means the prediction is close to the training data, i.e., higher prediction confidence. See details about the DI <a href="freqai-feature-engineering.html#identifying-outliers-with-the-dissimilarity-index-di">here</a>. <br> <strong>Datatype:</strong> Float.</td>
</tr>
<tr>
<td><code>df['%*']</code></td>
<td>Any dataframe column prepended with <code>%</code> in <code>feature_engineering_*()</code> is treated as a training feature. For example, you can include the RSI in the training feature set (similar to in <code>templates/FreqaiExampleStrategy.py</code>) by setting <code>df['%-rsi']</code>. See more details on how this is done <a href="../freqai-feature-engineering/">here</a>. <br> <strong>Note:</strong> Since the number of features prepended with <code>%</code> can multiply very quickly (10s of thousands of features are easily engineered using the multiplictative functionality of, e.g., <code>include_shifted_candles</code> and <code>include_timeframes</code> as described in the <a href="../freqai-parameter-table/">parameter table</a>), these features are removed from the dataframe that is returned from FreqAI to the strategy. To keep a particular type of feature for plotting purposes, you would prepend it with <code>%%</code> (see details below). <br> <strong>Datatype:</strong> Depends on the feature created by the user.</td>
<td>Any dataframe column prepended with <code>%</code> in <code>feature_engineering_*()</code> is treated as a training feature. For example, you can include the RSI in the training feature set (similar to in <code>templates/FreqaiExampleStrategy.py</code>) by setting <code>df['%-rsi']</code>. See more details on how this is done <a href="freqai-feature-engineering.html">here</a>. <br> <strong>Note:</strong> Since the number of features prepended with <code>%</code> can multiply very quickly (10s of thousands of features are easily engineered using the multiplictative functionality of, e.g., <code>include_shifted_candles</code> and <code>include_timeframes</code> as described in the <a href="freqai-parameter-table.html">parameter table</a>), these features are removed from the dataframe that is returned from FreqAI to the strategy. To keep a particular type of feature for plotting purposes, you would prepend it with <code>%%</code> (see details below). <br> <strong>Datatype:</strong> Depends on the feature created by the user.</td>
</tr>
<tr>
<td><code>df['%%*']</code></td>
@@ -2191,7 +2191,7 @@ will cause the algorithm to fail in live/dry mode. In order to add generalized f
</tbody>
</table>
<h2 id="setting-the-startup_candle_count">Setting the <code>startup_candle_count</code><a class="headerlink" href="#setting-the-startup_candle_count" title="Permanent link">&para;</a></h2>
<p>The <code>startup_candle_count</code> in the FreqAI strategy needs to be set up in the same way as in the standard Freqtrade strategy (see details <a href="../strategy-customization/#strategy-startup-period">here</a>). This value is used by Freqtrade to ensure that a sufficient amount of data is provided when calling the <code>dataprovider</code>, to avoid any NaNs at the beginning of the first training. You can easily set this value by identifying the longest period (in candle units) which is passed to the indicator creation functions (e.g., TA-Lib functions). In the presented example, <code>startup_candle_count</code> is 20 since this is the maximum value in <code>indicators_periods_candles</code>.</p>
<p>The <code>startup_candle_count</code> in the FreqAI strategy needs to be set up in the same way as in the standard Freqtrade strategy (see details <a href="strategy-customization.html#strategy-startup-period">here</a>). This value is used by Freqtrade to ensure that a sufficient amount of data is provided when calling the <code>dataprovider</code>, to avoid any NaNs at the beginning of the first training. You can easily set this value by identifying the longest period (in candle units) which is passed to the indicator creation functions (e.g., TA-Lib functions). In the presented example, <code>startup_candle_count</code> is 20 since this is the maximum value in <code>indicators_periods_candles</code>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>There are instances where the TA-Lib functions actually require more data than just the passed <code>period</code> or else the feature dataset gets populated with NaNs. Anecdotally, multiplying the <code>startup_candle_count</code> by 2 always leads to a fully NaN free training dataset. Hence, it is typically safest to multiply the expected <code>startup_candle_count</code> by 2. Look out for this log message to confirm that the data is clean:</p>
@@ -2199,7 +2199,7 @@ will cause the algorithm to fail in live/dry mode. In order to add generalized f
</code></pre></div>
</div>
<h2 id="creating-a-dynamic-target-threshold">Creating a dynamic target threshold<a class="headerlink" href="#creating-a-dynamic-target-threshold" title="Permanent link">&para;</a></h2>
<p>Deciding when to enter or exit a trade can be done in a dynamic way to reflect current market conditions. FreqAI allows you to return additional information from the training of a model (more info <a href="../freqai-feature-engineering/#returning-additional-info-from-training">here</a>). For example, the <code>&amp;*_std/mean</code> return values describe the statistical distribution of the target/label <em>during the most recent training</em>. Comparing a given prediction to these values allows you to know the rarity of the prediction. In <code>templates/FreqaiExampleStrategy.py</code>, the <code>target_roi</code> and <code>sell_roi</code> are defined to be 1.25 z-scores away from the mean which causes predictions that are closer to the mean to be filtered out.</p>
<p>Deciding when to enter or exit a trade can be done in a dynamic way to reflect current market conditions. FreqAI allows you to return additional information from the training of a model (more info <a href="freqai-feature-engineering.html#returning-additional-info-from-training">here</a>). For example, the <code>&amp;*_std/mean</code> return values describe the statistical distribution of the target/label <em>during the most recent training</em>. Comparing a given prediction to these values allows you to know the rarity of the prediction. In <code>templates/FreqaiExampleStrategy.py</code>, the <code>target_roi</code> and <code>sell_roi</code> are defined to be 1.25 z-scores away from the mean which causes predictions that are closer to the mean to be filtered out.</p>
<div class="highlight"><pre><span></span><code><span class="n">dataframe</span><span class="p">[</span><span class="s2">&quot;target_roi&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">dataframe</span><span class="p">[</span><span class="s2">&quot;&amp;-s_close_mean&quot;</span><span class="p">]</span> <span class="o">+</span> <span class="n">dataframe</span><span class="p">[</span><span class="s2">&quot;&amp;-s_close_std&quot;</span><span class="p">]</span> <span class="o">*</span> <span class="mf">1.25</span>
<span class="n">dataframe</span><span class="p">[</span><span class="s2">&quot;sell_roi&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">dataframe</span><span class="p">[</span><span class="s2">&quot;&amp;-s_close_mean&quot;</span><span class="p">]</span> <span class="o">-</span> <span class="n">dataframe</span><span class="p">[</span><span class="s2">&quot;&amp;-s_close_std&quot;</span><span class="p">]</span> <span class="o">*</span> <span class="mf">1.25</span>
</code></pre></div>
@@ -2326,7 +2326,7 @@ From top to bottom:</p>
<li><code>BasePyTorch*</code> - Implements the <code>predict</code> method. Here, the <code>*</code> represents a group of algorithms, such as classifiers or regressors. responsible for data preprocessing, predicting, and postprocessing if needed.</li>
<li><code>PyTorch*Classifier</code> / <code>PyTorch*Regressor</code> - implements the <code>fit</code> method. responsible for the main train flaw, where we initialize the trainer and model objects.</li>
</ol>
<p><img alt="image" src="../assets/freqai_pytorch-diagram.png" /></p>
<p><img alt="image" src="assets/freqai_pytorch-diagram.png" /></p>
<h4 id="full-example">Full example<a class="headerlink" href="#full-example" title="Permanent link">&para;</a></h4>
<p>Building a PyTorch regressor using MLP (multilayer perceptron) model, MSELoss criterion, and AdamW optimizer.</p>
<div class="highlight"><pre><span></span><code><span class="k">class</span><span class="w"> </span><span class="nc">PyTorchMLPRegressor</span><span class="p">(</span><span class="n">BasePyTorchRegressor</span><span class="p">):</span>
@@ -2423,7 +2423,7 @@ To see a full example, you can refer to the <a href="https://github.com/freqtrad
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../freqai/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Introduction">
<a href="freqai.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Introduction">
<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 11z"/></svg>
@@ -2440,7 +2440,7 @@ To see a full example, you can refer to the <a href="https://github.com/freqtrad
<a href="../freqai-parameter-table/" class="md-footer__link md-footer__link--next" aria-label="Next: Parameter table">
<a href="freqai-parameter-table.html" class="md-footer__link md-footer__link--next" aria-label="Next: Parameter table">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2488,12 +2488,12 @@ To see a full example, you can refer to the <a href="https://github.com/freqtrad
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

140
en/develop/freqai-developers/index.html → en/develop/freqai-developers.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/freqai-developers/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/freqai-developers.html">
<link rel="prev" href="../freqai-reinforcement-learning/">
<link rel="prev" href="freqai-reinforcement-learning.html">
<link rel="next" href="../leverage/">
<link rel="next" href="leverage.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -833,7 +833,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -856,7 +856,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -879,7 +879,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -902,7 +902,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -925,7 +925,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -948,7 +948,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -993,7 +993,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="freqai-developers.html" class="md-nav__link md-nav__link--active">
@@ -1076,7 +1076,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1098,7 +1098,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1120,7 +1120,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1142,7 +1142,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1202,7 +1202,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1225,7 +1225,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1248,7 +1248,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1316,7 +1316,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1339,7 +1339,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1362,7 +1362,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1385,7 +1385,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1408,7 +1408,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1431,7 +1431,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1454,7 +1454,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1477,7 +1477,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1500,7 +1500,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1530,7 +1530,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1552,7 +1552,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1574,7 +1574,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1596,7 +1596,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1618,7 +1618,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -1722,18 +1722,18 @@
<h2 id="project-architecture">Project architecture<a class="headerlink" href="#project-architecture" title="Permanent link">&para;</a></h2>
<p>The architecture and functions of FreqAI are generalized to encourages development of unique features, functions, models, etc.</p>
<p>The class structure and a detailed algorithmic overview is depicted in the following diagram:</p>
<p><img alt="image" src="../assets/freqai_algorithm-diagram.jpg" /></p>
<p><img alt="image" src="assets/freqai_algorithm-diagram.jpg" /></p>
<p>As shown, there are three distinct objects comprising FreqAI:</p>
<ul>
<li><strong>IFreqaiModel</strong> - A singular persistent object containing all the necessary logic to collect, store, and process data, engineer features, run training, and inference models.</li>
<li><strong>FreqaiDataKitchen</strong> - A non-persistent object which is created uniquely for each unique asset/model. Beyond metadata, it also contains a variety of data processing tools.</li>
<li><strong>FreqaiDataDrawer</strong> - A singular persistent object containing all the historical predictions, models, and save/load methods.</li>
</ul>
<p>There are a variety of built-in <a href="../freqai-configuration/#using-different-prediction-models">prediction models</a> which inherit directly from <code>IFreqaiModel</code>. Each of these models have full access to all methods in <code>IFreqaiModel</code> and can therefore override any of those functions at will. However, advanced users will likely stick to overriding <code>fit()</code>, <code>train()</code>, <code>predict()</code>, and <code>data_cleaning_train/predict()</code>.</p>
<p>There are a variety of built-in <a href="freqai-configuration.html#using-different-prediction-models">prediction models</a> which inherit directly from <code>IFreqaiModel</code>. Each of these models have full access to all methods in <code>IFreqaiModel</code> and can therefore override any of those functions at will. However, advanced users will likely stick to overriding <code>fit()</code>, <code>train()</code>, <code>predict()</code>, and <code>data_cleaning_train/predict()</code>.</p>
<h2 id="data-handling">Data handling<a class="headerlink" href="#data-handling" title="Permanent link">&para;</a></h2>
<p>FreqAI aims to organize model files, prediction data, and meta data in a way that simplifies post-processing and enhances crash resilience by automatic data reloading. The data is saved in a file structure,<code>user_data_dir/models/</code>, which contains all the data associated with the trainings and backtests. The <code>FreqaiDataKitchen()</code> relies heavily on the file structure for proper training and inferencing and should therefore not be manually modified.</p>
<h3 id="file-structure">File structure<a class="headerlink" href="#file-structure" title="Permanent link">&para;</a></h3>
<p>The file structure is automatically generated based on the model <code>identifier</code> set in the <a href="../freqai-configuration/#setting-up-the-configuration-file">config</a>. The following structure shows where the data is stored for post processing:</p>
<p>The file structure is automatically generated based on the model <code>identifier</code> set in the <a href="freqai-configuration.html#setting-up-the-configuration-file">config</a>. The following structure shows where the data is stored for post processing:</p>
<table>
<thead>
<tr>
@@ -1768,15 +1768,15 @@
</tr>
<tr>
<td></td>
<td><code>*_pca_object.pkl</code> - The <a href="../freqai-feature-engineering/#data-dimensionality-reduction-with-principal-component-analysis">Principal component analysis (PCA)</a> transform (if <code>principal_component_analysis: True</code> is set in the config) which will be used to transform unseen prediction features. <br></td>
<td><code>*_pca_object.pkl</code> - The <a href="freqai-feature-engineering.html#data-dimensionality-reduction-with-principal-component-analysis">Principal component analysis (PCA)</a> transform (if <code>principal_component_analysis: True</code> is set in the config) which will be used to transform unseen prediction features. <br></td>
</tr>
<tr>
<td></td>
<td><code>*_svm_model.pkl</code> - The <a href="../freqai-feature-engineering/#identifying-outliers-using-a-support-vector-machine-svm">Support Vector Machine (SVM)</a> model (if <code>use_SVM_to_remove_outliers: True</code> is set in the config) which is used to detect outliers in unseen prediction features. <br></td>
<td><code>*_svm_model.pkl</code> - The <a href="freqai-feature-engineering.html#identifying-outliers-using-a-support-vector-machine-svm">Support Vector Machine (SVM)</a> model (if <code>use_SVM_to_remove_outliers: True</code> is set in the config) which is used to detect outliers in unseen prediction features. <br></td>
</tr>
<tr>
<td></td>
<td><code>*_trained_df.pkl</code> - The dataframe containing all the training features used to train the <code>identifier</code> model. This is used for computing the <a href="../freqai-feature-engineering/#identifying-outliers-with-the-dissimilarity-index-di">Dissimilarity Index (DI)</a> and can also be used for post-processing. <br></td>
<td><code>*_trained_df.pkl</code> - The dataframe containing all the training features used to train the <code>identifier</code> model. This is used for computing the <a href="freqai-feature-engineering.html#identifying-outliers-with-the-dissimilarity-index-di">Dissimilarity Index (DI)</a> and can also be used for post-processing. <br></td>
</tr>
<tr>
<td></td>
@@ -1858,7 +1858,7 @@
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../freqai-reinforcement-learning/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Reinforcement Learning">
<a href="freqai-reinforcement-learning.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Reinforcement Learning">
<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 11z"/></svg>
@@ -1875,7 +1875,7 @@
<a href="../leverage/" class="md-footer__link md-footer__link--next" aria-label="Next: Short / Leverage">
<a href="leverage.html" class="md-footer__link md-footer__link--next" aria-label="Next: Short / Leverage">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -1923,12 +1923,12 @@
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

140
en/develop/freqai-feature-engineering/index.html → en/develop/freqai-feature-engineering.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/freqai-feature-engineering/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/freqai-feature-engineering.html">
<link rel="prev" href="../freqai-parameter-table/">
<link rel="prev" href="freqai-parameter-table.html">
<link rel="next" href="../freqai-running/">
<link rel="next" href="freqai-running.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -833,7 +833,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -856,7 +856,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -879,7 +879,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -924,7 +924,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="freqai-feature-engineering.html" class="md-nav__link md-nav__link--active">
@@ -1093,7 +1093,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -1116,7 +1116,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -1139,7 +1139,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1169,7 +1169,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1191,7 +1191,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1213,7 +1213,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1235,7 +1235,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1295,7 +1295,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1318,7 +1318,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1341,7 +1341,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1409,7 +1409,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1432,7 +1432,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1455,7 +1455,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1478,7 +1478,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1501,7 +1501,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1524,7 +1524,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1547,7 +1547,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1570,7 +1570,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1593,7 +1593,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1623,7 +1623,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1645,7 +1645,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1667,7 +1667,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1689,7 +1689,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1711,7 +1711,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -2104,7 +2104,7 @@ model for training/prediction and has therefore prepended it with <code>%</code>
<p>This will block <code>ta.ROC()</code> from being added to any timeframes other than <code>"1h"</code>.</p>
<h3 id="returning-additional-info-from-training">Returning additional info from training<a class="headerlink" href="#returning-additional-info-from-training" title="Permanent link">&para;</a></h3>
<p>Important metrics can be returned to the strategy at the end of each model training by assigning them to <code>dk.data['extra_returns_per_train']['my_new_value'] = XYZ</code> inside the custom prediction model class. </p>
<p>FreqAI takes the <code>my_new_value</code> assigned in this dictionary and expands it to fit the dataframe that is returned to the strategy. You can then use the returned metrics in your strategy through <code>dataframe['my_new_value']</code>. An example of how return values can be used in FreqAI are the <code>&amp;*_mean</code> and <code>&amp;*_std</code> values that are used to <a href="../freqai-configuration/#creating-a-dynamic-target-threshold">created a dynamic target threshold</a>.</p>
<p>FreqAI takes the <code>my_new_value</code> assigned in this dictionary and expands it to fit the dataframe that is returned to the strategy. You can then use the returned metrics in your strategy through <code>dataframe['my_new_value']</code>. An example of how return values can be used in FreqAI are the <code>&amp;*_mean</code> and <code>&amp;*_std</code> values that are used to <a href="freqai-configuration.html#creating-a-dynamic-target-threshold">created a dynamic target threshold</a>.</p>
<p>Another example, where the user wants to use live metrics from the trade database, is shown below:</p>
<div class="highlight"><pre><span></span><code><span class="w"> </span><span class="nt">&quot;freqai&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;extra_returns_per_train&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="nt">&quot;total_profit&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">4</span><span class="p">}</span>
@@ -2115,12 +2115,12 @@ model for training/prediction and has therefore prepended it with <code>%</code>
<p>FreqAI allows you to set a <code>weight_factor</code> to weight recent data more strongly than past data via an exponential function:</p>
<div class="arithmatex">\[ W_i = \exp(\frac{-i}{\alpha*n}) \]</div>
<p>where <span class="arithmatex">\(W_i\)</span> is the weight of data point <span class="arithmatex">\(i\)</span> in a total set of <span class="arithmatex">\(n\)</span> data points. Below is a figure showing the effect of different weight factors on the data points in a feature set.</p>
<p><img alt="weight-factor" src="../assets/freqai_weight-factor.jpg" /></p>
<p><img alt="weight-factor" src="assets/freqai_weight-factor.jpg" /></p>
<h2 id="building-the-data-pipeline">Building the data pipeline<a class="headerlink" href="#building-the-data-pipeline" title="Permanent link">&para;</a></h2>
<p>By default, FreqAI builds a dynamic pipeline based on user configuration settings. The default settings are robust and designed to work with a variety of methods. These two steps are a <code>MinMaxScaler(-1,1)</code> and a <code>VarianceThreshold</code> which removes any column that has 0 variance. Users can activate other steps with more configuration parameters. For example if users add <code>use_SVM_to_remove_outliers: true</code> to the <code>freqai</code> config, then FreqAI will automatically add the <a href="#identifying-outliers-using-a-support-vector-machine-svm"><code>SVMOutlierExtractor</code></a> to the pipeline. Likewise, users can add <code>principal_component_analysis: true</code> to the <code>freqai</code> config to activate PCA. The <a href="#identifying-outliers-with-the-dissimilarity-index-di">DissimilarityIndex</a> is activated with <code>DI_threshold: 1</code>. Finally, noise can also be added to the data with <code>noise_standard_deviation: 0.1</code>. Finally, users can add <a href="#identifying-outliers-with-dbscan">DBSCAN</a> outlier removal with <code>use_DBSCAN_to_remove_outliers: true</code>.</p>
<div class="admonition note">
<p class="admonition-title">More information available</p>
<p>Please review the <a href="../freqai-parameter-table/">parameter table</a> for more information on these parameters.</p>
<p>Please review the <a href="freqai-parameter-table.html">parameter table</a> for more information on these parameters.</p>
</div>
<h3 id="customizing-the-pipeline">Customizing the pipeline<a class="headerlink" href="#customizing-the-pipeline" title="Permanent link">&para;</a></h3>
<p>Users are encouraged to customize the data pipeline to their needs by building their own data pipeline. This can be done by simply setting <code>dk.feature_pipeline</code> to their desired <code>Pipeline</code> object inside their <code>IFreqaiModel</code> <code>train()</code> function, or if they prefer not to touch the <code>train()</code> function, they can override <code>define_data_pipeline</code>/<code>define_label_pipeline</code> functions in their <code>IFreqaiModel</code>:</p>
@@ -2194,7 +2194,7 @@ model for training/prediction and has therefore prepended it with <code>%</code>
</div>
<h3 id="migrating-a-custom-ifreqaimodel-to-the-new-pipeline">Migrating a custom <code>IFreqaiModel</code> to the new Pipeline<a class="headerlink" href="#migrating-a-custom-ifreqaimodel-to-the-new-pipeline" title="Permanent link">&para;</a></h3>
<p>If you have created your own custom <code>IFreqaiModel</code> with a custom <code>train()</code>/<code>predict()</code> function, <em>and</em> you still rely on <code>data_cleaning_train/predict()</code>, then you will need to migrate to the new pipeline. If your model does <em>not</em> rely on <code>data_cleaning_train/predict()</code>, then you do not need to worry about this migration.</p>
<p>More details about the migration can be found <a href="../strategy_migration/#freqai-new-data-pipeline">here</a>.</p>
<p>More details about the migration can be found <a href="strategy_migration.html#freqai-new-data-pipeline">here</a>.</p>
<h2 id="outlier-detection">Outlier detection<a class="headerlink" href="#outlier-detection" title="Permanent link">&para;</a></h2>
<p>Equity and crypto markets suffer from a high level of non-patterned noise in the form of outlier data points. FreqAI implements a variety of methods to identify such outliers and hence mitigate risk.</p>
<h3 id="identifying-outliers-with-the-dissimilarity-index-di">Identifying outliers with the Dissimilarity Index (DI)<a class="headerlink" href="#identifying-outliers-with-the-dissimilarity-index-di" title="Permanent link">&para;</a></h3>
@@ -2216,7 +2216,7 @@ model for training/prediction and has therefore prepended it with <code>%</code>
<div class="arithmatex">\[ DI_k = d_k/\overline{d} \]</div>
<p>You can tweak the DI through the <code>DI_threshold</code> to increase or decrease the extrapolation of the trained model. A higher <code>DI_threshold</code> means that the DI is more lenient and allows predictions further away from the training data to be used whilst a lower <code>DI_threshold</code> has the opposite effect and hence discards more predictions.</p>
<p>Below is a figure that describes the DI for a 3D data set.</p>
<p><img alt="DI" src="../assets/freqai_DI.jpg" /></p>
<p><img alt="DI" src="assets/freqai_DI.jpg" /></p>
<h3 id="identifying-outliers-using-a-support-vector-machine-svm">Identifying outliers using a Support Vector Machine (SVM)<a class="headerlink" href="#identifying-outliers-using-a-support-vector-machine-svm" title="Permanent link">&para;</a></h3>
<p>You can tell FreqAI to remove outlier data points from the training/test data sets using a Support Vector Machine (SVM) by including the following statement in the config:</p>
<div class="highlight"><pre><span></span><code><span class="w"> </span><span class="nt">&quot;freqai&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
@@ -2239,7 +2239,7 @@ model for training/prediction and has therefore prepended it with <code>%</code>
</code></pre></div>
<p>Which will add the <code>DataSieveDBSCAN</code> step to your <code>feature_pipeline</code>. This is an unsupervised machine learning algorithm that clusters data without needing to know how many clusters there should be.</p>
<p>Given a number of data points <span class="arithmatex">\(N\)</span>, and a distance <span class="arithmatex">\(\varepsilon\)</span>, DBSCAN clusters the data set by setting all data points that have <span class="arithmatex">\(N-1\)</span> other data points within a distance of <span class="arithmatex">\(\varepsilon\)</span> as <em>core points</em>. A data point that is within a distance of <span class="arithmatex">\(\varepsilon\)</span> from a <em>core point</em> but that does not have <span class="arithmatex">\(N-1\)</span> other data points within a distance of <span class="arithmatex">\(\varepsilon\)</span> from itself is considered an <em>edge point</em>. A cluster is then the collection of <em>core points</em> and <em>edge points</em>. Data points that have no other data points at a distance <span class="arithmatex">\(&lt;\varepsilon\)</span> are considered outliers. The figure below shows a cluster with <span class="arithmatex">\(N = 3\)</span>.</p>
<p><img alt="dbscan" src="../assets/freqai_dbscan.jpg" /></p>
<p><img alt="dbscan" src="assets/freqai_dbscan.jpg" /></p>
<p>FreqAI uses <code>sklearn.cluster.DBSCAN</code> (details are available on scikit-learn's webpage <a href="https://scikit-learn.org/stable/modules/generated/sklearn.cluster.DBSCAN.html">here</a> (external website)) with <code>min_samples</code> (<span class="arithmatex">\(N\)</span>) taken as &frac14; of the no. of time points (candles) in the feature set. <code>eps</code> (<span class="arithmatex">\(\varepsilon\)</span>) is computed automatically as the elbow point in the <em>k-distance graph</em> computed from the nearest neighbors in the pairwise distances of all data points in the feature set.</p>
<h3 id="data-dimensionality-reduction-with-principal-component-analysis">Data dimensionality reduction with Principal Component Analysis<a class="headerlink" href="#data-dimensionality-reduction-with-principal-component-analysis" title="Permanent link">&para;</a></h3>
<p>You can reduce the dimensionality of your features by activating the principal_component_analysis in the config:</p>
@@ -2288,7 +2288,7 @@ model for training/prediction and has therefore prepended it with <code>%</code>
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../freqai-parameter-table/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Parameter table">
<a href="freqai-parameter-table.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Parameter table">
<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 11z"/></svg>
@@ -2305,7 +2305,7 @@ model for training/prediction and has therefore prepended it with <code>%</code>
<a href="../freqai-running/" class="md-footer__link md-footer__link--next" aria-label="Next: Running FreqAI">
<a href="freqai-running.html" class="md-footer__link md-footer__link--next" aria-label="Next: Running FreqAI">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2353,12 +2353,12 @@ model for training/prediction and has therefore prepended it with <code>%</code>
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

154
en/develop/freqai-parameter-table/index.html → en/develop/freqai-parameter-table.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/freqai-parameter-table/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/freqai-parameter-table.html">
<link rel="prev" href="../freqai-configuration/">
<link rel="prev" href="freqai-configuration.html">
<link rel="next" href="../freqai-feature-engineering/">
<link rel="next" href="freqai-feature-engineering.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -833,7 +833,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -856,7 +856,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -901,7 +901,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="freqai-parameter-table.html" class="md-nav__link md-nav__link--active">
@@ -1031,7 +1031,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -1054,7 +1054,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -1077,7 +1077,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -1100,7 +1100,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1130,7 +1130,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1152,7 +1152,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1174,7 +1174,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1196,7 +1196,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1256,7 +1256,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1279,7 +1279,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1302,7 +1302,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1370,7 +1370,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1393,7 +1393,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1416,7 +1416,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1439,7 +1439,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1462,7 +1462,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1485,7 +1485,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1508,7 +1508,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1531,7 +1531,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1554,7 +1554,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1584,7 +1584,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1606,7 +1606,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1628,7 +1628,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1650,7 +1650,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1672,7 +1672,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -1852,7 +1852,7 @@
</tr>
<tr>
<td><code>backtest_period_days</code></td>
<td><strong>Required.</strong> <br> Number of days to inference from the trained model before sliding the <code>train_period_days</code> window defined above, and retraining the model during backtesting (more info <a href="../freqai-running/#backtesting">here</a>). This can be fractional days, but beware that the provided <code>timerange</code> will be divided by this number to yield the number of trainings necessary to complete the backtest. <br> <strong>Datatype:</strong> Float.</td>
<td><strong>Required.</strong> <br> Number of days to inference from the trained model before sliding the <code>train_period_days</code> window defined above, and retraining the model during backtesting (more info <a href="freqai-running.html#backtesting">here</a>). This can be fractional days, but beware that the provided <code>timerange</code> will be divided by this number to yield the number of trainings necessary to complete the backtest. <br> <strong>Datatype:</strong> Float.</td>
</tr>
<tr>
<td><code>identifier</code></td>
@@ -1876,11 +1876,11 @@
</tr>
<tr>
<td><code>fit_live_predictions_candles</code></td>
<td>Number of historical candles to use for computing target (label) statistics from prediction data, instead of from the training dataset (more information can be found <a href="../freqai-configuration/#creating-a-dynamic-target-threshold">here</a>). <br> <strong>Datatype:</strong> Positive integer.</td>
<td>Number of historical candles to use for computing target (label) statistics from prediction data, instead of from the training dataset (more information can be found <a href="freqai-configuration.html#creating-a-dynamic-target-threshold">here</a>). <br> <strong>Datatype:</strong> Positive integer.</td>
</tr>
<tr>
<td><code>continual_learning</code></td>
<td>Use the final state of the most recently trained model as starting point for the new model, allowing for incremental learning (more information can be found <a href="../freqai-running/#continual-learning">here</a>). Beware that this is currently a naive approach to incremental learning, and it has a high probability of overfitting/getting stuck in local minima while the market moves away from your model. We have the connections here primarily for experimental purposes and so that it is ready for more mature approaches to continual learning in chaotic systems like the crypto market. <br> <strong>Datatype:</strong> Boolean. <br> Default: <code>False</code>.</td>
<td>Use the final state of the most recently trained model as starting point for the new model, allowing for incremental learning (more information can be found <a href="freqai-running.html#continual-learning">here</a>). Beware that this is currently a naive approach to incremental learning, and it has a high probability of overfitting/getting stuck in local minima while the market moves away from your model. We have the connections here primarily for experimental purposes and so that it is ready for more mature approaches to continual learning in chaotic systems like the crypto market. <br> <strong>Datatype:</strong> Boolean. <br> Default: <code>False</code>.</td>
</tr>
<tr>
<td><code>write_metrics_to_disk</code></td>
@@ -1915,7 +1915,7 @@
</tr>
<tr>
<td><code>feature_parameters</code></td>
<td>A dictionary containing the parameters used to engineer the feature set. Details and examples are shown <a href="../freqai-feature-engineering/">here</a>. <br> <strong>Datatype:</strong> Dictionary.</td>
<td>A dictionary containing the parameters used to engineer the feature set. Details and examples are shown <a href="freqai-feature-engineering.html">here</a>. <br> <strong>Datatype:</strong> Dictionary.</td>
</tr>
<tr>
<td><code>include_timeframes</code></td>
@@ -1923,7 +1923,7 @@
</tr>
<tr>
<td><code>include_corr_pairlist</code></td>
<td>A list of correlated coins that FreqAI will add as additional features to all <code>pair_whitelist</code> coins. All indicators set in <code>feature_engineering_expand_*()</code> during feature engineering (see details <a href="../freqai-feature-engineering/">here</a>) will be created for each correlated coin. The correlated coins features are added to the base indicators dataset. <br> <strong>Datatype:</strong> List of assets (strings).</td>
<td>A list of correlated coins that FreqAI will add as additional features to all <code>pair_whitelist</code> coins. All indicators set in <code>feature_engineering_expand_*()</code> during feature engineering (see details <a href="freqai-feature-engineering.html">here</a>) will be created for each correlated coin. The correlated coins features are added to the base indicators dataset. <br> <strong>Datatype:</strong> List of assets (strings).</td>
</tr>
<tr>
<td><code>label_period_candles</code></td>
@@ -1935,11 +1935,11 @@
</tr>
<tr>
<td><code>weight_factor</code></td>
<td>Weight training data points according to their recency (see details <a href="../freqai-feature-engineering/#weighting-features-for-temporal-importance">here</a>). <br> <strong>Datatype:</strong> Positive float (typically &lt; 1).</td>
<td>Weight training data points according to their recency (see details <a href="freqai-feature-engineering.html#weighting-features-for-temporal-importance">here</a>). <br> <strong>Datatype:</strong> Positive float (typically &lt; 1).</td>
</tr>
<tr>
<td><code>indicator_max_period_candles</code></td>
<td><strong>No longer used (#7325)</strong>. Replaced by <code>startup_candle_count</code> which is set in the <a href="../freqai-configuration/#building-a-freqai-strategy">strategy</a>. <code>startup_candle_count</code> is timeframe independent and defines the maximum <em>period</em> used in <code>feature_engineering_*()</code> for indicator creation. FreqAI uses this parameter together with the maximum timeframe in <code>include_time_frames</code> to calculate how many data points to download such that the first data point does not include a NaN. <br> <strong>Datatype:</strong> Positive integer.</td>
<td><strong>No longer used (#7325)</strong>. Replaced by <code>startup_candle_count</code> which is set in the <a href="freqai-configuration.html#building-a-freqai-strategy">strategy</a>. <code>startup_candle_count</code> is timeframe independent and defines the maximum <em>period</em> used in <code>feature_engineering_*()</code> for indicator creation. FreqAI uses this parameter together with the maximum timeframe in <code>include_time_frames</code> to calculate how many data points to download such that the first data point does not include a NaN. <br> <strong>Datatype:</strong> Positive integer.</td>
</tr>
<tr>
<td><code>indicator_periods_candles</code></td>
@@ -1947,7 +1947,7 @@
</tr>
<tr>
<td><code>principal_component_analysis</code></td>
<td>Automatically reduce the dimensionality of the data set using Principal Component Analysis. See details about how it works <a href="../freqai-feature-engineering/#data-dimensionality-reduction-with-principal-component-analysis">here</a> <br> <strong>Datatype:</strong> Boolean. <br> Default: <code>False</code>.</td>
<td>Automatically reduce the dimensionality of the data set using Principal Component Analysis. See details about how it works <a href="freqai-feature-engineering.html#data-dimensionality-reduction-with-principal-component-analysis">here</a> <br> <strong>Datatype:</strong> Boolean. <br> Default: <code>False</code>.</td>
</tr>
<tr>
<td><code>plot_feature_importances</code></td>
@@ -1955,19 +1955,19 @@
</tr>
<tr>
<td><code>DI_threshold</code></td>
<td>Activates the use of the Dissimilarity Index for outlier detection when set to &gt; 0. See details about how it works <a href="../freqai-feature-engineering/#identifying-outliers-with-the-dissimilarity-index-di">here</a>. <br> <strong>Datatype:</strong> Positive float (typically &lt; 1).</td>
<td>Activates the use of the Dissimilarity Index for outlier detection when set to &gt; 0. See details about how it works <a href="freqai-feature-engineering.html#identifying-outliers-with-the-dissimilarity-index-di">here</a>. <br> <strong>Datatype:</strong> Positive float (typically &lt; 1).</td>
</tr>
<tr>
<td><code>use_SVM_to_remove_outliers</code></td>
<td>Train a support vector machine to detect and remove outliers from the training dataset, as well as from incoming data points. See details about how it works <a href="../freqai-feature-engineering/#identifying-outliers-using-a-support-vector-machine-svm">here</a>. <br> <strong>Datatype:</strong> Boolean.</td>
<td>Train a support vector machine to detect and remove outliers from the training dataset, as well as from incoming data points. See details about how it works <a href="freqai-feature-engineering.html#identifying-outliers-using-a-support-vector-machine-svm">here</a>. <br> <strong>Datatype:</strong> Boolean.</td>
</tr>
<tr>
<td><code>svm_params</code></td>
<td>All parameters available in Sklearn's <code>SGDOneClassSVM()</code>. See details about some select parameters <a href="../freqai-feature-engineering/#identifying-outliers-using-a-support-vector-machine-svm">here</a>. <br> <strong>Datatype:</strong> Dictionary.</td>
<td>All parameters available in Sklearn's <code>SGDOneClassSVM()</code>. See details about some select parameters <a href="freqai-feature-engineering.html#identifying-outliers-using-a-support-vector-machine-svm">here</a>. <br> <strong>Datatype:</strong> Dictionary.</td>
</tr>
<tr>
<td><code>use_DBSCAN_to_remove_outliers</code></td>
<td>Cluster data using the DBSCAN algorithm to identify and remove outliers from training and prediction data. See details about how it works <a href="../freqai-feature-engineering/#identifying-outliers-with-dbscan">here</a>. <br> <strong>Datatype:</strong> Boolean.</td>
<td>Cluster data using the DBSCAN algorithm to identify and remove outliers from training and prediction data. See details about how it works <a href="freqai-feature-engineering.html#identifying-outliers-with-dbscan">here</a>. <br> <strong>Datatype:</strong> Boolean.</td>
</tr>
<tr>
<td><code>noise_standard_deviation</code></td>
@@ -2033,7 +2033,7 @@
</tr>
<tr>
<td><code>model_training_parameters</code></td>
<td>A flexible dictionary that includes all parameters available by the selected model library. For example, if you use <code>LightGBMRegressor</code>, this dictionary can contain any parameter available by the <code>LightGBMRegressor</code> <a href="https://lightgbm.readthedocs.io/en/latest/pythonapi/lightgbm.LGBMRegressor.html">here</a> (external website). If you select a different model, this dictionary can contain any parameter from that model. A list of the currently available models can be found <a href="../freqai-configuration/#using-different-prediction-models">here</a>. <br> <strong>Datatype:</strong> Dictionary.</td>
<td>A flexible dictionary that includes all parameters available by the selected model library. For example, if you use <code>LightGBMRegressor</code>, this dictionary can contain any parameter available by the <code>LightGBMRegressor</code> <a href="https://lightgbm.readthedocs.io/en/latest/pythonapi/lightgbm.LGBMRegressor.html">here</a> (external website). If you select a different model, this dictionary can contain any parameter from that model. A list of the currently available models can be found <a href="freqai-configuration.html#using-different-prediction-models">here</a>. <br> <strong>Datatype:</strong> Dictionary.</td>
</tr>
<tr>
<td><code>n_estimators</code></td>
@@ -2236,7 +2236,7 @@
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../freqai-configuration/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Configuration">
<a href="freqai-configuration.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Configuration">
<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 11z"/></svg>
@@ -2253,7 +2253,7 @@
<a href="../freqai-feature-engineering/" class="md-footer__link md-footer__link--next" aria-label="Next: Feature engineering">
<a href="freqai-feature-engineering.html" class="md-footer__link md-footer__link--next" aria-label="Next: Feature engineering">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2301,12 +2301,12 @@
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

134
en/develop/freqai-reinforcement-learning/index.html → en/develop/freqai-reinforcement-learning.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/freqai-reinforcement-learning/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/freqai-reinforcement-learning.html">
<link rel="prev" href="../freqai-running/">
<link rel="prev" href="freqai-running.html">
<link rel="next" href="../freqai-developers/">
<link rel="next" href="freqai-developers.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -833,7 +833,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -856,7 +856,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -879,7 +879,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -902,7 +902,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -925,7 +925,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -970,7 +970,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="freqai-reinforcement-learning.html" class="md-nav__link md-nav__link--active">
@@ -1109,7 +1109,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1139,7 +1139,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1161,7 +1161,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1183,7 +1183,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1205,7 +1205,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1265,7 +1265,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1288,7 +1288,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1311,7 +1311,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1379,7 +1379,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1402,7 +1402,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1425,7 +1425,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1448,7 +1448,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1471,7 +1471,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1494,7 +1494,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1517,7 +1517,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1540,7 +1540,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1563,7 +1563,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1593,7 +1593,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1615,7 +1615,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1637,7 +1637,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1659,7 +1659,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1681,7 +1681,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -1865,7 +1865,7 @@ Users who prefer docker should ensure they use the docker image appended with <c
<p>Setting up and running a Reinforcement Learning model is the same as running a Regressor or Classifier. The same two flags, <code>--freqaimodel</code> and <code>--strategy</code>, must be defined on the command line:</p>
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>trade<span class="w"> </span>--freqaimodel<span class="w"> </span>ReinforcementLearner<span class="w"> </span>--strategy<span class="w"> </span>MyRLStrategy<span class="w"> </span>--config<span class="w"> </span>config.json
</code></pre></div>
<p>where <code>ReinforcementLearner</code> will use the templated <code>ReinforcementLearner</code> from <code>freqai/prediction_models/ReinforcementLearner</code> (or a custom user defined one located in <code>user_data/freqaimodels</code>). The strategy, on the other hand, follows the same base <a href="../freqai-feature-engineering/">feature engineering</a> with <code>feature_engineering_*</code> as a typical Regressor. The difference lies in the creation of the targets, Reinforcement Learning doesn't require them. However, FreqAI requires a default (neutral) value to be set in the action column:</p>
<p>where <code>ReinforcementLearner</code> will use the templated <code>ReinforcementLearner</code> from <code>freqai/prediction_models/ReinforcementLearner</code> (or a custom user defined one located in <code>user_data/freqaimodels</code>). The strategy, on the other hand, follows the same base <a href="freqai-feature-engineering.html">feature engineering</a> with <code>feature_engineering_*</code> as a typical Regressor. The difference lies in the creation of the targets, Reinforcement Learning doesn't require them. However, FreqAI requires a default (neutral) value to be set in the action column:</p>
<div class="highlight"><pre><span></span><code> <span class="k">def</span><span class="w"> </span><span class="nf">set_freqai_targets</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dataframe</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">DataFrame</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> *Only functional with FreqAI enabled strategies*</span>
@@ -1941,7 +1941,7 @@ Users who prefer docker should ensure they use the docker image appended with <c
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">}</span>
</code></pre></div>
<p>Parameter details can be found <a href="../freqai-parameter-table/">here</a>, but in general the <code>train_cycles</code> decides how many times the agent should cycle through the candle data in its artificial environment to train weights in the model. <code>model_type</code> is a string which selects one of the available models in <a href="https://stable-baselines3.readthedocs.io/en/master/">stable_baselines</a>(external link).</p>
<p>Parameter details can be found <a href="freqai-parameter-table.html">here</a>, but in general the <code>train_cycles</code> decides how many times the agent should cycle through the candle data in its artificial environment to train weights in the model. <code>model_type</code> is a string which selects one of the available models in <a href="https://stable-baselines3.readthedocs.io/en/master/">stable_baselines</a>(external link).</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If you would like to experiment with <code>continual_learning</code>, then you should set that value to <code>true</code> in the main <code>freqai</code> configuration dictionary. This will tell the Reinforcement Learning library to continue training new models from the final state of previous models, instead of retraining new models from scratch each time a retrain is initiated.</p>
@@ -2052,7 +2052,7 @@ The reward function provided with the Freqtrade source code is a showcase of fun
<div class="highlight"><pre><span></span><code>tensorboard<span class="w"> </span>--logdir<span class="w"> </span>user_data/models/unique-id
</code></pre></div>
<p>where <code>unique-id</code> is the <code>identifier</code> set in the <code>freqai</code> configuration file. This command must be run in a separate shell to view the output in the browser at 127.0.0.1:6006 (6006 is the default port used by Tensorboard).</p>
<p><img alt="tensorboard" src="../assets/tensorboard.jpg" /></p>
<p><img alt="tensorboard" src="assets/tensorboard.jpg" /></p>
<h2 id="custom-logging">Custom logging<a class="headerlink" href="#custom-logging" title="Permanent link">&para;</a></h2>
<p>FreqAI also provides a built in episodic summary logger called <code>self.tensorboard_log</code> for adding custom information to the Tensorboard log. By default, this function is already called once per step inside the environment to record the agent actions. All values accumulated for all steps in a single episode are reported at the conclusion of each episode, followed by a full reset of all metrics to 0 in preparation for the subsequent episode.</p>
<p><code>self.tensorboard_log</code> can also be used anywhere inside the environment, for example, it can be added to the <code>calculate_reward</code> function to collect more detailed information about how often various parts of the reward were called:</p>
@@ -2120,7 +2120,7 @@ The reward function provided with the Freqtrade source code is a showcase of fun
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../freqai-running/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Running FreqAI">
<a href="freqai-running.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Running FreqAI">
<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 11z"/></svg>
@@ -2137,7 +2137,7 @@ The reward function provided with the Freqtrade source code is a showcase of fun
<a href="../freqai-developers/" class="md-footer__link md-footer__link--next" aria-label="Next: Developer guide">
<a href="freqai-developers.html" class="md-footer__link md-footer__link--next" aria-label="Next: Developer guide">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2185,12 +2185,12 @@ The reward function provided with the Freqtrade source code is a showcase of fun
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

152
en/develop/freqai-running/index.html → en/develop/freqai-running.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/freqai-running/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/freqai-running.html">
<link rel="prev" href="../freqai-feature-engineering/">
<link rel="prev" href="freqai-feature-engineering.html">
<link rel="next" href="../freqai-reinforcement-learning/">
<link rel="next" href="freqai-reinforcement-learning.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -833,7 +833,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -856,7 +856,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -879,7 +879,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -902,7 +902,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -947,7 +947,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="freqai-running.html" class="md-nav__link md-nav__link--active">
@@ -1128,7 +1128,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -1151,7 +1151,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1181,7 +1181,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1203,7 +1203,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1225,7 +1225,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1247,7 +1247,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1307,7 +1307,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1330,7 +1330,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1353,7 +1353,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1421,7 +1421,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1444,7 +1444,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1467,7 +1467,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1490,7 +1490,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1513,7 +1513,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1536,7 +1536,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1559,7 +1559,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1582,7 +1582,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1605,7 +1605,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1635,7 +1635,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1657,7 +1657,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1679,7 +1679,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1701,7 +1701,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1723,7 +1723,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -1930,7 +1930,7 @@
<h1 id="running-freqai">Running FreqAI<a class="headerlink" href="#running-freqai" title="Permanent link">&para;</a></h1>
<p>There are two ways to train and deploy an adaptive machine learning model - live deployment and historical backtesting. In both cases, FreqAI runs/simulates periodic retraining of models as shown in the following figure:</p>
<p><img alt="freqai-window" src="../assets/freqai_moving-window.jpg" /></p>
<p><img alt="freqai-window" src="assets/freqai_moving-window.jpg" /></p>
<h2 id="live-deployments">Live deployments<a class="headerlink" href="#live-deployments" title="Permanent link">&para;</a></h2>
<p>FreqAI can be run dry/live using the following command:</p>
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>trade<span class="w"> </span>--strategy<span class="w"> </span>FreqaiExampleStrategy<span class="w"> </span>--config<span class="w"> </span>config_freqai.example.json<span class="w"> </span>--freqaimodel<span class="w"> </span>LightGBMRegressor
@@ -1945,7 +1945,7 @@
</code></pre></div>
<p>In this case, although FreqAI will initiate with a pre-trained model, it will still check to see how much time has elapsed since the model was trained. If a full <code>live_retrain_hours</code> has elapsed since the end of the loaded model, FreqAI will start training a new model.</p>
<h3 id="automatic-data-download">Automatic data download<a class="headerlink" href="#automatic-data-download" title="Permanent link">&para;</a></h3>
<p>FreqAI automatically downloads the proper amount of data needed to ensure training of a model through the defined <code>train_period_days</code> and <code>startup_candle_count</code> (see the <a href="../freqai-parameter-table/">parameter table</a> for detailed descriptions of these parameters). </p>
<p>FreqAI automatically downloads the proper amount of data needed to ensure training of a model through the defined <code>train_period_days</code> and <code>startup_candle_count</code> (see the <a href="freqai-parameter-table.html">parameter table</a> for detailed descriptions of these parameters). </p>
<h3 id="saving-prediction-data">Saving prediction data<a class="headerlink" href="#saving-prediction-data" title="Permanent link">&para;</a></h3>
<p>All predictions made during the lifetime of a specific <code>identifier</code> model are stored in <code>historic_predictions.pkl</code> to allow for reloading after a crash or changes made to the config.</p>
<h3 id="purging-old-model-data">Purging old model data<a class="headerlink" href="#purging-old-model-data" title="Permanent link">&para;</a></h3>
@@ -1973,7 +1973,7 @@ This way, you can return to using any model you wish by simply specifying the <c
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Backtesting calls <code>set_freqai_targets()</code> one time for each backtest window (where the number of windows is the full backtest timerange divided by the <code>backtest_period_days</code> parameter). Doing this means that the targets simulate dry/live behavior without look ahead bias. However, the definition of the features in <code>feature_engineering_*()</code> is performed once on the entire training timerange. This means that you should be sure that features do not look-ahead into the future.
More details about look-ahead bias can be found in <a href="../strategy-customization/#common-mistakes-when-developing-strategies">Common Mistakes</a>.</p>
More details about look-ahead bias can be found in <a href="strategy-customization.html#common-mistakes-when-developing-strategies">Common Mistakes</a>.</p>
</div>
<hr />
<h3 id="saving-backtesting-prediction-data">Saving backtesting prediction data<a class="headerlink" href="#saving-backtesting-prediction-data" title="Permanent link">&para;</a></h3>
@@ -1990,11 +1990,11 @@ If your strategy requires more data than this to generate the same features, you
<p>FreqAI allow you to reuse live historic predictions through the backtest parameter <code>--freqai-backtest-live-models</code>. This can be useful when you want to reuse predictions generated in dry/run for comparison or other study.</p>
<p>The <code>--timerange</code> parameter must not be informed, as it will be automatically calculated through the data in the historic predictions file.</p>
<h3 id="downloading-data-to-cover-the-full-backtest-period">Downloading data to cover the full backtest period<a class="headerlink" href="#downloading-data-to-cover-the-full-backtest-period" title="Permanent link">&para;</a></h3>
<p>For live/dry deployments, FreqAI will download the necessary data automatically. However, to use backtesting functionality, you need to download the necessary data using <code>download-data</code> (details <a href="../data-download/#data-downloading">here</a>). You need to pay careful attention to understanding how much <em>additional</em> data needs to be downloaded to ensure that there is a sufficient amount of training data <em>before</em> the start of the backtesting time range. The amount of additional data can be roughly estimated by moving the start date of the time range backwards by <code>train_period_days</code> and the <code>startup_candle_count</code> (see the <a href="../freqai-parameter-table/">parameter table</a> for detailed descriptions of these parameters) from the beginning of the desired backtesting time range. </p>
<p>As an example, to backtest the <code>--timerange 20210501-20210701</code> using the <a href="../freqai-configuration/#setting-up-the-configuration-file">example config</a> which sets <code>train_period_days</code> to 30, together with <code>startup_candle_count: 40</code> on a maximum <code>include_timeframes</code> of 1h, the start date for the downloaded data needs to be <code>20210501</code> - 30 days - 40 * 1h / 24 hours = 20210330 (31.7 days earlier than the start of the desired training time range).</p>
<p>For live/dry deployments, FreqAI will download the necessary data automatically. However, to use backtesting functionality, you need to download the necessary data using <code>download-data</code> (details <a href="data-download.html#data-downloading">here</a>). You need to pay careful attention to understanding how much <em>additional</em> data needs to be downloaded to ensure that there is a sufficient amount of training data <em>before</em> the start of the backtesting time range. The amount of additional data can be roughly estimated by moving the start date of the time range backwards by <code>train_period_days</code> and the <code>startup_candle_count</code> (see the <a href="freqai-parameter-table.html">parameter table</a> for detailed descriptions of these parameters) from the beginning of the desired backtesting time range. </p>
<p>As an example, to backtest the <code>--timerange 20210501-20210701</code> using the <a href="freqai-configuration.html#setting-up-the-configuration-file">example config</a> which sets <code>train_period_days</code> to 30, together with <code>startup_candle_count: 40</code> on a maximum <code>include_timeframes</code> of 1h, the start date for the downloaded data needs to be <code>20210501</code> - 30 days - 40 * 1h / 24 hours = 20210330 (31.7 days earlier than the start of the desired training time range).</p>
<h3 id="deciding-the-size-of-the-sliding-training-window-and-backtesting-duration">Deciding the size of the sliding training window and backtesting duration<a class="headerlink" href="#deciding-the-size-of-the-sliding-training-window-and-backtesting-duration" title="Permanent link">&para;</a></h3>
<p>The backtesting time range is defined with the typical <code>--timerange</code> parameter in the configuration file. The duration of the sliding training window is set by <code>train_period_days</code>, whilst <code>backtest_period_days</code> is the sliding backtesting window, both in number of days (<code>backtest_period_days</code> can be
a float to indicate sub-daily retraining in live/dry mode). In the presented <a href="../freqai-configuration/#setting-up-the-configuration-file">example config</a> (found in <code>config_examples/config_freqai.example.json</code>), the user is asking FreqAI to use a training period of 30 days and backtest on the subsequent 7 days. After the training of the model, FreqAI will backtest the subsequent 7 days. The "sliding window" then moves one week forward (emulating FreqAI retraining once per week in live mode) and the new model uses the previous 30 days (including the 7 days used for backtesting by the previous model) to train. This is repeated until the end of <code>--timerange</code>. This means that if you set <code>--timerange 20210501-20210701</code>, FreqAI will have trained 8 separate models at the end of <code>--timerange</code> (because the full range comprises 8 weeks).</p>
a float to indicate sub-daily retraining in live/dry mode). In the presented <a href="freqai-configuration.html#setting-up-the-configuration-file">example config</a> (found in <code>config_examples/config_freqai.example.json</code>), the user is asking FreqAI to use a training period of 30 days and backtest on the subsequent 7 days. After the training of the model, FreqAI will backtest the subsequent 7 days. The "sliding window" then moves one week forward (emulating FreqAI retraining once per week in live mode) and the new model uses the previous 30 days (including the 7 days used for backtesting by the previous model) to train. This is repeated until the end of <code>--timerange</code>. This means that if you set <code>--timerange 20210501-20210701</code>, FreqAI will have trained 8 separate models at the end of <code>--timerange</code> (because the full range comprises 8 weeks).</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Although fractional <code>backtest_period_days</code> is allowed, you should be aware that the <code>--timerange</code> is divided by this value to determine the number of models that FreqAI will need to train in order to backtest the full range. For example, by setting a <code>--timerange</code> of 10 days, and a <code>backtest_period_days</code> of 0.1, FreqAI will need to train 100 models per pair to complete the full backtest. Because of this, a true backtest of FreqAI adaptive training would take a <em>very</em> long time. The best way to fully test a model is to run it dry and let it train constantly. In this case, backtesting would take the exact same amount of time as a dry run.</p>
@@ -2009,29 +2009,29 @@ a float to indicate sub-daily retraining in live/dry mode). In the presented <a
<h2 id="controlling-the-model-learning-process">Controlling the model learning process<a class="headerlink" href="#controlling-the-model-learning-process" title="Permanent link">&para;</a></h2>
<p>Model training parameters are unique to the selected machine learning library. FreqAI allows you to set any parameter for any library using the <code>model_training_parameters</code> dictionary in the config. The example config (found in <code>config_examples/config_freqai.example.json</code>) shows some of the example parameters associated with <code>Catboost</code> and <code>LightGBM</code>, but you can add any parameters available in those libraries or any other machine learning library you choose to implement.</p>
<p>Data split parameters are defined in <code>data_split_parameters</code> which can be any parameters associated with scikit-learn's <code>train_test_split()</code> function. <code>train_test_split()</code> has a parameters called <code>shuffle</code> which allows to shuffle the data or keep it unshuffled. This is particularly useful to avoid biasing training with temporally auto-correlated data. More details about these parameters can be found the <a href="https://scikit-learn.org/stable/modules/generated/sklearn.model_selection.train_test_split.html">scikit-learn website</a> (external website).</p>
<p>The FreqAI specific parameter <code>label_period_candles</code> defines the offset (number of candles into the future) used for the <code>labels</code>. In the presented <a href="../freqai-configuration/#setting-up-the-configuration-file">example config</a>, the user is asking for <code>labels</code> that are 24 candles in the future.</p>
<p>The FreqAI specific parameter <code>label_period_candles</code> defines the offset (number of candles into the future) used for the <code>labels</code>. In the presented <a href="freqai-configuration.html#setting-up-the-configuration-file">example config</a>, the user is asking for <code>labels</code> that are 24 candles in the future.</p>
<h2 id="continual-learning">Continual learning<a class="headerlink" href="#continual-learning" title="Permanent link">&para;</a></h2>
<p>You can choose to adopt a continual learning scheme by setting <code>"continual_learning": true</code> in the config. By enabling <code>continual_learning</code>, after training an initial model from scratch, subsequent trainings will start from the final model state of the preceding training. This gives the new model a "memory" of the previous state. By default, this is set to <code>False</code> which means that all new models are trained from scratch, without input from previous models.</p>
<details class="danger" open="open">
<summary>Continual learning enforces a constant parameter space</summary>
<p>Since <code>continual_learning</code> means that the model parameter space <em>cannot</em> change between trainings, <code>principal_component_analysis</code> is automatically disabled when <code>continual_learning</code> is enabled. Hint: PCA changes the parameter space and the number of features, learn more about PCA <a href="../freqai-feature-engineering/#data-dimensionality-reduction-with-principal-component-analysis">here</a>.</p>
<p>Since <code>continual_learning</code> means that the model parameter space <em>cannot</em> change between trainings, <code>principal_component_analysis</code> is automatically disabled when <code>continual_learning</code> is enabled. Hint: PCA changes the parameter space and the number of features, learn more about PCA <a href="freqai-feature-engineering.html#data-dimensionality-reduction-with-principal-component-analysis">here</a>.</p>
</details>
<details class="danger" open="open">
<summary>Experimental functionality</summary>
<p>Beware that this is currently a naive approach to incremental learning, and it has a high probability of overfitting/getting stuck in local minima while the market moves away from your model. We have the mechanics available in FreqAI primarily for experimental purposes and so that it is ready for more mature approaches to continual learning in chaotic systems like the crypto market.</p>
</details>
<h2 id="hyperopt">Hyperopt<a class="headerlink" href="#hyperopt" title="Permanent link">&para;</a></h2>
<p>You can hyperopt using the same command as for <a href="../hyperopt/">typical Freqtrade hyperopt</a>:</p>
<p>You can hyperopt using the same command as for <a href="hyperopt.html">typical Freqtrade hyperopt</a>:</p>
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>hyperopt<span class="w"> </span>--hyperopt-loss<span class="w"> </span>SharpeHyperOptLoss<span class="w"> </span>--strategy<span class="w"> </span>FreqaiExampleStrategy<span class="w"> </span>--freqaimodel<span class="w"> </span>LightGBMRegressor<span class="w"> </span>--strategy-path<span class="w"> </span>freqtrade/templates<span class="w"> </span>--config<span class="w"> </span>config_examples/config_freqai.example.json<span class="w"> </span>--timerange<span class="w"> </span><span class="m">20220428</span>-20220507
</code></pre></div>
<p><code>hyperopt</code> requires you to have the data pre-downloaded in the same fashion as if you were doing <a href="#backtesting">backtesting</a>. In addition, you must consider some restrictions when trying to hyperopt FreqAI strategies:</p>
<ul>
<li>The <code>--analyze-per-epoch</code> hyperopt parameter is not compatible with FreqAI.</li>
<li>It's not possible to hyperopt indicators in the <code>feature_engineering_*()</code> and <code>set_freqai_targets()</code> functions. This means that you cannot optimize model parameters using hyperopt. Apart from this exception, it is possible to optimize all other <a href="../hyperopt/#running-hyperopt-with-smaller-search-space">spaces</a>.</li>
<li>It's not possible to hyperopt indicators in the <code>feature_engineering_*()</code> and <code>set_freqai_targets()</code> functions. This means that you cannot optimize model parameters using hyperopt. Apart from this exception, it is possible to optimize all other <a href="hyperopt.html#running-hyperopt-with-smaller-search-space">spaces</a>.</li>
<li>The backtesting instructions also apply to hyperopt.</li>
</ul>
<p>The best method for combining hyperopt and FreqAI is to focus on hyperopting entry/exit thresholds/criteria. You need to focus on hyperopting parameters that are not used in your features. For example, you should not try to hyperopt rolling window lengths in the feature creation, or any part of the FreqAI config which changes predictions. In order to efficiently hyperopt the FreqAI strategy, FreqAI stores predictions as dataframes and reuses them. Hence the requirement to hyperopt entry/exit thresholds/criteria only.</p>
<p>A good example of a hyperoptable parameter in FreqAI is a threshold for the <a href="../freqai-feature-engineering/#identifying-outliers-with-the-dissimilarity-index-di">Dissimilarity Index (DI)</a> <code>DI_values</code> beyond which we consider data points as outliers:</p>
<p>A good example of a hyperoptable parameter in FreqAI is a threshold for the <a href="freqai-feature-engineering.html#identifying-outliers-with-the-dissimilarity-index-di">Dissimilarity Index (DI)</a> <code>DI_values</code> beyond which we consider data points as outliers:</p>
<div class="highlight"><pre><span></span><code><span class="n">di_max</span> <span class="o">=</span> <span class="n">IntParameter</span><span class="p">(</span><span class="n">low</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">high</span><span class="o">=</span><span class="mi">20</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> <span class="n">space</span><span class="o">=</span><span class="s1">&#39;buy&#39;</span><span class="p">,</span> <span class="n">optimize</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">load</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">dataframe</span><span class="p">[</span><span class="s1">&#39;outlier&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">dataframe</span><span class="p">[</span><span class="s1">&#39;DI_values&#39;</span><span class="p">]</span> <span class="o">&gt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">di_max</span><span class="o">.</span><span class="n">value</span><span class="o">/</span><span class="mi">10</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
</code></pre></div>
@@ -2050,7 +2050,7 @@ a float to indicate sub-daily retraining in live/dry mode). In the presented <a
tensorboard<span class="w"> </span>--logdir<span class="w"> </span>user_data/models/unique-id
</code></pre></div>
<p>where <code>unique-id</code> is the <code>identifier</code> set in the <code>freqai</code> configuration file. This command must be run in a separate shell if you wish to view the output in your browser at 127.0.0.1:6060 (6060 is the default port used by Tensorboard).</p>
<p><img alt="tensorboard" src="../assets/tensorboard.jpg" /></p>
<p><img alt="tensorboard" src="assets/tensorboard.jpg" /></p>
<div class="admonition note">
<p class="admonition-title">Deactivate for improved performance</p>
<p>Tensorboard logging can slow down training and should be deactivated for production use.</p>
@@ -2093,7 +2093,7 @@ tensorboard<span class="w"> </span>--logdir<span class="w"> </span>user_data/mod
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../freqai-feature-engineering/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Feature engineering">
<a href="freqai-feature-engineering.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Feature engineering">
<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 11z"/></svg>
@@ -2110,7 +2110,7 @@ tensorboard<span class="w"> </span>--logdir<span class="w"> </span>user_data/mod
<a href="../freqai-reinforcement-learning/" class="md-footer__link md-footer__link--next" aria-label="Next: Reinforcement Learning">
<a href="freqai-reinforcement-learning.html" class="md-footer__link md-footer__link--next" aria-label="Next: Reinforcement Learning">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2158,12 +2158,12 @@ tensorboard<span class="w"> </span>--logdir<span class="w"> </span>user_data/mod
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

154
en/develop/freqai/index.html → en/develop/freqai.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/freqai/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/freqai.html">
<link rel="prev" href="../hyperopt/">
<link rel="prev" href="hyperopt.html">
<link rel="next" href="../freqai-configuration/">
<link rel="next" href="freqai-configuration.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -855,7 +855,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="freqai.html" class="md-nav__link md-nav__link--active">
@@ -1018,7 +1018,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -1041,7 +1041,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -1064,7 +1064,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -1087,7 +1087,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -1110,7 +1110,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -1133,7 +1133,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1163,7 +1163,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1185,7 +1185,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1207,7 +1207,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1229,7 +1229,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1289,7 +1289,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1312,7 +1312,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1335,7 +1335,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1403,7 +1403,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1426,7 +1426,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1449,7 +1449,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1472,7 +1472,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1495,7 +1495,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1518,7 +1518,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1541,7 +1541,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1564,7 +1564,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1587,7 +1587,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1617,7 +1617,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1639,7 +1639,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1661,7 +1661,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1683,7 +1683,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1705,7 +1705,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -1892,7 +1892,7 @@
<p><img alt="freqai-logo" src="../assets/freqai_doc_logo.svg" /></p>
<p><img alt="freqai-logo" src="assets/freqai_doc_logo.svg" /></p>
<h1 id="freqai">FreqAI<a class="headerlink" href="#freqai" title="Permanent link">&para;</a></h1>
<h2 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permanent link">&para;</a></h2>
<p>FreqAI is a software designed to automate a variety of tasks associated with training a predictive machine learning model to generate market forecasts given a set of input signals. In general, FreqAI aims to be a sandbox for easily deploying robust machine learning libraries on real-time data (<a href="#freqai-position-in-open-source-machine-learning-landscape">details</a>).</p>
@@ -1902,18 +1902,18 @@
</div>
<p>Features include:</p>
<ul>
<li><strong>Self-adaptive retraining</strong> - Retrain models during <a href="../freqai-running/#live-deployments">live deployments</a> to self-adapt to the market in a supervised manner</li>
<li><strong>Rapid feature engineering</strong> - Create large rich <a href="../freqai-feature-engineering/#feature-engineering">feature sets</a> (10k+ features) based on simple user-created strategies</li>
<li><strong>Self-adaptive retraining</strong> - Retrain models during <a href="freqai-running.html#live-deployments">live deployments</a> to self-adapt to the market in a supervised manner</li>
<li><strong>Rapid feature engineering</strong> - Create large rich <a href="freqai-feature-engineering.html#feature-engineering">feature sets</a> (10k+ features) based on simple user-created strategies</li>
<li><strong>High performance</strong> - Threading allows for adaptive model retraining on a separate thread (or on GPU if available) from model inferencing (prediction) and bot trade operations. Newest models and data are kept in RAM for rapid inferencing</li>
<li><strong>Realistic backtesting</strong> - Emulate self-adaptive training on historic data with a <a href="../freqai-running/#backtesting">backtesting module</a> that automates retraining</li>
<li><strong>Extensibility</strong> - The generalized and robust architecture allows for incorporating any <a href="../freqai-configuration/#using-different-prediction-models">machine learning library/method</a> available in Python. Eight examples are currently available, including classifiers, regressors, and a convolutional neural network</li>
<li><strong>Smart outlier removal</strong> - Remove outliers from training and prediction data sets using a variety of <a href="../freqai-feature-engineering/#outlier-detection">outlier detection techniques</a></li>
<li><strong>Crash resilience</strong> - Store trained models to disk to make reloading from a crash fast and easy, and <a href="../freqai-running/#purging-old-model-data">purge obsolete files</a> for sustained dry/live runs</li>
<li><strong>Automatic data normalization</strong> - <a href="../freqai-feature-engineering/#building-the-data-pipeline">Normalize the data</a> in a smart and statistically safe way</li>
<li><strong>Realistic backtesting</strong> - Emulate self-adaptive training on historic data with a <a href="freqai-running.html#backtesting">backtesting module</a> that automates retraining</li>
<li><strong>Extensibility</strong> - The generalized and robust architecture allows for incorporating any <a href="freqai-configuration.html#using-different-prediction-models">machine learning library/method</a> available in Python. Eight examples are currently available, including classifiers, regressors, and a convolutional neural network</li>
<li><strong>Smart outlier removal</strong> - Remove outliers from training and prediction data sets using a variety of <a href="freqai-feature-engineering.html#outlier-detection">outlier detection techniques</a></li>
<li><strong>Crash resilience</strong> - Store trained models to disk to make reloading from a crash fast and easy, and <a href="freqai-running.html#purging-old-model-data">purge obsolete files</a> for sustained dry/live runs</li>
<li><strong>Automatic data normalization</strong> - <a href="freqai-feature-engineering.html#building-the-data-pipeline">Normalize the data</a> in a smart and statistically safe way</li>
<li><strong>Automatic data download</strong> - Compute timeranges for data downloads and update historic data (in live deployments)</li>
<li><strong>Cleaning of incoming data</strong> - Handle NaNs safely before training and model inferencing</li>
<li><strong>Dimensionality reduction</strong> - Reduce the size of the training data via <a href="../freqai-feature-engineering/#data-dimensionality-reduction-with-principal-component-analysis">Principal Component Analysis</a></li>
<li><strong>Deploying bot fleets</strong> - Set one bot to train models while a fleet of <a href="../producer-consumer/">consumers</a> use signals.</li>
<li><strong>Dimensionality reduction</strong> - Reduce the size of the training data via <a href="freqai-feature-engineering.html#data-dimensionality-reduction-with-principal-component-analysis">Principal Component Analysis</a></li>
<li><strong>Deploying bot fleets</strong> - Set one bot to train models while a fleet of <a href="producer-consumer.html">consumers</a> use signals.</li>
</ul>
<h2 id="quick-start">Quick start<a class="headerlink" href="#quick-start" title="Permanent link">&para;</a></h2>
<p>The easiest way to quickly test FreqAI is to run it in dry mode with the following command:</p>
@@ -1928,13 +1928,13 @@
<code>freqtrade/templates/FreqaiExampleStrategy.py</code>, <code>freqtrade/freqai/prediction_models/LightGBMRegressor.py</code>, and
<code>config_examples/config_freqai.example.json</code>, respectively.</p>
<h2 id="general-approach">General approach<a class="headerlink" href="#general-approach" title="Permanent link">&para;</a></h2>
<p>You provide FreqAI with a set of custom <em>base indicators</em> (the same way as in a <a href="../strategy-customization/">typical Freqtrade strategy</a>) as well as target values (<em>labels</em>). For each pair in the whitelist, FreqAI trains a model to predict the target values based on the input of custom indicators. The models are then consistently retrained, with a predetermined frequency, to adapt to market conditions. FreqAI offers the ability to both backtest strategies (emulating reality with periodic retraining on historic data) and deploy dry/live runs. In dry/live conditions, FreqAI can be set to constant retraining in a background thread to keep models as up to date as possible.</p>
<p>You provide FreqAI with a set of custom <em>base indicators</em> (the same way as in a <a href="strategy-customization.html">typical Freqtrade strategy</a>) as well as target values (<em>labels</em>). For each pair in the whitelist, FreqAI trains a model to predict the target values based on the input of custom indicators. The models are then consistently retrained, with a predetermined frequency, to adapt to market conditions. FreqAI offers the ability to both backtest strategies (emulating reality with periodic retraining on historic data) and deploy dry/live runs. In dry/live conditions, FreqAI can be set to constant retraining in a background thread to keep models as up to date as possible.</p>
<p>An overview of the algorithm, explaining the data processing pipeline and model usage, is shown below.</p>
<p><img alt="freqai-algo" src="../assets/freqai_algo.jpg" /></p>
<p><img alt="freqai-algo" src="assets/freqai_algo.jpg" /></p>
<h3 id="important-machine-learning-vocabulary">Important machine learning vocabulary<a class="headerlink" href="#important-machine-learning-vocabulary" title="Permanent link">&para;</a></h3>
<p><strong>Features</strong> - the parameters, based on historic data, on which a model is trained. All features for a single candle are stored as a vector. In FreqAI, you build a feature data set from anything you can construct in the strategy.</p>
<p><strong>Labels</strong> - the target values that the model is trained toward. Each feature vector is associated with a single label that is defined by you within the strategy. These labels intentionally look into the future and are what you are training the model to be able to predict.</p>
<p><strong>Training</strong> - the process of "teaching" the model to match the feature sets to the associated labels. Different types of models "learn" in different ways which means that one might be better than another for a specific application. More information about the different models that are already implemented in FreqAI can be found <a href="../freqai-configuration/#using-different-prediction-models">here</a>.</p>
<p><strong>Training</strong> - the process of "teaching" the model to match the feature sets to the associated labels. Different types of models "learn" in different ways which means that one might be better than another for a specific application. More information about the different models that are already implemented in FreqAI can be found <a href="freqai-configuration.html#using-different-prediction-models">here</a>.</p>
<p><strong>Train data</strong> - a subset of the feature data set that is fed to the model during training to "teach" the model how to predict the targets. This data directly influences weight connections in the model.</p>
<p><strong>Test data</strong> - a subset of the feature data set that is used to evaluate the performance of the model after training. This data does not influence nodal weights within the model.</p>
<p><strong>Inferencing</strong> - the process of feeding a trained model new unseen data on which it will make a prediction. </p>
@@ -2030,7 +2030,7 @@ Stefan Gehring @bloodhunter4rc, @longyu, Andrew Lawless @paranoidandy, Pascal Sc
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../hyperopt/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Hyperopt">
<a href="hyperopt.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Hyperopt">
<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 11z"/></svg>
@@ -2047,7 +2047,7 @@ Stefan Gehring @bloodhunter4rc, @longyu, Andrew Lawless @paranoidandy, Pascal Sc
<a href="../freqai-configuration/" class="md-footer__link md-footer__link--next" aria-label="Next: Configuration">
<a href="freqai-configuration.html" class="md-footer__link md-footer__link--next" aria-label="Next: Configuration">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2095,12 +2095,12 @@ Stefan Gehring @bloodhunter4rc, @longyu, Andrew Lawless @paranoidandy, Pascal Sc
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

148
en/develop/hyperopt/index.html → en/develop/hyperopt.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/hyperopt/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/hyperopt.html">
<link rel="prev" href="../backtesting/">
<link rel="prev" href="backtesting.html">
<link rel="next" href="../freqai/">
<link rel="next" href="freqai.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -793,7 +793,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="hyperopt.html" class="md-nav__link md-nav__link--active">
@@ -1296,7 +1296,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -1319,7 +1319,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -1342,7 +1342,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -1365,7 +1365,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -1388,7 +1388,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -1411,7 +1411,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -1434,7 +1434,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1464,7 +1464,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1486,7 +1486,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1508,7 +1508,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1530,7 +1530,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1590,7 +1590,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1613,7 +1613,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1636,7 +1636,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1704,7 +1704,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1727,7 +1727,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1750,7 +1750,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1773,7 +1773,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1796,7 +1796,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1819,7 +1819,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1842,7 +1842,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1865,7 +1865,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1888,7 +1888,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1918,7 +1918,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1940,7 +1940,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1962,7 +1962,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1984,7 +1984,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -2006,7 +2006,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -2502,7 +2502,7 @@ parameters, a process called hyperparameter optimization. The bot uses algorithm
The search will burn all your CPU cores, make your laptop sound like a fighter jet and still take a long time.</p>
<p>In general, the search for best parameters starts with a few random combinations (see <a href="#reproducible-results">below</a> for more details) and then uses one of optuna's sampler algorithms (currently NSGAIIISampler) to quickly find a combination of parameters in the search hyperspace that minimizes the value of the <a href="#loss-functions">loss function</a>.</p>
<p>Hyperopt requires historic data to be available, just as backtesting does (hyperopt runs backtesting many times with different parameters).
To learn how to get data for the pairs and exchange you're interested in, head over to the <a href="../data-download/">Data Downloading</a> section of the documentation.</p>
To learn how to get data for the pairs and exchange you're interested in, head over to the <a href="data-download.html">Data Downloading</a> section of the documentation.</p>
<div class="admonition bug">
<p class="admonition-title">Bug</p>
<p>Hyperopt can crash when used with only 1 CPU Core as found out in <a href="https://github.com/freqtrade/freqtrade/issues/1133">Issue #1133</a></p>
@@ -2661,7 +2661,7 @@ Strategy arguments:
<p class="admonition-title">Note</p>
<p><code>populate_indicators</code> needs to create all indicators any of the spaces may use, otherwise hyperopt will not work.</p>
</div>
<p>Rarely you may also need to create a <a href="../advanced-hyperopt/#overriding-pre-defined-spaces">nested class</a> named <code>HyperOpt</code> and implement</p>
<p>Rarely you may also need to create a <a href="advanced-hyperopt.html#overriding-pre-defined-spaces">nested class</a> named <code>HyperOpt</code> and implement</p>
<ul>
<li><code>roi_space</code> - for custom ROI optimization (if you need the ranges for the ROI parameters in the optimization hyperspace that differ from default)</li>
<li><code>generate_roi_table</code> - for custom ROI optimization (if you need the ranges for the values in the ROI table that differ from default or the number of entries (steps) in the ROI table which differs from the default 4 steps)</li>
@@ -3038,7 +3038,7 @@ This class should be in its own file within the <code>user_data/hyperopts/</code
<li><code>ProfitDrawDownHyperOptLoss</code> - Optimizes by max Profit &amp; min Drawdown objective. <code>DRAWDOWN_MULT</code> variable within the hyperoptloss file can be adjusted to be stricter or more flexible on drawdown purposes.</li>
<li><code>MultiMetricHyperOptLoss</code> - Optimizes by several key metrics to achieve balanced performance. The primary focus is on maximizing Profit and minimizing Drawdown, while also considering additional metrics such as Profit Factor, Expectancy Ratio and Winrate. Moreover, it applies a penalty for epochs with a low number of trades, encouraging strategies with adequate trade frequency.</li>
</ul>
<p>Creation of a custom loss function is covered in the <a href="../advanced-hyperopt/">Advanced Hyperopt</a> part of the documentation.</p>
<p>Creation of a custom loss function is covered in the <a href="advanced-hyperopt.html">Advanced Hyperopt</a> part of the documentation.</p>
<h2 id="execute-hyperopt">Execute Hyperopt<a class="headerlink" href="#execute-hyperopt" title="Permanent link">&para;</a></h2>
<p>Once you have updated your hyperopt configuration you can run it.
Because hyperopt tries a lot of combinations to find the best parameters it will take time to get a good result.</p>
@@ -3216,10 +3216,10 @@ The prevalence is therefore: config &gt; parameter file &gt; strategy <code>*_pa
<p>These ranges should be sufficient in most cases. The minutes in the steps (ROI dict keys) are scaled linearly depending on the timeframe used. The ROI values in the steps (ROI dict values) are scaled logarithmically depending on the timeframe used.</p>
<p>If you have the <code>generate_roi_table()</code> and <code>roi_space()</code> methods in your custom hyperopt, remove them in order to utilize these adaptive ROI tables and the ROI hyperoptimization space generated by Freqtrade by default.</p>
<p>Override the <code>roi_space()</code> method if you need components of the ROI tables to vary in other ranges. Override the <code>generate_roi_table()</code> and <code>roi_space()</code> methods and implement your own custom approach for generation of the ROI tables during hyperoptimization if you need a different structure of the ROI tables or other amount of rows (steps).</p>
<p>A sample for these methods can be found in the <a href="../advanced-hyperopt/#overriding-pre-defined-spaces">overriding pre-defined spaces section</a>.</p>
<p>A sample for these methods can be found in the <a href="advanced-hyperopt.html#overriding-pre-defined-spaces">overriding pre-defined spaces section</a>.</p>
<div class="admonition note">
<p class="admonition-title">Reduced search space</p>
<p>To limit the search space further, Decimals are limited to 3 decimal places (a precision of 0.001). This is usually sufficient, every value more precise than this will usually result in overfitted results. You can however <a href="../advanced-hyperopt/#overriding-pre-defined-spaces">overriding pre-defined spaces</a> to change this to your needs.</p>
<p>To limit the search space further, Decimals are limited to 3 decimal places (a precision of 0.001). This is usually sufficient, every value more precise than this will usually result in overfitted results. You can however <a href="advanced-hyperopt.html#overriding-pre-defined-spaces">overriding pre-defined spaces</a> to change this to your needs.</p>
</div>
<h3 id="understand-hyperopt-stoploss-results">Understand Hyperopt Stoploss results<a class="headerlink" href="#understand-hyperopt-stoploss-results" title="Permanent link">&para;</a></h3>
<p>If you are optimizing stoploss values (i.e. if optimization search-space contains 'all', 'default' or 'stoploss'), your result will look as follows and include stoploss:</p>
@@ -3247,10 +3247,10 @@ The prevalence is therefore: config &gt; parameter file &gt; strategy <code>*_pa
<h4 id="default-stoploss-search-space">Default Stoploss Search Space<a class="headerlink" href="#default-stoploss-search-space" title="Permanent link">&para;</a></h4>
<p>If you are optimizing stoploss values, Freqtrade creates the 'stoploss' optimization hyperspace for you. By default, the stoploss values in that hyperspace vary in the range -0.35...-0.02, which is sufficient in most cases.</p>
<p>If you have the <code>stoploss_space()</code> method in your custom hyperopt file, remove it in order to utilize Stoploss hyperoptimization space generated by Freqtrade by default.</p>
<p>Override the <code>stoploss_space()</code> method and define the desired range in it if you need stoploss values to vary in other range during hyperoptimization. A sample for this method can be found in the <a href="../advanced-hyperopt/#overriding-pre-defined-spaces">overriding pre-defined spaces section</a>.</p>
<p>Override the <code>stoploss_space()</code> method and define the desired range in it if you need stoploss values to vary in other range during hyperoptimization. A sample for this method can be found in the <a href="advanced-hyperopt.html#overriding-pre-defined-spaces">overriding pre-defined spaces section</a>.</p>
<div class="admonition note">
<p class="admonition-title">Reduced search space</p>
<p>To limit the search space further, Decimals are limited to 3 decimal places (a precision of 0.001). This is usually sufficient, every value more precise than this will usually result in overfitted results. You can however <a href="../advanced-hyperopt/#overriding-pre-defined-spaces">overriding pre-defined spaces</a> to change this to your needs.</p>
<p>To limit the search space further, Decimals are limited to 3 decimal places (a precision of 0.001). This is usually sufficient, every value more precise than this will usually result in overfitted results. You can however <a href="advanced-hyperopt.html#overriding-pre-defined-spaces">overriding pre-defined spaces</a> to change this to your needs.</p>
</div>
<h3 id="understand-hyperopt-trailing-stop-results">Understand Hyperopt Trailing Stop results<a class="headerlink" href="#understand-hyperopt-trailing-stop-results" title="Permanent link">&para;</a></h3>
<p>If you are optimizing trailing stop values (i.e. if optimization search-space contains 'all' or 'trailing'), your result will look as follows and include trailing stop parameters:</p>
@@ -3275,10 +3275,10 @@ The prevalence is therefore: config &gt; parameter file &gt; strategy <code>*_pa
<p>As stated in the comment, you can also use it as the values of the corresponding settings in the configuration file.</p>
<h4 id="default-trailing-stop-search-space">Default Trailing Stop Search Space<a class="headerlink" href="#default-trailing-stop-search-space" title="Permanent link">&para;</a></h4>
<p>If you are optimizing trailing stop values, Freqtrade creates the 'trailing' optimization hyperspace for you. By default, the <code>trailing_stop</code> parameter is always set to True in that hyperspace, the value of the <code>trailing_only_offset_is_reached</code> vary between True and False, the values of the <code>trailing_stop_positive</code> and <code>trailing_stop_positive_offset</code> parameters vary in the ranges 0.02...0.35 and 0.01...0.1 correspondingly, which is sufficient in most cases.</p>
<p>Override the <code>trailing_space()</code> method and define the desired range in it if you need values of the trailing stop parameters to vary in other ranges during hyperoptimization. A sample for this method can be found in the <a href="../advanced-hyperopt/#overriding-pre-defined-spaces">overriding pre-defined spaces section</a>.</p>
<p>Override the <code>trailing_space()</code> method and define the desired range in it if you need values of the trailing stop parameters to vary in other ranges during hyperoptimization. A sample for this method can be found in the <a href="advanced-hyperopt.html#overriding-pre-defined-spaces">overriding pre-defined spaces section</a>.</p>
<div class="admonition note">
<p class="admonition-title">Reduced search space</p>
<p>To limit the search space further, Decimals are limited to 3 decimal places (a precision of 0.001). This is usually sufficient, every value more precise than this will usually result in overfitted results. You can however <a href="../advanced-hyperopt/#overriding-pre-defined-spaces">overriding pre-defined spaces</a> to change this to your needs.</p>
<p>To limit the search space further, Decimals are limited to 3 decimal places (a precision of 0.001). This is usually sufficient, every value more precise than this will usually result in overfitted results. You can however <a href="advanced-hyperopt.html#overriding-pre-defined-spaces">overriding pre-defined spaces</a> to change this to your needs.</p>
</div>
<h3 id="reproducible-results">Reproducible results<a class="headerlink" href="#reproducible-results" title="Permanent link">&para;</a></h3>
<p>The search for optimal parameters starts with a few (currently 30) random combinations in the hyperspace of parameters, random Hyperopt epochs. These random epochs are marked with an asterisk character (<code>*</code>) in the first column in the Hyperopt output.</p>
@@ -3328,7 +3328,7 @@ Freqtrade tries to counter the "local minima" problem by using new, randomized p
<p>The <code>buy_ema_short</code> space has 15 possible values (<code>5, 6, ... 19, 20</code>). If you now run hyperopt for the buy space, hyperopt will only have 15 values to try before running out of options.
Your epochs should therefore be aligned to the possible values - or you should be ready to interrupt a run if you norice a lot of <code>The objective has been evaluated at this point before.</code> warnings.</p>
<h2 id="show-details-of-hyperopt-results">Show details of Hyperopt results<a class="headerlink" href="#show-details-of-hyperopt-results" title="Permanent link">&para;</a></h2>
<p>After you run Hyperopt for the desired amount of epochs, you can later list all results for analysis, select only best or profitable once, and show the details for any of the epochs previously evaluated. This can be done with the <code>hyperopt-list</code> and <code>hyperopt-show</code> sub-commands. The usage of these sub-commands is described in the <a href="../utils/#list-hyperopt-results">Utils</a> chapter.</p>
<p>After you run Hyperopt for the desired amount of epochs, you can later list all results for analysis, select only best or profitable once, and show the details for any of the epochs previously evaluated. This can be done with the <code>hyperopt-list</code> and <code>hyperopt-show</code> sub-commands. The usage of these sub-commands is described in the <a href="utils.html#list-hyperopt-results">Utils</a> chapter.</p>
<h2 id="output-debug-messages-from-your-strategy">Output debug messages from your strategy<a class="headerlink" href="#output-debug-messages-from-your-strategy" title="Permanent link">&para;</a></h2>
<p>If you want to output debug messages from your strategy, you can use the <code>logging</code> module. By default, Freqtrade will output all messages with a level of <code>INFO</code> or higher. </p>
<div class="highlight"><pre><span></span><code><span class="kn">import</span><span class="w"> </span><span class="nn">logging</span>
@@ -3400,7 +3400,7 @@ It is recommended to use the <code>logging</code> module instead.</p>
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../backtesting/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Backtesting">
<a href="backtesting.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Backtesting">
<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 11z"/></svg>
@@ -3417,7 +3417,7 @@ It is recommended to use the <code>logging</code> module instead.</p>
<a href="../freqai/" class="md-footer__link md-footer__link--next" aria-label="Next: Introduction">
<a href="freqai.html" class="md-footer__link md-footer__link--next" aria-label="Next: Introduction">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -3465,12 +3465,12 @@ It is recommended to use the <code>logging</code> module instead.</p>
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

112
en/develop/index.html
View File

@@ -10,11 +10,11 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/index.html">
<link rel="next" href="docker_quickstart/">
<link rel="next" href="docker_quickstart.html">
<link rel="icon" href="images/logo.png">
@@ -106,7 +106,7 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="images/logo.png" alt="logo">
@@ -248,7 +248,7 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="images/logo.png" alt="logo">
@@ -297,7 +297,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="." class="md-nav__link md-nav__link--active">
<a href="index.html" class="md-nav__link md-nav__link--active">
@@ -463,7 +463,7 @@
<li class="md-nav__item">
<a href="docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -523,7 +523,7 @@
<li class="md-nav__item">
<a href="installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -576,7 +576,7 @@
<li class="md-nav__item">
<a href="bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -598,7 +598,7 @@
<li class="md-nav__item">
<a href="configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -620,7 +620,7 @@
<li class="md-nav__item">
<a href="strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -642,7 +642,7 @@
<li class="md-nav__item">
<a href="strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -664,7 +664,7 @@
<li class="md-nav__item">
<a href="strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -686,7 +686,7 @@
<li class="md-nav__item">
<a href="stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -708,7 +708,7 @@
<li class="md-nav__item">
<a href="plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -730,7 +730,7 @@
<li class="md-nav__item">
<a href="bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -790,7 +790,7 @@
<li class="md-nav__item">
<a href="telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -813,7 +813,7 @@
<li class="md-nav__item">
<a href="freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -836,7 +836,7 @@
<li class="md-nav__item">
<a href="rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -859,7 +859,7 @@
<li class="md-nav__item">
<a href="webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -889,7 +889,7 @@
<li class="md-nav__item">
<a href="data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -911,7 +911,7 @@
<li class="md-nav__item">
<a href="backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -933,7 +933,7 @@
<li class="md-nav__item">
<a href="hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -993,7 +993,7 @@
<li class="md-nav__item">
<a href="freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -1016,7 +1016,7 @@
<li class="md-nav__item">
<a href="freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -1039,7 +1039,7 @@
<li class="md-nav__item">
<a href="freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -1062,7 +1062,7 @@
<li class="md-nav__item">
<a href="freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -1085,7 +1085,7 @@
<li class="md-nav__item">
<a href="freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -1108,7 +1108,7 @@
<li class="md-nav__item">
<a href="freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -1131,7 +1131,7 @@
<li class="md-nav__item">
<a href="freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1161,7 +1161,7 @@
<li class="md-nav__item">
<a href="leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1183,7 +1183,7 @@
<li class="md-nav__item">
<a href="utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1205,7 +1205,7 @@
<li class="md-nav__item">
<a href="plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1227,7 +1227,7 @@
<li class="md-nav__item">
<a href="exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1287,7 +1287,7 @@
<li class="md-nav__item">
<a href="data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1310,7 +1310,7 @@
<li class="md-nav__item">
<a href="strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1333,7 +1333,7 @@
<li class="md-nav__item">
<a href="advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1401,7 +1401,7 @@
<li class="md-nav__item">
<a href="advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1424,7 +1424,7 @@
<li class="md-nav__item">
<a href="trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1447,7 +1447,7 @@
<li class="md-nav__item">
<a href="lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1470,7 +1470,7 @@
<li class="md-nav__item">
<a href="recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1493,7 +1493,7 @@
<li class="md-nav__item">
<a href="strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1516,7 +1516,7 @@
<li class="md-nav__item">
<a href="advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1539,7 +1539,7 @@
<li class="md-nav__item">
<a href="advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1562,7 +1562,7 @@
<li class="md-nav__item">
<a href="producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1585,7 +1585,7 @@
<li class="md-nav__item">
<a href="sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1615,7 +1615,7 @@
<li class="md-nav__item">
<a href="faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1637,7 +1637,7 @@
<li class="md-nav__item">
<a href="strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1659,7 +1659,7 @@
<li class="md-nav__item">
<a href="updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1681,7 +1681,7 @@
<li class="md-nav__item">
<a href="deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1703,7 +1703,7 @@
<li class="md-nav__item">
<a href="developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -1923,10 +1923,10 @@
<li>Select markets: Create your static list or use an automatic one based on top traded volumes and/or prices (not available during backtesting). You can also explicitly blacklist markets you don't want to trade.</li>
<li>Run: Test your strategy with simulated money (Dry-Run mode) or deploy it with real money (Live-Trade mode).</li>
<li>Control/Monitor: Use Telegram or a WebUI (start/stop the bot, show profit/loss, daily summary, current open trades results, etc.).</li>
<li>Analyze: Further analysis can be performed on either Backtesting data or Freqtrade trading history (SQL database), including automated standard plots, and methods to load the data into <a href="data-analysis/">interactive environments</a>.</li>
<li>Analyze: Further analysis can be performed on either Backtesting data or Freqtrade trading history (SQL database), including automated standard plots, and methods to load the data into <a href="data-analysis.html">interactive environments</a>.</li>
</ul>
<h2 id="supported-exchange-marketplaces">Supported exchange marketplaces<a class="headerlink" href="#supported-exchange-marketplaces" title="Permanent link">&para;</a></h2>
<p>Please read the <a href="exchanges/">exchange specific notes</a> to learn about eventual, special configurations needed for each exchange.</p>
<p>Please read the <a href="exchanges.html">exchange specific notes</a> to learn about eventual, special configurations needed for each exchange.</p>
<ul class="task-list">
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled checked/><span class="task-list-indicator"></span></label> <a href="https://www.binance.com/">Binance</a></li>
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled checked/><span class="task-list-indicator"></span></label> <a href="https://bingx.com/invite/0EM9RX">BingX</a></li>
@@ -1948,7 +1948,7 @@
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled checked/><span class="task-list-indicator"></span></label> <a href="https://hyperliquid.xyz/">Hyperliquid</a> (A decentralized exchange, or DEX)</li>
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled checked/><span class="task-list-indicator"></span></label> <a href="https://okx.com/">OKX</a></li>
</ul>
<p>Please make sure to read the <a href="exchanges/">exchange specific notes</a>, as well as the <a href="leverage/">trading with leverage</a> documentation before diving in.</p>
<p>Please make sure to read the <a href="exchanges.html">exchange specific notes</a>, as well as the <a href="leverage.html">trading with leverage</a> documentation before diving in.</p>
<h3 id="community-tested">Community tested<a class="headerlink" href="#community-tested" title="Permanent link">&para;</a></h3>
<p>Exchanges confirmed working by the community:</p>
<ul class="task-list">
@@ -1994,7 +1994,7 @@
<h3 id="help-discord">Help / Discord<a class="headerlink" href="#help-discord" title="Permanent link">&para;</a></h3>
<p>For any questions not covered by the documentation or for further information about the bot, or to simply engage with like-minded individuals, we encourage you to join the Freqtrade <a href="https://discord.gg/p7nuUNVfP7">discord server</a>.</p>
<h2 id="ready-to-try">Ready to try?<a class="headerlink" href="#ready-to-try" title="Permanent link">&para;</a></h2>
<p>Begin by reading the installation guide <a href="docker_quickstart/">for docker</a> (recommended), or for <a href="installation/">installation without docker</a>.</p>
<p>Begin by reading the installation guide <a href="docker_quickstart.html">for docker</a> (recommended), or for <a href="installation.html">installation without docker</a>.</p>
@@ -2034,7 +2034,7 @@
<a href="docker_quickstart/" class="md-footer__link md-footer__link--next" aria-label="Next: Quickstart with Docker">
<a href="docker_quickstart.html" class="md-footer__link md-footer__link--next" aria-label="Next: Quickstart with Docker">
<div class="md-footer__title">
<span class="md-footer__direction">
Next

146
en/develop/installation/index.html → en/develop/installation.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/installation/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/installation.html">
<link rel="prev" href="../docker_quickstart/">
<link rel="prev" href="docker_quickstart.html">
<link rel="next" href="../windows_installation/">
<link rel="next" href="windows_installation.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -385,7 +385,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="installation.html" class="md-nav__link md-nav__link--active">
@@ -785,7 +785,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -815,7 +815,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -837,7 +837,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -859,7 +859,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -881,7 +881,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -903,7 +903,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -925,7 +925,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -947,7 +947,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -969,7 +969,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -1029,7 +1029,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -1052,7 +1052,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -1075,7 +1075,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -1098,7 +1098,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -1128,7 +1128,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -1150,7 +1150,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -1172,7 +1172,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -1232,7 +1232,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -1255,7 +1255,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -1278,7 +1278,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -1301,7 +1301,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -1324,7 +1324,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -1347,7 +1347,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -1370,7 +1370,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1400,7 +1400,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1422,7 +1422,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1444,7 +1444,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1466,7 +1466,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1526,7 +1526,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1549,7 +1549,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1572,7 +1572,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1640,7 +1640,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1663,7 +1663,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1686,7 +1686,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1709,7 +1709,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1732,7 +1732,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1755,7 +1755,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1778,7 +1778,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1801,7 +1801,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1824,7 +1824,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1854,7 +1854,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1876,7 +1876,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1898,7 +1898,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1920,7 +1920,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1942,7 +1942,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -2370,15 +2370,15 @@
<p>This page explains how to prepare your environment for running the bot.</p>
<p>The freqtrade documentation describes various ways to install freqtrade</p>
<ul>
<li><a href="../docker_quickstart/">Docker images</a> (separate page)</li>
<li><a href="docker_quickstart.html">Docker images</a> (separate page)</li>
<li><a href="#script-installation">Script Installation</a></li>
<li><a href="#manual-installation">Manual Installation</a></li>
<li><a href="#installation-with-conda">Installation with Conda</a></li>
</ul>
<p>Please consider using the prebuilt <a href="../docker_quickstart/">docker images</a> to get started quickly while evaluating how freqtrade works.</p>
<p>Please consider using the prebuilt <a href="docker_quickstart.html">docker images</a> to get started quickly while evaluating how freqtrade works.</p>
<hr />
<h2 id="information">Information<a class="headerlink" href="#information" title="Permanent link">&para;</a></h2>
<p>For Windows installation, please use the <a href="../windows_installation/">windows installation guide</a>.</p>
<p>For Windows installation, please use the <a href="windows_installation.html">windows installation guide</a>.</p>
<p>The easiest way to install and run Freqtrade is to clone the bot Github repository and then run the <code>./setup.sh</code> script, if it's available for your platform.</p>
<div class="admonition note">
<p class="admonition-title">Version considerations</p>
@@ -2399,7 +2399,7 @@ Also, python headers (<code>python&lt;yourversion&gt;-dev</code> / <code>python&
<p>These requirements apply to both <a href="#script-installation">Script Installation</a> and <a href="#manual-installation">Manual Installation</a>.</p>
<div class="admonition note">
<p class="admonition-title">ARM64 systems</p>
<p>If you are running an ARM64 system (like a MacOS M1 or an Oracle VM), please use <a href="../docker_quickstart/">docker</a> to run freqtrade.
<p>If you are running an ARM64 system (like a MacOS M1 or an Oracle VM), please use <a href="docker_quickstart.html">docker</a> to run freqtrade.
While native installation is possible with some manual effort, this is not supported at the moment.</p>
</div>
<h3 id="install-guide">Install guide<a class="headerlink" href="#install-guide" title="Permanent link">&para;</a></h3>
@@ -2455,7 +2455,7 @@ bash<span class="w"> </span>setup.sh<span class="w"> </span>-i
<div class="admonition note">
<p class="admonition-title">Installation duration</p>
<p>Depending on your internet speed and the Raspberry Pi version, installation can take multiple hours to complete.
Due to this, we recommend to use the pre-build docker-image for Raspberry, by following the <a href="../docker_quickstart/">Docker quickstart documentation</a></p>
Due to this, we recommend to use the pre-build docker-image for Raspberry, by following the <a href="docker_quickstart.html">Docker quickstart documentation</a></p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
@@ -2571,9 +2571,9 @@ python3<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </s
<h3 id="optional-post-installation-tasks">(Optional) Post-installation Tasks<a class="headerlink" href="#optional-post-installation-tasks" title="Permanent link">&para;</a></h3>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If you run the bot on a server, you should consider using <a href="../docker_quickstart/">Docker</a> or a terminal multiplexer like <code>screen</code> or <a href="https://en.wikipedia.org/wiki/Tmux"><code>tmux</code></a> to avoid that the bot is stopped on logout.</p>
<p>If you run the bot on a server, you should consider using <a href="docker_quickstart.html">Docker</a> or a terminal multiplexer like <code>screen</code> or <a href="https://en.wikipedia.org/wiki/Tmux"><code>tmux</code></a> to avoid that the bot is stopped on logout.</p>
</div>
<p>On Linux with software suite <code>systemd</code>, as an optional post-installation task, you may wish to setup the bot to run as a <code>systemd service</code> or configure it to send the log messages to the <code>syslog</code>/<code>rsyslog</code> or <code>journald</code> daemons. See <a href="../advanced-setup/#advanced-logging">Advanced Logging</a> for details.</p>
<p>On Linux with software suite <code>systemd</code>, as an optional post-installation task, you may wish to setup the bot to run as a <code>systemd service</code> or configure it to send the log messages to the <code>syslog</code>/<code>rsyslog</code> or <code>journald</code> daemons. See <a href="advanced-setup.html#advanced-logging">Advanced Logging</a> for details.</p>
<hr />
<h2 id="installation-with-conda">Installation with Conda<a class="headerlink" href="#installation-with-conda" title="Permanent link">&para;</a></h2>
<p>Freqtrade can also be installed with Miniconda or Anaconda. We recommend using Miniconda as it's installation footprint is smaller. Conda will automatically prepare and manage the extensive library-dependencies of the Freqtrade program.</p>
@@ -2666,8 +2666,8 @@ freqtrade<span class="w"> </span>create-userdir<span class="w"> </span>--userdir
<span class="c1"># Step 2 - Create a new configuration file</span>
freqtrade<span class="w"> </span>new-config<span class="w"> </span>--config<span class="w"> </span>user_data/config.json
</code></pre></div>
<p>You are ready to run, read <a href="../configuration/">Bot Configuration</a>, remember to start with <code>dry_run: True</code> and verify that everything is working.</p>
<p>To learn how to setup your configuration, please refer to the <a href="../configuration/">Bot Configuration</a> documentation page.</p>
<p>You are ready to run, read <a href="configuration.html">Bot Configuration</a>, remember to start with <code>dry_run: True</code> and verify that everything is working.</p>
<p>To learn how to setup your configuration, please refer to the <a href="configuration.html">Bot Configuration</a> documentation page.</p>
<h3 id="start-the-bot">Start the Bot<a class="headerlink" href="#start-the-bot" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>trade<span class="w"> </span>--config<span class="w"> </span>user_data/config.json<span class="w"> </span>--strategy<span class="w"> </span>SampleStrategy
</code></pre></div>
@@ -2730,7 +2730,7 @@ For MacOS 10.14, this can be accomplished with the below command.</p>
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../docker_quickstart/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Quickstart with Docker">
<a href="docker_quickstart.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Quickstart with Docker">
<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 11z"/></svg>
@@ -2747,7 +2747,7 @@ For MacOS 10.14, this can be accomplished with the below command.</p>
<a href="../windows_installation/" class="md-footer__link md-footer__link--next" aria-label="Next: Windows">
<a href="windows_installation.html" class="md-footer__link md-footer__link--next" aria-label="Next: Windows">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2795,12 +2795,12 @@ For MacOS 10.14, this can be accomplished with the below command.</p>
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

138
en/develop/leverage/index.html → en/develop/leverage.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/leverage/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/leverage.html">
<link rel="prev" href="../freqai-developers/">
<link rel="prev" href="freqai-developers.html">
<link rel="next" href="../utils/">
<link rel="next" href="utils.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -831,7 +831,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -854,7 +854,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -877,7 +877,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -900,7 +900,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -923,7 +923,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -946,7 +946,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -969,7 +969,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1021,7 +1021,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="leverage.html" class="md-nav__link md-nav__link--active">
@@ -1243,7 +1243,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1265,7 +1265,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1287,7 +1287,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1347,7 +1347,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1370,7 +1370,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1393,7 +1393,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1461,7 +1461,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1484,7 +1484,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1507,7 +1507,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1530,7 +1530,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1553,7 +1553,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1576,7 +1576,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1599,7 +1599,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1622,7 +1622,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1645,7 +1645,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1675,7 +1675,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1697,7 +1697,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1719,7 +1719,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1741,7 +1741,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1763,7 +1763,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -2026,11 +2026,11 @@ We do not assume any responsibility for eventual losses that occur from using th
<p>Please only use advanced trading modes when you know how freqtrade (and your strategy) works.
Also, never risk more than what you can afford to lose.</p>
</div>
<p>If you already have an existing strategy, please read the <a href="../strategy_migration/#strategy-migration-between-v2-and-v3">strategy migration guide</a> to migrate your strategy from a freqtrade v2 strategy, to strategy of version 3 which can short and trade futures.</p>
<p>If you already have an existing strategy, please read the <a href="strategy_migration.html#strategy-migration-between-v2-and-v3">strategy migration guide</a> to migrate your strategy from a freqtrade v2 strategy, to strategy of version 3 which can short and trade futures.</p>
<h2 id="shorting">Shorting<a class="headerlink" href="#shorting" title="Permanent link">&para;</a></h2>
<p>Shorting is not possible when trading with <a href="#leverage-trading-modes"><code>trading_mode</code></a> set to <code>spot</code>. To short trade, <code>trading_mode</code> must be set to <code>margin</code>(currently unavailable) or <a href="#futures"><code>futures</code></a>, with <a href="#margin-mode"><code>margin_mode</code></a> set to <code>cross</code>(currently unavailable) or <a href="#isolated-margin-mode"><code>isolated</code></a></p>
<p>For a strategy to short, the strategy class must set the class variable <code>can_short = True</code></p>
<p>Please read <a href="../strategy-customization/#entry-signal-rules">strategy customization</a> for instructions on how to set signals to enter and exit short trades.</p>
<p>Please read <a href="strategy-customization.html#entry-signal-rules">strategy customization</a> for instructions on how to set signals to enter and exit short trades.</p>
<h2 id="understand-trading_mode">Understand <code>trading_mode</code><a class="headerlink" href="#understand-trading_mode" title="Permanent link">&para;</a></h2>
<p>The possible values are: <code>spot</code> (default), <code>margin</code>(<em>Currently unavailable</em>) or <code>futures</code>.</p>
<h3 id="spot">Spot<a class="headerlink" href="#spot" title="Permanent link">&para;</a></h3>
@@ -2070,10 +2070,10 @@ While freqtrade currently only supports one margin mode, this will change, and b
<p>One account is used to share collateral between markets (trading pairs). Margin is taken from total account balance to avoid liquidation when needed.</p>
<div class="highlight"><pre><span></span><code><span class="nt">&quot;margin_mode&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;cross&quot;</span>
</code></pre></div>
<p>Please read the <a href="../exchanges/">exchange specific notes</a> for exchanges that support this mode and how they differ.</p>
<p>Please read the <a href="exchanges.html">exchange specific notes</a> for exchanges that support this mode and how they differ.</p>
<h2 id="set-leverage-to-use">Set leverage to use<a class="headerlink" href="#set-leverage-to-use" title="Permanent link">&para;</a></h2>
<p>Different strategies and risk profiles will require different levels of leverage.
While you could configure one static leverage value - freqtrade offers you the flexibility to adjust this via <a href="../strategy-callbacks/#leverage-callback">strategy leverage callback</a> - which allows you to use different leverages by pair, or based on some other factor benefitting your strategy result.</p>
While you could configure one static leverage value - freqtrade offers you the flexibility to adjust this via <a href="strategy-callbacks.html#leverage-callback">strategy leverage callback</a> - which allows you to use different leverages by pair, or based on some other factor benefitting your strategy result.</p>
<p>If not implemented, leverage defaults to 1x (no leverage).</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -2095,7 +2095,7 @@ This artificial liquidation price is calculated as:</p>
<p>Currently Freqtrade is able to calculate liquidation prices, but does not calculate liquidation fees. Setting your <code>liquidation_buffer</code> to 0.0, or using a low <code>liquidation_buffer</code> could result in your positions being liquidated. Freqtrade does not track liquidation fees, so liquidations will result in inaccurate profit/loss results for your bot. If you use a low <code>liquidation_buffer</code>, it is recommended to use <code>stoploss_on_exchange</code> if your exchange supports this.</p>
</div>
<h2 id="unavailable-funding-rates">Unavailable funding rates<a class="headerlink" href="#unavailable-funding-rates" title="Permanent link">&para;</a></h2>
<p>For futures data, exchanges commonly provide the futures candles, the marks, and the funding rates. However, it is common that whilst candles and marks might be available, the funding rates are not. This can affect backtesting timeranges, i.e. you may only be able to test recent timeranges and not earlier, experiencing the <code>No data found. Terminating.</code> error. To get around this, add the <code>futures_funding_rate</code> config option as listed in <a href="../configuration/">configuration.md</a>, and it is recommended that you set this to <code>0</code>, unless you know a given specific funding rate for your pair, exchange and timerange. Setting this to anything other than <code>0</code> can have drastic effects on your profit calculations within strategy, e.g. within the <code>custom_exit</code>, <code>custom_stoploss</code>, etc functions.</p>
<p>For futures data, exchanges commonly provide the futures candles, the marks, and the funding rates. However, it is common that whilst candles and marks might be available, the funding rates are not. This can affect backtesting timeranges, i.e. you may only be able to test recent timeranges and not earlier, experiencing the <code>No data found. Terminating.</code> error. To get around this, add the <code>futures_funding_rate</code> config option as listed in <a href="configuration.html">configuration.md</a>, and it is recommended that you set this to <code>0</code>, unless you know a given specific funding rate for your pair, exchange and timerange. Setting this to anything other than <code>0</code> can have drastic effects on your profit calculations within strategy, e.g. within the <code>custom_exit</code>, <code>custom_stoploss</code>, etc functions.</p>
<div class="admonition warning">
<p class="admonition-title">This will mean your backtests are inaccurate.</p>
<p>This will not overwrite funding rates that are available from the exchange, but bear in mind that setting a false funding rate will mean backtesting results will be inaccurate for historical timeranges where funding rates are not available.</p>
@@ -2145,7 +2145,7 @@ This artificial liquidation price is calculated as:</p>
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../freqai-developers/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Developer guide">
<a href="freqai-developers.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Developer guide">
<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 11z"/></svg>
@@ -2162,7 +2162,7 @@ This artificial liquidation price is calculated as:</p>
<a href="../utils/" class="md-footer__link md-footer__link--next" aria-label="Next: Utility Sub-commands">
<a href="utils.html" class="md-footer__link md-footer__link--next" aria-label="Next: Utility Sub-commands">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2210,12 +2210,12 @@ This artificial liquidation price is calculated as:</p>
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

132
en/develop/lookahead-analysis/index.html → en/develop/lookahead-analysis.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/lookahead-analysis/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/lookahead-analysis.html">
<link rel="prev" href="../trade-object/">
<link rel="prev" href="trade-object.html">
<link rel="next" href="../recursive-analysis/">
<link rel="next" href="recursive-analysis.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -831,7 +831,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -854,7 +854,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -877,7 +877,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -900,7 +900,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -923,7 +923,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -946,7 +946,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -969,7 +969,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -999,7 +999,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1021,7 +1021,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1043,7 +1043,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1065,7 +1065,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1125,7 +1125,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1148,7 +1148,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1171,7 +1171,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1241,7 +1241,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1264,7 +1264,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1309,7 +1309,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="lookahead-analysis.html" class="md-nav__link md-nav__link--active">
@@ -1421,7 +1421,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1444,7 +1444,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1467,7 +1467,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1490,7 +1490,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1513,7 +1513,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1536,7 +1536,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1566,7 +1566,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1588,7 +1588,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1610,7 +1610,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1632,7 +1632,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1654,7 +1654,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -1797,11 +1797,11 @@
This means that if your indicators or entry/exit signals look into future candles, this will falsify your backtest.</p>
<p>The <code>lookahead-analysis</code> command requires historic data to be available.
To learn how to get data for the pairs and exchange you're interested in,
head over to the <a href="../data-download/">Data Downloading</a> section of the documentation.
head over to the <a href="data-download.html">Data Downloading</a> section of the documentation.
<code>lookahead-analysis</code> also supports freqai strategies.</p>
<p>This command internally chains backtests and pokes at the strategy to provoke it to show lookahead bias.
This is done by not looking at the strategy code itself, but at changed indicator values and moved entries/exits compared to the full backtest.</p>
<p><code>lookahead-analysis</code> can use the typical options of <a href="../backtesting/">Backtesting</a>, but forces the following options:</p>
<p><code>lookahead-analysis</code> can use the typical options of <a href="backtesting.html">Backtesting</a>, but forces the following options:</p>
<ul>
<li><code>--cache</code> is forced to "none".</li>
<li><code>--max-open-trades</code> is forced to be at least equal to the number of pairs.</li>
@@ -2022,7 +2022,7 @@ will falsely flag FreqAI target indicators defined in <code>set_freqai_targets()
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../trade-object/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Trade Object">
<a href="trade-object.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Trade Object">
<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 11z"/></svg>
@@ -2039,7 +2039,7 @@ will falsely flag FreqAI target indicators defined in <code>set_freqai_targets()
<a href="../recursive-analysis/" class="md-footer__link md-footer__link--next" aria-label="Next: Recursive analysis">
<a href="recursive-analysis.html" class="md-footer__link md-footer__link--next" aria-label="Next: Recursive analysis">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2087,12 +2087,12 @@ will falsely flag FreqAI target indicators defined in <code>set_freqai_targets()
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

136
en/develop/plotting/index.html → en/develop/plotting.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/plotting/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/plotting.html">
<link rel="prev" href="../utils/">
<link rel="prev" href="utils.html">
<link rel="next" href="../exchanges/">
<link rel="next" href="exchanges.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -831,7 +831,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -854,7 +854,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -877,7 +877,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -900,7 +900,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -923,7 +923,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -946,7 +946,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -969,7 +969,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -999,7 +999,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1021,7 +1021,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1065,7 +1065,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="plotting.html" class="md-nav__link md-nav__link--active">
@@ -1173,7 +1173,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1233,7 +1233,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1256,7 +1256,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1279,7 +1279,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1347,7 +1347,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1370,7 +1370,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1393,7 +1393,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1416,7 +1416,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1439,7 +1439,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1462,7 +1462,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1485,7 +1485,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1508,7 +1508,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1531,7 +1531,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1561,7 +1561,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1583,7 +1583,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1605,7 +1605,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1627,7 +1627,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1649,7 +1649,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -1789,7 +1789,7 @@
<p>The commands described in this page (<code>plot-dataframe</code>, <code>plot-profit</code>) should be considered deprecated and are in maintenance mode.
This is mostly for the performance problems even medium sized plots can cause, but also because "store a file and open it in a browser" isn't very intuitive from a UI perspective.</p>
<p>While there are no immediate plans to remove them, they are not actively maintained - and may be removed short-term should major changes be required to keep them working.</p>
<p>Please use <a href="../freq-ui/">FreqUI</a> for plotting needs, which doesn't struggle with the same performance problems.</p>
<p>Please use <a href="freq-ui.html">FreqUI</a> for plotting needs, which doesn't struggle with the same performance problems.</p>
</div>
<h2 id="installation-setup">Installation / Setup<a class="headerlink" href="#installation-setup" title="Permanent link">&para;</a></h2>
<p>Plotting modules use the Plotly library. You can install / upgrade this by running the following command:</p>
@@ -1802,7 +1802,7 @@ This is mostly for the performance problems even medium sized plots can cause, b
<li>Volume bars</li>
<li>Additional indicators as specified by <code>--indicators2</code></li>
</ul>
<p><img alt="plot-dataframe" src="../assets/plot-dataframe.png" /></p>
<p><img alt="plot-dataframe" src="assets/plot-dataframe.png" /></p>
<p>Possible arguments:</p>
<div class="highlight"><pre><span></span><code>usage: freqtrade plot-dataframe [-h] [-v] [--no-color] [--logfile FILE] [-V]
[-c PATH] [-d PATH] [--userdir PATH] [-s NAME]
@@ -1912,7 +1912,7 @@ Use <code>--indicators1</code> for the main plot and <code>--indicators2</code>
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>plot-dataframe<span class="w"> </span>--strategy<span class="w"> </span>AwesomeStrategy<span class="w"> </span>--export-filename<span class="w"> </span>user_data/backtest_results/backtest-result.json<span class="w"> </span>-p<span class="w"> </span>BTC/ETH
</code></pre></div>
<h3 id="plot-dataframe-basics">Plot dataframe basics<a class="headerlink" href="#plot-dataframe-basics" title="Permanent link">&para;</a></h3>
<p><img alt="plot-dataframe2" src="../assets/plot-dataframe2.png" /></p>
<p><img alt="plot-dataframe2" src="assets/plot-dataframe2.png" /></p>
<p>The <code>plot-dataframe</code> subcommand requires backtesting data, a strategy and either a backtesting-results file or a database, containing trades corresponding to the strategy.</p>
<p>The resulting plot will have the following elements:</p>
<ul>
@@ -2039,7 +2039,7 @@ This has the disadvantage that strategy parameters are not available, preventing
<p>If <code>position_adjustment_enable</code> / <code>adjust_trade_position()</code> is used, the trade initial buy price is averaged over multiple orders and the trade start price will most likely appear outside the candle range.</p>
</div>
<h2 id="plot-profit">Plot profit<a class="headerlink" href="#plot-profit" title="Permanent link">&para;</a></h2>
<p><img alt="plot-profit" src="../assets/plot-profit.png" /></p>
<p><img alt="plot-profit" src="assets/plot-profit.png" /></p>
<p>The <code>plot-profit</code> subcommand shows an interactive graph with three plots:</p>
<ul>
<li>Average closing price for all pairs.</li>
@@ -2172,7 +2172,7 @@ Strategy arguments:
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../utils/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Utility Sub-commands">
<a href="utils.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Utility Sub-commands">
<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 11z"/></svg>
@@ -2189,7 +2189,7 @@ Strategy arguments:
<a href="../exchanges/" class="md-footer__link md-footer__link--next" aria-label="Next: Exchange-specific Notes">
<a href="exchanges.html" class="md-footer__link md-footer__link--next" aria-label="Next: Exchange-specific Notes">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2237,12 +2237,12 @@ Strategy arguments:
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

134
en/develop/plugins/index.html → en/develop/plugins.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/plugins/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/plugins.html">
<link rel="prev" href="../stoploss/">
<link rel="prev" href="stoploss.html">
<link rel="next" href="../bot-usage/">
<link rel="next" href="bot-usage.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="plugins.html" class="md-nav__link md-nav__link--active">
@@ -901,7 +901,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -961,7 +961,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -984,7 +984,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -1007,7 +1007,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -1030,7 +1030,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -1060,7 +1060,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -1082,7 +1082,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -1104,7 +1104,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -1164,7 +1164,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -1187,7 +1187,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -1210,7 +1210,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -1233,7 +1233,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -1256,7 +1256,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -1279,7 +1279,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -1302,7 +1302,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1332,7 +1332,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1354,7 +1354,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1376,7 +1376,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1398,7 +1398,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1458,7 +1458,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1481,7 +1481,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1504,7 +1504,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1572,7 +1572,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1595,7 +1595,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1618,7 +1618,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1641,7 +1641,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1664,7 +1664,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1687,7 +1687,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1710,7 +1710,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1733,7 +1733,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1756,7 +1756,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1786,7 +1786,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1808,7 +1808,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1830,7 +1830,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1852,7 +1852,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1874,7 +1874,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -2265,7 +2265,7 @@ You may also use something like <code>.*DOWN/BTC</code> or <code>.*UP/BTC</code>
</ul>
<div class="admonition tip">
<p class="admonition-title">Testing pairlists</p>
<p>Pairlist configurations can be quite tricky to get right. Best use the <a href="../utils/#test-pairlist"><code>test-pairlist</code></a> utility sub-command to test your configuration quickly.</p>
<p>Pairlist configurations can be quite tricky to get right. Best use the <a href="utils.html#test-pairlist"><code>test-pairlist</code></a> utility sub-command to test your configuration quickly.</p>
</div>
<h4 id="static-pair-list">Static Pair List<a class="headerlink" href="#static-pair-list" title="Permanent link">&para;</a></h4>
<p>By default, the <code>StaticPairList</code> method is used, which uses a statically defined pair whitelist from the configuration. The pairlist also supports wildcards (in regex-style) - so <code>.*/BTC</code> will include all pairs with BTC as a stake.</p>
@@ -2446,8 +2446,8 @@ The percentage change is calculated as the change in price over the last 24 hour
<p><code>PercentChangePairList</code> does not support backtesting mode.</p>
</div>
<h4 id="producerpairlist">ProducerPairList<a class="headerlink" href="#producerpairlist" title="Permanent link">&para;</a></h4>
<p>With <code>ProducerPairList</code>, you can reuse the pairlist from a <a href="../producer-consumer/">Producer</a> without explicitly defining the pairlist on each consumer.</p>
<p><a href="../producer-consumer/">Consumer mode</a> is required for this pairlist to work.</p>
<p>With <code>ProducerPairList</code>, you can reuse the pairlist from a <a href="producer-consumer.html">Producer</a> without explicitly defining the pairlist on each consumer.</p>
<p><a href="producer-consumer.html">Consumer mode</a> is required for this pairlist to work.</p>
<p>The pairlist will perform a check on active pairs against the current exchange configuration to avoid attempting to trade on invalid markets.</p>
<p>You can limit the length of the pairlist with the optional parameter <code>number_assets</code>. Using <code>"number_assets"=0</code> or omitting this key will result in the reuse of all producer pairs valid for the current setup.</p>
<div class="highlight"><pre><span></span><code><span class="nt">&quot;pairlists&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
@@ -2974,7 +2974,7 @@ All protections are evaluated in the sequence they are defined.</p>
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../stoploss/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Stoploss">
<a href="stoploss.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Stoploss">
<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 11z"/></svg>
@@ -2991,7 +2991,7 @@ All protections are evaluated in the sequence they are defined.</p>
<a href="../bot-usage/" class="md-footer__link md-footer__link--next" aria-label="Next: Start the bot">
<a href="bot-usage.html" class="md-footer__link md-footer__link--next" aria-label="Next: Start the bot">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -3039,12 +3039,12 @@ All protections are evaluated in the sequence they are defined.</p>
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

132
en/develop/producer-consumer/index.html → en/develop/producer-consumer.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/producer-consumer/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/producer-consumer.html">
<link rel="prev" href="../advanced-orderflow/">
<link rel="prev" href="advanced-orderflow.html">
<link rel="next" href="../sql_cheatsheet/">
<link rel="next" href="sql_cheatsheet.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -831,7 +831,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -854,7 +854,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -877,7 +877,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -900,7 +900,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -923,7 +923,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -946,7 +946,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -969,7 +969,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -999,7 +999,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1021,7 +1021,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1043,7 +1043,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1065,7 +1065,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1125,7 +1125,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1148,7 +1148,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1171,7 +1171,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1241,7 +1241,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1264,7 +1264,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1287,7 +1287,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1310,7 +1310,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1333,7 +1333,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1356,7 +1356,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1379,7 +1379,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1424,7 +1424,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="producer-consumer.html" class="md-nav__link md-nav__link--active">
@@ -1509,7 +1509,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1539,7 +1539,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1561,7 +1561,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1583,7 +1583,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1605,7 +1605,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1627,7 +1627,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -1738,7 +1738,7 @@
<h1 id="producer-consumer-mode">Producer / Consumer mode<a class="headerlink" href="#producer-consumer-mode" title="Permanent link">&para;</a></h1>
<p>freqtrade provides a mechanism whereby an instance (also called <code>consumer</code>) may listen to messages from an upstream freqtrade instance (also called <code>producer</code>) using the message websocket. Mainly, <code>analyzed_df</code> and <code>whitelist</code> messages. This allows the reuse of computed indicators (and signals) for pairs in multiple bots without needing to compute them multiple times.</p>
<p>See <a href="../rest-api/#message-websocket">Message Websocket</a> in the Rest API docs for setting up the <code>api_server</code> configuration for your message websocket (this will be your producer).</p>
<p>See <a href="rest-api.html#message-websocket">Message Websocket</a> in the Rest API docs for setting up the <code>api_server</code> configuration for your message websocket (this will be your producer).</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>We strongly recommend to set <code>ws_token</code> to something random and known only to yourself to avoid unauthorized access to your bot.</p>
@@ -1871,7 +1871,7 @@
</code></pre></div>
<div class="admonition tip">
<p class="admonition-title">FreqAI</p>
<p>You can use this to setup <a href="../freqai/">FreqAI</a> on a powerful machine, while you run consumers on simple machines like raspberries, which can interpret the signals generated from the producer in different ways.</p>
<p>You can use this to setup <a href="freqai.html">FreqAI</a> on a powerful machine, while you run consumers on simple machines like raspberries, which can interpret the signals generated from the producer in different ways.</p>
</div>
<h3 id="example-consumer-strategy">Example - Consumer Strategy<a class="headerlink" href="#example-consumer-strategy" title="Permanent link">&para;</a></h3>
<p>A logically equivalent strategy which calculates no indicators itself, but will have the same analyzed dataframes available to make trading decisions based on the indicators calculated in the producer. In this example the consumer has the same entry criteria, however this is not necessary. The consumer may use different logic to enter/exit trades, and only use the indicators as specified.</p>
@@ -1974,7 +1974,7 @@
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../advanced-orderflow/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Orderflow">
<a href="advanced-orderflow.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Orderflow">
<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 11z"/></svg>
@@ -1991,7 +1991,7 @@
<a href="../sql_cheatsheet/" class="md-footer__link md-footer__link--next" aria-label="Next: SQL Cheat-sheet">
<a href="sql_cheatsheet.html" class="md-footer__link md-footer__link--next" aria-label="Next: SQL Cheat-sheet">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2039,12 +2039,12 @@
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

132
en/develop/recursive-analysis/index.html → en/develop/recursive-analysis.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/recursive-analysis/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/recursive-analysis.html">
<link rel="prev" href="../lookahead-analysis/">
<link rel="prev" href="lookahead-analysis.html">
<link rel="next" href="../strategy-advanced/">
<link rel="next" href="strategy-advanced.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -831,7 +831,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -854,7 +854,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -877,7 +877,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -900,7 +900,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -923,7 +923,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -946,7 +946,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -969,7 +969,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -999,7 +999,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1021,7 +1021,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1043,7 +1043,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1065,7 +1065,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1125,7 +1125,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1148,7 +1148,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1171,7 +1171,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1241,7 +1241,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1264,7 +1264,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1287,7 +1287,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1332,7 +1332,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="recursive-analysis.html" class="md-nav__link md-nav__link--active">
@@ -1426,7 +1426,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1449,7 +1449,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1472,7 +1472,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1495,7 +1495,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1518,7 +1518,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1548,7 +1548,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1570,7 +1570,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1592,7 +1592,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1614,7 +1614,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1636,7 +1636,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -1761,7 +1761,7 @@
<p>For example, to calculate a very basic indicator called <code>steps</code>, the first row's value is always 0, while the following rows' values are equal to the value of the previous row plus 1. If I were to calculate it using the latest 1000 candles, then the <code>steps</code> value of the first row is 0, and the <code>steps</code> value at the last closed candle is 999.</p>
<p>What happens if the calculation is using only the latest 500 candles? Then instead of 999, the <code>steps</code> value at last closed candle is 499. The difference of the value means your backtest result can differ from your dry/live run result.</p>
<p>The <code>recursive-analysis</code> command requires historic data to be available. To learn how to get data for the pairs and exchange you're interested in,
head over to the <a href="../data-download/">Data Downloading</a> section of the documentation.</p>
head over to the <a href="data-download.html">Data Downloading</a> section of the documentation.</p>
<p>This command is built upon preparing different lengths of data and calculates indicators based on them.
This does not backtest the strategy itself, but rather only calculates the indicators. After calculating the indicators of different startup candle values (<code>startup_candle_count</code>) are done, the values of last rows across all specified <code>startup_candle_count</code> are compared to see how much variance they show compared to the base calculation.</p>
<p>Command settings:</p>
@@ -1770,7 +1770,7 @@ This does not backtest the strategy itself, but rather only calculates the indic
<li>It is recommended to set a long timerange (at least 5000 candles) so that the initial indicators' calculation that is going to be used as a benchmark has very small or no recursive issues itself. For example, for a 5m timeframe, a timerange of 5000 candles would be equal to 18 days.</li>
<li><code>--cache</code> is forced to "none" to avoid loading previous indicators calculation automatically.</li>
</ul>
<p>In addition to the recursive formula check, this command also carries out a simple lookahead bias check on the indicator values only. For a full lookahead check, use <a href="../lookahead-analysis/">Lookahead-analysis</a>.</p>
<p>In addition to the recursive formula check, this command also carries out a simple lookahead bias check on the indicator values only. For a full lookahead check, use <a href="lookahead-analysis.html">Lookahead-analysis</a>.</p>
<h2 id="recursive-analysis-command-reference">Recursive-analysis command reference<a class="headerlink" href="#recursive-analysis-command-reference" title="Permanent link">&para;</a></h2>
<div class="highlight"><pre><span></span><code>usage: freqtrade recursive-analysis [-h] [-v] [--no-color] [--logfile FILE]
[-V] [-c PATH] [-d PATH] [--userdir PATH]
@@ -1898,7 +1898,7 @@ Strategy arguments:
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../lookahead-analysis/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Lookahead analysis">
<a href="lookahead-analysis.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Lookahead analysis">
<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 11z"/></svg>
@@ -1915,7 +1915,7 @@ Strategy arguments:
<a href="../strategy-advanced/" class="md-footer__link md-footer__link--next" aria-label="Next: Advanced Strategy">
<a href="strategy-advanced.html" class="md-footer__link md-footer__link--next" aria-label="Next: Advanced Strategy">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -1963,12 +1963,12 @@ Strategy arguments:
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

134
en/develop/rest-api/index.html → en/develop/rest-api.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/rest-api/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/rest-api.html">
<link rel="prev" href="../freq-ui/">
<link rel="prev" href="freq-ui.html">
<link rel="next" href="../webhook-config/">
<link rel="next" href="webhook-config.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -630,7 +630,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -653,7 +653,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -698,7 +698,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="rest-api.html" class="md-nav__link md-nav__link--active">
@@ -891,7 +891,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -921,7 +921,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -943,7 +943,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -965,7 +965,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -1025,7 +1025,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -1048,7 +1048,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -1071,7 +1071,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -1094,7 +1094,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -1117,7 +1117,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -1140,7 +1140,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -1163,7 +1163,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1193,7 +1193,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1215,7 +1215,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1237,7 +1237,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1259,7 +1259,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1319,7 +1319,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1342,7 +1342,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1365,7 +1365,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1433,7 +1433,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1456,7 +1456,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1479,7 +1479,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1502,7 +1502,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1525,7 +1525,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1548,7 +1548,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1571,7 +1571,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1594,7 +1594,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1617,7 +1617,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1647,7 +1647,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1669,7 +1669,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1691,7 +1691,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1713,7 +1713,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1735,7 +1735,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -1954,7 +1954,7 @@
<h1 id="rest-api">REST API<a class="headerlink" href="#rest-api" title="Permanent link">&para;</a></h1>
<h2 id="frequi">FreqUI<a class="headerlink" href="#frequi" title="Permanent link">&para;</a></h2>
<p>FreqUI now has it's own dedicated <a href="../freq-ui/">documentation section</a> - please refer to that section for all information regarding the FreqUI.</p>
<p>FreqUI now has it's own dedicated <a href="freq-ui.html">documentation section</a> - please refer to that section for all information regarding the FreqUI.</p>
<h2 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">&para;</a></h2>
<p>Enable the rest API by adding the api_server section to your configuration and setting <code>api_server.enabled</code> to <code>true</code>.</p>
<p>Sample configuration:</p>
@@ -2480,7 +2480,7 @@ All endpoints in the below table need to be prefixed with the base URL of the AP
<h3 id="message-websocket">Message WebSocket<a class="headerlink" href="#message-websocket" title="Permanent link">&para;</a></h3>
<p>The API Server includes a websocket endpoint for subscribing to RPC messages from the freqtrade Bot.
This can be used to consume real-time data from your bot, such as entry/exit fill messages, whitelist changes, populated indicators for pairs, and more.</p>
<p>This is also used to setup <a href="../producer-consumer/">Producer/Consumer mode</a> in Freqtrade.</p>
<p>This is also used to setup <a href="producer-consumer.html">Producer/Consumer mode</a> in Freqtrade.</p>
<p>Assuming your rest API is set to <code>127.0.0.1</code> on port <code>8080</code>, the endpoint is available at <code>http://localhost:8080/api/v1/message/ws</code>.</p>
<p>To access the websocket endpoint, the <code>ws_token</code> is required as a query parameter in the endpoint URL.</p>
<p>To generate a safe <code>ws_token</code> you can run the following code:</p>
@@ -2599,7 +2599,7 @@ It consists of a list of allowed URL's that are allowed to consume resources fro
}
</code></pre></div>
<p>In the following (pretty common) case, FreqUI is accessible on <code>http://localhost:8080/trade</code> (this is what you see in your navbar when navigating to freqUI).
<img alt="freqUI url" src="../assets/frequi_url.png" /></p>
<img alt="freqUI url" src="assets/frequi_url.png" /></p>
<p>The correct configuration for this case is <code>http://localhost:8080</code> - the main part of the URL including the port.</p>
<div class="highlight"><pre><span></span><code>{
//...
@@ -2655,7 +2655,7 @@ Such a configuration will not take effect, and the cors errors will remain.</p>
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../freq-ui/" class="md-footer__link md-footer__link--prev" aria-label="Previous: freqUI">
<a href="freq-ui.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: freqUI">
<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 11z"/></svg>
@@ -2672,7 +2672,7 @@ Such a configuration will not take effect, and the cors errors will remain.</p>
<a href="../webhook-config/" class="md-footer__link md-footer__link--next" aria-label="Next: Web Hook">
<a href="webhook-config.html" class="md-footer__link md-footer__link--next" aria-label="Next: Web Hook">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2720,12 +2720,12 @@ Such a configuration will not take effect, and the cors errors will remain.</p>
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

2
en/develop/search/search_index.json
View File

File diff suppressed because one or more lines are too long

188
en/develop/sitemap.xml
View File

@@ -1,191 +1,191 @@
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://www.freqtrade.io/en/stable/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/index.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/advanced-backtesting/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/advanced-backtesting.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/advanced-hyperopt/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/advanced-hyperopt.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/advanced-orderflow/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/advanced-orderflow.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/advanced-setup/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/advanced-setup.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/backtesting/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/backtesting.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/bot-basics/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/bot-basics.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/bot-usage/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/bot-usage.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/configuration/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/configuration.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/data-analysis/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/data-analysis.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/data-download/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/data-download.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/deprecated/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/deprecated.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/developer/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/developer.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/docker_quickstart/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/docker_quickstart.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/exchanges/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/exchanges.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/faq/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/faq.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/freq-ui/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/freq-ui.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/freqai-configuration/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/freqai-configuration.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/freqai-developers/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/freqai-developers.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/freqai-feature-engineering/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/freqai-feature-engineering.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/freqai-parameter-table/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/freqai-parameter-table.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/freqai-reinforcement-learning/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/freqai-reinforcement-learning.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/freqai-running/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/freqai-running.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/freqai/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/freqai.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/hyperopt/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/hyperopt.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/installation/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/installation.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/leverage/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/leverage.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/lookahead-analysis/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/lookahead-analysis.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/plotting/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/plotting.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/plugins/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/plugins.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/producer-consumer/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/producer-consumer.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/recursive-analysis/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/recursive-analysis.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/rest-api/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/rest-api.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/sql_cheatsheet/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/sql_cheatsheet.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/stoploss/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/stoploss.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/strategy-101/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/strategy-101.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/strategy-advanced/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/strategy-advanced.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/strategy-callbacks/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/strategy-callbacks.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/strategy-customization/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/strategy-customization.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/strategy_analysis_example/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/strategy_analysis_example.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/strategy_migration/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/strategy_migration.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/telegram-usage/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/telegram-usage.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/trade-object/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/trade-object.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/updating/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/updating.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/utils/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/utils.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/webhook-config/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/webhook-config.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/windows_installation/</loc>
<lastmod>2025-08-01</lastmod>
<loc>https://www.freqtrade.io/en/stable/windows_installation.html</loc>
<lastmod>2025-08-02</lastmod>
</url>
</urlset>

BIN
en/develop/sitemap.xml.gz
View File

Binary file not shown.

130
en/develop/sql_cheatsheet/index.html → en/develop/sql_cheatsheet.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/sql_cheatsheet/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/sql_cheatsheet.html">
<link rel="prev" href="../producer-consumer/">
<link rel="prev" href="producer-consumer.html">
<link rel="next" href="../faq/">
<link rel="next" href="faq.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -831,7 +831,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -854,7 +854,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -877,7 +877,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -900,7 +900,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -923,7 +923,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -946,7 +946,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -969,7 +969,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -999,7 +999,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1021,7 +1021,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1043,7 +1043,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1065,7 +1065,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1125,7 +1125,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1148,7 +1148,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1171,7 +1171,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1241,7 +1241,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1264,7 +1264,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1287,7 +1287,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1310,7 +1310,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1333,7 +1333,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1356,7 +1356,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1379,7 +1379,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1402,7 +1402,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1447,7 +1447,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="sql_cheatsheet.html" class="md-nav__link md-nav__link--active">
@@ -1629,7 +1629,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1651,7 +1651,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1673,7 +1673,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1695,7 +1695,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1717,7 +1717,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -1920,7 +1920,7 @@
<p>This page contains some help if you want to query your sqlite db.</p>
<div class="admonition tip">
<p class="admonition-title">Other Database systems</p>
<p>To use other Database Systems like PostgreSQL or MariaDB, you can use the same queries, but you need to use the respective client for the database system. <a href="../advanced-setup/#use-a-different-database-system">Click here</a> to learn how to setup a different database system with freqtrade.</p>
<p>To use other Database Systems like PostgreSQL or MariaDB, you can use the same queries, but you need to use the respective client for the database system. <a href="advanced-setup.html#use-a-different-database-system">Click here</a> to learn how to setup a different database system with freqtrade.</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@@ -2049,7 +2049,7 @@ It is strongly advised to backup your database file before making any manual cha
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../producer-consumer/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Producer/Consumer mode">
<a href="producer-consumer.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Producer/Consumer mode">
<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 11z"/></svg>
@@ -2066,7 +2066,7 @@ It is strongly advised to backup your database file before making any manual cha
<a href="../faq/" class="md-footer__link md-footer__link--next" aria-label="Next: FAQ">
<a href="faq.html" class="md-footer__link md-footer__link--next" aria-label="Next: FAQ">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2114,12 +2114,12 @@ It is strongly advised to backup your database file before making any manual cha
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

130
en/develop/stoploss/index.html → en/develop/stoploss.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/stoploss/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/stoploss.html">
<link rel="prev" href="../strategy-callbacks/">
<link rel="prev" href="strategy-callbacks.html">
<link rel="next" href="../plugins/">
<link rel="next" href="plugins.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="stoploss.html" class="md-nav__link md-nav__link--active">
@@ -741,7 +741,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -763,7 +763,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -823,7 +823,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -846,7 +846,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -869,7 +869,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -892,7 +892,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -922,7 +922,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -944,7 +944,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -966,7 +966,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -1026,7 +1026,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -1049,7 +1049,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -1072,7 +1072,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -1095,7 +1095,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -1118,7 +1118,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -1141,7 +1141,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -1164,7 +1164,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1194,7 +1194,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1216,7 +1216,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1238,7 +1238,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1260,7 +1260,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1320,7 +1320,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1343,7 +1343,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1366,7 +1366,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1434,7 +1434,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1457,7 +1457,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1480,7 +1480,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1503,7 +1503,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1526,7 +1526,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1549,7 +1549,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1572,7 +1572,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1595,7 +1595,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1618,7 +1618,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1648,7 +1648,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1670,7 +1670,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1692,7 +1692,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1714,7 +1714,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1736,7 +1736,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -2080,7 +2080,7 @@ The below is the default which is used if not changed in strategy or configurati
<li>Trailing stop loss.</li>
<li>Trailing stop loss, custom positive loss.</li>
<li>Trailing stop loss only once the trade has reached a certain offset.</li>
<li><a href="../strategy-callbacks/#custom-stoploss">Custom stoploss function</a></li>
<li><a href="strategy-callbacks.html#custom-stoploss">Custom stoploss function</a></li>
</ol>
<h3 id="static-stop-loss">Static Stop Loss<a class="headerlink" href="#static-stop-loss" title="Permanent link">&para;</a></h3>
<p>This is very simple, you define a stop loss of x (as a ratio of price, i.e. x * 100% of price). This will try to sell the asset once the loss exceeds the defined loss.</p>
@@ -2230,7 +2230,7 @@ If price moves 1% - you've lost 10$ of your own capital - therefore stoploss wil
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../strategy-callbacks/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Strategy Callbacks">
<a href="strategy-callbacks.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Strategy Callbacks">
<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 11z"/></svg>
@@ -2247,7 +2247,7 @@ If price moves 1% - you've lost 10$ of your own capital - therefore stoploss wil
<a href="../plugins/" class="md-footer__link md-footer__link--next" aria-label="Next: Plugins">
<a href="plugins.html" class="md-footer__link md-footer__link--next" aria-label="Next: Plugins">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2295,12 +2295,12 @@ If price moves 1% - you've lost 10$ of your own capital - therefore stoploss wil
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

164
en/develop/strategy-101/index.html → en/develop/strategy-101.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/strategy-101/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/strategy-101.html">
<link rel="prev" href="../configuration/">
<link rel="prev" href="configuration.html">
<link rel="next" href="../strategy-customization/">
<link rel="next" href="strategy-customization.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="strategy-101.html" class="md-nav__link md-nav__link--active">
@@ -666,7 +666,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -688,7 +688,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -710,7 +710,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -732,7 +732,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -754,7 +754,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -814,7 +814,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -837,7 +837,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -860,7 +860,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -883,7 +883,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -913,7 +913,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -935,7 +935,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -957,7 +957,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -1017,7 +1017,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -1040,7 +1040,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -1063,7 +1063,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -1086,7 +1086,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -1109,7 +1109,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -1132,7 +1132,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -1155,7 +1155,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1185,7 +1185,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1207,7 +1207,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1229,7 +1229,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1251,7 +1251,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1311,7 +1311,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1334,7 +1334,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1357,7 +1357,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1425,7 +1425,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1448,7 +1448,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1471,7 +1471,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1494,7 +1494,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1517,7 +1517,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1540,7 +1540,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1563,7 +1563,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1586,7 +1586,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1609,7 +1609,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1639,7 +1639,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1661,7 +1661,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1683,7 +1683,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1705,7 +1705,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1727,7 +1727,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -1940,7 +1940,7 @@
<h1 id="freqtrade-strategies-101-a-quick-start-for-strategy-development">Freqtrade Strategies 101: A Quick Start for Strategy Development<a class="headerlink" href="#freqtrade-strategies-101-a-quick-start-for-strategy-development" title="Permanent link">&para;</a></h1>
<p>For the purposes of this quick start, we are assuming you are familiar with the basics of trading, and have read the
<a href="../bot-basics/">Freqtrade basics</a> page.</p>
<a href="bot-basics.html">Freqtrade basics</a> page.</p>
<h2 id="required-knowledge">Required Knowledge<a class="headerlink" href="#required-knowledge" title="Permanent link">&para;</a></h2>
<p>A strategy in Freqtrade is a Python class that defines the logic for buying and selling cryptocurrency <code>assets</code>.</p>
<p>Assets are defined as <code>pairs</code>, which represent the <code>coin</code> and the <code>stake</code>. The coin is the asset you are trading using another currency as the stake.</p>
@@ -2025,34 +2025,34 @@ how to integrate it into your strategy. You can also check the <a href="https://
<h2 id="making-trades">Making trades<a class="headerlink" href="#making-trades" title="Permanent link">&para;</a></h2>
<p>When a signal is found (a <code>1</code> in an entry or exit column), Freqtrade will attempt to make an order, i.e. a <code>trade</code> or <code>position</code>.</p>
<p>Each new trade position takes up a <code>slot</code>. Slots represent the maximum number of concurrent new trades that can be opened.</p>
<p>The number of slots is defined by the <code>max_open_trades</code> <a href="../configuration/">configuration</a> option.</p>
<p>The number of slots is defined by the <code>max_open_trades</code> <a href="configuration.html">configuration</a> option.</p>
<p>However, there can be a range of scenarios where generating a signal does not always create a trade order. These include:</p>
<ul>
<li>not enough remaining stake to buy an asset, or funds in your wallet to sell an asset (including any fees)</li>
<li>not enough remaining free slots for a new trade to be opened (the number of positions you have open equals the <code>max_open_trades</code> option)</li>
<li>there is already an open trade for a pair (Freqtrade cannot stack positions - however it can <a href="../strategy-callbacks/#adjust-trade-position">adjust existing positions</a>)</li>
<li>if an entry and exit signal is present on the same candle, they are considered as <a href="../strategy-customization/#colliding-signals">colliding</a>, and no order will be raised</li>
<li>the strategy actively rejects the trade order due to logic you specify by using one of the relevant <a href="../strategy-callbacks/#trade-entry-buy-order-confirmation">entry</a> or <a href="../strategy-callbacks/#trade-exit-sell-order-confirmation">exit</a> callbacks</li>
<li>there is already an open trade for a pair (Freqtrade cannot stack positions - however it can <a href="strategy-callbacks.html#adjust-trade-position">adjust existing positions</a>)</li>
<li>if an entry and exit signal is present on the same candle, they are considered as <a href="strategy-customization.html#colliding-signals">colliding</a>, and no order will be raised</li>
<li>the strategy actively rejects the trade order due to logic you specify by using one of the relevant <a href="strategy-callbacks.html#trade-entry-buy-order-confirmation">entry</a> or <a href="strategy-callbacks.html#trade-exit-sell-order-confirmation">exit</a> callbacks</li>
</ul>
<p>Read through the <a href="../strategy-customization/">strategy customization</a> documentation for more details.</p>
<p>Read through the <a href="strategy-customization.html">strategy customization</a> documentation for more details.</p>
<h2 id="backtesting-and-forward-testing">Backtesting and forward testing<a class="headerlink" href="#backtesting-and-forward-testing" title="Permanent link">&para;</a></h2>
<p>Strategy development can be a long and frustrating process, as turning our human "gut instincts" into a working computer-controlled
("algo") strategy is not always straightforward.</p>
<p>Therefore a strategy should be tested to verify that it is going to work as intended.</p>
<p>Freqtrade has two testing modes:</p>
<ul>
<li><strong>backtesting</strong>: using historical data that you <a href="../data-download/">download from an exchange</a>, backtesting is a quick way to assess performance of a strategy. However, it can be very easy to distort results so a strategy will look a lot more profitable than it really is. Check the <a href="../backtesting/">backtesting documentation</a> for more information.</li>
<li><strong>backtesting</strong>: using historical data that you <a href="data-download.html">download from an exchange</a>, backtesting is a quick way to assess performance of a strategy. However, it can be very easy to distort results so a strategy will look a lot more profitable than it really is. Check the <a href="backtesting.html">backtesting documentation</a> for more information.</li>
<li><strong>dry run</strong>: often referred to as <em>forward testing</em>, dry runs use real time data from the exchange. However, any signals that would result in trades are tracked as normal by Freqtrade, but do not have any trades opened on the exchange itself. Forward testing runs in real time, so whilst it takes longer to get results it is a much more reliable indicator of <strong>potential</strong> performance than backtesting.</li>
</ul>
<p>Dry runs are enabled by setting <code>dry_run</code> to true in your <a href="../configuration/#using-dry-run-mode">configuration</a>.</p>
<p>Dry runs are enabled by setting <code>dry_run</code> to true in your <a href="configuration.html#using-dry-run-mode">configuration</a>.</p>
<div class="admonition warning">
<p class="admonition-title">Backtests can be very inaccurate</p>
<p>There are many reasons why backtest results may not match reality. Please check the <a href="../backtesting/#assumptions-made-by-backtesting">backtesting assumptions</a> and <a href="../strategy-customization/#common-mistakes-when-developing-strategies">common strategy mistakes</a> documentation.
<p>There are many reasons why backtest results may not match reality. Please check the <a href="backtesting.html#assumptions-made-by-backtesting">backtesting assumptions</a> and <a href="strategy-customization.html#common-mistakes-when-developing-strategies">common strategy mistakes</a> documentation.
Some websites that list and rank Freqtrade strategies show impressive backtest results. Do not assume these results are achieveable or realistic.</p>
</div>
<details class="hint">
<summary>Useful commands</summary>
<p>Freqtrade includes two useful commands to check for basic flaws in strategies: <a href="../lookahead-analysis/">lookahead-analysis</a> and <a href="../recursive-analysis/">recursive-analysis</a>.</p>
<p>Freqtrade includes two useful commands to check for basic flaws in strategies: <a href="lookahead-analysis.html">lookahead-analysis</a> and <a href="recursive-analysis.html">recursive-analysis</a>.</p>
</details>
<h3 id="assessing-backtesting-and-dry-run-results">Assessing backtesting and dry run results<a class="headerlink" href="#assessing-backtesting-and-dry-run-results" title="Permanent link">&para;</a></h3>
<p>Always dry run your strategy after backtesting it to see if backtesting and dry run results are sufficiently similar.</p>
@@ -2069,17 +2069,17 @@ Some websites that list and rank Freqtrade strategies show impressive backtest r
<h2 id="controlling-or-monitoring-a-running-bot">Controlling or monitoring a running bot<a class="headerlink" href="#controlling-or-monitoring-a-running-bot" title="Permanent link">&para;</a></h2>
<p>Once your bot is running in dry or live mode, Freqtrade has six mechanisms to control or monitor a running bot:</p>
<ul>
<li><strong><a href="../freq-ui/">FreqUI</a></strong>: The easiest to get started with, FreqUI is a web interface to see and control current activity of your bot.</li>
<li><strong><a href="../telegram-usage/">Telegram</a></strong>: On mobile devices, Telegram integration is available to get alerts about your bot activity and to control certain aspects.</li>
<li><strong><a href="freq-ui.html">FreqUI</a></strong>: The easiest to get started with, FreqUI is a web interface to see and control current activity of your bot.</li>
<li><strong><a href="telegram-usage.html">Telegram</a></strong>: On mobile devices, Telegram integration is available to get alerts about your bot activity and to control certain aspects.</li>
<li><strong><a href="https://github.com/freqtrade/ftui">FTUI</a></strong>: FTUI is a terminal (command line) interface to Freqtrade, and allows monitoring of a running bot only.</li>
<li><strong><a href="../rest-api/#consuming-the-api">freqtrade-client</a></strong>: A python implementation of the REST API, making it easy to make requests and consume bot responses from your python apps or the command line.</li>
<li><strong><a href="../rest-api/#available-endpoints">REST API endpoints</a></strong>: The REST API allows programmers to develop their own tools to interact with a Freqtrade bot.</li>
<li><strong><a href="../webhook-config/">Webhooks</a></strong>: Freqtrade can send information to other services, e.g. discord, by webhooks.</li>
<li><strong><a href="rest-api.html#consuming-the-api">freqtrade-client</a></strong>: A python implementation of the REST API, making it easy to make requests and consume bot responses from your python apps or the command line.</li>
<li><strong><a href="rest-api.html#available-endpoints">REST API endpoints</a></strong>: The REST API allows programmers to develop their own tools to interact with a Freqtrade bot.</li>
<li><strong><a href="webhook-config.html">Webhooks</a></strong>: Freqtrade can send information to other services, e.g. discord, by webhooks.</li>
</ul>
<h3 id="logs">Logs<a class="headerlink" href="#logs" title="Permanent link">&para;</a></h3>
<p>Freqtrade generates extensive debugging logs to help you understand what's happening. Please familiarise yourself with the information and error messages you might see in your bot logs.</p>
<p>Logging by default occurs on standard out (the command line). If you want to write out to a file instead, many freqtrade commands, including the <code>trade</code> command, accept the <code>--logfile</code> option to write to a file.</p>
<p>Check the <a href="../faq/#how-do-i-search-the-bot-logs-for-something">FAQ</a> for examples.</p>
<p>Check the <a href="faq.html#how-do-i-search-the-bot-logs-for-something">FAQ</a> for examples.</p>
<h2 id="final-thoughts">Final Thoughts<a class="headerlink" href="#final-thoughts" title="Permanent link">&para;</a></h2>
<p>Algo trading is difficult, and most public strategies are not good performers due to the time and effort to make a strategy work profitably in multiple scenarios.</p>
<p>Therefore, taking public strategies and using backtests as a way to assess performance is often problematic. However, Freqtrade provides useful ways to help you make decisions and do your due diligence.</p>
@@ -2088,8 +2088,8 @@ Some websites that list and rank Freqtrade strategies show impressive backtest r
<p>As always, only invest what you are willing to lose.</p>
<h2 id="conclusion">Conclusion<a class="headerlink" href="#conclusion" title="Permanent link">&para;</a></h2>
<p>Developing a strategy in Freqtrade involves defining entry and exit signals based on technical indicators. By following the structure and methods outlined above, you can create and test your own trading strategies.</p>
<p>Common questions and answers are available on our <a href="../faq/">FAQ</a>.</p>
<p>To continue, refer to the more in-depth <a href="../strategy-customization/">Freqtrade strategy customization documentation</a>.</p>
<p>Common questions and answers are available on our <a href="faq.html">FAQ</a>.</p>
<p>To continue, refer to the more in-depth <a href="strategy-customization.html">Freqtrade strategy customization documentation</a>.</p>
@@ -2128,7 +2128,7 @@ Some websites that list and rank Freqtrade strategies show impressive backtest r
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../configuration/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Configuration">
<a href="configuration.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Configuration">
<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 11z"/></svg>
@@ -2145,7 +2145,7 @@ Some websites that list and rank Freqtrade strategies show impressive backtest r
<a href="../strategy-customization/" class="md-footer__link md-footer__link--next" aria-label="Next: Strategy Customization">
<a href="strategy-customization.html" class="md-footer__link md-footer__link--next" aria-label="Next: Strategy Customization">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2193,12 +2193,12 @@ Some websites that list and rank Freqtrade strategies show impressive backtest r
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

132
en/develop/strategy-advanced/index.html → en/develop/strategy-advanced.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/strategy-advanced/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/strategy-advanced.html">
<link rel="prev" href="../recursive-analysis/">
<link rel="prev" href="recursive-analysis.html">
<link rel="next" href="../advanced-hyperopt/">
<link rel="next" href="advanced-hyperopt.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -831,7 +831,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -854,7 +854,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -877,7 +877,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -900,7 +900,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -923,7 +923,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -946,7 +946,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -969,7 +969,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -999,7 +999,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1021,7 +1021,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1043,7 +1043,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1065,7 +1065,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1125,7 +1125,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1148,7 +1148,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1171,7 +1171,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1241,7 +1241,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1264,7 +1264,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1287,7 +1287,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1310,7 +1310,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1355,7 +1355,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="strategy-advanced.html" class="md-nav__link md-nav__link--active">
@@ -1494,7 +1494,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1517,7 +1517,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1540,7 +1540,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1563,7 +1563,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1593,7 +1593,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1615,7 +1615,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1637,7 +1637,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1659,7 +1659,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1681,7 +1681,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -1846,8 +1846,8 @@
<h1 id="advanced-strategies">Advanced Strategies<a class="headerlink" href="#advanced-strategies" title="Permanent link">&para;</a></h1>
<p>This page explains some advanced concepts available for strategies.
If you're just getting started, please familiarize yourself with the <a href="../bot-basics/">Freqtrade basics</a> and methods described in <a href="../strategy-customization/">Strategy Customization</a> first.</p>
<p>The call sequence of the methods described here is covered under <a href="../bot-basics/#bot-execution-logic">bot execution logic</a>. Those docs are also helpful in deciding which method is most suitable for your customisation needs.</p>
If you're just getting started, please familiarize yourself with the <a href="bot-basics.html">Freqtrade basics</a> and methods described in <a href="strategy-customization.html">Strategy Customization</a> first.</p>
<p>The call sequence of the methods described here is covered under <a href="bot-basics.html#bot-execution-logic">bot execution logic</a>. Those docs are also helpful in deciding which method is most suitable for your customisation needs.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Callback methods should <em>only</em> be implemented if a strategy uses them.</p>
@@ -2187,7 +2187,7 @@ This can have slight performance implications, which are usually only visible du
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../recursive-analysis/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Recursive analysis">
<a href="recursive-analysis.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Recursive analysis">
<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 11z"/></svg>
@@ -2204,7 +2204,7 @@ This can have slight performance implications, which are usually only visible du
<a href="../advanced-hyperopt/" class="md-footer__link md-footer__link--next" aria-label="Next: Advanced Hyperopt">
<a href="advanced-hyperopt.html" class="md-footer__link md-footer__link--next" aria-label="Next: Advanced Hyperopt">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2252,12 +2252,12 @@ This can have slight performance implications, which are usually only visible du
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

152
en/develop/strategy-callbacks/index.html → en/develop/strategy-callbacks.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/strategy-callbacks/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/strategy-callbacks.html">
<link rel="prev" href="../strategy-customization/">
<link rel="prev" href="strategy-customization.html">
<link rel="next" href="../stoploss/">
<link rel="next" href="stoploss.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="strategy-callbacks.html" class="md-nav__link md-nav__link--active">
@@ -1028,7 +1028,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -1050,7 +1050,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -1072,7 +1072,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -1132,7 +1132,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -1155,7 +1155,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -1178,7 +1178,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -1201,7 +1201,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -1231,7 +1231,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -1253,7 +1253,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -1275,7 +1275,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -1335,7 +1335,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -1358,7 +1358,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -1381,7 +1381,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -1404,7 +1404,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -1427,7 +1427,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -1450,7 +1450,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -1473,7 +1473,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1503,7 +1503,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1525,7 +1525,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1547,7 +1547,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1569,7 +1569,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1629,7 +1629,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1652,7 +1652,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1675,7 +1675,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1743,7 +1743,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1766,7 +1766,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1789,7 +1789,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1812,7 +1812,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1835,7 +1835,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1858,7 +1858,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1881,7 +1881,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1904,7 +1904,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1927,7 +1927,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1957,7 +1957,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1979,7 +1979,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -2001,7 +2001,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -2023,7 +2023,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -2045,7 +2045,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -2575,7 +2575,7 @@
<h1 id="strategy-callbacks">Strategy Callbacks<a class="headerlink" href="#strategy-callbacks" title="Permanent link">&para;</a></h1>
<p>While the main strategy functions (<code>populate_indicators()</code>, <code>populate_entry_trend()</code>, <code>populate_exit_trend()</code>) should be used in a vectorized way, and are only called <a href="../bot-basics/#backtesting-hyperopt-execution-logic">once during backtesting</a>, callbacks are called "whenever needed".</p>
<p>While the main strategy functions (<code>populate_indicators()</code>, <code>populate_entry_trend()</code>, <code>populate_exit_trend()</code>) should be used in a vectorized way, and are only called <a href="bot-basics.html#backtesting-hyperopt-execution-logic">once during backtesting</a>, callbacks are called "whenever needed".</p>
<p>As such, you should avoid doing heavy calculations in callbacks to avoid delays during operations.
Depending on the callback used, they may be called when entering / exiting a trade, or throughout the duration of a trade.</p>
<p>Currently available callbacks:</p>
@@ -2597,7 +2597,7 @@ Depending on the callback used, they may be called when entering / exiting a tra
</ul>
<div class="admonition tip">
<p class="admonition-title">Callback calling sequence</p>
<p>You can find the callback calling sequence in <a href="../bot-basics/#bot-execution-logic">bot-basics</a></p>
<p>You can find the callback calling sequence in <a href="bot-basics.html#bot-execution-logic">bot-basics</a></p>
</div>
<h2 id="imports-necessary-for-a-strategy">Imports necessary for a strategy<a class="headerlink" href="#imports-necessary-for-a-strategy" title="Permanent link">&para;</a></h2>
<p>When creating a strategy, you will need to import the necessary modules and classes. The following imports are required for a strategy:</p>
@@ -2650,7 +2650,7 @@ This section aims to compare each different function, helping you to choose the
<li><strong><code>custom_exit()</code></strong> - Custom exit logic that will fully exit a trade immediately, called for every open trade at every bot loop iteration until a trade is closed.
✅ <strong>Use</strong> to specify exit conditions for each individual trade (including any additional adjusted orders using <code>adjust_trade_position()</code>), or if trade data is necessary to make an exit decision, e.g. using profit data to exit.
🚫 <strong>Don't use</strong> when you want to exit using vectorised indicator-based data (use a <code>populate_exit_trend()</code> signal instead), or as a proxy for <code>custom_stoploss()</code>, and be aware that rate-based exits in backtesting can be inaccurate.</li>
<li><strong><code>custom_stoploss()</code></strong> - Custom trailing stoploss, called for every open trade every iteration until a trade is closed. The value returned here is also used for <a href="../stoploss/#stop-loss-on-exchangefreqtrade">stoploss on exchange</a>.<br />
<li><strong><code>custom_stoploss()</code></strong> - Custom trailing stoploss, called for every open trade every iteration until a trade is closed. The value returned here is also used for <a href="stoploss.html#stop-loss-on-exchangefreqtrade">stoploss on exchange</a>.<br />
✅ <strong>Use</strong> to customize the stoploss logic to set a dynamic stoploss based on trade data or other conditions.
🚫 <strong>Don't use</strong> to exit a trade immediately based on a specific condition. Use <code>custom_exit()</code> for that purpose.</li>
<li><strong><code>custom_roi()</code></strong> - Custom ROI, called for every open trade every iteration until a trade is closed.
@@ -2768,7 +2768,7 @@ This can be used to perform calculations which are pair independent (apply to al
<span class="k">if</span> <span class="n">current_profit</span> <span class="o">&lt;</span> <span class="mf">0.0</span> <span class="ow">and</span> <span class="p">(</span><span class="n">current_time</span> <span class="o">-</span> <span class="n">trade</span><span class="o">.</span><span class="n">open_date_utc</span><span class="p">)</span><span class="o">.</span><span class="n">days</span> <span class="o">&gt;=</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">&quot;unclog&quot;</span>
</code></pre></div>
<p>See <a href="../strategy-advanced/#dataframe-access">Dataframe access</a> for more information about dataframe use in strategy callbacks.</p>
<p>See <a href="strategy-advanced.html#dataframe-access">Dataframe access</a> for more information about dataframe use in strategy callbacks.</p>
<h2 id="custom-stoploss">Custom stoploss<a class="headerlink" href="#custom-stoploss" title="Permanent link">&para;</a></h2>
<p>Called for open trade every iteration (roughly every 5 seconds) until a trade is closed.</p>
<p>The usage of the custom stoploss method must be enabled by setting <code>use_custom_stoploss=True</code> on the strategy object.</p>
@@ -2780,8 +2780,8 @@ During backtesting, <code>current_rate</code> (and <code>current_profit</code>)
<p>The absolute value of the return value is used (the sign is ignored), so returning <code>0.05</code> or <code>-0.05</code> have the same result, a stoploss 5% below the current price.
Returning <code>None</code> will be interpreted as "no desire to change", and is the only safe way to return when you'd like to not modify the stoploss.
<code>NaN</code> and <code>inf</code> values are considered invalid and will be ignored (identical to <code>None</code>).</p>
<p>Stoploss on exchange works similar to <code>trailing_stop</code>, and the stoploss on exchange is updated as configured in <code>stoploss_on_exchange_interval</code> (<a href="../stoploss/#stop-loss-on-exchangefreqtrade">More details about stoploss on exchange</a>).</p>
<p>If you're on futures markets, please take note of the <a href="../stoploss/#stoploss-and-leverage">stoploss and leverage</a> section, as the stoploss value returned from <code>custom_stoploss</code> is the risk for this trade - not the relative price movement.</p>
<p>Stoploss on exchange works similar to <code>trailing_stop</code>, and the stoploss on exchange is updated as configured in <code>stoploss_on_exchange_interval</code> (<a href="stoploss.html#stop-loss-on-exchangefreqtrade">More details about stoploss on exchange</a>).</p>
<p>If you're on futures markets, please take note of the <a href="stoploss.html#stoploss-and-leverage">stoploss and leverage</a> section, as the stoploss value returned from <code>custom_stoploss</code> is the risk for this trade - not the relative price movement.</p>
<div class="admonition note">
<p class="admonition-title">Use of dates</p>
<p>All time-based calculations should be done based on <code>current_time</code> - using <code>datetime.now()</code> or <code>datetime.utcnow()</code> is discouraged, as this will break backtesting support.</p>
@@ -2986,7 +2986,7 @@ In this example, we'll trail the highest price with 10% trailing stoploss for <c
<span class="c1"># return maximum stoploss value, keeping current stoploss price unchanged</span>
<span class="k">return</span> <span class="kc">None</span>
</code></pre></div>
<p>See <a href="../strategy-advanced/#dataframe-access">Dataframe access</a> for more information about dataframe use in strategy callbacks.</p>
<p>See <a href="strategy-advanced.html#dataframe-access">Dataframe access</a> for more information about dataframe use in strategy callbacks.</p>
<h3 id="common-helpers-for-stoploss-calculations">Common helpers for stoploss calculations<a class="headerlink" href="#common-helpers-for-stoploss-calculations" title="Permanent link">&para;</a></h3>
<h4 id="stoploss-relative-to-open-price">Stoploss relative to open price<a class="headerlink" href="#stoploss-relative-to-open-price" title="Permanent link">&para;</a></h4>
<p>Stoploss values returned from <code>custom_stoploss()</code> must specify a percentage relative to <code>current_rate</code>, but sometimes you may want to specify a stoploss relative to the <em>entry</em> price instead.
@@ -3014,7 +3014,7 @@ In this example, we'll trail the highest price with 10% trailing stoploss for <c
<span class="k">return</span> <span class="mi">1</span>
</code></pre></div>
<p>Full examples can be found in the <a href="./#custom-stoploss">Custom stoploss</a> section of the Documentation.</p>
<p>Full examples can be found in the <a href="strategy-callbacks.html#custom-stoploss">Custom stoploss</a> section of the Documentation.</p>
</details>
<div class="admonition note">
<p class="admonition-title">Note</p>
@@ -3030,7 +3030,7 @@ is blocked by <code>confirm_trade_exit()</code> method. Warnings can be solved b
<details class="example">
<summary>Returning a stoploss using absolute price from the custom stoploss function</summary>
<p>If we want to trail a stop price at 2xATR below current price we can call <code>stoploss_from_absolute(current_rate + (side * candle["atr"] * 2), current_rate=current_rate, is_short=trade.is_short, leverage=trade.leverage)</code>.
For futures, we need to adjust the direction (up or down), as well as adjust for leverage, since the <a href="./#custom-stoploss"><code>custom_stoploss</code></a> callback returns the <a href="../stoploss/#stoploss-and-leverage">"risk for this trade"</a> - not the relative price movement.</p>
For futures, we need to adjust the direction (up or down), as well as adjust for leverage, since the <a href="strategy-callbacks.html#custom-stoploss"><code>custom_stoploss</code></a> callback returns the <a href="stoploss.html#stoploss-and-leverage">"risk for this trade"</a> - not the relative price movement.</p>
<div class="highlight"><pre><span></span><code><span class="c1"># Default imports</span>
<span class="k">class</span><span class="w"> </span><span class="nc">AwesomeStrategy</span><span class="p">(</span><span class="n">IStrategy</span><span class="p">):</span>
@@ -3161,7 +3161,7 @@ For futures, we need to adjust the direction (up or down), as well as adjust for
</code></pre></div>
<hr />
<h2 id="custom-order-price-rules">Custom order price rules<a class="headerlink" href="#custom-order-price-rules" title="Permanent link">&para;</a></h2>
<p>By default, freqtrade use the orderbook to automatically set an order price(<a href="../configuration/#prices-used-for-orders">Relevant documentation</a>), you also have the option to create custom order prices based on your strategy.</p>
<p>By default, freqtrade use the orderbook to automatically set an order price(<a href="configuration.html#prices-used-for-orders">Relevant documentation</a>), you also have the option to create custom order prices based on your strategy.</p>
<p>You can use this feature by creating a <code>custom_entry_price()</code> function in your strategy file to customize entry prices and <code>custom_exit_price()</code> for exits.</p>
<p>Each of these methods are called right before placing an order on the exchange.</p>
<div class="admonition note">
@@ -3766,8 +3766,8 @@ This is obviously a very basic example.</p>
Use the annotation feature with care.</p>
</div>
<h3 id="plot-annotations-example">Plot annotations example<a class="headerlink" href="#plot-annotations-example" title="Permanent link">&para;</a></h3>
<p><img alt="FreqUI - plot Annotations" src="../assets/freqUI-chart-annotations-dark.png#only-dark" />
<img alt="FreqUI - plot Annotations" src="../assets/freqUI-chart-annotations-light.png#only-light" /></p>
<p><img alt="FreqUI - plot Annotations" src="assets/freqUI-chart-annotations-dark.png#only-dark" />
<img alt="FreqUI - plot Annotations" src="assets/freqUI-chart-annotations-light.png#only-light" /></p>
<details class="info">
<summary>Code used for the plot above</summary>
<p>This is an example code and should be treated as such.</p>
@@ -3845,7 +3845,7 @@ Use the annotation feature with care.</p>
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../strategy-customization/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Strategy Customization">
<a href="strategy-customization.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Strategy Customization">
<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 11z"/></svg>
@@ -3862,7 +3862,7 @@ Use the annotation feature with care.</p>
<a href="../stoploss/" class="md-footer__link md-footer__link--next" aria-label="Next: Stoploss">
<a href="stoploss.html" class="md-footer__link md-footer__link--next" aria-label="Next: Stoploss">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -3910,12 +3910,12 @@ Use the annotation feature with care.</p>
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

160
en/develop/strategy-customization/index.html → en/develop/strategy-customization.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/strategy-customization/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/strategy-customization.html">
<link rel="prev" href="../strategy-101/">
<link rel="prev" href="strategy-101.html">
<link rel="next" href="../strategy-callbacks/">
<link rel="next" href="strategy-callbacks.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="strategy-customization.html" class="md-nav__link md-nav__link--active">
@@ -1057,7 +1057,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -1079,7 +1079,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -1101,7 +1101,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -1123,7 +1123,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -1183,7 +1183,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -1206,7 +1206,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -1229,7 +1229,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -1252,7 +1252,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -1282,7 +1282,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -1304,7 +1304,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -1326,7 +1326,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -1386,7 +1386,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -1409,7 +1409,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -1432,7 +1432,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -1455,7 +1455,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -1478,7 +1478,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -1501,7 +1501,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -1524,7 +1524,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1554,7 +1554,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1576,7 +1576,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1598,7 +1598,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1620,7 +1620,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1680,7 +1680,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1703,7 +1703,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1726,7 +1726,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1794,7 +1794,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1817,7 +1817,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1840,7 +1840,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1863,7 +1863,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1886,7 +1886,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1909,7 +1909,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1932,7 +1932,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1955,7 +1955,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1978,7 +1978,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -2008,7 +2008,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -2030,7 +2030,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -2052,7 +2052,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -2074,7 +2074,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -2096,7 +2096,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -2680,8 +2680,8 @@
<p>This page explains how to customize your strategies, add new indicators and set up trading rules.</p>
<p>If you haven't already, please familiarize yourself with:</p>
<ul>
<li>the <a href="../strategy-101/">Freqtrade strategy 101</a>, which provides a quick start to strategy development</li>
<li>the <a href="../bot-basics/">Freqtrade bot basics</a>, which provides overall info on how the bot operates</li>
<li>the <a href="strategy-101.html">Freqtrade strategy 101</a>, which provides a quick start to strategy development</li>
<li>the <a href="bot-basics.html">Freqtrade bot basics</a>, which provides overall info on how the bot operates</li>
</ul>
<h2 id="develop-your-own-strategy">Develop your own strategy<a class="headerlink" href="#develop-your-own-strategy" title="Permanent link">&para;</a></h2>
<p>The bot includes a default strategy file.</p>
@@ -2746,7 +2746,7 @@ The current version is 3 - which is also the default when it's not set explicitl
<li>live</li>
<li>FreqAI (not covered here)</li>
</ul>
<p>Check the <a href="../configuration/">configuration documentation</a> about how to set the bot to dry or live mode.</p>
<p>Check the <a href="configuration.html">configuration documentation</a> about how to set the bot to dry or live mode.</p>
<p><strong>Always use dry mode when testing as this gives you an idea of how your strategy will work in reality without risking capital.</strong></p>
<h2 id="diving-in-deeper">Diving in deeper<a class="headerlink" href="#diving-in-deeper" title="Permanent link">&para;</a></h2>
<p><strong>For the following section we will use the <a href="https://github.com/freqtrade/freqtrade/blob/develop/freqtrade/templates/sample_strategy.py">user_data/strategies/sample_strategy.py</a>
@@ -2769,7 +2769,7 @@ Some common patterns for this are listed in the <a href="#common-mistakes-when-d
<p>Freqtrade includes two helpful commands to help assess common lookahead (using future data) and
recursive bias (variance in indicator values) issues. Before running a strategy in dry or live more,
you should always use these commands first. Please check the relevant documentation for
<a href="../lookahead-analysis/">lookahead</a> and <a href="../recursive-analysis/">recursive</a> analysis.</p>
<a href="lookahead-analysis.html">lookahead</a> and <a href="recursive-analysis.html">recursive</a> analysis.</p>
</details>
<h3 id="dataframe">Dataframe<a class="headerlink" href="#dataframe" title="Permanent link">&para;</a></h3>
<p>Freqtrade uses <a href="https://pandas.pydata.org/">pandas</a> to store/provide the candlestick (OHLCV) data.
@@ -2879,7 +2879,7 @@ Then uncomment indicators you need.</p>
<p>Some indicators have an unstable startup period in which there isn't enough candle data to calculate any values (NaN), or the calculation is incorrect. This can lead to inconsistencies, since Freqtrade does not know how long this unstable period is and uses whatever indicator values are in the dataframe.</p>
<p>To account for this, the strategy can be assigned the <code>startup_candle_count</code> attribute.</p>
<p>This should be set to the maximum number of candles that the strategy requires to calculate stable indicators. In the case where a user includes higher timeframes with informative pairs, the <code>startup_candle_count</code> does not necessarily change. The value is the maximum period (in candles) that any of the informatives timeframes need to compute stable indicators.</p>
<p>You can use <a href="../recursive-analysis/">recursive-analysis</a> to check and find the correct <code>startup_candle_count</code> to be used. When recursive analysis shows a variance of 0%, then you can be sure that you have enough startup candle data.</p>
<p>You can use <a href="recursive-analysis.html">recursive-analysis</a> to check and find the correct <code>startup_candle_count</code> to be used. When recursive analysis shows a variance of 0%, then you can be sure that you have enough startup candle data.</p>
<p>In this example strategy, this should be set to 400 (<code>startup_candle_count = 400</code>), since the minimum needed history for ema100 calculation to make sure the value is correct is 400 candles.</p>
<div class="highlight"><pre><span></span><code> <span class="n">dataframe</span><span class="p">[</span><span class="s1">&#39;ema100&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">ta</span><span class="o">.</span><span class="n">EMA</span><span class="p">(</span><span class="n">dataframe</span><span class="p">,</span> <span class="n">timeperiod</span><span class="o">=</span><span class="mi">100</span><span class="p">)</span>
</code></pre></div>
@@ -3066,7 +3066,7 @@ The time used will still be from the initial <code>trade.open_date</code> (when
<p>Sample of setting a 10% stoploss:</p>
<div class="highlight"><pre><span></span><code><span class="n">stoploss</span> <span class="o">=</span> <span class="o">-</span><span class="mf">0.10</span>
</code></pre></div>
<p>For the full documentation on stoploss features, look at the dedicated <a href="../stoploss/">stoploss page</a>.</p>
<p>For the full documentation on stoploss features, look at the dedicated <a href="stoploss.html">stoploss page</a>.</p>
<h3 id="timeframe">Timeframe<a class="headerlink" href="#timeframe" title="Permanent link">&para;</a></h3>
<p>This is the periodicity of candles the bot should use in the strategy.</p>
<p>Common values are <code>"1m"</code>, <code>"5m"</code>, <code>"15m"</code>, <code>"1h"</code>, however all values supported by your exchange should work.</p>
@@ -3080,7 +3080,7 @@ The time used will still be from the initial <code>trade.open_date</code> (when
<p>The <code>metadata</code> dict (available for <code>populate_entry_trend</code>, <code>populate_exit_trend</code>, <code>populate_indicators</code>) contains additional information.
Currently this is <code>pair</code>, which can be accessed using <code>metadata['pair']</code>, and will return a pair in the format <code>XRP/BTC</code> (or <code>XRP/BTC:BTC</code> for futures markets).</p>
<p>The metadata dict should not be modified and does not persist information across multiple functions in your strategy.</p>
<p>Instead, please check the <a href="../strategy-advanced/#storing-information-persistent">Storing information</a> section.</p>
<p>Instead, please check the <a href="strategy-advanced.html#storing-information-persistent">Storing information</a> section.</p>
<h2 id="imports-necessary-for-a-strategy">Imports necessary for a strategy<a class="headerlink" href="#imports-necessary-for-a-strategy" title="Permanent link">&para;</a></h2>
<p>When creating a strategy, you will need to import the necessary modules and classes. The following imports are required for a strategy:</p>
<p>By default, we recommend the following imports as a base line for your strategy:
@@ -3177,7 +3177,7 @@ and do not have access to data from other informative pairs. However, all inform
<p class="admonition-title">Note</p>
<p>Do not use the <code>@informative</code> decorator if you need to use data from one informative pair when generating another informative pair. Instead, define informative pairs manually as described <a href="#complete-dataprovider-sample">in the DataProvider section</a>.</p>
</div>
<p>When hyperopting, use of the hyperoptable parameter <code>.value</code> attribute is not supported. Please use the <code>.range</code> attribute. See <a href="../hyperopt/#optimizing-an-indicator-parameter">optimizing an indicator parameter</a> for more information.</p>
<p>When hyperopting, use of the hyperoptable parameter <code>.value</code> attribute is not supported. Please use the <code>.range</code> attribute. See <a href="hyperopt.html#optimizing-an-indicator-parameter">optimizing an indicator parameter</a> for more information.</p>
<details class="info">
<summary>Full documentation</summary>
<div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">informative</span><span class="p">(</span>
@@ -3390,7 +3390,7 @@ It is also not available in <code>populate_entry_trend()</code> and <code>popula
<details class="note">
<summary>Plotting with current_whitelist</summary>
<p>Current whitelist is not supported for <code>plot-dataframe</code>, as this command is usually used by providing an explicit pairlist and would therefore make the return values of this method misleading.
It's also not supported for FreqUI visualization in <a href="../utils/#webserver-mode">webserver mode</a>, as the configuration for webserver mode doesn't require a pairlist to be set.</p>
It's also not supported for FreqUI visualization in <a href="utils.html#webserver-mode">webserver mode</a>, as the configuration for webserver mode doesn't require a pairlist to be set.</p>
</details>
<h3 id="get_pair_dataframepair-timeframe"><em>get_pair_dataframe(pair, timeframe)</em><a class="headerlink" href="#get_pair_dataframepair-timeframe" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><span class="c1"># fetch live / historical candle (OHLCV) data for the first informative pair</span>
@@ -3402,11 +3402,11 @@ It's also not supported for FreqUI visualization in <a href="../utils/#webserver
<p class="admonition-title">Warning about backtesting</p>
<p>In backtesting, <code>dp.get_pair_dataframe()</code> behavior differs depending on where it's called.
Within <code>populate_*()</code> methods, <code>dp.get_pair_dataframe()</code> returns the full timerange. Please make sure to not "look into the future" to avoid surprises when running in dry/live mode.
Within <a href="../strategy-callbacks/">callbacks</a>, you'll get the full timerange up to the current (simulated) candle.</p>
Within <a href="strategy-callbacks.html">callbacks</a>, you'll get the full timerange up to the current (simulated) candle.</p>
</div>
<h3 id="get_analyzed_dataframepair-timeframe"><em>get_analyzed_dataframe(pair, timeframe)</em><a class="headerlink" href="#get_analyzed_dataframepair-timeframe" title="Permanent link">&para;</a></h3>
<p>This method is used by freqtrade internally to determine the last signal.
It can also be used in specific callbacks to get the signal that caused the action (see <a href="../strategy-advanced/">Advanced Strategy Documentation</a> for more details on available callbacks).</p>
It can also be used in specific callbacks to get the signal that caused the action (see <a href="strategy-advanced.html">Advanced Strategy Documentation</a> for more details on available callbacks).</p>
<div class="highlight"><pre><span></span><code><span class="c1"># fetch current dataframe</span>
<span class="n">dataframe</span><span class="p">,</span> <span class="n">last_updated</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">dp</span><span class="o">.</span><span class="n">get_analyzed_dataframe</span><span class="p">(</span><span class="n">pair</span><span class="o">=</span><span class="n">metadata</span><span class="p">[</span><span class="s1">&#39;pair&#39;</span><span class="p">],</span>
<span class="n">timeframe</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">timeframe</span><span class="p">)</span>
@@ -3540,7 +3540,7 @@ Identical notifications will only be sent once per candle, unless the 2<sup>nd</
<p class="admonition-title">Backtesting / Hyperopt</p>
<p>Wallets behaves differently depending on the function from which it is called.
Within <code>populate_*()</code> methods, it'll return the full wallet as configured.
Within <a href="../strategy-callbacks/">callbacks</a>, you'll get the wallet state corresponding to the actual simulated wallet at that point in the simulation process.</p>
Within <a href="strategy-callbacks.html">callbacks</a>, you'll get the wallet state corresponding to the actual simulated wallet at that point in the simulation process.</p>
</div>
<p>Always check if <code>wallets</code> is available to avoid failures during backtesting.</p>
<div class="highlight"><pre><span></span><code><span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">wallets</span><span class="p">:</span>
@@ -3568,7 +3568,7 @@ Within <a href="../strategy-callbacks/">callbacks</a>, you'll get the wallet sta
<span class="c1"># Summarize profit for this pair.</span>
<span class="n">curdayprofit</span> <span class="o">=</span> <span class="nb">sum</span><span class="p">(</span><span class="n">trade</span><span class="o">.</span><span class="n">close_profit</span> <span class="k">for</span> <span class="n">trade</span> <span class="ow">in</span> <span class="n">trades</span><span class="p">)</span>
</code></pre></div>
<p>For a full list of available methods, please consult the <a href="../trade-object/">Trade object</a> documentation.</p>
<p>For a full list of available methods, please consult the <a href="trade-object.html">Trade object</a> documentation.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Trade history is not available in <code>populate_*</code> methods during backtesting or hyperopt, and will result in empty results.</p>
@@ -3636,14 +3636,14 @@ You may also want to print the pair so it's clear what data is currently shown.<
<p>The following list contains some common patterns which should be avoided to prevent frustration:</p>
<ul>
<li>don't use <code>shift(-1)</code> or other negative values. This uses data from the future in backtesting, which is not available in dry or live modes.</li>
<li>don't use <code>.iloc[-1]</code> or any other absolute position in the dataframe within <code>populate_</code> functions, as this will be different between dry-run and backtesting. Absolute <code>iloc</code> indexing is safe to use in callbacks however - see <a href="../strategy-callbacks/">Strategy Callbacks</a>.</li>
<li>don't use <code>.iloc[-1]</code> or any other absolute position in the dataframe within <code>populate_</code> functions, as this will be different between dry-run and backtesting. Absolute <code>iloc</code> indexing is safe to use in callbacks however - see <a href="strategy-callbacks.html">Strategy Callbacks</a>.</li>
<li>don't use functions that use all dataframe or column values, e.g. <code>dataframe['mean_volume'] = dataframe['volume'].mean()</code>. As backtesting uses the full dataframe, at any point in the dataframe, the <code>'mean_volume'</code> series would include data from the future. Use rolling() calculations instead, e.g. <code>dataframe['volume'].rolling(&lt;window&gt;).mean()</code>.</li>
<li>don't use <code>.resample('1h')</code>. This uses the left border of the period interval, so moves data from an hour boundary to the start of the hour. Use <code>.resample('1h', label='right')</code> instead.</li>
<li>don't use <code>.merge()</code> to combine longer timeframes onto shorter ones. Instead, use the <a href="#informative-pairs">informative pair</a> helpers. (A plain merge can implicitly cause a lookahead bias as date refers to open date, not close date).</li>
</ul>
<div class="admonition tip">
<p class="admonition-title">Identifying problems</p>
<p>You should always use the two helper commands <a href="../lookahead-analysis/">lookahead-analysis</a> and <a href="../recursive-analysis/">recursive-analysis</a>, which can each help you figure out problems with your strategy in different ways.
<p>You should always use the two helper commands <a href="lookahead-analysis.html">lookahead-analysis</a> and <a href="recursive-analysis.html">recursive-analysis</a>, which can each help you figure out problems with your strategy in different ways.
Please treat them as what they are - helpers to identify most common problems. A negative result of each does not guarantee that there are none of the above errors included.</p>
</div>
<h3 id="colliding-signals">Colliding signals<a class="headerlink" href="#colliding-signals" title="Permanent link">&para;</a></h3>
@@ -3658,7 +3658,7 @@ Please treat them as what they are - helpers to identify most common problems. A
<p>Feel free to use any of them as inspiration for your own strategies. We're happy to accept Pull Requests containing new strategies to the repository.</p>
<h2 id="next-steps">Next steps<a class="headerlink" href="#next-steps" title="Permanent link">&para;</a></h2>
<p>Now you have a perfect strategy you probably want to backtest it.
Your next step is to learn <a href="../backtesting/">how to use backtesting</a>.</p>
Your next step is to learn <a href="backtesting.html">how to use backtesting</a>.</p>
@@ -3697,7 +3697,7 @@ Your next step is to learn <a href="../backtesting/">how to use backtesting</a>.
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../strategy-101/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Strategy Quickstart">
<a href="strategy-101.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Strategy Quickstart">
<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 11z"/></svg>
@@ -3714,7 +3714,7 @@ Your next step is to learn <a href="../backtesting/">how to use backtesting</a>.
<a href="../strategy-callbacks/" class="md-footer__link md-footer__link--next" aria-label="Next: Strategy Callbacks">
<a href="strategy-callbacks.html" class="md-footer__link md-footer__link--next" aria-label="Next: Strategy Callbacks">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -3762,12 +3762,12 @@ Your next step is to learn <a href="../backtesting/">how to use backtesting</a>.
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

128
en/develop/strategy_analysis_example/index.html → en/develop/strategy_analysis_example.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/strategy_analysis_example/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/strategy_analysis_example.html">
<link rel="prev" href="../data-analysis/">
<link rel="prev" href="data-analysis.html">
<link rel="next" href="../advanced-backtesting/">
<link rel="next" href="advanced-backtesting.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -831,7 +831,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -854,7 +854,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -877,7 +877,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -900,7 +900,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -923,7 +923,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -946,7 +946,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -969,7 +969,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -999,7 +999,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1021,7 +1021,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1043,7 +1043,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1065,7 +1065,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1127,7 +1127,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1172,7 +1172,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="strategy_analysis_example.html" class="md-nav__link md-nav__link--active">
@@ -1347,7 +1347,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1415,7 +1415,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1438,7 +1438,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1461,7 +1461,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1484,7 +1484,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1507,7 +1507,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1530,7 +1530,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1553,7 +1553,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1576,7 +1576,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1599,7 +1599,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1629,7 +1629,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1651,7 +1651,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1673,7 +1673,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1695,7 +1695,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1717,7 +1717,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -2176,7 +2176,7 @@ They will allow you to drill deeper into your results, and perform analysis whic
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../data-analysis/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Jupyter Notebooks">
<a href="data-analysis.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Jupyter Notebooks">
<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 11z"/></svg>
@@ -2193,7 +2193,7 @@ They will allow you to drill deeper into your results, and perform analysis whic
<a href="../advanced-backtesting/" class="md-footer__link md-footer__link--next" aria-label="Next: Backtest analysis">
<a href="advanced-backtesting.html" class="md-footer__link md-footer__link--next" aria-label="Next: Backtest analysis">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2241,12 +2241,12 @@ They will allow you to drill deeper into your results, and perform analysis whic
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

138
en/develop/strategy_migration/index.html → en/develop/strategy_migration.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/strategy_migration/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/strategy_migration.html">
<link rel="prev" href="../faq/">
<link rel="prev" href="faq.html">
<link rel="next" href="../updating/">
<link rel="next" href="updating.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -831,7 +831,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -854,7 +854,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -877,7 +877,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -900,7 +900,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -923,7 +923,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -946,7 +946,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -969,7 +969,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -999,7 +999,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1021,7 +1021,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1043,7 +1043,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1065,7 +1065,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1125,7 +1125,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1148,7 +1148,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1171,7 +1171,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1239,7 +1239,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1262,7 +1262,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1285,7 +1285,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1308,7 +1308,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1331,7 +1331,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1354,7 +1354,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1377,7 +1377,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1400,7 +1400,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1423,7 +1423,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1453,7 +1453,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1497,7 +1497,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="strategy_migration.html" class="md-nav__link md-nav__link--active">
@@ -1773,7 +1773,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1795,7 +1795,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1817,7 +1817,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -2157,7 +2157,7 @@ If you intend on using markets other than spot markets, please migrate your stra
</ul>
</li>
<li><a href="#adjust-trade-position-changes">Renamed <code>trade.nr_of_successful_buys</code> to <code>trade.nr_of_successful_entries</code> (mostly relevant for <code>adjust_trade_position()</code>)</a></li>
<li>Introduced new <a href="../strategy-callbacks/#leverage-callback"><code>leverage</code> callback</a>.</li>
<li>Introduced new <a href="strategy-callbacks.html#leverage-callback"><code>leverage</code> callback</a>.</li>
<li>Informative pairs can now pass a 3<sup>rd</sup> element in the Tuple, defining the candle type.</li>
<li><code>@informative</code> decorator now takes an optional <code>candle_type</code> argument.</li>
<li><a href="#helper-methods">helper methods</a> <code>stoploss_from_open</code> and <code>stoploss_from_absolute</code> now take <code>is_short</code> as additional argument.</li>
@@ -2241,7 +2241,7 @@ If you intend on using markets other than spot markets, please migrate your stra
</span>
<span class="k">return</span> <span class="n">dataframe</span>
</code></pre></div>
<p>Please refer to the <a href="../strategy-customization/#entry-signal-rules">Strategy documentation</a> on how to enter and exit short trades.</p>
<p>Please refer to the <a href="strategy-customization.html#entry-signal-rules">Strategy documentation</a> on how to enter and exit short trades.</p>
<h3 id="populate_sell_trend"><code>populate_sell_trend</code><a class="headerlink" href="#populate_sell_trend" title="Permanent link">&para;</a></h3>
<p>Similar to <code>populate_buy_trend</code>, <code>populate_sell_trend()</code> will be renamed to <code>populate_exit_trend()</code>.
We'll also change the column from <code>'sell'</code> to <code>'exit_long'</code>.</p>
@@ -2268,7 +2268,7 @@ We'll also change the column from <code>'sell'</code> to <code>'exit_long'</code
<span class="hll"> <span class="p">[</span><span class="s1">&#39;exit_long&#39;</span><span class="p">,</span> <span class="s1">&#39;exit_tag&#39;</span><span class="p">]]</span> <span class="o">=</span> <span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="s1">&#39;some_exit_tag&#39;</span><span class="p">)</span>
</span> <span class="k">return</span> <span class="n">dataframe</span>
</code></pre></div>
<p>Please refer to the <a href="../strategy-customization/#exit-signal-rules">Strategy documentation</a> on how to enter and exit short trades.</p>
<p>Please refer to the <a href="strategy-customization.html#exit-signal-rules">Strategy documentation</a> on how to enter and exit short trades.</p>
<h3 id="custom_sell"><code>custom_sell</code><a class="headerlink" href="#custom_sell" title="Permanent link">&para;</a></h3>
<p><code>custom_sell</code> has been renamed to <code>custom_exit</code>.
It's now also being called for every iteration, independent of current profit and <code>exit_profit_only</code> settings.</p>
@@ -2472,7 +2472,7 @@ And two words are joined with <code>_</code>. </p>
<p>Order pricing changed in 2 ways. <code>bid_strategy</code> was renamed to <code>entry_pricing</code> and <code>ask_strategy</code> was renamed to <code>exit_pricing</code>.
The attributes <code>ask_last_balance</code> -&gt; <code>price_last_balance</code> and <code>bid_last_balance</code> -&gt; <code>price_last_balance</code> were renamed as well.
Also, price-side can now be defined as <code>ask</code>, <code>bid</code>, <code>same</code> or <code>other</code>.
Please refer to the <a href="../configuration/#prices-used-for-orders">pricing documentation</a> for more information.</p>
Please refer to the <a href="configuration.html#prices-used-for-orders">pricing documentation</a> for more information.</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="hll"><span class="w"> </span><span class="nt">&quot;bid_strategy&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
</span><span class="hll"><span class="w"> </span><span class="nt">&quot;price_side&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;bid&quot;</span><span class="p">,</span>
@@ -2518,7 +2518,7 @@ Please refer to the <a href="../configuration/#prices-used-for-orders">pricing d
<p>The <code>populate_any_indicators()</code> method has been split into <code>feature_engineering_expand_all()</code>, <code>feature_engineering_expand_basic()</code>, <code>feature_engineering_standard()</code> and<code>set_freqai_targets()</code>.</p>
<p>For each new function, the pair (and timeframe where necessary) will be automatically added to the column.
As such, the definition of features becomes much simpler with the new logic.</p>
<p>For a full explanation of each method, please go to the corresponding <a href="../freqai-feature-engineering/#defining-the-features">freqAI documentation page</a></p>
<p>For a full explanation of each method, please go to the corresponding <a href="freqai-feature-engineering.html#defining-the-features">freqAI documentation page</a></p>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
<span class="normal"> 2</span>
<span class="normal"> 3</span>
@@ -3126,7 +3126,7 @@ As such, the definition of features becomes much simpler with the new logic.</p>
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../faq/" class="md-footer__link md-footer__link--prev" aria-label="Previous: FAQ">
<a href="faq.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: FAQ">
<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 11z"/></svg>
@@ -3143,7 +3143,7 @@ As such, the definition of features becomes much simpler with the new logic.</p>
<a href="../updating/" class="md-footer__link md-footer__link--next" aria-label="Next: Updating Freqtrade">
<a href="updating.html" class="md-footer__link md-footer__link--next" aria-label="Next: Updating Freqtrade">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -3191,12 +3191,12 @@ As such, the definition of features becomes much simpler with the new logic.</p>
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

134
en/develop/telegram-usage/index.html → en/develop/telegram-usage.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/telegram-usage/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/telegram-usage.html">
<link rel="prev" href="../bot-usage/">
<link rel="prev" href="bot-usage.html">
<link rel="next" href="../freq-ui/">
<link rel="next" href="freq-ui.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -652,7 +652,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="telegram-usage.html" class="md-nav__link md-nav__link--active">
@@ -995,7 +995,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -1018,7 +1018,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -1041,7 +1041,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -1071,7 +1071,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -1093,7 +1093,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -1115,7 +1115,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -1175,7 +1175,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -1198,7 +1198,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -1221,7 +1221,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -1244,7 +1244,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -1267,7 +1267,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -1290,7 +1290,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -1313,7 +1313,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1343,7 +1343,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1365,7 +1365,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1387,7 +1387,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1409,7 +1409,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1469,7 +1469,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1492,7 +1492,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1515,7 +1515,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1583,7 +1583,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1606,7 +1606,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1629,7 +1629,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1652,7 +1652,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1675,7 +1675,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1698,7 +1698,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1721,7 +1721,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1744,7 +1744,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1767,7 +1767,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1797,7 +1797,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1819,7 +1819,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1841,7 +1841,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1863,7 +1863,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1885,7 +1885,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -2367,7 +2367,7 @@ Each setting has the following possible values:</p>
Exit messages (<code>exit</code> and <code>exit_fill</code>) can be further controlled at individual exit reasons level, with the specific exit reason as the key. the default for all exit reasons is <code>on</code> - but can be configured via special <code>*</code> key - which will act as a wildcard for all exit reasons that are not explicitly defined.</li>
<li><code>*_fill</code> notifications are off by default and must be explicitly enabled. </li>
<li><code>protection_trigger</code> notifications are sent when a protection triggers and <code>protection_trigger_global</code> notifications trigger when global protections are triggered. </li>
<li><code>strategy_msg</code> - Receive notifications from the strategy, sent via <code>self.dp.send_msg()</code> from the strategy <a href="../strategy-customization/#send-notification">more details</a>. </li>
<li><code>strategy_msg</code> - Receive notifications from the strategy, sent via <code>self.dp.send_msg()</code> from the strategy <a href="strategy-customization.html#send-notification">more details</a>. </li>
<li><code>show_candle</code> - show candle values as part of entry/exit messages. Only possible values are <code>"ohlc"</code> or <code>"off"</code>. </li>
<li><code>balance_dust_level</code> will define what the <code>/balance</code> command takes as "dust" - Currencies with a balance below this will be shown. </li>
<li><code>allow_custom_messages</code> completely disable strategy messages. </li>
@@ -2686,9 +2686,9 @@ This command has an alias in <code>/fx</code> - which has the same capabilities,
</blockquote>
<p>Omitting the pair will open a query asking for the pair to trade (based on the current whitelist).
Trades created through <code>/forcelong</code> will have the buy-tag of <code>force_entry</code>.</p>
<p><img alt="Telegram force-buy screenshot" src="../assets/telegram_forcebuy.png" /></p>
<p><img alt="Telegram force-buy screenshot" src="assets/telegram_forcebuy.png" /></p>
<p>Note that for this to work, <code>force_entry_enable</code> needs to be set to true.</p>
<p><a href="../configuration/#understand-force_entry_enable">More details</a></p>
<p><a href="configuration.html#understand-force_entry_enable">More details</a></p>
<h3 id="performance">/performance<a class="headerlink" href="#performance" title="Permanent link">&para;</a></h3>
<p>Return the performance of each crypto-currency the bot has sold.</p>
<blockquote>
@@ -2823,7 +2823,7 @@ Strategies using <code>market_direction</code> will probably not produce reliabl
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../bot-usage/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Start the bot">
<a href="bot-usage.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Start the bot">
<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 11z"/></svg>
@@ -2840,7 +2840,7 @@ Strategies using <code>market_direction</code> will probably not produce reliabl
<a href="../freq-ui/" class="md-footer__link md-footer__link--next" aria-label="Next: freqUI">
<a href="freq-ui.html" class="md-footer__link md-footer__link--next" aria-label="Next: freqUI">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2888,12 +2888,12 @@ Strategies using <code>market_direction</code> will probably not produce reliabl
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

132
en/develop/trade-object/index.html → en/develop/trade-object.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/trade-object/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/trade-object.html">
<link rel="prev" href="../advanced-setup/">
<link rel="prev" href="advanced-setup.html">
<link rel="next" href="../lookahead-analysis/">
<link rel="next" href="lookahead-analysis.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -831,7 +831,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -854,7 +854,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -877,7 +877,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -900,7 +900,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -923,7 +923,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -946,7 +946,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -969,7 +969,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -999,7 +999,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1021,7 +1021,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1043,7 +1043,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1065,7 +1065,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1125,7 +1125,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1148,7 +1148,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1171,7 +1171,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1241,7 +1241,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1286,7 +1286,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="trade-object.html" class="md-nav__link md-nav__link--active">
@@ -1431,7 +1431,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1454,7 +1454,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1477,7 +1477,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1500,7 +1500,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1523,7 +1523,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1546,7 +1546,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1569,7 +1569,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1599,7 +1599,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1621,7 +1621,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1643,7 +1643,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1665,7 +1665,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1687,7 +1687,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -1860,7 +1860,7 @@
<h2 id="trade">Trade<a class="headerlink" href="#trade" title="Permanent link">&para;</a></h2>
<p>A position freqtrade enters is stored in a <code>Trade</code> object - which is persisted to the database.
It's a core concept of freqtrade - and something you'll come across in many sections of the documentation, which will most likely point you to this location.</p>
<p>It will be passed to the strategy in many <a href="../strategy-callbacks/">strategy callbacks</a>. The object passed to the strategy cannot be modified directly. Indirect modifications may occur based on callback results.</p>
<p>It will be passed to the strategy in many <a href="strategy-callbacks.html">strategy callbacks</a>. The object passed to the strategy cannot be modified directly. Indirect modifications may occur based on callback results.</p>
<h2 id="trade-available-attributes">Trade - Available attributes<a class="headerlink" href="#trade-available-attributes" title="Permanent link">&para;</a></h2>
<p>The following attributes / properties are available for each individual trade - and can be used with <code>trade.&lt;property&gt;</code> (e.g. <code>trade.pair</code>).</p>
<table>
@@ -2000,7 +2000,7 @@ They can be used as <code>Trade.&lt;method&gt;</code> - e.g. <code>open_trades =
<div class="admonition warning">
<p class="admonition-title">Backtesting/hyperopt</p>
<p>Most methods will work in both backtesting / hyperopt and live/dry modes.
During backtesting, it's limited to usage in <a href="../strategy-callbacks/">strategy callbacks</a>. Usage in <code>populate_*()</code> methods is not supported and will result in wrong results.</p>
During backtesting, it's limited to usage in <a href="strategy-callbacks.html">strategy callbacks</a>. Usage in <code>populate_*()</code> methods is not supported and will result in wrong results.</p>
</div>
<h3 id="get_trades_proxy">get_trades_proxy<a class="headerlink" href="#get_trades_proxy" title="Permanent link">&para;</a></h3>
<p>When your strategy needs some information on existing (open or close) trades - it's best to use <code>Trade.get_trades_proxy()</code>.</p>
@@ -2205,7 +2205,7 @@ Most properties here can be None as they are dependent on the exchange response.
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../advanced-setup/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Advanced Post-installation Tasks">
<a href="advanced-setup.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Advanced Post-installation Tasks">
<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 11z"/></svg>
@@ -2222,7 +2222,7 @@ Most properties here can be None as they are dependent on the exchange response.
<a href="../lookahead-analysis/" class="md-footer__link md-footer__link--next" aria-label="Next: Lookahead analysis">
<a href="lookahead-analysis.html" class="md-footer__link md-footer__link--next" aria-label="Next: Lookahead analysis">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2270,12 +2270,12 @@ Most properties here can be None as they are dependent on the exchange response.
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

130
en/develop/updating/index.html → en/develop/updating.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/updating/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/updating.html">
<link rel="prev" href="../strategy_migration/">
<link rel="prev" href="strategy_migration.html">
<link rel="next" href="../deprecated/">
<link rel="next" href="deprecated.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -831,7 +831,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -854,7 +854,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -877,7 +877,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -900,7 +900,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -923,7 +923,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -946,7 +946,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -969,7 +969,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -999,7 +999,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1021,7 +1021,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1043,7 +1043,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1065,7 +1065,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1125,7 +1125,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1148,7 +1148,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1171,7 +1171,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1239,7 +1239,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1262,7 +1262,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1285,7 +1285,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1308,7 +1308,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1331,7 +1331,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1354,7 +1354,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1377,7 +1377,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1400,7 +1400,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1423,7 +1423,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1453,7 +1453,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1475,7 +1475,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1519,7 +1519,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="updating.html" class="md-nav__link md-nav__link--active">
@@ -1603,7 +1603,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1625,7 +1625,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -1770,7 +1770,7 @@ freqtrade<span class="w"> </span>install-ui<span class="w"> </span>
Please refer to the corresponding installation sections (common problems linked below)</p>
<p>Common problems and their solutions:</p>
<ul>
<li><a href="../windows_installation/#install-ta-lib">ta-lib update on windows</a></li>
<li><a href="windows_installation.html#install-ta-lib">ta-lib update on windows</a></li>
</ul>
@@ -1810,7 +1810,7 @@ Please refer to the corresponding installation sections (common problems linked
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../strategy_migration/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Strategy migration">
<a href="strategy_migration.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Strategy migration">
<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 11z"/></svg>
@@ -1827,7 +1827,7 @@ Please refer to the corresponding installation sections (common problems linked
<a href="../deprecated/" class="md-footer__link md-footer__link--next" aria-label="Next: Deprecated Features">
<a href="deprecated.html" class="md-footer__link md-footer__link--next" aria-label="Next: Deprecated Features">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -1875,12 +1875,12 @@ Please refer to the corresponding installation sections (common problems linked
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

142
en/develop/utils/index.html → en/develop/utils.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/utils/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/utils.html">
<link rel="prev" href="../leverage/">
<link rel="prev" href="leverage.html">
<link rel="next" href="../plotting/">
<link rel="next" href="plotting.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -628,7 +628,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -651,7 +651,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -674,7 +674,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -697,7 +697,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -727,7 +727,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -749,7 +749,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -771,7 +771,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -831,7 +831,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -854,7 +854,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -877,7 +877,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -900,7 +900,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -923,7 +923,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -946,7 +946,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -969,7 +969,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -999,7 +999,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1043,7 +1043,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="utils.html" class="md-nav__link md-nav__link--active">
@@ -1376,7 +1376,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1398,7 +1398,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1458,7 +1458,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1481,7 +1481,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1504,7 +1504,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1572,7 +1572,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1595,7 +1595,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1618,7 +1618,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1641,7 +1641,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1664,7 +1664,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1687,7 +1687,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1710,7 +1710,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1733,7 +1733,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1756,7 +1756,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1786,7 +1786,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1808,7 +1808,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1830,7 +1830,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1852,7 +1852,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1874,7 +1874,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -2275,7 +2275,7 @@ options:
</code></pre></div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Only vital questions are asked. Freqtrade offers a lot more configuration possibilities, which are listed in the <a href="../configuration/#configuration-parameters">Configuration documentation</a></p>
<p>Only vital questions are asked. Freqtrade offers a lot more configuration possibilities, which are listed in the <a href="configuration.html#configuration-parameters">Configuration documentation</a></p>
</div>
<h3 id="create-config-examples">Create config examples<a class="headerlink" href="#create-config-examples" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code>$ freqtrade new-config --config user_data/config_binance.json
@@ -2291,8 +2291,8 @@ options:
</code></pre></div>
<h2 id="show-config">Show config<a class="headerlink" href="#show-config" title="Permanent link">&para;</a></h2>
<p>Show configuration file (with sensitive values redacted by default).
Especially useful with <a href="../configuration/#multiple-configuration-files">split configuration files</a> or <a href="../configuration/#environment-variables">environment variables</a>, where this command will show the merged configuration.</p>
<p><img alt="Show config output" src="../assets/show-config-output.png" /></p>
Especially useful with <a href="configuration.html#multiple-configuration-files">split configuration files</a> or <a href="configuration.html#environment-variables">environment variables</a>, where this command will show the merged configuration.</p>
<p><img alt="Show config output" src="assets/show-config-output.png" /></p>
<div class="highlight"><pre><span></span><code>usage: freqtrade show-config [-h] [--userdir PATH] [-c PATH]
[--show-sensitive]
@@ -2669,7 +2669,7 @@ human-readable list with summary:</li>
<div class="highlight"><pre><span></span><code>$ freqtrade list-markets --exchange kraken --all
</code></pre></div>
<h2 id="test-pairlist">Test pairlist<a class="headerlink" href="#test-pairlist" title="Permanent link">&para;</a></h2>
<p>Use the <code>test-pairlist</code> subcommand to test the configuration of <a href="../plugins/#pairlists">dynamic pairlists</a>.</p>
<p>Use the <code>test-pairlist</code> subcommand to test the configuration of <a href="plugins.html#pairlists">dynamic pairlists</a>.</p>
<p>Requires a configuration with specified <code>pairlists</code> attribute.
Can be used to generate static pairlists to be used during backtesting / hyperopt.</p>
<div class="highlight"><pre><span></span><code>usage: freqtrade test-pairlist [-h] [--userdir PATH] [-v] [-c PATH]
@@ -2693,12 +2693,12 @@ options:
--exchange EXCHANGE Exchange name. Only valid if no config is provided.
</code></pre></div>
<h3 id="examples_1">Examples<a class="headerlink" href="#examples_1" title="Permanent link">&para;</a></h3>
<p>Show whitelist when using a <a href="../plugins/#pairlists">dynamic pairlist</a>.</p>
<p>Show whitelist when using a <a href="plugins.html#pairlists">dynamic pairlist</a>.</p>
<div class="highlight"><pre><span></span><code>freqtrade test-pairlist --config config.json --quote USDT BTC
</code></pre></div>
<h2 id="convert-database">Convert database<a class="headerlink" href="#convert-database" title="Permanent link">&para;</a></h2>
<p><code>freqtrade convert-db</code> can be used to convert your database from one system to another (sqlite -&gt; postgres, postgres -&gt; other postgres), migrating all trades, orders and Pairlocks.</p>
<p>Please refer to the <a href="../advanced-setup/#use-a-different-database-system">corresponding documentation</a> to learn about requirements for different database systems.</p>
<p>Please refer to the <a href="advanced-setup.html#use-a-different-database-system">corresponding documentation</a> to learn about requirements for different database systems.</p>
<div class="highlight"><pre><span></span><code>usage: freqtrade convert-db [-h] [--db-url PATH] [--db-url-from PATH]
options:
@@ -2811,7 +2811,7 @@ Common arguments:
</code></pre></div>
<h2 id="detailed-backtest-analysis">Detailed backtest analysis<a class="headerlink" href="#detailed-backtest-analysis" title="Permanent link">&para;</a></h2>
<p>Advanced backtest result analysis.</p>
<p>More details in the <a href="../advanced-backtesting/#analyze-the-buyentry-and-sellexit-tags">Backtesting analysis</a> Section.</p>
<p>More details in the <a href="advanced-backtesting.html#analyze-the-buyentry-and-sellexit-tags">Backtesting analysis</a> Section.</p>
<div class="highlight"><pre><span></span><code>usage: freqtrade backtesting-analysis [-h] [-v] [--no-color] [--logfile FILE]
[-V] [-c PATH] [-d PATH]
[--userdir PATH]
@@ -3143,7 +3143,7 @@ Common arguments:
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../leverage/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Short / Leverage">
<a href="leverage.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Short / Leverage">
<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 11z"/></svg>
@@ -3160,7 +3160,7 @@ Common arguments:
<a href="../plotting/" class="md-footer__link md-footer__link--next" aria-label="Next: Plotting">
<a href="plotting.html" class="md-footer__link md-footer__link--next" aria-label="Next: Plotting">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -3208,12 +3208,12 @@ Common arguments:
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

130
en/develop/webhook-config/index.html → en/develop/webhook-config.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/webhook-config/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/webhook-config.html">
<link rel="prev" href="../rest-api/">
<link rel="prev" href="rest-api.html">
<link rel="next" href="../data-download/">
<link rel="next" href="data-download.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -361,7 +361,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -384,7 +384,7 @@
<li class="md-nav__item">
<a href="../windows_installation/" class="md-nav__link">
<a href="windows_installation.html" class="md-nav__link">
@@ -414,7 +414,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -436,7 +436,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -458,7 +458,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -480,7 +480,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -502,7 +502,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -630,7 +630,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -653,7 +653,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -676,7 +676,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -721,7 +721,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="webhook-config.html" class="md-nav__link md-nav__link--active">
@@ -858,7 +858,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -880,7 +880,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -902,7 +902,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -962,7 +962,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -985,7 +985,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -1008,7 +1008,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -1031,7 +1031,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -1054,7 +1054,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -1077,7 +1077,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -1100,7 +1100,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1130,7 +1130,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1152,7 +1152,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1174,7 +1174,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1196,7 +1196,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1256,7 +1256,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1279,7 +1279,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1302,7 +1302,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1370,7 +1370,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1393,7 +1393,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1416,7 +1416,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1439,7 +1439,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1462,7 +1462,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1485,7 +1485,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1508,7 +1508,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1531,7 +1531,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1554,7 +1554,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1584,7 +1584,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1606,7 +1606,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1628,7 +1628,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1650,7 +1650,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1672,7 +1672,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -2059,7 +2059,7 @@ You can configure this as follows:</p>
To disable either of the two default values (<code>entry_fill</code> / <code>exit_fill</code>), you can assign them an empty array (<code>exit_fill: []</code>).</p>
<p>Available fields correspond to the fields for webhooks and are documented in the corresponding webhook sections.</p>
<p>The notifications will look as follows by default.</p>
<p><img alt="discord-notification" src="../assets/discord_notification.png" /></p>
<p><img alt="discord-notification" src="assets/discord_notification.png" /></p>
<p>Custom messages can be sent from a strategy to Discord endpoints via the dataprovider.send_msg() function. To enable this, set the <code>allow_custom_messages</code> option to <code>true</code>:</p>
<div class="highlight"><pre><span></span><code><span class="w"> </span><span class="nt">&quot;discord&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;enabled&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
@@ -2105,7 +2105,7 @@ To disable either of the two default values (<code>entry_fill</code> / <code>exi
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../rest-api/" class="md-footer__link md-footer__link--prev" aria-label="Previous: REST API">
<a href="rest-api.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: REST API">
<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 11z"/></svg>
@@ -2122,7 +2122,7 @@ To disable either of the two default values (<code>entry_fill</code> / <code>exi
<a href="../data-download/" class="md-footer__link md-footer__link--next" aria-label="Next: Data Downloading">
<a href="data-download.html" class="md-footer__link md-footer__link--next" aria-label="Next: Data Downloading">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -2170,12 +2170,12 @@ To disable either of the two default values (<code>entry_fill</code> / <code>exi
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

136
en/develop/windows_installation/index.html → en/develop/windows_installation.html
View File

@@ -10,16 +10,16 @@
<link rel="canonical" href="https://www.freqtrade.io/en/stable/windows_installation/">
<link rel="canonical" href="https://www.freqtrade.io/en/stable/windows_installation.html">
<link rel="prev" href="../installation/">
<link rel="prev" href="installation.html">
<link rel="next" href="../bot-basics/">
<link rel="next" href="bot-basics.html">
<link rel="icon" href="../images/logo.png">
<link rel="icon" href="images/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
@@ -28,10 +28,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
@@ -50,9 +50,9 @@
<link rel="stylesheet" href="../stylesheets/ft.extra.css">
<link rel="stylesheet" href="stylesheets/ft.extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -108,9 +108,9 @@
<header class="md-header md-header--shadow" 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" data-md-component="logo">
<a href="index.html" title="Freqtrade" class="md-header__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
@@ -250,9 +250,9 @@
<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">
<a href="index.html" title="Freqtrade" class="md-nav__button md-logo" aria-label="Freqtrade" data-md-component="logo">
<img src="../images/logo.png" alt="logo">
<img src="images/logo.png" alt="logo">
</a>
Freqtrade
@@ -279,7 +279,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<a href="index.html" class="md-nav__link">
@@ -301,7 +301,7 @@
<li class="md-nav__item">
<a href="../docker_quickstart/" class="md-nav__link">
<a href="docker_quickstart.html" class="md-nav__link">
@@ -363,7 +363,7 @@
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<a href="installation.html" class="md-nav__link">
@@ -408,7 +408,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<a href="windows_installation.html" class="md-nav__link md-nav__link--active">
@@ -524,7 +524,7 @@
<li class="md-nav__item">
<a href="../bot-basics/" class="md-nav__link">
<a href="bot-basics.html" class="md-nav__link">
@@ -546,7 +546,7 @@
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<a href="configuration.html" class="md-nav__link">
@@ -568,7 +568,7 @@
<li class="md-nav__item">
<a href="../strategy-101/" class="md-nav__link">
<a href="strategy-101.html" class="md-nav__link">
@@ -590,7 +590,7 @@
<li class="md-nav__item">
<a href="../strategy-customization/" class="md-nav__link">
<a href="strategy-customization.html" class="md-nav__link">
@@ -612,7 +612,7 @@
<li class="md-nav__item">
<a href="../strategy-callbacks/" class="md-nav__link">
<a href="strategy-callbacks.html" class="md-nav__link">
@@ -634,7 +634,7 @@
<li class="md-nav__item">
<a href="../stoploss/" class="md-nav__link">
<a href="stoploss.html" class="md-nav__link">
@@ -656,7 +656,7 @@
<li class="md-nav__item">
<a href="../plugins/" class="md-nav__link">
<a href="plugins.html" class="md-nav__link">
@@ -678,7 +678,7 @@
<li class="md-nav__item">
<a href="../bot-usage/" class="md-nav__link">
<a href="bot-usage.html" class="md-nav__link">
@@ -738,7 +738,7 @@
<li class="md-nav__item">
<a href="../telegram-usage/" class="md-nav__link">
<a href="telegram-usage.html" class="md-nav__link">
@@ -761,7 +761,7 @@
<li class="md-nav__item">
<a href="../freq-ui/" class="md-nav__link">
<a href="freq-ui.html" class="md-nav__link">
@@ -784,7 +784,7 @@
<li class="md-nav__item">
<a href="../rest-api/" class="md-nav__link">
<a href="rest-api.html" class="md-nav__link">
@@ -807,7 +807,7 @@
<li class="md-nav__item">
<a href="../webhook-config/" class="md-nav__link">
<a href="webhook-config.html" class="md-nav__link">
@@ -837,7 +837,7 @@
<li class="md-nav__item">
<a href="../data-download/" class="md-nav__link">
<a href="data-download.html" class="md-nav__link">
@@ -859,7 +859,7 @@
<li class="md-nav__item">
<a href="../backtesting/" class="md-nav__link">
<a href="backtesting.html" class="md-nav__link">
@@ -881,7 +881,7 @@
<li class="md-nav__item">
<a href="../hyperopt/" class="md-nav__link">
<a href="hyperopt.html" class="md-nav__link">
@@ -941,7 +941,7 @@
<li class="md-nav__item">
<a href="../freqai/" class="md-nav__link">
<a href="freqai.html" class="md-nav__link">
@@ -964,7 +964,7 @@
<li class="md-nav__item">
<a href="../freqai-configuration/" class="md-nav__link">
<a href="freqai-configuration.html" class="md-nav__link">
@@ -987,7 +987,7 @@
<li class="md-nav__item">
<a href="../freqai-parameter-table/" class="md-nav__link">
<a href="freqai-parameter-table.html" class="md-nav__link">
@@ -1010,7 +1010,7 @@
<li class="md-nav__item">
<a href="../freqai-feature-engineering/" class="md-nav__link">
<a href="freqai-feature-engineering.html" class="md-nav__link">
@@ -1033,7 +1033,7 @@
<li class="md-nav__item">
<a href="../freqai-running/" class="md-nav__link">
<a href="freqai-running.html" class="md-nav__link">
@@ -1056,7 +1056,7 @@
<li class="md-nav__item">
<a href="../freqai-reinforcement-learning/" class="md-nav__link">
<a href="freqai-reinforcement-learning.html" class="md-nav__link">
@@ -1079,7 +1079,7 @@
<li class="md-nav__item">
<a href="../freqai-developers/" class="md-nav__link">
<a href="freqai-developers.html" class="md-nav__link">
@@ -1109,7 +1109,7 @@
<li class="md-nav__item">
<a href="../leverage/" class="md-nav__link">
<a href="leverage.html" class="md-nav__link">
@@ -1131,7 +1131,7 @@
<li class="md-nav__item">
<a href="../utils/" class="md-nav__link">
<a href="utils.html" class="md-nav__link">
@@ -1153,7 +1153,7 @@
<li class="md-nav__item">
<a href="../plotting/" class="md-nav__link">
<a href="plotting.html" class="md-nav__link">
@@ -1175,7 +1175,7 @@
<li class="md-nav__item">
<a href="../exchanges/" class="md-nav__link">
<a href="exchanges.html" class="md-nav__link">
@@ -1235,7 +1235,7 @@
<li class="md-nav__item">
<a href="../data-analysis/" class="md-nav__link">
<a href="data-analysis.html" class="md-nav__link">
@@ -1258,7 +1258,7 @@
<li class="md-nav__item">
<a href="../strategy_analysis_example/" class="md-nav__link">
<a href="strategy_analysis_example.html" class="md-nav__link">
@@ -1281,7 +1281,7 @@
<li class="md-nav__item">
<a href="../advanced-backtesting/" class="md-nav__link">
<a href="advanced-backtesting.html" class="md-nav__link">
@@ -1349,7 +1349,7 @@
<li class="md-nav__item">
<a href="../advanced-setup/" class="md-nav__link">
<a href="advanced-setup.html" class="md-nav__link">
@@ -1372,7 +1372,7 @@
<li class="md-nav__item">
<a href="../trade-object/" class="md-nav__link">
<a href="trade-object.html" class="md-nav__link">
@@ -1395,7 +1395,7 @@
<li class="md-nav__item">
<a href="../lookahead-analysis/" class="md-nav__link">
<a href="lookahead-analysis.html" class="md-nav__link">
@@ -1418,7 +1418,7 @@
<li class="md-nav__item">
<a href="../recursive-analysis/" class="md-nav__link">
<a href="recursive-analysis.html" class="md-nav__link">
@@ -1441,7 +1441,7 @@
<li class="md-nav__item">
<a href="../strategy-advanced/" class="md-nav__link">
<a href="strategy-advanced.html" class="md-nav__link">
@@ -1464,7 +1464,7 @@
<li class="md-nav__item">
<a href="../advanced-hyperopt/" class="md-nav__link">
<a href="advanced-hyperopt.html" class="md-nav__link">
@@ -1487,7 +1487,7 @@
<li class="md-nav__item">
<a href="../advanced-orderflow/" class="md-nav__link">
<a href="advanced-orderflow.html" class="md-nav__link">
@@ -1510,7 +1510,7 @@
<li class="md-nav__item">
<a href="../producer-consumer/" class="md-nav__link">
<a href="producer-consumer.html" class="md-nav__link">
@@ -1533,7 +1533,7 @@
<li class="md-nav__item">
<a href="../sql_cheatsheet/" class="md-nav__link">
<a href="sql_cheatsheet.html" class="md-nav__link">
@@ -1563,7 +1563,7 @@
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<a href="faq.html" class="md-nav__link">
@@ -1585,7 +1585,7 @@
<li class="md-nav__item">
<a href="../strategy_migration/" class="md-nav__link">
<a href="strategy_migration.html" class="md-nav__link">
@@ -1607,7 +1607,7 @@
<li class="md-nav__item">
<a href="../updating/" class="md-nav__link">
<a href="updating.html" class="md-nav__link">
@@ -1629,7 +1629,7 @@
<li class="md-nav__item">
<a href="../deprecated/" class="md-nav__link">
<a href="deprecated.html" class="md-nav__link">
@@ -1651,7 +1651,7 @@
<li class="md-nav__item">
<a href="../developer/" class="md-nav__link">
<a href="developer.html" class="md-nav__link">
@@ -1785,7 +1785,7 @@
<h1 id="windows-installation">Windows installation<a class="headerlink" href="#windows-installation" title="Permanent link">&para;</a></h1>
<p>We <strong>strongly</strong> recommend that Windows users use <a href="../docker_quickstart/">Docker</a> as this will work much easier and smoother (also more secure).</p>
<p>We <strong>strongly</strong> recommend that Windows users use <a href="docker_quickstart.html">Docker</a> as this will work much easier and smoother (also more secure).</p>
<p>If that is not possible, try using the Windows Linux subsystem (WSL) - for which the Ubuntu instructions should work.
Otherwise, please follow the instructions below.</p>
<p>All instructions assume that python 3.11+ is installed and available.</p>
@@ -1809,7 +1809,7 @@ Otherwise, please follow the instructions below.</p>
</div>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>Using the <a href="https://www.anaconda.com/distribution/">Anaconda Distribution</a> under Windows can greatly help with installation problems. Check out the <a href="../installation/#installation-with-conda">Anaconda installation section</a> in the documentation for more information.</p>
<p>Using the <a href="https://www.anaconda.com/distribution/">Anaconda Distribution</a> under Windows can greatly help with installation problems. Check out the <a href="installation.html#installation-with-conda">Anaconda installation section</a> in the documentation for more information.</p>
</div>
<h3 id="install-ta-lib">Install ta-lib<a class="headerlink" href="#install-ta-lib" title="Permanent link">&para;</a></h3>
<p>Install ta-lib according to the <a href="https://github.com/TA-Lib/ta-lib-python#windows">ta-lib documentation</a>.</p>
@@ -1835,8 +1835,8 @@ Commands for the legacy CMD windows console may differ.</p>
<div class="highlight"><pre><span></span><code>error:<span class="w"> </span>Microsoft<span class="w"> </span>Visual<span class="w"> </span>C++<span class="w"> </span><span class="m">14</span>.0<span class="w"> </span>is<span class="w"> </span>required.<span class="w"> </span>Get<span class="w"> </span>it<span class="w"> </span>with<span class="w"> </span><span class="s2">&quot;Microsoft Visual C++ Build Tools&quot;</span>:<span class="w"> </span>http://landinghub.visualstudio.com/visual-cpp-build-tools
</code></pre></div>
<p>Unfortunately, many packages requiring compilation don't provide a pre-built wheel. It is therefore mandatory to have a C/C++ compiler installed and available for your python environment to use.</p>
<p>You can download the Visual C++ build tools from <a href="https://visualstudio.microsoft.com/visual-cpp-build-tools/">here</a> and install "Desktop development with C++" in it's default configuration. Unfortunately, this is a heavy download / dependency so you might want to consider WSL2 or <a href="../docker_quickstart/">docker compose</a> first.</p>
<p><img alt="Windows installation" src="../assets/windows_install.png" /></p>
<p>You can download the Visual C++ build tools from <a href="https://visualstudio.microsoft.com/visual-cpp-build-tools/">here</a> and install "Desktop development with C++" in it's default configuration. Unfortunately, this is a heavy download / dependency so you might want to consider WSL2 or <a href="docker_quickstart.html">docker compose</a> first.</p>
<p><img alt="Windows installation" src="assets/windows_install.png" /></p>
<hr />
@@ -1876,7 +1876,7 @@ Commands for the legacy CMD windows console may differ.</p>
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../installation/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Linux/MacOS/Raspberry">
<a href="installation.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Linux/MacOS/Raspberry">
<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 11z"/></svg>
@@ -1893,7 +1893,7 @@ Commands for the legacy CMD windows console may differ.</p>
<a href="../bot-basics/" class="md-footer__link md-footer__link--next" aria-label="Next: Freqtrade Basics">
<a href="bot-basics.html" class="md-footer__link md-footer__link--next" aria-label="Next: Freqtrade Basics">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
@@ -1941,12 +1941,12 @@ Commands for the legacy CMD windows console may differ.</p>
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "search.share", "content.code.copy", "content.action.edit", "navigation.top", "navigation.footer"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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", "select.version": "Select version"}, "version": {"alias": true, "provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.50899def.min.js"></script>
<script src="assets/javascripts/bundle.50899def.min.js"></script>
<script src="../javascripts/config.js"></script>
<script src="javascripts/config.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>