Get vault details

Get one vault's full detail object.

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

The full vault object for one vault.

← Vaults API overview

Try it#

GET/advanced-vaults/mainnet/0x98C23E9d8f34FEFb1B7BD6a91B7FF122F4e16F5c

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" \
  -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

{
  "vaultId": "0x98C23E9d8f34FEFb1B7BD6a91B7FF122F4e16F5c",
  "address": "0x98C23E9d8f34FEFb1B7BD6a91B7FF122F4e16F5c",
  "name": "Aave V3 Ethereum USDC",
  "network": {
    "name": "mainnet",
    "chainId": 1,
    "networkCaip": "eip155:1"
  },
  "asset": {
    "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
    "assetCaip": "eip155:1/erc20:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
    "name": "USD Coin",
    "symbol": "USDC",
    "decimals": 6,
    "assetLogo": "https://static.debank.com/image/eth_token/logo_url/0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48/fffcd27b9efff5a86ab942084c05924d.png",
    "assetPriceInUsd": "0.9999",
    "assetGroup": "USD"
  },
  "benchmarkId": "edca4b94-02b1-4a32-ba7c-deb246e4b524",
  "slug": "aave-v3-eth-usdc",
  "protocol": {
    "protocolId": "aave-v3",
    "name": "aave-v3",
    "displayName": "Aave V3",
    "protocolUrl": "https://aave.com",
    "protocolLogo": "https://icons.llamao.fi/icons/protocols/aave-v3",
    "description": "Pooled lending: suppliers earn the interest borrowers pay on the reserve."
  },
  "description": "Pooled lending: suppliers earn the interest borrowers pay on the reserve.",
  "tags": [
    "Lending",
    "Direct Protocol Lending",
    "Shared Lending Pool"
  ],
  "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
    }
  },
  "tvl": {
    "usd": "2268702789",
    "native": "2268929682474779"
  },
  "lastUpdateTimestamp": 1791849600,
  "isStale": false,
  "apyTimestamp": 1791849600,
  "curator": null,
  "fees": null
}

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
vaultId	`string`	Id to use in `{vaultId}` paths: the address, else the slug.
address	`string \| null`	Vault address, checksummed.
name	`string`	Vault name.
network.name	`string`	Network name.
network.chainId	`integer`	EVM chain id.
network.networkCaip	`string`	CAIP-2 id, e.g. `eip155:1`.
asset.address	`string`	Token address, checksummed.
asset.assetCaip	`string`	CAIP-19 id of the token.
asset.name	`string`	Token name.
asset.symbol	`string`	Token symbol.
asset.decimals	`integer`	Token decimals.
asset.assetLogo	`string \| null`	Logo URL.
asset.assetPriceInUsd	`string \| null`	USD price on the vault's latest bar: USD TVL divided by native TVL.
asset.assetGroup	`string`	`USD`, `ETH`, `BTC`, `EUR` or `OTHER`: the currency the asset is worth, from its price against $1, ETH and BTC.
benchmarkId	`string`	Syncrone benchmark id, for the benchmark endpoints of the main API.
slug	`string`	Syncrone benchmark slug.
protocol.protocolId	`string`	Protocol id, used by protocol filters.
protocol.name	`string`	Same as `protocolId`.
protocol.displayName	`string`	Protocol display name.
protocol.protocolUrl	`string \| null`	Protocol website.
protocol.protocolLogo	`string \| null`	Protocol logo URL.
protocol.description	`string \| null`	What earns the yield.
description	`string \| null`	Vault description.
tags	`string[]`	What earns the yield, e.g. `Lending`, `Liquid Staking`, `RWA`.
apy.1day	`object \| null`	1-day trailing window. Null when the vault is younger than the window.
apy.1day.base	`number`	Share-price growth over the window, TVL-weighted and annualised, as a fraction (0.04 = 4%). Net of vault fees.
apy.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.
apy.1day.total	`number`	`base + reward`.
apy.7day	`object \| null`	7-day trailing window. Null when the vault is younger than the window.
apy.7day.base	`number`	Share-price growth over the window, TVL-weighted and annualised, as a fraction (0.04 = 4%). Net of vault fees.
apy.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.
apy.7day.total	`number`	`base + reward`.
apy.30day	`object \| null`	30-day trailing window. Null when the vault is younger than the window.
apy.30day.base	`number`	Share-price growth over the window, TVL-weighted and annualised, as a fraction (0.04 = 4%). Net of vault fees.
apy.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.
apy.30day.total	`number`	`base + reward`.
tvl.usd	`string \| null`	TVL in USD, whole dollars.
tvl.native	`string \| null`	TVL in the asset's base units (wei for an 18-decimal token).
lastUpdateTimestamp	`integer \| null`	Unix seconds of the newest indexed bar; TVL is read from it.
isStale	`boolean`	True when the vault has missed an indexing run: no bar for one live interval plus 6 h (30 h for a daily vault). Its figures are older than expected.
apyTimestamp	`integer \| null`	Unix seconds of the daily point the APY windows end at (00:00 UTC).
curator	`object \| null`	`name`, `websiteUrl`, `logoUrl` of the vault's curator, when it has one.
fees	`object \| null`	`performanceFee`, `managementFee` (per year), `withdrawalFee`, `depositFee`, as fractions read from the vault contract. Display only: APY is already net of them.
rewards	`object \| null`	Every incentive on the vault as of the latest synced day: `supply_reward_apr`, `coverage` (complete \| partial \| unknown), `legs[]` counted per program and token (`token`, `apr`, `usd_per_day`, `tvl_basis_usd`), `excluded[]` read but not counted with their `exclusions` reason, `points[]` as published (never an APR), `embedded` when the protocol's rewards are already in the share price, and `attribution`. Off-chain incentive data: Merkl (merkl.xyz).
alerts[]	`object`	Conditions that can stop deposits or withdrawals, empty when none: `code` (`oracle_unusable`, `market_stuck`, `exit_liquidity_low`, `utilization_sustained_high`, `withdrawal_delay`), `level` (`critical`, `warning`, `info`), `title`, `detail`, `navPct` (share of NAV affected, 0–100, null for `withdrawal_delay`) and `marketIds[]`.

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.

← PreviousList advanced vaults Next →Get vault APY