API Reference
App Login

NEAR API v1 Overview

❗️

Now Supporting v2!

This section covers NEAR Staking Reporting v1. For upgraded functionality, check out our Near Staking Reporting v2.

Overview

With the NEAR Staking Reporting API, you can access detailed staking information including the current or historical stakes and rewards allocated to a given validator or delegator address, as well as other relevant data such as the validator's status. Additionally, the API allows you to verify staking activity for a single or multiple validators or delegators.

Supported network: Mainnet

➡️ Stake & Rewards

Endpoints

Endpoint
Get the Stake & Rewards of a Validator - GET /validator/rewards/{address}
Get the Stake & Rewards of Multiple Validators - POST /validator/rewards
Get the Historical Stake & Rewards of a Validator - POST /validator/history/{address}
Get the Historical Stake & Rewards of Multiple Validators - POST /validator/history
Get the Stake & Rewards of a Delegator - GET /delegator/rewards/{address}
Get the Stake & Rewards of Multiple Delegators - POST /delegator/rewards
Get the Historical Stake & Rewards of a Delegator - POST /delegator/history/{address}
Get the Historical Stake & Rewards of Multiple Delegators - POST /delegator/history

Sample Object

The example object returned by the Stake & Rewards of Multiple Validators endpoint is shown below.

{
  "rewards": [
    {
      "address": "01node.near",
      "currency": "NEAR",
      "metadata": {
        "depositAmount": 0,
        "stakedEndBalance": 14618.614940599,
        "stakedStartingBalance": 14606.19861148,
        "startingBlock": "111124301",
        "unstakedEndBalance": 10145.939152364,
        "unstakedStartingBalance": 10145.939152364,
        "withdrawalAmount": 0
      },
      "return": 12.416329118,
      "startingBalance": 14606.19861148,
      "timeAggregation": "daily",
      "timeEnd": "2024-01-24T02:43:40Z",
      "timeStart": "2024-01-24T02:43:40Z",
      "validator": "01node.poolv1.near"
    },
    {
      "address": "blockdaemon.poolv1.near",
      "currency": "NEAR",
      "metadata": {
        "depositAmount": 0,
        "stakedEndBalance": 0,
        "stakedStartingBalance": 0,
        "startingBlock": "129873111",
        "unstakedEndBalance": 0,
        "unstakedStartingBalance": 0,
        "withdrawalAmount": 0
      },
      "return": 0,
      "startingBalance": 0,
      "timeAggregation": "daily",
      "timeEnd": "2024-10-09T07:30:30Z",
      "timeStart": "2024-10-09T07:30:30Z",
      "validator": "blockdaemon.poolv1.near"
    }
  ]
}

➡️ Status

Endpoints

Endpoint
Get the Status of a Validator - GET /validator/status/{address}
Get the Status of Multiple Validators - POST /validator/status
Get the Status of Delegator - GET /delegator/status/{address}
Get the Status of Multiple Delegators - POST /delegator/status

Sample Object

The example object returned by the Status of a Delegator endpoint is shown below.

{
  "activationDate": "2023-06-06",
  "address": "41b965acd61cbb4458eedb758afdfe17f2a26eca22afe3b235935ebba88e4590",
  "status": "active"
}

➡️ Staking Activity

Endpoints

Endpoint
Verify the Staking Activity of a Validator - GET /validator/active/{address}
Verify the Staking Activity of Multiple Validators - POST /validator/active
Verify the Staking Activity of a Delegator - GET /delegator/active/{address}
Verify the Staking Activity of Multiple Delegators - POST /delegator/active

Sample Object

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

{
  "active": true,
  "address": "41b965acd61cbb4458eedb758afdfe17f2a26eca22afe3b235935ebba88e4590"
}

👋 Need Help?

Contact us through email or our support page for any issues, bugs, or assistance you may need.