> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blockworks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Vault Protocols

> Metrics for a vault protocol across all chains: assets under management, active vaults, distinct curators, gross yield, net yield paid to depositors and fees, in USD. Each series is one protocol, keyed by its slug.

One row per vault protocol, keyed by its short name: name, project slug and project id. The id is the series key of the vault-protocols timeseries model.

|                  |                                                                                                     |
| ---------------- | --------------------------------------------------------------------------------------------------- |
| Access           | Projects\_protocols\_unified                                                                        |
| Tabular model    | `vault-protocols`: primary key `id`, identifiers `slug`                                             |
| Timeseries model | `vault-protocols`: intervals `1d`, series key `id` (Project ID), every series available in one call |

## Endpoints

<CardGroup cols={2}>
  <Card title="List Vault Protocols" icon="arrow-right" href="/api-reference/data-api/vaults/tabular-vault-protocols">
    One page of rows with per-column filters, sorting and pagination.
  </Card>

  <Card title="Batch Get Vault Protocol timeseries" icon="arrow-right" href="/api-reference/data-api/vaults/timeseries-vault-protocols">
    Every series in one request, or the named ones.
  </Card>

  <Card title="Get Vault Protocol timeseries" icon="arrow-right" href="/api-reference/data-api/vaults/timeseries-vault-protocols-by-id">
    One series over a time window, keyed by its Project ID.
  </Card>
</CardGroup>

## Metrics

6 metrics. Use the `Field` value in `selections`; every point starts with the timestamp and continues in this order.

| Field           | Name              | Type    | Unit | Description                                     |
| --------------- | ----------------- | ------- | ---- | ----------------------------------------------- |
| `aumUSD`        | AUM (USD)         | float64 |      | Total assets under management in vaults in USD. |
| `vaultCount`    | Vault Count       | float64 |      | Number of active vaults.                        |
| `curatorCount`  | Curator Count     | float64 |      | Number of distinct vault curators.              |
| `grossYieldUSD` | Gross Yield (USD) | float64 |      | Yield generated by vaults before fees in USD.   |
| `netYieldUSD`   | Net Yield (USD)   | float64 |      | Yield paid to depositors net of fees in USD.    |
| `feesUSD`       | Fees (USD)        | float64 |      | Fees taken by vaults and curators in USD.       |

## Columns

Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes).

| Field       | Type   | Filters                     | Sort    | Description                                                                                               |
| ----------- | ------ | --------------------------- | ------- | --------------------------------------------------------------------------------------------------------- |
| `id`        | string | `Eq`, `IsOneOf`             |         | The series key of the vault-protocols timeseries model, the protocol's short name (morpho). (primary key) |
| `name`      | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the protocol.                                                                         |
| `slug`      | string | `Eq`, `IsOneOf`             | yes     | The protocol's project slug, the slug used for the same protocol across the API. (identifier 1)           |
| `projectID` | string | `Eq`, `IsOneOf`             |         | The identifier of the protocol's project record.                                                          |

## Example

```bash curl theme={null}
curl "https://api.blockworks.com/query/timeseries/vault-protocols/1d/euler?timeframe=7d&selections=aumUSD,vaultCount" \
  -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY"
```

See [Get Vault Protocol timeseries](/api-reference/data-api/vaults/timeseries-vault-protocols-by-id) for the response and the errors.