Account staking payouts

GET

https://ksmassethub-playbook.nownodes.io/v1/accounts/{accountId}/staking-payouts

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Changed. Validator self-stake incentive is now included. Each entry of payouts has a new field validatorSelfStakeIncentive, and each entry of erasPayouts has a new field totalEraSelfStakeIncentivePayout (both "0" on chains without this incentive). totalEraPayout now explicitly covers the staker reward pool only; add totalEraSelfStakeIncentivePayout to get the full validator era payout. validatorSelfStakeIncentive is income for the queried account only when validatorId equals the account, so do not sum it across entries. Addresses encoded with any SS58 prefix are now accepted; before, an address from another network was rejected with 400.

Returns staking payout history for a given account including era rewards and claimed status.

Parameters

accountIdstringrequiredpath

SS58-encoded stash account address

atstringquery

Block hash or number to query at

depthstringquery

Number of eras to query (default: 1)

erastringquery

The era to query at (default: active_era - 1)

unclaimedOnlybooleanquery

Only show unclaimed rewards (default: true)

useRcBlockbooleanquery

Treat 'at' as relay chain block identifier

Response

200OK

Staking payout information

400Bad Request

Invalid parameters

500Internal Server Error

Internal server error

503Service Unavailable

Service unavailable

Account staking payouts

curl -X GET 'https://ksmassethub-playbook.nownodes.io/v1/accounts/{accountId}/staking-payouts'

const response = await fetch('https://ksmassethub-playbook.nownodes.io/v1/accounts/{accountId}/staking-payouts', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://ksmassethub-playbook.nownodes.io/v1/accounts/{accountId}/staking-payouts')
request = Net::HTTP::Get.new(uri)

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

import requests

response = requests.get('https://ksmassethub-playbook.nownodes.io/v1/accounts/{accountId}/staking-payouts')
data = response.json()

const response = await fetch('https://ksmassethub-playbook.nownodes.io/v1/accounts/{accountId}/staking-payouts', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://ksmassethub-playbook.nownodes.io/v1/accounts/{accountId}/staking-payouts";
const apiKey = "YOUR_API_KEY";

async function nownodesRequest(payload) {
  const response = await fetch(endpoint, {
    method: "GET",
    headers: {
      "Content-Type": "application/json",
      "api-key": apiKey,
    },
    body: JSON.stringify(payload),
  });

  return response.json();
}

const result = await nownodesRequest({});
console.log(result);

const response = await fetch('https://ksmassethub-playbook.nownodes.io/v1/accounts/{accountId}/staking-payouts', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://ksmassethub-playbook.nownodes.io/v1/accounts/{accountId}/staking-payouts')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://ksmassethub-playbook.nownodes.io/v1/accounts/{accountId}/staking-payouts')
request = Net::HTTP::Get.new(uri)

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

200

{
  "ahTimestamp": "string",
  "at": {
    "hash": "string",
    "height": "string"
  },
  "erasPayouts": [
    {
      "era": "string",
      "payouts": [
        {
          "claimed": true,
          "nominatorExposure": "string",
          "nominatorStakingPayout": "string",
          "totalValidatorExposure": "string",
          "totalValidatorRewardPoints": "string",
          "validatorCommission": "string",
          "validatorId": "string",
          "validatorSelfStakeIncentive": "string"
        }
      ],
      "totalEraPayout": "string",
      "totalEraRewardPoints": "string",
      "totalEraSelfStakeIncentivePayout": "string"
    }
  ],
  "rcBlockHash": "string",
  "rcBlockNumber": "string"
}