Reported Open Interest

PreviousMarket Level Open Interest NextOrderbooks

Last updated 6 months ago

Was this helpful?

Asset metrics

get

Returns requested metrics for specified assets. 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. Supported output formats are json (default) and csv, use format query parameter to override it. To fetch the next page of results use next_page_url JSON response field or x-next-page-url CSV HTTP header if present. If multiple metrics are requested in the same time the strict policy for partially available metrics among requested ones is applied:

Authorizations

Query parameters

assetsstring[]Required

Comma separated list of assets. Use the /catalog-all/assets endpoint for the full list of supported assets or specify asterisk (*) in order to get metrics for all supported assets.

metricsstring[]Required

Comma separated metrics to request time series data for. Information on all available metrics can be found on page https://coverage.coinmetrics.io/asset-metrics-v2. Use the /catalog-all/metrics or /catalog-all/assets endpoint for the full list of supported metrics per asset.

Example: ["AdrActCnt","BlkHgt"]

frequencystringOptional

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/metrics endpoint for the full list. Use the /catalog-all/assets endpoint for the full list of supported frequencies per asset-metric pair.

Default: 1dExample: 1b

statusstring · enumOptional

Which metric values do you want to see. Applicable only for "reviewable" metrics. You can find them in the /catalog/metrics endpoint.

Default: allPossible values:

start_timestringOptional

Start of the time interval. This field refers to the time field in the response. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120. Inclusive by default. Mutually exclusive with start_height and start_hash. UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it. If start_time is omitted, response will include time series from the earliest time available.

end_timestringOptional

End of the time interval. This field refers to the time field in the response. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120. Inclusive by default. Mutually exclusive with end_height and end_hash. UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it. If end_time is omitted, response will include time series up to the latest time available.

start_heightinteger · int64Optional

The start height indicates the beginning block height for the set of data that are returned. Inclusive by default. Mutually exclusive with start_time and start_hash.

end_heightinteger · int64Optional

The end height indicates the ending block height for the set of data that are returned. Inclusive by default. Mutually exclusive with end_time and end_hash. This parameter is disabled for Community users.

start_hashstringOptional

The start hash indicates the beginning block height for the set of data that are returned. Inclusive by default. Mutually exclusive with start_time and start_height.

end_hashstringOptional

The end hash indicates the ending block height for the set of data that are returned. Inclusive by default. Mutually exclusive with end_time and end_height.

start_inclusivebooleanOptional

Inclusive or exclusive corresponding start_* parameters.

Default: true

end_inclusivebooleanOptional

Inclusive or exclusive corresponding end_* parameters.

Default: true

min_confirmationsinteger · int32 · max: 99Optional

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).

timezonestringOptional

Timezone name for start_time and end_time timestamps. This parameter does not modify the output times, which are always UTC. Format is defined by TZ database.

Default: UTCExample: America/New_York

page_sizeinteger · int32 · min: 1 · max: 10000Optional

Number of items per single page of results. The value of this parameter is ignored if the endpoint supports the format parameter and its value is set to json_stream.

Default: 100

paging_fromstring · enumOptional

Where does the first page start, at the start of the interval or at the end. The value of this parameter is ignored if the endpoint supports the format parameter and its value is set to json_stream.

Default: endPossible values:

sortstring · enumOptional

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. Sorting by time is useful if you request metrics for a set of assets.

Default: assetPossible values:

limit_per_assetinteger · int32Optional

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.

prettybooleanOptional

Human-readable formatting of JSON responses.

Default: false

formatstring · enumOptional

Format of the response.

Default: jsonPossible values:

null_as_zerobooleanOptional

Nulls are represented as zeros in the response.

Default: false

next_page_tokenstringOptional

Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

ignore_forbidden_errorsbooleanOptional

Ignore "forbidden" errors for the items you currently don't have access to.

Default: false

ignore_unsupported_errorsbooleanOptional

Ignore "unsupported" errors for not currently supported by Coin Metrics items.

Default: false

Responses

get

