mohammadian7/freqtrade
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Deployed 7e7e475 to develop in en with MkDocs 1.6.1 and mike 2.1.4

Browse Source
This commit is contained in:
github-actions[bot]
2026-03-31 05:20:03 +00:00
parent df495f4472
commit 970aa93176
44 changed files with 13314 additions and 6959 deletions
Download Patch File Download Diff File Expand all files Collapse all files
en/develop/data-download/index.html
+320 -319
View File
@@ -2336,84 +2336,85 @@ 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">&para;</a></h3>
<p>``` output
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}]
[--candle-types {spot,futures,mark,index,premiumIndex,funding_rate} [{spot,futures,mark,index,premiumIndex,funding_rate} ...]]
[--prepend]</p>
<p>options:
-h, --help show this help message and exit
-p, --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: <code>None</code>.
--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 <code>--dl-trades</code>. Will be
automatic for exchanges which don't have historic
OHLCV (e.g. Kraken). If not provided, use <code>trades-to-
ohlcv</code> to convert trades data to OHLCV data.
--exchange EXCHANGE Exchange name. Only valid if no config is provided.
-t, --timeframes TIMEFRAMES [TIMEFRAMES ...]
Specify which tickers to download. Space-separated
list. Default: <code>1m 5m</code>.
--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: <code>feather</code>).
--data-format-trades {json,jsongz,feather,parquet}
Storage format for downloaded trades data. (default:
<code>feather</code>).
--trading-mode, --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 download. Defaults to the
necessary candles for the selected trading mode (e.g.
'spot' or ('futures', 'funding_rate' and 'mark') for
futures).
--prepend Allow data prepending. (Data-appending is disabled)</p>
<p>Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile, --log-file FILE
Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more
details.
-V, --version show program's version number and exit
-c, --config PATH Specify configuration file (default:
<code>userdir/config.json</code> or <code>config.json</code> whichever
exists). Multiple --config options may be used. Can be
set to <code>-</code> to read config from stdin.
-d, --datadir, --data-dir PATH
Path to the base directory of the exchange with
historical backtesting data. To see futures data, use
trading-mode additionally.
--userdir, --user-data-dir PATH
Path to userdata directory.</p>
<p>```</p>
<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"> [--candle-types {spot,futures,mark,index,premiumIndex,funding_rate} [{spot,futures,mark,index,premiumIndex,funding_rate} ...]]</span>
<span class="go"> [--prepend]</span>
<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&#39;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"> --candle-types {spot,futures,mark,index,premiumIndex,funding_rate} [{spot,futures,mark,index,premiumIndex,funding_rate} ...]</span>
<span class="go"> Select candle type to download. Defaults to the</span>
<span class="go"> necessary candles for the selected trading mode (e.g.</span>
<span class="go"> &#39;spot&#39; or (&#39;futures&#39;, &#39;funding_rate&#39; and &#39;mark&#39;) for</span>
<span class="go"> futures).</span>
<span class="go"> --prepend Allow data prepending. (Data-appending is disabled)</span>
<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"> &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more</span>
<span class="go"> details.</span>
<span class="go"> -V, --version show program&#39;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>
<p>Often, you'll want to download data for all pairs of a specific quote-currency. In such cases, you can use the following shorthand:
@@ -2427,15 +2428,15 @@ To also download data for inactive (delisted) pairs, add <code>--include-inactiv
</div>
<h3 id="start-download">Start download<a class="headerlink" href="#start-download" title="Permanent link">&para;</a></h3>
<p>A very simple command (assuming an available <code>config.json</code> file) can look as follows.</p>
<p><code>bash
freqtrade download-data --exchange binance</code></p>
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>download-data<span class="w"> </span>--exchange<span class="w"> </span>binance
</code></pre></div>
<p>This will download historical candle (OHLCV) data for all the currency pairs defined in the configuration.</p>
<p>Alternatively, specify the pairs directly</p>
<p><code>bash
freqtrade download-data --exchange binance --pairs ETH/USDT XRP/USDT BTC/USDT</code></p>
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>download-data<span class="w"> </span>--exchange<span class="w"> </span>binance<span class="w"> </span>--pairs<span class="w"> </span>ETH/USDT<span class="w"> </span>XRP/USDT<span class="w"> </span>BTC/USDT
</code></pre></div>
<p>or as regex (in this case, to download all active USDT pairs)</p>
<p><code>bash
freqtrade download-data --exchange binance --pairs ".*/USDT"</code></p>
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>download-data<span class="w"> </span>--exchange<span class="w"> </span>binance<span class="w"> </span>--pairs<span class="w"> </span><span class="s2">&quot;.*/USDT&quot;</span>
</code></pre></div>
<h3 id="other-notes">Other Notes<a class="headerlink" href="#other-notes" title="Permanent link">&para;</a></h3>
<ul>
<li>To use a different directory than the exchange specific default, use <code>--datadir user_data/data/some_directory</code>.</li>
@@ -2451,15 +2452,17 @@ freqtrade download-data --exchange binance --pairs ".*/USDT"</code></p>
<details class="note">
<summary>Permission denied errors</summary>
<p>If your configuration directory <code>user_data</code> was made by docker, you may get the following error:</p>
<p><code>cp: cannot create regular file 'user_data/data/binance/pairs.json': Permission denied</code></p>
<div class="highlight"><pre><span></span><code>cp: cannot create regular file &#39;user_data/data/binance/pairs.json&#39;: Permission denied
</code></pre></div>
<p>You can fix the permissions of your user-data directory as follows:</p>
<p><code>sudo chown -R $UID:$GID user_data</code></p>
<div class="highlight"><pre><span></span><code>sudo chown -R $UID:$GID user_data
</code></pre></div>
</details>
<h3 id="download-additional-data-before-the-current-timerange">Download additional data before the current timerange<a class="headerlink" href="#download-additional-data-before-the-current-timerange" title="Permanent link">&para;</a></h3>
<p>Assuming you downloaded all data from 2022 (<code>--timerange 20220101-</code>) - but you'd now like to also backtest with earlier data.
You can do so by using the <code>--prepend</code> flag, combined with <code>--timerange</code> - specifying an end-date.</p>
<p><code>bash
freqtrade download-data --exchange binance --pairs ETH/USDT XRP/USDT BTC/USDT --prepend --timerange 20210101-20220101</code></p>
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>download-data<span class="w"> </span>--exchange<span class="w"> </span>binance<span class="w"> </span>--pairs<span class="w"> </span>ETH/USDT<span class="w"> </span>XRP/USDT<span class="w"> </span>BTC/USDT<span class="w"> </span>--prepend<span class="w"> </span>--timerange<span class="w"> </span><span class="m">20210101</span>-20220101
</code></pre></div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Freqtrade will ignore the end-date in this mode if data is available, updating the end-date to the existing data start point.</p>
@@ -2475,11 +2478,11 @@ freqtrade download-data --exchange binance --pairs ETH/USDT XRP/USDT BTC/USDT --
<p>By default, both OHLCV data and trades data are stored in the <code>feather</code> format.</p>
<p>This can be changed via the <code>--data-format-ohlcv</code> and <code>--data-format-trades</code> command line arguments respectively.
To persist this change, you should also add the following snippet to your configuration, so you don't have to insert the above arguments each time:</p>
<p><code>jsonc
<div class="highlight"><pre><span></span><code> // ...
&quot;dataformat_ohlcv&quot;: &quot;feather&quot;,
&quot;dataformat_trades&quot;: &quot;feather&quot;,
// ...
"dataformat_ohlcv": "feather",
"dataformat_trades": "feather",
// ...</code></p>
</code></pre></div>
<p>If the default data-format has been changed during download, then the keys <code>dataformat_ohlcv</code> and <code>dataformat_trades</code> in the configuration file need to be adjusted to the selected dataformat as well.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
@@ -2487,7 +2490,7 @@ To persist this change, you should also add the following snippet to your config
</div>
<h4 id="dataformat-comparison">Dataformat comparison<a class="headerlink" href="#dataformat-comparison" title="Permanent link">&para;</a></h4>
<p>The following comparisons have been made with the following data, and by using the linux <code>time</code> command.</p>
<p><code>Found 6 pair / timeframe combinations.
<div class="highlight"><pre><span></span><code>Found 6 pair / timeframe combinations.
+----------+-------------+--------+---------------------+---------------------+
| Pair | Timeframe | Type | From | To |
|----------+-------------+--------+---------------------+---------------------|
@@ -2497,10 +2500,11 @@ To persist this change, you should also add the following snippet to your config
| XRP/USDT | 5m | spot | 2018-05-04 08:10:00 | 2022-09-13 19:15:00 |
| XRP/USDT | 1m | spot | 2018-05-04 08:11:00 | 2022-09-13 19:22:00 |
| ETH/USDT | 5m | spot | 2017-08-17 04:00:00 | 2022-09-13 19:20:00 |
+----------+-------------+--------+---------------------+---------------------+</code></p>
+----------+-------------+--------+---------------------+---------------------+
</code></pre></div>
<p>Timings have been taken in a not very scientific way with the following command, which forces reading the data into memory.</p>
<p><code>bash
time freqtrade list-data --show-timerange --data-format-ohlcv &lt;dataformat&gt;</code></p>
<div class="highlight"><pre><span></span><code><span class="nb">time</span><span class="w"> </span>freqtrade<span class="w"> </span>list-data<span class="w"> </span>--show-timerange<span class="w"> </span>--data-format-ohlcv<span class="w"> </span>&lt;dataformat&gt;
</code></pre></div>
<table>
<thead>
<tr>
@@ -2541,253 +2545,250 @@ If you are using Binance for example:</p>
<li>create a directory <code>user_data/data/binance</code> and copy or create the <code>pairs.json</code> file in that directory.</li>
<li>update the <code>pairs.json</code> file to contain the currency pairs you are interested in.</li>
</ul>
<p><code>bash
mkdir -p user_data/data/binance
touch user_data/data/binance/pairs.json</code></p>
<div class="highlight"><pre><span></span><code>mkdir<span class="w"> </span>-p<span class="w"> </span>user_data/data/binance
touch<span class="w"> </span>user_data/data/binance/pairs.json
</code></pre></div>
<p>The format of the <code>pairs.json</code> file is a simple json list.
Mixing different stake-currencies is allowed for this file, since it's only used for downloading.</p>
<p><code>json
[
"ETH/BTC",
"ETH/USDT",
"BTC/USDT",
"XRP/ETH"
]</code></p>
<div class="highlight"><pre><span></span><code><span class="p">[</span>
<span class="w"> </span><span class="s2">&quot;ETH/BTC&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s2">&quot;ETH/USDT&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s2">&quot;BTC/USDT&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s2">&quot;XRP/ETH&quot;</span>
<span class="p">]</span>
</code></pre></div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The <code>pairs.json</code> file is only used when no configuration is loaded (implicitly by naming, or via <code>--config</code> flag).
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">&para;</a></h2>
<p>``` output
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} ...]]</p>
<p>options:
-h, --help show this help message and exit
-p, --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 ...]
Specify which tickers to download. Space-separated
list. Default: <code>1m 5m</code>.
--trading-mode, --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.</p>
<p>Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile, --log-file FILE
Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more
details.
-V, --version show program's version number and exit
-c, --config PATH Specify configuration file (default:
<code>userdir/config.json</code> or <code>config.json</code> whichever
exists). Multiple --config options may be used. Can be
set to <code>-</code> to read config from stdin.
-d, --datadir, --data-dir PATH
Path to the base directory of the exchange with
historical backtesting data. To see futures data, use
trading-mode additionally.
--userdir, --user-data-dir PATH
Path to userdata directory.</p>
<p>```</p>
<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>
<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>
<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"> &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more</span>
<span class="go"> details.</span>
<span class="go"> -V, --version show program&#39;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">&para;</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.
It'll also remove original json data files (<code>--erase</code> parameter).</p>
<p><code>bash
freqtrade convert-data --format-from json --format-to jsongz --datadir ~/.freqtrade/data/binance -t 5m 15m --erase</code></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">&para;</a></h2>
<p>``` output
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]</p>
<p>options:
-h, --help show this help message and exit
-p, --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.</p>
<p>Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile, --log-file FILE
Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more
details.
-V, --version show program's version number and exit
-c, --config PATH Specify configuration file (default:
<code>userdir/config.json</code> or <code>config.json</code> whichever
exists). Multiple --config options may be used. Can be
set to <code>-</code> to read config from stdin.
-d, --datadir, --data-dir PATH
Path to the base directory of the exchange with
historical backtesting data. To see futures data, use
trading-mode additionally.
--userdir, --user-data-dir PATH
Path to userdata directory.</p>
<p>```</p>
<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>
<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>
<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"> &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more</span>
<span class="go"> details.</span>
<span class="go"> -V, --version show program&#39;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">&para;</a></h3>
<p>The following command will convert all available trade-data in <code>~/.freqtrade/data/kraken</code> from jsongz to json.
It'll also remove original jsongz data files (<code>--erase</code> parameter).</p>
<p><code>bash
freqtrade convert-trade-data --format-from jsongz --format-to json --datadir ~/.freqtrade/data/kraken --erase</code></p>
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>convert-trade-data<span class="w"> </span>--format-from<span class="w"> </span>jsongz<span class="w"> </span>--format-to<span class="w"> </span>json<span class="w"> </span>--datadir<span class="w"> </span>~/.freqtrade/data/kraken<span class="w"> </span>--erase
</code></pre></div>
<h2 id="sub-command-trades-to-ohlcv">Sub-command trades to ohlcv<a class="headerlink" href="#sub-command-trades-to-ohlcv" title="Permanent link">&para;</a></h2>
<p>When you need to use <code>--dl-trades</code> (kraken only) to download data, conversion of trades data to ohlcv data is the last step.
This command will allow you to repeat this last step for additional timeframes without re-downloading the data.</p>
<p>``` output
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}]</p>
<p>options:
-h, --help show this help message and exit
-p, --pairs PAIRS [PAIRS ...]
Limit command to these pairs. Pairs are space-
separated.
-t, --timeframes TIMEFRAMES [TIMEFRAMES ...]
Specify which tickers to download. Space-separated
list. Default: <code>1m 5m</code>.
--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: <code>feather</code>).
--data-format-trades {json,jsongz,feather,parquet}
Storage format for downloaded trades data. (default:
<code>feather</code>).
--trading-mode, --tradingmode {spot,margin,futures}
Select Trading mode</p>
<p>Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile, --log-file FILE
Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more
details.
-V, --version show program's version number and exit
-c, --config PATH Specify configuration file (default:
<code>userdir/config.json</code> or <code>config.json</code> whichever
exists). Multiple --config options may be used. Can be
set to <code>-</code> to read config from stdin.
-d, --datadir, --data-dir PATH
Path to the base directory of the exchange with
historical backtesting data. To see futures data, use
trading-mode additionally.
--userdir, --user-data-dir PATH
Path to userdata directory.</p>
<p>```</p>
<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>
<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>
<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"> &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more</span>
<span class="go"> details.</span>
<span class="go"> -V, --version show program&#39;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">&para;</a></h3>
<p><code>bash
freqtrade trades-to-ohlcv --exchange kraken -t 5m 1h 1d --pairs BTC/EUR ETH/EUR</code></p>
<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">&para;</a></h2>
<p>You can get a list of downloaded data using the <code>list-data</code> sub-command.</p>
<p>``` output
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]</p>
<p>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: <code>feather</code>).
--data-format-trades {json,jsongz,feather,parquet}
Storage format for downloaded trades data. (default:
<code>feather</code>).
--trades Work on trades data instead of OHLCV data.
-p, --pairs PAIRS [PAIRS ...]
Limit command to these pairs. Pairs are space-
separated.
--trading-mode, --tradingmode {spot,margin,futures}
Select Trading mode
--show-timerange Show timerange available for available data. (May take
a while to calculate).</p>
<p>Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file.
--logfile, --log-file FILE
Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more
details.
-V, --version show program's version number and exit
-c, --config PATH Specify configuration file (default:
<code>userdir/config.json</code> or <code>config.json</code> whichever
exists). Multiple --config options may be used. Can be
set to <code>-</code> to read config from stdin.
-d, --datadir, --data-dir PATH
Path to the base directory of the exchange with
historical backtesting data. To see futures data, use
trading-mode additionally.
--userdir, --user-data-dir PATH
Path to userdata directory.</p>
<p>```</p>
<h3 id="example-list-data">Example list-data<a class="headerlink" href="#example-list-data" title="Permanent link">&para;</a></h3>
<p>```bash</p>
<blockquote>
<p>freqtrade list-data --userdir ~/.freqtrade/user_data/</p>
</blockquote>
<div class="codehilite"><pre><span></span><code> Found 33 pair / timeframe combinations.
</code></pre></div>
<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>
<p>┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━┓
┃ Pair ┃ Timeframe ┃ Type ┃
<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>
<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"> &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more</span>
<span class="go"> details.</span>
<span class="go"> -V, --version show program&#39;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">&para;</a></h3>
<div class="highlight"><pre><span></span><code>&gt;<span class="w"> </span>freqtrade<span class="w"> </span>list-data<span class="w"> </span>--userdir<span class="w"> </span>~/.freqtrade/user_data/
<span class="w"> </span>Found<span class="w"> </span><span class="m">33</span><span class="w"> </span>pair<span class="w"> </span>/<span class="w"> </span>timeframe<span class="w"> </span>combinations.
┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━┓
┃<span class="w"> </span>Pair<span class="w"> </span>┃<span class="w"> </span>Timeframe<span class="w"> </span>┃<span class="w"> </span>Type<span class="w"> </span>┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━┩
│ ADA/BTC │ 5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d │ spot │
│ ADA/ETH │ 5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d │ spot │
│ ETH/BTC │ 5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d │ spot │
│ ETH/USDT │ 5m, 15m, 30m, 1h, 2h, 4h │ spot │
└───────────────┴───────────────────────────────────────────┴──────┘</p>
<p>```</p>
│<span class="w"> </span>ADA/BTC<span class="w"> </span>│<span class="w"> </span>5m,<span class="w"> </span>15m,<span class="w"> </span>30m,<span class="w"> </span>1h,<span class="w"> </span>2h,<span class="w"> </span>4h,<span class="w"> </span>6h,<span class="w"> </span>12h,<span class="w"> </span>1d<span class="w"> </span>│<span class="w"> </span>spot<span class="w"> </span>│
│<span class="w"> </span>ADA/ETH<span class="w"> </span>│<span class="w"> </span>5m,<span class="w"> </span>15m,<span class="w"> </span>30m,<span class="w"> </span>1h,<span class="w"> </span>2h,<span class="w"> </span>4h,<span class="w"> </span>6h,<span class="w"> </span>12h,<span class="w"> </span>1d<span class="w"> </span>│<span class="w"> </span>spot<span class="w"> </span>│
│<span class="w"> </span>ETH/BTC<span class="w"> </span>│<span class="w"> </span>5m,<span class="w"> </span>15m,<span class="w"> </span>30m,<span class="w"> </span>1h,<span class="w"> </span>2h,<span class="w"> </span>4h,<span class="w"> </span>6h,<span class="w"> </span>12h,<span class="w"> </span>1d<span class="w"> </span>│<span class="w"> </span>spot<span class="w"> </span>│
│<span class="w"> </span>ETH/USDT<span class="w"> </span>│<span class="w"> </span>5m,<span class="w"> </span>15m,<span class="w"> </span>30m,<span class="w"> </span>1h,<span class="w"> </span>2h,<span class="w"> </span>4h<span class="w"> </span>│<span class="w"> </span>spot<span class="w"> </span>│
└───────────────┴───────────────────────────────────────────┴──────┘
</code></pre></div>
<p>Show all trades data including from/to timerange</p>
<p>``` bash</p>
<blockquote>
<p>freqtrade list-data --show --trades
Found trades data for 1 pair. <br />
<div class="highlight"><pre><span></span><code>&gt;<span class="w"> </span>freqtrade<span class="w"> </span>list-data<span class="w"> </span>--show<span class="w"> </span>--trades
<span class="w"> </span>Found<span class="w"> </span>trades<span class="w"> </span>data<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>pair.<span class="w"> </span>
┏━━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┓
┃ Pair ┃ Type ┃ From ┃ To ┃ Trades ┃
┃<span class="w"> </span>Pair<span class="w"> </span>┃<span class="w"> </span>Type<span class="w"> </span>┃<span class="w"> </span>From<span class="w"> </span>┃<span class="w"> </span>To<span class="w"> </span>┃<span class="w"> </span>Trades<span class="w"> </span>┃
┡━━━━━━━━━╇━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━┩
│ XRP/ETH │ spot │ 2019-10-11 00:00:11 │ 2019-10-13 11:19:28 │ 12477 │
└─────────┴──────┴─────────────────────┴─────────────────────┴────────┘</p>
</blockquote>
<p>```</p>
│<span class="w"> </span>XRP/ETH<span class="w"> </span>│<span class="w"> </span>spot<span class="w"> </span>│<span class="w"> </span><span class="m">2019</span>-10-11<span class="w"> </span><span class="m">00</span>:00:11<span class="w"> </span>│<span class="w"> </span><span class="m">2019</span>-10-13<span class="w"> </span><span class="m">11</span>:19:28<span class="w"> </span>│<span class="w"> </span><span class="m">12477</span><span class="w"> </span>│
└─────────┴──────┴─────────────────────┴─────────────────────┴────────┘
</code></pre></div>
<h2 id="trades-tick-data">Trades (tick) data<a class="headerlink" href="#trades-tick-data" title="Permanent link">&para;</a></h2>
<p>By default, <code>download-data</code> sub-command downloads Candles (OHLCV) data. Most exchanges also provide historic trade-data via their API.
This data can be useful if you need many different timeframes, since it is only downloaded once, and then resampled locally to the desired timeframes.</p>
@@ -2805,8 +2806,8 @@ Most other exchanges provide OHLCV data with sufficient history, so downloading
<p>Kraken Futures uses standard OHLCV downloads and does not require <code>--dl-trades</code>.</p>
</div>
<p>Example call:</p>
<p><code>bash
freqtrade download-data --exchange kraken --pairs XRP/EUR ETH/EUR --days 20 --dl-trades</code></p>
<div class="highlight"><pre><span></span><code>freqtrade<span class="w"> </span>download-data<span class="w"> </span>--exchange<span class="w"> </span>kraken<span class="w"> </span>--pairs<span class="w"> </span>XRP/EUR<span class="w"> </span>ETH/EUR<span class="w"> </span>--days<span class="w"> </span><span class="m">20</span><span class="w"> </span>--dl-trades
</code></pre></div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>While this method uses async calls, it will be slow, since it requires the result of the previous call to generate the next request to the exchange.</p>