cryptodatapy 0.2.5__py3-none-any.whl → 0.2.7__py3-none-any.whl

cryptodatapy/extract/data_vendors/cryptocompare_api.py

@@ -84,8 +84,9 @@ class CryptoCompare(DataVendor):
         if categories is None:
             self.categories = ['crypto']
         if api_key is None:
-            raise TypeError("Set your api key. We recommend setting your api key in environment variables as"
-                            "'CRYPTOCOMPARE_API_KEY', will allow DataCredentials to automatically load it.")
+            raise TypeError("Set your CryptoCompare api key in environment variables as 'CRYPTOCOMPARE_API_KEY' or "
+                            "add it as an argument when instantiating the class. To get an api key, visit: "
+                            "https://min-api.cryptocompare.com/")
         if exchanges is None:
             self.exchanges = self.get_exchanges_info(as_list=True)
         if indexes is None:
@@ -467,9 +468,6 @@ class CryptoCompare(DataVendor):
         urls_params = self.set_urls_params(data_req, data_type, ticker)
         url, params = urls_params['url'], urls_params['params']
 
-        # # data req
-        # data_resp = DataRequest().get_req(url=url, params=params)
-
         # data req
         data_resp = DataRequest().get_req(url=url, params=params)
 

cryptodatapy/extract/data_vendors/datavendor.py

@@ -92,7 +92,7 @@ class DataVendor(ABC):
 
     @exchanges.setter
     def exchanges(
-        self, exchanges: Optional[Union[str, List[str], Dict[str, List[str]]]]
+        self, exchanges: Optional[Union[str, List[str], Dict[str, List[str]], pd.DataFrame]]
     ):
         """
         Sets a list of available exchanges for the data vendor.
@@ -101,6 +101,7 @@ class DataVendor(ABC):
             exchanges is None
             or isinstance(exchanges, list)
             or isinstance(exchanges, dict)
+            or isinstance(exchanges, pd.DataFrame)
         ):
             self._exchanges = exchanges
         elif isinstance(exchanges, str):
@@ -126,11 +127,16 @@ class DataVendor(ABC):
         return self._indexes
 
     @indexes.setter
-    def indexes(self, indexes: Optional[Union[str, List[str], Dict[str, List[str]]]]):
+    def indexes(self, indexes: Optional[Union[str, List[str], Dict[str, List[str]], pd.DataFrame]]):
         """
         Sets a list of available indexes for the data vendor.
         """
-        if indexes is None or isinstance(indexes, list) or isinstance(indexes, dict):
+        if (
+            indexes is None
+            or isinstance(indexes, list)
+            or isinstance(indexes, dict)
+            or isinstance(indexes, pd.DataFrame)
+        ):
             self._indexes = indexes
         elif isinstance(indexes, str):
             self._indexes = [indexes]
@@ -155,11 +161,16 @@ class DataVendor(ABC):
         return self._assets
 
     @assets.setter
-    def assets(self, assets: Optional[Union[str, List[str], Dict[str, List[str]]]]):
+    def assets(self, assets: Optional[Union[str, List[str], Dict[str, List[str]], pd.DataFrame]]):
         """
         Sets a list of available assets for the data vendor.
         """
-        if assets is None or isinstance(assets, list) or isinstance(assets, dict):
+        if (
+            assets is None
+            or isinstance(assets, list)
+            or isinstance(assets, dict)
+            or isinstance(assets, pd.DataFrame)
+        ):
             self._assets = assets
         elif isinstance(assets, str):
             self._assets = [assets]
@@ -184,11 +195,16 @@ class DataVendor(ABC):
         return self._markets
 
     @markets.setter
-    def markets(self, markets: Optional[Union[str, List[str], Dict[str, List[str]]]]):
+    def markets(self, markets: Optional[Union[str, List[str], Dict[str, List[str]], pd.DataFrame]]):
         """
         Sets a list of available markets for the data vendor.
         """
-        if markets is None or isinstance(markets, list) or isinstance(markets, dict):
+        if (
+            markets is None
+            or isinstance(markets, list)
+            or isinstance(markets, dict)
+            or isinstance(markets, pd.DataFrame)
+        ):
             self._markets = markets
         elif isinstance(markets, str):
             self._markets = [markets]
@@ -251,11 +267,16 @@ class DataVendor(ABC):
         return self._fields
 
     @fields.setter
-    def fields(self, fields: Optional[Union[str, List[str], Dict[str, List[str]]]]):
+    def fields(self, fields: Optional[Union[str, List[str], Dict[str, List[str]], pd.DataFrame]]):
         """
         Sets a list of available fields for the data vendor.
         """
-        if fields is None or isinstance(fields, list) or isinstance(fields, dict):
+        if (
+            fields is None
+            or isinstance(fields, list)
+            or isinstance(fields, dict)
+            or isinstance(fields, pd.DataFrame)
+        ):
             self._fields = fields
         elif isinstance(fields, str):
             self._fields = [fields]
@@ -280,9 +301,7 @@ class DataVendor(ABC):
         return self._frequencies
 
     @frequencies.setter
-    def frequencies(
-        self, frequencies: Optional[Union[str, List[str], Dict[str, List[str]]]]
-    ):
+    def frequencies(self, frequencies: Optional[Union[str, List[str], Dict[str, List[str]], pd.DataFrame]]):
         """
         Sets a list of available data frequencies for the data vendor.
         """
@@ -290,6 +309,7 @@ class DataVendor(ABC):
             frequencies is None
             or isinstance(frequencies, list)
             or isinstance(frequencies, dict)
+            or isinstance(frequencies, pd.DataFrame)
         ):
             self._frequencies = frequencies
         elif isinstance(frequencies, str):

cryptodatapy/extract/data_vendors/glassnode_api.py

@@ -79,8 +79,9 @@ class Glassnode(DataVendor):
         if categories is None:
             self.categories = ['crypto']
         if api_key is None:
-            raise TypeError("Set your api key. We recommend setting your api key in environment variables as"
-                            "'GLASSNODE_API_KEY', will allow DataCredentials to automatically load it.")
+            raise TypeError("Set your Glassnode api key in environment variables as 'GLASSNODE_API_KEY' or "
+                            "add it as an argument when instantiating the class. To get an api key, visit: "
+                            "https://docs.glassnode.com/basic-api/api-key")
         if assets is None:
             self.assets = self.get_assets_info(as_list=True)
         if fields is None:

cryptodatapy/extract/data_vendors/tiingo_api.py

@@ -109,8 +109,9 @@ class Tiingo(DataVendor):
         if categories is None:
             self.categories = ["crypto", "fx", "eqty"]
         if api_key is None:
-            raise TypeError("Set your api key. We recommend setting your api key in environment variables as"
-                            "'TIINGO_API_KEY', will allow DataCredentials to automatically load it.")
+            raise TypeError("Set your Tiingo api key in environment variables as 'TIINGO_API_KEY' or "
+                            "add it as an argument when instantiating the class. To get an api key, visit: "
+                            "https://www.tiingo.com/")
         if exchanges is None:
             self.exchanges = self.get_exchanges_info()
         if assets is None:

cryptodatapy/extract/datarequest.py

@@ -17,8 +17,9 @@ class DataRequest:
         self,
         source: str = "ccxt",
         tickers: Union[str, List[str]] = "btc",
-        freq: str = "d",
         quote_ccy: Optional[str] = None,
+        markets: Optional[Union[str, List[str]]] = None,
+        freq: str = "d",
         exch: Optional[str] = None,
         mkt_type: Optional[str] = "spot",
         start_date: Optional[Union[str, datetime, pd.Timestamp]] = None,
@@ -30,8 +31,11 @@ class DataRequest:
         trials: Optional[int] = 3,
         pause: Optional[float] = 0.1,
         source_tickers: Optional[Union[str, List[str]]] = None,
+        source_markets: Optional[Union[str, List[str]]] = None,
         source_freq: Optional[str] = None,
-        source_fields: Optional[Union[str, List[str]]] = None,
+        source_start_date: Optional[Union[str, int, datetime, pd.Timestamp]] = None,
+        source_end_date: Optional[Union[str, int, datetime, pd.Timestamp]] = None,
+        source_fields: Optional[Union[str, List[str]]] = None
     ):
         """
         Constructor
@@ -41,12 +45,14 @@ class DataRequest:
         source: str, default 'ccxt'
             Name of data source.
         tickers: list or str, default 'btc'
-            Ticker symbols for assets or time series.
-            e.g. 'BTC', 'EURUSD', 'SPY', 'US_Manuf_PMI', 'EZ_Rates_10Y', etc.
+            Ticker symbols for base assets.
+            e.g. 'BTC', 'EUR', 'SPY', 'US_Manuf_PMI', 'EZ_Rates_10Y', etc.
+        quote_ccy: str,  optional, default None
+            Ticker symbol for quote asset, e.g. 'USDT' for BTCUSDT (bitcoin in Tether USD), 'GBP' for EURGBP, etc.
+        markets: list or str, optional, default None
+            Markets/traded pairs of base assets vs quote assets, e.g. 'BTC/USDT', 'EUR/USD', 'SPY/USD', etc.
         freq: str, default 'd'
             Frequency of data observations. Defaults to daily 'd' which includes weekends for cryptoassets.
