From b00ca5470741166f74a03642af5c720fa8c9617e Mon Sep 17 00:00:00 2001 From: "Jakub Werner (jakubikan)" Date: Wed, 25 Sep 2024 21:20:35 +0200 Subject: [PATCH] adding docu --- docs/includes/pairlists.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/includes/pairlists.md b/docs/includes/pairlists.md index 804190e24..fe6a11bc1 100644 --- a/docs/includes/pairlists.md +++ b/docs/includes/pairlists.md @@ -360,7 +360,8 @@ The optional `bearer_token` will be included in the requests Authorization Heade "method": "MarketCapPairList", "number_assets": 20, "max_rank": 50, - "refresh_period": 86400 + "refresh_period": 86400, + "categories": ['layer-1'] } ] ``` @@ -369,6 +370,8 @@ The optional `bearer_token` will be included in the requests Authorization Heade `refresh_period` setting defines the period (in seconds) at which the marketcap rank data will be refreshed. Defaults to 86,400s (1 day). The pairlist cache (`refresh_period`) is applicable on both generating pairlists (first position in the list) and filtering instances (not the first position in the list). +`categories` settings this defines takes the list of coins from a category on coingecko. (https://www.coingecko.com/en/categories). Defaults to []. If you choose a wrong category string the Plugin will print the categories you that you can choose from on coingecko. Category is the id of the category so e.g. https://www.coingecko.com/en/categories/layer-1 -> `layer-1` would be the category. You can pass in a list `["layer-1", "meme-token"]` is possible if you choose to. + #### AgeFilter Removes pairs that have been listed on the exchange for less than `min_days_listed` days (defaults to `10`) or more than `max_days_listed` days (defaults `None` mean infinity).