Detailed Vaults Data

The Detailed Vaults Data (GET /v1/detailed/vaults) endpoint offers a granular view of DeFi vaults, curated based on a selection of filter parameters. This endpoint is designed for users who require in-depth information on vaults, including their financial statistics and operational details.

Parameters

• tags: An array of strings that allows for filtering of vaults by specific characteristics. All tags listed must be associated with the vault to appear in the results.

• token: A string indicating the token's name or symbol, allowing for filtering based on the specific token a vault operates with.

• network: A string to filter by the blockchain network name. Supported networks include mainnet, arbitrum, optimism, polygon, base, gnosis, among others.

• tvl_min: A numeric value setting the lower limit for the Total Value Locked (TVL) in USD a vault must have to be considered in the response.

• tvl_max: A numeric value setting the upper limit for the TVL in USD to refine the search.

• page: An integer indicating the page number of results, enabling pagination in the response.

• per_page: An integer dictating the number of items to display per page. This controls the chunk size of the paginated results.

All parameters are optional.

Responses

• 200 OK: The successful response contains a JSON array of detailed vault objects along with pagination information. It provides a multi-faceted view of each vault, including addresses, financial metrics, and other pertinent information.

The response structure typically looks like this:

{
  "next_page": 0,
  "data": [
    {
      "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,
      "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 structure:

• next_page indicates the page number to query next for more results.

• data is an array where each item is a vault object containing detailed attributes such as the vault's address, name, network, token (with detailed token information), and tvl (with the amount and its equivalent in USD).

The Detailed Vaults Data endpoint is crucial for users requiring extensive data for in-depth analysis or for applications that need to provide detailed information to their users.