From 2df80fc49a2b8f320a5881fbae75dc4b75077f31 Mon Sep 17 00:00:00 2001
From: Matthias <xmatthias@outlook.com>
Date: Wed, 19 Apr 2023 18:35:52 +0200
Subject: [PATCH] Add /pairlists endpoint to api

---
 freqtrade/rpc/api_server/api_schemas.py |  4 ++++
 freqtrade/rpc/api_server/api_v1.py      | 26 +++++++++++++++++++------
 tests/rpc/test_rpc_apiserver.py         | 16 +++++++++++++++
 3 files changed, 40 insertions(+), 6 deletions(-)

diff --git a/freqtrade/rpc/api_server/api_schemas.py b/freqtrade/rpc/api_server/api_schemas.py
index 53bf7558f..64d32b15f 100644
--- a/freqtrade/rpc/api_server/api_schemas.py
+++ b/freqtrade/rpc/api_server/api_schemas.py
@@ -389,6 +389,10 @@ class StrategyListResponse(BaseModel):
     strategies: List[str]
 
 
+class PairListResponse(BaseModel):
+    pairlists: List[Dict[str, Any]]
+
+
 class FreqAIModelListResponse(BaseModel):
     freqaimodels: List[str]
 
diff --git a/freqtrade/rpc/api_server/api_v1.py b/freqtrade/rpc/api_server/api_v1.py
index 8aa706e62..7a3a5ca84 100644
--- a/freqtrade/rpc/api_server/api_v1.py
+++ b/freqtrade/rpc/api_server/api_v1.py
@@ -15,11 +15,11 @@ from freqtrade.rpc.api_server.api_schemas import (AvailablePairs, Balances, Blac
                                                   DeleteLockRequest, DeleteTrade, ForceEnterPayload,
                                                   ForceEnterResponse, ForceExitPayload,
                                                   FreqAIModelListResponse, Health, Locks, Logs,
-                                                  OpenTradeSchema, PairHistory, PerformanceEntry,
-                                                  Ping, PlotConfig, Profit, ResultMsg, ShowConfig,
-                                                  Stats, StatusMsg, StrategyListResponse,
-                                                  StrategyResponse, SysInfo, Version,
-                                                  WhitelistResponse)
+                                                  OpenTradeSchema, PairHistory, PairListResponse,
+                                                  PerformanceEntry, Ping, PlotConfig, Profit,
+                                                  ResultMsg, ShowConfig, Stats, StatusMsg,
+                                                  StrategyListResponse, StrategyResponse, SysInfo,
+                                                  Version, WhitelistResponse)
 from freqtrade.rpc.api_server.deps import get_config, get_exchange, get_rpc, get_rpc_optional
 from freqtrade.rpc.rpc import RPCException
 
@@ -43,7 +43,8 @@ logger = logging.getLogger(__name__)
 # 2.23: Allow plot config request in webserver mode
 # 2.24: Add cancel_open_order endpoint
 # 2.25: Add several profit values to /status endpoint
-API_VERSION = 2.25
+# 2.26: new /pairlists endpoint
+API_VERSION = 2.26
 
 # Public API, requires no auth.
 router_public = APIRouter()
@@ -300,6 +301,19 @@ def get_strategy(strategy: str, config=Depends(get_config)):
     }
 
 
+@router.get('/pairlists', response_model=PairListResponse)
+def list_pairlists(config=Depends(get_config)):
+    from freqtrade.resolvers import PairListResolver
+    pairlists = PairListResolver.search_all_objects(
+        config, False)
+    pairlists = sorted(pairlists, key=lambda x: x['name'])
+
+    return {'pairlists': [{
+        "name": x['name'],
+         } for x in pairlists
+        ]}
+
+
 @router.get('/freqaimodels', response_model=FreqAIModelListResponse, tags=['freqai'])
 def list_freqaimodels(config=Depends(get_config)):
     from freqtrade.resolvers.freqaimodel_resolver import FreqaiModelResolver
diff --git a/tests/rpc/test_rpc_apiserver.py b/tests/rpc/test_rpc_apiserver.py
index 58c904838..d5a375f19 100644
--- a/tests/rpc/test_rpc_apiserver.py
+++ b/tests/rpc/test_rpc_apiserver.py
@@ -1580,6 +1580,22 @@ def test_api_freqaimodels(botclient, tmpdir, mocker):
     ]}
 
 
+def test_api_pairlists(botclient, tmpdir, mocker):
+    ftbot, client = botclient
+    ftbot.config['user_data_dir'] = Path(tmpdir)
+
+    rc = client_get(client, f"{BASE_URI}/pairlists")
+
+    assert_response(rc)
+    response = rc.json()
+    assert isinstance(response['pairlists'], list)
+    assert len(response['pairlists']) > 0
+
+    assert len([r for r in response['pairlists'] if r['name'] == 'AgeFilter']) == 1
+    assert len([r for r in response['pairlists'] if r['name'] == 'VolumePairList']) == 1
+    assert len([r for r in response['pairlists'] if r['name'] == 'StaticPairList']) == 1
+
+
 def test_list_available_pairs(botclient):
     ftbot, client = botclient