{
  "opencollection": "1.0.0",
  "info": {
    "name": "Substrate API Sidecar accounts rc staking API",
    "version": "20.14.1"
  },
  "items": [
    {
      "info": {
        "name": "rc staking",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get staking information for a _Stash_ account on the relay chain.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://polkadot-public-sidecar.parity-chains.parity.io/rc/accounts/:address/staking-info",
            "params": [
              {
                "name": "address",
                "value": "",
                "type": "path",
                "description": "SS58 address of the account. Must be a _Stash_ account."
              },
              {
                "name": "at",
                "value": "",
                "type": "query",
                "description": "Block at which to query the staking info for the specified account."
              },
              {
                "name": "includeClaimedRewards",
                "value": "",
                "type": "query",
                "description": "When set to `false`, the `claimedRewards` field is not included in the response."
              }
            ]
          },
          "docs": "Returns information about a _Stash_ account's staking activity on the relay chain. This endpoint is specifically for Asset Hub and queries the relay chain (Polkadot/Kusama) for staking information. The _Stash_ account can be either a validator or nominator account."
        },
        {
          "info": {
            "name": "Get payout information for a _Stash_ account on the relay chain.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://polkadot-public-sidecar.parity-chains.parity.io/rc/accounts/:address/staking-payouts",
            "params": [
              {
                "name": "address",
                "value": "",
                "type": "path",
                "description": "SS58 address of the account. Must be a _Stash_ account."
              },
              {
                "name": "at",
                "value": "",
                "type": "query",
                "description": "Block at which to query staking payouts."
              },
              {
                "name": "depth",
                "value": "",
                "type": "query",
                "description": "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."
              },
              {
                "name": "era",
                "value": "",
                "type": "query",
                "description": "The era to query at. Max era payout info is available for is the latest finished era (active_era - 1)."
              },
              {
                "name": "unclaimedOnly",
                "value": "",
                "type": "query",
                "description": "Only return unclaimed rewards."
              }
            ]
          },
          "docs": "Returns payout information for the last specified eras on the relay chain. This endpoint is specifically for Asset Hub and queries the relay chain (Polkadot/Kusama) for staking payout information. 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). The _Stash_ account can be either a validator or nominator account."
        },
        {
          "info": {
            "name": "Get progress on the general Staking pallet system on Relay Chain.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://polkadot-public-sidecar.parity-chains.parity.io/rc/pallets/staking/progress",
            "params": [
              {
                "name": "at",
                "value": "",
                "type": "query",
                "description": "Block at which to retrieve a staking progress report."
              }
            ]
          },
          "docs": "Returns information on the progress of key components of the staking system and estimates of future points of interest. If you are querying from Asset Hub for staking progress, this endpoint requires multi chain connections between the relay chain, and asset hub itself. Set the asset hub rpc to SAS_SUBSTRATE_URL, and add the relay chain to the SAS_SUBSTRATE_MULTI_CHAIN_URL env var. Refer to the README for the structure of the env vars. The `useRcBlock` parameter allows querying Asset Hub state u"
        },
        {
          "info": {
            "name": "Get all validators (active/waiting) of a specific chain.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://polkadot-public-sidecar.parity-chains.parity.io/rc/pallets/staking/validators",
            "params": [
              {
                "name": "at",
                "value": "",
                "type": "query",
                "description": "Block at which to retrieve the list of validators."
              }
            ]
          },
          "docs": "Returns a list of all validators addresses and their corresponding status which can be either active or waiting. For declared validators, it also includes their commission rate (as parts-per-billion) and nomination blocking status. It will also return a list of active validators that will not be part of the next era for staking. They will be under the key \"validatorsToBeChilled\". It's important to note, that addresses can be present in both the \"validators\" key, and \"validatorsToBeChilled\". Comm"
        }
      ]
    }
  ],
  "bundled": true
}