Shielded Supply

Contents

• Shielded Supply

Shielded Supply

Definition

The sum of all native units being held in shielded pool(s).

Name	MetricID	Unit	Interval
Shielded Supply	SplyShld	Native units	All time

Details

• This metric takes into account all shielded pools that an asset may have.

• Shielded pools are where private transfers can happen in ZEC-like assets. Blockchain observers can only see coins coming in or out of the pool, but have no details about the transfers happening inside the pool.

Chart

Source: CM Network Data Charts

Asset-Specific Details

• Only relevant for ZEC and its derivatives.

Release History

• Released in the 4.2 release of NDP

See Also

• Current Supply

• Shielded Tx Cnt

• Fully Shielded Tx Cnt

Availability for Assets

Coin Metrics CoverageCoin Metrics Coverage

API Endpoints

Shielded supply metrics can be accessed using these endpoints:

• timeseries/asset-metrics

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

Response

200400401403

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

Shell

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

Python

import requests
response = requests.get('https://api.coinmetrics.io/v4/timeseries/asset-metrics?metrics=SplyShld&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="SplyShld", 
        assets="btc",
    ).to_dataframe()
)