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

# Savings Financials

> Net yield paid to depositors in each onchain savings product, in USD. Each series is one savings product token, keyed by protocol, chain, savings product and token.

One row per savings financial, keyed by protocol, chain, savings product and token: the parent protocol and product, chain, token and the mapped protocol, project and network records. The id is the series key of the savings-financials timeseries model.

| | |
| - | - |
| Access | Lending-protocols-dataset |
| Tabular model | `savings-financials`: primary key `id` |
| Timeseries model | `savings-financials`: intervals `1d`, series key `id` (Savings Financial ID), series must be named (up to 10 per call) |

## Endpoints

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

> [card] [Batch Get Savings Financial timeseries](https://docs.blockworks.com/api-reference/data-api/savings/timeseries-savings-financials.md)
>
> Up to 10 series in one request, named by Savings Financial ID in `series`.

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

## Metrics

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

| Field | Name | Type | Unit | Description |
| - | - | - | - | - |
| `netYieldUSD` | Net Yield (USD) | float64 | | Net yield paid to depositors 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 savings-financials timeseries model, the parent slug, chain, savings id and token address, joined with underscores. (primary key) |
| `name` | string | `Eq`, `IsOneOf`, `Contains` | default | The display name of the series, the savings product name and token symbol. |
| `slug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's project slug, the slug used for the same protocol across the API. |
| `parentSlug` | string | `Eq`, `IsOneOf` | yes | The parent protocol's short name. |
| `productSlug` | string | `Eq`, `IsOneOf` | | The product or version within the parent protocol. |
| `chain` | string | `Eq`, `IsOneOf` | | The short name of the chain (ethereum, base, solana). |
| `savingsID` | string | `Eq`, `IsOneOf` | | The savings product's identifier. |
| `tokenAddress` | string | `Eq`, `IsOneOf` | | The token contract address (the mint address on Solana); null when unlabeled. |
| `savingsName` | string | `Eq`, `IsOneOf`, `Contains` | | The savings product's display name. |
| `tokenSymbol` | string | `Eq`, `IsOneOf`, `Contains` | yes | The token'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/savings-financials/1d/<id>?timeframe=7d&selections=netYieldUSD" \
  -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY"
```

See [Get Savings Financial timeseries](https://docs.blockworks.com/api-reference/data-api/savings/timeseries-savings-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.