Staking rewards API. This doc describes how you can get data about staking rewards by different parameters in several POS chains. (0.1)

Download OpenAPI specification:Download

URL: https://p2p.org License: Apache 2.0

Overview

This section provides an overview of the API design, methods, and supported use cases.

Most of the endpoints accept JSON as input and return JSON responses. This means that you must usually add the following headers to your request:

Content-type: application/json
Accept: application/json

Trying the API

You can use a third party client, such as curl, HTTPie, Postman or the Insomnia rest client to test the Staking rewards API.

Note that you will need to pass credentials data.

For e.g., here is how to get blockchains list with curl, when basic authorization is used:

curl -X GET 'https://staking-data-api-p2p.hasura.app/api/rest/blockchains' \
-H 'Content-Type: application/json' \
-H 'x-hasura-admin-secret: secret' \

Authorization

Using API key header to interact with API.

Please request us for access.

Errors

We follow the error response format proposed in RFC 7807 also known as Problem Details for HTTP APIs. As with our normal API responses, your client must be prepared to gracefully handle additional members of the response.

Unauthorized

This indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. Please check that you have valid credentials.

NotFound

This client error response indicates that the server cannot find the requested resource.

Unknown (Internal Server Error)

This means that the server encountered an unexpected condition that prevented it from fulfilling the request.

Blockchain

List blockchains

Method returns the list of blockchains that are supported by API. You can use this info for API endpoints which consist of blockchain_name in parameters.

SecurityApiKeyAuth

Responses

200

Success.

401

Request not authenticated due to missing, invalid, authentication info.

404

A specified resource is not found.

500

Unknown server error.

get/blockchains

Request samples

curl
Python

Response samples

application/json

{"blockchains": [[{"blockchain_name": "Ethereum",
"ecosystem_name": "Ethereum ecosystem"
},
{"blockchain_name": "Polkadot",
"ecosystem_name": "Polkadot ecosystem"
},
{"blockchain_name": "Kusama",
"ecosystem_name": "Polkadot ecosystem"
}
]
]
}

Blockchains periods

This method returns the acceptable periods of blockchain_period for staking data. You can use this info for API endpoints which consist of blockchain_period_name in parameters.

SecurityApiKeyAuth

Request

path Parameters

blockchain_name

required

string

The name of blockchain.

Responses

200

Success.

401

Request not authenticated due to missing, invalid, authentication info.

404

A specified resource is not found.

500

Unknown server error.

get/blockchains/{blockchain_name}/periods

Request samples

curl
Python

Response samples

application/json

{"blockchainPeriods": [{"blockchain_name": "Polkadot",
"ecosystem_name": "Polkadot ecosystem",
"blockchain_period_name": "era"
}
]
}

Blockchains on-chain report

This method returns the blockchain staking data for every defined blockchain period (specified period of rewards payment and stat collection, can be block era epoch day depends on chain)

SecurityApiKeyAuth

Request

path Parameters

blockchain_name

required

string

The name of blockchain.

query Parameters

datetime_from	string <date-time> Default: "2000-01-01 00:00:00" The start date for query.
datetime_to	string <date-time> Default: "2100-01-01 00:00:00" The finish date for query.
period_count	string Default: 100 The number of last periods for data mart.

Responses

200

Success.

401

Request not authenticated due to missing, invalid, authentication info.

404

A specified resource is not found.

500

Unknown server error.

get/blockchains/{blockchain_name}/report

Request samples

curl
Python

Response samples

application/json

{"blockchainReports": [{"blockchain_name": "Polkadot",
"ecosystem_name": "Polkadot ecosystem",
"blockchain_period_name": "era",
"blockchain_period_num": "946",
"datetime_from": "2023-01-04 15:36:18.014000",
"datetime_to": "2023-01-05 15:36:18.011000",
"blockchain_total_rewards": "241225.0405479788",
"reward_coingecoid": "polkadot",
"blockchain_total_stake": "504346062.64968455",
"stake_coingecoide": "polkadot",
"delegators_num": "20241",
"validators_num": "297"
}
]
}

Validators

List validators

Get the list of active validators per period.

SecurityApiKeyAuth

Request

path Parameters

blockchain_name

required

string

The name of blockchain.

query Parameters

datetime_from	string <date-time> Default: "2000-01-01 00:00:00" The start date for query.
datetime_to	string <date-time> Default: "2100-01-01 00:00:00" The finish date for query.
period_count	string Default: 100 The number of last periods for data mart.

Responses

200

Success.

401

Request not authenticated due to missing, invalid, authentication info.

404

A specified resource is not found.

500

Unknown server error.

get/blockchains/{blockchain_name}/validators

Request samples

curl
Python

Response samples

application/json

{"validators": [{"blockchain_name": "Polkadot",
"ecosystem_name": "Polkadot ecosystem",
"blockchain_period_name": "era",
"blockchain_period_num": "946",
"datetime_from": "2023-01-04 15:36:18.014000",
"datetime_to": "2023-01-05 15:36:18.011000",
"validators_addresses": [{"validator_address": "12eZSMk8GJYE2Lq943dSEnMUoZs1ek7jU8QN3rEA1yPZPjcR"
},
{"validator_address": "12pgR5dyEkUP6iTR9u7b74Nz7uCsCYKpkFfA5LFbQPjGwNHL"
}
]
}
]
}

Validators on-chain report

This method returns the blockchain staking data for every defined blockchain period per every validator that was active.