GET /v4/timeseries/asset-metrics HTTP/1.1
Host: api.coinmetrics.io
Accept: */*

{
  "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"
}

Exchange metrics

get

Returns metrics for specified exchanges. Results are ordered by tuple (exchange, time). To fetch the next page of results use next_page_url JSON response field.

Authorizations

Query parameters

exchangesstring[]Required

Comma separated list of exchange names or asterisk (*) for all supported exchanges.

Example: {"summary":"the list of exchanges","value":"coinbase,binance,etc"}

metricsstring[]Required

Comma separated metrics to request time series data for. Information on all available metrics can be found on page https://coverage.coinmetrics.io/exchange-metrics-v2. Use the /catalog-all/exchange endpoint for the full list of supported metrics per exchange.

Example: ["open_interest_reported_future_usd","volume_reported_spot_usd_1d"]

frequencystringOptional

Frequency of the exchange metrics. Supported values are 1h, 1d.

Default: 1d

start_timestringOptional

Start of the time interval. This field refers to the time field in the response. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120. Inclusive by default. UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it. If start_time is omitted, response will include time series from the earliest time available.

end_timestringOptional

End of the time interval. This field refers to the time field in the response. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120. Inclusive by default. UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it. If end_time is omitted, response will include time series up to the latest time available.

start_inclusivebooleanOptional

Inclusive or exclusive corresponding start_* parameters.

Default: true

end_inclusivebooleanOptional

Inclusive or exclusive corresponding end_* parameters.

Default: true

timezonestringOptional

Timezone name for start_time and end_time timestamps. This parameter does not modify the output times, which are always UTC. Format is defined by TZ database.

Default: UTCExample: America/New_York

page_sizeinteger · int32 · min: 1 · max: 10000Optional

Number of items per single page of results. The value of this parameter is ignored if the endpoint supports the format parameter and its value is set to json_stream.

Default: 100

paging_fromstring · enumOptional

Default: endPossible values:

sortstring · enumOptional

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. Sorting by time is useful if you request metrics for a set of exchanges.

Default: exchangePossible values:

limit_per_exchangeinteger · int32Optional

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.

prettybooleanOptional

Human-readable formatting of JSON responses.

Default: false

formatstring · enumOptional

Format of the response.

Default: jsonPossible values:

next_page_tokenstringOptional

Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

Responses

get

GET /v4/timeseries/exchange-metrics HTTP/1.1
Host: api.coinmetrics.io
Accept: */*

{
  "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"
    }
  ]
}

Exchange-asset metrics

get

Returns metrics for specified exchange-asset. Results are ordered by tuple (exchange_asset, time). To fetch the next page of results use next_page_url JSON response field.

Authorizations

Query parameters

exchange_assetsstring[]Required

Comma separated list of exchange-asset pairs or patterns like exchange-* or *-asset.

metricsstring[]Required

Comma separated metrics to request time series data for. Information on all available metrics can be found on page https://coverage.coinmetrics.io/exchange-asset-metrics-v2. Use the /catalog-all/exchange-assets endpoint for the full list of supported metrics per exchange-asset combination.

Example: ["open_interest_reported_future_usd","volume_reported_spot_usd_1d"]

frequencystringOptional

Frequency of the exchange-asset metrics. Supported values are 5m, 1h, 1d.

Default: 1d

start_timestringOptional

Start of the time interval. This field refers to the time field in the response. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120. Inclusive by default. UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it. If start_time is omitted, response will include time series from the earliest time available.

end_timestringOptional

End of the time interval. This field refers to the time field in the response. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120. Inclusive by default. UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it. If end_time is omitted, response will include time series up to the latest time available.

start_inclusivebooleanOptional

Inclusive or exclusive corresponding start_* parameters.

Default: true

end_inclusivebooleanOptional

Inclusive or exclusive corresponding end_* parameters.

Default: true

timezonestringOptional

Timezone name for start_time and end_time timestamps. This parameter does not modify the output times, which are always UTC. Format is defined by TZ database.

Default: UTCExample: America/New_York

page_sizeinteger · int32 · min: 1 · max: 10000Optional

Number of items per single page of results. The value of this parameter is ignored if the endpoint supports the format parameter and its value is set to json_stream.

