Get reward earnings summary

Get fixed-window reward earnings

curl --request GET \
  --url https://api.yield.xyz/v1/yields/{yieldId}/rewards/summary \
  --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/summary', 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/summary",
  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/summary"

	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/summary")

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"
  },
  "last24H": {
    "amount": "0.21",
    "amountRaw": "210000"
  },
  "last7D": {
    "amount": "0.21",
    "amountRaw": "210000"
  },
  "last30D": {
    "amount": "0.21",
    "amountRaw": "210000"
  },
  "lastYear": {
    "amount": "0.21",
    "amountRaw": "210000"
  },
  "total": {
    "amount": "0.21",
    "amountRaw": "210000"
  }
}

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

summary

Get fixed-window reward earnings

curl --request GET \
  --url https://api.yield.xyz/v1/yields/{yieldId}/rewards/summary \
  --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/summary', 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/summary",
  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/summary"

	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/summary")

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"
  },
  "last24H": {
    "amount": "0.21",
    "amountRaw": "210000"
  },
  "last7D": {
    "amount": "0.21",
    "amountRaw": "210000"
  },
  "last30D": {
    "amount": "0.21",
    "amountRaw": "210000"
  },
  "lastYear": {
    "amount": "0.21",
    "amountRaw": "210000"
  },
  "total": {
    "amount": "0.21",
    "amountRaw": "210000"
  }
}

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

Every window is measured back from the request and ends at the last aggregated hour. last24H is the 24 hourly rows ending at the hour that contains the request, clipped to the last aggregated hour. last7D, last30D and lastYear start at midnight UTC 7, 30 and 365 days before the request, so last7D covers seven full UTC days plus today so far, and lastYear is 365 days rather than a calendar year. total is all earnings through the last aggregated hour. Amounts are signed decimal strings, with amountRaw in base units. The same coverage rules apply as for reward earnings: earnings are recorded only for wallets that have already used Yield.xyz on that network, from that point on, a yield without reward support returns 404, and feeConfigurationId selects one of your allocator vaults.

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"

Response

Fixed-window earnings

yieldId

string

required

Example:

"ethereum-usdc-morpho-vault"

address

string

required

Example:

"0x742d35cc6634c0532925a3b844bc454e4438f44e"

token

object

required

Show child attributes

last24H

object

required

24 hourly earnings rows ending at the hour that contains the request, clipped to the last aggregated hour. The hour that started exactly 24 hours earlier is excluded. Zero when the last aggregated hour is older than that window.

Show child attributes

last7D

object

required

Earnings from midnight UTC 7 days before the request through the last aggregated hour. That is seven full UTC days plus the partial day up to the last aggregated hour, not a rolling 168 hours. Zero when the last aggregated hour is older than the window start.

Show child attributes

last30D

object

required

Earnings from midnight UTC 30 days before the request through the last aggregated hour. Same calendar rule as last7D, not a rolling 720 hours.

Show child attributes

lastYear

object

required

Earnings from midnight UTC 365 days before the request through the last aggregated hour. This is a fixed 365 days, not a calendar year, so a leap day is not added.

Show child attributes

total

object

required

All earnings through the last aggregated hour.

Show child attributes

⌘I

Getting started

Earn

Trade

Borrow

Get reward earnings summary

Authorizations

Path Parameters

Query Parameters

Response