Skip To Content

Blockdaemon Documentation

Polkadot Staking Reporting API

Polkadot Staking Reporting API

Overview
Supported Networks

Nominator Endpoints
(GET) Get Status of Nominator
(POST) Get Status of Nominators
(GET) Get Stake & Rewards of Nominator
(POST) Get Stake & Rewards of Nominators
(POST) Get Historical Stake & Rewards of Nominator
(POST) Get Historical Stake & Rewards of Nominators
(GET) Verify Staking Activity of Nominator
(POST) Verify Staking Activity of Nominators

Validator Endpoints
(GET) Get Status of Validator
(POST) Get Status of Validators
(GET) Get Stake & Rewards of Validator
(POST) Get Stake & Rewards of Validators
(POST) Get Historical Stake & Rewards of Validator
(POST) Get Historical Stake & Rewards of Validators
(GET) Verify Staking Activity of Validator
(POST) Verify Staking Activity of Validators


Overview

With Blockdaemon Staking Reporting API, you can easily access staking information from multiple protocols for your financial data analysis needs.

The Polkadot Staking Reporting API endpoints listed in this section allow the retrieval of staking data in Polkadot Mainnet. You can get the current or historical stake & rewards allocated to given nominator and validator addresses and other data.

See also:


Supported Networks

Blockdaemon Staking Reporting API supports the following Polkadot networks:

  • Polkadot Mainnet

(GET) Get Status of Nominator

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/nominator/status/{address}

Returns the current status of a given nominator address.

Learn how to authorize your request: Authentication Guide

Path Parameters

It is required to specify a nominator address as the last path parameter, e.g.:

  • 15pBbks3VK95JxhzrKwCvFc8kwzKz4c9qrNzCDT3sSJPp9Ft

Example Queries

The query in this section provides a useful example for (GET) Get Status of Nominator.

To get the current status of a nominator in Polkadot Mainnet, use the following query:

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/nominator/status/15pBbks3VK95JxhzrKwCvFc8kwzKz4c9qrNzCDT3sSJPp9Ft

Example Response

The following is a typical response from (GET) Get Status of Nominator:

{
    "address": "15pBbks3VK95JxhzrKwCvFc8kwzKz4c9qrNzCDT3sSJPp9Ft",
    "status": "active",
    "commission": 1,
    "activationDate": "2022-09-23"
}

(POST) Get Status of Nominators

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/nominator/status

Returns the current status of multiple given nominator addresses.

Learn how to authorize your request: Authentication Guide

Request Body

In the body of your request, specify an array of nominator addresses, for example:

{
    "addresses": [
        "15pBbks3VK95JxhzrKwCvFc8kwzKz4c9qrNzCDT3sSJPp9Ft",
        "14EpUEGi5ywuk7FKGDCi8mZs4etP1sw3fMGAXYP5FsdCD1A7"
    ]
}

Example Response

The following is a typical response from (POST) Get Status of Nominators:

[
    {
        "address": "15pBbks3VK95JxhzrKwCvFc8kwzKz4c9qrNzCDT3sSJPp9Ft",
        "status": "active",
        "commission": 1,
        "activationDate": "2022-09-23"
    },
    { ...more items... }
]

(GET) Get Stake & Rewards of Nominator

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/nominator/rewards/{address}

Returns the current stake & rewards allocated to a given nominator address. Timestamps are given in UTC.

Learn how to authorize your request: Authentication Guide

Path Parameters

It is required to specify a nominator address as the last path parameter, e.g.:

  • 15pBbks3VK95JxhzrKwCvFc8kwzKz4c9qrNzCDT3sSJPp9Ft

Example Queries

The query in this section provides a useful example for (GET) Get Stake & Rewards of Nominator.

To get the current stake & rewards of a nominator in Polkadot Mainnet, use the following query:

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/nominator/rewards/15pBbks3VK95JxhzrKwCvFc8kwzKz4c9qrNzCDT3sSJPp9Ft

Example Response

The following is a typical response from (GET) Get Stake & Rewards of Nominator:

{
    "address": "15pBbks3VK95JxhzrKwCvFc8kwzKz4c9qrNzCDT3sSJPp9Ft",
    "currency": "DOT",
    "return": 10.63887846913839680727192724406968,
    "timeStart": "2022-12-14T15:36:18Z",
    "timeEnd": "2022-12-14T15:36:18Z",
    "timeAggregation": "era",
    "startingBalance": 30661.1257179199,
    "metadata": {
        "delegationAddress": "11uMPbeaEDJhUxzU4ZfWW9VQEsryP9XqFcNRfPdYda6aFWJ",
        "era": 926
    }
}

