docs: rephrase categories docs and add performance warning

This commit is contained in:
Matthias
2024-09-26 20:07:41 +02:00
parent 6837196e44
commit 7b93b55b78

View File

@@ -368,9 +368,13 @@ The optional `bearer_token` will be included in the requests Authorization Heade
`number_assets` defines the maximum number of pairs returned by the pairlist. `max_rank` will determine the maximum rank used in creating/filtering the pairlist. It's expected that some coins within the top `max_rank` marketcap will not be included in the resulting pairlist since not all pairs will have active trading pairs in your preferred market/stake/exchange combination.
`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).
The `refresh_period` setting defines the interval (in seconds) at which the marketcap rank data will be refreshed. The default is 86,400 seconds (1 day). The pairlist cache (`refresh_period`) applies to both generating pairlists (when in the first position in the list) and filtering instances (when not in 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.
The `categories` setting specifies the [coingecko categories](https://www.coingecko.com/en/categories) from which to select coins from. The default is an empty list `[]`, meaning no category filtering is applied.
If an incorrect category string is chosen, the plugin will print the available categories from CoinGecko and fail. The category should be the ID of the category, for example, for `https://www.coingecko.com/en/categories/layer-1`, the category ID would be `layer-1`. You can pass multiple categories such as `["layer-1", "meme-token"]` to select from several categories.
!!! Warning "Many categories"
Each added category corresponds to one API call to CoinGecko. The more categories you add, the longer the pairlist generation will take, potentially causing rate limit issues.
#### AgeFilter