Validators
Querying into individual validator indices or aggregations of validator indices.
The RatedAPI allows you to aggregate stats on validator indices on-the-fly. Head on over to Aggregating validator indices to learn more.
The Validators class is the lowest order of aggregation that the Rated API supports. The effectiveness endpoint returns you all kinds of useful information (e.g. rewards, performance etc) about a specific validator index, in the requested time-frame.
Single validator index effectiveness
This endpoint returns all the useful information you will ever need on the historical performance of a single validator index. This includes rewards (aggregate and granular), performance (effectiveness and its components), slashing history and much more. For a glossary of the variables returned see effectiveness.
Here's how to interpret the inputs required to operate it 👇
filterType
hour, day and datetime
from
Start day (integer) or datetime (e.g. from=“2022-12-01”)
granularity
The size of time increments you are looking to query. Can be day / week / month / quarter / year
size
The number of results included per page
include
A list of field names. Use it to filter the specific fields you want in the response payload
Aggregating validator indices
The Rated API enables the aggregation of all the metrics that live under effectiveness accross an arbitrary number of validator indices or pubkeys, at the endpoint level.
Here's how to interpret the inputs required to operate it 👇
filterType
hour, day and datetime
from
Start day (integer) or datetime (e.g. from=“2022-12-01”)
to
End day (integer) or datetime (e.g. from=“2022-12-01”)
granularity
The size of time increments you are looking to query. Can be day / week / month / quarter / year
size
The number of results included per page
groupBy
Time window or validator; we either group by validator index or across time
include
A list of field names. Use it to filter the specific fields you want in the response payload
Validator metadata [single keys]
This endpoint allows for a reverse lookup into the entity-to-validator index mappings that live in the RatedDB. Simply pass a validator index to the endpoint, and the response will tell you which operator or pool this validator is associated with.
Validators metadata [groups]
This endpoint allows users to request metadata for a group of validators that map to the same operator or pool (i.e. it gives you an answer to the question "give me all of Kiln's validator indices under Lido").
idType
The type of entity class you would like to filter by. You might ask for pool, nodeOperator
operatorsIds
An array of entities names you want to filter by
from
The validator index you want to start to navigate from
size
The number of results included per page
withdrawalAddress
Filter by the withdrawal address
Rated builds and operates the most complete dataset for validator id mappings. These are gated endpoints and is being provisioned on a case-by-case basis. If you're interested in working with it, get in touch via hello@rated.network with an overview of your use case.
Validators APR
This endpoint returns historical data on the returns of a validator index. What's really exciting about this one, is the ability to dig deep into the components of the aggregate return (e.g. returned earned on the execution layer vs the consensus layer etc).
window refers to the time window of the aggregation, with 1d, 7d, 30d and all being the supported values.
Note: a validator must be active throughout the time window for the value to be produced. For all time the last 90 days are considered.
Last updated