mirror of
https://github.com/freqtrade/freqtrade.git
synced 2025-12-02 18:13:04 +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]
@@ -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>
|
||||
|
||||
Reference in New Issue
Block a user