Staking payouts

Get payout information for a _Stash_ account.

get

Returns payout information for the last specified eras. If specifying both the depth and era query params, this endpoint will return information for (era - depth) through era. (i.e. if depth=5 and era=20 information will be returned for eras 16 through 20). N.B. You cannot query eras less then current_era - HISTORY_DEPTH. N.B. The nominator* fields correspond to the address being queried, even if it is a validator's Stash address. This is because a validator is technically nominating itself.

Path parameters

accountIdstring · SS58Required

SS58 address of the account. Must be a Stash account.

Query parameters

atstring · unsignedInteger or $hexOptional

Block height (as a non-negative integer) or hash (as a hex string).

depthstring · unsignedIntegerOptional

The number of eras to query for payouts of. Must be less than or equal to HISTORY_DEPTH. In cases where era - (depth -1) is less than 0, the first era queried will be 0.

Default: 1

erastring · unsignedIntegerOptional

The era to query at.

Default: `active_era - 1`

unclaimedOnlystring · booleanOptional

Only return unclaimed rewards.

Default: true

Responses

200

successful operation

application/json

400

invalid blockId supplied for at query param

application/json

404

account not found

application/json

get

HTTPcURLJavaScriptPython

GET /accounts/{accountId}/staking-payouts HTTP/1.1
Host: dot-playbook.nownodes.io
Accept: */*

{
  "at": {
    "hash": "text",
    "height": "text"
  },
  "erasPayouts": [
    {
      "era": "text",
      "totalEraRewardPoints": "text",
      "totalEraPayout": "text",
      "payouts": [
        {
          "validatorId": "text",
          "nominatorStakingPayout": "text",
          "claimed": true,
          "totalValidatorRewardPoints": "text",
          "validatorCommission": "text",
          "totalValidatorExposure": "text",
          "nominatorExposure": "text"
        }
      ]
    }
  ]
}