Sign in

v1

latestOpenAPI 3.0.02026-07-2442138225.7 KB
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 body

providerId'hyperliquid' | 'hyperliquid-xyz'

Single provider identifier. At least one of providerId or providerIds must be provided.

providerIdsstring[]

Single provider only (one CSV value, one repeated param, or a one-element JSON array). At least one of providerId or providerIds must be provided. Must not combine with a different providerId.

addressstring required

User wallet address

Example request

{
  "providerId": "hyperliquid",
  "providerIds": [
    "hyperliquid"
  ],
  "address": "0x1234..."
}

Response

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

Example response

{
  "items": [
    {
      "yieldId": "ethereum-eth-lido-staking",
      "balances": [
        {
          "providerId": "hyperliquid",
          "collateral": {
            "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
            "symbol": "USDC",
            "name": "USD Coin",
            "decimals": 6
          },
          "accountValue": 1280.44,
          "usedMargin": 320.13,
          "availableBalance": 960.31,
          "unrealizedPnl": 12.8
        }
      ],
      "outputTokenBalance": {
        "providerId": "hyperliquid",
        "collateral": {
          "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
          "symbol": "USDC",
          "name": "USD Coin",
          "decimals": 6
        },
        "accountValue": 1280.44,
        "usedMargin": 320.13,
        "availableBalance": 960.31,
        "unrealizedPnl": 12.8
      },
      "rewardRate": {
        "total": 6.5,
        "rateType": "APR",
        "components": [
          {
            "rate": 0.04,
            "rateType": "APR",
            "token": {
              "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
              "symbol": "USDC",
              "name": "USD Coin",
              "decimals": 6
            },
            "yieldSource": "protocol_incentive",
            "description": "LDO distributed to incentivize stETH adoption via Lido Boost"
          }
        ]
      }
    }
  ],
  "errors": [
    {
      "yieldId": "ethereum-compound-usdc",
      "error": "Failed to fetch data from blockchain: RPC timeout"
    }
  ]
}