Feerates

Contents

• Mean Feerate Mempool (mempool_feerate_mean)

• Median Feerate Mempool (mempool_feerate_median)

• Next Block Average Feerate (mempool_next_block_approx_feerate_mean)

• Next Block Maximum Feerate (mempool_next_block_approx_feerate_max)

• Next Block Median Feerate (mempool_next_block_approx_feerate_median)

• Next Block Minimum Feerate (mempool_next_block_approx_feerate_min)

• Next Block Minimum Recommended Fee (mempool_next_block_inclusion_approx_feerate_min)

Mean Feerate Mempool

Definition

The mean feerate (fee/vsize) of all mempool transactions, in native units per byte. Virtual Size (vsize) is a unit used to measure the size of a bitcoin transaction after the activation of SegWit.

Dictionary

Name	MetricID	Unit	Interval
Mean Feerate Mempool	mempool_feerate_mean	fee/vsize	1m

Methodology

The mempool is evaluated and the feerate (fee/vsize) attached to all transactions is aggregated. The mean feerate of all transactions is then calculated.

Available Assets

Bitcoin (BTC)

Sample Query

https://api.coinmetrics.io/v4/timeseries/asset-metrics?api_key=%3Cyour_key%3E&assets=btc&frequency=1m&limit_per_asset=1&metrics=mempool_feerate_mean&pretty=trueapi.coinmetrics.io

Median Feerate Mempool

Definition

The median feerate (fee/vsize) of all mempool transactions in native units per byte. Virtual Size (vsize) is a unit used to measure the size of a bitcoin transaction after the activation of SegWit.

Dictionary

Name	MetricID	Unit	Interval
Median Feerate Mempool	mempool_feerate_median	fee/vsize	1m

Methodology

The mempool is evaluated and the feerate (fee/vsize) attached to all transactions is calculated. The median feerate of all transactions is then assessed.

Available Assets

Bitcoin (BTC)

Sample Query

https://api.coinmetrics.io/v4/timeseries/asset-metrics?api_key=%3Cyour_key%3E&assets=btc&frequency=1m&limit_per_asset=1&metrics=mempool_feerate_median&pretty=trueapi.coinmetrics.io

Next Block Average Feerate

Definition

The approximate value of the mean feerate for the upcoming blockchain block.

Dictionary

Name	MetricID	Unit	Interval
Next Block Average feerate	mempool_next_block_approx_feerate_mean	sats/vbyte	1m

Methodology

The calculation begins by ranking mempool transactions based on how much fees they are paying. A block template is then applied to these transactions with the goal of identifying which transactions rational miners would pick if they were to build a block at that minute The average (mean) feerate of the transactions in that block template is then showcased.

Available Assets

Bitcoin (BTC)

Sample Assets

https://api.coinmetrics.io/v4/timeseries/asset-metrics?api_key=%3Cyour_key%3E&assets=btc&frequency=1m&limit_per_asset=1&metrics=mempool_next_block_approx_feerate_men&pretty=trueapi.coinmetrics.io

Next Block Maximum Feerate

Definition

The approximate value of the maximum feerate for the upcoming blockchain block.

Dictionary

Name	MetricID	Unit	Interval
Next Block Maximum feerate	mempool_next_block_approx_feerate_max	sats/vbyte	1m

\

Methodology

The calculation begins by ranking mempool transactions based on how much fees they are paying. A block template is then applied to these transactions with the goal of identifying which transactions rational miners would pick if they were to build a block at that minute The feerate of the highest transaction that would still be included in that block template is then showcased.

Available Assets

Bitcoin (BTC)

Sample Query

https://api.coinmetrics.io/v4/timeseries/asset-metrics?api_key=%3Cyour_key%3E&assets=btc&frequency=1m&limit_per_asset=1&metrics=mempool_next_block_approx_feerate_max&pretty=trueapi.coinmetrics.io

Next Block Median Feerate

Definition

The approximate value of the median feerate for the upcoming blockchain block.

Dictionary

Name	MetricID	Unit	Interval
Next Block Median feerate	mempool_next_block_approx_feerate_median	sats/vbyte	1m

Methodology

The calculation begins by ranking mempool transactions based on how much fees they are paying. A block template is then applied to these transactions with the goal of identifying which transactions rational miners would pick if they were to build a block at that minute The median feerate of the transactions in that block template is then showcased.

Available Assets

Bitcoin (BTC)