-        quote_ccy: str,  optional, default None
-            Quote currency for base asset, e.g. 'GBP' for EURGBP, 'USD' for BTCUSD (bitcoin in dollars), etc.
         exch: str,  optional, default None
             Name of asset exchange, e.g. 'Binance', 'FTX', 'IEX', 'Nasdaq', etc.
         mkt_type: str, optional, default 'spot'
@@ -72,18 +78,26 @@ class DataRequest:
         source_tickers: list or str, optional, default None
             List or string of ticker symbols for assets or time series in the format used by the
             data source. If None, tickers will be converted from CryptoDataPy to data source format.
+        source_markets: list or str, optional, default None
+            List or string of markets/traded pairs of base assets vs quote assets in the format used by the
+            data source. If None, markets will be converted from CryptoDataPy to data source format.
         source_freq: str, optional, default None
             Frequency of observations for assets or time series in format used by data source. If None,
             frequency will be converted from CryptoDataPy to data source format.
+        source_start_date: str, int, datetime or pd.Timestamp, optional, default None
+            Start date for data request in format used by data source.
+        source_end_date: str, int, datetime or pd.Timestamp, optional, default None
+            End date for data request in format used by data source.
         source_fields: list or str, optional, default None
             List or string of fields for assets or time series in format used by data source. If None,
             fields will be converted from CryptoDataPy to data source format.
         """
         # params
-        self.source = source  # specific data source
+        self.source = source  # name of data source
         self.tickers = tickers  # tickers
-        self.freq = freq  # frequency
         self.quote_ccy = quote_ccy  # quote ccy
+        self.markets = markets  # markets
+        self.freq = freq  # frequency
         self.exch = exch  # exchange
         self.mkt_type = mkt_type  # market type
         self.start_date = start_date  # start date
@@ -95,7 +109,10 @@ class DataRequest:
         self.trials = trials  # number of times to try query request
         self.pause = pause  # number of seconds to pause between query request trials
         self.source_tickers = source_tickers  # tickers used by data source
+        self.source_markets = source_markets
         self.source_freq = source_freq  # frequency used by data source
+        self.source_start_date = source_start_date  # start date used by data source
+        self.source_end_date = source_end_date  # end date used by data source
         self.source_fields = source_fields  # fields used by data source
 
     @property
@@ -151,6 +168,46 @@ class DataRequest:
         else:
             raise TypeError("Tickers must be a string or list of strings (tickers).")
 
+    @property
+    def quote_ccy(self):
+        """
+        Returns quote currency for data request.
+        """
+        return self._quote_ccy
+
+    @quote_ccy.setter
+    def quote_ccy(self, quote):
+        """
+        Sets quote currency for data request.
+        """
+        if quote is None:
+            self._quote_ccy = quote
+        elif isinstance(quote, str):
+            self._quote_ccy = quote
+        else:
+            raise TypeError("Quote currency must be a string.")
+
+    @property
+    def markets(self):
+        """
+        Returns markets for data request.
+        """
+        return self._markets
+
+    @markets.setter
+    def markets(self, markets):
+        """
+        Sets markets for data request.
+        """
+        if markets is None:
+            self._markets = markets
+        elif isinstance(markets, str):
+            self._markets = [markets]
+        elif isinstance(markets, list):
+            self._markets = markets
+        else:
+            raise TypeError("Markets must be a string or list of strings (markets).")
+
     @property
     def freq(self):
         """
@@ -197,32 +254,15 @@ class DataRequest:
             "y": "yearly",
         }
 
-        if frequency not in list(freq_dict.keys()):
+        if frequency is None:
+            self._frequency = frequency
+        elif frequency not in list(freq_dict.keys()):
             raise ValueError(
                 f"{frequency} is an invalid data frequency. Valid frequencies are: {freq_dict}"
             )
         else:
             self._frequency = frequency
 
-    @property
-    def quote_ccy(self):
-        """
-        Returns quote currency for data request.
-        """
-        return self._quote_ccy
-
-    @quote_ccy.setter
-    def quote_ccy(self, quote):
-        """
-        Sets quote currency for data request.
-        """
-        if quote is None:
-            self._quote_ccy = quote
-        elif isinstance(quote, str):
-            self._quote_ccy = quote
-        else:
-            raise TypeError("Quote currency must be a string.")
-
     @property
     def exch(self):
         """
@@ -484,6 +524,29 @@ class DataRequest:
                 "Source tickers must be a string or list of strings (tickers) in data source's format."
             )
 
+    @property
+    def source_markets(self):
+        """
+        Returns markets for data request in data source format.
+        """
+        return self._source_markets
+
+    @source_markets.setter
+    def source_markets(self, markets):
+        """
+        Sets markets for data request in data source format.
+        """
+        if markets is None:
+            self._source_markets = markets
+        elif isinstance(markets, str):
+            self._source_markets = [markets]
+        elif isinstance(markets, list):
+            self._source_markets = markets
+        else:
+            raise TypeError(
+                "Source markets must be a string or list of strings (markets) in data source's format."
+            )
+
     @property
     def source_freq(self):
         """
