From 442929505dca5fc0890244f8d2162a84ecaf30f8 Mon Sep 17 00:00:00 2001 From: Victor Ramirez Date: Fri, 12 Jul 2024 13:56:47 +0000 Subject: [PATCH] Fix CI/CD pipeline This MR fixes the CI/CD pipeline from generate_docs onward --- .gitlab-ci.yml | 1 + coinmetrics/__init__.py | 2 +- default.nix | 2 +- docs/docs/api_client.md | 156 ++++++++++++++--------------- docs/site/api_client.html | 156 ++++++++++++++--------------- docs/site/search/search_index.json | 2 +- docs/site/sitemap.xml.gz | Bin 127 -> 127 bytes poetry.lock | 25 ++++- pyproject.toml | 2 +- 9 files changed, 184 insertions(+), 162 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 1caa03c..d1e6807 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -80,6 +80,7 @@ generate-docs: - python -m pip install --upgrade regex pydoc-markdown - python -m pip install wheel dulwich pyrsistent - python -m pip install poetry jinja2==3.0.3 regex + - poetry lock --no-update - poetry install - apk add py3-dbus - apk add bash diff --git a/coinmetrics/__init__.py b/coinmetrics/__init__.py index a227d78..d2b2654 100644 --- a/coinmetrics/__init__.py +++ b/coinmetrics/__init__.py @@ -1 +1 @@ -__version__ = "2024.2.7.10" +__version__ = "2024.7.11.18" diff --git a/default.nix b/default.nix index 0a3bf18..870f085 100644 --- a/default.nix +++ b/default.nix @@ -20,7 +20,7 @@ buildPythonPackage rec { pname = "coinmetrics-api-client"; - version = "2024.2.7.10"; + version = "2024.7.11.18"; format = "pyproject"; disabled = pythonOlder "3.9"; diff --git a/docs/docs/api_client.md b/docs/docs/api_client.md index fd92969..dd3cc39 100644 --- a/docs/docs/api_client.md +++ b/docs/docs/api_client.md @@ -3124,8 +3124,8 @@ Returns asset alerts for the specified assets. - `alerts` (`list(str), str`): list of asset alert names - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. - `end_inclusive` (`bool`): Flag to define if end timestamp must be included in the timeseries if present. True by default. - `timezone` (`str`): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page. @@ -3162,8 +3162,8 @@ Returns Defi Balance Sheet records for specified DeFi protocols. - `defi_protocols` (`str, List[str]`): list of DeFi protocols like aave_v2_eth or protocol patterns like aave_v2_* or aave_*_eth or *_eth. - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_height` (`int`): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time - `end_height` (`int`): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. @@ -3197,8 +3197,8 @@ Returns the chains of blocks for the specified assets. - `assets` (`list(str), str`): list of asset names, e.g. 'btc' - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. - `end_inclusive` (`bool`): Flag to define if end timestamp must be included in the timeseries if present. True by default. - `timezone` (`str`): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page. @@ -3245,8 +3245,8 @@ Returns requested metrics for specified assets. - `frequency` (`str`): frequency of the returned timeseries, e.g 15s, 1d, etc. - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_height` (`int`): Start block of the timeseries (only applicable when querying with frequency 1b). - `end_height` (`int`): End block of the timeseries (only applicable when querying with frequency 1b). - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. @@ -3301,8 +3301,8 @@ Returns metrics for specified exchanges. - `frequency` (`str`): frequency of the returned timeseries, e.g 15s, 1d, etc. - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_height` (`int`): Start block of the timeseries (only applicable when querying with frequency 1b). - `end_height` (`int`): End block of the timeseries (only applicable when querying with frequency 1b). - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. @@ -3346,8 +3346,8 @@ Returns metrics for specified exchange-asset. - `frequency` (`str`): frequency of the returned timeseries, e.g 15s, 1d, etc. - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_height` (`int`): Start block of the timeseries (only applicable when querying with frequency 1b). - `end_height` (`int`): End block of the timeseries (only applicable when querying with frequency 1b). - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. @@ -3390,8 +3390,8 @@ Returns metrics books for specified asset-asset pairs. - `frequency` (`str`): frequency of the returned timeseries, e.g 15s, 1d, etc. - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_height` (`int`): Start block of the timeseries (only applicable when querying with frequency 1b). - `end_height` (`int`): End block of the timeseries (only applicable when querying with frequency 1b). - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. @@ -3433,8 +3433,8 @@ Results are ordered by tuple (pair, time). - `frequency` (`str`): frequency of the returned timeseries, e.g 15s, 1d, etc. - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_height` (`int`): Start block of the timeseries (only applicable when querying with frequency 1b). - `end_height` (`int`): End block of the timeseries (only applicable when querying with frequency 1b). - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. @@ -3477,8 +3477,8 @@ Returns metrics for specified institutions. - `frequency` (`str`): frequency of the returned timeseries, e.g 15s, 1d, etc. - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_height` (`int`): Start block of the timeseries (only applicable when querying with frequency 1b). - `end_height` (`int`): End block of the timeseries (only applicable when querying with frequency 1b). - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. @@ -3516,8 +3516,8 @@ Returns index candles for specified indexes and date range. - `frequency` (`str`): frequency of the returned timeseries, e.g 15s, 1d, etc. - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. - `end_inclusive` (`bool`): Flag to define if end timestamp must be included in the timeseries if present. True by default. - `timezone` (`str`): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page. @@ -3554,8 +3554,8 @@ Returns index levels for specified indexes and date range. - `frequency` (`str`): frequency of the returned timeseries, e.g 15s, 1d, etc. - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. - `end_inclusive` (`bool`): Flag to define if end timestamp must be included in the timeseries if present. True by default. - `timezone` (`str`): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page. @@ -3593,8 +3593,8 @@ Returns index constituents for specified indexes and date range. - `frequency` (`str`): frequency of the returned timeseries, e.g 15s, 1d, etc. - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. - `end_inclusive` (`bool`): Flag to define if end timestamp must be included in the timeseries if present. True by default. - `timezone` (`str`): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page. @@ -3633,8 +3633,8 @@ For more information on market metrics, see: https://docs.coinmetrics.io/api/v4# - `frequency` (`str`): frequency of the returned timeseries, e.g 15s, 1d, etc. - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. - `end_inclusive` (`bool`): Flag to define if end timestamp must be included in the timeseries if present. True by default. - `timezone` (`str`): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page. @@ -3675,8 +3675,8 @@ For more information on market candles, see: https://docs.coinmetrics.io/info/ma - `frequency` (`str`): frequency of the returned timeseries, e.g 15s, 1d, etc. - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. - `end_inclusive` (`bool`): Flag to define if end timestamp must be included in the timeseries if present. True by default. - `timezone` (`str`): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page. @@ -3713,8 +3713,8 @@ For more information on market trades, see: https://docs.coinmetrics.io/info/mar - `markets` (`list(str), str`): list of market ids. Market ids use the following naming convention: `exchangeName-baseAsset-quoteAsset-spot` for spot markets, `exchangeName-futuresSymbol-future` for futures markets, and `exchangeName-optionsSymbol-option` for options markets. e.g., `'coinbase-btc-usd-spot'`, `'bitmex-XBTUSD-future'` - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. - `end_inclusive` (`bool`): Flag to define if end timestamp must be included in the timeseries if present. True by default. - `timezone` (`str`): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page. @@ -3752,8 +3752,8 @@ For more information on open interest, see: https://docs.coinmetrics.io/info/mar - `markets` (`list(str), str`): list of market ids. Market ids use the following naming convention: `exchangeName-baseAsset-quoteAsset-spot` for spot markets, `exchangeName-futuresSymbol-future` for futures markets, and `exchangeName-optionsSymbol-option` for options markets. e.g., `'coinbase-btc-usd-spot'`, `'bitmex-XBTUSD-future'` - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. - `end_inclusive` (`bool`): Flag to define if end timestamp must be included in the timeseries if present. True by default. - `granularity` (`str`): Downsampling granularity of market open interest. Supported values are raw, 1m, 1h, and 1d. @@ -3790,8 +3790,8 @@ For more information on liquidations, see: https://docs.coinmetrics.io/info/mark - `markets` (`list(str), str`): list of market ids. Market ids use the following naming convention: `exchangeName-baseAsset-quoteAsset-spot` for spot markets, `exchangeName-futuresSymbol-future` for futures markets, and `exchangeName-optionsSymbol-option` for options markets. e.g., `'coinbase-btc-usd-spot'`, `'bitmex-XBTUSD-future'` - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. - `end_inclusive` (`bool`): Flag to define if end timestamp must be included in the timeseries if present. True by default. - `timezone` (`str`): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page. @@ -3827,8 +3827,8 @@ For more information on funding rates, see: https://docs.coinmetrics.io/info/mar - `markets` (`list(str), str`): list of market ids. Market ids use the following naming convention: `exchangeName-baseAsset-quoteAsset-spot` for spot markets, `exchangeName-futuresSymbol-future` for futures markets, and `exchangeName-optionsSymbol-option` for options markets. e.g., `'coinbase-btc-usd-spot'`, `'bitmex-XBTUSD-future'` - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. - `end_inclusive` (`bool`): Flag to define if end timestamp must be included in the timeseries if present. True by default. - `timezone` (`str`): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page. @@ -3864,8 +3864,8 @@ For more information on funding rates, see: https://docs.coinmetrics.io/info/mar - `markets` (`list(str), str`): list of market ids. Market ids use the following naming convention: `exchangeName-baseAsset-quoteAsset-spot` for spot markets, `exchangeName-futuresSymbol-future` for futures markets, and `exchangeName-optionsSymbol-option` for options markets. e.g., `'coinbase-btc-usd-spot'`, `'bitmex-XBTUSD-future'` - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. - `end_inclusive` (`bool`): Flag to define if end timestamp must be included in the timeseries if present. True by default. - `timezone` (`str`): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page. @@ -3904,8 +3904,8 @@ For more information on order books, see: https://docs.coinmetrics.io/info/marke - `granularity` (`str`): Downsampling granularity of market order books and quotes. Supported values are raw, 1m, 1h, and 1d. - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. - `end_inclusive` (`bool`): Flag to define if end timestamp must be included in the timeseries if present. True by default. - `depth_limit` (`str`): book depth limit, 100 levels max or full book that is not limited and provided as is from the exchange. Full book snapshots are collected once per hour @@ -3945,8 +3945,8 @@ For more information on quotes, see: https://docs.coinmetrics.io/info/markets/qu - `granularity` (``): Downsampling granularity of market order books and quotes. Supported values are raw, 1m, 1h, and 1d. - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. - `end_inclusive` (`bool`): Flag to define if end timestamp must be included in the timeseries if present. True by default. - `timezone` (`str`): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page. @@ -3983,8 +3983,8 @@ Returns contract prices for specified markets. This includes index price and mar - `markets` (`list(str), str`): list of market ids. Market ids use the following naming convention: `exchangeName-baseAsset-quoteAsset-spot` for spot markets, `exchangeName-futuresSymbol-future` for futures markets, and `exchangeName-optionsSymbol-option` for options markets. e.g., `'coinbase-btc-usd-spot'`, `'bitmex-XBTUSD-future', 'deribit-ETH-25MAR22-1200-P-option'` - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. - `end_inclusive` (`bool`): Flag to define if end timestamp must be included in the timeseries if present. True by default. - `granularity` (`str`): Downsampling granularity of market contract prices. Supported values are raw, 1m, 1h, and 1d. @@ -4020,8 +4020,8 @@ Returns implied volatility for specified markets. - `markets` (`list(str), str`): list of market ids. Market ids use the following naming convention: `exchangeName-baseAsset-quoteAsset-spot` for spot markets, `exchangeName-futuresSymbol-future` for futures markets, and `exchangeName-optionsSymbol-option` for options markets. e.g., `'coinbase-btc-usd-spot'`, `'bitmex-XBTUSD-future', 'deribit-ETH-25MAR22-1200-P-option'` - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. - `end_inclusive` (`bool`): Flag to define if end timestamp must be included in the timeseries if present. True by default. - `granularity` (`str - one of raw, 1m, 1h, and 1d`): Downsampling granularity of market implied volatility. Supported values are raw, 1m, 1h, and 1d. @@ -4057,8 +4057,8 @@ Returns greeks for option markets. - `markets` (`list(str), str`): list of market ids. Market ids use the following naming convention: `exchangeName-baseAsset-quoteAsset-spot` for spot markets, `exchangeName-futuresSymbol-future` for futures markets, and `exchangeName-optionsSymbol-option` for options markets. e.g., `'coinbase-btc-usd-spot'`, `'bitmex-XBTUSD-future', 'deribit-ETH-25MAR22-1200-P-option'` - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. - `end_inclusive` (`bool`): Flag to define if end timestamp must be included in the timeseries if present. True by default. - `granularity` (`str - one of raw, 1m, 1h, and 1d`): Downsampling granularity of market greeks. Supported values are raw, 1m, 1h, and 1d @@ -4092,8 +4092,8 @@ Returns mining pool tips summaries for specified assets. - `assets` (`list(str), str`): list of asset names, e.g. 'btc' - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. - `end_inclusive` (`bool`): Flag to define if end timestamp must be included in the timeseries if present. True by default. - `timezone` (`str`): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page. @@ -4126,8 +4126,8 @@ Returns mempool feerates for the specified assets. Note: for this method, page_s - `assets` (`list(str), str`): list of asset names, e.g. 'btc' - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. - `end_inclusive` (`bool`): Flag to define if end timestamp must be included in the timeseries if present. True by default. - `timezone` (`str`): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page. @@ -4381,8 +4381,8 @@ Returns a list of blockchain blocks metadata. - `heights` (`str, list(str)`): Optional comma separated list of block heights to filter a response. - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_height` (`int`): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time - `end_height` (`int`): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. @@ -4423,8 +4423,8 @@ Returns a list of blockchain accounts with their balances. - `accounts` (`str, list(str)`): Optional comma separated list of accounts to filter a response. - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_height` (`int`): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time - `end_height` (`int`): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time - `start_chain_sequence_number` (`int`): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time @@ -4470,8 +4470,8 @@ Returns a list of blockchain transactions metadata. - `block_hashes` (`str, list(str)`): Optional comma separated list of block hashes to filter a response. - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_height` (`int`): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time - `end_height` (`int`): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. @@ -4515,8 +4515,8 @@ Returns a list of blockchain accounts balance updates. - `block_hashes` (`str, list(str)`): Optional comma separated list of block hashes to filter a response. - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_height` (`int`): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time - `end_height` (`int`): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time - `start_chain_sequence_number` (`int`): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time @@ -4561,8 +4561,8 @@ Returns a list of blockchain blocks metadata. - `heights` (`str, list(str)`): Optional comma separated list of block heights to filter a response. - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_height` (`int`): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time - `end_height` (`int`): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time - `chain` (`str`): Default: "main" Chain type. Supported values are main and all (includes both main and stale). @@ -4605,8 +4605,8 @@ Returns a list of blockchain accounts with their balances. - `accounts` (`str, list(str)`): Optional comma separated list of accounts to filter a response. - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_height` (`int`): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time - `end_height` (`int`): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time - `start_chain_sequence_number` (`int`): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time @@ -4648,8 +4648,8 @@ Returns a list of blockchain sub-accounts with their balances. - `accounts` (`str, list(str)`): Optional comma separated list of accounts to filter a response. - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_height` (`int`): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time - `end_height` (`int`): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time - `start_chain_sequence_number` (`int`): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time @@ -4692,8 +4692,8 @@ Returns a list of blockchain transactions metadata. - `block_hashes` (`str, list(str)`): Optional comma separated list of block hashes to filter a response. - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_height` (`int`): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time - `end_height` (`int`): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time - `chain` (`str`): Default: "main". Chain type. Supported values are main and all (includes both main and stale). @@ -4743,8 +4743,8 @@ Returns a list of blockchain accounts balance updates. - `block_hashes` (`str, list(str)`): Optional comma separated list of block hashes to filter a response. - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_height` (`int`): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time - `end_height` (`int`): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time - `start_chain_sequence_number` (`int`): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time @@ -4913,8 +4913,8 @@ def get_list_of_balance_updates_for_account_v2( - `txids` (`Union[str, List[str]]`): Optional comma separated list of transaction identifiers (txid) to filter a response. The list must contain a single element for Community users. - `block_hashes` (`Union[str, List[str]]`): Optional comma separated list of block hashes to filter a response. The list must contain a single element for Community users. - `include_counterparties` (`bool`): Include information about the counterparties balance updates. -- `start_time` (`str`): Start of the time interval. This field refers to the `time` field in the response. Multiple formats of ISO 8601 are supported: `2006-01-20T00:00:00Z`, `2006-01-20T00:00:00.000Z`, `2006-01-20T00:00:00.123456Z`, `2006-01-20T00:00:00.123456789Z`, `2006-01-20`, `20060120`. Inclusive by default. Mutually exclusive with `start_height`. UTC timezone by default. `Z` suffix is optional and `timezone` parameter has a priority over it. If `start_time` is omitted, response will include time series from the **earliest** time available. This parameter is disabled for Community users. -- `end_time` (`str`): End of the time interval. This field refers to the `time` field in the response. Multiple formats of ISO 8601 are supported: `2006-01-20T00:00:00Z`, `2006-01-20T00:00:00.000Z`, `2006-01-20T00:00:00.123456Z`, `2006-01-20T00:00:00.123456789Z`, `2006-01-20`, `20060120`. Inclusive by default. Mutually exclusive with `end_height`. UTC timezone by default. `Z` suffix is optional and `timezone` parameter has a priority over it. If `end_time` is omitted, response will include time series up to the **latest** time available. This parameter is disabled for Community users. +- `start_time` (`str`): Start of the time interval. This field refers to the `time` field in the response. Multiple formats of ISO 8601 are supported: `2006-01-20T00:00:00Z`, `2006-01-20T00:00:00.000Z`, `2006-01-20T00:00:00.123456Z`, `2006-01-20T00:00:00.123456789, 2006-01-20, 20060120Z`, `2006-01-20`, `20060120`. Inclusive by default. Mutually exclusive with `start_height`. UTC timezone by default. `Z` suffix is optional and `timezone` parameter has a priority over it. If `start_time` is omitted, response will include time series from the **earliest** time available. This parameter is disabled for Community users. +- `end_time` (`str`): End of the time interval. This field refers to the `time` field in the response. Multiple formats of ISO 8601 are supported: `2006-01-20T00:00:00Z`, `2006-01-20T00:00:00.000Z`, `2006-01-20T00:00:00.123456Z`, `2006-01-20T00:00:00.123456789, 2006-01-20, 20060120Z`, `2006-01-20`, `20060120`. Inclusive by default. Mutually exclusive with `end_height`. UTC timezone by default. `Z` suffix is optional and `timezone` parameter has a priority over it. If `end_time` is omitted, response will include time series up to the **latest** time available. This parameter is disabled for Community users. - `start_height` (`int`): The start height indicates the beginning block height for the set of data that are returned. Inclusive by default. Mutually exclusive with `start_time`. This parameter is disabled for Community users. - `end_height` (`int`): The end height indicates the ending block height for the set of data that are returned. Inclusive by default. Mutually exclusive with `end_time`. This parameter is disabled for Community users. - `start_chain_sequence_number` (`int`): Start of the `chain_sequence_number` interval. This parameter is disabled for Community users. @@ -4964,8 +4964,8 @@ Returns status updates for the specified or all transactions. - `replacements_only` (`bool`): Boolean indicating if the response should contain only the replacement transactions. - `page_size` (`int`): number of items returned per page when calling the API. If the request times out, try using a smaller number. - `paging_from` (`PagingFrom, str`): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries. -- `start_time` (`datetime, date, str`): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 -- `end_time` (`datetime, date, str`): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120 +- `start_time` (`datetime, date, str`): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 +- `end_time` (`datetime, date, str`): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120 - `start_inclusive` (`bool`): Flag to define if start timestamp must be included in the timeseries if present. True by default. - `end_inclusive` (`bool`): Flag to define if end timestamp must be included in the timeseries if present. True by default. - `timezone` (`str`): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page. @@ -5399,8 +5399,8 @@ def get_snapshots_of_asset_metric_constituents( - `metric` (`str`): Target metric name. - `at_time` (`Optional[str]`): Returns constituents at a specified date. Value `now` can be specified to get the current constituents. Mutually exclusive with `start_time` and/or `end_time`. -- `end_time` (`Optional[Union[datetime, date, str]]`): Start of the time interval, inclusive. Multiple formats of ISO 8601 are supported: `2006-01-20T00:00:00Z`, `2006-01-20T00:00:00.000Z`, `2006-01-20T00:00:00.123456Z`, `2006-01-20T00:00:00.123456789Z`, `2006-01-20`, `20060120`. Mutually exclusive with `at_time`. -- `start_time` (`Optional[Union[datetime, date, str]]`): End of the time interval, inclusive. Multiple formats of ISO 8601 are supported: `2006-01-20T00:00:00Z`, `2006-01-20T00:00:00.000Z`, `2006-01-20T00:00:00.123456Z`, `2006-01-20T00:00:00.123456789Z`, `2006-01-20`, `20060120`. Mutually exclusive with `at_time`. +- `end_time` (`Optional[Union[datetime, date, str]]`): Start of the time interval, inclusive. Multiple formats of ISO 8601 are supported: `2006-01-20T00:00:00Z`, `2006-01-20T00:00:00.000Z`, `2006-01-20T00:00:00.123456Z`, `2006-01-20T00:00:00.123456789, 2006-01-20, 20060120Z`, `2006-01-20`, `20060120`. Mutually exclusive with `at_time`. +- `start_time` (`Optional[Union[datetime, date, str]]`): End of the time interval, inclusive. Multiple formats of ISO 8601 are supported: `2006-01-20T00:00:00Z`, `2006-01-20T00:00:00.000Z`, `2006-01-20T00:00:00.123456Z`, `2006-01-20T00:00:00.123456789, 2006-01-20, 20060120Z`, `2006-01-20`, `20060120`. Mutually exclusive with `at_time`. - `next_page_token` (`Optional[str]`): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use `next_page_url` response field. - `page_size` (`Optional[int]`): Number of items per single page of results. - `paging_from` (`Optional[str]`): Where does the first page start, at the start of the interval or at the end. @@ -5430,8 +5430,8 @@ def get_timeframes_of_asset_metric_constituents( - `constituents` (`Optional[Union[str, List[str]]]`): Comma separated list of constituents. By default all constituents are returned. Different asset metrics may have different constituents. For example, constituents for `volume_trusted_spot_usd_1d` are exchanges. -- `end_time` (`Optional[Union[datetime, date, str]]`): Start of the time interval, inclusive. Multiple formats of ISO 8601 are supported: `2006-01-20T00:00:00Z`, `2006-01-20T00:00:00.000Z`, `2006-01-20T00:00:00.123456Z`, `2006-01-20T00:00:00.123456789Z`, `2006-01-20`, `20060120`. Mutually exclusive with `at_time`. -- `start_time` (`Optional[Union[datetime, date, str]]`): End of the time interval, inclusive. Multiple formats of ISO 8601 are supported: `2006-01-20T00:00:00Z`, `2006-01-20T00:00:00.000Z`, `2006-01-20T00:00:00.123456Z`, `2006-01-20T00:00:00.123456789Z`, `2006-01-20`, `20060120`. Mutually exclusive with `at_time`. +- `end_time` (`Optional[Union[datetime, date, str]]`): Start of the time interval, inclusive. Multiple formats of ISO 8601 are supported: `2006-01-20T00:00:00Z`, `2006-01-20T00:00:00.000Z`, `2006-01-20T00:00:00.123456Z`, `2006-01-20T00:00:00.123456789, 2006-01-20, 20060120Z`, `2006-01-20`, `20060120`. Mutually exclusive with `at_time`. +- `start_time` (`Optional[Union[datetime, date, str]]`): End of the time interval, inclusive. Multiple formats of ISO 8601 are supported: `2006-01-20T00:00:00Z`, `2006-01-20T00:00:00.000Z`, `2006-01-20T00:00:00.123456Z`, `2006-01-20T00:00:00.123456789, 2006-01-20, 20060120Z`, `2006-01-20`, `20060120`. Mutually exclusive with `at_time`. - `next_page_token` (`Optional[str]`): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use `next_page_url` response field. - `page_size` (`Optional[int]`): Number of items per single page of results. - `paging_from` (`Optional[str]`): Where does the first page start, at the start of the interval or at the end. diff --git a/docs/site/api_client.html b/docs/site/api_client.html index 34c081e..ff06163 100644 --- a/docs/site/api_client.html +++ b/docs/site/api_client.html @@ -5319,8 +5319,8 @@

get_asset_alerts @@ -5350,8 +5350,8 @@

get_defi_balance_sheetsdefi_protocols (str, List[str]): list of DeFi protocols like aave_v2_eth or protocol patterns like aave_v2_* or aave_*_eth or *_eth.
  • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
  • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
    • -
  • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
    • -
  • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
    • +
  • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
    • +
  • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
  • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
  • end_height (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
  • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
    • @@ -5378,8 +5378,8 @@

    get_asset_chains @@ -5419,8 +5419,8 @@

    get_asset_metricsget_exchange_metricsget_exchange_asset_metricsget_pair_metricsget_pair_candlesget_institution_metricsfrequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
  • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
  • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
    • -
  • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
    • -
  • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
    • +
  • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
    • +
  • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
  • start_height (int): Start block of the timeseries (only applicable when querying with frequency 1b).
  • end_height (int): End block of the timeseries (only applicable when querying with frequency 1b).
  • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
    • @@ -5647,8 +5647,8 @@

    get_index_candles @@ -5678,8 +5678,8 @@

    get_index_levels @@ -5710,8 +5710,8 @@

    get_index_constituentsfrequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
  • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
  • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
    • -
  • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
    • -
  • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
    • +
  • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
    • +
  • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
  • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
  • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
  • timezone (str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.
    • @@ -5742,8 +5742,8 @@

    get_market_metrics @@ -5776,8 +5776,8 @@

    get_market_candles @@ -5806,8 +5806,8 @@

    get_market_trades @@ -5837,8 +5837,8 @@

    get_market_open_interestmarkets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future'
  • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
  • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
    • -
  • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
    • -
  • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
    • +
  • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
    • +
  • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
  • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
  • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
  • granularity (str): Downsampling granularity of market open interest. Supported values are raw, 1m, 1h, and 1d.
    • @@ -5867,8 +5867,8 @@

    get_market_liquidationsmarkets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future'
  • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
  • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
    • -
  • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
    • -
  • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
    • +
  • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
    • +
  • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
  • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
  • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
  • timezone (str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.
    • @@ -5896,8 +5896,8 @@

    get_market_funding_ratesmarkets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future'
  • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
  • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
    • -
  • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
    • -
  • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
    • +
  • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
    • +
  • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
  • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
  • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
  • timezone (str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.
    • @@ -5925,8 +5925,8 @@

    get_predicted_market_funding_ratesmarkets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future'
  • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
  • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
    • -
  • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
    • -
  • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
    • +
  • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
    • +
  • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
  • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
  • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
  • timezone (str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.
    • @@ -5957,8 +5957,8 @@

    get_market_orderbooksget_market_quotes @@ -6021,8 +6021,8 @@

    get_market_contract_pricesget_market_implied_volatilityget_market_greeksget_mining_pool_tips_summary @@ -6136,8 +6136,8 @@

    get_mempool_feerates @@ -6317,8 +6317,8 @@

    get_list_of_blocksget_list_of_accountsget_list_of_transactionsblock_hashes (str, list(str)): Optional comma separated list of block hashes to filter a response.
  • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
  • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
    • -
  • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
    • -
  • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
    • +
  • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
    • +
  • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
  • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
  • end_height (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
  • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
    • @@ -6430,8 +6430,8 @@

    get_list_of_balance_updatesget_list_of_blocks_v2 @@ -6506,8 +6506,8 @@

    get_list_of_accounts_v2accounts (str, list(str)): Optional comma separated list of accounts to filter a response.
  • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
  • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
    • -
  • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
    • -
  • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
    • +
  • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
    • +
  • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
  • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
  • end_height (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
  • start_chain_sequence_number (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
    • @@ -6542,8 +6542,8 @@

    get_list_of_sub_accounts_v2get_list_of_transactions_v2 @@ -6623,8 +6623,8 @@

    get_list_of_balance_updates_v2get_list_of_balance_updates_
  • txids (Union[str, List[str]]): Optional comma separated list of transaction identifiers (txid) to filter a response. The list must contain a single element for Community users.
  • block_hashes (Union[str, List[str]]): Optional comma separated list of block hashes to filter a response. The list must contain a single element for Community users.
  • include_counterparties (bool): Include information about the counterparties balance updates.
    • -
  • start_time (str): Start of the time interval. This field refers to the time field in the response. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120. Inclusive by default. Mutually exclusive with start_height. UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it. If start_time is omitted, response will include time series from the earliest time available. This parameter is disabled for Community users.
    • -
  • end_time (str): End of the time interval. This field refers to the time field in the response. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120. Inclusive by default. Mutually exclusive with end_height. UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it. If end_time is omitted, response will include time series up to the latest time available. This parameter is disabled for Community users.
    • +
  • start_time (str): Start of the time interval. This field refers to the time field in the response. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120Z, 2006-01-20, 20060120. Inclusive by default. Mutually exclusive with start_height. UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it. If start_time is omitted, response will include time series from the earliest time available. This parameter is disabled for Community users.
    • +
  • end_time (str): End of the time interval. This field refers to the time field in the response. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120Z, 2006-01-20, 20060120. Inclusive by default. Mutually exclusive with end_height. UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it. If end_time is omitted, response will include time series up to the latest time available. This parameter is disabled for Community users.
  • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Inclusive by default. Mutually exclusive with start_time. This parameter is disabled for Community users.
  • end_height (int): The end height indicates the ending block height for the set of data that are returned. Inclusive by default. Mutually exclusive with end_time. This parameter is disabled for Community users.
  • start_chain_sequence_number (int): Start of the chain_sequence_number interval. This parameter is disabled for Community users.
    • @@ -6792,8 +6792,8 @@

    get_transaction_trackerreplacements_only (bool): Boolean indicating if the response should contain only the replacement transactions.
  • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
  • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
    • -
  • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
    • -
  • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
    • +
  • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
    • +
  • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
  • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
  • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
  • timezone (str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.
    • @@ -7123,8 +7123,8 @@

    get_snapshots_of_asset_metri
    • metric (str): Target metric name.
    • at_time (Optional[str]): Returns constituents at a specified date. Value now can be specified to get the current constituents. Mutually exclusive with start_time and/or end_time.
      • -
    • end_time (Optional[Union[datetime, date, str]]): Start of the time interval, inclusive. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120. Mutually exclusive with at_time.
      • -
    • start_time (Optional[Union[datetime, date, str]]): End of the time interval, inclusive. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120. Mutually exclusive with at_time.
      • +
    • end_time (Optional[Union[datetime, date, str]]): Start of the time interval, inclusive. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120Z, 2006-01-20, 20060120. Mutually exclusive with at_time.
      • +
    • start_time (Optional[Union[datetime, date, str]]): End of the time interval, inclusive. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120Z, 2006-01-20, 20060120. Mutually exclusive with at_time.
    • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
    • page_size (Optional[int]): Number of items per single page of results.
    • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • @@ -7148,8 +7148,8 @@

      get_timeframes_of_asset_met
    • constituents (Optional[Union[str, List[str]]]): Comma separated list of constituents. By default all constituents are returned. Different asset metrics may have different constituents. For example, constituents for volume_trusted_spot_usd_1d are exchanges.
      • -
    • end_time (Optional[Union[datetime, date, str]]): Start of the time interval, inclusive. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120. Mutually exclusive with at_time.
      • -
    • start_time (Optional[Union[datetime, date, str]]): End of the time interval, inclusive. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120. Mutually exclusive with at_time.
      • +
    • end_time (Optional[Union[datetime, date, str]]): Start of the time interval, inclusive. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120Z, 2006-01-20, 20060120. Mutually exclusive with at_time.
      • +
    • start_time (Optional[Union[datetime, date, str]]): End of the time interval, inclusive. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120Z, 2006-01-20, 20060120. Mutually exclusive with at_time.
    • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
    • page_size (Optional[int]): Number of items per single page of results.
    • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • diff --git a/docs/site/search/search_index.json b/docs/site/search/search_index.json index d79fa91..3ff1160 100644 --- a/docs/site/search/search_index.json +++ b/docs/site/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"index.html","title":"Coin Metrics Python API v4 client library","text":"

      This is an official Python API client for Coin Metrics API v4.

      "},{"location":"index.html#installation-and-updates","title":"Installation and Updates","text":"

      To install the client you can run the following command: 

      pip install coinmetrics-api-client\n

      Note that the client is updated regularly to reflect the changes made in API v4. Ensure that your latest version matches with what's in pyPI

      To update your version, run the following command: 

      pip install coinmetrics-api-client -U\n

      "},{"location":"index.html#introduction","title":"Introduction","text":"

      You can use this client for querying all kinds of data with your API.

      To initialize the client you should use your API key, and the CoinMetricsClient class like the following. 

      from coinmetrics.api_client import CoinMetricsClient\n\nclient = CoinMetricsClient(\"<cm_api_key>\")\n\n# or to use community API:\nclient = CoinMetricsClient()\n

      After that you can use the client object for getting information such as available market trades as a list of dictionaries: 

      print(client.catalog_market_trades_v2().to_list())\n

      or to iterate over each page of data:

      for data in client.catalog_market_trades_v2():\n    print(data)\n

      you can also use filters for the catalog endpoints like this:

      print(client.catalog_market_trades_v2(exchange=\"binance\").to_list())\n

      All the catalog V2 endpoints meant to help access the historical data served by other endpoints. For example, you can get all the BTC market trades for a certain day from binance like this:

      import os\nfrom coinmetrics.api_client import CoinMetricsClient\nclient = CoinMetricsClient(os.environ['CM_API_KEY'])\nbtc_binance_markets = [market['market'] for market in client.catalog_market_trades_v2(exchange=\"binance\", asset=\"btc\").to_list()]\nstart_time = \"2023-01-01\"\nend_time = \"2023-01-02\"\nbinance_market_trades = client.get_market_trades(markets=btc_binance_markets, start_time=start_time, end_time=end_time, page_size=1000).export_to_csv(\"binance_trades.csv\")\n
      in this case you would get all the information markets that trade on binance only.

      You can use this client to connect to our API v4 and get catalog or timeseries data from python environment. It natively supports paging over the data so you can use it to iterate over timeseries entries seamlessly.

      The client can be used to query both pro and community data.

      The full list of methods can be found in the API Client Spec.

      If you'd like a more holistic view of what is offered from an API endpoint you can use the to_dataframe() function associated with our catalog endpoints. The code snippet below shows getting a dataframe of information on all the assets that data is provided for: 

      print(client.catalog_market_metrics_v2(exchange=\"binance\", page_size=1000).to_dataframe())\n

      Output: 

                                   market                                            metrics\n0       binance-1000BTTCUSDT-future  [{'metric': 'liquidity_depth_0_1_percent_ask_v...\n1      binance-1000FLOKIUSDT-future  [{'metric': 'liquidations_reported_future_buy_...\n2       binance-1000LUNCBUSD-future  [{'metric': 'liquidations_reported_future_buy_...\n3       binance-1000LUNCUSDT-future  [{'metric': 'liquidations_reported_future_buy_...\n4       binance-1000PEPEUSDT-future  [{'metric': 'liquidations_reported_future_buy_...\n

      Now you can use the pandas Dataframe functionality to do useful transformations, such as filtering out the assets without metrics available, then saving that data to a csv file: 

      import pandas as pd\nimport os\nfrom coinmetrics.api_client import CoinMetricsClient\nfrom datetime import timedelta\nclient = CoinMetricsClient(os.environ['CM_API_KEY'])\nbinance_markets = client.catalog_market_trades_v2(exchange=\"binance\", page_size=1000).to_dataframe()\nbinance_markets['max_time'] = pd.to_datetime(binance_markets['max_time'], utc=True)\ncurrent_utc_time = pd.Timestamp.now(tz='UTC')\none_day_ago = current_utc_time - timedelta(days=1)\nfiltered_binance_markets = binance_markets[binance_markets['max_time'] > one_day_ago]\n

      "},{"location":"index.html#parallel-execution-for-faster-data-export","title":"Parallel execution for faster data export","text":"

      There are times when it may be useful to pull in large amounts of data at once. The most effective way to do this when calling the CoinMetrics API is to split your request into many different queries. This functionality is now built into the API Client directly to allow for faster data export:

      import os\nfrom coinmetrics.api_client import CoinMetricsClient\n\n\nif __name__ == '__main__':\n    client = CoinMetricsClient(os.environ['CM_API_KEY'])\n    binance_eth_markets = [market['market'] for market in client.catalog_market_candles(exchange=\"binance\", base=\"eth\")]\n    start_time = \"2022-03-01\"\n    end_time = \"2023-05-01\"\n    client.get_market_candles(markets=binance_eth_markets, start_time=start_time, end_time=end_time, page_size=1000).parallel().export_to_json_files()\n

      What this feature does is rather request all the data in one thread, it will split into many threads or processes and either store them in separate files in the case of .parallel().export_to_csv_files() and .parallel().export_to_json_files or combine them all into one file or data structure in the case of .parallel().to_list(), .parallel().to_dataframe(), .parallel().export_to_json(). It's important to know that in order to send more requests per second to the CoinMetrics this uses the parallel tasks features in Python's concurrent.futures package. This means when using this feature, the API Client will use significantly more resources and may approach the Coin Metrics rate limits.

      In terms of resource usage and speed, these usages are in order from most performant to least: * .export_to_json_files() * .export_to_csv_files() * .to_list() * .export_to_json() * .to_dataframe()

      "},{"location":"index.html#splitting-single-parameter-queries-into-many-requests-for-increased-performance","title":"Splitting single parameter queries into many requests for increased performance","text":"

      There is a feature time_increment that can be used to split a single query into many based on time range, and then combine them later. Consider this example where we speed up getting a 2 months worth of BTC ReferenceRateUSD data into many parallel threads to create a dataframe faster: 

      import datetime\nimport os\nfrom coinmetrics.api_client import CoinMetricsClient\nfrom dateutil.relativedelta import relativedelta\nclient = CoinMetricsClient(os.environ.get(\"CM_API_KEY\"))\nstart_time = datetime.datetime.now()\nassets = [\"btc\", \"eth\", \"algo\"]\nif __name__ == '__main__':\n    client.get_asset_metrics(\n        assets=assets,\n        metrics=\"ReferenceRateUSD\",\n        frequency=\"1m\",\n        start_time=\"2022-03-01\",\n        end_time=\"2023-03-01\",\n        page_size=1000,\n        end_inclusive=False).parallel(\n        time_increment=relativedelta(months=1)).export_to_csv(\"btcRRs.csv\")\n    print(f\"Time taken parallel: {datetime.datetime.now() - start_time}\")\n    start_time = datetime.datetime.now()\n    client.get_asset_metrics(\n        assets=assets,\n        metrics=\"ReferenceRateUSD\",\n        frequency=\"1m\",\n        start_time=\"2022-03-01\",\n        end_time=\"2023-03-01\",\n        page_size=1000,\n        end_inclusive=False).export_to_csv(\"btcRRsNormal.csv\")\n
      Notice we pass in the time_increment=relativedelta(months=1) so that means we will split the threads up by month, in addition to by asset. So this will run a total 36 separate threads, 12 threads for each month x 3 threads for each asset. The difference it takes in time is dramatic: 
      Exporting to dataframe type: 100%|\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588| 36/36 [00:00<00:00, 54.62it/s]\nTime taken parallel: 0:00:36.654147\nTime taken normal: 0:05:20.073826\n

      Please note that for short time periods you can pass in a time_increment with datetime.timedelta to specify up to several weeks, for larger time frames you can use dateutil.relativedelta.relativedelta in order to split requests up by increments of months or years.

      "},{"location":"index.html#to-keep-in-mind-when-using-using-parallel-feature-or-generally-writing-high-performance-code-using-api-client","title":"To keep in mind when using using parallel feature or generally writing high performance code using API Client:","text":"
      • If you are using a small page_size and trying to export a large number amount of, this will be your biggest bottleneck. Generally the fastest page_size is 1000 to 10000
      • If you are unsure why an action is taking a long time, running the CoinMetricsClient using verbose=True or debug=True can give better insight into what is happening under the hood
      • The parallel feature is best used when you are exporting a large amount of data, that can be split by query params into many smaller requests. A good example of this is market candles over a long time frame - if you are querying hundreds of markets and are sure there will be data, using .parallel().export_to_csv_files(\"...\") can have a huge performance increase, if you are just querying a single market you will not see a difference
      • The parallel feature is highly configurable, there is several configuration options that may be suitable for advanced users like tweaking the max_workers parameter, or changing the default ProcessPoolExecutor to a ThreadPoolExectuor
      • Using multithreaded code is inherently more complex, it will be harder to debug issues with long running queries when running parallel exports compared to normal single threaded code
      • For that reason, this tool is best suited for exporting historical data rather than supporting a real time production system
      • The methods that create separate files for each thread will be the safest and most performant to use - .export_to_csv_files() and .export_to_json_files(). Using the methods that return a single output - .export_to_csv(), export_to_list(), and .export_to_dataframe() need to join the data from many threads before it can be returned, this may use a lot of memory if you are accessing data types like market orderbooks or market trades and could fail altogether
      • If you get the error BrokenProcessPool it might be because you're missing a main() function
      "},{"location":"index.html#examples","title":"Examples","text":"

      The API Client allows you to chain together workflows for importing, transforming, then exporting Coin Metrics data. Below are examples of common use-cases that can be altered to tailor your specific needs. In addition to the examples listed below, there's examples covering all the API methods, found in the examples directory.

      Example Notebooks

      • walkthrough_community.ipynb: Walks through the basic functionality available using the community client.

      Asset Metrics

      • bbb_metrics_csv_exporter_using_plain_requests.py: Queries block-by-block metrics using the requests library and exports the output into a CSV file.
      • bbb_metrics_json_exporter.py: Queries block-by-block metrics and exports the output into a JSON file.
      • eod_metrics_csv_exporter.py: Exports a set of user-defined metrics and assets published at end-of-day and exports the output into a CSV file.
      • reference_rates_json_exporter.py: Queries Coin Metrics Reference Rates at a user-defined frequency for a set of assets, then exports the output into a JSON file.

      Market Data

      • books_json_exporter.py: Queries market orderbook data then exports the output into a JSON file.
      • candles_json_exporter.py: Queries market candles data then exports the output into a JSON file.
      • funding_rates_json_exporter.py: Queries market funding rates data then exports the output into a JSON file.
      • trades_csv_exporter.py: Queries market trades data then exports the output into a CSV file.
      • trades_json_exporter.py: Queries market trades data then exports the output into a JSON file.

      **Parallel processing exports * candles_csv_export.py: Exports market candles in parallel to many separate csv files * candles_json_export.py: Exports market candles in parallel to many separate json files * market_trades_list.py: Creates a list of market trades, using .parallel() feature to improve performance * market_orderbooks.py: Exports market orderbooks to many csv files * candles_csv_export_manual.py: Example of parallelism using the API Client without using the .parallel() feature * btc_1m_metrics_export.py: Example of splitting a large request for asset metrics by metric to improve performance, exporting a single csv and also separate csv. * market_orderbooks_csv_exporter_by_day.py: Example of splitting a market orderbook export up by day, to increase export performance

      "},{"location":"index.html#getting-timeseries-data","title":"Getting timeseries data","text":"

      For getting timeseries data you want to use methods of the client class that start with get_. It's important to note that the timeseries endpoints return data of a parent class type DataCollection. The DataCollection class is meant to support a variety of different data export and data manipulation use cases, so just calling one of the client methods such as data = client.get_market_trades(markets=\"coinbase-btc-usd-spot\") will not actually retrieve the data related to this API call. You must then call a function on this DataCollection such as data.export_to_csv(\"coinbase_btc_usd_spot_trades.csv) or data.to_dataframe() in order to access the data. There is more explicit examples below.If you are curious to see how the API calls are being made and with what parameters, instantiating the client with the verbose argument like CoinMetricsClient(api_key=<YOUR_API_KEY>, verbose=True) will print the API calls as well as information on performance to console.

      For example if you want to get a bunch of market data trades for coinbase btc-usd pair you can run something similar to the following:

      for trade in client.get_market_trades(\n    markets='coinbase-btc-usd-spot', \n    start_time='2020-01-01', \n    end_time='2020-01-03',\n    limit_per_market=10\n):\n    print(trade)\n
      This example uses the DataCollection as a Python iterator, so with each iteration of the Python for loop it will call the Coin Metrics API and return data. The default page_size for calls to the API is 100, so each call will return 100 trades until it reaches the end of the query. To get more trades in each API call, you can add the parameter page_size to the .get_market_trades() method call, up to a maximum of 10000.

      Or if you want to see daily btc asset metrics you can use something like this:

      for metric_data in client.get_asset_metrics(assets='btc', \n                                            metrics=['ReferenceRateUSD', 'BlkHgt', 'AdrActCnt',  \n                                                     'AdrActRecCnt', 'FlowOutBFXUSD'], \n                                            frequency='1d',\n                                            limit_per_asset=10):\n    print(metric_data)\n
      This will print you the requested metrics for all the days where we have any of the metrics present.

      "},{"location":"index.html#dataframes","title":"DataFrames","text":"

      (New in >=2021.9.30.14.30)

      Timeseries data can be transformed into a pandas dataframe by using the to_dataframe() method. The code snippet below shows how: 

      import pandas as pd\nfrom coinmetrics.api_client import CoinMetricsClient\nfrom os import environ\n\nclient = CoinMetricsClient()\ntrades = client.get_market_trades(\n    markets='coinbase-btc-usd-spot', \n    start_time='2021-09-19T00:00:00Z', \n    limit_per_market=10\n)\ntrades_df = trades.to_dataframe()\nprint(trades_df.head())\n
      If you want to use dataframes, then you will need to install pandas

      Notes

      • This only works with requests that return the type DataCollection. Thus, catalog requests, which return lists cannot be returned as dataframes. Please see the API Client Spec for a full list of requests and their return types.
      • API restrictions apply. Some requests may return empty results due to limited access to the API from you API key.
      "},{"location":"index.html#type-conversion","title":"Type Conversion","text":"

      (New in >=2021.12.17.18.00)

      As of version 2021.12.17.18.00 or later, outputs from the to_dataframe function automatically convert the dtypes for a dataframe to the optimal pandas types. 

      metrics_list = ['volume_trusted_spot_usd_1d', 'SplyFF', 'AdrBalUSD1Cnt']\nasset_list = ['btc','xmr']\nstart_time='2021-12-01'\ndf_metrics = client.get_asset_metrics(\n  assets=asset_list, metrics=metrics_list, start_time=start_time, limit_per_asset=3\n).to_dataframe()\nprint(df_metrics.dtypes)\n

      asset                          string\ntime                           datetime64[ns, tzutc()]\nAdrBalUSD1Cnt                   Int64\nSplyFF                        Float64\nvolume_trusted_spot_usd_1d    Float64\ndtype: object\n

      This can be turned off by setting optimize_pandas_types=False

      Alternatively, you can manually enter your own type conversion by passing in a dictionary for dtype_mapper. This can be done in conjunction with pandas' built in type optimizations. 

      mapper = {\n  'SplyFF': 'Float64',\n  'AdrBalUSD1Cnt': 'Int64',\n}\ndf_mapped = client.get_asset_metrics(\n  assets=asset_list, metrics=metrics_list, start_time=start_time, limit_per_asset=3\n).to_dataframe(dtype_mapper=mapper, optimize_pandas_types=True)\nprint(df_mapped.dtypes)\n

      asset                                          object\ntime                          datetime64[ns, tzutc()]\nAdrBalUSD1Cnt                                   Int64\nSplyFF                                        Float64\nvolume_trusted_spot_usd_1d                    float64\ndtype: object\n

      Or as strictly the only types in the dataframe

      dtype_mapper = {\n    'ReferenceRateUSD': np.float64,\n    'time': np.datetime64\n}\ndf = client.get_asset_metrics(\n  assets='btc', metrics='ReferenceRateUSD', start_time='2022-06-15', limit_per_asset=1\n).to_dataframe(dtype_mapper=dtype_mapper, optimize_pandas_types=False)\ndf.info()\n
      RangeIndex: 1 entries, 0 to 0\nData columns (total 3 columns):\n #   Column            Non-Null Count  Dtype         \n---  ------            --------------  -----         \n 0   asset             1 non-null      object        \n 1   time              1 non-null      datetime64[ns]\n 2   ReferenceRateUSD  1 non-null      float64       \ndtypes: datetime64[ns](1), float64(1), object(1)\nmemory usage: 152.0+ bytes\n

      Note that in order to pass a custom datetime object, setting a dtype_mapper is mandatory.

      Pandas type conversion tends to be more performant. But if there are custom operations that must be done using numpy datatypes, this option will let you perform them.

      "},{"location":"index.html#exporting-to-csv-and-json-files","title":"Exporting to csv and json files:","text":"

      You can also easily export timeseries data to csv and json files with builtin functions on the DataCollection type. For example this script will export Coinbase btc and eth trades for a date to csv and json files respectively: 

          start_date = datetime.date(year=2022, month=1, day=1)\n    end_date = datetime.datetime(year=2022, month=1, day=1)\n    market_trades_btc = client.get_market_trades(page_size=1000, markets=\"coinbase-btc-usd-spot\", start_time=start_date, end_time=end_date)\n    market_trades_btc.export_to_csv(\"jan_1_2022_coinbase_btc_trades.csv\")\n    market_trades_eth = client.get_market_trades(page_size=1000, markets=\"coinbase-eth-usd-spot\", start_time=start_date, end_time=end_date)\n    market_trades_eth.export_to_json(\"jan_1_2022_coinbase_eth.json\")\n

      "},{"location":"index.html#paging","title":"Paging","text":"

      You can make the datapoints to iterate from start (default) or from end.

      for that you should use a paging_from argument like the following: 

      from coinmetrics.api_client import CoinMetricsClient\nfrom coinmetrics.constants import PagingFrom\n\nclient = CoinMetricsClient()\n\nfor metric_data in client.get_asset_metrics(assets='btc', metrics=['ReferenceRateUSD'],\n                                            paging_from=PagingFrom.START):\n    print(metric_data)\n

      PagingFrom.END: is available but by default it will page from the start.

      "},{"location":"index.html#debugging-the-api-client","title":"Debugging the API Client","text":"

      There are two additional options for the API Client - debug_mode and verbose. These two options log network calls to the console, and in the case of debug_mode it will generate a log file of all the network requests and the time it takes to call them. These tools can be used to diagnose issues in your code and also to get a better understanding of request times so that users can write more performant code. For example, running the below code: 

      import os\n\nfrom coinmetrics.api_client import CoinMetricsClient\n\napi_key = os.environ['CM_API_KEY']\n\nif __name__ == '__main__':\n    client = CoinMetricsClient(api_key=api_key, debug_mode=True)\n    reference_rates_example = client.get_asset_metrics(assets=['btc', 'algo', 'eth'], metrics=['ReferenceRateUSD'])\n    for data in reference_rates_example:\n        continue\n

      The console output will look like: 

      [DEBUG] 2023-01-09 11:01:02,044 - Starting API Client debugging session. logging to stdout and cm_api_client_debug_2023_01_09_11_01_02.txt\n[DEBUG] 2023-01-09 11:01:02,044 - Using coinmetrics version 2022.11.14.16\n[DEBUG] 2023-01-09 11:01:02,044 - Current state of API Client, excluding API KEY: {'_verify_ssl_certs': True, '_api_base_url': 'https://api.coinmetrics.io/v4', '_ws_api_base_url': 'wss://api.coinmetrics.io/v4', '_http_header': {'Api-Client-Version': '2022.11.14.16'}, '_proxies': {'http': None, 'https': None}, 'debug_mode': True, 'verbose': False}\n[DEBUG] 2023-01-09 11:01:02,044 - Attempting to call url: timeseries/asset-metrics with params: {'assets': ['btc', 'algo', 'eth'], 'metrics': ['ReferenceRateUSD'], 'frequency': None, 'page_size': None, 'paging_from': 'start', 'start_time': None, 'end_time': None, 'start_height': None, 'end_height': None, 'start_inclusive': None, 'end_inclusive': None, 'timezone': None, 'sort': None, 'limit_per_asset': None}\n[DEBUG] 2023-01-09 11:01:02,387 - Response status code: 200 for url: https://api.coinmetrics.io/v4/timeseries/asset-metrics?api_key=[REDACTED]&assets=btc%2Calgo%2Ceth&metrics=ReferenceRateUSD&paging_from=start took: 0:00:00.342874 response body size (bytes): 9832\n[DEBUG] 2023-01-09 11:01:02,388 - Attempting to call url: timeseries/asset-metrics with params: {'assets': ['btc', 'algo', 'eth'], 'metrics': ['ReferenceRateUSD'], 'frequency': None, 'page_size': None, 'paging_from': 'start', 'start_time': None, 'end_time': None, 'start_height': None, 'end_height': None, 'start_inclusive': None, 'end_inclusive': None, 'timezone': None, 'sort': None, 'limit_per_asset': None, 'next_page_token': '0.MjAxOS0wOS0zMFQwMDowMDowMFo'}\n[DEBUG] 2023-01-09 11:01:02,559 - Response status code: 200 for url: https://api.coinmetrics.io/v4/timeseries/asset-metrics?api_key=[REDACTED]&assets=btc%2Calgo%2Ceth&metrics=ReferenceRateUSD&paging_from=start&next_page_token=0.MjAxOS0wOS0zMFQwMDowMDowMFo took: 0:00:00.171487 response body size (bytes): 9857\n
      Then it can be easier to understand what network calls the API Client is making, and where any issues may exist. If you wish to dig even deeper, you may consider modifying the _send_request() method of the API Client to log additional data about the state of your environment, or anything else that would help diagnose issues. You will notice a log file generated in the format cm_api_client_debug_2023_01_09_11_01_02.txt. This log file might be helpful for your own use or to give more context if you are working with Coin Metrics customer success.

      "},{"location":"index.html#ssl-certs-verification","title":"SSL Certs verification","text":"

      Sometimes your organization network have special rules on SSL certs verification and in this case you might face the following error when running the script: 

      SSLError: HTTPSConnectionPool(host='api.coinmetrics.io', port=443): Max retries exceeded with url: <some_url_path> (Caused by SSLError(SSLCertVerificationError(1, '[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: self signed certificate in certificate chain (_ssl.c:1123)')))\n

      In this case, you can pass an option during client initialization to disable ssl verification for requests like this:

      client = CoinMetricsClient(verify_ssl_certs=False)\n

      We don't recommend setting it to False by default and you should make sure you understand the security risks of disabling SSL certs verification.

      Additionally, you may choose to specify the path to the SSL certificates on your machine. This may cause errors where Python is unable to locate the certificates on your machine, particularly when using Python virtual environments. 

      from coinmetrics.api_client import CoinMetricsClient\nSSL_CERT_LOCATION = '/Users/<USER_NAME>/Library/Python/3.8/lib/python/site-packages/certifi/cacert.pem'\nclient = CoinMetricsClient(verify_ssl_certs=SSL_CERT_LOCATION)\n

      A quick way to find the certs on your machine is: python3 -c \"import requests; print(requests.certs.where())\" And note that this will change based on whether or not you are using a Python virtual environment or not

      "},{"location":"index.html#installing-and-running-coinmetrics-package-and-other-python-packages-behind-a-secure-python-network","title":"Installing and running coinmetrics package and other python packages behind a secure python network","text":"

      Related to SSL Certs verification, you may have trouble installing and updating PyPi packages to your local environment. So you may need to choose the best solution for your company and environment - either using package managers or installing offline.

      "},{"location":"index.html#installing-using-package-managers","title":"Installing using package managers","text":"

      Full instructions for setting up your environment to use conda, pip, yarn, npm, etc. can be found here. Additionally, a workaround to disable SSL verification when installing a trusted Python package is this: 

      pip install --trusted-host pypi.python.org <packagename>\n
      Although it is important to make sure you understand the risks associated with disabling SSL verification and ensure compliance with company policies.

      "},{"location":"index.html#installing-python-packages-locally-offline","title":"Installing Python packages locally/ offline","text":"

      It may be easier to download and install the package locally. Steps: 1. Download the files for the Coin Metrics API Client from PyPi 2. Install it locally

      "},{"location":"index.html#requests-proxy","title":"Requests Proxy","text":"

      Sometimes your organization has special rules on making requests to third parties and you have to use proxies in order to comply with the rules.

      For proxies that don't require auth you can specify them similar to this example: 

      client = CoinMetricsClient(proxy_url=f'http://<hostname>:<port>')\n

      For proxies that require auth, you should be able to specify username and password similar to this example: 

      client = CoinMetricsClient(proxy_url=f'http://<username>:<password>@<hostname>:<port>')\n

      "},{"location":"index.html#extended-documentation","title":"Extended documentation","text":"

      For more information about the available methods in the client please reference API Client Spec

      "},{"location":"FlatFilesExport.html","title":"Flat Files Exporter","text":""},{"location":"FlatFilesExport.html#exporting-flat-files","title":"Exporting flat files","text":"

      Along with the API client we provide a data exporting tool which allow downloading large amount of data as flat files rather than from the API itself. The tool allows users to download daily files over our entire provided history for market trades, market quotes, and market candles.

      "},{"location":"FlatFilesExport.html#authorization-for-flat-files-download","title":"Authorization for flat files download","text":"

      This program was set up to easily access a flat files server provided to Coin Metrics commercial clients. If you are a community API user or a client without access to this server, a 403 error will be returned. If you are a community API user and looking to get historical asset prices, Coin Metrics does offer historical asset prices for download. The CoinMetricsDataExporter class will return a CoinMetricsUnauthorizedException if your API key is not authorized to access this server. The flat files export is considered a separate product from the Coin Metrics API, if you would like to gain access or believe you should have access but do not, please contact coinmetrics support.

      "},{"location":"FlatFilesExport.html#installation-and-set-up","title":"Installation and set up","text":"

      The tool is installed a long with the coinmetrics-api-client, it's recommended to create a new Python [virtual environment] for your project and install the package: 

      python -m venv .venv \nsource .venv/bin/activate \npip install coinmetrics-api-client\n

      The export tool requires access to a CoinMetrics API key, and is accessed with the environment variable CM_API_KEY, the easiest way to set this is to run export CM_API_KEY=<API_KEY> in your terminal on MacOS/Linux or just set CM_API_KEY=<API_KEY> on Windows. Additionally, you have the option of passing it in which each command instead.

      To confirm the tool is installed correct execute the command coinmetrics export --help which brings up relevant documentation. At the bottom of the help message all the available commands are shown: 

      Commands:\n  get-asset-pairs\n  get-exchanges\n  market-candles-future  Used to export data related to future market...\n  market-candles-spot    Used to export data related to spot market candles.\n  market-quotes-future   Used to export data related to future market...\n  market-quotes-spot     Used to export data related to spot market quotes...\n  market-trades-future   Used to export data related to future market...\n  market-trades-spot     Used to export data related to spot market trades.\n

      "},{"location":"FlatFilesExport.html#exporting-market-trades-files","title":"Exporting Market Trades Files","text":"

      Further documentation is available on any of the commands by running coinmetrics export <command> --help, for example running coinmetrics export market-trades-spot --help prints: 

      Usage: coinmetrics export market-trades-spot [OPTIONS] EXCHANGES [START_DATE]:\n                                             [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m\n                                             -%d %H:%M:%S] [END_DATE]:[%Y-%m-%\n                                             d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d\n                                             %H:%M:%S]\n\n  Used to export data related to spot market trades. Format: coinmetrics\n  export market-trades-spot <exchanges> <start_date> <end_date> Example:\n  coinmetrics export market-trades-spot coinbase,binance 2022-01-01\n  2022-01-03.\n\nArguments:\n  EXCHANGES                       Pass in arguments as a list of strings\n                                  separated by by commas i.e.\n                                  binance,coinbase,bitmex  [required]\n\n  [START_DATE]:[%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]\n                                  [default: 2022-08-10]\n  [END_DATE]:[%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]\n                                  [default: 2022-08-10]\n\nOptions:\n  --output-format TEXT        [default: json.gz]\n  --threaded / --no-threaded  [default: False]\n  --api-key TEXT\n  --help                      Show this message and exit.\n

      "},{"location":"FlatFilesExport.html#example","title":"Example:","text":"

      If you want to get the flat files for spot-market-trades from coinbase and binance for the first 5 days of June 2022: coinmetrics export market-trades-spot binance,coinbase 2022-06-01 2022-06-05

      In your current directory you will see: 

      market-trades-spot\n\u251c\u2500\u2500 binance\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 2022-06-01.json.gz\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 2022-06-02.json.gz\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 2022-06-03.json.gz\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 2022-06-04.json.gz\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 2022-06-05.json.gz\n\u2514\u2500\u2500 coinbase\n    \u251c\u2500\u2500 2022-06-01.json.gz\n    \u251c\u2500\u2500 2022-06-02.json.gz\n    \u251c\u2500\u2500 2022-06-03.json.gz\n    \u251c\u2500\u2500 2022-06-04.json.gz\n    \u2514\u2500\u2500 2022-06-05.json.gz\n
      By default the files are downloaded as gzipped json files - they are compressed in order to take up less space. If you instead wish to download the data as a csv or json you can use: coinmetrics export market-trades-spot binance,coinbase 2022-06-01 2022-06-05 --output-format csv

      The functionality for getting future, rather than spot market trades is the exact same, just replace market-trades-spot with market-trades-future

      In order to figure out what exchanges are supported for a flat file type you can run coinmetrics export get-exchanges <command>, so in this case running coinmetrics export get-exchanges market-trades-spot

      "},{"location":"FlatFilesExport.html#exporting-market-quotes","title":"Exporting market quotes","text":"

      Market quotes are similar to market trades, except data is separated by exchange and by asset-pair. So you must provide both what exchanges you are querying as well the specific asset pairs.

      Example if you wanted to export files to market quotes for ETHUSDT and BTCUSDT over a certain timeframe as json files: coinmetrics export market-quotes-spot binance ETHUSDT,BTCUSDT 2022-03-03 2022-03-05 --output-format json

      In order to find what asset pairs are availible you can query this information with coinmetrics export get-asset-pairs <command> <exchange> so in this case, for Binance you would run coinmetrics export get-asset-pairs market-quotes-spot binance. If you are comfortable with command line tools it may be helpful to string this with unix command line tools like grep. For example, to find all the BTC related pairs for binance you might run coinmetrics export get-asset-pairs market-quotes-spot binance | grep BTC.

      The functionality is the same for market-qutoes-futures.

      "},{"location":"FlatFilesExport.html#exporting-market-candles","title":"Exporting market candles","text":"

      Exporting market candles also functions similar to market trades, however you must specify a frequency in addition to an exchange and date range. The frequency denominates the range which the market candles cover. These frequencies are currently \"1m\", \"5m\", \"10m\", \"15m\", \"30m\", \"1h\", and \"1d\".

      Example to download 5m spot market candles for coinbase and binance for a date range: coinmetrics export market-candles-spot 5m coinbase,binance 2022-01-01 2022-01-05 Which creates these files: 

      market-candles-spot-5m\n\u251c\u2500\u2500 binance\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 2022-01-01.json.gz\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 2022-01-02.json.gz\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 2022-01-03.json.gz\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 2022-01-04.json.gz\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 2022-01-05.json.gz\n\u2514\u2500\u2500 coinbase\n    \u251c\u2500\u2500 2022-01-01.json.gz\n    \u251c\u2500\u2500 2022-01-02.json.gz\n    \u251c\u2500\u2500 2022-01-03.json.gz\n    \u251c\u2500\u2500 2022-01-04.json.gz\n    \u2514\u2500\u2500 2022-01-05.json.gz\n

      The functionality is the same for market-candles-future

      "},{"location":"FlatFilesExport.html#using-api-key-without-setting-an-environment-variable","title":"Using API Key without setting an environment variable","text":"

      If you don't wish to put your CoinMetrics API key in your environment, you may also pass it in with any command with the flag --api-key. Example: coinmetrics export market-candles-spot 5m coinbase,binance 2022-01-01 2022-01-05 --api-key <API_KEY>

      "},{"location":"FlatFilesExport.html#downloading-files-in-parallel","title":"Downloading files in parallel","text":"

      If you are downloading many files and want to speed the process up there is an option to concurrently download multiple rather than one at a time, using the --threaded flag. Example: coinmetrics export market-candles-spot 5m coinbase,binance 2022-01-01 2022-01-05 --threaded Note that using this option will consume more system resources and network bandwith, and the download speed will still be limited by egress from the files server as well as the specs of your machine.

      "},{"location":"FlatFilesExport.html#using-the-coinmetricsdataexporter-in-python-instead-of-cli","title":"Using the CoinMetricsDataExporter in Python instead of CLI","text":"

      Depending on the use case it might be more convenient to use the CoinMetricsDataExporter directly in Python rather than from the CLI. There is several examples here as well as one below: 

      from coinmetrics.data_exporter import CoinMetricsDataExporter\nfrom datetime import datetime\n\nCM_API_KEY = \"<YOUR_API_KEY>\"\ndata_exporter = CoinMetricsDataExporter(api_key=CM_API_KEY)\n\nif __name__ == \"__main__\":\n\"\"\"\n    This script will export all the daily market-trades-spot files for Coinbase and Gemini for the month of January  \n    \"\"\"\n    start_date = datetime(2019, 1, 1)\n    end_date = datetime(2019, 1, 31)\n    exchanges = [\"coinbase\",\"gemini\"]\n    data_exporter.export_market_trades_spot_data(start_date=start_date, end_date=end_date, exchanges=exchanges, threaded=True)\n

      "},{"location":"api_client.html","title":"API Client Spec","text":""},{"location":"api_client.html#coinmetricsapi_client","title":"coinmetrics.api_client","text":""},{"location":"api_client.html#coinmetricsclient-objects","title":"CoinMetricsClient Objects","text":"
      class CoinMetricsClient()\n
      "},{"location":"api_client.html#catalog_assets","title":"catalog_assets","text":"
      def catalog_assets(\n        assets: Optional[Union[List[str], str]] = None,\n        include: Optional[Union[List[str], str]] = None,\n        exclude: Optional[Union[List[str], str]] = None) -> CatalogAssetsData\n

      Returns meta information about available assets.

      Arguments:

      • assets (list(str), str): A single asset or a list of assets to return info for. If no assets provided, all available assets are returned.
      • include (list(str), str): list of fields to include in response. Supported values are metrics, markets, exchanges. Included by default if omitted.
      • exclude (list(str), str): list of fields to include in response. Supported values are metrics, markets, exchanges. Included by default if omitted.

      Returns:

      list(dict(str, any)): Information that is available for requested assets, like: Full name, metrics and available frequencies, markets, exchanges, etc.

      "},{"location":"api_client.html#catalog_asset_alerts","title":"catalog_asset_alerts","text":"
      def catalog_asset_alerts(\n        assets: Optional[Union[str, List[str]]] = None,\n        alerts: Optional[Union[str,\n                               List[str]]] = None) -> CatalogAssetAlertsData\n

      Arguments:

      • assets (Union[str, List[str]]): Comma separated list of assets. By default all assets are returned.
      • alerts (Union[str, List[str]]): Comma separated list of asset alert names. By default all asset alerts are returned.

      Returns:

      CatalogAssetAlertsData: List of asset alerts.

      "},{"location":"api_client.html#catalog_asset_chains","title":"catalog_asset_chains","text":"
      def catalog_asset_chains(\n        assets: Optional[Union[str,\n                               List[str]]] = None) -> CatalogAssetChainsData\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.

      Returns:

      CatalogAssetChainsData: List of asset chains assets

      "},{"location":"api_client.html#catalog_mempool_feerates","title":"catalog_mempool_feerates","text":"
      def catalog_mempool_feerates(\n    assets: Optional[Union[str,\n                           List[str]]] = None) -> CatalogMempoolFeeratesData\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.

      Returns:

      CatalogMempoolFeeratesData: List of mempool feerates assets

      "},{"location":"api_client.html#catalog_mining_pool_tips_summaries","title":"catalog_mining_pool_tips_summaries","text":"
      def catalog_mining_pool_tips_summaries(\n    assets: Optional[Union[str,\n                           List[str]]] = None) -> CatalogMiningPoolTipsData\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.

      Returns:

      CatalogMiningPoolTipsData: List of mining pool tips assets

      "},{"location":"api_client.html#catalog_transaction_tracker_assets","title":"catalog_transaction_tracker_assets","text":"
      def catalog_transaction_tracker_assets(\n    assets: Optional[Union[str, List[str]]] = None\n) -> CatalogTransactionTrackerData\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.

      Returns:

      CatalogTransactionTrackerData: List of transaction tracker assets

      "},{"location":"api_client.html#catalog_asset_pairs","title":"catalog_asset_pairs","text":"
      def catalog_asset_pairs(\n    asset_pairs: Optional[Union[List[str],\n                                str]] = None) -> CatalogAssetPairsData\n

      Returns meta information about available asset-asset pairs

      Arguments:

      • asset_pairs (list(str), str): A single asset-asset pair (e.g. \"btc-eth\") or a list of asset-asset pairs to return info for. If none are provided, all available pairs are returned.

      Returns:

      list(dict(str, any)): Information that is available for requested asset-asset pair like metrics and their respective frequencies and time ranges

      "},{"location":"api_client.html#catalog_asset_metrics","title":"catalog_asset_metrics","text":"
      def catalog_asset_metrics(\n        metrics: Optional[Union[List[str], str]] = None,\n        reviewable: Optional[bool] = None) -> CatalogMetricsData\n

      Returns list of available asset metrics along with information for them like

      description, category, precision and assets for which a metric is available.

      Arguments:

      • metrics (list(str), str): A single asset metric name or a list of metrics to return info for. If no metrics provided, all available metrics are returned.
      • reviewable (bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.

      Returns:

      list(dict(str, any)): Information about asset metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is available.

      "},{"location":"api_client.html#catalog_exchange_metrics","title":"catalog_exchange_metrics","text":"
      def catalog_exchange_metrics(\n        metrics: Optional[Union[List[str], str]] = None,\n        reviewable: Optional[bool] = None) -> CatalogMetricsData\n

      Returns list of available exchange metrics along with information for them like

      description, category, precision and assets for which a metric is available.

      Arguments:

      • metrics (list(str), str): A single exchange metric name or a list of metrics to return info for. If no metrics provided, all available metrics are returned.
      • reviewable (bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.

      Returns:

      list(dict(str, any)): Information about exchange metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is available.

      "},{"location":"api_client.html#catalog_exchange_asset_metrics","title":"catalog_exchange_asset_metrics","text":"
      def catalog_exchange_asset_metrics(\n        metrics: Optional[Union[List[str], str]] = None,\n        reviewable: Optional[bool] = None) -> CatalogExchangeAssetMetricsData\n

      Returns list of available exchange metrics along with information for them like

      description, category, precision and assets for which a metric is available.

      Arguments:

      • metrics (list(str), str): A single exchange metric name or a list of metrics to return info for. If no metrics provided, all available metrics are returned.
      • reviewable (bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.

      Returns:

      list(dict(str, any)): Information about exchange metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is available.

      "},{"location":"api_client.html#catalog_pair_metrics","title":"catalog_pair_metrics","text":"
      def catalog_pair_metrics(\n        metrics: Optional[Union[List[str], str]] = None,\n        reviewable: Optional[bool] = None) -> CatalogPairMetricsData\n

      Returns list of available pair metrics along with information for them like

      description, category, precision and assets for which a metric is available.

      Arguments:

      • metrics (list(str), str): A single pair metric name or a list of metrics to return info for. If no metrics provided, all available metrics are returned.
      • reviewable (bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.

      Returns:

      list(dict(str, any)): Information about pair metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is available.

      "},{"location":"api_client.html#catalog_institution_metrics","title":"catalog_institution_metrics","text":"
      def catalog_institution_metrics(\n        metrics: Optional[Union[List[str], str]] = None,\n        reviewable: Optional[bool] = None) -> CatalogInstitutionMetricsData\n

      Returns list of available institution metrics along with information for them like

      description, category, precision and assets for which a metric is available.

      Arguments:

      • metrics (list(str), str): A single institution metric name or a list of metrics to return info for. If no metrics provided, all available metrics are returned.
      • reviewable (bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.

      Returns:

      list(dict(str, any)): Information about institution metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is available.

      "},{"location":"api_client.html#catalog_asset_pair_candles","title":"catalog_asset_pair_candles","text":"
      def catalog_asset_pair_candles(\n    asset_pairs: Optional[Union[List[str], str]] = None\n) -> CatalogAssetPairCandlesData\n

      Returns meta information about available asset-asset pairs

      Arguments:

      • asset_pairs (list(str), str): A single asset-asset pair (e.g. \"btc-eth\") or a list of asset-asset pairs to return info for. If none are provided, all available pairs are returned.

      Returns:

      list(dict(str, any)): Returns a list of available asset pair candles along with the time ranges of available data per candle duration.

      "},{"location":"api_client.html#catalog_exchanges","title":"catalog_exchanges","text":"
      def catalog_exchanges(\n        exchanges: Optional[Union[List[str],\n                                  str]] = None) -> CatalogExchangesData\n

      Returns meta information about exchanges.

      Arguments:

      • exchanges (list(str), str): A single exchange name or a list of exchanges to return info for. If no exchanges provided, all available exchanges are returned.

      Returns:

      list(dict(str, any)): Information that is available for requested exchanges, like: markets, min and max time available.

      "},{"location":"api_client.html#catalog_exchange_assets","title":"catalog_exchange_assets","text":"
      def catalog_exchange_assets(\n    exchange_assets: Optional[Union[List[str], str]] = None\n) -> CatalogExchangeAssetsData\n

      Returns meta information about available exchange-asset pairs

      Arguments:

      • exchange_assets (list(str), str): A single exchange-asset pair (e.g. \"binance-btc\") or a list of exchange-asset pairs to return info for. If none are provided, all available pairs are returned.

      Returns:

      list(dict(str, any)): Information that is available for requested exchange-asset pair like metrics and their respective frequencies and time ranges

      "},{"location":"api_client.html#catalog_indexes","title":"catalog_indexes","text":"
      def catalog_indexes(\n        indexes: Optional[Union[List[str], str]] = None) -> CatalogIndexesData\n

      Returns meta information about available indexes.

      Arguments:

      • indexes (list(str), str): A single index name or a list of indexes to return info for. If no indexes provided, all available indexes are returned.

      Returns:

      list(dict(str, any)): Information that is available for requested indexes, like: Full name, and available frequencies.

      "},{"location":"api_client.html#catalog_index_candles","title":"catalog_index_candles","text":"
      def catalog_index_candles(\n    indexes: Optional[Union[List[str],\n                            str]] = None) -> CatalogMarketCandlesData\n

      Returns meta information about available index candles.

      Arguments:

      • indexes (list(str), str): A single index name or a list of indexes to return info for. If no indexes provided, all available index candles are returned.

      Returns:

      list(dict(str, any)): Information that is available for requested index candles, like: Full name, and available frequencies.

      "},{"location":"api_client.html#catalog_institutions","title":"catalog_institutions","text":"
      def catalog_institutions(\n    institutions: Optional[Union[List[str], str]] = None\n) -> CatalogInstitutionsData\n

      Returns meta information about available institutions

      Arguments:

      • institutions (list(str), str): A single institution (e.g. \"grayscale\") or a list of institutions to return info for. If none are provided, all available pairs are returned.

      Returns:

      list(dict(str, any)): Information that is available for requested institution like metrics and their respective frequencies and time ranges.

      "},{"location":"api_client.html#catalog_markets","title":"catalog_markets","text":"
      def catalog_markets(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        include: Optional[Union[List[str], str]] = None,\n        exclude: Optional[Union[List[str], str]] = None) -> CatalogMarketsData\n

      Returns list of available markets that correspond to a filter. If no filter is set, returns all available assets.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.
      • include (list(str), str): list of fields to include in response. Supported values are trades, orderbooks, quotes, funding_rates, openinterest, liquidations. Included by default if omitted.
      • exclude (list(str), str): list of fields to exclude from response. Supported values are trades, orderbooks, quotes, funding_rates, openinterest, liquidations. Included by default if omitted.

      Returns:

      list(dict(str, any)): Information about markets that correspond to a filter along with meta information like: type of market and min and max available time frames.

      "},{"location":"api_client.html#catalog_market_trades","title":"catalog_market_trades","text":"
      def catalog_market_trades(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of markets with trades support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about market trades that are available for the provided filter, as well as the time frames they are available

      "},{"location":"api_client.html#catalog_metrics","title":"catalog_metrics","text":"
      def catalog_metrics(metrics: Optional[Union[List[str], str]] = None,\n                    reviewable: Optional[bool] = None) -> CatalogMetricsData\n

      Returns list of available metrics along with information for them like

      description, category, precision and assets for which a metric is available.

      Arguments:

      • metrics (list(str), str): A single metric name or a list of metrics to return info for. If no metrics provided, all available metrics are returned.
      • reviewable (bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.

      Returns:

      list(dict(str, any)): Information about metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is available.

      "},{"location":"api_client.html#catalog_market_metrics","title":"catalog_market_metrics","text":"
      def catalog_market_metrics(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketMetricsData\n

      Returns list of available markets with metrics support along woth time ranges of available data per metric.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about markets that correspond to a filter along with meta information like: type of market and min and max available time frames.

      "},{"location":"api_client.html#catalog_market_candles","title":"catalog_market_candles","text":"
      def catalog_market_candles(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketCandlesData\n

      Returns list of available markets with candles support along woth time ranges of available data per metric.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about markets that correspond to a filter along with meta information like: type of market and min and max available time frames.

      "},{"location":"api_client.html#catalog_market_orderbooks","title":"catalog_market_orderbooks","text":"
      def catalog_market_orderbooks(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketOrderbooksData\n

      Returns a list of markets with orderbooks support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about markets orderbooks that correspond to a filter

      "},{"location":"api_client.html#catalog_market_quotes","title":"catalog_market_quotes","text":"
      def catalog_market_quotes(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of markets with quotes support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about markets quotes that correspond to a filter

      "},{"location":"api_client.html#catalog_market_funding_rates","title":"catalog_market_funding_rates","text":"
      def catalog_market_funding_rates(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of markets with funding rates support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about funding rates that correspond to a filter

      "},{"location":"api_client.html#catalog_market_contract_prices","title":"catalog_market_contract_prices","text":"
      def catalog_market_contract_prices(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        limit: Optional[str] = None) -> CatalogMarketContractPrices\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • limit (Optional[str]): Limit of response items. none means no limit.

      Returns:

      CatalogMarketContractPrices: List of contract prices statistics.

      "},{"location":"api_client.html#catalog_market_implied_volatility","title":"catalog_market_implied_volatility","text":"
      def catalog_market_implied_volatility(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        limit: Optional[str] = None) -> CatalogMarketImpliedVolatility\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • limit (Optional[str]): Limit of response items. none means no limit.

      Returns:

      CatalogMarketImpliedVolatility: List of implied volatility statistics.

      "},{"location":"api_client.html#catalog_market_greeks","title":"catalog_market_greeks","text":"
      def catalog_market_greeks(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of markets with greeks support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about market greeks that correspond to the filter

      "},{"location":"api_client.html#catalog_market_open_interest","title":"catalog_market_open_interest","text":"
      def catalog_market_open_interest(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of markets with open interest support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about market open interest that correspond to a filter

      "},{"location":"api_client.html#catalog_market_liquidations","title":"catalog_market_liquidations","text":"
      def catalog_market_liquidations(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of markets with liquidations support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about market liquidations that correspond to a filter

      "},{"location":"api_client.html#catalog_full_assets","title":"catalog_full_assets","text":"
      def catalog_full_assets(\n        assets: Optional[Union[List[str], str]] = None,\n        include: Optional[Union[List[str], str]] = None,\n        exclude: Optional[Union[List[str], str]] = None) -> CatalogAssetsData\n

      Returns meta information about supported assets.

      Arguments:

      • assets (list(str), str): A single asset or a list of assets to return info for. If no assets provided, all supported assets are returned.
      • include (list(str), str): list of fields to include in response. Supported values are metrics, markets, exchanges. Included by default if omitted.
      • exclude (list(str), str): list of fields to exclude from response. Supported values are metrics, markets, exchanges. Included by default if omitted.

      Returns:

      list(dict(str, any)): Information that is supported for requested assets, like: Full name, metrics and supported frequencies, markets, exchanges, etc.

      "},{"location":"api_client.html#catalog_full_asset_metrics","title":"catalog_full_asset_metrics","text":"
      def catalog_full_asset_metrics(\n        metrics: Optional[Union[List[str], str]] = None,\n        reviewable: Optional[bool] = None) -> CatalogMetricsData\n

      Returns list of all available asset metrics along with information for them like

      description, category, precision and assets for which a metric is available.

      Arguments:

      • metrics (list(str), str): A single asset metric name or a list of metrics to return info for. If no metrics provided, all available metrics are returned.
      • reviewable (bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.

      Returns:

      list(dict(str, any)): Information about asset metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is available.

      "},{"location":"api_client.html#catalog_full_asset_alerts","title":"catalog_full_asset_alerts","text":"
      def catalog_full_asset_alerts(\n        assets: Optional[Union[str, List[str]]] = None,\n        alerts: Optional[Union[str,\n                               List[str]]] = None) -> CatalogAssetAlertsData\n

      Arguments:

      • assets (Union[str, List[str]]): Comma separated list of assets. By default all assets are returned.
      • alerts (Union[str, List[str]]): Comma separated list of asset alert names. By default all asset alerts are returned.

      Returns:

      CatalogAssetAlertsData: List of asset alerts.

      "},{"location":"api_client.html#catalog_full_asset_chains","title":"catalog_full_asset_chains","text":"
      def catalog_full_asset_chains(\n        assets: Optional[Union[str,\n                               List[str]]] = None) -> CatalogAssetChainsData\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.

      Returns:

      CatalogAssetChainsData: List of asset chains assets

      "},{"location":"api_client.html#catalog_full_mempool_feerates","title":"catalog_full_mempool_feerates","text":"
      def catalog_full_mempool_feerates(\n    assets: Optional[Union[str,\n                           List[str]]] = None) -> CatalogMempoolFeeratesData\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.

      Returns:

      CatalogMempoolFeeratesData: List of mempool feerates assets

      "},{"location":"api_client.html#catalog_full_mining_pool_tips_summaries","title":"catalog_full_mining_pool_tips_summaries","text":"
      def catalog_full_mining_pool_tips_summaries(\n    assets: Optional[Union[str,\n                           List[str]]] = None) -> CatalogMiningPoolTipsData\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.

      Returns:

      CatalogMiningPoolTipsData: List of mining pool tips assets

      "},{"location":"api_client.html#catalog_full_transaction_tracker_assets","title":"catalog_full_transaction_tracker_assets","text":"
      def catalog_full_transaction_tracker_assets(\n    assets: Optional[Union[str, List[str]]] = None\n) -> CatalogTransactionTrackerData\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.

      Returns:

      CatalogTransactionTrackerData: List of transaction tracker assets

      "},{"location":"api_client.html#catalog_full_asset_pairs","title":"catalog_full_asset_pairs","text":"
      def catalog_full_asset_pairs(\n    asset_pairs: Optional[Union[List[str],\n                                str]] = None) -> CatalogAssetPairsData\n

      Returns meta information about supported asset-asset pairs

      Arguments:

      • asset_pairs (list(str), str): A single asset-asset pair (e.g. \"btc-eth\") or a list of asset-asset pairs to return info for. If none are provided, all supported pairs are returned.

      Returns:

      list(dict(str, any)): Information that is supported for requested asset-asset pair like metrics and their respective frequencies and time ranges

      "},{"location":"api_client.html#catalog_full_pair_metrics","title":"catalog_full_pair_metrics","text":"
      def catalog_full_pair_metrics(\n        metrics: Optional[Union[List[str], str]] = None,\n        reviewable: Optional[bool] = None) -> CatalogPairMetricsData\n

      Returns list of all available pair metrics along with information for them like

      description, category, precision and assets for which a metric is available.

      Arguments:

      • metrics (list(str), str): A single pair metric name or a list of metrics to return info for. If no metrics provided, all available metrics are returned.
      • reviewable (bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.

      Returns:

      list(dict(str, any)): Information about pair metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is available.

      "},{"location":"api_client.html#catalog_full_institution_metrics","title":"catalog_full_institution_metrics","text":"
      def catalog_full_institution_metrics(\n        metrics: Optional[Union[List[str], str]] = None,\n        reviewable: Optional[bool] = None) -> CatalogInstitutionMetricsData\n

      Returns list of available institution metrics along with information for them like

      description, category, precision and assets for which a metric is available.

      Arguments:

      • metrics (list(str), str): A single institution metric name or a list of metrics to return info for. If no metrics provided, all available metrics are returned.
      • reviewable (bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.

      Returns:

      list(dict(str, any)): Information about institution metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is available.

      "},{"location":"api_client.html#catalog_full_asset_pair_candles","title":"catalog_full_asset_pair_candles","text":"
      def catalog_full_asset_pair_candles(\n    asset_pairs: Optional[Union[List[str], str]] = None\n) -> CatalogAssetPairCandlesData\n

      Returns meta information about available asset-asset pairs

      Arguments:

      • asset_pairs (list(str), str): A single asset-asset pair (e.g. \"btc-eth\") or a list of asset-asset pairs to return info for. If none are provided, all available pairs are returned.

      Returns:

      list(dict(str, any)): Returns a list of available asset pair candles along with the time ranges of available data per candle duration.

      "},{"location":"api_client.html#catalog_full_exchanges","title":"catalog_full_exchanges","text":"
      def catalog_full_exchanges(\n        exchanges: Optional[Union[List[str],\n                                  str]] = None) -> CatalogExchangesData\n

      Returns meta information about exchanges.

      Arguments:

      • exchanges (list(str), str): A single exchange name or a list of exchanges to return info for. If no exchanges provided, all supported exchanges are returned.

      Returns:

      list(dict(str, any)): Information that is supported for requested exchanges, like: markets, min and max time supported.

      "},{"location":"api_client.html#catalog_full_exchange_assets","title":"catalog_full_exchange_assets","text":"
      def catalog_full_exchange_assets(\n    exchange_assets: Optional[Union[List[str], str]] = None\n) -> CatalogExchangeAssetsData\n

      Returns meta information about supported exchange-asset pairs

      Arguments:

      • exchange_assets (list(str), str): A single exchange-asset pair (e.g. \"binance-btc\") or a list of exchange-asset pairs to return info for. If none are provided, all supported pairs are returned.

      Returns:

      list(dict(str, any)): Information that is supported for requested exchange-asset pair like metrics and their respective frequencies and time ranges

      "},{"location":"api_client.html#catalog_full_exchange_metrics","title":"catalog_full_exchange_metrics","text":"
      def catalog_full_exchange_metrics(\n        metrics: Optional[Union[List[str], str]] = None,\n        reviewable: Optional[bool] = None) -> CatalogMetricsData\n

      Returns list of all available exchange metrics along with information for them like

      description, category, precision and assets for which a metric is available.

      Arguments:

      • metrics (list(str), str): A single exchange metric name or a list of metrics to return info for. If no metrics provided, all available metrics are returned.
      • reviewable (bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.

      Returns:

      list(dict(str, any)): Information about exchange metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is available.

      "},{"location":"api_client.html#catalog_full_exchange_asset_metrics","title":"catalog_full_exchange_asset_metrics","text":"
      def catalog_full_exchange_asset_metrics(\n        metrics: Optional[Union[List[str], str]] = None,\n        reviewable: Optional[bool] = None) -> CatalogExchangeAssetMetricsData\n

      Returns list of available exchange metrics along with information for them like

      description, category, precision and assets for which a metric is available.

      Arguments:

      • metrics (list(str), str): A single exchange metric name or a list of metrics to return info for. If no metrics provided, all available metrics are returned.
      • reviewable (bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.

      Returns:

      list(dict(str, any)): Information about exchange metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is available.

      "},{"location":"api_client.html#catalog_full_indexes","title":"catalog_full_indexes","text":"
      def catalog_full_indexes(\n        indexes: Optional[Union[List[str], str]] = None) -> CatalogIndexesData\n

      Returns meta information about supported indexes.

      Arguments:

      • indexes (list(str), str): A single index name or a list of indexes to return info for. If no indexes provided, all supported indexes are returned.

      Returns:

      list(dict(str, any)): Information that is supported for requested indexes, like: Full name, and supported frequencies.

      "},{"location":"api_client.html#catalog_full_index_candles","title":"catalog_full_index_candles","text":"
      def catalog_full_index_candles(\n    indexes: Optional[Union[List[str],\n                            str]] = None) -> CatalogMarketCandlesData\n

      Returns meta information about supported index candles.

      Arguments:

      • indexes (list(str), str): A single index name or a list of indexes to return info for. If no indexes provided, all supported indexes are returned.

      Returns:

      list(dict(str, any)): Information that is supported for requested index candles, like: Full name, and supported frequencies.

      "},{"location":"api_client.html#catalog_full_institutions","title":"catalog_full_institutions","text":"
      def catalog_full_institutions(\n    institutions: Optional[Union[List[str], str]] = None\n) -> CatalogInstitutionsData\n

      Returns meta information about supported institutions

      Arguments:

      • institutions (list(str), str): A single institution (e.g. \"grayscale\") or a list of institutions to return info for. If none are provided, all supported pairs are returned.

      Returns:

      list(dict(str, any)): Information that is supported for requested institution like metrics and their respective frequencies and time ranges.

      "},{"location":"api_client.html#catalog_full_markets","title":"catalog_full_markets","text":"
      def catalog_full_markets(markets: Optional[Union[List[str], str]] = None,\n                         market_type: Optional[str] = None,\n                         exchange: Optional[str] = None,\n                         base: Optional[str] = None,\n                         quote: Optional[str] = None,\n                         asset: Optional[str] = None,\n                         symbol: Optional[str] = None,\n                         include: Optional[str] = None,\n                         exclude: Optional[str] = None) -> CatalogMarketsData\n

      Returns list of supported markets that correspond to a filter. If no filter is set, returns all supported assets.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.
      • include (list(str), str): ist of fields to include in response. Supported values are trades, orderbooks, quotes, funding_rates, openinterest, liquidations. Included by default if omitted.
      • exclude (list(str), str): list of fields to exclude from response. Supported values are trades, orderbooks, quotes, funding_rates, openinterest, liquidations. Included by default if omitted.

      Returns:

      list(dict(str, any)): Information about markets that correspond to a filter along with meta information like: type of market and min and max supported time frames.

      "},{"location":"api_client.html#catalog_full_market_trades","title":"catalog_full_market_trades","text":"
      def catalog_full_market_trades(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of all markets with trades support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about market trades that are available for the provided filter, as well as the time frames they are available

      "},{"location":"api_client.html#catalog_full_metrics","title":"catalog_full_metrics","text":"
      def catalog_full_metrics(\n        metrics: Optional[Union[List[str], str]] = None,\n        reviewable: Optional[bool] = None) -> CatalogMetricsData\n

      Returns list of supported metrics along with information for them like

      description, category, precision and assets for which a metric is supported.

      Arguments:

      • metrics (list(str), str): A single metric name or a list of metrics to return info for. If no metrics provided, all supported metrics are returned.
      • reviewable (bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.

      Returns:

      list(dict(str, any)): Information about metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is supported.

      "},{"location":"api_client.html#catalog_full_market_metrics","title":"catalog_full_market_metrics","text":"
      def catalog_full_market_metrics(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketMetricsData\n

      Returns list of supported markets with metrics support along woth time ranges of available data per metric.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about markets that correspond to a filter along with meta information like: type of market and min and max available time frames.

      "},{"location":"api_client.html#catalog_full_market_candles","title":"catalog_full_market_candles","text":"
      def catalog_full_market_candles(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketCandlesData\n

      Returns list of available markets with candles support along woth time ranges of available data per metric.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about markets that correspond to a filter along with meta information like: type of market and min and max available time frames.

      "},{"location":"api_client.html#catalog_full_market_orderbooks","title":"catalog_full_market_orderbooks","text":"
      def catalog_full_market_orderbooks(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of markets with orderbooks support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about markets orderbooks that correspond to a filter

      "},{"location":"api_client.html#catalog_full_market_quotes","title":"catalog_full_market_quotes","text":"
      def catalog_full_market_quotes(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of markets with quotes support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about markets quotes that correspond to a filter

      "},{"location":"api_client.html#catalog_full_market_funding_rates","title":"catalog_full_market_funding_rates","text":"
      def catalog_full_market_funding_rates(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of all markets with funding rates support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about funding rates that correspond to a filter

      "},{"location":"api_client.html#catalog_full_market_contract_prices","title":"catalog_full_market_contract_prices","text":"
      def catalog_full_market_contract_prices(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        limit: Optional[str] = None) -> CatalogMarketContractPrices\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • limit (Optional[str]): Limit of response items. none means no limit.

      Returns:

      CatalogMarketContractPrices: List of contract prices statistics.

      "},{"location":"api_client.html#catalog_full_contract_prices_v2","title":"catalog_full_contract_prices_v2","text":"
      def catalog_full_contract_prices_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of contract prices statistics.

      "},{"location":"api_client.html#catalog_full_market_implied_volatility","title":"catalog_full_market_implied_volatility","text":"
      def catalog_full_market_implied_volatility(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        limit: Optional[str] = None) -> CatalogMarketImpliedVolatility\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • limit (Optional[str]): Limit of response items. none means no limit.

      Returns:

      CatalogMarketImpliedVolatility: List of implied volatility statistics.

      "},{"location":"api_client.html#catalog_full_market_greeks","title":"catalog_full_market_greeks","text":"
      def catalog_full_market_greeks(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of all markets with greeks support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about market greeks that correspond to the filter

      "},{"location":"api_client.html#catalog_full_market_open_interest","title":"catalog_full_market_open_interest","text":"
      def catalog_full_market_open_interest(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of markets with open interest support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about market open interest that correspond to a filter

      "},{"location":"api_client.html#catalog_full_market_liquidations","title":"catalog_full_market_liquidations","text":"
      def catalog_full_market_liquidations(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of all markets with liquidations support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about market liquidations that correspond to a filter

      "},{"location":"api_client.html#catalog_market_trades_v2","title":"catalog_market_trades_v2","text":"
      def catalog_market_trades_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market trades statistics.

      "},{"location":"api_client.html#catalog_market_candles_v2","title":"catalog_market_candles_v2","text":"
      def catalog_market_candles_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market candles statistics.

      "},{"location":"api_client.html#catalog_market_orderbooks_v2","title":"catalog_market_orderbooks_v2","text":"
      def catalog_market_orderbooks_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market orderbooks statistics.

      "},{"location":"api_client.html#catalog_market_quotes_v2","title":"catalog_market_quotes_v2","text":"
      def catalog_market_quotes_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market quotes statistics.

      "},{"location":"api_client.html#catalog_market_funding_rates_v2","title":"catalog_market_funding_rates_v2","text":"
      def catalog_market_funding_rates_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market funding rates statistics.

      "},{"location":"api_client.html#catalog_market_funding_rates_predicted_v2","title":"catalog_market_funding_rates_predicted_v2","text":"
      def catalog_market_funding_rates_predicted_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market funding rates statistics.

      "},{"location":"api_client.html#catalog_market_contract_prices_v2","title":"catalog_market_contract_prices_v2","text":"
      def catalog_market_contract_prices_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of contract prices statistics.

      "},{"location":"api_client.html#catalog_market_implied_volatility_v2","title":"catalog_market_implied_volatility_v2","text":"
      def catalog_market_implied_volatility_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of implied volatility statistics.

      "},{"location":"api_client.html#catalog_market_greeks_v2","title":"catalog_market_greeks_v2","text":"
      def catalog_market_greeks_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of greeks statistics.

      "},{"location":"api_client.html#catalog_market_open_interest_v2","title":"catalog_market_open_interest_v2","text":"
      def catalog_market_open_interest_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market open interest statistics.

      "},{"location":"api_client.html#catalog_market_liquidations_v2","title":"catalog_market_liquidations_v2","text":"
      def catalog_market_liquidations_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market liquidations statistics.

      "},{"location":"api_client.html#catalog_market_metrics_v2","title":"catalog_market_metrics_v2","text":"
      def catalog_market_metrics_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        metrics: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market metrics statistics.

      "},{"location":"api_client.html#catalog_full_market_trades_v2","title":"catalog_full_market_trades_v2","text":"
      def catalog_full_market_trades_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market trades statistics.

      "},{"location":"api_client.html#catalog_full_market_candles_v2","title":"catalog_full_market_candles_v2","text":"
      def catalog_full_market_candles_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market candles statistics.

      "},{"location":"api_client.html#catalog_full_market_orderbooks_v2","title":"catalog_full_market_orderbooks_v2","text":"
      def catalog_full_market_orderbooks_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market orderbooks statistics.

      "},{"location":"api_client.html#catalog_full_market_quotes_v2","title":"catalog_full_market_quotes_v2","text":"
      def catalog_full_market_quotes_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market quotes statistics.

      "},{"location":"api_client.html#catalog_full_market_funding_rates_v2","title":"catalog_full_market_funding_rates_v2","text":"
      def catalog_full_market_funding_rates_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market funding rates statistics.

      "},{"location":"api_client.html#catalog_full_market_funding_rates_predicted_v2","title":"catalog_full_market_funding_rates_predicted_v2","text":"
      def catalog_full_market_funding_rates_predicted_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market funding rates statistics.

      "},{"location":"api_client.html#catalog_full_market_contract_prices_v2","title":"catalog_full_market_contract_prices_v2","text":"
      def catalog_full_market_contract_prices_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of contract prices statistics.

      "},{"location":"api_client.html#catalog_full_market_implied_volatility_v2","title":"catalog_full_market_implied_volatility_v2","text":"
      def catalog_full_market_implied_volatility_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of implied volatility statistics.

      "},{"location":"api_client.html#catalog_full_market_greeks_v2","title":"catalog_full_market_greeks_v2","text":"
      def catalog_full_market_greeks_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of greeks statistics.

      "},{"location":"api_client.html#catalog_full_market_open_interest_v2","title":"catalog_full_market_open_interest_v2","text":"
      def catalog_full_market_open_interest_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market open interest statistics.

      "},{"location":"api_client.html#catalog_full_market_liquidations_v2","title":"catalog_full_market_liquidations_v2","text":"
      def catalog_full_market_liquidations_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market liquidations statistics.

      "},{"location":"api_client.html#catalog_full_market_metrics_v2","title":"catalog_full_market_metrics_v2","text":"
      def catalog_full_market_metrics_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        metrics: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market metrics statistics.

      "},{"location":"api_client.html#catalog_asset_metrics_v2","title":"catalog_asset_metrics_v2","text":"
      def catalog_asset_metrics_v2(\n        assets: Optional[Union[str, List[str]]] = None,\n        metrics: Optional[Union[str, List[str]]] = None,\n        reviewable: Optional[bool] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None,\n        format: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.
      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • reviewable (Optional[bool]): Limit to human-reviewable metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.

      Returns:

      CatalogV2DataCollection: List of asset metrics.

      "},{"location":"api_client.html#catalog_full_asset_metrics_v2","title":"catalog_full_asset_metrics_v2","text":"
      def catalog_full_asset_metrics_v2(\n        assets: Optional[Union[str, List[str]]] = None,\n        metrics: Optional[Union[str, List[str]]] = None,\n        reviewable: Optional[bool] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None,\n        format: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.
      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • reviewable (Optional[bool]): Limit to human-reviewable metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.

      Returns:

      CatalogV2DataCollection: List of asset metrics.

      "},{"location":"api_client.html#catalog_exchange_metrics_v2","title":"catalog_exchange_metrics_v2","text":"
      def catalog_exchange_metrics_v2(\n        exchanges: Optional[Union[str, List[str]]] = None,\n        metrics: Optional[Union[str, List[str]]] = None,\n        reviewable: Optional[bool] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None,\n        format: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • exchanges (Optional[Union[str, List[str]]]): Comma separated list of exchanges. By default all exchanges are returned.
      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • reviewable (Optional[bool]): Limit to human-reviewable metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.

      Returns:

      CatalogV2DataCollection: List of exchange metrics.

      "},{"location":"api_client.html#catalog_full_exchange_metrics_v2","title":"catalog_full_exchange_metrics_v2","text":"
      def catalog_full_exchange_metrics_v2(\n        exchanges: Optional[Union[str, List[str]]] = None,\n        metrics: Optional[Union[str, List[str]]] = None,\n        reviewable: Optional[bool] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None,\n        format: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • exchanges (Optional[Union[str, List[str]]]): Comma separated list of exchanges. By default all exchanges are returned.
      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • reviewable (Optional[bool]): Limit to human-reviewable metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.

      Returns:

      CatalogV2DataCollection: List of exchange metrics.

      "},{"location":"api_client.html#catalog_exchange_asset_metrics_v2","title":"catalog_exchange_asset_metrics_v2","text":"
      def catalog_exchange_asset_metrics_v2(\n        exchange_assets: Optional[Union[str, List[str]]] = None,\n        metrics: Optional[Union[str, List[str]]] = None,\n        reviewable: Optional[bool] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None,\n        format: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • exchange_assets (Optional[Union[str, List[str]]]): Comma separated list of exchange-assets. By default, all exchange-assets pairs are returned.
      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • reviewable (Optional[bool]): Limit to human-reviewable metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.

      Returns:

      CatalogV2DataCollection: List of exchange-asset metrics.

      "},{"location":"api_client.html#catalog_full_exchange_asset_metrics_v2","title":"catalog_full_exchange_asset_metrics_v2","text":"
      def catalog_full_exchange_asset_metrics_v2(\n        exchange_assets: Optional[Union[str, List[str]]] = None,\n        metrics: Optional[Union[str, List[str]]] = None,\n        reviewable: Optional[bool] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None,\n        format: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • exchange_assets (Optional[Union[str, List[str]]]): Comma separated list of exchange-assets. By default, all exchange-assets pairs are returned.
      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • reviewable (Optional[bool]): Limit to human-reviewable metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.

      Returns:

      CatalogV2DataCollection: List of exchange-asset metrics.

      "},{"location":"api_client.html#catalog_pair_metrics_v2","title":"catalog_pair_metrics_v2","text":"
      def catalog_pair_metrics_v2(\n        pairs: Optional[Union[str, List[str]]] = None,\n        metrics: Optional[Union[str, List[str]]] = None,\n        reviewable: Optional[bool] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None,\n        format: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • pairs (Optional[Union[str, List[str]]]): Comma separated list of asset pairs. By default, all asset pairs are returned.
      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • reviewable (Optional[bool]): Limit to human-reviewable metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.

      Returns:

      CatalogV2DataCollection: List of pair metrics.

      "},{"location":"api_client.html#catalog_full_pair_metrics_v2","title":"catalog_full_pair_metrics_v2","text":"
      def catalog_full_pair_metrics_v2(\n        pairs: Optional[Union[str, List[str]]] = None,\n        metrics: Optional[Union[str, List[str]]] = None,\n        reviewable: Optional[bool] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None,\n        format: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • pairs (Optional[Union[str, List[str]]]): Comma separated list of asset pairs. By default, all asset pairs are returned.
      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • reviewable (Optional[bool]): Limit to human-reviewable metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.

      Returns:

      CatalogV2DataCollection: List of pair metrics.

      "},{"location":"api_client.html#catalog_institution_metrics_v2","title":"catalog_institution_metrics_v2","text":"
      def catalog_institution_metrics_v2(\n        institutions: Optional[Union[str, List[str]]] = None,\n        metrics: Optional[Union[str, List[str]]] = None,\n        reviewable: Optional[bool] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None,\n        format: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • institutions (Optional[Union[str, List[str]]]): Comma separated list of institutions. By default, all institutions are returned.
      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • reviewable (Optional[bool]): Limit to human-reviewable metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.

      Returns:

      CatalogV2DataCollection: List of institution metrics.

      "},{"location":"api_client.html#catalog_full_institution_metrics_v2","title":"catalog_full_institution_metrics_v2","text":"
      def catalog_full_institution_metrics_v2(\n        institutions: Optional[Union[str, List[str]]] = None,\n        metrics: Optional[Union[str, List[str]]] = None,\n        reviewable: Optional[bool] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None,\n        format: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • institutions (Optional[Union[str, List[str]]]): Comma separated list of institutions. By default, all institutions are returned.
      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • reviewable (Optional[bool]): Limit to human-reviewable metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.

      Returns:

      CatalogV2DataCollection: List of institution metrics.

      "},{"location":"api_client.html#catalog_pair_candles_v2","title":"catalog_pair_candles_v2","text":"
      def catalog_pair_candles_v2(\n        pairs: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • pairs (Optional[Union[str, List[str]]]): Comma separated list of asset pairs. By default, all asset pairs are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of asset pair candles statistics.

      "},{"location":"api_client.html#catalog_index_candles_v2","title":"catalog_index_candles_v2","text":"
      def catalog_index_candles_v2(\n        indexes: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • indexes (Optional[Union[str, List[str]]]): Comma separated list of indexes. By default all assets are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of index candles statistics.

      "},{"location":"api_client.html#catalog_index_levels_v2","title":"catalog_index_levels_v2","text":"
      def catalog_index_levels_v2(\n        indexes: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • indexes (Optional[Union[str, List[str]]]): Comma separated list of indexes. By default all indexes are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of index levels.

      "},{"location":"api_client.html#catalog_asset_chains_v2","title":"catalog_asset_chains_v2","text":"
      def catalog_asset_chains_v2(\n        assets: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of asset chains assets

      "},{"location":"api_client.html#catalog_mempool_feerates_v2","title":"catalog_mempool_feerates_v2","text":"
      def catalog_mempool_feerates_v2(\n        assets: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of mempool feerates assets

      "},{"location":"api_client.html#catalog_mining_pool_tips_summaries_v2","title":"catalog_mining_pool_tips_summaries_v2","text":"
      def catalog_mining_pool_tips_summaries_v2(\n        assets: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of mining pool tips assets

      "},{"location":"api_client.html#catalog_transaction_tracker_assets_v2","title":"catalog_transaction_tracker_assets_v2","text":"
      def catalog_transaction_tracker_assets_v2(\n        assets: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of transaction tracker assets

      "},{"location":"api_client.html#catalog_full_pair_candles_v2","title":"catalog_full_pair_candles_v2","text":"
      def catalog_full_pair_candles_v2(\n        pairs: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • pairs (Optional[Union[str, List[str]]]): Comma separated list of asset pairs. By default, all asset pairs are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of asset pair candles statistics.

      "},{"location":"api_client.html#catalog_full_index_candles_v2","title":"catalog_full_index_candles_v2","text":"
      def catalog_full_index_candles_v2(\n        indexes: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • indexes (Optional[Union[str, List[str]]]): Comma separated list of indexes. By default all assets are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of index candles statistics.

      "},{"location":"api_client.html#catalog_full_index_levels_v2","title":"catalog_full_index_levels_v2","text":"
      def catalog_full_index_levels_v2(\n        indexes: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • indexes (Optional[Union[str, List[str]]]): Comma separated list of indexes. By default all indexes are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of index levels.

      "},{"location":"api_client.html#catalog_full_asset_chains_v2","title":"catalog_full_asset_chains_v2","text":"
      def catalog_full_asset_chains_v2(\n        assets: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of asset chains assets

      "},{"location":"api_client.html#catalog_full_mempool_feerates_v2","title":"catalog_full_mempool_feerates_v2","text":"
      def catalog_full_mempool_feerates_v2(\n        assets: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of mempool feerates assets

      "},{"location":"api_client.html#catalog_full_mining_pool_tips_summaries_v2","title":"catalog_full_mining_pool_tips_summaries_v2","text":"
      def catalog_full_mining_pool_tips_summaries_v2(\n        assets: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of mining pool tips assets

      "},{"location":"api_client.html#catalog_full_transaction_tracker_assets_v2","title":"catalog_full_transaction_tracker_assets_v2","text":"
      def catalog_full_transaction_tracker_assets_v2(\n        assets: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of transaction tracker assets

      "},{"location":"api_client.html#get_asset_alerts","title":"get_asset_alerts","text":"
      def get_asset_alerts(\n        assets: Union[List[str], str],\n        alerts: Union[List[str], str],\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        include_heartbeats: Optional[bool] = None) -> DataCollection\n

      Returns asset alerts for the specified assets.

      Arguments:

      • assets (list(str), str): list of asset names, e.g. 'btc'
      • alerts (list(str), str): list of asset alert names
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • include_heartbeats (bool): If set to true, includes information about most recent time asset was successfully evaluated.

      Returns:

      DataCollection: Asset alerts timeseries.

      "},{"location":"api_client.html#get_defi_balance_sheets","title":"get_defi_balance_sheets","text":"
      def get_defi_balance_sheets(defi_protocols: Union[str, List[str]],\n                            page_size: Optional[int] = None,\n                            paging_from: Optional[Union[PagingFrom,\n                                                        str]] = \"start\",\n                            start_time: Optional[Union[datetime, date,\n                                                       str]] = None,\n                            end_time: Optional[Union[datetime, date,\n                                                     str]] = None,\n                            start_height: Optional[int] = None,\n                            end_height: Optional[int] = None,\n                            start_inclusive: Optional[bool] = None,\n                            end_inclusive: Optional[bool] = None,\n                            timezone: Optional[str] = None) -> DataCollection\n

      Returns Defi Balance Sheet records for specified DeFi protocols.

      Arguments:

      • defi_protocols (str, List[str]): list of DeFi protocols like aave_v2_eth or protocol patterns like aave_v2_* or aave_*_eth or *_eth.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_height (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: list of blockchain blocks metadata

      "},{"location":"api_client.html#get_asset_chains","title":"get_asset_chains","text":"
      def get_asset_chains(\n        assets: Union[List[str], str],\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None) -> AssetChainsDataCollection\n

      Returns the chains of blocks for the specified assets.

      Arguments:

      • assets (list(str), str): list of asset names, e.g. 'btc'
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      AssetChainsDataCollection: Asset chains timeseries.

      "},{"location":"api_client.html#get_asset_metrics","title":"get_asset_metrics","text":"
      def get_asset_metrics(\n        assets: Union[List[str], str],\n        metrics: Union[List[str], str],\n        frequency: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_height: Optional[int] = None,\n        end_height: Optional[int] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        sort: Optional[str] = None,\n        limit_per_asset: Optional[int] = None,\n        status: Optional[str] = None,\n        start_hash: Optional[str] = None,\n        end_hash: Optional[str] = None,\n        min_confirmations: Optional[int] = None,\n        null_as_zero: Optional[bool] = None,\n        ignore_forbidden_errors: Optional[bool] = None,\n        ignore_unsupported_errors: Optional[bool] = None) -> DataCollection\n

      Returns requested metrics for specified assets.

      Arguments:

      • assets (list(str), str): list of asset names, e.g. 'btc'
      • metrics (list(str), str): list of asset-specific metric names, e.g. 'PriceUSD'
      • frequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_height (int): Start block of the timeseries (only applicable when querying with frequency 1b).
      • end_height (int): End block of the timeseries (only applicable when querying with frequency 1b).
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • sort (str): How results will be sorted, e.g. \"asset\", \"height\", or \"time\". Default is \"asset\". Metrics with 1b frequency are sorted by (asset, height, block_hash) tuples by default. Metrics with other frequencies are sorted by (asset, time) by default. If you want to sort 1d metrics by (time, asset) you should choose time as value for the sort parameter. Sorting by time is useful if you request metrics for a set of assets.
      • limit_per_asset (int): How many entries per asset the result should contain.
      • status (str): Which metric values do you want to see. Applicable only for \"reviewable\" metrics. You can find them in the /catalog/metrics endpoint. Default: \"all\". Supported: \"all\" \"flash\" \"reviewed\" \"revised\"
      • start_hash (str): The start hash indicates the beginning block height for the set of data that are returned. Inclusive by default. Mutually exclusive with start_time and start_height.
      • end_hash (str): The end hash indicates the ending block height for the set of data that are returned. Inclusive by default. Mutually exclusive with end_time and end_height.
      • min_confirmations (int): Specifies how many blocks behind the chain tip block by block metrics (1b frequency) are based on. Default for btc is 2 and 99 for eth.
      • null_as_zero (bool): Default: false. Nulls are represented as zeros in the response.
      • ignore_forbidden_errors (bool): Default: false. Ignore HTTP 403 Forbidden errors
      • ignore_unsupported_errors (bool): Default: false. Ignore errors for unsupported assets, metrics or frequencies.

      Returns:

      DataCollection: Asset Metrics timeseries.

      "},{"location":"api_client.html#get_exchange_metrics","title":"get_exchange_metrics","text":"
      def get_exchange_metrics(\n        exchanges: Union[List[str], str],\n        metrics: Union[List[str], str],\n        frequency: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_height: Optional[int] = None,\n        end_height: Optional[int] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        sort: Optional[str] = None,\n        limit_per_exchange: Optional[int] = None) -> DataCollection\n

      Returns metrics for specified exchanges.

      Arguments:

      • exchanges (list(str), str): A single exchange name or a list of exchanges to return info for.
      • metrics (list(str), str): list of exchange-specific metric names, e.g. 'open_interest_reported_future_usd'. To find a list of available metrics for a given exchange, call client.catalog_exchanges()
      • frequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_height (int): Start block of the timeseries (only applicable when querying with frequency 1b).
      • end_height (int): End block of the timeseries (only applicable when querying with frequency 1b).
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • sort (str): How results will be sorted, e.g. 'exchange', 'time'. Metrics are sorted by 'exchange' by default.
      • limit_per_exchange (int): How many entries per exchange the result should contain.

      Returns:

      DataCollection: Asset Metrics timeseries.

      "},{"location":"api_client.html#get_exchange_asset_metrics","title":"get_exchange_asset_metrics","text":"
      def get_exchange_asset_metrics(\n        exchange_assets: Union[List[str], str],\n        metrics: Union[List[str], str],\n        frequency: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_height: Optional[int] = None,\n        end_height: Optional[int] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        sort: Optional[str] = None,\n        limit_per_exchange_asset: Optional[int] = None) -> DataCollection\n

      Returns metrics for specified exchange-asset.

      Arguments:

      • exchange_assets (list(str), str): A single exchange-asset pairs (e.g. \"binance-btc\" or a list of exchange-asset-pair to return info for.
      • metrics (list(str), str): list of exchange-specific metric names, e.g. 'open_interest_reported_future_usd'. To find a list of available metrics for a given exchange, call client.catalog_exchanges()
      • frequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_height (int): Start block of the timeseries (only applicable when querying with frequency 1b).
      • end_height (int): End block of the timeseries (only applicable when querying with frequency 1b).
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • sort (str): How results will be sorted, e.g. \"exchange_asset\", \"time\". Default is \"exchange_asset\".
      • limit_per_exchange_asset (int): How many entries per exchange-asset the result should contain.

      Returns:

      DataCollection: Exchange-Asset Metrics timeseries.

      "},{"location":"api_client.html#get_pair_metrics","title":"get_pair_metrics","text":"
      def get_pair_metrics(pairs: Union[List[str], str],\n                     metrics: Union[List[str], str],\n                     frequency: Optional[str] = None,\n                     page_size: Optional[int] = None,\n                     paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n                     start_time: Optional[Union[datetime, date, str]] = None,\n                     end_time: Optional[Union[datetime, date, str]] = None,\n                     start_height: Optional[int] = None,\n                     end_height: Optional[int] = None,\n                     start_inclusive: Optional[bool] = None,\n                     end_inclusive: Optional[bool] = None,\n                     timezone: Optional[str] = None,\n                     sort: Optional[str] = None,\n                     limit_per_pair: Optional[int] = None) -> DataCollection\n

      Returns metrics books for specified asset-asset pairs.

      Arguments:

      • pairs (list(str), str): A single asset-asset pairs (e.g. \"btc-usd\") or a list of asset-asset-pairs to return info for.
      • metrics (list(str), str): list of exchange-specific metric names, e.g. 'open_interest_reported_future_usd'. To find a list of available metrics for a given exchange, call client.catalog_exchanges()
      • frequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_height (int): Start block of the timeseries (only applicable when querying with frequency 1b).
      • end_height (int): End block of the timeseries (only applicable when querying with frequency 1b).
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • sort (str): How results will be sorted, e.g.\"pair\", \"time\". \"pair\" by default
      • limit_per_pair (int): How many entries per asset pair the result should contain.

      Returns:

      DataCollection: Exchange-Asset Metrics timeseries.

      "},{"location":"api_client.html#get_pair_candles","title":"get_pair_candles","text":"
      def get_pair_candles(pairs: Union[List[str], str],\n                     frequency: Optional[str] = None,\n                     page_size: Optional[int] = None,\n                     paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n                     start_time: Optional[Union[datetime, date, str]] = None,\n                     end_time: Optional[Union[datetime, date, str]] = None,\n                     start_height: Optional[int] = None,\n                     end_height: Optional[int] = None,\n                     start_inclusive: Optional[bool] = None,\n                     end_inclusive: Optional[bool] = None,\n                     timezone: Optional[str] = None,\n                     limit_per_pair: Optional[int] = None) -> DataCollection\n

      Returns candles for specified asset pairs.

      Results are ordered by tuple (pair, time).

      Arguments:

      • pairs (list(str), str): A single asset-asset pairs (e.g. \"btc-usd\") or a list of asset-asset-pairs to return info for.
      • frequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_height (int): Start block of the timeseries (only applicable when querying with frequency 1b).
      • end_height (int): End block of the timeseries (only applicable when querying with frequency 1b).
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_pair (int): How many entries per asset pair the result should contain.

      Returns:

      DataCollection: Asset pair candles timeseries.

      "},{"location":"api_client.html#get_institution_metrics","title":"get_institution_metrics","text":"
      def get_institution_metrics(\n        institutions: Union[List[str], str],\n        metrics: Union[List[str], str],\n        frequency: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_height: Optional[int] = None,\n        end_height: Optional[int] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        sort: Optional[str] = None,\n        limit_per_institution: Optional[int] = None) -> DataCollection\n

      Returns metrics for specified institutions.

      Arguments:

      • institutions (list(str), str): A single institution name or a list of institutions to return info for.
      • metrics (list(str), str): list of institution-specific metric names, e.g. 'gbtc_total_assets'
      • frequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_height (int): Start block of the timeseries (only applicable when querying with frequency 1b).
      • end_height (int): End block of the timeseries (only applicable when querying with frequency 1b).
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • sort (str): How results will be sorted, e.g. \"institution\", or \"time\". Default is \"institution\".
      • limit_per_institution (int): How many entries per institution the result should contain.

      Returns:

      DataCollection: Asset Metrics timeseries.

      "},{"location":"api_client.html#get_index_candles","title":"get_index_candles","text":"
      def get_index_candles(indexes: Union[List[str], str],\n                      frequency: Optional[str] = None,\n                      page_size: Optional[int] = None,\n                      paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n                      start_time: Optional[Union[datetime, date, str]] = None,\n                      end_time: Optional[Union[datetime, date, str]] = None,\n                      start_inclusive: Optional[bool] = None,\n                      end_inclusive: Optional[bool] = None,\n                      timezone: Optional[str] = None,\n                      limit_per_index: Optional[int] = None) -> DataCollection\n

      Returns index candles for specified indexes and date range.

      Arguments:

      • indexes (list(str), str): list of index names, e.g. 'CMBI10'
      • frequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_index (int): How many entries per index the result should contain.

      Returns:

      DataCollection: Index Candles timeseries.

      "},{"location":"api_client.html#get_index_levels","title":"get_index_levels","text":"
      def get_index_levels(\n        indexes: Union[List[str], str],\n        frequency: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        limit_per_index: Optional[int] = None,\n        include_verification: Optional[bool] = None) -> DataCollection\n

      Returns index levels for specified indexes and date range.

      Arguments:

      • indexes (list(str), str): list of index names, e.g. 'CMBI10'
      • frequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_index (int): How many entries per index the result should contain.
      • include_verification: Default: False set to true, includes information about verification.

      Returns:

      DataCollection: Index Levels timeseries.

      "},{"location":"api_client.html#get_index_constituents","title":"get_index_constituents","text":"
      def get_index_constituents(indexes: Union[List[str], str],\n                           frequency: Optional[str] = None,\n                           page_size: Optional[int] = None,\n                           paging_from: Optional[Union[PagingFrom,\n                                                       str]] = \"start\",\n                           start_time: Optional[Union[datetime, date,\n                                                      str]] = None,\n                           end_time: Optional[Union[datetime, date,\n                                                    str]] = None,\n                           start_inclusive: Optional[bool] = None,\n                           end_inclusive: Optional[bool] = None,\n                           timezone: Optional[str] = None) -> DataCollection\n

      Returns index constituents for specified indexes and date range.

      Arguments:

      • indexes (list(str), str): list of index names, e.g. 'CMBI10'
      • frequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: Index Constituents timeseries.

      "},{"location":"api_client.html#get_market_metrics","title":"get_market_metrics","text":"
      def get_market_metrics(markets: Union[List[str], str],\n                       metrics: Union[List[str], str],\n                       frequency: Optional[str] = None,\n                       page_size: Optional[int] = None,\n                       paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n                       start_time: Optional[Union[datetime, date, str]] = None,\n                       end_time: Optional[Union[datetime, date, str]] = None,\n                       start_inclusive: Optional[bool] = None,\n                       end_inclusive: Optional[bool] = None,\n                       timezone: Optional[str] = None,\n                       limit_per_market: Optional[int] = None,\n                       sort: Optional[str] = None) -> DataCollection\n

      Returns market metrics for specified markets, frequency and date range.

      For more information on market metrics, see: https://docs.coinmetrics.io/api/v4#operation/getTimeseriesMarketMetrics

      Arguments:

      • markets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future'
      • metrics (list(str), str): list of metrics, i.e. 'liquidations_reported_future_buy_units_1d'. See market metrics catalog for a list of supported metrics: https://docs.coinmetrics.io/api/v4#operation/getCatalogMarketMetrics
      • frequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_market (int): How many entries per market the result should contain.
      • sort (str): How results will be sorted. Metrics are sorted by (market, time) by default. If you want to sort 1d metrics by (time, market) you should choose time as value for the sort parameter. Sorting by time is useful if you request metrics for a set of markets.

      Returns:

      DataCollection: Market Candles timeseries.

      "},{"location":"api_client.html#get_market_candles","title":"get_market_candles","text":"
      def get_market_candles(\n        markets: Union[List[str], str],\n        frequency: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        limit_per_market: Optional[int] = None) -> DataCollection\n

      Returns market candles for specified markets, frequency and date range.

      For more information on market candles, see: https://docs.coinmetrics.io/info/markets/candles

      Arguments:

      • markets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future'
      • frequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_market (int): How many entries per market the result should contain.

      Returns:

      DataCollection: Market Candles timeseries.

      "},{"location":"api_client.html#get_market_trades","title":"get_market_trades","text":"
      def get_market_trades(\n        markets: Union[List[str], str],\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        limit_per_market: Optional[int] = None,\n        min_confirmations: Optional[int] = None) -> DataCollection\n

      Returns market trades for specified markets and date range.

      For more information on market trades, see: https://docs.coinmetrics.io/info/markets/trades

      Arguments:

      • markets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future'
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_market (int): How many entries per market the result should contain.
      • min_confirmations (int): Specifies how many blocks behind the chain tip trades are based on. Default is 2.

      Returns:

      DataCollection: Market Trades timeseries.

      "},{"location":"api_client.html#get_market_open_interest","title":"get_market_open_interest","text":"
      def get_market_open_interest(\n        markets: Union[List[str], str],\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        granularity: Optional[str] = None,\n        timezone: Optional[str] = None,\n        limit_per_market: Optional[int] = None) -> DataCollection\n

      Returns market open interest for specified markets and date range.

      For more information on open interest, see: https://docs.coinmetrics.io/info/markets/openinterest

      Arguments:

      • markets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future'
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • granularity (str): Downsampling granularity of market open interest. Supported values are raw, 1m, 1h, and 1d.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_market (int): How many entries per market the result should contain.

      Returns:

      DataCollection: Market Open Interest timeseries.

      "},{"location":"api_client.html#get_market_liquidations","title":"get_market_liquidations","text":"
      def get_market_liquidations(\n        markets: Union[List[str], str],\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        limit_per_market: Optional[int] = None) -> DataCollection\n

      Returns market liquidations for specified markets and date range.

      For more information on liquidations, see: https://docs.coinmetrics.io/info/markets/liquidations

      Arguments:

      • markets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future'
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_market (int): How many entries per market the result should contain.

      Returns:

      DataCollection: Market Liquidations timeseries.

      "},{"location":"api_client.html#get_market_funding_rates","title":"get_market_funding_rates","text":"
      def get_market_funding_rates(\n        markets: Union[List[str], str],\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        limit_per_market: Optional[int] = None) -> DataCollection\n

      Returns market funding rates for specified markets and date range.

      For more information on funding rates, see: https://docs.coinmetrics.io/info/markets/fundingrates

      Arguments:

      • markets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future'
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_market (int): How many entries per market the result should contain.

      Returns:

      DataCollection: Market Funding Rates timeseries.

      "},{"location":"api_client.html#get_predicted_market_funding_rates","title":"get_predicted_market_funding_rates","text":"
      def get_predicted_market_funding_rates(\n        markets: Union[List[str], str],\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        limit_per_market: Optional[int] = None) -> DataCollection\n

      Returns predicted funding rates for specified futures markets. Results are ordered by tuple (market, time).

      For more information on funding rates, see: https://docs.coinmetrics.io/info/markets/fundingrates

      Arguments:

      • markets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future'
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_market (int): How many entries per market the result should contain.

      Returns:

      DataCollection: Market Funding Rates timeseries.

      "},{"location":"api_client.html#get_market_orderbooks","title":"get_market_orderbooks","text":"
      def get_market_orderbooks(\n        markets: Union[List[str], str],\n        granularity: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        depth_limit: Optional[str] = \"100\",\n        timezone: Optional[str] = None,\n        limit_per_market: Optional[int] = None) -> DataCollection\n

      Returns market order books for specified markets and date range.

      For more information on order books, see: https://docs.coinmetrics.io/info/markets/orderbook

      Arguments:

      • markets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future'
      • granularity (str): Downsampling granularity of market order books and quotes. Supported values are raw, 1m, 1h, and 1d.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • depth_limit (str): book depth limit, 100 levels max or full book that is not limited and provided as is from the exchange. Full book snapshots are collected once per hour
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_market (int): How many entries per market the result should contain.

      Returns:

      DataCollection: Market Order Books timeseries.

      "},{"location":"api_client.html#get_market_quotes","title":"get_market_quotes","text":"
      def get_market_quotes(\n        markets: Union[List[str], str],\n        granularity: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        limit_per_market: Optional[int] = None,\n        include_one_sided: Optional[bool] = None) -> DataCollection\n

      Returns market quotes for specified markets and date range.

      For more information on quotes, see: https://docs.coinmetrics.io/info/markets/quotes

      Arguments:

      • markets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future'
      • granularity (``): Downsampling granularity of market order books and quotes. Supported values are raw, 1m, 1h, and 1d.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_market (int): How many entries per market the result should contain.
      • include_one_sided (bool): Default: false Include one-side and empty books in quotes response.

      Returns:

      DataCollection: Market Quotes timeseries.

      "},{"location":"api_client.html#get_market_contract_prices","title":"get_market_contract_prices","text":"
      def get_market_contract_prices(\n        markets: Union[List[str], str],\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        granularity: Optional[str] = None,\n        timezone: Optional[str] = None,\n        limit_per_market: Optional[int] = None,\n        frequency: Optional[str] = None) -> DataCollection\n

      Returns contract prices for specified markets. This includes index price and mark price that are used by the exchange for settlement and risk management purposes.

      Arguments:

      • markets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future', 'deribit-ETH-25MAR22-1200-P-option'
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • granularity (str): Downsampling granularity of market contract prices. Supported values are raw, 1m, 1h, and 1d.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_market (int): How many entries per market the result should contain.

      Returns:

      DataCollection: Market Contract Prices timeseries.

      "},{"location":"api_client.html#get_market_implied_volatility","title":"get_market_implied_volatility","text":"
      def get_market_implied_volatility(\n        markets: Union[List[str], str],\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        granularity: Optional[str] = None,\n        timezone: Optional[str] = None,\n        limit_per_market: Optional[int] = None) -> DataCollection\n

      Returns implied volatility for specified markets.

      Arguments:

      • markets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future', 'deribit-ETH-25MAR22-1200-P-option'
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • granularity (str - one of raw, 1m, 1h, and 1d): Downsampling granularity of market implied volatility. Supported values are raw, 1m, 1h, and 1d.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_market (int): How many entries per market the result should contain.

      Returns:

      DataCollection: Market Volatility timeseries.

      "},{"location":"api_client.html#get_market_greeks","title":"get_market_greeks","text":"
      def get_market_greeks(\n        markets: Union[List[str], str],\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        granularity: Optional[str] = None,\n        timezone: Optional[str] = None,\n        limit_per_market: Optional[int] = None) -> DataCollection\n

      Returns greeks for option markets.

      Arguments:

      • markets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future', 'deribit-ETH-25MAR22-1200-P-option'
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • granularity (str - one of raw, 1m, 1h, and 1d): Downsampling granularity of market greeks. Supported values are raw, 1m, 1h, and 1d
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_market (int): How many entries per market the result should contain.

      Returns:

      DataCollection: Market Volatility timeseries.

      "},{"location":"api_client.html#get_mining_pool_tips_summary","title":"get_mining_pool_tips_summary","text":"
      def get_mining_pool_tips_summary(\n        assets: Union[List[str], str],\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None) -> DataCollection\n

      Returns mining pool tips summaries for specified assets.

      Arguments:

      • assets (list(str), str): list of asset names, e.g. 'btc'
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: Mining Pool Tips timeseries.

      "},{"location":"api_client.html#get_mempool_feerates","title":"get_mempool_feerates","text":"
      def get_mempool_feerates(assets: Union[List[str], str],\n                         page_size: Optional[int] = 200,\n                         paging_from: Optional[Union[PagingFrom,\n                                                     str]] = \"start\",\n                         start_time: Optional[Union[datetime, date,\n                                                    str]] = None,\n                         end_time: Optional[Union[datetime, date, str]] = None,\n                         start_inclusive: Optional[bool] = None,\n                         end_inclusive: Optional[bool] = None,\n                         timezone: Optional[str] = None) -> DataCollection\n

      Returns mempool feerates for the specified assets. Note: for this method, page_size must be <= 200.

      Arguments:

      • assets (list(str), str): list of asset names, e.g. 'btc'
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: Mempool Fee Rates timeseries.

      "},{"location":"api_client.html#get_stream_asset_metrics","title":"get_stream_asset_metrics","text":"
      def get_stream_asset_metrics(\n        assets: Union[List[str], str],\n        metrics: Union[List[str], str],\n        frequency: Optional[str] = None,\n        backfill: Union[Backfill, str] = Backfill.LATEST) -> CmStream\n

      Returns timeseries stream of metrics for specified assets.

      Arguments:

      • assets (list(str), str): list of asset names, e.g. 'btc'
      • metrics (list(str), str): list of asset-specific metric names, e.g. 'PriceUSD'
      • frequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
      • backfill (str): What data should be sent upon a connection (\"latest\" or \"none\"). By default the latest values are sent just before real-time data.

      Returns:

      CmStream: Asset Metrics timeseries stream.

      "},{"location":"api_client.html#get_stream_market_trades","title":"get_stream_market_trades","text":"
      def get_stream_market_trades(\n        markets: Union[List[str], str],\n        backfill: Union[Backfill, str] = Backfill.LATEST) -> CmStream\n

      Returns timeseries stream of market trades.

      Arguments:

      • markets (list(str), str): list of markets or market patterns like exchange-* or exchange-*-spot or *USDT-future.
      • backfill (str): What data should be sent upon a connection (\"latest\" or \"none\"). By default the latest values are sent just before real-time data.

      Returns:

      CmStream: Market Trades timeseries stream.

      "},{"location":"api_client.html#get_stream_market_orderbooks","title":"get_stream_market_orderbooks","text":"
      def get_stream_market_orderbooks(\n        markets: Union[List[str], str],\n        backfill: Union[Backfill, str] = Backfill.LATEST,\n        depth_limit: Optional[str] = None) -> CmStream\n

      Returns timeseries stream of market orderbooks.

      Arguments:

      • markets (list(str), str): list of markets or market patterns like exchange-* or exchange-*-spot or *USDT-future.
      • backfill (str): What data should be sent upon a connection (\"latest\" or \"none\"). By default the latest values are sent just before real-time data.
      • depth_limit (str): Default: 100. Supported Values: 100 \"full_book\". Book depth limit.

      Returns:

      CmStream: Market Orderbooks timeseries stream.

      "},{"location":"api_client.html#get_stream_market_quotes","title":"get_stream_market_quotes","text":"
      def get_stream_market_quotes(\n        markets: Union[List[str], str],\n        backfill: Union[Backfill, str] = Backfill.LATEST,\n        include_one_sided: Optional[bool] = None) -> CmStream\n

      Returns timeseries stream of market quotes.

      Arguments:

      • markets (list(str), str): list of markets or market patterns like exchange-* or exchange-*-spot or *USDT-future.
      • backfill (str): What data should be sent upon a connection (\"latest\" or \"none\"). By default the latest values are sent just before real-time data.
      • include_one_sided (bool): Default: false. Include one-side and empty books in quotes response.

      Returns:

      CmStream: Market Quotes timeseries stream.

      "},{"location":"api_client.html#get_stream_pair_quotes","title":"get_stream_pair_quotes","text":"
      def get_stream_pair_quotes(pairs: Union[str, List[str]],\n                           aggregation_method: Optional[str] = None,\n                           backfill: Optional[str] = None) -> CmStream\n

      Arguments:

      • pairs (Optional[Union[str, List[str]]]): Comma separated list of asset pairs. Use the /catalog-all/pairs endpoint for the full list of supported asset pairs.
      • aggregation_method (str): The method to use for aggregation.
      • backfill (str): What data should be sent upon a connection. By default the latest values are sent just before real-time data.

      Returns:

      CmStream:

      "},{"location":"api_client.html#get_stream_asset_quotes","title":"get_stream_asset_quotes","text":"
      def get_stream_asset_quotes(assets: Union[str, List[str]],\n                            aggregation_method: Optional[str] = None,\n                            backfill: Optional[str] = None) -> CmStream\n

      Arguments:

      • assets (Union[str, List[str]]): Comma separated list of assets. Use the /catalog-all/assets endpoint for the full list of supported assets.
      • aggregation_method (str): The method to use for aggregation.
      • backfill (str): What data should be sent upon a connection. By default the latest values are sent just before real-time data.

      Returns:

      CmStream:

      "},{"location":"api_client.html#get_stream_market_candles","title":"get_stream_market_candles","text":"
      def get_stream_market_candles(\n        markets: Union[List[str], str],\n        frequency: Optional[str] = None,\n        backfill: Union[Backfill, str] = Backfill.LATEST) -> CmStream\n

      Returns timeseries stream of market candles.

      Arguments:

      • markets (list(str), str): list of markets or market patterns like exchange-* or exchange-*-spot or *USDT-future.
      • frequency (str): Candle duration. Supported values are 1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d.
      • backfill (str): What data should be sent upon a connection (\"latest\" or \"none\"). By default the latest values are sent just before real-time data.

      Returns:

      CmStream: Market Candles timeseries stream.

      "},{"location":"api_client.html#get_stream_index_levels","title":"get_stream_index_levels","text":"
      def get_stream_index_levels(\n        indexes: Union[List[str], str],\n        include_verification: Optional[bool] = None,\n        backfill: Union[Backfill, str] = Backfill.LATEST) -> CmStream\n

      Returns timeseries stream of index levels.

      Arguments:

      • indexes (list(str), str): list of indxes or market patterns such as CMBIBTC
      • backfill (str): What data should be sent upon a connection (\"latest\" or \"none\"). By default the latest values are sent just before real-time data.
      • include_verification: Default: False If set to true, includes information about verification.

      Returns:

      CmStream: Index levels data timeseries stream.

      "},{"location":"api_client.html#get_stream_market_liquidations","title":"get_stream_market_liquidations","text":"
      def get_stream_market_liquidations(markets: Union[str, List[str]],\n                                   backfill: Optional[str] = None) -> CmStream\n

      Returns timeseries stream for market liquidations

      Arguments:

      • markets (Union[str, List[str]]): Comma separated list of markets or market patterns like exchange-* or exchange-*-spot or *USDT-future. Use the /catalog-all/markets endpoint for the full list of supported markets.
      • backfill (Optional[str]): What data should be sent upon a connection. By default the latest values are sent just before real-time data.

      Returns:

      CmStream: Market liquidations timeseries stream

      "},{"location":"api_client.html#get_stream_market_open_interest","title":"get_stream_market_open_interest","text":"
      def get_stream_market_open_interest(\n        markets: Union[str, List[str]],\n        backfill: Optional[str] = None) -> CmStream\n

      Arguments:

      • markets (Union[str, List[str]]): Comma separated list of markets or market patterns like exchange-* or exchange-*-spot or *USDT-future. Use the /catalog-all/markets endpoint for the full list of supported markets.
      • backfill (Optional[str]): What data should be sent upon a connection. By default the latest values are sent just before real-time data.

      Returns:

      CmStream:

      "},{"location":"api_client.html#get_list_of_blocks","title":"get_list_of_blocks","text":"
      def get_list_of_blocks(asset: str,\n                       block_hashes: Optional[Union[List[str], str]] = None,\n                       heights: Optional[Union[List[str], str]] = None,\n                       page_size: Optional[int] = None,\n                       paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n                       start_time: Optional[Union[datetime, date, str]] = None,\n                       end_time: Optional[Union[datetime, date, str]] = None,\n                       start_height: Optional[int] = None,\n                       end_height: Optional[int] = None,\n                       start_inclusive: Optional[bool] = None,\n                       end_inclusive: Optional[bool] = None,\n                       timezone: Optional[str] = None) -> DataCollection\n

      Returns a list of blockchain blocks metadata.

      Arguments:

      • asset (str): Asset name
      • block_hashes (str, list(str)): Optional comma separated list of block hashes to filter a response.
      • heights (str, list(str)): Optional comma separated list of block heights to filter a response.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_height (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: list of blockchain blocks metadata

      "},{"location":"api_client.html#get_list_of_accounts","title":"get_list_of_accounts","text":"
      def get_list_of_accounts(asset: str,\n                         accounts: Optional[Union[List[str], str]] = None,\n                         page_size: Optional[int] = None,\n                         paging_from: Optional[Union[PagingFrom,\n                                                     str]] = \"start\",\n                         start_time: Optional[Union[datetime, date,\n                                                    str]] = None,\n                         end_time: Optional[Union[datetime, date, str]] = None,\n                         start_height: Optional[int] = None,\n                         end_height: Optional[int] = None,\n                         start_chain_sequence_number: Optional[int] = None,\n                         end_chain_sequence_number: Optional[int] = None,\n                         start_inclusive: Optional[bool] = None,\n                         end_inclusive: Optional[bool] = None,\n                         timezone: Optional[str] = None) -> DataCollection\n

      Returns a list of blockchain accounts with their balances.

      Arguments:

      • asset (str): Asset name
      • accounts (str, list(str)): Optional comma separated list of accounts to filter a response.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_height (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • start_chain_sequence_number (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_chain_sequence_number (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: list of blockchain accounts metadata

      "},{"location":"api_client.html#get_list_of_transactions","title":"get_list_of_transactions","text":"
      def get_list_of_transactions(asset: str,\n                             transaction_hashes: Optional[Union[List[str],\n                                                                str]] = None,\n                             block_hashes: Optional[Union[List[str],\n                                                          str]] = None,\n                             page_size: Optional[int] = None,\n                             paging_from: Optional[Union[PagingFrom,\n                                                         str]] = \"start\",\n                             start_time: Optional[Union[datetime, date,\n                                                        str]] = None,\n                             end_time: Optional[Union[datetime, date,\n                                                      str]] = None,\n                             start_height: Optional[int] = None,\n                             end_height: Optional[int] = None,\n                             start_inclusive: Optional[bool] = None,\n                             end_inclusive: Optional[bool] = None,\n                             timezone: Optional[str] = None) -> DataCollection\n

      Returns a list of blockchain transactions metadata.

      Arguments:

      • asset (str): Asset name
      • transaction_hashes (str, list(str)): Optional comma separated list of transaction hashes to filter a response.
      • block_hashes (str, list(str)): Optional comma separated list of block hashes to filter a response.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_height (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: list of transaction metadata

      "},{"location":"api_client.html#get_list_of_balance_updates","title":"get_list_of_balance_updates","text":"
      def get_list_of_balance_updates(\n        asset: str,\n        accounts: Optional[Union[List[str], str]] = None,\n        transaction_hashes: Optional[Union[List[str], str]] = None,\n        block_hashes: Optional[Union[List[str], str]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_height: Optional[int] = None,\n        end_height: Optional[int] = None,\n        start_chain_sequence_number: Optional[int] = None,\n        end_chain_sequence_number: Optional[int] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None) -> DataCollection\n

      Returns a list of blockchain accounts balance updates.

      Arguments:

      • asset (str): Asset name
      • accounts (str, list(str)): Optional comma separated list of accounts to filter a response.
      • transaction_hashes (str, list(str)): Optional comma separated list of transaction hashes to filter a response.
      • block_hashes (str, list(str)): Optional comma separated list of block hashes to filter a response.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_height (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • start_chain_sequence_number (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_chain_sequence_number (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: list of balance updates

      "},{"location":"api_client.html#get_list_of_blocks_v2","title":"get_list_of_blocks_v2","text":"
      def get_list_of_blocks_v2(asset: str,\n                          block_hashes: Optional[Union[List[str], str]] = None,\n                          heights: Optional[Union[List[str], str]] = None,\n                          page_size: Optional[int] = None,\n                          paging_from: Optional[Union[PagingFrom,\n                                                      str]] = \"start\",\n                          start_time: Optional[Union[datetime, date,\n                                                     str]] = None,\n                          end_time: Optional[Union[datetime, date,\n                                                   str]] = None,\n                          start_height: Optional[int] = None,\n                          end_height: Optional[int] = None,\n                          chain: Optional[bool] = None,\n                          start_inclusive: Optional[bool] = None,\n                          end_inclusive: Optional[bool] = None,\n                          timezone: Optional[str] = None) -> DataCollection\n

      Returns a list of blockchain blocks metadata.

      Arguments:

      • asset (str): Asset name
      • block_hashes (str, list(str)): Optional comma separated list of block hashes to filter a response.
      • heights (str, list(str)): Optional comma separated list of block heights to filter a response.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_height (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • chain (str): Default: \"main\" Chain type. Supported values are main and all (includes both main and stale).
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: list of blockchain blocks metadata

      "},{"location":"api_client.html#get_list_of_accounts_v2","title":"get_list_of_accounts_v2","text":"
      def get_list_of_accounts_v2(asset: str,\n                            accounts: Optional[Union[List[str], str]] = None,\n                            page_size: Optional[int] = None,\n                            paging_from: Optional[Union[PagingFrom,\n                                                        str]] = \"start\",\n                            start_time: Optional[Union[datetime, date,\n                                                       str]] = None,\n                            end_time: Optional[Union[datetime, date,\n                                                     str]] = None,\n                            start_height: Optional[int] = None,\n                            end_height: Optional[int] = None,\n                            start_chain_sequence_number: Optional[int] = None,\n                            end_chain_sequence_number: Optional[int] = None,\n                            start_inclusive: Optional[bool] = None,\n                            end_inclusive: Optional[bool] = None,\n                            timezone: Optional[str] = None) -> DataCollection\n

      Returns a list of blockchain accounts with their balances.

      Arguments:

      • asset (str): Asset name
      • accounts (str, list(str)): Optional comma separated list of accounts to filter a response.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_height (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • start_chain_sequence_number (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_chain_sequence_number (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: list of blockchain accounts metadata

      "},{"location":"api_client.html#get_list_of_sub_accounts_v2","title":"get_list_of_sub_accounts_v2","text":"
      def get_list_of_sub_accounts_v2(\n        asset: str,\n        accounts: Optional[Union[List[str], str]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_height: Optional[int] = None,\n        end_height: Optional[int] = None,\n        start_chain_sequence_number: Optional[int] = None,\n        end_chain_sequence_number: Optional[int] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None) -> DataCollection\n

      Returns a list of blockchain sub-accounts with their balances.

      Arguments:

      • asset (str): Asset name
      • accounts (str, list(str)): Optional comma separated list of accounts to filter a response.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_height (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • start_chain_sequence_number (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_chain_sequence_number (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: list of blockchain accounts metadata

      "},{"location":"api_client.html#get_list_of_transactions_v2","title":"get_list_of_transactions_v2","text":"
      def get_list_of_transactions_v2(\n        asset: str,\n        txids: Optional[Union[List[str], str]] = None,\n        block_hashes: Optional[Union[List[str], str]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_height: Optional[int] = None,\n        end_height: Optional[int] = None,\n        chain: Optional[str] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None) -> DataCollection\n

      Returns a list of blockchain transactions metadata.

      Arguments:

      • asset (str): Asset name
      • txids (str, list(str)): Optional comma separated list of transaction identifiers (txid) to filter a response.
      • block_hashes (str, list(str)): Optional comma separated list of block hashes to filter a response.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_height (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • chain (str): Default: \"main\". Chain type. Supported values are main and all (includes both main and stale).
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: list of transaction metadata

      "},{"location":"api_client.html#get_list_of_balance_updates_v2","title":"get_list_of_balance_updates_v2","text":"
      def get_list_of_balance_updates_v2(\n        asset: str,\n        accounts: Optional[Union[List[str], str]] = None,\n        sub_accounts: Optional[Union[List[str], str]] = None,\n        limit_per_account: Optional[int] = None,\n        txids: Optional[Union[List[str], str]] = None,\n        block_hashes: Optional[Union[List[str], str]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_height: Optional[int] = None,\n        end_height: Optional[int] = None,\n        start_chain_sequence_number: Optional[int] = None,\n        end_chain_sequence_number: Optional[int] = None,\n        include_sub_accounts: Optional[bool] = None,\n        chain: Optional[str] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None) -> DataCollection\n

      Returns a list of blockchain accounts balance updates.

      Arguments:

      • asset (str): Asset name
      • accounts (str, list(str)): Optional comma separated list of accounts to filter a response.
      • limit_per_account (int): How many entries per account the result should contain. It is applicable when multiple accounts are requested.
      • txids (str, list(str)): Optional comma separated list of transaction ids to filter a response.
      • block_hashes (str, list(str)): Optional comma separated list of block hashes to filter a response.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_height (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • start_chain_sequence_number (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_chain_sequence_number (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • include_sub_accounts (bool): bool indicating if the response should contain sub-accounts.
      • chain: Chain type. Supported values are main and all (includes both main and stale).
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: list of balance updates

      "},{"location":"api_client.html#get_full_transaction_for_block","title":"get_full_transaction_for_block","text":"
      def get_full_transaction_for_block(asset: str, block_hash: str,\n                                   txid: str) -> List[Dict[str, Any]]\n

      Arguments:

      • asset (str): Asset name.
      • block_hash (str): Block hash.
      • txid (str): Transaction identifier (txid).

      Returns:

      DataCollection: Blockchain full transaction.

      "},{"location":"api_client.html#get_full_block","title":"get_full_block","text":"
      def get_full_block(asset: str, block_hash: str) -> Dict[str, Any]\n

      Arguments:

      • asset (str): Asset name.
      • block_hash (str): Block hash.

      Returns:

      Dict[str, Any]: Blockchain full block.

      "},{"location":"api_client.html#get_full_block_v2","title":"get_full_block_v2","text":"
      def get_full_block_v2(\n        asset: str, block_hash: str,\n        include_sub_accounts: Optional[bool]) -> List[Dict[str, Any]]\n

      Returns a full blockchain block with all transactions and balance updates.

      Arguments:

      • asset (str): Asset name
      • block_hash (str): block hash
      • include_sub_accounts (bool): Boolean indicating if the response should contain sub-accounts

      Returns:

      list(dict(str), any): blockchain block data

      "},{"location":"api_client.html#get_full_transaction","title":"get_full_transaction","text":"
      def get_full_transaction(asset: str, txid: str) -> List[Dict[str, Any]]\n

      Arguments:

      • asset (Optional[str]): Asset name.
      • txid (Optional[str]): Transaction identifier (txid).

      Returns:

      DataCollection: Blockchain full transaction.

      "},{"location":"api_client.html#get_full_transaction_v2","title":"get_full_transaction_v2","text":"
      def get_full_transaction_v2(\n        asset: str, txid: str,\n        include_sub_accounts: Optional[bool]) -> List[Dict[str, Any]]\n

      Returns a full blockchain transaction with all balance updates.

      Arguments:

      • asset (str): Asset name
      • txid (str): transaction identifier
      • include_sub_accounts (bool): Boolean indicating if the response should contain sub-accounts

      Returns:

      list(dict(str), any): block transaction data

      "},{"location":"api_client.html#get_full_transaction_for_block_v2","title":"get_full_transaction_for_block_v2","text":"
      def get_full_transaction_for_block_v2(\n        asset: str, block_hash: str, txid: str,\n        include_sub_accounts: Optional[bool]) -> List[Dict[str, Any]]\n

      Returns a full blockchain transaction with all balance updates for a specific block.

      Arguments:

      • asset (str): Asset name
      • block_hash (str): block hash
      • txid (str): transaction identifier
      • include_sub_accounts (bool): Boolean indicating if the response should contain sub-accounts

      Returns:

      list(dict(str, Any)): block transaction data with balance updates

      "},{"location":"api_client.html#get_list_of_balance_updates_for_account_v2","title":"get_list_of_balance_updates_for_account_v2","text":"
      def get_list_of_balance_updates_for_account_v2(\n        asset: str,\n        account: str,\n        txids: Optional[Union[str, List[str]]] = None,\n        block_hashes: Optional[Union[str, List[str]]] = None,\n        include_counterparties: Optional[bool] = None,\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_height: Optional[int] = None,\n        end_height: Optional[int] = None,\n        start_chain_sequence_number: Optional[int] = None,\n        end_chain_sequence_number: Optional[int] = None,\n        include_sub_accounts: Optional[bool] = None,\n        chain: Optional[str] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> DataCollection\n

      Arguments:

      • asset (Optional[str]): Asset name.
      • account (Optional[str]): Account id.
      • txids (Union[str, List[str]]): Optional comma separated list of transaction identifiers (txid) to filter a response. The list must contain a single element for Community users.
      • block_hashes (Union[str, List[str]]): Optional comma separated list of block hashes to filter a response. The list must contain a single element for Community users.
      • include_counterparties (bool): Include information about the counterparties balance updates.
      • start_time (str): Start of the time interval. This field refers to the time field in the response. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120. Inclusive by default. Mutually exclusive with start_height. UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it. If start_time is omitted, response will include time series from the earliest time available. This parameter is disabled for Community users.
      • end_time (str): End of the time interval. This field refers to the time field in the response. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120. Inclusive by default. Mutually exclusive with end_height. UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it. If end_time is omitted, response will include time series up to the latest time available. This parameter is disabled for Community users.
      • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Inclusive by default. Mutually exclusive with start_time. This parameter is disabled for Community users.
      • end_height (int): The end height indicates the ending block height for the set of data that are returned. Inclusive by default. Mutually exclusive with end_time. This parameter is disabled for Community users.
      • start_chain_sequence_number (int): Start of the chain_sequence_number interval. This parameter is disabled for Community users.
      • end_chain_sequence_number (int): End of the chain_sequence_number interval. This parameter is disabled for Community users.
      • include_sub_accounts (bool): Boolean indicating if the response should contain sub-accounts. This parameter is disabled for Community users.
      • chain (str): Chain type. Supported values are main and all (includes both main and stale). This parameter is disabled for Community users.
      • start_inclusive (bool): Inclusive or exclusive corresponding start_* parameters. This parameter is disabled for Community users.
      • end_inclusive (bool): Inclusive or exclusive corresponding end_* parameters. This parameter is disabled for Community users.
      • timezone (str): Timezone name for start_time and end_time timestamps. This parameter does not modify the output times, which are always UTC. Format is defined by TZ database.
      • page_size (int): Number of items per single page of results. This parameter is disabled for Community users.
      • paging_from (str): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (str): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      DataCollection: Blockchain balance updates for account.

      "},{"location":"api_client.html#get_transaction_tracker","title":"get_transaction_tracker","text":"
      def get_transaction_tracker(\n    asset: str,\n    addresses: Optional[Union[List[str], str]] = None,\n    txids: Optional[Union[List[str], str]] = None,\n    replacements_for_txids: Optional[Union[List[str], str]] = None,\n    replacements_only: Optional[bool] = None,\n    page_size: Optional[int] = None,\n    paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n    start_time: Optional[Union[datetime, date, str]] = None,\n    end_time: Optional[Union[datetime, date, str]] = None,\n    start_inclusive: Optional[bool] = None,\n    end_inclusive: Optional[bool] = None,\n    timezone: Optional[str] = None,\n    unconfirmed_only: Optional[bool] = None\n) -> TransactionTrackerDataCollection\n

      Returns status updates for the specified or all transactions.

      Arguments:

      • asset (str): Asset name
      • txids (str, list(str)): Optional comma separated list of transaction identifiers (txid) to track.
      • replacements_for_txids (str, list(str)): Optional comma separated list of transaction identifiers (txid) to get the corresponding replacement transactions for. Mutually exclusive with txids.
      • replacements_only (bool): Boolean indicating if the response should contain only the replacement transactions.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      TransactionTrackerDataCollection: status updates for the specified or all transactions.

      "},{"location":"api_client.html#get_taxonomy_assets","title":"get_taxonomy_assets","text":"
      def get_taxonomy_assets(assets: Optional[List[str]] = None,\n                        class_ids: Optional[List[str]] = None,\n                        sector_ids: Optional[List[str]] = None,\n                        subsector_ids: Optional[List[str]] = None,\n                        classification_start_time: Optional[str] = None,\n                        classification_end_time: Optional[str] = None,\n                        end_inclusive: Optional[bool] = None,\n                        start_inclusive: Optional[bool] = None,\n                        page_size: Optional[int] = None,\n                        paging_from: Optional[str] = None,\n                        version: Optional[str] = None) -> DataCollection\n

      Returns assets with information about their sector, industry, and industry group IDs. By default reutrns all

      covered assets

      Arguments:

      • assets (Optional[List[str]]): Asset names
      • class_ids (Optional[List[str]]): List of class identifiers.
      • sector_ids (Optional[List[str]]): Lst of sector identifiers.
      • subsector_ids (Optional[List[str]]): List of subsector identifiers
      • classification_start_time (Optional[str]): Start time for the taxonomy assets. ISO-8601 format date. Inclusive by default
      • classification_end_time (Optional[str]): End time for the taxonomy assets. ISO-8601 format date. Inclusive by default
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • page_size (Optional[int]): Page size for # of assets to return, will default to 100
      • paging_from (Optional[str]): Which direction to page from \"start\" or \"end\". \"end\" by default
      • version (Optional[str]): Version to query, default is \"latest\".

      Returns:

      Datacollection: Returns a data collection containing the taxonomy assets

      "},{"location":"api_client.html#get_taxonomy_assets_metadata","title":"get_taxonomy_assets_metadata","text":"
      def get_taxonomy_assets_metadata(\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        version: Optional[str] = None) -> DataCollection\n

      Returns metadata about the assets, sectors, and industries included in the CM taxonomy

      Arguments:

      • start_time (Optional[Union[datetime, date, str]]): Start time for the taxonomy version file. ISO-8601 format date. Inclusive by default
      • end_time (Optional[Union[datetime, date, str]]): End time for the taxonomy version file. ISO-8601 format date. Exclusive by default
      • start_inclusive (str): Start time of taxonomy version.
      • end_inclusive (str): End time of taxonomy version.
      • page_size (Optional[int]): Page size for # of asset metadata to return, will default to 100
      • paging_from (Optional[str]): Which direction to page from \"start\" or \"end\". \"end\" by default
      • version (Optional[str]): Version to query, default is \"latest\".

      Returns:

      Datacollection: Returns a data collection containing the taxonomy assets

      "},{"location":"api_client.html#get_asset_profiles","title":"get_asset_profiles","text":"
      def get_asset_profiles(assets: Optional[Union[List[str], str]] = None,\n                       full_names: Optional[Union[List[str], str]] = None,\n                       page_size: Optional[int] = None,\n                       paging_from: Optional[str] = None) -> DataCollection\n

      Returns profile data for assets, ordered by asset

      Arguments:

      • assets (Optional[Union[List[str], str]]): Returns profile data for assets.
      • full_names (Optional[Union[List[str], str]]): Comma separated list of asset full names. By default profile data for all assets is returned. Mutually exclusive with assets parameter.
      • page_size (int): Number of items per single page of results.
      • paging_from (int): Where does the first page start, at the \"start\" of the interval or at the \"end\"

      "},{"location":"api_client.html#reference_data_asset_metrics","title":"reference_data_asset_metrics","text":"
      def reference_data_asset_metrics(\n        metrics: Optional[Union[str, List[str]]] = None,\n        reviewable: Optional[bool] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None) -> DataCollection\n

      Arguments:

      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • reviewable (Optional[bool]): Limit to human-reviewable metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.

      Returns:

      DataCollection: List of asset metrics metadata.

      "},{"location":"api_client.html#reference_data_markets","title":"reference_data_markets","text":"
      def reference_data_markets(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      DataCollection: List of markets metadata.

      "},{"location":"api_client.html#reference_data_exchange_metrics","title":"reference_data_exchange_metrics","text":"
      def reference_data_exchange_metrics(\n        metrics: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None) -> DataCollection\n

      Arguments:

      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.

      Returns:

      DataCollection: List of exchange metrics metadata.

      "},{"location":"api_client.html#reference_data_exchange_asset_metrics","title":"reference_data_exchange_asset_metrics","text":"
      def reference_data_exchange_asset_metrics(\n        metrics: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None) -> DataCollection\n

      Arguments:

      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.

      Returns:

      DataCollection: List of exchange asset metrics metadata.

      "},{"location":"api_client.html#reference_data_pair_metrics","title":"reference_data_pair_metrics","text":"
      def reference_data_pair_metrics(\n        metrics: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None) -> DataCollection\n

      Arguments:

      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.

      Returns:

      DataCollection: List of pair metrics metadata.

      "},{"location":"api_client.html#reference_data_institution_metrics","title":"reference_data_institution_metrics","text":"
      def reference_data_institution_metrics(\n        metrics: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None) -> DataCollection\n

      Arguments:

      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.

      Returns:

      DataCollection: List of institution metrics metadata.

      "},{"location":"api_client.html#reference_data_assets","title":"reference_data_assets","text":"
      def reference_data_assets(\n        assets: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> DataCollection\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      DataCollection: List of assets metadata.

      "},{"location":"api_client.html#reference_data_exchanges","title":"reference_data_exchanges","text":"
      def reference_data_exchanges(\n        exchanges: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> DataCollection\n

      Arguments:

      • exchanges (Optional[Union[str, List[str]]]): Comma separated list of exchanges. By default all exchanges are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      DataCollection: List of exchanges metadata.

      "},{"location":"api_client.html#reference_data_indexes","title":"reference_data_indexes","text":"
      def reference_data_indexes(\n        indexes: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> DataCollection\n

      Arguments:

      • indexes (Optional[Union[str, List[str]]]): Comma separated list of indexes. By default all indexes are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      DataCollection: List of indexes metadata.

      "},{"location":"api_client.html#reference_data_pairs","title":"reference_data_pairs","text":"
      def reference_data_pairs(\n        pairs: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> DataCollection\n

      Arguments:

      • pairs (Optional[Union[str, List[str]]]): Comma separated list of asset pairs. By default, all asset pairs are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      DataCollection: List of pairs metadata.

      "},{"location":"api_client.html#reference_data_market_metrics","title":"reference_data_market_metrics","text":"
      def reference_data_market_metrics(\n        metrics: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> DataCollection\n

      Arguments:

      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      DataCollection: List of market metrics metadata.

      "},{"location":"api_client.html#security_master_assets","title":"security_master_assets","text":"
      def security_master_assets(\n        assets: Optional[Union[str, List[str]]] = None,\n        codes: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> DataCollection\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma-separated list of assets to query. Mutually exclusive with codes.
      • codes (Optional[Union[str, List[str]]]): Comma-separated list of ten-digit alphanumeric identifying codes. Mutually exclusive with assets.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      DataCollection: List of assets and their metadata in security master

      "},{"location":"api_client.html#security_master_markets","title":"security_master_markets","text":"
      def security_master_markets(\n        type: Optional[str] = None,\n        markets: Optional[Union[str, List[str]]] = None,\n        symbol: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> DataCollection\n

      Arguments:

      • type (Optional[str]): Type of markets.
      • markets (Optional[Union[str, List[str]]]): List of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • exchange (Optional[str]): Unique name of an exchange.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      DataCollection: List of security master entries.

      "},{"location":"api_client.html#get_snapshots_of_asset_metric_constituents","title":"get_snapshots_of_asset_metric_constituents","text":"
      def get_snapshots_of_asset_metric_constituents(\n        metric: str,\n        at_time: Optional[str] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_time: Optional[Union[datetime, date, str]] = None,\n        next_page_token: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None) -> DataCollection\n

      Arguments:

      • metric (str): Target metric name.
      • at_time (Optional[str]): Returns constituents at a specified date. Value now can be specified to get the current constituents. Mutually exclusive with start_time and/or end_time.
      • end_time (Optional[Union[datetime, date, str]]): Start of the time interval, inclusive. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120. Mutually exclusive with at_time.
      • start_time (Optional[Union[datetime, date, str]]): End of the time interval, inclusive. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120. Mutually exclusive with at_time.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.

      Returns:

      DataCollection: Snapshots of asset metric constituents.

      "},{"location":"api_client.html#get_timeframes_of_asset_metric_constituents","title":"get_timeframes_of_asset_metric_constituents","text":"
      def get_timeframes_of_asset_metric_constituents(\n        metric: str,\n        constituents: Optional[Union[str, List[str]]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_time: Optional[Union[datetime, date, str]] = None,\n        next_page_token: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None) -> DataCollection\n

      Arguments:

      • metric (str): Target metric name.
      • constituents (Optional[Union[str, List[str]]]): Comma separated list of constituents. By default all constituents are returned. Different asset metrics may have different constituents. For example, constituents for volume_trusted_spot_usd_1d are exchanges.
      • end_time (Optional[Union[datetime, date, str]]): Start of the time interval, inclusive. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120. Mutually exclusive with at_time.
      • start_time (Optional[Union[datetime, date, str]]): End of the time interval, inclusive. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120. Mutually exclusive with at_time.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.

      Returns:

      DataCollection: List of timeframes.

      "},{"location":"api_client.html#blockchain_metadata_tags","title":"blockchain_metadata_tags","text":"
      def blockchain_metadata_tags(\n        type: Optional[str] = None,\n        page_size: Optional[int] = None,\n        next_page_token: Optional[str] = None) -> DataCollection\n

      Arguments:

      • type (Optional[str]): The type of a tag.
      • page_size (Optional[int]): Number of items per single page of results.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      DataCollection: List of tags.

      "},{"location":"api_client.html#blockchain_metadata_tagged_entities","title":"blockchain_metadata_tagged_entities","text":"
      def blockchain_metadata_tagged_entities(\n        tags: Optional[Union[str, List[str]]] = None,\n        entities: Optional[Union[str, List[str]]] = None,\n        locations: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        next_page_token: Optional[str] = None) -> DataCollection\n

      Arguments:

      • tags (Optional[Union[str, List[str]]]): Comma separated list of tags. Mutually exclusive with entities parameter. Currently a single tag is allowed per each request.
      • entities (Optional[Union[str, List[str]]]): Comma separated list of entities. Mutually exclusive with tags parameter.
      • locations (Optional[Union[str, List[str]]]): Comma separated list of entity locations (asset representation where the entity has been tagged). Currently a single entity location is allowed per each request.
      • page_size (Optional[int]): Number of items per single page of results.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      DataCollection: List of tagged entities. Ordered by tuple (entity, tag, location, start_time) if requested by providing entities parameter. Ordered by tuple (tag, location, entity, started_time) if requested by providing tags parameter.

      "}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"index.html","title":"Coin Metrics Python API v4 client library","text":"

      This is an official Python API client for Coin Metrics API v4.

      "},{"location":"index.html#installation-and-updates","title":"Installation and Updates","text":"

      To install the client you can run the following command: 

      pip install coinmetrics-api-client\n

      Note that the client is updated regularly to reflect the changes made in API v4. Ensure that your latest version matches with what's in pyPI

      To update your version, run the following command: 

      pip install coinmetrics-api-client -U\n

      "},{"location":"index.html#introduction","title":"Introduction","text":"

      You can use this client for querying all kinds of data with your API.

      To initialize the client you should use your API key, and the CoinMetricsClient class like the following. 

      from coinmetrics.api_client import CoinMetricsClient\n\nclient = CoinMetricsClient(\"<cm_api_key>\")\n\n# or to use community API:\nclient = CoinMetricsClient()\n

      After that you can use the client object for getting information such as available market trades as a list of dictionaries: 

      print(client.catalog_market_trades_v2().to_list())\n

      or to iterate over each page of data:

      for data in client.catalog_market_trades_v2():\n    print(data)\n

      you can also use filters for the catalog endpoints like this:

      print(client.catalog_market_trades_v2(exchange=\"binance\").to_list())\n

      All the catalog V2 endpoints meant to help access the historical data served by other endpoints. For example, you can get all the BTC market trades for a certain day from binance like this:

      import os\nfrom coinmetrics.api_client import CoinMetricsClient\nclient = CoinMetricsClient(os.environ['CM_API_KEY'])\nbtc_binance_markets = [market['market'] for market in client.catalog_market_trades_v2(exchange=\"binance\", asset=\"btc\").to_list()]\nstart_time = \"2023-01-01\"\nend_time = \"2023-01-02\"\nbinance_market_trades = client.get_market_trades(markets=btc_binance_markets, start_time=start_time, end_time=end_time, page_size=1000).export_to_csv(\"binance_trades.csv\")\n
      in this case you would get all the information markets that trade on binance only.

      You can use this client to connect to our API v4 and get catalog or timeseries data from python environment. It natively supports paging over the data so you can use it to iterate over timeseries entries seamlessly.

      The client can be used to query both pro and community data.

      The full list of methods can be found in the API Client Spec.

      If you'd like a more holistic view of what is offered from an API endpoint you can use the to_dataframe() function associated with our catalog endpoints. The code snippet below shows getting a dataframe of information on all the assets that data is provided for: 

      print(client.catalog_market_metrics_v2(exchange=\"binance\", page_size=1000).to_dataframe())\n

      Output: 

                                   market                                            metrics\n0       binance-1000BTTCUSDT-future  [{'metric': 'liquidity_depth_0_1_percent_ask_v...\n1      binance-1000FLOKIUSDT-future  [{'metric': 'liquidations_reported_future_buy_...\n2       binance-1000LUNCBUSD-future  [{'metric': 'liquidations_reported_future_buy_...\n3       binance-1000LUNCUSDT-future  [{'metric': 'liquidations_reported_future_buy_...\n4       binance-1000PEPEUSDT-future  [{'metric': 'liquidations_reported_future_buy_...\n

      Now you can use the pandas Dataframe functionality to do useful transformations, such as filtering out the assets without metrics available, then saving that data to a csv file: 

      import pandas as pd\nimport os\nfrom coinmetrics.api_client import CoinMetricsClient\nfrom datetime import timedelta\nclient = CoinMetricsClient(os.environ['CM_API_KEY'])\nbinance_markets = client.catalog_market_trades_v2(exchange=\"binance\", page_size=1000).to_dataframe()\nbinance_markets['max_time'] = pd.to_datetime(binance_markets['max_time'], utc=True)\ncurrent_utc_time = pd.Timestamp.now(tz='UTC')\none_day_ago = current_utc_time - timedelta(days=1)\nfiltered_binance_markets = binance_markets[binance_markets['max_time'] > one_day_ago]\n

      "},{"location":"index.html#parallel-execution-for-faster-data-export","title":"Parallel execution for faster data export","text":"

      There are times when it may be useful to pull in large amounts of data at once. The most effective way to do this when calling the CoinMetrics API is to split your request into many different queries. This functionality is now built into the API Client directly to allow for faster data export:

      import os\nfrom coinmetrics.api_client import CoinMetricsClient\n\n\nif __name__ == '__main__':\n    client = CoinMetricsClient(os.environ['CM_API_KEY'])\n    binance_eth_markets = [market['market'] for market in client.catalog_market_candles(exchange=\"binance\", base=\"eth\")]\n    start_time = \"2022-03-01\"\n    end_time = \"2023-05-01\"\n    client.get_market_candles(markets=binance_eth_markets, start_time=start_time, end_time=end_time, page_size=1000).parallel().export_to_json_files()\n

      What this feature does is rather request all the data in one thread, it will split into many threads or processes and either store them in separate files in the case of .parallel().export_to_csv_files() and .parallel().export_to_json_files or combine them all into one file or data structure in the case of .parallel().to_list(), .parallel().to_dataframe(), .parallel().export_to_json(). It's important to know that in order to send more requests per second to the CoinMetrics this uses the parallel tasks features in Python's concurrent.futures package. This means when using this feature, the API Client will use significantly more resources and may approach the Coin Metrics rate limits.

      In terms of resource usage and speed, these usages are in order from most performant to least: * .export_to_json_files() * .export_to_csv_files() * .to_list() * .export_to_json() * .to_dataframe()

      "},{"location":"index.html#splitting-single-parameter-queries-into-many-requests-for-increased-performance","title":"Splitting single parameter queries into many requests for increased performance","text":"

      There is a feature time_increment that can be used to split a single query into many based on time range, and then combine them later. Consider this example where we speed up getting a 2 months worth of BTC ReferenceRateUSD data into many parallel threads to create a dataframe faster: 

      import datetime\nimport os\nfrom coinmetrics.api_client import CoinMetricsClient\nfrom dateutil.relativedelta import relativedelta\nclient = CoinMetricsClient(os.environ.get(\"CM_API_KEY\"))\nstart_time = datetime.datetime.now()\nassets = [\"btc\", \"eth\", \"algo\"]\nif __name__ == '__main__':\n    client.get_asset_metrics(\n        assets=assets,\n        metrics=\"ReferenceRateUSD\",\n        frequency=\"1m\",\n        start_time=\"2022-03-01\",\n        end_time=\"2023-03-01\",\n        page_size=1000,\n        end_inclusive=False).parallel(\n        time_increment=relativedelta(months=1)).export_to_csv(\"btcRRs.csv\")\n    print(f\"Time taken parallel: {datetime.datetime.now() - start_time}\")\n    start_time = datetime.datetime.now()\n    client.get_asset_metrics(\n        assets=assets,\n        metrics=\"ReferenceRateUSD\",\n        frequency=\"1m\",\n        start_time=\"2022-03-01\",\n        end_time=\"2023-03-01\",\n        page_size=1000,\n        end_inclusive=False).export_to_csv(\"btcRRsNormal.csv\")\n
      Notice we pass in the time_increment=relativedelta(months=1) so that means we will split the threads up by month, in addition to by asset. So this will run a total 36 separate threads, 12 threads for each month x 3 threads for each asset. The difference it takes in time is dramatic: 
      Exporting to dataframe type: 100%|\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588| 36/36 [00:00<00:00, 54.62it/s]\nTime taken parallel: 0:00:36.654147\nTime taken normal: 0:05:20.073826\n

      Please note that for short time periods you can pass in a time_increment with datetime.timedelta to specify up to several weeks, for larger time frames you can use dateutil.relativedelta.relativedelta in order to split requests up by increments of months or years.

      "},{"location":"index.html#to-keep-in-mind-when-using-using-parallel-feature-or-generally-writing-high-performance-code-using-api-client","title":"To keep in mind when using using parallel feature or generally writing high performance code using API Client:","text":"
      • If you are using a small page_size and trying to export a large number amount of, this will be your biggest bottleneck. Generally the fastest page_size is 1000 to 10000
      • If you are unsure why an action is taking a long time, running the CoinMetricsClient using verbose=True or debug=True can give better insight into what is happening under the hood
      • The parallel feature is best used when you are exporting a large amount of data, that can be split by query params into many smaller requests. A good example of this is market candles over a long time frame - if you are querying hundreds of markets and are sure there will be data, using .parallel().export_to_csv_files(\"...\") can have a huge performance increase, if you are just querying a single market you will not see a difference
      • The parallel feature is highly configurable, there is several configuration options that may be suitable for advanced users like tweaking the max_workers parameter, or changing the default ProcessPoolExecutor to a ThreadPoolExectuor
      • Using multithreaded code is inherently more complex, it will be harder to debug issues with long running queries when running parallel exports compared to normal single threaded code
      • For that reason, this tool is best suited for exporting historical data rather than supporting a real time production system
      • The methods that create separate files for each thread will be the safest and most performant to use - .export_to_csv_files() and .export_to_json_files(). Using the methods that return a single output - .export_to_csv(), export_to_list(), and .export_to_dataframe() need to join the data from many threads before it can be returned, this may use a lot of memory if you are accessing data types like market orderbooks or market trades and could fail altogether
      • If you get the error BrokenProcessPool it might be because you're missing a main() function
      "},{"location":"index.html#examples","title":"Examples","text":"

      The API Client allows you to chain together workflows for importing, transforming, then exporting Coin Metrics data. Below are examples of common use-cases that can be altered to tailor your specific needs. In addition to the examples listed below, there's examples covering all the API methods, found in the examples directory.

      Example Notebooks

      • walkthrough_community.ipynb: Walks through the basic functionality available using the community client.

      Asset Metrics

      • bbb_metrics_csv_exporter_using_plain_requests.py: Queries block-by-block metrics using the requests library and exports the output into a CSV file.
      • bbb_metrics_json_exporter.py: Queries block-by-block metrics and exports the output into a JSON file.
      • eod_metrics_csv_exporter.py: Exports a set of user-defined metrics and assets published at end-of-day and exports the output into a CSV file.
      • reference_rates_json_exporter.py: Queries Coin Metrics Reference Rates at a user-defined frequency for a set of assets, then exports the output into a JSON file.

      Market Data

      • books_json_exporter.py: Queries market orderbook data then exports the output into a JSON file.
      • candles_json_exporter.py: Queries market candles data then exports the output into a JSON file.
      • funding_rates_json_exporter.py: Queries market funding rates data then exports the output into a JSON file.
      • trades_csv_exporter.py: Queries market trades data then exports the output into a CSV file.
      • trades_json_exporter.py: Queries market trades data then exports the output into a JSON file.

      **Parallel processing exports * candles_csv_export.py: Exports market candles in parallel to many separate csv files * candles_json_export.py: Exports market candles in parallel to many separate json files * market_trades_list.py: Creates a list of market trades, using .parallel() feature to improve performance * market_orderbooks.py: Exports market orderbooks to many csv files * candles_csv_export_manual.py: Example of parallelism using the API Client without using the .parallel() feature * btc_1m_metrics_export.py: Example of splitting a large request for asset metrics by metric to improve performance, exporting a single csv and also separate csv. * market_orderbooks_csv_exporter_by_day.py: Example of splitting a market orderbook export up by day, to increase export performance

      "},{"location":"index.html#getting-timeseries-data","title":"Getting timeseries data","text":"

      For getting timeseries data you want to use methods of the client class that start with get_. It's important to note that the timeseries endpoints return data of a parent class type DataCollection. The DataCollection class is meant to support a variety of different data export and data manipulation use cases, so just calling one of the client methods such as data = client.get_market_trades(markets=\"coinbase-btc-usd-spot\") will not actually retrieve the data related to this API call. You must then call a function on this DataCollection such as data.export_to_csv(\"coinbase_btc_usd_spot_trades.csv) or data.to_dataframe() in order to access the data. There is more explicit examples below.If you are curious to see how the API calls are being made and with what parameters, instantiating the client with the verbose argument like CoinMetricsClient(api_key=<YOUR_API_KEY>, verbose=True) will print the API calls as well as information on performance to console.

      For example if you want to get a bunch of market data trades for coinbase btc-usd pair you can run something similar to the following:

      for trade in client.get_market_trades(\n    markets='coinbase-btc-usd-spot', \n    start_time='2020-01-01', \n    end_time='2020-01-03',\n    limit_per_market=10\n):\n    print(trade)\n
      This example uses the DataCollection as a Python iterator, so with each iteration of the Python for loop it will call the Coin Metrics API and return data. The default page_size for calls to the API is 100, so each call will return 100 trades until it reaches the end of the query. To get more trades in each API call, you can add the parameter page_size to the .get_market_trades() method call, up to a maximum of 10000.

      Or if you want to see daily btc asset metrics you can use something like this:

      for metric_data in client.get_asset_metrics(assets='btc', \n                                            metrics=['ReferenceRateUSD', 'BlkHgt', 'AdrActCnt',  \n                                                     'AdrActRecCnt', 'FlowOutBFXUSD'], \n                                            frequency='1d',\n                                            limit_per_asset=10):\n    print(metric_data)\n
      This will print you the requested metrics for all the days where we have any of the metrics present.

      "},{"location":"index.html#dataframes","title":"DataFrames","text":"

      (New in >=2021.9.30.14.30)

      Timeseries data can be transformed into a pandas dataframe by using the to_dataframe() method. The code snippet below shows how: 

      import pandas as pd\nfrom coinmetrics.api_client import CoinMetricsClient\nfrom os import environ\n\nclient = CoinMetricsClient()\ntrades = client.get_market_trades(\n    markets='coinbase-btc-usd-spot', \n    start_time='2021-09-19T00:00:00Z', \n    limit_per_market=10\n)\ntrades_df = trades.to_dataframe()\nprint(trades_df.head())\n
      If you want to use dataframes, then you will need to install pandas

      Notes

      • This only works with requests that return the type DataCollection. Thus, catalog requests, which return lists cannot be returned as dataframes. Please see the API Client Spec for a full list of requests and their return types.
      • API restrictions apply. Some requests may return empty results due to limited access to the API from you API key.
      "},{"location":"index.html#type-conversion","title":"Type Conversion","text":"

      (New in >=2021.12.17.18.00)

      As of version 2021.12.17.18.00 or later, outputs from the to_dataframe function automatically convert the dtypes for a dataframe to the optimal pandas types. 

      metrics_list = ['volume_trusted_spot_usd_1d', 'SplyFF', 'AdrBalUSD1Cnt']\nasset_list = ['btc','xmr']\nstart_time='2021-12-01'\ndf_metrics = client.get_asset_metrics(\n  assets=asset_list, metrics=metrics_list, start_time=start_time, limit_per_asset=3\n).to_dataframe()\nprint(df_metrics.dtypes)\n

      asset                          string\ntime                           datetime64[ns, tzutc()]\nAdrBalUSD1Cnt                   Int64\nSplyFF                        Float64\nvolume_trusted_spot_usd_1d    Float64\ndtype: object\n

      This can be turned off by setting optimize_pandas_types=False

      Alternatively, you can manually enter your own type conversion by passing in a dictionary for dtype_mapper. This can be done in conjunction with pandas' built in type optimizations. 

      mapper = {\n  'SplyFF': 'Float64',\n  'AdrBalUSD1Cnt': 'Int64',\n}\ndf_mapped = client.get_asset_metrics(\n  assets=asset_list, metrics=metrics_list, start_time=start_time, limit_per_asset=3\n).to_dataframe(dtype_mapper=mapper, optimize_pandas_types=True)\nprint(df_mapped.dtypes)\n

      asset                                          object\ntime                          datetime64[ns, tzutc()]\nAdrBalUSD1Cnt                                   Int64\nSplyFF                                        Float64\nvolume_trusted_spot_usd_1d                    float64\ndtype: object\n

      Or as strictly the only types in the dataframe

      dtype_mapper = {\n    'ReferenceRateUSD': np.float64,\n    'time': np.datetime64\n}\ndf = client.get_asset_metrics(\n  assets='btc', metrics='ReferenceRateUSD', start_time='2022-06-15', limit_per_asset=1\n).to_dataframe(dtype_mapper=dtype_mapper, optimize_pandas_types=False)\ndf.info()\n
      RangeIndex: 1 entries, 0 to 0\nData columns (total 3 columns):\n #   Column            Non-Null Count  Dtype         \n---  ------            --------------  -----         \n 0   asset             1 non-null      object        \n 1   time              1 non-null      datetime64[ns]\n 2   ReferenceRateUSD  1 non-null      float64       \ndtypes: datetime64[ns](1), float64(1), object(1)\nmemory usage: 152.0+ bytes\n

      Note that in order to pass a custom datetime object, setting a dtype_mapper is mandatory.

      Pandas type conversion tends to be more performant. But if there are custom operations that must be done using numpy datatypes, this option will let you perform them.

      "},{"location":"index.html#exporting-to-csv-and-json-files","title":"Exporting to csv and json files:","text":"

      You can also easily export timeseries data to csv and json files with builtin functions on the DataCollection type. For example this script will export Coinbase btc and eth trades for a date to csv and json files respectively: 

          start_date = datetime.date(year=2022, month=1, day=1)\n    end_date = datetime.datetime(year=2022, month=1, day=1)\n    market_trades_btc = client.get_market_trades(page_size=1000, markets=\"coinbase-btc-usd-spot\", start_time=start_date, end_time=end_date)\n    market_trades_btc.export_to_csv(\"jan_1_2022_coinbase_btc_trades.csv\")\n    market_trades_eth = client.get_market_trades(page_size=1000, markets=\"coinbase-eth-usd-spot\", start_time=start_date, end_time=end_date)\n    market_trades_eth.export_to_json(\"jan_1_2022_coinbase_eth.json\")\n

      "},{"location":"index.html#paging","title":"Paging","text":"

      You can make the datapoints to iterate from start (default) or from end.

      for that you should use a paging_from argument like the following: 

      from coinmetrics.api_client import CoinMetricsClient\nfrom coinmetrics.constants import PagingFrom\n\nclient = CoinMetricsClient()\n\nfor metric_data in client.get_asset_metrics(assets='btc', metrics=['ReferenceRateUSD'],\n                                            paging_from=PagingFrom.START):\n    print(metric_data)\n

      PagingFrom.END: is available but by default it will page from the start.

      "},{"location":"index.html#debugging-the-api-client","title":"Debugging the API Client","text":"

      There are two additional options for the API Client - debug_mode and verbose. These two options log network calls to the console, and in the case of debug_mode it will generate a log file of all the network requests and the time it takes to call them. These tools can be used to diagnose issues in your code and also to get a better understanding of request times so that users can write more performant code. For example, running the below code: 

      import os\n\nfrom coinmetrics.api_client import CoinMetricsClient\n\napi_key = os.environ['CM_API_KEY']\n\nif __name__ == '__main__':\n    client = CoinMetricsClient(api_key=api_key, debug_mode=True)\n    reference_rates_example = client.get_asset_metrics(assets=['btc', 'algo', 'eth'], metrics=['ReferenceRateUSD'])\n    for data in reference_rates_example:\n        continue\n

      The console output will look like: 

      [DEBUG] 2023-01-09 11:01:02,044 - Starting API Client debugging session. logging to stdout and cm_api_client_debug_2023_01_09_11_01_02.txt\n[DEBUG] 2023-01-09 11:01:02,044 - Using coinmetrics version 2022.11.14.16\n[DEBUG] 2023-01-09 11:01:02,044 - Current state of API Client, excluding API KEY: {'_verify_ssl_certs': True, '_api_base_url': 'https://api.coinmetrics.io/v4', '_ws_api_base_url': 'wss://api.coinmetrics.io/v4', '_http_header': {'Api-Client-Version': '2022.11.14.16'}, '_proxies': {'http': None, 'https': None}, 'debug_mode': True, 'verbose': False}\n[DEBUG] 2023-01-09 11:01:02,044 - Attempting to call url: timeseries/asset-metrics with params: {'assets': ['btc', 'algo', 'eth'], 'metrics': ['ReferenceRateUSD'], 'frequency': None, 'page_size': None, 'paging_from': 'start', 'start_time': None, 'end_time': None, 'start_height': None, 'end_height': None, 'start_inclusive': None, 'end_inclusive': None, 'timezone': None, 'sort': None, 'limit_per_asset': None}\n[DEBUG] 2023-01-09 11:01:02,387 - Response status code: 200 for url: https://api.coinmetrics.io/v4/timeseries/asset-metrics?api_key=[REDACTED]&assets=btc%2Calgo%2Ceth&metrics=ReferenceRateUSD&paging_from=start took: 0:00:00.342874 response body size (bytes): 9832\n[DEBUG] 2023-01-09 11:01:02,388 - Attempting to call url: timeseries/asset-metrics with params: {'assets': ['btc', 'algo', 'eth'], 'metrics': ['ReferenceRateUSD'], 'frequency': None, 'page_size': None, 'paging_from': 'start', 'start_time': None, 'end_time': None, 'start_height': None, 'end_height': None, 'start_inclusive': None, 'end_inclusive': None, 'timezone': None, 'sort': None, 'limit_per_asset': None, 'next_page_token': '0.MjAxOS0wOS0zMFQwMDowMDowMFo'}\n[DEBUG] 2023-01-09 11:01:02,559 - Response status code: 200 for url: https://api.coinmetrics.io/v4/timeseries/asset-metrics?api_key=[REDACTED]&assets=btc%2Calgo%2Ceth&metrics=ReferenceRateUSD&paging_from=start&next_page_token=0.MjAxOS0wOS0zMFQwMDowMDowMFo took: 0:00:00.171487 response body size (bytes): 9857\n
      Then it can be easier to understand what network calls the API Client is making, and where any issues may exist. If you wish to dig even deeper, you may consider modifying the _send_request() method of the API Client to log additional data about the state of your environment, or anything else that would help diagnose issues. You will notice a log file generated in the format cm_api_client_debug_2023_01_09_11_01_02.txt. This log file might be helpful for your own use or to give more context if you are working with Coin Metrics customer success.

      "},{"location":"index.html#ssl-certs-verification","title":"SSL Certs verification","text":"

      Sometimes your organization network have special rules on SSL certs verification and in this case you might face the following error when running the script: 

      SSLError: HTTPSConnectionPool(host='api.coinmetrics.io', port=443): Max retries exceeded with url: <some_url_path> (Caused by SSLError(SSLCertVerificationError(1, '[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: self signed certificate in certificate chain (_ssl.c:1123)')))\n

      In this case, you can pass an option during client initialization to disable ssl verification for requests like this:

      client = CoinMetricsClient(verify_ssl_certs=False)\n

      We don't recommend setting it to False by default and you should make sure you understand the security risks of disabling SSL certs verification.

      Additionally, you may choose to specify the path to the SSL certificates on your machine. This may cause errors where Python is unable to locate the certificates on your machine, particularly when using Python virtual environments. 

      from coinmetrics.api_client import CoinMetricsClient\nSSL_CERT_LOCATION = '/Users/<USER_NAME>/Library/Python/3.8/lib/python/site-packages/certifi/cacert.pem'\nclient = CoinMetricsClient(verify_ssl_certs=SSL_CERT_LOCATION)\n

      A quick way to find the certs on your machine is: python3 -c \"import requests; print(requests.certs.where())\" And note that this will change based on whether or not you are using a Python virtual environment or not

      "},{"location":"index.html#installing-and-running-coinmetrics-package-and-other-python-packages-behind-a-secure-python-network","title":"Installing and running coinmetrics package and other python packages behind a secure python network","text":"

      Related to SSL Certs verification, you may have trouble installing and updating PyPi packages to your local environment. So you may need to choose the best solution for your company and environment - either using package managers or installing offline.

      "},{"location":"index.html#installing-using-package-managers","title":"Installing using package managers","text":"

      Full instructions for setting up your environment to use conda, pip, yarn, npm, etc. can be found here. Additionally, a workaround to disable SSL verification when installing a trusted Python package is this: 

      pip install --trusted-host pypi.python.org <packagename>\n
      Although it is important to make sure you understand the risks associated with disabling SSL verification and ensure compliance with company policies.

      "},{"location":"index.html#installing-python-packages-locally-offline","title":"Installing Python packages locally/ offline","text":"

      It may be easier to download and install the package locally. Steps: 1. Download the files for the Coin Metrics API Client from PyPi 2. Install it locally

      "},{"location":"index.html#requests-proxy","title":"Requests Proxy","text":"

      Sometimes your organization has special rules on making requests to third parties and you have to use proxies in order to comply with the rules.

      For proxies that don't require auth you can specify them similar to this example: 

      client = CoinMetricsClient(proxy_url=f'http://<hostname>:<port>')\n

      For proxies that require auth, you should be able to specify username and password similar to this example: 

      client = CoinMetricsClient(proxy_url=f'http://<username>:<password>@<hostname>:<port>')\n

      "},{"location":"index.html#extended-documentation","title":"Extended documentation","text":"

      For more information about the available methods in the client please reference API Client Spec

      "},{"location":"FlatFilesExport.html","title":"Flat Files Exporter","text":""},{"location":"FlatFilesExport.html#exporting-flat-files","title":"Exporting flat files","text":"

      Along with the API client we provide a data exporting tool which allow downloading large amount of data as flat files rather than from the API itself. The tool allows users to download daily files over our entire provided history for market trades, market quotes, and market candles.

      "},{"location":"FlatFilesExport.html#authorization-for-flat-files-download","title":"Authorization for flat files download","text":"

      This program was set up to easily access a flat files server provided to Coin Metrics commercial clients. If you are a community API user or a client without access to this server, a 403 error will be returned. If you are a community API user and looking to get historical asset prices, Coin Metrics does offer historical asset prices for download. The CoinMetricsDataExporter class will return a CoinMetricsUnauthorizedException if your API key is not authorized to access this server. The flat files export is considered a separate product from the Coin Metrics API, if you would like to gain access or believe you should have access but do not, please contact coinmetrics support.

      "},{"location":"FlatFilesExport.html#installation-and-set-up","title":"Installation and set up","text":"

      The tool is installed a long with the coinmetrics-api-client, it's recommended to create a new Python [virtual environment] for your project and install the package: 

      python -m venv .venv \nsource .venv/bin/activate \npip install coinmetrics-api-client\n

      The export tool requires access to a CoinMetrics API key, and is accessed with the environment variable CM_API_KEY, the easiest way to set this is to run export CM_API_KEY=<API_KEY> in your terminal on MacOS/Linux or just set CM_API_KEY=<API_KEY> on Windows. Additionally, you have the option of passing it in which each command instead.

      To confirm the tool is installed correct execute the command coinmetrics export --help which brings up relevant documentation. At the bottom of the help message all the available commands are shown: 

      Commands:\n  get-asset-pairs\n  get-exchanges\n  market-candles-future  Used to export data related to future market...\n  market-candles-spot    Used to export data related to spot market candles.\n  market-quotes-future   Used to export data related to future market...\n  market-quotes-spot     Used to export data related to spot market quotes...\n  market-trades-future   Used to export data related to future market...\n  market-trades-spot     Used to export data related to spot market trades.\n

      "},{"location":"FlatFilesExport.html#exporting-market-trades-files","title":"Exporting Market Trades Files","text":"

      Further documentation is available on any of the commands by running coinmetrics export <command> --help, for example running coinmetrics export market-trades-spot --help prints: 

      Usage: coinmetrics export market-trades-spot [OPTIONS] EXCHANGES [START_DATE]:\n                                             [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m\n                                             -%d %H:%M:%S] [END_DATE]:[%Y-%m-%\n                                             d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d\n                                             %H:%M:%S]\n\n  Used to export data related to spot market trades. Format: coinmetrics\n  export market-trades-spot <exchanges> <start_date> <end_date> Example:\n  coinmetrics export market-trades-spot coinbase,binance 2022-01-01\n  2022-01-03.\n\nArguments:\n  EXCHANGES                       Pass in arguments as a list of strings\n                                  separated by by commas i.e.\n                                  binance,coinbase,bitmex  [required]\n\n  [START_DATE]:[%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]\n                                  [default: 2022-08-10]\n  [END_DATE]:[%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]\n                                  [default: 2022-08-10]\n\nOptions:\n  --output-format TEXT        [default: json.gz]\n  --threaded / --no-threaded  [default: False]\n  --api-key TEXT\n  --help                      Show this message and exit.\n

      "},{"location":"FlatFilesExport.html#example","title":"Example:","text":"

      If you want to get the flat files for spot-market-trades from coinbase and binance for the first 5 days of June 2022: coinmetrics export market-trades-spot binance,coinbase 2022-06-01 2022-06-05

      In your current directory you will see: 

      market-trades-spot\n\u251c\u2500\u2500 binance\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 2022-06-01.json.gz\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 2022-06-02.json.gz\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 2022-06-03.json.gz\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 2022-06-04.json.gz\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 2022-06-05.json.gz\n\u2514\u2500\u2500 coinbase\n    \u251c\u2500\u2500 2022-06-01.json.gz\n    \u251c\u2500\u2500 2022-06-02.json.gz\n    \u251c\u2500\u2500 2022-06-03.json.gz\n    \u251c\u2500\u2500 2022-06-04.json.gz\n    \u2514\u2500\u2500 2022-06-05.json.gz\n
      By default the files are downloaded as gzipped json files - they are compressed in order to take up less space. If you instead wish to download the data as a csv or json you can use: coinmetrics export market-trades-spot binance,coinbase 2022-06-01 2022-06-05 --output-format csv

      The functionality for getting future, rather than spot market trades is the exact same, just replace market-trades-spot with market-trades-future

      In order to figure out what exchanges are supported for a flat file type you can run coinmetrics export get-exchanges <command>, so in this case running coinmetrics export get-exchanges market-trades-spot

      "},{"location":"FlatFilesExport.html#exporting-market-quotes","title":"Exporting market quotes","text":"

      Market quotes are similar to market trades, except data is separated by exchange and by asset-pair. So you must provide both what exchanges you are querying as well the specific asset pairs.

      Example if you wanted to export files to market quotes for ETHUSDT and BTCUSDT over a certain timeframe as json files: coinmetrics export market-quotes-spot binance ETHUSDT,BTCUSDT 2022-03-03 2022-03-05 --output-format json

      In order to find what asset pairs are availible you can query this information with coinmetrics export get-asset-pairs <command> <exchange> so in this case, for Binance you would run coinmetrics export get-asset-pairs market-quotes-spot binance. If you are comfortable with command line tools it may be helpful to string this with unix command line tools like grep. For example, to find all the BTC related pairs for binance you might run coinmetrics export get-asset-pairs market-quotes-spot binance | grep BTC.

      The functionality is the same for market-qutoes-futures.

      "},{"location":"FlatFilesExport.html#exporting-market-candles","title":"Exporting market candles","text":"

      Exporting market candles also functions similar to market trades, however you must specify a frequency in addition to an exchange and date range. The frequency denominates the range which the market candles cover. These frequencies are currently \"1m\", \"5m\", \"10m\", \"15m\", \"30m\", \"1h\", and \"1d\".

      Example to download 5m spot market candles for coinbase and binance for a date range: coinmetrics export market-candles-spot 5m coinbase,binance 2022-01-01 2022-01-05 Which creates these files: 

      market-candles-spot-5m\n\u251c\u2500\u2500 binance\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 2022-01-01.json.gz\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 2022-01-02.json.gz\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 2022-01-03.json.gz\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 2022-01-04.json.gz\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 2022-01-05.json.gz\n\u2514\u2500\u2500 coinbase\n    \u251c\u2500\u2500 2022-01-01.json.gz\n    \u251c\u2500\u2500 2022-01-02.json.gz\n    \u251c\u2500\u2500 2022-01-03.json.gz\n    \u251c\u2500\u2500 2022-01-04.json.gz\n    \u2514\u2500\u2500 2022-01-05.json.gz\n

      The functionality is the same for market-candles-future

      "},{"location":"FlatFilesExport.html#using-api-key-without-setting-an-environment-variable","title":"Using API Key without setting an environment variable","text":"

      If you don't wish to put your CoinMetrics API key in your environment, you may also pass it in with any command with the flag --api-key. Example: coinmetrics export market-candles-spot 5m coinbase,binance 2022-01-01 2022-01-05 --api-key <API_KEY>

      "},{"location":"FlatFilesExport.html#downloading-files-in-parallel","title":"Downloading files in parallel","text":"

      If you are downloading many files and want to speed the process up there is an option to concurrently download multiple rather than one at a time, using the --threaded flag. Example: coinmetrics export market-candles-spot 5m coinbase,binance 2022-01-01 2022-01-05 --threaded Note that using this option will consume more system resources and network bandwith, and the download speed will still be limited by egress from the files server as well as the specs of your machine.

      "},{"location":"FlatFilesExport.html#using-the-coinmetricsdataexporter-in-python-instead-of-cli","title":"Using the CoinMetricsDataExporter in Python instead of CLI","text":"

      Depending on the use case it might be more convenient to use the CoinMetricsDataExporter directly in Python rather than from the CLI. There is several examples here as well as one below: 

      from coinmetrics.data_exporter import CoinMetricsDataExporter\nfrom datetime import datetime\n\nCM_API_KEY = \"<YOUR_API_KEY>\"\ndata_exporter = CoinMetricsDataExporter(api_key=CM_API_KEY)\n\nif __name__ == \"__main__\":\n\"\"\"\n    This script will export all the daily market-trades-spot files for Coinbase and Gemini for the month of January  \n    \"\"\"\n    start_date = datetime(2019, 1, 1)\n    end_date = datetime(2019, 1, 31)\n    exchanges = [\"coinbase\",\"gemini\"]\n    data_exporter.export_market_trades_spot_data(start_date=start_date, end_date=end_date, exchanges=exchanges, threaded=True)\n

      "},{"location":"api_client.html","title":"API Client Spec","text":""},{"location":"api_client.html#coinmetricsapi_client","title":"coinmetrics.api_client","text":""},{"location":"api_client.html#coinmetricsclient-objects","title":"CoinMetricsClient Objects","text":"
      class CoinMetricsClient()\n
      "},{"location":"api_client.html#catalog_assets","title":"catalog_assets","text":"
      def catalog_assets(\n        assets: Optional[Union[List[str], str]] = None,\n        include: Optional[Union[List[str], str]] = None,\n        exclude: Optional[Union[List[str], str]] = None) -> CatalogAssetsData\n

      Returns meta information about available assets.

      Arguments:

      • assets (list(str), str): A single asset or a list of assets to return info for. If no assets provided, all available assets are returned.
      • include (list(str), str): list of fields to include in response. Supported values are metrics, markets, exchanges. Included by default if omitted.
      • exclude (list(str), str): list of fields to include in response. Supported values are metrics, markets, exchanges. Included by default if omitted.

      Returns:

      list(dict(str, any)): Information that is available for requested assets, like: Full name, metrics and available frequencies, markets, exchanges, etc.

      "},{"location":"api_client.html#catalog_asset_alerts","title":"catalog_asset_alerts","text":"
      def catalog_asset_alerts(\n        assets: Optional[Union[str, List[str]]] = None,\n        alerts: Optional[Union[str,\n                               List[str]]] = None) -> CatalogAssetAlertsData\n

      Arguments:

      • assets (Union[str, List[str]]): Comma separated list of assets. By default all assets are returned.
      • alerts (Union[str, List[str]]): Comma separated list of asset alert names. By default all asset alerts are returned.

      Returns:

      CatalogAssetAlertsData: List of asset alerts.

      "},{"location":"api_client.html#catalog_asset_chains","title":"catalog_asset_chains","text":"
      def catalog_asset_chains(\n        assets: Optional[Union[str,\n                               List[str]]] = None) -> CatalogAssetChainsData\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.

      Returns:

      CatalogAssetChainsData: List of asset chains assets

      "},{"location":"api_client.html#catalog_mempool_feerates","title":"catalog_mempool_feerates","text":"
      def catalog_mempool_feerates(\n    assets: Optional[Union[str,\n                           List[str]]] = None) -> CatalogMempoolFeeratesData\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.

      Returns:

      CatalogMempoolFeeratesData: List of mempool feerates assets

      "},{"location":"api_client.html#catalog_mining_pool_tips_summaries","title":"catalog_mining_pool_tips_summaries","text":"
      def catalog_mining_pool_tips_summaries(\n    assets: Optional[Union[str,\n                           List[str]]] = None) -> CatalogMiningPoolTipsData\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.

      Returns:

      CatalogMiningPoolTipsData: List of mining pool tips assets

      "},{"location":"api_client.html#catalog_transaction_tracker_assets","title":"catalog_transaction_tracker_assets","text":"
      def catalog_transaction_tracker_assets(\n    assets: Optional[Union[str, List[str]]] = None\n) -> CatalogTransactionTrackerData\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.

      Returns:

      CatalogTransactionTrackerData: List of transaction tracker assets

      "},{"location":"api_client.html#catalog_asset_pairs","title":"catalog_asset_pairs","text":"
      def catalog_asset_pairs(\n    asset_pairs: Optional[Union[List[str],\n                                str]] = None) -> CatalogAssetPairsData\n

      Returns meta information about available asset-asset pairs

      Arguments:

      • asset_pairs (list(str), str): A single asset-asset pair (e.g. \"btc-eth\") or a list of asset-asset pairs to return info for. If none are provided, all available pairs are returned.

      Returns:

      list(dict(str, any)): Information that is available for requested asset-asset pair like metrics and their respective frequencies and time ranges

      "},{"location":"api_client.html#catalog_asset_metrics","title":"catalog_asset_metrics","text":"
      def catalog_asset_metrics(\n        metrics: Optional[Union[List[str], str]] = None,\n        reviewable: Optional[bool] = None) -> CatalogMetricsData\n

      Returns list of available asset metrics along with information for them like

      description, category, precision and assets for which a metric is available.

      Arguments:

      • metrics (list(str), str): A single asset metric name or a list of metrics to return info for. If no metrics provided, all available metrics are returned.
      • reviewable (bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.

      Returns:

      list(dict(str, any)): Information about asset metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is available.

      "},{"location":"api_client.html#catalog_exchange_metrics","title":"catalog_exchange_metrics","text":"
      def catalog_exchange_metrics(\n        metrics: Optional[Union[List[str], str]] = None,\n        reviewable: Optional[bool] = None) -> CatalogMetricsData\n

      Returns list of available exchange metrics along with information for them like

      description, category, precision and assets for which a metric is available.

      Arguments:

      • metrics (list(str), str): A single exchange metric name or a list of metrics to return info for. If no metrics provided, all available metrics are returned.
      • reviewable (bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.

      Returns:

      list(dict(str, any)): Information about exchange metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is available.

      "},{"location":"api_client.html#catalog_exchange_asset_metrics","title":"catalog_exchange_asset_metrics","text":"
      def catalog_exchange_asset_metrics(\n        metrics: Optional[Union[List[str], str]] = None,\n        reviewable: Optional[bool] = None) -> CatalogExchangeAssetMetricsData\n

      Returns list of available exchange metrics along with information for them like

      description, category, precision and assets for which a metric is available.

      Arguments:

      • metrics (list(str), str): A single exchange metric name or a list of metrics to return info for. If no metrics provided, all available metrics are returned.
      • reviewable (bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.

      Returns:

      list(dict(str, any)): Information about exchange metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is available.

      "},{"location":"api_client.html#catalog_pair_metrics","title":"catalog_pair_metrics","text":"
      def catalog_pair_metrics(\n        metrics: Optional[Union[List[str], str]] = None,\n        reviewable: Optional[bool] = None) -> CatalogPairMetricsData\n

      Returns list of available pair metrics along with information for them like

      description, category, precision and assets for which a metric is available.

      Arguments:

      • metrics (list(str), str): A single pair metric name or a list of metrics to return info for. If no metrics provided, all available metrics are returned.
      • reviewable (bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.

      Returns:

      list(dict(str, any)): Information about pair metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is available.

      "},{"location":"api_client.html#catalog_institution_metrics","title":"catalog_institution_metrics","text":"
      def catalog_institution_metrics(\n        metrics: Optional[Union[List[str], str]] = None,\n        reviewable: Optional[bool] = None) -> CatalogInstitutionMetricsData\n

      Returns list of available institution metrics along with information for them like

      description, category, precision and assets for which a metric is available.

      Arguments:

      • metrics (list(str), str): A single institution metric name or a list of metrics to return info for. If no metrics provided, all available metrics are returned.
      • reviewable (bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.

      Returns:

      list(dict(str, any)): Information about institution metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is available.

      "},{"location":"api_client.html#catalog_asset_pair_candles","title":"catalog_asset_pair_candles","text":"
      def catalog_asset_pair_candles(\n    asset_pairs: Optional[Union[List[str], str]] = None\n) -> CatalogAssetPairCandlesData\n

      Returns meta information about available asset-asset pairs

      Arguments:

      • asset_pairs (list(str), str): A single asset-asset pair (e.g. \"btc-eth\") or a list of asset-asset pairs to return info for. If none are provided, all available pairs are returned.

      Returns:

      list(dict(str, any)): Returns a list of available asset pair candles along with the time ranges of available data per candle duration.

      "},{"location":"api_client.html#catalog_exchanges","title":"catalog_exchanges","text":"
      def catalog_exchanges(\n        exchanges: Optional[Union[List[str],\n                                  str]] = None) -> CatalogExchangesData\n

      Returns meta information about exchanges.

      Arguments:

      • exchanges (list(str), str): A single exchange name or a list of exchanges to return info for. If no exchanges provided, all available exchanges are returned.

      Returns:

      list(dict(str, any)): Information that is available for requested exchanges, like: markets, min and max time available.

      "},{"location":"api_client.html#catalog_exchange_assets","title":"catalog_exchange_assets","text":"
      def catalog_exchange_assets(\n    exchange_assets: Optional[Union[List[str], str]] = None\n) -> CatalogExchangeAssetsData\n

      Returns meta information about available exchange-asset pairs

      Arguments:

      • exchange_assets (list(str), str): A single exchange-asset pair (e.g. \"binance-btc\") or a list of exchange-asset pairs to return info for. If none are provided, all available pairs are returned.

      Returns:

      list(dict(str, any)): Information that is available for requested exchange-asset pair like metrics and their respective frequencies and time ranges

      "},{"location":"api_client.html#catalog_indexes","title":"catalog_indexes","text":"
      def catalog_indexes(\n        indexes: Optional[Union[List[str], str]] = None) -> CatalogIndexesData\n

      Returns meta information about available indexes.

      Arguments:

      • indexes (list(str), str): A single index name or a list of indexes to return info for. If no indexes provided, all available indexes are returned.

      Returns:

      list(dict(str, any)): Information that is available for requested indexes, like: Full name, and available frequencies.

      "},{"location":"api_client.html#catalog_index_candles","title":"catalog_index_candles","text":"
      def catalog_index_candles(\n    indexes: Optional[Union[List[str],\n                            str]] = None) -> CatalogMarketCandlesData\n

      Returns meta information about available index candles.

      Arguments:

      • indexes (list(str), str): A single index name or a list of indexes to return info for. If no indexes provided, all available index candles are returned.

      Returns:

      list(dict(str, any)): Information that is available for requested index candles, like: Full name, and available frequencies.

      "},{"location":"api_client.html#catalog_institutions","title":"catalog_institutions","text":"
      def catalog_institutions(\n    institutions: Optional[Union[List[str], str]] = None\n) -> CatalogInstitutionsData\n

      Returns meta information about available institutions

      Arguments:

      • institutions (list(str), str): A single institution (e.g. \"grayscale\") or a list of institutions to return info for. If none are provided, all available pairs are returned.

      Returns:

      list(dict(str, any)): Information that is available for requested institution like metrics and their respective frequencies and time ranges.

      "},{"location":"api_client.html#catalog_markets","title":"catalog_markets","text":"
      def catalog_markets(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        include: Optional[Union[List[str], str]] = None,\n        exclude: Optional[Union[List[str], str]] = None) -> CatalogMarketsData\n

      Returns list of available markets that correspond to a filter. If no filter is set, returns all available assets.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.
      • include (list(str), str): list of fields to include in response. Supported values are trades, orderbooks, quotes, funding_rates, openinterest, liquidations. Included by default if omitted.
      • exclude (list(str), str): list of fields to exclude from response. Supported values are trades, orderbooks, quotes, funding_rates, openinterest, liquidations. Included by default if omitted.

      Returns:

      list(dict(str, any)): Information about markets that correspond to a filter along with meta information like: type of market and min and max available time frames.

      "},{"location":"api_client.html#catalog_market_trades","title":"catalog_market_trades","text":"
      def catalog_market_trades(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of markets with trades support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about market trades that are available for the provided filter, as well as the time frames they are available

      "},{"location":"api_client.html#catalog_metrics","title":"catalog_metrics","text":"
      def catalog_metrics(metrics: Optional[Union[List[str], str]] = None,\n                    reviewable: Optional[bool] = None) -> CatalogMetricsData\n

      Returns list of available metrics along with information for them like

      description, category, precision and assets for which a metric is available.

      Arguments:

      • metrics (list(str), str): A single metric name or a list of metrics to return info for. If no metrics provided, all available metrics are returned.
      • reviewable (bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.

      Returns:

      list(dict(str, any)): Information about metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is available.

      "},{"location":"api_client.html#catalog_market_metrics","title":"catalog_market_metrics","text":"
      def catalog_market_metrics(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketMetricsData\n

      Returns list of available markets with metrics support along woth time ranges of available data per metric.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about markets that correspond to a filter along with meta information like: type of market and min and max available time frames.

      "},{"location":"api_client.html#catalog_market_candles","title":"catalog_market_candles","text":"
      def catalog_market_candles(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketCandlesData\n

      Returns list of available markets with candles support along woth time ranges of available data per metric.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about markets that correspond to a filter along with meta information like: type of market and min and max available time frames.

      "},{"location":"api_client.html#catalog_market_orderbooks","title":"catalog_market_orderbooks","text":"
      def catalog_market_orderbooks(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketOrderbooksData\n

      Returns a list of markets with orderbooks support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about markets orderbooks that correspond to a filter

      "},{"location":"api_client.html#catalog_market_quotes","title":"catalog_market_quotes","text":"
      def catalog_market_quotes(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of markets with quotes support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about markets quotes that correspond to a filter

      "},{"location":"api_client.html#catalog_market_funding_rates","title":"catalog_market_funding_rates","text":"
      def catalog_market_funding_rates(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of markets with funding rates support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about funding rates that correspond to a filter

      "},{"location":"api_client.html#catalog_market_contract_prices","title":"catalog_market_contract_prices","text":"
      def catalog_market_contract_prices(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        limit: Optional[str] = None) -> CatalogMarketContractPrices\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • limit (Optional[str]): Limit of response items. none means no limit.

      Returns:

      CatalogMarketContractPrices: List of contract prices statistics.

      "},{"location":"api_client.html#catalog_market_implied_volatility","title":"catalog_market_implied_volatility","text":"
      def catalog_market_implied_volatility(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        limit: Optional[str] = None) -> CatalogMarketImpliedVolatility\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • limit (Optional[str]): Limit of response items. none means no limit.

      Returns:

      CatalogMarketImpliedVolatility: List of implied volatility statistics.

      "},{"location":"api_client.html#catalog_market_greeks","title":"catalog_market_greeks","text":"
      def catalog_market_greeks(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of markets with greeks support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about market greeks that correspond to the filter

      "},{"location":"api_client.html#catalog_market_open_interest","title":"catalog_market_open_interest","text":"
      def catalog_market_open_interest(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of markets with open interest support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about market open interest that correspond to a filter

      "},{"location":"api_client.html#catalog_market_liquidations","title":"catalog_market_liquidations","text":"
      def catalog_market_liquidations(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of markets with liquidations support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about market liquidations that correspond to a filter

      "},{"location":"api_client.html#catalog_full_assets","title":"catalog_full_assets","text":"
      def catalog_full_assets(\n        assets: Optional[Union[List[str], str]] = None,\n        include: Optional[Union[List[str], str]] = None,\n        exclude: Optional[Union[List[str], str]] = None) -> CatalogAssetsData\n

      Returns meta information about supported assets.

      Arguments:

      • assets (list(str), str): A single asset or a list of assets to return info for. If no assets provided, all supported assets are returned.
      • include (list(str), str): list of fields to include in response. Supported values are metrics, markets, exchanges. Included by default if omitted.
      • exclude (list(str), str): list of fields to exclude from response. Supported values are metrics, markets, exchanges. Included by default if omitted.

      Returns:

      list(dict(str, any)): Information that is supported for requested assets, like: Full name, metrics and supported frequencies, markets, exchanges, etc.

      "},{"location":"api_client.html#catalog_full_asset_metrics","title":"catalog_full_asset_metrics","text":"
      def catalog_full_asset_metrics(\n        metrics: Optional[Union[List[str], str]] = None,\n        reviewable: Optional[bool] = None) -> CatalogMetricsData\n

      Returns list of all available asset metrics along with information for them like

      description, category, precision and assets for which a metric is available.

      Arguments:

      • metrics (list(str), str): A single asset metric name or a list of metrics to return info for. If no metrics provided, all available metrics are returned.
      • reviewable (bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.

      Returns:

      list(dict(str, any)): Information about asset metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is available.

      "},{"location":"api_client.html#catalog_full_asset_alerts","title":"catalog_full_asset_alerts","text":"
      def catalog_full_asset_alerts(\n        assets: Optional[Union[str, List[str]]] = None,\n        alerts: Optional[Union[str,\n                               List[str]]] = None) -> CatalogAssetAlertsData\n

      Arguments:

      • assets (Union[str, List[str]]): Comma separated list of assets. By default all assets are returned.
      • alerts (Union[str, List[str]]): Comma separated list of asset alert names. By default all asset alerts are returned.

      Returns:

      CatalogAssetAlertsData: List of asset alerts.

      "},{"location":"api_client.html#catalog_full_asset_chains","title":"catalog_full_asset_chains","text":"
      def catalog_full_asset_chains(\n        assets: Optional[Union[str,\n                               List[str]]] = None) -> CatalogAssetChainsData\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.

      Returns:

      CatalogAssetChainsData: List of asset chains assets

      "},{"location":"api_client.html#catalog_full_mempool_feerates","title":"catalog_full_mempool_feerates","text":"
      def catalog_full_mempool_feerates(\n    assets: Optional[Union[str,\n                           List[str]]] = None) -> CatalogMempoolFeeratesData\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.

      Returns:

      CatalogMempoolFeeratesData: List of mempool feerates assets

      "},{"location":"api_client.html#catalog_full_mining_pool_tips_summaries","title":"catalog_full_mining_pool_tips_summaries","text":"
      def catalog_full_mining_pool_tips_summaries(\n    assets: Optional[Union[str,\n                           List[str]]] = None) -> CatalogMiningPoolTipsData\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.

      Returns:

      CatalogMiningPoolTipsData: List of mining pool tips assets

      "},{"location":"api_client.html#catalog_full_transaction_tracker_assets","title":"catalog_full_transaction_tracker_assets","text":"
      def catalog_full_transaction_tracker_assets(\n    assets: Optional[Union[str, List[str]]] = None\n) -> CatalogTransactionTrackerData\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.

      Returns:

      CatalogTransactionTrackerData: List of transaction tracker assets

      "},{"location":"api_client.html#catalog_full_asset_pairs","title":"catalog_full_asset_pairs","text":"
      def catalog_full_asset_pairs(\n    asset_pairs: Optional[Union[List[str],\n                                str]] = None) -> CatalogAssetPairsData\n

      Returns meta information about supported asset-asset pairs

      Arguments:

      • asset_pairs (list(str), str): A single asset-asset pair (e.g. \"btc-eth\") or a list of asset-asset pairs to return info for. If none are provided, all supported pairs are returned.

      Returns:

      list(dict(str, any)): Information that is supported for requested asset-asset pair like metrics and their respective frequencies and time ranges

      "},{"location":"api_client.html#catalog_full_pair_metrics","title":"catalog_full_pair_metrics","text":"
      def catalog_full_pair_metrics(\n        metrics: Optional[Union[List[str], str]] = None,\n        reviewable: Optional[bool] = None) -> CatalogPairMetricsData\n

      Returns list of all available pair metrics along with information for them like

      description, category, precision and assets for which a metric is available.

      Arguments:

      • metrics (list(str), str): A single pair metric name or a list of metrics to return info for. If no metrics provided, all available metrics are returned.
      • reviewable (bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.

      Returns:

      list(dict(str, any)): Information about pair metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is available.

      "},{"location":"api_client.html#catalog_full_institution_metrics","title":"catalog_full_institution_metrics","text":"
      def catalog_full_institution_metrics(\n        metrics: Optional[Union[List[str], str]] = None,\n        reviewable: Optional[bool] = None) -> CatalogInstitutionMetricsData\n

      Returns list of available institution metrics along with information for them like

      description, category, precision and assets for which a metric is available.

      Arguments:

      • metrics (list(str), str): A single institution metric name or a list of metrics to return info for. If no metrics provided, all available metrics are returned.
      • reviewable (bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.

      Returns:

      list(dict(str, any)): Information about institution metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is available.

      "},{"location":"api_client.html#catalog_full_asset_pair_candles","title":"catalog_full_asset_pair_candles","text":"
      def catalog_full_asset_pair_candles(\n    asset_pairs: Optional[Union[List[str], str]] = None\n) -> CatalogAssetPairCandlesData\n

      Returns meta information about available asset-asset pairs

      Arguments:

      • asset_pairs (list(str), str): A single asset-asset pair (e.g. \"btc-eth\") or a list of asset-asset pairs to return info for. If none are provided, all available pairs are returned.

      Returns:

      list(dict(str, any)): Returns a list of available asset pair candles along with the time ranges of available data per candle duration.

      "},{"location":"api_client.html#catalog_full_exchanges","title":"catalog_full_exchanges","text":"
      def catalog_full_exchanges(\n        exchanges: Optional[Union[List[str],\n                                  str]] = None) -> CatalogExchangesData\n

      Returns meta information about exchanges.

      Arguments:

      • exchanges (list(str), str): A single exchange name or a list of exchanges to return info for. If no exchanges provided, all supported exchanges are returned.

      Returns:

      list(dict(str, any)): Information that is supported for requested exchanges, like: markets, min and max time supported.

      "},{"location":"api_client.html#catalog_full_exchange_assets","title":"catalog_full_exchange_assets","text":"
      def catalog_full_exchange_assets(\n    exchange_assets: Optional[Union[List[str], str]] = None\n) -> CatalogExchangeAssetsData\n

      Returns meta information about supported exchange-asset pairs

      Arguments:

      • exchange_assets (list(str), str): A single exchange-asset pair (e.g. \"binance-btc\") or a list of exchange-asset pairs to return info for. If none are provided, all supported pairs are returned.

      Returns:

      list(dict(str, any)): Information that is supported for requested exchange-asset pair like metrics and their respective frequencies and time ranges

      "},{"location":"api_client.html#catalog_full_exchange_metrics","title":"catalog_full_exchange_metrics","text":"
      def catalog_full_exchange_metrics(\n        metrics: Optional[Union[List[str], str]] = None,\n        reviewable: Optional[bool] = None) -> CatalogMetricsData\n

      Returns list of all available exchange metrics along with information for them like

      description, category, precision and assets for which a metric is available.

      Arguments:

      • metrics (list(str), str): A single exchange metric name or a list of metrics to return info for. If no metrics provided, all available metrics are returned.
      • reviewable (bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.

      Returns:

      list(dict(str, any)): Information about exchange metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is available.

      "},{"location":"api_client.html#catalog_full_exchange_asset_metrics","title":"catalog_full_exchange_asset_metrics","text":"
      def catalog_full_exchange_asset_metrics(\n        metrics: Optional[Union[List[str], str]] = None,\n        reviewable: Optional[bool] = None) -> CatalogExchangeAssetMetricsData\n

      Returns list of available exchange metrics along with information for them like

      description, category, precision and assets for which a metric is available.

      Arguments:

      • metrics (list(str), str): A single exchange metric name or a list of metrics to return info for. If no metrics provided, all available metrics are returned.
      • reviewable (bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.

      Returns:

      list(dict(str, any)): Information about exchange metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is available.

      "},{"location":"api_client.html#catalog_full_indexes","title":"catalog_full_indexes","text":"
      def catalog_full_indexes(\n        indexes: Optional[Union[List[str], str]] = None) -> CatalogIndexesData\n

      Returns meta information about supported indexes.

      Arguments:

      • indexes (list(str), str): A single index name or a list of indexes to return info for. If no indexes provided, all supported indexes are returned.

      Returns:

      list(dict(str, any)): Information that is supported for requested indexes, like: Full name, and supported frequencies.

      "},{"location":"api_client.html#catalog_full_index_candles","title":"catalog_full_index_candles","text":"
      def catalog_full_index_candles(\n    indexes: Optional[Union[List[str],\n                            str]] = None) -> CatalogMarketCandlesData\n

      Returns meta information about supported index candles.

      Arguments:

      • indexes (list(str), str): A single index name or a list of indexes to return info for. If no indexes provided, all supported indexes are returned.

      Returns:

      list(dict(str, any)): Information that is supported for requested index candles, like: Full name, and supported frequencies.

      "},{"location":"api_client.html#catalog_full_institutions","title":"catalog_full_institutions","text":"
      def catalog_full_institutions(\n    institutions: Optional[Union[List[str], str]] = None\n) -> CatalogInstitutionsData\n

      Returns meta information about supported institutions

      Arguments:

      • institutions (list(str), str): A single institution (e.g. \"grayscale\") or a list of institutions to return info for. If none are provided, all supported pairs are returned.

      Returns:

      list(dict(str, any)): Information that is supported for requested institution like metrics and their respective frequencies and time ranges.

      "},{"location":"api_client.html#catalog_full_markets","title":"catalog_full_markets","text":"
      def catalog_full_markets(markets: Optional[Union[List[str], str]] = None,\n                         market_type: Optional[str] = None,\n                         exchange: Optional[str] = None,\n                         base: Optional[str] = None,\n                         quote: Optional[str] = None,\n                         asset: Optional[str] = None,\n                         symbol: Optional[str] = None,\n                         include: Optional[str] = None,\n                         exclude: Optional[str] = None) -> CatalogMarketsData\n

      Returns list of supported markets that correspond to a filter. If no filter is set, returns all supported assets.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.
      • include (list(str), str): ist of fields to include in response. Supported values are trades, orderbooks, quotes, funding_rates, openinterest, liquidations. Included by default if omitted.
      • exclude (list(str), str): list of fields to exclude from response. Supported values are trades, orderbooks, quotes, funding_rates, openinterest, liquidations. Included by default if omitted.

      Returns:

      list(dict(str, any)): Information about markets that correspond to a filter along with meta information like: type of market and min and max supported time frames.

      "},{"location":"api_client.html#catalog_full_market_trades","title":"catalog_full_market_trades","text":"
      def catalog_full_market_trades(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of all markets with trades support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about market trades that are available for the provided filter, as well as the time frames they are available

      "},{"location":"api_client.html#catalog_full_metrics","title":"catalog_full_metrics","text":"
      def catalog_full_metrics(\n        metrics: Optional[Union[List[str], str]] = None,\n        reviewable: Optional[bool] = None) -> CatalogMetricsData\n

      Returns list of supported metrics along with information for them like

      description, category, precision and assets for which a metric is supported.

      Arguments:

      • metrics (list(str), str): A single metric name or a list of metrics to return info for. If no metrics provided, all supported metrics are returned.
      • reviewable (bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.

      Returns:

      list(dict(str, any)): Information about metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is supported.

      "},{"location":"api_client.html#catalog_full_market_metrics","title":"catalog_full_market_metrics","text":"
      def catalog_full_market_metrics(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketMetricsData\n

      Returns list of supported markets with metrics support along woth time ranges of available data per metric.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about markets that correspond to a filter along with meta information like: type of market and min and max available time frames.

      "},{"location":"api_client.html#catalog_full_market_candles","title":"catalog_full_market_candles","text":"
      def catalog_full_market_candles(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketCandlesData\n

      Returns list of available markets with candles support along woth time ranges of available data per metric.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about markets that correspond to a filter along with meta information like: type of market and min and max available time frames.

      "},{"location":"api_client.html#catalog_full_market_orderbooks","title":"catalog_full_market_orderbooks","text":"
      def catalog_full_market_orderbooks(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of markets with orderbooks support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about markets orderbooks that correspond to a filter

      "},{"location":"api_client.html#catalog_full_market_quotes","title":"catalog_full_market_quotes","text":"
      def catalog_full_market_quotes(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of markets with quotes support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about markets quotes that correspond to a filter

      "},{"location":"api_client.html#catalog_full_market_funding_rates","title":"catalog_full_market_funding_rates","text":"
      def catalog_full_market_funding_rates(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of all markets with funding rates support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about funding rates that correspond to a filter

      "},{"location":"api_client.html#catalog_full_market_contract_prices","title":"catalog_full_market_contract_prices","text":"
      def catalog_full_market_contract_prices(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        limit: Optional[str] = None) -> CatalogMarketContractPrices\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • limit (Optional[str]): Limit of response items. none means no limit.

      Returns:

      CatalogMarketContractPrices: List of contract prices statistics.

      "},{"location":"api_client.html#catalog_full_contract_prices_v2","title":"catalog_full_contract_prices_v2","text":"
      def catalog_full_contract_prices_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of contract prices statistics.

      "},{"location":"api_client.html#catalog_full_market_implied_volatility","title":"catalog_full_market_implied_volatility","text":"
      def catalog_full_market_implied_volatility(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        limit: Optional[str] = None) -> CatalogMarketImpliedVolatility\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • limit (Optional[str]): Limit of response items. none means no limit.

      Returns:

      CatalogMarketImpliedVolatility: List of implied volatility statistics.

      "},{"location":"api_client.html#catalog_full_market_greeks","title":"catalog_full_market_greeks","text":"
      def catalog_full_market_greeks(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of all markets with greeks support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about market greeks that correspond to the filter

      "},{"location":"api_client.html#catalog_full_market_open_interest","title":"catalog_full_market_open_interest","text":"
      def catalog_full_market_open_interest(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of markets with open interest support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about market open interest that correspond to a filter

      "},{"location":"api_client.html#catalog_full_market_liquidations","title":"catalog_full_market_liquidations","text":"
      def catalog_full_market_liquidations(\n        markets: Optional[Union[List[str], str]] = None,\n        market_type: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None) -> CatalogMarketTradesData\n

      Returns a list of all markets with liquidations support along with the time ranges of available data.

      Arguments:

      • markets (list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'
      • market_type (str): Type of market: \"spot\", \"future\", \"option\"
      • exchange (str): name of the exchange
      • base (str): name of base asset
      • quote (str): name of quote asset
      • asset (str): name of either base or quote asset
      • symbol (str): name of a symbol. Usually used for futures contracts.

      Returns:

      list(dict(str, any)): Information about market liquidations that correspond to a filter

      "},{"location":"api_client.html#catalog_market_trades_v2","title":"catalog_market_trades_v2","text":"
      def catalog_market_trades_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market trades statistics.

      "},{"location":"api_client.html#catalog_market_candles_v2","title":"catalog_market_candles_v2","text":"
      def catalog_market_candles_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market candles statistics.

      "},{"location":"api_client.html#catalog_market_orderbooks_v2","title":"catalog_market_orderbooks_v2","text":"
      def catalog_market_orderbooks_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market orderbooks statistics.

      "},{"location":"api_client.html#catalog_market_quotes_v2","title":"catalog_market_quotes_v2","text":"
      def catalog_market_quotes_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market quotes statistics.

      "},{"location":"api_client.html#catalog_market_funding_rates_v2","title":"catalog_market_funding_rates_v2","text":"
      def catalog_market_funding_rates_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market funding rates statistics.

      "},{"location":"api_client.html#catalog_market_funding_rates_predicted_v2","title":"catalog_market_funding_rates_predicted_v2","text":"
      def catalog_market_funding_rates_predicted_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market funding rates statistics.

      "},{"location":"api_client.html#catalog_market_contract_prices_v2","title":"catalog_market_contract_prices_v2","text":"
      def catalog_market_contract_prices_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of contract prices statistics.

      "},{"location":"api_client.html#catalog_market_implied_volatility_v2","title":"catalog_market_implied_volatility_v2","text":"
      def catalog_market_implied_volatility_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of implied volatility statistics.

      "},{"location":"api_client.html#catalog_market_greeks_v2","title":"catalog_market_greeks_v2","text":"
      def catalog_market_greeks_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of greeks statistics.

      "},{"location":"api_client.html#catalog_market_open_interest_v2","title":"catalog_market_open_interest_v2","text":"
      def catalog_market_open_interest_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market open interest statistics.

      "},{"location":"api_client.html#catalog_market_liquidations_v2","title":"catalog_market_liquidations_v2","text":"
      def catalog_market_liquidations_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market liquidations statistics.

      "},{"location":"api_client.html#catalog_market_metrics_v2","title":"catalog_market_metrics_v2","text":"
      def catalog_market_metrics_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        metrics: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market metrics statistics.

      "},{"location":"api_client.html#catalog_full_market_trades_v2","title":"catalog_full_market_trades_v2","text":"
      def catalog_full_market_trades_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market trades statistics.

      "},{"location":"api_client.html#catalog_full_market_candles_v2","title":"catalog_full_market_candles_v2","text":"
      def catalog_full_market_candles_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market candles statistics.

      "},{"location":"api_client.html#catalog_full_market_orderbooks_v2","title":"catalog_full_market_orderbooks_v2","text":"
      def catalog_full_market_orderbooks_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market orderbooks statistics.

      "},{"location":"api_client.html#catalog_full_market_quotes_v2","title":"catalog_full_market_quotes_v2","text":"
      def catalog_full_market_quotes_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market quotes statistics.

      "},{"location":"api_client.html#catalog_full_market_funding_rates_v2","title":"catalog_full_market_funding_rates_v2","text":"
      def catalog_full_market_funding_rates_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market funding rates statistics.

      "},{"location":"api_client.html#catalog_full_market_funding_rates_predicted_v2","title":"catalog_full_market_funding_rates_predicted_v2","text":"
      def catalog_full_market_funding_rates_predicted_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market funding rates statistics.

      "},{"location":"api_client.html#catalog_full_market_contract_prices_v2","title":"catalog_full_market_contract_prices_v2","text":"
      def catalog_full_market_contract_prices_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of contract prices statistics.

      "},{"location":"api_client.html#catalog_full_market_implied_volatility_v2","title":"catalog_full_market_implied_volatility_v2","text":"
      def catalog_full_market_implied_volatility_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of implied volatility statistics.

      "},{"location":"api_client.html#catalog_full_market_greeks_v2","title":"catalog_full_market_greeks_v2","text":"
      def catalog_full_market_greeks_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of greeks statistics.

      "},{"location":"api_client.html#catalog_full_market_open_interest_v2","title":"catalog_full_market_open_interest_v2","text":"
      def catalog_full_market_open_interest_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market open interest statistics.

      "},{"location":"api_client.html#catalog_full_market_liquidations_v2","title":"catalog_full_market_liquidations_v2","text":"
      def catalog_full_market_liquidations_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market liquidations statistics.

      "},{"location":"api_client.html#catalog_full_market_metrics_v2","title":"catalog_full_market_metrics_v2","text":"
      def catalog_full_market_metrics_v2(\n        markets: Optional[Union[str, List[str]]] = None,\n        metrics: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        market_type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        format: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • market_type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of market metrics statistics.

      "},{"location":"api_client.html#catalog_asset_metrics_v2","title":"catalog_asset_metrics_v2","text":"
      def catalog_asset_metrics_v2(\n        assets: Optional[Union[str, List[str]]] = None,\n        metrics: Optional[Union[str, List[str]]] = None,\n        reviewable: Optional[bool] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None,\n        format: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.
      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • reviewable (Optional[bool]): Limit to human-reviewable metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.

      Returns:

      CatalogV2DataCollection: List of asset metrics.

      "},{"location":"api_client.html#catalog_full_asset_metrics_v2","title":"catalog_full_asset_metrics_v2","text":"
      def catalog_full_asset_metrics_v2(\n        assets: Optional[Union[str, List[str]]] = None,\n        metrics: Optional[Union[str, List[str]]] = None,\n        reviewable: Optional[bool] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None,\n        format: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.
      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • reviewable (Optional[bool]): Limit to human-reviewable metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.

      Returns:

      CatalogV2DataCollection: List of asset metrics.

      "},{"location":"api_client.html#catalog_exchange_metrics_v2","title":"catalog_exchange_metrics_v2","text":"
      def catalog_exchange_metrics_v2(\n        exchanges: Optional[Union[str, List[str]]] = None,\n        metrics: Optional[Union[str, List[str]]] = None,\n        reviewable: Optional[bool] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None,\n        format: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • exchanges (Optional[Union[str, List[str]]]): Comma separated list of exchanges. By default all exchanges are returned.
      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • reviewable (Optional[bool]): Limit to human-reviewable metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.

      Returns:

      CatalogV2DataCollection: List of exchange metrics.

      "},{"location":"api_client.html#catalog_full_exchange_metrics_v2","title":"catalog_full_exchange_metrics_v2","text":"
      def catalog_full_exchange_metrics_v2(\n        exchanges: Optional[Union[str, List[str]]] = None,\n        metrics: Optional[Union[str, List[str]]] = None,\n        reviewable: Optional[bool] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None,\n        format: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • exchanges (Optional[Union[str, List[str]]]): Comma separated list of exchanges. By default all exchanges are returned.
      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • reviewable (Optional[bool]): Limit to human-reviewable metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.

      Returns:

      CatalogV2DataCollection: List of exchange metrics.

      "},{"location":"api_client.html#catalog_exchange_asset_metrics_v2","title":"catalog_exchange_asset_metrics_v2","text":"
      def catalog_exchange_asset_metrics_v2(\n        exchange_assets: Optional[Union[str, List[str]]] = None,\n        metrics: Optional[Union[str, List[str]]] = None,\n        reviewable: Optional[bool] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None,\n        format: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • exchange_assets (Optional[Union[str, List[str]]]): Comma separated list of exchange-assets. By default, all exchange-assets pairs are returned.
      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • reviewable (Optional[bool]): Limit to human-reviewable metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.

      Returns:

      CatalogV2DataCollection: List of exchange-asset metrics.

      "},{"location":"api_client.html#catalog_full_exchange_asset_metrics_v2","title":"catalog_full_exchange_asset_metrics_v2","text":"
      def catalog_full_exchange_asset_metrics_v2(\n        exchange_assets: Optional[Union[str, List[str]]] = None,\n        metrics: Optional[Union[str, List[str]]] = None,\n        reviewable: Optional[bool] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None,\n        format: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • exchange_assets (Optional[Union[str, List[str]]]): Comma separated list of exchange-assets. By default, all exchange-assets pairs are returned.
      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • reviewable (Optional[bool]): Limit to human-reviewable metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.

      Returns:

      CatalogV2DataCollection: List of exchange-asset metrics.

      "},{"location":"api_client.html#catalog_pair_metrics_v2","title":"catalog_pair_metrics_v2","text":"
      def catalog_pair_metrics_v2(\n        pairs: Optional[Union[str, List[str]]] = None,\n        metrics: Optional[Union[str, List[str]]] = None,\n        reviewable: Optional[bool] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None,\n        format: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • pairs (Optional[Union[str, List[str]]]): Comma separated list of asset pairs. By default, all asset pairs are returned.
      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • reviewable (Optional[bool]): Limit to human-reviewable metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.

      Returns:

      CatalogV2DataCollection: List of pair metrics.

      "},{"location":"api_client.html#catalog_full_pair_metrics_v2","title":"catalog_full_pair_metrics_v2","text":"
      def catalog_full_pair_metrics_v2(\n        pairs: Optional[Union[str, List[str]]] = None,\n        metrics: Optional[Union[str, List[str]]] = None,\n        reviewable: Optional[bool] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None,\n        format: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • pairs (Optional[Union[str, List[str]]]): Comma separated list of asset pairs. By default, all asset pairs are returned.
      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • reviewable (Optional[bool]): Limit to human-reviewable metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.

      Returns:

      CatalogV2DataCollection: List of pair metrics.

      "},{"location":"api_client.html#catalog_institution_metrics_v2","title":"catalog_institution_metrics_v2","text":"
      def catalog_institution_metrics_v2(\n        institutions: Optional[Union[str, List[str]]] = None,\n        metrics: Optional[Union[str, List[str]]] = None,\n        reviewable: Optional[bool] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None,\n        format: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • institutions (Optional[Union[str, List[str]]]): Comma separated list of institutions. By default, all institutions are returned.
      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • reviewable (Optional[bool]): Limit to human-reviewable metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.

      Returns:

      CatalogV2DataCollection: List of institution metrics.

      "},{"location":"api_client.html#catalog_full_institution_metrics_v2","title":"catalog_full_institution_metrics_v2","text":"
      def catalog_full_institution_metrics_v2(\n        institutions: Optional[Union[str, List[str]]] = None,\n        metrics: Optional[Union[str, List[str]]] = None,\n        reviewable: Optional[bool] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None,\n        format: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • institutions (Optional[Union[str, List[str]]]): Comma separated list of institutions. By default, all institutions are returned.
      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • reviewable (Optional[bool]): Limit to human-reviewable metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
      • format (Optional[str]): Format of the response. Supported values are json, json_stream.

      Returns:

      CatalogV2DataCollection: List of institution metrics.

      "},{"location":"api_client.html#catalog_pair_candles_v2","title":"catalog_pair_candles_v2","text":"
      def catalog_pair_candles_v2(\n        pairs: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • pairs (Optional[Union[str, List[str]]]): Comma separated list of asset pairs. By default, all asset pairs are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of asset pair candles statistics.

      "},{"location":"api_client.html#catalog_index_candles_v2","title":"catalog_index_candles_v2","text":"
      def catalog_index_candles_v2(\n        indexes: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • indexes (Optional[Union[str, List[str]]]): Comma separated list of indexes. By default all assets are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of index candles statistics.

      "},{"location":"api_client.html#catalog_index_levels_v2","title":"catalog_index_levels_v2","text":"
      def catalog_index_levels_v2(\n        indexes: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • indexes (Optional[Union[str, List[str]]]): Comma separated list of indexes. By default all indexes are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of index levels.

      "},{"location":"api_client.html#catalog_asset_chains_v2","title":"catalog_asset_chains_v2","text":"
      def catalog_asset_chains_v2(\n        assets: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of asset chains assets

      "},{"location":"api_client.html#catalog_mempool_feerates_v2","title":"catalog_mempool_feerates_v2","text":"
      def catalog_mempool_feerates_v2(\n        assets: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of mempool feerates assets

      "},{"location":"api_client.html#catalog_mining_pool_tips_summaries_v2","title":"catalog_mining_pool_tips_summaries_v2","text":"
      def catalog_mining_pool_tips_summaries_v2(\n        assets: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of mining pool tips assets

      "},{"location":"api_client.html#catalog_transaction_tracker_assets_v2","title":"catalog_transaction_tracker_assets_v2","text":"
      def catalog_transaction_tracker_assets_v2(\n        assets: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of transaction tracker assets

      "},{"location":"api_client.html#catalog_full_pair_candles_v2","title":"catalog_full_pair_candles_v2","text":"
      def catalog_full_pair_candles_v2(\n        pairs: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • pairs (Optional[Union[str, List[str]]]): Comma separated list of asset pairs. By default, all asset pairs are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of asset pair candles statistics.

      "},{"location":"api_client.html#catalog_full_index_candles_v2","title":"catalog_full_index_candles_v2","text":"
      def catalog_full_index_candles_v2(\n        indexes: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • indexes (Optional[Union[str, List[str]]]): Comma separated list of indexes. By default all assets are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of index candles statistics.

      "},{"location":"api_client.html#catalog_full_index_levels_v2","title":"catalog_full_index_levels_v2","text":"
      def catalog_full_index_levels_v2(\n        indexes: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • indexes (Optional[Union[str, List[str]]]): Comma separated list of indexes. By default all indexes are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of index levels.

      "},{"location":"api_client.html#catalog_full_asset_chains_v2","title":"catalog_full_asset_chains_v2","text":"
      def catalog_full_asset_chains_v2(\n        assets: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of asset chains assets

      "},{"location":"api_client.html#catalog_full_mempool_feerates_v2","title":"catalog_full_mempool_feerates_v2","text":"
      def catalog_full_mempool_feerates_v2(\n        assets: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of mempool feerates assets

      "},{"location":"api_client.html#catalog_full_mining_pool_tips_summaries_v2","title":"catalog_full_mining_pool_tips_summaries_v2","text":"
      def catalog_full_mining_pool_tips_summaries_v2(\n        assets: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of mining pool tips assets

      "},{"location":"api_client.html#catalog_full_transaction_tracker_assets_v2","title":"catalog_full_transaction_tracker_assets_v2","text":"
      def catalog_full_transaction_tracker_assets_v2(\n        assets: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> CatalogV2DataCollection\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      CatalogV2DataCollection: List of transaction tracker assets

      "},{"location":"api_client.html#get_asset_alerts","title":"get_asset_alerts","text":"
      def get_asset_alerts(\n        assets: Union[List[str], str],\n        alerts: Union[List[str], str],\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        include_heartbeats: Optional[bool] = None) -> DataCollection\n

      Returns asset alerts for the specified assets.

      Arguments:

      • assets (list(str), str): list of asset names, e.g. 'btc'
      • alerts (list(str), str): list of asset alert names
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • include_heartbeats (bool): If set to true, includes information about most recent time asset was successfully evaluated.

      Returns:

      DataCollection: Asset alerts timeseries.

      "},{"location":"api_client.html#get_defi_balance_sheets","title":"get_defi_balance_sheets","text":"
      def get_defi_balance_sheets(defi_protocols: Union[str, List[str]],\n                            page_size: Optional[int] = None,\n                            paging_from: Optional[Union[PagingFrom,\n                                                        str]] = \"start\",\n                            start_time: Optional[Union[datetime, date,\n                                                       str]] = None,\n                            end_time: Optional[Union[datetime, date,\n                                                     str]] = None,\n                            start_height: Optional[int] = None,\n                            end_height: Optional[int] = None,\n                            start_inclusive: Optional[bool] = None,\n                            end_inclusive: Optional[bool] = None,\n                            timezone: Optional[str] = None) -> DataCollection\n

      Returns Defi Balance Sheet records for specified DeFi protocols.

      Arguments:

      • defi_protocols (str, List[str]): list of DeFi protocols like aave_v2_eth or protocol patterns like aave_v2_* or aave_*_eth or *_eth.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_height (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: list of blockchain blocks metadata

      "},{"location":"api_client.html#get_asset_chains","title":"get_asset_chains","text":"
      def get_asset_chains(\n        assets: Union[List[str], str],\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None) -> AssetChainsDataCollection\n

      Returns the chains of blocks for the specified assets.

      Arguments:

      • assets (list(str), str): list of asset names, e.g. 'btc'
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      AssetChainsDataCollection: Asset chains timeseries.

      "},{"location":"api_client.html#get_asset_metrics","title":"get_asset_metrics","text":"
      def get_asset_metrics(\n        assets: Union[List[str], str],\n        metrics: Union[List[str], str],\n        frequency: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_height: Optional[int] = None,\n        end_height: Optional[int] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        sort: Optional[str] = None,\n        limit_per_asset: Optional[int] = None,\n        status: Optional[str] = None,\n        start_hash: Optional[str] = None,\n        end_hash: Optional[str] = None,\n        min_confirmations: Optional[int] = None,\n        null_as_zero: Optional[bool] = None,\n        ignore_forbidden_errors: Optional[bool] = None,\n        ignore_unsupported_errors: Optional[bool] = None) -> DataCollection\n

      Returns requested metrics for specified assets.

      Arguments:

      • assets (list(str), str): list of asset names, e.g. 'btc'
      • metrics (list(str), str): list of asset-specific metric names, e.g. 'PriceUSD'
      • frequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_height (int): Start block of the timeseries (only applicable when querying with frequency 1b).
      • end_height (int): End block of the timeseries (only applicable when querying with frequency 1b).
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • sort (str): How results will be sorted, e.g. \"asset\", \"height\", or \"time\". Default is \"asset\". Metrics with 1b frequency are sorted by (asset, height, block_hash) tuples by default. Metrics with other frequencies are sorted by (asset, time) by default. If you want to sort 1d metrics by (time, asset) you should choose time as value for the sort parameter. Sorting by time is useful if you request metrics for a set of assets.
      • limit_per_asset (int): How many entries per asset the result should contain.
      • status (str): Which metric values do you want to see. Applicable only for \"reviewable\" metrics. You can find them in the /catalog/metrics endpoint. Default: \"all\". Supported: \"all\" \"flash\" \"reviewed\" \"revised\"
      • start_hash (str): The start hash indicates the beginning block height for the set of data that are returned. Inclusive by default. Mutually exclusive with start_time and start_height.
      • end_hash (str): The end hash indicates the ending block height for the set of data that are returned. Inclusive by default. Mutually exclusive with end_time and end_height.
      • min_confirmations (int): Specifies how many blocks behind the chain tip block by block metrics (1b frequency) are based on. Default for btc is 2 and 99 for eth.
      • null_as_zero (bool): Default: false. Nulls are represented as zeros in the response.
      • ignore_forbidden_errors (bool): Default: false. Ignore HTTP 403 Forbidden errors
      • ignore_unsupported_errors (bool): Default: false. Ignore errors for unsupported assets, metrics or frequencies.

      Returns:

      DataCollection: Asset Metrics timeseries.

      "},{"location":"api_client.html#get_exchange_metrics","title":"get_exchange_metrics","text":"
      def get_exchange_metrics(\n        exchanges: Union[List[str], str],\n        metrics: Union[List[str], str],\n        frequency: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_height: Optional[int] = None,\n        end_height: Optional[int] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        sort: Optional[str] = None,\n        limit_per_exchange: Optional[int] = None) -> DataCollection\n

      Returns metrics for specified exchanges.

      Arguments:

      • exchanges (list(str), str): A single exchange name or a list of exchanges to return info for.
      • metrics (list(str), str): list of exchange-specific metric names, e.g. 'open_interest_reported_future_usd'. To find a list of available metrics for a given exchange, call client.catalog_exchanges()
      • frequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_height (int): Start block of the timeseries (only applicable when querying with frequency 1b).
      • end_height (int): End block of the timeseries (only applicable when querying with frequency 1b).
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • sort (str): How results will be sorted, e.g. 'exchange', 'time'. Metrics are sorted by 'exchange' by default.
      • limit_per_exchange (int): How many entries per exchange the result should contain.

      Returns:

      DataCollection: Asset Metrics timeseries.

      "},{"location":"api_client.html#get_exchange_asset_metrics","title":"get_exchange_asset_metrics","text":"
      def get_exchange_asset_metrics(\n        exchange_assets: Union[List[str], str],\n        metrics: Union[List[str], str],\n        frequency: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_height: Optional[int] = None,\n        end_height: Optional[int] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        sort: Optional[str] = None,\n        limit_per_exchange_asset: Optional[int] = None) -> DataCollection\n

      Returns metrics for specified exchange-asset.

      Arguments:

      • exchange_assets (list(str), str): A single exchange-asset pairs (e.g. \"binance-btc\" or a list of exchange-asset-pair to return info for.
      • metrics (list(str), str): list of exchange-specific metric names, e.g. 'open_interest_reported_future_usd'. To find a list of available metrics for a given exchange, call client.catalog_exchanges()
      • frequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_height (int): Start block of the timeseries (only applicable when querying with frequency 1b).
      • end_height (int): End block of the timeseries (only applicable when querying with frequency 1b).
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • sort (str): How results will be sorted, e.g. \"exchange_asset\", \"time\". Default is \"exchange_asset\".
      • limit_per_exchange_asset (int): How many entries per exchange-asset the result should contain.

      Returns:

      DataCollection: Exchange-Asset Metrics timeseries.

      "},{"location":"api_client.html#get_pair_metrics","title":"get_pair_metrics","text":"
      def get_pair_metrics(pairs: Union[List[str], str],\n                     metrics: Union[List[str], str],\n                     frequency: Optional[str] = None,\n                     page_size: Optional[int] = None,\n                     paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n                     start_time: Optional[Union[datetime, date, str]] = None,\n                     end_time: Optional[Union[datetime, date, str]] = None,\n                     start_height: Optional[int] = None,\n                     end_height: Optional[int] = None,\n                     start_inclusive: Optional[bool] = None,\n                     end_inclusive: Optional[bool] = None,\n                     timezone: Optional[str] = None,\n                     sort: Optional[str] = None,\n                     limit_per_pair: Optional[int] = None) -> DataCollection\n

      Returns metrics books for specified asset-asset pairs.

      Arguments:

      • pairs (list(str), str): A single asset-asset pairs (e.g. \"btc-usd\") or a list of asset-asset-pairs to return info for.
      • metrics (list(str), str): list of exchange-specific metric names, e.g. 'open_interest_reported_future_usd'. To find a list of available metrics for a given exchange, call client.catalog_exchanges()
      • frequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_height (int): Start block of the timeseries (only applicable when querying with frequency 1b).
      • end_height (int): End block of the timeseries (only applicable when querying with frequency 1b).
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • sort (str): How results will be sorted, e.g.\"pair\", \"time\". \"pair\" by default
      • limit_per_pair (int): How many entries per asset pair the result should contain.

      Returns:

      DataCollection: Exchange-Asset Metrics timeseries.

      "},{"location":"api_client.html#get_pair_candles","title":"get_pair_candles","text":"
      def get_pair_candles(pairs: Union[List[str], str],\n                     frequency: Optional[str] = None,\n                     page_size: Optional[int] = None,\n                     paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n                     start_time: Optional[Union[datetime, date, str]] = None,\n                     end_time: Optional[Union[datetime, date, str]] = None,\n                     start_height: Optional[int] = None,\n                     end_height: Optional[int] = None,\n                     start_inclusive: Optional[bool] = None,\n                     end_inclusive: Optional[bool] = None,\n                     timezone: Optional[str] = None,\n                     limit_per_pair: Optional[int] = None) -> DataCollection\n

      Returns candles for specified asset pairs.

      Results are ordered by tuple (pair, time).

      Arguments:

      • pairs (list(str), str): A single asset-asset pairs (e.g. \"btc-usd\") or a list of asset-asset-pairs to return info for.
      • frequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_height (int): Start block of the timeseries (only applicable when querying with frequency 1b).
      • end_height (int): End block of the timeseries (only applicable when querying with frequency 1b).
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_pair (int): How many entries per asset pair the result should contain.

      Returns:

      DataCollection: Asset pair candles timeseries.

      "},{"location":"api_client.html#get_institution_metrics","title":"get_institution_metrics","text":"
      def get_institution_metrics(\n        institutions: Union[List[str], str],\n        metrics: Union[List[str], str],\n        frequency: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_height: Optional[int] = None,\n        end_height: Optional[int] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        sort: Optional[str] = None,\n        limit_per_institution: Optional[int] = None) -> DataCollection\n

      Returns metrics for specified institutions.

      Arguments:

      • institutions (list(str), str): A single institution name or a list of institutions to return info for.
      • metrics (list(str), str): list of institution-specific metric names, e.g. 'gbtc_total_assets'
      • frequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_height (int): Start block of the timeseries (only applicable when querying with frequency 1b).
      • end_height (int): End block of the timeseries (only applicable when querying with frequency 1b).
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • sort (str): How results will be sorted, e.g. \"institution\", or \"time\". Default is \"institution\".
      • limit_per_institution (int): How many entries per institution the result should contain.

      Returns:

      DataCollection: Asset Metrics timeseries.

      "},{"location":"api_client.html#get_index_candles","title":"get_index_candles","text":"
      def get_index_candles(indexes: Union[List[str], str],\n                      frequency: Optional[str] = None,\n                      page_size: Optional[int] = None,\n                      paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n                      start_time: Optional[Union[datetime, date, str]] = None,\n                      end_time: Optional[Union[datetime, date, str]] = None,\n                      start_inclusive: Optional[bool] = None,\n                      end_inclusive: Optional[bool] = None,\n                      timezone: Optional[str] = None,\n                      limit_per_index: Optional[int] = None) -> DataCollection\n

      Returns index candles for specified indexes and date range.

      Arguments:

      • indexes (list(str), str): list of index names, e.g. 'CMBI10'
      • frequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_index (int): How many entries per index the result should contain.

      Returns:

      DataCollection: Index Candles timeseries.

      "},{"location":"api_client.html#get_index_levels","title":"get_index_levels","text":"
      def get_index_levels(\n        indexes: Union[List[str], str],\n        frequency: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        limit_per_index: Optional[int] = None,\n        include_verification: Optional[bool] = None) -> DataCollection\n

      Returns index levels for specified indexes and date range.

      Arguments:

      • indexes (list(str), str): list of index names, e.g. 'CMBI10'
      • frequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_index (int): How many entries per index the result should contain.
      • include_verification: Default: False set to true, includes information about verification.

      Returns:

      DataCollection: Index Levels timeseries.

      "},{"location":"api_client.html#get_index_constituents","title":"get_index_constituents","text":"
      def get_index_constituents(indexes: Union[List[str], str],\n                           frequency: Optional[str] = None,\n                           page_size: Optional[int] = None,\n                           paging_from: Optional[Union[PagingFrom,\n                                                       str]] = \"start\",\n                           start_time: Optional[Union[datetime, date,\n                                                      str]] = None,\n                           end_time: Optional[Union[datetime, date,\n                                                    str]] = None,\n                           start_inclusive: Optional[bool] = None,\n                           end_inclusive: Optional[bool] = None,\n                           timezone: Optional[str] = None) -> DataCollection\n

      Returns index constituents for specified indexes and date range.

      Arguments:

      • indexes (list(str), str): list of index names, e.g. 'CMBI10'
      • frequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: Index Constituents timeseries.

      "},{"location":"api_client.html#get_market_metrics","title":"get_market_metrics","text":"
      def get_market_metrics(markets: Union[List[str], str],\n                       metrics: Union[List[str], str],\n                       frequency: Optional[str] = None,\n                       page_size: Optional[int] = None,\n                       paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n                       start_time: Optional[Union[datetime, date, str]] = None,\n                       end_time: Optional[Union[datetime, date, str]] = None,\n                       start_inclusive: Optional[bool] = None,\n                       end_inclusive: Optional[bool] = None,\n                       timezone: Optional[str] = None,\n                       limit_per_market: Optional[int] = None,\n                       sort: Optional[str] = None) -> DataCollection\n

      Returns market metrics for specified markets, frequency and date range.

      For more information on market metrics, see: https://docs.coinmetrics.io/api/v4#operation/getTimeseriesMarketMetrics

      Arguments:

      • markets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future'
      • metrics (list(str), str): list of metrics, i.e. 'liquidations_reported_future_buy_units_1d'. See market metrics catalog for a list of supported metrics: https://docs.coinmetrics.io/api/v4#operation/getCatalogMarketMetrics
      • frequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_market (int): How many entries per market the result should contain.
      • sort (str): How results will be sorted. Metrics are sorted by (market, time) by default. If you want to sort 1d metrics by (time, market) you should choose time as value for the sort parameter. Sorting by time is useful if you request metrics for a set of markets.

      Returns:

      DataCollection: Market Candles timeseries.

      "},{"location":"api_client.html#get_market_candles","title":"get_market_candles","text":"
      def get_market_candles(\n        markets: Union[List[str], str],\n        frequency: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        limit_per_market: Optional[int] = None) -> DataCollection\n

      Returns market candles for specified markets, frequency and date range.

      For more information on market candles, see: https://docs.coinmetrics.io/info/markets/candles

      Arguments:

      • markets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future'
      • frequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_market (int): How many entries per market the result should contain.

      Returns:

      DataCollection: Market Candles timeseries.

      "},{"location":"api_client.html#get_market_trades","title":"get_market_trades","text":"
      def get_market_trades(\n        markets: Union[List[str], str],\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        limit_per_market: Optional[int] = None,\n        min_confirmations: Optional[int] = None) -> DataCollection\n

      Returns market trades for specified markets and date range.

      For more information on market trades, see: https://docs.coinmetrics.io/info/markets/trades

      Arguments:

      • markets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future'
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_market (int): How many entries per market the result should contain.
      • min_confirmations (int): Specifies how many blocks behind the chain tip trades are based on. Default is 2.

      Returns:

      DataCollection: Market Trades timeseries.

      "},{"location":"api_client.html#get_market_open_interest","title":"get_market_open_interest","text":"
      def get_market_open_interest(\n        markets: Union[List[str], str],\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        granularity: Optional[str] = None,\n        timezone: Optional[str] = None,\n        limit_per_market: Optional[int] = None) -> DataCollection\n

      Returns market open interest for specified markets and date range.

      For more information on open interest, see: https://docs.coinmetrics.io/info/markets/openinterest

      Arguments:

      • markets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future'
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • granularity (str): Downsampling granularity of market open interest. Supported values are raw, 1m, 1h, and 1d.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_market (int): How many entries per market the result should contain.

      Returns:

      DataCollection: Market Open Interest timeseries.

      "},{"location":"api_client.html#get_market_liquidations","title":"get_market_liquidations","text":"
      def get_market_liquidations(\n        markets: Union[List[str], str],\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        limit_per_market: Optional[int] = None) -> DataCollection\n

      Returns market liquidations for specified markets and date range.

      For more information on liquidations, see: https://docs.coinmetrics.io/info/markets/liquidations

      Arguments:

      • markets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future'
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_market (int): How many entries per market the result should contain.

      Returns:

      DataCollection: Market Liquidations timeseries.

      "},{"location":"api_client.html#get_market_funding_rates","title":"get_market_funding_rates","text":"
      def get_market_funding_rates(\n        markets: Union[List[str], str],\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        limit_per_market: Optional[int] = None) -> DataCollection\n

      Returns market funding rates for specified markets and date range.

      For more information on funding rates, see: https://docs.coinmetrics.io/info/markets/fundingrates

      Arguments:

      • markets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future'
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_market (int): How many entries per market the result should contain.

      Returns:

      DataCollection: Market Funding Rates timeseries.

      "},{"location":"api_client.html#get_predicted_market_funding_rates","title":"get_predicted_market_funding_rates","text":"
      def get_predicted_market_funding_rates(\n        markets: Union[List[str], str],\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        limit_per_market: Optional[int] = None) -> DataCollection\n

      Returns predicted funding rates for specified futures markets. Results are ordered by tuple (market, time).

      For more information on funding rates, see: https://docs.coinmetrics.io/info/markets/fundingrates

      Arguments:

      • markets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future'
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_market (int): How many entries per market the result should contain.

      Returns:

      DataCollection: Market Funding Rates timeseries.

      "},{"location":"api_client.html#get_market_orderbooks","title":"get_market_orderbooks","text":"
      def get_market_orderbooks(\n        markets: Union[List[str], str],\n        granularity: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        depth_limit: Optional[str] = \"100\",\n        timezone: Optional[str] = None,\n        limit_per_market: Optional[int] = None) -> DataCollection\n

      Returns market order books for specified markets and date range.

      For more information on order books, see: https://docs.coinmetrics.io/info/markets/orderbook

      Arguments:

      • markets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future'
      • granularity (str): Downsampling granularity of market order books and quotes. Supported values are raw, 1m, 1h, and 1d.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • depth_limit (str): book depth limit, 100 levels max or full book that is not limited and provided as is from the exchange. Full book snapshots are collected once per hour
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_market (int): How many entries per market the result should contain.

      Returns:

      DataCollection: Market Order Books timeseries.

      "},{"location":"api_client.html#get_market_quotes","title":"get_market_quotes","text":"
      def get_market_quotes(\n        markets: Union[List[str], str],\n        granularity: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        limit_per_market: Optional[int] = None,\n        include_one_sided: Optional[bool] = None) -> DataCollection\n

      Returns market quotes for specified markets and date range.

      For more information on quotes, see: https://docs.coinmetrics.io/info/markets/quotes

      Arguments:

      • markets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future'
      • granularity (``): Downsampling granularity of market order books and quotes. Supported values are raw, 1m, 1h, and 1d.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_market (int): How many entries per market the result should contain.
      • include_one_sided (bool): Default: false Include one-side and empty books in quotes response.

      Returns:

      DataCollection: Market Quotes timeseries.

      "},{"location":"api_client.html#get_market_contract_prices","title":"get_market_contract_prices","text":"
      def get_market_contract_prices(\n        markets: Union[List[str], str],\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        granularity: Optional[str] = None,\n        timezone: Optional[str] = None,\n        limit_per_market: Optional[int] = None,\n        frequency: Optional[str] = None) -> DataCollection\n

      Returns contract prices for specified markets. This includes index price and mark price that are used by the exchange for settlement and risk management purposes.

      Arguments:

      • markets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future', 'deribit-ETH-25MAR22-1200-P-option'
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • granularity (str): Downsampling granularity of market contract prices. Supported values are raw, 1m, 1h, and 1d.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_market (int): How many entries per market the result should contain.

      Returns:

      DataCollection: Market Contract Prices timeseries.

      "},{"location":"api_client.html#get_market_implied_volatility","title":"get_market_implied_volatility","text":"
      def get_market_implied_volatility(\n        markets: Union[List[str], str],\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        granularity: Optional[str] = None,\n        timezone: Optional[str] = None,\n        limit_per_market: Optional[int] = None) -> DataCollection\n

      Returns implied volatility for specified markets.

      Arguments:

      • markets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future', 'deribit-ETH-25MAR22-1200-P-option'
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • granularity (str - one of raw, 1m, 1h, and 1d): Downsampling granularity of market implied volatility. Supported values are raw, 1m, 1h, and 1d.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_market (int): How many entries per market the result should contain.

      Returns:

      DataCollection: Market Volatility timeseries.

      "},{"location":"api_client.html#get_market_greeks","title":"get_market_greeks","text":"
      def get_market_greeks(\n        markets: Union[List[str], str],\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        granularity: Optional[str] = None,\n        timezone: Optional[str] = None,\n        limit_per_market: Optional[int] = None) -> DataCollection\n

      Returns greeks for option markets.

      Arguments:

      • markets (list(str), str): list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future', 'deribit-ETH-25MAR22-1200-P-option'
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • granularity (str - one of raw, 1m, 1h, and 1d): Downsampling granularity of market greeks. Supported values are raw, 1m, 1h, and 1d
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.
      • limit_per_market (int): How many entries per market the result should contain.

      Returns:

      DataCollection: Market Volatility timeseries.

      "},{"location":"api_client.html#get_mining_pool_tips_summary","title":"get_mining_pool_tips_summary","text":"
      def get_mining_pool_tips_summary(\n        assets: Union[List[str], str],\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None) -> DataCollection\n

      Returns mining pool tips summaries for specified assets.

      Arguments:

      • assets (list(str), str): list of asset names, e.g. 'btc'
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: Mining Pool Tips timeseries.

      "},{"location":"api_client.html#get_mempool_feerates","title":"get_mempool_feerates","text":"
      def get_mempool_feerates(assets: Union[List[str], str],\n                         page_size: Optional[int] = 200,\n                         paging_from: Optional[Union[PagingFrom,\n                                                     str]] = \"start\",\n                         start_time: Optional[Union[datetime, date,\n                                                    str]] = None,\n                         end_time: Optional[Union[datetime, date, str]] = None,\n                         start_inclusive: Optional[bool] = None,\n                         end_inclusive: Optional[bool] = None,\n                         timezone: Optional[str] = None) -> DataCollection\n

      Returns mempool feerates for the specified assets. Note: for this method, page_size must be <= 200.

      Arguments:

      • assets (list(str), str): list of asset names, e.g. 'btc'
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: Mempool Fee Rates timeseries.

      "},{"location":"api_client.html#get_stream_asset_metrics","title":"get_stream_asset_metrics","text":"
      def get_stream_asset_metrics(\n        assets: Union[List[str], str],\n        metrics: Union[List[str], str],\n        frequency: Optional[str] = None,\n        backfill: Union[Backfill, str] = Backfill.LATEST) -> CmStream\n

      Returns timeseries stream of metrics for specified assets.

      Arguments:

      • assets (list(str), str): list of asset names, e.g. 'btc'
      • metrics (list(str), str): list of asset-specific metric names, e.g. 'PriceUSD'
      • frequency (str): frequency of the returned timeseries, e.g 15s, 1d, etc.
      • backfill (str): What data should be sent upon a connection (\"latest\" or \"none\"). By default the latest values are sent just before real-time data.

      Returns:

      CmStream: Asset Metrics timeseries stream.

      "},{"location":"api_client.html#get_stream_market_trades","title":"get_stream_market_trades","text":"
      def get_stream_market_trades(\n        markets: Union[List[str], str],\n        backfill: Union[Backfill, str] = Backfill.LATEST) -> CmStream\n

      Returns timeseries stream of market trades.

      Arguments:

      • markets (list(str), str): list of markets or market patterns like exchange-* or exchange-*-spot or *USDT-future.
      • backfill (str): What data should be sent upon a connection (\"latest\" or \"none\"). By default the latest values are sent just before real-time data.

      Returns:

      CmStream: Market Trades timeseries stream.

      "},{"location":"api_client.html#get_stream_market_orderbooks","title":"get_stream_market_orderbooks","text":"
      def get_stream_market_orderbooks(\n        markets: Union[List[str], str],\n        backfill: Union[Backfill, str] = Backfill.LATEST,\n        depth_limit: Optional[str] = None) -> CmStream\n

      Returns timeseries stream of market orderbooks.

      Arguments:

      • markets (list(str), str): list of markets or market patterns like exchange-* or exchange-*-spot or *USDT-future.
      • backfill (str): What data should be sent upon a connection (\"latest\" or \"none\"). By default the latest values are sent just before real-time data.
      • depth_limit (str): Default: 100. Supported Values: 100 \"full_book\". Book depth limit.

      Returns:

      CmStream: Market Orderbooks timeseries stream.

      "},{"location":"api_client.html#get_stream_market_quotes","title":"get_stream_market_quotes","text":"
      def get_stream_market_quotes(\n        markets: Union[List[str], str],\n        backfill: Union[Backfill, str] = Backfill.LATEST,\n        include_one_sided: Optional[bool] = None) -> CmStream\n

      Returns timeseries stream of market quotes.

      Arguments:

      • markets (list(str), str): list of markets or market patterns like exchange-* or exchange-*-spot or *USDT-future.
      • backfill (str): What data should be sent upon a connection (\"latest\" or \"none\"). By default the latest values are sent just before real-time data.
      • include_one_sided (bool): Default: false. Include one-side and empty books in quotes response.

      Returns:

      CmStream: Market Quotes timeseries stream.

      "},{"location":"api_client.html#get_stream_pair_quotes","title":"get_stream_pair_quotes","text":"
      def get_stream_pair_quotes(pairs: Union[str, List[str]],\n                           aggregation_method: Optional[str] = None,\n                           backfill: Optional[str] = None) -> CmStream\n

      Arguments:

      • pairs (Optional[Union[str, List[str]]]): Comma separated list of asset pairs. Use the /catalog-all/pairs endpoint for the full list of supported asset pairs.
      • aggregation_method (str): The method to use for aggregation.
      • backfill (str): What data should be sent upon a connection. By default the latest values are sent just before real-time data.

      Returns:

      CmStream:

      "},{"location":"api_client.html#get_stream_asset_quotes","title":"get_stream_asset_quotes","text":"
      def get_stream_asset_quotes(assets: Union[str, List[str]],\n                            aggregation_method: Optional[str] = None,\n                            backfill: Optional[str] = None) -> CmStream\n

      Arguments:

      • assets (Union[str, List[str]]): Comma separated list of assets. Use the /catalog-all/assets endpoint for the full list of supported assets.
      • aggregation_method (str): The method to use for aggregation.
      • backfill (str): What data should be sent upon a connection. By default the latest values are sent just before real-time data.

      Returns:

      CmStream:

      "},{"location":"api_client.html#get_stream_market_candles","title":"get_stream_market_candles","text":"
      def get_stream_market_candles(\n        markets: Union[List[str], str],\n        frequency: Optional[str] = None,\n        backfill: Union[Backfill, str] = Backfill.LATEST) -> CmStream\n

      Returns timeseries stream of market candles.

      Arguments:

      • markets (list(str), str): list of markets or market patterns like exchange-* or exchange-*-spot or *USDT-future.
      • frequency (str): Candle duration. Supported values are 1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d.
      • backfill (str): What data should be sent upon a connection (\"latest\" or \"none\"). By default the latest values are sent just before real-time data.

      Returns:

      CmStream: Market Candles timeseries stream.

      "},{"location":"api_client.html#get_stream_index_levels","title":"get_stream_index_levels","text":"
      def get_stream_index_levels(\n        indexes: Union[List[str], str],\n        include_verification: Optional[bool] = None,\n        backfill: Union[Backfill, str] = Backfill.LATEST) -> CmStream\n

      Returns timeseries stream of index levels.

      Arguments:

      • indexes (list(str), str): list of indxes or market patterns such as CMBIBTC
      • backfill (str): What data should be sent upon a connection (\"latest\" or \"none\"). By default the latest values are sent just before real-time data.
      • include_verification: Default: False If set to true, includes information about verification.

      Returns:

      CmStream: Index levels data timeseries stream.

      "},{"location":"api_client.html#get_stream_market_liquidations","title":"get_stream_market_liquidations","text":"
      def get_stream_market_liquidations(markets: Union[str, List[str]],\n                                   backfill: Optional[str] = None) -> CmStream\n

      Returns timeseries stream for market liquidations

      Arguments:

      • markets (Union[str, List[str]]): Comma separated list of markets or market patterns like exchange-* or exchange-*-spot or *USDT-future. Use the /catalog-all/markets endpoint for the full list of supported markets.
      • backfill (Optional[str]): What data should be sent upon a connection. By default the latest values are sent just before real-time data.

      Returns:

      CmStream: Market liquidations timeseries stream

      "},{"location":"api_client.html#get_stream_market_open_interest","title":"get_stream_market_open_interest","text":"
      def get_stream_market_open_interest(\n        markets: Union[str, List[str]],\n        backfill: Optional[str] = None) -> CmStream\n

      Arguments:

      • markets (Union[str, List[str]]): Comma separated list of markets or market patterns like exchange-* or exchange-*-spot or *USDT-future. Use the /catalog-all/markets endpoint for the full list of supported markets.
      • backfill (Optional[str]): What data should be sent upon a connection. By default the latest values are sent just before real-time data.

      Returns:

      CmStream:

      "},{"location":"api_client.html#get_list_of_blocks","title":"get_list_of_blocks","text":"
      def get_list_of_blocks(asset: str,\n                       block_hashes: Optional[Union[List[str], str]] = None,\n                       heights: Optional[Union[List[str], str]] = None,\n                       page_size: Optional[int] = None,\n                       paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n                       start_time: Optional[Union[datetime, date, str]] = None,\n                       end_time: Optional[Union[datetime, date, str]] = None,\n                       start_height: Optional[int] = None,\n                       end_height: Optional[int] = None,\n                       start_inclusive: Optional[bool] = None,\n                       end_inclusive: Optional[bool] = None,\n                       timezone: Optional[str] = None) -> DataCollection\n

      Returns a list of blockchain blocks metadata.

      Arguments:

      • asset (str): Asset name
      • block_hashes (str, list(str)): Optional comma separated list of block hashes to filter a response.
      • heights (str, list(str)): Optional comma separated list of block heights to filter a response.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_height (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: list of blockchain blocks metadata

      "},{"location":"api_client.html#get_list_of_accounts","title":"get_list_of_accounts","text":"
      def get_list_of_accounts(asset: str,\n                         accounts: Optional[Union[List[str], str]] = None,\n                         page_size: Optional[int] = None,\n                         paging_from: Optional[Union[PagingFrom,\n                                                     str]] = \"start\",\n                         start_time: Optional[Union[datetime, date,\n                                                    str]] = None,\n                         end_time: Optional[Union[datetime, date, str]] = None,\n                         start_height: Optional[int] = None,\n                         end_height: Optional[int] = None,\n                         start_chain_sequence_number: Optional[int] = None,\n                         end_chain_sequence_number: Optional[int] = None,\n                         start_inclusive: Optional[bool] = None,\n                         end_inclusive: Optional[bool] = None,\n                         timezone: Optional[str] = None) -> DataCollection\n

      Returns a list of blockchain accounts with their balances.

      Arguments:

      • asset (str): Asset name
      • accounts (str, list(str)): Optional comma separated list of accounts to filter a response.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_height (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • start_chain_sequence_number (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_chain_sequence_number (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: list of blockchain accounts metadata

      "},{"location":"api_client.html#get_list_of_transactions","title":"get_list_of_transactions","text":"
      def get_list_of_transactions(asset: str,\n                             transaction_hashes: Optional[Union[List[str],\n                                                                str]] = None,\n                             block_hashes: Optional[Union[List[str],\n                                                          str]] = None,\n                             page_size: Optional[int] = None,\n                             paging_from: Optional[Union[PagingFrom,\n                                                         str]] = \"start\",\n                             start_time: Optional[Union[datetime, date,\n                                                        str]] = None,\n                             end_time: Optional[Union[datetime, date,\n                                                      str]] = None,\n                             start_height: Optional[int] = None,\n                             end_height: Optional[int] = None,\n                             start_inclusive: Optional[bool] = None,\n                             end_inclusive: Optional[bool] = None,\n                             timezone: Optional[str] = None) -> DataCollection\n

      Returns a list of blockchain transactions metadata.

      Arguments:

      • asset (str): Asset name
      • transaction_hashes (str, list(str)): Optional comma separated list of transaction hashes to filter a response.
      • block_hashes (str, list(str)): Optional comma separated list of block hashes to filter a response.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_height (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: list of transaction metadata

      "},{"location":"api_client.html#get_list_of_balance_updates","title":"get_list_of_balance_updates","text":"
      def get_list_of_balance_updates(\n        asset: str,\n        accounts: Optional[Union[List[str], str]] = None,\n        transaction_hashes: Optional[Union[List[str], str]] = None,\n        block_hashes: Optional[Union[List[str], str]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_height: Optional[int] = None,\n        end_height: Optional[int] = None,\n        start_chain_sequence_number: Optional[int] = None,\n        end_chain_sequence_number: Optional[int] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None) -> DataCollection\n

      Returns a list of blockchain accounts balance updates.

      Arguments:

      • asset (str): Asset name
      • accounts (str, list(str)): Optional comma separated list of accounts to filter a response.
      • transaction_hashes (str, list(str)): Optional comma separated list of transaction hashes to filter a response.
      • block_hashes (str, list(str)): Optional comma separated list of block hashes to filter a response.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_height (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • start_chain_sequence_number (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_chain_sequence_number (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: list of balance updates

      "},{"location":"api_client.html#get_list_of_blocks_v2","title":"get_list_of_blocks_v2","text":"
      def get_list_of_blocks_v2(asset: str,\n                          block_hashes: Optional[Union[List[str], str]] = None,\n                          heights: Optional[Union[List[str], str]] = None,\n                          page_size: Optional[int] = None,\n                          paging_from: Optional[Union[PagingFrom,\n                                                      str]] = \"start\",\n                          start_time: Optional[Union[datetime, date,\n                                                     str]] = None,\n                          end_time: Optional[Union[datetime, date,\n                                                   str]] = None,\n                          start_height: Optional[int] = None,\n                          end_height: Optional[int] = None,\n                          chain: Optional[bool] = None,\n                          start_inclusive: Optional[bool] = None,\n                          end_inclusive: Optional[bool] = None,\n                          timezone: Optional[str] = None) -> DataCollection\n

      Returns a list of blockchain blocks metadata.

      Arguments:

      • asset (str): Asset name
      • block_hashes (str, list(str)): Optional comma separated list of block hashes to filter a response.
      • heights (str, list(str)): Optional comma separated list of block heights to filter a response.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_height (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • chain (str): Default: \"main\" Chain type. Supported values are main and all (includes both main and stale).
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: list of blockchain blocks metadata

      "},{"location":"api_client.html#get_list_of_accounts_v2","title":"get_list_of_accounts_v2","text":"
      def get_list_of_accounts_v2(asset: str,\n                            accounts: Optional[Union[List[str], str]] = None,\n                            page_size: Optional[int] = None,\n                            paging_from: Optional[Union[PagingFrom,\n                                                        str]] = \"start\",\n                            start_time: Optional[Union[datetime, date,\n                                                       str]] = None,\n                            end_time: Optional[Union[datetime, date,\n                                                     str]] = None,\n                            start_height: Optional[int] = None,\n                            end_height: Optional[int] = None,\n                            start_chain_sequence_number: Optional[int] = None,\n                            end_chain_sequence_number: Optional[int] = None,\n                            start_inclusive: Optional[bool] = None,\n                            end_inclusive: Optional[bool] = None,\n                            timezone: Optional[str] = None) -> DataCollection\n

      Returns a list of blockchain accounts with their balances.

      Arguments:

      • asset (str): Asset name
      • accounts (str, list(str)): Optional comma separated list of accounts to filter a response.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_height (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • start_chain_sequence_number (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_chain_sequence_number (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: list of blockchain accounts metadata

      "},{"location":"api_client.html#get_list_of_sub_accounts_v2","title":"get_list_of_sub_accounts_v2","text":"
      def get_list_of_sub_accounts_v2(\n        asset: str,\n        accounts: Optional[Union[List[str], str]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_height: Optional[int] = None,\n        end_height: Optional[int] = None,\n        start_chain_sequence_number: Optional[int] = None,\n        end_chain_sequence_number: Optional[int] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None) -> DataCollection\n

      Returns a list of blockchain sub-accounts with their balances.

      Arguments:

      • asset (str): Asset name
      • accounts (str, list(str)): Optional comma separated list of accounts to filter a response.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_height (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • start_chain_sequence_number (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_chain_sequence_number (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: list of blockchain accounts metadata

      "},{"location":"api_client.html#get_list_of_transactions_v2","title":"get_list_of_transactions_v2","text":"
      def get_list_of_transactions_v2(\n        asset: str,\n        txids: Optional[Union[List[str], str]] = None,\n        block_hashes: Optional[Union[List[str], str]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_height: Optional[int] = None,\n        end_height: Optional[int] = None,\n        chain: Optional[str] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None) -> DataCollection\n

      Returns a list of blockchain transactions metadata.

      Arguments:

      • asset (str): Asset name
      • txids (str, list(str)): Optional comma separated list of transaction identifiers (txid) to filter a response.
      • block_hashes (str, list(str)): Optional comma separated list of block hashes to filter a response.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_height (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • chain (str): Default: \"main\". Chain type. Supported values are main and all (includes both main and stale).
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: list of transaction metadata

      "},{"location":"api_client.html#get_list_of_balance_updates_v2","title":"get_list_of_balance_updates_v2","text":"
      def get_list_of_balance_updates_v2(\n        asset: str,\n        accounts: Optional[Union[List[str], str]] = None,\n        sub_accounts: Optional[Union[List[str], str]] = None,\n        limit_per_account: Optional[int] = None,\n        txids: Optional[Union[List[str], str]] = None,\n        block_hashes: Optional[Union[List[str], str]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_height: Optional[int] = None,\n        end_height: Optional[int] = None,\n        start_chain_sequence_number: Optional[int] = None,\n        end_chain_sequence_number: Optional[int] = None,\n        include_sub_accounts: Optional[bool] = None,\n        chain: Optional[str] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None) -> DataCollection\n

      Returns a list of blockchain accounts balance updates.

      Arguments:

      • asset (str): Asset name
      • accounts (str, list(str)): Optional comma separated list of accounts to filter a response.
      • limit_per_account (int): How many entries per account the result should contain. It is applicable when multiple accounts are requested.
      • txids (str, list(str)): Optional comma separated list of transaction ids to filter a response.
      • block_hashes (str, list(str)): Optional comma separated list of block hashes to filter a response.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_height (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • start_chain_sequence_number (int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_time
      • end_chain_sequence_number (int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_time
      • include_sub_accounts (bool): bool indicating if the response should contain sub-accounts.
      • chain: Chain type. Supported values are main and all (includes both main and stale).
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      DataCollection: list of balance updates

      "},{"location":"api_client.html#get_full_transaction_for_block","title":"get_full_transaction_for_block","text":"
      def get_full_transaction_for_block(asset: str, block_hash: str,\n                                   txid: str) -> List[Dict[str, Any]]\n

      Arguments:

      • asset (str): Asset name.
      • block_hash (str): Block hash.
      • txid (str): Transaction identifier (txid).

      Returns:

      DataCollection: Blockchain full transaction.

      "},{"location":"api_client.html#get_full_block","title":"get_full_block","text":"
      def get_full_block(asset: str, block_hash: str) -> Dict[str, Any]\n

      Arguments:

      • asset (str): Asset name.
      • block_hash (str): Block hash.

      Returns:

      Dict[str, Any]: Blockchain full block.

      "},{"location":"api_client.html#get_full_block_v2","title":"get_full_block_v2","text":"
      def get_full_block_v2(\n        asset: str, block_hash: str,\n        include_sub_accounts: Optional[bool]) -> List[Dict[str, Any]]\n

      Returns a full blockchain block with all transactions and balance updates.

      Arguments:

      • asset (str): Asset name
      • block_hash (str): block hash
      • include_sub_accounts (bool): Boolean indicating if the response should contain sub-accounts

      Returns:

      list(dict(str), any): blockchain block data

      "},{"location":"api_client.html#get_full_transaction","title":"get_full_transaction","text":"
      def get_full_transaction(asset: str, txid: str) -> List[Dict[str, Any]]\n

      Arguments:

      • asset (Optional[str]): Asset name.
      • txid (Optional[str]): Transaction identifier (txid).

      Returns:

      DataCollection: Blockchain full transaction.

      "},{"location":"api_client.html#get_full_transaction_v2","title":"get_full_transaction_v2","text":"
      def get_full_transaction_v2(\n        asset: str, txid: str,\n        include_sub_accounts: Optional[bool]) -> List[Dict[str, Any]]\n

      Returns a full blockchain transaction with all balance updates.

      Arguments:

      • asset (str): Asset name
      • txid (str): transaction identifier
      • include_sub_accounts (bool): Boolean indicating if the response should contain sub-accounts

      Returns:

      list(dict(str), any): block transaction data

      "},{"location":"api_client.html#get_full_transaction_for_block_v2","title":"get_full_transaction_for_block_v2","text":"
      def get_full_transaction_for_block_v2(\n        asset: str, block_hash: str, txid: str,\n        include_sub_accounts: Optional[bool]) -> List[Dict[str, Any]]\n

      Returns a full blockchain transaction with all balance updates for a specific block.

      Arguments:

      • asset (str): Asset name
      • block_hash (str): block hash
      • txid (str): transaction identifier
      • include_sub_accounts (bool): Boolean indicating if the response should contain sub-accounts

      Returns:

      list(dict(str, Any)): block transaction data with balance updates

      "},{"location":"api_client.html#get_list_of_balance_updates_for_account_v2","title":"get_list_of_balance_updates_for_account_v2","text":"
      def get_list_of_balance_updates_for_account_v2(\n        asset: str,\n        account: str,\n        txids: Optional[Union[str, List[str]]] = None,\n        block_hashes: Optional[Union[str, List[str]]] = None,\n        include_counterparties: Optional[bool] = None,\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_height: Optional[int] = None,\n        end_height: Optional[int] = None,\n        start_chain_sequence_number: Optional[int] = None,\n        end_chain_sequence_number: Optional[int] = None,\n        include_sub_accounts: Optional[bool] = None,\n        chain: Optional[str] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        timezone: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> DataCollection\n

      Arguments:

      • asset (Optional[str]): Asset name.
      • account (Optional[str]): Account id.
      • txids (Union[str, List[str]]): Optional comma separated list of transaction identifiers (txid) to filter a response. The list must contain a single element for Community users.
      • block_hashes (Union[str, List[str]]): Optional comma separated list of block hashes to filter a response. The list must contain a single element for Community users.
      • include_counterparties (bool): Include information about the counterparties balance updates.
      • start_time (str): Start of the time interval. This field refers to the time field in the response. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120Z, 2006-01-20, 20060120. Inclusive by default. Mutually exclusive with start_height. UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it. If start_time is omitted, response will include time series from the earliest time available. This parameter is disabled for Community users.
      • end_time (str): End of the time interval. This field refers to the time field in the response. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120Z, 2006-01-20, 20060120. Inclusive by default. Mutually exclusive with end_height. UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it. If end_time is omitted, response will include time series up to the latest time available. This parameter is disabled for Community users.
      • start_height (int): The start height indicates the beginning block height for the set of data that are returned. Inclusive by default. Mutually exclusive with start_time. This parameter is disabled for Community users.
      • end_height (int): The end height indicates the ending block height for the set of data that are returned. Inclusive by default. Mutually exclusive with end_time. This parameter is disabled for Community users.
      • start_chain_sequence_number (int): Start of the chain_sequence_number interval. This parameter is disabled for Community users.
      • end_chain_sequence_number (int): End of the chain_sequence_number interval. This parameter is disabled for Community users.
      • include_sub_accounts (bool): Boolean indicating if the response should contain sub-accounts. This parameter is disabled for Community users.
      • chain (str): Chain type. Supported values are main and all (includes both main and stale). This parameter is disabled for Community users.
      • start_inclusive (bool): Inclusive or exclusive corresponding start_* parameters. This parameter is disabled for Community users.
      • end_inclusive (bool): Inclusive or exclusive corresponding end_* parameters. This parameter is disabled for Community users.
      • timezone (str): Timezone name for start_time and end_time timestamps. This parameter does not modify the output times, which are always UTC. Format is defined by TZ database.
      • page_size (int): Number of items per single page of results. This parameter is disabled for Community users.
      • paging_from (str): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (str): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      DataCollection: Blockchain balance updates for account.

      "},{"location":"api_client.html#get_transaction_tracker","title":"get_transaction_tracker","text":"
      def get_transaction_tracker(\n    asset: str,\n    addresses: Optional[Union[List[str], str]] = None,\n    txids: Optional[Union[List[str], str]] = None,\n    replacements_for_txids: Optional[Union[List[str], str]] = None,\n    replacements_only: Optional[bool] = None,\n    page_size: Optional[int] = None,\n    paging_from: Optional[Union[PagingFrom, str]] = \"start\",\n    start_time: Optional[Union[datetime, date, str]] = None,\n    end_time: Optional[Union[datetime, date, str]] = None,\n    start_inclusive: Optional[bool] = None,\n    end_inclusive: Optional[bool] = None,\n    timezone: Optional[str] = None,\n    unconfirmed_only: Optional[bool] = None\n) -> TransactionTrackerDataCollection\n

      Returns status updates for the specified or all transactions.

      Arguments:

      • asset (str): Asset name
      • txids (str, list(str)): Optional comma separated list of transaction identifiers (txid) to track.
      • replacements_for_txids (str, list(str)): Optional comma separated list of transaction identifiers (txid) to get the corresponding replacement transactions for. Mutually exclusive with txids.
      • replacements_only (bool): Boolean indicating if the response should contain only the replacement transactions.
      • page_size (int): number of items returned per page when calling the API. If the request times out, try using a smaller number.
      • paging_from (PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.
      • start_time (datetime, date, str): Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • end_time (datetime, date, str): End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • timezone (str): timezone of the start/end times in db format for example: \"America/Chicago\". Default value is \"UTC\". For more details check out API documentation page.

      Returns:

      TransactionTrackerDataCollection: status updates for the specified or all transactions.

      "},{"location":"api_client.html#get_taxonomy_assets","title":"get_taxonomy_assets","text":"
      def get_taxonomy_assets(assets: Optional[List[str]] = None,\n                        class_ids: Optional[List[str]] = None,\n                        sector_ids: Optional[List[str]] = None,\n                        subsector_ids: Optional[List[str]] = None,\n                        classification_start_time: Optional[str] = None,\n                        classification_end_time: Optional[str] = None,\n                        end_inclusive: Optional[bool] = None,\n                        start_inclusive: Optional[bool] = None,\n                        page_size: Optional[int] = None,\n                        paging_from: Optional[str] = None,\n                        version: Optional[str] = None) -> DataCollection\n

      Returns assets with information about their sector, industry, and industry group IDs. By default reutrns all

      covered assets

      Arguments:

      • assets (Optional[List[str]]): Asset names
      • class_ids (Optional[List[str]]): List of class identifiers.
      • sector_ids (Optional[List[str]]): Lst of sector identifiers.
      • subsector_ids (Optional[List[str]]): List of subsector identifiers
      • classification_start_time (Optional[str]): Start time for the taxonomy assets. ISO-8601 format date. Inclusive by default
      • classification_end_time (Optional[str]): End time for the taxonomy assets. ISO-8601 format date. Inclusive by default
      • start_inclusive (bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.
      • end_inclusive (bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.
      • page_size (Optional[int]): Page size for # of assets to return, will default to 100
      • paging_from (Optional[str]): Which direction to page from \"start\" or \"end\". \"end\" by default
      • version (Optional[str]): Version to query, default is \"latest\".

      Returns:

      Datacollection: Returns a data collection containing the taxonomy assets

      "},{"location":"api_client.html#get_taxonomy_assets_metadata","title":"get_taxonomy_assets_metadata","text":"
      def get_taxonomy_assets_metadata(\n        start_time: Optional[Union[datetime, date, str]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_inclusive: Optional[bool] = None,\n        end_inclusive: Optional[bool] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        version: Optional[str] = None) -> DataCollection\n

      Returns metadata about the assets, sectors, and industries included in the CM taxonomy

      Arguments:

      • start_time (Optional[Union[datetime, date, str]]): Start time for the taxonomy version file. ISO-8601 format date. Inclusive by default
      • end_time (Optional[Union[datetime, date, str]]): End time for the taxonomy version file. ISO-8601 format date. Exclusive by default
      • start_inclusive (str): Start time of taxonomy version.
      • end_inclusive (str): End time of taxonomy version.
      • page_size (Optional[int]): Page size for # of asset metadata to return, will default to 100
      • paging_from (Optional[str]): Which direction to page from \"start\" or \"end\". \"end\" by default
      • version (Optional[str]): Version to query, default is \"latest\".

      Returns:

      Datacollection: Returns a data collection containing the taxonomy assets

      "},{"location":"api_client.html#get_asset_profiles","title":"get_asset_profiles","text":"
      def get_asset_profiles(assets: Optional[Union[List[str], str]] = None,\n                       full_names: Optional[Union[List[str], str]] = None,\n                       page_size: Optional[int] = None,\n                       paging_from: Optional[str] = None) -> DataCollection\n

      Returns profile data for assets, ordered by asset

      Arguments:

      • assets (Optional[Union[List[str], str]]): Returns profile data for assets.
      • full_names (Optional[Union[List[str], str]]): Comma separated list of asset full names. By default profile data for all assets is returned. Mutually exclusive with assets parameter.
      • page_size (int): Number of items per single page of results.
      • paging_from (int): Where does the first page start, at the \"start\" of the interval or at the \"end\"

      "},{"location":"api_client.html#reference_data_asset_metrics","title":"reference_data_asset_metrics","text":"
      def reference_data_asset_metrics(\n        metrics: Optional[Union[str, List[str]]] = None,\n        reviewable: Optional[bool] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None) -> DataCollection\n

      Arguments:

      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • reviewable (Optional[bool]): Limit to human-reviewable metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.

      Returns:

      DataCollection: List of asset metrics metadata.

      "},{"location":"api_client.html#reference_data_markets","title":"reference_data_markets","text":"
      def reference_data_markets(\n        markets: Optional[Union[str, List[str]]] = None,\n        exchange: Optional[str] = None,\n        type: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        asset: Optional[str] = None,\n        symbol: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> DataCollection\n

      Arguments:

      • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • exchange (Optional[str]): Unique name of an exchange.
      • type (Optional[str]): Type of markets.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • asset (Optional[str]): Any asset of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      DataCollection: List of markets metadata.

      "},{"location":"api_client.html#reference_data_exchange_metrics","title":"reference_data_exchange_metrics","text":"
      def reference_data_exchange_metrics(\n        metrics: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None) -> DataCollection\n

      Arguments:

      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.

      Returns:

      DataCollection: List of exchange metrics metadata.

      "},{"location":"api_client.html#reference_data_exchange_asset_metrics","title":"reference_data_exchange_asset_metrics","text":"
      def reference_data_exchange_asset_metrics(\n        metrics: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None) -> DataCollection\n

      Arguments:

      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.

      Returns:

      DataCollection: List of exchange asset metrics metadata.

      "},{"location":"api_client.html#reference_data_pair_metrics","title":"reference_data_pair_metrics","text":"
      def reference_data_pair_metrics(\n        metrics: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None) -> DataCollection\n

      Arguments:

      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.

      Returns:

      DataCollection: List of pair metrics metadata.

      "},{"location":"api_client.html#reference_data_institution_metrics","title":"reference_data_institution_metrics","text":"
      def reference_data_institution_metrics(\n        metrics: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None) -> DataCollection\n

      Arguments:

      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.

      Returns:

      DataCollection: List of institution metrics metadata.

      "},{"location":"api_client.html#reference_data_assets","title":"reference_data_assets","text":"
      def reference_data_assets(\n        assets: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> DataCollection\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma separated list of assets. By default all assets are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      DataCollection: List of assets metadata.

      "},{"location":"api_client.html#reference_data_exchanges","title":"reference_data_exchanges","text":"
      def reference_data_exchanges(\n        exchanges: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> DataCollection\n

      Arguments:

      • exchanges (Optional[Union[str, List[str]]]): Comma separated list of exchanges. By default all exchanges are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      DataCollection: List of exchanges metadata.

      "},{"location":"api_client.html#reference_data_indexes","title":"reference_data_indexes","text":"
      def reference_data_indexes(\n        indexes: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> DataCollection\n

      Arguments:

      • indexes (Optional[Union[str, List[str]]]): Comma separated list of indexes. By default all indexes are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      DataCollection: List of indexes metadata.

      "},{"location":"api_client.html#reference_data_pairs","title":"reference_data_pairs","text":"
      def reference_data_pairs(\n        pairs: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> DataCollection\n

      Arguments:

      • pairs (Optional[Union[str, List[str]]]): Comma separated list of asset pairs. By default, all asset pairs are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      DataCollection: List of pairs metadata.

      "},{"location":"api_client.html#reference_data_market_metrics","title":"reference_data_market_metrics","text":"
      def reference_data_market_metrics(\n        metrics: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> DataCollection\n

      Arguments:

      • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics are returned.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      DataCollection: List of market metrics metadata.

      "},{"location":"api_client.html#security_master_assets","title":"security_master_assets","text":"
      def security_master_assets(\n        assets: Optional[Union[str, List[str]]] = None,\n        codes: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> DataCollection\n

      Arguments:

      • assets (Optional[Union[str, List[str]]]): Comma-separated list of assets to query. Mutually exclusive with codes.
      • codes (Optional[Union[str, List[str]]]): Comma-separated list of ten-digit alphanumeric identifying codes. Mutually exclusive with assets.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      DataCollection: List of assets and their metadata in security master

      "},{"location":"api_client.html#security_master_markets","title":"security_master_markets","text":"
      def security_master_markets(\n        type: Optional[str] = None,\n        markets: Optional[Union[str, List[str]]] = None,\n        symbol: Optional[str] = None,\n        exchange: Optional[str] = None,\n        base: Optional[str] = None,\n        quote: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None,\n        next_page_token: Optional[str] = None) -> DataCollection\n

      Arguments:

      • type (Optional[str]): Type of markets.
      • markets (Optional[Union[str, List[str]]]): List of markets.
      • symbol (Optional[str]): Symbol of derivative markets, full instrument name.
      • exchange (Optional[str]): Unique name of an exchange.
      • base (Optional[str]): Base asset of markets.
      • quote (Optional[str]): Quote asset of markets.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      DataCollection: List of security master entries.

      "},{"location":"api_client.html#get_snapshots_of_asset_metric_constituents","title":"get_snapshots_of_asset_metric_constituents","text":"
      def get_snapshots_of_asset_metric_constituents(\n        metric: str,\n        at_time: Optional[str] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_time: Optional[Union[datetime, date, str]] = None,\n        next_page_token: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None) -> DataCollection\n

      Arguments:

      • metric (str): Target metric name.
      • at_time (Optional[str]): Returns constituents at a specified date. Value now can be specified to get the current constituents. Mutually exclusive with start_time and/or end_time.
      • end_time (Optional[Union[datetime, date, str]]): Start of the time interval, inclusive. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120Z, 2006-01-20, 20060120. Mutually exclusive with at_time.
      • start_time (Optional[Union[datetime, date, str]]): End of the time interval, inclusive. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120Z, 2006-01-20, 20060120. Mutually exclusive with at_time.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.

      Returns:

      DataCollection: Snapshots of asset metric constituents.

      "},{"location":"api_client.html#get_timeframes_of_asset_metric_constituents","title":"get_timeframes_of_asset_metric_constituents","text":"
      def get_timeframes_of_asset_metric_constituents(\n        metric: str,\n        constituents: Optional[Union[str, List[str]]] = None,\n        end_time: Optional[Union[datetime, date, str]] = None,\n        start_time: Optional[Union[datetime, date, str]] = None,\n        next_page_token: Optional[str] = None,\n        page_size: Optional[int] = None,\n        paging_from: Optional[str] = None) -> DataCollection\n

      Arguments:

      • metric (str): Target metric name.
      • constituents (Optional[Union[str, List[str]]]): Comma separated list of constituents. By default all constituents are returned. Different asset metrics may have different constituents. For example, constituents for volume_trusted_spot_usd_1d are exchanges.
      • end_time (Optional[Union[datetime, date, str]]): Start of the time interval, inclusive. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120Z, 2006-01-20, 20060120. Mutually exclusive with at_time.
      • start_time (Optional[Union[datetime, date, str]]): End of the time interval, inclusive. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120Z, 2006-01-20, 20060120. Mutually exclusive with at_time.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.
      • page_size (Optional[int]): Number of items per single page of results.
      • paging_from (Optional[str]): Where does the first page start, at the start of the interval or at the end.

      Returns:

      DataCollection: List of timeframes.

      "},{"location":"api_client.html#blockchain_metadata_tags","title":"blockchain_metadata_tags","text":"
      def blockchain_metadata_tags(\n        type: Optional[str] = None,\n        page_size: Optional[int] = None,\n        next_page_token: Optional[str] = None) -> DataCollection\n

      Arguments:

      • type (Optional[str]): The type of a tag.
      • page_size (Optional[int]): Number of items per single page of results.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      DataCollection: List of tags.

      "},{"location":"api_client.html#blockchain_metadata_tagged_entities","title":"blockchain_metadata_tagged_entities","text":"
      def blockchain_metadata_tagged_entities(\n        tags: Optional[Union[str, List[str]]] = None,\n        entities: Optional[Union[str, List[str]]] = None,\n        locations: Optional[Union[str, List[str]]] = None,\n        page_size: Optional[int] = None,\n        next_page_token: Optional[str] = None) -> DataCollection\n

      Arguments:

      • tags (Optional[Union[str, List[str]]]): Comma separated list of tags. Mutually exclusive with entities parameter. Currently a single tag is allowed per each request.
      • entities (Optional[Union[str, List[str]]]): Comma separated list of entities. Mutually exclusive with tags parameter.
      • locations (Optional[Union[str, List[str]]]): Comma separated list of entity locations (asset representation where the entity has been tagged). Currently a single entity location is allowed per each request.
      • page_size (Optional[int]): Number of items per single page of results.
      • next_page_token (Optional[str]): Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

      Returns:

      DataCollection: List of tagged entities. Ordered by tuple (entity, tag, location, start_time) if requested by providing entities parameter. Ordered by tuple (tag, location, entity, started_time) if requested by providing tags parameter.

      "}]} \ No newline at end of file diff --git a/docs/site/sitemap.xml.gz b/docs/site/sitemap.xml.gz index 18b37319ee1c0632360476a2791f6d1b0e041082..f04ad5be93913ff0aba9770ab714d6206ce75461 100644 GIT binary patch delta 14 Vcmb=g=aBE_;0RWokT#K{8~`5U1U~=( delta 14 Vcmb=g=aBE_;BbmMoH~)C8~`At1eE{) diff --git a/poetry.lock b/poetry.lock index 13a1e67..56c82a4 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,4 +1,4 @@ -# This file is automatically @generated by Poetry 1.6.1 and should not be changed by hand. +# This file is automatically @generated by Poetry 1.8.3 and should not be changed by hand. [[package]] name = "babel" @@ -586,6 +586,16 @@ files = [ {file = "MarkupSafe-2.1.3-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:5bbe06f8eeafd38e5d0a4894ffec89378b6c6a625ff57e3028921f8ff59318ac"}, {file = "MarkupSafe-2.1.3-cp311-cp311-win32.whl", hash = "sha256:dd15ff04ffd7e05ffcb7fe79f1b98041b8ea30ae9234aed2a9168b5797c3effb"}, {file = "MarkupSafe-2.1.3-cp311-cp311-win_amd64.whl", hash = "sha256:134da1eca9ec0ae528110ccc9e48041e0828d79f24121a1a146161103c76e686"}, + {file = "MarkupSafe-2.1.3-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:f698de3fd0c4e6972b92290a45bd9b1536bffe8c6759c62471efaa8acb4c37bc"}, + {file = "MarkupSafe-2.1.3-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:aa57bd9cf8ae831a362185ee444e15a93ecb2e344c8e52e4d721ea3ab6ef1823"}, + {file = "MarkupSafe-2.1.3-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ffcc3f7c66b5f5b7931a5aa68fc9cecc51e685ef90282f4a82f0f5e9b704ad11"}, + {file = "MarkupSafe-2.1.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:47d4f1c5f80fc62fdd7777d0d40a2e9dda0a05883ab11374334f6c4de38adffd"}, + {file = "MarkupSafe-2.1.3-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:1f67c7038d560d92149c060157d623c542173016c4babc0c1913cca0564b9939"}, + {file = "MarkupSafe-2.1.3-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:9aad3c1755095ce347e26488214ef77e0485a3c34a50c5a5e2471dff60b9dd9c"}, + {file = "MarkupSafe-2.1.3-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:14ff806850827afd6b07a5f32bd917fb7f45b046ba40c57abdb636674a8b559c"}, + {file = "MarkupSafe-2.1.3-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8f9293864fe09b8149f0cc42ce56e3f0e54de883a9de90cd427f191c346eb2e1"}, + {file = "MarkupSafe-2.1.3-cp312-cp312-win32.whl", hash = "sha256:715d3562f79d540f251b99ebd6d8baa547118974341db04f5ad06d5ea3eb8007"}, + {file = "MarkupSafe-2.1.3-cp312-cp312-win_amd64.whl", hash = "sha256:1b8dd8c3fd14349433c79fa8abeb573a55fc0fdd769133baac1f5e07abf54aeb"}, {file = "MarkupSafe-2.1.3-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:8e254ae696c88d98da6555f5ace2279cf7cd5b3f52be2b5cf97feafe883b58d2"}, {file = "MarkupSafe-2.1.3-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:cb0932dc158471523c9637e807d9bfb93e06a95cbf010f1a38b98623b929ef2b"}, {file = "MarkupSafe-2.1.3-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9402b03f1a1b4dc4c19845e5c749e3ab82d5078d16a2a4c2cd2df62d57bb0707"}, @@ -1235,6 +1245,7 @@ files = [ {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515"}, + {file = "PyYAML-6.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290"}, {file = "PyYAML-6.0.1-cp310-cp310-win32.whl", hash = "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924"}, {file = "PyYAML-6.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d"}, {file = "PyYAML-6.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007"}, @@ -1242,8 +1253,16 @@ files = [ {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673"}, + {file = "PyYAML-6.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b"}, {file = "PyYAML-6.0.1-cp311-cp311-win32.whl", hash = "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741"}, {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, + {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, + {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, + {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef"}, + {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, + {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, + {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, + {file = "PyYAML-6.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df"}, {file = "PyYAML-6.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c"}, @@ -1260,6 +1279,7 @@ files = [ {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735"}, + {file = "PyYAML-6.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6"}, {file = "PyYAML-6.0.1-cp38-cp38-win32.whl", hash = "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206"}, {file = "PyYAML-6.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62"}, {file = "PyYAML-6.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8"}, @@ -1267,6 +1287,7 @@ files = [ {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c"}, + {file = "PyYAML-6.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5"}, {file = "PyYAML-6.0.1-cp39-cp39-win32.whl", hash = "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c"}, {file = "PyYAML-6.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486"}, {file = "PyYAML-6.0.1.tar.gz", hash = "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43"}, @@ -1771,4 +1792,4 @@ pandas = ["pandas"] [metadata] lock-version = "2.0" python-versions = "^3.7.1" -content-hash = "2605ac701361608dfb564416eea9b5e60d2d3092be2ee1c35b233f923be8ca09" +content-hash = "38333e8274b07e45cb3104095afb399627d5e388cb0198b910f0edfd651f3837" diff --git a/pyproject.toml b/pyproject.toml index 0108b14..d085581 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "coinmetrics-api-client" -version = "2024.2.7.10" +version = "2024.7.11.18" description = "Python client for Coin Metrics API v4." authors = ["Coin Metrics ", "Oleksandr Buchkovskyi "] license = "MIT"