Skip to main content
The Rated API facilitates efficient and detailed management of rewards distributed on Ethereum. By leveraging the API, users can achieve granular insight into their reward dynamics, aiding in precise accounting and better decision-making.
  1. Node Operators can keep track of their rewards in granular detail, accounting for the attribution of rewards for specific validator duties.
  2. Pools, Custodians and Centralised Exchanges can take stock of the rewards they receive from one or more staking providers in a consolidated view, including a breakdown of the different sources of rewards.

Integration Steps

Step 1: Generate Authorization Token

Sign into the Rated Console to generate your API Token.

Step 2: Get Rewards Data

The Rated API offers time window aggregation, allowing you to consolidate data over various time periods such as day, week, month, quarter, year or all time. You can retrieve reward info in two ways:
  1. Pre-materialized views
  2. Specific validator groups

Step 2.1: Getting Rewards for Pre-materialized Views

Imagine you’re Kiln (a Node Operator), Lido (a Pool), or Coinbase (an Exchange). You want all your reward details (consensus layer and execution layer including penalties) for August 2023, shown daily. Here’s how you’d go about getting this data. Call the Operator effectivenessendpoint with the following parameters set:

Get Effectiveness

GET
/
v0
/
eth
/
operators
/
{operator_id}
/
effectiveness
Example: Obtaining daily reward metrics for the month of August 2023 for Kiln
You will get the following response:
Note that if you’re looking to get the same data grouped by withdrawal/deposit address, you can simply input operator_id as the address (0x..) and idType as withdrawalAddress or depositAddress.

Step 2.2: Getting Rewards for specific validators groups

For validator groupings, you will need to call the Aggregating validator indices endpoint. We’ll show this similarly as above for all reward details for the month of August 2023 for a set of validator indices, aggregated daily.

Get Effectiveness Aggregation

GET
/
v0
/
eth
/
validators
/
effectiveness
Example: Obtaining daily reward metrics for the month of August 2023 for Validator group {675893, 675894, 675895}
You will get the following response: