From ca353fa2a3a1190a125eaf62ad42303abb99cd03 Mon Sep 17 00:00:00 2001 From: Victor Ramirez Date: Wed, 8 Jan 2025 21:32:03 +0000 Subject: [PATCH] Fix generate-docs job from poetry 2 update Fix the generate-docs job from failing due to the poetry 2 update --- .gitlab-ci.yml | 2 +- coinmetrics/__init__.py | 2 +- default.nix | 2 +- docs/docs/CHANGELOG.md | 242 ++ docs/docs/FlatFilesExport.md | 176 + docs/site/CHANGELOG.html | 1280 ++++--- docs/site/FlatFilesExport.html | 993 +++++- docs/site/api_client.html | 4844 -------------------------- docs/site/releases/CHANGELOG.html | 226 +- docs/site/search/search_index.json | 2 +- docs/site/sitemap.xml | 24 +- docs/site/sitemap.xml.gz | Bin 315 -> 320 bytes docs/site/tools/FlatFilesExport.html | 2 +- poetry.lock | 152 +- pyproject.toml | 2 +- 15 files changed, 2476 insertions(+), 5473 deletions(-) create mode 100644 docs/docs/CHANGELOG.md create mode 100644 docs/docs/FlatFilesExport.md delete mode 100644 docs/site/api_client.html diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 0b1b9dd..7451568 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -80,7 +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 lock - poetry install - apk add py3-dbus - apk add bash diff --git a/coinmetrics/__init__.py b/coinmetrics/__init__.py index 1e8482d..b9e8799 100644 --- a/coinmetrics/__init__.py +++ b/coinmetrics/__init__.py @@ -1 +1 @@ -__version__ = "2024.12.23.19" +__version__ = "2025.1.8.20" diff --git a/default.nix b/default.nix index 67cdce0..d890c43 100644 --- a/default.nix +++ b/default.nix @@ -20,7 +20,7 @@ buildPythonPackage rec { pname = "coinmetrics-api-client"; - version = "2024.12.23.19"; + version = "2025.1.8.20"; format = "pyproject"; disabled = pythonOlder "3.9"; diff --git a/docs/docs/CHANGELOG.md b/docs/docs/CHANGELOG.md new file mode 100644 index 0000000..7608fb5 --- /dev/null +++ b/docs/docs/CHANGELOG.md @@ -0,0 +1,242 @@ +# Changelog + +## 2024.12.16.21 +### Added +- pd.DateOffset as a valid data type for `time_increment` in `parallel()` + +### Changed +- Update pandas dependency to >= 2.0 and websocket-client >= 1.6.0 + +## 2024.12.16.21 +### Added +- Allowed pandas Timestamp data type to be passed in `client` API calls +- Added "deprecated" flag to catalog v1 endpoints + +## 2024.12.11.19 +### Added +- Catalog-v2/blockchain endpoints + +## 2024.12.10.20 +### Changed +- Removed unused columns for `reference_data_*().to_dataframe()` return +- Improved casting for return data types + +## 2024.11.21.20 +### Changed +- Upgraded the typer dependency to >= 0.6.1 + +## 2024.11.18.19 +### Changed +- Set `format=json_stream` for `catalog` and `reference_data` functions by default, drastically improving speed + +## 2024.10.31.17 +### Fixed +- Bug where requests have double '/' in URL + +## 2024.10.15.19 +### Changed +- Updated the request header to denote User-Agent as a Python API Client user + +## 2024.10.9.20 +### Added +- `txids` as a valid `parallelize_on` variable + +## 2024.10.4.15 +### Added +- Transformation logic for `catalog_*_v2().to_dataframe()` that flattens these dataframes +### Fixed +- Type casting for `coin_metrics_id` field from pandas dataframes for very large integers + +## 2024.9.18.17 +### Added +- Auto-retry logic for Websockets +### Removed +- Redundant tests + +## 2024.9.18.16 +### Fixed +- Bug on parallelization where `end_time` uses user's timezone instead of UTC +### Added +- `base_native` and `quote_native` fields to `reference_data_markets()` + +## 2024.8.20.13 +### Changed +- Removed JSON parsing on `on_error` for `CmStream` default + +## 2024.8.16.10 +### Removed +- Atlas V1 (`get_blockchain_()`) endpoints +### Added +- Warnings for upcoming `catalog` deprecation + +## 2024.8.14.17 +### Added +- `txid`, `accounts`, `block_hashes`, `heights`, and `sub_accounts` as valid `parallel` variables +- `height_increment` as a valid `parallel` parameter + +## 2024.8.5.13 +### Added +- Temporary patch for returning all columns for `to_dataframe()` call for `reference_data_*` and `security_master_*` functions + +## 2024.7.12.14 +### Added +- Allowed timezone aware datetimes to be passed to client API calls + +## 2024.2.6.16 +### Added +- Functions `get_market_funding_rates_predicted`, `catalog_{full}_market_funding_rates_predicted_v2` +- Generic examples for Python API Client functions + +## 2024.1.17.17 +### Fixed +- Bug where `blockchain_metadata` functions were not being called properly + +## 2023.11.27.17 +### Added +- `blockchain_metadata_tags()` and `blockchain_metadata_tagged_entities` functions +### Changed +- Updated README to shorten example code and remove catalog v1 + +## 2023.11.13.14 +### Added +- Functions `get_snapshots_of_asset_metric_constituents` and `get_timeframes_of_asset_metric_constituents` + +## 2023.10.30.13 +### Added +- Function `get_stream_market_open_interest` + +## 2023.10.19.17 +### Added +- Function `get_stream_market_liquidations` + +## 2023.9.29.14 +### Added +- `metrics` parameter to `catalog_{full}_markets_v2` +- `catalog_index_levels_v2` and `reference_data_markets` + +## 2023.9.22.21 +### Added +- Parallelization support for `blockchain` endpoints + +## 2023.9.11.14 +### Changed +- Replaced `frequency` parameter with `granularity` for `get_market_quotes` and `get_market_orderbooks` +### Added +- Functions `reference_data_assets`, `reference_data_indexes`, `reference_data_pairs` + +## 2023.8.30.20 +### Added +- Functions `security_master_assets`, `security_master_markets` + +## 2023.8.28.16 +### Added +- Functions `catalog_{full}_pair_candles_v2`, `catalog_{full}_index_candles_v2`, `catalog_{full}_asset_chains_v2`, `catalog_{full}_mempool_feerates_v2`, `catalog_{full}_mining_pool_tips_summaries_v2`, `catalog_{full}_transaction_tracker_assets_v2` + +## 2023.8.25.15 +### Added +- Ability to parallelize API request for significantly improved data pull speed + +## 2023.8.24.13 +### Added +- Functions `reference_data_asset_metrics`, `reference_data_institution_metrics` +### Fixed +- Added `frequency` parameter to `get_market_orderbooks` (fixed in 2023.9.11.14) + +## 2023.8.22.14 +### Added +- Functions `catalog_{full}_asset_metrics_v2`, `catalog_exchange_{full}_metrics_v2`, `catalog_{full}_exchange_asset_metrics_v2`, `catalog_{full}_pair_metrics_v2`, `catalog_{full}_institution_metrics_v2` + +## 2023.8.10.19 +### Added +- `on_close` handler to `CmStream` + +## 2023.7.11.17 +### Added +- Functions `catalog_{full}_contract_prices_v2`, `catalog_{full}_market_trades_v2`, `catalog_{full}_market_candles_v2`, `catalog_{full}_market_orderbooks_v2`, `catalog_{full}_market_quotes_v2`, `catalog_{full}_market_funding_rates_v2`, `catalog_{full}_market_contract_prices_v2`, `catalog_{full}_market_implied_volatility_v2`, `catalog_{full}_market_greeks_v2`, `catalog_{full}_market_open_interest`, `catalog_{full}_market_liquidations_v2`, `catalog_{full}_market_metrics_v2`. + +## 2023.6.8.20 +### Fixed +- Market metrics catalog implementation to prevent duplicate rows +- Added test to verify one row per frequency + +## 2023.5.26.17 +### Added +- Transaction tracker parameters +- Include heartbeats functionality + +## 2023.5.17.19 +### Changed +- Fixed catalog performance issues + +### Added +- Walkthrough notebook for DS UA Workshop + +## 2023.5.2.20 +### Added +- Rate limiter for community users +- Multithreading to CI pipeline +- Sample script for exporting atlas balance updates + +## 2023.4.26.13 +### Fixed +- URL fixes + +## 2023.4.24.14 +### Added +- Missing catalog endpoints +- Support for optional columns in API data +- New endpoint and tests + +## 2023.3.16.17 +### Changed +- Updated Dockerfile and dependencies +- Updated poetry lock file +- Bug fixes in examples + +### Added +- Missing timeseries stream endpoints + +## 2023.2.27.22 +### Added +- Missing functions and parameters + +## 2023.2.23.0 +### Added +- Missing functions parameters +- Improved documentation for DataCollections usage + +## 2023.1.26.23 +### Added +- Unauthorized error handling to FlatFilesExporter +- Updated CI pipeline + +## 2023.1.10.21 +### Added +- Debug mode to help figure out performance issues +- Documentation updates for to_dataframe() method for catalog +- Automated testing code coverage +- Error handling for large requests (URI too long) +- Support for secondary_level parameter in to_dataframe() +- Support for index levels via WS in the client + +## 2022.11.14.16 +### Changed +- Modified API Client to use python requests.Session for improved performance + +## 2022.11.3.18 +### Added +- Taxonomy endpoints +- Updated Atlas V2 balance endpoints + +### Fixed +- Fixed broken examples using `type` parameter + +## 2022.10.18.18 +### Changed +- Updated build pipeline + +## 2022.10.14.20 +### Added +- New catalog endpoints for metrics +- Automated version updates on release +- Documentation generation \ No newline at end of file diff --git a/docs/docs/FlatFilesExport.md b/docs/docs/FlatFilesExport.md new file mode 100644 index 0000000..7bcf46b --- /dev/null +++ b/docs/docs/FlatFilesExport.md @@ -0,0 +1,176 @@ +## Exporting flat files +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. + +## Authorization for flat files download +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](https://coinmetrics.io/community-network-data/). +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. + +### Installation and set up +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: + +```commandline +python -m venv .venv +source .venv/bin/activate +pip install coinmetrics-api-client +``` + +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=` in your terminal on MacOS/Linux or just `set CM_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: +```commandline +Commands: + get-asset-pairs + get-exchanges + market-candles-future Used to export data related to future market... + market-candles-spot Used to export data related to spot market candles. + market-quotes-future Used to export data related to future market... + market-quotes-spot Used to export data related to spot market quotes... + market-trades-future Used to export data related to future market... + market-trades-spot Used to export data related to spot market trades. +``` + +### Exporting Market Trades Files +Further documentation is available on any of the commands by running `coinmetrics export --help`, for example +running `coinmetrics export market-trades-spot --help` prints: +```commandline +Usage: coinmetrics export market-trades-spot [OPTIONS] EXCHANGES [START_DATE]: + [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m + -%d %H:%M:%S] [END_DATE]:[%Y-%m-% + d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d + %H:%M:%S] + + Used to export data related to spot market trades. Format: coinmetrics + export market-trades-spot Example: + coinmetrics export market-trades-spot coinbase,binance 2022-01-01 + 2022-01-03. + +Arguments: + EXCHANGES Pass in arguments as a list of strings + separated by by commas i.e. + binance,coinbase,bitmex [required] + + [START_DATE]:[%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S] + [default: 2022-08-10] + [END_DATE]:[%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S] + [default: 2022-08-10] + +Options: + --output-format TEXT [default: json.gz] + --threaded / --no-threaded [default: False] + --api-key TEXT + --help Show this message and exit. + +``` + +#### Example: +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: +```commandline +market-trades-spot +├── binance +│   ├── 2022-06-01.json.gz +│   ├── 2022-06-02.json.gz +│   ├── 2022-06-03.json.gz +│   ├── 2022-06-04.json.gz +│   └── 2022-06-05.json.gz +└── coinbase + ├── 2022-06-01.json.gz + ├── 2022-06-02.json.gz + ├── 2022-06-03.json.gz + ├── 2022-06-04.json.gz + └── 2022-06-05.json.gz +``` +By default the files are downloaded as [gzipped json files](https://fileinfo.com/extension/gz) - 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 `, +so in this case running `coinmetrics export get-exchanges market-trades-spot` + +### Exporting market quotes +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 ` +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`. + +### Exporting market candles +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: +```commandline +market-candles-spot-5m +├── binance +│   ├── 2022-01-01.json.gz +│   ├── 2022-01-02.json.gz +│   ├── 2022-01-03.json.gz +│   ├── 2022-01-04.json.gz +│   └── 2022-01-05.json.gz +└── coinbase + ├── 2022-01-01.json.gz + ├── 2022-01-02.json.gz + ├── 2022-01-03.json.gz + ├── 2022-01-04.json.gz + └── 2022-01-05.json.gz +``` + +The functionality is the same for `market-candles-future` + +### Using API Key without setting an environment variable +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 ` + +### Downloading files in parallel +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. + +### Using the CoinMetricsDataExporter in Python instead of CLI +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](examples/files_download) as well as one below: +```python +from coinmetrics.data_exporter import CoinMetricsDataExporter +from datetime import datetime + +CM_API_KEY = "" +data_exporter = CoinMetricsDataExporter(api_key=CM_API_KEY) + +if __name__ == "__main__": + """ + This script will export all the daily market-trades-spot files for Coinbase and Gemini for the month of January + """ + start_date = datetime(2019, 1, 1) + end_date = datetime(2019, 1, 31) + exchanges = ["coinbase","gemini"] + data_exporter.export_market_trades_spot_data(start_date=start_date, end_date=end_date, exchanges=exchanges, threaded=True) +``` + diff --git a/docs/site/CHANGELOG.html b/docs/site/CHANGELOG.html index 986f162..c111ded 100644 --- a/docs/site/CHANGELOG.html +++ b/docs/site/CHANGELOG.html @@ -1,397 +1,847 @@ - - - - - - - - Changelog - Coin Metrics Python API Client - - - - - - - - - - - - - -
- + -
- -
-
-
-
-
+ + -

Changelog

+ + + + + + + + + + +
+
+
+ + + + +
+
-
-
- -
- Built with MkDocs using a theme provided by Read the Docs. - - -
-
- - -
- + + + + + + + + +
+ + + + + + + + + + +
+
+
- « Previous + - Next » + + - - - - - - - - - - - + + \ No newline at end of file diff --git a/docs/site/FlatFilesExport.html b/docs/site/FlatFilesExport.html index f3b7a8f..05cc6d4 100644 --- a/docs/site/FlatFilesExport.html +++ b/docs/site/FlatFilesExport.html @@ -1,87 +1,849 @@ - - - - - - - - Flat Files Exporter - Coin Metrics Python API Client - - - - - - - - - - - - - -
- -
-
-
    -
    • -
  • Flat Files Exporter
    • -
  • +
-
-
+ + + + + + + + + + -

Exporting flat files

+ + + + + + + + + + + + + + + + + + +
  • + + + + + + + + + + +
    • + + + + + + + + + + + + + + + + + + + + + +
  • + + + + + + + + + + +
    • + + + + + + + + + + + + + + + + + + + + + +
  • + + + + + + + + + + +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
  • + + + + + + + + + + +
    • + + + + + + + + + +
  • + + + + + Releases + + + + +
    • + + + + + + + + + + + + + + + + + + + + +
  • + + + + + + + + + + +
    • + + + + + +
    +
    +
    + + + + +
    +
    + + + + + + + +

    FlatFilesExport

    + +

    Exporting flat files

    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.

    @@ -229,48 +991,59 @@

    Using the Co exchanges = ["coinbase","gemini"] data_exporter.export_market_trades_spot_data(start_date=start_date, end_date=end_date, exchanges=exchanges, threaded=True)

    - -
    -
    - - - - - -
    - + + + + + + + + +
    + + + + + + + + + + +
    +
    +
    - « Previous + - - - - - - - - - - - + + + + + + \ No newline at end of file diff --git a/docs/site/api_client.html b/docs/site/api_client.html deleted file mode 100644 index b972820..0000000 --- a/docs/site/api_client.html +++ /dev/null @@ -1,4844 +0,0 @@ - - - - - - - - API Client Spec - Coin Metrics Python API Client - - - - - - - - - - - - - -
    - - -
    - -
    -
    -
      -
      • -
    • API Client Spec
      • -
    • -
      • -
    -
    -
    -
    -
    - -

    -

    coinmetrics.api_client

    -

    -

    CoinMetricsClient Objects

    -
    class CoinMetricsClient()
-
    -

    -

    catalog_assets

    -
    @deprecated("catalog")
-def catalog_assets(
-        assets: Optional[Union[List[str], str]] = None,
-        include: Optional[Union[List[str], str]] = None,
-        exclude: Optional[Union[List[str], str]] = None) -> CatalogAssetsData
-
    -

    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.

    -

    -

    catalog_asset_alerts

    -
    @deprecated("catalog")
-def catalog_asset_alerts(
-        assets: Optional[Union[str, List[str]]] = None,
-        alerts: Optional[Union[str,
-                               List[str]]] = None) -> CatalogAssetAlertsData
-
    -

    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.

    -

    -

    catalog_asset_chains

    -
    @deprecated("catalog")
-def catalog_asset_chains(
-        assets: Optional[Union[str,
-                               List[str]]] = None) -> CatalogAssetChainsData
-
    -

    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

    -

    -

    catalog_mempool_feerates

    -
    @deprecated("catalog")
-def catalog_mempool_feerates(
-    assets: Optional[Union[str,
-                           List[str]]] = None) -> CatalogMempoolFeeratesData
-
    -

    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

    -

    -

    catalog_mining_pool_tips_summaries

    -
    @deprecated("catalog")
-def catalog_mining_pool_tips_summaries(
-    assets: Optional[Union[str,
-                           List[str]]] = None) -> CatalogMiningPoolTipsData
-
    -

    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

    -

    -

    catalog_transaction_tracker_assets

    -
    @deprecated("catalog")
-def catalog_transaction_tracker_assets(
-    assets: Optional[Union[str, List[str]]] = None
-) -> CatalogTransactionTrackerData
-
    -

    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

    -

    -

    catalog_asset_pairs

    -
    @deprecated("catalog")
-def catalog_asset_pairs(
-    asset_pairs: Optional[Union[List[str],
-                                str]] = None) -> CatalogAssetPairsData
-
    -

    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

    -

    -

    catalog_asset_metrics

    -
    @deprecated("catalog")
-def catalog_asset_metrics(
-        metrics: Optional[Union[List[str], str]] = None,
-        reviewable: Optional[bool] = None) -> CatalogMetricsData
-
    -

    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.

    -

    -

    catalog_exchange_metrics

    -
    @deprecated("catalog")
-def catalog_exchange_metrics(
-        metrics: Optional[Union[List[str], str]] = None,
-        reviewable: Optional[bool] = None) -> CatalogMetricsData
-
    -

    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.

    -

    -

    catalog_exchange_asset_metrics

    -
    @deprecated("catalog")
-def catalog_exchange_asset_metrics(
-        metrics: Optional[Union[List[str], str]] = None,
-        reviewable: Optional[bool] = None) -> CatalogExchangeAssetMetricsData
-
    -

    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.

    -

    -

    catalog_pair_metrics

    -
    @deprecated("catalog")
-def catalog_pair_metrics(
-        metrics: Optional[Union[List[str], str]] = None,
-        reviewable: Optional[bool] = None) -> CatalogPairMetricsData
-
    -

    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.

    -

    -

    catalog_institution_metrics

    -
    @deprecated("catalog")
-def catalog_institution_metrics(
-        metrics: Optional[Union[List[str], str]] = None,
-        reviewable: Optional[bool] = None) -> CatalogInstitutionMetricsData
-
    -

    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.

    -

    -

    catalog_asset_pair_candles

    -
    @deprecated("catalog")
-def catalog_asset_pair_candles(
-    asset_pairs: Optional[Union[List[str], str]] = None
-) -> CatalogAssetPairCandlesData
-
    -

    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.

    -

    -

    catalog_exchanges

    -
    @deprecated("catalog")
-def catalog_exchanges(
-        exchanges: Optional[Union[List[str],
-                                  str]] = None) -> CatalogExchangesData
-
    -

    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.

    -

    -

    catalog_exchange_assets

    -
    @deprecated("catalog")
-def catalog_exchange_assets(
-    exchange_assets: Optional[Union[List[str], str]] = None
-) -> CatalogExchangeAssetsData
-
    -

    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

    -

    -

    catalog_indexes

    -
    @deprecated("catalog")
-def catalog_indexes(
-        indexes: Optional[Union[List[str], str]] = None) -> CatalogIndexesData
-
    -

    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.

    -

    -

    catalog_index_candles

    -
    @deprecated("catalog")
-def catalog_index_candles(
-    indexes: Optional[Union[List[str],
-                            str]] = None) -> CatalogMarketCandlesData
-
    -

    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.

    -

    -

    catalog_institutions

    -
    @deprecated("catalog")
-def catalog_institutions(
-    institutions: Optional[Union[List[str], str]] = None
-) -> CatalogInstitutionsData
-
    -

    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.

    -

    -

    catalog_markets

    -
    @deprecated("catalog")
-def catalog_markets(
-        markets: Optional[Union[List[str], str]] = None,
-        market_type: Optional[str] = None,
-        exchange: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        include: Optional[Union[List[str], str]] = None,
-        exclude: Optional[Union[List[str], str]] = None) -> CatalogMarketsData
-
    -

    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.

    -

    -

    catalog_market_trades

    -
    @deprecated("catalog")
-def catalog_market_trades(
-        markets: Optional[Union[List[str], str]] = None,
-        market_type: Optional[str] = None,
-        exchange: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None) -> CatalogMarketTradesData
-
    -

    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

    -

    -

    catalog_metrics

    -
    @deprecated("catalog")
-def catalog_metrics(metrics: Optional[Union[List[str], str]] = None,
-                    reviewable: Optional[bool] = None) -> CatalogMetricsData
-
    -

    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.

    -

    -

    catalog_market_metrics

    -
    @deprecated("catalog")
-def catalog_market_metrics(
-        markets: Optional[Union[List[str], str]] = None,
-        market_type: Optional[str] = None,
-        exchange: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None) -> CatalogMarketMetricsData
-
    -

    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.

    -

    -

    catalog_market_candles

    -
    @deprecated("catalog")
-def catalog_market_candles(
-        markets: Optional[Union[List[str], str]] = None,
-        market_type: Optional[str] = None,
-        exchange: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None) -> CatalogMarketCandlesData
-
    -

    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.

    -

    -

    catalog_market_orderbooks

    -
    @deprecated("catalog")
-def catalog_market_orderbooks(
-        markets: Optional[Union[List[str], str]] = None,
-        market_type: Optional[str] = None,
-        exchange: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None) -> CatalogMarketOrderbooksData
-
    -

    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

    -

    -

    catalog_market_quotes

    -
    @deprecated("catalog")
-def catalog_market_quotes(
-        markets: Optional[Union[List[str], str]] = None,
-        market_type: Optional[str] = None,
-        exchange: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None) -> CatalogMarketTradesData
-
    -

    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

    -

    -

    catalog_market_funding_rates

    -
    @deprecated("catalog")
-def catalog_market_funding_rates(
-        markets: Optional[Union[List[str], str]] = None,
-        market_type: Optional[str] = None,
-        exchange: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None) -> CatalogMarketTradesData
-
    -

    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

    -

    -

    catalog_market_contract_prices

    -
    @deprecated("catalog")
-def catalog_market_contract_prices(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = None,
-        limit: Optional[str] = None) -> CatalogMarketContractPrices
-
    -

    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.

    -

    -

    catalog_market_implied_volatility

    -
    @deprecated("catalog")
-def catalog_market_implied_volatility(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = None,
-        limit: Optional[str] = None) -> CatalogMarketImpliedVolatility
-
    -

    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.

    -

    -

    catalog_market_greeks

    -
    @deprecated("catalog")
-def catalog_market_greeks(
-        markets: Optional[Union[List[str], str]] = None,
-        market_type: Optional[str] = None,
-        exchange: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None) -> CatalogMarketTradesData
-
    -

    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

    -

    -

    catalog_market_open_interest

    -
    @deprecated("catalog")
-def catalog_market_open_interest(
-        markets: Optional[Union[List[str], str]] = None,
-        market_type: Optional[str] = None,
-        exchange: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None) -> CatalogMarketTradesData
-
    -

    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

    -

    -

    catalog_market_liquidations

    -
    @deprecated("catalog")
-def catalog_market_liquidations(
-        markets: Optional[Union[List[str], str]] = None,
-        market_type: Optional[str] = None,
-        exchange: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None) -> CatalogMarketTradesData
-
    -

    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

    -

    -

    catalog_full_assets

    -
    @deprecated("catalog")
-def catalog_full_assets(
-        assets: Optional[Union[List[str], str]] = None,
-        include: Optional[Union[List[str], str]] = None,
-        exclude: Optional[Union[List[str], str]] = None) -> CatalogAssetsData
-
    -

    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.

    -

    -

    catalog_full_asset_metrics

    -
    @deprecated("catalog")
-def catalog_full_asset_metrics(
-        metrics: Optional[Union[List[str], str]] = None,
-        reviewable: Optional[bool] = None) -> CatalogMetricsData
-
    -

    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.

    -

    -

    catalog_full_asset_alerts

    -
    @deprecated("catalog")
-def catalog_full_asset_alerts(
-        assets: Optional[Union[str, List[str]]] = None,
-        alerts: Optional[Union[str,
-                               List[str]]] = None) -> CatalogAssetAlertsData
-
    -

    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.

    -

    -

    catalog_full_asset_chains

    -
    @deprecated("catalog")
-def catalog_full_asset_chains(
-        assets: Optional[Union[str,
-                               List[str]]] = None) -> CatalogAssetChainsData
-
    -

    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

    -

    -

    catalog_full_mempool_feerates

    -
    @deprecated("catalog")
-def catalog_full_mempool_feerates(
-    assets: Optional[Union[str,
-                           List[str]]] = None) -> CatalogMempoolFeeratesData
-
    -

    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

    -

    -

    catalog_full_mining_pool_tips_summaries

    -
    @deprecated("catalog")
-def catalog_full_mining_pool_tips_summaries(
-    assets: Optional[Union[str,
-                           List[str]]] = None) -> CatalogMiningPoolTipsData
-
    -

    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

    -

    -

    catalog_full_transaction_tracker_assets

    -
    @deprecated("catalog")
-def catalog_full_transaction_tracker_assets(
-    assets: Optional[Union[str, List[str]]] = None
-) -> CatalogTransactionTrackerData
-
    -

    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

    -

    -

    catalog_full_asset_pairs

    -
    @deprecated("catalog")
-def catalog_full_asset_pairs(
-    asset_pairs: Optional[Union[List[str],
-                                str]] = None) -> CatalogAssetPairsData
-
    -

    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

    -

    -

    catalog_full_pair_metrics

    -
    @deprecated("catalog")
-def catalog_full_pair_metrics(
-        metrics: Optional[Union[List[str], str]] = None,
-        reviewable: Optional[bool] = None) -> CatalogPairMetricsData
-
    -

    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.

    -

    -

    catalog_full_institution_metrics

    -
    @deprecated("catalog")
-def catalog_full_institution_metrics(
-        metrics: Optional[Union[List[str], str]] = None,
-        reviewable: Optional[bool] = None) -> CatalogInstitutionMetricsData
-
    -

    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.

    -

    -

    catalog_full_asset_pair_candles

    -
    @deprecated("catalog")
-def catalog_full_asset_pair_candles(
-    asset_pairs: Optional[Union[List[str], str]] = None
-) -> CatalogAssetPairCandlesData
-
    -

    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.

    -

    -

    catalog_full_exchanges

    -
    @deprecated("catalog")
-def catalog_full_exchanges(
-        exchanges: Optional[Union[List[str],
-                                  str]] = None) -> CatalogExchangesData
-
    -

    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.

    -

    -

    catalog_full_exchange_assets

    -
    @deprecated("catalog")
-def catalog_full_exchange_assets(
-    exchange_assets: Optional[Union[List[str], str]] = None
-) -> CatalogExchangeAssetsData
-
    -

    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

    -

    -

    catalog_full_exchange_metrics

    -
    @deprecated("catalog")
-def catalog_full_exchange_metrics(
-        metrics: Optional[Union[List[str], str]] = None,
-        reviewable: Optional[bool] = None) -> CatalogMetricsData
-
    -

    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.

    -

    -

    catalog_full_exchange_asset_metrics

    -
    @deprecated("catalog")
-def catalog_full_exchange_asset_metrics(
-        metrics: Optional[Union[List[str], str]] = None,
-        reviewable: Optional[bool] = None) -> CatalogExchangeAssetMetricsData
-
    -

    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.

    -

    -

    catalog_full_indexes

    -
    @deprecated("catalog")
-def catalog_full_indexes(
-        indexes: Optional[Union[List[str], str]] = None) -> CatalogIndexesData
-
    -

    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.

    -

    -

    catalog_full_index_candles

    -
    @deprecated("catalog")
-def catalog_full_index_candles(
-    indexes: Optional[Union[List[str],
-                            str]] = None) -> CatalogMarketCandlesData
-
    -

    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.

    -

    -

    catalog_full_institutions

    -
    @deprecated("catalog")
-def catalog_full_institutions(
-    institutions: Optional[Union[List[str], str]] = None
-) -> CatalogInstitutionsData
-
    -

    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.

    -

    -

    catalog_full_markets

    -
    @deprecated("catalog")
-def catalog_full_markets(markets: Optional[Union[List[str], str]] = None,
-                         market_type: Optional[str] = None,
-                         exchange: Optional[str] = None,
-                         base: Optional[str] = None,
-                         quote: Optional[str] = None,
-                         asset: Optional[str] = None,
-                         symbol: Optional[str] = None,
-                         include: Optional[str] = None,
-                         exclude: Optional[str] = None) -> CatalogMarketsData
-
    -

    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.

    -

    -

    catalog_full_market_trades

    -
    @deprecated("catalog")
-def catalog_full_market_trades(
-        markets: Optional[Union[List[str], str]] = None,
-        market_type: Optional[str] = None,
-        exchange: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None) -> CatalogMarketTradesData
-
    -

    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

    -

    -

    catalog_full_metrics

    -
    @deprecated("catalog")
-def catalog_full_metrics(
-        metrics: Optional[Union[List[str], str]] = None,
-        reviewable: Optional[bool] = None) -> CatalogMetricsData
-
    -

    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.

    -

    -

    catalog_full_market_metrics

    -
    @deprecated("catalog")
-def catalog_full_market_metrics(
-        markets: Optional[Union[List[str], str]] = None,
-        market_type: Optional[str] = None,
-        exchange: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None) -> CatalogMarketMetricsData
-
    -

    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.

    -

    -

    catalog_full_market_candles

    -
    @deprecated("catalog")
-def catalog_full_market_candles(
-        markets: Optional[Union[List[str], str]] = None,
-        market_type: Optional[str] = None,
-        exchange: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None) -> CatalogMarketCandlesData
-
    -

    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.

    -

    -

    catalog_full_market_orderbooks

    -
    @deprecated("catalog")
-def catalog_full_market_orderbooks(
-        markets: Optional[Union[List[str], str]] = None,
-        market_type: Optional[str] = None,
-        exchange: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None) -> CatalogMarketTradesData
-
    -

    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

    -

    -

    catalog_full_market_quotes

    -
    @deprecated("catalog")
-def catalog_full_market_quotes(
-        markets: Optional[Union[List[str], str]] = None,
-        market_type: Optional[str] = None,
-        exchange: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None) -> CatalogMarketTradesData
-
    -

    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

    -

    -

    catalog_full_market_funding_rates

    -
    @deprecated("catalog")
-def catalog_full_market_funding_rates(
-        markets: Optional[Union[List[str], str]] = None,
-        market_type: Optional[str] = None,
-        exchange: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None) -> CatalogMarketTradesData
-
    -

    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

    -

    -

    catalog_full_market_contract_prices

    -
    @deprecated("catalog")
-def catalog_full_market_contract_prices(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = None,
-        limit: Optional[str] = None) -> CatalogMarketContractPrices
-
    -

    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.

    -

    -

    catalog_full_contract_prices_v2

    -
    def catalog_full_contract_prices_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_full_market_implied_volatility

    -
    def catalog_full_market_implied_volatility(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = None,
-        limit: Optional[str] = None) -> CatalogMarketImpliedVolatility
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    • limit (Optional[str]): Limit of response items. none means no limit.
      • -
    -

    Returns:

    -

    CatalogMarketImpliedVolatility: List of implied volatility statistics.

    -

    -

    catalog_full_market_greeks

    -
    def catalog_full_market_greeks(
-        markets: Optional[Union[List[str], str]] = None,
-        market_type: Optional[str] = None,
-        exchange: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None) -> CatalogMarketTradesData
-
    -

    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

    -

    -

    catalog_full_market_open_interest

    -
    def catalog_full_market_open_interest(
-        markets: Optional[Union[List[str], str]] = None,
-        market_type: Optional[str] = None,
-        exchange: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None) -> CatalogMarketTradesData
-
    -

    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

    -

    -

    catalog_full_market_liquidations

    -
    def catalog_full_market_liquidations(
-        markets: Optional[Union[List[str], str]] = None,
-        market_type: Optional[str] = None,
-        exchange: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None) -> CatalogMarketTradesData
-
    -

    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

    -

    -

    catalog_market_trades_v2

    -
    def catalog_market_trades_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_market_candles_v2

    -
    def catalog_market_candles_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_market_orderbooks_v2

    -
    def catalog_market_orderbooks_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_market_quotes_v2

    -
    def catalog_market_quotes_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_market_funding_rates_v2

    -
    def catalog_market_funding_rates_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_market_funding_rates_predicted_v2

    -
    def catalog_market_funding_rates_predicted_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_market_contract_prices_v2

    -
    def catalog_market_contract_prices_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_market_implied_volatility_v2

    -
    def catalog_market_implied_volatility_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_market_greeks_v2

    -
    def catalog_market_greeks_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_market_open_interest_v2

    -
    def catalog_market_open_interest_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_market_liquidations_v2

    -
    def catalog_market_liquidations_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_market_metrics_v2

    -
    def catalog_market_metrics_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        metrics: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    Arguments:

    -
      -
    • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • -
    • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics 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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_full_market_trades_v2

    -
    def catalog_full_market_trades_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_full_market_candles_v2

    -
    def catalog_full_market_candles_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_full_market_orderbooks_v2

    -
    def catalog_full_market_orderbooks_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_full_market_quotes_v2

    -
    def catalog_full_market_quotes_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_full_market_funding_rates_v2

    -
    def catalog_full_market_funding_rates_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_full_market_funding_rates_predicted_v2

    -
    def catalog_full_market_funding_rates_predicted_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_full_market_contract_prices_v2

    -
    def catalog_full_market_contract_prices_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_full_market_implied_volatility_v2

    -
    def catalog_full_market_implied_volatility_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_full_market_greeks_v2

    -
    def catalog_full_market_greeks_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_full_market_open_interest_v2

    -
    def catalog_full_market_open_interest_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_full_market_liquidations_v2

    -
    def catalog_full_market_liquidations_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_full_market_metrics_v2

    -
    def catalog_full_market_metrics_v2(
-        markets: Optional[Union[str, List[str]]] = None,
-        metrics: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        market_type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        format: Optional[str] = "json_stream",
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> CatalogV2DataCollection
-
    -

    Arguments:

    -
      -
    • markets (Optional[Union[str, List[str]]]): Comma separated list of markets. By default all markets are returned.
      • -
    • metrics (Optional[Union[str, List[str]]]): Comma separated list of metrics. By default all metrics 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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='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.

    -

    -

    catalog_asset_metrics_v2

    -
    def catalog_asset_metrics_v2(
-        assets: Optional[Union[str, List[str]]] = None,
-        metrics: Optional[Union[str, List[str]]] = None,
-        reviewable: Optional[bool] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of asset metrics.

    -

    -

    catalog_full_asset_metrics_v2

    -
    def catalog_full_asset_metrics_v2(
-        assets: Optional[Union[str, List[str]]] = None,
-        metrics: Optional[Union[str, List[str]]] = None,
-        reviewable: Optional[bool] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of asset metrics.

    -

    -

    catalog_exchange_metrics_v2

    -
    def catalog_exchange_metrics_v2(
-        exchanges: Optional[Union[str, List[str]]] = None,
-        metrics: Optional[Union[str, List[str]]] = None,
-        reviewable: Optional[bool] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of exchange metrics.

    -

    -

    catalog_full_exchange_metrics_v2

    -
    def catalog_full_exchange_metrics_v2(
-        exchanges: Optional[Union[str, List[str]]] = None,
-        metrics: Optional[Union[str, List[str]]] = None,
-        reviewable: Optional[bool] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of exchange metrics.

    -

    -

    catalog_exchange_asset_metrics_v2

    -
    def catalog_exchange_asset_metrics_v2(
-        exchange_assets: Optional[Union[str, List[str]]] = None,
-        metrics: Optional[Union[str, List[str]]] = None,
-        reviewable: Optional[bool] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of exchange-asset metrics.

    -

    -

    catalog_full_exchange_asset_metrics_v2

    -
    def catalog_full_exchange_asset_metrics_v2(
-        exchange_assets: Optional[Union[str, List[str]]] = None,
-        metrics: Optional[Union[str, List[str]]] = None,
-        reviewable: Optional[bool] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of exchange-asset metrics.

    -

    -

    catalog_pair_metrics_v2

    -
    def catalog_pair_metrics_v2(
-        pairs: Optional[Union[str, List[str]]] = None,
-        metrics: Optional[Union[str, List[str]]] = None,
-        reviewable: Optional[bool] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of pair metrics.

    -

    -

    catalog_full_pair_metrics_v2

    -
    def catalog_full_pair_metrics_v2(
-        pairs: Optional[Union[str, List[str]]] = None,
-        metrics: Optional[Union[str, List[str]]] = None,
-        reviewable: Optional[bool] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of pair metrics.

    -

    -

    catalog_institution_metrics_v2

    -
    def catalog_institution_metrics_v2(
-        institutions: Optional[Union[str, List[str]]] = None,
-        metrics: Optional[Union[str, List[str]]] = None,
-        reviewable: Optional[bool] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of institution metrics.

    -

    -

    catalog_full_institution_metrics_v2

    -
    def catalog_full_institution_metrics_v2(
-        institutions: Optional[Union[str, List[str]]] = None,
-        metrics: Optional[Union[str, List[str]]] = None,
-        reviewable: Optional[bool] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of institution metrics.

    -

    -

    catalog_pair_candles_v2

    -
    def catalog_pair_candles_v2(
-        pairs: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of asset pair candles statistics.

    -

    -

    catalog_index_candles_v2

    -
    def catalog_index_candles_v2(
-        indexes: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of index candles statistics.

    -

    -

    catalog_index_levels_v2

    -
    def catalog_index_levels_v2(
-        indexes: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of index levels.

    -

    -

    catalog_asset_chains_v2

    -
    def catalog_asset_chains_v2(
-        assets: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of asset chains assets

    -

    -

    catalog_mempool_feerates_v2

    -
    def catalog_mempool_feerates_v2(
-        assets: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of mempool feerates assets

    -

    -

    catalog_mining_pool_tips_summaries_v2

    -
    def catalog_mining_pool_tips_summaries_v2(
-        assets: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of mining pool tips assets

    -

    -

    catalog_transaction_tracker_assets_v2

    -
    def catalog_transaction_tracker_assets_v2(
-        assets: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of transaction tracker assets

    -

    -

    catalog_full_pair_candles_v2

    -
    def catalog_full_pair_candles_v2(
-        pairs: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of asset pair candles statistics.

    -

    -

    catalog_full_index_candles_v2

    -
    def catalog_full_index_candles_v2(
-        indexes: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of index candles statistics.

    -

    -

    catalog_full_index_levels_v2

    -
    def catalog_full_index_levels_v2(
-        indexes: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of index levels.

    -

    -

    catalog_full_asset_chains_v2

    -
    def catalog_full_asset_chains_v2(
-        assets: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of asset chains assets

    -

    -

    catalog_full_mempool_feerates_v2

    -
    def catalog_full_mempool_feerates_v2(
-        assets: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of mempool feerates assets

    -

    -

    catalog_full_mining_pool_tips_summaries_v2

    -
    def catalog_full_mining_pool_tips_summaries_v2(
-        assets: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of mining pool tips assets

    -

    -

    catalog_full_transaction_tracker_assets_v2

    -
    def catalog_full_transaction_tracker_assets_v2(
-        assets: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of transaction tracker assets

    -

    -

    catalog_blockchain_accounts_v2

    -
    def catalog_blockchain_accounts_v2(
-        assets: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of blockchain-v2/accounts assets using catalog-v2

    -

    -

    catalog_blockchain_balance_updates_v2

    -
    def catalog_blockchain_balance_updates_v2(
-        assets: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of blockchain-v2/balance-updates assets using catalog-v2

    -

    -

    catalog_blockchain_blocks_v2

    -
    def catalog_blockchain_blocks_v2(
-        assets: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of blockchain-v2/blocks assets using catalog-v2

    -

    -

    catalog_blockchain_transactions_v2

    -
    def catalog_blockchain_transactions_v2(
-        assets: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: List of blockchain-v2/transactions assets using catalog-v2

    -

    -

    catalog_full_blockchain_accounts_v2

    -
    def catalog_full_blockchain_accounts_v2(
-        assets: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: Full list of blockchain-v2/accounts assets using catalog-v2

    -

    -

    catalog_full_blockchain_balance_updates_v2

    -
    def catalog_full_blockchain_balance_updates_v2(
-        assets: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: Full list of blockchain-v2/balance-updates assets using catalog-v2

    -

    -

    catalog_full_blockchain_blocks_v2

    -
    def catalog_full_blockchain_blocks_v2(
-        assets: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: Full list of blockchain-v2/blocks assets using catalog-v2

    -

    -

    catalog_full_blockchain_transactions_v2

    -
    def catalog_full_blockchain_transactions_v2(
-        assets: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> CatalogV2DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    CatalogV2DataCollection: Full list of blockchain-v2/transactions assets using catalog-v2

    -

    -

    get_asset_alerts

    -
    def get_asset_alerts(
-        assets: Union[List[str], str],
-        alerts: Union[List[str], str],
-        page_size: Optional[int] = None,
-        paging_from: Optional[Union[PagingFrom, str]] = "start",
-        start_time: Optional[Union[datetime, date, str]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_inclusive: Optional[bool] = None,
-        end_inclusive: Optional[bool] = None,
-        timezone: Optional[str] = None,
-        include_heartbeats: Optional[bool] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_defi_balance_sheets

    -
    def get_defi_balance_sheets(defi_protocols: Union[str, List[str]],
-                            page_size: Optional[int] = None,
-                            paging_from: Optional[Union[PagingFrom,
-                                                        str]] = "start",
-                            start_time: Optional[Union[datetime, date,
-                                                       str]] = None,
-                            end_time: Optional[Union[datetime, date,
-                                                     str]] = None,
-                            start_height: Optional[int] = None,
-                            end_height: Optional[int] = None,
-                            start_inclusive: Optional[bool] = None,
-                            end_inclusive: Optional[bool] = None,
-                            timezone: Optional[str] = None) -> DataCollection
-
    -

    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

    -

    -

    get_asset_chains

    -
    def get_asset_chains(
-        assets: Union[List[str], str],
-        page_size: Optional[int] = None,
-        paging_from: Optional[Union[PagingFrom, str]] = "start",
-        start_time: Optional[Union[datetime, date, str]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_inclusive: Optional[bool] = None,
-        end_inclusive: Optional[bool] = None,
-        timezone: Optional[str] = None) -> AssetChainsDataCollection
-
    -

    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.

    -

    -

    get_asset_metrics

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

    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.

    -

    -

    get_exchange_metrics

    -
    def get_exchange_metrics(
-        exchanges: Union[List[str], str],
-        metrics: Union[List[str], str],
-        frequency: Optional[str] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[Union[PagingFrom, str]] = "start",
-        start_time: Optional[Union[datetime, date, str]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_height: Optional[int] = None,
-        end_height: Optional[int] = None,
-        start_inclusive: Optional[bool] = None,
-        end_inclusive: Optional[bool] = None,
-        timezone: Optional[str] = None,
-        sort: Optional[str] = None,
-        limit_per_exchange: Optional[int] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_exchange_asset_metrics

    -
    def get_exchange_asset_metrics(
-        exchange_assets: Union[List[str], str],
-        metrics: Union[List[str], str],
-        frequency: Optional[str] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[Union[PagingFrom, str]] = "start",
-        start_time: Optional[Union[datetime, date, str]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_height: Optional[int] = None,
-        end_height: Optional[int] = None,
-        start_inclusive: Optional[bool] = None,
-        end_inclusive: Optional[bool] = None,
-        timezone: Optional[str] = None,
-        sort: Optional[str] = None,
-        limit_per_exchange_asset: Optional[int] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_pair_metrics

    -
    def get_pair_metrics(pairs: Union[List[str], str],
-                     metrics: Union[List[str], str],
-                     frequency: Optional[str] = None,
-                     page_size: Optional[int] = None,
-                     paging_from: Optional[Union[PagingFrom, str]] = "start",
-                     start_time: Optional[Union[datetime, date, str]] = None,
-                     end_time: Optional[Union[datetime, date, str]] = None,
-                     start_height: Optional[int] = None,
-                     end_height: Optional[int] = None,
-                     start_inclusive: Optional[bool] = None,
-                     end_inclusive: Optional[bool] = None,
-                     timezone: Optional[str] = None,
-                     sort: Optional[str] = None,
-                     limit_per_pair: Optional[int] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_pair_candles

    -
    def get_pair_candles(pairs: Union[List[str], str],
-                     frequency: Optional[str] = None,
-                     page_size: Optional[int] = None,
-                     paging_from: Optional[Union[PagingFrom, str]] = "start",
-                     start_time: Optional[Union[datetime, date, str]] = None,
-                     end_time: Optional[Union[datetime, date, str]] = None,
-                     start_height: Optional[int] = None,
-                     end_height: Optional[int] = None,
-                     start_inclusive: Optional[bool] = None,
-                     end_inclusive: Optional[bool] = None,
-                     timezone: Optional[str] = None,
-                     limit_per_pair: Optional[int] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_institution_metrics

    -
    def get_institution_metrics(
-        institutions: Union[List[str], str],
-        metrics: Union[List[str], str],
-        frequency: Optional[str] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[Union[PagingFrom, str]] = "start",
-        start_time: Optional[Union[datetime, date, str]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_height: Optional[int] = None,
-        end_height: Optional[int] = None,
-        start_inclusive: Optional[bool] = None,
-        end_inclusive: Optional[bool] = None,
-        timezone: Optional[str] = None,
-        sort: Optional[str] = None,
-        limit_per_institution: Optional[int] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_index_candles

    -
    def get_index_candles(indexes: Union[List[str], str],
-                      frequency: Optional[str] = None,
-                      page_size: Optional[int] = None,
-                      paging_from: Optional[Union[PagingFrom, str]] = "start",
-                      start_time: Optional[Union[datetime, date, str]] = None,
-                      end_time: Optional[Union[datetime, date, str]] = None,
-                      start_inclusive: Optional[bool] = None,
-                      end_inclusive: Optional[bool] = None,
-                      timezone: Optional[str] = None,
-                      limit_per_index: Optional[int] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_index_levels

    -
    def get_index_levels(
-        indexes: Union[List[str], str],
-        frequency: Optional[str] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[Union[PagingFrom, str]] = "start",
-        start_time: Optional[Union[datetime, date, str]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_inclusive: Optional[bool] = None,
-        end_inclusive: Optional[bool] = None,
-        timezone: Optional[str] = None,
-        limit_per_index: Optional[int] = None,
-        include_verification: Optional[bool] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_index_constituents

    -
    def get_index_constituents(indexes: Union[List[str], str],
-                           frequency: Optional[str] = None,
-                           page_size: Optional[int] = None,
-                           paging_from: Optional[Union[PagingFrom,
-                                                       str]] = "start",
-                           start_time: Optional[Union[datetime, date,
-                                                      str]] = None,
-                           end_time: Optional[Union[datetime, date,
-                                                    str]] = None,
-                           start_inclusive: Optional[bool] = None,
-                           end_inclusive: Optional[bool] = None,
-                           timezone: Optional[str] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_market_metrics

    -
    def get_market_metrics(markets: Union[List[str], str],
-                       metrics: Union[List[str], str],
-                       frequency: Optional[str] = None,
-                       page_size: Optional[int] = None,
-                       paging_from: Optional[Union[PagingFrom, str]] = "start",
-                       start_time: Optional[Union[datetime, date, str]] = None,
-                       end_time: Optional[Union[datetime, date, str]] = None,
-                       start_inclusive: Optional[bool] = None,
-                       end_inclusive: Optional[bool] = None,
-                       timezone: Optional[str] = None,
-                       limit_per_market: Optional[int] = None,
-                       sort: Optional[str] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_market_candles

    -
    def get_market_candles(
-        markets: Union[List[str], str],
-        frequency: Optional[str] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[Union[PagingFrom, str]] = "start",
-        start_time: Optional[Union[datetime, date, str]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_inclusive: Optional[bool] = None,
-        end_inclusive: Optional[bool] = None,
-        timezone: Optional[str] = None,
-        limit_per_market: Optional[int] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_market_trades

    -
    def get_market_trades(
-        markets: Union[List[str], str],
-        page_size: Optional[int] = None,
-        paging_from: Optional[Union[PagingFrom, str]] = "start",
-        start_time: Optional[Union[datetime, date, str]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_inclusive: Optional[bool] = None,
-        end_inclusive: Optional[bool] = None,
-        timezone: Optional[str] = None,
-        limit_per_market: Optional[int] = None,
-        min_confirmations: Optional[int] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_market_open_interest

    -
    def get_market_open_interest(
-        markets: Union[List[str], str],
-        page_size: Optional[int] = None,
-        paging_from: Optional[Union[PagingFrom, str]] = "start",
-        start_time: Optional[Union[datetime, date, str]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_inclusive: Optional[bool] = None,
-        end_inclusive: Optional[bool] = None,
-        granularity: Optional[str] = None,
-        timezone: Optional[str] = None,
-        limit_per_market: Optional[int] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_market_liquidations

    -
    def get_market_liquidations(
-        markets: Union[List[str], str],
-        page_size: Optional[int] = None,
-        paging_from: Optional[Union[PagingFrom, str]] = "start",
-        start_time: Optional[Union[datetime, date, str]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_inclusive: Optional[bool] = None,
-        end_inclusive: Optional[bool] = None,
-        timezone: Optional[str] = None,
-        limit_per_market: Optional[int] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_market_funding_rates

    -
    def get_market_funding_rates(
-        markets: Union[List[str], str],
-        page_size: Optional[int] = None,
-        paging_from: Optional[Union[PagingFrom, str]] = "start",
-        start_time: Optional[Union[datetime, date, str]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_inclusive: Optional[bool] = None,
-        end_inclusive: Optional[bool] = None,
-        timezone: Optional[str] = None,
-        limit_per_market: Optional[int] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_predicted_market_funding_rates

    -
    def get_predicted_market_funding_rates(
-        markets: Union[List[str], str],
-        start_time: Optional[Union[datetime, date, str]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_inclusive: Optional[bool] = None,
-        end_inclusive: Optional[bool] = None,
-        timezone: Optional[str] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[Union[PagingFrom, str]] = "start",
-        limit_per_market: Optional[int] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_market_orderbooks

    -
    def get_market_orderbooks(
-        markets: Union[List[str], str],
-        granularity: Optional[str] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[Union[PagingFrom, str]] = "start",
-        start_time: Optional[Union[datetime, date, str]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_inclusive: Optional[bool] = None,
-        end_inclusive: Optional[bool] = None,
-        depth_limit: Optional[str] = "100",
-        timezone: Optional[str] = None,
-        limit_per_market: Optional[int] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_market_quotes

    -
    def get_market_quotes(
-        markets: Union[List[str], str],
-        granularity: Optional[str] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[Union[PagingFrom, str]] = "start",
-        start_time: Optional[Union[datetime, date, str]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_inclusive: Optional[bool] = None,
-        end_inclusive: Optional[bool] = None,
-        timezone: Optional[str] = None,
-        limit_per_market: Optional[int] = None,
-        include_one_sided: Optional[bool] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_market_contract_prices

    -
    def get_market_contract_prices(
-        markets: Union[List[str], str],
-        page_size: Optional[int] = None,
-        paging_from: Optional[Union[PagingFrom, str]] = "start",
-        start_time: Optional[Union[datetime, date, str]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_inclusive: Optional[bool] = None,
-        end_inclusive: Optional[bool] = None,
-        granularity: Optional[str] = None,
-        timezone: Optional[str] = None,
-        limit_per_market: Optional[int] = None,
-        frequency: Optional[str] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_market_implied_volatility

    -
    def get_market_implied_volatility(
-        markets: Union[List[str], str],
-        page_size: Optional[int] = None,
-        paging_from: Optional[Union[PagingFrom, str]] = "start",
-        start_time: Optional[Union[datetime, date, str]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_inclusive: Optional[bool] = None,
-        end_inclusive: Optional[bool] = None,
-        granularity: Optional[str] = None,
-        timezone: Optional[str] = None,
-        limit_per_market: Optional[int] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_market_greeks

    -
    def get_market_greeks(
-        markets: Union[List[str], str],
-        page_size: Optional[int] = None,
-        paging_from: Optional[Union[PagingFrom, str]] = "start",
-        start_time: Optional[Union[datetime, date, str]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_inclusive: Optional[bool] = None,
-        end_inclusive: Optional[bool] = None,
-        granularity: Optional[str] = None,
-        timezone: Optional[str] = None,
-        limit_per_market: Optional[int] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_mining_pool_tips_summary

    -
    def get_mining_pool_tips_summary(
-        assets: Union[List[str], str],
-        page_size: Optional[int] = None,
-        paging_from: Optional[Union[PagingFrom, str]] = "start",
-        start_time: Optional[Union[datetime, date, str]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_inclusive: Optional[bool] = None,
-        end_inclusive: Optional[bool] = None,
-        timezone: Optional[str] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_mempool_feerates

    -
    def get_mempool_feerates(assets: Union[List[str], str],
-                         page_size: Optional[int] = 200,
-                         paging_from: Optional[Union[PagingFrom,
-                                                     str]] = "start",
-                         start_time: Optional[Union[datetime, date,
-                                                    str]] = None,
-                         end_time: Optional[Union[datetime, date, str]] = None,
-                         start_inclusive: Optional[bool] = None,
-                         end_inclusive: Optional[bool] = None,
-                         timezone: Optional[str] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_stream_asset_metrics

    -
    def get_stream_asset_metrics(
-        assets: Union[List[str], str],
-        metrics: Union[List[str], str],
-        frequency: Optional[str] = None,
-        backfill: Union[Backfill, str] = Backfill.LATEST) -> CmStream
-
    -

    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.

    -

    -

    get_stream_market_trades

    -
    def get_stream_market_trades(
-        markets: Union[List[str], str],
-        backfill: Union[Backfill, str] = Backfill.LATEST) -> CmStream
-
    -

    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.

    -

    -

    get_stream_market_orderbooks

    -
    def get_stream_market_orderbooks(
-        markets: Union[List[str], str],
-        backfill: Union[Backfill, str] = Backfill.LATEST,
-        depth_limit: Optional[str] = None) -> CmStream
-
    -

    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.

    -

    -

    get_stream_market_quotes

    -
    def get_stream_market_quotes(
-        markets: Union[List[str], str],
-        backfill: Union[Backfill, str] = Backfill.LATEST,
-        include_one_sided: Optional[bool] = None) -> CmStream
-
    -

    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.

    -

    -

    get_stream_pair_quotes

    -
    def get_stream_pair_quotes(pairs: Union[str, List[str]],
-                           aggregation_method: Optional[str] = None,
-                           backfill: Optional[str] = None) -> CmStream
-
    -

    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:

    -

    -

    get_stream_asset_quotes

    -
    def get_stream_asset_quotes(assets: Union[str, List[str]],
-                            aggregation_method: Optional[str] = None,
-                            backfill: Optional[str] = None) -> CmStream
-
    -

    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:

    -

    -

    get_stream_market_candles

    -
    def get_stream_market_candles(
-        markets: Union[List[str], str],
-        frequency: Optional[str] = None,
-        backfill: Union[Backfill, str] = Backfill.LATEST) -> CmStream
-
    -

    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.

    -

    -

    get_stream_index_levels

    -
    def get_stream_index_levels(
-        indexes: Union[List[str], str],
-        include_verification: Optional[bool] = None,
-        backfill: Union[Backfill, str] = Backfill.LATEST) -> CmStream
-
    -

    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.

    -

    -

    get_stream_market_liquidations

    -
    def get_stream_market_liquidations(markets: Union[str, List[str]],
-                                   backfill: Optional[str] = None) -> CmStream
-
    -

    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

    -

    -

    get_stream_market_open_interest

    -
    def get_stream_market_open_interest(
-        markets: Union[str, List[str]],
-        backfill: Optional[str] = None) -> CmStream
-
    -

    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:

    -

    -

    get_list_of_blocks_v2

    -
    def get_list_of_blocks_v2(asset: str,
-                          block_hashes: Optional[Union[List[str], str]] = None,
-                          heights: Optional[Union[List[str], str]] = None,
-                          page_size: Optional[int] = None,
-                          paging_from: Optional[Union[PagingFrom,
-                                                      str]] = "start",
-                          start_time: Optional[Union[datetime, date,
-                                                     str]] = None,
-                          end_time: Optional[Union[datetime, date,
-                                                   str]] = None,
-                          start_height: Optional[int] = None,
-                          end_height: Optional[int] = None,
-                          chain: Optional[bool] = None,
-                          start_inclusive: Optional[bool] = None,
-                          end_inclusive: Optional[bool] = None,
-                          timezone: Optional[str] = None) -> DataCollection
-
    -

    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

    -

    -

    get_list_of_accounts_v2

    -
    def get_list_of_accounts_v2(asset: str,
-                            accounts: Optional[Union[List[str], str]] = None,
-                            page_size: Optional[int] = None,
-                            paging_from: Optional[Union[PagingFrom,
-                                                        str]] = "start",
-                            start_time: Optional[Union[datetime, date,
-                                                       str]] = None,
-                            end_time: Optional[Union[datetime, date,
-                                                     str]] = None,
-                            start_height: Optional[int] = None,
-                            end_height: Optional[int] = None,
-                            start_chain_sequence_number: Optional[int] = None,
-                            end_chain_sequence_number: Optional[int] = None,
-                            start_inclusive: Optional[bool] = None,
-                            end_inclusive: Optional[bool] = None,
-                            timezone: Optional[str] = None) -> DataCollection
-
    -

    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

    -

    -

    get_list_of_sub_accounts_v2

    -
    def get_list_of_sub_accounts_v2(
-        asset: str,
-        accounts: Optional[Union[List[str], str]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[Union[PagingFrom, str]] = "start",
-        start_time: Optional[Union[datetime, date, str]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_height: Optional[int] = None,
-        end_height: Optional[int] = None,
-        start_chain_sequence_number: Optional[int] = None,
-        end_chain_sequence_number: Optional[int] = None,
-        start_inclusive: Optional[bool] = None,
-        end_inclusive: Optional[bool] = None,
-        timezone: Optional[str] = None) -> DataCollection
-
    -

    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

    -

    -

    get_list_of_transactions_v2

    -
    def get_list_of_transactions_v2(
-        asset: str,
-        txids: Optional[Union[List[str], str]] = None,
-        block_hashes: Optional[Union[List[str], str]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[Union[PagingFrom, str]] = "start",
-        start_time: Optional[Union[datetime, date, str]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_height: Optional[int] = None,
-        end_height: Optional[int] = None,
-        chain: Optional[str] = None,
-        start_inclusive: Optional[bool] = None,
-        end_inclusive: Optional[bool] = None,
-        timezone: Optional[str] = None) -> DataCollection
-
    -

    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

    -

    -

    get_list_of_balance_updates_v2

    -
    def get_list_of_balance_updates_v2(
-        asset: str,
-        accounts: Optional[Union[List[str], str]] = None,
-        sub_accounts: Optional[Union[List[str], str]] = None,
-        limit_per_account: Optional[int] = None,
-        txids: Optional[Union[List[str], str]] = None,
-        block_hashes: Optional[Union[List[str], str]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[Union[PagingFrom, str]] = "start",
-        start_time: Optional[Union[datetime, date, str]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_height: Optional[int] = None,
-        end_height: Optional[int] = None,
-        start_chain_sequence_number: Optional[int] = None,
-        end_chain_sequence_number: Optional[int] = None,
-        include_sub_accounts: Optional[bool] = None,
-        chain: Optional[str] = None,
-        start_inclusive: Optional[bool] = None,
-        end_inclusive: Optional[bool] = None,
-        timezone: Optional[str] = None) -> DataCollection
-
    -

    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

    -

    -

    get_full_block_v2

    -
    def get_full_block_v2(
-        asset: str, block_hash: str,
-        include_sub_accounts: Optional[bool]) -> List[Dict[str, Any]]
-
    -

    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

    -

    -

    get_full_transaction_v2

    -
    def get_full_transaction_v2(
-        asset: str, txid: str,
-        include_sub_accounts: Optional[bool]) -> List[Dict[str, Any]]
-
    -

    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

    -

    -

    get_full_transaction_for_block_v2

    -
    def get_full_transaction_for_block_v2(
-        asset: str, block_hash: str, txid: str,
-        include_sub_accounts: Optional[bool]) -> List[Dict[str, Any]]
-
    -

    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

    -

    -

    get_list_of_balance_updates_for_account_v2

    -
    def get_list_of_balance_updates_for_account_v2(
-        asset: str,
-        account: str,
-        txids: Optional[Union[str, List[str]]] = None,
-        block_hashes: Optional[Union[str, List[str]]] = None,
-        include_counterparties: Optional[bool] = None,
-        start_time: Optional[Union[datetime, date, str]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_height: Optional[int] = None,
-        end_height: Optional[int] = None,
-        start_chain_sequence_number: Optional[int] = None,
-        end_chain_sequence_number: Optional[int] = None,
-        include_sub_accounts: Optional[bool] = None,
-        chain: Optional[str] = None,
-        start_inclusive: Optional[bool] = None,
-        end_inclusive: Optional[bool] = None,
-        timezone: Optional[str] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_transaction_tracker

    -
    def get_transaction_tracker(
-    asset: str,
-    addresses: Optional[Union[List[str], str]] = None,
-    txids: Optional[Union[List[str], str]] = None,
-    replacements_for_txids: Optional[Union[List[str], str]] = None,
-    replacements_only: Optional[bool] = None,
-    page_size: Optional[int] = None,
-    paging_from: Optional[Union[PagingFrom, str]] = "start",
-    start_time: Optional[Union[datetime, date, str]] = None,
-    end_time: Optional[Union[datetime, date, str]] = None,
-    start_inclusive: Optional[bool] = None,
-    end_inclusive: Optional[bool] = None,
-    timezone: Optional[str] = None,
-    unconfirmed_only: Optional[bool] = None
-) -> TransactionTrackerDataCollection
-
    -

    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.

    -

    -

    get_taxonomy_assets

    -
    def get_taxonomy_assets(assets: Optional[List[str]] = None,
-                        class_ids: Optional[List[str]] = None,
-                        sector_ids: Optional[List[str]] = None,
-                        subsector_ids: Optional[List[str]] = None,
-                        classification_start_time: Optional[str] = None,
-                        classification_end_time: Optional[str] = None,
-                        end_inclusive: Optional[bool] = None,
-                        start_inclusive: Optional[bool] = None,
-                        page_size: Optional[int] = None,
-                        paging_from: Optional[str] = None,
-                        version: Optional[str] = None) -> DataCollection
-
    -

    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

    -

    -

    get_taxonomy_assets_metadata

    -
    def get_taxonomy_assets_metadata(
-        start_time: Optional[Union[datetime, date, str]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_inclusive: Optional[bool] = None,
-        end_inclusive: Optional[bool] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        version: Optional[str] = None) -> DataCollection
-
    -

    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

    -

    -

    get_asset_profiles

    -
    def get_asset_profiles(assets: Optional[Union[List[str], str]] = None,
-                       full_names: Optional[Union[List[str], str]] = None,
-                       page_size: Optional[int] = None,
-                       paging_from: Optional[str] = None) -> DataCollection
-
    -

    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"
      • -
    -

    -

    reference_data_asset_metrics

    -
    def reference_data_asset_metrics(
-        metrics: Optional[Union[str, List[str]]] = None,
-        reviewable: Optional[bool] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    DataCollection: List of asset metrics metadata.

    -

    -

    reference_data_markets

    -
    def reference_data_markets(
-        markets: Optional[Union[str, List[str]]] = None,
-        exchange: Optional[str] = None,
-        type: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        asset: Optional[str] = None,
-        symbol: Optional[str] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    DataCollection: List of markets metadata.

    -

    -

    reference_data_exchange_metrics

    -
    def reference_data_exchange_metrics(
-        metrics: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    DataCollection: List of exchange metrics metadata.

    -

    -

    reference_data_exchange_asset_metrics

    -
    def reference_data_exchange_asset_metrics(
-        metrics: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    DataCollection: List of exchange asset metrics metadata.

    -

    -

    reference_data_pair_metrics

    -
    def reference_data_pair_metrics(
-        metrics: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    DataCollection: List of pair metrics metadata.

    -

    -

    reference_data_institution_metrics

    -
    def reference_data_institution_metrics(
-        metrics: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    DataCollection: List of institution metrics metadata.

    -

    -

    reference_data_assets

    -
    def reference_data_assets(
-        assets: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    DataCollection: List of assets metadata.

    -

    -

    reference_data_exchanges

    -
    def reference_data_exchanges(
-        exchanges: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    DataCollection: List of exchanges metadata.

    -

    -

    reference_data_indexes

    -
    def reference_data_indexes(
-        indexes: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    DataCollection: List of indexes metadata.

    -

    -

    reference_data_pairs

    -
    def reference_data_pairs(
-        pairs: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    DataCollection: List of pairs metadata.

    -

    -

    reference_data_market_metrics

    -
    def reference_data_market_metrics(
-        metrics: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None,
-        format: Optional[str] = "json_stream") -> DataCollection
-
    -

    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.
      • -
    • format (Optional[str]): Default: "json_stream" (Python API Client). Format of the response. Supported values are json, json_stream. Setting format='json_stream' is generally more performant. page_size is ignored when format='json_stream'.
      • -
    -

    Returns:

    -

    DataCollection: List of market metrics metadata.

    -

    -

    security_master_assets

    -
    def security_master_assets(
-        assets: Optional[Union[str, List[str]]] = None,
-        codes: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> DataCollection
-
    -

    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

    -

    -

    security_master_markets

    -
    def security_master_markets(
-        type: Optional[str] = None,
-        markets: Optional[Union[str, List[str]]] = None,
-        symbol: Optional[str] = None,
-        exchange: Optional[str] = None,
-        base: Optional[str] = None,
-        quote: Optional[str] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None,
-        next_page_token: Optional[str] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_snapshots_of_asset_metric_constituents

    -
    def get_snapshots_of_asset_metric_constituents(
-        metric: str,
-        at_time: Optional[str] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_time: Optional[Union[datetime, date, str]] = None,
-        next_page_token: Optional[str] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None) -> DataCollection
-
    -

    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.

    -

    -

    get_timeframes_of_asset_metric_constituents

    -
    def get_timeframes_of_asset_metric_constituents(
-        metric: str,
-        constituents: Optional[Union[str, List[str]]] = None,
-        end_time: Optional[Union[datetime, date, str]] = None,
-        start_time: Optional[Union[datetime, date, str]] = None,
-        next_page_token: Optional[str] = None,
-        page_size: Optional[int] = None,
-        paging_from: Optional[str] = None) -> DataCollection
-
    -

    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.

    -

    -

    blockchain_metadata_tags

    -
    def blockchain_metadata_tags(
-        type: Optional[str] = None,
-        page_size: Optional[int] = None,
-        next_page_token: Optional[str] = None) -> DataCollection
-
    -

    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.

    -

    -

    blockchain_metadata_tagged_entities

    -
    def blockchain_metadata_tagged_entities(
-        tags: Optional[Union[str, List[str]]] = None,
-        entities: Optional[Union[str, List[str]]] = None,
-        locations: Optional[Union[str, List[str]]] = None,
-        page_size: Optional[int] = None,
-        next_page_token: Optional[str] = None) -> DataCollection
-
    -

    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.

    - -
    -
    - -
    -
    - -
    - -
    - -
    - - - - « Previous - - - Next » - - -
    - - - - - - - - - diff --git a/docs/site/releases/CHANGELOG.html b/docs/site/releases/CHANGELOG.html index d44a9a9..b9db0ab 100644 --- a/docs/site/releases/CHANGELOG.html +++ b/docs/site/releases/CHANGELOG.html @@ -808,6 +808,39 @@ + + +
  • + + + Changed + + + +
    • + + + + + + +
  • + + + 2024.12.16.21 + + + +