Skip to main content

Node API - Polkadot Sidecar


API AuthenticationClick to view API Authentication details
API calls require authentication with API key via Authorization request header or URL property. Calls are made to one of the Polkadot Sidecar Node API endpoints found in your app's dashboard.

For example: https://polkadot--sidecar.datahub.figment.io

Here's some boilerplate to get you started. 
fetch("https://polkadot--sidecar.datahub.figment.io/accounts/1qnJN7FViy3HZaxZK9tGAA71zxHSBeUweirKqCaox4t8GT7/balance-info", {
    method: 'POST', // can also be 'GET', 'PUT' or any appropriate method
    headers: {
        "Authorization" : "<api_key>",
        "Content-Type": "application/json" // if method is 'POST'
    },
    body: JSON.stringify({
      // JSON Payload
    })
})

Available Methods

/accounts/{accountId}/balance-info

Get balance information for an account.

Request Query (try it)
Example Response
{
  "at": {
    "hash": "0xc0228d74162527c190909fc9651c9e753c5519757fdad06c6d3d36f24d00dca2",
    "height": "12013835"
  },
  "nonce": "161609",
  "tokenSymbol": "DOT",
  "free": "53413103962315749",
  "reserved": "0",
  "miscFrozen": "0",
  "feeFrozen": "0",
  "locks": []
}
SpecificationView Specification

