cryptodatapy 0.2.0__py3-none-any.whl → 0.2.2__py3-none-any.whl

cryptodatapy/extract/data_vendors/.ipynb_checkpoints/glassnode_api_test-checkpoint.ipynb

@@ -1,504 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "code",
-   "execution_count": 14,
-   "id": "e3a0c158",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from typing import Optional, Any, Union, Dict\n",
-    "\n",
-    "import pandas as pd\n",
-    "\n",
-    "from cryptodatapy.extract.data_vendors.datavendor import DataVendor\n",
-    "from cryptodatapy.extract.datarequest import DataRequest\n",
-    "from cryptodatapy.transform.convertparams import ConvertParams\n",
-    "from cryptodatapy.transform.wrangle import WrangleData, WrangleInfo\n",
-    "from cryptodatapy.util.datacredentials import DataCredentials\n",
-    "\n",
-    "\n",
-    "# data credentials\n",
-    "data_cred = DataCredentials()\n",
-    "\n",
-    "# url endpoints\n",
-    "urls = {'assets_info': 'assets', 'fields_info': 'endpoints'}\n",
-    "\n",
-    "\n",
-    "class Glassnode(DataVendor):\n",
-    "    \"\"\"\n",
-    "    Retrieves data from Glassnode API.\n",
-    "    \"\"\"\n",
-    "\n",
-    "    def __init__(\n",
-    "            self,\n",
-    "            categories=None,\n",
-    "            exchanges: Optional[list[str]] = None,\n",
-    "            indexes: Optional[list[str]] = None,\n",
-    "            assets: Optional[list[str]] = None,\n",
-    "            markets: Optional[list[str]] = None,\n",
-    "            market_types=None,\n",
-    "            fields: Optional[list[str]] = None,\n",
-    "            frequencies=None,\n",
-    "            base_url: str = data_cred.glassnode_base_url,\n",
-    "            api_key: str = data_cred.glassnode_api_key,\n",
-    "            max_obs_per_call: Optional[int] = None,\n",
-    "            rate_limit: Optional[Any] = None\n",
-    "    ):\n",
-    "        \"\"\"\n",
-    "        Constructor\n",
-    "\n",
-    "        Parameters\n",
-    "        ----------\n",
-    "        categories: list or str, {'crypto', 'fx', 'rates', 'eqty', 'commodities', 'credit', 'macro', 'alt'}\n",
-    "            List or string of available categories, e.g. ['crypto', 'fx', 'alt'].\n",
-    "        exchanges: list, optional, default None\n",
-    "            List of available exchanges, e.g. ['Binance', 'Coinbase', 'Kraken', 'FTX', ...].\n",
-    "        indexes: list, optional, default None\n",
-    "            List of available indexes, e.g. ['mvda', 'bvin'].\n",
-    "        assets: list, optional, default None\n",
-    "            List of available assets, e.g. ['btc', 'eth'].\n",
-    "        markets: list, optional, default None\n",
-    "            List of available markets as asset/quote currency pairs, e.g. ['btcusdt', 'ethbtc'].\n",
-    "        market_types: list\n",
-    "            List of available market types, e.g. [spot', 'perpetual_future', 'future', 'option'].\n",
-    "        fields: list, optional, default None\n",
-    "            List of available fields, e.g. ['open', 'high', 'low', 'close', 'volume'].\n",
-    "        frequencies: list\n",
-    "            List of available frequencies, e.g. ['tick', '1min', '5min', '10min', '20min', '30min', '1h', '2h', '4h',\n",
-    "            '8h', 'd', 'w', 'm']\n",
-    "        base_url: str\n",
-    "            Base url used for GET requests. If not provided, default is set to base_url stored in DataCredentials.\n",
-    "        api_key: str\n",
-    "            Api key, e.g. 'dcf13983adf7dfa79a0dfa35adf'. If not provided, default is set to\n",
-    "            api_key stored in DataCredentials.\n",
-    "        max_obs_per_call: int, optional, default None\n",
-    "            Maximum number of observations returned per API call. If not provided, default is set to\n",
-    "            api_limit stored in DataCredentials.\n",
-    "        rate_limit: Any, optional, Default None\n",
-    "            Number of API calls made and left, by time frequency.\n",
-    "        \"\"\"\n",
-    "        DataVendor.__init__(self, categories, exchanges, indexes, assets, markets, market_types, fields,\n",
-    "                            frequencies, base_url, api_key, max_obs_per_call, rate_limit)\n",
-    "\n",
-    "        if frequencies is None:\n",
-    "            self.frequencies = ['10min', '15min', '30min', '1h', '2h', '4h', '8h', 'd', 'w', 'm', 'q', 'y']\n",
-    "        if market_types is None:\n",
-    "            self.market_types = ['spot', 'perpetual_future', 'future', 'option']\n",
-    "        if categories is None:\n",
-    "            self.categories = ['crypto']\n",
-    "        if api_key is None:\n",
-    "            raise TypeError(\"Set your api key. We recommend setting your api key in environment variables as\"\n",
-    "                            \"'GLASSNODE_API_KEY', will allow DataCredentials to automatically load it.\")\n",
-    "#         if assets is None:\n",
-    "#             self.assets = self.get_assets_info(as_list=True)\n",
-    "#         if fields is None:\n",
-    "#             self.fields = self.get_fields_info(data_type=None, as_list=True)\n",
-    "\n",
-    "    def get_exchanges_info(self) -> None:\n",
-    "        \"\"\"\n",
-    "        Gets exchanges info.\n",
-    "        \"\"\"\n",
-    "        return None\n",
-    "\n",
-    "    def get_indexes_info(self) -> None:\n",
-    "        \"\"\"\n",
-    "        Gets indexes info.\n",
-    "        \"\"\"\n",
-    "        return None\n",
-    "\n",
-    "    def req_assets(self) -> Dict[str, Any]:\n",
-    "        \"\"\"\n",
-    "        Get request for assets info.\n",
-    "\n",
-    "        Returns\n",
-    "        -------\n",
-    "        dict: dictionary\n",
-    "            Data response with asset info in json format.\n",
-    "        \"\"\"\n",
-    "        return DataRequest().get_req(url=self.base_url + urls['assets_info'], params={'api_key': self.api_key})\n",
-    "\n",
-    "    def get_assets_info(self, as_list: bool = False) -> Union[list[str], pd.DataFrame]:\n",
-    "        \"\"\"\n",
-    "        Get assets info.\n",
-    "\n",
-    "        Parameters\n",
-    "        ----------\n",
-    "        as_list: bool, default False\n",
-    "            Returns assets info as list.\n",
-    "\n",
-    "        Returns\n",
-    "        -------\n",
-    "        assets: list or pd.DataFrame\n",
-    "            List or dataframe with info on available assets.\n",
-    "        \"\"\"\n",
-    "        # data req\n",
-    "        data_resp = self.req_assets()\n",
-    "        # wrangle data resp\n",
-    "        assets = WrangleInfo(data_resp).gn_assets_info(as_list=as_list)\n",
-    "\n",
-    "        return assets\n",
-    "\n",
-    "    def get_markets_info(self) -> None:\n",
-    "        \"\"\"\n",
-    "        Get markets info.\n",
-    "        \"\"\"\n",
-    "        return None\n",
-    "\n",
-    "    def req_fields(self) -> Dict[str, Any]:\n",
-    "        \"\"\"\n",
-    "        Get request for fields info.\n",
-    "\n",
-    "        Returns\n",
-    "        -------\n",
-    "        dict: dictionary\n",
-    "            Data response with fields info in json format.\n",
-    "        \"\"\"\n",
-    "        return DataRequest().get_req(url=self.base_url.replace('v1', 'v2') + urls['fields_info'],\n",
-    "                                     params={'api_key': self.api_key})\n",
-    "\n",
-    "    def get_fields_info(self, data_type: Optional[str] = None, as_list: bool = False) -> Union[list[str], pd.DataFrame]:\n",
-    "        \"\"\"\n",
-    "        Get fields info.\n",
-    "\n",
-    "        Parameters\n",
-    "        ----------\n",
-    "        data_type: str, {'market', 'on-chain', 'off-chain'}, default None\n",
-    "            Type of data.\n",
-    "        as_list: bool, default False\n",
-    "            Returns available fields info as list.\n",
-    "\n",
-    "        Returns\n",
-    "        -------\n",
-    "        fields: list or pd.DataFrame\n",
-    "            List or dataframe with info on available fields.\n",
-    "        \"\"\"\n",
-    "        # data req\n",
-    "        data_resp = self.req_fields()\n",
-    "        # wrangle data resp\n",
-    "        fields = WrangleInfo(data_resp).gn_fields_info(data_type=data_type, as_list=as_list)\n",
-    "\n",
-    "        return fields\n",
-    "\n",
-    "    def get_rate_limit_info(self) -> None:\n",
-    "        \"\"\"\n",
-    "        Get rate limit info.\n",
-    "        \"\"\"\n",
-    "        return None\n",
-    "\n",
-    "    def req_data(self, data_req: DataRequest, ticker: str, field: str) -> Dict[str, Any]:\n",
-    "        \"\"\"\n",
-    "        Submits data request to API.\n",
-    "\n",
-    "        Parameters\n",
-    "        ----------\n",
-    "        data_req: DataRequest\n",
-    "            Data request parameters in CryptoDataPy format.\n",
-    "        ticker: str\n",
-    "            Requested ticker symbol.\n",
-    "        field: str\n",
-    "            Requested field.\n",
-    "\n",
-    "        Returns\n",
-    "        -------\n",
-    "        data_resp: dict\n",
-    "            Data response in json format.\n",
-    "        \"\"\"\n",
-    "        # convert data request parameters to CryptoCompare format\n",
-    "        gn_data_req = ConvertParams(data_req).to_glassnode()\n",
-    "\n",
-    "        # set url, params\n",
-    "        url = self.base_url + field\n",
-    "        params = {\n",
-    "            'api_key': self.api_key,\n",
-    "            'a': ticker,\n",
-    "            's': gn_data_req['start_date'],\n",
-    "            'u': gn_data_req['end_date'],\n",
-    "            'i': gn_data_req['freq'],\n",
-    "            'c': gn_data_req['quote_ccy']\n",
-    "        }\n",
-    "        # data req\n",
-    "        data_resp = DataRequest().get_req(url=url, params=params)\n",
-    "\n",
-    "        return data_resp\n",
-    "\n",
-    "    @staticmethod\n",
-    "    def wrangle_data_resp(data_req: DataRequest, data_resp: Dict[str, Any], field: str) -> pd.DataFrame:\n",
-    "        \"\"\"\n",
-    "        Wrangle data response into tidy data format.\n",
-    "\n",
-    "        Parameters\n",
-    "        ----------\n",
-    "        data_req: DataRequest\n",
-    "            Data request parameters in CryptoDataPy format.\n",
-    "        data_resp: dictionary\n",
-    "            Data response in JSON format.\n",
-    "        field: str\n",
-    "            Requested field.\n",
-    "\n",
-    "        Returns\n",
-    "        -------\n",
-    "        df: pd.DataFrame\n",
-    "            Wrangled dataframe with DatetimeIndex and selected field values (cols), in tidy format.\n",
-    "        \"\"\"\n",
-    "        # wrangle data resp\n",
-    "        if data_resp is None or len(data_resp) == 0:\n",
-    "            df = None\n",
-    "        else:\n",
-    "            df = WrangleData(data_req, data_resp).glassnode(field)\n",
-    "\n",
-    "        return df\n",
-    "\n",
-    "    def get_tidy_data(self, data_req: DataRequest, ticker: str, field: str) -> pd.DataFrame:\n",
-    "        \"\"\"\n",
-    "        Submits data request and wrangles the data response into tidy data format.\n",
-    "\n",
-    "        Parameters\n",
-    "        ----------\n",
-    "        data_req: DataRequest\n",
-    "            Data request parameters in CryptoDataPy format.\n",
-    "        ticker: str\n",
-    "            Requested ticker symbol.\n",
-    "        field: str\n",
-    "            Requested field.\n",
-    "\n",
-    "        Returns\n",
-    "        -------\n",
-    "        df: pd.DataFrame\n",
-    "            Dataframe with DatetimeIndex and field values (col) wrangled into tidy data format.\n",
-    "        \"\"\"\n",
-    "        # get entire data history\n",
-    "        df = self.req_data(data_req, ticker=ticker, field=field)\n",
-    "        # wrangle df\n",
-    "        df = self.wrangle_data_resp(data_req, df, field)\n",
-    "\n",
-    "        return df\n",
-    "\n",
-    "    def get_all_fields(self, data_req: DataRequest, ticker: str) -> pd.DataFrame:\n",
-    "        \"\"\"\n",
-    "        Loops list of tickers, retrieves data in tidy format for each ticker and stores it in a dataframe.\n",
-    "\n",
-    "        Parameters\n",
-    "        ----------\n",
-    "        data_req: DataRequest\n",
-    "            Data request parameters in CryptoDataPy format.\n",
-    "        ticker: str\n",
-    "            Requested ticker symbol.\n",
-    "\n",
-    "        Returns\n",
-    "        -------\n",
-    "        df: pd.DataFrame\n",
-    "            Dataframe with DatetimeIndex and values for fields (cols), in tidy data format.\n",
-    "        \"\"\"\n",
-    "        # convert data request parameters to CryptoCompare format\n",
-    "        gn_data_req = ConvertParams(data_req).to_glassnode()\n",
-    "\n",
-    "        df = pd.DataFrame()  # empty fields df\n",
-    "        counter = 0  # ohlc counter to avoid requesting OHLC data multiples times\n",
-    "\n",
-    "        for field in gn_data_req['fields']:  # loop through fields\n",
-    "\n",
-    "            df0 = None\n",
-    "\n",
-    "            # get tidy data\n",
-    "            if field == 'market/price_usd_ohlc' and counter == 0:\n",
-    "                df0 = self.get_tidy_data(data_req, ticker, field)\n",
-    "                counter += 1\n",
-    "            elif field != 'market/price_usd_ohlc':\n",
-    "                df0 = self.get_tidy_data(data_req, ticker, field)\n",
-    "\n",
-    "            # add field to fields df\n",
-    "            if df0 is not None:\n",
-    "                df = pd.concat([df, df0], axis=1)\n",
-    "\n",
-    "        return df\n",
-    "\n",
-    "    def check_params(self, data_req: DataRequest) -> None:\n",
-    "        \"\"\"\n",
-    "        Check data request parameters before calling API to improve efficiency.\n",
-    "\n",
-    "        Parameters\n",
-    "        ----------\n",
-    "        data_req: DataRequest\n",
-    "            Data request parameters in CryptoDataPy format.\n",
-    "        \"\"\"\n",
-    "        # convert data request parameters to CryptoCompare format\n",
-    "        gn_data_req = ConvertParams(data_req).to_glassnode()\n",
-    "\n",
-    "        # check tickers\n",
-    "        if not all([ticker.upper() in self.assets for ticker in gn_data_req['tickers']]):\n",
-    "            raise ValueError(f\"Some of the selected assets are not available.\"\n",
-    "                             \" See assets attribute for a list of available assets.\")\n",
-    "\n",
-    "        # check fields\n",
-    "        if not all([field in self.fields for field in gn_data_req['fields']]):\n",
-    "            raise ValueError(f\"Some of the selected fields are not available.\"\n",
-    "                             \" See fields attribute for a list of available fields.\")\n",
-    "\n",
-    "        # check freq\n",
-    "        if data_req.freq not in self.frequencies:\n",
-    "            raise ValueError(f\"On-chain data is only available for {self.frequencies} frequencies.\"\n",
-    "                             f\" Change data request frequency and try again.\")\n",
-    "\n",
-    "        return None\n",
-    "\n",
-    "    def get_data(self, data_req: DataRequest) -> pd.DataFrame:\n",
-    "        \"\"\"\n",
-    "        Get market, on-chain or off-chain data.\n",
-    "\n",
-    "        Parameters\n",
-    "        ----------\n",
-    "        data_req: DataRequest\n",
-    "            Data request parameters in CryptoDataPy format.\n",
-    "\n",
-    "        Returns\n",
-    "        -------\n",
-    "        df: pd.DataFrame - MultiIndex\n",
-    "            DataFrame with DatetimeIndex (level 0), ticker (level 1), and values for market, on-chain and/or\n",
-    "            off-chain fields (cols), in tidy data format.\n",
-    "        \"\"\"\n",
-    "        # convert data request parameters to CryptoCompare format\n",
-    "        gn_data_req = ConvertParams(data_req).to_glassnode()\n",
-    "\n",
-    "        # check params\n",
-    "        self.check_params(data_req)\n",
-    "\n",
-    "        # empty df to add data\n",
-    "        df = pd.DataFrame()\n",
-    "\n",
-    "        # loop through tickers and fields\n",
-    "        for ticker in gn_data_req['tickers']:  # loop tickers\n",
-    "\n",
-    "            # get all fields for ticker\n",
-    "            df0 = self.get_all_fields(data_req, ticker)\n",
-    "            # add ticker to index\n",
-    "            df0['ticker'] = ticker.upper()\n",
-    "            df0.set_index(['ticker'], append=True, inplace=True)\n",
-    "            # stack ticker dfs\n",
-    "            df = pd.concat([df, df0])\n",
-    "\n",
-    "        # filter df for desired fields and typecast\n",
-    "        fields = [field for field in data_req.fields if field in df.columns]\n",
-    "        df = df.loc[:, fields]\n",
-    "\n",
-    "        return df.sort_index()\n"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 15,
-   "id": "ed941370",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "gn = Glassnode()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 16,
-   "id": "f999fa1b",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "dr = DataRequest()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 17,
-   "id": "f9ae10a2",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "url = gn.base_url + 'assets'"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 18,
-   "id": "6baff740",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'https://api.glassnode.com/v1/metrics/assets'"
-      ]
-     },
-     "execution_count": 18,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "url"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 19,
-   "id": "b3617fe0",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import json\n",
-    "import requests\n",
-    "import pandas as pd\n",
-    "\n",
-    "\n",
-    "# insert your API key here\n",
-    "API_KEY = gn.api_key\n",
-    "\n",
-    "# make API request\n",
-    "res = requests.get('https://api.glassnode.com/v1/metrics/indicators/sopr',\n",
-    "    params={'a': 'BTC', 'api_key': API_KEY})\n",
-    "\n",
-    "# # convert to pandas dataframe\n",
-    "# df = pd.read_json(res.text, convert_dates=['t'])"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 20,
-   "id": "efd5044c",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "<Response [403]>"
-      ]
-     },
-     "execution_count": 20,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "requests.get(url, params={'api_key': API_KEY})"
-   ]
-  }
- ],
- "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
-}

cryptodatapy/extract/data_vendors/.pytest_cache/.gitignore

@@ -1,2 +0,0 @@
-# Created by pytest automatically.
-*

cryptodatapy/extract/data_vendors/.pytest_cache/CACHEDIR.TAG

@@ -1,4 +0,0 @@
-Signature: 8a477f597d28d172789f06886806bc55
-# This file is a cache directory tag created by pytest.
-# For information about cache directory tags, see:
-#	https://bford.info/cachedir/spec.html

cryptodatapy/extract/data_vendors/.pytest_cache/README.md

@@ -1,8 +0,0 @@
-# pytest cache directory #
-
-This directory contains data from the pytest's cache plugin,
-which provides the `--lf` and `--ff` options, as well as the `cache` fixture.
-
-**Do not** commit this to version control.
-
-See [the docs](https://docs.pytest.org/en/stable/how-to/cache.html) for more information.

cryptodatapy/extract/data_vendors/.pytest_cache/v/cache/nodeids

@@ -1 +0,0 @@
-[]

cryptodatapy/extract/data_vendors/.pytest_cache/v/cache/stepwise

@@ -1 +0,0 @@
-[]

cryptodatapy/extract/web/.ipynb_checkpoints/Untitled-checkpoint.ipynb

@@ -1,6 +0,0 @@
-{
- "cells": [],
- "metadata": {},
- "nbformat": 4,
- "nbformat_minor": 5
-}