Detailed Vaults

Last updated 3 days ago

get

Retrieves a comprehensive list of vaults with detailed performance metrics including APY, TVL, rewards, risk scores, and protocol information based on specified filters.

Authorizations

Query parameters

pageintegerOptional

Page number (starting from 0)

Default: 0

perPageinteger · max: 5000Optional

Number of items per page

Default: 5000

allowedAssetsstring[]Optional

Assets to be included by symbol(ticker).

disallowedAssetsstring[]Optional

Assets to be excluded by symbol(ticker). The parameter is ignored if "allowedAssets" is specified.

allowedProtocolsstring[]Optional

Protocols to be included by name.

disallowedProtocolsstring[]Optional

Protocols to be excluded by name. The parameter is ignored if "allowedProtocols" is specified.

minTvlintegerOptional

Minimum TVL in USD of the vaults to be included

onlyTransactionalbooleanOptional

Include only vaults that are supported in the transactional interface.

onlyAppFeaturedbooleanOptional

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

maxTvlintegerOptional

Maximum TVL in USD of the vaults to be included

tagsstring[]Optional

Tags to be included.

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/detailed-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,
      "name": "text",
      "protocol": {
        "name": "text",
        "product": "text",
        "version": "text",
        "protocolUrl": "text",
        "description": "text",
        "protocolLogo": "text"
      },
      "lendUrl": "text",
      "description": "text",
      "protocolVaultUrl": "text",
      "tags": [
        "text"
      ],
      "holdersData": {
        "totalCount": 1,
        "totalBalance": "text",
        "topHolders": [
          {
            "address": "text",
            "lpTokenBalance": "text"
          }
        ]
      },
      "apy": {
        "1day": {
          "base": 1,
          "reward": 1,
          "total": 1
        },
        "7day": {
          "base": 1,
          "reward": 1,
          "total": 1
        },
        "30day": {
          "base": 1,
          "reward": 1,
          "total": 1
        }
      },
      "tvl": {
        "usd": "text",
        "native": "text"
      },
      "rewards": [
        {
          "asset": {
            "address": "text",
            "assetCaip": "text",
            "name": "text",
            "symbol": "text",
            "decimals": 1,
            "assetLogo": "https://example.com",
            "assetPriceInUsd": "text"
          },
          "apy": {
            "1day": 1,
            "7day": 1,
            "30day": 1
          }
        }
      ],
      "score": {
        "vaultScore": 1,
        "vaultTvlScore": 1,
        "protocolTvlScore": 1,
        "holderScore": 1,
        "networkScore": 1,
        "assetScore": 1
      },
      "additionalIncentives": "text",
      "lpToken": {
        "address": "text",
        "tokenCaip": "text",
        "name": "text",
        "symbol": "text",
        "decimals": 1
      },
      "childrenVaults": [
        {
          "address": "text",
          "asset": {
            "address": "text",
            "assetCaip": "text",
            "name": "text",
            "symbol": "text",
            "decimals": 1,
            "assetLogo": "https://example.com",
            "assetPriceInUsd": "text"
          },
          "lpToken": {
            "address": "text",
            "tokenCaip": "text",
            "name": "text",
            "symbol": "text",
            "decimals": 1
          },
          "additionalAssets": [
            {
              "address": "text",
              "assetCaip": "text",
              "name": "text",
              "symbol": "text",
              "decimals": 1,
              "assetLogo": "https://example.com",
              "assetPriceInUsd": "text"
            }
          ]
        }
      ],
      "additionalAssets": [
        {
          "address": "text",
          "assetCaip": "text",
          "name": "text",
          "symbol": "text",
          "decimals": 1,
          "assetLogo": "https://example.com",
          "assetPriceInUsd": "text"
        }
      ]
    }
  ],
  "errors": {
    "unsupportedNetworks": [
      "text"
    ],
    "unsupportedAssets": [
      "text"
    ],
    "unsupportedProtocols": [
      "text"
    ]
  }
}

get

Retrieves a detailed performance metrics of single vault including APY, TVL, rewards, risk scores, and protocol information based on specified filters.

Authorizations

Path parameters

networkstring · enumRequired

Include only vaults with provided network(name or CAIP)

Possible values:

