Vault Information

The Vault Information (GET /v1/vaults/{network}/{vaultAddress}) endpoint is a targeted query service within the vaults.fyi API that provides detailed information on a specific vault, identified by its unique address and the network it resides on.

Parameters

• vaultAddress (required): The unique address of the vault whose information you want to retrieve. This is a path parameter included in the endpoint URL.

• network (required): The name of the network on which the vault exists. This parameter is also part of the path URL and supports a predefined set of network names such as mainnet, arbitrum, optimism, polygon, base, and gnosis.

Responses

• 200 OK: A successful response will return a JSON object that thoroughly describes the vault, encompassing a range of information from basic details to more specific attributes like financial statistics and associated tags.

The response will typically look like this:

{
  "name": "string",
  "address": "string",
  "network": "mainnet",
  "protocol": "string",
  "tvlDetails": {
    "tvlNative": "string",
    "tvlUsd": "string",
    "lockedNative": "string",
    "lockedUsd": "string",
    "liquidNative": "string",
    "liquidUsd": "string"
  },
  "tvl": "string",
  "liquid": "string",
  "locked": "string",
  "numberOfHolders": 0,
  "topHolders": [
    {
      "address": "string",
      "balance": "string"
    }
  ],
  "lendLink": "string",
  "tags": [
    "string"
  ],
  "token": {
    "name": "string",
    "assetAddress": "string",
    "symbol": "string",
    "decimals": 0
  },
  "apy": {
    "base": {
      "1day": 0,
      "7day": 0,
      "30day": 0
    },
    "rewards": {
      "1day": 0,
      "7day": 0,
      "30day": 0
    },
    "total": {
      "1day": 0,
      "7day": 0,
      "30day": 0
    }
  },
  "description": "string",
  "rewards": [
    {
      "apy": {
        "1day": 0,
        "7day": 0,
        "30day": 0
      },
      "assetPriceInUsd": 0,
      "asset": {
        "name": "string",
        "assetAddress": "string",
        "symbol": "string",
        "decimals": 0
      }
    }
  ]
}

In this data structure:

• name, address, and network provide the basic identification of the vault.

• tvlDetails is an array of data on "Total value locked" in the vault in both native token and USD terms.

• liquid and locked offer insights into the liquidity and lock-up status of assets within the vault. (Sometimes it is impossible to estimate liquid/locked values precisely. In conditions where some portion of the TVL is "uncertain", the proportion would always lean towards putting it as locked value.)

• numberOfHolders reveals the number of unique depositors.

• lendLink could be a URL or identifier linking to lending opportunities or additional information.

• tags is an array of strings providing categorizations or features of the vault.

• token is an object detailing the associated token with name, assetAddress, symbol, and decimals.

• apy is an object that contains the annual percentage yield for the past 1, 7, and 30 days, broken down into base, rewards and total APY.

• rewards is an array of objects that contain:

  • apy is an object that contains the annual percentage yield for the past 1, 7, and 30 days.

  • assetPriceInUsd is the most recent price of the reward token denominated in USD with 1e8 precision.

  • asset is an object detailing the associated reward token with name, assetAddress, symbol, and decimals.

This endpoint is invaluable for users or applications that need to extract and display specific vault data or for conducting in-depth analysis on individual vaults within the DeFi space.