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

# Nest Get Vault APYs

Fetch APY data for all Nest vaults from Nest API and App API. Returns enriched vault information including cooldown periods, TVL, and teller addresses. Ideal for: yield comparison, rebalancing decisions, vault analytics, DeFi research.

![Nest Get Vault APYs logo](https://cdn.b3.fun/b3os-icons/plume.svg)
Catalog action Blockchain Data

Fetch APY data for all Nest vaults from Nest API and App API. Returns enriched vault information including cooldown periods, TVL, and teller addresses. Ideal for: yield comparison, rebalancing decisions, vault analytics, DeFi research.


## At a Glance

| Field | Value |
| --- | --- |
| Action ID | `nest-get-vault-apys` |
| Category | Blockchain Data |
| Connector | Not required |
| Requires gas | No |
| Funds movement | None declared |
| Tags | `defi`, `plume`, `nest`, `apy`, `yield`, `vault`, `read`, `rebalancing` |

## Payload Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `vaultFilter` | `string` | No | Filter vaults by type: "boring" \(BoringVault only\), "nest" \(NestVault only\), or "all" \(default: "boring"\). |
| `minTvl` | `number` | No | Minimum TVL in USD to include a vault \(default: 100000\). Filters out tiny/empty vaults. |

## Result Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `vaultApys` | `array` | Yes | APY and metadata for each vault. |
| `fetchedAt` | `string` | Yes | ISO 8601 timestamp when data was fetched. |
| `warnings` | `array` | No | Any warnings encountered during fetching. |

## Examples

**Workflow node**

```json
{
  "type": "nest-get-vault-apys",
  "payload": {
    "vaultFilter": "boring",
    "minTvl": 100000
  },
  "children": []
}
```
  **Test with API**

```bash
curl -X POST "https://api.b3os.org/v1/actions/nest-get-vault-apys/test" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "inputs": {
    "vaultFilter": "boring",
    "minTvl": 100000
  }
}'
```

**Use expressions for dynamic values**

Payload fields can use workflow expressions such as `{{$trigger.body.amount}}`, `{{$nodes.fetch.result.price}}`, and `{{$props.asset}}` when the value should come from a trigger, prior node, or reusable workflow prop.