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
    • Gauntlet
  • Plans
    • Credits
      • Credits (v1 endpoints)
  • Links
    • vaults.fyi
    • X
    • Farcaster
    • Wallfacer Labs
Powered by GitBook
On this page
  1. API
  2. Introduction
  3. Market data
  4. Insights (Basic)
  5. General Endpoints

List Vaults

The List Vaults (GET /v1/vaults) endpoint provides a versatile tool for fetching a curated list of DeFi vaults based on specific criteria set by the user. By leveraging a series of query parameters, users can fine-tune their search to pinpoint vaults that match their exact needs. Below is a breakdown of the available parameters and the expected response:

Parameters

  • tags: An array of strings allowing users to filter vaults that are tagged with specified attributes. To return results, all listed tags must be associated with the vault.

  • token: A string representing the token name or symbol. This parameter filters the vaults by the specific token they use.

  • network: A string value denoting the blockchain network. You can filter vaults that are active on networks such as mainnet, arbitrum, optimism, polygon, base, gnosis, and others as listed in the Available values.

  • tvl_min: A numeric field specifying the minimum Total Value Locked (TVL) in USD that a vault must have to be included in the results.

  • tvl_max: A numeric field indicating the maximum TVL in USD to filter the vaults, providing an upper boundary for the search.

All parameters are optional.

Responses

  • 200 OK: Success response returns an array of objects, each containing the vault's address and the network it belongs to. The response is in JSON format, which is specified by the Accept header in the request.

The response data structure consists of:

[
  {
    "address": "string",
    "network": "string"
  }
]

Each object in the array represents a vault, where address is the unique identifier for the vault on the blockchain, and network is the name of the blockchain network the vault is part of.

Utilizing this endpoint, users can effectively sort and access a wide array of vault information, allowing for a high degree of customization for those building financial tools, applications, or conducting market research in the DeFi space.

Last updated 1 year ago