Vaults API
Yield, TVL and share price for DeFi vaults and lending markets, with history and network reference rates.
Every figure is read from the vault contracts themselves, once a day at 00:00 UTC, and served from Syncrone's benchmark index. Each endpoint page has a Try it panel: paste an API key and call it from the browser.
Authentication#
Send the key in the x-api-key header. The base URL is https://api-v2.syncrone.fi/api/catalog. Vaults are addressed as {network}/{vaultId}: the network name, CAIP-2 id or chain id, then the vault address.
Conventions#
- APY values are fractions:
0.0412is 4.12%.baseis the vault's share-price growth over the window, annualised and TVL-weighted, so it is net of every fee the vault charges.rewardis on-chain incentives.totalisbase + reward. - Windows are trailing 1, 7 and 30 days, ending at the vault's latest daily point (00:00 UTC). A window is null until the vault has that much history.
- TVL
usdis whole dollars. TVLnativeis in the asset's base units (wei for an 18-decimal token). - Timestamps are Unix seconds.
- Lists page with
page(from 0) andperPage(up to 1000).nextPageis present while more items exist. - Freshness:
isStalemarks a vault that missed an indexing run. Vaults registered but not indexed yet are not listed.GET /healthreturns 503 when data is stale, so it can drive an alert.
General#
Reference data: the vaults, assets, networks, tags, curators and protocols the catalog covers, and service health. Use these to browse coverage and fill filter dropdowns.
| Capability | How to call | Required inputs |
|---|---|---|
| List supported vault identifiers | GET /vaults | Optional query: |
| List supported assets and tokens | GET /assets | Optional query: |
| List supported networks | GET /networks | None. |
| List vault tags | GET /tags | None. |
| List vault curators | GET /curators | None. |
| List supported protocols and their filterable protocol IDs | GET /protocols | None. |
| Check API availability | GET /health | None. |
Advanced Vaults#
The full vault object: asset, protocol, tags, APY over 1, 7 and 30 days, TVL, curator and fees. APY is net of every fee the vault charges; the fees object is for display only.
| Capability | How to call | Required inputs |
|---|---|---|
| List and filter vaults with full analytics | GET /advanced-vaults | Optional query: |
| Get one vault's full detail object | GET /advanced-vaults/{network}/{vaultId} | Path: |
| Get one vault's APY breakdown | GET /advanced-vaults/{network}/{vaultId}/apy | Path: |
| Get one vault's TVL data | GET /advanced-vaults/{network}/{vaultId}/tvl | Path: |
| Get one vault's return and risk metrics | GET /advanced-vaults/{network}/{vaultId}/risk | Path: |
| List where vaults' assets sit, with utilization and drawdowns | GET /allocation | Optional query: |
| Get where one vault's assets sit | GET /allocation/{network}/{vaultId} | Path: |
Historical#
Time series per vault: APY, TVL and share price per point, and the USD price of the vault's asset.
| Capability | How to call | Required inputs |
|---|---|---|
| Fetch combined APY, TVL, and share-price history | GET /historical/{network}/{vaultId} | Path: |
| Fetch APY history only | GET /historical/{network}/{vaultId}/apy | Path: |
| Fetch TVL history only | GET /historical/{network}/{vaultId}/tvl | Path: |
| Fetch share-price history only | GET /historical/{network}/{vaultId}/sharePrice | Path: |
| Fetch historical underlying asset prices | GET /historical/asset-prices/{network}/{assetAddress} | Path: |
Benchmarks#
Network reference rates: the baseline yield of USD and ETH deposits on one chain, current and daily history.
| Capability | How to call | Required inputs |
|---|---|---|
| Fetch the current benchmark rate for a network | GET /benchmarks/{network} | Path: |
| Fetch historical benchmark rates for a network | GET /historical-benchmarks/{network} | Path: |
Fixed Term#
Pendle principal-token (PT) markets: the fixed APY a buyer locks in until expiry, with TVL and liquidity. One entry per maturity; markets are read once a day at 00:00 UTC.
| Capability | How to call | Required inputs |
|---|---|---|
| List active Pendle PT markets with fixed APY, expiry, TVL and liquidity | GET /fixed-term | Optional query: |
| Get one Pendle PT market | GET /fixed-term/detailed/{network}/{vaultId} | Path: |
Errors#
Failed requests return JSON with error. 400 means a parameter is invalid or the network is unknown, 401 means the key is missing or rejected, 404 means no vault, asset or rate matched, and 500 means the service failed.