Addresses with Balance

Val in Addrs w/ Bal ≥ X% of Current Supply

Definition

The sum of all native units being held in addresses whose balance was at least X% of the current supply of native units as the end of that day. Only native units are considered (e.g., an address with less than X ETH but with more than X in ERC-20 tokens would not be considered).

Dictionary

Name

MetricID

Unit

Interval

Val in Addrs w/ Bal ≥ .00000001% of Current Supply

SplyAdrBal1in10B

Native units

1 day

Val in Addrs w/ Bal ≥ .0000001% of Current Supply

SplyAdrBal1in1B

Native units

1 day

Val in Addrs w/ Bal ≥ .000001% of Current Supply

SplyAdrBal1in100M

Native units

1 day

Val in Addrs w/ Bal ≥ .00001% of Current Supply

SplyAdrBal1in10M

Native units

1 day

Val in Addrs w/ Bal ≥ .0001% of Current Supply

SplyAdrBal1in1M

Native units

1 day

Val in Addrs w/ Bal ≥ .001% of Current Supply

SplyAdrBal1in100K

Native units

1 day

Val in Addrs w/ Bal ≥ .01% of Current Supply

SplyAdrBal1in10K

Native units

1 day

Val in Addrs w/ Bal ≥ .1% of Current Supply

SplyAdrBal1in1K

Native units

1 day

Details

The supply used is SplyCur
The comparison is done using greater than or equal comparison (an address owning exactly 1/10,000,000,000th of the supply counts towards SplyAdrBal1in10B)
For a day D, balances are taken at the end of that day.
Only native units are taken into account, not L2 tokens.

Asset-Specific Details

For XRP, escrows are taken into account.
This metric is not available for assets that have full privacy, like Monero, Grin.
For assets that have opt-in privacy features, like ZCash, it only takes the non-private balances into account.

Release History

Released in the version 4.0 of Network Data Pro

Availability for Assets

Coin Metrics CoverageCoin Metrics Coverage

Val in Addrs w/ Bal ≥ $X (native units)

Definition

The sum of all native units being held in addresses whose balance was $1 or greater at the end of that day. Only native units are considered (e.g., an address with less than X ETH but with more than X in ERC-20 tokens would not be considered).

Dictionary

Name

MetricID

Unit

Interval

Val in Addrs w/ Bal ≥ $1 USD

SplyAdrBalUSD1

Native units

1 day

Val in Addrs w/ Bal ≥ $10 USD

SplyAdrBalUSD10

Native units

1 day

Val in Addrs w/ Bal ≥ $100 USD

SplyAdrBalUSD100

Native units

1 day

Val in Addrs w/ Bal ≥ $1K USD

SplyAdrBalUSD1k

Native units

1 day

Val in Addrs w/ Bal ≥ $10K USD

SplyAdrBalUSD10K

Native units

1 day

Val in Addrs w/ Bal ≥ $100K USD

SplyAdrBalUSD100K

Native units

1 day

Details

This metric breaks down the supply of an asset by the USD balance of addresses owning it.
For a day D, balances are taken at the end of that day, the price used it the close price for that day too.
Only native units are taken into account, not L2 tokens.
The comparison is done using greater than or equal comparison (an address owning exactly $1 counts towards SplyAdrBalUSD1).

Asset-Specific Details

For Ripple, escrows are taken into account.
This metric is not available for assets that have full privacy, like Monero, Grin.
For assets that have opt-in privacy features, like ZCash, it only takes the non-private balances into account.

Release History

Released in the 4.0 release of NDP

Availability for Assets

Coin Metrics CoverageCoin Metrics Coverage

Val in Addrs w/ Bal ≥ X (native units)

Definition

The sum of all native units being held in addresses whose balance was X native unit or greater at the end of that day. Only native units are considered (e.g., an address with less than X ETH but with more than X in ERC-20 tokens would not be considered).

Name

MetricID

Unit

Interval

Val in Addrs w/ Bal ≥ .001 (native units)

SplyAdrBalNtv0.001

Native units

1 day

Val in Addrs w/ Bal ≥ .01 (native units)

SplyAdrBalNtv0.001

Native units

1 day

Val in Addrs w/ Bal ≥ .001 (native units)

SplyAdrBalNtv0.1

Native units

1 day

Val in Addrs w/ Bal ≥ 1 (native units)

SplyAdrBalNtv1

Native units

1 day

Val in Addrs w/ Bal ≥ 10 (native units)

SplyAdrBalNtv10

Native units

1 day

Val in Addrs w/ Bal ≥ 100 (native units)

SplyAdrBalNtv100

Native units

1 day

Val in Addrs w/ Bal ≥ 1K (native units)

SplyAdrBalNtv1K

Native units

1 day

Val in Addrs w/ Bal ≥ 10K (native units)

SplyAdrBalNtv10K

Native units

1 day

Val in Addrs w/ Bal ≥ 100K (native units)

SplyAdrBalNtv100K

Native units

1 day

Details

This metric breaks down the supply of an asset by the balance of addresses owning it.
Only native units are taken into account, not L2 tokens.
The comparison is done using greater than or equal comparison (an address owning exactly 1 native unit counts towards SplyAdrBalNtv1).

Asset-Specific Details

For Ripple, escrows are taken into account.
This metric is not available for assets that have full privacy, like Monero and Grin.
For assets that have opt-in privacy features, like ZCash, it only takes the non-private balances into account.

Release History

Released in the 4.0 release of NDP

Availability for Assets

Coin Metrics CoverageCoin Metrics Coverage

Supply Held by Smart Contracts

Definition

The sum of all native units being held by smart contracts.

Name

MetricID

Unit

Interval

Supply Held by Smart Contracts (native units)

SplyContNtv

Native units

1 day

Supply Held by Smart Contracts (USD)

SplyContUSD

Native units

1 day

Availability for Assets

Coin Metrics CoverageCoin Metrics Coverage

API Endpoints

Address with Balance Supply metrics can be accessed using these endpoints:

timeseries/asset-metrics

and by passing in the metric ID's SplyAdrBal* and SplyCont* 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.

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

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

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

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

from coinmetrics.api_client import CoinMetricsClient

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

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

PreviousActive Supply NextBurnt Supply

Last updated 1 year ago

Was this helpful?

Contents

Val in Addrs w/ Bal ≥ X% of Current Supply

Definition

Dictionary

Details

Asset-Specific Details

Release History

Availability for Assets

Val in Addrs w/ Bal ≥ $X (native units)

Definition

Dictionary

Details

Asset-Specific Details

Release History

Availability for Assets

Val in Addrs w/ Bal ≥ X (native units)

Definition

Details

Asset-Specific Details

Release History

Availability for Assets

Supply Held by Smart Contracts

Definition

Availability for Assets

API Endpoints

Asset metrics