Parameters

  • accountId string($SS58) (required) (path) SS58 address of the account.
  • at string($unsignedInteger or $hex (query) Block at which to query balance info for the specified account.
  • token string (query) Token to query the balance of. If not specified it will query the chains native token (e.g. DOT for Polkadot). Note: this is only relevant for chains that support multiple tokens through the ORML tokens pallet.
  • denominated boolean (query) When set to true it will denominate any balance's given atomic value using the chains given decimal value. Default value:false

Response

  • Returns information about an account's balance. Replaces /balance/{address} from versions < v1.0.0.

/accounts/{accountId}/vesting-info

Get vesting information for an account.

Request Query (try it)
Example Response
{
  "at": {
    "hash": "0x3f1597893c2dee47bb8ee39dac0b262838a49a824b052468e2d3c3611721f1ec",
    "height": "12013902"
  },
  "vesting": []
}
SpecificationView Specification

Parameters

  • accountId string($SS58) (required) (path) SS58 address of the account.
  • at string($unsignedInteger or $hex) (query) Block at which to query the vesting info for the specified account.

Response

  • Returns the vesting schedule for an account. Replaces /vesting/{address} from versions < v1.0.0.

/accounts/{address}/validate

Validate a given address.

Request Query (try it)
Example Response
{
  "isValid": true,
  "ss58Prefix": "0",
  "network": "polkadot",
  "accountId": "0x3d0f887e609fbfc84f3eba39b873844a42ed0ef99c9f460d9a829d4e2ef5fe7b"
}
SpecificationView Specification

Parameters

  • address string($SS58 or Hex) (required) (path) SS58 or Hex address of the account.

Response

  • Returns whether the given address is valid ss58 format, the ss58 prefix if the address has one, the network address format, and what the account ID is for this address.

/blocks

Get a range of blocks by their height.

Request Query (try it)
Example Response
[
  {
    "number": "12014029",
    "hash": "0xaa3c192e5791c0cc6eff93068f42d693700e4ff226f28679da100c69ddf415fa",
    "parentHash": "0x74d5187e88a06db0f7998b2550f8a26664f56173d808f3ef76b0820033a54cfe",
    "stateRoot": "0xca9a1f4aca804a9b501ff5d4b1e33073862d75e97f52bbd9191b2979228e3138",
    "extrinsicsRoot": "0xdf57669dd49b13b3a00d608763ebda2973d0ff7514f065fc45b242e44cf3a014",
    "authorId": "13mhUnQ6qwvuuTYoKTtJkmssm3jDCGhTTSsHCXvvRhFooDiF",
    "logs": [
      {
        "type": "PreRuntime",
        "index": "6",
        "value": [
          "0x42414245",
          "0x038e000000b2288510000000001e2761cae48e73e7b79ef5d3a44e8b19a568b20fac090f2653fa71621713a53877fc0ede5bd6e8a78955a4fe09718b2e99ec2f116f27efc22db4eeb564237f0f77643298e58fffb85aa5fff9199315361ea389b692f091b1d746d58de42f5504"
        ]
      },
      {
        "type": "Seal",
        "index": "5",
        "value": [
          "0x42414245",
          "0xec3f0206f4b36e3dc3ff07ae5e923102a47c33bb16c9d579e8015ddd79895171e58720c862532073c175b69975acbd1e8a6c56925a51d99ea21a89baee605b86"
        ]
      }
    ],
    "onInitialize": {
      "events": []
    },
    "extrinsics": [
      {
        "method": {
          "pallet": "timestamp",
          "method": "set"
        },
        "signature": null,
        "nonce": null,
        "args": {
          "now": "1662972972010"
        },
        "tip": null,
        "hash": "0x4f36bcceb834b11c96bdb7b94752fea3fbf4527b3f6d85e3e24f440f83ce962c",
        "info": {},
        "era": {
          "immortalEra": "0x00"
        },
        "events": [
          {
            "method": {
              "pallet": "system",
              "method": "ExtrinsicSuccess"
            },
            "data": [
              {
                "weight": "132273000",
                "class": "Mandatory",
                "paysFee": "Yes"
              }
            ]
          }
        ],
        "success": true,
        "paysFee": false
      },
      {
        "method": {
          "pallet": "paraInherent",
          "method": "enter"
        },
        "signature": null,
        "nonce": null,
        "args": {
          "data": {
            "bitfields": [
              {
                "payload": "0x528cc30400",
                "validatorIndex": "0",
                "signature": "0x5e0d8963a25161d9"
              }
            ],
            "backedCandidates": [
              {
                "candidate": {
                  "descriptor": {
                    "paraId": "1000",
                    "relayParent": "0x74d5187e88a06db0f7998b2550f8a26664f56173d808f3ef76b0820033a54cfe",
                    "collator": "0x5029f1db1c55b13f92256e1fa5e7afc25da5465cb372b7b26538df1e49bb125c",
                    "persistedValidationDataHash": "0xfbf197d09c6394172337fbe8b80d71f6fd78b6b60994ea7861bdfa8cec2f616c",
                    "povHash": "0x0892ca557071243df7a89c1c4eb5bcd0b0e8b562b8eedfb4b43060e4445db414",
                    "erasureRoot": "0xcb2ceb9db294145cf9a0f4e4aa57f4712b799735b0822db2fdc70fa1e5387690",
                    "signature": "0xea9f7f7f37f08ab0c299698dbe903955a2d8c07e33f145d71fd8d65b3d36373dcccd9a832b1109e5e67601be73009755dbb1f650a00b197e96f72eee0b08d98d",
                    "paraHead": "0x53fe014d7fce1709e55e71804fd418b71a5d45cbd9560f81bd06bf6c9618581e",
                    "validationCodeHash": "0xb442577c84d6753a61007c2e802c912a8d2400bd2207df2d923eed701fe00f48"
                  },
                  "commitments": {
                    "upwardMessages": [],
                    "horizontalMessages": [],
                    "newValidationCode": null,
                    "headData": "0x18f84ebe69090dc5ce93cb4206fee857b024d0b3ede814f8644267ac8cd3f39cb2a98000af3eaa2b2f1ad850b548ebcb6ca8e7e07b7a37b0dfa4f2c586176415eacbd44d00a43bd745b5da84f5b5d340441715aadd00487ee53ddfa27f329425a4b6de0708066175726120589442080000000005617572610101f9db332a5b99696adb51972565da7ca374c6d8481d8fb325f3ecea570031b8d076325fa9c0ef81dbb041b38ab8ebf4f541ab89ad1395ad28a473c19017989706",
                    "processedDownwardMessages": "0",
                    "hrmpWatermark": "12014028"
                  }
                },
                "validityVotes": [
                  {
                    "explicit": "0x42e81edc3af5"
                  }
                ],
                "validatorIndices": "0x1f"
              }
            ],
            "disputes": [],
            "parentHeader": {
              "parentHash": "0x435aacdb48ec8535f9da12d6c7cc3e1bba588b181a8148db3f493c3e1966745f",
              "number": "12014028",
              "stateRoot": "0x58f89bee1816c7789cd90dc4b3712628781f6230b0ad741c865f4515694ee571",
              "extrinsicsRoot": "0x066aa3dfd76e99481bb1ff439fcb761bdf667e73027e92b2ff947be5320742c8",
              "digest": {
                "logs": [
                  {
                    "preRuntime": [
                      "0x42414245",
                      "0x0353000000b12882"
                    ]
                  },
                  {
                    "seal": [
                      "0x42414245",
                      "0xf84370ccf77ab0"
                    ]
                  }
                ]
              }
            }
          }
        },
        "tip": null,
        "hash": "0x292f32c853165eda2dfd393312d8ae01e82dbd2e5d5e179a412e54a2db31dd00",
        "info": {},
        "era": {
          "immortalEra": "0x00"
        },
        "events": [
          {
            "method": {
              "pallet": "paraInclusion",
              "method": "CandidateIncluded"
            },
            "data": [
              {
                "descriptor": {
                  "paraId": "2000",
                  "relayParent": "0x435aacdb48ec8535f9da12d6c7cc3e1bba588b181a8148db3f493c3e1966745f",
                  "collator": "0x6ec546cf3f7ce3ea65e8830f82f602b6e609f2164e895c346f0e3f3e15723b57",
                  "persistedValidationDataHash": "0x3e97577847c0657be0f7314d131b8eee0d62c5710d08c79f40ed053e5093669c",
                  "povHash": "0x94fae12502a8f0f7686acfff6d495ae075e063675e661d13d61aa48992c9b6e4",
                  "erasureRoot": "0x91e08dfdadcf2bdd33bcc76809d52274673b0b6facae08ad3db9930c85e6fa53",
                  "signature": "0x303a9058f22e641bcca13e34433743a650e99e4d0424602f589dc01f4afb4e7f1e4f45852efdf34c96f7682842fa416a5d25280edeec22f15d3e29df725bea8c",
                  "paraHead": "0x11a088993f5143344e388ea75e4f47c745fcf9997b801c96cf0703e022a014e6",
                  "validationCodeHash": "0x8cb61a552f8842af75bc65a5749450e2c0abbe640de059f59a45bb8235ba30bf"
                },
                "commitmentsHash": "0x6cc97124f1b34018ecfece1b7a2d89ac0f20dd031aa99257355c05c0ed4317cb"
              },
              "0x9505bdb49b062ccc",
              "1",
              "0"
            ]
          },
          {
            "method": {
              "pallet": "paraInclusion",
              "method": "CandidateIncluded"
            },
            "data": [
              {
                "descriptor": {
                  "paraId": "2006",
                  "relayParent": "0x435aacdb48ec8535f9da12d6c7cc3e1bba588b181a8148db3f493c3e1966745f",
                  "collator": "0x7c3edf31c82d6fef6a0cdd6b1b7e761e978b54df9c7410c2a2f8f1ecabb4514c",
                  "persistedValidationDataHash": "0x8a698c525d9b1034c20a10db0ca999a771289f83df5bab441fe77e4cacdd96c3",
                  "povHash": "0xa436fef2b987d7e8bfaf1c10cdda82265c1d00bb2ce9c8b282f7a91ac7100b10",
                  "erasureRoot": "0x1380399d05b169429893e91dc2f65baa70ed56edde58a8a3b8dbaefa5e584f48",
                  "signature": "0x7ec82758be677cb5f37d69742e71907842f15f8f8abcd4e3cba1ad9f23346312439743b7c5995a5e8a355ead3eeff2c5ad9cab7f84c64637ff58cfdb1c561385",
                  "paraHead": "0x0985e55259350f03e2dae82325db64f1ed1c27fc5519dad116a44f7c0ad4f17d",
                  "validationCodeHash": "0xbcd83143dbfa6c3277b6b3f65f5fd1277ae483f1d7fcaf7c1293acca855c52a3"
                },
                "commitmentsHash": "0x595bd14555408d61fa14bb5727d91069c4a9b485aca22f3288b3822ab98a56dd"
              },
              "0x25a7e386",
              "4",
              "3"
            ]
          }
        ],
        "success": true,
        "paysFee": true
      }
    ],
    "onFinalize": {
      "events": []
    },
    "finalized": true
  }
]
SpecificationView Specification

Parameters

  • range string (required) (query) A range of integers. There is a max limit of 500 blocks per request. Example : 0-499
  • eventDocs boolean (query) When set to true, every event will have an extra docs property with a string of the events documentation. Default value : false
  • extrinsicDocs boolean (query) When set to true, every extrinsic will have an extra docs property with a string of the extrinsics documentation. Default value : false

Response

  • Given a range query parameter return an array of all the blocks within that range.

/blocks/{blockId}

Get a block by its height or hash.

Request Query (try it)
Example Response
[
  {
    "number": "12014029",
    "hash": "0xaa3c192e5791c0cc6eff93068f42d693700e4ff226f28679da100c69ddf415fa",
    "parentHash": "0x74d5187e88a06db0f7998b2550f8a26664f56173d808f3ef76b0820033a54cfe",
    "stateRoot": "0xca9a1f4aca804a9b501ff5d4b1e33073862d75e97f52bbd9191b2979228e3138",
    "extrinsicsRoot": "0xdf57669dd49b13b3a00d608763ebda2973d0ff7514f065fc45b242e44cf3a014",
    "authorId": "13mhUnQ6qwvuuTYoKTtJkmssm3jDCGhTTSsHCXvvRhFooDiF",
    "logs": [
      {
        "type": "PreRuntime",
        "index": "6",
        "value": [
          "0x42414245",
          "0x038e000000b2288510000000001e2761cae48e73e7b79ef5d3a44e8b19a568b20fac090f2653fa71621713a53877fc0ede5bd6e8a78955a4fe09718b2e99ec2f116f27efc22db4eeb564237f0f77643298e58fffb85aa5fff9199315361ea389b692f091b1d746d58de42f5504"
        ]
      },
      {
        "type": "Seal",
        "index": "5",
        "value": [
          "0x42414245",
          "0xec3f0206f4b36e3dc3ff07ae5e923102a47c33bb16c9d579e8015ddd79895171e58720c862532073c175b69975acbd1e8a6c56925a51d99ea21a89baee605b86"
        ]
      }
    ],
    "onInitialize": {
      "events": []
    },
    "extrinsics": [
      {
        "method": {
          "pallet": "timestamp",
          "method": "set"
        },
        "signature": null,
        "nonce": null,
        "args": {
          "now": "1662972972010"
        },
        "tip": null,
        "hash": "0x4f36bcceb834b11c96bdb7b94752fea3fbf4527b3f6d85e3e24f440f83ce962c",
        "info": {},
        "era": {
          "immortalEra": "0x00"
        },
        "events": [
          {
            "method": {
              "pallet": "system",
              "method": "ExtrinsicSuccess"
            },
            "data": [
              {
                "weight": "132273000",
                "class": "Mandatory",
                "paysFee": "Yes"
              }
            ]
          }
        ],
        "success": true,
        "paysFee": false
      },
      {
        "method": {
          "pallet": "paraInherent",
          "method": "enter"
        },
        "signature": null,
        "nonce": null,
        "args": {
          "data": {
            "bitfields": [
              {
                "payload": "0x528cc30400",
                "validatorIndex": "0",
                "signature": "0x5e0d8963a25161d9"
              }
            ],
            "backedCandidates": [
              {
                "candidate": {
                  "descriptor": {
                    "paraId": "1000",
                    "relayParent": "0x74d5187e88a06db0f7998b2550f8a26664f56173d808f3ef76b0820033a54cfe",
                    "collator": "0x5029f1db1c55b13f92256e1fa5e7afc25da5465cb372b7b26538df1e49bb125c",
                    "persistedValidationDataHash": "0xfbf197d09c6394172337fbe8b80d71f6fd78b6b60994ea7861bdfa8cec2f616c",
                    "povHash": "0x0892ca557071243df7a89c1c4eb5bcd0b0e8b562b8eedfb4b43060e4445db414",
                    "erasureRoot": "0xcb2ceb9db294145cf9a0f4e4aa57f4712b799735b0822db2fdc70fa1e5387690",
                    "signature": "0xea9f7f7f37f08ab0c299698dbe903955a2d8c07e33f145d71fd8d65b3d36373dcccd9a832b1109e5e67601be73009755dbb1f650a00b197e96f72eee0b08d98d",
                    "paraHead": "0x53fe014d7fce1709e55e71804fd418b71a5d45cbd9560f81bd06bf6c9618581e",
                    "validationCodeHash": "0xb442577c84d6753a61007c2e802c912a8d2400bd2207df2d923eed701fe00f48"
                  },
                  "commitments": {
                    "upwardMessages": [],
                    "horizontalMessages": [],
                    "newValidationCode": null,
                    "headData": "0x18f84ebe69090dc5ce93cb4206fee857b024d0b3ede814f8644267ac8cd3f39cb2a98000af3eaa2b2f1ad850b548ebcb6ca8e7e07b7a37b0dfa4f2c586176415eacbd44d00a43bd745b5da84f5b5d340441715aadd00487ee53ddfa27f329425a4b6de0708066175726120589442080000000005617572610101f9db332a5b99696adb51972565da7ca374c6d8481d8fb325f3ecea570031b8d076325fa9c0ef81dbb041b38ab8ebf4f541ab89ad1395ad28a473c19017989706",
                    "processedDownwardMessages": "0",
                    "hrmpWatermark": "12014028"
                  }
                },
                "validityVotes": [
                  {
                    "explicit": "0x42e81edc3af5"
                  }
                ],
                "validatorIndices": "0x1f"
              }
            ],
            "disputes": [],
            "parentHeader": {
              "parentHash": "0x435aacdb48ec8535f9da12d6c7cc3e1bba588b181a8148db3f493c3e1966745f",
              "number": "12014028",
              "stateRoot": "0x58f89bee1816c7789cd90dc4b3712628781f6230b0ad741c865f4515694ee571",
              "extrinsicsRoot": "0x066aa3dfd76e99481bb1ff439fcb761bdf667e73027e92b2ff947be5320742c8",
              "digest": {
                "logs": [
                  {
                    "preRuntime": [
                      "0x42414245",
                      "0x0353000000b12882"
                    ]
                  },
                  {
                    "seal": [
                      "0x42414245",
                      "0xf84370ccf77ab0"
                    ]
                  }
                ]
              }
            }
          }
        },
        "tip": null,
        "hash": "0x292f32c853165eda2dfd393312d8ae01e82dbd2e5d5e179a412e54a2db31dd00",
        "info": {},
        "era": {
          "immortalEra": "0x00"
        },
        "events": [
          {
            "method": {
              "pallet": "paraInclusion",
              "method": "CandidateIncluded"
            },
            "data": [
              {
                "descriptor": {
                  "paraId": "2000",
                  "relayParent": "0x435aacdb48ec8535f9da12d6c7cc3e1bba588b181a8148db3f493c3e1966745f",
                  "collator": "0x6ec546cf3f7ce3ea65e8830f82f602b6e609f2164e895c346f0e3f3e15723b57",
                  "persistedValidationDataHash": "0x3e97577847c0657be0f7314d131b8eee0d62c5710d08c79f40ed053e5093669c",
                  "povHash": "0x94fae12502a8f0f7686acfff6d495ae075e063675e661d13d61aa48992c9b6e4",
                  "erasureRoot": "0x91e08dfdadcf2bdd33bcc76809d52274673b0b6facae08ad3db9930c85e6fa53",
                  "signature": "0x303a9058f22e641bcca13e34433743a650e99e4d0424602f589dc01f4afb4e7f1e4f45852efdf34c96f7682842fa416a5d25280edeec22f15d3e29df725bea8c",
                  "paraHead": "0x11a088993f5143344e388ea75e4f47c745fcf9997b801c96cf0703e022a014e6",
                  "validationCodeHash": "0x8cb61a552f8842af75bc65a5749450e2c0abbe640de059f59a45bb8235ba30bf"
                },
                "commitmentsHash": "0x6cc97124f1b34018ecfece1b7a2d89ac0f20dd031aa99257355c05c0ed4317cb"
              },
              "0x9505bdb49b062ccc",
              "1",
              "0"
            ]
          },
          {
            "method": {
              "pallet": "paraInclusion",
              "method": "CandidateIncluded"
            },
            "data": [
              {
                "descriptor": {
                  "paraId": "2006",
                  "relayParent": "0x435aacdb48ec8535f9da12d6c7cc3e1bba588b181a8148db3f493c3e1966745f",
                  "collator": "0x7c3edf31c82d6fef6a0cdd6b1b7e761e978b54df9c7410c2a2f8f1ecabb4514c",
                  "persistedValidationDataHash": "0x8a698c525d9b1034c20a10db0ca999a771289f83df5bab441fe77e4cacdd96c3",
                  "povHash": "0xa436fef2b987d7e8bfaf1c10cdda82265c1d00bb2ce9c8b282f7a91ac7100b10",
                  "erasureRoot": "0x1380399d05b169429893e91dc2f65baa70ed56edde58a8a3b8dbaefa5e584f48",
                  "signature": "0x7ec82758be677cb5f37d69742e71907842f15f8f8abcd4e3cba1ad9f23346312439743b7c5995a5e8a355ead3eeff2c5ad9cab7f84c64637ff58cfdb1c561385",
                  "paraHead": "0x0985e55259350f03e2dae82325db64f1ed1c27fc5519dad116a44f7c0ad4f17d",
                  "validationCodeHash": "0xbcd83143dbfa6c3277b6b3f65f5fd1277ae483f1d7fcaf7c1293acca855c52a3"
                },
                "commitmentsHash": "0x595bd14555408d61fa14bb5727d91069c4a9b485aca22f3288b3822ab98a56dd"
              },
              "0x25a7e386",
              "4",
              "3"
            ]
          }
        ],
        "success": true,
        "paysFee": true
      }
    ],
    "onFinalize": {
      "events": []
    },
    "finalized": true
  }
]
SpecificationView Specification

Parameters

  • blockId string (required) (path) Block identifier, as the block height or block hash.
  • eventDocs boolean (query) When set to true, every event will have an extra docs property with a string of the events documentation. Default value : false
  • extrinsicDocs boolean (query) When set to true, every extrinsic will have an extra docs property with a string of the extrinsics documentation. Default value : false

Response

  • Returns a single block. BlockId can either be a block hash or a block height. Replaces /block/{number} from versions < v1.0.0.

/blocks/{blockId}/header

Get a block's header by its height or hash. BlockId can either be a block hash or a block height.

Request Query (try it)
Example Response
{
  "parentHash": "0xaa3c192e5791c0cc6eff93068f42d693700e4ff226f28679da100c69ddf415fa",
  "number": "12014030",
  "stateRoot": "0xa603231af4baf330d3d6832517026a6be4005358e864929db4fbe0eace8e6f14",
  "extrinsicsRoot": "0xb9684415d89ca9a6b3dfaf16e33b0708d5d0dbf039b1b1c2a7f570a3d8756a6a",
  "digest": {
    "logs": [
      {
        "preRuntime": [
          "0x42414245",
          "0x03bb000000b328851000000000760ef053b768ff6a57dab8e6e0db264e26763a60f017e52998c29ae9fdc0293722d907ee7aba7b8613eee78d3e4001f08c118b2db7c2337cd6f3843642ff020e033ddad9f9690904c714b7f1e54f71ab013ed43f80e804d9650f2fe7f8195107"
        ]
      },
      {
        "seal": [
          "0x42414245",
          "0x0453664d4e9b7d8c108e0768dcd8abd101f1870d1c6dcb622dd24e9c5b463936af8e15b6a318b5cd51f213d88e16e12eaf48acc0d6b22257a0c208f5d1c62884"
        ]
      }
    ]
  }
}
SpecificationView Specification

Parameters

  • blockId string (required) (path) Block identifier, as the block height or block hash.

Response

  • Returns a single block's header.

/blocks/{blockId}/extrinsics/{extinsicIndex}

Get an extrinsic by its extrinsicIndex and block height or hash. The pair blockID and extrinsicIndex are sometimes referred to as a timepoint.

Request Query (try it)
Example Response
{
  "at": {
    "height": "12014030",
    "hash": "0xef66b7e13334b37ac1ecd30e418f898a001b70ba3620029185e269bb10abdb41"
  },
  "extrinsics": {
    "method": {
      "pallet": "timestamp",
      "method": "set"
    },
    "signature": null,
    "nonce": null,
    "args": {
      "now": "1662972978008"
    },
    "tip": null,
    "hash": "0xfbaa8d47f13cf4839e6de972e5f953672d495639b4891b0845de06c08607e3ab",
    "info": {},
    "era": {
      "immortalEra": "0x00"
    },
    "events": [
      {
        "method": {
          "pallet": "system",
          "method": "ExtrinsicSuccess"
        },
        "data": [
          {
            "weight": "132273000",
            "class": "Mandatory",
            "paysFee": "Yes"
          }
        ]
      }
    ],
    "success": true,
    "paysFee": false
  }
}
SpecificationView Specification

Parameters

  • blockId string (required) (path) Block identifier, as the block height or block hash.
  • extrinsicIndex string (required) (path) The extrinsic's index within the block's body.
  • eventDocs boolean (query) When set to true, every event will have an extra docs property with a string of the events documentation. Default value : false
  • extrinsicDocs boolean (query) When set to true, every extrinsic will have an extra docs property with a string of the extrinsics documentation. Default value : false

Response

  • Returns a single extrinsic.

/blocks/head

Get the most recently finalized block.

Request Query (try it)
Example Response
{
  "number": "12014332",
  "hash": "0xaca8451fdab1d509387a0bb50f845a4495581fa900e65f9c522f8c31bb59250d",
  "parentHash": "0x62f96545e4f098068f18c7cf24f74e4301586d6d7d32fe1ed7c0dbd1464c6eb7",
  "stateRoot": "0x3cfa4baf519354411edffa18f9217bfbbd63eb38b3f2bb8b7425682db34161b6",
  "extrinsicsRoot": "0x1a4610de222685772258fd10f2899e89f303465f3e014aaee4a19c477a34b9d9",
  "authorId": "14Fqi7dFQfRtQRrtBW7BL5m9E1fbTp3dvAnW19AUqEKhWCFd",
  "logs": [
    {
      "type": "PreRuntime",
      "index": "6",
      "value": [
        "0x42414245",
        "0x03b2000000e1298510000000009c3d1f63e072526093f3b9412f10c5fbb699dea1652ba6349b5d7e4e53e0ee13169c6596345cdff78e40ca514250201081ca4bcbd37fcca75925fd2fd679f008720c670838abe1599ba03d7a0487b0ed1882f802cb4fe2140dff8c5289ad9d0c"
      ]
    },
    {
      "type": "Seal",
      "index": "5",
      "value": [
        "0x42414245",
        "0x7c09cbd8a8ed89af5fd1c1072893afc30f5e942412841972862e6f3dbf0902604193d80e215bcc2b100de3b030e87663e5421b000c5576c6d468bae9a14f7a8e"
      ]
    }
  ],
  "onInitialize": {
    "events": []
  },
  "extrinsics": [
    {
      "method": {
        "pallet": "timestamp",
        "method": "set"
      },
      "signature": null,
      "nonce": null,
      "args": {
        "now": "1662974790011"
      },
      "tip": null,
      "hash": "0x3925d41d5915d57653faee43e479115f986a7aaf2e070b5280a8ca3d4a4eded4",
      "info": {},
      "era": {
        "immortalEra": "0x00"
      },
      "events": [
        {
          "method": {
            "pallet": "system",
            "method": "ExtrinsicSuccess"
          },
          "data": [
            {
              "weight": "132273000",
              "class": "Mandatory",
              "paysFee": "Yes"
            }
          ]
        }
      ],
      "success": true,
      "paysFee": false
    },
    {
      "method": {
        "pallet": "paraInherent",
        "method": "enter"
      },
      "signature": null,
      "nonce": null,
      "args": {
        "data": {
          "bitfields": [
            {
              "payload": "0x90637e0000",
              "validatorIndex": "0",
              "signature": "0x723e95033e34ce3f42888909d5a462d885b70e7dd9f747708a082e1925638a76f121cdb2786046d29ec71e0e07a837e0f910103afdfbe61f81491dda6d9cf88f"
            }
          ],
          "backedCandidates": [
            {
              "candidate": {
                "descriptor": {
                  "paraId": "1000",
                  "relayParent": "0x62f96545e4f098068f18c7cf24f74e4301586d6d7d32fe1ed7c0dbd1464c6eb7",
                  "collator": "0x5029f1db1c55b13f92256e1fa5e7afc25da5465cb372b7b26538df1e49bb125c",
                  "persistedValidationDataHash": "0x0ee0208584b09973b5bd7d0e77498eed4f1dcb1be0c3273648998cff037d6911",
                  "povHash": "0xda5660a89ce3686612b48840f763b0fd344f7e14684a662a82f402c9d1178ca3",
                  "erasureRoot": "0xd8b9cc9cc7d753e5bc0258ac44934ad9687e5c43f9277a9e318d553613fd0e18",
                  "signature": "0x1ecffd9297fa15a08213acb843a5bed08375a31215c78c1dc5827cc363eb7b676b9bb519cfcb47e3f473ae48506e40e10696ed0fe6563a1770e90f81b0843b82",
                  "paraHead": "0xff42387bf5e0736cca8f8a689384904f27a5c72cb39cc9f67379f730b5320c05",
                  "validationCodeHash": "0xb442577c84d6753a61007c2e802c912a8d2400bd2207df2d923eed701fe00f48"
                },
                "commitments": {
                  "upwardMessages": [],
                  "horizontalMessages": [],
                  "newValidationCode": null,
                  "headData": "0x54ede546a32bd4554f41e499cfc85bf1709d807ddd86c6ef696361c61a74c5e802ac8000f75d77dc429a15339cda537e997629fb7c18fdc4c0fb514d767201fde4d8c5a6cfbfc59995b3f79b77f608ddccc3bf8e61d2abde1f4c3036d7c999d4124a42ff08066175726120f09442080000000005617572610101bb55ad725291083c7f5e44debf33265b4960ee17fabde5d3338edc020597ecccec7b1918faf7caa75db725a76539080a10f9fc94aa7e3e275da8ea79c7bbd205",
                  "processedDownwardMessages": "0",
                  "hrmpWatermark": "12014331"
                }
              },
              "validityVotes": [
                {
                  "explicit": "0xda203d2fd4fed8c1d7a280ec4b60a86c39b06b81ee203703b7084f212a4cec51d7df7b065922837b7adcf2f351dcb84e54611d3f1649e875a8eea765af8e5489"
                },
                {
                  "explicit": "0x96e7feced5c8493290e17a1fb798e03243b9b6ebec2b5a930eb112258bf72d4eed973d58ce60b79fdf0663b16f3f217577d1a269d07055ef7de2a1f2edb1f48f"
                },
                {
                  "implicit": "0x4c9a6c0663dbe4c914feb17473230715f0c3bade7684cd3c14a40606b2152524c8ac0f735c5cf33deb3a247c7685665d95f1887604f8aa480774dd80ee8ea580"
                },
                {
                  "explicit": "0xfc0d94e461f0bcf8e748220ad7aaf93b9c85df9e03431321b64d92010a184d6eabce6c22c2d02d493c91db0002fce02289ce9b73d14c34addd0b6e389c737682"
                },
                {
                  "explicit": "0x2afe1598cdb4b481be452df050acb594aea8ec6944bce1f8f84413075ca5946a607f896aa09feb80fd56766f94cb81368919c54320738ee7f9c9f846c70c2c80"
                }
              ],
              "validatorIndices": "0x1f"
            }
          ],
          "disputes": [],
          "parentHeader": {
            "parentHash": "0xb66dfa33dcce6156facdf25708796fb7ba68d7799df9a7b82e0818bb2e464e8c",
            "number": "12014331",
            "stateRoot": "0x23591573cc10ac588b36e287f95c223c0948f30365d2d59188b6976aad086fe4",
            "extrinsicsRoot": "0x309b3157e724e1d99f9ea20f5454ec4d1f3badde9dfd72f458a6abd34efd74e8",
            "digest": {
              "logs": [
                {
                  "preRuntime": [
                    "0x42414245",
                    "0x03c8000000e029851"
                  ]
                },
                {
                  "seal": [
                    "0x42414245",
                    "0xa0c4d8a8052ce451f8ca815e7109b0ac8116d5af0f06809098dcd170288cf828b8af879062d6002b631d0d3e917994fb06217e70fd3cd29f67d6055bff85cc82"
                  ]
                }
              ]
            }
          }
        }
      },
      "tip": null,
      "hash": "0x08d6bbbe08371a143af4dc95bb447b00d4bfbb44fdc22e020f4de066c84ef7e3",
      "info": {},
      "era": {
        "immortalEra": "0x00"
      },
      "events": [
        {
          "method": {
            "pallet": "paraInclusion",
            "method": "CandidateIncluded"
          },
          "data": [
            {
              "descriptor": {
                "paraId": "2006",
                "relayParent": "0xb66dfa33dcce6156facdf25708796fb7ba68d7799df9a7b82e0818bb2e464e8c",
                "collator": "0x0c8c34d3dba95faea176615e7b573b57ed743ff7d65e43d359072410bacf7735",
                "persistedValidationDataHash": "0xd245ee7adeee37bf311370011bdde9d0d52f88f5962693807af56d5ee04a54be",
                "povHash": "0x5e7278132c32fc0a7a4f4af1cf44b65b4d00ed61d59a00ead448a13d29338ccf",
                "erasureRoot": "0x23f0ba7a6e43ff1ab70a99ff82c5661e1f9732d3f113c15ffebd48f63bed5617",
                "signature": "0x0ea9591b5dff8a9ad8e2b187cbb36d3f65351597f74cd1012fab2fe6fcbadf4dae6941dcfdfedcef2a3002d410fbb065cfcf6485a2d7d9da75539e903b83a487",
                "paraHead": "0x01b0cdbaa0a4ed6a7854d1e94b15fc218797b3677f14a11d8d40434505eed473",
                "validationCodeHash": "0xbcd83143dbfa6c3277b6b3f65f5fd1277ae483f1d7fcaf7c1293acca855c52a3"
              },
              "commitmentsHash": "0x010e916850de68b5c9bd51d5ad201c9b81df960d490e8b07eaacf5b018063836"
            },
            "0x0fbaffaedb01c3",
            "4",
            "34"
          ]
        },
        {
          "method": {
            "pallet": "paraInclusion",
            "method": "CandidateIncluded"
          },
          "data": [
            {
              "descriptor": {
                "paraId": "2012",
                "relayParent": "0xb66dfa33dcce6156facdf25708796fb7ba68d7799df9a7b82e0818bb2e464e8c",
                "collator": "0x7e48f69af3aff0cb187e64ff6a332776152c24736f794d531a85396c6e586506",
                "persistedValidationDataHash": "0x15c48d9248594262f329efc65c5c9b93e5e31fb5fbbb5a78fbf34802054221c3",
                "povHash": "0x7a7f928e5dd6d0a6a66963d84ac86497add88539152727cdcaf238aae4f30489",
                "erasureRoot": "0xf2e588ccefded91ed08e7a653a192399fb7c7e944966429596733abf88fbd017",
                "signature": "0x6cd8f717794caf0abde93ca13a32fbb5d57887a596def1501f023fa9e2ea5243643b7c4cd97fd0409fe9122d461dfbf4f149d051a8cf8d5d94cc4ce7df5d7f82",
                "paraHead": "0xd261b9a968fede1c3fd7079ef64c1edd9513ea53772b0544e9db320a990511c1",
                "validationCodeHash": "0x66452129fc8bae1383432b0886af5a4ddc8dc1f8ccff8e0285fba492dee8178f"
              },
              "commitmentsHash": "0x8886cb7de7110e2412cf3a6dae8d273fadce70200e73c08442120ae42c5fa5c9"
            },
            "0xf106477e0d38",
            "7",
            "37"
          ]
        }
      ],
      "success": true,
      "paysFee": false
    }
  ],
  "onFinalize": {
    "events": []
  },
  "finalized": true
}
SpecificationView Specification

Parameters

  • finalized boolean (query) Boolean representing whether or not to get the finalized head. If it is not set the value defaults to true. When set to false it will attempt to get the newest known block, which may not be finalized. Default value : true
  • eventDocs boolean (query) When set to true, every event will have an extra docs property with a string of the events documentation. Default value : false
  • extrinsicDocs boolean (query) When set to true, every extrinsic will have an extra docs property with a string of the extrinsics documentation. Default value : false

Response

  • Returns the most recently finalized block. Replaces /block from versions < v1.0.0.

/blocks/head/header

Get information about the header of the most recently finalized block.

Request Query (try it)
Example Response
{
  "parentHash": "0x7446d8b13acc8884585faf7b6a166bcd82f9e2cae1b980691e69921f96325b05",
  "number": "12014380",
  "stateRoot": "0x2fad87582fc5302bac92d2df7c263493e89b1af1379504a2604d4a79595c2228",
  "extrinsicsRoot": "0x8d4a57c662e1bb81513164355280650184ba746fb00a5bb43eb567b83d272d0f",
  "digest": {
    "logs": [
      {
        "preRuntime": [
          "0x42414245",
          "0x03ff000000112a85100000000008f790b42e7a8a8a866bb97447edfec5b9a06522cfcac3a3af344d931fb6a42357f432f8afc7b82416b1a71b3e7738bc3dec498afa7403e4451276fcce1c450a512bd16fd09f7bc4f6c8d32ed7cf30b5a7e648fd24394b761d6ac2e2f382160b"
        ]
      },
      {
        "seal": [
          "0x42414245",
          "0xf43c3dcbba6eb009e5ffd00b7d6e924611c29663ffab66136f98a243c661534889b9b44ea8eb8549e5e7443d48ce9772da7dd623d98ee6e23a3c7a8d6abcf383"
        ]
      }
    ]
  }
}
SpecificationView Specification

Parameters

  • finalized boolean (query) Boolean representing whether or not to get the finalized head. If it is not set the value defaults to true. When set to false it will attempt to get the newest known block, which may not be finalized. Default value : true

Response

  • Returns the most recently finalized block's header.

/node/network

Get information about the Substrate node's activity in the peer-to-peer network.

Request Query (try it)
Example Response
{
  "nodeRoles": [
    {
      "full": null
    }
  ],
  "numPeers": "50",
  "isSyncing": false,
  "shouldHavePeers": true,
  "localPeerId": "12D3KooWPP13UQfPHda9rCWfTtBJeoNoa5sbMTR6MuVZHBkENtcG",
  "localListenAddresses": [
    "/ip6/::1/tcp/30333/ws/p2p/12D3KooWPP13UQfPHda9rCWfTtBJeoNoa5sbMTR6MuVZHBkENtcG",
    "/ip6/fe80::ccac:93ff:fe91:33b1/tcp/30333/ws/p2p/12D3KooWPP13UQfPHda9rCWfTtBJeoNoa5sbMTR6MuVZHBkENtcG",
    "/ip6/fe80::3883:b0ff:fe3c:e808/tcp/30333/ws/p2p/12D3KooWPP13UQfPHda9rCWfTtBJeoNoa5sbMTR6MuVZHBkENtcG",
    "/ip4/127.0.0.1/tcp/30333/ws/p2p/12D3KooWPP13UQfPHda9rCWfTtBJeoNoa5sbMTR6MuVZHBkENtcG",
    "/ip4/134.122.36.228/tcp/30333/ws/p2p/12D3KooWPP13UQfPHda9rCWfTtBJeoNoa5sbMTR6MuVZHBkENtcG",
    "/ip4/10.20.0.103/tcp/30333/ws/p2p/12D3KooWPP13UQfPHda9rCWfTtBJeoNoa5sbMTR6MuVZHBkENtcG",
    "/ip4/10.118.16.5/tcp/30333/ws/p2p/12D3KooWPP13UQfPHda9rCWfTtBJeoNoa5sbMTR6MuVZHBkENtcG"
  ],
  "peersInfo": "Cannot query system_peers from node."
}
SpecificationView Specification

Parameters

  • None

Response

  • Returns network related information of the node.

/node/transaction-pool

Get pending extrinsics from the substrate node.

Request Query (try it)
Example Response
{
  "pool": [
    {
      "hash": "0x1b64b7acbbaecfe07f22f91c725865cca310030c4294f0d313b1589f5aa44291",
      "encodedExtrinsic": "0xb10384002534454d30f8a028e42654d6b535e0651d1d026ddf115cef59ae1dd71bae074e00fec4c289d694850bc13fcd4d766b596f3807af0054e595c9658a0812a9894cfad354ef3062ff5afeed411d01b8fec6aff6209c128223b500912d8d4e30eec300250296dd0900001a020c0500002468d07059d57a6761537424881429e6f5a111bb01aee6920561bd29b398223d0b84c75f60800505000097d48b286732f6420764060d2721ca7501f4487905cdb98d111412258633dd160f00966fde7ec801050000c6108d0078208af637875d303dd4464df461812d3ddbacc64d4319a4f25c138a0b003c01b58b0e"
    }
  ]
}
SpecificationView Specification

Parameters

  • includeFee boolean (query) Boolean representing whether or not to include tips, partialFee, and priority in each extrinsic. Default value : false

Response

  • Returns the extrinsics that the node knows of that have not been included in a block.

/node/version

Get information about the Substrate node's implementation and versioning.

Request Query (try it)
Example Response
{
  "clientVersion": "0.9.28-314298c32ac",
  "clientImplName": "parity-polkadot",
  "chain": "Polkadot"
}
SpecificationView Specification

Parameters

  • None

Response

  • Returns versioning information of the node.

/pallets/staking/progress

Get progress on the general Staking pallet system.

Request Query (try it)
Example Response
{
  "at": {
    "hash": "0xb0e10640c3f88dcbe6bc84d93d2e820246540b349e586ac3733a87df5ee2ac89",
    "height": "12016665"
  },
  "activeEra": "832",
  "forceEra": "NotForcing",
  "nextSessionEstimate": "12018026",
  "unappliedSlashes": [],
  "nextActiveEraEstimate": "12018026",
  "electionStatus": "Deprecated, see docs",
  "idealValidatorCount": "297",
  "validatorSet": [
    "111B8CxcmnWbuDLyGvgUmRezDCK1brRZmvUuQ6SrFdMyc3S",
    "16mM7YxjyYqXu7uaJfmfCk9xcr8qqaYUyLazTBt3bueQJAFR"
  ]
}
SpecificationView Specification

Parameters

  • at string($unsignedInteger or $hex) (query) Block at which to retrieve a staking progress report.

Response

  • Returns information on the progress of key components of the staking system and estimates of future points of interest.

/pallets/{palletId}/storage

Get a list of storage items for a pallet.

Request Query (try it)
Example Response
{
  "at": {
    "hash": "0x553ce65c2250320a1cfff92eb8a11204c0cd59e7ac22504dd21d853f0568a60f",
    "height": "12025820"
  },
  "pallet": "balances",
  "palletIndex": "5",
  "items": [
    {
      "name": "TotalIssuance",
      "modifier": "Default",
      "type": {
        "plain": "6"
      },
      "fallback": "0x00000000000000000000000000000000",
      "docs": " The total units issued in the system."
    }
  ]
}
SpecificationView Specification

Parameters

  • palletId string (required) (path) Name or index of the pallet to query the storage of. Note: the pallet name must match what is specified in the runtime metadata.
  • adjustMetadataV13 boolean (query) Instruct sidecar to return StorageEntryType in the V13 metadata format rather than V14. This is a temporary flag to allow existing systems to migrate. It will be deprecated and then removed in the future.
  • onlyIds boolean (query) Only return the names (IDs) of the storage items instead of all of each storage item's metadata.
  • at string($unsignedInteger or $hex) (query) Block at which to retrieve a list of the pallet's storage items.

Response

  • Returns a list of storage item metadata for storage items of the specified palletId.

/pallets/{palletId}/storage/{storageItemId}

Get the value of a storage item. If it is a map, query param key1 is required. If the storage item is double map query params key1 and key2 are required.

Request Query (try it)
Example Response
{
  "at": {
    "hash": "0x24b6312726d4d7ddc41a45f6ca25015ec43535d379ed977b242174d2403652da",
    "height": "12025817"
  },
  "pallet": "balances",
  "palletIndex": "5",
  "storageItem": "totalIssuance",
  "value": "12318830209621402437"
}
SpecificationView Specification

Parameters

  • palletId string (required) (path) Name or index of the pallet to query the storage of. Note: the pallet name must match what is specified in the runtime metadata.
  • storageItemId string (required) (path) Id of the storage item to query for.
  • adjustMetadataV13 boolean (query) Instruct sidecar to return StorageEntryType in the V13 metadata format rather than V14. This is a temporary flag to allow existing systems to migrate. It will be deprecated and then removed in the future.
  • key1 string (query) Key for a map, or first key for a double map. Required for querying a map.
  • key2 string (query) Second key for a double map. Required for querying a double map.
  • at string($unsignedInteger or $hex) (query) Block at which to query the storage item at.
  • metadata boolean (query) Include the storage items metadata (including documentation) if set to true. Default value : false

Response

  • Returns the value stored under the storageItemId.

/runtime/metadata

Get the runtime metadata in decoded, JSON form.

Request Query (try it)
Example Response
{
  "magicNumber": "1635018093",
  "metadata": {
    "v14": {
      "lookup": {
        "types": [
          {
            "id": "0",
            "type": {
              "path": [
                "sp_core",
                "crypto",
                "AccountId32"
              ],
              "params": [],
              "def": {
                "composite": {
                  "fields": [
                    {
                      "name": null,
                      "type": "1",
                      "typeName": "[u8; 32]",
                      "docs": []
                    }
                  ]
                }
              },
              "docs": []
            }
          },
          {
            "id": "1",
            "type": {
              "path": [],
              "params": [],
              "def": {
                "array": {
                  "len": "32",
                  "type": "2"
                }
              },
              "docs": []
            }
          }
        ]
      }
    }
  }
}
SpecificationView Specification

Parameters

  • at string($unsignedInteger or $hex) (query) Block at which to retrieve the metadata at.

Response

  • Returns the runtime metadata as a JSON object. Substrate Reference: - FRAME Support: https://crates.parity.io/frame_support/metadata/index.html - Knowledge Base: https://substrate.dev/docs/en/knowledgebase/runtime/metadata

/runtime/code

Get the runtime wasm blob.

Request Query (try it)
Example Response
{
  "at": {
    "hash": "0x405352f172017647d653f86a340764d35d88215aee5a417226357f49a88db854",
    "height": "12015240"
  },
  "code": "0x52bc537646db8......"
}
SpecificationView Specification

Parameters

  • at string($unsignedInteger or $hex) (query) Block at which to retrieve the runtime wasm blob at.

Response

  • Returns the runtime Wasm blob in hex format.

/runtime/spec

Get the version information of the substrate runtime.

Request Query (try it)
Example Response
{
  "at": {
    "height": "12015284",
    "hash": "0x591d10ea75a644abb9baf90ebfea1b6a31844b2da8e7b594c5c0a58635af8d3a"
  },
  "authoringVersion": "0",
  "transactionVersion": "13",
  "implVersion": "0",
  "specName": "polkadot",
  "specVersion": "9270",
  "chainType": {
    "live": null
  },
  "properties": {
    "ss58Format": "0",
    "tokenDecimals": [
      "10"
    ],
    "tokenSymbol": [
      "DOT"
    ]
  }
}
SpecificationView Specification

Parameters

  • at string($unsignedInteger or $hex) (query) Block at which to retrieve runtime version information at.

Response

  • Returns version information related to the runtime.

/transaction

Submit a transaction to the node's transaction pool.

Request Body (try it)
Example Response
{
  "hash": "string"
}
SpecificationView Specification

Parameters

  • tx (string) as JSON body parameters.

Response

  • Accepts a valid signed extrinsic and returns the hash of the successfully submitted transaction.

/transaction/dry-run

Use the dryrun call to practice the submission of a transaction.

Request Body (try it)
Example Response
{
  "resultType": "DispatchOutcome",
  "result": "Ok",
  "validityErrorType": "InvalidTransaction"
}
SpecificationView Specification

Parameters

  • tx (string) as JSON body parameters.

Response

  • Returns resultType. result and alidityErrorType.

/transaction/fee-estimate

Send a serialized transaction and receive back a naive fee estimate. Note: partialFee does not include any tips that you may add to increase a transaction's priority. See the reference on compute_fee. Replaces /tx/fee-estimate from versions < v1.0.0. Substrate Reference: - RuntimeDispatchInfo: https://crates.parity.io/pallet_transaction_payment_rpc_runtime_api/struct.RuntimeDispatchInfo.html - query_info: https://crates.parity.io/pallet_transaction_payment/struct.Module.html#method.query_info - compute_fee: https://crates.parity.io/pallet_transaction_payment/struct.Module.html#method.compute_fee

Request Body (try it)
Example Response
{
  "weight": "string",
  "class": "Normal",
  "partialFee": "string"
}
SpecificationView Specification

Parameters

  • tx (string) as JSON body parameter.

Response

  • Returns the fee estimation for the submitted transaction which includes weight, class and partialFee.

/transaction/material

Get all the network information needed to construct a transaction offline.

Request Query (try it)
Example Response
{
  "at": {
    "hash": "0x60a65fd2799c2c2c1d4ef08bd8206ceee7f697fc9e2aa0a66f0d91f6a17de5fb",
    "height": "12015435"
  },
  "genesisHash": "0x91b171bb158e2d3848fa23a9f1c25182fb8e20313b2c1eb49219da7a70ce90c3",
  "chainName": "Polkadot",
  "specName": "polkadot",
  "specVersion": "9270",
  "txVersion": "13",
  "metadata": "0x6d65746"
}
SpecificationView Specification

Parameters

  • at string($unsignedInteger or $hex) (query) Block at which to retrieve the transaction construction material.
  • noMeta boolean (query) Default value : false
  • false metadata string (query)

Response

  • Returns the material that is universal to constructing any signed transaction offline.

/paras

List all registered paras (parathreads and parachains).

Request Query (try it)
Example Response
{
  "at": {
    "hash": "0xe5621ef2956d7f1602474625198c5637f8551340299a156484b3f1a61645714d",
    "height": "12015469"
  },
  "paras": [
    {
      "paraId": "2028",
      "paraLifecycle": "Parathread"
    }
  ]
}
SpecificationView Specification

Parameters

  • at string($unsignedInteger or $hex) (query) Block at which to retrieve paras list at.

Response

  • Returns all registered parachains and parathreads with lifecycle info.

/paras/leases/current

Get general information about the current lease period.

Request Query (try it)
Example Response
{
  "at": {
    "hash": "0x9bf3c4402b6c2df520230044c2f785fdaa0f6dd523f09ca45a0e3d359b5502c8",
    "height": "12015870"
  },
  "leasePeriodIndex": "9",
  "endOfLeasePeriod": "13017600"
}
SpecificationView Specification

Parameters

  • at string($unsignedInteger or $hex) (query) Block at which to retrieve current lease period info at.
  • currentLeaseHolders boolean (query) Wether or not to include the currentLeaseHolders property. Inclusion of the property will likely result in a larger payload and increased response time. Default value : true

Response

  • Returns an overview of the current lease period, including lease holders.

/paras/auctions/current

Get the status of the current auction.

Request Query (try it)
Example Response
{
  "at": {
    "hash": "0x9f25b92233db1635a34c63eb43a5d63b7bf673e99decd41dd2a8ccd5b15ce8e5",
    "height": "12015878"
  },
  "beginEnd": "12019000",
  "finishEnd": "12091000",
  "phase": "startPeriod",
  "auctionIndex": "27",
  "leasePeriods": [
    "9",
    "10",
    "11",
    "12",
    "13",
    "14",
    "15",
    "16"
  ],
  "winning": null
}
SpecificationView Specification

Parameters

  • at string($unsignedInteger or $hex) (query) Block at which to retrieve auction progress at.

Response

  • Returns an overview of the current auction. There is only one auction at a time. If there is no auction most fields will be null. If the current auction phase is in vrfDelay and you are looking to retrieve the latest winning bids, it is advised to query one block before finishEnd in the endingPeriod phase for that auction as there technically are no winners during the vrfDelay and thus the field is null.

/paras/crowdloans

List all stored crowdloans.

Request Query (try it)
Example Response
{
  "at": {
    "hash": "0x23027e169af2c144eab03eca3201737ebcbec16c452da9c05f24f5fe14c86721",
    "height": "12015918"
  },
  "funds": [
    {
      "paraId": "2040",
      "fundInfo": {
        "depositor": "12jYuVktdKEC6C4g4d5fuW9MLgUDbxvJRhMBkhEGyqarUzbQ",
        "verifier": null,
        "deposit": "5000000000000",
        "raised": "9733236135609673",
        "end": "10881400",
        "cap": "10000000000000000",
        "lastContribution": {
          "ending": "10190174"
        },
        "firstPeriod": "8",
        "lastPeriod": "15",
        "fundIndex": "36"
      }
    }
  ]
}
SpecificationView Specification

Parameters

  • at string($unsignedInteger or $hex) (query) Block at which to retrieve the list of paraIds that have crowdloans at.

Response

  • Returns a list of all the crowdloans and their associated paraIds.

/paras/{paraId}/crowdloan-info

Get crowdloan information for a paraId.

Request Query (try it)
Example Response
{
  "at": {
    "hash": "0x58f88f21c058996e53d9976983b5cc69d4750b117f6d685d85808d24a41c1840",
    "height": "12015934"
  },
  "fundInfo": {
    "depositor": "12jYuVktdKEC6C4g4d5fuW9MLgUDbxvJRhMBkhEGyqarUzbQ",
    "verifier": null,
    "deposit": "5000000000000",
    "raised": "9733236135609673",
    "end": "10881400",
    "cap": "10000000000000000",
    "lastContribution": {
      "ending": "10190174"
    },
    "firstPeriod": "8",
    "lastPeriod": "15",
    "fundIndex": "36"
  },
  "leasePeriods": [
    "8",
    "9",
    "10",
    "11",
    "12",
    "13",
    "14",
    "15"
  ]
}
SpecificationView Specification

Parameters

  • paraId number (required) (path) paraId to query the crowdloan information of.
  • at string($unsignedInteger or $hex) (query) Block at which to retrieve info at.

Response

  • Returns crowdloan's fundInfo and the set of leasePeriods the crowdloan` covers.

/paras/{paraId}/lease-info

Get current and future leases as well as the lifecycle stage for a given paraId.

Request Query (try it)
Example Response
{
  "at": {
    "hash": "0x6c793f308cfc61b648e0adf098e88398bb3b3e2819e568d1cf18e8c722c17bac",
    "height": "12015959"
  },
  "paraLifecycle": "Parachain",
  "leases": [
    {
      "leasePeriodIndex": "9",
      "account": "13UVJyLnbVp77Z2t6qjFmcyzTXYQJjyb6Hww7ZHPumd81iht",
      "deposit": "9264118989479833"
    },
    {
      "leasePeriodIndex": "10",
      "account": "13UVJyLnbVp77Z2t6qjFmcyzTXYQJjyb6Hww7ZHPumd81iht",
      "deposit": "9264118989479833"
    },
    {
      "leasePeriodIndex": "11",
      "account": "13UVJyLnbVp77Z2t6qjFmcyzTXYQJjyb6Hww7ZHPumd81iht",
      "deposit": "9264118989479833"
    },
    {
      "leasePeriodIndex": "12",
      "account": "13UVJyLnbVp77Z2t6qjFmcyzTXYQJjyb6Hww7ZHPumd81iht",
      "deposit": "9264118989479833"
    },
    {
      "leasePeriodIndex": "13",
      "account": "13UVJyLnbVp77Z2t6qjFmcyzTXYQJjyb6Hww7ZHPumd81iht",
      "deposit": "9264118989479833"
    },
    {
      "leasePeriodIndex": "14",
      "account": "13UVJyLnbVp77Z2t6qjFmcyzTXYQJjyb6Hww7ZHPumd81iht",
      "deposit": "9264118989479833"
    },
    {
      "leasePeriodIndex": "15",
      "account": "13UVJyLnbVp77Z2t6qjFmcyzTXYQJjyb6Hww7ZHPumd81iht",
      "deposit": "9264118989479833"
    }
  ]
}
SpecificationView Specification

Parameters

  • paraId number (required) (path) paraId to query the crowdloan information of.
  • at string($unsignedInteger or $hex) (query) Block at which to retrieve para's leases at.

Response

  • Returns a list of leases that belong to the paraId as well as the paraId's current lifecycle stage.

/accounts/{accountId}/staking-info

Get staking information for a stash account.

Request Query (try it)
Example Response
{
  "at": {
    "hash": "0x484c2435cc9a7b4a75a5add2a9804ec468d981d2360466c3a3c523d70811d581",
    "height": "12016032"
  },
  "controller": "13pZ8dj3xK7zm7hsNVNLjQEuxxTZY7vWbbgdrDZiHPmp4Edc",
  "rewardDestination": {
    "account": "12T7GCFJu79FhaijnGSstHP2R5U1NHsghw2JFvHi75eaeyyY"
  },
  "numSlashingSpans": "2",
  "staking": {
    "stash": "138QdRbUTB9eNY94Q4Mj5r39FkgMiyHCAy8UFMNA5gvtrfSB",
    "total": "1018249380627",
    "active": "1018249380627",
    "unlocking": [],
    "claimedRewards": [
      "748",
      "749",
      "750",
      "751",
      "752",
      "753",
      "754",
      "755",
      "756",
      "757",
      "758",
      "759",
      "760",
      "761",
      "762",
      "763",
      "764",
      "765",
      "766",
      "767",
      "768",
      "769",
      "770",
      "771",
      "772",
      "773",
      "774",
      "775",
      "776",
      "777",
      "778",
      "779",
      "780",
      "781",
      "782",
      "783",
      "784",
      "785",
      "786",
      "787",
      "788",
      "789",
      "790",
      "791",
      "792",
      "793",
      "794",
      "795",
      "796",
      "797",
      "798",
      "799",
      "800",
      "801",
      "802",
      "803",
      "804",
      "805",
      "806",
      "807",
      "808",
      "809",
      "810",
      "811",
      "812",
      "813",
      "814",
      "815",
      "816",
      "817",
      "818",
      "819",
      "820",
      "821",
      "822",
      "823",
      "824",
      "825",
      "826",
      "827",
      "828",
      "829",
      "830",
      "831"
    ]
  }
}
SpecificationView Specification

Parameters

  • accountId string($SS58) (required) (path) SS58 address of the account. Must be a Stash account.
  • at string($unsignedInteger or $hex (query) Block at which to query the staking info for the specified account.

Response

  • Returns information about a Stash account's staking activity.

/accounts/{accountId}/staking-payouts

Get payout information for a stash account.

Request Query (try it)
Example Response
{
  "at": {
    "height": "12016058",
    "hash": "0x74deb1ade16cbee13fee562a954d07e75bf6962e5a66fa9d3fc8b0ea051c1bbd"
  },
  "erasPayouts": [
    {
      "era": "831",
      "totalEraRewardPoints": "14030100",
      "totalEraPayout": "2608121199698399",
      "payouts": [
        {
          "validatorId": "138QdRbUTB9eNY94Q4Mj5r39FkgMiyHCAy8UFMNA5gvtrfSB",
          "nominatorStakingPayout": "1111278452440",
          "claimed": false,
          "totalValidatorRewardPoints": "59780",
          "validatorCommission": "100000000",
          "totalValidatorExposure": "37923077300445169",
          "nominatorExposure": "0"
        }
      ]
    }
  ]
}
SpecificationView Specification

Parameters

  • accountId string($SS58) (required) (path) SS58 address of the account. Must be a Stash account.
  • depth string($unsignedInteger) (query) 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. Default value : 1
  • era string($unsignedInteger) (query) The era to query at. Default value : active_era - 1
  • unclaimedOnly string($boolean) (query) Only return unclaimed rewards. Default value : true

Response

  • 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.