Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.rated.network/llms.txt

Use this file to discover all available pages before exploring further.

Private sets is a self-serve feature designed to enable organizations to curate a set of validators, each marked with a unique tag. This tag, carrying an identifier specific to your organization, ensures that only you can view the performance and rewards metrics for it. Displayed within your console, these tags streamline analysis processes and let you perform A/B testing on your node setup or group together validators for a specific customer confidentially.

​
Getting Started

Build and Growth API users can create private sets. Build tier comes with max 4 sets while Growth comes with 20.

​
Step 1: Creating a Tag and associating validators to it

To call a set’s effectiveness, you must first create a tag which acts as a unique identifier for the set.
POST
/
v1
/
tags
 Body parameters (Required)
NameTypeDescription
namestringName for the tag
Response 
{
  "id": "string",
  "name": "string",
  "network": "mainnet",
  "organizationId": "string",
  "createdBy": "string",
  "createdAt": "2024-03-14T18:12:14.677Z",
  "updatedAt": "2024-03-14T18:12:14.677Z"
}
Using the id that you get in the response above, call the following endpoint to associate validators with the tag
POST
/
v1
/
tags
/
{id}
/
validators
 Body parameters (Required)
NameTypeDescription
pubkeysarraylist of keys you wish to associate to a tag
Response 
{
    "tag": "string",
    "pubkeysAdded": integer
}
Once you have a tag with validator mappings, you can move to Step 2.
To add more validators to a tag, call POST /v1/tags/{id}/validators with the new keys you’d like to add. Similarly, to remove a pubkey from an existing tag, callDELETE /v1/tags/{id}/validators/{pubkey}.
Removing keys from a tag doesn’t erase their impact on historical performance ie performance of a removed pubkey continues to impact the all-time performance of a set.

​
Step 2: Calling the performance and rewards endpoints for your set

Using the tag’s ID, call the sets endpoints to retrieve performance and rewards metrics. These endpoints operate similar to the /operators/ endpoints with similar granularities and refresh windows.
GET
/
v1
/
eth
/
sets
/
{set_id}
/
effectiveness
GET
/
v1
/
eth
/
sets
/
{set_id}
/
attestations
GET
/
v1
/
eth
/
sets
/
{set_id}
/
proposals
GET
/
v1
/
eth
/
sets
/
{set_id}
/
rewards
GET
/
v1
/
eth
/
sets
/
{set_id}
/
penalties
 Query parameters
NameTypeValue
granularityenumhouror day
fromDatedatethe date from which you wish to retrieve the data
toDatedatethe date upto which you wish to retrieve the data
limitintegerthe number of rows returned per page
offsetintegeroffset allows you to omit a specified number of rows before the beginning of the result set
Response 
{
"pages": 3,
"results": [
    {
      "hour": null,
      "day": 796,
      "date": 2023-01-01,
      "startEpoch": 179324,
      "endEpoch": 179100,
      "validatorCount": 16075,
      "avgInclusionDelay": 1.0138705386457403,
      "avgUptime": 0.9999466390184881,
      "avgCorrectness": 0.9929917401071404,
      "avgProposerEffectiveness": 99.53271028037379,
      "avgValidatorEffectiveness": 97.96642775943795,
      "avgAttesterEffectiveness": 97.9580945527236
    }
  ],
  "previous": "string",
  "next": "string"
}