Wallet Actions

Get earn vault position

Changed on

Retrieve a wallet's current position in a specific earn vault, including deposit/withdraw totals and current onchain vault shares.

get/v1/wallets/{wallet_id}/earn/ethereum/vaults

Request

  • Base URL
    https://api.privy.io
  • URL
    https://api.privy.io/v1/wallets/{wallet_id}/earn/ethereum/vaults
  • Auth
    HTTP basic

Path parameters

wallet_idstring required

ID of the wallet.

Query parameters

vault_idstring required

The vault ID to get position for.

include_archivedboolean

Include archived wallets in lookup. Defaults to false.

Headers

privy-app-idstring required

ID of your Privy app.

Response

Earn vault position retrieved successfully.

apy_bpsinteger

Wallet-specific net APY in basis points, rounded to the nearest integer. Returned together with apy_allocation when available.

total_depositedstring required

Total amount deposited into the vault, in smallest unit.

total_withdrawnstring required

Total amount withdrawn from the vault, in smallest unit.

assets_in_vaultstring required

Current asset value in the vault (realtime from ERC-4626), in smallest unit.

shares_in_vaultstring required

Current vault shares held (realtime from ERC-4626).

Example response

{
  "asset": {
    "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
    "symbol": "usdc",
    "decimals": 6
  },
  "apy_bps": 617,
  "apy_allocation": [
    {
      "apy_bps": 700,
      "assets_in_vault": "25000000000",
      "type": "boost"
    },
    {
      "apy_bps": 200,
      "assets_in_vault": "5000000000",
      "type": "base"
    }
  ],
  "total_deposited": "30000000000",
  "total_withdrawn": "0",
  "assets_in_vault": "30000000000",
  "shares_in_vault": "1000000000000000000"
}

Changes

  • 4facbfa7f9d4Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 41cbc1e43b72Revision changes
    • info

      added the new optional query request parameter include_archived