> For the complete documentation index, see [llms.txt](https://gitbook-docs.coinmetrics.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook-docs.coinmetrics.io/network-data/network-data-overview/supply/shielded-supply.md).

# Shielded Supply

## Contents

* [Shielded Supply](#splyshld)

## Shielded Supply <a href="#splyshld" id="splyshld"></a>

### 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

<figure><img src="https://2398817338-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MO23j33wWGzm0NrZseN%2Fuploads%2Fgit-blob-4dc6819291143da6a4f07f448e02c7be66112126%2FCoin_Metrics_Network_Data_2022-09-16T12-33.png?alt=media" alt=""><figcaption><p>Source: CM Network Data Charts</p></figcaption></figure>

### Asset-Specific Details

* Only relevant for ZEC and its derivatives.

### Release History

* Released in the 4.2 release of NDP

### See Also

* [Current Supply](https://docs.coinmetrics.io/asset-metrics/supply/splycur)
* [Shielded Tx Cnt](https://docs.coinmetrics.io/asset-metrics/transactions/txshldcnt)
* [Fully Shielded Tx Cnt](https://docs.coinmetrics.io/asset-metrics/transactions/txshldfullcnt)

### Availability for Assets

{% embed url="<https://coverage.coinmetrics.io/asset-metrics/SplyShld>" %}

## 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.

{% openapi src="/files/kc3C7O6zTLYNBA0AcsZt" path="/timeseries/asset-metrics" method="get" %}
[openapi.yaml](https://2398817338-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MO23j33wWGzm0NrZseN%2Fuploads%2Fgit-blob-a236d0d04b3b155748ce07a17aca8108fce9b7c2%2Fopenapi.yaml?alt=media)
{% endopenapi %}

{% tabs %}
{% tab title="Shell" %}

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

{% endtab %}

{% tab title="Python" %}

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

{% endtab %}

{% tab title="Python Client" %}

```python
from coinmetrics.api_client import CoinMetricsClient

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

print(
    client.get_asset_metrics(
        metrics="SplyShld", 
        assets="zec",
    ).to_dataframe()
)
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://gitbook-docs.coinmetrics.io/network-data/network-data-overview/supply/shielded-supply.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.