List vaults

List supported vault identifiers.

GEThttps://api-v2.syncrone.fi/api/catalog/vaults

Every vault in the catalog with its network and asset. Use it to discover coverage and the vaultId each vault is addressed by.

← Vaults API overview

Try it#

GET/vaults?perPage=3&network=mainnet

API keyx-api-key

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

Parameters

pagequery

perPagequery

networkquery

assetSymbolquery

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/vaults?perPage=3&network=mainnet" \
  -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 /vaults?perPage=3&network=mainnet

{
  "itemsOnPage": 3,
  "nextPage": 1,
  "data": [
    {
      "vaultId": "0x6914ECCf50837dC61b43ee478a9BD9B439648956",
      "address": "0x6914ECCf50837dC61b43ee478a9BD9B439648956",
      "name": "Aave EtherFi Ethereum FRAX",
      "network": {
        "name": "mainnet",
        "chainId": 1,
        "networkCaip": "eip155:1"
      },
      "asset": {
        "address": "0x853d955aCEf822Db058eb8505911ED77F175b99e",
        "assetCaip": "eip155:1/erc20:0x853d955aCEf822Db058eb8505911ED77F175b99e",
        "name": "Frax",
        "symbol": "FRAX",
        "decimals": 18,
        "assetLogo": "https://raw.githubusercontent.com/bgd-labs/web3-icons/main/icons/full/frax.svg",
        "assetPriceInUsd": "0.993",
        "assetGroup": "USD"
      },
      "benchmarkId": "46fb6399-2cbc-4848-94fe-0bdae03256ea",
      "slug": "aave-etherfi-eth-frax"
    },
    {
      "vaultId": "0x7380c583cDe4409eFF5DD3320D93a45D96B80E2e",
      "address": "0x7380c583cDe4409eFF5DD3320D93a45D96B80E2e",
      "name": "Aave EtherFi 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": "15b139b6-e544-4638-ba6e-ce5975a77750",
      "slug": "aave-etherfi-eth-usdc"
    },
    {
      "vaultId": "0xbe1F842e7e0afd2c2322aae5d34bA899544b29db",
      "address": "0xbe1F842e7e0afd2c2322aae5d34bA899544b29db",
      "name": "Aave EtherFi Ethereum weETH",
      "network": {
        "name": "mainnet",
        "chainId": 1,
        "networkCaip": "eip155:1"
      },
      "asset": {
        "address": "0xCd5fE23C85820F7B72D0926FC9b05b43E359b7ee",
        "assetCaip": "eip155:1/erc20:0xCd5fE23C85820F7B72D0926FC9b05b43E359b7ee",
        "name": "EtherFi wrapped ETH",
        "symbol": "weETH",
        "decimals": 18,
        "assetLogo": "https://static.debank.com/image/eth_token/logo_url/0xcd5fe23c85820f7b72d0926fc9b05b43e359b7ee/44da129be16d522a3255d2c066f2049a.png",
        "assetPriceInUsd": "2707.6017",
        "assetGroup": "ETH"
      },
      "benchmarkId": "f925500f-ddd6-4a8d-9394-daebfd993c2f",
      "slug": "aave-etherfi-eth-weeth"
    }
  ]
}

Parameters#

Name	Type	Description
pagequery	`integer`	Page number, starting from 0. default: 0
perPagequery	`integer`	Items per page, 1 to 1000. default: 50
networkquery	`string`	Only vaults on this network (name, CAIP-2 id or chain id).
assetSymbolquery	`string`	Only vaults whose asset has this symbol, case-insensitive.

Response#

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

Field	Type	Description
itemsOnPage	`integer`	Number of items in `data`.
nextPage	`integer`	Next page number. Absent on the last page.
data[].vaultId	`string`	Id to use in `{vaultId}` paths: the address, else the slug.
data[].address	`string \| null`	Vault address, checksummed.
data[].name	`string`	Vault name.
data[].network.name	`string`	Network name.
data[].network.chainId	`integer`	EVM chain id.
data[].network.networkCaip	`string`	CAIP-2 id, e.g. `eip155:1`.
data[].asset.address	`string`	Token address, checksummed.
data[].asset.assetCaip	`string`	CAIP-19 id of the token.
data[].asset.name	`string`	Token name.
data[].asset.symbol	`string`	Token symbol.
data[].asset.decimals	`integer`	Token decimals.
data[].asset.assetLogo	`string \| null`	Logo URL.
data[].asset.assetPriceInUsd	`string \| null`	USD price on the vault's latest bar: USD TVL divided by native TVL.
data[].asset.assetGroup	`string`	`USD`, `ETH`, `BTC`, `EUR` or `OTHER`: the currency the asset is worth, from its price against $1, ETH and BTC.
data[].benchmarkId	`string`	Syncrone benchmark id, for the benchmark endpoints of the main API.
data[].slug	`string`	Syncrone benchmark slug.

Errors#

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

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

← PreviousOverview Next →List assets