Kusama - REST API

REST API endpoints supported on Kusama Mainnet through Tatum RPC Gateway, with base URLs and an example request.

Call Kusama REST endpoints through Tatum RPC Gateway. Append the endpoint path to the network's base URL and send your API key in the x-api-key header. See Authentication.

Kusama has 2 REST API interfaces, each with its own base URLs and endpoints: Substrate API Sidecar and Polkadot REST API.

Substrate API Sidecar

Substrate API Sidecar, the original Node.js REST service.

Base URLs

NetworkBase URL
Kusama Mainnethttps://kusama-mainnet.gateway.tatum.io/substrateapi

Example request

curl 'https://kusama-mainnet.gateway.tatum.io/substrateapi/blocks/head/header' \
  --header 'x-api-key: {YOUR_API_KEY}'

Endpoints

59 endpoints. Parameters and responses are described in the Substrate API Sidecar documentation.

EndpointDescription
GET /accounts/{accountId}/asset-approvalsReturns an account's asset approval for a given asset and delegate.
GET /accounts/{accountId}/asset-balancesReturns an account's balances of Assets pallet assets on Asset Hub chains.
GET /accounts/{accountId}/balance-infoReturns an account's free, reserved and locked balances.
GET /accounts/{accountId}/convertConverts an account ID to an SS58 address.
GET /accounts/{accountId}/pool-asset-approvalsReturns an account's pool asset approval for a given asset and delegate.
GET /accounts/{accountId}/pool-asset-balancesReturns an account's pool asset balances.
GET /accounts/{accountId}/proxy-infoReturns an account's proxies and their types.
GET /accounts/{accountId}/staking-infoReturns staking information for a stash account, such as bonded amount and nominations.
GET /accounts/{accountId}/staking-payoutsReturns staking payouts of a stash account for recent eras.
GET /accounts/{accountId}/vesting-infoReturns an account's vesting schedule.
GET /accounts/{address}/validateValidates an SS58 address and returns its prefix and network.
GET /accounts/compareCompares up to 30 SS58 addresses and returns whether they share the same public key.
GET /blocksReturns the blocks in a given height range.
GET /blocks/{blockId}Returns a block by height or hash, with its extrinsics and events.
GET /blocks/{blockId}/extrinsics-rawReturns a block's header and its extrinsics as hex values.
GET /blocks/{blockId}/extrinsics/{extrinsicIndex}Returns an extrinsic by its index in a block.
GET /blocks/{blockId}/headerReturns a block header by height or hash.
GET /blocks/headReturns the latest finalized block, with its extrinsics and events.
GET /blocks/head/headerReturns the header of the latest finalized block.
GET /coretime/infoReturns general coretime information from the coretime chain or the relay chain.
GET /coretime/leasesLists the leases registered on the coretime chain.
GET /coretime/overviewReturns information on all cores, including assignments, workload and regions.
GET /coretime/regionsLists the regions registered on the coretime chain.
GET /coretime/renewalsLists the potential renewals registered on the coretime chain.
GET /coretime/reservationsLists the reservations registered on the coretime chain.
GET /node/networkReturns the node's peer-to-peer network information, such as peer count and sync status.
GET /node/transaction-poolReturns the extrinsics pending in the node's transaction pool.
GET /node/versionReturns the node's client version, implementation name and chain.
GET /pallets/{palletId}/constsLists the constants of a pallet.
GET /pallets/{palletId}/consts/{constantItemId}Returns the value and metadata of a pallet constant.
GET /pallets/{palletId}/dispatchablesLists the dispatchable calls of a pallet.
GET /pallets/{palletId}/dispatchables/{dispatchableItemId}Returns the metadata of a pallet dispatchable call.
GET /pallets/{palletId}/errorsLists the errors of a pallet.
GET /pallets/{palletId}/errors/{errorItemId}Returns the metadata of a pallet error.
GET /pallets/{palletId}/eventsLists the events of a pallet.
GET /pallets/{palletId}/events/{eventItemId}Returns the metadata of a pallet event.
GET /pallets/{palletId}/storageLists the storage items of a pallet.
GET /pallets/{palletId}/storage/{storageItemId}Returns the value of a pallet storage item.
GET /pallets/asset-conversion/liquidity-poolsLists the existing liquidity pools of the Asset Conversion pallet.
GET /pallets/asset-conversion/next-available-idReturns the next available liquidity pool asset ID.
GET /pallets/assets/{assetId}/asset-infoReturns the details and metadata of an asset.
GET /pallets/foreign-assetsLists all foreign assets with their details and metadata.
GET /pallets/nomination-pools/{poolId}Returns the details and metadata of a nomination pool.
GET /pallets/nomination-pools/infoReturns global nomination pool counters and limits.
GET /pallets/on-going-referendaLists the referenda currently in progress.
GET /pallets/pool-assets/{assetId}/asset-infoReturns the details and metadata of a pool asset.
GET /pallets/staking/progressReturns staking progress, such as the active era and session.
GET /pallets/staking/validatorsLists all validators and whether each is active or waiting.
GET /runtime/codeReturns the runtime Wasm blob in hex format.
GET /runtime/metadataReturns the runtime metadata in decoded JSON form.
GET /runtime/metadata/{metadataVersion}Returns a given version of the runtime metadata in decoded JSON form.
GET /runtime/metadata/versionsLists the available runtime metadata versions.
GET /runtime/specReturns the runtime version information and chain properties.
GET /transaction/materialReturns the network information needed to construct a transaction offline.
GET /transaction/material/{metadataVersion}Returns the network information needed to construct a transaction offline, with metadata of a given version.
POST /contracts/ink/{address}/queryQueries an ink! smart contract with a given message.
POST /transactionSubmits a signed extrinsic to the node's transaction pool.
POST /transaction/dry-runSimulates the submission of an extrinsic without broadcasting it.
POST /transaction/fee-estimateEstimates the fee of a serialized extrinsic, excluding tips.

