Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kusama staking API

The staking API from Kusama — 4 operation(s) for staking.

Kusama staking API is one of 21 APIs that Kusama publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include staking. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 4 paths, and defines 11 schemas. It is described by OpenAPI 3.0.0, at version 20.14.1.

Requests are made against 5 base URLs: https://polkadot-public-sidecar.parity-chains.parity.io/, https://kusama-public-sidecar.parity-chains.parity.io/, https://polkadot-asset-hub-public-sidecar.parity-chains.parity.io/, https://kusama-asset-hub-public-sidecar.parity-chains.parity.io/, http://localhost:8080.

4 operations 4 paths 11 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
20.14.1
Base URL
https://kusama-rpc.polkadot.io/
Resource Areas
1

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

staking 4
GET
/accounts/{accountId}/staking-info
Get staking information for a Stash account.
getStakingSummaryByAccountId 5 params → 200400404
GET
/accounts/{accountId}/staking-payouts
Get payout information for a Stash account.
getStakingPayoutsByAccountId 7 params → 200400404
GET
/pallets/staking/progress
Get progress on the general Staking pallet system.
getStakingProgress 3 params → 200400
GET
/pallets/staking/validators
Get all validators (active/waiting) of a specific chain.
getStakingValidators 3 params → 200400

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are StakingProgress (12 properties), AccountStakingInfo (9 properties), StakingValidators (6 properties), StakingLedger (5 properties). Each schema is shown below with its type and property counts.

BlockIdentifiers
object
2 properties
Error
object
4 properties
AccountStakingInfo
object
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 calcu…
9 properties
UnappliedSlash
object
5 properties
Payouts
array
AccountStakingPayouts
object
5 properties
Nominations
object
3 properties
ElectionStatus
object
Information about the off-chain election. Not included in response when forceEra.isForceNone.
2 properties
StakingProgress
object
12 properties
StakingLedger
object
The staking ledger.
5 properties
StakingValidators
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kusama-staking-api-openapi.yml Raw ↑

Other APIs Kusama publishes across the network.

Kusama JSON-RPC API
Kusama accounts API
Kusama ahm API
Kusama blocks API
Kusama contracts API
Kusama coretime API
Kusama node API
Kusama pallets API
Kusama paras API
Kusama rc accounts API
Kusama rc API
Kusama rc blocks API