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

This commit is contained in:
github-actions[bot]
2025-01-07 05:49:17 +00:00
parent d8a9fc38c6
commit e012bea88d
48 changed files with 56681 additions and 244 deletions

View File

@@ -1946,13 +1946,13 @@
<p>Backtesting requires historic data to be available. <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> 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>
<h2 id="backtesting-command-reference">Backtesting command reference<a class="headerlink" href="#backtesting-command-reference" title="Permanent link">&para;</a></h2> <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] [--logfile FILE] [-V] [-c PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade backtesting [-h] [-v] [--no-color] [--logfile FILE] [-V]
[-d PATH] [--userdir PATH] [-s NAME] [-c PATH] [-d PATH] [--userdir PATH] [-s NAME]
[--strategy-path PATH] [--strategy-path PATH]
[--recursive-strategy-search] [--recursive-strategy-search]
[--freqaimodel NAME] [--freqaimodel-path PATH] [--freqaimodel NAME] [--freqaimodel-path PATH]
[-i TIMEFRAME] [--timerange TIMERANGE] [-i TIMEFRAME] [--timerange TIMERANGE]
[--data-format-ohlcv {json,jsongz,hdf5,feather,parquet}] [--data-format-ohlcv {json,jsongz,feather,parquet}]
[--max-open-trades INT] [--max-open-trades INT]
[--stake-amount STAKE_AMOUNT] [--fee FLOAT] [--stake-amount STAKE_AMOUNT] [--fee FLOAT]
[-p PAIRS [PAIRS ...]] [--eps] [-p PAIRS [PAIRS ...]] [--eps]
@@ -1972,7 +1972,7 @@ options:
Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`). Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).
--timerange TIMERANGE --timerange TIMERANGE
Specify what timerange of data to use. Specify what timerange of data to use.
--data-format-ohlcv {json,jsongz,hdf5,feather,parquet} --data-format-ohlcv {json,jsongz,feather,parquet}
Storage format for downloaded candle (OHLCV) data. Storage format for downloaded candle (OHLCV) data.
(default: `feather`). (default: `feather`).
--max-open-trades INT --max-open-trades INT
@@ -2022,6 +2022,8 @@ options:
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile FILE, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more

View File

@@ -1767,13 +1767,13 @@
</div> </div>
<h2 id="bot-commands">Bot commands<a class="headerlink" href="#bot-commands" title="Permanent link">&para;</a></h2> <h2 id="bot-commands">Bot commands<a class="headerlink" href="#bot-commands" title="Permanent link">&para;</a></h2>
<div class="highlight"><pre><span></span><code>usage: freqtrade [-h] [-V] <div class="highlight"><pre><span></span><code>usage: freqtrade [-h] [-V]
{trade,create-userdir,new-config,show-config,new-strategy,download-data,convert-data,convert-trade-data,trades-to-ohlcv,list-data,backtesting,backtesting-show,backtesting-analysis,edge,hyperopt,hyperopt-list,hyperopt-show,list-exchanges,list-markets,list-pairs,list-strategies,list-freqaimodels,list-timeframes,show-trades,test-pairlist,convert-db,install-ui,plot-dataframe,plot-profit,webserver,strategy-updater,lookahead-analysis,recursive-analysis} {trade,create-userdir,new-config,show-config,new-strategy,download-data,convert-data,convert-trade-data,trades-to-ohlcv,list-data,backtesting,backtesting-show,backtesting-analysis,edge,hyperopt,hyperopt-list,hyperopt-show,list-exchanges,list-markets,list-pairs,list-strategies,list-hyperoptloss,list-freqaimodels,list-timeframes,show-trades,test-pairlist,convert-db,install-ui,plot-dataframe,plot-profit,webserver,strategy-updater,lookahead-analysis,recursive-analysis}
... ...
Free, open source crypto trading bot Free, open source crypto trading bot
positional arguments: positional arguments:
{trade,create-userdir,new-config,show-config,new-strategy,download-data,convert-data,convert-trade-data,trades-to-ohlcv,list-data,backtesting,backtesting-show,backtesting-analysis,edge,hyperopt,hyperopt-list,hyperopt-show,list-exchanges,list-markets,list-pairs,list-strategies,list-freqaimodels,list-timeframes,show-trades,test-pairlist,convert-db,install-ui,plot-dataframe,plot-profit,webserver,strategy-updater,lookahead-analysis,recursive-analysis} {trade,create-userdir,new-config,show-config,new-strategy,download-data,convert-data,convert-trade-data,trades-to-ohlcv,list-data,backtesting,backtesting-show,backtesting-analysis,edge,hyperopt,hyperopt-list,hyperopt-show,list-exchanges,list-markets,list-pairs,list-strategies,list-hyperoptloss,list-freqaimodels,list-timeframes,show-trades,test-pairlist,convert-db,install-ui,plot-dataframe,plot-profit,webserver,strategy-updater,lookahead-analysis,recursive-analysis}
trade Trade module. trade Trade module.
create-userdir Create user-data directory. create-userdir Create user-data directory.
new-config Create new config new-config Create new config
@@ -1797,6 +1797,7 @@ positional arguments:
list-markets Print markets on exchange. list-markets Print markets on exchange.
list-pairs Print pairs on exchange. list-pairs Print pairs on exchange.
list-strategies Print available strategies. list-strategies Print available strategies.
list-hyperoptloss Print available hyperopt loss functions.
list-freqaimodels Print available freqAI models. list-freqaimodels Print available freqAI models.
list-timeframes Print available timeframes for the exchange. list-timeframes Print available timeframes for the exchange.
show-trades Show trades. show-trades Show trades.
@@ -1815,12 +1816,14 @@ options:
-V, --version show program&#39;s version number and exit -V, --version show program&#39;s version number and exit
</code></pre></div> </code></pre></div>
<h3 id="bot-trading-commands">Bot trading commands<a class="headerlink" href="#bot-trading-commands" title="Permanent link">&para;</a></h3> <h3 id="bot-trading-commands">Bot trading commands<a class="headerlink" href="#bot-trading-commands" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code>usage: freqtrade trade [-h] [-v] [--logfile FILE] [-V] [-c PATH] [-d PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade trade [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH]
[--userdir PATH] [-s NAME] [--strategy-path PATH] [-d PATH] [--userdir PATH] [-s NAME]
[--strategy-path PATH] [--recursive-strategy-search]
[--freqaimodel NAME] [--freqaimodel-path PATH]
[--db-url PATH] [--sd-notify] [--dry-run] [--db-url PATH] [--sd-notify] [--dry-run]
[--dry-run-wallet DRY_RUN_WALLET] [--dry-run-wallet DRY_RUN_WALLET] [--fee FLOAT]
optional arguments: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--db-url PATH Override trades database URL, this is useful in custom --db-url PATH Override trades database URL, this is useful in custom
deployments (default: `sqlite:///tradesv3.sqlite` for deployments (default: `sqlite:///tradesv3.sqlite` for
@@ -1832,10 +1835,15 @@ optional arguments:
--dry-run-wallet DRY_RUN_WALLET, --starting-balance DRY_RUN_WALLET --dry-run-wallet DRY_RUN_WALLET, --starting-balance DRY_RUN_WALLET
Starting balance, used for backtesting / hyperopt and Starting balance, used for backtesting / hyperopt and
dry-runs. dry-runs.
--fee FLOAT Specify fee ratio. Will be applied twice (on trade
entry and exit).
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--logfile FILE Log to the file specified. Special values are: --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE
Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more
details. details.
-V, --version show program&#39;s version number and exit -V, --version show program&#39;s version number and exit
@@ -1844,7 +1852,7 @@ Common arguments:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH -d PATH, --datadir PATH, --data-dir PATH
Path to directory with historical backtesting data. Path to directory with historical backtesting data.
--userdir PATH, --user-data-dir PATH --userdir PATH, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
@@ -1854,6 +1862,12 @@ Strategy arguments:
Specify strategy class name which will be used by the Specify strategy class name which will be used by the
bot. bot.
--strategy-path PATH Specify additional strategy lookup path. --strategy-path PATH Specify additional strategy lookup path.
--recursive-strategy-search
Recursively search for a strategy in the strategies
folder.
--freqaimodel NAME Specify a custom freqaimodels.
--freqaimodel-path PATH
Specify additional lookup path for freqaimodels.
</code></pre></div> </code></pre></div>
<h3 id="how-to-specify-which-configuration-file-be-used">How to specify which configuration file be used?<a class="headerlink" href="#how-to-specify-which-configuration-file-be-used" title="Permanent link">&para;</a></h3> <h3 id="how-to-specify-which-configuration-file-be-used">How to specify which configuration file be used?<a class="headerlink" href="#how-to-specify-which-configuration-file-be-used" title="Permanent link">&para;</a></h3>
<p>The bot allows you to select which configuration file you want to use by means of <p>The bot allows you to select which configuration file you want to use by means of

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -1960,16 +1960,16 @@ Without provided configuration, <code>--exchange</code> becomes mandatory.</p>
If you are updating existing data after inserting new pairs that you have no data for, use the <code>--new-pairs-days xx</code> parameter. Specified number of days will be downloaded for new pairs while old pairs will be updated with missing data only. </p> If you are updating existing data after inserting new pairs that you have no data for, use the <code>--new-pairs-days xx</code> parameter. Specified number of days will be downloaded for new pairs while old pairs will be updated with missing data only. </p>
</div> </div>
<h3 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">&para;</a></h3> <h3 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code>usage: freqtrade download-data [-h] [-v] [--logfile FILE] [-V] [-c PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade download-data [-h] [-v] [--no-color] [--logfile FILE] [-V]
[-d PATH] [--userdir PATH] [-c PATH] [-d PATH] [--userdir PATH]
[-p PAIRS [PAIRS ...]] [--pairs-file FILE] [-p PAIRS [PAIRS ...]] [--pairs-file FILE]
[--days INT] [--new-pairs-days INT] [--days INT] [--new-pairs-days INT]
[--include-inactive-pairs] [--include-inactive-pairs]
[--timerange TIMERANGE] [--dl-trades] [--timerange TIMERANGE] [--dl-trades]
[--convert] [--exchange EXCHANGE] [--convert] [--exchange EXCHANGE]
[-t TIMEFRAMES [TIMEFRAMES ...]] [--erase] [-t TIMEFRAMES [TIMEFRAMES ...]] [--erase]
[--data-format-ohlcv {json,jsongz,hdf5,feather,parquet}] [--data-format-ohlcv {json,jsongz,feather,parquet}]
[--data-format-trades {json,jsongz,hdf5,feather,parquet}] [--data-format-trades {json,jsongz,feather,parquet}]
[--trading-mode {spot,margin,futures}] [--trading-mode {spot,margin,futures}]
[--prepend] [--prepend]
@@ -1987,9 +1987,7 @@ options:
Also download data from inactive pairs. Also download data from inactive pairs.
--timerange TIMERANGE --timerange TIMERANGE
Specify what timerange of data to use. Specify what timerange of data to use.
--dl-trades Download trades instead of OHLCV data. The bot will --dl-trades Download trades instead of OHLCV data.
resample trades to the desired timeframe as specified
as --timeframes/-t.
--convert Convert downloaded trades to OHLCV data. Only --convert Convert downloaded trades to OHLCV data. Only
applicable in combination with `--dl-trades`. Will be applicable in combination with `--dl-trades`. Will be
automatic for exchanges which don&#39;t have historic automatic for exchanges which don&#39;t have historic
@@ -2001,10 +1999,10 @@ options:
list. Default: `1m 5m`. list. Default: `1m 5m`.
--erase Clean all existing data for the selected --erase Clean all existing data for the selected
exchange/pairs/timeframes. exchange/pairs/timeframes.
--data-format-ohlcv {json,jsongz,hdf5,feather,parquet} --data-format-ohlcv {json,jsongz,feather,parquet}
Storage format for downloaded candle (OHLCV) data. Storage format for downloaded candle (OHLCV) data.
(default: `feather`). (default: `feather`).
--data-format-trades {json,jsongz,hdf5,feather,parquet} --data-format-trades {json,jsongz,feather,parquet}
Storage format for downloaded trades data. (default: Storage format for downloaded trades data. (default:
`feather`). `feather`).
--trading-mode {spot,margin,futures}, --tradingmode {spot,margin,futures} --trading-mode {spot,margin,futures}, --tradingmode {spot,margin,futures}
@@ -2013,6 +2011,8 @@ options:
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile FILE, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more
@@ -2085,15 +2085,14 @@ You can do so by using the <code>--prepend</code> flag, combined with <code>--ti
<li><code>feather</code> - a dataformat based on Apache Arrow</li> <li><code>feather</code> - a dataformat based on Apache Arrow</li>
<li><code>json</code> - plain "text" json files</li> <li><code>json</code> - plain "text" json files</li>
<li><code>jsongz</code> - a gzip-zipped version of json files</li> <li><code>jsongz</code> - a gzip-zipped version of json files</li>
<li><code>hdf5</code> - a high performance datastore (deprecated)</li>
<li><code>parquet</code> - columnar datastore (OHLCV only)</li> <li><code>parquet</code> - columnar datastore (OHLCV only)</li>
</ul> </ul>
<p>By default, both OHLCV data and trades data are stored in the <code>feather</code> format.</p> <p>By default, both OHLCV data and trades data are stored in the <code>feather</code> format.</p>
<p>This can be changed via the <code>--data-format-ohlcv</code> and <code>--data-format-trades</code> command line arguments respectively. <p>This can be changed via the <code>--data-format-ohlcv</code> and <code>--data-format-trades</code> command line arguments respectively.
To persist this change, you should also add the following snippet to your configuration, so you don't have to insert the above arguments each time:</p> To persist this change, you should also add the following snippet to your configuration, so you don't have to insert the above arguments each time:</p>
<div class="highlight"><pre><span></span><code> // ... <div class="highlight"><pre><span></span><code> // ...
&quot;dataformat_ohlcv&quot;: &quot;hdf5&quot;, &quot;dataformat_ohlcv&quot;: &quot;feather&quot;,
&quot;dataformat_trades&quot;: &quot;hdf5&quot;, &quot;dataformat_trades&quot;: &quot;feather&quot;,
// ... // ...
</code></pre></div> </code></pre></div>
<p>If the default data-format has been changed during download, then the keys <code>dataformat_ohlcv</code> and <code>dataformat_trades</code> in the configuration file need to be adjusted to the selected dataformat as well.</p> <p>If the default data-format has been changed during download, then the keys <code>dataformat_ohlcv</code> and <code>dataformat_trades</code> in the configuration file need to be adjusted to the selected dataformat as well.</p>
@@ -2143,11 +2142,6 @@ To persist this change, you should also add the following snippet to your config
<td>27s</td> <td>27s</td>
</tr> </tr>
<tr> <tr>
<td><code>hdf5</code></td>
<td>145Mb</td>
<td>3.9s</td>
</tr>
<tr>
<td><code>parquet</code></td> <td><code>parquet</code></td>
<td>83Mb</td> <td>83Mb</td>
<td>3.8s</td> <td>3.8s</td>
@@ -2181,11 +2175,11 @@ Mixing different stake-currencies is allowed for this file, since it's only used
You can force the usage of this file via <code>--pairs-file pairs.json</code> - however we recommend to use the pairlist from within the configuration, either via <code>exchange.pair_whitelist</code> or <code>pairs</code> setting in the configuration.</p> You can force the usage of this file via <code>--pairs-file pairs.json</code> - however we recommend to use the pairlist from within the configuration, either via <code>exchange.pair_whitelist</code> or <code>pairs</code> setting in the configuration.</p>
</div> </div>
<h2 id="sub-command-convert-data">Sub-command convert data<a class="headerlink" href="#sub-command-convert-data" title="Permanent link">&para;</a></h2> <h2 id="sub-command-convert-data">Sub-command convert data<a class="headerlink" href="#sub-command-convert-data" title="Permanent link">&para;</a></h2>
<div class="highlight"><pre><span></span><code>usage: freqtrade convert-data [-h] [-v] [--logfile FILE] [-V] [-c PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade convert-data [-h] [-v] [--no-color] [--logfile FILE] [-V]
[-d PATH] [--userdir PATH] [-c PATH] [-d PATH] [--userdir PATH]
[-p PAIRS [PAIRS ...]] --format-from [-p PAIRS [PAIRS ...]] --format-from
{json,jsongz,hdf5,feather,parquet} --format-to {json,jsongz,feather,parquet} --format-to
{json,jsongz,hdf5,feather,parquet} [--erase] {json,jsongz,feather,parquet} [--erase]
[--exchange EXCHANGE] [--exchange EXCHANGE]
[-t TIMEFRAMES [TIMEFRAMES ...]] [-t TIMEFRAMES [TIMEFRAMES ...]]
[--trading-mode {spot,margin,futures}] [--trading-mode {spot,margin,futures}]
@@ -2196,9 +2190,9 @@ options:
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...] -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
Limit command to these pairs. Pairs are space- Limit command to these pairs. Pairs are space-
separated. separated.
--format-from {json,jsongz,hdf5,feather,parquet} --format-from {json,jsongz,feather,parquet}
Source format for data conversion. Source format for data conversion.
--format-to {json,jsongz,hdf5,feather,parquet} --format-to {json,jsongz,feather,parquet}
Destination format for data conversion. Destination format for data conversion.
--erase Clean all existing data for the selected --erase Clean all existing data for the selected
exchange/pairs/timeframes. exchange/pairs/timeframes.
@@ -2214,6 +2208,8 @@ options:
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile FILE, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more
@@ -2235,12 +2231,11 @@ It'll also remove original json data files (<code>--erase</code> parameter).</p>
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>convert-data<span class="w"> </span>--format-from<span class="w"> </span>json<span class="w"> </span>--format-to<span class="w"> </span>jsongz<span class="w"> </span>--datadir<span class="w"> </span>~/.freqtrade/data/binance<span class="w"> </span>-t<span class="w"> </span>5m<span class="w"> </span>15m<span class="w"> </span>--erase <div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>convert-data<span class="w"> </span>--format-from<span class="w"> </span>json<span class="w"> </span>--format-to<span class="w"> </span>jsongz<span class="w"> </span>--datadir<span class="w"> </span>~/.freqtrade/data/binance<span class="w"> </span>-t<span class="w"> </span>5m<span class="w"> </span>15m<span class="w"> </span>--erase
</code></pre></div> </code></pre></div>
<h2 id="sub-command-convert-trade-data">Sub-command convert trade data<a class="headerlink" href="#sub-command-convert-trade-data" title="Permanent link">&para;</a></h2> <h2 id="sub-command-convert-trade-data">Sub-command convert trade data<a class="headerlink" href="#sub-command-convert-trade-data" title="Permanent link">&para;</a></h2>
<div class="highlight"><pre><span></span><code>usage: freqtrade convert-trade-data [-h] [-v] [--logfile FILE] [-V] [-c PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade convert-trade-data [-h] [-v] [--no-color] [--logfile FILE]
[-d PATH] [--userdir PATH] [-V] [-c PATH] [-d PATH] [--userdir PATH]
[-p PAIRS [PAIRS ...]] --format-from [-p PAIRS [PAIRS ...]] --format-from
{json,jsongz,hdf5,feather,parquet} {json,jsongz,feather,parquet,kraken_csv}
--format-to --format-to {json,jsongz,feather,parquet}
{json,jsongz,hdf5,feather,parquet}
[--erase] [--exchange EXCHANGE] [--erase] [--exchange EXCHANGE]
options: options:
@@ -2248,9 +2243,9 @@ options:
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...] -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
Limit command to these pairs. Pairs are space- Limit command to these pairs. Pairs are space-
separated. separated.
--format-from {json,jsongz,hdf5,feather,parquet} --format-from {json,jsongz,feather,parquet,kraken_csv}
Source format for data conversion. Source format for data conversion.
--format-to {json,jsongz,hdf5,feather,parquet} --format-to {json,jsongz,feather,parquet}
Destination format for data conversion. Destination format for data conversion.
--erase Clean all existing data for the selected --erase Clean all existing data for the selected
exchange/pairs/timeframes. exchange/pairs/timeframes.
@@ -2258,6 +2253,8 @@ options:
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile FILE, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more
@@ -2281,13 +2278,14 @@ It'll also remove original jsongz data files (<code>--erase</code> parameter).</
<h2 id="sub-command-trades-to-ohlcv">Sub-command trades to ohlcv<a class="headerlink" href="#sub-command-trades-to-ohlcv" title="Permanent link">&para;</a></h2> <h2 id="sub-command-trades-to-ohlcv">Sub-command trades to ohlcv<a class="headerlink" href="#sub-command-trades-to-ohlcv" title="Permanent link">&para;</a></h2>
<p>When you need to use <code>--dl-trades</code> (kraken only) to download data, conversion of trades data to ohlcv data is the last step. <p>When you need to use <code>--dl-trades</code> (kraken only) to download data, conversion of trades data to ohlcv data is the last step.
This command will allow you to repeat this last step for additional timeframes without re-downloading the data.</p> This command will allow you to repeat this last step for additional timeframes without re-downloading the data.</p>
<div class="highlight"><pre><span></span><code>usage: freqtrade trades-to-ohlcv [-h] [-v] [--logfile FILE] [-V] [-c PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade trades-to-ohlcv [-h] [-v] [--no-color] [--logfile FILE] [-V]
[-d PATH] [--userdir PATH] [-c PATH] [-d PATH] [--userdir PATH]
[-p PAIRS [PAIRS ...]] [-p PAIRS [PAIRS ...]]
[-t TIMEFRAMES [TIMEFRAMES ...]] [-t TIMEFRAMES [TIMEFRAMES ...]]
[--exchange EXCHANGE] [--exchange EXCHANGE]
[--data-format-ohlcv {json,jsongz,hdf5,feather,parquet}] [--data-format-ohlcv {json,jsongz,feather,parquet}]
[--data-format-trades {json,jsongz,hdf5,feather}] [--data-format-trades {json,jsongz,feather,parquet}]
[--trading-mode {spot,margin,futures}]
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
@@ -2298,15 +2296,19 @@ options:
Specify which tickers to download. Space-separated Specify which tickers to download. Space-separated
list. Default: `1m 5m`. list. Default: `1m 5m`.
--exchange EXCHANGE Exchange name. Only valid if no config is provided. --exchange EXCHANGE Exchange name. Only valid if no config is provided.
--data-format-ohlcv {json,jsongz,hdf5,feather,parquet} --data-format-ohlcv {json,jsongz,feather,parquet}
Storage format for downloaded candle (OHLCV) data. Storage format for downloaded candle (OHLCV) data.
(default: `feather`). (default: `feather`).
--data-format-trades {json,jsongz,hdf5,feather} --data-format-trades {json,jsongz,feather,parquet}
Storage format for downloaded trades data. (default: Storage format for downloaded trades data. (default:
`feather`). `feather`).
--trading-mode {spot,margin,futures}, --tradingmode {spot,margin,futures}
Select Trading mode
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile FILE, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more
@@ -2327,10 +2329,11 @@ Common arguments:
</code></pre></div> </code></pre></div>
<h2 id="sub-command-list-data">Sub-command list-data<a class="headerlink" href="#sub-command-list-data" title="Permanent link">&para;</a></h2> <h2 id="sub-command-list-data">Sub-command list-data<a class="headerlink" href="#sub-command-list-data" title="Permanent link">&para;</a></h2>
<p>You can get a list of downloaded data using the <code>list-data</code> sub-command.</p> <p>You can get a list of downloaded data using the <code>list-data</code> sub-command.</p>
<div class="highlight"><pre><span></span><code>usage: freqtrade list-data [-h] [-v] [--logfile FILE] [-V] [-c PATH] [-d PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade list-data [-h] [-v] [--no-color] [--logfile FILE] [-V]
[--userdir PATH] [--exchange EXCHANGE] [-c PATH] [-d PATH] [--userdir PATH]
[--data-format-ohlcv {json,jsongz,hdf5,feather,parquet}] [--exchange EXCHANGE]
[--data-format-trades {json,jsongz,hdf5,feather,parquet}] [--data-format-ohlcv {json,jsongz,feather,parquet}]
[--data-format-trades {json,jsongz,feather,parquet}]
[--trades] [-p PAIRS [PAIRS ...]] [--trades] [-p PAIRS [PAIRS ...]]
[--trading-mode {spot,margin,futures}] [--trading-mode {spot,margin,futures}]
[--show-timerange] [--show-timerange]
@@ -2338,10 +2341,10 @@ Common arguments:
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--exchange EXCHANGE Exchange name. Only valid if no config is provided. --exchange EXCHANGE Exchange name. Only valid if no config is provided.
--data-format-ohlcv {json,jsongz,hdf5,feather,parquet} --data-format-ohlcv {json,jsongz,feather,parquet}
Storage format for downloaded candle (OHLCV) data. Storage format for downloaded candle (OHLCV) data.
(default: `feather`). (default: `feather`).
--data-format-trades {json,jsongz,hdf5,feather,parquet} --data-format-trades {json,jsongz,feather,parquet}
Storage format for downloaded trades data. (default: Storage format for downloaded trades data. (default:
`feather`). `feather`).
--trades Work on trades data instead of OHLCV data. --trades Work on trades data instead of OHLCV data.
@@ -2355,6 +2358,8 @@ options:
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile FILE, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more

View File

@@ -1928,8 +1928,8 @@ We will keep a compatibility layer for 1-2 versions (so both <code>buy_tag</code
<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> <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> <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> <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 will be removed in 2025.1. We recommend switching to the feather data format.</p> <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.</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>

View File

@@ -2031,23 +2031,25 @@ We calculate the risk reward ratio as follows:<br>
<li><strong>Trade 4</strong> The strategy detects a new buy signal int the <strong>XLM/ETH</strong> market. <code>Edge Positioning</code> calculates the stoploss of <span class="arithmatex">\(2\%\)</span>, and the position size of <span class="arithmatex">\(0.055 / 0.02 = 2.75\)</span> <strong>ETH</strong>.</li> <li><strong>Trade 4</strong> The strategy detects a new buy signal int the <strong>XLM/ETH</strong> market. <code>Edge Positioning</code> calculates the stoploss of <span class="arithmatex">\(2\%\)</span>, and the position size of <span class="arithmatex">\(0.055 / 0.02 = 2.75\)</span> <strong>ETH</strong>.</li>
</ul> </ul>
<h2 id="edge-command-reference">Edge command reference<a class="headerlink" href="#edge-command-reference" title="Permanent link">&para;</a></h2> <h2 id="edge-command-reference">Edge command reference<a class="headerlink" href="#edge-command-reference" title="Permanent link">&para;</a></h2>
<div class="highlight"><pre><span></span><code>usage: freqtrade edge [-h] [-v] [--logfile FILE] [-V] [-c PATH] [-d PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade edge [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH]
[--userdir PATH] [-s NAME] [--strategy-path PATH] [-d PATH] [--userdir PATH] [-s NAME]
[--strategy-path PATH] [--recursive-strategy-search]
[--freqaimodel NAME] [--freqaimodel-path PATH]
[-i TIMEFRAME] [--timerange TIMERANGE] [-i TIMEFRAME] [--timerange TIMERANGE]
[--data-format-ohlcv {json,jsongz,hdf5}] [--data-format-ohlcv {json,jsongz,feather,parquet}]
[--max-open-trades INT] [--stake-amount STAKE_AMOUNT] [--max-open-trades INT] [--stake-amount STAKE_AMOUNT]
[--fee FLOAT] [-p PAIRS [PAIRS ...]] [--fee FLOAT] [-p PAIRS [PAIRS ...]]
[--stoplosses STOPLOSS_RANGE] [--stoplosses STOPLOSS_RANGE]
optional arguments: options:
-h, --help show this help message and exit -h, --help show this help message and exit
-i TIMEFRAME, --timeframe TIMEFRAME -i TIMEFRAME, --timeframe TIMEFRAME
Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`). Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).
--timerange TIMERANGE --timerange TIMERANGE
Specify what timerange of data to use. Specify what timerange of data to use.
--data-format-ohlcv {json,jsongz,hdf5} --data-format-ohlcv {json,jsongz,feather,parquet}
Storage format for downloaded candle (OHLCV) data. Storage format for downloaded candle (OHLCV) data.
(default: `None`). (default: `feather`).
--max-open-trades INT --max-open-trades INT
Override the value of the `max_open_trades` Override the value of the `max_open_trades`
configuration setting. configuration setting.
@@ -2067,7 +2069,10 @@ optional arguments:
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--logfile FILE Log to the file specified. Special values are: --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE
Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more
details. details.
-V, --version show program&#39;s version number and exit -V, --version show program&#39;s version number and exit
@@ -2076,7 +2081,7 @@ Common arguments:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH -d PATH, --datadir PATH, --data-dir PATH
Path to directory with historical backtesting data. Path to directory with historical backtesting data.
--userdir PATH, --user-data-dir PATH --userdir PATH, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
@@ -2086,6 +2091,12 @@ Strategy arguments:
Specify strategy class name which will be used by the Specify strategy class name which will be used by the
bot. bot.
--strategy-path PATH Specify additional strategy lookup path. --strategy-path PATH Specify additional strategy lookup path.
--recursive-strategy-search
Recursively search for a strategy in the strategies
folder.
--freqaimodel NAME Specify a custom freqaimodels.
--freqaimodel-path PATH
Specify additional lookup path for freqaimodels.
</code></pre></div> </code></pre></div>
<h2 id="configurations">Configurations<a class="headerlink" href="#configurations" title="Permanent link">&para;</a></h2> <h2 id="configurations">Configurations<a class="headerlink" href="#configurations" title="Permanent link">&para;</a></h2>
<p>Edge module has following configuration options:</p> <p>Edge module has following configuration options:</p>

View File

@@ -2426,12 +2426,12 @@ The legacy method was supported up to 2021.8 and has been removed in 2021.9.</p>
pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements-hyperopt.txt pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements-hyperopt.txt
</code></pre></div> </code></pre></div>
<h2 id="hyperopt-command-reference">Hyperopt command reference<a class="headerlink" href="#hyperopt-command-reference" title="Permanent link">&para;</a></h2> <h2 id="hyperopt-command-reference">Hyperopt command reference<a class="headerlink" href="#hyperopt-command-reference" title="Permanent link">&para;</a></h2>
<div class="highlight"><pre><span></span><code>usage: freqtrade hyperopt [-h] [-v] [--logfile FILE] [-V] [-c PATH] [-d PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade hyperopt [-h] [-v] [--no-color] [--logfile FILE] [-V]
[--userdir PATH] [-s NAME] [--strategy-path PATH] [-c PATH] [-d PATH] [--userdir PATH] [-s NAME]
[--recursive-strategy-search] [--freqaimodel NAME] [--strategy-path PATH] [--recursive-strategy-search]
[--freqaimodel-path PATH] [-i TIMEFRAME] [--freqaimodel NAME] [--freqaimodel-path PATH]
[--timerange TIMERANGE] [-i TIMEFRAME] [--timerange TIMERANGE]
[--data-format-ohlcv {json,jsongz,hdf5,feather,parquet}] [--data-format-ohlcv {json,jsongz,feather,parquet}]
[--max-open-trades INT] [--max-open-trades INT]
[--stake-amount STAKE_AMOUNT] [--fee FLOAT] [--stake-amount STAKE_AMOUNT] [--fee FLOAT]
[-p PAIRS [PAIRS ...]] [--hyperopt-path PATH] [-p PAIRS [PAIRS ...]] [--hyperopt-path PATH]
@@ -2439,7 +2439,7 @@ pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </s
[--dry-run-wallet DRY_RUN_WALLET] [--dry-run-wallet DRY_RUN_WALLET]
[--timeframe-detail TIMEFRAME_DETAIL] [-e INT] [--timeframe-detail TIMEFRAME_DETAIL] [-e INT]
[--spaces {all,buy,sell,roi,stoploss,trailing,protection,trades,default} [{all,buy,sell,roi,stoploss,trailing,protection,trades,default} ...]] [--spaces {all,buy,sell,roi,stoploss,trailing,protection,trades,default} [{all,buy,sell,roi,stoploss,trailing,protection,trades,default} ...]]
[--print-all] [--no-color] [--print-json] [-j JOBS] [--print-all] [--print-json] [-j JOBS]
[--random-state INT] [--min-trades INT] [--random-state INT] [--min-trades INT]
[--hyperopt-loss NAME] [--disable-param-export] [--hyperopt-loss NAME] [--disable-param-export]
[--ignore-missing-spaces] [--analyze-per-epoch] [--ignore-missing-spaces] [--analyze-per-epoch]
@@ -2450,7 +2450,7 @@ options:
Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`). Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).
--timerange TIMERANGE --timerange TIMERANGE
Specify what timerange of data to use. Specify what timerange of data to use.
--data-format-ohlcv {json,jsongz,hdf5,feather,parquet} --data-format-ohlcv {json,jsongz,feather,parquet}
Storage format for downloaded candle (OHLCV) data. Storage format for downloaded candle (OHLCV) data.
(default: `feather`). (default: `feather`).
--max-open-trades INT --max-open-trades INT
@@ -2484,8 +2484,6 @@ options:
Specify which parameters to hyperopt. Space-separated Specify which parameters to hyperopt. Space-separated
list. list.
--print-all Print all results, not only the best ones. --print-all Print all results, not only the best ones.
--no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--print-json Print output in JSON format. --print-json Print output in JSON format.
-j JOBS, --job-workers JOBS -j JOBS, --job-workers JOBS
The number of concurrently running jobs for The number of concurrently running jobs for
@@ -2508,7 +2506,7 @@ options:
SortinoHyperOptLoss, SortinoHyperOptLossDaily, SortinoHyperOptLoss, SortinoHyperOptLossDaily,
CalmarHyperOptLoss, MaxDrawDownHyperOptLoss, CalmarHyperOptLoss, MaxDrawDownHyperOptLoss,
MaxDrawDownRelativeHyperOptLoss, MaxDrawDownRelativeHyperOptLoss,
ProfitDrawDownHyperOptLoss ProfitDrawDownHyperOptLoss, MultiMetricHyperOptLoss
--disable-param-export --disable-param-export
Disable automatic hyperopt parameter export. Disable automatic hyperopt parameter export.
--ignore-missing-spaces, --ignore-unparameterized-spaces --ignore-missing-spaces, --ignore-unparameterized-spaces
@@ -2518,6 +2516,8 @@ options:
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile FILE, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more

View File

@@ -1678,30 +1678,73 @@ It also supports the lookahead-analysis of freqai strategies.</p>
</ul> </ul>
<p>Those are set to avoid users accidentally generating false positives.</p> <p>Those are set to avoid users accidentally generating false positives.</p>
<h2 id="lookahead-analysis-command-reference">Lookahead-analysis command reference<a class="headerlink" href="#lookahead-analysis-command-reference" title="Permanent link">&para;</a></h2> <h2 id="lookahead-analysis-command-reference">Lookahead-analysis command reference<a class="headerlink" href="#lookahead-analysis-command-reference" title="Permanent link">&para;</a></h2>
<div class="highlight"><pre><span></span><code>usage: freqtrade lookahead-analysis [-h] [-v] [--logfile FILE] [-V] [-c PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade lookahead-analysis [-h] [-v] [--no-color] [--logfile FILE]
[-d PATH] [--userdir PATH] [-s NAME] [-V] [-c PATH] [-d PATH] [--userdir PATH]
[--strategy-path PATH] [-s NAME] [--strategy-path PATH]
[--recursive-strategy-search] [--recursive-strategy-search]
[--freqaimodel NAME] [--freqaimodel NAME]
[--freqaimodel-path PATH] [-i TIMEFRAME] [--freqaimodel-path PATH] [-i TIMEFRAME]
[--timerange TIMERANGE] [--timerange TIMERANGE]
[--data-format-ohlcv {json,jsongz,hdf5,feather,parquet}] [--data-format-ohlcv {json,jsongz,feather,parquet}]
[--max-open-trades INT] [--max-open-trades INT]
[--stake-amount STAKE_AMOUNT] [--stake-amount STAKE_AMOUNT]
[--fee FLOAT] [-p PAIRS [PAIRS ...]] [--fee FLOAT] [-p PAIRS [PAIRS ...]]
[--enable-protections]
[--dry-run-wallet DRY_RUN_WALLET] [--dry-run-wallet DRY_RUN_WALLET]
[--timeframe-detail TIMEFRAME_DETAIL] [--timeframe-detail TIMEFRAME_DETAIL]
[--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]] [--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]]
[--export {none,trades,signals}] [--export {none,trades,signals}]
[--export-filename PATH] [--export-filename PATH]
[--breakdown {day,week,month} [{day,week,month} ...]]
[--cache {none,day,week,month}]
[--freqai-backtest-live-models] [--freqai-backtest-live-models]
[--minimum-trade-amount INT] [--minimum-trade-amount INT]
[--targeted-trade-amount INT] [--targeted-trade-amount INT]
[--lookahead-analysis-exportfilename LOOKAHEAD_ANALYSIS_EXPORTFILENAME] [--lookahead-analysis-exportfilename LOOKAHEAD_ANALYSIS_EXPORTFILENAME]
options: options:
-h, --help show this help message and exit
-i TIMEFRAME, --timeframe TIMEFRAME
Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).
--timerange TIMERANGE
Specify what timerange of data to use.
--data-format-ohlcv {json,jsongz,feather,parquet}
Storage format for downloaded candle (OHLCV) data.
(default: `feather`).
--max-open-trades INT
Override the value of the `max_open_trades`
configuration setting.
--stake-amount STAKE_AMOUNT
Override the value of the `stake_amount` configuration
setting.
--fee FLOAT Specify fee ratio. Will be applied twice (on trade
entry and exit).
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
Limit command to these pairs. Pairs are space-
separated.
--enable-protections, --enableprotections
Enable protections for backtesting.Will slow
backtesting down by a considerable amount, but will
include configured protections
--dry-run-wallet DRY_RUN_WALLET, --starting-balance DRY_RUN_WALLET
Starting balance, used for backtesting / hyperopt and
dry-runs.
--timeframe-detail TIMEFRAME_DETAIL
Specify detail timeframe for backtesting (`1m`, `5m`,
`30m`, `1h`, `1d`).
--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]
Provide a space-separated list of strategies to
backtest. Please note that timeframe needs to be set
either in config or via command line. When using this
together with `--export trades`, the strategy-name is
injected into the filename (so `backtest-data.json`
becomes `backtest-data-SampleStrategy.json`
--export {none,trades,signals}
Export backtest results (default: trades).
--export-filename PATH, --backtest-filename PATH
Use this filename for backtest results.Requires
`--export` to be set as well. Example: `--export-filen
ame=user_data/backtest_results/backtest_today.json`
--freqai-backtest-live-models
Run backtest with ready models.
--minimum-trade-amount INT --minimum-trade-amount INT
Minimum trade amount for lookahead-analysis Minimum trade amount for lookahead-analysis
--targeted-trade-amount INT --targeted-trade-amount INT
@@ -1709,6 +1752,37 @@ options:
--lookahead-analysis-exportfilename LOOKAHEAD_ANALYSIS_EXPORTFILENAME --lookahead-analysis-exportfilename LOOKAHEAD_ANALYSIS_EXPORTFILENAME
Use this csv-filename to store lookahead-analysis- Use this csv-filename to store lookahead-analysis-
results results
Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE
Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more
details.
-V, --version show program&#39;s version number and exit
-c PATH, --config PATH
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH
Path to directory with historical backtesting data.
--userdir PATH, --user-data-dir PATH
Path to userdata directory.
Strategy arguments:
-s NAME, --strategy NAME
Specify strategy class name which will be used by the
bot.
--strategy-path PATH Specify additional strategy lookup path.
--recursive-strategy-search
Recursively search for a strategy in the strategies
folder.
--freqaimodel NAME Specify a custom freqaimodels.
--freqaimodel-path PATH
Specify additional lookup path for freqaimodels.
</code></pre></div> </code></pre></div>
<div class="admonition note"> <div class="admonition note">
<p>The above Output was reduced to options <code>lookahead-analysis</code> adds on top of regular backtesting commands.</p> <p>The above Output was reduced to options <code>lookahead-analysis</code> adds on top of regular backtesting commands.</p>

View File

@@ -1705,18 +1705,22 @@ This is mostly for the performance problems even medium sized plots can cause, b
</ul> </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> <p>Possible arguments:</p>
<div class="highlight"><pre><span></span><code>usage: freqtrade plot-dataframe [-h] [-v] [--logfile FILE] [-V] [-c PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade plot-dataframe [-h] [-v] [--no-color] [--logfile FILE] [-V]
[-d PATH] [--userdir PATH] [-s NAME] [-c PATH] [-d PATH] [--userdir PATH] [-s NAME]
[--strategy-path PATH] [-p PAIRS [PAIRS ...]] [--strategy-path PATH]
[--recursive-strategy-search]
[--freqaimodel NAME] [--freqaimodel-path PATH]
[-p PAIRS [PAIRS ...]]
[--indicators1 INDICATORS1 [INDICATORS1 ...]] [--indicators1 INDICATORS1 [INDICATORS1 ...]]
[--indicators2 INDICATORS2 [INDICATORS2 ...]] [--indicators2 INDICATORS2 [INDICATORS2 ...]]
[--plot-limit INT] [--db-url PATH] [--plot-limit INT] [--db-url PATH]
[--trade-source {DB,file}] [--export EXPORT] [--trade-source {DB,file}]
[--export {none,trades,signals}]
[--export-filename PATH] [--export-filename PATH]
[--timerange TIMERANGE] [-i TIMEFRAME] [--timerange TIMERANGE] [-i TIMEFRAME]
[--no-trades] [--no-trades]
optional arguments: options:
-h, --help show this help message and exit -h, --help show this help message and exit
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...] -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
Limit command to these pairs. Pairs are space- Limit command to these pairs. Pairs are space-
@@ -1738,13 +1742,12 @@ optional arguments:
--trade-source {DB,file} --trade-source {DB,file}
Specify the source for trades (Can be DB or file Specify the source for trades (Can be DB or file
(backtest file)) Default: file (backtest file)) Default: file
--export EXPORT Export backtest results, argument are: trades. --export {none,trades,signals}
Example: `--export=trades` Export backtest results (default: trades).
--export-filename PATH --export-filename PATH, --backtest-filename PATH
Save backtest results to the file with this filename. Use this filename for backtest results.Requires
Requires `--export` to be set as well. Example: `--export` to be set as well. Example: `--export-filen
`--export-filename=user_data/backtest_results/backtest ame=user_data/backtest_results/backtest_today.json`
_today.json`
--timerange TIMERANGE --timerange TIMERANGE
Specify what timerange of data to use. Specify what timerange of data to use.
-i TIMEFRAME, --timeframe TIMEFRAME -i TIMEFRAME, --timeframe TIMEFRAME
@@ -1753,7 +1756,10 @@ optional arguments:
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--logfile FILE Log to the file specified. Special values are: --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE
Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more
details. details.
-V, --version show program&#39;s version number and exit -V, --version show program&#39;s version number and exit
@@ -1762,7 +1768,7 @@ Common arguments:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH -d PATH, --datadir PATH, --data-dir PATH
Path to directory with historical backtesting data. Path to directory with historical backtesting data.
--userdir PATH, --user-data-dir PATH --userdir PATH, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
@@ -1772,6 +1778,12 @@ Strategy arguments:
Specify strategy class name which will be used by the Specify strategy class name which will be used by the
bot. bot.
--strategy-path PATH Specify additional strategy lookup path. --strategy-path PATH Specify additional strategy lookup path.
--recursive-strategy-search
Recursively search for a strategy in the strategies
folder.
--freqaimodel NAME Specify a custom freqaimodels.
--freqaimodel-path PATH
Specify additional lookup path for freqaimodels.
</code></pre></div> </code></pre></div>
<p>Example:</p> <p>Example:</p>
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>plot-dataframe<span class="w"> </span>-p<span class="w"> </span>BTC/ETH<span class="w"> </span>--strategy<span class="w"> </span>AwesomeStrategy <div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>plot-dataframe<span class="w"> </span>-p<span class="w"> </span>BTC/ETH<span class="w"> </span>--strategy<span class="w"> </span>AwesomeStrategy
@@ -1943,27 +1955,30 @@ This graph will also highlight the start (and end) of the Max drawdown period.</
<p>The third graph can be useful to spot outliers, events in pairs that cause profit spikes.</p> <p>The third graph can be useful to spot outliers, events in pairs that cause profit spikes.</p>
<p>The forth graph can help you analyze trade parallelism, showing how often max_open_trades have been maxed out.</p> <p>The forth graph can help you analyze trade parallelism, showing how often max_open_trades have been maxed out.</p>
<p>Possible options for the <code>freqtrade plot-profit</code> subcommand:</p> <p>Possible options for the <code>freqtrade plot-profit</code> subcommand:</p>
<div class="highlight"><pre><span></span><code>usage: freqtrade plot-profit [-h] [-v] [--logfile FILE] [-V] [-c PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade plot-profit [-h] [-v] [--no-color] [--logfile FILE] [-V]
[-d PATH] [--userdir PATH] [-s NAME] [-c PATH] [-d PATH] [--userdir PATH] [-s NAME]
[--strategy-path PATH] [-p PAIRS [PAIRS ...]] [--strategy-path PATH]
[--timerange TIMERANGE] [--export EXPORT] [--recursive-strategy-search]
[--freqaimodel NAME] [--freqaimodel-path PATH]
[-p PAIRS [PAIRS ...]] [--timerange TIMERANGE]
[--export {none,trades,signals}]
[--export-filename PATH] [--db-url PATH] [--export-filename PATH] [--db-url PATH]
[--trade-source {DB,file}] [-i TIMEFRAME] [--trade-source {DB,file}] [-i TIMEFRAME]
[--auto-open]
optional arguments: options:
-h, --help show this help message and exit -h, --help show this help message and exit
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...] -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
Limit command to these pairs. Pairs are space- Limit command to these pairs. Pairs are space-
separated. separated.
--timerange TIMERANGE --timerange TIMERANGE
Specify what timerange of data to use. Specify what timerange of data to use.
--export EXPORT Export backtest results, argument are: trades. --export {none,trades,signals}
Example: `--export=trades` Export backtest results (default: trades).
--export-filename PATH, --backtest-filename PATH --export-filename PATH, --backtest-filename PATH
Use backtest results from this filename. Use this filename for backtest results.Requires
Requires `--export` to be set as well. Example: `--export` to be set as well. Example: `--export-filen
`--export-filename=user_data/backtest_results/backtest ame=user_data/backtest_results/backtest_today.json`
_today.json`
--db-url PATH Override trades database URL, this is useful in custom --db-url PATH Override trades database URL, this is useful in custom
deployments (default: `sqlite:///tradesv3.sqlite` for deployments (default: `sqlite:///tradesv3.sqlite` for
Live Run mode, `sqlite:///tradesv3.dryrun.sqlite` for Live Run mode, `sqlite:///tradesv3.dryrun.sqlite` for
@@ -1977,7 +1992,10 @@ optional arguments:
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--logfile FILE Log to the file specified. Special values are: --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE
Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more
details. details.
-V, --version show program&#39;s version number and exit -V, --version show program&#39;s version number and exit
@@ -1986,7 +2004,7 @@ Common arguments:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH -d PATH, --datadir PATH, --data-dir PATH
Path to directory with historical backtesting data. Path to directory with historical backtesting data.
--userdir PATH, --user-data-dir PATH --userdir PATH, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
@@ -1996,6 +2014,12 @@ Strategy arguments:
Specify strategy class name which will be used by the Specify strategy class name which will be used by the
bot. bot.
--strategy-path PATH Specify additional strategy lookup path. --strategy-path PATH Specify additional strategy lookup path.
--recursive-strategy-search
Recursively search for a strategy in the strategies
folder.
--freqaimodel NAME Specify a custom freqaimodels.
--freqaimodel-path PATH
Specify additional lookup path for freqaimodels.
</code></pre></div> </code></pre></div>
<p>The <code>-p/--pairs</code> argument, can be used to limit the pairs that are considered for this calculation.</p> <p>The <code>-p/--pairs</code> argument, can be used to limit the pairs that are considered for this calculation.</p>
<p>Examples:</p> <p>Examples:</p>

View File

@@ -1673,34 +1673,39 @@ This does not backtest the strategy itself, but rather only calculates the indic
</ul> </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/">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> <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] [--logfile FILE] [-V] [-c PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade recursive-analysis [-h] [-v] [--no-color] [--logfile FILE]
[-d PATH] [--userdir PATH] [-s NAME] [-V] [-c PATH] [-d PATH] [--userdir PATH]
[--strategy-path PATH] [-s NAME] [--strategy-path PATH]
[--recursive-strategy-search] [--recursive-strategy-search]
[--freqaimodel NAME] [--freqaimodel NAME]
[--freqaimodel-path PATH] [-i TIMEFRAME] [--freqaimodel-path PATH] [-i TIMEFRAME]
[--timerange TIMERANGE] [--timerange TIMERANGE]
[--data-format-ohlcv {json,jsongz,hdf5,feather,parquet}] [--data-format-ohlcv {json,jsongz,feather,parquet}]
[-p PAIR] [-p PAIRS [PAIRS ...]]
[--freqai-backtest-live-models] [--startup-candle STARTUP_CANDLE [STARTUP_CANDLE ...]]
[--startup-candle STARTUP_CANDLES [STARTUP_CANDLES ...]]
optional arguments: options:
-h, --help show this help message and exit -h, --help show this help message and exit
-i TIMEFRAME, --timeframe TIMEFRAME -i TIMEFRAME, --timeframe TIMEFRAME
Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`). Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).
--data-format-ohlcv {json,jsongz,hdf5,feather,parquet} --timerange TIMERANGE
Specify what timerange of data to use.
--data-format-ohlcv {json,jsongz,feather,parquet}
Storage format for downloaded candle (OHLCV) data. Storage format for downloaded candle (OHLCV) data.
(default: `feather`). (default: `feather`).
-p PAIR, --pairs PAIR -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
Limit command to this pair. Limit command to these pairs. Pairs are space-
separated.
--startup-candle STARTUP_CANDLE [STARTUP_CANDLE ...] --startup-candle STARTUP_CANDLE [STARTUP_CANDLE ...]
Provide a space-separated list of startup_candle_count to Specify startup candles to be checked (`199`, `499`,
be checked. Default : `199 399 499 999 1999`. `999`, `1999`).
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--logfile FILE Log to the file specified. Special values are: --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE
Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more
details. details.
-V, --version show program&#39;s version number and exit -V, --version show program&#39;s version number and exit
@@ -1709,7 +1714,7 @@ Common arguments:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH -d PATH, --datadir PATH, --data-dir PATH
Path to directory with historical backtesting data. Path to directory with historical backtesting data.
--userdir PATH, --user-data-dir PATH --userdir PATH, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
@@ -1719,8 +1724,12 @@ Strategy arguments:
Specify strategy class name which will be used by the Specify strategy class name which will be used by the
bot. bot.
--strategy-path PATH Specify additional strategy lookup path. --strategy-path PATH Specify additional strategy lookup path.
--timerange TIMERANGE --recursive-strategy-search
Specify what timerange of data to use. Recursively search for a strategy in the strategies
folder.
--freqaimodel NAME Specify a custom freqaimodels.
--freqaimodel-path PATH
Specify additional lookup path for freqaimodels.
</code></pre></div> </code></pre></div>
<h3 id="why-are-odd-numbered-default-startup-candles-used">Why are odd-numbered default startup candles used?<a class="headerlink" href="#why-are-odd-numbered-default-startup-candles-used" title="Permanent link">&para;</a></h3> <h3 id="why-are-odd-numbered-default-startup-candles-used">Why are odd-numbered default startup candles used?<a class="headerlink" href="#why-are-odd-numbered-default-startup-candles-used" title="Permanent link">&para;</a></h3>
<p>The default value for startup candles are odd numbers. When the bot fetches candle data from the exchange's API, the last candle is the one being checked by the bot and the rest of the data are the "startup candles".</p> <p>The default value for startup candles are odd numbers. When the bot fetches candle data from the exchange's API, the last candle is the one being checked by the bot and the rest of the data are the "startup candles".</p>

File diff suppressed because one or more lines are too long

View File

@@ -192,6 +192,146 @@
<loc>https://www.freqtrade.io/en/stable/windows_installation/</loc> <loc>https://www.freqtrade.io/en/stable/windows_installation/</loc>
<lastmod>2025-01-07</lastmod> <lastmod>2025-01-07</lastmod>
</url> </url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/backtesting-analysis/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/backtesting-show/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/backtesting/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/convert-data/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/convert-db/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/convert-trade-data/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/create-userdir/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/download-data/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/edge/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/hyperopt-list/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/hyperopt-show/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/hyperopt/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/install-ui/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/list-data/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/list-exchanges/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/list-freqaimodels/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/list-hyperoptloss/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/list-markets/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/list-pairs/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/list-strategies/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/list-timeframes/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/lookahead-analysis/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/main/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/new-config/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/new-strategy/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/plot-dataframe/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/plot-profit/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/recursive-analysis/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/show-config/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/show-trades/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/strategy-updater/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/test-pairlist/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/trade/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/trades-to-ohlcv/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url>
<loc>https://www.freqtrade.io/en/stable/commands/webserver/</loc>
<lastmod>2025-01-07</lastmod>
</url>
<url> <url>
<loc>https://www.freqtrade.io/en/stable/includes/cors/</loc> <loc>https://www.freqtrade.io/en/stable/includes/cors/</loc>
<lastmod>2025-01-07</lastmod> <lastmod>2025-01-07</lastmod>

Binary file not shown.

View File

@@ -2138,10 +2138,10 @@
<h2 id="create-userdir">Create userdir<a class="headerlink" href="#create-userdir" title="Permanent link">&para;</a></h2> <h2 id="create-userdir">Create userdir<a class="headerlink" href="#create-userdir" title="Permanent link">&para;</a></h2>
<p>Creates the directory structure to hold your files for freqtrade. <p>Creates the directory structure to hold your files for freqtrade.
Will also create strategy and hyperopt examples for you to get started. Will also create strategy and hyperopt examples for you to get started.
Can be used multiple times - using <code>--reset</code> will reset the sample strategy and hyperopt files to their default state. </p> Can be used multiple times - using <code>--reset</code> will reset the sample strategy and hyperopt files to their default state.</p>
<div class="highlight"><pre><span></span><code>usage: freqtrade create-userdir [-h] [--userdir PATH] [--reset] <div class="highlight"><pre><span></span><code>usage: freqtrade create-userdir [-h] [--userdir PATH] [--reset]
optional arguments: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--userdir PATH, --user-data-dir PATH --userdir PATH, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
@@ -2166,11 +2166,13 @@ optional arguments:
<p>Creates a new configuration file, asking some questions which are important selections for a configuration.</p> <p>Creates a new configuration file, asking some questions which are important selections for a configuration.</p>
<div class="highlight"><pre><span></span><code>usage: freqtrade new-config [-h] [-c PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade new-config [-h] [-c PATH]
optional arguments: options:
-h, --help show this help message and exit -h, --help show this help message and exit
-c PATH, --config PATH -c PATH, --config PATH
Specify configuration file (default: `config.json`). Multiple --config options may be used. Can be set to `-` Specify configuration file (default:
to read config from stdin. `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin.
</code></pre></div> </code></pre></div>
<div class="admonition warning"> <div class="admonition warning">
<p class="admonition-title">Warning</p> <p class="admonition-title">Warning</p>
@@ -2233,20 +2235,22 @@ Yet, please do double-check for sensitive values in your output to make sure you
<p>Creates a new strategy from a template similar to SampleStrategy. <p>Creates a new strategy from a template similar to SampleStrategy.
The file will be named inline with your class name, and will not overwrite existing files.</p> The file will be named inline with your class name, and will not overwrite existing files.</p>
<p>Results will be located in <code>user_data/strategies/&lt;strategyclassname&gt;.py</code>.</p> <p>Results will be located in <code>user_data/strategies/&lt;strategyclassname&gt;.py</code>.</p>
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade new-strategy [-h] [--userdir PATH] [-s NAME]</span> <div class="highlight"><pre><span></span><code>usage: freqtrade new-strategy [-h] [--userdir PATH] [-s NAME]
<span class="go"> [--template {full,minimal,advanced}]</span> [--strategy-path PATH]
[--template {full,minimal,advanced}]
<span class="go">optional arguments:</span> options:
<span class="go"> -h, --help show this help message and exit</span> -h, --help show this help message and exit
<span class="go"> --userdir PATH, --user-data-dir PATH</span> --userdir PATH, --user-data-dir PATH
<span class="go"> Path to userdata directory.</span> Path to userdata directory.
<span class="go"> -s NAME, --strategy NAME</span> -s NAME, --strategy NAME
<span class="go"> Specify strategy class name which will be used by the</span> Specify strategy class name which will be used by the
<span class="go"> bot.</span> bot.
<span class="go"> --template {full,minimal,advanced}</span> --strategy-path PATH Specify additional strategy lookup path.
<span class="go"> Use a template which is either `minimal`, `full`</span> --template {full,minimal,advanced}
<span class="go"> (containing multiple sample indicators) or `advanced`.</span> Use a template which is either `minimal`, `full`
<span class="go"> Default: `full`.</span> (containing multiple sample indicators) or `advanced`.
Default: `full`.
</code></pre></div> </code></pre></div>
<h3 id="sample-usage-of-new-strategy">Sample usage of new-strategy<a class="headerlink" href="#sample-usage-of-new-strategy" title="Permanent link">&para;</a></h3> <h3 id="sample-usage-of-new-strategy">Sample usage of new-strategy<a class="headerlink" href="#sample-usage-of-new-strategy" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>new-strategy<span class="w"> </span>--strategy<span class="w"> </span>AwesomeStrategy <div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>new-strategy<span class="w"> </span>--strategy<span class="w"> </span>AwesomeStrategy
@@ -2260,24 +2264,25 @@ The file will be named inline with your class name, and will not overwrite exist
<h2 id="list-strategies">List Strategies<a class="headerlink" href="#list-strategies" title="Permanent link">&para;</a></h2> <h2 id="list-strategies">List Strategies<a class="headerlink" href="#list-strategies" title="Permanent link">&para;</a></h2>
<p>Use the <code>list-strategies</code> subcommand to see all strategies in one particular directory.</p> <p>Use the <code>list-strategies</code> subcommand to see all strategies in one particular directory.</p>
<p>This subcommand is useful for finding problems in your environment with loading strategies: modules with strategies that contain errors and failed to load are printed in red (LOAD FAILED), while strategies with duplicate names are printed in yellow (DUPLICATE NAME).</p> <p>This subcommand is useful for finding problems in your environment with loading strategies: modules with strategies that contain errors and failed to load are printed in red (LOAD FAILED), while strategies with duplicate names are printed in yellow (DUPLICATE NAME).</p>
<div class="highlight"><pre><span></span><code>usage: freqtrade list-strategies [-h] [-v] [--logfile FILE] [-V] [-c PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade list-strategies [-h] [-v] [--no-color] [--logfile FILE] [-V]
[-d PATH] [--userdir PATH] [-c PATH] [-d PATH] [--userdir PATH]
[--strategy-path PATH] [-1] [--no-color] [--strategy-path PATH] [-1]
[--recursive-strategy-search] [--recursive-strategy-search]
optional arguments: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--strategy-path PATH Specify additional strategy lookup path. --strategy-path PATH Specify additional strategy lookup path.
-1, --one-column Print output in one column. -1, --one-column Print output in one column.
--no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--recursive-strategy-search --recursive-strategy-search
Recursively search for a strategy in the strategies Recursively search for a strategy in the strategies
folder. folder.
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--logfile FILE Log to the file specified. Special values are: --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE
Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more
details. details.
-V, --version show program&#39;s version number and exit -V, --version show program&#39;s version number and exit
@@ -2286,7 +2291,7 @@ Common arguments:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH -d PATH, --datadir PATH, --data-dir PATH
Path to directory with historical backtesting data. Path to directory with historical backtesting data.
--userdir PATH, --user-data-dir PATH --userdir PATH, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
@@ -2308,20 +2313,20 @@ Common arguments:
<p>Use the <code>list-hyperoptloss</code> subcommand to see all hyperopt loss functions available.</p> <p>Use the <code>list-hyperoptloss</code> subcommand to see all hyperopt loss functions available.</p>
<p>It provides a quick list of all available loss functions in your environment.</p> <p>It provides a quick list of all available loss functions in your environment.</p>
<p>This subcommand can be useful for finding problems in your environment with loading loss functions: modules with Hyperopt-Loss functions that contain errors and failed to load are printed in red (LOAD FAILED), while hyperopt-Loss functions with duplicate names are printed in yellow (DUPLICATE NAME).</p> <p>This subcommand can be useful for finding problems in your environment with loading loss functions: modules with Hyperopt-Loss functions that contain errors and failed to load are printed in red (LOAD FAILED), while hyperopt-Loss functions with duplicate names are printed in yellow (DUPLICATE NAME).</p>
<div class="highlight"><pre><span></span><code>usage: freqtrade list-hyperoptloss [-h] [-v] [--logfile FILE] [-V] [-c PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade list-hyperoptloss [-h] [-v] [--no-color] [--logfile FILE]
[-d PATH] [--userdir PATH] [-V] [-c PATH] [-d PATH] [--userdir PATH]
[--hyperopt-path PATH] [-1] [--no-color] [--hyperopt-path PATH] [-1]
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--hyperopt-path PATH Specify additional lookup path for Hyperopt Loss --hyperopt-path PATH Specify additional lookup path for Hyperopt Loss
functions. functions.
-1, --one-column Print output in one column. -1, --one-column Print output in one column.
--no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile FILE, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more
@@ -2340,21 +2345,22 @@ Common arguments:
<h2 id="list-freqai-models">List freqAI models<a class="headerlink" href="#list-freqai-models" title="Permanent link">&para;</a></h2> <h2 id="list-freqai-models">List freqAI models<a class="headerlink" href="#list-freqai-models" title="Permanent link">&para;</a></h2>
<p>Use the <code>list-freqaimodels</code> subcommand to see all freqAI models available.</p> <p>Use the <code>list-freqaimodels</code> subcommand to see all freqAI models available.</p>
<p>This subcommand is useful for finding problems in your environment with loading freqAI models: modules with models that contain errors and failed to load are printed in red (LOAD FAILED), while models with duplicate names are printed in yellow (DUPLICATE NAME).</p> <p>This subcommand is useful for finding problems in your environment with loading freqAI models: modules with models that contain errors and failed to load are printed in red (LOAD FAILED), while models with duplicate names are printed in yellow (DUPLICATE NAME).</p>
<div class="highlight"><pre><span></span><code>usage: freqtrade list-freqaimodels [-h] [-v] [--logfile FILE] [-V] [-c PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade list-freqaimodels [-h] [-v] [--no-color] [--logfile FILE]
[-d PATH] [--userdir PATH] [-V] [-c PATH] [-d PATH] [--userdir PATH]
[--freqaimodel-path PATH] [-1] [--no-color] [--freqaimodel-path PATH] [-1]
optional arguments: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--freqaimodel-path PATH --freqaimodel-path PATH
Specify additional lookup path for freqaimodels. Specify additional lookup path for freqaimodels.
-1, --one-column Print output in one column. -1, --one-column Print output in one column.
--no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--logfile FILE Log to the file specified. Special values are: --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE
Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more
details. details.
-V, --version show program&#39;s version number and exit -V, --version show program&#39;s version number and exit
@@ -2370,12 +2376,32 @@ Common arguments:
</code></pre></div> </code></pre></div>
<h2 id="list-exchanges">List Exchanges<a class="headerlink" href="#list-exchanges" title="Permanent link">&para;</a></h2> <h2 id="list-exchanges">List Exchanges<a class="headerlink" href="#list-exchanges" title="Permanent link">&para;</a></h2>
<p>Use the <code>list-exchanges</code> subcommand to see the exchanges available for the bot.</p> <p>Use the <code>list-exchanges</code> subcommand to see the exchanges available for the bot.</p>
<div class="highlight"><pre><span></span><code>usage: freqtrade list-exchanges [-h] [-1] [-a] <div class="highlight"><pre><span></span><code>usage: freqtrade list-exchanges [-h] [-v] [--no-color] [--logfile FILE] [-V]
[-c PATH] [-d PATH] [--userdir PATH] [-1] [-a]
optional arguments: options:
-h, --help show this help message and exit -h, --help show this help message and exit
-1, --one-column Print output in one column. -1, --one-column Print output in one column.
-a, --all Print all exchanges known to the ccxt library. -a, --all Print all exchanges known to the ccxt library.
Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE
Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more
details.
-V, --version show program&#39;s version number and exit
-c PATH, --config PATH
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH
Path to directory with historical backtesting data.
--userdir PATH, --user-data-dir PATH
Path to userdata directory.
</code></pre></div> </code></pre></div>
<p>Example: see exchanges available for the bot:</p> <p>Example: see exchanges available for the bot:</p>
<div class="highlight"><pre><span></span><code>$ freqtrade list-exchanges <div class="highlight"><pre><span></span><code>$ freqtrade list-exchanges
@@ -2417,8 +2443,8 @@ okx True Official spot, isolated futures
</div> </div>
<h2 id="list-timeframes">List Timeframes<a class="headerlink" href="#list-timeframes" title="Permanent link">&para;</a></h2> <h2 id="list-timeframes">List Timeframes<a class="headerlink" href="#list-timeframes" title="Permanent link">&para;</a></h2>
<p>Use the <code>list-timeframes</code> subcommand to see the list of timeframes available for the exchange.</p> <p>Use the <code>list-timeframes</code> subcommand to see the list of timeframes available for the exchange.</p>
<div class="highlight"><pre><span></span><code>usage: freqtrade list-timeframes [-h] [-v] [--logfile FILE] [-V] [-c PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade list-timeframes [-h] [-v] [--no-color] [--logfile FILE] [-V]
[-d PATH] [--userdir PATH] [-c PATH] [-d PATH] [--userdir PATH]
[--exchange EXCHANGE] [-1] [--exchange EXCHANGE] [-1]
options: options:
@@ -2428,6 +2454,8 @@ options:
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile FILE, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more
@@ -2462,18 +2490,14 @@ For example, in the 'ETH/BTC' pair 'ETH' is the base currency, while 'BTC' is th
<p>For pairs traded by Freqtrade the pair quote currency is defined by the value of the <code>stake_currency</code> configuration setting.</p> <p>For pairs traded by Freqtrade the pair quote currency is defined by the value of the <code>stake_currency</code> configuration setting.</p>
<p>You can print info about any pair/market with these subcommands - and you can filter output by quote-currency using <code>--quote BTC</code>, or by base-currency using <code>--base ETH</code> options correspondingly.</p> <p>You can print info about any pair/market with these subcommands - and you can filter output by quote-currency using <code>--quote BTC</code>, or by base-currency using <code>--base ETH</code> options correspondingly.</p>
<p>These subcommands have same usage and same set of available options:</p> <p>These subcommands have same usage and same set of available options:</p>
<div class="highlight"><pre><span></span><code>usage: freqtrade list-markets [-h] [-v] [--logfile FILE] [-V] [-c PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade list-pairs [-h] [-v] [--no-color] [--logfile FILE] [-V]
[-d PATH] [--userdir PATH] [--exchange EXCHANGE] [-c PATH] [-d PATH] [--userdir PATH]
[--print-list] [--print-json] [-1] [--print-csv] [--exchange EXCHANGE] [--print-list]
[--base BASE_CURRENCY [BASE_CURRENCY ...]] [--print-json] [-1] [--print-csv]
[--quote QUOTE_CURRENCY [QUOTE_CURRENCY ...]]
[-a] [--trading-mode {spot,margin,futures}]
usage: freqtrade list-pairs [-h] [-v] [--logfile FILE] [-V] [-c PATH]
[-d PATH] [--userdir PATH] [--exchange EXCHANGE]
[--print-list] [--print-json] [-1] [--print-csv]
[--base BASE_CURRENCY [BASE_CURRENCY ...]] [--base BASE_CURRENCY [BASE_CURRENCY ...]]
[--quote QUOTE_CURRENCY [QUOTE_CURRENCY ...]] [-a] [--quote QUOTE_CURRENCY [QUOTE_CURRENCY ...]] [-a]
[--trading-mode {spot,margin,futures}] [--trading-mode {spot,margin,futures}]
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--exchange EXCHANGE Exchange name. Only valid if no config is provided. --exchange EXCHANGE Exchange name. Only valid if no config is provided.
@@ -2493,6 +2517,8 @@ options:
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile FILE, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more
@@ -2564,7 +2590,7 @@ options:
<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/#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] <div class="highlight"><pre><span></span><code>usage: freqtrade convert-db [-h] [--db-url PATH] [--db-url-from PATH]
optional arguments: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--db-url PATH Override trades database URL, this is useful in custom --db-url PATH Override trades database URL, this is useful in custom
deployments (default: `sqlite:///tradesv3.sqlite` for deployments (default: `sqlite:///tradesv3.sqlite` for
@@ -2586,15 +2612,18 @@ There may still be bugs - so if you happen to stumble across these, please repor
Freqtrade will start the webserver and allow FreqUI to start and control backtesting processes. Freqtrade will start the webserver and allow FreqUI to start and control backtesting processes.
This has the advantage that data will not be reloaded between backtesting runs (as long as timeframe and timerange remain identical). This has the advantage that data will not be reloaded between backtesting runs (as long as timeframe and timerange remain identical).
FreqUI will also show the backtesting results.</p> FreqUI will also show the backtesting results.</p>
<div class="highlight"><pre><span></span><code>usage: freqtrade webserver [-h] [-v] [--logfile FILE] [-V] [-c PATH] [-d PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade webserver [-h] [-v] [--no-color] [--logfile FILE] [-V]
[--userdir PATH] [-c PATH] [-d PATH] [--userdir PATH]
optional arguments: options:
-h, --help show this help message and exit -h, --help show this help message and exit
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--logfile FILE Log to the file specified. Special values are: --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE
Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more
details. details.
-V, --version show program&#39;s version number and exit -V, --version show program&#39;s version number and exit
@@ -2603,7 +2632,7 @@ Common arguments:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH -d PATH, --datadir PATH, --data-dir PATH
Path to directory with historical backtesting data. Path to directory with historical backtesting data.
--userdir PATH, --user-data-dir PATH --userdir PATH, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
@@ -2630,22 +2659,27 @@ Adding <code>--show-pair-list</code> outputs a sorted pair list you can easily c
<summary>Strategy overfitting</summary> <summary>Strategy overfitting</summary>
<p>Only using winning pairs can lead to an overfitted strategy, which will not work well on future data. Make sure to extensively test your strategy in dry-run before risking real money.</p> <p>Only using winning pairs can lead to an overfitted strategy, which will not work well on future data. Make sure to extensively test your strategy in dry-run before risking real money.</p>
</details> </details>
<div class="highlight"><pre><span></span><code>usage: freqtrade backtesting-show [-h] [-v] [--logfile FILE] [-V] [-c PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade backtesting-show [-h] [-v] [--no-color] [--logfile FILE] [-V]
[-d PATH] [--userdir PATH] [-c PATH] [-d PATH] [--userdir PATH]
[--export-filename PATH] [--show-pair-list] [--export-filename PATH] [--show-pair-list]
[--breakdown {day,week,month} [{day,week,month} ...]]
optional arguments: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--export-filename PATH --export-filename PATH, --backtest-filename PATH
Save backtest results to the file with this filename. Use this filename for backtest results.Requires
Requires `--export` to be set as well. Example: `--export` to be set as well. Example: `--export-filen
`--export-filename=user_data/backtest_results/backtest ame=user_data/backtest_results/backtest_today.json`
_today.json`
--show-pair-list Show backtesting pairlist sorted by profit. --show-pair-list Show backtesting pairlist sorted by profit.
--breakdown {day,week,month} [{day,week,month} ...]
Show backtesting breakdown per [day, week, month].
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--logfile FILE Log to the file specified. Special values are: --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE
Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more
details. details.
-V, --version show program&#39;s version number and exit -V, --version show program&#39;s version number and exit
@@ -2654,7 +2688,7 @@ Common arguments:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH -d PATH, --datadir PATH, --data-dir PATH
Path to directory with historical backtesting data. Path to directory with historical backtesting data.
--userdir PATH, --user-data-dir PATH --userdir PATH, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
@@ -2662,55 +2696,57 @@ Common arguments:
<h2 id="detailed-backtest-analysis">Detailed backtest analysis<a class="headerlink" href="#detailed-backtest-analysis" title="Permanent link">&para;</a></h2> <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>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/#analyze-the-buyentry-and-sellexit-tags">Backtesting analysis</a> Section.</p>
<div class="highlight"><pre><span></span><code>usage: freqtrade backtesting-analysis [-h] [-v] [--logfile FILE] [-V] <div class="highlight"><pre><span></span><code>usage: freqtrade backtesting-analysis [-h] [-v] [--no-color] [--logfile FILE]
[-c PATH] [-d PATH] [--userdir PATH] [-V] [-c PATH] [-d PATH]
[--userdir PATH]
[--export-filename PATH] [--export-filename PATH]
[--analysis-groups {0,1,2,3,4} [{0,1,2,3,4} ...]] [--analysis-groups {0,1,2,3,4,5} [{0,1,2,3,4,5} ...]]
[--enter-reason-list ENTER_REASON_LIST [ENTER_REASON_LIST ...]] [--enter-reason-list ENTER_REASON_LIST [ENTER_REASON_LIST ...]]
[--exit-reason-list EXIT_REASON_LIST [EXIT_REASON_LIST ...]] [--exit-reason-list EXIT_REASON_LIST [EXIT_REASON_LIST ...]]
[--indicator-list INDICATOR_LIST [INDICATOR_LIST ...]] [--indicator-list INDICATOR_LIST [INDICATOR_LIST ...]]
[--timerange YYYYMMDD-[YYYYMMDD]] [--entry-only] [--exit-only]
[--rejected] [--timerange TIMERANGE]
[--analysis-to-csv] [--rejected-signals] [--analysis-to-csv]
[--analysis-csv-path PATH] [--analysis-csv-path ANALYSIS_CSV_PATH]
optional arguments: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--export-filename PATH, --backtest-filename PATH --export-filename PATH, --backtest-filename PATH
Use this filename for backtest results.Requires Use this filename for backtest results.Requires
`--export` to be set as well. Example: `--export-filen `--export` to be set as well. Example: `--export-filen
ame=user_data/backtest_results/backtest_today.json` ame=user_data/backtest_results/backtest_today.json`
--analysis-groups {0,1,2,3,4} [{0,1,2,3,4} ...] --analysis-groups {0,1,2,3,4,5} [{0,1,2,3,4,5} ...]
grouping output - 0: simple wins/losses by enter tag, grouping output - 0: simple wins/losses by enter tag,
1: by enter_tag, 2: by enter_tag and exit_tag, 3: by 1: by enter_tag, 2: by enter_tag and exit_tag, 3: by
pair and enter_tag, 4: by pair, enter_ and exit_tag pair and enter_tag, 4: by pair, enter_ and exit_tag
(this can get quite large) (this can get quite large), 5: by exit_tag
--enter-reason-list ENTER_REASON_LIST [ENTER_REASON_LIST ...] --enter-reason-list ENTER_REASON_LIST [ENTER_REASON_LIST ...]
Space separated list of entry signals to analyse. Space separated list of entry signals to analyse.
Default: all. e.g. &#39;entry_tag_a entry_tag_b&#39; Default: all. e.g. &#39;entry_tag_a entry_tag_b&#39;
--exit-reason-list EXIT_REASON_LIST [EXIT_REASON_LIST ...] --exit-reason-list EXIT_REASON_LIST [EXIT_REASON_LIST ...]
Space separated list of exit signals to analyse. Space separated list of exit signals to analyse.
Default: all. e.g. Default: all. e.g. &#39;exit_tag_a roi stop_loss
&#39;exit_tag_a roi stop_loss trailing_stop_loss&#39; trailing_stop_loss&#39;
--indicator-list INDICATOR_LIST [INDICATOR_LIST ...] --indicator-list INDICATOR_LIST [INDICATOR_LIST ...]
Space separated list of indicators to analyse. e.g. Space separated list of indicators to analyse. e.g.
&#39;close rsi bb_lowerband profit_abs&#39; &#39;close rsi bb_lowerband profit_abs&#39;
--timerange YYYYMMDD-[YYYYMMDD] --entry-only Only analyze entry signals.
Timerange to filter trades for analysis, --exit-only Only analyze exit signals.
start inclusive, end exclusive. e.g. --timerange TIMERANGE
20220101-20220201 Specify what timerange of data to use.
--rejected --rejected-signals Analyse rejected signals
Print out rejected trades table --analysis-to-csv Save selected analysis tables to individual CSVs
--analysis-to-csv --analysis-csv-path ANALYSIS_CSV_PATH
Write out tables to individual CSVs, by default to Specify a path to save the analysis CSVs if
&#39;user_data/backtest_results&#39; unless &#39;--analysis-csv-path&#39; is given. --analysis-to-csv is enabled. Default:
--analysis-csv-path [PATH] user_data/basktesting_results/
Optional path where individual CSVs will be written. If not used,
CSVs will be written to &#39;user_data/backtest_results&#39;.
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--logfile FILE Log to the file specified. Special values are: --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE
Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more
details. details.
-V, --version show program&#39;s version number and exit -V, --version show program&#39;s version number and exit
@@ -2719,15 +2755,15 @@ Common arguments:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH -d PATH, --datadir PATH, --data-dir PATH
Path to directory with historical backtesting data. Path to directory with historical backtesting data.
--userdir PATH, --user-data-dir PATH --userdir PATH, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
</code></pre></div> </code></pre></div>
<h2 id="list-hyperopt-results">List Hyperopt results<a class="headerlink" href="#list-hyperopt-results" title="Permanent link">&para;</a></h2> <h2 id="list-hyperopt-results">List Hyperopt results<a class="headerlink" href="#list-hyperopt-results" title="Permanent link">&para;</a></h2>
<p>You can list the hyperoptimization epochs the Hyperopt module evaluated previously with the <code>hyperopt-list</code> sub-command.</p> <p>You can list the hyperoptimization epochs the Hyperopt module evaluated previously with the <code>hyperopt-list</code> sub-command.</p>
<div class="highlight"><pre><span></span><code>usage: freqtrade hyperopt-list [-h] [-v] [--logfile FILE] [-V] [-c PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade hyperopt-list [-h] [-v] [--no-color] [--logfile FILE] [-V]
[-d PATH] [--userdir PATH] [--best] [-c PATH] [-d PATH] [--userdir PATH] [--best]
[--profitable] [--min-trades INT] [--profitable] [--min-trades INT]
[--max-trades INT] [--min-avg-time FLOAT] [--max-trades INT] [--min-avg-time FLOAT]
[--max-avg-time FLOAT] [--min-avg-profit FLOAT] [--max-avg-time FLOAT] [--min-avg-profit FLOAT]
@@ -2735,10 +2771,11 @@ Common arguments:
[--min-total-profit FLOAT] [--min-total-profit FLOAT]
[--max-total-profit FLOAT] [--max-total-profit FLOAT]
[--min-objective FLOAT] [--max-objective FLOAT] [--min-objective FLOAT] [--max-objective FLOAT]
[--no-color] [--print-json] [--no-details] [--print-json] [--no-details]
[--hyperopt-filename PATH] [--export-csv FILE] [--hyperopt-filename FILENAME]
[--export-csv FILE]
optional arguments: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--best Select only best epochs. --best Select only best epochs.
--profitable Select only profitable epochs. --profitable Select only profitable epochs.
@@ -2758,8 +2795,6 @@ optional arguments:
Select epochs above objective. Select epochs above objective.
--max-objective FLOAT --max-objective FLOAT
Select epochs below objective. Select epochs below objective.
--no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--print-json Print output in JSON format. --print-json Print output in JSON format.
--no-details Do not print best epoch details. --no-details Do not print best epoch details.
--hyperopt-filename FILENAME --hyperopt-filename FILENAME
@@ -2770,7 +2805,10 @@ optional arguments:
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--logfile FILE Log to the file specified. Special values are: --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE
Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more
details. details.
-V, --version show program&#39;s version number and exit -V, --version show program&#39;s version number and exit
@@ -2779,7 +2817,7 @@ Common arguments:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH -d PATH, --datadir PATH, --data-dir PATH
Path to directory with historical backtesting data. Path to directory with historical backtesting data.
--userdir PATH, --user-data-dir PATH --userdir PATH, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
@@ -2798,14 +2836,14 @@ You can override this using the <code>--hyperopt-filename</code> argument, and s
</code></pre></div></p> </code></pre></div></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> <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>You can show the details of any hyperoptimization epoch previously evaluated by the Hyperopt module with the <code>hyperopt-show</code> subcommand.</p> <p>You can show the details of any hyperoptimization epoch previously evaluated by the Hyperopt module with the <code>hyperopt-show</code> subcommand.</p>
<div class="highlight"><pre><span></span><code>usage: freqtrade hyperopt-show [-h] [-v] [--logfile FILE] [-V] [-c PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade hyperopt-show [-h] [-v] [--no-color] [--logfile FILE] [-V]
[-d PATH] [--userdir PATH] [--best] [-c PATH] [-d PATH] [--userdir PATH] [--best]
[--profitable] [-n INT] [--print-json] [--profitable] [-n INT] [--print-json]
[--hyperopt-filename FILENAME] [--no-header] [--hyperopt-filename FILENAME] [--no-header]
[--disable-param-export] [--disable-param-export]
[--breakdown {day,week,month} [{day,week,month} ...]] [--breakdown {day,week,month} [{day,week,month} ...]]
optional arguments: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--best Select only best epochs. --best Select only best epochs.
--profitable Select only profitable epochs. --profitable Select only profitable epochs.
@@ -2822,7 +2860,10 @@ optional arguments:
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--logfile FILE Log to the file specified. Special values are: --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE
Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more
details. details.
-V, --version show program&#39;s version number and exit -V, --version show program&#39;s version number and exit
@@ -2831,7 +2872,7 @@ Common arguments:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH -d PATH, --datadir PATH, --data-dir PATH
Path to directory with historical backtesting data. Path to directory with historical backtesting data.
--userdir PATH, --user-data-dir PATH --userdir PATH, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
@@ -2850,12 +2891,13 @@ You can override this using the <code>--hyperopt-filename</code> argument, and s
</code></pre></div> </code></pre></div>
<h2 id="show-trades">Show trades<a class="headerlink" href="#show-trades" title="Permanent link">&para;</a></h2> <h2 id="show-trades">Show trades<a class="headerlink" href="#show-trades" title="Permanent link">&para;</a></h2>
<p>Print selected (or all) trades from database to screen.</p> <p>Print selected (or all) trades from database to screen.</p>
<div class="highlight"><pre><span></span><code>usage: freqtrade show-trades [-h] [-v] [--logfile FILE] [-V] [-c PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade show-trades [-h] [-v] [--no-color] [--logfile FILE] [-V]
[-d PATH] [--userdir PATH] [--db-url PATH] [-c PATH] [-d PATH] [--userdir PATH]
[--db-url PATH]
[--trade-ids TRADE_IDS [TRADE_IDS ...]] [--trade-ids TRADE_IDS [TRADE_IDS ...]]
[--print-json] [--print-json]
optional arguments: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--db-url PATH Override trades database URL, this is useful in custom --db-url PATH Override trades database URL, this is useful in custom
deployments (default: `sqlite:///tradesv3.sqlite` for deployments (default: `sqlite:///tradesv3.sqlite` for
@@ -2867,7 +2909,10 @@ optional arguments:
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--logfile FILE Log to the file specified. Special values are: --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE
Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more
details. details.
-V, --version show program&#39;s version number and exit -V, --version show program&#39;s version number and exit
@@ -2876,7 +2921,7 @@ Common arguments:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH -d PATH, --datadir PATH, --data-dir PATH
Path to directory with historical backtesting data. Path to directory with historical backtesting data.
--userdir PATH, --user-data-dir PATH --userdir PATH, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
@@ -2894,18 +2939,30 @@ Your original strategy will remain available in the <code>user_data/strategies_o
<p>Strategy updater will work on a "best effort" approach. Please do your due diligence and verify the results of the conversion. <p>Strategy updater will work on a "best effort" approach. Please do your due diligence and verify the results of the conversion.
We also recommend to run a python formatter (e.g. <code>black</code>) to format results in a sane manner.</p> We also recommend to run a python formatter (e.g. <code>black</code>) to format results in a sane manner.</p>
</div> </div>
<div class="highlight"><pre><span></span><code>usage: freqtrade strategy-updater [-h] [-v] [--logfile FILE] [-V] [-c PATH] <div class="highlight"><pre><span></span><code>usage: freqtrade strategy-updater [-h] [-v] [--no-color] [--logfile FILE] [-V]
[-d PATH] [--userdir PATH] [-c PATH] [-d PATH] [--userdir PATH]
[--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]] [--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]]
[--strategy-path PATH]
[--recursive-strategy-search]
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--strategy-list STRATEGY_LIST [STRATEGY_LIST ...] --strategy-list STRATEGY_LIST [STRATEGY_LIST ...]
Provide a space-separated list of strategies to Provide a space-separated list of strategies to
be converted. backtest. Please note that timeframe needs to be set
either in config or via command line. When using this
together with `--export trades`, the strategy-name is
injected into the filename (so `backtest-data.json`
becomes `backtest-data-SampleStrategy.json`
--strategy-path PATH Specify additional strategy lookup path.
--recursive-strategy-search
Recursively search for a strategy in the strategies
folder.
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile FILE, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more