(POST) Get Stake & Rewards of Nominators

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/nominator/rewards

Returns the current stake & rewards allocated to multiple given nominator addresses. Timestamps are given in UTC.

Learn how to authorize your request: Authentication Guide

Request Body

In the body of your request, specify an array of nominator addresses, for example:

{
    "addresses": [
        "15pBbks3VK95JxhzrKwCvFc8kwzKz4c9qrNzCDT3sSJPp9Ft",
        "14EpUEGi5ywuk7FKGDCi8mZs4etP1sw3fMGAXYP5FsdCD1A7"
    ]
}

Query Parameters

To aggregate rewards across addresses, use the following parameter:

  • parameter: aggregate
  • value: true / false (default)

Example Queries

The query in this section provides a useful example for (POST) Get Stake & Rewards of Nominators.

To get the aggregated rewards of multiple nominators in Polkadot Mainnet, use the following query:

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/nominator/rewards?aggregate=true

Example Response

The following is a typical response from (POST) Get Stake & Rewards of Nominators (non-aggregated):

[
    {
        "address": "14EpUEGi5ywuk7FKGDCi8mZs4etP1sw3fMGAXYP5FsdCD1A7",
        "currency": "DOT",
        "return": 291.8878715902130772546871109460372,
        "timeStart": "2022-12-14T15:36:18Z",
        "timeEnd": "2022-12-14T15:36:18Z",
        "timeAggregation": "era",
        "startingBalance": 584565.8888183158,
        "metadata": {
            "delegationAddress": "139MMfwzrHyveFAuCS5SUaZG85qwM66pRnvoKyST3gd9Ao1F",
            "era": 926
        }
    },
    { ...more items... }
]

(POST) Get Historical Stake & Rewards of Nominator

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/nominator/history/{address}

Returns the historical stake & rewards allocated to a given nominator address. Timestamps are given in UTC.

Learn how to authorize your request: Authentication Guide

Path Parameters

It is required to specify a nominator address as the last path parameter, e.g.:

  • 15pBbks3VK95JxhzrKwCvFc8kwzKz4c9qrNzCDT3sSJPp9Ft

Request Body

In the body of your request, specify a date range, for example:

{
    "fromTime": 1662940800000,
    "toTime": 1664755200000,
    "timeUnit": "weekly"
}

In the fromTime and toTime fields, you should specify Unix timestamps in milliseconds (UTC time zone).

The timeUnit parameter takes the following values:

Value Response
era All the rewards between given timestamps, aggregated by Polkadot era (24 hours)
day / daily All the rewards between given timestamps, aggregated by day
week / weekly All the rewards between given timestamps, aggregated by week
month / monthly All the rewards between given timestamps, aggregated by month

Example Queries

The query in this section provides a useful example for (GET) Get Historical Stake & Rewards of Nominator.

To get historical stake & rewards of a nominator in Polkadot Mainnet, use the following query:

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/nominator/history/15pBbks3VK95JxhzrKwCvFc8kwzKz4c9qrNzCDT3sSJPp9Ft

Example Response

The following is a typical response from (POST) Get Historical Stake & Rewards of Nominator:

[
    {
        "address": "15pBbks3VK95JxhzrKwCvFc8kwzKz4c9qrNzCDT3sSJPp9Ft",
        "currency": "DOT",
        "return": 76.9466692269298639354749403808634,
        "timeStart": "2022-09-26T00:00:00Z",
        "timeEnd": "2022-10-02T23:59:59Z",
        "timeAggregation": "weekly",
        "startingBalance": 30661.1257179199,
        "metadata": {
            "delegationAddress": "several"
        }
    },
    { ...more items... }
]

(POST) Get Historical Stake & Rewards of Nominators

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/nominator/history

Returns the historical stake & rewards allocated to multiple given nominator addresses. Timestamps are given in UTC.

Learn how to authorize your request: Authentication Guide

Request Body

In the body of your request, specify a date range and an array of nominator addresses, for example:

{
    "fromTime": 1662940800000,
    "toTime": 1664755200000,
    "timeUnit": "weekly",
    "addresses": [
        "15pBbks3VK95JxhzrKwCvFc8kwzKz4c9qrNzCDT3sSJPp9Ft",
        "14EpUEGi5ywuk7FKGDCi8mZs4etP1sw3fMGAXYP5FsdCD1A7"
    ]
}

In the fromTime and toTime fields, you should specify Unix timestamps in milliseconds (UTC time zone).

