Skip to main content
GET
/
v1
/
eth
/
entities
/
{entity_id}
/
effectiveness
Get effectiveness for Pools, Operators and Addresses
curl --request GET \
  --url https://api.rated.network/v1/eth/entities/{entity_id}/effectiveness \
  --header 'Authorization: Bearer <token>'
{
  "previous": "<string>",
  "next": "<string>",
  "pages": 1,
  "results": [
    {
      "id": "<string>",
      "idType": "depositAddress",
      "validatorCount": 1,
      "avgInclusionDelay": 1,
      "avgUptime": 1,
      "avgCorrectness": 1,
      "avgProposerEffectiveness": 1,
      "avgValidatorEffectiveness": 1,
      "avgAttesterEffectiveness": 1,
      "sumEndEpochBalance": 123,
      "sumEndEpochEffectiveBalance": 123,
      "hour": 1,
      "day": 1,
      "startDay": 1,
      "endDay": 1,
      "startEpoch": 1,
      "endEpoch": 1,
      "startDate": "<string>",
      "endDate": "<string>",
      "date": "<string>",
      "startTimestamp": "2023-11-07T05:31:56Z",
      "endTimestamp": "2023-11-07T05:31:56Z",
      "startSlot": 1,
      "endSlot": 1
    }
  ]
}

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

Path Parameters

​
entity_id
string
required

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

​
fromDate
string<date> | null

Start date

Example:

"2023-01-01"

​
toDate
string<date> | null

End date

Example:

"2023-12-31"

​
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)

​
entityType
enum<string>
required

The type of entity class you would like returned

Available options:
depositAddress,
withdrawalAddress,
nodeOperator,
pool,
poolShare,
entity,
validator,
privateSet
​
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
default:day

The size of time increments you are looking to query

Available options:
hour,
day,
week,
month,
quarter,
year,
all

Response

Successful Response

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