NEAR Rewards

General features described in Rewards Overview

delegator_addresses

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

start

• Type: string
• Required: Yes
• Description: Epoch numbers (as integers) or timestamps (as strings "YYYY-MM-DD")

end

• Type: string
• Required: Yes
• Description: Epoch numbers (as integers) or timestamps (as strings "YYYY-MM-DD")

time_rollup

• Type: string
• Enum: required
• Allowed Values: daily

Responses

200 A rewards result set with metadata.

Object Structure

• data:

  • Type: array of objects
  • Object Structure:
    • delegator_address:
      • Type: string
      • Description: delegator address that received the rewards.
    • validator:
      • Type: string
      • Description: The validator that distributed the rewards
    • epoch:
      • Type: string
      • Description: The epoch number (only present when time_rollup is "epoch").
    • timestamp:
      • Type: string
      • Description: The timestamp of the end of the epoch or date in the daily time_rollup.
    • rewards:
      • Type: array of objects
      • Object Structure:
        • text: string
        • currency: string
        • numeric: integer
        • exp: integer
    • balances:
      • Type: array of objects
      • Object Structure:
        • text: string
        • currency: string
        • numeric: integer
        • exp: integer

• meta:

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

400 Parameter error

401 Unauthorized

500 System error

Example cURL Command

curl --request POST \
     --url https://api.figment.io/near/rewards \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-api-key: your-api-key-here' \
     --data '{"time_rollup": "daily"}'  

Example JSON Response

{  
  "data": [  
    {  
      "delegator_address": "ccb593f13a9ee3eaba2b063265c5960406e1de3758d9d9d9eb87701e5c9dd8ed",  
      "validator": "figment.poolv1.near",  
      "epoch": "75743490",  
      "timestamp": "2023-07-21T00:00:00Z",  
      "rewards": [  
        {  
          "text": "0.000000000000000000001453",  
          "currency": "NEAR",  
          "numeric": 1453,  
          "exp": 24  
        }  
      ],  
      "balances": [  
        {  
          "text": "0.000000000548826223520098",  
          "currency": "NEAR",  
          "numeric": 548826223520098,  
          "exp": 24  
        }  
      ]  
    }  
  ],  
  "meta": {  
    "protocol": "near",  
    "network": "mainnet",  
    "time_rollup": "epoch"  
  }  
}