Sample Query

https://api.coinmetrics.io/v4/timeseries/asset-metrics?api_key=%3Cyour_key%3E&assets=btc&frequency=1m&limit_per_asset=1&metrics=mempool_next_block_approx_feerate_median&pretty=trueapi.coinmetrics.io

Next Block Minimum Feerate

Definition

The approximate value of the minimum feerate for the upcoming blockchain block.

Dictionary

Name	MetricID	Unit	Interval
Next Block Minimum feerate	mempool_next_block_approx_feerate_min	sats/vbyte	1m

Methodology

The calculation begins by ranking mempool transactions based on how much fees they are paying. A block template is then applied to these transactions with the goal of identifying which transactions rational miners would pick if they were to build a block at that minute. The feerate of the lowest transaction that would still be included in that block template is then showcased.

Available Assets

Bitcoin (BTC)

Sample Query

https://api.coinmetrics.io/v4/timeseries/asset-metrics?api_key=%3Cyour_key%3E&assets=btc&frequency=1m&limit_per_asset=1&metrics=mempool_next_block_approx_feerate_min&pretty=trueapi.coinmetrics.io

Next Block Minimum Recommended Fee

Definition

The recommended minimum feerate required for a transaction to be included in the upcoming blockchain block. This metric differs from mempool_next_block_approx_feerate_min in that it accounts for situations where there are many transactions paying the minimum feerate. By adding an additional cushion to the minimum estimate, this metric provides better settlement guarantees.

Dictionary

Name	MetricID	Unit	Interval
Next Block minimum recommended fee	mempool_next_block_inclusion_approx_feerate_min	sats/vbyte	1m

Methodology

The calculation begins by ranking mempool transactions based on how much fees they are paying. A block template is then applied to these transactions with the goal of identifying which transactions rational miners would pick if they were to build a block at that minute The feerate of the lowest transaction that would still be included in that block template is then showcased. Depending on the aggregate size of transactions paying the minimum feerate, additional satoshi units are added in order to increase the likelihood that a transaction paying this feerate will be included in the next block.

Available Assets

Bitcoin (BTC)

Sample Query

https://api.coinmetrics.io/v4/timeseries/asset-metrics?api_key=%3Cyour_key%3E&assets=btc&frequency=1m&limit_per_asset=1&metrics=mempool_next_block_approx_feerate_min&pretty=trueapi.coinmetrics.io

Definition

The approximate value of the minimum feerate for the upcoming blockchain block.

Dictionary

Name	MetricID	Unit	Interval
Next Block Minimum feerate	mempool_next_block_approx_feerate_min	sats/vbyte	1m

Methodology

The calculation begins by ranking mempool transactions based on how much fees they are paying. A block template is then applied to these transactions with the goal of identifying which transactions rational miners would pick if they were to build a block at that minute. The feerate of the lowest transaction that would still be included in that block template is then showcased.

Available Assets

Bitcoin (BTC)

Sample Query

https://api.coinmetrics.io/v4/timeseries/asset-metrics?api_key=%3Cyour_key%3E&assets=btc&frequency=1m&limit_per_asset=1&metrics=mempool_next_block_approx_feerate_min&pretty=trueapi.coinmetrics.io

API Endpoints

Fee Rate metrics can be accessed using these endpoints:

• timeseries/asset-metrics

and by passing in the metric ID's mempool_feerate* and mempool_next_block_approx_feerate_* in the metrics parameter.

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

200

Time series of metrics for an asset.

application/jsontext/csv

400

Asset not found.

application/json

401

Requested resource requires authorization.

application/json

403

Requested resource is not available with supplied credentials.

application/json

414

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

get

HTTPcURLJavaScriptPython

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

Shell

curl --compressed "https://api.coinmetrics.io/v4/timeseries/asset-metrics?metrics=mempool_feerate_median&assets=btc&pretty=true&api_key=<your_key>"

Python

import requests
response = requests.get('https://api.coinmetrics.io/v4/timeseries/asset-metrics?metrics=mempool_feerate_median&assets=btc&pretty=true&api_key=<your_key>').json()
print(response)

Python Client

from coinmetrics.api_client import CoinMetricsClient

api_key = "<API_KEY>"
client = CoinMetricsClient(api_key)

print(
    client.get_asset_metrics(
        metrics="mempool_feerate_median", 
        assets="btc",
    ).to_dataframe()
)