The timeUnit parameter takes the following values:

Value Response
era All the rewards between given timestamps, aggregated by Polkadot era (24 hours)
day / daily All the rewards between given timestamps, aggregated by day
week / weekly All the rewards between given timestamps, aggregated by week
month / monthly All the rewards between given timestamps, aggregated by month

Query Parameters

To aggregate rewards across addresses, use the following parameter:

  • parameter: aggregate
  • value: true / false (default)

Example Queries

The query in this section provides a useful example for (POST) Get Historical Stake & Rewards of Nominators.

To get the aggregated historical rewards of multiple nominators in Polkadot Mainnet, use the following query:

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/nominator/history?aggregate=true

Example Response

The following is a typical response from (POST) Get Historical Stake & Rewards of Nominators (non-aggregated):

[
    {
        "address": "15pBbks3VK95JxhzrKwCvFc8kwzKz4c9qrNzCDT3sSJPp9Ft",
        "currency": "DOT",
        "return": 76.9466692269298639354749403808634,
        "timeStart": "2022-09-26T00:00:00Z",
        "timeEnd": "2022-10-02T23:59:59Z",
        "timeAggregation": "weekly",
        "startingBalance": 30661.1257179199,
        "metadata": {
            "delegationAddress": "several"
        }
    },
    { ...more items... }
]

(GET) Verify Staking Activity of Nominator

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/nominator/active/{address}

Returns true if a given nominator address is active, false otherwise.

Learn how to authorize your request: Authentication Guide

Path Parameters

It is required to specify a nominator address as the last path parameter, e.g.:

  • 15pBbks3VK95JxhzrKwCvFc8kwzKz4c9qrNzCDT3sSJPp9Ft

Example Queries

The query in this section provides a useful example for (GET) Verify Staking Activity of Nominator.

To verify the staking activity of a nominator in Polkadot Mainnet, use the following query:

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/nominator/active/14EpUEGi5ywuk7FKGDCi8mZs4etP1sw3fMGAXYP5FsdCD1A7

Example Response

The following is a typical response from (GET) Verify Staking Activity of Nominator:

{
    "15pBbks3VK95JxhzrKwCvFc8kwzKz4c9qrNzCDT3sSJPp9Ft": false
}

(POST) Verify Staking Activity of Nominators

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/nominator/active

Returns true if a given nominator address is active, false otherwise (for each address from a list).

Learn how to authorize your request: Authentication Guide

Request Body

In the body of your request, specify an array of nominator addresses, for example:

{
    "addresses": [
        "15pBbks3VK95JxhzrKwCvFc8kwzKz4c9qrNzCDT3sSJPp9Ft",
        "14EpUEGi5ywuk7FKGDCi8mZs4etP1sw3fMGAXYP5FsdCD1A7"
    ]
}

Example Response

The following is a typical response from (GET) Verify Staking Activity of Nominators:

[
    {
        "15pBbks3VK95JxhzrKwCvFc8kwzKz4c9qrNzCDT3sSJPp9Ft": false
    },
    { ...more items... }
]

(GET) Get Status of Validator

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/validator/status/{address}

Returns the current status of a given validator address.

Learn how to authorize your request: Authentication Guide

Path Parameters

It is required to specify a validator address as the last path parameter, e.g.:

  • 12doHFjPjPngNvZCWX4WeF4rkLFJ5LmmEyDvPGQ2C1aPppwy

Example Queries

The query in this section provides a useful example for (GET) Get Status of Validator.

To get the current status of a validator in Polkadot Mainnet, use the following query:

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/validator/status/12doHFjPjPngNvZCWX4WeF4rkLFJ5LmmEyDvPGQ2C1aPppwy

Example Response

The following is a typical response from (GET) Get Status of Validator:

{
    "address": "12doHFjPjPngNvZCWX4WeF4rkLFJ5LmmEyDvPGQ2C1aPppwy",
    "status": "active",
    "commission": 1,
    "activationDate": "2022-09-23"
}

(POST) Get Status of Validators

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/validator/status

Returns the current status of multiple given validator addresses.

Learn how to authorize your request: Authentication Guide

Request Body

In the body of your request, specify an array of validator addresses, for example:

{
    "addresses": [
        "12doHFjPjPngNvZCWX4WeF4rkLFJ5LmmEyDvPGQ2C1aPppwy"
    ]
}

Example Response

The following is a typical response from (POST) Get Status of Validators:

[
    {
        "address": "12doHFjPjPngNvZCWX4WeF4rkLFJ5LmmEyDvPGQ2C1aPppwy",
        "status": "active",
        "commission": 1,
        "activationDate": "2022-09-23"
    },
    { ...more items... }
]

