Staking info

Get staking information for a _Stash_ account.

get

Returns information about a Stash account's staking activity. Replaces /staking/{address} from versions < v1.0.0. The Stash account can be either a validator or nominator account.

Path parameters

accountIdstring · SS58Required

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

Query parameters

atstring · unsignedInteger or $hexOptional

Block identifier, as the block height or block hash.

includeClaimedRewardsstring · booleanOptional

When set to false, the claimedRewards field is not included in the response.

Default: true

Responses

application/json

objectOptional

Note: For Sidecar versions prior to v.20.0.0, in field claimedRewards under staking, we return whatever we would find under StakingLedger with no further calculations. From v.20.0.0 onwards, claimedRewards is calculated based on different calls: lastReward, claimedRewards or legacyClaimedRewards. Note on lastReward: Runtime versions of Kusama less than 1062 will either have lastReward in place of claimedRewards, or no field at all. This is related to changes in reward distribution. See: Lazy Payouts, Simple Payouts

application/json

application/json

get

HTTPcURLJavaScriptPython

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

{
  "at": {
    "hash": "text",
    "height": "text"
  },
  "rewardDestination": "Staked",
  "controller": "text",
  "numSlashingSpans": "text",
  "nominations": {
    "targets": [
      "text"
    ],
    "submittedIn": "text",
    "suppressed": true
  },
  "staking": {
    "stash": "text",
    "total": "text",
    "active": "text",
    "unlocking": "text",
    "claimedRewards": [
      {
        "era": "text",
        "status": "claimed"
      }
    ]
  }
}