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

Deployed 66577b7 to develop in en with MkDocs 1.6.1 and mike 2.1.3

Browse Source
This commit is contained in:
github-actions[bot]
2025-09-06 15:56:06 +00:00
parent eaabd5ba00
commit 2fe57dfb94
4 changed files with 108 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

File diff suppressed because one or more lines are too long

94
en/develop/sitemap.xml
View File

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

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

Binary file not shown.

60
en/develop/strategy-customization/index.html
View File

@@ -885,6 +885,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#funding_ratepair" class="md-nav__link">
<span class="md-ellipsis">
funding_rate(pair)
</span>
</a>
</li>
<li class="md-nav__item">
@@ -2495,6 +2504,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#funding_ratepair" class="md-nav__link">
<span class="md-ellipsis">
funding_rate(pair)
</span>
</a>
</li>
<li class="md-nav__item">
@@ -3365,6 +3383,7 @@ It is also not available in <code>populate_entry_trend()</code> and <code>popula
<li><code>ohlcv(pair, timeframe)</code> - Currently cached candle (OHLCV) data for the pair, returns DataFrame or empty DataFrame.</li>
<li><a href="#orderbookpair-maximum"><code>orderbook(pair, maximum)</code></a> - Returns latest orderbook data for the pair, a dict with bids/asks with a total of <code>maximum</code> entries.</li>
<li><a href="#tickerpair"><code>ticker(pair)</code></a> - Returns current ticker data for the pair. See <a href="https://github.com/ccxt/ccxt/wiki/Manual#price-tickers">ccxt documentation</a> for more details on the Ticker data structure.</li>
<li><a href="#funding_ratepair"><code>funding_rate(pair)</code></a> - Returns current funding rate data for the pair.</li>
<li><code>runmode</code> - Property containing the current runmode.</li>
</ul>
<h3 id="example-usages">Example Usages<a class="headerlink" href="#example-usages" title="Permanent link">&para;</a></h3>
@@ -3418,6 +3437,7 @@ You can check for this with <code>if dataframe.empty:</code> and handle this cas
This should not happen when using whitelisted pairs.</p>
</div>
<h3 id="orderbookpair-maximum"><em>orderbook(pair, maximum)</em><a class="headerlink" href="#orderbookpair-maximum" title="Permanent link">&para;</a></h3>
<p>Retrieve the current order book for a pair.</p>
<div class="highlight"><pre><span></span><code><span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">dp</span><span class="o">.</span><span class="n">runmode</span><span class="o">.</span><span class="n">value</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;live&#39;</span><span class="p">,</span> <span class="s1">&#39;dry_run&#39;</span><span class="p">):</span>
<span class="n">ob</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">dp</span><span class="o">.</span><span class="n">orderbook</span><span class="p">(</span><span class="n">metadata</span><span class="p">[</span><span class="s1">&#39;pair&#39;</span><span class="p">],</span> <span class="mi">1</span><span class="p">)</span>
<span class="n">dataframe</span><span class="p">[</span><span class="s1">&#39;best_bid&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">ob</span><span class="p">[</span><span class="s1">&#39;bids&#39;</span><span class="p">][</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
@@ -3461,6 +3481,46 @@ data returned from the exchange and add appropriate error handling / defaults.</
<p class="admonition-title">Warning about backtesting</p>
<p>This method will always return up-to-date / real-time values. As such, usage during backtesting / hyperopt without runmode checks will lead to wrong results, e.g. your whole dataframe will contain the same single value in all rows.</p>
</div>
<h3 id="funding_ratepair"><em>funding_rate(pair)</em><a class="headerlink" href="#funding_ratepair" title="Permanent link">&para;</a></h3>
<p>Retrieves the current funding rate for the pair and only works for futures pairs in the format of <code>base/quote:settle</code> (e.g. <code>ETH/USDT:USDT</code>).</p>
<div class="highlight"><pre><span></span><code><span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">dp</span><span class="o">.</span><span class="n">runmode</span><span class="o">.</span><span class="n">value</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;live&#39;</span><span class="p">,</span> <span class="s1">&#39;dry_run&#39;</span><span class="p">):</span>
<span class="n">funding_rate</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">dp</span><span class="o">.</span><span class="n">funding_rate</span><span class="p">(</span><span class="n">metadata</span><span class="p">[</span><span class="s1">&#39;pair&#39;</span><span class="p">])</span>
<span class="n">dataframe</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="s1">&#39;current_funding_rate&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">funding_rate</span><span class="p">[</span><span class="s1">&#39;fundingRate&#39;</span><span class="p">]</span>
<span class="n">dataframe</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="s1">&#39;next_funding_timestamp&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">funding_rate</span><span class="p">[</span><span class="s1">&#39;fundingTimestamp&#39;</span><span class="p">]</span>
<span class="n">dataframe</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="s1">&#39;next_funding_datetime&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">funding_rate</span><span class="p">[</span><span class="s1">&#39;fundingDatetime&#39;</span><span class="p">]</span>
</code></pre></div>
<p>The funding rate structure is aligned with the funding rate structure from <a href="https://github.com/ccxt/ccxt/wiki/Manual#funding-rate-structure">ccxt</a>, so the result will be formatted as follows:</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="s2">&quot;info&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="c1"># ... </span>
<span class="p">},</span>
<span class="s2">&quot;symbol&quot;</span><span class="p">:</span> <span class="s2">&quot;BTC/USDT:USDT&quot;</span><span class="p">,</span>
<span class="s2">&quot;markPrice&quot;</span><span class="p">:</span> <span class="mf">110730.7</span><span class="p">,</span>
<span class="s2">&quot;indexPrice&quot;</span><span class="p">:</span> <span class="mf">110782.52</span><span class="p">,</span>
<span class="s2">&quot;interestRate&quot;</span><span class="p">:</span> <span class="mf">0.0001</span><span class="p">,</span>
<span class="s2">&quot;estimatedSettlePrice&quot;</span><span class="p">:</span> <span class="mf">110822.67200153</span><span class="p">,</span>
<span class="s2">&quot;timestamp&quot;</span><span class="p">:</span> <span class="mi">1757146321001</span><span class="p">,</span>
<span class="s2">&quot;datetime&quot;</span><span class="p">:</span> <span class="s2">&quot;2025-09-06T08:12:01.001Z&quot;</span><span class="p">,</span>
<span class="s2">&quot;fundingRate&quot;</span><span class="p">:</span> <span class="mf">5.609e-05</span><span class="p">,</span>
<span class="s2">&quot;fundingTimestamp&quot;</span><span class="p">:</span> <span class="mi">1757174400000</span><span class="p">,</span>
<span class="s2">&quot;fundingDatetime&quot;</span><span class="p">:</span> <span class="s2">&quot;2025-09-06T16:00:00.000Z&quot;</span><span class="p">,</span>
<span class="s2">&quot;nextFundingRate&quot;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">&quot;nextFundingTimestamp&quot;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">&quot;nextFundingDatetime&quot;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">&quot;previousFundingRate&quot;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">&quot;previousFundingTimestamp&quot;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">&quot;previousFundingDatetime&quot;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">&quot;interval&quot;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="p">}</span>
</code></pre></div>
<p>Therefore, using <code>funding_rate['fundingRate']</code> as demonstrated above will use the current funding rate.
Actually available data will vary between exchanges, so this code may not work as expected across exchanges.</p>
<div class="admonition warning">
<p class="admonition-title">Warning about backtesting</p>
<p>Current funding-rate is not part of the historic data which means backtesting and hyperopt will not work correctly if this method is used, as the method will return up-to-date values.
We recommend to use the historically available funding rate for backtesting (which is automatically downloaded, and is at the frequency of what the exchange provides, usually 4h or 8h).
<code>self.dp.get_pair_dataframe(pair=metadata['pair'], timeframe='8h', candle_type="funding_rate")</code></p>
</div>
<h3 id="send-notification">Send Notification<a class="headerlink" href="#send-notification" title="Permanent link">&para;</a></h3>
<p>The dataprovider <code>.send_msg()</code> function allows you to send custom notifications from your strategy.
Identical notifications will only be sent once per candle, unless the 2<sup>nd</sup> argument (<code>always_send</code>) is set to True.</p>