API reference
Resources dedicated to exposing and explaining the various endpoints that the Rated API supports.
The standard form of the Rated API looks something like this
👇
https://api.rated.network/version/network/entity/endpoint
At the highest level, here's how you should interpret the class of instructions you are passing to it:
Class | Text |
|---|---|
version | The version of the API you are on. Currently the API is in v0 |
network | The network you are querying |
entityId | The class of entity you are querying for. This could be either of Validators, Operators and Network |
resource | The specific resource you are querying for |
All rewards and performance metrics are hosted under the "effectiveness" endpoint.
By default, the API returns data in daily chunks (24h / 225 epoch / 7200 slot increments), starting from Beacon Chain genesis.
As such,
Day 0 encompasses the 225 epoch period between epochs [0, 225), and maps to datetime 2020-12-01 12:00:23 UTC to 2022-12-02 12:00:11 UTC.The Rated API supports querying for rewards, performance and metadata at the validator pubkey level, all the way up to a pre-configured operator (list of pubkeys) or pool (list of operators).
We have the capability to aggregate statistics on an arbitrary number of keys, and can pre-configure entity aggregations that follow continuously updated registries (e.g. rated.network/o/Lido).
The Rated API also supports aggregation, so days can be rolled up in weeks, months, quarters, years and even all time.
To use this feature, the
granularity query parameter can be used. For example, to obtain monthly aggregates for validator index 100:curl -X 'GET' \\
'[<https://api.rated.network/v0/eth/validators/100/effectiveness?size=10&granularity=month&filterType=day>](<https://api.rated.network/v0/eth/validators/100/effectiveness?size=10&granularity=day&filterType=day>)' \\
-H 'accept: application/json' \\
-H 'X-Rated-Network: mainnet'
Last modified 1mo ago