Skip to main content

/accounts/{accountId}/staking-payouts REST API Endpoint

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.

Updated on
Sep 02, 2024

Path Parameters

accountId
string
REQUIRED

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

Query Parameters

at
string

The block at which to query staking payouts.

depth
integer

The number of eras to query for payouts must be less than or equal to HISTORY_DEPTH. If the calculated start era (era - (depth - 1)) is less than 0, the query will begin from era 0

era
string

The era to query at.

unclaimedOnly
boolean

Return unclaimed rewards if set to true

Returns

at
object

An object containing information about the state.

hash
string

The hash of the block at the specified state.

height
string

The height of the block at the specified state.

erasPayouts
array

An array of objects, each representing the payout information for a particular era.

era
string

The era for which the payouts are being reported

totalEraRewardPoints
string

The total reward points for the era

totalEraPayout
string

The total payout for the era.

payouts
array

An array of objects, each representing the payout details for a specific validator and their nominators.

validatorId
string

The identifier of the validator.

nominatorStakingPayout
string

The staking payout for the nominator.

claimed
boolean

A boolean indicating whether the payout has been claimed

totalValidatorRewardPoints
string

The total reward points earned by the validator.

validatorCommission
string

The commission taken by the validator.

totalValidatorExposure
string

The total exposure of the validator.

nominatorExposure
string

The exposure of the nominator.

Request
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free