openapi: 3.0.2
info:
  title: Coin Metrics API v4 Blockchain Explorer Job Timeseries API
  description: '[Coin Metrics Homepage](https://coinmetrics.io/)<br/> [API Backward Compatibility Policy](https://docs.coinmetrics.io/access-our-data/api#backward-compatibility)<br/> [Python API Client](https://coinmetrics.github.io/api-client-python/site/index.html)<br/><br/>

    HTTP API root endpoint URL is `https://api.coinmetrics.io/v4`. Coin Metrics&apos; paid product.<br/> WebSocket API root endpoint is `wss://api.coinmetrics.io/v4`. Coin Metrics&apos; paid product.<br/><br/> The Community HTTP API root endpoint URL is `https://community-api.coinmetrics.io/v4`. API key is not required when accessing community endpoints. Available to the community under the [Creative Commons](https://creativecommons.org/licenses/by-nc/4.0/) license.

    # Authentication

    <!-- ReDoc-Inject: <security-definitions> -->

    # Response headers

    Note that Coin Metrics API responses have a `CF-RAY` HTTP header e.g. `88a6ec1d2f930774-IAD` which can be used for diagnostic purposes. When raising Support requests, please ensure to provide the value of this header. '
  termsOfService: https://coinmetrics.io/api/terms
  contact:
    name: Coin Metrics Support
    url: https://coinmetrics.io/support/
    email: support@coinmetrics.io
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 4.0.0
servers:
- url: https://api.coinmetrics.io/v4
- url: wss://api.coinmetrics.io/v4
- url: https://community-api.coinmetrics.io/v4
tags:
- name: Timeseries
  description: Endpoints for fetching metrics, market data, indexes and other time series data.
paths:
  /timeseries/asset-metrics:
    servers:
    - url: https://api.coinmetrics.io/v4
    - url: https://community-api.coinmetrics.io/v4
    get:
      summary: Asset metrics
      description: "Returns requested metrics for specified assets.<br/><br/> Results for block by block metrics (`1b` frequency) are ordered by tuple `(asset, height, block_hash)`, all other metrics are ordered by tuple `(asset, time)`. You can change the sorting using `sort` query parameter.<br/><br/> Supported output formats are `json` (default), `json_stream` and `csv`. Use the `format` query parameter to override it.<br/> To fetch the next page of results use `next_page_url` JSON response field or `x-next-page-url` CSV HTTP header if present.<br/><br/> If multiple metrics are requested in the same time the strict policy for partially available metrics among requested ones is applied: <ul>\n  <li>missing metric name in the JSON response means that the metric is \"not a supported metric\" for the asset and frequency while some other requested metrics are supported.</li>\n  <li>`null` value of the metric means \"no data in the database\" while some other requested metrics have data.</li>\n</ul>"
      operationId: getTimeseriesAssetMetrics
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/asset-metrics?assets=btc&metrics=PriceUSD,SplyBMXNtv&start_time=2020-02-29&end_time=2020-03-01&frequency=1d&pretty=true&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/asset-metrics?assets=btc&metrics=PriceUSD,SplyBMXNtv&start_time=2020-02-29&end_time=2020-03-01&frequency=1d&pretty=true&api_key=<your_key>'').json()

          print(response)

          '
      - label: Python Client
        source: 'from coinmetrics.api_client import CoinMetricsClient

          client = CoinMetricsClient(<your_key>)


          response = client.get_asset_metrics(assets="btc", metrics="PriceUSD,SplyBMXNtv", start_time="2020-02-29", end_time="2020-03-01", frequency="1d").to_list()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/AssetMetricsAssetId'
      - $ref: '#/components/parameters/AssetMetrics'
      - $ref: '#/components/parameters/AssetMetricsFrequency'
      - $ref: '#/components/parameters/Status'
      - $ref: '#/components/parameters/StartTimeMutuallyExclusiveWithHeightAndHash'
      - $ref: '#/components/parameters/EndTimeMutuallyExclusiveWithHeightAndHash'
      - $ref: '#/components/parameters/StartHeightMutuallyExclusiveWithTimeAndHash'
      - $ref: '#/components/parameters/EndHeightMutuallyExclusiveWithTimeAndHash'
      - $ref: '#/components/parameters/StartHash'
      - $ref: '#/components/parameters/EndHash'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/MinConfirmations'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/LimitPerAsset'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/ResponseFormat'
      - $ref: '#/components/parameters/NullAsZero'
      - $ref: '#/components/parameters/NextPageToken'
      - $ref: '#/components/parameters/IgnoreUnsupportedErrors'
      - $ref: '#/components/parameters/IgnoreForbiddenErrors'
      responses:
        '200':
          $ref: '#/components/responses/AssetMetrics'
        '400':
          $ref: '#/components/responses/AssetNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/exchange-metrics:
    servers:
    - url: https://api.coinmetrics.io/v4
    - url: https://community-api.coinmetrics.io/v4
    get:
      summary: Exchange metrics
      description: Returns metrics for specified exchanges.<br/> Results are ordered by tuple `(exchange, time)`.<br/> To fetch the next page of results use `next_page_url` JSON response field.<br/>
      operationId: getTimeseriesExchangeMetrics
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/exchange-metrics?exchanges=binance&metrics=volume_reported_spot_usd_1d&start_time=2020-01-01&end_time=2020-01-04&paging_from=start&frequency=1d&pretty=true&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/exchange-metrics?exchanges=binance&metrics=volume_reported_spot_usd_1d&start_time=2020-01-01&end_time=2020-01-04&paging_from=start&frequency=1d&pretty=true&api_key=<your_key>'').json()

          print(response)

          '
      - label: Python Client
        source: 'from coinmetrics.api_client import CoinMetricsClient

          client = CoinMetricsClient(<your_key>)


          response = client.get_exchange_metrics(exchanges="binance", metrics="volume_reported_spot_usd_1d", start_time="2020-01-01", end_time="2020-01-04", paging_from="start", frequency="1d").to_list()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/Exchanges'
      - $ref: '#/components/parameters/ExchangeMetricsParam'
      - $ref: '#/components/parameters/ExchangeMetricsFrequency'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/ExchangeSort'
      - $ref: '#/components/parameters/LimitPerExchange'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/Format'
      - $ref: '#/components/parameters/NextPageToken'
      responses:
        '200':
          $ref: '#/components/responses/ExchangeMetrics'
        '400':
          $ref: '#/components/responses/ExchangeNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/exchange-asset-metrics:
    servers:
    - url: https://api.coinmetrics.io/v4
    - url: https://community-api.coinmetrics.io/v4
    get:
      summary: Exchange-asset metrics
      description: Returns metrics for specified exchange-asset.<br/> Results are ordered by tuple `(exchange_asset, time)`.<br/> To fetch the next page of results use `next_page_url` JSON response field.<br/>
      operationId: getTimeseriesExchangeAssetMetrics
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/exchange-asset-metrics?exchange_assets=binance-btc&metrics=volume_reported_spot_usd_1d&start_time=2021-10-04&end_time=2020-10-07&paging_from=start&frequency=1d&pretty=true&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/exchange-asset-metrics?exchange_assets=binance-btc&metrics=volume_reported_spot_usd_1d&start_time=2021-10-04&end_time=2020-10-07&paging_from=start&frequency=1d&pretty=true&api_key=<your_key>'').json()

          print(response)

          '
      - label: Python Client
        source: 'from coinmetrics.api_client import CoinMetricsClient

          client = CoinMetricsClient(<your_key>)


          response = client.get_exchange_asset_metrics(exchange_assets="binance-btc", metrics="volume_reported_spot_usd_1d", start_time="2021-10-04", end_time="2020-10-07", paging_from="start", frequency="1d").to_list()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/ExchangeAssets'
      - $ref: '#/components/parameters/ExchangeAssetMetricsParam'
      - $ref: '#/components/parameters/ExchangeAssetMetricsFrequency'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/ExchangeAssetSort'
      - $ref: '#/components/parameters/LimitPerExchangeAsset'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/ResponseFormat'
      - $ref: '#/components/parameters/NextPageToken'
      responses:
        '200':
          $ref: '#/components/responses/ExchangeAssetMetrics'
        '400':
          $ref: '#/components/responses/ExchangeAssetNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/exchange-pair-metrics:
    servers:
    - url: https://api.coinmetrics.io/v4
    - url: https://community-api.coinmetrics.io/v4
    get:
      summary: Exchange-pair metrics
      description: Returns metrics for specified exchange-pair.<br/> Results are ordered by tuple `(exchange_pair, time)`.<br/> To fetch the next page of results use `next_page_url` JSON response field.<br/>
      operationId: getTimeseriesExchangePairMetrics
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/exchange-pair-metrics?exchange_pairs=binance-btc-usdt&metrics=volatility_implied_skew_delta_50_270d_expiration&start_time=2025-10-04&end_time=2025-10-07&paging_from=start&frequency=1d&pretty=true&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/exchange-pair-metrics?exchange_pairs=binance-btc-usdt&metrics=volatility_implied_skew_delta_50_270d_expiration&start_time=2025-10-04&end_time=2025-10-07&paging_from=start&frequency=1d&pretty=true&api_key=<your_key>'').json()

          print(response)

          '
      - label: Python Client
        source: 'from coinmetrics.api_client import CoinMetricsClient

          client = CoinMetricsClient(<your_key>)


          response = client.get_exchange_pair_metrics(exchange_pairs="binance-btc-usdt", metrics="volatility_implied_skew_delta_50_270d_expiration", start_time="2025-10-04", end_time="2025-10-07", paging_from="start", frequency="1d").to_list()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/ExchangePairs'
      - $ref: '#/components/parameters/ExchangePairMetricsParam'
      - $ref: '#/components/parameters/ExchangePairMetricsFrequency'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/LimitPerExchangePair'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/ResponseFormat'
      - $ref: '#/components/parameters/NextPageToken'
      responses:
        '200':
          $ref: '#/components/responses/ExchangePairMetrics'
        '400':
          $ref: '#/components/responses/ExchangePairNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/market-metrics:
    servers:
    - url: https://api.coinmetrics.io/v4
    - url: https://community-api.coinmetrics.io/v4
    get:
      summary: Market metrics
      description: Returns metrics for specified markets.<br/> Results are ordered by tuple `(market, time)`.<br/> To fetch the next page of results use `next_page_url` JSON response field.<br/>
      operationId: getTimeseriesMarketMetrics
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/market-metrics?markets=binance-BTCUSDT-future&metrics=liquidations_reported_future_buy_usd_5m&start_time=2022-01-19T20:00:00Z&end_time=2022-01-19T21:00:00Z&paging_from=start&frequency=5m&pretty=true&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/market-metrics?markets=binance-BTCUSDT-future&metrics=liquidations_reported_future_buy_usd_5m&start_time=2022-01-19T20:00:00Z&end_time=2022-01-19T21:00:00Z&paging_from=start&frequency=5m&pretty=true&api_key=<your_key>'').json()

          print(response)

          '
      - label: Python Client
        source: 'from coinmetrics.api_client import CoinMetricsClient

          client = CoinMetricsClient(<your_key>)


          response = client.get_market_metrics(markets="binance-BTCUSDT-future", metrics="liquidations_reported_future_buy_usd_5m", start_time="2022-01-19T20:00:00Z", end_time="2022-01-19T21:00:00Z", paging_from="start", frequency="5m").to_list()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/MarketId'
      - $ref: '#/components/parameters/MarketMetricsParam'
      - $ref: '#/components/parameters/MarketMetricsFrequency'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/MarketMetricsSort'
      - $ref: '#/components/parameters/LimitPerMarket'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/ResponseFormat'
      - $ref: '#/components/parameters/NextPageToken'
      - $ref: '#/components/parameters/IgnoreUnsupportedErrors'
      - $ref: '#/components/parameters/IgnoreForbiddenErrors'
      responses:
        '200':
          $ref: '#/components/responses/MarketMetrics'
        '400':
          $ref: '#/components/responses/MarketNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/pair-metrics:
    servers:
    - url: https://api.coinmetrics.io/v4
    - url: https://community-api.coinmetrics.io/v4
    get:
      summary: Pair metrics
      description: Returns metrics for specified asset pairs.<br/> Results are ordered by tuple `(pair, time)`.<br/> To fetch the next page of results use `next_page_url` JSON response field.<br/>
      operationId: getTimeseriesPairMetrics
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/pair-metrics?pairs=btc-usd&metrics=volume_trusted_spot_usd_1d&frequency=1d&pretty=true&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/pair-metrics?pairs=btc-usd&metrics=volume_trusted_spot_usd_1d&frequency=1d&pretty=true&api_key=<your_key>'').json()

          print(response)

          '
      - label: Python Client
        source: 'from coinmetrics.api_client import CoinMetricsClient

          client = CoinMetricsClient(<your_key>)


          response = client.get_pair_metrics(pairs="btc-usd", metrics="volume_trusted_spot_usd_1d", frequency="1d").to_list()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/Pair'
      - $ref: '#/components/parameters/PairMetricsParam'
      - $ref: '#/components/parameters/PairMetricsFrequency'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/PairSort'
      - $ref: '#/components/parameters/LimitPerPair'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/Format'
      - $ref: '#/components/parameters/NextPageToken'
      responses:
        '200':
          $ref: '#/components/responses/PairMetrics'
        '400':
          $ref: '#/components/responses/PairNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/pair-candles:
    servers:
    - url: https://api.coinmetrics.io/v4
    - url: https://community-api.coinmetrics.io/v4
    get:
      summary: Pair candles
      description: Returns candles for specified asset pairs.<br/> Results are ordered by tuple `(pair, time)`.<br/> To fetch the next page of results use `next_page_url` JSON response field.<br/>
      operationId: getTimeseriesPairCandles
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/pair-candles?pairs=btc-usd&frequency=1d&pretty=true&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/pair-candles?pairs=btc-usd&frequency=1d&pretty=true&api_key=<your_key>'').json()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/PairWithCandle'
      - $ref: '#/components/parameters/CandleFrequency'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/LimitPerPairCandle'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/Format'
      - $ref: '#/components/parameters/NextPageToken'
      responses:
        '200':
          $ref: '#/components/responses/PairCandles'
        '400':
          $ref: '#/components/responses/PairNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/protocol-metrics:
    servers:
    - url: https://api.coinmetrics.io/v4
    get:
      summary: Protocol metrics
      description: Returns metrics for specified protocols.<br/> Results are ordered by tuple `(protocol, market)`.<br/> To fetch the next page of results use `next_page_url` JSON response field.<br/>
      operationId: getTimeseriesProtocolMetrics
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/protocol-metrics?protocols=aave_v3&markets=core-weth&chains=ethereum&metrics=supply_apy&pretty=true&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/protocol-metrics?protocols=aave_v3&markets=core-weth&chains=ethereum&metrics=supply_apy&pretty=true&api_key=<your_key>'').json()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/Protocols'
      - $ref: '#/components/parameters/ProtocolChains'
      - $ref: '#/components/parameters/ProtocolMarkets'
      - $ref: '#/components/parameters/ProtocolFrequency'
      - $ref: '#/components/parameters/ProtocolMetrics'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFromWithStartByDefault'
      - $ref: '#/components/parameters/NextPageToken'
      - $ref: '#/components/parameters/CatalogResponseFormat'
      - $ref: '#/components/parameters/Pretty'
      responses:
        '200':
          $ref: '#/components/responses/ProtocolMetricsResponse'
        '400':
          $ref: '#/components/responses/ProtocolNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/institution-metrics:
    servers:
    - url: https://api.coinmetrics.io/v4
    - url: https://community-api.coinmetrics.io/v4
    get:
      summary: Institution metrics
      description: Returns metrics for specified institutions.<br/> Results are ordered by tuple `(institution, time)`.<br/> To fetch the next page of results use `next_page_url` JSON response field.<br/>
      operationId: getTimeseriesInstitutionMetrics
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/institution-metrics?institutions=grayscale&metrics=btc_total_assets&frequency=1d&pretty=true&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/institution-metrics?institutions=grayscale&metrics=btc_total_assets&frequency=1d&pretty=true&api_key=<your_key>'').json()

          print(response)

          '
      - label: Python Client
        source: 'from coinmetrics.api_client import CoinMetricsClient

          client = CoinMetricsClient(<your_key>)


          response = client.get_institution_metrics(institutions="grayscale", metrics="btc_total_assets", frequency="1d").to_list()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/Institution'
      - $ref: '#/components/parameters/InstitutionMetricsParam'
      - $ref: '#/components/parameters/InstitutionMetricsFrequency'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/InstitutionSort'
      - $ref: '#/components/parameters/LimitPerInstitution'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/Format'
      - $ref: '#/components/parameters/NextPageToken'
      responses:
        '200':
          $ref: '#/components/responses/InstitutionMetrics'
        '400':
          $ref: '#/components/responses/MarketNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/market-trades:
    servers:
    - url: https://api.coinmetrics.io/v4
    - url: https://community-api.coinmetrics.io/v4
    get:
      summary: Market trades
      description: Returns trades for specified markets.<br/> Results are ordered by tuple `(market, time, coin_metrics_id)`.<br/> To fetch the next page of results use `next_page_url` JSON response field.
      operationId: getTimeseriesMarketTrades
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/market-trades?start_time=2015-01-08T20:55:00Z&end_time=2015-01-08T21:00:00Z&paging_from=start&markets=coinbase-btc-usd-spot&pretty=true&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/market-trades?start_time=2015-01-08T20:55:00Z&end_time=2015-01-08T21:00:00Z&paging_from=start&markets=coinbase-btc-usd-spot&pretty=true&api_key=<your_key>'').json()

          print(response)

          '
      - label: Python Client
        source: 'from coinmetrics.api_client import CoinMetricsClient

          client = CoinMetricsClient(<your_key>)


          response = client.get_market_trades(start_time="2015-01-08T20:55:00Z", end_time="2015-01-08T21:00:00Z", paging_from="start", markets="coinbase-btc-usd-spot").to_list()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/MarketId'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/LimitPerMarket'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/ResponseFormat'
      - $ref: '#/components/parameters/NextPageToken'
      - $ref: '#/components/parameters/TradeMinConfirmations'
      responses:
        '200':
          $ref: '#/components/responses/MarketTrades'
        '400':
          $ref: '#/components/responses/MarketNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/market-openinterest:
    servers:
    - url: https://api.coinmetrics.io/v4
    - url: https://community-api.coinmetrics.io/v4
    get:
      summary: Market open interest
      description: Returns open interest for specified futures markets.<br/> Results are ordered by tuple `(market, time)`.<br/> To fetch the next page of results use `next_page_url` JSON response field. Keep in mind that spot markets are not supported by this endpoint.<br/><br/> <b>Note:</b> The `value_usd` field in this endpoint was previously calculated using hardcoded logic that no longer reflects current contract specifications across all exchanges.<br/><br/> To address this, we have deprecated the `value_usd` field and introduced new, more accurate metrics available via the `/timeseries/market-metrics` endpoint.<br/><br/> These two metrics should be used as a replacement for the `value_usd` field going forward:<br/> - `open_interest_reported_future_usd` to represent the notional value of open interest in U.S. dollars for futures markets<br/> - `open_interest_reported_option_notional_usd` to represent the notional value of open interest in U.S. dollars for options markets<br/><br/> We also introduced `open_interest_reported_option_market_value_usd` to represent the market value of open interest in U.S. dollars for options markets.
      operationId: getTimeseriesMarketOpenIntereset
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/market-openinterest?start_time=2020-08-05T23:00:00Z&end_time=2020-08-06T00:00:00Z&paging_from=start&markets=bitmex-XBTUSD-future&pretty=true&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/market-openinterest?start_time=2020-08-05T23:00:00Z&end_time=2020-08-06T00:00:00Z&paging_from=start&markets=bitmex-XBTUSD-future&pretty=true&api_key=<your_key>'').json()

          print(response)

          '
      - label: Python Client
        source: 'from coinmetrics.api_client import CoinMetricsClient

          client = CoinMetricsClient(<your_key>)


          response = client.get_market_openinterest(start_time="2020-08-05T23:00:00Z", end_time="2020-08-06T00:00:00Z", paging_from="start", markets="bitmex-XBTUSD-future").to_list()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/MarketId'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/OpenInterestGranularity'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/LimitPerMarket'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/ResponseFormat'
      - $ref: '#/components/parameters/NextPageToken'
      responses:
        '200':
          $ref: '#/components/responses/MarketOpenInterest'
        '400':
          $ref: '#/components/responses/MarketNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/market-liquidations:
    servers:
    - url: https://api.coinmetrics.io/v4
    - url: https://community-api.coinmetrics.io/v4
    get:
      summary: Market liquidations
      description: Returns liquidations for specified futures markets.<br/> Results are ordered by tuple `(market, time)`.<br/> To fetch the next page of results use `next_page_url` JSON response field. Keep in mind that spot markets are not supported by this endpoint.
      operationId: getTimeseriesMarketLiquidations
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/market-liquidations?start_time=2020-10-10T15:00:00Z&end_time=2020-10-10T16:00:00Z&paging_from=start&markets=bitmex-XBTUSD-future&pretty=true&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/market-liquidations?start_time=2020-10-10T15:00:00Z&end_time=2020-10-10T16:00:00Z&paging_from=start&markets=bitmex-XBTUSD-future&pretty=true&api_key=<your_key>'').json()

          print(response)

          '
      - label: Python Client
        source: 'from coinmetrics.api_client import CoinMetricsClient

          client = CoinMetricsClient(<your_key>)


          response = client.get_market_liquidations(start_time="2020-10-10T15:00:00Z", end_time="2020-10-10T16:00:00Z", paging_from="start", markets="bitmex-XBTUSD-future").to_list()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/MarketId'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/LimitPerMarket'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/ResponseFormat'
      - $ref: '#/components/parameters/NextPageToken'
      responses:
        '200':
          $ref: '#/components/responses/MarketLiquidations'
        '400':
          $ref: '#/components/responses/MarketNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/market-funding-rates:
    servers:
    - url: https://api.coinmetrics.io/v4
    - url: https://community-api.coinmetrics.io/v4
    get:
      summary: Market funding rates
      description: Returns funding rates for specified futures markets.<br/> Results are ordered by tuple `(market, time)`.<br/> To fetch the next page of results use `next_page_url` JSON response field. Keep in mind that spot markets are not supported by this endpoint.
      operationId: getTimeseriesMarketFundingRates
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/market-funding-rates?start_time=2020-11-11T18:00:00Z&end_time=2020-11-11T19:00:00Z&paging_from=start&markets=bitmex-XBTUSD-future&pretty=true&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/market-funding-rates?start_time=2020-11-11T18:00:00Z&end_time=2020-11-11T19:00:00Z&paging_from=start&markets=bitmex-XBTUSD-future&pretty=true&api_key=<your_key>'').json()

          print(response)

          '
      - label: Python Client
        source: 'from coinmetrics.api_client import CoinMetricsClient

          client = CoinMetricsClient(<your_key>)


          response = client.get_market_funding_rates(start_time="2020-11-11T18:00:00Z", end_time="2020-11-11T19:00:00Z", paging_from="start", markets="bitmex-XBTUSD-future").to_list()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/MarketId'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/LimitPerMarket'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/ResponseFormat'
      - $ref: '#/components/parameters/NextPageToken'
      responses:
        '200':
          $ref: '#/components/responses/MarketFundingRates'
        '400':
          $ref: '#/components/responses/MarketNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/market-funding-rates-predicted:
    servers:
    - url: https://api.coinmetrics.io/v4
    - url: https://community-api.coinmetrics.io/v4
    get:
      summary: Predicted Market funding rates
      description: Returns predicted funding rates for specified futures markets.<br/> Results are ordered by tuple `(market, time)`.<br/> To fetch the next page of results use `next_page_url` JSON response field. Keep in mind that spot markets are not supported by this endpoint.
      operationId: getTimeseriesMarketFundingRatesPredicted
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/market-funding-rates-predicted?start_time=2023-01-01&end_time=2023-01-02&paging_from=start&markets=deribit-XRP_USDC-PERPETUAL-future&pretty=true&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/market-funding-rates-predicted?start_time=2023-01-01&end_time=2023-01-02&paging_from=start&markets=deribit-XRP_USDC-PERPETUAL-future&pretty=true&api_key=<your_key>'').json()

          print(response)

          '
      - label: Python Client
        source: 'from coinmetrics.api_client import CoinMetricsClient

          client = CoinMetricsClient(<your_key>)


          response = client.get_market_funding_rates_predicted(start_time="2023-01-01", end_time="2023-01-02", paging_from="start", markets="deribit-XRP_USDC-PERPETUAL-future").to_list()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/MarketId'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/LimitPerMarket'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/ResponseFormat'
      - $ref: '#/components/parameters/NextPageToken'
      responses:
        '200':
          $ref: '#/components/responses/MarketFundingRatesPredicted'
        '400':
          $ref: '#/components/responses/MarketNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/market-orderbooks:
    servers:
    - url: https://api.coinmetrics.io/v4
    - url: https://community-api.coinmetrics.io/v4
    get:
      summary: Market orderbooks
      description: Returns orderbooks for specified markets.<br/> Results are ordered by tuple `(market, time)`.<br/> To fetch the next page of results use `next_page_url` JSON response field.
      operationId: getTimeseriesMarketOrderbooks
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/market-orderbooks?start_time=2020-06-08T21:00:00Z&end_time=2020-06-08T22:00:00Z&paging_from=start&markets=coinbase-btc-usd-spot&pretty=true&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/market-orderbooks?start_time=2020-06-08T21:00:00Z&end_time=2020-06-08T22:00:00Z&paging_from=start&markets=coinbase-btc-usd-spot&pretty=true&api_key=<your_key>'').json()

          print(response)

          '
      - label: Python Client
        source: 'from coinmetrics.api_client import CoinMetricsClient

          client = CoinMetricsClient(<your_key>)


          response = client.get_market_orderbooks(start_time="2020-06-08T21:00:00Z", end_time="2020-06-08T22:00:00Z", paging_from="start", markets="coinbase-btc-usd-spot").to_list()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/MarketId'
      - $ref: '#/components/parameters/MarketOrderBooksAndQuotesGranularity'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/BookPageSize'
      - $ref: '#/components/parameters/BookDepth'
      - $ref: '#/components/parameters/CatalogResponseFormat'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/LimitPerMarket'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/NextPageToken'
      - $ref: '#/components/parameters/OrderBookDataset'
      - $ref: '#/components/parameters/OrderBookStartWithSnapshot'
      responses:
        '200':
          $ref: '#/components/responses/MarketOrderBooks'
        '400':
          $ref: '#/components/responses/MarketNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/market-quotes:
    servers:
    - url: https://api.coinmetrics.io/v4
    - url: https://community-api.coinmetrics.io/v4
    get:
      summary: Market quotes
      description: Returns quotes for specified markets.<br/> Results are ordered by tuple `(market, time)`.<br/> To fetch the next page of results use `next_page_url` JSON response field.
      operationId: getTimeseriesMarketQuotes
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/market-quotes?start_time=2020-06-08T21:00:00Z&end_time=2020-06-08T22:00:00Z&paging_from=start&markets=coinbase-btc-usd-spot&pretty=true&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/market-quotes?start_time=2020-06-08T21:00:00Z&end_time=2020-06-08T22:00:00Z&paging_from=start&markets=coinbase-btc-usd-spot&pretty=true&api_key=<your_key>'').json()

          print(response)

          '
      - label: Python Client
        source: 'from coinmetrics.api_client import CoinMetricsClient

          client = CoinMetricsClient(<your_key>)


          response = client.get_market_quotes(start_time="2020-06-08T21:00:00Z", end_time="2020-06-08T22:00:00Z", paging_from="start", markets="coinbase-btc-usd-spot").to_list()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/MarketId'
      - $ref: '#/components/parameters/MarketOrderBooksAndQuotesGranularity'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/CatalogResponseFormat'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/LimitPerMarket'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/NextPageToken'
      - $ref: '#/components/parameters/IncludeOneSided'
      responses:
        '200':
          $ref: '#/components/responses/MarketQuotes'
        '400':
          $ref: '#/components/responses/MarketNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/market-candles:
    servers:
    - url: https://api.coinmetrics.io/v4
    - url: https://community-api.coinmetrics.io/v4
    get:
      summary: Market candles
      description: Returns candles for specified markets.<br/> Results are ordered by tuple `(market, time)`.<br/> To fetch the next page of results use `next_page_url` JSON response field.<br/> Coin Metrics derives candles directly from trades. Candles are only generated if there are trades in the underlying interval. Therefore, gaps in candles data through time are normal and to be expected. To construct gapless candles, the client should fill forward candles through time, setting the open, high, low, and close to the close of the previous candle, setting the vwap to the vwap of the previous candle, and setting the volume to zero.
      operationId: getTimeseriesMarketCandles
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/market-candles?start_time=2020-06-08T20:45:00Z&end_time=2020-06-08T20:50:00Z&paging_from=start&markets=coinbase-btc-usd-spot&pretty=true&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/market-candles?start_time=2020-06-08T20:45:00Z&end_time=2020-06-08T20:50:00Z&paging_from=start&markets=coinbase-btc-usd-spot&pretty=true&api_key=<your_key>'').json()

          print(response)

          '
      - label: Python Client
        source: 'from coinmetrics.api_client import CoinMetricsClient

          client = CoinMetricsClient(<your_key>)


          response = client.get_market_candles(start_time="2020-06-08T20:45:00Z", end_time="2020-06-08T20:50:00Z", paging_from="start", markets="coinbase-btc-usd-spot").to_list()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/MarketId'
      - $ref: '#/components/parameters/CandleFrequency'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/LimitPerMarket'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/ResponseFormat'
      - $ref: '#/components/parameters/NextPageToken'
      - $ref: '#/components/parameters/IgnoreUnsupportedErrors'
      - $ref: '#/components/parameters/IgnoreForbiddenErrors'
      responses:
        '200':
          $ref: '#/components/responses/MarketCandles'
        '400':
          $ref: '#/components/responses/MarketNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/market-contract-prices:
    servers:
    - url: https://api.coinmetrics.io/v4
    - url: https://community-api.coinmetrics.io/v4
    get:
      summary: Market contract prices
      description: 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.<br/> Results are ordered by tuple `(market, time)`.<br/> To fetch the next page of results use `next_page_url` JSON response field.<br/>
      operationId: getTimeseriesMarketContractPrices
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/market-contract-prices?start_time=2021-09-01T13:00:00Z&end_time=2021-09-01T14:00:00Z&paging_from=start&markets=deribit-ETH-25MAR22-1200-P-option&pretty=true&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/market-contract-prices?start_time=2021-09-01T13:00:00Z&end_time=2021-09-01T14:00:00Z&paging_from=start&markets=deribit-ETH-25MAR22-1200-P-option&pretty=true&api_key=<your_key>'').json()

          print(response)

          '
      - label: Python Client
        source: 'from coinmetrics.api_client import CoinMetricsClient

          client = CoinMetricsClient(<your_key>)


          response = client.get_market_contract_prices(start_time="2021-09-01T13:00:00Z", end_time="2021-09-01T14:00:00Z", paging_from="start", markets="deribit-ETH-25MAR22-1200-P-option").to_list()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/MarketId'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/ContractPricesGranularity'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/LimitPerMarket'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/ResponseFormat'
      - $ref: '#/components/parameters/NextPageToken'
      responses:
        '200':
          $ref: '#/components/responses/MarketContractPrices'
        '400':
          $ref: '#/components/responses/MarketNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/market-implied-volatility:
    servers:
    - url: https://api.coinmetrics.io/v4
    - url: https://community-api.coinmetrics.io/v4
    get:
      summary: Market implied volatility
      description: Returns implied volatility for specified markets.<br/> Results are ordered by tuple `(market, time)`.<br/> To fetch the next page of results use `next_page_url` JSON response field.<br/> Implied volatility is calculated using an options pricing model. It represents the market's expectation of future volatility and is the value, when input to an options pricing model, that makes the actual options price equal to its theoretical price.
      operationId: getTimeseriesMarketImpliedVolatility
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/market-implied-volatility?start_time=2021-09-05T13:00:00Z&end_time=2021-09-05T14:00:00Z&paging_from=start&markets=deribit-ETH-10SEP21-3200-P-option&pretty=true&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/market-implied-volatility?start_time=2021-09-05T13:00:00Z&end_time=2021-09-05T14:00:00Z&paging_from=start&markets=deribit-ETH-10SEP21-3200-P-option&pretty=true&api_key=<your_key>'').json()

          print(response)

          '
      - label: Python Client
        source: 'from coinmetrics.api_client import CoinMetricsClient

          client = CoinMetricsClient(<your_key>)


          response = client.get_market_implied_volatility(start_time="2021-09-05T13:00:00Z", end_time="2021-09-05T14:00:00Z", paging_from="start", markets="deribit-ETH-10SEP21-3200-P-option").to_list()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/MarketId'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/LimitPerMarket'
      - $ref: '#/components/parameters/ImpliedVolatilityGranularity'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/ResponseFormat'
      - $ref: '#/components/parameters/NextPageToken'
      responses:
        '200':
          $ref: '#/components/responses/MarketImpliedVolatility'
        '400':
          $ref: '#/components/responses/MarketNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/market-greeks:
    servers:
    - url: https://api.coinmetrics.io/v4
    - url: https://community-api.coinmetrics.io/v4
    get:
      summary: Market greeks
      description: Returns greeks for option markets.<br/> Results are ordered by tuple `(market, time)`.<br/> To fetch the next page of results use `next_page_url` JSON response field.<br/> Option greeks represent the sensitivity of the price of an options contract with respect to changes in its underlying parameters. Greeks are used in risk management and hedging so that market participants can achieve their desired exposure.
      operationId: getTimeseriesMarketGreeks
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/market-greeks?start_time=2021-09-01&end_time=2021-09-02&paging_from=start&markets=deribit-ETH-25MAR22-1200-P-option&pretty=true&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/market-greeks?start_time=2021-09-01&end_time=2021-09-02&paging_from=start&markets=deribit-ETH-25MAR22-1200-P-option&pretty=true&api_key=<your_key>'').json()

          print(response)

          '
      - label: Python Client
        source: 'from coinmetrics.api_client import CoinMetricsClient

          client = CoinMetricsClient(<your_key>)


          response = client.get_market_greeks(start_time="2021-09-01", end_time="2021-09-02", paging_from="start", markets="deribit-ETH-25MAR22-1200-P-option").to_list()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/MarketId'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/LimitPerMarket'
      - $ref: '#/components/parameters/GreeksGranularity'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/ResponseFormat'
      - $ref: '#/components/parameters/NextPageToken'
      responses:
        '200':
          $ref: '#/components/responses/MarketGreeks'
        '400':
          $ref: '#/components/responses/MarketNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/index-candles:
    servers:
    - url: https://api.coinmetrics.io/v4
    - url: https://community-api.coinmetrics.io/v4
    get:
      summary: Index candles
      description: Returns candles for specified indexes.<br/> Results are ordered by tuple `(index, time)`.<br/> To fetch the next page of results use `next_page_url` JSON response field.<br/>
      operationId: getTimeseriesIndexCandles
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/index-candles?start_time=2022-06-28&end_time=2022-06-30&paging_from=start&indexes=CMBIBTC&frequency=1d&pretty=true&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/index-candles?start_time=2022-06-28&end_time=2022-06-30&paging_from=start&indexes=CMBIBTC&frequency=1d&pretty=true&api_key=<your_key>'').json()

          print(response)

          '
      - label: Python Client
        source: 'from coinmetrics.api_client import CoinMetricsClient

          client = CoinMetricsClient(<your_key>)


          response = client.get_index_candles(start_time="2022-06-28", end_time="2022-06-30", paging_from="start", indexes="CMBIBTC", frequency="1d").to_list()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/IndexIdWithCandle'
      - $ref: '#/components/parameters/CandleFrequency'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/LimitPerIndex'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/Format'
      - $ref: '#/components/parameters/NextPageToken'
      responses:
        '200':
          $ref: '#/components/responses/IndexCandles'
        '400':
          $ref: '#/components/responses/IndexNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/index-levels:
    servers:
    - url: https://api.coinmetrics.io/v4
    - url: https://community-api.coinmetrics.io/v4
    get:
      summary: Index levels
      description: Returns levels for specified indexes.<br/> Results are ordered by tuple `(index, time)`.<br/> To fetch the next page of results use `next_page_url` JSON response field.
      operationId: getTimeseriesIndexLevels
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/index-levels?start_time=2020-01-01&end_time=2020-01-02&paging_from=start&indexes=CMBIBTC&frequency=1d-ny-close&pretty=true&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/index-levels?start_time=2020-01-01&end_time=2020-01-02&paging_from=start&indexes=CMBIBTC&frequency=1d-ny-close&pretty=true&api_key=<your_key>'').json()

          print(response)

          '
      - label: Python Client
        source: 'from coinmetrics.api_client import CoinMetricsClient

          client = CoinMetricsClient(<your_key>)


          response = client.get_index_levels(start_time="2020-01-01", end_time="2020-01-02", paging_from="start", indexes="CMBIBTC", frequency="1d-ny-close").to_list()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/IndexId'
      - $ref: '#/components/parameters/IndexFrequency'
      - $ref: '#/components/parameters/IndexLevelsGranularity'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/LimitPerIndex'
      - $ref: '#/components/parameters/IncludeVerification'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/ResponseFormat'
      - $ref: '#/components/parameters/NextPageToken'
      responses:
        '200':
          $ref: '#/components/responses/IndexLevels'
        '400':
          $ref: '#/components/responses/IndexNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      security:
      - api_key: []
  /timeseries/index-constituents:
    servers:
    - url: https://api.coinmetrics.io/v4
    - url: https://community-api.coinmetrics.io/v4
    get:
      summary: Index constituents
      description: Returns constituents and weights for specified indexes.<br/> Results are ordered by tuple `(index, time)`.<br/> To fetch the next page of results use `next_page_url` JSON response field.
      operationId: getTimeseriesIndexConstituents
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/index-constituents?start_time=2020-05-01T22:00:00Z&end_time=2020-05-01T22:00:00Z&paging_from=start&indexes=CMBIBTC&pretty=true&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/index-constituents?start_time=2020-05-01T22:00:00Z&end_time=2020-05-01T22:00:00Z&paging_from=start&indexes=CMBIBTC&pretty=true&api_key=<your_key>'').json()

          print(response)

          '
      - label: Python Client
        source: 'from coinmetrics.api_client import CoinMetricsClient

          client = CoinMetricsClient(<your_key>)


          response = client.get_index_constituents(start_time="2020-05-01T22:00:00Z", end_time="2020-05-01T22:00:00Z", paging_from="start", indexes="CMBIBTC").to_list()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/IndexId'
      - $ref: '#/components/parameters/IndexConstituentsFrequency'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/Format'
      - $ref: '#/components/parameters/NextPageToken'
      responses:
        '200':
          $ref: '#/components/responses/IndexConstituents'
        '400':
          $ref: '#/components/responses/IndexNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      security:
      - api_key: []
  /timeseries/mining-pool-tips-summary:
    servers:
    - url: https://api.coinmetrics.io/v4
    - url: https://community-api.coinmetrics.io/v4
    get:
      summary: Mining pool tips summary (experimental)
      description: Returns mining pool tips summaries for the specified assets.<br/> Lists last tips that we saw in all mining pools that were active during the past hour.<br/> A new summary is created when we detect any change in current tips across all mining pools.<br/> This endpoint is useful for those who want to track forks and reorgs by visualizing the distribution of currently active tips between mining pools.<br/> Results are ordered by tuple `(asset, time)`.<br/> To fetch the next page of results use `next_page_url` JSON response field.
      operationId: getTimeseriesMiningPoolTipsSummary
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/mining-pool-tips-summary?assets=btc&page_size=3&pretty=true&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/mining-pool-tips-summary?assets=btc&page_size=3&pretty=true&api_key=<your_key>'').json()

          print(response)

          '
      - label: Python Client
        source: 'from coinmetrics.api_client import CoinMetricsClient

          client = CoinMetricsClient(<your_key>)


          response = client.get_mining_pool_tips_summary(assets="btc", page_size="3").to_list()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/AssetId'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/Format'
      - $ref: '#/components/parameters/NextPageToken'
      responses:
        '200':
          $ref: '#/components/responses/MiningPoolTipsSummary'
        '400':
          $ref: '#/components/responses/AssetNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/asset-chains:
    servers:
    - url: https://api.coinmetrics.io/v4
    - url: https://community-api.coinmetrics.io/v4
    get:
      summary: Asset chains (experimental)
      description: Returns the chains of blocks for the specified assets.<br/> Lists all the chains that were active in the blockchain during the time that's enough to produce the number of blocks considered as an industry-standard number of confirmations.<br/> A new entry is created when we detect any new block anywhere in the chain.<br/> This endpoint is useful for those who want to quickly detect reorganizations or visualize currently active chains.<br/> If there are two or more active chains, then the response will contain the chain fragments starting from their common ancestor block. Otherwise, if there is a single active chain - only the blockchain tip is returned.<br/> The reorganization depth is measured as a number of consecutive blocks that were disconnected from the common ancestor block.<br/> Results are ordered by tuple `(asset, time)`.<br/> To fetch the next page of results use `next_page_url` JSON response field.
      operationId: getAssetChains
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/AssetId'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/Format'
      - $ref: '#/components/parameters/NextPageToken'
      responses:
        '200':
          $ref: '#/components/responses/AssetChains'
        '400':
          $ref: '#/components/responses/AssetNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/mempool-feerates:
    servers:
    - url: https://api.coinmetrics.io/v4
    get:
      summary: Mempool feerates (deprecated)
      description: Returns mempool feerates for the specified assets.<br/> This endpoint is useful for those who want to explore the history of the feerate distribution and potentially select the time period with the lowest commissions.<br/> Results are ordered by `(asset, time)`.<br/> To fetch the next page of results use the `next_page_url` JSON response field.
      operationId: getMempoolFeerates
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/AssetId'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/MempoolFeeratesPageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/Format'
      - $ref: '#/components/parameters/NextPageToken'
      responses:
        '200':
          $ref: '#/components/responses/MempoolFeerates'
        '400':
          $ref: '#/components/responses/AssetNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/BlockchainForbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/asset-alerts:
    servers:
    - url: https://api.coinmetrics.io/v4
    get:
      summary: Asset alerts (deprecated)
      description: Returns asset alerts for the specified assets.<br/> This endpoint is useful for those who wants to track the breaches in the particular asset's Key Risk Indicator thresholds.<br/> An asset alert is issued once an alerting metric value either breaches it's Key Risk Indicator threshold or returns back to normal for a predefined period of time.<br/> Results are ordered by `(asset, time, alert)`.<br/> To fetch the next page of results use the `next_page_url` JSON response field.
      operationId: getAssetAlerts
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/AssetId'
      - $ref: '#/components/parameters/AssetAlertId'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/Format'
      - $ref: '#/components/parameters/NextPageToken'
      - $ref: '#/components/parameters/AssetAlertIncludeHeartbeats'
      responses:
        '200':
          $ref: '#/components/responses/AssetAlerts'
        '400':
          $ref: '#/components/responses/AssetNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
  /timeseries/defi-balance-sheets:
    servers:
    - url: https://api.coinmetrics.io/v4
    get:
      summary: DeFi balance sheets (experimental)
      description: Returns Defi Balance Sheet records for specified DeFi protocols.</br> The data is being updated on an end-of-day frequency.</br> Results are ordered by tuple (`defi_protocol`, `block_height`).</br> To fetch the next page of results use the `next_page_url` JSON response field.
      operationId: getDefiBalanceSheets
      x-codeSamples:
      - label: Shell
        source: 'curl --compressed "https://api.coinmetrics.io/v4/timeseries/defi-balance-sheets?defi_protocols=aave_v2_eth&api_key=<your_key>"

          '
      - label: Python
        source: 'import requests

          response = requests.get(''https://api.coinmetrics.io/v4/timeseries/defi-balance-sheets?defi_protocols=aave_v2_eth&api_key=<your_key>'').json()

          print(response)

          '
      - label: Python Client
        source: 'from coinmetrics.api_client import CoinMetricsClient

          client = CoinMetricsClient(<your_key>)


          response = client.get_defi_balance_sheets(defi_protocols="aave_v2_eth").to_list()

          print(response)

          '
      tags:
      - Timeseries
      parameters:
      - $ref: '#/components/parameters/DefiProtocols'
      - $ref: '#/components/parameters/StartTimeMutuallyExclusiveWithHeight'
      - $ref: '#/components/parameters/EndTimeMutuallyExclusiveWithHeight'
      - $ref: '#/components/parameters/StartHeightMutuallyExclusiveWithTime'
      - $ref: '#/components/parameters/EndHeightMutuallyExclusiveWithTime'
      - $ref: '#/components/parameters/StartInclusive'
      - $ref: '#/components/parameters/EndInclusive'
      - $ref: '#/components/parameters/Timezone'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagingFrom'
      - $ref: '#/components/parameters/Pretty'
      - $ref: '#/components/parameters/Format'
      - $ref: '#/components/parameters/NextPageToken'
      responses:
        '200':
          $ref: '#/components/responses/DefiBalanceSheets'
        '400':
          $ref: '#/components/responses/DefiProtocolNotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '414':
          $ref: '#/components/responses/UriTooLong'
      security:
      - api_key: []
components:
  parameters:
    PairSort:
      description: How results will be sorted. Metrics are sorted by `(pair, time)` by default. If you want to sort `1d` metrics by `(time, pair)` you should choose `time` as value for the `sort` parameter.<br/> Sorting by `time` is useful if you request metrics for a set of asset pairs.
      in: query
      name: sort
      schema:
        default: pair
        enum:
        - pair
        - time
        type: string
    MarketMetricsSort:
      description: 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.<br/> Sorting by `time` is useful if you request metrics for a set of markets.
      in: query
      name: sort
      schema:
        default: market
        enum:
        - market
        - time
        type: string
    EndTimeMutuallyExclusiveWithHeightAndHash:
      description: 'End of the time interval.<br/> This field refers to the `time` field in the response.<br/> Multiple formats of ISO 8601 are supported: `2006-01-20T00:00:00Z`, `2006-01-20T00:00:00.000Z`, `2006-01-20T00:00:00.123456Z`, `2006-01-20T00:00:00.123456789Z`, `2006-01-20`, `20060120`.<br/> Inclusive by default. Mutually exclusive with `end_height` and `end_hash`.<br/> UTC timezone by default. `Z` suffix is optional and `timezone` parameter has a priority over it.<br/> If `end_time` is omitted, response will include time series up to the **latest** time available.'
      in: query
      name: end_time
      schema:
        type: string
    LimitPerExchangeAsset:
      description: How many entries per exchange_asset result should contain. For example, this combination of parameters `exchange_assets=binance-btc,coinbase-eth&metrics=volume_trusted_spot_usd_1h&limit_per_exchange_asset=1` returns the latest `volume_trusted_spot_usd_1h` values for `binance-btc` and `coinbase-eth`.
      in: query
      name: limit_per_exchange_asset
      schema:
        type: integer
        format: int32
    Status:
      description: Which metric values do you want to see. Applicable only for "reviewable" metrics. You can find them in the `/catalog-v2/asset-metrics` endpoint.
      in: query
      name: status
      schema:
        default: all
        enum:
        - all
        - flash
        - reviewed
        - revised
        type: string
    LimitPerExchangePair:
      description: How many entries per exchange_pair result should contain. For example, this combination of parameters `exchange_pairs=binance-btc-usdt,coinbase-eth-usd&metrics=volatility_implied_skew_delta_05_1d_expiration&limit_per_exchange_pair=1` returns the latest `volatility_implied_skew_delta_05_1d_expiration` values for `binance-btc-usdt` and `coinbase-eth-usd`.
      in: query
      name: limit_per_exchange_pair
      schema:
        type: integer
        format: int32
    Exchanges:
      description: Comma separated list of exchange names or asterisk (*) for all supported exchanges.
      examples:
        list-example:
          summary: the list of exchanges
          value: coinbase,binance,etc
        asterisk-example:
          summary: all supported exchanges
          value: '*'
      in: query
      name: exchanges
      required: true
      schema:
        type: array
        items:
          type: string
      explode: false
    AssetMetricsFrequency:
      description: Frequency of the metrics. Supported values are `1b` (block by block), `1s` (one second), `1m` (one minute), `5m` (five minutes), `10m` (ten minutes), `1h` (one hour), `1d` (one day), `1d-ny-close` (one day at New York close time). Please refer to the `/catalog-v2/asset-metrics` endpoint for the full list.<br/> Use the [/catalog-all-v2/asset-metrics](#operation/getCatalogAllV2AssetMetrics) endpoint for the full list of supported frequencies per asset-metric pair.
      in: query
      name: frequency
      schema:
        default: 1d
        example: 1b
        type: string
    LimitPerExchange:
      description: How many entries per institution result should contain. For example, this combination of parameters `exchanges=binance,coinbase&metrics=volume_trusted_spot_usd_1h&limit_per_exchange=1` returns the latest `volume_trusted_spot_usd_1h` values for `binance` and `coinbase`.
      in: query
      name: limit_per_exchange
      schema:
        type: integer
        format: int32
    ContractPricesGranularity:
      description: Downsampling granularity of market contract prices. Supported values are `raw`, `1m`, `1h`, and `1d`.
      in: query
      name: granularity
      schema:
        default: raw
        type: string
        enum:
        - raw
        - 1m
        - 1h
        - 1d
    IncludeVerification:
      description: If set to true, includes information about verification.
      in: query
      name: include_verification
      required: false
      schema:
        type: boolean
        default: false
    InstitutionSort:
      description: 'How results will be sorted. Metrics are sorted by `(institution, time)` by default. If you want to sort `1d` metrics by `(time, institution)` you should choose `time` as value for the `sort` parameter.<br/> Sorting by `time` is useful if you request metrics for a set of institutions.<br/> Note: sorting by `time` is not supported when wildcards are used.'
      in: query
      name: sort
      schema:
        default: institution
        enum:
        - institution
        - time
        type: string
    EndHeightMutuallyExclusiveWithTime:
      description: The end height indicates the ending block height for the set of data that are returned.<br/> Inclusive by default. Mutually exclusive with `end_time`.
      in: query
      name: end_height
      schema:
        type: integer
        format: int64
        minimum: 0
    Sort:
      description: How results will be sorted. 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.<br/> Sorting by `time` is useful if you request metrics for a set of assets.
      in: query
      name: sort
      schema:
        default: asset
        enum:
        - asset
        - height
        - time
        type: string
    OrderBookDataset:
      description: "Logical order book dataset to return.<br/><br/> `snapshots` (default) returns snapshot rows only.<br/><br/> `updates` returns Book Streams snapshot/update rows for migrated exchanges.<br/><br/> Caveats:<br/> <ul>\n    <li>`dataset=updates` is currently supported for `full_book` and `30000` depths, `raw` granularity, `json_stream` format, `paging_from=start`, and migrated exchanges only.</li>\n    <li>When the `updates` dataset is requested, there are no guarantees on how snapshots are placed inside the data. Snapshots can appear at arbitrary timestamps and at irregular intervals.</li>\n    <li>Clients should reset their order book state on every snapshot row, not only on the first one. Snapshots may be emitted mid-stream, for example when the upstream feed is switched, and can carry book state that differs from prior updates. Treating every snapshot as a full state replacement is always safe while skipping snapshots is not.</li>\n    <li>When the `updates` dataset is requested, the response may contain redundant snapshots that do not change order book state and are there for state synchronization. Such redundant snapshots have the same timestamp and `coin_metrics_id` as the previous row. Clients may use this to detect redundant snapshots, but the safe default is still to reset state on every snapshot.</li>\n</ul>"
      in: query
      name: dataset
      schema:
        type: string
        enum:
        - snapshots
        - updates
        default: snapshots
    Format:
      description: Format of the response.
      in: query
      name: format
      schema:
        enum:
        - json
        - csv
        type: string
        default: json
    ResponseFormat:
      description: Format of the response. Supported values are `json`, `json_stream`, `csv`.
      in: query
      name: format
      schema:
        enum:
        - json
        - json_stream
        - csv
        type: string
        default: json
    ExchangePairMetricsParam:
      description: Comma separated metrics to request time series data for.<br/> Information on all available metrics can be found on page https://coverage.coinmetrics.io/exchange-pair-metrics.<br/> Use the [/catalog-all-v2/exchange-pair-metrics](#operation/getCatalogAllV2ExchangePairMetrics) endpoint for the full list of supported metrics per exchange-pair combination.
      in: query
      name: metrics
      required: true
      schema:
        example:
        - volatility_implied_put_delta_50_1y_expiration
        - volatility_implied_skew_delta_05_1d_expiration
        type: array
        items:
          type: string
      explode: false
    MinConfirmations:
      description: 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`. For example, a `min_confirmations` of `0` means metrics are being calculated for the block at the tip of the chain (the latest block received by our node) whereas a `min_confirmations` of `6` means that metrics are being applied to the block that is `6` blocks behind the chain tip (i.e., the 7th block if the chain tip is block 1).
      in: query
      name: min_confirmations
      schema:
        type: integer
        format: int32
        minimum: 0
        maximum: 99
    BookPageSize:
      description: Number of items per single page of results. Maximum value for unlimited order books is 100.<br/> The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
      in: query
      name: page_size
      schema:
        default: 100
        type: integer
        format: int32
        minimum: 1
        maximum: 10000
    ImpliedVolatilityGranularity:
      description: Downsampling granularity of market implied volatility. Supported values are `raw`, `1m`, `1h`, and `1d`.
      in: query
      name: granularity
      schema:
        default: raw
        type: string
        enum:
        - raw
        - 1m
        - 1h
        - 1d
    PagingFrom:
      description: Where does the first page start, at the start of the interval or at the end.<br/> The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
      in: query
      name: paging_from
      schema:
        default: end
        enum:
        - start
        - end
        type: string
        format: PagingFrom
    PairWithCandle:
      description: Comma separated list of asset pairs or patterns like `btc-*`, or `*-btc`.<br/> Use the [/catalog-all-v2/pair-candles](#operation/getCatalogAllV2PairCandles) endpoint for the full list of supported asset pairs.
      in: query
      name: pairs
      required: true
      schema:
        type: array
        items:
          type: string
      explode: false
    Pretty:
      description: Human-readable formatting of JSON responses.
      in: query
      name: pretty
      schema:
        type: boolean
        default: false
    StartHeightMutuallyExclusiveWithTime:
      description: The start height indicates the beginning block height for the set of data that are returned.<br/> Inclusive by default. Mutually exclusive with `start_time`.
      in: query
      name: start_height
      schema:
        type: integer
        format: int64
        minimum: 0
    EndInclusive:
      description: Inclusive or exclusive corresponding `end_*` parameters.
      in: query
      name: end_inclusive
      schema:
        default: true
        type: boolean
    ExchangeAssets:
      description: Comma separated list of exchange-asset pairs or patterns like `exchange-*` or `*-asset`.
      in: query
      name: exchange_assets
      required: true
      schema:
        type: array
        items:
          type: string
      explode: false
    IgnoreForbiddenErrors:
      description: Ignore "forbidden" errors for the items you currently don't have access to.
      in: query
      name: ignore_forbidden_errors
      schema:
        type: boolean
        default: false
    LimitPerInstitution:
      description: How many entries per institution result should contain. For example, this combination of parameters `institutions=institution1,institution2&metrics=total_assets&limit_per_institution=1` returns the latest `total_assets` values for `institution1` and `institution2`.
      in: query
      name: limit_per_institution
      schema:
        type: integer
        format: int32
    IndexFrequency:
      description: Frequency of the index. Supported values are `1s`, `15s`, `1h`, `1d-ny-close`, `1d-sg-close`, `1d`, `1d-HH:00`.<br/> Use the [/catalog-all-v2/index-levels](#operation/getCatalogAllV2IndexLevels) endpoint for the full list of supported frequencies per index.
      in: query
      name: frequency
      schema:
        default: 1d
        type: string
    AssetMetrics:
      description: Comma separated metrics to request time series data for.<br/> Information on all available metrics can be found on page https://coverage.coinmetrics.io/asset-metrics-v2.<br/> Use the [/catalog-all-v2/asset-metrics](#operation/getCatalogAllV2AssetMetrics) endpoint for the full list of supported metrics per asset.
      in: query
      name: metrics
      required: true
      schema:
        example:
        - AdrActCnt
        - BlkHgt
        type: array
        items:
          type: string
      explode: false
    StartHeightMutuallyExclusiveWithTimeAndHash:
      description: The start height indicates the beginning block height for the set of data that are returned.<br/> Inclusive by default. Mutually exclusive with `start_time` and `start_hash`.
      in: query
      name: start_height
      schema:
        type: integer
        format: int64
        minimum: 0
    EndTimeMutuallyExclusiveWithHeight:
      description: 'End of the time interval.<br/> This field refers to the `time` field in the response.<br/> Multiple formats of ISO 8601 are supported: `2006-01-20T00:00:00Z`, `2006-01-20T00:00:00.000Z`, `2006-01-20T00:00:00.123456Z`, `2006-01-20T00:00:00.123456789Z`, `2006-01-20`, `20060120`.<br/> Inclusive by default. Mutually exclusive with `end_height`.<br/> UTC timezone by default. `Z` suffix is optional and `timezone` parameter has a priority over it.<br/> If `end_time` is omitted, response will include time series up to the **latest** time available.'
      in: query
      name: end_time
      schema:
        type: string
    Institution:
      description: 'Comma separated list of institutions, or wildcard (*) for all supported institutions.<br/> Note: the wildcards are not supported when `sort` parameter is set to `time`.<br/> Use the [/catalog-all-v2/institution-metrics](#operation/getCatalogAllV2InstitutionMetrics) endpoint for the full list of supported institutions.'
      in: query
      name: institutions
      required: true
      schema:
        type: array
        items:
          type: string
      explode: false
    MarketId:
      description: Comma separated list of markets or market patterns like `exchange-*` or `exchange-*-spot` or `*USDT-future`.<br/> Use a corresponding `/catalog-all-v2/market-{dataType}` endpoint for the full list of supported markets for a given data type.
      in: query
      name: markets
      required: true
      schema:
        type: array
        items:
          type: string
      explode: false
    Pair:
      description: Comma separated list of asset pairs or patterns like `btc-*`, or `*-btc`.<br/> Use a corresponding `/catalog-all-v2/pair-{dataType}` endpoint for the full list of supported pairs for a given data type.
      in: query
      name: pairs
      required: true
      schema:
        type: array
        items:
          type: string
      explode: false
    DefiProtocols:
      description: Comma separated list of DeFi protocols like `aave_v2_eth` or protocol patterns like `aave_v2_*` or `aave_*_eth` or `*_eth`.
      in: query
      name: defi_protocols
      required: true
      schema:
        type: array
        items:
          type: string
      explode: false
    MarketOrderBooksAndQuotesGranularity:
      description: Downsampling granularity of market order books and quotes. Supported values are `raw`, `1m`, `1h`, and `1d`.
      in: query
      name: granularity
      schema:
        default: raw
        type: string
        enum:
        - raw
        - 1m
        - 1h
        - 1d
    ExchangeSort:
      description: How results will be sorted. Metrics are sorted by `(exchange, time)` by default. If you want to sort `1d` metrics by `(time, exchange)` you should choose `time` as value for the `sort` parameter.<br/> Sorting by `time` is useful if you request metrics for a set of exchanges.
      in: query
      name: sort
      schema:
        default: exchange
        enum:
        - exchange
        - time
        type: string
    NullAsZero:
      description: Nulls are represented as zeros in the response.
      in: query
      name: null_as_zero
      schema:
        type: boolean
        default: false
    LimitPerMarket:
      description: How many entries per market result should contain. It is useful when multiple markets are requested.
      in: query
      name: limit_per_market
      schema:
        type: integer
        format: int32
    PairMetricsParam:
      description: Comma separated metrics to request time series data for.<br/> Information on all available metrics can be found on page https://coverage.coinmetrics.io/pair-metrics-v2.<br/> Use the [/catalog-all-v2/pair-metrics](#operation/getCatalogAllV2PairMetrics) endpoint for the full list of supported metrics per pair.
      in: query
      name: metrics
      required: true
      schema:
        example:
        - volume_trusted_spot_usd_1h
        - volume_trusted_spot_usd_1d
        type: array
        items:
          type: string
      explode: false
    StartTime:
      description: 'Start of the time interval.<br/> This field refers to the `time` field in the response.<br/> Multiple formats of ISO 8601 are supported: `2006-01-20T00:00:00Z`, `2006-01-20T00:00:00.000Z`, `2006-01-20T00:00:00.123456Z`, `2006-01-20T00:00:00.123456789Z`, `2006-01-20`, `20060120`.<br/> Inclusive by default.<br/> UTC timezone by default. `Z` suffix is optional and `timezone` parameter has a priority over it.<br/> If `start_time` is omitted, response will include time series from the **earliest** time available.'
      in: query
      name: start_time
      schema:
        type: string
    PageSize:
      description: Number of items per single page of results.<br/> The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
      in: query
      name: page_size
      schema:
        default: 100
        type: integer
        format: int32
        minimum: 1
        maximum: 10000
    TradeMinConfirmations:
      description: Specifies how many blocks behind the chain tip trades are based on. Default is `2`. For example, a `min_confirmations` of `0` means trades are being collected for all blocks up to the block at the tip of the chain (the latest block received by our node) whereas a `min_confirmations` of `6` means that trades are being collected for all blocks up to the block that is `6` blocks behind the chain tip (i.e., the 7th block if the chain tip is block 1). Currently available only for DeFi markets.
      in: query
      name: min_confirmations
      schema:
        type: integer
        format: int32
        minimum: 0
        maximum: 99
        default: 2
    EndHash:
      description: The end hash indicates the ending block height for the set of data that are returned.<br/> Inclusive by default. Mutually exclusive with `end_time` and `end_height`.
      in: query
      name: end_hash
      schema:
        type: string
    LimitPerAsset:
      description: How many entries per asset result should contain. For example, this combination of parameters `assets=btc,eth&metrics=ReferenceRate&limit_per_asset=1` returns the latest `ReferenceRate` values for `btc` and `eth`.
      in: query
      name: limit_per_asset
      schema:
        type: integer
        format: int32
    IndexIdWithCandle:
      description: Comma separated list of indexes, or patterns like `CMBI*`, or `*BTC`.<br/> Use the [/catalog-all-v2/index-candles](#operation/getCatalogAllV2IndexCandles) endpoint for the full list of supported indexes.
      in: query
      name: indexes
      required: true
      schema:
        example: CMBIBE
        type: array
        items:
          type: string
      explode: false
    PagingFromWithStartByDefault:
      description: Where does the first page start, at the start of the interval or at the end.<br/> The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
      in: query
      name: paging_from
      schema:
        default: start
        enum:
        - start
        - end
        type: string
        format: PagingFrom
    IndexId:
      description: Comma separated list of indexes, or patterns like `CMBI*`, or `*BTC`.<br/> Use the [/catalog-all-v2/index-levels](#operation/getCatalogAllV2IndexLevels) endpoint for the full list of supported indexes.
      in: query
      name: indexes
      required: true
      schema:
        example: CMBIBE
        type: array
        items:
          type: string
      explode: false
    ProtocolMetrics:
      description: Comma separated list of protocol metrics like `supply_apy`.
      in: query
      name: metrics
      schema:
        type: array
        items:
          type: string
      explode: false
    MarketMetricsParam:
      description: Comma separated metrics to request time series data for.<br/> Use the [/catalog-all-v2/market-metrics](#operation/getCatalogAllV2MarketMetrics) endpoint for the full list of supported metrics per exchange-asset combination.
      in: query
      name: metrics
      required: true
      schema:
        example:
        - liquidations_reported_future_buy_units_1d
        - liquidations_reported_future_sell_units_1d
        type: array
        items:
          type: string
      explode: false
    ExchangeMetricsFrequency:
      description: Frequency of the exchange metrics. Supported values are `1h`, `1d`.
      in: query
      name: frequency
      schema:
        default: 1d
        type: string
    IndexConstituentsFrequency:
      description: Frequency of index constituents. Supported values are `1h`, `1d`, `1d-ny-close`, `1d-ny-midday`, `1d-sg-close`.<br/> If omitted, only changed constituents are returned.
      in: query
      name: frequency
      schema:
        type: string
    MempoolFeeratesPageSize:
      description: Number of mempool feerate snapshots per single page of results.
      in: query
      name: page_size
      schema:
        default: 10
        type: integer
        format: int32
        minimum: 1
        maximum: 200
    ProtocolMarkets:
      description: Comma separated list of protocol markets like `core-weth` or `steakusdc`.
      in: query
      name: markets
      schema:
        type: array
        items:
          type: string
      explode: false
    ProtocolChains:
      description: Comma separated list of protocol chains like `ethereum` or `base`.
      in: query
      name: chains
      schema:
        type: array
        items:
          type: string
      explode: false
    StartTimeMutuallyExclusiveWithHeightAndHash:
      description: 'Start of the time interval.<br/> This field refers to the `time` field in the response.<br/> Multiple formats of ISO 8601 are supported: `2006-01-20T00:00:00Z`, `2006-01-20T00:00:00.000Z`, `2006-01-20T00:00:00.123456Z`, `2006-01-20T00:00:00.123456789Z`, `2006-01-20`, `20060120`.<br/> Inclusive by default. Mutually exclusive with `start_height` and `start_hash`.<br/> UTC timezone by default. `Z` suffix is optional and `timezone` parameter has a priority over it.<br/> If `start_time` is omitted, response will include time series from the **earliest** time available.'
      in: query
      name: start_time
      schema:
        type: string
    IndexLevelsGranularity:
      description: Downsampling granularity for the data of a given native frequency. Granularity applied to external indexes only. Ignored for the indexes calculated by Coin Metrics. Possible values are `raw`, `1d-ny-close`, `1d-ny-close-last-second`, `1d-ldn-close`, `1d-ldn-close-last-second`, `1d-sg-close`, `1d-sg-close-last-second`, or custom offsets (e.g., `1d-16:00`).
      in: query
      name: granularity
      schema:
        type: string
        default: raw
    IncludeOneSided:
      description: Include one-side and empty books in quotes response.
      in: query
      name: include_one_sided
      schema:
        type: boolean
        default: false
    OpenInterestGranularity:
      description: Downsampling granularity of market open interest. Supported values are `raw`, `1m`, `1h`, and `1d`.
      in: query
      name: granularity
      schema:
        default: raw
        type: string
        enum:
        - raw
        - 1m
        - 1h
        - 1d
    ExchangeAssetMetricsFrequency:
      description: Frequency of the exchange-asset metrics. Supported values are `5m`, `1h`, `1d`.
      in: query
      name: frequency
      schema:
        default: 1d
        type: string
    NextPageToken:
      description: Token for receiving the results from the next page of a query.<br/> Should not be used directly. To iterate through pages just use `next_page_url` response field.
      in: query
      name: next_page_token
      schema:
        type: string
    LimitPerIndex:
      description: How many entries per index result should contain. It is useful when multiple indexes are requested.
      in: query
      name: limit_per_index
      schema:
        type: integer
        format: int32
    OrderBookStartWithSnapshot:
      description: Applies only when `dataset=updates`.<br/><br/> When `false` (default), rows are returned from the exact readable range. This is useful when the order book state is already initialized so the timestamp of the last row received can be used to resume downloading order book data.<br/><br/> When `true`, the response starts with a snapshot row when one is available at or before the effective dataset start. This is useful for order book state initialization. The API may include a snapshot from before `start_time` so client state can be initialized before the first update row is applied.<br/><br/> This parameter is ignored when `dataset=snapshots`.
      in: query
      name: start_with_snapshot
      schema:
        type: boolean
        default: false
    ExchangePairs:
      description: Comma separated list of exchange-pairs or patterns like `exchange-*` or `*-pair`.
      in: query
      name: exchange_pairs
      required: true
      schema:
        type: array
        items:
          type: string
      explode: false
    CatalogResponseFormat:
      description: Format of the response. Supported values are `json`, `json_stream`.
      in: query
      name: format
      schema:
        type: string
        default: json
    EndTime:
      description: 'End of the time interval.<br/> This field refers to the `time` field in the response.<br/> Multiple formats of ISO 8601 are supported: `2006-01-20T00:00:00Z`, `2006-01-20T00:00:00.000Z`, `2006-01-20T00:00:00.123456Z`, `2006-01-20T00:00:00.123456789Z`, `2006-01-20`, `20060120`.<br/> Inclusive by default.<br/> UTC timezone by default. `Z` suffix is optional and `timezone` parameter has a priority over it.<br/> If `end_time` is omitted, response will include time series up to the **latest** time available.'
      in: query
      name: end_time
      schema:
        type: string
    GreeksGranularity:
      description: Downsampling granularity of market greeks. Supported values are `raw`, `1m`, `1h`, and `1d`.
      in: query
      name: granularity
      schema:
        default: raw
        type: string
        enum:
        - raw
        - 1m
        - 1h
        - 1d
    CandleFrequency:
      description: 'Candle duration. Supported values are `1m`, `5m`, `10m`, `15m`, `30m`, `1h`, `4h`, `1d`, and `1d-HH:00`. \

        Note: The `timezone` parameter value will be taken into account when the `1d` or `1d-HH:00` frequency is specified.

        '
      in: query
      name: frequency
      schema:
        default: 1d
        example: 5m
        type: string
    LimitPerPair:
      description: How many entries per pair result should contain. For example, this combination of parameters `pair=btc-usd,eth-usd&metrics=volume_trusted_spot_usd_1h&limit_per_pair=1` returns the latest `volume_trusted_spot_usd_1h` values for `btc-usd` and `eth-usd`.
      in: query
      name: limit_per_pair
      schema:
        type: integer
        format: int32
    ProtocolFrequency:
      description: Frequency of the protocol metrics. Supported values are `1d`, `1m`.
      in: query
      name: frequency
      required: true
      schema:
        type: string
    IgnoreUnsupportedErrors:
      description: Ignore "unsupported" errors for not currently supported by Coin Metrics items.
      in: query
      name: ignore_unsupported_errors
      schema:
        type: boolean
        default: false
    InstitutionMetricsParam:
      description: Comma separated metrics to request time series data for.<br/> Information on all available metrics can be found on page https://docs.coinmetrics.io/market-data/market-data-overview/institution-metrics-overview.<br/> Use the [/catalog-all-v2/institution-metrics](#operation/getCatalogAllV2InstitutionMetrics) endpoint for the full list of supported metrics per institution.
      in: query
      name: metrics
      required: true
      schema:
        example:
        - btc_total_assets
        - btc_shares_outstanding
        type: array
        items:
          type: string
      explode: false
    EndHeightMutuallyExclusiveWithTimeAndHash:
      description: The end height indicates the ending block height for the set of data that are returned.<br/> Inclusive by default. Mutually exclusive with `end_time` and `end_hash`.<br/> This parameter is disabled for Community users.
      in: query
      name: end_height
      schema:
        type: integer
        format: int64
        minimum: 0
    StartTimeMutuallyExclusiveWithHeight:
      description: 'Start of the time interval.<br/> This field refers to the `time` field in the response.<br/> Multiple formats of ISO 8601 are supported: `2006-01-20T00:00:00Z`, `2006-01-20T00:00:00.000Z`, `2006-01-20T00:00:00.123456Z`, `2006-01-20T00:00:00.123456789Z`, `2006-01-20`, `20060120`.<br/> Inclusive by default. Mutually exclusive with `start_height`.<br/> UTC timezone by default. `Z` suffix is optional and `timezone` parameter has a priority over it.<br/> If `start_time` is omitted, response will include time series from the **earliest** time available.'
      in: query
      name: start_time
      schema:
        type: string
    AssetMetricsAssetId:
      description: Comma separated list of assets.<br/> Use the [/catalog-all-v2/asset-metrics](#operation/getCatalogAllV2AssetMetrics) endpoint for the full list of supported assets or specify asterisk (*) in order to get metrics for all supported assets.
      in: query
      name: assets
      required: true
      schema:
        type: array
        items:
          type: string
      explode: false
    Protocols:
      description: Comma separated list of protocols like `aave_v3` or `morpho_blue`.
      in: query
      name: protocols
      schema:
        type: array
        items:
          type: string
      explode: false
    Timezone:
      description: Timezone name for `start_time` and `end_time` timestamps.<br/> This parameter does not modify the output times, which are always `UTC`.<br/> Format is defined by [TZ database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
      in: query
      name: timezone
      schema:
        example: America/New_York
        default: UTC
        type: string
    StartInclusive:
      description: Inclusive or exclusive corresponding `start_*` parameters.
      in: query
      name: start_inclusive
      schema:
        default: true
        type: boolean
    LimitPerPairCandle:
      description: How many entries per pair result should contain.
      in: query
      name: limit_per_pair
      schema:
        type: integer
        format: int32
    ExchangeAssetMetricsParam:
      description: Comma separated metrics to request time series data for.<br/> Information on all available metrics can be found on page https://coverage.coinmetrics.io/exchange-asset-metrics-v2.<br/> Use the [/catalog-all-v2/exchange-asset-metrics](#operation/getCatalogAllV2ExchangeAssetMetrics) endpoint for the full list of supported metrics per exchange-asset combination.
      in: query
      name: metrics
      required: true
      schema:
        example:
        - open_interest_reported_future_usd
        - volume_reported_spot_usd_1d
        type: array
        items:
          type: string
      explode: false
    ExchangeAssetSort:
      description: How results will be sorted. Metrics are sorted by `(exchange_asset, time)` by default. If you want to sort `1d` metrics by `(time, exchange_asset)` you should choose `time` as value for the `sort` parameter.<br/> Sorting by `time` is useful if you request metrics for a set of exchange-assets.
      in: query
      name: sort
      schema:
        default: exchange_asset
        enum:
        - exchange_asset
        - time
        type: string
    BookDepth:
      description: Book depth limit. Supported values are between 1 and 30000, `10pct_mid_price` or `full_book`.
      in: query
      name: depth_limit
      schema:
        default: '100'
        type: string
    MarketMetricsFrequency:
      description: Frequency of the market metrics. Supported values are `1m`, `5m`, `1h`, `1d`.
      in: query
      name: frequency
      schema:
        default: 1d
        type: string
    InstitutionMetricsFrequency:
      description: Frequency of the institution metrics. Supported values are `1d`.
      in: query
      name: frequency
      schema:
        default: 1d
        type: string
    AssetAlertId:
      description: Comma separated list of asset alert names.<br/> Use the [/catalog-all/asset-alerts](#operation/getCatalogAllAssetAlerts) endpoint for the full list of supported asset alerts.
      in: query
      name: alerts
      required: true
      schema:
        type: array
        items:
          type: string
      explode: false
    ExchangeMetricsParam:
      description: Comma separated metrics to request time series data for.<br/> Information on all available metrics can be found on page https://coverage.coinmetrics.io/exchange-metrics-v2.<br/> Use the [/catalog-all-v2/exchange-metrics](#operation/getCatalogAllV2ExchangeMetrics) endpoint for the full list of supported metrics per exchange.
      in: query
      name: metrics
      required: true
      schema:
        example:
        - open_interest_reported_future_usd
        - volume_reported_spot_usd_1d
        type: array
        items:
          type: string
      explode: false
    PairMetricsFrequency:
      description: Frequency of the pair metrics. Supported values are `1h`, `1d`.
      in: query
      name: frequency
      schema:
        default: 1d
        type: string
    ExchangePairMetricsFrequency:
      description: Frequency of the exchange-pair metrics. Supported values are `1h`, `1d`.
      in: query
      name: frequency
      schema:
        default: 1d
        type: string
    AssetAlertIncludeHeartbeats:
      description: If set to true, includes information about most recent time asset was successfully evaluated.
      in: query
      name: include_heartbeats
      required: false
      schema:
        type: boolean
        default: false
    AssetId:
      description: Comma separated list of assets.<br/> Use a corresponding `/catalog-all-v2/asset-{dataType}` endpoint for the full list of supported assets for a given data type.
      in: query
      name: assets
      required: true
      schema:
        type: array
        items:
          type: string
      explode: false
    StartHash:
      description: The start hash indicates the beginning block height for the set of data that are returned.<br/> Inclusive by default. Mutually exclusive with `start_time` and `start_height`.
      in: query
      name: start_hash
      schema:
        type: string
  schemas:
    PairMetricsResponse:
      description: Time series of pair metrics.
      properties:
        data:
          items:
            type: object
            properties:
              pair:
                $ref: '#/components/schemas/Pair'
              time:
                $ref: '#/components/schemas/Time'
            additionalProperties:
              nullable: true
              description: Metric value. `null` value is only possible when multiple metrics are requested, but not all are calculated for now. Absent metric field is only possible when multiple metrics are requested, but not all are supported for requested asset pairs.
              type: string
            required:
            - pair
            - time
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    BlockchainBlockHash:
      description: Hash of the block.
      type: string
    IndexLevelsResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/IndexLevel'
          type: array
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    OpenInterestExchangeTime:
      description: Time corresponding to open interest data point, according to the exchange. Can be NULL, if exchange doesn't support it.
      type: string
      format: date-time
    MarketImpliedVolatility:
      description: Information about market implied volatility.
      properties:
        market:
          $ref: '#/components/schemas/MarketId'
        time:
          $ref: '#/components/schemas/Time'
        iv_trade:
          $ref: '#/components/schemas/ImpliedVolatilityTrade'
        iv_bid:
          $ref: '#/components/schemas/ImpliedVolatilityBid'
        iv_ask:
          $ref: '#/components/schemas/ImpliedVolatilityAsk'
        iv_mark:
          $ref: '#/components/schemas/ImpliedVolatilityMark'
        database_time:
          $ref: '#/components/schemas/DatabaseTime'
        exchange_time:
          $ref: '#/components/schemas/OptionTickerExchangeTime'
      type: object
      required:
      - market
      - time
      - database_time
    DefiBalanceSheetLiquidSupplyRatio:
      description: DeFi balance sheet liquid supply ratio.
      type: string
      format: decimal
    MarketId:
      description: Unique name of the market.
      type: string
    DefiBalanceSheetAssetItem:
      description: DeFi balance sheet asset item.
      properties:
        asset:
          $ref: '#/components/schemas/Asset'
        total_units:
          $ref: '#/components/schemas/DefiBalanceSheetItemBalanceUnits'
        loans_lent_units:
          $ref: '#/components/schemas/DefiBalanceSheetItemBalanceUnits'
        tvl_units:
          $ref: '#/components/schemas/DefiBalanceSheetItemBalanceUnits'
        total_usd:
          $ref: '#/components/schemas/DefiBalanceSheetItemBalanceUsd'
        loans_lent_usd:
          $ref: '#/components/schemas/DefiBalanceSheetItemBalanceUsd'
        tvl_usd:
          $ref: '#/components/schemas/DefiBalanceSheetItemBalanceUsd'
        total_share:
          $ref: '#/components/schemas/DefiBalanceSheetItemShare'
        loans_lent_share:
          $ref: '#/components/schemas/DefiBalanceSheetItemShare'
        tvl_share:
          $ref: '#/components/schemas/DefiBalanceSheetItemShare'
      required:
      - asset
      - total_units
    ExchangeAsset:
      description: Unique combination of the exchange and asset.
      type: string
    MarkPrice:
      description: The price representing the futures' or option's price calculated by the exchange for risk management purposes.
      type: string
      format: decimal
    OrderBookBids:
      description: The bids orders on the order book.
      items:
        $ref: '#/components/schemas/BookEntry'
      type: array
    MarketGreeksResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/MarketGreeks'
          type: array
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    MarketOpenInterestDataArray:
      description: Time series of market open interest.
      items:
        $ref: '#/components/schemas/MarketOpenInterest'
      type: array
    TradeSide:
      description: The market order side. "buy" means that an ask was removed from the book by an incoming buy order, "sell" means that a bid was removed from the book by an incoming sell order.
      type: string
    MarketTradesResponse:
      properties:
        data:
          $ref: '#/components/schemas/MarketTradesDataArray'
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    ErrorObject:
      properties:
        type:
          description: Error type string. Can be used for error identification.
          type: string
        message:
          description: Human-friendly error description. Can be amended without prior notification. Do not use for error identification in your code.
          type: string
      required:
      - type
      - description
      type: object
    GreeksRho:
      description: The first derivative of the option's price to the risk free interest rate.
      type: string
      format: decimal
    ExchangePairMetricsResponse:
      description: Time series of exchange pair metrics.
      properties:
        data:
          items:
            type: object
            properties:
              exchange_pair:
                $ref: '#/components/schemas/ExchangePair'
              time:
                $ref: '#/components/schemas/Time'
            additionalProperties:
              nullable: true
              description: Metric value. `null` value is only possible when multiple metrics are requested, but not all are calculated for now. Absent metric field is only possible when multiple metrics are requested, but not all are supported for requested exchange-pairs.
              type: string
            required:
            - exchange_pair
            - time
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    ProtocolMetricValue:
      description: Protocol metric value.
      properties:
        market:
          description: Protocol market.
          type: string
        protocol:
          description: Protocol name.
          type: string
        chain:
          description: Protocol chain.
          type: string
        time:
          $ref: '#/components/schemas/Time'
      additionalProperties:
        nullable: true
        description: Metric value. `null` value is only possible when multiple metrics are requested, but not all are calculated for now. Absent metric field is only possible when multiple metrics are requested, but not all are supported for requested market.
        type: string
      type: object
      required:
      - market
      - protocol
      - chain
      - time
    DefiBalanceSheetCurrentRatio:
      description: DeFi balance sheet current ratio.
      type: string
      format: decimal
    ChainsCount:
      description: Count of all the chains that were active in the blockchain during the past hour.
      type: string
      format: int64
    MempoolFeerateBandFees:
      description: Fees summed up for all the transactions included into the current mempool feerate band. Unit is BTC.
      type: string
      format: decimal
    TradesCoinMetricsId:
      description: ID of a trade (unique per exchange market). We are using exchange reported value if exchange reports a unique numeric trade id. If exchange reports trade id as a string we convert to numeric using Bijective mapping from exchange reported trade id's string. If exchange doesn't report unique ID we transform it using exchange reported data to form a unique value per market.
      type: string
    DefiBalanceSheetLiabilitiesTotalUsd:
      description: Total USD value of all liabilities in the DeFi balance sheet.
      type: string
      format: decimal
    IndexLevel:
      description: Information about index level.
      properties:
        index:
          $ref: '#/components/schemas/Index'
        time:
          $ref: '#/components/schemas/Time'
        level:
          $ref: '#/components/schemas/IndexLevelValue'
        verification:
          $ref: '#/components/schemas/Verification'
      type: object
      required:
      - index
      - time
      - level
    ImpliedVolatilityMark:
      description: Implied volatility calculated from mark price.
      type: string
      format: decimal
    ImpliedVolatilityBid:
      description: Implied volatility calculated from bid price.
      type: string
      format: decimal
    DefiBalanceSheetDebtToAssetRatio:
      description: DeFi balance sheet debt to asset.
      type: string
      format: decimal
    IndexWeight:
      description: The weight of the constituent.
      type: string
      format: decimal
    LiquidationsCoinMetricsId:
      description: ID of a liquidation (unique per exchange market). We are using exchange reported value if exchange reports a unique numeric liquidation id. If exchange reports liquidation id as a string we convert to numeric using Bijective mapping from exchange reported liquidation id's string. If exchange doesn't report unique ID we transform it using exchange reported data to form a unique value per market.
      type: string
    MempoolFeerateBandFeerate:
      description: Rounded feerate value used to aggregate the transactions into the current mempool feerate band. Unit is sat/vB.
      type: string
      format: decimal
    MempoolFeerateBandPhysicalSize:
      description: Physical sizes summed up for all the transactions included into the current mempool feerate band.
      type: string
      format: decimal
    DefiBalanceSheet:
      properties:
        defi_protocol:
          $ref: '#/components/schemas/DefiProtocol'
        block_height:
          $ref: '#/components/schemas/DefiBalanceSheetBlockHeight'
        time:
          $ref: '#/components/schemas/DefiBalanceSheetTime'
        assets_total_usd:
          $ref: '#/components/schemas/DefiBalanceSheetAssetsTotalUsd'
        assets_total_count:
          $ref: '#/components/schemas/DefiBalanceSheetAssetsTotalCount'
        liabilities_total_usd:
          $ref: '#/components/schemas/DefiBalanceSheetLiabilitiesTotalUsd'
        liabilities_total_count:
          $ref: '#/components/schemas/DefiBalanceSheetLiabilitiesTotalCount'
        loans_lent_total_usd:
          $ref: '#/components/schemas/DefiBalanceSheetLoansLentTotalUsd'
        tvl_total_usd:
          $ref: '#/components/schemas/DefiBalanceSheetTvlTotalUsd'
        net_working_capital_usd:
          $ref: '#/components/schemas/DefiBalanceSheetNetWorkingCapitalUsd'
        protocol_utilization_ratio:
          $ref: '#/components/schemas/DefiBalanceSheetProtocolUtilizationRatio'
        liquid_supply_ratio:
          $ref: '#/components/schemas/DefiBalanceSheetLiquidSupplyRatio'
        current_ratio:
          $ref: '#/components/schemas/DefiBalanceSheetCurrentRatio'
        debt_to_assets_ratio:
          $ref: '#/components/schemas/DefiBalanceSheetDebtToAssetRatio'
        assets:
          $ref: '#/components/schemas/DefiBalanceSheetAssets'
        liabilities:
          $ref: '#/components/schemas/DefiBalanceSheetLiabilities'
      required:
      - defi_protocol
      - block_height
      - time
      - assets_total_usd
      - assets_total_count
      - liabilities_total_usd
      - liabilities_total_count
      - loans_lent_total_usd
      - tvl_total_usd
      - net_working_capital_usd
      - assets
      - liabilities
    DefiBalanceSheetItemBalanceUnits:
      description: Balance units value.
      type: string
      format: decimal
    QuoteAskPrice:
      description: The limit price of the top ask on the order book. If no asks in the order book, the ask price is skipped.
      type: string
      format: decimal
    PoolCount:
      description: The count of unique pools mining on the tip.
      type: string
      format: int64
    ProtocolMetricsResponse:
      description: Time series of protocol metrics.
      properties:
        data:
          items:
            $ref: '#/components/schemas/ProtocolMetricValue'
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    SettlementPriceEstimated:
      description: The estimated price of the underlying asset.
      type: string
      format: decimal
    DefiProtocol:
      description: DeFi protocol name (e.g. `aave_v2_eth` or `uniswap_v3_eth`).
      type: string
    VerificationIndexLevelValue:
      description: The verification value of the index.
      type: string
      format: decimal
    AssetAlerts:
      type: array
      items:
        $ref: '#/components/schemas/AssetAlert'
    AssetAlertsResponse:
      description: Asset alerts response.
      properties:
        heartbeats:
          $ref: '#/components/schemas/AssetAlertHeartbeats'
        data:
          $ref: '#/components/schemas/AssetAlerts'
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    TradeSender:
      description: Swap caller. Available for DeFi markets only.
      type: string
    ExchangeMetricsResponse:
      description: Time series of Exchange metrics.
      properties:
        data:
          items:
            type: object
            properties:
              exchange:
                $ref: '#/components/schemas/Exchange'
              time:
                $ref: '#/components/schemas/Time'
            additionalProperties:
              nullable: true
              description: Metric value. `null` value is only possible when multiple metrics are requested, but not all are calculated for now. Absent metric field is only possible when multiple metrics are requested, but not all are supported for requested exchanges.
              type: string
            required:
            - exchange
            - time
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    AssetAlertHeartbeat:
      properties:
        asset:
          $ref: '#/components/schemas/Asset'
        time:
          $ref: '#/components/schemas/Time'
        block_height:
          $ref: '#/components/schemas/BlockchainBlockHeight'
        alert:
          $ref: '#/components/schemas/AssetAlertName'
      required:
      - asset
      - time
      - alert
    DefiBalanceSheetTvlTotalUsd:
      description: Total USD value of TVL in the DeFi balance sheet.
      type: string
      format: decimal
    ReorgDepth:
      description: A number of consecutive blocks that were disconnected from the common ancestor block of the previous and current longest active chains during the chain reorganization.
      type: string
      format: int64
    IndexConstituents:
      description: Information about index constituents.
      properties:
        index:
          $ref: '#/components/schemas/Index'
        time:
          $ref: '#/components/schemas/Time'
        constituents:
          items:
            properties:
              asset:
                $ref: '#/components/schemas/AssetId'
              weight:
                $ref: '#/components/schemas/IndexWeight'
              price:
                $ref: '#/components/schemas/IndexConstituentPrice'
              quantity:
                $ref: '#/components/schemas/IndexConstituentQuantity'
              weight_basis_value:
                $ref: '#/components/schemas/IndexConstituentWeightBasisValue'
            type: object
          type: array
      type: object
      required:
      - index
      - time
      - constituents
    OrderBookAndQuoteCoinMetricsId:
      description: ID of an order book or quote. It can be generated by Coin Metrics or provided by an exchange. If it is generated by Coin Metrics it is unique. If it is generated by exchange we can't guarantee its uniqueness.
      type: string
    DefiBalanceSheetLiabilitiesTotalCount:
      description: Total count of all liabilities in the DeFi balance sheet.
      type: string
      format: int64
    QuoteAskSize:
      description: The size of the top ask on the order book. If no asks in the order book, the ask size is skipped.
      type: string
      format: decimal
    GreeksDelta:
      description: The first derivative of the option's price to the underlying asset's price.
      type: string
      format: decimal
    DefiBalanceSheetBlockHeight:
      description: The block height at which this DeFi balance sheet is calculated.
      type: string
      format: int64
    CandlePriceOpen:
      description: The opening price of the candle.
      type: string
      format: decimal
    MempoolFeerate:
      properties:
        asset:
          $ref: '#/components/schemas/Asset'
        time:
          $ref: '#/components/schemas/Time'
        feerates:
          $ref: '#/components/schemas/MempoolFeerateBands'
      required:
      - asset
      - time
      - feerates
    DefiBalanceSheetLoansLentTotalUsd:
      description: Total USD value of loans lent in the DeFi balance sheet.
      type: string
      format: decimal
    IndexConstituentQuantity:
      description: The quantity of the constituent.
      type: string
      format: decimal
    Asset:
      description: Name of the asset.
      type: string
    DefiBalanceSheetItemBalanceUsd:
      description: Balance USD value.
      type: string
      format: decimal
    AssetAlert:
      properties:
        asset:
          $ref: '#/components/schemas/Asset'
        time:
          $ref: '#/components/schemas/Time'
        block_height:
          $ref: '#/components/schemas/BlockchainBlockHeight'
        alert:
          $ref: '#/components/schemas/AssetAlertName'
        value:
          $ref: '#/components/schemas/AssetAlertValue'
        threshold:
          $ref: '#/components/schemas/AssetAlertThreshold'
        status:
          $ref: '#/components/schemas/AssetAlertStatus'
      required:
      - asset
      - time
      - alert
      - status
    MarketFundingRatesDataArray:
      description: Time series of market funding rates.
      items:
        $ref: '#/components/schemas/MarketFundingRate'
      type: array
    DefiBalanceSheets:
      type: array
      items:
        $ref: '#/components/schemas/DefiBalanceSheet'
    MarketLiquidation:
      description: Information about liquidation.
      properties:
        market:
          $ref: '#/components/schemas/MarketId'
        time:
          $ref: '#/components/schemas/Time'
        coin_metrics_id:
          $ref: '#/components/schemas/LiquidationsCoinMetricsId'
        amount:
          $ref: '#/components/schemas/LiquidationAmount'
        price:
          $ref: '#/components/schemas/LiquidationPrice'
        side:
          $ref: '#/components/schemas/LiquidationSide'
        type:
          $ref: '#/components/schemas/LiquidationType'
        database_time:
          $ref: '#/components/schemas/DatabaseTime'
      required:
      - market
      - time
      - coin_metrics_id
      - amount
      - price
      - type
      - database_time
      type: object
    Verification:
      description: Information about verification.
      properties:
        timestamp:
          $ref: '#/components/schemas/VerificationTime'
        level:
          $ref: '#/components/schemas/VerificationIndexLevelValue'
        signature:
          $ref: '#/components/schemas/Signature'
      type: object
      required:
      - signature
    PairCandlesResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/PairCandle'
          type: array
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    AssetId:
      description: Unique name of the asset.
      type: string
    TradeMarkPrice:
      description: The price representing the futures' or option's price calculated by the exchange for risk management purposes.
      type: string
      format: decimal
    MempoolFeeratesResponse:
      description: Mempool feerates response.
      properties:
        data:
          $ref: '#/components/schemas/MempoolFeerates'
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    Pair:
      description: Pair string representation as `<base>-<quote>`.
      type: string
    GreeksTheta:
      description: The first derivative of the option's price to the passage of time.
      type: string
      format: decimal
    Reorg:
      description: Indicates if the last appended block triggered the chain reorganization.
      type: string
    MarketOrderBook:
      description: Information about order book.
      properties:
        market:
          $ref: '#/components/schemas/MarketId'
        time:
          $ref: '#/components/schemas/Time'
        coin_metrics_id:
          $ref: '#/components/schemas/OrderBookAndQuoteCoinMetricsId'
        asks:
          $ref: '#/components/schemas/OrderBookAsks'
        bids:
          $ref: '#/components/schemas/OrderBookBids'
        database_time:
          $ref: '#/components/schemas/DatabaseTime'
        collect_time:
          $ref: '#/components/schemas/OrderBookCollectTime'
      type: object
      required:
      - market
      - time
      - coin_metrics_id
      - asks
      - bids
      - database_time
    GreeksGamma:
      description: The second derivative of the option's price to the underlying asset's price.
      type: string
      format: decimal
    TradeImpliedVolatility:
      description: Implied volatility calculated from the trade price.
      type: string
      format: decimal
    MarketOpenInterest:
      description: Information about open interest.
      properties:
        market:
          $ref: '#/components/schemas/MarketId'
        time:
          $ref: '#/components/schemas/Time'
        contract_count:
          $ref: '#/components/schemas/ContractCount'
        value_usd:
          deprecated: true
          $ref: '#/components/schemas/ContractValueUSD'
        database_time:
          $ref: '#/components/schemas/DatabaseTime'
        exchange_time:
          $ref: '#/components/schemas/OpenInterestExchangeTime'
      required:
      - market
      - time
      - contract_count
      - value_usd
      - database_time
      type: object
    MarketLiquidationsResponse:
      properties:
        data:
          $ref: '#/components/schemas/MarketLiquidationsDataArray'
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    MarketCandlesResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/MarketCandle'
          type: array
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    AssetAlertThreshold:
      description: Asset alert's Key Risk Indicator threshold value. Omitted if the corresponding alert rule consists of multiple conditions.
      type: string
    InstitutionMetricsResponse:
      description: Time series of institution metrics.
      properties:
        data:
          items:
            type: object
            properties:
              institution:
                $ref: '#/components/schemas/Institution'
              time:
                $ref: '#/components/schemas/Time'
            additionalProperties:
              nullable: true
              description: Metric value. `null` value is only possible when multiple metrics are requested, but not all are calculated for now. Absent metric field is only possible when multiple metrics are requested, but not all are supported for requested institutions.
              type: string
            required:
            - institution
            - time
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    DefiBalanceSheetItemShare:
      description: The percentage that this item represents relative to the total value.
      type: string
      format: decimal
    DefiBalanceSheetAssetsTotalCount:
      description: Total count of all assets in the DeFi balance sheet.
      type: string
      format: int64
    AssetAlertName:
      description: Asset alert name.
      type: string
    AssetChainsResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/AssetChains'
          type: array
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    CandleTradesCount:
      description: The number of trades used for candle calculation.
      type: string
      format: int64
    AssetAlertStatus:
      description: Becomes 'active' if there was a breach of the Key Risk Indicator, otherwise stays 'inactive'.
      type: string
    CandleUsdVolume:
      description: The volume of the candle in USD.
      type: string
      format: decimal
    FundingRatePredictedEstimatedRate:
      description: Estimated rate of a predicted funding rate.
      type: string
      format: decimal
    MiningPoolTipsSummary:
      description: Information about the mining pool tips summary.
      properties:
        asset:
          $ref: '#/components/schemas/Asset'
        time:
          $ref: '#/components/schemas/Time'
        tips_count:
          $ref: '#/components/schemas/TipsCount'
        block_hashes_at_tip:
          $ref: '#/components/schemas/BlockHashesAtTip'
        tips:
          description: All last tips that we saw in all mining pools that were active during the past hour.
          items:
            properties:
              last_time:
                $ref: '#/components/schemas/Time'
              height:
                $ref: '#/components/schemas/BlockchainBlockHeight'
              hash:
                $ref: '#/components/schemas/BlockchainBlockHash'
              pool_count:
                $ref: '#/components/schemas/PoolCount'
            required:
            - last_time
            - height
            - hash
            - pool_count
            type: object
          type: array
      type: object
      required:
      - asset
      - time
      - tips_count
      - block_hashes_at_tip
      - tips
    Signature:
      description: The signature information.
      type: string
    AssetChain:
      description: Contains the chain fragments starting from the block which is a common ancestor for other blocks. If there is a single active chain - only the chain tip is included.<br/>
      items:
        $ref: '#/components/schemas/AssetChainBlock'
      type: array
    TradeIndexPrice:
      description: The price index is an aggregate price derived from the major exchanges to be representative of the underlying asset's market consensus price.
      type: string
      format: decimal
    TradeAmount:
      description: The amount of the base asset traded.
      type: string
      format: decimal
    DefiBalanceSheetLiabilityItem:
      description: DeFi balance sheet liability item.
      properties:
        asset:
          $ref: '#/components/schemas/Asset'
        total_units:
          $ref: '#/components/schemas/DefiBalanceSheetItemBalanceUnits'
        total_usd:
          $ref: '#/components/schemas/DefiBalanceSheetItemBalanceUsd'
        total_share:
          $ref: '#/components/schemas/DefiBalanceSheetItemShare'
      required:
      - asset
      - total_units
    MarketOpenInterestResponse:
      properties:
        data:
          $ref: '#/components/schemas/MarketOpenInterestDataArray'
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    QuoteBidPrice:
      description: The limit price of the top bid on the order book. If no bids in the order book, the bid price is skipped.
      type: string
      format: decimal
    IndexConstituentPrice:
      description: The price of the constituent.
      type: string
      format: decimal
    TradePrice:
      description: The price of the base asset quoted in the quote asset that the trade was executed at.
      type: string
      format: decimal
    DatabaseTime:
      description: A time when we saved the data in the database. The time is in ISO 8601 date-time format. Always with nanoseconds precision.
      type: string
      format: date-time
    MarketMetricsResponse:
      description: Time series of market metrics.
      properties:
        data:
          items:
            type: object
            properties:
              market:
                $ref: '#/components/schemas/Market'
              time:
                $ref: '#/components/schemas/Time'
            additionalProperties:
              nullable: true
              description: Metric value. `null` value is only possible when multiple metrics are requested, but not all are calculated for now. Absent metric field is only possible when multiple metrics are requested, but not all are supported for requested market.
              type: string
            required:
            - market
            - time
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    LiquidationSide:
      description: The market order side. "buy" means that an ask was removed from the book by an incoming buy order, "sell" means that a bid was removed from the book by an incoming sell order.
      type: string
    TradeBlockHash:
      description: Swap block hash. Available for DeFi markets only.
      type: string
    IndexId:
      description: Name of the index.
      type: string
    DefiBalanceSheetTime:
      description: The time near or equal to the block creation time this DeFi balance sheet is calculated at. The time in ISO 8601 date-time format. Always with nanoseconds precision.
      type: string
      format: date-time
    ImpliedVolatilityTrade:
      description: Implied volatility calculated from last trade price.
      type: string
      format: decimal
    Exchange:
      description: Name of the exchange.
      type: string
    LiquidationAmount:
      description: The amount of the base asset liquidated.
      type: string
      format: decimal
    IndexConstituentsResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/IndexConstituents'
          type: array
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    ExchangeAssetMetricsResponse:
      description: Time series of exchange metrics.
      properties:
        data:
          items:
            type: object
            properties:
              exchange_asset:
                $ref: '#/components/schemas/ExchangeAsset'
              time:
                $ref: '#/components/schemas/Time'
            additionalProperties:
              nullable: true
              description: Metric value. `null` value is only possible when multiple metrics are requested, but not all are calculated for now. Absent metric field is only possible when multiple metrics are requested, but not all are supported for requested exchange-asset pairs.
              type: string
            required:
            - exchange_asset
            - time
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    DefiBalanceSheetLiabilities:
      description: DeFi balance sheet liabilities.
      type: array
      items:
        $ref: '#/components/schemas/DefiBalanceSheetLiabilityItem'
    MarketGreeks:
      description: Information about market greeks.
      properties:
        market:
          $ref: '#/components/schemas/MarketId'
        time:
          $ref: '#/components/schemas/Time'
        vega:
          $ref: '#/components/schemas/GreeksVega'
        theta:
          $ref: '#/components/schemas/GreeksTheta'
        rho:
          $ref: '#/components/schemas/GreeksRho'
        delta:
          $ref: '#/components/schemas/GreeksDelta'
        gamma:
          $ref: '#/components/schemas/GreeksGamma'
        database_time:
          $ref: '#/components/schemas/DatabaseTime'
        exchange_time:
          $ref: '#/components/schemas/OptionTickerExchangeTime'
      type: object
      required:
      - market
      - time
      - database_time
    Institution:
      description: Institution name.
      type: string
    DefiBalanceSheetProtocolUtilizationRatio:
      description: DeFi balance sheet protocol utilization ratio.
      type: string
      format: decimal
    AssetAlertHeartbeats:
      type: array
      items:
        $ref: '#/components/schemas/AssetAlertHeartbeat'
    AssetChainBlock:
      properties:
        time:
          $ref: '#/components/schemas/Time'
        hash:
          $ref: '#/components/schemas/BlockchainBlockHash'
        height:
          $ref: '#/components/schemas/BlockchainBlockHeight'
      required:
      - time
      - hash
      - height
    MempoolFeerateBandConsensusSize:
      description: Consensus sizes summed up for all the transactions included into the current mempool feerate band. vSizes sum can be derived as 'vSize = consensusSize / 4'.
      type: string
      format: decimal
    MarketContractPricesResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/MarketContractPrices'
          type: array
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    VerificationTime:
      description: The verification time of the index.
      type: string
      format: date-time
    MarketQuotesResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/MarketQuote'
          type: array
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    DefiBalanceSheetsResponse:
      description: DeFi balance sheets response.
      properties:
        data:
          $ref: '#/components/schemas/DefiBalanceSheets'
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    MarketFundingRatePredicted:
      description: Information about predicted funding rate.
      properties:
        market:
          $ref: '#/components/schemas/MarketId'
        time:
          $ref: '#/components/schemas/Time'
        rate_predicted:
          $ref: '#/components/schemas/FundingRatePredictedEstimatedRate'
        rate_time:
          $ref: '#/components/schemas/Time'
        database_time:
          $ref: '#/components/schemas/DatabaseTime'
      required:
      - market
      - time
      - rate_predicted
      - database_time
      type: object
    IndexPrice:
      description: The price index is an aggregate price derived from the major exchanges to be representative of the underlying asset's market consensus price.
      type: string
      format: decimal
    MarketTrade:
      description: Information about trade.
      properties:
        market:
          $ref: '#/components/schemas/MarketId'
        time:
          $ref: '#/components/schemas/Time'
        coin_metrics_id:
          $ref: '#/components/schemas/TradesCoinMetricsId'
        amount:
          $ref: '#/components/schemas/TradeAmount'
        price:
          $ref: '#/components/schemas/TradePrice'
        side:
          $ref: '#/components/schemas/TradeSide'
        block_hash:
          $ref: '#/components/schemas/TradeBlockHash'
        block_height:
          $ref: '#/components/schemas/TradeBlockHeight'
        txid:
          $ref: '#/components/schemas/TradeTransactionId'
        initiator:
          $ref: '#/components/schemas/TradeInitiator'
        sender:
          $ref: '#/components/schemas/TradeSender'
        beneficiary:
          $ref: '#/components/schemas/TradeBeneficiary'
        database_time:
          $ref: '#/components/schemas/DatabaseTime'
        mark_price:
          $ref: '#/components/schemas/TradeMarkPrice'
        index_price:
          $ref: '#/components/schemas/TradeIndexPrice'
        iv_trade:
          $ref: '#/components/schemas/TradeImpliedVolatility'
        liquidation:
          $ref: '#/components/schemas/TradeLiquidation'
      required:
      - market
      - time
      - coin_metrics_id
      - amount
      - price
      - database_time
      type: object
    CandlePriceHigh:
      description: The high price of the candle.
      type: string
      format: decimal
    TradeBeneficiary:
      description: Swap output receiver. Available for DeFi markets only.
      type: string
    MempoolFeerateBand:
      properties:
        feerate:
          $ref: '#/components/schemas/MempoolFeerateBandFeerate'
        count:
          $ref: '#/components/schemas/MempoolFeerateBandCount'
        consensus_size:
          $ref: '#/components/schemas/MempoolFeerateBandConsensusSize'
        physical_size:
          $ref: '#/components/schemas/MempoolFeerateBandPhysicalSize'
        fees:
          $ref: '#/components/schemas/MempoolFeerateBandFees'
      required:
      - feerate
      - count
      - consensus_size
      - fees
    ExchangePair:
      description: Unique combination of the exchange and pair.
      type: string
    CandleVolume:
      description: The volume of the candle in units of the base asset.
      type: string
      format: decimal
    MiningPoolTipsSummaryResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/MiningPoolTipsSummary'
          type: array
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    IndexLevelValue:
      description: The value of the index.
      type: string
      format: decimal
    IndexCandle:
      description: Information about index candle.
      properties:
        index:
          $ref: '#/components/schemas/IndexId'
        time:
          $ref: '#/components/schemas/Time'
        price_open:
          $ref: '#/components/schemas/CandlePriceOpen'
        price_close:
          $ref: '#/components/schemas/CandlePriceClose'
        price_high:
          $ref: '#/components/schemas/CandlePriceHigh'
        price_low:
          $ref: '#/components/schemas/CandlePriceLow'
        candle_trades_count:
          $ref: '#/components/schemas/CandleTradesCount'
      type: object
      required:
      - index
      - time
      - price_open
      - price_close
      - price_high
      - price_low
      - candle_trades_count
    LiquidationPrice:
      description: The price of the base asset quoted in the quote asset that the liquidation was executed at.
      type: string
      format: decimal
    MempoolFeerates:
      type: array
      items:
        $ref: '#/components/schemas/MempoolFeerate'
    ImpliedVolatilityAsk:
      description: Implied volatility calculated from ask price.
      type: string
      format: decimal
    TipsCount:
      description: The count of unique elements in the `tips` array.
      type: string
      format: int64
    MarketFundingRatesResponse:
      properties:
        data:
          $ref: '#/components/schemas/MarketFundingRatesDataArray'
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    DefiBalanceSheetAssets:
      description: DeFi balance sheet assets.
      type: array
      items:
        $ref: '#/components/schemas/DefiBalanceSheetAssetItem'
    MempoolFeerateBands:
      type: array
      items:
        $ref: '#/components/schemas/MempoolFeerateBand'
    FundingRateRate:
      description: Rate of a funding rate.
      type: string
      format: decimal
    FundingRateInterval:
      description: Interval of a funding rate for a given market.
      type: string
    GreeksVega:
      description: The first derivative of the option's price to the volatility of the underlying asset's price.
      type: string
      format: decimal
    TradeInitiator:
      description: Swap transaction initiator. Available for DeFi markets only.
      type: string
    TradeTransactionId:
      description: Swap transaction ID. Available for DeFi markets only.
      type: string
    LiquidationType:
      description: The liquidation type. "trade" means that liquidation was executed, "order" means that the order was placed for the liquidation at the timestamp of the data entry but it wasn't necessarily executed yet.
      type: string
    MarketTradesDataArray:
      description: Time series of market trades.
      items:
        $ref: '#/components/schemas/MarketTrade'
      type: array
    MarketFundingRatesPredictedResponse:
      properties:
        data:
          $ref: '#/components/schemas/MarketFundingRatesPredictedDataArray'
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    Time:
      description: The time in ISO 8601 date-time format. Always with nanoseconds precision.
      type: string
      format: date-time
    CandlePriceClose:
      description: The closing price of the candle.
      type: string
      format: decimal
    BookEntry:
      properties:
        price:
          $ref: '#/components/schemas/OrderBookPrice'
        size:
          $ref: '#/components/schemas/OrderBookSize'
      required:
      - price
      - size
      type: object
    ContractValueUSD:
      deprecated: true
      description: 'Deprecated. Contract value in USD. This field was previously calculated using hardcoded logic that no longer reflects current contract specifications across all exchanges. Please use the new metrics available via `/timeseries/market-metrics` endpoint: `open_interest_reported_future_usd` for futures markets and `open_interest_reported_option_notional_usd` for options markets.'
      type: string
      format: decimal
    BlockHashesAtTip:
      description: The count of unique hashes at the chain tip.
      type: string
      format: int64
    ErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/ErrorObject'
      required:
      - error
      type: object
    DefiBalanceSheetAssetsTotalUsd:
      description: Total USD value of all assets in the DeFi balance sheet.
      type: string
      format: decimal
    CandlePriceLow:
      description: The low price of the candle.
      type: string
      format: decimal
    MarketOrderbookResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/MarketOrderBook'
          type: array
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    TradeLiquidation:
      description: Indicates whether the maker side, taker side, or both sides of the trade is under liquidation.
      type: string
    MarketFundingRate:
      description: Information about funding rate.
      properties:
        market:
          $ref: '#/components/schemas/MarketId'
        time:
          $ref: '#/components/schemas/Time'
        rate:
          $ref: '#/components/schemas/FundingRateRate'
        period:
          $ref: '#/components/schemas/FundingRatePeriod'
        interval:
          $ref: '#/components/schemas/FundingRateInterval'
        database_time:
          $ref: '#/components/schemas/DatabaseTime'
      required:
      - market
      - time
      - database_time
      type: object
    OrderBookSize:
      description: The size of the limit order on the order book in units of the base asset.
      type: string
      format: decimal
    CandleVwap:
      description: The volume-weighted average price of the candle.
      type: string
      format: decimal
    QuoteBidSize:
      description: The size of the top bid on the order book. If no bids in the order book, the bid size is skipped.
      type: string
      format: decimal
    PairCandle:
      description: Information about pair candle.
      properties:
        pair:
          $ref: '#/components/schemas/PairId'
        time:
          $ref: '#/components/schemas/Time'
        price_open:
          $ref: '#/components/schemas/CandlePriceOpen'
        price_close:
          $ref: '#/components/schemas/CandlePriceClose'
        price_high:
          $ref: '#/components/schemas/CandlePriceHigh'
        price_low:
          $ref: '#/components/schemas/CandlePriceLow'
      type: object
      required:
      - pair
      - time
      - price_open
      - price_close
      - price_high
      - price_low
      - vwap
      - volume
      - candle_usd_volume
      - candle_trades_count
    NextPageToken:
      description: Token of the next page results for a given request.
      type: string
    MempoolFeerateBandCount:
      description: Amount of transactions included into the current mempool feerate band.
      type: string
      format: int64
    OrderBookAsks:
      description: The ask orders on the order book.
      items:
        $ref: '#/components/schemas/BookEntry'
      type: array
    ContractCount:
      description: Number of contracts.
      type: string
      format: int64
    IndexConstituentWeightBasisValue:
      description: The weight basis value of the constituent.
      type: string
      format: decimal
    IndexCandlesResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/IndexCandle'
          type: array
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    OptionTickerExchangeTime:
      description: Time corresponding to option ticker data point, according to the exchange. Can be NULL, if exchange doesn't support it.
      type: string
      format: date-time
    OrderBookCollectTime:
      description: Time of when the order book was received from the exchange.
      type: string
      format: date-time
    MarketContractPrices:
      description: Information about market contract prices.
      properties:
        market:
          $ref: '#/components/schemas/MarketId'
        time:
          $ref: '#/components/schemas/Time'
        mark_price:
          $ref: '#/components/schemas/MarkPrice'
        index_price:
          $ref: '#/components/schemas/IndexPrice'
        settlement_price_estimated:
          $ref: '#/components/schemas/SettlementPriceEstimated'
        database_time:
          $ref: '#/components/schemas/DatabaseTime'
        exchange_time:
          $ref: '#/components/schemas/OptionTickerExchangeTime'
      type: object
      required:
      - market
      - time
      - database_time
    PairId:
      description: Unique name of the pair.
      type: string
    TradeBlockHeight:
      description: Swap block height. Available for DeFi markets only.
      type: string
      format: int64
    MarketLiquidationsDataArray:
      description: Time series of market liquidations.
      items:
        $ref: '#/components/schemas/MarketLiquidation'
      type: array
    BlockchainBlockHeight:
      description: Height of the block.
      type: string
      format: int64
    DefiBalanceSheetNetWorkingCapitalUsd:
      description: DeFi balance sheet net working capital USD value.
      type: string
      format: decimal
    MarketImpliedVolatilityResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/MarketImpliedVolatility'
          type: array
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    AssetMetricsResponse:
      description: Time series of asset metrics.
      properties:
        data:
          items:
            type: object
            properties:
              asset:
                $ref: '#/components/schemas/Asset'
              time:
                $ref: '#/components/schemas/Time'
            additionalProperties:
              nullable: true
              description: Metric value. `null` value is only possible when multiple metrics are requested, but not all are calculated for now. Absent metric field is only possible when multiple metrics are requested, but not all are supported for requested assets.
              type: string
            required:
            - asset
            - time
        next_page_token:
          $ref: '#/components/schemas/NextPageToken'
        next_page_url:
          $ref: '#/components/schemas/NextPageUrl'
      required:
      - data
      type: object
    NextPageUrl:
      description: URL of the next page results for a given request.
      type: string
    OrderBookPrice:
      description: The limit price of the order on the order book.
      type: string
      format: decimal
    AssetChains:
      description: Information about the asset chains.
      properties:
        asset:
          $ref: '#/components/schemas/Asset'
        time:
          $ref: '#/components/schemas/Time'
        chains_count:
          $ref: '#/components/schemas/ChainsCount'
        blocks_count_at_tip:
          $ref: '#/components/schemas/BlocksCountAtTip'
        reorg:
          $ref: '#/components/schemas/Reorg'
        reorg_depth:
          $ref: '#/components/schemas/ReorgDepth'
        chains:
          description: All the chains that were active in the blockchain during the time that's enough to produce the amount of blocks considered as an industry standard number of confirmations.
          items:
            $ref: '#/components/schemas/AssetChain'
          type: array
      type: object
      required:
      - asset
      - time
      - chains_count
      - blocks_count_at_tip
      - chains
    Index:
      description: Name of the index.
      type: string
    BlocksCountAtTip:
      description: Count of the blocks on the maximum chain height.
      type: string
      format: int64
    MarketFundingRatesPredictedDataArray:
      description: Time series of predicted market funding rates.
      items:
        $ref: '#/components/schemas/MarketFundingRatePredicted'
      type: array
    FundingRatePeriod:
      description: Period of a funding rate for a given market.
      type: string
    Market:
      description: Unique name of the market.
      type: string
    MarketCandle:
      description: Information about market candle.
      properties:
        market:
          $ref: '#/components/schemas/MarketId'
        time:
          $ref: '#/components/schemas/Time'
        price_open:
          $ref: '#/components/schemas/CandlePriceOpen'
        price_close:
          $ref: '#/components/schemas/CandlePriceClose'
        price_high:
          $ref: '#/components/schemas/CandlePriceHigh'
        price_low:
          $ref: '#/components/schemas/CandlePriceLow'
        vwap:
          $ref: '#/components/schemas/CandleVwap'
        volume:
          $ref: '#/components/schemas/CandleVolume'
        candle_usd_volume:
          $ref: '#/components/schemas/CandleUsdVolume'
        candle_trades_count:
          $ref: '#/components/schemas/CandleTradesCount'
      type: object
      required:
      - market
      - time
      - price_open
      - price_close
      - price_high
      - price_low
      - vwap
      - volume
      - candle_usd_volume
      - candle_trades_count
    MarketQuote:
      description: Information about market quote.
      properties:
        market:
          $ref: '#/components/schemas/MarketId'
        time:
          $ref: '#/components/schemas/Time'
        coin_metrics_id:
          $ref: '#/components/schemas/OrderBookAndQuoteCoinMetricsId'
        ask_price:
          $ref: '#/components/schemas/QuoteAskPrice'
        ask_size:
          $ref: '#/components/schemas/QuoteAskSize'
        bid_price:
          $ref: '#/components/schemas/QuoteBidPrice'
        bid_size:
          $ref: '#/components/schemas/QuoteBidSize'
      type: object
      required:
      - market
      - time
      - coin_metrics_id
    AssetAlertValue:
      description: Captured value of the alerting metric. Omitted if the ratio-based alert's divisor constituent was equal to zero or if the corresponding alert rule consists of multiple conditions.
      type: string
  responses:
    IndexNotFound:
      content:
        application/json:
          example:
            error:
              type: bad_parameter
              message: Bad parameter 'indexes'. Value 'asdgwav' is not supported.
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Index not found.
    MarketTrades:
      description: Time series of market trades.
      content:
        application/json:
          example:
            data:
            - time: '2015-01-08T20:55:00.028749000Z'
              market: coinbase-btc-usd-spot
              coin_metrics_id: '100'
              amount: '1000.01'
              price: '10.61'
              database_time: '2016-06-08T20:55:00.256754000Z'
              side: buy
            - time: '2021-06-08T20:55:00.758178000Z'
              market: coinbase-btc-usd-spot
              coin_metrics_id: '200000000'
              amount: '1000.01'
              price: '1000000.61'
              database_time: '2021-06-08T20:55:01.053472000Z'
              side: sell
            next_page_token: 0.MjAyMC0wNi0wOFQyMTowMzowNi40OTM1OTZafDk0MjMzMjAz
            next_page_url: https://api.coinmetrics.io/v4/timeseries/market-trades?markets=coinbase-btc-usd-spot&api_key=<your_key>&pretty=true&page_size=2&next_page_token=0.MjAyMC0wNi0wOFQyMTowMzowNi40OTM1OTZafDk0MjMzMjAz
          schema:
            $ref: '#/components/schemas/MarketTradesResponse'
        text/csv:
          example: 'time,market,coin_metrics_id,amount,price,database_time,side,block_hash,block_height,txid,initiator,sender,beneficiary

            2015-01-08T20:55:00.028749000Z,coinbase-btc-usd-spot,100,1000.01,10.61,2016-06-08T20:55:00.256754000Z,buy,,,,,,

            2021-06-08T20:55:00.758178000Z,coinbase-btc-usd-spot,200000000,1000.01,1000000.61,2021-06-08T20:55:01.053472000Z,sell,,,,,,'
          schema:
            $ref: '#/components/schemas/MarketTradesResponse'
    ExchangePairMetrics:
      description: Time series of exchange-pair metrics.
      content:
        application/json:
          example:
            data:
            - exchange_pair: okex-eth-usd
              time: '2025-11-26T00:00:00.000000000Z'
              volatility_implied_call_delta_05_14d_expiration: '0.806213248428136'
              volatility_implied_put_delta_20_30d_expiration: '0.778877191593058'
            - exchange_pair: okex-eth-usd
              time: '2025-11-27T00:00:00.000000000Z'
              volatility_implied_call_delta_05_14d_expiration: '0.797963061181699'
              volatility_implied_put_delta_20_30d_expiration: '0.751840944724143'
            next_page_token: b2tleC1ldGgtdXNk.MjAyNS0xMS0yNlQwMDowMDowMFo
            next_page_url: https://api.coinmetrics.io/v4/timeseries/exchange-pair-metrics?exchange_pairs=*&metrics=volatility_implied_call_delta_05_14d_expiration,volatility_implied_put_delta_20_30d_expiration&page_size=2&pretty=true&api_key=<your_key>&next_page_token=b2tleC1ldGgtdXNk.MjAyNS0xMS0yNlQwMDowMDowMFo
          schema:
            $ref: '#/components/schemas/ExchangePairMetricsResponse'
    ExchangeAssetMetrics:
      description: Time series of exchange-asset metrics.
      content:
        application/json:
          example:
            data:
            - exchange_asset: binance-btc
              time: '2021-10-04T00:00:00.000000000Z'
              open_interest_reported_future_usd: '3469621227.0258'
            - exchange_asset: binance-btc
              time: '2021-10-05T00:00:00.000000000Z'
              open_interest_reported_future_usd: '3562791590.02995'
            - exchange_asset: binance-btc
              time: '2021-10-06T00:00:00.000000000Z'
              open_interest_reported_future_usd: '3970248573.60142'
            - exchange_asset: binance-btc
              time: '2021-10-07T00:00:00.000000000Z'
              open_interest_reported_future_usd: '4110308192.96416'
          schema:
            $ref: '#/components/schemas/ExchangeAssetMetricsResponse'
    MarketContractPrices:
      description: Time series of market contract prices.
      content:
        application/json:
          example:
            data:
            - market: deribit-ETH-25MAR22-1200-P-option
              time: '2021-09-01T13:24:00.000000000Z'
              mark_price: '0.02126'
              index_price: '3529.34'
              database_time: '2021-09-01T13:24:41.266168000Z'
              exchange_time: '2021-09-01T13:24:00.000000000Z'
            next_page_token: 0.MjAyMC0wNi0wOFQyMDo0NTowMFo
            next_page_url: https://api.coinmetrics.io/v4/timeseries/market-contract-prices?markets=deribit-ETH-10SEP21-3200-P-option&api_key=<your_key>&pretty=true&page_size=2&next_page_token=0.MjAyMC0wNi0wOFQyMDo0NTowMFo
          schema:
            $ref: '#/components/schemas/MarketContractPricesResponse'
    PairNotFound:
      content:
        application/json:
          example:
            error:
              type: bad_parameter
              message: Bad parameter 'pairs'. Value 'sdvwbtc' is not supported.
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Pair not found.
    AssetAlerts:
      description: Asset alerts.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AssetAlertsResponse'
          example:
            data:
            - asset: btc
              time: '2021-06-08T11:48:21.000000000Z'
              alert: mempool_count_empty_5m
              value: '0'
              threshold: '0'
              status: active
            - asset: btc
              time: '2021-06-08T12:48:21.000000000Z'
              alert: mempool_vsize_hi
              value: '323'
              threshold: '300'
              status: active
            - asset: btc
              time: '2021-06-08T13:48:21.000000000Z'
              alert: mempool_count_empty_5m
              value: '1'
              threshold: '0'
              status: inactive
            next_page_token: MjAyMS0wNi0wOFQxMDo0MTo1NS4zOTZafEJMZER2Q1JSd3FqSi16dTVSdDVPc1RCYVRBeFJfWG9DN2xsMS0wenM5Tm8
            next_page_url: https://api.coinmetrics.io/v4/timeseries/asset-alerts?api_key=<your_key>&assets=btc&alerts=mempool_vsize_hi,mempool_count_empty_5m&pretty=true&page_size=1&paging_from=start&next_page_token=MjAyMS0wNi0wOFQxMDo0MTo1NS4zOTZafEJMZER2Q1JSd3FqSi16dTVSdDVPc1RCYVRBeFJfWG9DN2xsMS0wenM5Tm8
    MempoolFeerates:
      description: Mempool feerates.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MempoolFeeratesResponse'
          example:
            data:
            - asset: btc
              time: '2021-06-08T11:48:21.000000000Z'
              feerates:
              - feerate: '1'
                count: '123'
                consensus_size: '512'
                physical_size: '128'
                fees: '0.09'
              - feerate: '3'
                count: '12'
                consensus_size: '2048'
                physical_size: '1152'
                fees: '0.003'
            next_page_token: MjAyMS0wNi0wOFQxMDo0MTo1NS4zOTZafEJMZER2Q1JSd3FqSi16dTVSdDVPc1RCYVRBeFJfWG9DN2xsMS0wenM5Tm8
            next_page_url: https://api.coinmetrics.io/v4/timeseries/mempool-feerates?api_key=<your_key>&assets=btc&pretty=true&page_size=1&paging_from=start&next_page_token=MjAyMS0wNi0wOFQxMDo0MTo1NS4zOTZafEJMZER2Q1JSd3FqSi16dTVSdDVPc1RCYVRBeFJfWG9DN2xsMS0wenM5Tm8
    ExchangeMetrics:
      description: Time series of exchange metrics.
      content:
        application/json:
          example:
            data:
            - exchange: binance
              time: '2022-01-01T00:00:00.000000000Z'
              volume_reported_spot_usd_1d: '8988114373.91716'
            - exchange: binance
              time: '2022-01-02T00:00:00.000000000Z'
              volume_reported_spot_usd_1d: '9686610104.12659'
            - exchange: binance
              time: '2022-01-03T00:00:00.000000000Z'
              volume_reported_spot_usd_1d: '13513437237.6032'
            - exchange: binance
              time: '2022-01-04T00:00:00.000000000Z'
              volume_reported_spot_usd_1d: '15006844836.1782'
          schema:
            $ref: '#/components/schemas/ExchangeMetricsResponse'
    PairCandles:
      description: Time series of pair candles.
      content:
        application/json:
          example:
            data:
            - pair: btc-usd
              time: '2022-06-27T00:00:00.000000000Z'
              price_open: '21027.92'
              price_close: '20722.93'
              price_high: '21510.66'
              price_low: '20505.5'
            - pair: btc-usd
              time: '2022-06-28T00:00:00.000000000Z'
              price_open: '20722.93'
              price_close: '20252.89'
              price_high: '21185.14'
              price_low: '20177.31'
          schema:
            $ref: '#/components/schemas/PairCandlesResponse'
    IndexConstituents:
      description: Time series of index constituents.
      content:
        application/json:
          example:
            data:
            - time: '2020-05-01T22:00:00.000000000Z'
              index: CMBI10
              constituents:
              - asset: bch
                weight: '0.01887429752681492'
              - asset: bsv
                weight: '0.01343767932475944'
              - asset: btc
                weight: '0.747355794635124'
              - asset: etc
                weight: '0.004565578678797349'
              - asset: eth
                weight: '0.1351998514006912'
              - asset: ltc
                weight: '0.01756776057810796'
              - asset: xlm
                weight: '0.008757017272583251'
              - asset: xmr
                weight: '0.006442672327610681'
              - asset: xrp
                weight: '0.03769069726575187'
              - asset: xtz
                weight: '0.01010865098975933'
            next_page_token: 0.MjAyMC0wNS0wMVQyMjowMDowMFo
            next_page_url: https://api.coinmetrics.io/v4/timeseries/index-constituents?indexes=CMBI10&api_key=<your_key>&pretty=true&page_size=1&next_page_token=0.MjAyMC0wNS0wMVQyMjowMDowMFo
          schema:
            $ref: '#/components/schemas/IndexConstituentsResponse'
    MarketGreeks:
      description: Time series of market greeks.
      content:
        application/json:
          example:
            data:
            - market: deribit-ETH-25MAR22-1200-P-option
              time: '2021-09-01T13:24:00.000000000Z'
              database_time: '2021-09-01T13:24:41.266168000Z'
              exchange_time: '2021-09-01T13:24:00.000000000Z'
              vega: '2.47772'
              theta: '-0.70691'
              rho: '-1.31245'
              delta: '-0.04137'
              gamma: '0.00003'
            next_page_token: 0.MjAyMC0wNi0wOFQyMDo0NTowMFo
            next_page_url: https://api.coinmetrics.io/v4/timeseries/market-greeks?markets=deribit-ETH-10SEP21-3200-P-option&api_key=<your_key>&pretty=true&page_size=2&next_page_token=0.MjAyMC0wNi0wOFQyMDo0NTowMFo
          schema:
            $ref: '#/components/schemas/MarketGreeksResponse'
    UriTooLong:
      description: Provided URI is too long. It must not be greater than 10000 symbols.
    MarketQuotes:
      description: Time series of market quotes.
      content:
        application/json:
          example:
            data:
            - time: '2020-06-08T21:14:48.215145000Z'
              market: coinbase-btc-usd-spot
              coin_metrics_id: 1591479594286046-27326992
              ask_price: '9685.02'
              ask_size: '0.04340557'
              bid_price: '9685.01'
              bid_size: '0.00484254'
            next_page_token: 0.MjAyMC0wNi0wOFQyMToxNDo0OC4yMTUxNDVafDE1OTE0Nzk1OTQyODYwNDY
            next_page_url: https://api.coinmetrics.io/v4/timeseries/market-quotes?markets=coinbase-btc-usd-spot&api_key=<your_key>&pretty=true&page_size=1&next_page_token=0.MjAyMC0wNi0wOFQyMToxNDo0OC4yMTUxNDVafDE1OTE0Nzk1OTQyODYwNDY
          schema:
            $ref: '#/components/schemas/MarketQuotesResponse'
    MarketLiquidations:
      description: Time series of market liquidations.
      content:
        application/json:
          example:
            data:
            - market: binance-BTCUSDT-future
              time: '2020-10-10T15:44:42.105000000Z'
              coin_metrics_id: '1602344682105000000'
              amount: '0.045'
              price: '11380.39'
              type: trade
              database_time: '2020-10-10T15:44:45.109122000Z'
              side: buy
            - market: binance-BTCUSDT-future
              time: '2020-10-10T15:45:37.067000000Z'
              coin_metrics_id: '1602344737067000000'
              amount: '0.004'
              price: '11386'
              type: trade
              database_time: '2020-10-10T15:45:39.329348000Z'
              side: buy
          schema:
            $ref: '#/components/schemas/MarketLiquidationsResponse'
    MarketNotFound:
      content:
        application/json:
          example:
            error:
              type: bad_parameter
              message: Bad parameter 'markets'. Market 'sdvwbtc-as-asd-spot' is not supported.
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Market not found.
    AssetMetrics:
      description: Time series of metrics for an asset.
      content:
        application/json:
          examples:
            daily_metrics:
              summary: Example of a message with daily metrics.
              value:
                data:
                - asset: btc
                  time: '2020-02-29T00:00:00.000000000Z'
                  PriceUSD: '8582.09029964933'
                  SplyBMXNtv: '283220.10827406'
                  SplyBMXNtv-status: reviewed
                  SplyBMXNtv-status-time: '2020-03-01T09:59:13.847251000Z'
                - asset: btc
                  time: '2020-03-01T00:00:00.000000000Z'
                  PriceUSD: '8541.77389392169'
                  SplyBMXNtv: '284691.32323907'
                  SplyBMXNtv-status: reviewed
                  SplyBMXNtv-status-time: '2020-03-02T14:00:02.622168000Z'
                next_page_token: 0.MjAyMC0wNi0wN1QwMDowMDowMFo,MjAyMC0wNi0wN1QwMDowMDowMFo
                next_page_url: https://api.coinmetrics.io/v4/timeseries/asset-metrics?api_key=<your_key>&pretty=true&assets=btc&metrics=SplyBMXNtv,PriceUSD&page_size=2&next_page_token=0.MjAyMC0wNi0wN1QwMDowMDowMFo,MjAyMC0wNi0wN1QwMDowMDowMFo
            block_by_block_metrics:
              summary: Example of a message with block by block metrics.
              value:
                data:
                - block_hash: 0000000000000000000b7ee9ded84d26167a13c8377cd003fb344584368ba7e9
                  parent_block_hash: 0000000000000000000fd3f882c12258b3c604c724fe2e9747e250b094b8b026
                  height: '635276'
                  asset: btc
                  time: '2020-06-18T10:37:23.000000000Z'
                  FlowTfrToExCnt: '374'
                  FlowTfrToExCnt-status: flash
                  FlowTfrToExCnt-status-time: '2020-06-18T10:38:47.586052000Z'
                  PriceUSD: '9435.03'
                - block_hash: 00000000000000000004be53922df7ddf7efc5ed5c45fdf48ccc92eb7f4df30b
                  parent_block_hash: 0000000000000000000b7ee9ded84d26167a13c8377cd003fb344584368ba7e9
                  height: '635277'
                  asset: btc
                  time: '2020-06-18T11:07:58.000000000Z'
                  FlowTfrToExCnt: '325'
                  FlowTfrToExCnt-status: flash
                  FlowTfrToExCnt-status-time: '2020-06-18T11:09:15.174316000Z'
                  PriceUSD: '9441.84'
                next_page_token: 0.NjM1Mjc2,NjM1Mjc2
                next_page_url: https://api.coinmetrics.io/v4/timeseries/asset-metrics?api_key=<your_key>&pretty=true&assets=btc&metrics=FlowTfrToExCnt,PriceUSD&page_size=2&frequency=1b&next_page_token=0.NjM1Mjc2,NjM1Mjc2
            by_second_frequency_metrics:
              summary: Example of a message with 1s metrics.
              value:
                data:
                - asset: btc
                  time: '2020-06-18T11:36:09.000000000Z'
                  ReferenceRate: '9431.1200000000008'
                - asset: btc
                  time: '2020-06-18T11:36:10.000000000Z'
                  ReferenceRate: '9431.1200000000008'
                next_page_token: 0.MjAyMC0wNi0xOFQxMTozNjowOVo
                next_page_url: https://api.coinmetrics.io/v4/timeseries/asset-metrics?api_key=<your_key>&pretty=true&assets=btc&metrics=ReferenceRate&page_size=2&frequency=1s&next_page_token=0.MjAyMC0wNi0xOFQxMTozNjowOVo
          schema:
            $ref: '#/components/schemas/AssetMetricsResponse'
        text/csv:
          example: 'asset,time,PriceUSD,SplyBMXNtv,SplyBMXNtv-status,SplyBMXNtv-status-time

            btc,2020-02-29T00:00:00.000000000Z,8582.09029964933,283220.10827406,reviewed,2020-03-01T09:59:13.847251000Z

            btc,2020-03-01T00:00:00.000000000Z,8541.77389392169,284691.32323907,reviewed,2020-03-02T14:00:02.622168000Z

            btc,2020-03-02T00:00:00.000000000Z,8906.21475645821,284962.29021857,reviewed,2020-03-03T14:24:11.689979000Z'
          schema:
            $ref: '#/components/schemas/AssetMetricsResponse'
    DefiBalanceSheets:
      description: DeFi balance sheets.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DefiBalanceSheetsResponse'
          example:
            data:
            - defi_protocol: aave_v2_eth
              block_height: '15656731'
              time: '2022-10-02T00:00:00.000000000Z'
              assets_total_usd: '5457689622.84'
              assets_total_count: '34'
              assets:
              - asset: 1inch
                balance_units: '16674724.15'
                balance_usd: '9580408.36'
                share: '0.001755'
              - asset: aave
                balance_units: '1743338.27'
                balance_usd: '129832512.22'
                share: '0.023789'
              liabilities_total_usd: '5458419619.21'
              liabilities_total_count: '34'
              liabilities:
              - asset: 1inch
                balance_units: '16674705.4'
                balance_usd: '9580397.58'
                share: '0.001755'
              - asset: aave
                balance_units: '1743338.27'
                balance_usd: '129832512.22'
                share: '0.023786'
              loans_lent_total_usd: '1531826827.01'
              tvl_total_usd: '3925862795.83'
              net_working_capital: '-1532556823.38'
              protocol_utilization_ratio: '0.28'
              liquid_supply_ratio: '0.72'
              current_ratio: '0.72'
              debt_to_assets_ratio: '1'
            next_page_token: 0.MTUwMjYyMzI
            next_page_url: https://api.coinmetrics.io/v4/timeseries/defi-balance-sheets?api_key=<your_key>&defi_protocols=aave_v2_eth&next_page_token=0.MTUwMjYyMzI
    IndexLevels:
      description: Time series of index levels.
      content:
        application/json:
          example:
            data:
            - time: '2017-05-22T00:00:00.000000000Z'
              index: CMBIWORK
              level: '389473805.713838875'
            - time: '2017-05-23T00:00:00.000000000Z'
              index: CMBIWORK
              level: '362701474.775819778'
            next_page_token: 0.MjAxNy0wNS0yMlQwMDowMDowMFo
            next_page_url: https://api.coinmetrics.io/v4/timeseries/index-levels?indexes=CMBIWORK&api_key=<your_key>&pretty=true&page_size=2&next_page_token=0.MjAxNy0wNS0yMlQwMDowMDowMFo
          schema:
            $ref: '#/components/schemas/IndexLevelsResponse'
    ProtocolNotFound:
      content:
        application/json:
          example:
            error:
              type: bad_parameter
              message: Bad parameter 'protocols'. Value 'asdgwav' is not supported.
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Protocol not found.
    MiningPoolTipsSummary:
      description: Time series of mining pool tips summaries.
      content:
        application/json:
          example:
            data:
            - asset: btc
              time: '2021-04-20T15:38:35.378090000Z'
              tips_count: '2'
              block_hashes_at_tip: '1'
              tips:
              - last_time: '2021-04-20T15:26:21.615787000Z'
                height: '679916'
                hash: 0000000000000000000b014cad322db899c4fcffc2bdbe1968c6fa85217308a2
                pool_count: '2'
              - last_time: '2021-04-20T15:38:35.378090000Z'
                height: '679917'
                hash: 000000000000000000004035d600016c2005b4238acb2750625126542b8033a0
                pool_count: '10'
            - asset: btc
              time: '2021-04-20T15:38:35.543325000Z'
              tips_count: '2'
              block_hashes_at_tip: '1'
              tips:
              - last_time: '2021-04-20T15:26:21.351310000Z'
                height: '679916'
                hash: 0000000000000000000b014cad322db899c4fcffc2bdbe1968c6fa85217308a2
                pool_count: '1'
              - last_time: '2021-04-20T15:38:35.543325000Z'
                height: '679917'
                hash: 000000000000000000004035d600016c2005b4238acb2750625126542b8033a0
                pool_count: '11'
            - asset: btc
              time: '2021-04-20T15:38:35.744213000Z'
              tips_count: '1'
              block_hashes_at_tip: '1'
              tips:
              - last_time: '2021-04-20T15:38:35.744213000Z'
                height: '679917'
                hash: 000000000000000000004035d600016c2005b4238acb2750625126542b8033a0
                pool_count: '12'
            next_page_token: 0.MjAyMS0wNC0yMFQxNTozODozNS4zNzgwOTBa
            next_page_url: https://api.coinmetrics.io/v4/timeseries/mining-pool-tips-summary?api_key=<your_key>&pretty=true&assets=btc&page_size=3&next_page_token=0.MjAyMS0wNC0yMFQxNTozODozNS4zNzgwOTBa
          schema:
            $ref: '#/components/schemas/MiningPoolTipsSummaryResponse'
    MarketOpenInterest:
      description: Time series of market open interest.
      content:
        application/json:
          example:
            data:
            - market: binance-BTCUSDT-future
              time: '2020-08-05T23:04:50.421035000Z'
              contract_count: '35074.075'
              value_usd: '408810440.79225'
              database_time: '2020-08-05T23:04:50.606185000Z'
              exchange_time: '2020-08-05T23:03:59.417000000Z'
            - market: binance-BTCUSDT-future
              time: '2020-08-05T23:19:10.016074000Z'
              contract_count: '35061.142'
              value_usd: '409113039.09552'
              database_time: '2020-08-05T23:19:10.749665000Z'
              exchange_time: '2020-08-05T23:19:00.458000000Z'
          schema:
            $ref: '#/components/schemas/MarketOpenInterestResponse'
    PairMetrics:
      description: Time series of pair metrics.
      content:
        application/json:
          example:
            data:
            - pair: btc-usd
              time: '2020-09-28T00:00:00.000000000Z'
              volume_trusted_spot_usd_1d: '317000178.776577'
            - pair: btc-usd
              time: '2020-09-29T00:00:00.000000000Z'
              volume_trusted_spot_usd_1d: '246153685.485477'
            - pair: btc-usd
              time: '2020-09-30T00:00:00.000000000Z'
              volume_trusted_spot_usd_1d: '217972373.240482'
            - pair: btc-usd
              time: '2020-10-01T00:00:00.000000000Z'
              volume_trusted_spot_usd_1d: '492203699.871197'
          schema:
            $ref: '#/components/schemas/PairMetricsResponse'
    BlockchainForbidden:
      content:
        application/json:
          example:
            error:
              type: forbidden
              message: Requested resource is not available with supplied credentials.
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Requested resource is not available with supplied credentials.
    AssetChains:
      description: Time series of asset chains.
      content:
        application/json:
          example:
            data:
            - asset: btc
              time: '2021-01-01T15:30:00.000000000Z'
              chains_count: '2'
              blocks_count_at_tip: '1'
              reorg: 'true'
              reorg_depth: '1'
              chains:
              - - hash: 000000000000000000004035d600016c2005b4238acb2750625126542b8033aa
                  height: '679917'
                  time: '2021-01-01T15:00:00.000000000Z'
                - hash: 000000000000000000004035d600016c2005b4238acb2750625126542b8033ac
                  height: '679918'
                  time: '2021-01-01T15:20:00.000000000Z'
                - hash: 000000000000000000004035d600016c2005b4238acb2750625126542b8033ad
                  height: '679919'
                  time: '2021-01-01T15:30:00.000000000Z'
              - - hash: 000000000000000000004035d600016c2005b4238acb2750625126542b8033aa
                  height: '679917'
                  time: '2021-01-01T15:00:00.000000000Z'
                - hash: 000000000000000000004035d600016c2005b4238acb2750625126542b8033ab
                  height: '679918'
                  time: '2021-01-01T15:10:00.000000000Z'
            next_page_token: 0.MjAyMS0wNC0yMFQxNTozODozNS4zNzgwOTBa
            next_page_url: https://api.coinmetrics.io/v4/timeseries/asset-chains?api_key=<your_key>&pretty=true&assets=btc&page_size=3&next_page_token=0.MjAyMS0wNC0yMFQxNTozODozNS4zNzgwOTBa
          schema:
            $ref: '#/components/schemas/AssetChainsResponse'
    IndexCandles:
      description: Time series of index candles.
      content:
        application/json:
          example:
            data:
            - index: CMBIBTC
              time: '2022-06-28T00:00:00.000000000Z'
              price_open: '21072.8899999999994'
              price_close: '20248.47'
              price_high: '21086.7200000000012'
              price_low: '20184.6'
              candle_trades_count: '116028440'
            - index: CMBIBTC
              time: '2022-06-29T00:00:00.000000000Z'
              price_open: '20252.89'
              price_close: '20089.0299999999988'
              price_high: '20402.8100000000013'
              price_low: '19867.9399999999987'
              candle_trades_count: '228458314'
            - index: CMBIBTC
              time: '2022-06-30T00:00:00.000000000Z'
              price_open: '20093.1800000000003'
              price_close: '19900.6'
              price_high: '20130'
              price_low: '18655.1500000000015'
              candle_trades_count: '252868227'
          schema:
            $ref: '#/components/schemas/IndexCandlesResponse'
    AssetNotFound:
      content:
        application/json:
          example:
            error:
              type: bad_parameter
              message: Bad parameter 'assets'. Value 'sdvwbtc' is not supported.
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Asset not found.
    MarketCandles:
      description: Time series of market candles.
      content:
        application/json:
          example:
            data:
            - time: '2020-06-08T20:45:00.000000000Z'
              market: coinbase-btc-usd-spot
              price_open: '9705.07999999999993'
              price_close: '9705.01000000000022'
              price_high: '9706.19000000000051'
              price_low: '9705'
              vwap: '9705.1686505895068'
              volume: '16.8066639099999975'
              candle_usd_volume: '16.8066639099999975'
              candle_trades_count: '212'
            - time: '2020-06-08T20:50:00.000000000Z'
              market: coinbase-btc-usd-spot
              price_open: '9705'
              price_close: '9696.27000000000044'
              price_high: '9705'
              price_low: '9695.71999999999935'
              vwap: '9698.38894423754937'
              volume: '14.7672128699999963'
              candle_usd_volume: '14.7672128699999963'
              candle_trades_count: '215'
            next_page_token: 0.MjAyMC0wNi0wOFQyMDo0NTowMFo
            next_page_url: https://api.coinmetrics.io/v4/timeseries/market-candles?markets=coinbase-btc-usd-spot&api_key=<your_key>&pretty=true&page_size=2&frequency=5m&next_page_token=0.MjAyMC0wNi0wOFQyMDo0NTowMFo
          schema:
            $ref: '#/components/schemas/MarketCandlesResponse'
    ExchangeAssetNotFound:
      content:
        application/json:
          example:
            error:
              type: bad_parameter
              message: Bad parameter 'id'. Exchange-asset pair 'sdvwbtc-btc' is not supported.
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Exchange-asset pair not found.
    ExchangePairNotFound:
      content:
        application/json:
          example:
            error:
              type: bad_parameter
              message: Bad parameter 'exchange_pairs'. Value 'sdvwbtc-btc-usdt' is not supported.
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Exchange-pair not found.
    DefiProtocolNotFound:
      content:
        application/json:
          example:
            error:
              type: bad_parameter
              message: Bad parameter 'defi_protocols'. Value 'sdvwbtc' is not supported.
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: DeFi protocol not found.
    MarketOrderBooks:
      description: Time series of market order books.
      content:
        application/json:
          example:
            data:
            - time: '2020-06-08T21:01:23.283083000Z'
              market: coinbase-btc-usd-spot
              coin_metrics_id: 1591479594286046-27268420
              asks:
              - price: '9701.48'
                size: '2.65178241'
              - price: '9701.49'
                size: '0.10941481'
              bids:
              - price: '9701.4'
                size: '4.43779413'
              - price: '9699.94'
                size: '0.041'
            next_page_token: 0.MjAyMC0wNi0wOFQyMTowMToyMy4yODMwODNafDE1OTE0Nzk1OTQyODYwNDY
            next_page_url: https://api.coinmetrics.io/v4/timeseries/market-orderbooks?markets=coinbase-btc-usd-spot&api_key=<your_key>&pretty=true&page_size=1&next_page_token=0.MjAyMC0wNi0wOFQyMTowMToyMy4yODMwODNafDE1OTE0Nzk1OTQyODYwNDY
          schema:
            $ref: '#/components/schemas/MarketOrderbookResponse'
    MarketMetrics:
      description: Time series of market metrics.
      content:
        application/json:
          example:
            data:
            - market: binance-BTCUSDT-future
              time: '2022-01-19T20:00:00.000000000Z'
              liquidations_reported_future_buy_usd_5m: '1298.36866'
            - market: binance-BTCUSDT-future
              time: '2022-01-19T20:10:00.000000000Z'
              liquidations_reported_future_buy_usd_5m: '39713.60016'
            - market: binance-BTCUSDT-future
              time: '2022-01-19T20:30:00.000000000Z'
              liquidations_reported_future_buy_usd_5m: '29084.10932'
            - market: binance-BTCUSDT-future
              time: '2022-01-19T21:00:00.000000000Z'
              liquidations_reported_future_buy_usd_5m: '46294.99528'
          schema:
            $ref: '#/components/schemas/MarketMetricsResponse'
    MarketFundingRates:
      description: Time series of market funding rates.
      content:
        application/json:
          example:
            data:
            - market: bitmex-XBTUSD-future
              time: '2020-11-11T18:00:00.000000000Z'
              rate: '-0.000007'
              period: 08:00:00
              interval: 01:00:00
              database_time: '2020-12-02T10:49:31.262231000Z'
            - market: bitmex-XBTUSD-future
              time: '2020-11-11T19:00:00.000000000Z'
              rate: '0.2123'
              period: 08:00:00
              interval: 01:00:00
              database_time: '2020-12-02T10:49:31.262231000Z'
          schema:
            $ref: '#/components/schemas/MarketFundingRatesResponse'
    ExchangeNotFound:
      content:
        application/json:
          example:
            error:
              type: bad_parameter
              message: Bad parameter 'id'. Exchange 'sdvwbtc' is not supported.
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Exchange not found.
    ProtocolMetricsResponse:
      description: Time series of protocol metrics.
      content:
        application/json:
          example:
            data:
            - protocol: aave_v3
              market: core-weth
              chain: ethereum
              time: '2026-06-12T00:00:00.000000000Z'
              supply_apy: '1.36345867342'
              utilization_rate: '0.782002605849005506'
            - protocol: aave_v3
              market: core-weth
              chain: ethereum
              time: '2026-06-13T00:00:00.000000000Z'
              supply_apy: '1.36153288068'
              utilization_rate: '0.781455839183805442'
          schema:
            $ref: '#/components/schemas/ProtocolMetricsResponse'
    MarketImpliedVolatility:
      description: Time series of market implied volatility.
      content:
        application/json:
          example:
            data:
            - market: deribit-ETH-10SEP21-3200-P-option
              time: '2021-09-05T13:26:00.000000000Z'
              database_time: '2021-09-05T13:26:37.808731000Z'
              exchange_time: '2021-09-05T13:26:36.642000000Z'
              iv_bid: '1.0086'
              iv_ask: '1.1132'
              iv_mark: '1.0616'
            next_page_token: 0.MjAyMC0wNi0wOFQyMDo0NTowMFo
            next_page_url: https://api.coinmetrics.io/v4/timeseries/market-implied-volatility?markets=deribit-ETH-10SEP21-3200-P-option&api_key=<your_key>&pretty=true&page_size=2&next_page_token=0.MjAyMC0wNi0wOFQyMDo0NTowMFo
          schema:
            $ref: '#/components/schemas/MarketImpliedVolatilityResponse'
    Unauthorized:
      description: Requested resource requires authorization.
      content:
        application/json:
          examples:
            unauthorized:
              summary: Unauthorized error response.
              value:
                error:
                  type: unauthorized
                  message: Requested resource requires authorization.
            wrong_credentials:
              summary: Wrong credentials error response.
              value:
                error:
                  type: wrong_credentials
                  message: Supplied credentials are not valid.
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InstitutionMetrics:
      description: Time series of institution metrics.
      content:
        application/json:
          example:
            data:
            - institution: institution1
              time: '2020-09-28T00:00:00.000000000Z'
              total_assets: '317000178.776577'
            - institution: institution1
              time: '2020-09-29T00:00:00.000000000Z'
              total_assets: '246153685.485477'
            - institution: institution1
              time: '2020-09-30T00:00:00.000000000Z'
              total_assets: '217972373.240482'
            - institution: institution1
              time: '2020-10-01T00:00:00.000000000Z'
              total_assets: '492203699.871197'
          schema:
            $ref: '#/components/schemas/InstitutionMetricsResponse'
    MarketFundingRatesPredicted:
      description: Time series of predicted market funding rates.
      content:
        application/json:
          example:
            data:
            - market: deribit-XRP_USDC-PERPETUAL-future
              time: '2024-01-30T13:36:00.000000000Z'
              database_time: '2024-01-30T13:36:16.493351000Z'
              rate_predicted: '0.00013059'
            - market: deribit-XRP_USDC-PERPETUAL-future
              time: '2024-01-30T13:37:00.000000000Z'
              database_time: '2024-01-30T13:37:16.500723000Z'
              rate_predicted: '0.00013016'
          schema:
            $ref: '#/components/schemas/MarketFundingRatesPredictedResponse'
    Forbidden:
      content:
        application/json:
          example:
            error:
              type: forbidden
              message: Requested metric 'SplyBMXNtv' with frequency '1d' for asset 'btc' is not available with supplied credentials.
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Requested resource is not available with supplied credentials.
  securitySchemes:
    api_key:
      description: Coin Metrics API key can be specified as `?api_key=` query parameter.
      in: query
      name: api_key
      type: apiKey
x-tagGroups:
- name: General
  tags:
  - Rate limits
- name: Reference Data
  tags:
  - Reference Data
  - Profile
  - Taxonomy
  - Taxonomy Metadata
- name: Catalog
  tags:
  - Catalog
  - Full catalog
  - Catalog v2
  - Full catalog v2
- name: Timeseries
  tags:
  - Timeseries
  - Timeseries stream
- name: Universal blockchain explorer
  tags:
  - List of blockchain entities v2
  - Full blockchain entities v2
  - Blockchain Explorer Job
  - Blockchain Explorer Job Results
- name: Tools
  tags:
  - Chain Monitor tools
- name: Security Master
  tags:
  - Security Master
- name: Constituents
  tags:
  - Constituent Snapshots
  - Constituent Timeframes
- name: Blockchain Metadata
  tags:
  - Blockchain Metadata
- name: Jobs
  tags:
  - Jobs