Reference Rate

Definition

The CM Reference Rates represent the reference rate of one unit of the asset in quoted units (USD, BTC, ETH, EUR)

Name	MetricID	Unit	Interval
Reference Rate	ReferenceRate	USD	1d, 1d-ny-close, 1h, 1m, 1s, 200ms
Reference Rate, USD	ReferenceRateUSD	USD	1d, 1d-ny-close, 1h, 1m, 1s, 200ms
Reference Rate, BTC	ReferenceRateBTC	BTC	1d, 1d-ny-close, 1h, 1m, 1s, 200ms
Reference Rate, ETH	ReferenceRateETH	ETH	1d, 1d-ny-close, 1h, 1m, 1s, 200ms
Reference Rate, EUR	ReferenceRateEUR	EUR	1d, 1d-ny-close, 1h, 1m, 1s, 200ms

Please note that ReferenceRate and ReferenceRateUSD metrics are identical to each other.

Details

• The CM Reference Rates are published once a day, once an hour, once a minute, once a second, and once every 200 milliseconds and utilizes volume-weighted median, time-weighted average, and inverse price variance-weighted median techniques. \

• Common use cases for the CM Reference Rates include research, backtesting, calculating net asset value for investment funds, calculating closing prices for indexes or financial benchmarks, serving as a data source for on-chain price oracles, risk management, indicative intraday values for investment funds and financial benchmarks, and settling financial derivatives.\

• The CM Reference Rates supports multiple frequencies. The daily and hourly frequencies utilize one calculation methodology and the minute, second, and 200 millisecond frequencies ("real-time frequencies") utilize a separate calculation methodology.\

• The daily and hourly frequencies are calculated at the end of every hour and day, respectively, (the "Calculation Time") and are published within 5 minutes (the “Publication Time”). The real-time frequencies are published in real-time with no delay.\

• Please note that this metric is served through both the /timeseries/asset-metrics HTTP endpoint and the /timeseries-stream/asset-metrics websocket endpoint. The HTTP endpoint supports the frequencies 1d, 1h, 1m, and 1s. The websocket endpoint supports the frequencies 1s and 200ms.\

• Please see our CM Prices Overview for more information on methodology and policies.

API Endpoints

ReferenceRate metrics are available in the endpoints:

• /timeseries/asset-metrics

• /timeseries-stream/asset-metrics by passing in the <metric_id> in the metrics parameter.

Asset metrics

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:

GEThttps://api.coinmetrics.io/v4/timeseries/asset-metrics

Authorization

api_key

Query parameters

Response

200400401403414

Time series of metrics for an asset.

Body

application/jsontext/csv

data*any

next_page_tokenNextPageToken (string)

Token of the next page results for a given request.

next_page_urlNextPageUrl (string)

URL of the next page results for a given request.

Request

ShellPython

curl --compressed "https://api.coinmetrics.io/v4/timeseries/asset-metrics?assets=btc&metrics=PriceUSD,FlowInGEMUSD&frequency=1d&pretty=true&api_key=<your_key>"

Response

{
  "next_page_token": "text",
  "next_page_url": "text"
}

Asset metrics

Returns a WebSocket stream of metrics for specified assets. Endpoint supports only block by block (1b frequency), per second (1s frequency), and sub-second (200ms frequency) metrics. Different sets of metrics may come in different messages. If you are falling behind (slow client) you will get warning message first, then error message and disconnection will happen.

GEThttps://api.coinmetrics.io/v4/timeseries-stream/asset-metrics

Authorization

api_key

Query parameters

Response

414default

Provided URI is too long. It must not be greater than 10000 symbols.

Request

JavaScriptPython

// This is getting Reference Rates for Bitcoin and Ethereum at a frequency of 1 second
ws = new WebSocket("wss://api.coinmetrics.io/v4/timeseries-stream/asset-metrics?assets=btc,eth&metrics=ReferenceRate&frequency=1s&pretty=true&api_key=<your_key>")
ws.onmessage = m => console.log(m.data); ws.onclose = () => console.log("closed")

Example

A sample of the reference rates data for Bitcoin with one hour frequency is shown below:

{
  "data" : [ {
    "asset" : "btc",
    "time" : "2023-03-23T10:00:00.000000000Z",
    "ReferenceRateUSD" : "27706.6749620105"
  }, {
    "asset" : "btc",
    "time" : "2023-03-23T11:00:00.000000000Z",
    "ReferenceRateUSD" : "27720.9770701344"
  }, {
    "asset" : "btc",
    "time" : "2023-03-23T12:00:00.000000000Z",
    "ReferenceRateUSD" : "27617.113279661"
  }, {
    "asset" : "btc",
    "time" : "2023-03-23T13:00:00.000000000Z",
    "ReferenceRateUSD" : "27633.9196513735"
  }, {
    "asset" : "btc",
    "time" : "2023-03-23T14:00:00.000000000Z",
    "ReferenceRateUSD" : "27450.324137931"
  }
}

A sample of the reference rates data for Bitcoin with one second frequency is shown below:

{
  "data" : [ {
    "asset" : "btc",
    "time" : "2023-03-23T14:21:37.000000000Z",
    "ReferenceRateUSD" : "27460"
  }, {
    "asset" : "btc",
    "time" : "2023-03-23T14:21:38.000000000Z",
    "ReferenceRateUSD" : "27460"
  }, {
    "asset" : "btc",
    "time" : "2023-03-23T14:21:39.000000000Z",
    "ReferenceRateUSD" : "27460"
  }, {
    "asset" : "btc",
    "time" : "2023-03-23T14:21:40.000000000Z",
    "ReferenceRateUSD" : "27460"
  }, {
    "asset" : "btc",
    "time" : "2023-03-23T14:21:41.000000000Z",
    "ReferenceRateUSD" : "27460"
  }
}

• asset: The ID of the asset.\

• time: The reference rate time in ISO 8601 date-time format.\

• ReferenceRateUSD: The published reference rate value in U.S. Dollars.

Release History

• Please see the Coin Metrics Prices Change Log for release history.

Availability for Assets

Community and pro asset availability does not differ. Community is available via HTTP API only, is limited to 1,000 API requests per 10 minutes per IP address and only showcases the last 24 hours of history for the 1 hour, 1 minute and 1 second frequencies. The full history is available for daily frequencies.

Please see our Coin Metrics Coverage below for our asset coverage universe.

Coin Metrics CoverageCoin Metrics Coverage