Yield

Get Ethereum Yield Vault Position

Changed on

Retrieve a wallet's current position in a specific ethereum yield vault. Returns the vault shares and asset values.

get/v1/wallets/{wallet_id}/ethereum_yield_vault

Request

  • Base URL
    https://api.privy.io
  • URL
    https://api.privy.io/v1/wallets/{wallet_id}/ethereum_yield_vault
  • 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

Yield position retrieved successfully.

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 ERC4626), in smallest unit.

shares_in_vaultstring required

Current vault shares held (realtime from ERC4626).

Example response

{
  "asset": {
    "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
    "symbol": "USDC"
  },
  "total_deposited": "1000000",
  "total_withdrawn": "0",
  "assets_in_vault": "1050000",
  "shares_in_vault": "1000000000000000000"
}

Changes