Get vault APY

Get one vault's APY breakdown.

GEThttps://api-v2.syncrone.fi/api/catalog/advanced-vaults/{network}/{vaultId}/apy

The vault's APY over the trailing 1, 7 and 30 days, ending at its latest daily point.

← Vaults API overview

Try it#

GET/advanced-vaults/mainnet/0x98C23E9d8f34FEFb1B7BD6a91B7FF122F4e16F5c/apy

API keyx-api-key

Kept in this browser tab only, and sent to Syncrone with each request. No key yet? Create one ↗

Example vaults

Parameters

networkpathrequired

vaultIdpathrequired

Response

Paste an API key, then press Send. The parameters are pre-filled with a real example.

curl

curl "https://api-v2.syncrone.fi/api/catalog/advanced-vaults/mainnet/0x98C23E9d8f34FEFb1B7BD6a91B7FF122F4e16F5c/apy" \
  -H "x-api-key: $SYNCRONE_API_KEY"

Example#

A real response to the pre-filled Try it request, recorded from Syncrone data. Values move with every indexing run.

200GET /advanced-vaults/mainnet/0x98C23E9d8f34FEFb1B7BD6a91B7FF122F4e16F5c/apy

{
  "1day": {
    "base": 0.04364611560858411,
    "reward": 0,
    "total": 0.04364611560858411
  },
  "7day": {
    "base": 0.04497736287108545,
    "reward": 0,
    "total": 0.04497736287108545
  },
  "30day": {
    "base": 0.041377517377179096,
    "reward": 0,
    "total": 0.041377517377179096
  }
}

Parameters#

Name	Type	Description
networkpathrequired	`string`	Network name (`mainnet`, `base`, `arbitrum`…), CAIP-2 id (`eip155:1`) or chain id (`1`).
vaultIdpathrequired	`string`	Vault address (the share or receipt token, any case). A vault listed without an address is addressed by its `slug`.

Response#

200 returns JSON with these fields. APY values are fractions (0.04 = 4%); timestamps are Unix seconds.

Field	Type	Description
1day	`object \| null`	1-day trailing window. Null when the vault is younger than the window.
1day.base	`number`	Share-price growth over the window, TVL-weighted and annualised, as a fraction (0.04 = 4%). Net of vault fees.
1day.reward	`number`	Mean reward APY over the window: on-chain emissions plus off-chain programs (Merkl) paid to every depositor, divided by this vault's TVL. Restricted, points-only and issuer-priced programs are not counted (see `rewards`). 0 when none was recorded.
1day.total	`number`	`base + reward`.
7day	`object \| null`	7-day trailing window. Null when the vault is younger than the window.
7day.base	`number`	Share-price growth over the window, TVL-weighted and annualised, as a fraction (0.04 = 4%). Net of vault fees.
7day.reward	`number`	Mean reward APY over the window: on-chain emissions plus off-chain programs (Merkl) paid to every depositor, divided by this vault's TVL. Restricted, points-only and issuer-priced programs are not counted (see `rewards`). 0 when none was recorded.
7day.total	`number`	`base + reward`.
30day	`object \| null`	30-day trailing window. Null when the vault is younger than the window.
30day.base	`number`	Share-price growth over the window, TVL-weighted and annualised, as a fraction (0.04 = 4%). Net of vault fees.
30day.reward	`number`	Mean reward APY over the window: on-chain emissions plus off-chain programs (Merkl) paid to every depositor, divided by this vault's TVL. Restricted, points-only and issuer-priced programs are not counted (see `rewards`). 0 when none was recorded.
30day.total	`number`	`base + reward`.

Errors#

Status	Meaning
400	Invalid query or path parameter, or unknown network.
401	Missing or rejected API key.
404	No vault with this id on this network.
429	Too many requests from the docs playground. Wait a minute.
500	The service failed.

Error bodies carry error and, for invalid parameters, details.

← PreviousGet vault details Next →Get vault TVL