SecurityApiKeyAuth

Request

path Parameters

blockchain_name

required

string

The name of blockchain.

query Parameters

datetime_from	string <date-time> Default: "2000-01-01 00:00:00" The start date for query.
datetime_to	string <date-time> Default: "2100-01-01 00:00:00" The finish date for query.
period_count	string Default: 100 The number of last periods for data mart.
validator_address required	string Validator public key.

Responses

200

Success.

401

Request not authenticated due to missing, invalid, authentication info.

404

A specified resource is not found.

500

Unknown server error.

get/blockchains/{blockchain_name}/validators/report

Request samples

curl
Python

Response samples

application/json

{"validatorReports": [{"blockchain_name": "Polkadot",
"ecosystem_name": "Polkadot ecosystem",
"blockchain_period_name": "era",
"blockchain_period_num": "946",
"datetime_from": "2023-01-04 15:36:18.014000",
"datetime_to": "2023-01-05 15:36:18.011000",
"validators_addresses": "14AkAFBzukRhAFh1wyko1ZoNWnUyq7bY1XbjeTeCHimCzPU1",
"delegator_num": "256",
"validator_fee": "2.5",
"stake": [{"type": "clients_stake",
"amount": "2275343.5417242087",
"coingekoid": "polkadot"
},
{"type": "self",
"amount": "0",
"coingekoid": "polkadot"
}
],
"rewards": [{"type": "validator_fee",
"amount": "20.26669878544223",
"coingekoid": "polkadot",
"period_payment_date": "2023-01-05 15:36:18.011000"
}
]
}
]
}

Delegators

List delegators

Get the list of active delegators per period.

SecurityApiKeyAuth

Request

path Parameters

blockchain_name

required

string

The name of blockchain.

query Parameters

datetime_from	string <date-time> Default: "2000-01-01 00:00:00" The start date for query.
datetime_to	string <date-time> Default: "2100-01-01 00:00:00" The finish date for query.
period_count	string Default: 100 The number of last periods for data mart.

Responses

200

Success.

401

Request not authenticated due to missing, invalid, authentication info.

404

A specified resource is not found.

500

Unknown server error.

get/blockchains/{blockchain_name}/delegators

Request samples

curl
Python

Response samples

application/json

{"delegators": [{"blockchain_name": "Polkadot",
"ecosystem_name": "Polkadot ecosystem",
"blockchain_period_name": "era",
"blockchain_period_num": "1016",
"datetime_from": "2023-03-14 15:36:18.014000",
"datetime_to": "2023-03-15 15:36:18.011000",
"blockchain_user_address": [{"blockchain_user_address": "1BEV8SuBhtFYcXhwesJf9cePgpFjGzY58ybnb4yfrEAaBMx"
},
{"blockchain_user_address": "1MUoG2n9WhmXUszhuQdyPeXSGg7MoVn8ZFaZnXyGyzs4wW1"
}
]
}
]
}

Delegators on-chain report

Get delegator on-chain report.

SecurityApiKeyAuth

Request

path Parameters

blockchain_name

required

string

The name of blockchain.

query Parameters

datetime_from	string <date-time> Default: "2000-01-01 00:00:00" The start date for query.
datetime_to	string <date-time> Default: "2100-01-01 00:00:00" The finish date for query.
period_count	string Default: 100 The number of last periods for data mart.
blockchain_user_address required	string Delegator public key.

Responses

200

Success.

401

Request not authenticated due to missing, invalid, authentication info.

404

A specified resource is not found.

500

Unknown server error.

get/blockchains/{blockchain_name}/delegators/report

Request samples

curl
Python

Response samples

application/json

{"delegatorReports": [{"blockchain_name": "Polkadot",
"ecosystem_name": "Polkadot ecosystem",
"blockchain_period_name": "era",
"blockchain_period_num": "946",
"datetime_from": "2023-01-04 15:36:18.014000",
"datetime_to": "2023-01-05 15:36:18.011000",
"blockchain_user_address": "13YoPoKBvLrZM1avJBUMQ9Ccd8uC7D4y8dWNYeeXqpQQGEYP",
"stake": [{"type": "clients_stake",
"amount": "701.5",
"coingekoid": "polkadot"
}
],
"rewards": [{"type": "client_reward",
"amount": "0.34437678615378675",
"coingekoid": "polkadot",
"period_payment_date": "2023-01-05 15:36:18.011000",
"validator_address": "153YD8ZHD9dRh82U419bSCB5SzWhbdAFzjj4NtA5pMazR2yC"
}
]
}
]
}

APR

Get APR for given deposit address.

SecurityApiKeyAuth

Request

path Parameters

deposit_address

required

string

The blockchain user address.

Responses

200

Success.

401

Request not authenticated due to missing, invalid, authentication info.

404

A specified resource is not found.

500

Unknown server error.

get/deposits/{deposit_address}/apr

Request samples

curl
Python

Response samples

application/json

{"result": [{"apr": "4.7415101558088555"
}
]
}

Rewards

Get total rewards for given deposit address.

SecurityApiKeyAuth

Request

path Parameters

deposit_address

required

string

The blockchain user address.

Responses

200

Success.

401

Request not authenticated due to missing, invalid, authentication info.

404

A specified resource is not found.

500

Unknown server error.

get/deposits/{deposit_address}/total_rewards

Request samples

curl
Python

Response samples

application/json

{"result": [{"total_rewards": "0.06417987100000008"
}
]
}