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

cryptodatapy/conf/fields.csv

@@ -27,7 +27,7 @@ vwap,volume-weighted avg price,average volume-weighted price of quote asset with
 dividend,dividend,dividend paid out on ex-ante date,market,ohlc_bars,d ,quote currency units,Float64,,,,,,divCash,,,,,,
 split,split,"factor used to adjust prices when a company splits, reverse splits, or pays a distribution",market,ohlc_bars,d ,factor ,Float64,,,,,,splitFactor,,,,,,
 ref_rate_usd,reference rate in USD,price of asset in USD using an aggregation methodology,market,ohlc_bars,d ,quote currency units,Float64,,ReferenceRateUSD,,,,,,,,,,
-oi,open interest,number of outstanding futures contracts that are open and have yet to be settled,market,derivatives,"1min, 5min, 10min, 15min, 30min, 1h, 2h, 4h, 8h, d, w, m, q",number of contracts,Float64,,contract_count,,,,,,,,,,
+oi,open interest,number of outstanding futures contracts that are open and have yet to be settled,market,derivatives,"1min, 5min, 10min, 15min, 30min, 1h, 2h, 4h, 8h, d, w, m, q",number of contracts,Float64,,contract_count,openInterestAmount,,,,,,,,,
 funding_rate,funding rate,interest rate for holding derivative contract within time interval,market,derivatives,"1h, 2h, 4h, 8h, d, w, m, q",interest rate over time interval,Float64,,rate,fundingRate,derivatives/futures_funding_rate_perpetual,,,,,,,,
 mkt_cap,market capitalization,usd value of circulating supply,market,market capitalization,"d, w, m, q",usd,Float64,,CapMrktCurUSD,,market/marketcap_usd,,,,,,,,
 mkt_cap_real,"market capitalization, reaized","The sum USD value based on the USD closing price on the day that a native unit last moved (i.e., last transacted) for all native units",market,market capitalization,"d, w, m, q",usd,Float64,,CapRealUSD,,,,,,,,,,

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):
         """
@@ -206,25 +263,6 @@ class DataRequest:
         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):
         """
@@ -486,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):
         """
@@ -507,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):
         """

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
+}