Skip to main content
GET
/
v1
/
cardano
/
validators
/
{pool_id}
/
rewards
Get stake pool/validator rewards metrics
curl --request GET \
  --url https://api.rated.network/v1/cardano/validators/{pool_id}/rewards \
  --header 'Authorization: Bearer <token>'
{
  "previous": "<string>",
  "next": "<string>",
  "pages": 1,
  "results": [
    {
      "day": "2023-12-25",
      "epoch": 123,
      "fromBlockNumber": 123,
      "toBlockNumber": 123,
      "fromSlotNumber": 123,
      "toSlotNumber": 123,
      "poolId": "<string>",
      "poolOwnerStakeAddresses": [
        "<string>"
      ],
      "totalRealizedDelegatorRewards": 123,
      "totalRealizedValidatorRewards": 123,
      "totalEarnedDelegatorRewards": 123,
      "totalEarnedValidatorRewards": 123,
      "poolFee": 123,
      "poolFlatFee": 123,
      "poolName": "<string>",
      "poolTicker": "<string>",
      "poolHashId": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.rated.network/llms.txt

Use this file to discover all available pages before exploring further.

Using this endpoint, you can query the historical daily rewards of a stake pool/validator by their unique poolId, which is a hash in the form of pool + 52 characters (ex: pool12vx0utf438rpxskmvwm870vpz6qnurdqekzjea39jzl7gs3hhhl) or poolHashId which is the hashed version of the poolId. These rewards are denominated in ADA. totalRealizedDelegatorRewards and totalRealizedValidatorRewards refer to rewards already distributed to the members/delegators and stake pool owners/validators respectively based on the epoch when they were distributed. Meanwhile, totalEarnedDelegatorRewards and totalEarnedValidatorRewards refer to the rewards earned for an epoch but not yet distributed. These rewards are already net of the 20% cut that the treasury takes. In terms of timing, we align these rewards according to the day when an epoch ended.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
pool_id
string
required

Query Parameters

​
limit
integer
default:10

The number of results returned per page

​
offset
integer
default:0

The number of results to skip before starting to return

​
fromDate
string<date> | null

Start date

Example:

"2023-01-01"

​
toDate
string<date> | null

End date

Example:

"2023-12-31"

Response

Successful Response

​
previous
string | null
required
​
next
string | null
required
​
pages
integer
required
Required range: x >= 0
​
results
CardanoValidatorRewards · object[]
required