(GET) Get Stake & Rewards of Validator

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/validator/rewards/{address}

Returns the current stake & rewards allocated to a given validator address. Timestamps are given in UTC.

Learn how to authorize your request: Authentication Guide

Path Parameters

It is required to specify a validator address as the last path parameter, e.g.:

  • 12doHFjPjPngNvZCWX4WeF4rkLFJ5LmmEyDvPGQ2C1aPppwy

Example Queries

The query in this section provides a useful example for (GET) Get Stake & Rewards of Validator.

To get the current stake & rewards of a validator in Polkadot Mainnet, use the following query:

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/validator/rewards/12doHFjPjPngNvZCWX4WeF4rkLFJ5LmmEyDvPGQ2C1aPppwy

Example Response

The following is a typical response from (GET) Get Stake & Rewards of Validator:

{
    "address": "12doHFjPjPngNvZCWX4WeF4rkLFJ5LmmEyDvPGQ2C1aPppwy",
    "currency": "DOT",
    "return": 1060.338956097252009484294005140814,
    "timeStart": "2022-12-14T15:36:18Z",
    "timeEnd": "2022-12-14T15:36:18Z",
    "timeAggregation": "era",
    "startingBalance": 1693163.7714432,
    "metadata": {
        "commission": 0.03,
        "validatorRewards": 1029.455297181798067460479616641567,
        "commissionRewards": 30.88365891545394202381438849924701,
        "era": 926
    }
}

(POST) Get Stake & Rewards of Validators

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/validator/rewards

Returns the current stake & rewards allocated to multiple given validator addresses. Timestamps are given in UTC.

Learn how to authorize your request: Authentication Guide

Request Body

In the body of your request, specify an array of validator addresses, for example:

{
    "addresses": [
        "12doHFjPjPngNvZCWX4WeF4rkLFJ5LmmEyDvPGQ2C1aPppwy"
    ]
}

Query Parameters

To aggregate rewards across addresses, use the following parameter:

  • parameter: aggregate
  • value: true / false (default)

Example Queries

The query in this section provides a useful example for (POST) Get Stake & Rewards of Validators.

To get the aggregated rewards of multiple validators in Polkadot Mainnet, use the following query:

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/validator/rewards?aggregate=true

Example Response

The following is a typical response from (POST) Get Stake & Rewards of Validators (non-aggregated):

[
    {
        "address": "12doHFjPjPngNvZCWX4WeF4rkLFJ5LmmEyDvPGQ2C1aPppwy",
        "currency": "DOT",
        "return": 1060.338956097252009484294005140814,
        "timeStart": "2022-12-14T15:36:18Z",
        "timeEnd": "2022-12-14T15:36:18Z",
        "timeAggregation": "era",
        "startingBalance": 1693163.7714432,
        "metadata": {
            "commission": 0.03,
            "validatorRewards": 1029.455297181798067460479616641567,
            "commissionRewards": 30.88365891545394202381438849924701,
            "era": 926
        }
    },
    { ...more items... }
]

(POST) Get Historical Stake & Rewards of Validator

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/validator/history/{address}

Returns the historical stake & rewards allocated to a given validator address. Timestamps are given in UTC.

Learn how to authorize your request: Authentication Guide

Path Parameters

It is required to specify a validator address as the last path parameter, e.g.:

  • 12doHFjPjPngNvZCWX4WeF4rkLFJ5LmmEyDvPGQ2C1aPppwy

Request Body

In the body of your request, specify a date range, for example:

{
    "fromTime": 1662940800000,
    "toTime": 1664755200000,
    "timeUnit": "weekly"
}

In the fromTime and toTime fields, you should specify Unix timestamps in milliseconds (UTC time zone).

The timeUnit parameter takes the following values:

Value Response
era All the rewards between given timestamps, aggregated by Polkadot era (24 hours)
day / daily All the rewards between given timestamps, aggregated by day
week / weekly All the rewards between given timestamps, aggregated by week
month / monthly All the rewards between given timestamps, aggregated by month

Example Queries

The query in this section provides a useful example for (GET) Get Historical Stake & Rewards of Validator.

To get historical stake & rewards of a validator in Polkadot Mainnet, use the following query:

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/validator/history/12doHFjPjPngNvZCWX4WeF4rkLFJ5LmmEyDvPGQ2C1aPppwy

Example Response

The following is a typical response from (POST) Get Historical Stake & Rewards of Validator:

