Get balances across multiple yields and networks

post

https://api.yield.xyz/v1/yields/balances

Retrieve balances for multiple wallet addresses across different networks and yield opportunities. Send an array of balance requests - each request can specify a yieldId (optional for chain scanning), address, network, and custom arguments. This is the same format as the single yield balance endpoint but in array form. Duplicate requests (same yieldId + address + network) are automatically deduplicated, with specific yield requests taking precedence over chain scans.

Body Params

Request containing an array of balance queries. Each query contains: yieldId (optional), address (required), network (required), and arguments (optional). When yieldId is omitted, all yields for that network will be scanned. You can mix chain scans with specific yield queries - duplicates are automatically deduplicated with specific queries taking precedence.

queries

array of objects

required

length between 1 and 25

Array of balance queries (maximum 25 queries per request)

queries*

yieldId

string

The unique identifier of the yield (optional for chain scanning)

address

string

required

User wallet address to check balances for

network

string

enum

required

Network for this address

arguments

object

Arguments for balance queries

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns balances grouped by yield with detailed error information for failed yields. Only yields with non-zero balances are included in the response.

400Invalid request parameters

401Invalid or missing API key

429Rate limit exceeded

500Internal server error