Default: 100

paging_fromstring · enumOptional

Default: endPossible values:

sortstring · enumOptional

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. Sorting by time is useful if you request metrics for a set of exchange-assets.

Default: exchange_assetPossible values:

limit_per_exchange_assetinteger · int32Optional

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.

prettybooleanOptional

Human-readable formatting of JSON responses.

Default: false

formatstring · enumOptional

Format of the response.

Default: jsonPossible values:

next_page_tokenstringOptional

Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

Responses

get

GET /v4/timeseries/exchange-asset-metrics HTTP/1.1
Host: api.coinmetrics.io
Accept: */*

{
  "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"
    }
  ]
}

Pair metrics

get

Returns metrics for specified asset pairs. Results are ordered by tuple (pair, time). To fetch the next page of results use next_page_url JSON response field.

Authorizations

Query parameters

pairsstring[]Required

Comma separated list of asset pairs or patterns like btc-*, or *-btc. Use the /catalog-all/pairs endpoint for the full list of supported asset pairs.

metricsstring[]Required

Comma separated metrics to request time series data for. Information on all available metrics can be found on page https://coverage.coinmetrics.io/pair-metrics-v2. Use the /catalog-all/pairs endpoint for the full list of supported metrics per pair.

Example: ["volume_trusted_spot_usd_1h","volume_trusted_spot_usd_1d"]

frequencystringOptional

Frequency of the pair metrics. Supported values are 1h, 1d.

Default: 1d

start_timestringOptional

Start of the time interval. This field refers to the time field in the response. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120. Inclusive by default. UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it. If start_time is omitted, response will include time series from the earliest time available.

end_timestringOptional

End of the time interval. This field refers to the time field in the response. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120. Inclusive by default. UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it. If end_time is omitted, response will include time series up to the latest time available.

start_inclusivebooleanOptional

Inclusive or exclusive corresponding start_* parameters.

Default: true

end_inclusivebooleanOptional

Inclusive or exclusive corresponding end_* parameters.

Default: true

timezonestringOptional

Timezone name for start_time and end_time timestamps. This parameter does not modify the output times, which are always UTC. Format is defined by TZ database.

Default: UTCExample: America/New_York

page_sizeinteger · int32 · min: 1 · max: 10000Optional

Number of items per single page of results. The value of this parameter is ignored if the endpoint supports the format parameter and its value is set to json_stream.

Default: 100

paging_fromstring · enumOptional

Default: endPossible values:

sortstring · enumOptional

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. Sorting by time is useful if you request metrics for a set of asset pairs.

Default: pairPossible values:

limit_per_pairinteger · int32Optional

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.

prettybooleanOptional

Human-readable formatting of JSON responses.

Default: false

formatstring · enumOptional

Format of the response.

Default: jsonPossible values:

next_page_tokenstringOptional

Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

Responses

get

GET /v4/timeseries/pair-metrics HTTP/1.1
Host: api.coinmetrics.io
Accept: */*

{
  "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"
    }
  ]
}

Contents

Reported Coin-Margined Future Open Interest

Definition

Details

Release History

See Also

Availability for Assets

Reported Non-Perpetual Future Open Interest

Definition

Details

Release History

See Also

Availability for Assets

Reported Perpetual Future Open Interest

Definition

Details

Release History

See Also

Availability for Assets

Reported Tether-Margined Future Open Interest

Definition

Details

Release History

See Also

Availability for Assets

Reported Future Open Interest

Definition

Details

Release History

Availability for Assets

API Endpoints

Contents

Reported Coin-Margined Future Open Interest

Definition

Details

Release History

See Also

Availability for Assets

Reported Non-Perpetual Future Open Interest

Definition

Details

Release History

See Also

Availability for Assets

Reported Perpetual Future Open Interest

Definition

Details

Release History

See Also

Availability for Assets

Reported Tether-Margined Future Open Interest

Definition

Details

Release History

See Also

Availability for Assets

Reported Future Open Interest

Definition

Details

Release History

Availability for Assets

API Endpoints

Asset metrics

Exchange metrics

Exchange-asset metrics

Pair metrics