Get vault details

Use the get vault details endpoint to retrieve vault-level information like current APY, TVL, and available liquidity. This is useful for displaying vault metrics to users before they deposit, or for checking liquidity before initiating a large withdrawal.

View the full API reference for the get vault details endpoint.

Usage

REST API

Make a GET request to:

https://api.privy.io/api/v1/earn/ethereum/vaults/{vault_id}

Parameters

string

required

The unique identifier for the vault.

Returns

string

The vault’s unique identifier.

string

Display name of the vault.

"morpho" | "aave" | "veda"

The protocol powering the vault. Some response fields vary by provider (see below).

string

The onchain address of the vault contract.

object

The vault’s underlying asset.

Show Asset fields

string

The token contract address.

string

The token symbol (e.g. "usdc").

number

The number of decimals for the token.

string

Chain identifier in CAIP-2 format.

number | null

Current APY in basis points (e.g. 500 = 5%). See the note below on when this is null.

number | null

The application’s share of the APY in basis points. See the note below on when this is null.

number | null

Total value locked in the vault in USD. See the note below on when this is null.

number | null

Liquidity available for withdrawal in USD. See the note below on when this is null.

string

The ID of the vault’s admin wallet, which receives your app’s share of fees.

string

The onchain address of the vault’s admin wallet.

The following fields are provider-specific:

number

Morpho vaults only. Additional token-incentive rewards APR, in basis points.

string

Aave vaults only. Performance fees currently available for your app to collect, in the smallest unit of the underlying asset. This is your app’s share after the revenue split. Collect it with the collect fees endpoint.

For Morpho and Aave vaults, user_apy, app_apy, tvl_usd, and available_liquidity_usd are always populated. For Veda vaults, available_liquidity_usd is always null, and user_apy, app_apy, and tvl_usd may be null for the first 7–10 days after the vault is deployed, after which they are populated.

Example

curl https://api.privy.io/api/v1/earn/ethereum/vaults/{vault_id} \
  -H "privy-app-id: <your-app-id>" \
  -H "Authorization: Basic <credentials>"

Morpho vault

{
  "id": "<your-vault-id>",
  "name": "Gauntlet USDC Prime",
  "provider": "morpho",
  "vault_address": "0x04422053aDDbc9bB2759b248B574e3FCA76Bc145",
  "asset": {
    "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
    "symbol": "usdc",
    "decimals": 6
  },
  "caip2": "eip155:1",
  "user_apy": 500,
  "app_apy": 100,
  "tvl_usd": 1000000,
  "available_liquidity_usd": 500000,
  "admin_wallet_id": "<admin-wallet-id>",
  "admin_wallet_address": "0x1234abcd...",
  "total_rewards_apr": 50
}

Aave vault

{
  "id": "<your-vault-id>",
  "name": "Aave USDC",
  "provider": "aave",
  "vault_address": "0x1234567890123456789012345678901234567890",
  "asset": {
    "address": "0x1234567890abcdef1234567890abcdef12345678",
    "symbol": "usdc",
    "decimals": 6
  },
  "caip2": "eip155:8453",
  "user_apy": 420,
  "app_apy": 80,
  "tvl_usd": 250000,
  "available_liquidity_usd": 250000,
  "admin_wallet_id": "<admin-wallet-id>",
  "admin_wallet_address": "0x1234abcd...",
  "available_fees": "1500000"
}

Check available_liquidity_usd before initiating large withdrawals. If the vault’s lending markets are fully utilized, a withdrawal may partially fill or fail. See liquidity considerations for more details.

Next steps

Webhooks

Track deposit, withdrawal, and claim activity in real time.

Get started

Vault actions

Positions and monitoring

Providers

Usage

Parameters

Returns

Example

Next steps

Webhooks

​Usage

​Parameters

​Returns

​Example

​Next steps

Webhooks

Usage

Parameters

Returns

Example

Next steps