Skip to content

Commit 4f216eb

Browse files
authored
Merge pull request freqtrade#11790 from freqtrade/docs/compare_exit_callbacks
docs: add "exit logic comparisons" table
2 parents f3d7f67 + 0c13414 commit 4f216eb

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
## Exit logic comparisons
2+
3+
Freqtrade allows your strategy to implement different exit logic using signal-based or callback-based functions.
4+
This section aims to compare each different function, helping you to choose the one that best fits your needs.
5+
6+
* **`populate_exit_trend()`** - Vectorized signal-based exit logic using indicators in the main dataframe
7+
**Use** to define exit signals based on indicators or other data that can be calculated in a vectorized manner.
8+
🚫 **Don't use** to customize exit conditions for each individual trade, or if trade data is necessary to make an exit decision.
9+
* **`custom_exit()`** - Custom exit logic that will fully exit a trade immediately, called for every open trade at every bot loop iteration until a trade is closed.
10+
**Use** to specify exit conditions for each individual trade (including any additional adjusted orders using `adjust_trade_position()`), or if trade data is necessary to make an exit decision, e.g. using profit data to exit.
11+
🚫 **Don't use** when you want to exit using vectorised indicator-based data (use a `populate_exit_trend()` signal instead), or as a proxy for `custom_stoploss()`, and be aware that rate-based exits in backtesting can be inaccurate.
12+
* **`custom_stoploss()`** - Custom trailing stoploss, called for every open trade every iteration until a trade is closed. The value returned here is also used for [stoploss on exchange](stoploss.md#stop-loss-on-exchangefreqtrade).
13+
**Use** to customize the stoploss logic to set a dynamic stoploss based on trade data or other conditions.
14+
🚫 **Don't use** to exit a trade immediately based on a specific condition. Use `custom_exit()` for that purpose.
15+
* **`custom_roi()`** - Custom ROI, called for every open trade every iteration until a trade is closed.
16+
**Use** to specify a minimum ROI threshold ("take-profit") to exit a trade at this ROI level at some point within the trade duration, based on profit or other conditions.
17+
🚫 **Don't use** to exit a trade immediately based on a specific condition. Use `custom_exit()`.
18+
🚫 **Don't use** for static ROI. Use `minimal_roi`.

docs/strategy-callbacks.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ Currently available callbacks:
2727

2828
--8<-- "includes/strategy-imports.md"
2929

30+
--8<-- "includes/strategy-exit-comparisons.md"
31+
32+
3033
## Bot start
3134

3235
A simple callback which is called once when the strategy is loaded.

0 commit comments

Comments
 (0)