Sign in

v1

latestOpenAPI 3.1.02026-07-24223580832.9 KB
Polkadot Staking Reporting

Get the Historical Stake & Rewards of a Nominator

Returns the historical stake & rewards allocated by a user-defined nominator address.

post/v1/polkadot/mainnet/nominator/history/{address}

Path parameters

addressstring required

A single public address to check.

Request body

fromTimeinteger required

The millisecond timestamp from which you wish to retrieve the historical stake and rewards.

toTimeinteger required

The millisecond timestamp until which you wish to retrieve the historical stake and rewards.

timeUnit'era' | 'day' | 'week' | 'month' required

This parameter is used to aggregate rewards. It must be one of era, day, week, or month.

Example request

{
  "fromTime": 1678174507000,
  "toTime": 1678779307000
}

Response

Historical Stake & Rewards of a Nominator

addressstring required

The public address.

currencystring required

The cryptocurrency protocol the request relates to.

returnnumber float required

The sum of the rewards for the previous UTC day. Rewards are recorded per session (four hours on Polkadot), and calculated per era (twenty-four hours on Polkadot). Thus, rewards will be calculated once per day on Polkadot.

timeStartstring required

The timestamp, in UTC, that marks the start of the period covered.

timeEndstring required

The timestamp, in UTC, that marks the end of the period covered.

timeAggregationstring required

The agregation period, one of era, day, week, or month.

startingBalancenumber float required

The staked amount at the beginning of the previous UTC day (at the timeStart).