Sign in

v1

latestOpenAPI 3.0.02026-07-2442138225.7 KB
Portfolio

Get historical balance snapshots for a yield

Returns a chronological time series of balance snapshots for a wallet address within a yield. Each entry reflects the position at a specific timestamp or block. Supports configurable sampling intervals and point-in-time queries. Only available for ERC4626 vaults with indexed transfer history.

get/v1/yields/{yieldId}/balances/history

Path parameters

yieldIdstring required

The unique identifier of the yield

Query parameters

addressstring required

Wallet address to fetch history for

fromstring

Start of time range (ISO 8601)

tostring

End of time range (ISO 8601). Defaults to now.

blockNumbernumber

Block number for a point-in-time snapshot. When provided, from/to/interval are ignored.

feeConfigurationIdstring

Fee configuration ID used to select allocator vault contract history. Falls back to default fee configuration.

interval'block' | 'hour' | 'day' | 'week'

Sampling resolution for the time series

sort'asc' | 'desc'

Sort order by timestamp. Defaults to most recent first (desc).

limitnumber

Maximum number of items to return (default 30, max 100)

offsetnumber

Pagination offset

Response

Returns a paginated time series of balance snapshots

totalnumber required

Total number of items available

offsetnumber required

Offset of the current page

limitnumber required

Limit of the current page

Example response

{
  "total": 150,
  "limit": 100,
  "items": [
    {
      "timestamp": "2025-07-12T00:00:00.000Z",
      "blockNumber": 20540000,
      "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
        }
      ],
      "periodDelta": {
        "shareAmount": "1.000000000000000000",
        "shareAmountRaw": "1000000000000000000",
        "amount": "0.050000000000000000",
        "amountRaw": "50000000000000000"
      }
    }
  ]
}