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

> Daily gross and net yield and performance, management and platform fees in USD for one token in one vault, with shares outstanding and share price. Each series is one vault token, keyed by protocol, product, chain, vault and token. Many series per protocol, so name the vaults you need.

One row per token in a vault with financials, keyed by protocol, product, chain, vault and token: the vault, its curator and classification, the token, the parent protocol and product, chain and the mapped protocol, project and network records. The id is the series key of the vault-financials timeseries model.

| | |
| - | - |
| Access | Vaults-dataset |
| Tabular model | `vault-financials`: primary key `id` |
| Timeseries model | `vault-financials`: intervals `1d`, series key `id` (Vault Financial ID), series must be named (up to 20 per call) |

## Endpoints

> **[List Vault Financials](https://docs.blockworks.com/api-reference/data-api/vaults/tabular-vault-financials.md)**
>
> One page of rows with per-column filters, sorting and pagination.

> **[Batch Get Vault Financial timeseries](https://docs.blockworks.com/api-reference/data-api/vaults/timeseries-vault-financials.md)**
>
> Up to 20 series in one request, named by Vault Financial ID in `series`.

> **[Get Vault Financial timeseries](https://docs.blockworks.com/api-reference/data-api/vaults/timeseries-vault-financials-by-id.md)**
>
> One series over a time window, keyed by its Vault Financial ID.

## Metrics

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

| Field | Name | Type | Unit | Description |
| - | - | - | - | - |
| `grossYieldUSD` | Gross Yield (USD) | float64 | | Gross yield earned by the vault in USD. |
| `netYieldUSD` | Net Yield (USD) | float64 | | Yield to depositors after fees in USD. |
| `performanceFeesUSD` | Performance Fees (USD) | float64 | | Performance fees in USD. |
| `managementFeesUSD` | Management Fees (USD) | float64 | | Management fees in USD. |
| `platformFeesUSD` | Platform Fees (USD) | float64 | | Platform fees in USD. |
| `feesUSD` | Fees (USD) | float64 | | Total fees in USD. |
| `totalShares` | Total Shares | float64 | | Vault shares outstanding. |
| `sharePrice` | Share Price | float64 | | Share price in units of the vault asset. |
| `sharePriceUSD` | Share Price (USD) | float64 | | Share price 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-financials timeseries model, the parent slug, product slug, chain, vault key and token key, joined with underscores. (primary key) |
| `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the series, the vault name and token symbol. |
| `slug` | string | `Eq`, `IsOneOf` | yes | The project's slug, the slug used for the same project across the API. |
| `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name (aave, morpho). |
| `productSlug` | string | `Eq`, `IsOneOf` | | The product within the parent protocol (morpho-vault). |
| `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain the vault lives on (ethereum, base, solana). |
| `vaultID` | string | `Eq`, `IsOneOf` | | The vault contract or program address; null when the protocol does not label vaults. |
| `vaultName` | string | `Eq`, `IsOneOf`, `Contains` | | The vault display name. |
| `vaultType` | string | `Eq`, `IsOneOf` | | The vault type. |
| `vaultVersion` | string | `Eq`, `IsOneOf` | | The vault version. |
| `vaultStrategy` | string | `Eq`, `IsOneOf` | | The vault strategy. |
| `vaultCategory` | string | `Eq`, `IsOneOf` | | The vault category. |
| `vaultSubcategory` | string | `Eq`, `IsOneOf` | | The vault subcategory within its category. |
| `curator` | string | `Eq`, `IsOneOf`, `Contains` | | The curator's display name (Steakhouse Financial, Gauntlet); Unknown when unattributed. |
| `curatorSlug` | string | `Eq`, `IsOneOf` | | The curator's slug, the id in vault-curators (steakhouse-financial, unknown). |
| `curatorProjectID` | string | `Eq`, `IsOneOf` | | The identifier of the curator's project record; null when unmapped. |
| `curatorProjectSlug` | string | `Eq`, `IsOneOf` | | The slug of the curator's project record; null when unmapped. |
| `institutionalPartner` | string | `Eq`, `IsOneOf` | | The institutional partner the vault is run for; null otherwise. |
| `tokenAddress` | string | `Eq`, `IsOneOf` | | The vault asset's contract address (the mint address on Solana); null when unlabeled. |
| `tokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The vault asset's ticker symbol. |
| `protocolSlug` | string | `Eq`, `IsOneOf` | | The slug of the protocol record mapped to the product; null when unmapped. |
| `protocolName` | string | `Eq`, `IsOneOf` | | The name of the protocol record mapped to the product; null when unmapped. |
| `projectID` | string | `Eq`, `IsOneOf` | | The identifier of the parent protocol's project record; null when unmapped. |
| `networkID` | string | `Eq`, `IsOneOf` | | The chain's networkID in the blockchains model; null when unmapped. |

## Example

```bash curl theme={null}
curl "https://api.blockworks.com/query/timeseries/vault-financials/1d/<id>?timeframe=7d&selections=grossYieldUSD,netYieldUSD" \
  -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY"
```

See [Get Vault Financial timeseries](https://docs.blockworks.com/api-reference/data-api/vaults/timeseries-vault-financials-by-id.md) for the response and the errors.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.