Introduction to Polkadot Reporting API

Overview

The Polkadot Staking Reporting API enables users to access staking data for validators and nominators. The API provides information on staking rewards, status, and staking activity.

🌐 Supported network: Mainnet

➡️ Stake & Rewards

The Stake and Rewards endpoints return the current or historical rewards data for both nominators and validators.

Endpoints

Nominators

Validators

Sample Object

The example object returned by the Historical Stake & Rewards of a Validator endpoint is shown below.

[
  {
    "address": "11VR4pF6c7kfBhfmuwwjWY3FodeYBKWx7ix2rsRCU2q6hqJ",
    "currency": "DOT",
    "return": 783.089894122252,
    "timeStart": "2023-03-06T00:00:00Z",
    "timeEnd": "2023-03-12T23:59:59Z",
    "timeAggregation": "weekly",
    "startingBalance": 2058184.9337034964,
    "metadata": {
      "commission": 0.008,
      "validatorRewards": 776.8748949625516,
      "commissionRewards": 6.214999159700413
    }
  }
]

➡️ Status

This endpoint returns the current status of nominators and validators. Possible statuses include:

• UNKNOWN
• ACTIVE
• INACTIVE

Endpoints

Nominators

Validators

Sample Object

The example object returned by the Status of Multiple Validators endpoint is shown below.

[
  {
    "address": "11VR4pF6c7kfBhfmuwwjWY3FodeYBKWx7ix2rsRCU2q6hqJ",
    "status": "active",
    "commission": 1,
    "activationDate": "2022-10-02"
  },
  {
    "address": "123VugBRFMqUEFviSYrG3ewdZ46ZmqxjmRaGY6BvakfdPVaG",
    "status": "active",
    "commission": 1,
    "activationDate": "2022-09-23"
  }
]

➡️ Staking Activity

This endpoint verifies the staking activity of nominators and validators. It helps track whether a participant is actively involved in staking.

Endpoints

Nominators

Validators

Sample Object

The example object returned by the Staking Activity of a Nominator endpoint is shown below.

{
  "11VR4pF6c7kfBhfmuwwjWY3FodeYBKWx7ix2rsRCU2q6hqJ": false
}