Skip to main content
GET
/
v1
/
earn
/
ethereum
/
vaults
/
{vault_id}
Get earn vault details
curl --request GET \
  --url https://api.privy.io/v1/earn/ethereum/vaults/{vault_id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'privy-app-id: <privy-app-id>'
{
  "id": "cm7oxq1el000e11o8iwp7d0d0",
  "name": "Gauntlet USDC Prime",
  "provider": "morpho",
  "vault_address": "0x460b523b670e751c1d7c85f24504825e24f64700",
  "asset": {
    "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
    "symbol": "usdc",
    "decimals": 6
  },
  "caip2": "eip155:8453",
  "user_apy": 500,
  "app_apy": 50,
  "tvl_usd": 64000000,
  "available_liquidity_usd": 64000000
}

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.

Detailed vault information including current APY, liquidity, and asset metadata.

​
id
string
required

Vault identifier.

​
name
string
required

Human-readable vault name from the yield provider.

​
provider
enum<string>
required

Supported earn provider protocols.

Available options:
morpho,
aave
​
vault_address
string
required

Onchain vault contract address.

​
asset
EarnAsset · object
required

Asset metadata for an earn vault position.

Example:
{
  "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
  "symbol": "usdc",
  "decimals": 6
}
​
caip2
string
required

CAIP-2 chain identifier (e.g. "eip155:8453").

​
user_apy
number | null
required

Current annual percentage yield 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.