Portfolio

Get balances across multiple yields and networks

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.

post/v1/yields/balances

Request

  • Base URL: https://api.yield.xyz
  • URL: https://api.yield.xyz/v1/yields/balances
  • Auth: API key in header x-api-key

Request body

Example request

{
  "queries": [
    {
      "yieldId": "ethereum-eth-lido-staking",
      "address": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
      "network": "ethereum"
    }
  ]
}

Response

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

Changes

No recorded changes to this operation across all 1 revision of this API.