Metadata

A series of endpoints that drill down on metadata-related metrics for both entities and validators.

Metadata endpoint is available only to annual commitment and custom Enterprise plans. Get in touch with [e-mail] to learn more.

Entity Metadata

The entity metadata endpoints inform you about how validators are mapped to entities, their APRs, and slashing metrics. Please head to our Glossary to understand what individual metrics refer to.

Get Validator mappings for Pools and Operators.

This endpoint returns information about the validators mapped to a pool or an operator. Use this endpoint to retrieve validator indices or pubkeys that belong to a pool or an operator, as well as their deposit and withdrawal addresses.

GET/v1/eth/entities/{entity_id}/mappings

Path parameters

entity_id*Entity Id

Query parameters

Header parameters

Response

200400

Successful Response

Body

application/json

previousPrevious

nextNext

pages*Pages

results*Results

Request

JavaScriptCurlPython

const response = await fetch('/v1/eth/entities/{entity_id}/mappings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "previous": "https://endpoint?limit=10&offset=10",
  "next": "https://endpoint?limit=10&offset=10",
  "pages": 10,
  "results": [
    {
      "depositAddresses": [
        "0x74134d0c91798d720a5585364bb4be7396c5b973"
      ],
      "dvtOperators": [],
      "nodeOperators": [],
      "validatorIndex": 100,
      "validatorPubkey": "0xb5bc96b70df0dfcc252c9ff0d1b42cb6dc0d55f8defa474dc0a5c7e0402c241e2850fea9c582e276b638b3c2c3a5ec55",
      "withdrawalAddress": "0xfff1ce616cf83327981bf61396ad0c04e0c8b771"
    }
  ]
}

Get APR information for Pools, Operators and Addresses.

This endpoint returns windowed APR information for a single pool, node operator or deposit/withdrawal address.

GET/v1/eth/entities/{entity_id}/aprs

Path parameters

entity_id*Entity Id

Query parameters

Header parameters

Response

200400

Successful Response

Body

application/json

previousPrevious

nextNext

pages*Pages

results*Results

Request

JavaScriptCurlPython

const response = await fetch('/v1/eth/entities/{entity_id}/aprs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "previous": "https://endpoint?limit=10&offset=10",
  "next": "https://endpoint?limit=10&offset=10",
  "pages": 10,
  "results": [
    {
      "window": "1d",
      "percentage": 5.35,
      "percentageConsensus": 4.04,
      "percentageExecution": 1.31,
      "activeStake": 4823520000000000,
      "activeValidators": 150735
    }
  ]
}

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.

Validator Metadata

The validator metadata endpoints inform you about how entities are mapped to validators, their APRs, and slashing metrics. Please head to our Glossary to understand what individual metrics refer to.

Get Pool and Operator mappings for all Validators.

This endpoint returns information about the pools and operators mapped to validators. Use this endpoint to retrieve pool and operator mapping information for all validators.

GET/v1/eth/validators/mappings

Query parameters

Header parameters

Response

200400

Successful Response

Body

application/json

previousPrevious

nextNext

pages*Pages

results*Results

Request

JavaScriptCurlPython

const response = await fetch('/v1/eth/validators/mappings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "previous": "https://endpoint?limit=10&offset=10",
  "next": "https://endpoint?limit=10&offset=10",
  "pages": 10,
  "results": [
    {
      "depositAddresses": [
        "0x74134d0c91798d720a5585364bb4be7396c5b973"
      ],
      "dvtOperators": [],
      "nodeOperators": [],
      "validatorIndex": 100,
      "validatorPubkey": "0xb5bc96b70df0dfcc252c9ff0d1b42cb6dc0d55f8defa474dc0a5c7e0402c241e2850fea9c582e276b638b3c2c3a5ec55",
      "withdrawalAddress": "0xfff1ce616cf83327981bf61396ad0c04e0c8b771"
    }
  ]
}

Get Pool and Operator mappings for Validators.

This endpoint returns information about the pools and operators mapped to a validator. Use this endpoint to retrieve pool and operator mapping information for a single validator.

