Entity APR%

GET /v0/eth/operators/{operator_id}/apr

Get Operator Apr

cURL

curl --request GET \
  --url https://api.rated.network/v0/eth/operators/{operator_id}/apr \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "percentage": 123,
  "percentageConsensus": 123,
  "percentageExecution": 123,
  "activeStake": 123,
  "activeValidators": 1
}

This endpoint returns historical data on the returns any of the entities supported have recorded. 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).

Here’s how to interpret the inputs required to operate it 👇

Parameter	Context
operatorId	The name of the entity in question. This could be deposit address, a node operator, or a pool. Please see our docs to get a better understanding of how we aggregate validators.
window	The time window of aggregation. You might ask for 1d, 7d, 30d or All-time data.
idType	The type of entity class you would like returned. You might ask for pool, poolShare, nodeOperator, depositAddress and withdrawalAddress.

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

operator_id · string · required

Query Parameters

window · enum<string> · required

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

idType · enum<string> | null

Available options: depositAddress, withdrawalAddress, nodeOperator, pool, poolShare, entity, validator, privateSet

apr_type · enum<string> · default: backward

Available options: backward, forward

Response

200

application/json

Successful Response

id · string · required

idType · enum<string> · required

Available options: depositAddress, withdrawalAddress, nodeOperator, pool, poolShare, entity, validator, privateSet

timeWindow · enum<string> · required

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

aprType · enum<string> · required

Available options: backward, forward

percentage · number · required

percentageConsensus · number · required

percentageExecution · number · required

activeStake · number · required

activeValidators · integer · required

Required range: x >= 0