Wallet Actions

Get earn vault details

Changed on

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

get/v1/earn/ethereum/vaults/{vault_id}

Request

  • Base URL
    https://api.privy.io
  • URL
    https://api.privy.io/v1/earn/ethereum/vaults/{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.

OR
OR
OR

Example response

{
  "id": "cm7oxq1el000e11o8iwp7d0d0",
  "name": "Aave USDC Vault",
  "provider": "aave",
  "vault_address": "0x1234567890abcdef1234567890abcdef12345678",
  "asset": {
    "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
    "symbol": "usdc",
    "decimals": 6
  },
  "caip2": "eip155:8453",
  "user_apy": 500,
  "app_apy": 50,
  "tvl_usd": 64000000,
  "available_liquidity_usd": 64000000,
  "admin_wallet_id": "fmfdj6yqly31huorjqzq38zc",
  "admin_wallet_address": "0xabcdefabcdefabcdefabcdefabcdefabcdefabcd",
  "available_fees": "10000000"
}

Changes

  • 4facbfa7f9d4Revision changes
    • breaking

      added to the response body oneOf list for the response status

    • info

      added tempo mapping keys to the response discriminator for the response status

  • bb2eb34156ccRevision changes
    • breaking

      added to the response body oneOf list for the response status

    • info

      added veda mapping keys to the response discriminator for the response status