Skip to main content
GET
/
v0
/
polygon
/
delegators
/
{delegator_address}
/
summary
Delegator Summary
curl --request GET \
  --url https://api.rated.network/v0/polygon/delegators/{delegator_address}/summary \
  --header 'Authorization: Bearer <token>'
{
  "delegatorAddress": "<string>",
  "timeWindow": "1d",
  "networkPenetration": "<string>",
  "delegations": [
    {
      "validatorId": 1,
      "validatorName": "<string>",
      "stakePercentage": 123
    }
  ],
  "aprGross": "<string>",
  "aprNet": "<string>",
  "aggregateEffectiveness": "<string>",
  "blendedCommissionRate": "<string>",
  "totalDelegatorStake": "<string>",
  "totalGrossRewards": "<string>",
  "totalNetRewards": "<string>",
  "totalCommissionPaid": "<string>"
}
This endpoint returns high level information about a delegator over the time period such as their network penetration, rewards, annual percentage rate (APR), paid commissions, and the aggregate effectiveness of their validator delegates. Here’s how to interpret the inputs required to operate it
ParameterContext
windowWindow of the aggregation, with 1d, 7d, 30d and all being the supported values

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
delegator_address
string
required

Query Parameters

​
window
enum<string>
required
Available options:
1d,
7d,
30d,
all

Response

Successful Response

​
delegatorAddress
string
required
​
timeWindow
enum<string>
required
Available options:
1d,
7d,
30d,
all
​
networkPenetration
string
required
​
delegations
PolygonDelegation · object[]
required
​
aprGross
string | null
required
​
aprNet
string | null
required
​
aggregateEffectiveness
string
required
​
blendedCommissionRate
string
required
​
totalDelegatorStake
string
required
​
totalGrossRewards
string
required
​
totalNetRewards
string
required
​
totalCommissionPaid
string
required