Skip to main content
GET
Get earn vault details

Authorizations

Authorization
string
header
required

Basic Auth header with your app ID as the username and your app secret as the password.

Headers

privy-app-id
string
required

ID of your Privy app.

Path Parameters

vault_id
string
required

The Privy vault ID.

Response

200 - application/json

Vault details retrieved successfully.

Vault details for an Aave earn vault, including fee visibility.

id
string
required

Vault identifier.

name
string
required

Human-readable vault name from the yield provider.

vault_address
string
required

Onchain vault contract address.

asset
EarnAsset · object
required

Asset metadata for an earn vault position.

Example:
caip2
string
required

CAIP-2 chain identifier (e.g. "eip155:4217" for Tempo, "eip155:8453" for Base).

user_apy
number | null
required

Annual percentage yield available to the user, after fees and excluding rewards, in basis points (e.g. 500 for 5%). 1 basis point = 0.01%.

app_apy
number | null
required

Annual percentage yield earned by the app from fee wrapper fees, in basis points.

tvl_usd
number | null
required

Total value locked in USD.

available_liquidity_usd
number | null
required

Available liquidity in USD.

admin_wallet_id
string
required

Privy wallet ID of the vault admin.

admin_wallet_address
string
required

EVM address of the vault admin wallet.

provider
enum<string>
required
Available options:
aave
available_fees
string
required

Fees available to collect, in smallest unit of the underlying asset.