Get vault position

Once Privy confirms a deposit, your app can query the wallet’s holdings using the get position endpoint. The assets_in_vault field shows the current redeemable value, including accrued yield.

View the full API reference for the get position endpoint.

Usage

REST API

To check a wallet’s position via REST API, make a GET request to:

https://api.privy.io/api/v1/wallets/{wallet_id}/earn/ethereum/vaults?vault_id={vault_id}

Parameters

string

required

The unique identifier for the vault.

Returns

object

The vault’s underlying asset, with address, symbol, and decimals fields.

string

Total amount deposited into the vault through Privy Earn, in the token’s smallest unit.

string

Total amount withdrawn from the vault through Privy Earn, in the token’s smallest unit.

string

Current redeemable value of the wallet’s vault shares, including accrued yield.

string

Number of vault shares held by the wallet.

Example

curl https://api.privy.io/api/v1/wallets/{wallet_id}/earn/ethereum/vaults?vault_id={vault_id} \
  -H "privy-app-id: <your-app-id>" \
  -H "Authorization: Basic <credentials>"

Example response

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

Display balances

Field	What it represents	How to use it
`assets_in_vault`	Current redeemable value including yield	Show this as the user’s current balance
`total_deposited`	Sum of Privy Earn deposits	Use as the user’s cost basis
`total_withdrawn`	Sum of Privy Earn withdrawals	Subtract from `total_deposited` for net contributions
`shares_in_vault`	Raw vault shares held	Rarely shown to users — use `assets_in_vault` instead

Privy computes total_deposited and total_withdrawn from the deposits and withdrawals made through the Privy Earn deposit and withdraw endpoints. Deposits and withdrawals made directly onchain are not counted. assets_in_vault and shares_in_vault are read live from the vault contract, so they include all activity. If wallets interact with a vault outside Privy Earn, see Reading Earn vault totals onchain to compute totals that include all activity.

Calculate earned yield

To display how much yield a wallet has earned:

earned_yield = assets_in_vault - (total_deposited - total_withdrawn)

For example, if a wallet deposited 1,000 USDC, withdrew 200 USDC, and assets_in_vault is 850 USDC:

earned_yield = 850 - (1000 - 200) = 850 - 800 = 50 USDC

All amounts are in the token’s smallest unit. For USDC (6 decimals), divide by 10^6 before displaying to users. For example, 1050000 equals 1.05 USDC.

Next steps

Get vault details

Retrieve vault-level information like APY, TVL, and available liquidity.

Get started

Vault actions

Positions and monitoring

Providers

Usage

Parameters

Returns

Example

Display balances

Calculate earned yield

Next steps

Get vault details

​Usage

​Parameters

​Returns

​Example

​Display balances

​Calculate earned yield

​Next steps

Get vault details

Usage

Parameters

Returns

Example

Display balances

Calculate earned yield

Next steps