vaults.fyi
  • General
    • ๐ŸฆOverview
    • ๐Ÿ’กUse Cases
      • For Wallets and Apps
      • For Analysts
      • For Protocols & Product Teams
    • ๐Ÿ”ŽMethodology
      • vaults.fyi USD benchmark rate
      • vaults.fyi ETH benchmark rate
    • โ“FAQ
      • Vault requirements for inclusion on vaults.fyi
    • ๐Ÿค–AI
  • API
    • Introduction
      • Market data
      • Transactional support
      • Portfolio tracking
      • Personalized insights
  • Endpoints
    • General
    • Detailed Vaults
    • Historical
    • Portfolio
    • Transactions
    • Legacy (v1) endpoints
      • v1 Market data
        • Get historical data
          • Get historical APY and TVL data on single vault over timestamp range
          • Get historical APY on single vault over timestamp range
          • Get historical TVL on single vault at single timestamp
          • Get historical APY on single vault at single timestamp
        • Get data for multiple vaults
        • Get data on single vault
          • Get APY on single vault
        • Get benchmark rates
        • Get supported vaults, networks & tokens
          • /vaults
          • /networks
          • /tokens
          • /tags
      • v1 Contextual insights
        • Top vault options for address
        • Get single top option for address
        • [Etherscan cards] Get top USD, top ETH vault for address
      • v1 Generate payloads
        • Prepare calldata
          • Supply/Deposit
          • Withdraw/Redeem
            • Request redeem
            • Claim redeem
          • Claim rewards
        • Get contract interaction details
        • Get supported assets
        • Get supported vaults
      • v1 Position tracking
        • Get user balances
        • Get user positions
        • Get list of past vault txns by user address
        • Get estimated returns for user's vault position
  • Case Studies
    • Kraken Wallet
    • Etherscan Cards
  • Plans
    • Credits
      • Credits (v1 endpoints)
  • Links
    • vaults.fyi
    • X
    • Farcaster
    • Wallfacer Labs
Powered by GitBook
On this page
  1. Endpoints

General

PreviousEndpointsNextDetailed Vaults

Last updated 3 days ago

get

Retrieves a filtered list of vaults with their basic information including address, network, associated asset details, and transactional support status.

Authorizations
Query parameters
pageintegerOptional

Page number (starting from 0)

Default: 0
perPageinteger ยท max: 5000Optional

Number of items per page

Default: 5000
networkstring ยท enumOptional

Include only vaults with provided network(name or CAIP)

Possible values:
assetSymbolstring ยท min: 1Optional

Include only vaults with an asset of provided symbol(ticker)

onlyTransactionalbooleanOptional

Include only vaults that are supported in the transactional interface.

onlyAppFeaturedbooleanOptional

Include only vaults that are featured in app.vaults.fyi

Responses
200
Default Response
application/json
400
Default Response
application/json
401
Default Response
application/json
403
Default Response
application/json
500
Default Response
application/json
get
GET //v2/vaults HTTP/1.1
Host: api.vaults.fyi
x-api-key: YOUR_API_KEY
Accept: */*
{
  "itemsOnPage": 1,
  "nextPage": 1,
  "data": [
    {
      "address": "text",
      "network": {
        "name": "mainnet",
        "chainId": 1,
        "networkCaip": "text"
      },
      "asset": {
        "address": "text",
        "assetCaip": "text",
        "name": "text",
        "symbol": "text",
        "decimals": 1,
        "assetLogo": "https://example.com",
        "assetPriceInUsd": "text"
      },
      "isTransactional": true,
      "isAppFeatured": true
    }
  ]
}
get

Retrieves a filtered list of supported assets with their metadata including address, symbol, name, decimals, and network information.

Authorizations
Query parameters
pageintegerOptional

Page number (starting from 0)

Default: 0
perPageinteger ยท max: 5000Optional

Number of items per page

Default: 5000
networkstring ยท enumOptional

Include only vaults with provided network(name or CAIP)

Possible values:
Responses
200
Default Response
application/json
400
Default Response
application/json
401
Default Response
application/json
403
Default Response
application/json
500
Default Response
application/json
get
GET //v2/assets HTTP/1.1
Host: api.vaults.fyi
x-api-key: YOUR_API_KEY
Accept: */*
{
  "itemsOnPage": 1,
  "nextPage": 1,
  "data": [
    {
      "address": "text",
      "assetCaip": "text",
      "name": "text",
      "symbol": "text",
      "decimals": 1,
      "assetLogo": "https://example.com",
      "assetPriceInUsd": "text",
      "network": {
        "name": "mainnet",
        "chainId": 1,
        "networkCaip": "text"
      }
    }
  ]
}
get

Retrieves a complete list of available vault categorization tags that can be used for filtering and organizing vault data

Authorizations
Responses
200
Tags of the vault
application/json
Responsestring[]

Tags of the vault

401
Default Response
application/json
500
Default Response
application/json
get
GET //v2/tags HTTP/1.1
Host: api.vaults.fyi
x-api-key: YOUR_API_KEY
Accept: */*
[
  "text"
]
get

Retrieves a complete list of supported blockchain networks with their identifiers including network name, chain ID, and CAIP format identifier.

Authorizations
Responses
200
List of supported networks
application/json
401
Default Response
application/json
500
Default Response
application/json
get
GET //v2/networks HTTP/1.1
Host: api.vaults.fyi
x-api-key: YOUR_API_KEY
Accept: */*
[
  {
    "name": "mainnet",
    "chainId": 1,
    "networkCaip": "text"
  }
]
  • GET/v2/vaults
  • GET/v2/assets
  • GET/v2/tags
  • GET/v2/networks