cryptodatapy.extract.libraries.dbnomics_api

Attributes

data_cred

Classes

DBnomics

Retrieves data from DBnomics API.

Module Contents

cryptodatapy.extract.libraries.dbnomics_api.data_cred

class cryptodatapy.extract.libraries.dbnomics_api.DBnomics(categories=None, exchanges: List[str] | None = None, indexes: List[str] | None = None, assets: List[str] | None = None, markets: List[str] | None = None, market_types: List[str] | None = None, fields: Dict[str, List[str]] | None = None, frequencies=None, base_url: str | None = None, api_key: str | None = None, max_obs_per_call: int | None = None, rate_limit: str | None = None)

Bases: cryptodatapy.extract.libraries.library.Library

Retrieves data from DBnomics API.

static get_vendors_info()

Gets available vendors info.

get_assets_info() → None

Gets available assets info.

get_indexes_info() → None

Gets available indexes info.

get_markets_info() → None

Gets market pairs info.

get_fields_info(cat: str | None = None) → Dict[str, List[str]]

Gets fields info.

Parameters:

cat (str, {'crypto', 'eqty', 'fx', 'rates', 'cmdty', 'macro', 'alt'}, default None) – Asset class or time series category.

Returns:

fields – Dictionary with info on available fields, by category.

Return type:

dictionary

get_exchanges_info() → None

Gets exchanges info.

get_rate_limit_info() → None

Gets rate limit info.

static get_series(ticker: str) → pandas.DataFrame

Gets series from DBnomics python client.

Parameters:

ticker (str) – Ticker symbol/identifier of time series.

Returns:

df – Dataframe with DatetimeIndex and actual values (col) for requested series.

Return type:

pd.DataFrame

static wrangle_data_resp(data_req: cryptodatapy.extract.datarequest.DataRequest, data_resp: pandas.DataFrame) → pandas.DataFrame

Wrangle data response.

Parameters:

• data_req (DataRequest) – Parameters of data request in CryptoDataPy format.

• data_resp (pd.DataFrame) – Data response from client.

Returns:

df – Wrangled dataframe with DatetimeIndex (level 0), ticker (level 1), and values for macro time series for selected fields (cols), in tidy format.

Return type:

pd.DataFrame

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.

Parameters:

• data_req (DataRequest) – Data request parameters in CryptoDataPy format.

• ticker (str) – Tickery symbol/identifier for time series.

Returns:

df – Dataframe with DatetimeIndex and field values (col) wrangled into tidy data format.

Return type:

pd.DataFrame

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.

get_data(data_req: cryptodatapy.extract.datarequest.DataRequest) → pandas.DataFrame

Get data macro data.

Parameters:

data_req (DataRequest) – Parameters of data request in CryptoDataPy format.

Returns:

df – DataFrame with DatetimeIndex (level 0), ticker (level 1) and values macro or off-chain fields (cols).

Return type:

pd.DataFrame - MultiIndex