Get a Stream of Rewards

Request Parameters

network

• Type: string
• Required: Yes
• Defaults to: mainnet
• Description: The network to look up against.

type

• Type: string
• Enum:
• Required: Yes
• Allowed values: validator, delegator

startTime

• Type: number
• Defaults to: 1706659200
• Description: Epoch-based start time for reward queries.

endTime

• Type: number
• Defaults to: 1712059200
• Description: Epoch-based end time for reward queries.

epoch

• Type: number
• Defaults to: 80000
• Description: The epoch to look up rewards for.

addresses

• Type: array of strings
• Required: Yes
• Defaults to: ["0xAB30eF276ADC2bE22CE58d75B4F4009173A73676","0x6ae6c540c7b110d5c01cb9bc23297a013f9f4982"]
• Description: List of addresses to retrieve rewards for.

period

• Type: string
• Enum:
• Defaults to: monthly
• Allowed values: yearly, monthly, raw, daily, weekly, epoch
• Description: How the data is aggregated (raw and epoch is checkpoint-level data).

denomination

• Type: string
• Enum:
• Defaults to: wei
• Allowed values: wei, kwei, mwei, gwei, szabo, finney, ether, pol, m@pol, g@pol, t@pol
• Description: The denomination to return rewards in.

aggregate

• Type: boolean
• Defaults to: false
• Description: Whether to aggregate across provided addresses or per address - true to aggregate across all addresses.

accept

• Type: string
• Enum:
• Defaults to: application/json
• Allowed values: application/json, application/x-ndjson
• Description: Generated from available response content types.

Example Request

curl --request POST \
     --url https://svc.blockdaemon.com/reporting/staking/v2/polygon/mainnet/validator/rewards \
     --header 'X-API-Key: ••••' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
  "startTime": 1706659200,
  "endTime": 1712059200,
  "epoch": 80000,
  "addresses": [
    "0xAB30eF276ADC2bE22CE58d75B4F4009173A73676",
    "0x6ae6c540c7b110d5c01cb9bc23297a013f9f4982"
  ],
  "period": "monthly",
  "denomination": "wei",
  "aggregate": false
}'

Response Codes

• 200: OK
• 400: Bad Request
• 422: Validation Error

Updated 2 months ago.