Returns delegator rewards by checkpoint. Max 50 accounts per request.

General features described in Rewards Overview

Request Parameters

delegator_addresses

• Type: array of strings
• Required: Yes
• Description: Delegator addresses.

start

• Type: integer
• Required: Yes
• Description: Either checkpoint (number) or timestamps (strings formatted like "YYYY-MM-DD").

end

• Type: integer
• Required: Yes
• Description: Either checkpoint (number) or timestamps (strings formatted like "YYYY-MM-DD").

Response Structure

200 A rewards result set with metadata.

Response Object

• data: array of objects
  • delegator_address: string
    • The account that received the reward. This is a checksummed ethereum address including lower case and capital letters.
  • validator: string
    • The "owner address" of the validator which distributed the rewards.
  • checkpoint: string
    • The checkpoint number.
  • timestamp: string
    • The timestamp of the end of the checkpoint.
  • rewards: array of objects
    • text: string
      • The textual version of the other fields in the rewards object.
    • currency: string
    • numeric: integer
    • exp: integer
  • balances: array of objects
    • text: string
      • The textual version of the other fields in the balances object.
    • currency: string
    • numeric: integer
    • exp: integer
      • The exponent used to calculate the final MATIC amount.

meta

• protocol: string
• network: string
• time_rollup: string

Example cURL Request

curl --request POST \
     --url https://api.figment.io/polygon/rewards \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-api-key: your-api-key-here'

Example Response

{
  "data": [
    {
      "delegator_address": "0xA722e1F10Bc95c102251A13c2bbCB61A67257003",
      "validator": "0xF9e9b98dd99114C6C1B5C28Ae101849880E9542f",
      "checkpoint": "45500",
      "timestamp": "2023-07-21T00:00:00Z",
      "rewards": [
        {
          "text": "0.000817335418355351",
          "currency": "MATIC",
          "numeric": 817335418355351,
          "exp": 18
        }
      ],
      "balances": [
        {
          "text": "302.56",
          "currency": "MATIC",
          "numeric": 302560000000000000000,
          "exp": 18
        }
      ]
    }
  ],

"meta": {
    "protocol": "polygon",
    "network": "mainnet",
    "time_rollup": "checkpoint"
  }
}