API Reference
Log inRegister interest

Get historical balance snapshots for a yield

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

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.

Path Params
string
required

The unique identifier of the yield

Query Params
string
required

Wallet address to fetch history for

string

Start of time range (ISO 8601)

string

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

number

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

string

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

string
enum

Sampling resolution for the time series

Allowed:
string
enum

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

Allowed:
number
1 to 100
Defaults to 30

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

number
≥ 0
Defaults to 0

Pagination offset

Responses

404

Yield not found with the specified ID

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?