Authentication

Rated uses API keys that represent bearer tokens to access API endpoints. These API keys can be generated via console.rated.network.

The API keys are added as an Authorization key in the API request headers with the value Bearer <API key>

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

curl

#Authenticated Request
curl -v -X 'GET' \
'https://api.rated.network/v0/eth/operators/Kiln/effectiveness?idType=nodeOperator&granularity=day&from=2023-08-31&size=31&filterType=datetime&include=sumEarnings&include=day&include=sumEstimatedRewards&include=sumEstimatedPenalties&include=sumPriorityFees&include=sumBaselineMev&include=sumMissedExecutionRewards&include=sumConsensusBlockRewards&include=sumMissedConsensusBlockRewards&include=sumAttestationRewards&include=sumAllRewards&include=sumMissedAttestationRewards&include=sumMissedAttestationPenalties&include=sumWrongTargetPenalties&include=sumLateTargetPenalties&include=sumWrongHeadPenalties&include=sumLateSourcePenalties' \
-H 'Content-Type: application/json' \
-H 'X-Rated-Network: mainnet' \
-H 'Authorization: Bearer <YOUR-TOKEN-HERE>'

python

import requests

url = "https://api.rated.network/v0/eth/operators/Coinbase/effectiveness"
params = {
    "idType": "nodeOperator",
    "granularity": "day",
    "from": "2023-08-31",
    "size": 31,
    "filterType": "datetime",
    "include": [
        "sumEarnings", "day", "sumEstimatedRewards", "sumEstimatedPenalties",
        "sumPriorityFees", "sumBaselineMev", "sumMissedExecutionRewards",
        "sumConsensusBlockRewards", "sumMissedConsensusBlockRewards",
        "sumAttestationRewards", "sumAllRewards", "sumMissedAttestationRewards",
        "sumMissedAttestationPenalties", "sumWrongTargetPenalties",
        "sumLateTargetPenalties", "sumWrongHeadPenalties", "sumLateSourcePenalties"
    ]
}

#Authenticated Request
headers = {
    "Content-Type": "application/json",
    "X-Rated-Network": "mainnet",
    "Authorization": "Bearer <YOUR-TOKEN-HERE>"
}

response = requests.get(url, params=params, headers=headers)
data = response.json()