mirror of
https://github.com/freqtrade/freqtrade.git
synced 2025-12-02 10:03:05 +00:00
Deployed 706955e to develop in en with MkDocs 1.6.1 and mike 2.1.3
This commit is contained in:
github-actions[bot]
@@ -2100,126 +2100,124 @@
|
||||
To learn how to get data for the pairs and exchange you're interested in, head over to the <a href="../data-download/">Data Downloading</a> section of the documentation.</p>
|
||||
<p>Backtesting is also available in <a href="../freq-ui/#backtesting">webserver mode</a>, which allows you to run backtests via the web interface.</p>
|
||||
<h2 id="backtesting-command-reference">Backtesting command reference<a class="headerlink" href="#backtesting-command-reference" title="Permanent link">¶</a></h2>
|
||||
<div class="highlight"><pre><span></span><code>usage: freqtrade backtesting [-h] [-v] [--no-color] [--logfile FILE] [-V]
|
||||
[-c PATH] [-d PATH] [--userdir PATH] [-s NAME]
|
||||
[--strategy-path PATH]
|
||||
[--recursive-strategy-search]
|
||||
[--freqaimodel NAME] [--freqaimodel-path PATH]
|
||||
[-i TIMEFRAME] [--timerange TIMERANGE]
|
||||
[--data-format-ohlcv {json,jsongz,feather,parquet}]
|
||||
[--max-open-trades INT]
|
||||
[--stake-amount STAKE_AMOUNT] [--fee FLOAT]
|
||||
[-p PAIRS [PAIRS ...]] [--eps]
|
||||
[--enable-protections]
|
||||
[--enable-dynamic-pairlist]
|
||||
[--dry-run-wallet DRY_RUN_WALLET]
|
||||
[--timeframe-detail TIMEFRAME_DETAIL]
|
||||
[--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]]
|
||||
[--export {none,trades,signals}]
|
||||
[--backtest-filename PATH]
|
||||
[--backtest-directory PATH]
|
||||
[--breakdown {day,week,month,year,weekday} [{day,week,month,year,weekday} ...]]
|
||||
[--cache {none,day,week,month}]
|
||||
[--freqai-backtest-live-models] [--notes TEXT]
|
||||
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade backtesting [-h] [-v] [--no-color] [--logfile FILE] [-V]</span>
|
||||
<span class="go"> [-c PATH] [-d PATH] [--userdir PATH] [-s NAME]</span>
|
||||
<span class="go"> [--strategy-path PATH]</span>
|
||||
<span class="go"> [--recursive-strategy-search]</span>
|
||||
<span class="go"> [--freqaimodel NAME] [--freqaimodel-path PATH]</span>
|
||||
<span class="go"> [-i TIMEFRAME] [--timerange TIMERANGE]</span>
|
||||
<span class="go"> [--data-format-ohlcv {json,jsongz,feather,parquet}]</span>
|
||||
<span class="go"> [--max-open-trades INT]</span>
|
||||
<span class="go"> [--stake-amount STAKE_AMOUNT] [--fee FLOAT]</span>
|
||||
<span class="go"> [-p PAIRS [PAIRS ...]] [--eps]</span>
|
||||
<span class="go"> [--enable-protections]</span>
|
||||
<span class="go"> [--enable-dynamic-pairlist]</span>
|
||||
<span class="go"> [--dry-run-wallet DRY_RUN_WALLET]</span>
|
||||
<span class="go"> [--timeframe-detail TIMEFRAME_DETAIL]</span>
|
||||
<span class="go"> [--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]]</span>
|
||||
<span class="go"> [--export {none,trades,signals}]</span>
|
||||
<span class="go"> [--backtest-filename PATH]</span>
|
||||
<span class="go"> [--backtest-directory PATH]</span>
|
||||
<span class="go"> [--breakdown {day,week,month,year,weekday} [{day,week,month,year,weekday} ...]]</span>
|
||||
<span class="go"> [--cache {none,day,week,month}]</span>
|
||||
<span class="go"> [--freqai-backtest-live-models] [--notes TEXT]</span>
|
||||
|
||||
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.
|
||||
--eps, --enable-position-stacking
|
||||
Allow buying the same pair multiple times (position
|
||||
stacking).
|
||||
--enable-protections, --enableprotections
|
||||
Enable protections for backtesting. Will slow
|
||||
backtesting down by a considerable amount, but will
|
||||
include configured protections
|
||||
--enable-dynamic-pairlist
|
||||
Enables dynamic pairlist refreshes in backtesting. The
|
||||
pairlist will be generated for each new candle if
|
||||
you're using a pairlist handler that supports this
|
||||
feature, for example, ShuffleFilter.
|
||||
--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).
|
||||
--backtest-filename PATH, --export-filename PATH
|
||||
Use this filename for backtest results.Example:
|
||||
`--backtest-
|
||||
filename=backtest_results_2020-09-27_16-20-48.json`.
|
||||
Assumes either `user_data/backtest_results/` or
|
||||
`--export-directory` as base directory.
|
||||
--backtest-directory PATH, --export-directory PATH
|
||||
Directory to use for backtest results. Example:
|
||||
`--export-directory=user_data/backtest_results/`.
|
||||
--breakdown {day,week,month,year,weekday} [{day,week,month,year,weekday} ...]
|
||||
Show backtesting breakdown per [day, week, month,
|
||||
year, weekday].
|
||||
--cache {none,day,week,month}
|
||||
Load a cached backtest result no older than specified
|
||||
age (default: day).
|
||||
--freqai-backtest-live-models
|
||||
Run backtest with ready models.
|
||||
--notes TEXT Add notes to the backtest results.
|
||||
<span class="go">options:</span>
|
||||
<span class="go"> -h, --help show this help message and exit</span>
|
||||
<span class="go"> -i, --timeframe TIMEFRAME</span>
|
||||
<span class="go"> Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).</span>
|
||||
<span class="go"> --timerange TIMERANGE</span>
|
||||
<span class="go"> Specify what timerange of data to use.</span>
|
||||
<span class="go"> --data-format-ohlcv {json,jsongz,feather,parquet}</span>
|
||||
<span class="go"> Storage format for downloaded candle (OHLCV) data.</span>
|
||||
<span class="go"> (default: `feather`).</span>
|
||||
<span class="go"> --max-open-trades INT</span>
|
||||
<span class="go"> Override the value of the `max_open_trades`</span>
|
||||
<span class="go"> configuration setting.</span>
|
||||
<span class="go"> --stake-amount STAKE_AMOUNT</span>
|
||||
<span class="go"> Override the value of the `stake_amount` configuration</span>
|
||||
<span class="go"> setting.</span>
|
||||
<span class="go"> --fee FLOAT Specify fee ratio. Will be applied twice (on trade</span>
|
||||
<span class="go"> entry and exit).</span>
|
||||
<span class="go"> -p, --pairs PAIRS [PAIRS ...]</span>
|
||||
<span class="go"> Limit command to these pairs. Pairs are space-</span>
|
||||
<span class="go"> separated.</span>
|
||||
<span class="go"> --eps, --enable-position-stacking</span>
|
||||
<span class="go"> Allow buying the same pair multiple times (position</span>
|
||||
<span class="go"> stacking).</span>
|
||||
<span class="go"> --enable-protections, --enableprotections</span>
|
||||
<span class="go"> Enable protections for backtesting. Will slow</span>
|
||||
<span class="go"> backtesting down by a considerable amount, but will</span>
|
||||
<span class="go"> include configured protections</span>
|
||||
<span class="go"> --enable-dynamic-pairlist</span>
|
||||
<span class="go"> Enables dynamic pairlist refreshes in backtesting. The</span>
|
||||
<span class="go"> pairlist will be generated for each new candle if</span>
|
||||
<span class="go"> you're using a pairlist handler that supports this</span>
|
||||
<span class="go"> feature, for example, ShuffleFilter.</span>
|
||||
<span class="go"> --dry-run-wallet, --starting-balance DRY_RUN_WALLET</span>
|
||||
<span class="go"> Starting balance, used for backtesting / hyperopt and</span>
|
||||
<span class="go"> dry-runs.</span>
|
||||
<span class="go"> --timeframe-detail TIMEFRAME_DETAIL</span>
|
||||
<span class="go"> Specify detail timeframe for backtesting (`1m`, `5m`,</span>
|
||||
<span class="go"> `30m`, `1h`, `1d`).</span>
|
||||
<span class="go"> --strategy-list STRATEGY_LIST [STRATEGY_LIST ...]</span>
|
||||
<span class="go"> Provide a space-separated list of strategies to</span>
|
||||
<span class="go"> backtest. Please note that timeframe needs to be set</span>
|
||||
<span class="go"> either in config or via command line. When using this</span>
|
||||
<span class="go"> together with `--export trades`, the strategy-name is</span>
|
||||
<span class="go"> injected into the filename (so `backtest-data.json`</span>
|
||||
<span class="go"> becomes `backtest-data-SampleStrategy.json`</span>
|
||||
<span class="go"> --export {none,trades,signals}</span>
|
||||
<span class="go"> Export backtest results (default: trades).</span>
|
||||
<span class="go"> --backtest-filename, --export-filename PATH</span>
|
||||
<span class="go"> Use this filename for backtest results.Example:</span>
|
||||
<span class="go"> `--backtest-</span>
|
||||
<span class="go"> filename=backtest_results_2020-09-27_16-20-48.json`.</span>
|
||||
<span class="go"> Assumes either `user_data/backtest_results/` or</span>
|
||||
<span class="go"> `--export-directory` as base directory.</span>
|
||||
<span class="go"> --backtest-directory, --export-directory PATH</span>
|
||||
<span class="go"> Directory to use for backtest results. Example:</span>
|
||||
<span class="go"> `--export-directory=user_data/backtest_results/`.</span>
|
||||
<span class="go"> --breakdown {day,week,month,year,weekday} [{day,week,month,year,weekday} ...]</span>
|
||||
<span class="go"> Show backtesting breakdown per [day, week, month,</span>
|
||||
<span class="go"> year, weekday].</span>
|
||||
<span class="go"> --cache {none,day,week,month}</span>
|
||||
<span class="go"> Load a cached backtest result no older than specified</span>
|
||||
<span class="go"> age (default: day).</span>
|
||||
<span class="go"> --freqai-backtest-live-models</span>
|
||||
<span class="go"> Run backtest with ready models.</span>
|
||||
<span class="go"> --notes TEXT Add notes to the backtest results.</span>
|
||||
|
||||
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:
|
||||
'syslog', 'journald'. See the documentation for more
|
||||
details.
|
||||
-V, --version show program'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 the base directory of the exchange with
|
||||
historical backtesting data. To see futures data, use
|
||||
trading-mode additionally.
|
||||
--userdir PATH, --user-data-dir PATH
|
||||
Path to userdata directory.
|
||||
<span class="go">Common arguments:</span>
|
||||
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
||||
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
||||
<span class="go"> useful if you are redirecting output to a file.</span>
|
||||
<span class="go"> --logfile, --log-file FILE</span>
|
||||
<span class="go"> Log to the file specified. Special values are:</span>
|
||||
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
||||
<span class="go"> details.</span>
|
||||
<span class="go"> -V, --version show program's version number and exit</span>
|
||||
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
||||
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
||||
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
||||
<span class="go"> set to `-` to read config from stdin.</span>
|
||||
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
||||
<span class="go"> Path to the base directory of the exchange with</span>
|
||||
<span class="go"> historical backtesting data. To see futures data, use</span>
|
||||
<span class="go"> trading-mode additionally.</span>
|
||||
<span class="go"> --userdir, --user-data-dir PATH</span>
|
||||
<span class="go"> Path to userdata directory.</span>
|
||||
|
||||
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.
|
||||
<span class="go">Strategy arguments:</span>
|
||||
<span class="go"> -s, --strategy NAME Specify strategy class name which will be used by the</span>
|
||||
<span class="go"> bot.</span>
|
||||
<span class="go"> --strategy-path PATH Specify additional strategy lookup path.</span>
|
||||
<span class="go"> --recursive-strategy-search</span>
|
||||
<span class="go"> Recursively search for a strategy in the strategies</span>
|
||||
<span class="go"> folder.</span>
|
||||
<span class="go"> --freqaimodel NAME Specify a custom freqaimodels.</span>
|
||||
<span class="go"> --freqaimodel-path PATH</span>
|
||||
<span class="go"> Specify additional lookup path for freqaimodels.</span>
|
||||
</code></pre></div>
|
||||
<h2 id="test-your-strategy-with-backtesting">Test your strategy with Backtesting<a class="headerlink" href="#test-your-strategy-with-backtesting" title="Permanent link">¶</a></h2>
|
||||
<p>Now you have good Entry and exit strategies and some historic data, you want to test it against
|
||||
|
||||
@@ -1865,110 +1865,107 @@
|
||||
<p>The clock on the system running the bot must be accurate, synchronized to a NTP server frequently enough to avoid problems with communication to the exchanges.</p>
|
||||
</div>
|
||||
<h2 id="bot-commands">Bot commands<a class="headerlink" href="#bot-commands" title="Permanent link">¶</a></h2>
|
||||
<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-hyperoptloss,list-freqaimodels,list-timeframes,show-trades,test-pairlist,convert-db,install-ui,plot-dataframe,plot-profit,webserver,strategy-updater,lookahead-analysis,recursive-analysis}
|
||||
...
|
||||
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade [-h] [-V]</span>
|
||||
<span class="go"> {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} ...</span>
|
||||
|
||||
Free, open source crypto trading bot
|
||||
<span class="go">Free, open source crypto trading bot</span>
|
||||
|
||||
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-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.
|
||||
create-userdir Create user-data directory.
|
||||
new-config Create new config
|
||||
show-config Show resolved config
|
||||
new-strategy Create new strategy
|
||||
download-data Download backtesting data.
|
||||
convert-data Convert candle (OHLCV) data from one format to
|
||||
another.
|
||||
convert-trade-data Convert trade data from one format to another.
|
||||
trades-to-ohlcv Convert trade data to OHLCV data.
|
||||
list-data List downloaded data.
|
||||
backtesting Backtesting module.
|
||||
backtesting-show Show past Backtest results
|
||||
backtesting-analysis
|
||||
Backtest Analysis module.
|
||||
edge Edge module. No longer part of Freqtrade
|
||||
hyperopt Hyperopt module.
|
||||
hyperopt-list List Hyperopt results
|
||||
hyperopt-show Show details of Hyperopt results
|
||||
list-exchanges Print available exchanges.
|
||||
list-markets Print markets on exchange.
|
||||
list-pairs Print pairs on exchange.
|
||||
list-strategies Print available strategies.
|
||||
list-hyperoptloss Print available hyperopt loss functions.
|
||||
list-freqaimodels Print available freqAI models.
|
||||
list-timeframes Print available timeframes for the exchange.
|
||||
show-trades Show trades.
|
||||
test-pairlist Test your pairlist configuration.
|
||||
convert-db Migrate database to different system
|
||||
install-ui Install FreqUI
|
||||
plot-dataframe Plot candles with indicators.
|
||||
plot-profit Generate plot showing profits.
|
||||
webserver Webserver module.
|
||||
strategy-updater updates outdated strategy files to the current version
|
||||
lookahead-analysis Check for potential look ahead bias.
|
||||
recursive-analysis Check for potential recursive formula issue.
|
||||
<span class="go">positional arguments:</span>
|
||||
<span class="go"> {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}</span>
|
||||
<span class="go"> trade Trade module.</span>
|
||||
<span class="go"> create-userdir Create user-data directory.</span>
|
||||
<span class="go"> new-config Create new config</span>
|
||||
<span class="go"> show-config Show resolved config</span>
|
||||
<span class="go"> new-strategy Create new strategy</span>
|
||||
<span class="go"> download-data Download backtesting data.</span>
|
||||
<span class="go"> convert-data Convert candle (OHLCV) data from one format to</span>
|
||||
<span class="go"> another.</span>
|
||||
<span class="go"> convert-trade-data Convert trade data from one format to another.</span>
|
||||
<span class="go"> trades-to-ohlcv Convert trade data to OHLCV data.</span>
|
||||
<span class="go"> list-data List downloaded data.</span>
|
||||
<span class="go"> backtesting Backtesting module.</span>
|
||||
<span class="go"> backtesting-show Show past Backtest results</span>
|
||||
<span class="go"> backtesting-analysis</span>
|
||||
<span class="go"> Backtest Analysis module.</span>
|
||||
<span class="go"> edge Edge module. No longer part of Freqtrade</span>
|
||||
<span class="go"> hyperopt Hyperopt module.</span>
|
||||
<span class="go"> hyperopt-list List Hyperopt results</span>
|
||||
<span class="go"> hyperopt-show Show details of Hyperopt results</span>
|
||||
<span class="go"> list-exchanges Print available exchanges.</span>
|
||||
<span class="go"> list-markets Print markets on exchange.</span>
|
||||
<span class="go"> list-pairs Print pairs on exchange.</span>
|
||||
<span class="go"> list-strategies Print available strategies.</span>
|
||||
<span class="go"> list-hyperoptloss Print available hyperopt loss functions.</span>
|
||||
<span class="go"> list-freqaimodels Print available freqAI models.</span>
|
||||
<span class="go"> list-timeframes Print available timeframes for the exchange.</span>
|
||||
<span class="go"> show-trades Show trades.</span>
|
||||
<span class="go"> test-pairlist Test your pairlist configuration.</span>
|
||||
<span class="go"> convert-db Migrate database to different system</span>
|
||||
<span class="go"> install-ui Install FreqUI</span>
|
||||
<span class="go"> plot-dataframe Plot candles with indicators.</span>
|
||||
<span class="go"> plot-profit Generate plot showing profits.</span>
|
||||
<span class="go"> webserver Webserver module.</span>
|
||||
<span class="go"> strategy-updater updates outdated strategy files to the current version</span>
|
||||
<span class="go"> lookahead-analysis Check for potential look ahead bias.</span>
|
||||
<span class="go"> recursive-analysis Check for potential recursive formula issue.</span>
|
||||
|
||||
options:
|
||||
-h, --help show this help message and exit
|
||||
-V, --version show program's version number and exit
|
||||
<span class="go">options:</span>
|
||||
<span class="go"> -h, --help show this help message and exit</span>
|
||||
<span class="go"> -V, --version show program's version number and exit</span>
|
||||
</code></pre></div>
|
||||
<h3 id="bot-trading-commands">Bot trading commands<a class="headerlink" href="#bot-trading-commands" title="Permanent link">¶</a></h3>
|
||||
<div class="highlight"><pre><span></span><code>usage: freqtrade trade [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c 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]
|
||||
[--dry-run-wallet DRY_RUN_WALLET] [--fee FLOAT]
|
||||
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade trade [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH]</span>
|
||||
<span class="go"> [-d PATH] [--userdir PATH] [-s NAME]</span>
|
||||
<span class="go"> [--strategy-path PATH] [--recursive-strategy-search]</span>
|
||||
<span class="go"> [--freqaimodel NAME] [--freqaimodel-path PATH]</span>
|
||||
<span class="go"> [--db-url PATH] [--sd-notify] [--dry-run]</span>
|
||||
<span class="go"> [--dry-run-wallet DRY_RUN_WALLET] [--fee FLOAT]</span>
|
||||
|
||||
options:
|
||||
-h, --help show this help message and exit
|
||||
--db-url PATH Override trades database URL, this is useful in custom
|
||||
deployments (default: `sqlite:///tradesv3.sqlite` for
|
||||
Live Run mode, `sqlite:///tradesv3.dryrun.sqlite` for
|
||||
Dry Run).
|
||||
--sd-notify Notify systemd service manager.
|
||||
--dry-run Enforce dry-run for trading (removes Exchange secrets
|
||||
and simulates trades).
|
||||
--dry-run-wallet DRY_RUN_WALLET, --starting-balance DRY_RUN_WALLET
|
||||
Starting balance, used for backtesting / hyperopt and
|
||||
dry-runs.
|
||||
--fee FLOAT Specify fee ratio. Will be applied twice (on trade
|
||||
entry and exit).
|
||||
<span class="go">options:</span>
|
||||
<span class="go"> -h, --help show this help message and exit</span>
|
||||
<span class="go"> --db-url PATH Override trades database URL, this is useful in custom</span>
|
||||
<span class="go"> deployments (default: `sqlite:///tradesv3.sqlite` for</span>
|
||||
<span class="go"> Live Run mode, `sqlite:///tradesv3.dryrun.sqlite` for</span>
|
||||
<span class="go"> Dry Run).</span>
|
||||
<span class="go"> --sd-notify Notify systemd service manager.</span>
|
||||
<span class="go"> --dry-run Enforce dry-run for trading (removes Exchange secrets</span>
|
||||
<span class="go"> and simulates trades).</span>
|
||||
<span class="go"> --dry-run-wallet, --starting-balance DRY_RUN_WALLET</span>
|
||||
<span class="go"> Starting balance, used for backtesting / hyperopt and</span>
|
||||
<span class="go"> dry-runs.</span>
|
||||
<span class="go"> --fee FLOAT Specify fee ratio. Will be applied twice (on trade</span>
|
||||
<span class="go"> entry and exit).</span>
|
||||
|
||||
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:
|
||||
'syslog', 'journald'. See the documentation for more
|
||||
details.
|
||||
-V, --version show program'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 the base directory of the exchange with
|
||||
historical backtesting data. To see futures data, use
|
||||
trading-mode additionally.
|
||||
--userdir PATH, --user-data-dir PATH
|
||||
Path to userdata directory.
|
||||
<span class="go">Common arguments:</span>
|
||||
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
||||
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
||||
<span class="go"> useful if you are redirecting output to a file.</span>
|
||||
<span class="go"> --logfile, --log-file FILE</span>
|
||||
<span class="go"> Log to the file specified. Special values are:</span>
|
||||
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
||||
<span class="go"> details.</span>
|
||||
<span class="go"> -V, --version show program's version number and exit</span>
|
||||
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
||||
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
||||
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
||||
<span class="go"> set to `-` to read config from stdin.</span>
|
||||
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
||||
<span class="go"> Path to the base directory of the exchange with</span>
|
||||
<span class="go"> historical backtesting data. To see futures data, use</span>
|
||||
<span class="go"> trading-mode additionally.</span>
|
||||
<span class="go"> --userdir, --user-data-dir PATH</span>
|
||||
<span class="go"> Path to userdata directory.</span>
|
||||
|
||||
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.
|
||||
<span class="go">Strategy arguments:</span>
|
||||
<span class="go"> -s, --strategy NAME Specify strategy class name which will be used by the</span>
|
||||
<span class="go"> bot.</span>
|
||||
<span class="go"> --strategy-path PATH Specify additional strategy lookup path.</span>
|
||||
<span class="go"> --recursive-strategy-search</span>
|
||||
<span class="go"> Recursively search for a strategy in the strategies</span>
|
||||
<span class="go"> folder.</span>
|
||||
<span class="go"> --freqaimodel NAME Specify a custom freqaimodels.</span>
|
||||
<span class="go"> --freqaimodel-path PATH</span>
|
||||
<span class="go"> Specify additional lookup path for freqaimodels.</span>
|
||||
</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">¶</a></h3>
|
||||
<p>The bot allows you to select which configuration file you want to use by means of
|
||||
|
||||
@@ -2059,79 +2059,78 @@ 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>
|
||||
</div>
|
||||
<h3 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">¶</a></h3>
|
||||
<div class="highlight"><pre><span></span><code>usage: freqtrade download-data [-h] [-v] [--no-color] [--logfile FILE] [-V]
|
||||
[-c PATH] [-d PATH] [--userdir PATH]
|
||||
[-p PAIRS [PAIRS ...]] [--pairs-file FILE]
|
||||
[--days INT] [--new-pairs-days INT]
|
||||
[--include-inactive-pairs]
|
||||
[--no-parallel-download]
|
||||
[--timerange TIMERANGE] [--dl-trades]
|
||||
[--convert] [--exchange EXCHANGE]
|
||||
[-t TIMEFRAMES [TIMEFRAMES ...]] [--erase]
|
||||
[--data-format-ohlcv {json,jsongz,feather,parquet}]
|
||||
[--data-format-trades {json,jsongz,feather,parquet}]
|
||||
[--trading-mode {spot,margin,futures}]
|
||||
[--prepend]
|
||||
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade download-data [-h] [-v] [--no-color] [--logfile FILE] [-V]</span>
|
||||
<span class="go"> [-c PATH] [-d PATH] [--userdir PATH]</span>
|
||||
<span class="go"> [-p PAIRS [PAIRS ...]] [--pairs-file FILE]</span>
|
||||
<span class="go"> [--days INT] [--new-pairs-days INT]</span>
|
||||
<span class="go"> [--include-inactive-pairs]</span>
|
||||
<span class="go"> [--no-parallel-download]</span>
|
||||
<span class="go"> [--timerange TIMERANGE] [--dl-trades]</span>
|
||||
<span class="go"> [--convert] [--exchange EXCHANGE]</span>
|
||||
<span class="go"> [-t TIMEFRAMES [TIMEFRAMES ...]] [--erase]</span>
|
||||
<span class="go"> [--data-format-ohlcv {json,jsongz,feather,parquet}]</span>
|
||||
<span class="go"> [--data-format-trades {json,jsongz,feather,parquet}]</span>
|
||||
<span class="go"> [--trading-mode {spot,margin,futures}]</span>
|
||||
<span class="go"> [--prepend]</span>
|
||||
|
||||
options:
|
||||
-h, --help show this help message and exit
|
||||
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
|
||||
Limit command to these pairs. Pairs are space-
|
||||
separated.
|
||||
--pairs-file FILE File containing a list of pairs. Takes precedence over
|
||||
--pairs or pairs configured in the configuration.
|
||||
--days INT Download data for given number of days.
|
||||
--new-pairs-days INT Download data of new pairs for given number of days.
|
||||
Default: `None`.
|
||||
--include-inactive-pairs
|
||||
Also download data from inactive pairs.
|
||||
--no-parallel-download
|
||||
Disable parallel startup download. Only use this if
|
||||
you experience issues.
|
||||
--timerange TIMERANGE
|
||||
Specify what timerange of data to use.
|
||||
--dl-trades Download trades instead of OHLCV data.
|
||||
--convert Convert downloaded trades to OHLCV data. Only
|
||||
applicable in combination with `--dl-trades`. Will be
|
||||
automatic for exchanges which don't have historic
|
||||
OHLCV (e.g. Kraken). If not provided, use `trades-to-
|
||||
ohlcv` to convert trades data to OHLCV data.
|
||||
--exchange EXCHANGE Exchange name. Only valid if no config is provided.
|
||||
-t TIMEFRAMES [TIMEFRAMES ...], --timeframes TIMEFRAMES [TIMEFRAMES ...]
|
||||
Specify which tickers to download. Space-separated
|
||||
list. Default: `1m 5m`.
|
||||
--erase Clean all existing data for the selected
|
||||
exchange/pairs/timeframes.
|
||||
--data-format-ohlcv {json,jsongz,feather,parquet}
|
||||
Storage format for downloaded candle (OHLCV) data.
|
||||
(default: `feather`).
|
||||
--data-format-trades {json,jsongz,feather,parquet}
|
||||
Storage format for downloaded trades data. (default:
|
||||
`feather`).
|
||||
--trading-mode {spot,margin,futures}, --tradingmode {spot,margin,futures}
|
||||
Select Trading mode
|
||||
--prepend Allow data prepending. (Data-appending is disabled)
|
||||
<span class="go">options:</span>
|
||||
<span class="go"> -h, --help show this help message and exit</span>
|
||||
<span class="go"> -p, --pairs PAIRS [PAIRS ...]</span>
|
||||
<span class="go"> Limit command to these pairs. Pairs are space-</span>
|
||||
<span class="go"> separated.</span>
|
||||
<span class="go"> --pairs-file FILE File containing a list of pairs. Takes precedence over</span>
|
||||
<span class="go"> --pairs or pairs configured in the configuration.</span>
|
||||
<span class="go"> --days INT Download data for given number of days.</span>
|
||||
<span class="go"> --new-pairs-days INT Download data of new pairs for given number of days.</span>
|
||||
<span class="go"> Default: `None`.</span>
|
||||
<span class="go"> --include-inactive-pairs</span>
|
||||
<span class="go"> Also download data from inactive pairs.</span>
|
||||
<span class="go"> --no-parallel-download</span>
|
||||
<span class="go"> Disable parallel startup download. Only use this if</span>
|
||||
<span class="go"> you experience issues.</span>
|
||||
<span class="go"> --timerange TIMERANGE</span>
|
||||
<span class="go"> Specify what timerange of data to use.</span>
|
||||
<span class="go"> --dl-trades Download trades instead of OHLCV data.</span>
|
||||
<span class="go"> --convert Convert downloaded trades to OHLCV data. Only</span>
|
||||
<span class="go"> applicable in combination with `--dl-trades`. Will be</span>
|
||||
<span class="go"> automatic for exchanges which don't have historic</span>
|
||||
<span class="go"> OHLCV (e.g. Kraken). If not provided, use `trades-to-</span>
|
||||
<span class="go"> ohlcv` to convert trades data to OHLCV data.</span>
|
||||
<span class="go"> --exchange EXCHANGE Exchange name. Only valid if no config is provided.</span>
|
||||
<span class="go"> -t, --timeframes TIMEFRAMES [TIMEFRAMES ...]</span>
|
||||
<span class="go"> Specify which tickers to download. Space-separated</span>
|
||||
<span class="go"> list. Default: `1m 5m`.</span>
|
||||
<span class="go"> --erase Clean all existing data for the selected</span>
|
||||
<span class="go"> exchange/pairs/timeframes.</span>
|
||||
<span class="go"> --data-format-ohlcv {json,jsongz,feather,parquet}</span>
|
||||
<span class="go"> Storage format for downloaded candle (OHLCV) data.</span>
|
||||
<span class="go"> (default: `feather`).</span>
|
||||
<span class="go"> --data-format-trades {json,jsongz,feather,parquet}</span>
|
||||
<span class="go"> Storage format for downloaded trades data. (default:</span>
|
||||
<span class="go"> `feather`).</span>
|
||||
<span class="go"> --trading-mode, --tradingmode {spot,margin,futures}</span>
|
||||
<span class="go"> Select Trading mode</span>
|
||||
<span class="go"> --prepend Allow data prepending. (Data-appending is disabled)</span>
|
||||
|
||||
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:
|
||||
'syslog', 'journald'. See the documentation for more
|
||||
details.
|
||||
-V, --version show program'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 the base directory of the exchange with
|
||||
historical backtesting data. To see futures data, use
|
||||
trading-mode additionally.
|
||||
--userdir PATH, --user-data-dir PATH
|
||||
Path to userdata directory.
|
||||
<span class="go">Common arguments:</span>
|
||||
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
||||
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
||||
<span class="go"> useful if you are redirecting output to a file.</span>
|
||||
<span class="go"> --logfile, --log-file FILE</span>
|
||||
<span class="go"> Log to the file specified. Special values are:</span>
|
||||
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
||||
<span class="go"> details.</span>
|
||||
<span class="go"> -V, --version show program's version number and exit</span>
|
||||
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
||||
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
||||
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
||||
<span class="go"> set to `-` to read config from stdin.</span>
|
||||
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
||||
<span class="go"> Path to the base directory of the exchange with</span>
|
||||
<span class="go"> historical backtesting data. To see futures data, use</span>
|
||||
<span class="go"> trading-mode additionally.</span>
|
||||
<span class="go"> --userdir, --user-data-dir PATH</span>
|
||||
<span class="go"> Path to userdata directory.</span>
|
||||
</code></pre></div>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Downloading all data for one quote currency</p>
|
||||
@@ -2280,57 +2279,56 @@ 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>
|
||||
</div>
|
||||
<h2 id="sub-command-convert-data">Sub-command convert data<a class="headerlink" href="#sub-command-convert-data" title="Permanent link">¶</a></h2>
|
||||
<div class="highlight"><pre><span></span><code>usage: freqtrade convert-data [-h] [-v] [--no-color] [--logfile FILE] [-V]
|
||||
[-c PATH] [-d PATH] [--userdir PATH]
|
||||
[-p PAIRS [PAIRS ...]] --format-from
|
||||
{json,jsongz,feather,parquet} --format-to
|
||||
{json,jsongz,feather,parquet} [--erase]
|
||||
[--exchange EXCHANGE]
|
||||
[-t TIMEFRAMES [TIMEFRAMES ...]]
|
||||
[--trading-mode {spot,margin,futures}]
|
||||
[--candle-types {spot,futures,mark,index,premiumIndex,funding_rate} [{spot,futures,mark,index,premiumIndex,funding_rate} ...]]
|
||||
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade convert-data [-h] [-v] [--no-color] [--logfile FILE] [-V]</span>
|
||||
<span class="go"> [-c PATH] [-d PATH] [--userdir PATH]</span>
|
||||
<span class="go"> [-p PAIRS [PAIRS ...]]</span>
|
||||
<span class="go"> --format-from {json,jsongz,feather,parquet}</span>
|
||||
<span class="go"> --format-to {json,jsongz,feather,parquet}</span>
|
||||
<span class="go"> [--erase] [--exchange EXCHANGE]</span>
|
||||
<span class="go"> [-t TIMEFRAMES [TIMEFRAMES ...]]</span>
|
||||
<span class="go"> [--trading-mode {spot,margin,futures}]</span>
|
||||
<span class="go"> [--candle-types {spot,futures,mark,index,premiumIndex,funding_rate} [{spot,futures,mark,index,premiumIndex,funding_rate} ...]]</span>
|
||||
|
||||
options:
|
||||
-h, --help show this help message and exit
|
||||
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
|
||||
Limit command to these pairs. Pairs are space-
|
||||
separated.
|
||||
--format-from {json,jsongz,feather,parquet}
|
||||
Source format for data conversion.
|
||||
--format-to {json,jsongz,feather,parquet}
|
||||
Destination format for data conversion.
|
||||
--erase Clean all existing data for the selected
|
||||
exchange/pairs/timeframes.
|
||||
--exchange EXCHANGE Exchange name. Only valid if no config is provided.
|
||||
-t TIMEFRAMES [TIMEFRAMES ...], --timeframes TIMEFRAMES [TIMEFRAMES ...]
|
||||
Specify which tickers to download. Space-separated
|
||||
list. Default: `1m 5m`.
|
||||
--trading-mode {spot,margin,futures}, --tradingmode {spot,margin,futures}
|
||||
Select Trading mode
|
||||
--candle-types {spot,futures,mark,index,premiumIndex,funding_rate} [{spot,futures,mark,index,premiumIndex,funding_rate} ...]
|
||||
Select candle type to convert. Defaults to all
|
||||
available types.
|
||||
<span class="go">options:</span>
|
||||
<span class="go"> -h, --help show this help message and exit</span>
|
||||
<span class="go"> -p, --pairs PAIRS [PAIRS ...]</span>
|
||||
<span class="go"> Limit command to these pairs. Pairs are space-</span>
|
||||
<span class="go"> separated.</span>
|
||||
<span class="go"> --format-from {json,jsongz,feather,parquet}</span>
|
||||
<span class="go"> Source format for data conversion.</span>
|
||||
<span class="go"> --format-to {json,jsongz,feather,parquet}</span>
|
||||
<span class="go"> Destination format for data conversion.</span>
|
||||
<span class="go"> --erase Clean all existing data for the selected</span>
|
||||
<span class="go"> exchange/pairs/timeframes.</span>
|
||||
<span class="go"> --exchange EXCHANGE Exchange name. Only valid if no config is provided.</span>
|
||||
<span class="go"> -t, --timeframes TIMEFRAMES [TIMEFRAMES ...]</span>
|
||||
<span class="go"> Specify which tickers to download. Space-separated</span>
|
||||
<span class="go"> list. Default: `1m 5m`.</span>
|
||||
<span class="go"> --trading-mode, --tradingmode {spot,margin,futures}</span>
|
||||
<span class="go"> Select Trading mode</span>
|
||||
<span class="go"> --candle-types {spot,futures,mark,index,premiumIndex,funding_rate} [{spot,futures,mark,index,premiumIndex,funding_rate} ...]</span>
|
||||
<span class="go"> Select candle type to convert. Defaults to all</span>
|
||||
<span class="go"> available types.</span>
|
||||
|
||||
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:
|
||||
'syslog', 'journald'. See the documentation for more
|
||||
details.
|
||||
-V, --version show program'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 the base directory of the exchange with
|
||||
historical backtesting data. To see futures data, use
|
||||
trading-mode additionally.
|
||||
--userdir PATH, --user-data-dir PATH
|
||||
Path to userdata directory.
|
||||
<span class="go">Common arguments:</span>
|
||||
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
||||
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
||||
<span class="go"> useful if you are redirecting output to a file.</span>
|
||||
<span class="go"> --logfile, --log-file FILE</span>
|
||||
<span class="go"> Log to the file specified. Special values are:</span>
|
||||
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
||||
<span class="go"> details.</span>
|
||||
<span class="go"> -V, --version show program's version number and exit</span>
|
||||
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
||||
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
||||
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
||||
<span class="go"> set to `-` to read config from stdin.</span>
|
||||
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
||||
<span class="go"> Path to the base directory of the exchange with</span>
|
||||
<span class="go"> historical backtesting data. To see futures data, use</span>
|
||||
<span class="go"> trading-mode additionally.</span>
|
||||
<span class="go"> --userdir, --user-data-dir PATH</span>
|
||||
<span class="go"> Path to userdata directory.</span>
|
||||
</code></pre></div>
|
||||
<h3 id="example-converting-data">Example converting data<a class="headerlink" href="#example-converting-data" title="Permanent link">¶</a></h3>
|
||||
<p>The following command will convert all candle (OHLCV) data available in <code>~/.freqtrade/data/binance</code> from json to jsongz, saving diskspace in the process.
|
||||
@@ -2338,46 +2336,45 @@ 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
|
||||
</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">¶</a></h2>
|
||||
<div class="highlight"><pre><span></span><code>usage: freqtrade convert-trade-data [-h] [-v] [--no-color] [--logfile FILE]
|
||||
[-V] [-c PATH] [-d PATH] [--userdir PATH]
|
||||
[-p PAIRS [PAIRS ...]] --format-from
|
||||
{json,jsongz,feather,parquet,kraken_csv}
|
||||
--format-to {json,jsongz,feather,parquet}
|
||||
[--erase] [--exchange EXCHANGE]
|
||||
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade convert-trade-data [-h] [-v] [--no-color] [--logfile FILE]</span>
|
||||
<span class="go"> [-V] [-c PATH] [-d PATH] [--userdir PATH]</span>
|
||||
<span class="go"> [-p PAIRS [PAIRS ...]]</span>
|
||||
<span class="go"> --format-from {json,jsongz,feather,parquet,kraken_csv}</span>
|
||||
<span class="go"> --format-to {json,jsongz,feather,parquet}</span>
|
||||
<span class="go"> [--erase] [--exchange EXCHANGE]</span>
|
||||
|
||||
options:
|
||||
-h, --help show this help message and exit
|
||||
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
|
||||
Limit command to these pairs. Pairs are space-
|
||||
separated.
|
||||
--format-from {json,jsongz,feather,parquet,kraken_csv}
|
||||
Source format for data conversion.
|
||||
--format-to {json,jsongz,feather,parquet}
|
||||
Destination format for data conversion.
|
||||
--erase Clean all existing data for the selected
|
||||
exchange/pairs/timeframes.
|
||||
--exchange EXCHANGE Exchange name. Only valid if no config is provided.
|
||||
<span class="go">options:</span>
|
||||
<span class="go"> -h, --help show this help message and exit</span>
|
||||
<span class="go"> -p, --pairs PAIRS [PAIRS ...]</span>
|
||||
<span class="go"> Limit command to these pairs. Pairs are space-</span>
|
||||
<span class="go"> separated.</span>
|
||||
<span class="go"> --format-from {json,jsongz,feather,parquet,kraken_csv}</span>
|
||||
<span class="go"> Source format for data conversion.</span>
|
||||
<span class="go"> --format-to {json,jsongz,feather,parquet}</span>
|
||||
<span class="go"> Destination format for data conversion.</span>
|
||||
<span class="go"> --erase Clean all existing data for the selected</span>
|
||||
<span class="go"> exchange/pairs/timeframes.</span>
|
||||
<span class="go"> --exchange EXCHANGE Exchange name. Only valid if no config is provided.</span>
|
||||
|
||||
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:
|
||||
'syslog', 'journald'. See the documentation for more
|
||||
details.
|
||||
-V, --version show program'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 the base directory of the exchange with
|
||||
historical backtesting data. To see futures data, use
|
||||
trading-mode additionally.
|
||||
--userdir PATH, --user-data-dir PATH
|
||||
Path to userdata directory.
|
||||
<span class="go">Common arguments:</span>
|
||||
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
||||
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
||||
<span class="go"> useful if you are redirecting output to a file.</span>
|
||||
<span class="go"> --logfile, --log-file FILE</span>
|
||||
<span class="go"> Log to the file specified. Special values are:</span>
|
||||
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
||||
<span class="go"> details.</span>
|
||||
<span class="go"> -V, --version show program's version number and exit</span>
|
||||
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
||||
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
||||
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
||||
<span class="go"> set to `-` to read config from stdin.</span>
|
||||
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
||||
<span class="go"> Path to the base directory of the exchange with</span>
|
||||
<span class="go"> historical backtesting data. To see futures data, use</span>
|
||||
<span class="go"> trading-mode additionally.</span>
|
||||
<span class="go"> --userdir, --user-data-dir PATH</span>
|
||||
<span class="go"> Path to userdata directory.</span>
|
||||
</code></pre></div>
|
||||
<h3 id="example-converting-trades">Example converting trades<a class="headerlink" href="#example-converting-trades" title="Permanent link">¶</a></h3>
|
||||
<p>The following command will convert all available trade-data in <code>~/.freqtrade/data/kraken</code> from jsongz to json.
|
||||
@@ -2387,106 +2384,104 @@ 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">¶</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.
|
||||
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] [--no-color] [--logfile FILE] [-V]
|
||||
[-c PATH] [-d PATH] [--userdir PATH]
|
||||
[-p PAIRS [PAIRS ...]]
|
||||
[-t TIMEFRAMES [TIMEFRAMES ...]]
|
||||
[--exchange EXCHANGE]
|
||||
[--data-format-ohlcv {json,jsongz,feather,parquet}]
|
||||
[--data-format-trades {json,jsongz,feather,parquet}]
|
||||
[--trading-mode {spot,margin,futures}]
|
||||
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade trades-to-ohlcv [-h] [-v] [--no-color] [--logfile FILE] [-V]</span>
|
||||
<span class="go"> [-c PATH] [-d PATH] [--userdir PATH]</span>
|
||||
<span class="go"> [-p PAIRS [PAIRS ...]]</span>
|
||||
<span class="go"> [-t TIMEFRAMES [TIMEFRAMES ...]]</span>
|
||||
<span class="go"> [--exchange EXCHANGE]</span>
|
||||
<span class="go"> [--data-format-ohlcv {json,jsongz,feather,parquet}]</span>
|
||||
<span class="go"> [--data-format-trades {json,jsongz,feather,parquet}]</span>
|
||||
<span class="go"> [--trading-mode {spot,margin,futures}]</span>
|
||||
|
||||
options:
|
||||
-h, --help show this help message and exit
|
||||
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
|
||||
Limit command to these pairs. Pairs are space-
|
||||
separated.
|
||||
-t TIMEFRAMES [TIMEFRAMES ...], --timeframes TIMEFRAMES [TIMEFRAMES ...]
|
||||
Specify which tickers to download. Space-separated
|
||||
list. Default: `1m 5m`.
|
||||
--exchange EXCHANGE Exchange name. Only valid if no config is provided.
|
||||
--data-format-ohlcv {json,jsongz,feather,parquet}
|
||||
Storage format for downloaded candle (OHLCV) data.
|
||||
(default: `feather`).
|
||||
--data-format-trades {json,jsongz,feather,parquet}
|
||||
Storage format for downloaded trades data. (default:
|
||||
`feather`).
|
||||
--trading-mode {spot,margin,futures}, --tradingmode {spot,margin,futures}
|
||||
Select Trading mode
|
||||
<span class="go">options:</span>
|
||||
<span class="go"> -h, --help show this help message and exit</span>
|
||||
<span class="go"> -p, --pairs PAIRS [PAIRS ...]</span>
|
||||
<span class="go"> Limit command to these pairs. Pairs are space-</span>
|
||||
<span class="go"> separated.</span>
|
||||
<span class="go"> -t, --timeframes TIMEFRAMES [TIMEFRAMES ...]</span>
|
||||
<span class="go"> Specify which tickers to download. Space-separated</span>
|
||||
<span class="go"> list. Default: `1m 5m`.</span>
|
||||
<span class="go"> --exchange EXCHANGE Exchange name. Only valid if no config is provided.</span>
|
||||
<span class="go"> --data-format-ohlcv {json,jsongz,feather,parquet}</span>
|
||||
<span class="go"> Storage format for downloaded candle (OHLCV) data.</span>
|
||||
<span class="go"> (default: `feather`).</span>
|
||||
<span class="go"> --data-format-trades {json,jsongz,feather,parquet}</span>
|
||||
<span class="go"> Storage format for downloaded trades data. (default:</span>
|
||||
<span class="go"> `feather`).</span>
|
||||
<span class="go"> --trading-mode, --tradingmode {spot,margin,futures}</span>
|
||||
<span class="go"> Select Trading mode</span>
|
||||
|
||||
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:
|
||||
'syslog', 'journald'. See the documentation for more
|
||||
details.
|
||||
-V, --version show program'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 the base directory of the exchange with
|
||||
historical backtesting data. To see futures data, use
|
||||
trading-mode additionally.
|
||||
--userdir PATH, --user-data-dir PATH
|
||||
Path to userdata directory.
|
||||
<span class="go">Common arguments:</span>
|
||||
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
||||
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
||||
<span class="go"> useful if you are redirecting output to a file.</span>
|
||||
<span class="go"> --logfile, --log-file FILE</span>
|
||||
<span class="go"> Log to the file specified. Special values are:</span>
|
||||
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
||||
<span class="go"> details.</span>
|
||||
<span class="go"> -V, --version show program's version number and exit</span>
|
||||
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
||||
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
||||
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
||||
<span class="go"> set to `-` to read config from stdin.</span>
|
||||
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
||||
<span class="go"> Path to the base directory of the exchange with</span>
|
||||
<span class="go"> historical backtesting data. To see futures data, use</span>
|
||||
<span class="go"> trading-mode additionally.</span>
|
||||
<span class="go"> --userdir, --user-data-dir PATH</span>
|
||||
<span class="go"> Path to userdata directory.</span>
|
||||
</code></pre></div>
|
||||
<h3 id="example-trade-to-ohlcv-conversion">Example trade-to-ohlcv conversion<a class="headerlink" href="#example-trade-to-ohlcv-conversion" title="Permanent link">¶</a></h3>
|
||||
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>trades-to-ohlcv<span class="w"> </span>--exchange<span class="w"> </span>kraken<span class="w"> </span>-t<span class="w"> </span>5m<span class="w"> </span>1h<span class="w"> </span>1d<span class="w"> </span>--pairs<span class="w"> </span>BTC/EUR<span class="w"> </span>ETH/EUR
|
||||
</code></pre></div>
|
||||
<h2 id="sub-command-list-data">Sub-command list-data<a class="headerlink" href="#sub-command-list-data" title="Permanent link">¶</a></h2>
|
||||
<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] [--no-color] [--logfile FILE] [-V]
|
||||
[-c PATH] [-d PATH] [--userdir PATH]
|
||||
[--exchange EXCHANGE]
|
||||
[--data-format-ohlcv {json,jsongz,feather,parquet}]
|
||||
[--data-format-trades {json,jsongz,feather,parquet}]
|
||||
[--trades] [-p PAIRS [PAIRS ...]]
|
||||
[--trading-mode {spot,margin,futures}]
|
||||
[--show-timerange]
|
||||
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade list-data [-h] [-v] [--no-color] [--logfile FILE] [-V]</span>
|
||||
<span class="go"> [-c PATH] [-d PATH] [--userdir PATH]</span>
|
||||
<span class="go"> [--exchange EXCHANGE]</span>
|
||||
<span class="go"> [--data-format-ohlcv {json,jsongz,feather,parquet}]</span>
|
||||
<span class="go"> [--data-format-trades {json,jsongz,feather,parquet}]</span>
|
||||
<span class="go"> [--trades] [-p PAIRS [PAIRS ...]]</span>
|
||||
<span class="go"> [--trading-mode {spot,margin,futures}]</span>
|
||||
<span class="go"> [--show-timerange]</span>
|
||||
|
||||
options:
|
||||
-h, --help show this help message and exit
|
||||
--exchange EXCHANGE Exchange name. Only valid if no config is provided.
|
||||
--data-format-ohlcv {json,jsongz,feather,parquet}
|
||||
Storage format for downloaded candle (OHLCV) data.
|
||||
(default: `feather`).
|
||||
--data-format-trades {json,jsongz,feather,parquet}
|
||||
Storage format for downloaded trades data. (default:
|
||||
`feather`).
|
||||
--trades Work on trades data instead of OHLCV data.
|
||||
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
|
||||
Limit command to these pairs. Pairs are space-
|
||||
separated.
|
||||
--trading-mode {spot,margin,futures}, --tradingmode {spot,margin,futures}
|
||||
Select Trading mode
|
||||
--show-timerange Show timerange available for available data. (May take
|
||||
a while to calculate).
|
||||
<span class="go">options:</span>
|
||||
<span class="go"> -h, --help show this help message and exit</span>
|
||||
<span class="go"> --exchange EXCHANGE Exchange name. Only valid if no config is provided.</span>
|
||||
<span class="go"> --data-format-ohlcv {json,jsongz,feather,parquet}</span>
|
||||
<span class="go"> Storage format for downloaded candle (OHLCV) data.</span>
|
||||
<span class="go"> (default: `feather`).</span>
|
||||
<span class="go"> --data-format-trades {json,jsongz,feather,parquet}</span>
|
||||
<span class="go"> Storage format for downloaded trades data. (default:</span>
|
||||
<span class="go"> `feather`).</span>
|
||||
<span class="go"> --trades Work on trades data instead of OHLCV data.</span>
|
||||
<span class="go"> -p, --pairs PAIRS [PAIRS ...]</span>
|
||||
<span class="go"> Limit command to these pairs. Pairs are space-</span>
|
||||
<span class="go"> separated.</span>
|
||||
<span class="go"> --trading-mode, --tradingmode {spot,margin,futures}</span>
|
||||
<span class="go"> Select Trading mode</span>
|
||||
<span class="go"> --show-timerange Show timerange available for available data. (May take</span>
|
||||
<span class="go"> a while to calculate).</span>
|
||||
|
||||
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:
|
||||
'syslog', 'journald'. See the documentation for more
|
||||
details.
|
||||
-V, --version show program'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 the base directory of the exchange with
|
||||
historical backtesting data. To see futures data, use
|
||||
trading-mode additionally.
|
||||
--userdir PATH, --user-data-dir PATH
|
||||
Path to userdata directory.
|
||||
<span class="go">Common arguments:</span>
|
||||
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
||||
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
||||
<span class="go"> useful if you are redirecting output to a file.</span>
|
||||
<span class="go"> --logfile, --log-file FILE</span>
|
||||
<span class="go"> Log to the file specified. Special values are:</span>
|
||||
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
||||
<span class="go"> details.</span>
|
||||
<span class="go"> -V, --version show program's version number and exit</span>
|
||||
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
||||
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
||||
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
||||
<span class="go"> set to `-` to read config from stdin.</span>
|
||||
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
||||
<span class="go"> Path to the base directory of the exchange with</span>
|
||||
<span class="go"> historical backtesting data. To see futures data, use</span>
|
||||
<span class="go"> trading-mode additionally.</span>
|
||||
<span class="go"> --userdir, --user-data-dir PATH</span>
|
||||
<span class="go"> Path to userdata directory.</span>
|
||||
</code></pre></div>
|
||||
<h3 id="example-list-data">Example list-data<a class="headerlink" href="#example-list-data" title="Permanent link">¶</a></h3>
|
||||
<div class="highlight"><pre><span></span><code>><span class="w"> </span>freqtrade<span class="w"> </span>list-data<span class="w"> </span>--userdir<span class="w"> </span>~/.freqtrade/user_data/
|
||||
|
||||
@@ -2525,133 +2525,131 @@ 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
|
||||
</code></pre></div>
|
||||
<h2 id="hyperopt-command-reference">Hyperopt command reference<a class="headerlink" href="#hyperopt-command-reference" title="Permanent link">¶</a></h2>
|
||||
<div class="highlight"><pre><span></span><code>usage: freqtrade hyperopt [-h] [-v] [--no-color] [--logfile FILE] [-V]
|
||||
[-c PATH] [-d PATH] [--userdir PATH] [-s NAME]
|
||||
[--strategy-path PATH] [--recursive-strategy-search]
|
||||
[--freqaimodel NAME] [--freqaimodel-path PATH]
|
||||
[-i TIMEFRAME] [--timerange TIMERANGE]
|
||||
[--data-format-ohlcv {json,jsongz,feather,parquet}]
|
||||
[--max-open-trades INT]
|
||||
[--stake-amount STAKE_AMOUNT] [--fee FLOAT]
|
||||
[-p PAIRS [PAIRS ...]] [--hyperopt-path PATH]
|
||||
[--eps] [--enable-protections]
|
||||
[--dry-run-wallet DRY_RUN_WALLET]
|
||||
[--timeframe-detail TIMEFRAME_DETAIL] [-e INT]
|
||||
[--spaces SPACES [SPACES ...]] [--print-all]
|
||||
[--print-json] [-j JOBS] [--random-state INT]
|
||||
[--min-trades INT] [--hyperopt-loss NAME]
|
||||
[--disable-param-export] [--ignore-missing-spaces]
|
||||
[--analyze-per-epoch] [--early-stop INT]
|
||||
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade hyperopt [-h] [-v] [--no-color] [--logfile FILE] [-V]</span>
|
||||
<span class="go"> [-c PATH] [-d PATH] [--userdir PATH] [-s NAME]</span>
|
||||
<span class="go"> [--strategy-path PATH] [--recursive-strategy-search]</span>
|
||||
<span class="go"> [--freqaimodel NAME] [--freqaimodel-path PATH]</span>
|
||||
<span class="go"> [-i TIMEFRAME] [--timerange TIMERANGE]</span>
|
||||
<span class="go"> [--data-format-ohlcv {json,jsongz,feather,parquet}]</span>
|
||||
<span class="go"> [--max-open-trades INT]</span>
|
||||
<span class="go"> [--stake-amount STAKE_AMOUNT] [--fee FLOAT]</span>
|
||||
<span class="go"> [-p PAIRS [PAIRS ...]] [--hyperopt-path PATH]</span>
|
||||
<span class="go"> [--eps] [--enable-protections]</span>
|
||||
<span class="go"> [--dry-run-wallet DRY_RUN_WALLET]</span>
|
||||
<span class="go"> [--timeframe-detail TIMEFRAME_DETAIL] [-e INT]</span>
|
||||
<span class="go"> [--spaces SPACES [SPACES ...]] [--print-all]</span>
|
||||
<span class="go"> [--print-json] [-j JOBS] [--random-state INT]</span>
|
||||
<span class="go"> [--min-trades INT] [--hyperopt-loss NAME]</span>
|
||||
<span class="go"> [--disable-param-export] [--ignore-missing-spaces]</span>
|
||||
<span class="go"> [--analyze-per-epoch] [--early-stop INT]</span>
|
||||
|
||||
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.
|
||||
--hyperopt-path PATH Specify additional lookup path for Hyperopt Loss
|
||||
functions.
|
||||
--eps, --enable-position-stacking
|
||||
Allow buying the same pair multiple times (position
|
||||
stacking).
|
||||
--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`).
|
||||
-e INT, --epochs INT Specify number of epochs (default: 100).
|
||||
--spaces SPACES [SPACES ...]
|
||||
Specify which parameters to hyperopt. Space-separated
|
||||
list. Available builtin options (custom spaces will
|
||||
not be listed here): default, all, buy, sell, enter,
|
||||
exit, roi, stoploss, trailing, protection, trades.
|
||||
Default: `default` - which includes all spaces except
|
||||
for 'trailing', 'protection', and 'trades'.
|
||||
--print-all Print all results, not only the best ones.
|
||||
--print-json Print output in JSON format.
|
||||
-j JOBS, --job-workers JOBS
|
||||
The number of concurrently running jobs for
|
||||
hyperoptimization (hyperopt worker processes). If -1
|
||||
(default), all CPUs are used, for -2, all CPUs but one
|
||||
are used, etc. If 1 is given, no parallel computing
|
||||
code is used at all.
|
||||
--random-state INT Set random state to some positive integer for
|
||||
reproducible hyperopt results.
|
||||
--min-trades INT Set minimal desired number of trades for evaluations
|
||||
in the hyperopt optimization path (default: 1).
|
||||
--hyperopt-loss NAME, --hyperoptloss NAME
|
||||
Specify the class name of the hyperopt loss function
|
||||
class (IHyperOptLoss). Different functions can
|
||||
generate completely different results, since the
|
||||
target for optimization is different. Built-in
|
||||
Hyperopt-loss-functions are:
|
||||
ShortTradeDurHyperOptLoss, OnlyProfitHyperOptLoss,
|
||||
SharpeHyperOptLoss, SharpeHyperOptLossDaily,
|
||||
SortinoHyperOptLoss, SortinoHyperOptLossDaily,
|
||||
CalmarHyperOptLoss, MaxDrawDownHyperOptLoss,
|
||||
MaxDrawDownRelativeHyperOptLoss,
|
||||
MaxDrawDownPerPairHyperOptLoss,
|
||||
ProfitDrawDownHyperOptLoss, MultiMetricHyperOptLoss
|
||||
--disable-param-export
|
||||
Disable automatic hyperopt parameter export.
|
||||
--ignore-missing-spaces, --ignore-unparameterized-spaces
|
||||
Suppress errors for any requested Hyperopt spaces that
|
||||
do not contain any parameters.
|
||||
--analyze-per-epoch Run populate_indicators once per epoch.
|
||||
--early-stop INT Early stop hyperopt if no improvement after (default:
|
||||
0) epochs.
|
||||
<span class="go">options:</span>
|
||||
<span class="go"> -h, --help show this help message and exit</span>
|
||||
<span class="go"> -i, --timeframe TIMEFRAME</span>
|
||||
<span class="go"> Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).</span>
|
||||
<span class="go"> --timerange TIMERANGE</span>
|
||||
<span class="go"> Specify what timerange of data to use.</span>
|
||||
<span class="go"> --data-format-ohlcv {json,jsongz,feather,parquet}</span>
|
||||
<span class="go"> Storage format for downloaded candle (OHLCV) data.</span>
|
||||
<span class="go"> (default: `feather`).</span>
|
||||
<span class="go"> --max-open-trades INT</span>
|
||||
<span class="go"> Override the value of the `max_open_trades`</span>
|
||||
<span class="go"> configuration setting.</span>
|
||||
<span class="go"> --stake-amount STAKE_AMOUNT</span>
|
||||
<span class="go"> Override the value of the `stake_amount` configuration</span>
|
||||
<span class="go"> setting.</span>
|
||||
<span class="go"> --fee FLOAT Specify fee ratio. Will be applied twice (on trade</span>
|
||||
<span class="go"> entry and exit).</span>
|
||||
<span class="go"> -p, --pairs PAIRS [PAIRS ...]</span>
|
||||
<span class="go"> Limit command to these pairs. Pairs are space-</span>
|
||||
<span class="go"> separated.</span>
|
||||
<span class="go"> --hyperopt-path PATH Specify additional lookup path for Hyperopt Loss</span>
|
||||
<span class="go"> functions.</span>
|
||||
<span class="go"> --eps, --enable-position-stacking</span>
|
||||
<span class="go"> Allow buying the same pair multiple times (position</span>
|
||||
<span class="go"> stacking).</span>
|
||||
<span class="go"> --enable-protections, --enableprotections</span>
|
||||
<span class="go"> Enable protections for backtesting. Will slow</span>
|
||||
<span class="go"> backtesting down by a considerable amount, but will</span>
|
||||
<span class="go"> include configured protections</span>
|
||||
<span class="go"> --dry-run-wallet, --starting-balance DRY_RUN_WALLET</span>
|
||||
<span class="go"> Starting balance, used for backtesting / hyperopt and</span>
|
||||
<span class="go"> dry-runs.</span>
|
||||
<span class="go"> --timeframe-detail TIMEFRAME_DETAIL</span>
|
||||
<span class="go"> Specify detail timeframe for backtesting (`1m`, `5m`,</span>
|
||||
<span class="go"> `30m`, `1h`, `1d`).</span>
|
||||
<span class="go"> -e, --epochs INT Specify number of epochs (default: 100).</span>
|
||||
<span class="go"> --spaces SPACES [SPACES ...]</span>
|
||||
<span class="go"> Specify which parameters to hyperopt. Space-separated</span>
|
||||
<span class="go"> list. Available builtin options (custom spaces will</span>
|
||||
<span class="go"> not be listed here): default, all, buy, sell, enter,</span>
|
||||
<span class="go"> exit, roi, stoploss, trailing, protection, trades.</span>
|
||||
<span class="go"> Default: `default` - which includes all spaces except</span>
|
||||
<span class="go"> for 'trailing', 'protection', and 'trades'.</span>
|
||||
<span class="go"> --print-all Print all results, not only the best ones.</span>
|
||||
<span class="go"> --print-json Print output in JSON format.</span>
|
||||
<span class="go"> -j, --job-workers JOBS</span>
|
||||
<span class="go"> The number of concurrently running jobs for</span>
|
||||
<span class="go"> hyperoptimization (hyperopt worker processes). If -1</span>
|
||||
<span class="go"> (default), all CPUs are used, for -2, all CPUs but one</span>
|
||||
<span class="go"> are used, etc. If 1 is given, no parallel computing</span>
|
||||
<span class="go"> code is used at all.</span>
|
||||
<span class="go"> --random-state INT Set random state to some positive integer for</span>
|
||||
<span class="go"> reproducible hyperopt results.</span>
|
||||
<span class="go"> --min-trades INT Set minimal desired number of trades for evaluations</span>
|
||||
<span class="go"> in the hyperopt optimization path (default: 1).</span>
|
||||
<span class="go"> --hyperopt-loss, --hyperoptloss NAME</span>
|
||||
<span class="go"> Specify the class name of the hyperopt loss function</span>
|
||||
<span class="go"> class (IHyperOptLoss). Different functions can</span>
|
||||
<span class="go"> generate completely different results, since the</span>
|
||||
<span class="go"> target for optimization is different. Built-in</span>
|
||||
<span class="go"> Hyperopt-loss-functions are:</span>
|
||||
<span class="go"> ShortTradeDurHyperOptLoss, OnlyProfitHyperOptLoss,</span>
|
||||
<span class="go"> SharpeHyperOptLoss, SharpeHyperOptLossDaily,</span>
|
||||
<span class="go"> SortinoHyperOptLoss, SortinoHyperOptLossDaily,</span>
|
||||
<span class="go"> CalmarHyperOptLoss, MaxDrawDownHyperOptLoss,</span>
|
||||
<span class="go"> MaxDrawDownRelativeHyperOptLoss,</span>
|
||||
<span class="go"> MaxDrawDownPerPairHyperOptLoss,</span>
|
||||
<span class="go"> ProfitDrawDownHyperOptLoss, MultiMetricHyperOptLoss</span>
|
||||
<span class="go"> --disable-param-export</span>
|
||||
<span class="go"> Disable automatic hyperopt parameter export.</span>
|
||||
<span class="go"> --ignore-missing-spaces, --ignore-unparameterized-spaces</span>
|
||||
<span class="go"> Suppress errors for any requested Hyperopt spaces that</span>
|
||||
<span class="go"> do not contain any parameters.</span>
|
||||
<span class="go"> --analyze-per-epoch Run populate_indicators once per epoch.</span>
|
||||
<span class="go"> --early-stop INT Early stop hyperopt if no improvement after (default:</span>
|
||||
<span class="go"> 0) epochs.</span>
|
||||
|
||||
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:
|
||||
'syslog', 'journald'. See the documentation for more
|
||||
details.
|
||||
-V, --version show program'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 the base directory of the exchange with
|
||||
historical backtesting data. To see futures data, use
|
||||
trading-mode additionally.
|
||||
--userdir PATH, --user-data-dir PATH
|
||||
Path to userdata directory.
|
||||
<span class="go">Common arguments:</span>
|
||||
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
||||
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
||||
<span class="go"> useful if you are redirecting output to a file.</span>
|
||||
<span class="go"> --logfile, --log-file FILE</span>
|
||||
<span class="go"> Log to the file specified. Special values are:</span>
|
||||
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
||||
<span class="go"> details.</span>
|
||||
<span class="go"> -V, --version show program's version number and exit</span>
|
||||
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
||||
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
||||
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
||||
<span class="go"> set to `-` to read config from stdin.</span>
|
||||
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
||||
<span class="go"> Path to the base directory of the exchange with</span>
|
||||
<span class="go"> historical backtesting data. To see futures data, use</span>
|
||||
<span class="go"> trading-mode additionally.</span>
|
||||
<span class="go"> --userdir, --user-data-dir PATH</span>
|
||||
<span class="go"> Path to userdata directory.</span>
|
||||
|
||||
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.
|
||||
<span class="go">Strategy arguments:</span>
|
||||
<span class="go"> -s, --strategy NAME Specify strategy class name which will be used by the</span>
|
||||
<span class="go"> bot.</span>
|
||||
<span class="go"> --strategy-path PATH Specify additional strategy lookup path.</span>
|
||||
<span class="go"> --recursive-strategy-search</span>
|
||||
<span class="go"> Recursively search for a strategy in the strategies</span>
|
||||
<span class="go"> folder.</span>
|
||||
<span class="go"> --freqaimodel NAME Specify a custom freqaimodels.</span>
|
||||
<span class="go"> --freqaimodel-path PATH</span>
|
||||
<span class="go"> Specify additional lookup path for freqaimodels.</span>
|
||||
</code></pre></div>
|
||||
<h3 id="hyperopt-checklist">Hyperopt checklist<a class="headerlink" href="#hyperopt-checklist" title="Permanent link">¶</a></h3>
|
||||
<p>Checklist on all tasks / possibilities in hyperopt</p>
|
||||
|
||||
@@ -1812,128 +1812,126 @@ This is done by not looking at the strategy code itself, but at changed indicato
|
||||
</ul>
|
||||
<p>These 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">¶</a></h2>
|
||||
<div class="highlight"><pre><span></span><code>usage: freqtrade lookahead-analysis [-h] [-v] [--no-color] [--logfile FILE]
|
||||
[-V] [-c PATH] [-d PATH] [--userdir PATH]
|
||||
[-s NAME] [--strategy-path PATH]
|
||||
[--recursive-strategy-search]
|
||||
[--freqaimodel NAME]
|
||||
[--freqaimodel-path PATH] [-i TIMEFRAME]
|
||||
[--timerange TIMERANGE]
|
||||
[--data-format-ohlcv {json,jsongz,feather,parquet}]
|
||||
[--max-open-trades INT]
|
||||
[--stake-amount STAKE_AMOUNT]
|
||||
[--fee FLOAT] [-p PAIRS [PAIRS ...]]
|
||||
[--enable-protections]
|
||||
[--enable-dynamic-pairlist]
|
||||
[--dry-run-wallet DRY_RUN_WALLET]
|
||||
[--timeframe-detail TIMEFRAME_DETAIL]
|
||||
[--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]]
|
||||
[--export {none,trades,signals}]
|
||||
[--backtest-filename PATH]
|
||||
[--backtest-directory PATH]
|
||||
[--freqai-backtest-live-models]
|
||||
[--minimum-trade-amount INT]
|
||||
[--targeted-trade-amount INT]
|
||||
[--lookahead-analysis-exportfilename LOOKAHEAD_ANALYSIS_EXPORTFILENAME]
|
||||
[--allow-limit-orders]
|
||||
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade lookahead-analysis [-h] [-v] [--no-color] [--logfile FILE]</span>
|
||||
<span class="go"> [-V] [-c PATH] [-d PATH] [--userdir PATH]</span>
|
||||
<span class="go"> [-s NAME] [--strategy-path PATH]</span>
|
||||
<span class="go"> [--recursive-strategy-search]</span>
|
||||
<span class="go"> [--freqaimodel NAME]</span>
|
||||
<span class="go"> [--freqaimodel-path PATH] [-i TIMEFRAME]</span>
|
||||
<span class="go"> [--timerange TIMERANGE]</span>
|
||||
<span class="go"> [--data-format-ohlcv {json,jsongz,feather,parquet}]</span>
|
||||
<span class="go"> [--max-open-trades INT]</span>
|
||||
<span class="go"> [--stake-amount STAKE_AMOUNT]</span>
|
||||
<span class="go"> [--fee FLOAT] [-p PAIRS [PAIRS ...]]</span>
|
||||
<span class="go"> [--enable-protections]</span>
|
||||
<span class="go"> [--enable-dynamic-pairlist]</span>
|
||||
<span class="go"> [--dry-run-wallet DRY_RUN_WALLET]</span>
|
||||
<span class="go"> [--timeframe-detail TIMEFRAME_DETAIL]</span>
|
||||
<span class="go"> [--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]]</span>
|
||||
<span class="go"> [--export {none,trades,signals}]</span>
|
||||
<span class="go"> [--backtest-filename PATH]</span>
|
||||
<span class="go"> [--backtest-directory PATH]</span>
|
||||
<span class="go"> [--freqai-backtest-live-models]</span>
|
||||
<span class="go"> [--minimum-trade-amount INT]</span>
|
||||
<span class="go"> [--targeted-trade-amount INT]</span>
|
||||
<span class="go"> [--lookahead-analysis-exportfilename LOOKAHEAD_ANALYSIS_EXPORTFILENAME]</span>
|
||||
<span class="go"> [--allow-limit-orders]</span>
|
||||
|
||||
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
|
||||
--enable-dynamic-pairlist
|
||||
Enables dynamic pairlist refreshes in backtesting. The
|
||||
pairlist will be generated for each new candle if
|
||||
you're using a pairlist handler that supports this
|
||||
feature, for example, ShuffleFilter.
|
||||
--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).
|
||||
--backtest-filename PATH, --export-filename PATH
|
||||
Use this filename for backtest results.Example:
|
||||
`--backtest-
|
||||
filename=backtest_results_2020-09-27_16-20-48.json`.
|
||||
Assumes either `user_data/backtest_results/` or
|
||||
`--export-directory` as base directory.
|
||||
--backtest-directory PATH, --export-directory PATH
|
||||
Directory to use for backtest results. Example:
|
||||
`--export-directory=user_data/backtest_results/`.
|
||||
--freqai-backtest-live-models
|
||||
Run backtest with ready models.
|
||||
--minimum-trade-amount INT
|
||||
Minimum trade amount for lookahead-analysis
|
||||
--targeted-trade-amount INT
|
||||
Targeted trade amount for lookahead analysis
|
||||
--lookahead-analysis-exportfilename LOOKAHEAD_ANALYSIS_EXPORTFILENAME
|
||||
Use this csv-filename to store lookahead-analysis-
|
||||
results
|
||||
--allow-limit-orders Allow limit orders in lookahead analysis (could cause
|
||||
false positives in lookahead analysis results).
|
||||
<span class="go">options:</span>
|
||||
<span class="go"> -h, --help show this help message and exit</span>
|
||||
<span class="go"> -i, --timeframe TIMEFRAME</span>
|
||||
<span class="go"> Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).</span>
|
||||
<span class="go"> --timerange TIMERANGE</span>
|
||||
<span class="go"> Specify what timerange of data to use.</span>
|
||||
<span class="go"> --data-format-ohlcv {json,jsongz,feather,parquet}</span>
|
||||
<span class="go"> Storage format for downloaded candle (OHLCV) data.</span>
|
||||
<span class="go"> (default: `feather`).</span>
|
||||
<span class="go"> --max-open-trades INT</span>
|
||||
<span class="go"> Override the value of the `max_open_trades`</span>
|
||||
<span class="go"> configuration setting.</span>
|
||||
<span class="go"> --stake-amount STAKE_AMOUNT</span>
|
||||
<span class="go"> Override the value of the `stake_amount` configuration</span>
|
||||
<span class="go"> setting.</span>
|
||||
<span class="go"> --fee FLOAT Specify fee ratio. Will be applied twice (on trade</span>
|
||||
<span class="go"> entry and exit).</span>
|
||||
<span class="go"> -p, --pairs PAIRS [PAIRS ...]</span>
|
||||
<span class="go"> Limit command to these pairs. Pairs are space-</span>
|
||||
<span class="go"> separated.</span>
|
||||
<span class="go"> --enable-protections, --enableprotections</span>
|
||||
<span class="go"> Enable protections for backtesting. Will slow</span>
|
||||
<span class="go"> backtesting down by a considerable amount, but will</span>
|
||||
<span class="go"> include configured protections</span>
|
||||
<span class="go"> --enable-dynamic-pairlist</span>
|
||||
<span class="go"> Enables dynamic pairlist refreshes in backtesting. The</span>
|
||||
<span class="go"> pairlist will be generated for each new candle if</span>
|
||||
<span class="go"> you're using a pairlist handler that supports this</span>
|
||||
<span class="go"> feature, for example, ShuffleFilter.</span>
|
||||
<span class="go"> --dry-run-wallet, --starting-balance DRY_RUN_WALLET</span>
|
||||
<span class="go"> Starting balance, used for backtesting / hyperopt and</span>
|
||||
<span class="go"> dry-runs.</span>
|
||||
<span class="go"> --timeframe-detail TIMEFRAME_DETAIL</span>
|
||||
<span class="go"> Specify detail timeframe for backtesting (`1m`, `5m`,</span>
|
||||
<span class="go"> `30m`, `1h`, `1d`).</span>
|
||||
<span class="go"> --strategy-list STRATEGY_LIST [STRATEGY_LIST ...]</span>
|
||||
<span class="go"> Provide a space-separated list of strategies to</span>
|
||||
<span class="go"> backtest. Please note that timeframe needs to be set</span>
|
||||
<span class="go"> either in config or via command line. When using this</span>
|
||||
<span class="go"> together with `--export trades`, the strategy-name is</span>
|
||||
<span class="go"> injected into the filename (so `backtest-data.json`</span>
|
||||
<span class="go"> becomes `backtest-data-SampleStrategy.json`</span>
|
||||
<span class="go"> --export {none,trades,signals}</span>
|
||||
<span class="go"> Export backtest results (default: trades).</span>
|
||||
<span class="go"> --backtest-filename, --export-filename PATH</span>
|
||||
<span class="go"> Use this filename for backtest results.Example:</span>
|
||||
<span class="go"> `--backtest-</span>
|
||||
<span class="go"> filename=backtest_results_2020-09-27_16-20-48.json`.</span>
|
||||
<span class="go"> Assumes either `user_data/backtest_results/` or</span>
|
||||
<span class="go"> `--export-directory` as base directory.</span>
|
||||
<span class="go"> --backtest-directory, --export-directory PATH</span>
|
||||
<span class="go"> Directory to use for backtest results. Example:</span>
|
||||
<span class="go"> `--export-directory=user_data/backtest_results/`.</span>
|
||||
<span class="go"> --freqai-backtest-live-models</span>
|
||||
<span class="go"> Run backtest with ready models.</span>
|
||||
<span class="go"> --minimum-trade-amount INT</span>
|
||||
<span class="go"> Minimum trade amount for lookahead-analysis</span>
|
||||
<span class="go"> --targeted-trade-amount INT</span>
|
||||
<span class="go"> Targeted trade amount for lookahead analysis</span>
|
||||
<span class="go"> --lookahead-analysis-exportfilename LOOKAHEAD_ANALYSIS_EXPORTFILENAME</span>
|
||||
<span class="go"> Use this csv-filename to store lookahead-analysis-</span>
|
||||
<span class="go"> results</span>
|
||||
<span class="go"> --allow-limit-orders Allow limit orders in lookahead analysis (could cause</span>
|
||||
<span class="go"> false positives in lookahead analysis results).</span>
|
||||
|
||||
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:
|
||||
'syslog', 'journald'. See the documentation for more
|
||||
details.
|
||||
-V, --version show program'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 the base directory of the exchange with
|
||||
historical backtesting data. To see futures data, use
|
||||
trading-mode additionally.
|
||||
--userdir PATH, --user-data-dir PATH
|
||||
Path to userdata directory.
|
||||
<span class="go">Common arguments:</span>
|
||||
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
||||
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
||||
<span class="go"> useful if you are redirecting output to a file.</span>
|
||||
<span class="go"> --logfile, --log-file FILE</span>
|
||||
<span class="go"> Log to the file specified. Special values are:</span>
|
||||
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
||||
<span class="go"> details.</span>
|
||||
<span class="go"> -V, --version show program's version number and exit</span>
|
||||
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
||||
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
||||
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
||||
<span class="go"> set to `-` to read config from stdin.</span>
|
||||
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
||||
<span class="go"> Path to the base directory of the exchange with</span>
|
||||
<span class="go"> historical backtesting data. To see futures data, use</span>
|
||||
<span class="go"> trading-mode additionally.</span>
|
||||
<span class="go"> --userdir, --user-data-dir PATH</span>
|
||||
<span class="go"> Path to userdata directory.</span>
|
||||
|
||||
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.
|
||||
<span class="go">Strategy arguments:</span>
|
||||
<span class="go"> -s, --strategy NAME Specify strategy class name which will be used by the</span>
|
||||
<span class="go"> bot.</span>
|
||||
<span class="go"> --strategy-path PATH Specify additional strategy lookup path.</span>
|
||||
<span class="go"> --recursive-strategy-search</span>
|
||||
<span class="go"> Recursively search for a strategy in the strategies</span>
|
||||
<span class="go"> folder.</span>
|
||||
<span class="go"> --freqaimodel NAME Specify a custom freqaimodels.</span>
|
||||
<span class="go"> --freqaimodel-path PATH</span>
|
||||
<span class="go"> Specify additional lookup path for freqaimodels.</span>
|
||||
</code></pre></div>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
|
||||
@@ -1804,89 +1804,87 @@ This is mostly for the performance problems even medium sized plots can cause, b
|
||||
</ul>
|
||||
<p><img alt="plot-dataframe" src="../assets/plot-dataframe.png" /></p>
|
||||
<p>Possible arguments:</p>
|
||||
<div class="highlight"><pre><span></span><code>usage: freqtrade plot-dataframe [-h] [-v] [--no-color] [--logfile FILE] [-V]
|
||||
[-c PATH] [-d PATH] [--userdir PATH] [-s NAME]
|
||||
[--strategy-path PATH]
|
||||
[--recursive-strategy-search]
|
||||
[--freqaimodel NAME] [--freqaimodel-path PATH]
|
||||
[-p PAIRS [PAIRS ...]]
|
||||
[--indicators1 INDICATORS1 [INDICATORS1 ...]]
|
||||
[--indicators2 INDICATORS2 [INDICATORS2 ...]]
|
||||
[--plot-limit INT] [--db-url PATH]
|
||||
[--trade-source {DB,file}]
|
||||
[--export {none,trades,signals}]
|
||||
[--backtest-filename PATH]
|
||||
[--timerange TIMERANGE] [-i TIMEFRAME]
|
||||
[--no-trades]
|
||||
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade plot-dataframe [-h] [-v] [--no-color] [--logfile FILE] [-V]</span>
|
||||
<span class="go"> [-c PATH] [-d PATH] [--userdir PATH] [-s NAME]</span>
|
||||
<span class="go"> [--strategy-path PATH]</span>
|
||||
<span class="go"> [--recursive-strategy-search]</span>
|
||||
<span class="go"> [--freqaimodel NAME] [--freqaimodel-path PATH]</span>
|
||||
<span class="go"> [-p PAIRS [PAIRS ...]]</span>
|
||||
<span class="go"> [--indicators1 INDICATORS1 [INDICATORS1 ...]]</span>
|
||||
<span class="go"> [--indicators2 INDICATORS2 [INDICATORS2 ...]]</span>
|
||||
<span class="go"> [--plot-limit INT] [--db-url PATH]</span>
|
||||
<span class="go"> [--trade-source {DB,file}]</span>
|
||||
<span class="go"> [--export {none,trades,signals}]</span>
|
||||
<span class="go"> [--backtest-filename PATH]</span>
|
||||
<span class="go"> [--timerange TIMERANGE] [-i TIMEFRAME]</span>
|
||||
<span class="go"> [--no-trades]</span>
|
||||
|
||||
options:
|
||||
-h, --help show this help message and exit
|
||||
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
|
||||
Limit command to these pairs. Pairs are space-
|
||||
separated.
|
||||
--indicators1 INDICATORS1 [INDICATORS1 ...]
|
||||
Set indicators from your strategy you want in the
|
||||
first row of the graph. Space-separated list. Example:
|
||||
`ema3 ema5`. Default: `['sma', 'ema3', 'ema5']`.
|
||||
--indicators2 INDICATORS2 [INDICATORS2 ...]
|
||||
Set indicators from your strategy you want in the
|
||||
third row of the graph. Space-separated list. Example:
|
||||
`fastd fastk`. Default: `['macd', 'macdsignal']`.
|
||||
--plot-limit INT Specify tick limit for plotting. Notice: too high
|
||||
values cause huge files. Default: 750.
|
||||
--db-url PATH Override trades database URL, this is useful in custom
|
||||
deployments (default: `sqlite:///tradesv3.sqlite` for
|
||||
Live Run mode, `sqlite:///tradesv3.dryrun.sqlite` for
|
||||
Dry Run).
|
||||
--trade-source {DB,file}
|
||||
Specify the source for trades (Can be DB or file
|
||||
(backtest file)) Default: file
|
||||
--export {none,trades,signals}
|
||||
Export backtest results (default: trades).
|
||||
--backtest-filename PATH, --export-filename PATH
|
||||
Use this filename for backtest results.Example:
|
||||
`--backtest-
|
||||
filename=backtest_results_2020-09-27_16-20-48.json`.
|
||||
Assumes either `user_data/backtest_results/` or
|
||||
`--export-directory` as base directory.
|
||||
--timerange TIMERANGE
|
||||
Specify what timerange of data to use.
|
||||
-i TIMEFRAME, --timeframe TIMEFRAME
|
||||
Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).
|
||||
--no-trades Skip using trades from backtesting file and DB.
|
||||
<span class="go">options:</span>
|
||||
<span class="go"> -h, --help show this help message and exit</span>
|
||||
<span class="go"> -p, --pairs PAIRS [PAIRS ...]</span>
|
||||
<span class="go"> Limit command to these pairs. Pairs are space-</span>
|
||||
<span class="go"> separated.</span>
|
||||
<span class="go"> --indicators1 INDICATORS1 [INDICATORS1 ...]</span>
|
||||
<span class="go"> Set indicators from your strategy you want in the</span>
|
||||
<span class="go"> first row of the graph. Space-separated list. Example:</span>
|
||||
<span class="go"> `ema3 ema5`. Default: `['sma', 'ema3', 'ema5']`.</span>
|
||||
<span class="go"> --indicators2 INDICATORS2 [INDICATORS2 ...]</span>
|
||||
<span class="go"> Set indicators from your strategy you want in the</span>
|
||||
<span class="go"> third row of the graph. Space-separated list. Example:</span>
|
||||
<span class="go"> `fastd fastk`. Default: `['macd', 'macdsignal']`.</span>
|
||||
<span class="go"> --plot-limit INT Specify tick limit for plotting. Notice: too high</span>
|
||||
<span class="go"> values cause huge files. Default: 750.</span>
|
||||
<span class="go"> --db-url PATH Override trades database URL, this is useful in custom</span>
|
||||
<span class="go"> deployments (default: `sqlite:///tradesv3.sqlite` for</span>
|
||||
<span class="go"> Live Run mode, `sqlite:///tradesv3.dryrun.sqlite` for</span>
|
||||
<span class="go"> Dry Run).</span>
|
||||
<span class="go"> --trade-source {DB,file}</span>
|
||||
<span class="go"> Specify the source for trades (Can be DB or file</span>
|
||||
<span class="go"> (backtest file)) Default: file</span>
|
||||
<span class="go"> --export {none,trades,signals}</span>
|
||||
<span class="go"> Export backtest results (default: trades).</span>
|
||||
<span class="go"> --backtest-filename, --export-filename PATH</span>
|
||||
<span class="go"> Use this filename for backtest results.Example:</span>
|
||||
<span class="go"> `--backtest-</span>
|
||||
<span class="go"> filename=backtest_results_2020-09-27_16-20-48.json`.</span>
|
||||
<span class="go"> Assumes either `user_data/backtest_results/` or</span>
|
||||
<span class="go"> `--export-directory` as base directory.</span>
|
||||
<span class="go"> --timerange TIMERANGE</span>
|
||||
<span class="go"> Specify what timerange of data to use.</span>
|
||||
<span class="go"> -i, --timeframe TIMEFRAME</span>
|
||||
<span class="go"> Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).</span>
|
||||
<span class="go"> --no-trades Skip using trades from backtesting file and DB.</span>
|
||||
|
||||
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:
|
||||
'syslog', 'journald'. See the documentation for more
|
||||
details.
|
||||
-V, --version show program'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 the base directory of the exchange with
|
||||
historical backtesting data. To see futures data, use
|
||||
trading-mode additionally.
|
||||
--userdir PATH, --user-data-dir PATH
|
||||
Path to userdata directory.
|
||||
<span class="go">Common arguments:</span>
|
||||
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
||||
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
||||
<span class="go"> useful if you are redirecting output to a file.</span>
|
||||
<span class="go"> --logfile, --log-file FILE</span>
|
||||
<span class="go"> Log to the file specified. Special values are:</span>
|
||||
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
||||
<span class="go"> details.</span>
|
||||
<span class="go"> -V, --version show program's version number and exit</span>
|
||||
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
||||
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
||||
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
||||
<span class="go"> set to `-` to read config from stdin.</span>
|
||||
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
||||
<span class="go"> Path to the base directory of the exchange with</span>
|
||||
<span class="go"> historical backtesting data. To see futures data, use</span>
|
||||
<span class="go"> trading-mode additionally.</span>
|
||||
<span class="go"> --userdir, --user-data-dir PATH</span>
|
||||
<span class="go"> Path to userdata directory.</span>
|
||||
|
||||
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.
|
||||
<span class="go">Strategy arguments:</span>
|
||||
<span class="go"> -s, --strategy NAME Specify strategy class name which will be used by the</span>
|
||||
<span class="go"> bot.</span>
|
||||
<span class="go"> --strategy-path PATH Specify additional strategy lookup path.</span>
|
||||
<span class="go"> --recursive-strategy-search</span>
|
||||
<span class="go"> Recursively search for a strategy in the strategies</span>
|
||||
<span class="go"> folder.</span>
|
||||
<span class="go"> --freqaimodel NAME Specify a custom freqaimodels.</span>
|
||||
<span class="go"> --freqaimodel-path PATH</span>
|
||||
<span class="go"> Specify additional lookup path for freqaimodels.</span>
|
||||
</code></pre></div>
|
||||
<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
|
||||
@@ -2058,75 +2056,73 @@ 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 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>
|
||||
<div class="highlight"><pre><span></span><code>usage: freqtrade plot-profit [-h] [-v] [--no-color] [--logfile FILE] [-V]
|
||||
[-c PATH] [-d PATH] [--userdir PATH] [-s NAME]
|
||||
[--strategy-path PATH]
|
||||
[--recursive-strategy-search]
|
||||
[--freqaimodel NAME] [--freqaimodel-path PATH]
|
||||
[-p PAIRS [PAIRS ...]] [--timerange TIMERANGE]
|
||||
[--export {none,trades,signals}]
|
||||
[--backtest-filename PATH] [--db-url PATH]
|
||||
[--trade-source {DB,file}] [-i TIMEFRAME]
|
||||
[--auto-open]
|
||||
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade plot-profit [-h] [-v] [--no-color] [--logfile FILE] [-V]</span>
|
||||
<span class="go"> [-c PATH] [-d PATH] [--userdir PATH] [-s NAME]</span>
|
||||
<span class="go"> [--strategy-path PATH]</span>
|
||||
<span class="go"> [--recursive-strategy-search]</span>
|
||||
<span class="go"> [--freqaimodel NAME] [--freqaimodel-path PATH]</span>
|
||||
<span class="go"> [-p PAIRS [PAIRS ...]] [--timerange TIMERANGE]</span>
|
||||
<span class="go"> [--export {none,trades,signals}]</span>
|
||||
<span class="go"> [--backtest-filename PATH] [--db-url PATH]</span>
|
||||
<span class="go"> [--trade-source {DB,file}] [-i TIMEFRAME]</span>
|
||||
<span class="go"> [--auto-open]</span>
|
||||
|
||||
options:
|
||||
-h, --help show this help message and exit
|
||||
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
|
||||
Limit command to these pairs. Pairs are space-
|
||||
separated.
|
||||
--timerange TIMERANGE
|
||||
Specify what timerange of data to use.
|
||||
--export {none,trades,signals}
|
||||
Export backtest results (default: trades).
|
||||
--backtest-filename PATH, --export-filename PATH
|
||||
Use this filename for backtest results.Example:
|
||||
`--backtest-
|
||||
filename=backtest_results_2020-09-27_16-20-48.json`.
|
||||
Assumes either `user_data/backtest_results/` or
|
||||
`--export-directory` as base directory.
|
||||
--db-url PATH Override trades database URL, this is useful in custom
|
||||
deployments (default: `sqlite:///tradesv3.sqlite` for
|
||||
Live Run mode, `sqlite:///tradesv3.dryrun.sqlite` for
|
||||
Dry Run).
|
||||
--trade-source {DB,file}
|
||||
Specify the source for trades (Can be DB or file
|
||||
(backtest file)) Default: file
|
||||
-i TIMEFRAME, --timeframe TIMEFRAME
|
||||
Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).
|
||||
--auto-open Automatically open generated plot.
|
||||
<span class="go">options:</span>
|
||||
<span class="go"> -h, --help show this help message and exit</span>
|
||||
<span class="go"> -p, --pairs PAIRS [PAIRS ...]</span>
|
||||
<span class="go"> Limit command to these pairs. Pairs are space-</span>
|
||||
<span class="go"> separated.</span>
|
||||
<span class="go"> --timerange TIMERANGE</span>
|
||||
<span class="go"> Specify what timerange of data to use.</span>
|
||||
<span class="go"> --export {none,trades,signals}</span>
|
||||
<span class="go"> Export backtest results (default: trades).</span>
|
||||
<span class="go"> --backtest-filename, --export-filename PATH</span>
|
||||
<span class="go"> Use this filename for backtest results.Example:</span>
|
||||
<span class="go"> `--backtest-</span>
|
||||
<span class="go"> filename=backtest_results_2020-09-27_16-20-48.json`.</span>
|
||||
<span class="go"> Assumes either `user_data/backtest_results/` or</span>
|
||||
<span class="go"> `--export-directory` as base directory.</span>
|
||||
<span class="go"> --db-url PATH Override trades database URL, this is useful in custom</span>
|
||||
<span class="go"> deployments (default: `sqlite:///tradesv3.sqlite` for</span>
|
||||
<span class="go"> Live Run mode, `sqlite:///tradesv3.dryrun.sqlite` for</span>
|
||||
<span class="go"> Dry Run).</span>
|
||||
<span class="go"> --trade-source {DB,file}</span>
|
||||
<span class="go"> Specify the source for trades (Can be DB or file</span>
|
||||
<span class="go"> (backtest file)) Default: file</span>
|
||||
<span class="go"> -i, --timeframe TIMEFRAME</span>
|
||||
<span class="go"> Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).</span>
|
||||
<span class="go"> --auto-open Automatically open generated plot.</span>
|
||||
|
||||
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:
|
||||
'syslog', 'journald'. See the documentation for more
|
||||
details.
|
||||
-V, --version show program'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 the base directory of the exchange with
|
||||
historical backtesting data. To see futures data, use
|
||||
trading-mode additionally.
|
||||
--userdir PATH, --user-data-dir PATH
|
||||
Path to userdata directory.
|
||||
<span class="go">Common arguments:</span>
|
||||
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
||||
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
||||
<span class="go"> useful if you are redirecting output to a file.</span>
|
||||
<span class="go"> --logfile, --log-file FILE</span>
|
||||
<span class="go"> Log to the file specified. Special values are:</span>
|
||||
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
||||
<span class="go"> details.</span>
|
||||
<span class="go"> -V, --version show program's version number and exit</span>
|
||||
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
||||
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
||||
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
||||
<span class="go"> set to `-` to read config from stdin.</span>
|
||||
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
||||
<span class="go"> Path to the base directory of the exchange with</span>
|
||||
<span class="go"> historical backtesting data. To see futures data, use</span>
|
||||
<span class="go"> trading-mode additionally.</span>
|
||||
<span class="go"> --userdir, --user-data-dir PATH</span>
|
||||
<span class="go"> Path to userdata directory.</span>
|
||||
|
||||
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.
|
||||
<span class="go">Strategy arguments:</span>
|
||||
<span class="go"> -s, --strategy NAME Specify strategy class name which will be used by the</span>
|
||||
<span class="go"> bot.</span>
|
||||
<span class="go"> --strategy-path PATH Specify additional strategy lookup path.</span>
|
||||
<span class="go"> --recursive-strategy-search</span>
|
||||
<span class="go"> Recursively search for a strategy in the strategies</span>
|
||||
<span class="go"> folder.</span>
|
||||
<span class="go"> --freqaimodel NAME Specify a custom freqaimodels.</span>
|
||||
<span class="go"> --freqaimodel-path PATH</span>
|
||||
<span class="go"> Specify additional lookup path for freqaimodels.</span>
|
||||
</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>Examples:</p>
|
||||
|
||||
@@ -1772,65 +1772,63 @@ This does not backtest the strategy itself, but rather only calculates the indic
|
||||
</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>
|
||||
<h2 id="recursive-analysis-command-reference">Recursive-analysis command reference<a class="headerlink" href="#recursive-analysis-command-reference" title="Permanent link">¶</a></h2>
|
||||
<div class="highlight"><pre><span></span><code>usage: freqtrade recursive-analysis [-h] [-v] [--no-color] [--logfile FILE]
|
||||
[-V] [-c PATH] [-d PATH] [--userdir PATH]
|
||||
[-s NAME] [--strategy-path PATH]
|
||||
[--recursive-strategy-search]
|
||||
[--freqaimodel NAME]
|
||||
[--freqaimodel-path PATH] [-i TIMEFRAME]
|
||||
[--timerange TIMERANGE]
|
||||
[--data-format-ohlcv {json,jsongz,feather,parquet}]
|
||||
[-p PAIRS [PAIRS ...]]
|
||||
[--startup-candle STARTUP_CANDLE [STARTUP_CANDLE ...]]
|
||||
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade recursive-analysis [-h] [-v] [--no-color] [--logfile FILE]</span>
|
||||
<span class="go"> [-V] [-c PATH] [-d PATH] [--userdir PATH]</span>
|
||||
<span class="go"> [-s NAME] [--strategy-path PATH]</span>
|
||||
<span class="go"> [--recursive-strategy-search]</span>
|
||||
<span class="go"> [--freqaimodel NAME]</span>
|
||||
<span class="go"> [--freqaimodel-path PATH] [-i TIMEFRAME]</span>
|
||||
<span class="go"> [--timerange TIMERANGE]</span>
|
||||
<span class="go"> [--data-format-ohlcv {json,jsongz,feather,parquet}]</span>
|
||||
<span class="go"> [-p PAIRS [PAIRS ...]]</span>
|
||||
<span class="go"> [--startup-candle STARTUP_CANDLE [STARTUP_CANDLE ...]]</span>
|
||||
|
||||
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`).
|
||||
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
|
||||
Limit command to these pairs. Pairs are space-
|
||||
separated.
|
||||
--startup-candle STARTUP_CANDLE [STARTUP_CANDLE ...]
|
||||
Specify startup candles to be checked (`199`, `499`,
|
||||
`999`, `1999`).
|
||||
<span class="go">options:</span>
|
||||
<span class="go"> -h, --help show this help message and exit</span>
|
||||
<span class="go"> -i, --timeframe TIMEFRAME</span>
|
||||
<span class="go"> Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).</span>
|
||||
<span class="go"> --timerange TIMERANGE</span>
|
||||
<span class="go"> Specify what timerange of data to use.</span>
|
||||
<span class="go"> --data-format-ohlcv {json,jsongz,feather,parquet}</span>
|
||||
<span class="go"> Storage format for downloaded candle (OHLCV) data.</span>
|
||||
<span class="go"> (default: `feather`).</span>
|
||||
<span class="go"> -p, --pairs PAIRS [PAIRS ...]</span>
|
||||
<span class="go"> Limit command to these pairs. Pairs are space-</span>
|
||||
<span class="go"> separated.</span>
|
||||
<span class="go"> --startup-candle STARTUP_CANDLE [STARTUP_CANDLE ...]</span>
|
||||
<span class="go"> Specify startup candles to be checked (`199`, `499`,</span>
|
||||
<span class="go"> `999`, `1999`).</span>
|
||||
|
||||
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:
|
||||
'syslog', 'journald'. See the documentation for more
|
||||
details.
|
||||
-V, --version show program'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 the base directory of the exchange with
|
||||
historical backtesting data. To see futures data, use
|
||||
trading-mode additionally.
|
||||
--userdir PATH, --user-data-dir PATH
|
||||
Path to userdata directory.
|
||||
<span class="go">Common arguments:</span>
|
||||
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
||||
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
||||
<span class="go"> useful if you are redirecting output to a file.</span>
|
||||
<span class="go"> --logfile, --log-file FILE</span>
|
||||
<span class="go"> Log to the file specified. Special values are:</span>
|
||||
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
||||
<span class="go"> details.</span>
|
||||
<span class="go"> -V, --version show program's version number and exit</span>
|
||||
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
||||
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
||||
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
||||
<span class="go"> set to `-` to read config from stdin.</span>
|
||||
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
||||
<span class="go"> Path to the base directory of the exchange with</span>
|
||||
<span class="go"> historical backtesting data. To see futures data, use</span>
|
||||
<span class="go"> trading-mode additionally.</span>
|
||||
<span class="go"> --userdir, --user-data-dir PATH</span>
|
||||
<span class="go"> Path to userdata directory.</span>
|
||||
|
||||
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.
|
||||
<span class="go">Strategy arguments:</span>
|
||||
<span class="go"> -s, --strategy NAME Specify strategy class name which will be used by the</span>
|
||||
<span class="go"> bot.</span>
|
||||
<span class="go"> --strategy-path PATH Specify additional strategy lookup path.</span>
|
||||
<span class="go"> --recursive-strategy-search</span>
|
||||
<span class="go"> Recursively search for a strategy in the strategies</span>
|
||||
<span class="go"> folder.</span>
|
||||
<span class="go"> --freqaimodel NAME Specify a custom freqaimodels.</span>
|
||||
<span class="go"> --freqaimodel-path PATH</span>
|
||||
<span class="go"> Specify additional lookup path for freqaimodels.</span>
|
||||
</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">¶</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>
|
||||
|
||||
@@ -794,6 +794,15 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#freqtrade-client-available-commands" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Freqtrade client- available commands
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@@ -1847,6 +1856,15 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#freqtrade-client-available-commands" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Freqtrade client- available commands
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@@ -2067,6 +2085,7 @@ to do so, please use the following:</p>
|
||||
</code></pre></div>
|
||||
<p>For a full list of available commands, please refer to the list below.</p>
|
||||
</details>
|
||||
<h4 id="freqtrade-client-available-commands">Freqtrade client- available commands<a class="headerlink" href="#freqtrade-client-available-commands" title="Permanent link">¶</a></h4>
|
||||
<p>Possible commands can be listed from the rest-client script using the <code>help</code> command.</p>
|
||||
<div class="highlight"><pre><span></span><code>freqtrade-client<span class="w"> </span><span class="nb">help</span>
|
||||
</code></pre></div>
|
||||
@@ -2075,8 +2094,8 @@ to do so, please use the following:</p>
|
||||
<span class="go">available_pairs</span>
|
||||
<span class="go"> Return available pair (backtest data) based on timeframe / stake_currency selection</span>
|
||||
|
||||
<span class="go"> :param timeframe: Only pairs with this timeframe available.</span>
|
||||
<span class="go"> :param stake_currency: Only pairs that include this timeframe</span>
|
||||
<span class="go">:param timeframe: Only pairs with this timeframe available.</span>
|
||||
<span class="go">:param stake_currency: Only pairs that include this stake currency.</span>
|
||||
|
||||
<span class="go">balance</span>
|
||||
<span class="go"> Get the account balance.</span>
|
||||
@@ -2084,12 +2103,12 @@ to do so, please use the following:</p>
|
||||
<span class="go">blacklist</span>
|
||||
<span class="go"> Show the current blacklist.</span>
|
||||
|
||||
<span class="go"> :param add: List of coins to add (example: "BNB/BTC")</span>
|
||||
<span class="go">:param add: List of coins to add (example: "BNB/BTC")</span>
|
||||
|
||||
<span class="go">cancel_open_order</span>
|
||||
<span class="go"> Cancel open order for trade.</span>
|
||||
|
||||
<span class="go"> :param trade_id: Cancels open orders for this trade.</span>
|
||||
<span class="go">:param trade_id: Cancels open orders for this trade.</span>
|
||||
|
||||
<span class="go">count</span>
|
||||
<span class="go"> Return the amount of open trades.</span>
|
||||
@@ -2100,48 +2119,69 @@ to do so, please use the following:</p>
|
||||
<span class="go">delete_lock</span>
|
||||
<span class="go"> Delete (disable) lock from the database.</span>
|
||||
|
||||
<span class="go"> :param lock_id: ID for the lock to delete</span>
|
||||
<span class="go">:param lock_id: ID for the lock to delete</span>
|
||||
|
||||
<span class="go">delete_trade</span>
|
||||
<span class="go"> Delete trade from the database.</span>
|
||||
<span class="go"> Tries to close open orders. Requires manual handling of this asset on the exchange.</span>
|
||||
<span class="go">Tries to close open orders. Requires manual handling of this asset on the exchange.</span>
|
||||
|
||||
<span class="go"> :param trade_id: Deletes the trade with this ID from the database.</span>
|
||||
<span class="go">:param trade_id: Deletes the trade with this ID from the database.</span>
|
||||
|
||||
<span class="go">entries</span>
|
||||
<span class="go"> Returns List of dicts containing all Trades, based on buy tag performance</span>
|
||||
<span class="go">Can either be average for all pairs or a specific pair provided</span>
|
||||
|
||||
<span class="go">exits</span>
|
||||
<span class="go"> Returns List of dicts containing all Trades, based on exit reason performance</span>
|
||||
<span class="go">Can either be average for all pairs or a specific pair provided</span>
|
||||
|
||||
<span class="go">forcebuy</span>
|
||||
<span class="go"> Buy an asset.</span>
|
||||
|
||||
<span class="go"> :param pair: Pair to buy (ETH/BTC)</span>
|
||||
<span class="go"> :param price: Optional - price to buy</span>
|
||||
<span class="go">:param pair: Pair to buy (ETH/BTC)</span>
|
||||
<span class="go">:param price: Optional - price to buy</span>
|
||||
|
||||
<span class="go">forceenter</span>
|
||||
<span class="go"> Force entering a trade</span>
|
||||
|
||||
<span class="go"> :param pair: Pair to buy (ETH/BTC)</span>
|
||||
<span class="go"> :param side: 'long' or 'short'</span>
|
||||
<span class="go"> :param price: Optional - price to buy</span>
|
||||
<span class="go"> :param order_type: Optional keyword argument - 'limit' or 'market'</span>
|
||||
<span class="go"> :param stake_amount: Optional keyword argument - stake amount (as float)</span>
|
||||
<span class="go"> :param leverage: Optional keyword argument - leverage (as float)</span>
|
||||
<span class="go"> :param enter_tag: Optional keyword argument - entry tag (as string, default: 'force_enter')</span>
|
||||
<span class="go">:param pair: Pair to buy (ETH/BTC)</span>
|
||||
<span class="go">:param side: 'long' or 'short'</span>
|
||||
<span class="go">:param price: Optional - price to buy</span>
|
||||
<span class="go">:param order_type: Optional keyword argument - 'limit' or 'market'</span>
|
||||
<span class="go">:param stake_amount: Optional keyword argument - stake amount (as float)</span>
|
||||
<span class="go">:param leverage: Optional keyword argument - leverage (as float)</span>
|
||||
<span class="go">:param enter_tag: Optional keyword argument - entry tag (as string, default: 'force_enter')</span>
|
||||
|
||||
<span class="go">forceexit</span>
|
||||
<span class="go"> Force-exit a trade.</span>
|
||||
|
||||
<span class="go"> :param tradeid: Id of the trade (can be received via status command)</span>
|
||||
<span class="go"> :param ordertype: Order type to use (must be market or limit)</span>
|
||||
<span class="go"> :param amount: Amount to sell. Full sell if not given</span>
|
||||
<span class="go">:param tradeid: Id of the trade (can be received via status command)</span>
|
||||
<span class="go">:param ordertype: Order type to use (must be market or limit)</span>
|
||||
<span class="go">:param amount: Amount to sell. Full sell if not given</span>
|
||||
|
||||
<span class="go">health</span>
|
||||
<span class="go"> Provides a quick health check of the running bot.</span>
|
||||
|
||||
<span class="go">lock_add</span>
|
||||
<span class="go"> Manually lock a specific pair</span>
|
||||
<span class="go">list_custom_data</span>
|
||||
<span class="go"> List custom-data of the running bot for a specific trade.</span>
|
||||
|
||||
<span class="go"> :param pair: Pair to lock</span>
|
||||
<span class="go"> :param until: Lock until this date (format "2024-03-30 16:00:00Z")</span>
|
||||
<span class="go"> :param side: Side to lock (long, short, *)</span>
|
||||
<span class="go"> :param reason: Reason for the lock </span>
|
||||
<span class="go">:param trade_id: ID of the trade</span>
|
||||
<span class="go">:param key: str, optional - Key of the custom-data</span>
|
||||
|
||||
<span class="go">list_open_trades_custom_data</span>
|
||||
<span class="go"> List open trades custom-data of the running bot.</span>
|
||||
|
||||
<span class="go">:param key: str, optional - Key of the custom-data</span>
|
||||
<span class="go">:param limit: limit of trades</span>
|
||||
<span class="go">:param offset: trades offset for pagination</span>
|
||||
|
||||
<span class="go">lock_add</span>
|
||||
<span class="go"> Lock pair</span>
|
||||
|
||||
<span class="go">:param pair: Pair to lock</span>
|
||||
<span class="go">:param until: Lock until this date (format "2024-03-30 16:00:00Z")</span>
|
||||
<span class="go">:param side: Side to lock (long, short, *)</span>
|
||||
<span class="go">:param reason: Reason for the lock</span>
|
||||
|
||||
<span class="go">locks</span>
|
||||
<span class="go"> Return current locks</span>
|
||||
@@ -2149,22 +2189,34 @@ to do so, please use the following:</p>
|
||||
<span class="go">logs</span>
|
||||
<span class="go"> Show latest logs.</span>
|
||||
|
||||
<span class="go"> :param limit: Limits log messages to the last <limit> logs. No limit to get the entire log.</span>
|
||||
<span class="go">:param limit: Limits log messages to the last <limit> logs. No limit to get the entire log.</span>
|
||||
|
||||
<span class="go">mix_tags</span>
|
||||
<span class="go"> Returns List of dicts containing all Trades, based on entry_tag + exit_reason performance</span>
|
||||
<span class="go">Can either be average for all pairs or a specific pair provided</span>
|
||||
|
||||
<span class="go">monthly</span>
|
||||
<span class="go"> Return the profits for each month, and amount of trades.</span>
|
||||
|
||||
<span class="go">pair_candles</span>
|
||||
<span class="go"> Return live dataframe for <pair><timeframe>.</span>
|
||||
|
||||
<span class="go"> :param pair: Pair to get data for</span>
|
||||
<span class="go"> :param timeframe: Only pairs with this timeframe available.</span>
|
||||
<span class="go"> :param limit: Limit result to the last n candles.</span>
|
||||
<span class="go">:param pair: Pair to get data for</span>
|
||||
<span class="go">:param timeframe: Only pairs with this timeframe available.</span>
|
||||
<span class="go">:param limit: Limit result to the last n candles.</span>
|
||||
<span class="go">:param columns: List of dataframe columns to return. Empty list will return OHLCV.</span>
|
||||
|
||||
<span class="go">pair_history</span>
|
||||
<span class="go"> Return historic, analyzed dataframe</span>
|
||||
|
||||
<span class="go"> :param pair: Pair to get data for</span>
|
||||
<span class="go"> :param timeframe: Only pairs with this timeframe available.</span>
|
||||
<span class="go"> :param strategy: Strategy to analyze and get values for</span>
|
||||
<span class="go"> :param timerange: Timerange to get data for (same format than --timerange endpoints)</span>
|
||||
<span class="go">:param pair: Pair to get data for</span>
|
||||
<span class="go">:param timeframe: Only pairs with this timeframe available.</span>
|
||||
<span class="go">:param strategy: Strategy to analyze and get values for</span>
|
||||
<span class="go">:param freqaimodel: FreqAI model to use for analysis</span>
|
||||
<span class="go">:param timerange: Timerange to get data for (same format than --timerange endpoints)</span>
|
||||
|
||||
<span class="go">pairlists_available</span>
|
||||
<span class="go"> Lists available pairlist providers</span>
|
||||
|
||||
<span class="go">performance</span>
|
||||
<span class="go"> Return the performance of the different coins.</span>
|
||||
@@ -2187,9 +2239,6 @@ to do so, please use the following:</p>
|
||||
<span class="go">start</span>
|
||||
<span class="go"> Start the bot if it's in the stopped state.</span>
|
||||
|
||||
<span class="go">pause</span>
|
||||
<span class="go"> Pause the bot if it's in the running state. If triggered on stopped state will handle open positions.</span>
|
||||
|
||||
<span class="go">stats</span>
|
||||
<span class="go"> Return the stats report (durations, sell-reasons).</span>
|
||||
|
||||
@@ -2208,7 +2257,7 @@ to do so, please use the following:</p>
|
||||
<span class="go">strategy</span>
|
||||
<span class="go"> Get strategy details</span>
|
||||
|
||||
<span class="go"> :param strategy: Strategy class name</span>
|
||||
<span class="go">:param strategy: Strategy class name</span>
|
||||
|
||||
<span class="go">sysinfo</span>
|
||||
<span class="go"> Provides system information (CPU, RAM usage)</span>
|
||||
@@ -2216,30 +2265,21 @@ to do so, please use the following:</p>
|
||||
<span class="go">trade</span>
|
||||
<span class="go"> Return specific trade</span>
|
||||
|
||||
<span class="go"> :param trade_id: Specify which trade to get.</span>
|
||||
<span class="go">:param trade_id: Specify which trade to get.</span>
|
||||
|
||||
<span class="go">trades</span>
|
||||
<span class="go"> Return trades history, sorted by id</span>
|
||||
<span class="go"> Return trades history, sorted by id (or by latest timestamp if order_by_id=False)</span>
|
||||
|
||||
<span class="go"> :param limit: Limits trades to the X last trades. Max 500 trades.</span>
|
||||
<span class="go"> :param offset: Offset by this amount of trades.</span>
|
||||
|
||||
<span class="go">list_open_trades_custom_data</span>
|
||||
<span class="go"> Return a dict containing open trades custom-datas</span>
|
||||
|
||||
<span class="go"> :param key: str, optional - Key of the custom-data</span>
|
||||
<span class="go"> :param limit: Limits trades to X trades.</span>
|
||||
<span class="go"> :param offset: Offset by this amount of trades.</span>
|
||||
|
||||
<span class="go">list_custom_data</span>
|
||||
<span class="go"> Return a dict containing custom-datas of a specified trade</span>
|
||||
|
||||
<span class="go"> :param trade_id: int - ID of the trade</span>
|
||||
<span class="go"> :param key: str, optional - Key of the custom-data</span>
|
||||
<span class="go">:param limit: Limits trades to the X last trades. Max 500 trades.</span>
|
||||
<span class="go">:param offset: Offset by this amount of trades.</span>
|
||||
<span class="go">:param order_by_id: Sort trades by id (default: True). If False, sorts by latest timestamp.</span>
|
||||
|
||||
<span class="go">version</span>
|
||||
<span class="go"> Return the version of the bot.</span>
|
||||
|
||||
<span class="go">weekly</span>
|
||||
<span class="go"> Return the profits for each week, and amount of trades.</span>
|
||||
|
||||
<span class="go">whitelist</span>
|
||||
<span class="go"> Show the current whitelist.</span>
|
||||
</code></pre></div>
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user