Skip to main content
GET
/
v1
/
eth
/
entities
/
{entity_id}
/
aprs
Get APR information for Pools, Operators and Addresses.
curl --request GET \
  --url https://api.rated.network/v1/eth/entities/{entity_id}/aprs \
  --header 'Authorization: Bearer <token>'
{
  "previous": "<string>",
  "next": "<string>",
  "pages": 1,
  "results": [
    {
      "id": "<string>",
      "idType": "depositAddress",
      "window": "1d",
      "percentage": 123,
      "percentageConsensus": 123,
      "percentageExecution": 123,
      "activeStake": 123,
      "activeValidators": 1
    }
  ]
}
This endpoint is available only to annual commitment and custom Enterprise plans. Get in touch with [email protected] to learn more.
This endpoint returns historical data on the returns of an entity. What’s really exciting about this one, is the ability to dig deep into the components of the aggregate return (e.g. returned earned on the execution layer vs the consensus layer etc). window refers to the time window of the aggregation, with 1d, 7d, 30d and all being the supported values.
A validator must be active throughout the time window for the value to be produced. For all time the last 90 days are considered.

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>
required

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 for the APR calculation

Available options:
1d,
7d,
30d,
all

Response

Successful Response

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