v1

latestOpenAPI 3.0.02026-07-2442138225.7 KB

Portfolio

Get balances for a specific yield

Retrieve all balances associated with a yield opportunity for a specific wallet address, including active, pending, claimable, and withdrawable balances. The network is automatically determined from the yield configuration.

post/v1/yields/{yieldId}/balances

Path parameters

yieldIdstring required

The unique identifier of the yield opportunity

Request body

addressstring required

User wallet address to check balances for

Example request

{
  "address": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
  "arguments": {
    "cAddressBech": "0x123...",
    "pAddressBech": "P-avax1...",
    "autoSweepDayOfMonth": 20,
    "autoSweepTimezone": "Europe/London"
  }
}

Response

Returns balance information including different balance types (active, entering, exiting, withdrawable, claimable, locked) with amounts and available actions

yieldIdstring required

Unique identifier of the yield

Example response

{
  "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"
      }
    ]
  }
}