Get reward earnings

Get bucketed reward earnings

curl --request GET \
  --url https://api.yield.xyz/v1/yields/{yieldId}/rewards \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.yield.xyz/v1/yields/{yieldId}/rewards', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.yield.xyz/v1/yields/{yieldId}/rewards",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.yield.xyz/v1/yields/{yieldId}/rewards"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.yield.xyz/v1/yields/{yieldId}/rewards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "yieldId": "ethereum-usdc-morpho-vault",
  "address": "0x742d35cc6634c0532925a3b844bc454e4438f44e",
  "token": {
    "symbol": "USDC",
    "decimals": 6,
    "network": "ethereum",
    "address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"
  },
  "interval": "day",
  "from": "2026-10-07T00:00:00.000Z",
  "to": "2026-10-14T10:45:00.000Z",
  "items": [
    {
      "timestamp": "2026-10-07T00:00:00.000Z",
      "amount": "0.212345",
      "amountRaw": "212345"
    }
  ]
}

{
  "message": "Invalid API key",
  "error": "Unauthorized",
  "statusCode": 401
}

{
  "message": "Rate limit exceeded",
  "error": "Too Many Requests",
  "statusCode": 429,
  "retryAfter": 30
}

{
  "message": "Internal server error",
  "error": "Internal Server Error",
  "statusCode": 500
}

GET

yields

{yieldId}

rewards

Get bucketed reward earnings

curl --request GET \
  --url https://api.yield.xyz/v1/yields/{yieldId}/rewards \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.yield.xyz/v1/yields/{yieldId}/rewards', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.yield.xyz/v1/yields/{yieldId}/rewards",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.yield.xyz/v1/yields/{yieldId}/rewards"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.yield.xyz/v1/yields/{yieldId}/rewards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "yieldId": "ethereum-usdc-morpho-vault",
  "address": "0x742d35cc6634c0532925a3b844bc454e4438f44e",
  "token": {
    "symbol": "USDC",
    "decimals": 6,
    "network": "ethereum",
    "address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"
  },
  "interval": "day",
  "from": "2026-10-07T00:00:00.000Z",
  "to": "2026-10-14T10:45:00.000Z",
  "items": [
    {
      "timestamp": "2026-10-07T00:00:00.000Z",
      "amount": "0.212345",
      "amountRaw": "212345"
    }
  ]
}

{
  "message": "Invalid API key",
  "error": "Unauthorized",
  "statusCode": 401
}

{
  "message": "Rate limit exceeded",
  "error": "Too Many Requests",
  "statusCode": 429,
  "retryAfter": 30
}

{
  "message": "Internal server error",
  "error": "Internal Server Error",
  "statusCode": 500
}

Each bucket holds the earnings for that period only, not a running total, so add the buckets up for a cumulative figure. Choose the window with period (1d, 7d, 30d, 90d, 1y, all; default 30d) or with from and to (ISO 8601). Each of from and to is optional on its own, and either one overrides period. from is floored to UTC midnight, so a from with a time component includes that whole UTC day. to defaults to now, is extended to the end of its UTC day, and is then clamped to the last aggregated hour. A to without from starts at the wallet’s first earnings bucket. interval sets the bucket size: day (default), week or month. period=all, or a to without from, defaults interval to week. A range of more than 366 buckets returns 400. Earnings are aggregated hourly, so the newest bucket ends at the last aggregated hour. They are recorded only for wallets that have already used Yield.xyz on that network, from that point on, and earlier earnings are not backfilled. A yield without reward support returns 404. To read earnings for one of your allocator vaults, pass its feeConfigurationId; an id that is not one of your project’s fee configurations returns 400. For preset windows (the last 24 hours, 7, 30 and 365 days from UTC midnight, and all time), use the reward earnings summary. For the yield’s rate over time rather than a wallet’s earnings, use reward rate history.

Authorizations

x-api-key

string

header

required

Path Parameters

yieldId

string

required

The unique identifier of the yield

Example:

"ethereum-usdc-morpho-vault"

Query Parameters

address

string

required

Wallet address to fetch earnings for

Example:

"0x742d35cc6634c0532925a3b844bc454e4438f44e"

feeConfigurationId

string

Fee configuration ID used to resolve the partner allocator vault. An id that is not one of the project fee configurations is rejected.

Example:

"66f299cd-aaaa-bbbb-cccc-d1f26e3a02db"

from

string

Start of the time range (ISO 8601). Overrides period. Floored to the UTC day.

Example:

"2026-10-07T00:00:00.000Z"

string

End of the time range (ISO 8601). Overrides period. Defaults to now, then the end of that UTC day, clamped to the last aggregated hour. When to is set without from, the range starts at the first earnings bucket.

Example:

"2026-10-14T10:45:00.000Z"

period

enum<string>

Predefined time window. Ignored when from or to is provided. Default: 30d. period=all defaults interval to week.

Available options:

1d,

7d,

30d,

90d,

1y,

all

interval

enum<string>

Bucket size (day, week, or month). Default: day. period=all and a to without from default to week when omitted.

Available options:

day,

week,

month

Response

Bucketed non-cumulative earnings

yieldId

string

required

Example:

"ethereum-usdc-morpho-vault"

address

string

required

Example:

"0x742d35cc6634c0532925a3b844bc454e4438f44e"

token

object

required

Show child attributes

interval

enum<string>

required

Available options:

day,

week,

month

Example:

"day"

from

string

required

Example:

"2026-10-07T00:00:00.000Z"

string

required

Example:

"2026-10-14T10:45:00.000Z"

items

object[]

required

Show child attributes

⌘I

Getting started

Earn

Trade

Borrow

Get reward earnings

Authorizations

Path Parameters

Query Parameters

Response