Skip to main content

getSubVaults

Description:

Returns the list of sub vaults for a given meta vault.

Arguments:

NameTypeRequiredDescription
vaultAddressstringYesThe address of the meta vault
limitnumberYesLimits the number of sub vaults returned
skipnumberYesSkips the specified number of sub vaults

Returns:

type Output = Array<{
id: string
apy: string
imageUrl: string
displayName: string
stakingAssets: bigint
exitingAssets: bigint
}>
NameDescription
idAddress of vault
apyCurrent vault apy
imageUrlLink for vault logo
displayNameName of vault
stakingAssetsThe amount of assets staking in the sub vault
exitingAssetsThe total number of assets that are exiting the sub vault

Example:

await sdk.vault.getSubVaults({
skip: 0,
limit: 20,
vaultAddress: '0x...'
})