Yield

Get Ethereum Vault Details

Changed on

Retrieve detailed information about an ethereum yield vault, including current APY and liquidity.

get/v1/ethereum_yield_vault/{vault_id}

Request

  • Base URL
    https://api.privy.io
  • URL
    https://api.privy.io/v1/ethereum_yield_vault/{vault_id}
  • Auth
    HTTP basic

Path parameters

vault_idstring required

The Privy vault ID.

Headers

privy-app-idstring required

ID of your Privy app.

Response

Vault details retrieved successfully.

idstring required

Vault identifier.

namestring required

Human-readable vault name from the yield provider.

provider'morpho' | 'aave' | 'veda' required

Supported yield/lending protocol providers.

vault_addressstring required

On-chain vault contract address.

asset_addressstring required

Underlying asset token address.

caip2string required

Chain identifier (e.g., eip155:4217 for Tempo, eip155:8453 for Base).

user_apynumber nullable required

Current annual percentage yield in basis points (e.g., 500 for 5%). 1 basis point = 0.01%.

app_apynumber nullable required

Annual percentage yield earned by the app from vault fees, in basis points. Null when APY data is unavailable.

tvl_usdnumber nullable required

Total value locked in USD.

available_liquidity_usdnumber nullable required

Assets available for instant withdrawal in USD.

Example response

{
  "id": "cm7oxq1el000e11o8iwp7d0d0",
  "name": "Gauntlet USDC Prime",
  "provider": "morpho",
  "vault_address": "0x04422053aDDbc9bB2759b248B574e3FCA76Bc145",
  "asset_address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
  "caip2": "eip155:1",
  "user_apy": 500,
  "app_apy": 50,
  "tvl_usd": 1000000,
  "available_liquidity_usd": 500000
}

Changes