stable/freqtrade/pairlist/VolumePairList.py

82 lines
3.0 KiB
Python
Raw Normal View History

2018-11-30 05:34:56 +00:00
"""
2019-03-02 16:24:28 +00:00
Volume PairList provider
2018-11-30 05:34:56 +00:00
Provides lists as configured in config.json
"""
import logging
from typing import List
2019-10-29 09:39:27 +00:00
from cachetools import TTLCache, cached
2018-11-30 05:34:56 +00:00
from freqtrade import OperationalException
2019-10-29 09:39:27 +00:00
from freqtrade.pairlist.IPairList import IPairList
2018-11-30 05:34:56 +00:00
logger = logging.getLogger(__name__)
2018-12-04 06:12:56 +00:00
SORT_VALUES = ['askVolume', 'bidVolume', 'quoteVolume']
2018-11-30 05:34:56 +00:00
2018-12-05 19:44:56 +00:00
class VolumePairList(IPairList):
2018-11-30 05:34:56 +00:00
def __init__(self, freqtrade, config: dict) -> None:
2018-12-05 19:44:56 +00:00
super().__init__(freqtrade, config)
2018-12-04 19:23:03 +00:00
self._whitelistconf = self._config.get('pairlist', {}).get('config')
if 'number_assets' not in self._whitelistconf:
raise OperationalException(
f'`number_assets` not specified. Please check your configuration '
'for "pairlist.config.number_assets"')
2018-12-03 19:31:25 +00:00
self._number_pairs = self._whitelistconf['number_assets']
2018-12-04 06:12:56 +00:00
self._sort_key = self._whitelistconf.get('sort_key', 'quoteVolume')
2019-10-28 15:21:00 +00:00
self._precision_filter = self._whitelistconf.get('precision_filter', True)
2018-12-04 06:12:56 +00:00
if not self._freqtrade.exchange.exchange_has('fetchTickers'):
raise OperationalException(
'Exchange does not support dynamic whitelist.'
'Please edit your config and restart the bot'
)
2018-12-05 18:48:50 +00:00
if not self._validate_keys(self._sort_key):
2018-12-04 06:12:56 +00:00
raise OperationalException(
f'key {self._sort_key} not in {SORT_VALUES}')
2018-11-30 05:34:56 +00:00
2018-12-05 18:48:50 +00:00
def _validate_keys(self, key):
2018-12-04 06:12:56 +00:00
return key in SORT_VALUES
2018-12-03 19:31:25 +00:00
def short_desc(self) -> str:
"""
Short whitelist method description - used for startup-messages
-> Please overwrite in subclasses
"""
return f"{self.name} - top {self._whitelistconf['number_assets']} volume pairs."
2018-11-30 05:34:56 +00:00
2018-12-05 19:44:56 +00:00
def refresh_pairlist(self) -> None:
2018-11-30 05:34:56 +00:00
"""
2018-12-05 19:44:56 +00:00
Refreshes pairlists and assigns them to self._whitelist and self._blacklist respectively
-> Please overwrite in subclasses
2018-11-30 05:34:56 +00:00
"""
# Generate dynamic whitelist
2019-03-02 16:24:28 +00:00
self._whitelist = self._gen_pair_whitelist(
2019-10-25 17:49:23 +00:00
self._config['stake_currency'], self._sort_key)
2018-11-30 05:34:56 +00:00
@cached(TTLCache(maxsize=1, ttl=1800))
2018-12-04 06:16:34 +00:00
def _gen_pair_whitelist(self, base_currency: str, key: str) -> List[str]:
"""
Updates the whitelist with with a dynamically generated list
:param base_currency: base currency as str
:param key: sort key (defaults to 'quoteVolume')
:return: List of pairs
"""
tickers = self._freqtrade.exchange.get_tickers()
# check length so that we make sure that '/' is actually in the string
tickers = [v for k, v in tickers.items()
2019-03-14 21:48:42 +00:00
if (len(k.split('/')) == 2 and k.split('/')[1] == base_currency
and v[key] is not None)]
sorted_tickers = sorted(tickers, reverse=True, key=lambda t: t[key])
2019-03-02 16:24:28 +00:00
# Validate whitelist to only have active market pairs
2019-10-30 14:59:52 +00:00
pairs = self.validate_whitelist([s['symbol'] for s in sorted_tickers], tickers)
logger.info(f"Searching {self._number_pairs} pairs: {pairs[:self._number_pairs]}")
return pairs