cryptodatapy.extract.libraries.dbnomics_api
===========================================

.. py:module:: cryptodatapy.extract.libraries.dbnomics_api


Attributes
----------

.. autoapisummary::

   cryptodatapy.extract.libraries.dbnomics_api.data_cred


Classes
-------

.. autoapisummary::

   cryptodatapy.extract.libraries.dbnomics_api.DBnomics


Module Contents
---------------

.. py:data:: data_cred

.. py:class:: DBnomics(categories=None, exchanges: Optional[List[str]] = None, indexes: Optional[List[str]] = None, assets: Optional[List[str]] = None, markets: Optional[List[str]] = None, market_types: Optional[List[str]] = None, fields: Optional[Dict[str, List[str]]] = None, frequencies=None, base_url: Optional[str] = None, api_key: Optional[str] = None, max_obs_per_call: Optional[int] = None, rate_limit: Optional[str] = None)

   Bases: :py:obj:`cryptodatapy.extract.libraries.library.Library`


   Retrieves data from DBnomics API.


   .. py:method:: get_vendors_info()
      :staticmethod:


      Gets available vendors info.



   .. py:method:: get_assets_info() -> None

      Gets available assets info.



   .. py:method:: get_indexes_info() -> None

      Gets available indexes info.



   .. py:method:: get_markets_info() -> None

      Gets market pairs info.



   .. py:method:: get_fields_info(cat: Optional[str] = None) -> Dict[str, List[str]]

      Gets fields info.

      :param cat: Asset class or time series category.
      :type cat: str, {'crypto', 'eqty', 'fx', 'rates', 'cmdty', 'macro', 'alt'}, default None

      :returns: **fields** -- Dictionary with info on available fields, by category.
      :rtype: dictionary



   .. py:method:: get_exchanges_info() -> None

      Gets exchanges info.



   .. py:method:: get_rate_limit_info() -> None

      Gets rate limit info.



   .. py:method:: get_series(ticker: str) -> pandas.DataFrame
      :staticmethod:


      Gets series from DBnomics python client.

      :param ticker: Ticker symbol/identifier of time series.
      :type ticker: str

      :returns: **df** -- Dataframe with DatetimeIndex and actual values (col) for requested series.
      :rtype: pd.DataFrame



   .. py:method:: wrangle_data_resp(data_req: cryptodatapy.extract.datarequest.DataRequest, data_resp: pandas.DataFrame) -> pandas.DataFrame
      :staticmethod:


      Wrangle data response.

      :param data_req: Parameters of data request in CryptoDataPy format.
      :type data_req: DataRequest
      :param data_resp: Data response from client.
      :type data_resp: pd.DataFrame

      :returns: **df** -- Wrangled dataframe with DatetimeIndex (level 0), ticker (level 1), and values for macro time series
                for selected fields (cols), in tidy format.
      :rtype: pd.DataFrame



   .. py:method:: get_tidy_data(data_req: cryptodatapy.extract.datarequest.DataRequest, ticker: str) -> pandas.DataFrame

      Submits data request to Python client and wrangles the data response into tidy data format.

      :param data_req: Data request parameters in CryptoDataPy format.
      :type data_req: DataRequest
      :param ticker: Tickery symbol/identifier for time series.
      :type ticker: str

      :returns: **df** -- Dataframe with DatetimeIndex and field values (col) wrangled into tidy data format.
      :rtype: pd.DataFrame



   .. py:method:: check_params(data_req: cryptodatapy.extract.datarequest.DataRequest) -> None

      Checks the parameters of the data request before requesting data to reduce API calls
      and improve efficiency.




   .. py:method:: get_data(data_req: cryptodatapy.extract.datarequest.DataRequest) -> pandas.DataFrame

      Get data macro data.

      :param data_req: Parameters of data request in CryptoDataPy format.
      :type data_req: DataRequest

      :returns: **df** -- DataFrame with DatetimeIndex (level 0), ticker (level 1) and values macro or off-chain fields (cols).
      :rtype: pd.DataFrame - MultiIndex