@@ -505,6 +568,60 @@ class DataRequest:
                 "Source data frequency must be a string in data source's format."
             )
 
+    @property
+    def source_start_date(self):
+        """
+        Returns start date for data request in data source format.
+        """
+        return self._source_start_date
+
+    @source_start_date.setter
+    def source_start_date(self, start_date):
+        """
+        Sets start date for data request in data source format.
+        """
+        if start_date is None:
+            self._source_start_date = start_date
+        elif isinstance(start_date, str):
+            self._source_start_date = start_date
+        elif isinstance(start_date, int):
+            self._source_start_date = start_date
+        elif isinstance(start_date, datetime):
+            self._source_start_date = start_date
+        elif isinstance(start_date, pd.Timestamp):
+            self._source_start_date = start_date
+        else:
+            raise ValueError(
+                'Start date must be in "YYYY-MM-DD" string, integer, datetime or pd.Timestamp format.'
+            )
+
+    @property
+    def source_end_date(self):
+        """
+        Returns end date for data request in data source format.
+        """
+        return self._source_end_date
+
+    @source_end_date.setter
+    def source_end_date(self, end_date):
+        """
+        Sets end date for data request in data source format.
+        """
+        if end_date is None:
+            self._source_end_date = end_date
+        elif isinstance(end_date, str):
+            self._source_end_date = end_date
+        elif isinstance(end_date, int):
+            self._source_end_date = end_date
+        elif isinstance(end_date, datetime):
+            self._source_end_date = end_date
+        elif isinstance(end_date, pd.Timestamp):
+            self._source_end_date = end_date
+        else:
+            raise ValueError(
+                'End date must be in "YYYY-MM-DD" string, integer, datetime or pd.Timestamp format.'
+            )
+
     @property
     def source_fields(self):
         """
@@ -555,15 +672,59 @@ class DataRequest:
             # get request
             try:
                 resp = requests.get(url, params=params, headers=headers)
-                assert resp.status_code == 200
-            # exception
-            except AssertionError as e:
-                logging.warning(e)
+                # check for status code
+                resp.raise_for_status()
+
+                return resp.json()
+
+            # handle HTTP errors
+            except requests.exceptions.HTTPError as http_err:
+                status_code = resp.status_code
+
+                # Tailored handling for different status codes
+                if status_code == 400:
+                    logging.warning(f"Bad Request (400): {resp.text}")
+                elif status_code == 401:
+                    logging.warning("Unauthorized (401): Check the authentication credentials.")
+                elif status_code == 403:
+                    logging.warning("Forbidden (403): You do not have permission to access this resource.")
+                elif status_code == 404:
+                    logging.warning("Not Found (404): The requested resource could not be found.")
+                elif status_code == 500:
+                    logging.error("Internal Server Error (500): The server encountered an error.")
+                elif status_code == 503:
+                    logging.error("Service Unavailable (503): The server is temporarily unavailable.")
+                else:
+                    logging.error(f"HTTP error occurred: {http_err} (Status Code: {status_code})")
+                    logging.error(f"Response Content: {resp.text}")
+
+                # Increment attempts and log warning
+                attempts += 1
+                logging.warning(f"Attempt #{attempts}: Failed to get data due to: {http_err}")
+                sleep(self.pause)  # Pause before retrying
+                if attempts == self.trials:
+                    logging.error("Max attempts reached. Unable to fetch data.")
+                    break
+
+            # handle non-HTTP exceptions (e.g., network issues)
+            except requests.exceptions.RequestException as req_err:
                 attempts += 1
-                logging.warning(f"Failed to get data on attempt #{attempts}.")
+                logging.warning(f"Request error on attempt #{attempts}: {req_err}. "
+                                f"Retrying after {self.pause} seconds...")
                 sleep(self.pause)
-                if attempts == 3:
+                if attempts == self.trials:
+                    logging.error("Max attempts reached. Unable to fetch data due to request errors.")
                     break
 
-            else:
-                return resp.json()
+            # handle other exceptions
+            except Exception as e:
+                attempts += 1
+                logging.warning(f"An unexpected error occurred: {e}. "
+                                f"Retrying after {self.pause} seconds...")
+                sleep(self.pause)
+                if attempts == self.trials:
+                    logging.error("Max attempts reached. Unable to fetch data due to request errors.")
+                    break
+
+        # return None if the API call fails
+        return None

cryptodatapy/extract/libraries/Untitled.ipynb

@@ -0,0 +1,33 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "89bd834b-aec0-45fe-82a0-c5d873c9518a",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "cryptodatapy",
+   "language": "python",
+   "name": "cryptodatapy"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.12"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}