YieldGetAggregateBalances returns a wallet's earn positions across chains.
Earn
YieldGetAggregateBalances
Fetch a wallet’s earn balances across chains and yield positions
POST
YieldGetAggregateBalances returns a wallet's earn positions across chains.
Overview
YieldGetAggregateBalances returns a wallet’s active yield positions across one or more chains. Use this to show users their current DeFi holdings — principal, earned yield, and which markets they are in.
The SDK’s useEarnBalances hook wraps this endpoint — prefer it in React apps.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
queries | object[] | Yes | Array of 1–25 balance queries |
| Field | Type | Required | Description |
|---|---|---|---|
address | string | Yes | Wallet address to look up |
network | string | Yes | Network identifier (e.g. "ethereum", "base", "polygon") |
You can pass up to 25 queries per request, enabling multi-chain balance lookups in a single call.
Response
Returnspayload containing balance records. Each balance entry includes:
| Field | Description |
|---|---|
yieldId | Market ID — matches the id field from YieldGetMarkets |
address | Wallet address |
network | Network the position is on |
amount | Balance amount in the market’s token |
amountUsd | USD value of the position |
Examples
Fetch balances on a single chain
Multi-chain balance lookup
SDK alternative
In React, use theuseEarnBalances hook:
See also
- YieldGetMarkets — Match
yieldIdagainst market IDs - YieldCreateExitAction — Build withdrawal transactions for active positions
- Markets & Providers — SDK hooks reference