Core APIReferenceVaultsSlug

/vaults/{slug}/apy

Get Vault APY by slug. `compositionApy` is the composition-weighted yield APY based on underlying yield-bearing assets (liquid assets and off-chain value are excluded from the APY denominator). `apy` is a legacy alias for `compositionApy`. `navApy` is the price-delta (NAV-based) APY computed from vault token price changes.

GET
/vaults/{slug}/apy

Get Vault APY by slug. compositionApy is the composition-weighted yield APY based on underlying yield-bearing assets (liquid assets and off-chain value are excluded from the APY denominator). apy is a legacy alias for compositionApy. navApy is the price-delta (NAV-based) APY computed from vault token price changes.

Path Parameters

slug*string

Unique slug identifier for the vault.

Length1 <= length

Query Parameters

includeBreakdown?string
Defaultfalse

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/vaults/nest-alpha-vault/apy"
{  "data": {    "vaultAddress": "string",    "apy": {      "rolling7d": 0,      "rolling30d": 0,      "sec30d": 0    },    "compositionApy": {      "rolling7d": 0,      "rolling30d": 0,      "sec30d": 0    },    "navApy": {      "rolling7d": 0,      "rolling30d": 0,      "sec30d": 0    },    "breakdown": {      "totalValue": 0,      "liquidAssets": {        "totalValue": 0,        "weight": 0      },      "offChainValue": 0,      "yieldAssets": [        {          "slug": "string",          "value": 0,          "weight": 0,          "apy": {            "rolling7d": 0,            "rolling30d": 0,            "sec30d": 0          }        }      ]    },    "errors": [      {        "source": "superstate",        "operation": "getPendingTransactions",        "message": "superstate getPendingTransactions timed out after 10000ms",        "code": "TIMEOUT",        "timestamp": 1704067200      }    ]  }}

/vaults/{slug} GET

Get VaultInfo by slug

/vaults/{slug}/apy-history GET

Get APY history for vault by slug for the given date range. `compositionApy` is the composition-weighted yield APY (liquid assets and off-chain value are excluded from the APY denominator). `apy` is a legacy alias for `compositionApy`. `navApy` is the price-delta (NAV-based) APY computed from vault token price changes.