Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.privy.io/llms.txt

Use this file to discover all available pages before exploring further.

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

Make a GET request to:
https://auth.privy.io/api/v1/ethereum_yield_vault/{vault_id}

​
Parameters

​
vault_id
string
required
The unique identifier for the vault.

​
Returns

​
id
string
The vault’s unique identifier.
​
name
string
Display name of the vault.
​
provider
string
The protocol powering the vault (e.g. "morpho").
​
vault_address
string
The onchain address of the vault contract.
​
asset_address
string
The address of the vault’s underlying token.
​
caip2
string
Chain identifier in CAIP-2 format.
​
user_apy
number
Current APY in basis points (e.g. 500 = 5%).
​
tvl_usd
number
Total value locked in the vault in USD.
​
available_liquidity_usd
number
Liquidity available for withdrawal in USD.

​
Example

curl https://auth.privy.io/api/v1/ethereum_yield_vault/{vault_id} \
  -H "privy-app-id: <your-app-id>" \
  -H "Authorization: Basic <credentials>"
Example response
{
  "id": "<your-vault-id>",
  "name": "Gauntlet USDC Prime",
  "provider": "morpho",
  "vault_address": "0x04422053aDDbc9bB2759b248B574e3FCA76Bc145",
  "asset_address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
  "caip2": "eip155:1",
  "user_apy": 500,
  "tvl_usd": 1000000,
  "available_liquidity_usd": 500000
}
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.