REST API endpoints supported on Polkadot Asset Hub Mainnet through Tatum RPC Gateway, with base URLs and an example request.
Call Polkadot Asset Hub 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.
Polkadot Asset Hub 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
| Network | Base URL |
|---|---|
| Polkadot Asset Hub Mainnet | https://polkadot-assethub.gateway.tatum.io/substrateapi |
Example request
curl 'https://polkadot-assethub.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.
| Endpoint | Description |
|---|---|
GET /accounts/{accountId}/asset-approvals | Returns an account's asset approval for a given asset and delegate. |
GET /accounts/{accountId}/asset-balances | Returns an account's balances of Assets pallet assets on Asset Hub chains. |
GET /accounts/{accountId}/balance-info | Returns an account's free, reserved and locked balances. |
GET /accounts/{accountId}/convert | Converts an account ID to an SS58 address. |
GET /accounts/{accountId}/pool-asset-approvals | Returns an account's pool asset approval for a given asset and delegate. |
GET /accounts/{accountId}/pool-asset-balances | Returns an account's pool asset balances. |
GET /accounts/{accountId}/proxy-info | Returns an account's proxies and their types. |
GET /accounts/{accountId}/staking-info | Returns staking information for a stash account, such as bonded amount and nominations. |
GET /accounts/{accountId}/staking-payouts | Returns staking payouts of a stash account for recent eras. |
GET /accounts/{accountId}/vesting-info | Returns an account's vesting schedule. |
GET /accounts/{address}/validate | Validates an SS58 address and returns its prefix and network. |
GET /accounts/compare | Compares up to 30 SS58 addresses and returns whether they share the same public key. |
GET /blocks | Returns 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-raw | Returns 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}/header | Returns a block header by height or hash. |
GET /blocks/head | Returns the latest finalized block, with its extrinsics and events. |
GET /blocks/head/header | Returns the header of the latest finalized block. |
GET /coretime/info | Returns general coretime information from the coretime chain or the relay chain. |
GET /coretime/leases | Lists the leases registered on the coretime chain. |
GET /coretime/overview | Returns information on all cores, including assignments, workload and regions. |
GET /coretime/regions | Lists the regions registered on the coretime chain. |
GET /coretime/renewals | Lists the potential renewals registered on the coretime chain. |
GET /coretime/reservations | Lists the reservations registered on the coretime chain. |
GET /node/network | Returns the node's peer-to-peer network information, such as peer count and sync status. |
GET /node/transaction-pool | Returns the extrinsics pending in the node's transaction pool. |
GET /node/version | Returns the node's client version, implementation name and chain. |
GET /pallets/{palletId}/consts | Lists the constants of a pallet. |
GET /pallets/{palletId}/consts/{constantItemId} | Returns the value and metadata of a pallet constant. |
GET /pallets/{palletId}/dispatchables | Lists the dispatchable calls of a pallet. |
GET /pallets/{palletId}/dispatchables/{dispatchableItemId} | Returns the metadata of a pallet dispatchable call. |
GET /pallets/{palletId}/errors | Lists the errors of a pallet. |
GET /pallets/{palletId}/errors/{errorItemId} | Returns the metadata of a pallet error. |
GET /pallets/{palletId}/events | Lists the events of a pallet. |
GET /pallets/{palletId}/events/{eventItemId} | Returns the metadata of a pallet event. |
GET /pallets/{palletId}/storage | Lists the storage items of a pallet. |
GET /pallets/{palletId}/storage/{storageItemId} | Returns the value of a pallet storage item. |
GET /pallets/asset-conversion/liquidity-pools | Lists the existing liquidity pools of the Asset Conversion pallet. |
GET /pallets/asset-conversion/next-available-id | Returns the next available liquidity pool asset ID. |
GET /pallets/assets/{assetId}/asset-info | Returns the details and metadata of an asset. |
GET /pallets/foreign-assets | Lists 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/info | Returns global nomination pool counters and limits. |
GET /pallets/on-going-referenda | Lists the referenda currently in progress. |
GET /pallets/pool-assets/{assetId}/asset-info | Returns the details and metadata of a pool asset. |
GET /pallets/staking/progress | Returns staking progress, such as the active era and session. |
GET /pallets/staking/validators | Lists all validators and whether each is active or waiting. |
GET /runtime/code | Returns the runtime Wasm blob in hex format. |
GET /runtime/metadata | Returns 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/versions | Lists the available runtime metadata versions. |
GET /runtime/spec | Returns the runtime version information and chain properties. |
GET /transaction/material | Returns 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}/query | Queries an ink! smart contract with a given message. |
POST /transaction | Submits a signed extrinsic to the node's transaction pool. |
POST /transaction/dry-run | Simulates the submission of an extrinsic without broadcasting it. |
POST /transaction/fee-estimate | Estimates 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
| Network | Base URL |
|---|---|
| Polkadot Asset Hub Mainnet | https://polkadot-assethub.gateway.tatum.io/v1 |
Example request
curl 'https://polkadot-assethub.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.
| Endpoint | Description |
|---|---|
GET /accounts/{accountId}/asset-approvals | Returns an account's asset approval for a given asset and delegate. |
GET /accounts/{accountId}/asset-balances | Returns an account's balances of Assets pallet assets on Asset Hub chains. |
GET /accounts/{accountId}/balance-info | Returns an account's free, reserved and locked balances. |
GET /accounts/{accountId}/convert | Converts an account ID to an SS58 address. |
GET /accounts/{accountId}/foreign-asset-balances | Returns an account's foreign asset balances on Asset Hub chains. |
GET /accounts/{accountId}/pool-asset-approvals | Returns an account's pool asset approval for a given asset and delegate. |
GET /accounts/{accountId}/pool-asset-balances | Returns an account's pool asset balances. |
GET /accounts/{accountId}/proxy-info | Returns an account's proxies and their types. |
GET /accounts/{accountId}/staking-info | Returns staking information for a stash account, such as bonded amount and nominations. |
GET /accounts/{accountId}/staking-payouts | Returns staking payouts of a stash account for recent eras. |
GET /accounts/{accountId}/validate | Validates an SS58 address and returns its prefix and network. |
GET /accounts/{accountId}/vesting-info | Returns an account's vesting schedule. |
GET /accounts/compare | Compares up to 30 SS58 addresses and returns whether they share the same public key. |
GET /ahm-info | Returns Asset Hub Migration start and end blocks for the relay chain and Asset Hub. |
GET /blocks | Returns 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-raw | Returns 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}/header | Returns a block header by height or hash. |
GET /blocks/{blockNumber}/para-inclusions | Returns the parachain candidates included in a relay chain block. |
GET /blocks/head | Returns the latest finalized block, with its extrinsics and events. |
GET /blocks/head/header | Returns the header of the latest finalized block. |
GET /capabilities | Returns the chain name and the pallets in its runtime metadata. |
GET /coretime/info | Returns general coretime information from the coretime chain or the relay chain. |
GET /coretime/leases | Lists the leases registered on the coretime chain. |
GET /coretime/overview | Returns information on all cores, including assignments, workload and regions. |
GET /coretime/regions | Lists the regions registered on the coretime chain. |
GET /coretime/renewals | Lists the potential renewals registered on the coretime chain. |
GET /coretime/reservations | Lists the reservations registered on the coretime chain. |
GET /health | Returns the health status of the API server. |
GET /node/network | Returns the node's peer-to-peer network information, such as peer count and sync status. |
GET /node/transaction-pool | Returns the extrinsics pending in the node's transaction pool. |
GET /node/version | Returns the node's client version, implementation name and chain. |
GET /pallets/{palletId}/consts | Lists the constants of a pallet. |
GET /pallets/{palletId}/consts/{constantItemId} | Returns the value and metadata of a pallet constant. |
GET /pallets/{palletId}/dispatchables | Lists the dispatchable calls of a pallet. |
GET /pallets/{palletId}/dispatchables/{dispatchableItemId} | Returns the metadata of a pallet dispatchable call. |
GET /pallets/{palletId}/errors | Lists the errors of a pallet. |
GET /pallets/{palletId}/errors/{errorItemId} | Returns the metadata of a pallet error. |
GET /pallets/{palletId}/events | Lists the events of a pallet. |
GET /pallets/{palletId}/events/{eventItemId} | Returns the metadata of a pallet event. |
GET /pallets/{palletId}/storage | Lists the storage items of a pallet. |
GET /pallets/{palletId}/storage/{storageItemId} | Returns the value of a pallet storage item. |
GET /pallets/asset-conversion/liquidity-pools | Lists the existing liquidity pools of the Asset Conversion pallet. |
GET /pallets/asset-conversion/next-available-id | Returns the next available liquidity pool asset ID. |
GET /pallets/assets/{assetId}/asset-info | Returns the details and metadata of an asset. |
GET /pallets/foreign-assets | Lists 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/info | Returns global nomination pool counters and limits. |
GET /pallets/on-going-referenda | Lists the referenda currently in progress. |
GET /pallets/pool-assets/{assetId}/asset-info | Returns the details and metadata of a pool asset. |
GET /pallets/staking/progress | Returns staking progress, such as the active era and session. |
GET /pallets/staking/validators | Lists all validators and whether each is active or waiting. |
GET /runtime/code | Returns the runtime Wasm blob in hex format. |
GET /runtime/metadata | Returns the runtime metadata in decoded JSON form. |
GET /runtime/metadata/v14 | Returns the version 14 runtime metadata in decoded JSON form. |
GET /runtime/metadata/versions | Lists the available runtime metadata versions. |
GET /runtime/spec | Returns the runtime version information and chain properties. |
GET /transaction/material | Returns the network information needed to construct a transaction offline. |
GET /transaction/material/v14 | Returns the network information needed to construct a transaction offline, with version 14 metadata. |
POST /transaction | Submits a signed extrinsic to the node's transaction pool. |
POST /transaction/dry-run | Simulates the submission of an extrinsic without broadcasting it. |
POST /transaction/fee-estimate | Estimates the fee of a serialized extrinsic, excluding tips. |
POST /transaction/metadata-blob | Returns the minimal metadata an offline signer needs to decode a transaction, and the metadata hash. |
POST /transaction/parse | Decodes 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.