GET/v1/eth/validators/{validator_index_or_pubkey}/mappings

Path parameters

validator_index_or_pubkey*Validator Index Or Pubkey

integerstring

Header parameters

Response

200400

Successful Response

Body

application/json

validatorIndex*Validatorindex

validatorPubkey*Validatorpubkey

poolPool

dvtNetworkDvtnetwork

nodeOperatorsNodeoperators

dvtOperatorsDvtoperators

depositAddressesDepositaddresses

withdrawalAddressWithdrawaladdress

subpoolSubpool

Request

JavaScriptCurlPython

const response = await fetch('/v1/eth/validators/{validator_index_or_pubkey}/mappings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "depositAddresses": [
    "0x74134d0c91798d720a5585364bb4be7396c5b973"
  ],
  "dvtOperators": [],
  "nodeOperators": [],
  "validatorIndex": 100,
  "validatorPubkey": "0xb5bc96b70df0dfcc252c9ff0d1b42cb6dc0d55f8defa474dc0a5c7e0402c241e2850fea9c582e276b638b3c2c3a5ec55",
  "withdrawalAddress": "0xfff1ce616cf83327981bf61396ad0c04e0c8b771"
}

Get APR information for Validators.

This endpoint returns windowed information about the APRs for a single validator.

GET/v1/eth/validators/{validator_index_or_pubkey}/aprs

Path parameters

validator_index_or_pubkey*Validator Index Or Pubkey

integerstring

Query parameters

Header parameters

Response

200400

Successful Response

Body

application/json

previousPrevious

nextNext

pages*Pages

results*Results

Request

JavaScriptCurlPython

const response = await fetch('/v1/eth/validators/{validator_index_or_pubkey}/aprs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "previous": "https://endpoint?limit=10&offset=10",
  "next": "https://endpoint?limit=10&offset=10",
  "pages": 10,
  "results": [
    {
      "window": "1d",
      "aprType": "backward",
      "percentage": 5.35,
      "percentageConsensus": 4.04,
      "percentageExecution": 1.31,
      "activeStake": 4823520000000000
    }
  ]
}

This endpoint returns historical data on the returns of a validator index or pubkey. 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.

Get Slashings information for all Validators.

This endpoint returns information about the slashings for all validators.

GET/v1/eth/validators/slashings

Query parameters

Header parameters

Response

200400

Successful Response

Body

application/json

previousPrevious

nextNext

pages*Pages

results*Results

Request

JavaScriptCurlPython

const response = await fetch('/v1/eth/validators/slashings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "previous": "https://endpoint?limit=10&offset=10",
  "next": "https://endpoint?limit=10&offset=10",
  "pages": 10,
  "results": [
    {
      "validatorIndex": 516858,
      "validatorPubkey": "0xafa647044b05fd7d7f3cfd806170fc9774bf37cbcfd4f083528522bb2a011e57f3af00f8bb8435a9d3316816e4cdb022",
      "slashingEpoch": 203644,
      "withdrawableEpoch": 211836,
      "balanceBeforeSlashing": 32001900366,
      "balanceBeforeWithdrawal": 30980804667,
      "slashingPenalties": 1021095699
    }
  ]
}

API Metadata

Get metadata on the Rated Ethereum API endpoints

This endpoint returns information about the latest data available from Rated's Ethereum API endpoints.

GET/v1/eth/apiMetadata

Query parameters

Header parameters

Response

200400

Successful Response

Body

application/json

day*Day

startEpoch*Startepoch

endEpoch*Endepoch

startSlot*Startslot

endSlot*Endslot

fromDateFromdate

toDateTodate

Request

JavaScriptCurlPython

const response = await fetch('/v1/eth/apiMetadata', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "day": 1337,
  "startEpoch": 300825,
  "endEpoch": 301049,
  "startSlot": 9626400,
  "endSlot": 9633599,
  "fromDate": "2024-07-30T12:00:23",
  "toDate": "2024-07-31T12:00:11"
}