Skip to main content
GET
Get earn vault position

Authorizations

Authorization
string
header
required

Basic Auth header with your app ID as the username and your app secret as the password.

Headers

privy-app-id
string
required

ID of your Privy app.

Path Parameters

wallet_id
string
required

ID of the wallet.

Query Parameters

vault_id
string
required

The vault ID to get position for.

include_archived
boolean

Include archived wallets in lookup. Defaults to false.

Response

200 - application/json

Earn vault position retrieved successfully.

A wallet's position in an earn vault.

asset
EarnAsset · object
required

Asset metadata for an earn vault position.

Example:
total_deposited
string
required

Total amount deposited into the vault, in smallest unit.

total_withdrawn
string
required

Total amount withdrawn from the vault, in smallest unit.

assets_in_vault
string
required

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

shares_in_vault
string
required

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