Polygon API v2 Overview

Learn all about Blockdaemon's Polygon Staking Reporting API.

Overview

The Blockdaemon Polygon Staking Reporting API enables access to Polygon staking information which can be used for financial data analysis. Version 2 of the API not only includes the functionalities of version 1 but also adds additional improvements:

  • Timezone-based reporting capabilities.
  • Near-real-time data availability (Now per epoch vs. previously EOD rollup).
  • Improved handling of validator and delegator status.

👍

Info:

For more information, please refer to the Migration Guide.

➡️ Get the Rewards

Endpoints

Endpoint
Get a Stream of Rewards - POST /rewards
Get a Stream of Rewards for a Single Address - GET /rewards/{address}

Sample Object

The example object returned by the Get a stream of rewards endpoint is shown below.

{
  "address": "15MdAHnkxt9TMC2Rj595hsg8Hnv693pPBB",
  "denomination": "wei",
  "return": "283291849202",
  "startTime": 1704067200,
  "endTime": 1706745600,
  "period": "raw",
  "startBalance": "124222",
  "metadata": {
    "blockNumber": "0x1",
    "epoch": "1",
    "withdrawal": "123243",
    "restakeTotal": "123243"
  }
}

➡️ Get a Status

Endpoints

Endpoint
Get a Stream of Statuses - POST /status
Get Status for an Address - POST /status/address

Sample Object

The example object returned by the Get status for an address endpoint is shown below.

{
  "address": "15MdAHnkxt9TMC2Rj595hsg8Hnv693pPBB",
  "status": "active",
  "timestamp": 1708612182
}

➡️ Get Health

Endpoints

Sample Object

The response below is returned from the Get the Protocol Rewards Processing Health endpoint.

{
  "status": "OPTIMAL",
  "timestamp": 1717992000,
  "metadata": {
    "chainCheckpoint": "63629",
    "lastProcessedCheckpoint": "63628"
  }
}

👋 Need Help?

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