The gateway lists its supported endpoints at runtime:

Polkadot REST API

Parity's Rust Polkadot REST API, a drop-in replacement for Substrate API Sidecar.

Base URLs

NetworkBase URL
Kusama Mainnethttps://kusama-mainnet.gateway.tatum.io/v1

Example request

curl 'https://kusama-mainnet.gateway.tatum.io/v1/blocks/head/header' \
  --header 'x-api-key: {YOUR_API_KEY}'

Endpoints

65 endpoints. Parameters and responses are described in the Polkadot REST API documentation.

EndpointDescription
GET /accounts/{accountId}/asset-approvalsReturns an account's asset approval for a given asset and delegate.
GET /accounts/{accountId}/asset-balancesReturns an account's balances of Assets pallet assets on Asset Hub chains.
GET /accounts/{accountId}/balance-infoReturns an account's free, reserved and locked balances.
GET /accounts/{accountId}/convertConverts an account ID to an SS58 address.
GET /accounts/{accountId}/foreign-asset-balancesReturns an account's foreign asset balances on Asset Hub chains.
GET /accounts/{accountId}/pool-asset-approvalsReturns an account's pool asset approval for a given asset and delegate.
GET /accounts/{accountId}/pool-asset-balancesReturns an account's pool asset balances.
GET /accounts/{accountId}/proxy-infoReturns an account's proxies and their types.
GET /accounts/{accountId}/staking-infoReturns staking information for a stash account, such as bonded amount and nominations.
GET /accounts/{accountId}/staking-payoutsReturns staking payouts of a stash account for recent eras.
GET /accounts/{accountId}/validateValidates an SS58 address and returns its prefix and network.
GET /accounts/{accountId}/vesting-infoReturns an account's vesting schedule.
GET /accounts/compareCompares up to 30 SS58 addresses and returns whether they share the same public key.
GET /ahm-infoReturns Asset Hub Migration start and end blocks for the relay chain and Asset Hub.
GET /blocksReturns the blocks in a given height range.
GET /blocks/{blockNumber}Returns a block by height or hash, with its extrinsics and events.
GET /blocks/{blockNumber}/extrinsics-rawReturns a block's header and its extrinsics as hex values.
GET /blocks/{blockNumber}/extrinsics/{extrinsicIndex}Returns an extrinsic by its index in a block.
GET /blocks/{blockNumber}/headerReturns a block header by height or hash.
GET /blocks/{blockNumber}/para-inclusionsReturns the parachain candidates included in a relay chain block.
GET /blocks/headReturns the latest finalized block, with its extrinsics and events.
GET /blocks/head/headerReturns the header of the latest finalized block.
GET /capabilitiesReturns the chain name and the pallets in its runtime metadata.
GET /coretime/infoReturns general coretime information from the coretime chain or the relay chain.
GET /coretime/leasesLists the leases registered on the coretime chain.
GET /coretime/overviewReturns information on all cores, including assignments, workload and regions.
GET /coretime/regionsLists the regions registered on the coretime chain.
GET /coretime/renewalsLists the potential renewals registered on the coretime chain.
GET /coretime/reservationsLists the reservations registered on the coretime chain.
GET /healthReturns the health status of the API server.
GET /node/networkReturns the node's peer-to-peer network information, such as peer count and sync status.
GET /node/transaction-poolReturns the extrinsics pending in the node's transaction pool.
GET /node/versionReturns the node's client version, implementation name and chain.
GET /pallets/{palletId}/constsLists the constants of a pallet.
GET /pallets/{palletId}/consts/{constantItemId}Returns the value and metadata of a pallet constant.
GET /pallets/{palletId}/dispatchablesLists the dispatchable calls of a pallet.
GET /pallets/{palletId}/dispatchables/{dispatchableItemId}Returns the metadata of a pallet dispatchable call.
GET /pallets/{palletId}/errorsLists the errors of a pallet.
GET /pallets/{palletId}/errors/{errorItemId}Returns the metadata of a pallet error.
GET /pallets/{palletId}/eventsLists the events of a pallet.
GET /pallets/{palletId}/events/{eventItemId}Returns the metadata of a pallet event.
GET /pallets/{palletId}/storageLists the storage items of a pallet.
GET /pallets/{palletId}/storage/{storageItemId}Returns the value of a pallet storage item.
GET /pallets/asset-conversion/liquidity-poolsLists the existing liquidity pools of the Asset Conversion pallet.
GET /pallets/asset-conversion/next-available-idReturns the next available liquidity pool asset ID.
GET /pallets/assets/{assetId}/asset-infoReturns the details and metadata of an asset.
GET /pallets/foreign-assetsLists all foreign assets with their details and metadata.
GET /pallets/nomination-pools/{poolId}Returns the details and metadata of a nomination pool.
GET /pallets/nomination-pools/infoReturns global nomination pool counters and limits.
GET /pallets/on-going-referendaLists the referenda currently in progress.
GET /pallets/pool-assets/{assetId}/asset-infoReturns the details and metadata of a pool asset.
GET /pallets/staking/progressReturns staking progress, such as the active era and session.
GET /pallets/staking/validatorsLists all validators and whether each is active or waiting.
GET /runtime/codeReturns the runtime Wasm blob in hex format.
GET /runtime/metadataReturns the runtime metadata in decoded JSON form.
GET /runtime/metadata/v14Returns the version 14 runtime metadata in decoded JSON form.
GET /runtime/metadata/versionsLists the available runtime metadata versions.
GET /runtime/specReturns the runtime version information and chain properties.
GET /transaction/materialReturns the network information needed to construct a transaction offline.
GET /transaction/material/v14Returns the network information needed to construct a transaction offline, with version 14 metadata.
POST /transactionSubmits a signed extrinsic to the node's transaction pool.
POST /transaction/dry-runSimulates the submission of an extrinsic without broadcasting it.
POST /transaction/fee-estimateEstimates the fee of a serialized extrinsic, excluding tips.
POST /transaction/metadata-blobReturns the minimal metadata an offline signer needs to decode a transaction, and the metadata hash.
POST /transaction/parseDecodes a raw transaction into its call, arguments, signature, nonce, tip and era.

The gateway lists its supported endpoints at runtime:

Endpoint unavailable?

If you need an endpoint we don't support yet, contact support.