vaultAddressstringRequired

Address of the vault for which the data will be returned

Pattern: ^0x[a-fA-F0-9]{40}$

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/detailed-vaults/{network}/{vaultAddress} HTTP/1.1
Host: api.vaults.fyi
x-api-key: YOUR_API_KEY
Accept: */*

{
  "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,
  "name": "text",
  "protocol": {
    "name": "text",
    "product": "text",
    "version": "text",
    "protocolUrl": "text",
    "description": "text",
    "protocolLogo": "text"
  },
  "lendUrl": "text",
  "description": "text",
  "protocolVaultUrl": "text",
  "tags": [
    "text"
  ],
  "holdersData": {
    "totalCount": 1,
    "totalBalance": "text",
    "topHolders": [
      {
        "address": "text",
        "lpTokenBalance": "text"
      }
    ]
  },
  "apy": {
    "1day": {
      "base": 1,
      "reward": 1,
      "total": 1
    },
    "7day": {
      "base": 1,
      "reward": 1,
      "total": 1
    },
    "30day": {
      "base": 1,
      "reward": 1,
      "total": 1
    }
  },
  "tvl": {
    "usd": "text",
    "native": "text"
  },
  "rewards": [
    {
      "asset": {
        "address": "text",
        "assetCaip": "text",
        "name": "text",
        "symbol": "text",
        "decimals": 1,
        "assetLogo": "https://example.com",
        "assetPriceInUsd": "text"
      },
      "apy": {
        "1day": 1,
        "7day": 1,
        "30day": 1
      }
    }
  ],
  "score": {
    "vaultScore": 1,
    "vaultTvlScore": 1,
    "protocolTvlScore": 1,
    "holderScore": 1,
    "networkScore": 1,
    "assetScore": 1
  },
  "additionalIncentives": "text",
  "lpToken": {
    "address": "text",
    "tokenCaip": "text",
    "name": "text",
    "symbol": "text",
    "decimals": 1
  },
  "childrenVaults": [
    {
      "address": "text",
      "asset": {
        "address": "text",
        "assetCaip": "text",
        "name": "text",
        "symbol": "text",
        "decimals": 1,
        "assetLogo": "https://example.com",
        "assetPriceInUsd": "text"
      },
      "lpToken": {
        "address": "text",
        "tokenCaip": "text",
        "name": "text",
        "symbol": "text",
        "decimals": 1
      },
      "additionalAssets": [
        {
          "address": "text",
          "assetCaip": "text",
          "name": "text",
          "symbol": "text",
          "decimals": 1,
          "assetLogo": "https://example.com",
          "assetPriceInUsd": "text"
        }
      ]
    }
  ],
  "additionalAssets": [
    {
      "address": "text",
      "assetCaip": "text",
      "name": "text",
      "symbol": "text",
      "decimals": 1,
      "assetLogo": "https://example.com",
      "assetPriceInUsd": "text"
    }
  ]
}

get

Retrieves vault APY breakdown.

Authorizations

Path parameters

networkstring · enumRequired

Include only vaults with provided network(name or CAIP)

Possible values:

vaultAddressstringRequired

Address of the vault for which the data will be returned

Pattern: ^0x[a-fA-F0-9]{40}$

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/detailed-vaults/{network}/{vaultAddress}/apy HTTP/1.1
Host: api.vaults.fyi
x-api-key: YOUR_API_KEY
Accept: */*

{
  "1day": {
    "base": 1,
    "reward": 1,
    "total": 1
  },
  "7day": {
    "base": 1,
    "reward": 1,
    "total": 1
  },
  "30day": {
    "base": 1,
    "reward": 1,
    "total": 1
  }
}

get

Retrieves vault Tvl breakdown.

Authorizations

Path parameters

networkstring · enumRequired

Include only vaults with provided network(name or CAIP)

Possible values:

vaultAddressstringRequired

Address of the vault for which the data will be returned

Pattern: ^0x[a-fA-F0-9]{40}$

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/detailed-vaults/{network}/{vaultAddress}/tvl HTTP/1.1
Host: api.vaults.fyi
x-api-key: YOUR_API_KEY
Accept: */*

{
  "usd": "text",
  "native": "text"
}