Skip to main content
GET
Get rewards metrics for a group of validators

Authorizations

Authorization
string
header
required

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

Headers

X-Rated-Network
enum<string>
default:mainnet
Available options:
mainnet,
hoodi,
holesky

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

toDate
string<date> | null

End date

Example:

"2023-12-31"

fromDate
string<date> | null

Start date

Example:

"2023-01-01"

fromDay
integer | null

Start day

Required range: x >= 0
Example:

"791"

toDay
integer | null

End day

Required range: x >= 0
Example:

"851"

utc
boolean | null
default:false

Returns results based on UTC days (true) or ETH chain days (false)

pubkeys
string[] | null

A list of validator pubkeys you want to filter by

indices
integer[] | null

A list of validator indices you want to filter by

Required range: x >= 0
sortBy
string

The filter you want results to be sorted by

sortOrder
enum<string> | null
default:asc

The sort order for the results

Available options:
asc,
desc
granularity
enum<string> | null

The size of time increments you are looking to query. Use 'epoch' for per-epoch results, which also requires fromEpoch and toEpoch.

Available options:
epoch,
hour,
day,
week,
month,
quarter,
year,
all
groupBy
enum<string> | null
default:validator
Available options:
granularity,
validator
fromEpoch
integer | null

First epoch to return, inclusive. Required when granularity=epoch, and not accepted otherwise. Cannot be combined with the date or day filters.

Required range: x >= 0
Example:

469400

toEpoch
integer | null

Last epoch to return, inclusive. Required when granularity=epoch. Each response covers a range of epochs for every validator you asked for; follow the 'next' link until it is null. 'limit' and 'offset' do not apply here.

Required range: x >= 0
Example:

469449

afterEpoch
integer | null

Page cursor, used when sortOrder=asc. Take it from the 'next' or 'previous' link rather than setting it yourself; omit it to start at fromEpoch. Use beforeEpoch when sortOrder=desc.

Required range: x >= 0
Example:

469449

beforeEpoch
integer | null

Page cursor, used when sortOrder=desc. Take it from the 'next' or 'previous' link rather than setting it yourself; omit it to start at toEpoch. Use afterEpoch when sortOrder=asc.

Required range: x >= 0
Example:

469400

Response

Successful Response

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