Add rudimentary description per pairlist

freqtrade/plugins/pairlist/AgeFilter.py

@@ -68,6 +68,10 @@ class AgeFilter(IPairList):
             f"{self._max_days_listed} {plural(self._max_days_listed, 'day')}"
         ) if self._max_days_listed else '')
 
+    @staticmethod
+    def description() -> str:
+        return "Filter pairs by age (days listed)."
+
     @staticmethod
     def available_parameters() -> Dict[str, PairlistParameter]:
         return {

freqtrade/plugins/pairlist/IPairList.py

@@ -89,6 +89,16 @@ class IPairList(LoggingMixin, ABC):
         If no Pairlist requires tickers, an empty Dict is passed
         as tickers argument to filter_pairlist
         """
+        return False
+
+    @staticmethod
+    @abstractmethod
+    def description() -> str:
+        """
+        Return description of this Pairlist Handler
+        -> Please overwrite in subclasses
+        """
+        return ""
 
     @staticmethod
     def available_parameters() -> Dict[str, PairlistParameter]:

freqtrade/plugins/pairlist/OffsetFilter.py

@@ -43,6 +43,10 @@ class OffsetFilter(IPairList):
             return f"{self.name} - Taking {self._number_pairs} Pairs, starting from {self._offset}."
         return f"{self.name} - Offsetting pairs by {self._offset}."
 
+    @staticmethod
+    def description() -> str:
+        return "Offset pair list filter."
+
     @staticmethod
     def available_parameters() -> Dict[str, PairlistParameter]:
         return {

freqtrade/plugins/pairlist/PerformanceFilter.py

@@ -40,6 +40,10 @@ class PerformanceFilter(IPairList):
         """
         return f"{self.name} - Sorting pairs by performance."
 
+    @staticmethod
+    def description() -> str:
+        return "Filter pairs by performance."
+
     @staticmethod
     def available_parameters() -> Dict[str, PairlistParameter]:
         return {

freqtrade/plugins/pairlist/PrecisionFilter.py

@@ -46,6 +46,10 @@ class PrecisionFilter(IPairList):
         """
         return f"{self.name} - Filtering untradable pairs."
 
+    @staticmethod
+    def description() -> str:
+        return "Filters low-value coins which would not allow setting stoplosses."
+
     def _validate_pair(self, pair: str, ticker: Optional[Ticker]) -> bool:
         """
         Check if pair has enough room to add a stoploss to avoid "unsellable" buys of very

freqtrade/plugins/pairlist/PriceFilter.py

@@ -65,6 +65,10 @@ class PriceFilter(IPairList):
 
         return f"{self.name} - No price filters configured."
 
+    @staticmethod
+    def description() -> str:
+        return "Filter pairs by price."
+
     @staticmethod
     def available_parameters() -> Dict[str, PairlistParameter]:
         return {

freqtrade/plugins/pairlist/ProducerPairList.py

@@ -57,6 +57,10 @@ class ProducerPairList(IPairList):
         """
         return f"{self.name} - {self._producer_name}"
 
+    @staticmethod
+    def description() -> str:
+        return "Get a pairlist from an upstream bot."
+
     @staticmethod
     def available_parameters() -> Dict[str, PairlistParameter]:
         return {

freqtrade/plugins/pairlist/RemotePairList.py

@@ -65,6 +65,10 @@ class RemotePairList(IPairList):
         """
         return f"{self.name} - {self._pairlistconfig['number_assets']} pairs from RemotePairlist."
 
+    @staticmethod
+    def description() -> str:
+        return "Retrieve pairs from a remote API."
+
     @staticmethod
     def available_parameters() -> Dict[str, PairlistParameter]:
         return {

freqtrade/plugins/pairlist/ShuffleFilter.py

@@ -55,6 +55,10 @@ class ShuffleFilter(IPairList):
         return (f"{self.name} - Shuffling pairs every {self._shuffle_freq}" +
                 (f", seed = {self._seed}." if self._seed is not None else "."))
 
+    @staticmethod
+    def description() -> str:
+        return "Randomize pairlist order."
+
     @staticmethod
     def available_parameters() -> Dict[str, PairlistParameter]:
         return {

freqtrade/plugins/pairlist/SpreadFilter.py

@@ -45,6 +45,10 @@ class SpreadFilter(IPairList):
         return (f"{self.name} - Filtering pairs with ask/bid diff above "
                 f"{self._max_spread_ratio:.2%}.")
 
+    @staticmethod
+    def description() -> str:
+        return "Filter by bid/ask difference."
+
     @staticmethod
     def available_parameters() -> Dict[str, PairlistParameter]:
         return {

freqtrade/plugins/pairlist/StaticPairList.py

@@ -42,6 +42,10 @@ class StaticPairList(IPairList):
         """
         return f"{self.name}"
 
+    @staticmethod
+    def description() -> str:
+        return "Use pairlist as configured in config."
+
     @staticmethod
     def available_parameters() -> Dict[str, PairlistParameter]:
         return {

freqtrade/plugins/pairlist/VolatilityFilter.py

@@ -64,6 +64,10 @@ class VolatilityFilter(IPairList):
                 f"{self._min_volatility}-{self._max_volatility} "
                 f" the last {self._days} {plural(self._days, 'day')}.")
 
+    @staticmethod
+    def description() -> str:
+        return "Filter pairs by their recent volatility."
+
     @staticmethod
     def available_parameters() -> Dict[str, PairlistParameter]:
         return {

freqtrade/plugins/pairlist/VolumePairList.py

@@ -114,6 +114,10 @@ class VolumePairList(IPairList):
         """
         return f"{self.name} - top {self._pairlistconfig['number_assets']} volume pairs."
 
+    @staticmethod
+    def description() -> str:
+        return "Provides dynamic pair list based on trade volumes."
+
     @staticmethod
     def available_parameters() -> Dict[str, PairlistParameter]:
         return {

freqtrade/plugins/pairlist/rangestabilityfilter.py

@@ -62,6 +62,10 @@ class RangeStabilityFilter(IPairList):
                 f"{self._min_rate_of_change}{max_rate_desc} over the "
                 f"last {plural(self._days, 'day')}.")
 
+    @staticmethod
+    def description() -> str:
+        return "Filters pairs by their rate of change."
+
     @staticmethod
     def available_parameters() -> Dict[str, PairlistParameter]:
         return {

freqtrade/rpc/api_server/api_schemas.py

@@ -404,6 +404,7 @@ class StrategyListResponse(BaseModel):
 
 class PairListResponse(BaseModel):
     name: str
+    description: str
     is_pairlist_generator: bool
     params: Dict[str, Any]
 
@@ -418,10 +419,6 @@ class PairListsPayload(BaseModel):
     stake_currency: str
 
 
-class PairListsTest(BaseModel):
-    pairlists: List[PairListResponse]
-
-
 class FreqAIModelListResponse(BaseModel):
     freqaimodels: List[str]
 

freqtrade/rpc/api_server/api_v1.py

@@ -328,6 +328,7 @@ def list_pairlists(config=Depends(get_config)):
         "name": x['name'],
         "is_pairlist_generator": x['class'].is_pairlist_generator,
         "params": x['class'].available_parameters(),
+        "description": x['class'].description(),
          } for x in pairlists
     ]}