Flows

Flows Received by Miners

Definition

The sum of block rewards, fees, and other transfers received by all mining entities during an interval, excluding transfers from another mining entity. A mining entity is defined as an address that has been credited from a transaction debiting the 'FEES' or 'ISSUANCE' accounts in accordance with Coin Metric’s Universal Blockchain Data Model (UBDM).

Name

MetricID

Unit

Interval

Flows Received by Miners (native units)

FlowMinerIn0HopAllNtv

Native units

1 day

Flows Received by Miners (USD)

FlowMinerIn0HopAllUSD

USD

1 day

Details

This metric is not computed as the sum of block rewards and fees collected by all mining entities during an interval.
For more details on how this metric is computed, please refer to our blog post introducing Miner Flows

Asset-Specific Details

This metric will initially only be available for Bitcoin.

Release History

Release Version: 4.8 (Nov, 2020)

Availability for Assets

Coin Metrics CoverageCoin Metrics Coverage

Flows Received One Hop from Miners

Defintion

The sum of block rewards, fees, and other transfers received by all addresses within one hop of a mining entity during an interval, excluding transfers from another address within one hop of a mining entity. An address within one hop of a mining entity is defined as an address that has been credited from a transaction debiting the 'FEES' or 'ISSUANCE' accounts in accordance with Coin Metric’s Universal Blockchain Data Model (UBDM).

Name

MetricID

Unit

Interval

Flows Received One Hop from Miners (native units)

FlowMinerIn1HopAllNtv

Native units

1 day

Flows Received One Hop from Miners (USD)

FlowMinerIn1HopAllUSD

USD

1 day

Details

This metric is not computed as the sum of block rewards and fees collected by addresses within one hop of a mining entity during an interval.
For more details on how this metric is computed, please refer to our blog post introducing Miner Flows

Asset-Specific Details

This metric will initially only be available for Bitcoin.

Release History

Release Version: NDP-EOD 4.8 (Nov, 2020)

Availability for Assets

Coin Metrics CoverageCoin Metrics Coverage

Miner Net Flows

Definition

The net value sent or received by a mining entity in native units . A mining entity is defined as an address that has been credited from a transaction debiting the 'FEES' or 'ISSUANCE' accounts in accordance with Coin Metric’s Universal Blockchain Data Model (UBDM).

Name

MetricID

Unit

Interval

Miner Net Flows (native units)

FlowMinerNet0HopAllNtv

Native units

1 day

Miner Net Flows (native units)

FlowMinerNet0HopAllUSD

USD

1 day

Details

For more details on how this metric is computed, please refer to our blog post introducing Miner Flows

Asset-Specific Details

This metric will initially only be available for Bitcoin.

Release History

Release Version: NDP-EOD 4.8 (Nov, 2020)

Availability for Assets

Coin Metrics CoverageCoin Metrics Coverage

Net Flows One Hop from Miners

Definition

The difference between the sum of block rewards, fees, and other transfers received by all addresses within one hop of a mining entity during an interval, excluding transfers to another address within one hop of a mining entity, and those sent. An address within one hop of a mining entity is defined as an address that has been credited from a transaction debiting the 'FEES' or 'ISSUANCE' accounts in accordance with Coin Metric’s Universal Blockchain Data Model (UBDM), or any address that has been credited in a transaction sent by such an address.

Name

MetricID

Unit

Interval

Net Flows One Hop from Miners (native units)

FlowMinerNet1HopAllNtv

Native units

1 day

Net Flows One Hop from Miners (USD)

FlowMinerNet1HopAllUSD

USD

1 day

Details

For more details on how this metric is computed, please refer to our blog post introducing Miner Flows

Asset-Specific Details

This metric will initially only be available for Bitcoin.

Release History

Release Version: NDP-EOD 4.8 (Nov, 2020)

Availability for Assets

Coin Metrics CoverageCoin Metrics Coverage

Flows Sent by Miners

Definition

Name

MetricID

Unit

Interval

Flows Sent by Miners (native units)

FlowMinerOut0HopAllNtv

Native units

1 day

Flows Sent by Miners (USD)

FlowMinerOut0HopAllUSD

USD

1 day

Details

For more details on how this metric is computed, please refer to our blog post introducing Miner Flows

