Skip to main content

getYieldDetails

Gets full details for one Earn vault: registry data (contract address, curator, underlying asset) merged with live protocol data (netApy, netApyExcludingRewards, tvlUsd) on a best-effort basis — these fields may be omitted if that data is temporarily unavailable.

Usage

Parameters

Returns

Promise<YieldVaultDetails> - The vault’s full details.
getYieldDetails throws (via the underlying request) when vaultId doesn’t resolve to a vault accessible to the current environment — an unrecognized ID or a private vault scoped to a different environment look the same to the caller.

Examples

Format an amount using assetDecimals

React

Last modified on August 26, 2026