cryptodatapy.transform.wrangle ============================== .. py:module:: cryptodatapy.transform.wrangle Classes ------- .. autoapisummary:: cryptodatapy.transform.wrangle.WrangleInfo cryptodatapy.transform.wrangle.WrangleData Module Contents --------------- .. py:class:: WrangleInfo(data_resp: Union[Dict[str, Any], pandas.DataFrame]) Wrangles metadata data responses from various APIs into dataframe or list. .. py:attribute:: data_resp .. py:method:: cc_exch_info(as_list: bool = False) -> Union[pandas.DataFrame, list] Converts exchanges info to dataframe or list. :param as_list: Returns info as list. :type as_list: bool, default False :returns: **exch** -- Exchanges info converted to dataframe or list. :rtype: pd.DataFrame or list .. py:method:: cc_indexes_info(as_list: bool = False) -> Union[pandas.DataFrame, list] Converts indexes info to dataframe or list. :param as_list: Returns info as list. :type as_list: bool, default False :returns: **indexes** -- Indexes info converted to dataframe or list. :rtype: pd.DataFrame or list .. py:method:: cc_assets_info(as_list: bool = False) -> Union[pandas.DataFrame, list] Converts assets info into dataframe or list. :param as_list: Returns info as list. :type as_list: bool, default False :returns: **assets** -- Assets info converted to dataframe or list. :rtype: pd.DataFrame or list .. py:method:: cc_mkts_info(as_list: bool = False) -> Union[Dict, List] Converts markets info to dictionary or list. :param as_list: Returns info as list. :type as_list: bool, default False :returns: **mkts** -- Markets info converted to dictionary or list. :rtype: dictionary or list .. py:method:: cc_onchain_tickers_info(as_list: bool = False) -> Union[pandas.DataFrame, List] Converts on-chain tickers info to dataframe or list. :param as_list: Returns info as list. :type as_list: bool, default False :returns: **tickers** -- On-chain tickers info converted to dataframe or list. :rtype: pd.DataFrame or list .. py:method:: cc_onchain_info() -> List[str] Converts on-chain fields info to list. :returns: **onchain** -- On-chain fields info converted to list. :rtype: list .. py:method:: cc_social_info() -> List[str] Converts social stats info to list. :returns: **social** -- Social stats fields info converted to list. :rtype: list .. py:method:: cc_rate_limit_info() -> pandas.DataFrame Converts rate limit info to dataframe. :returns: **rate_limit** -- Rate limit info converted to dataframe. :rtype: pd.DataFrame .. py:method:: cc_news() -> pandas.DataFrame Converts news feed to dataframe. :returns: **news** -- News feed converted to dataframe. :rtype: pd.DataFrame .. py:method:: cc_news_sources() -> pandas.DataFrame Converts news sources to dataframe. :returns: **news_sources** -- News sources converted to dataframe. :rtype: pd.DataFrame .. py:method:: cc_top_mkt_cap_info() -> List[str] Converts top market cap coins info to list. :returns: **top_mkt_cap** -- Top market cap coins list. :rtype: pd.DataFrame .. py:method:: cm_meta_resp(as_list: bool = False, index_name: Optional[str] = None) -> Union[pandas.DataFrame, List[str]] Converts CoinMetrics client metadata response to dataframe or list. :param as_list: Returns metadata as list. :type as_list: bool, default False :param index_name: Name to give index col. :type index_name: str, optional, default None :returns: **meta** -- Metadata converted to dataframe or list. :rtype: pd.DataFrame or list .. py:method:: cm_inst_info(as_dict: bool = False) -> Union[Dict[str, List[str]], pandas.DataFrame] Converts CoinMetrics client institutions metadata response to dataframe or list. :param as_dict: Returns metadata as dictionary. :type as_dict: bool, default False :returns: **meta** -- Metadata converted to dataframe or dictionary. :rtype: pd.DataFrame or dict .. py:method:: ip_idx_info(cat: Optional[str] = None, as_dict: bool = False) -> Union[Dict[str, List[str]], pandas.DataFrame] Wrangle InvestPy indexes info. :param cat: Asset class. :type cat: str, {'eqty', 'cmdty', 'rates'}, optional, default None :param as_dict: Returns available indexes as dictionary, with cat-indexes key-values pairs. :type as_dict: bool, default False :returns: **indexes** -- Dictionary or dataframe with info on available indexes, by category. :rtype: dictionary or pd.DataFrame .. py:method:: ip_meta_resp(data_type: str, as_list: bool = False) -> Union[List[str], pandas.DataFrame] Wrangle InvestPy fx info. :param data_type: Type of data response to wrangle. :type data_type: str :param as_list: Returns available indexes as list. :type as_list: bool, default False :returns: **fx** -- List or dataframe with fx info. :rtype: list or pd.DataFrame .. py:method:: gn_assets_info(as_list: bool = False) -> Union[pandas.DataFrame, list] Converts assets info into dataframe or list. :param as_list: Returns info as list. :type as_list: bool, default False :returns: **assets** -- Assets info converted to dataframe or list. :rtype: pd.DataFrame or list .. py:method:: gn_fields_info(data_type: Optional[str] = None, as_list: bool = False) -> Union[List[str], pandas.DataFrame] Converts fields info into dataframe or list. :param data_type: Type of data. :type data_type: str, {'market', 'on-chain', 'off-chain'}, default None :param as_list: Returns available fields info as list. :type as_list: bool, default False :returns: **fields** -- List or dataframe with info on available fields. :rtype: list or pd.DataFrame .. py:class:: WrangleData(data_req: cryptodatapy.extract.datarequest.DataRequest, data_resp: Union[Dict[str, pandas.DataFrame], pandas.DataFrame]) Wrangles time series data responses from various APIs into tidy data format. .. py:attribute:: data_req .. py:attribute:: data_resp .. py:attribute:: tidy_data .. py:method:: cryptocompare() -> pandas.DataFrame Wrangles CryptoCompare data response to dataframe with tidy data format. :returns: Wrangled dataframe into tidy data format. :rtype: pd.DataFrame .. py:method:: coinmetrics() -> pandas.DataFrame Wrangles CoinMetrics data response to dataframe with tidy data format. :returns: Wrangled dataframe into tidy data format. :rtype: pd.DataFrame .. py:method:: glassnode(field: str) -> pandas.DataFrame Wrangles Glassnode data response to dataframe with tidy data format. :param field: Name of requested field. :type field: str :returns: Wrangled dataframe into tidy data format. :rtype: pd.DataFrame .. py:method:: tiingo(data_type: str) -> pandas.DataFrame Wrangles Tiingo data response to dataframe with tidy data format. :param data_type: Data type to wrangle. :type data_type: str, {'eqty', 'iex', 'crypto', 'fx'} :returns: Wrangled dataframe into tidy data format. :rtype: pd.DataFrame .. py:method:: polygon() -> pandas.DataFrame Wrangles Polygon data response to dataframe with tidy data format. :returns: Wrangled dataframe into tidy data format. :rtype: pd.DataFrame .. py:method:: investpy() -> pandas.DataFrame Wrangles InvestPy data response to dataframe with tidy data format. :returns: Wrangled dataframe into tidy data format. :rtype: pd.DataFrame .. py:method:: dbnomics() -> pandas.DataFrame Wrangles DBnomics data response to dataframe with tidy data format. :returns: Wrangled dataframe into tidy data format. :rtype: pd.DataFrame .. py:method:: ccxt_ohlcv() -> pandas.DataFrame Wrangles CCXT OHLCV data response to dataframe with tidy data format. :returns: Dataframe with tidy data format. :rtype: pd.DataFrame .. py:method:: ccxt_funding_rates() -> pandas.DataFrame Wrangles CCXT funding rates data response to dataframe with tidy data format. :returns: Dataframe with tidy data format. :rtype: pd.DataFrame .. py:method:: ccxt_open_interest() -> pandas.DataFrame Wrangles CCXT open interest data response to dataframe with tidy data format. :returns: Dataframe with tidy data format. :rtype: pd.DataFrame .. py:method:: ccxt(data_type: str) -> pandas.DataFrame Wrangles CCXT data response to dataframe with tidy data format. :returns: Wrangled dataframe into tidy data format. :rtype: pd.DataFrame .. py:method:: fred() -> pandas.DataFrame Wrangles Fred data response to dataframe with tidy data format. :returns: Wrangled dataframe into tidy data format. :rtype: pd.DataFrame .. py:method:: yahoo() -> pandas.DataFrame Wrangles Yahoo data response to dataframe with tidy data format. :returns: Wrangled dataframe into tidy data format. :rtype: pd.DataFrame .. py:method:: alphavantage() -> pandas.DataFrame Wrangles Alpha Vantage data response to dataframe with tidy data format. :returns: Wrangled dataframe into tidy data format. :rtype: pd.DataFrame .. py:method:: famafrench() -> pandas.DataFrame Wrangles Fama-French data response to dataframe with tidy data format. :returns: Wrangled dataframe into tidy data format. :rtype: pd.DataFrame .. py:method:: wb() -> pandas.DataFrame Wrangles World Bank data response to dataframe with tidy data format. :returns: Wrangled dataframe into tidy data format. :rtype: pd.DataFrame .. py:method:: aqr() -> pandas.DataFrame Wrangles AQR data file to dataframe with tidy data format. :returns: Wrangled dataframe into tidy data format. :rtype: pd.DataFrame .. py:method:: convert_fields_to_lib(data_source: str) -> WrangleData Convert cols/fields from data source data resp to CryptoDataPy format. :param data_source: Name of data source. :type data_source: str :returns: WrangleData object with data_resp fields converted to CryptoDataPy format. :rtype: WrangleData .. py:method:: filter_dates() -> WrangleData Filter start and end dates to those in data request. :param self: WrangleData object with filtered dates. :type self: WrangleData :returns: WrangleData object with data_resp dates filtered. :rtype: WrangleData