GET
/
v0
/
polygon
/
delegators
/
{delegator_address}
/
rewards
curl --request GET \
  --url https://api.rated.network/v0/polygon/delegators/{delegator_address}/rewards
{
  "page": {
    "from": 123,
    "to": 123,
    "granularity": "checkpoint",
    "size": 1
  },
  "total": 1,
  "data": [
    {
      "delegatorAddress": "0x00000",
      "delegatorStake": 1000000,
      "fromCheckpoint": 54000,
      "fromDate": "2023-01-01",
      "missedRewards": 0,
      "rewards": 0.05,
      "toCheckpoint": 54000,
      "toDate": "2023-01-01",
      "validatorId": 103
    }
  ],
  "next": "<string>"
}

This endpoint returns information about the rewards received by a delegator and the rewards it has missed out on over a number of checkpoints. The rewards can be broken down at a per checkpoint level or daily level as well.

Here’s how to interpret the inputs required to operate it 👇

ParameterContext
fromStarting (highest) checkpoint (integer, e.g. 54000) or UTC date (e.g. from=“2023-11-22”)
toEnding (lowest) checkpoint (integer, e.g. 52922) or UTC date (e.g. from=“2023-10-31”)
granularityThe size of time increments you are looking to query. Can be checkpoint or day
sizeThe number of results included per page

Path Parameters

​
delegator_address
string
required

Query Parameters

​
from
any | null

The starting (highest) checkpoint or date (UTC) to return. For example, 41100 or 2021-01-01.

​
to
any | null

The ending (lowest) checkpoint or date (UTC) to return. For example, 41100 or 2021-01-01.

​
granularity
enum<string> | null

Checkpoint or UTC day

Available options:
checkpoint,
day
​
size
integer
default:
15

Maximum number of time periods (days or checkpoint) in the results.

Response

200
application/json
Successful Response
​
page
object
required
​
total
integer
required
Required range: x > 0
​
data
object[]
required
​
next
string | null
Delegator SummariesNetwork