---
title: "Get reward history"
method: GET
path: "/v1/yields/{yieldId}/rewards/history"
tags: ["Portfolio"]
---

# Get reward history

`GET /v1/yields/{yieldId}/rewards/history`

## Request

- Base URL: `https://api.yield.xyz`
- URL: `https://api.yield.xyz/v1/yields/{yieldId}/rewards/history`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/yield/apis/yield-xyz-api/docs/v1/yields/:yieldId/rewards/history/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a chronological list of on-chain reward events for an indexed yield. Each record includes timestamp, token metadata, amount, reward source, and transaction reference.

## Path parameters

- `yieldId` string, required

## Query parameters

- `address` string, required
- `from` string
- `to` string
- `sort` 'asc' | 'desc'
- `limit` number
- `offset` number

## Response `200`

Paginated reward events

- PaginatedResponseDto
  - `total` number, required: Total number of items available
  - `offset` number, required: Offset of the current page
  - `limit` number, required: Limit of the current page

## Other responses

- `400`: Invalid request parameters
- `401`: Invalid or missing API key
- `404`: Reward history not available for this yield (not indexed)
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/yield/apis/yield-xyz-api.md) - [All operations](https://skmtc.dev/yield/apis/yield-xyz-api/llms.txt) - [OpenAPI document](https://skmtc.dev/yield/apis/yield-xyz-api/revisions/acfa80015ca5?raw)
