Skip to main content
GET
/
v1
/
eth
/
entities
/
{entity_id}
/
summaries
Get summary stats on individual Pools, Operators and Addresses
curl --request GET \
  --url https://api.rated.network/v1/eth/entities/{entity_id}/summaries \
  --header 'Authorization: Bearer <token>'
{
  "previous": "<string>",
  "next": "<string>",
  "pages": 1,
  "results": [
    {
      "id": "<string>",
      "type": "depositAddress",
      "window": "<string>",
      "name": "<string>",
      "validatorCount": 1,
      "avgValidatorEffectiveness": 123,
      "networkPenetration": 1,
      "clientPercentages": [
        {}
      ],
      "relayerPercentages": [
        {}
      ],
      "sumEpochEndBalance": 123,
      "sumEpochEndEffectiveBalance": 123
    }
  ]
}

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

​
entityType
enum<string> | null

The type of entity class you would like returned

Available options:
depositAddress,
withdrawalAddress,
nodeOperator,
pool,
poolShare,
entity,
validator,
privateSet
​
window
enum<string> | null

The time window of aggregation

Available options:
1d,
7d,
30d,
all
​
sortBy
string | null

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

Response

Successful Response

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