Merge pull request #130 from JoeSchr/master

Add TrailingSL as an example for using ATR or any other indicator inside of custom_stoploss
2021-03-05 19:20:45 +01:00
parent 1afb9860a6 edf77a1869
commit fd5fecd1e2
1 changed files with 96 additions and 0 deletions
@@ -0,0 +1,96 @@
+# pragma pylint: disable=missing-docstring, invalid-name, pointless-string-statement
+# isort: skip_file
+# --- Do not remove these libs ---
+import numpy as np  # noqa
+import pandas as pd  # noqa
+from pandas import DataFrame
+
+from freqtrade.strategy.interface import IStrategy
+
+# --------------------------------
+# Add your lib to import here
+import talib.abstract as ta
+import freqtrade.vendor.qtpylib.indicators as qtpylib
+from datetime import datetime
+from freqtrade.persistence import Trade
+from freqtrade.state import RunMode
+
+class CustomStoplossWithPSAR(IStrategy):
+    """
+    this is an example class, implementing a PSAR based trailing stop loss
+    you are supposed to take the `custom_stoploss()` and `populate_indicators()`
+    parts and adapt it to your own strategy
+
+    the populate_buy_trend() function is pretty nonsencial
+    """
+
+    custom_info = {}
+    use_custom_stoploss = True
+
+    def custom_stoploss(self, pair: str, trade: 'Trade', current_time: datetime,
+                        current_rate: float, current_profit: float, **kwargs) -> float:
+
+        result = 1
+        if self.custom_info and pair in self.custom_info and trade:
+            # using current_time directly (like below) will only work in backtesting/hyperopt.
+            # in live / dry-run, it'll be really the current time
+            relative_sl = None
+            if self.dp:
+                # backtesting/hyperopt
+                if self.dp.runmode.value in ('backtest', 'hyperopt'):
+                    relative_sl = self.custom_info[pair].loc[current_time]['sar']
+                # for live, dry-run, storing the dataframe is not really necessary,
+                # it's available from get_analyzed_dataframe()
+                else:
+                    # so we need to get analyzed_dataframe from dp
+                    dataframe, last_updated = self.dp.get_analyzed_dataframe(pair=pair,
+                                                                             timeframe=self.timeframe)
+                    # only use .iat[-1] in live mode, otherwise you will look into the future
+                    # see: https://www.freqtrade.io/en/latest/strategy-customization/#common-mistakes-when-developing-strategies
+                    relative_sl = dataframe['sar'].iat[-1]
+
+            if (relative_sl is not None):
+                # print("custom_stoploss().relative_sl: {}".format(relative_sl))
+                # calculate new_stoploss relative to current_rate
+                new_stoploss = (current_rate-relative_sl)/current_rate
+                # turn into relative negative offset required by `custom_stoploss` return implementation
+                result = new_stoploss - 1
+
+        # print("custom_stoploss() -> {}".format(result))
+        return result
+
+    def populate_indicators(self, dataframe: DataFrame, metadata: dict) -> DataFrame:
+        dataframe['sar'] = ta.SAR(dataframe)
+        if self.dp.runmode.value in ('backtest', 'hyperopt'):
+            self.custom_info[metadata['pair']] = dataframe[['date', 'sar']].copy().set_index('date')
+
+        # all "normal" indicators:
+        # e.g.
+        # dataframe['rsi'] = ta.RSI(dataframe)
+        return dataframe
+
+    def populate_buy_trend(self, dataframe: DataFrame, metadata: dict) -> DataFrame:
+        """
+        Placeholder Strategy: buys when SAR is smaller then candle before
+        Based on TA indicators, populates the buy signal for the given dataframe
+        :param dataframe: DataFrame
+        :return: DataFrame with buy column
+        """
+        dataframe.loc[
+            (
+                (dataframe['sar'] < dataframe['sar'].shift())
+            ),
+            'buy'] = 1
+
+        return dataframe
+
+    def populate_sell_trend(self, dataframe: DataFrame, metadata: dict) -> DataFrame:
+        """
+        Placeholder Strategy: does nothing
+        Based on TA indicators, populates the sell signal for the given dataframe
+        :param dataframe: DataFrame
+        :return: DataFrame with buy column
+        """
+        # Deactivated sell signal to allow the strategy to work correctly
+        dataframe.loc[:, 'sell'] = 0
+        return dataframe