[
    {
        "address": "12doHFjPjPngNvZCWX4WeF4rkLFJ5LmmEyDvPGQ2C1aPppwy",
        "currency": "DOT",
        "return": 7404.915057186377240995000440915054,
        "timeStart": "2022-09-26T00:00:00Z",
        "timeEnd": "2022-10-02T23:59:59Z",
        "timeAggregation": "weekly",
        "startingBalance": 2489497.0056051192,
        "metadata": {
            "commission": 0.03,
            "validatorRewards": 7189.237919598424505820388777587432,
            "commissionRewards": 215.677137587952735174611663327623
        }
    },
    { ...more items... }
]

(POST) Get Historical Stake & Rewards of Validators

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/validator/history

Returns the historical stake & rewards allocated to multiple given validator addresses. Timestamps are given in UTC.

Learn how to authorize your request: Authentication Guide

Request Body

In the body of your request, specify a date range and an array of validator addresses, for example:

{
    "fromTime": 1662940800000,
    "toTime": 1664755200000,
    "timeUnit": "weekly",
    "addresses": [
        "12doHFjPjPngNvZCWX4WeF4rkLFJ5LmmEyDvPGQ2C1aPppwy"
    ]
}

In the fromTime and toTime fields, you should specify Unix timestamps in milliseconds (UTC time zone).

The timeUnit parameter takes the following values:

Value Response
era All the rewards between given timestamps, aggregated by Polkadot era (24 hours)
day / daily All the rewards between given timestamps, aggregated by day
week / weekly All the rewards between given timestamps, aggregated by week
month / monthly All the rewards between given timestamps, aggregated by month

Query Parameters

To aggregate rewards across addresses, use the following parameter:

  • parameter: aggregate
  • value: true / false (default)

Example Queries

The query in this section provides a useful example for (POST) Get Historical Stake & Rewards of Validators.

To get the aggregated historical rewards of multiple validators in Polkadot Mainnet, use the following query:

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/validator/history?aggregate=true

Example Response

The following is a typical response from (POST) Get Historical Stake & Rewards of Validators (non-aggregated):

[
    {
        "address": "12doHFjPjPngNvZCWX4WeF4rkLFJ5LmmEyDvPGQ2C1aPppwy",
        "currency": "DOT",
        "return": 7404.915057186377240995000440915054,
        "timeStart": "2022-09-26T00:00:00Z",
        "timeEnd": "2022-10-02T23:59:59Z",
        "timeAggregation": "weekly",
        "startingBalance": 2489497.0056051192,
        "metadata": {
            "commission": 0.03,
            "validatorRewards": 7189.237919598424505820388777587432,
            "commissionRewards": 215.677137587952735174611663327623
        }
    },
    { ...more items... }
]

(GET) Verify Staking Activity of Validator

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/validator/active/{address}

Returns true if a given validator address is active, false otherwise.

Learn how to authorize your request: Authentication Guide

Path Parameters

It is required to specify a validator address as the last path parameter, e.g.:

  • 12doHFjPjPngNvZCWX4WeF4rkLFJ5LmmEyDvPGQ2C1aPppwy

Example Queries

The query in this section provides a useful example for (GET) Verify Staking Activity of Validator.

To verify the staking activity of a validator in Polkadot Mainnet, use the following query:

https://svc.blockdaemon.com/reporting/staking/v1/polkadot/mainnet/validator/active/12doHFjPjPngNvZCWX4WeF4rkLFJ5LmmEyDvPGQ2C1aPppwy

Example Response

The following is a typical response from (GET) Verify Staking Activity of Validator:

{
    "12doHFjPjPngNvZCWX4WeF4rkLFJ5LmmEyDvPGQ2C1aPppwy": false
}

(POST) Verify Staking Activity of Validators

https://svc.blockdaemon.comreporting/staking/v1/polkadot/mainnet/validator/active

Returns true if a given validator address is active, false otherwise (for each address from a list).

Learn how to authorize your request: Authentication Guide

Request Body

In the body of your request, specify an array of validator addresses, for example:

{
    "addresses": [
        "12doHFjPjPngNvZCWX4WeF4rkLFJ5LmmEyDvPGQ2C1aPppwy"
    ]
}

Example Response

The following is a typical response from (GET) Verify Staking Activity of Validators:

[
    {
        "12doHFjPjPngNvZCWX4WeF4rkLFJ5LmmEyDvPGQ2C1aPppwy": false
    },
    { ...more items... }
]

We don't support Internet Explorer

Please use Chrome, Safari, Firefox, or Edge to view this site.