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:
In this data structure:
name
,address
, andnetwork
provide the basic identification of the vault.tvl
indicates the total value locked in the vault.liquid
andlocked
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 aslocked
value.)numDepositors
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 withname
,assetAddress
,symbol
, anddecimals
.apy
is an object that contains the annual percentage yield for the past 1, 7, and 30 days.rewards
is an array of objects that contain:apy
indicates the annual percentage yield for vault generated from the associated reward token.assetPriceInUsd
is the most recent price of the reward token denominated in USD with1e8
precision.asset
is an object detailing the associated reward token withname
,assetAddress
,symbol
, anddecimals
.
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.
Last updated