Asset-Specific Details

This metric will initially only be available for Bitcoin.

Release History

Release Version: NDP-EOD 4.8 (Nov, 2020)

Availability for Assets

Coin Metrics CoverageCoin Metrics Coverage

Flows Sent One Hop from Miners

Definition

The sum of block rewards, fees, and other transfers sent by all addresses within one hop of a mining entity during an interval, excluding transfers to another address within one hop of a mining entity. An address within one hop of a mining entity is defined as an address that has been credited from a transaction debiting the 'FEES' or 'ISSUANCE' accounts in accordance with Coin Metric’s Universal Blockchain Data Model (UBDM), or any address that has been credited in a transaction sent by such an address.

Name

MetricID

Unit

Interval

Flows Sent One Hop from Miners (native units)

FlowMinerOut1HopAllNtv

Native units

1 day

Flows Sent One Hop from Miners (USD)

FlowMinerOut1HopAllUSD

USD

1 day

Details

For more details on how this metric is computed, please refer to our blog post introducing Miner Flows

Asset-Specific Details

This metric will initially only be available for Bitcoin.

Release History

Release Version: NDP-EOD 4.8 (Nov, 2020)

Availability for Assets

Coin Metrics CoverageCoin Metrics Coverage

Miner Rolling Inventory, 30 day (%)

Definition

The outflow from all mining entities divided by miner revenue, over a rolling window of 30 days.

Name

MetricID

Unit

Interval

Miner Rolling Inventory, 30 day (%)

MRI0HopAll30d

Percentage

30 days

Details

This metric is computed as FlowMinerOut0HopAllNtv / RevNtv over a rolling window of 30 days

Asset-specific Details

This metric will initially only be available for Bitcoin.

Release History

Release Version: NDP-EOD 4.8 (Nov, 2020)

Availability for Assets

Coin Metrics CoverageCoin Metrics Coverage

Miner One Hop Rolling Inventory, 30 day (%)

Definition

The outflow from all addresses within one hop of a mining entity divided by miner revenue, over a rolling window of 30 days.

Dictionary

Name

MetricID

Unit

Interval

Miner One Hop Rolling Inventory, 30 day (%)

MRI1HopAll30d

Percentage

30 days

Details

This metric is computed as FlowMinerOut1HopAllNtv / RevNtv over a rolling window of 30 days

Asset-Specific Details

This metric will initially only be available for Bitcoin.

Release History

Release Version: NDP-EOD 4.8 (Nov, 2020)

Availability for Assets

Coin Metrics CoverageCoin Metrics Coverage

API Endpoints

Flows metrics can be accessed using these endpoints:

timeseries/asset-metrics

and by passing in the metric ID's FlowMinerIn0HopAll*, FlowMinerIn1HopAll* FlowMinerNet0HopAll*``FlowMinerNet0HopAll*``FlowMinerOut0HopAll*``FlowMinerOut0HopAll*in the metrics parameter.

Asset metrics

get

/timeseries/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:

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.

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

/timeseries/asset-metrics

GET /v4/timeseries/asset-metrics?assets=text&metrics=AdrActCnt 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"
}

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

from coinmetrics.api_client import CoinMetricsClient

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

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

PreviousExchange Flows NextHardware Hash Rate

Last updated 1 year ago

Was this helpful?

Contents

Flows Received by Miners

Definition

Details

Asset-Specific Details

Release History

Availability for Assets

Flows Received One Hop from Miners

Defintion

Asset-Specific Details

Release History

Availability for Assets

Miner Net Flows

Definition

Details

Asset-Specific Details

Release History

Availability for Assets

Net Flows One Hop from Miners

Definition

Details

Asset-Specific Details

Release History

Availability for Assets

Flows Sent by Miners

Definition

Details

Asset-Specific Details

Release History

Availability for Assets

Flows Sent One Hop from Miners

Definition

Details

Asset-Specific Details

Release History

Availability for Assets

Miner Rolling Inventory, 30 day (%)

Definition

Details

Asset-specific Details

Release History

Availability for Assets

Miner One Hop Rolling Inventory, 30 day (%)

Definition

Dictionary

Details

Asset-Specific Details

Release History

Availability for Assets

API Endpoints

Asset metrics