Kusama RPC API - Author Methods
v1.0.0https://ksm-assethub.nownodes.ioKusama RPChttps://ksmassethub-playbook.nownodes.iohttps://ksm.nownodes.ioKusama RPChttps://ksm-playbook.nownodes.ioAPI for interacting with Kusama via JSON-RPC. Contains author category methods for submitting and monitoring extrinsics.
Authentication
api-keyAuthapiKeyAPI Key: API_key in header
ASSETHUB
chain
Get the hash of the last finalized block
Returns the hash of the block that was finalized on the chain.
Body
JSON-RPC request parameters
jsonrpcstringrequiredJSON-RPC version
idstringrequiredRequest identifier
methodstringrequiredMethod name
paramsArray<any>requiredMethod parameters (empty array)
Response
Hash of the last finalized block
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerGet block by hash
Returns full information of a block, including header, extrinsics, and digest.
Body
JSON-RPC request parameters
jsonrpcstringrequiredJSON-RPC version
idstringrequiredRequest identifier
methodstringrequiredMethod name
paramsArray<string>requiredArray containing block hash to retrieve
Response
Full block details
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerGet block hash by block number
Returns the block hash using the block number in the chain.
Body
JSON-RPC request parameters
jsonrpcstringrequiredJSON-RPC version
idstringrequiredRequest identifier
methodstringrequiredMethod name
paramsArray<integer>requiredArray containing block number
Response
Block hash by block number
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerpayment
Retrieve fee information for an encoded extrinsic
Returns detailed fee information (weight, partial fee, etc.) for a given encoded extrinsic.
Body
JSON-RPC request containing encoded extrinsic
jsonrpcstringrequiredJSON-RPC version
idstringrequiredRequest identifier
methodstringrequiredMethod name
paramsArray<string>requiredArray containing encoded extrinsic(s) to query fee info for
Response
Fee information for the extrinsic
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerstate
Retrieve storage for a given key
Returns the value stored under a specific key at the latest block or a given block.
Body
JSON-RPC request parameters
jsonrpcstringrequiredJSON-RPC version
idstringrequiredRequest identifier
methodstringrequiredMethod name
paramsArray<string>requiredArray containing storage keys
Response
Returns the value stored at the specified key
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerGet the runtime version
Returns version information about the runtime, including spec version, implementation version, and transaction version.
Body
JSON-RPC request parameters
jsonrpcstringrequiredJSON-RPC version
idstringrequiredRequest identifier
methodstringrequiredMethod name
paramsArray<any>requiredNo parameters required
Response
Runtime version information
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerRetrieve runtime metadata
Returns the runtime metadata, which includes information about modules, calls, storage, and events.
Body
JSON-RPC request parameters
jsonrpcstringrequiredJSON-RPC version
idstringrequiredRequest identifier
methodstringrequiredMethod name
paramsArray<any>requiredNo parameters required
Response
Runtime metadata in hex format
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerReturns proof of storage entries at a specific block state
Provides a cryptographic proof for the existence and content of storage entries at a given block.
Body
JSON-RPC request parameters
jsonrpcstringrequiredJSON-RPC version
idstringrequiredRequest identifier
methodstringrequiredMethod name
paramsArray<any>requiredList of storage keys for which to generate proof
Response
Proof of storage entries
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerRetrieves the storage hash
Returns the hash of the storage value stored under a specific key.
Body
JSON-RPC request parameters
jsonrpcstringrequiredidstringrequiredmethodstringrequiredparamsArray<any>requiredStorage key(s) to compute hash
Response
Storage hash result
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerRetrieves the storage size
Returns the size in bytes of the storage value under a specific key.
Body
JSON-RPC request parameters
jsonrpcstringrequiredidstringrequiredmethodstringrequiredparamsArray<any>requiredStorage key(s) to measure
Response
Storage size result
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerQuery historical storage entries
Returns the storage changes between two blocks for a set of keys.
Body
JSON-RPC request parameters
jsonrpcstringrequiredidstringrequiredmethodstringrequiredparamsArray<any>requiredList of storage keys and block range
Response
Query storage result
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerQuery storage entries at a specific block
Returns the storage values for given keys at a specified block hash.
Body
JSON-RPC request parameters
jsonrpcstringrequiredidstringrequiredmethodstringrequiredparamsArray<any>requiredList of storage keys and block hash
Response
Storage entries at block
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headersystem
Retrieve the name of the chain
Returns the network name (e.g., Kusama, Polkadot) the node is connected to.
Body
JSON-RPC request to get chain name
jsonrpcstringrequiredJSON-RPC version
idstringrequiredRequest identifier
methodstringrequiredMethod name
paramsArray<any>requiredShould be empty for this method
Response
Chain name
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerRetrieve custom properties from chain spec
Returns chain-specific properties such as token symbol, decimals, and address format.
Body
JSON-RPC request to get system properties
jsonrpcstringrequiredJSON-RPC version
idstringrequiredRequest identifier
methodstringrequiredMethod name
paramsArray<any>requiredShould be empty for this method
Response
System properties of the chain
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerhealth
Health check
Health check
Returns the health status of the API server.
Response
API is healthy
Authorization
api-keyAuthapiKey in headernode
Connected node information
Node network info
Returns the node's network information including peer count, syncing status, and local peer ID.
Response
Node network information
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerTransaction pool
Returns the node's transaction pool with optional fee information.
Parameters
includeFeebooleanqueryInclude fee details for each transaction
Response
Transaction pool entries
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerNode version
Returns the node's version information including client version, implementation name, and chain name.
Response
Node version information
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet information about the Substrate node's activity in the peer-to-peer network.
Returns network related information of the node.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet pending extrinsics from the Substrate node.
Returns the extrinsics that the node knows of that have not been included in a block.
Parameters
includeFeebooleanfalsequeryBoolean representing whether or not to include tips, partialFee, and priority in each extrinsic.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet information about the Substrates node's implementation and versioning.
Returns versioning information of the node.
Response
successful operation
Authorization
api-keyAuthapiKey in headerversion
API version
API version
Returns the current version of the Polkadot REST API.
Response
API version
Authorization
api-keyAuthapiKey in headerblocks
Block queries and extrinsic data
Get blocks by range
Returns a collection of blocks given a numeric range. Range is inclusive and limited to 500 blocks.
Parameters
rangestringqueryBlock range in format 'start-end' (e.g. '100-200')
eventDocsbooleanqueryInclude documentation for events
extrinsicDocsbooleanqueryInclude documentation for extrinsics
noFeesbooleanquerySkip fee calculation for extrinsics
useRcBlockbooleanqueryTreat range as Relay Chain blocks
useEvmFormatbooleanqueryConvert AccountId32 addresses to EVM format for revive pallet events
Response
Array of block information
Invalid range parameter
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet latest block
Returns the latest finalized or canonical block with full extrinsic and event details.
Parameters
finalizedbooleanqueryWhen true (default), returns finalized head. When false, returns canonical head.
eventDocsbooleanqueryInclude documentation for events
extrinsicDocsbooleanqueryInclude documentation for extrinsics
noFeesbooleanquerySkip fee calculation for extrinsics
decodedXcmMsgsbooleanqueryDecode and include XCM messages
paraIdinteger<int32>>= 0queryFilter XCM messages by parachain ID
useRcBlockbooleanqueryWhen true, use relay chain head to find corresponding Asset Hub blocks
useEvmFormatbooleanqueryConvert AccountId32 addresses to EVM format for revive pallet events
Response
Latest block information
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet head block header
Returns the header of the latest finalized or canonical block (lightweight, no extrinsics/events).
Parameters
finalizedbooleanqueryWhen true (default), returns finalized head header. When false, returns canonical head header.
useRcBlockbooleanqueryTreat as Relay Chain block and return Asset Hub blocks
Response
Block header information
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet block by ID
Returns block information for a given block identifier (hash or number), including extrinsics, events, and fees.
Parameters
blockIdstringrequiredpathBlock height number or block hash
eventDocsbooleanqueryInclude documentation for events
extrinsicDocsbooleanqueryInclude documentation for extrinsics
noFeesbooleanquerySkip fee calculation for extrinsics
finalizedKeybooleanqueryWhen true (default), include finalized status in response
decodedXcmMsgsbooleanqueryDecode and include XCM messages
paraIdinteger<int32>>= 0queryFilter XCM messages by parachain ID
useRcBlockbooleanqueryTreat blockId as Relay Chain block and return Asset Hub blocks
useEvmFormatbooleanqueryConvert AccountId32 addresses to EVM format for revive pallet events
Response
Block information
Invalid block identifier
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet raw extrinsics
Returns raw block data with hex-encoded extrinsics for a given block identifier. The extrinsics are returned as raw hex strings without decoding.
Parameters
blockIdstringrequiredpathBlock height number or block hash
useRcBlockbooleanqueryWhen true, treat blockId as Relay Chain block and return Asset Hub blocks
Response
Raw block data with hex-encoded extrinsics
Invalid block identifier
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet extrinsic by index
Returns a specific extrinsic from a block by its index within the block.
Parameters
blockIdstringrequiredpathBlock height number or block hash
extrinsicIndexstringrequiredpathIndex of the extrinsic within the block
eventDocsbooleanqueryInclude documentation for events
extrinsicDocsbooleanqueryInclude documentation for extrinsics
noFeesbooleanquerySkip fee calculation
useRcBlockbooleanqueryWhen true, treat blockId as Relay Chain block and return Asset Hub extrinsics
useEvmFormatbooleanqueryConvert AccountId32 addresses to EVM format for revive pallet events
Response
Extrinsic details
Invalid block identifier or extrinsic index
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet block header by ID
Returns the header of the specified block (lightweight, no extrinsics/events).
Parameters
blockIdstringrequiredpathBlock height number or block hash
useRcBlockbooleanqueryTreat blockId as Relay Chain block and return Asset Hub blocks
Response
Block header information
Invalid block identifier
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet parachain inclusions
Returns parachain inclusion information for a given relay chain block. Extracts CandidateIncluded events from the ParaInclusion pallet.
Parameters
blockIdstringrequiredpathBlock height number or block hash
paraIdinteger<int32>>= 0queryFilter results by a specific parachain ID
Response
Parachain inclusion information
Invalid block identifier
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet a range of blocks by their height.
Given a range query parameter return an array of all the blocks within that range.
Parameters
rangestringrequiredqueryA range of integers. There is a max limit of 500 blocks per request.
eventDocsbooleanfalsequeryWhen set to true, every event will have an extra docs property with a string of the events documentation.
extrinsicDocsbooleanfalsequeryWhen set to true, every extrinsic will have an extra docs property with a string of the extrinsics documentation.
noFeesbooleanfalsequeryWhen set to true, the fee won't be calculated for the extrinsics.
Response
successful operation
invalid Block identifier supplied
Authorization
api-keyAuthapiKey in headerGet a block by its height or hash.
Returns a single block. BlockId can either be a block hash or a block height. Replaces /block/{number} from versions < v1.0.0.
Parameters
blockIdstringrequiredpathBlock identifier, as the block height or block hash.
eventDocsbooleanfalsequeryWhen set to true, every event will have an extra docs property with a string of the events documentation.
extrinsicDocsbooleanfalsequeryWhen set to true, every extrinsic will have an extra docs property with a string of the extrinsics documentation.
noFeesbooleanfalsequeryWhen set to true, the fee won't be calculated for the extrinsics.
finalizedKeybooleanqueryWhen set to false, this will override the chain-config, and omit the finalized key in the response. This can increase performance slightly by avoiding an additional RPC call to the node.
decodedXcmMsgsbooleanfalsequeryWhen set to true, this will show the decoded XCM messages within the extrinsics of the requested block.
paraIdstringqueryWhen it is set, this will return only the decoded XCM messages for the specified origin Parachain Id (originParaId). To activate this functionality, ensure that the decodedXcmMsgs parameter is set to true.
Response
successful operation
invalid Block identifier supplied
Authorization
api-keyAuthapiKey in headerGet a block's header by its height or hash.
Returns a single block's header. BlockId can either be a block hash or a block height.
Parameters
blockIdstringrequiredpathBlock identifier, as the block height or block hash.
Response
successful operation
invalid Block identifier supplied
Authorization
api-keyAuthapiKey in headerGet an extrinsic by its extrinsicIndex and block height or hash. The pair blockId, extrinsicIndex is sometimes referred to as a Timepoint.
Returns a single extrinsic.
Parameters
blockIdstringrequiredpathBlock identifier, as the block height or block hash.
extrinsicIndexstringrequiredpathThe extrinsic's index within the block's body.
eventDocsbooleanfalsequeryWhen set to true, every event will have an extra docs property with a string of the events documentation.
extrinsicDocsbooleanfalsequeryWhen set to true, every extrinsic will have an extra docs property with a string of the extrinsics documentation.
Response
successful operation
Requested extrinsicIndex does not exist
Authorization
api-keyAuthapiKey in headerGet the most recently finalized block.
Returns the most recently finalized block. Replaces /block from versions < v1.0.0.
Parameters
finalizedbooleantruequeryBoolean 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.
eventDocsbooleanfalsequeryWhen set to true, every event will have an extra docs property with a string of the events documentation.
extrinsicDocsbooleanfalsequeryWhen set to true, every extrinsic will have an extra docs property with a string of the extrinsics documentation.
noFeesbooleanfalsequeryWhen set to true, the fee won't be calculated for the extrinsics.
decodedXcmMsgsbooleanfalsequeryWhen set to true, this will show the decoded XCM messages within the extrinsics of the requested block.
paraIdstringqueryWhen it is set, this will return only the decoded XCM messages for the specified origin Parachain Id (originParaId). To activate this functionality, ensure that the decodedXcmMsgs parameter is set to true.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet information about the header of the most recent finalized block.
Returns the most recently finalized block's header.
Parameters
finalizedbooleantruequeryBoolean 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.
Response
successful operation
invalid Block identifier supplied
Authorization
api-keyAuthapiKey in headerGet a blocks header & its extrinsics as hex values.
Returns a block & its extrinsics as hex values. BlockId can either be a block hash or a block height.
Parameters
blockIdstringrequiredpathBlock identifier, as the block height or block hash.
Response
successful operation
invalid Block identifier supplied
Authorization
api-keyAuthapiKey in headeraccounts
Account balance, staking, and proxy information
Compare account addresses
Compares multiple SS58 addresses to determine if they have the same underlying public key.
Parameters
addressesstringrequiredqueryComma-separated list of SS58 addresses to compare (max 30)
Response
Comparison result
Invalid parameters
Authorization
api-keyAuthapiKey in headerAccount asset approvals
Returns asset approval information for a given account, asset, and delegate.
Parameters
accountIdstringrequiredpathSS58-encoded account address
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
assetIdstringrequiredqueryThe asset ID to query approval for
delegatestringrequiredqueryThe delegate address with spending approval
Response
Asset approval information
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerAccount asset balances
Returns asset balances for a given account on Asset Hub chains.
Parameters
accountIdstringrequiredpathSS58-encoded account address
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
assetsstringqueryComma-separated list of asset IDs to query
showEmptybooleanqueryWhen true, include assets with zero balance (default: false)
Response
Account asset balances
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerAccount balance info
Returns balance information for a given account including free, reserved, and locked balances.
Parameters
accountIdstringrequiredpathSS58-encoded account address
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
tokenstringqueryToken symbol for chains with multiple tokens
denominatedbooleanqueryWhen true, denominate balances using chain decimals
Response
Account balance information
Invalid account or block parameter
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerConvert account format
Converts an account address between different SS58 formats and key types.
Parameters
accountIdstringrequiredpathSS58-encoded account address or hex public key
schemestringqueryCryptographic scheme: ed25519, sr25519, or ecdsa (default: sr25519)
prefixinteger<int32>>= 0querySS58 prefix number (default: 42)
publicKeybooleanqueryIf true, treat input as a public key
Response
Converted account information
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerAccount foreign asset balances
Returns foreign asset balances for a given account on Asset Hub chains. Foreign assets use XCM MultiLocation as their identifier.
Parameters
accountIdstringrequiredpathSS58-encoded account address
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
foreignAssetsArray<string>queryList of multilocation JSON strings to filter by
showEmptybooleanqueryWhen true, include assets with zero balance (default: false)
Response
Foreign asset balances
Invalid account or parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerAccount pool asset approvals
Returns pool asset approval information for a given account, asset, and delegate.
Parameters
accountIdstringrequiredpathSS58-encoded account address
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
assetIdstringrequiredqueryThe pool asset ID to query approval for
delegatestringrequiredqueryThe delegate address with spending approval
Response
Pool asset approval information
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerAccount pool asset balances
Returns pool asset balances for a given account.
Parameters
accountIdstringrequiredpathSS58-encoded account address
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
assetsstringqueryComma-separated list of pool asset IDs to query
showEmptybooleanqueryWhen true, include assets with zero balance (default: false)
Response
Pool asset balances
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerAccount proxy info
Returns proxy information for a given account including delegated proxies and their types.
Parameters
accountIdstringrequiredpathSS58-encoded account address
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Proxy information
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerAccount staking info
Returns staking information for a given stash account including bonded amount, controller, and nominations.
Parameters
accountIdstringrequiredpathSS58-encoded stash account address
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
includeClaimedRewardsbooleanqueryWhen true, include claimed rewards in the response
Response
Staking information
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerAccount staking payouts
Returns staking payout history for a given account including era rewards and claimed status.
Parameters
accountIdstringrequiredpathSS58-encoded stash account address
atstringqueryBlock hash or number to query at
depthstringqueryNumber of eras to query (default: 1)
erastringqueryThe era to query at (default: active_era - 1)
unclaimedOnlybooleanqueryOnly show unclaimed rewards (default: true)
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Staking payout information
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerValidate account address
Validates an SS58-encoded account address and returns details about its format.
Parameters
accountIdstringrequiredpathSS58-encoded account address to validate
atstringqueryBlock hash or number (accepted for API consistency)
Response
Validation result
Authorization
api-keyAuthapiKey in headerAccount vesting info
Returns vesting information for a given account including vesting schedules and locked amounts.
Parameters
accountIdstringrequiredpathSS58-encoded account address
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
includeClaimablebooleanqueryWhen true, calculate vested amounts
Response
Vesting information
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet an array of asset-balances for an account.
Returns information about an account's asset-balances. This is specific to the assets pallet for parachains. If no assets query parameter is provided, all asset-balances for the given account will be returned.
Parameters
accountIdstring<SS58>requiredpathSS58 address of the account.
atstring<unsignedInteger or $hex>queryBlock at which to query asset-balance info for the specified account.
assetsArray<string><Array of unsignedInteger's>queryAn array of AssetId's to be queried. If not supplied, defaults to providing all asset balances associated with the accountId will be returned. The array query param format follows Express 4.x API. ex:?assets[]=1&assets[]=2&assets[]=3.
Response
successfull operation
Invalid Address
Authorization
api-keyAuthapiKey in headerGet foreign asset balances for an account
Retrieves all foreign asset holdings (XCM assets from other parachains) for a specific account in AssetHub. Returns an array of foreign assets with their balances, metadata, and verification status.
Parameters
accountIdstringrequiredpathThe SS58-encoded account identifier (32-byte public key) to query foreign asset balances for.
atstringqueryOptional block hash or height to query historical state. If not provided, uses the latest finalized block.
includeZeroBalancesbooleanfalsequeryInclude assets with zero balance in the response. Default is false.
verifiedOnlybooleanfalsequeryReturn only verified foreign assets (assets that have gone through governance approval). Default is false.
Response
Successful response containing foreign asset balances for the account
Authorization
api-keyAuthapiKey in headerGet an asset approval for an account.
Returns information about an account's asset approval transaction. It is required to pass in a delegate and an assetId as query parameters.
Parameters
accountIdstring<SS58>requiredpathSS58 address of the account.
atstring<unsignedInteger or $hex>queryBlock at which to query asset approval info for the specified account.
assetIdstring<unsignedInteger>requiredqueryThe assetId associated with the asset-approval.
delegatestring<SS58>requiredqueryThe delegate's accountId associated with an asset-approval.
Response
successfull operation
Invalid Address
Authorization
api-keyAuthapiKey in headerGet balance information for an account.
Returns information about an account's balance. Replaces /balance/{address} from versions < v1.0.0.
Parameters
accountIdstring<SS58>requiredpathSS58 address of the account.
atstring<unsignedInteger or $hex>queryBlock at which to query balance info for the specified account.
tokenstringqueryToken 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.
denominatedbooleanfalsequeryWhen set to true it will denominate any balance's given atomic value using the chains given decimal value.
Response
successful operation
Invalid Address
account not found
Authorization
api-keyAuthapiKey in headerConvert a given AccountId to an SS58 address.
Returns the SS58 prefix, the network address format, the SS58 address, and the AccountId that was given as input parameter, the scheme that was used and if it is a public key or not (boolean).
Parameters
accountIdstring<AccountId or Hex>requiredpathAccountId or Public Key (hex).
schemestring<string>sr25519queryThe cryptographic scheme to be used in order to convert the AccountId to an SS58 address. It can take one of three values [sr25519, ed25519, ecdsa]. The default scheme that is used is sr25519 (if it is not set in the query parameter).
prefixstring<number>42queryThe address prefix which can be one of the values found in the SS58-registry.
publicKeystring<boolean>truequeryDefines if the given value in the path parameter is a Public Key (hex) or not (hence AccountId).
Response
successfully converted the AccountId and retrieved the address info.
Invalid AccountId
AccountId not found
Authorization
api-keyAuthapiKey in headerGet an array of pool-asset-balances for an account.
Returns information about an account's pool-asset-balances. This is specific to the pool assets pallet for parachains. If no assets query parameter is provided, all pool-asset-balances for the given account will be returned.
Parameters
accountIdstring<SS58>requiredpathSS58 address of the account.
atstring<unsignedInteger or $hex>queryBlock at which to query pool-asset-balance info for the specified account.
assetsArray<string><Array of unsignedInteger's>queryAn array of AssetId's to be queried. If not supplied, defaults to providing all asset balances associated with the accountId will be returned. The array query param format follows Express 4.x API. ex:?assets[]=1&assets[]=2&assets[]=3.
Response
successfull operation
Invalid Address
Authorization
api-keyAuthapiKey in headerGet an asset approval for an account.
Returns information about an account's asset approval transaction. It is required to pass in a delegate and an assetId as query parameters.
Parameters
accountIdstring<SS58>requiredpathSS58 address of the account.
atstring<unsignedInteger or $hex>queryBlock at which to query asset approval info for the specified account.
assetIdstring<unsignedInteger>requiredqueryThe assetId associated with the asset-approval.
delegatestring<SS58>requiredqueryThe delegate's accountId associated with an asset-approval.
Response
successfull operation
Invalid Address
Authorization
api-keyAuthapiKey in headerGet proxy account information.
Returns information about a proxy account. This will include delegated accounts and deposits held.
Parameters
accountIdstring<SS58>requiredpathSS58 address of the account.
atstring<unsignedInteger or $hex>queryBlock at which to query proxy info for the specified account.
Response
successfull operation
Invalid Address
Authorization
api-keyAuthapiKey in headerGet vesting information for an account.
Returns the vesting schedule for an account. Replaces /vesting/{address} from versions < v1.0.0.
Parameters
accountIdstring<SS58>requiredpathSS58 address of the account.
atstring<unsignedInteger or $hex>queryBlock at which to query the vesting info for the specified account.
Response
successful operation
Invalid Address
account not found
Authorization
api-keyAuthapiKey in headerValidate a given address.
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.
Parameters
addressstring<SS58 or Hex>requiredpathSS58 or Hex address of the account.
Response
successfully retrieved address info
Authorization
api-keyAuthapiKey in headerCompares up to 30 SS58 addresses.
Returns if the given addresses are equal or not, along with details of each address. Equality is determined by comparing the accountId/publicKey of each address.
Parameters
addressesArray<string>requiredqueryAn array or a comma separated string of SS58 addresses. Provide up to 30 addresses using one of these formats ?addresses=...&addresses=... or ?addresses[]=...&addresses[]=... or ?addresses=...,....
Response
successfully compared at least two SS58 addresses.
Invalid Address
Authorization
api-keyAuthapiKey in headerpallets
Runtime pallet metadata, storage, constants, events, errors
Liquidity pools
Returns all liquidity pools from the AssetConversion pallet.
Parameters
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Liquidity pools
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerNext available pool ID
Returns the next available pool asset ID from the AssetConversion pallet.
Parameters
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Next available ID
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerAsset info
Returns details for a specific asset including supply, admin, and metadata.
Parameters
assetIdstringrequiredpathAsset ID
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Asset information
Asset not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerForeign assets
Returns all foreign assets with their details and metadata. Foreign assets use XCM MultiLocation as their identifier.
Parameters
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Foreign assets list
Not supported on this chain
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerNomination pools info
Returns global nomination pools statistics and configuration.
Parameters
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Nomination pools information
Not supported on this chain
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerNomination pool details
Returns details for a specific nomination pool.
Parameters
poolIdstringrequiredpathPool ID
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Pool details
Pool not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerOn-going referenda
Returns all currently active referenda from the Referenda pallet.
Parameters
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Active referenda
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerPool asset info
Returns details for a specific pool asset including supply, admin, and metadata.
Parameters
assetIdstringrequiredpathPool asset ID
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Pool asset information
Pool asset not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerStaking progress
Returns staking progress including era, session info, and validator counts.
Parameters
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Staking progress information
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerStaking validators
Returns the list of active validators and their info.
Parameters
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Validator information
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerPallet constants
Returns all constants defined in a pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
atstringqueryBlock hash or number to query at
onlyIdsbooleanqueryOnly return constant names
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Pallet constants
Invalid pallet
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerPallet constant value
Returns the value and metadata of a specific constant in a pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
constantItemIdstringrequiredpathName of the constant
atstringqueryBlock hash or number to query at
metadatabooleanqueryInclude metadata
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Constant value
Invalid parameters
Constant not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerPallet dispatchables
Returns the dispatchable calls defined in a pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
atstringqueryBlock hash or number to query at
onlyIdsbooleanqueryOnly return dispatchable names
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Pallet dispatchables
Invalid pallet
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerPallet dispatchable details
Returns a single dispatchable call defined in a pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
dispatchableIdstringrequiredpathName of the dispatchable
atstringqueryBlock hash or number to query at
metadatabooleanqueryInclude metadata
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Dispatchable details
Dispatchable not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerPallet errors
Returns all errors defined in a pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
atstringqueryBlock hash or number to query at
onlyIdsbooleanqueryOnly return error names
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Pallet errors
Invalid pallet
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerPallet error details
Returns metadata for a specific error in a pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
errorItemIdstringrequiredpathName of the error
atstringqueryBlock hash or number to query at
metadatabooleanqueryInclude metadata
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Error details
Error not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet pallet events
Returns all events defined in a pallet.
Parameters
palletIdstringrequiredpathPallet name or index
atstringqueryBlock identifier (number or hash)
onlyIdsbooleanqueryOnly return event names
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Pallet events
Invalid request
Pallet not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet pallet event item
Returns metadata for a specific event in a pallet.
Parameters
palletIdstringrequiredpathPallet name or index
eventItemIdstringrequiredpathEvent name
atstringqueryBlock identifier (number or hash)
metadatabooleanqueryInclude full event metadata
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Event item details
Invalid request
Pallet or event not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerPallet storage items
Returns the list of storage items for a given pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
atstringqueryBlock hash or number to query at
onlyIdsbooleanqueryOnly return storage item names
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Pallet storage items
Invalid pallet or parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerPallet storage item value
Returns the value of a specific storage item in a pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
storageItemIdstringrequiredpathName of the storage item
atstringqueryBlock hash or number to query at
keys[]Array<string>queryStorage key arguments
metadatabooleanqueryInclude metadata for the storage item
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Storage item value
Invalid parameters
Storage item not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet information and metadata associated with an asset.
Returns information associated with an asset which includes the assets AssetDetails and AssetMetadata.
Parameters
assetIdstring<unsignedInteger>requiredpathThe unsignedInteger Id of an asset.
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the assetInfo.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet information related to existing liquidity pools.
Returns a list of the existing liquidity pools and its corresponding tokens at a given block height. If no block is specified, it returns the latest list available.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the liquidity pools information.
Response
successful operation
invalid blockId supplied for at query param
Authorization
api-keyAuthapiKey in headerGet the next available liquidity pool id.
Returns the next available liquidity pool's id at a given block height. If no block is specified, it returns the latest list available.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the next liquidity pool's id.
Response
successful operation
invalid blockId supplied for at query param
Authorization
api-keyAuthapiKey in headerGet information and metadata associated with foreign assets.
Returns information associated with every foreign asset which includes the assets AssetDetails and AssetMetadata.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the foreign assets.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet information associated with nomination pools.
Returns information and metadata for nomination pools including pool counters and limits.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the nomination pool info.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet information and metadata associated with a nomination pool.
Returns information associated with a nomination pool which includes the nomination pools' bondedPool, rewardPool and metadata.
Parameters
poolIdstring<unsignedInteger>requiredpathThe unsignedInteger Id of a nomination pool.
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the nomination pool.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet a list of all on-going referenda that have track root (0) and whitelisted (1), along with their associated information.
Returns information associated with on-going referenda which includes the referendum's enactment, submitted and deciding fields.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the on-going referenda.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet a list of constants for a pallet.
Returns a list of const item metadata for constant items of the specified palletId.
Parameters
palletIdstringrequiredpathName or index of the pallet to read constant metadata for. Note: the pallet name must match what is specified in the runtime metadata.
onlyIdsbooleanqueryOnly return the names (IDs) of the const items instead of every constant's metadata.
atstring<unsignedInteger or $hex>queryBlock at which to retrieve a list of the pallet's constant items.
Response
successful operation
invalid blockId supplied for at query param
could not find pallet with palletId
Authorization
api-keyAuthapiKey in headerGet the value of a constant item.
Returns the value stored under the constantItemId.
Parameters
palletIdstringrequiredpathName or index of the pallet to read constant metadata for. Note: the pallet name must match what is specified in the runtime metadata.
constantItemIdstringrequiredpathId of the const item to query for.
atstring<unsignedInteger or $hex>queryBlock at which to query the const item at.
metadatabooleanfalsequeryInclude the const items metadata (including documentation) if set to true.
Response
successful operation
invalid blockId supplied for at query param
could not find resource with id
Authorization
api-keyAuthapiKey in headerGet a list of dispatchables for a pallet.
Returns a list of dispatchable item metadata for distpachable items of the specified palletId.
Parameters
palletIdstringrequiredpathName or index of the pallet to read dispatchable metadata for. Note: the pallet name must match what is specified in the runtime metadata.
onlyIdsbooleanqueryOnly return the names (IDs) of the dispatchable items instead of every dispatchable's metadata.
Response
successful operation
invalid blockId supplied for at query param
could not find pallet with palletId
Authorization
api-keyAuthapiKey in headerGet the value of a dispatchable item.
Returns the value stored under the dispatchableItemId.
Parameters
palletIdstringrequiredpathName or index of the pallet to read dispatchable metadata for. Note: the pallet name must match what is specified in the runtime metadata.
dispatchableItemIdstringrequiredpathId of the dispatchable item to query for.
metadatabooleanfalsequeryInclude the dispatchable items metadata (including documentation) if set to true.
Response
successful operation
invalid blockId supplied for at query param
could not find resource with id
Authorization
api-keyAuthapiKey in headerGet a list of errors for a pallet.
Returns a list of error item metadata for error items of the specified palletId.
Parameters
palletIdstringrequiredpathName or index of the pallet to read error metadata for. Note: the pallet name must match what is specified in the runtime metadata.
onlyIdsbooleanqueryOnly return the names (IDs) of the error items instead of every error's metadata.
atstring<unsignedInteger or $hex>queryBlock at which to retrieve a list of the pallet's error items.
Response
successful operation
invalid blockId supplied for at query param
could not find pallet with palletId
Authorization
api-keyAuthapiKey in headerGet the value of an error item.
Returns the value stored under the errorItemId.
Parameters
palletIdstringrequiredpathName or index of the pallet to read error metadata for. Note: the pallet name must match what is specified in the runtime metadata.
errorItemIdstringrequiredpathId of the error item to query for.
atstring<unsignedInteger or $hex>queryBlock at which to query the error item at.
metadatabooleanfalsequeryInclude the error items metadata (including documentation) if set to true.
Response
successful operation
invalid blockId supplied for at query param
could not find resource with id
Authorization
api-keyAuthapiKey in headerGet a list of events for a pallet.
Returns a list of event item metadata for event items of the specified palletId.
Parameters
palletIdstringrequiredpathName or index of the pallet to read event metadata for. Note: the pallet name must match what is specified in the runtime metadata.
onlyIdsbooleanqueryOnly return the names (IDs) of the event items instead of every event's metadata.
atstring<unsignedInteger or $hex>queryBlock at which to retrieve a list of the pallet's event items.
Response
successful operation
invalid blockId supplied for at query param
could not find pallet with palletId
Authorization
api-keyAuthapiKey in headerGet the value of an event item.
Returns the value stored under the eventItemId.
Parameters
palletIdstringrequiredpathName or index of the pallet to read event metadata for. Note: the pallet name must match what is specified in the runtime metadata.
eventItemIdstringrequiredpathId of the event item to query for.
atstring<unsignedInteger or $hex>queryBlock at which to query the event item at.
metadatabooleanfalsequeryInclude the event items metadata (including documentation) if set to true.
Response
successful operation
invalid blockId supplied for at query param
could not find resource with id
Authorization
api-keyAuthapiKey in headerGet a list of storage items for a pallet.
Returns a list of storage item metadata for storage items of the specified palletId.
Parameters
palletIdstringrequiredpathName or index of the pallet to query the storage of. Note: the pallet name must match what is specified in the runtime metadata.
onlyIdsbooleanqueryOnly return the names (IDs) of the storage items instead of all of each storage item's metadata.
atstring<unsignedInteger or $hex>queryBlock at which to retrieve a list of the pallet's storage items.
Response
successful operation
invalid blockId supplied for at query param
could not find pallet with palletId
Authorization
api-keyAuthapiKey in headerGet the value of a storage item.
Returns the value stored under the storageItemId. If it is a map, query param key1 is required. If the storage item is double map query params key1 and key2 are required.
Parameters
palletIdstringrequiredpathName or index of the pallet to query the storage of. Note: pallet name aligns with pallet name as specified in runtime metadata.
storageItemIdstringrequiredpathId of the storage item to query for.
keysArray<string>querySet of N keys used for querying a storage map. It should be queried using the following format - ?keys[]=key1&keys[]=key2. Order matters, as it will determine the order the keys are passed into the storage calls.
atstring<unsignedInteger or $hex>queryBlock at which to query the storage item at.
metadatabooleanfalsequeryInclude the storage items metadata (including documentation) if set to true.
Response
successful operation
invalid blockId supplied for at query param
could not find resource with id
Authorization
api-keyAuthapiKey in headerGet information and metadata associated with a pool asset.
Returns information associated with a pool asset which includes the assets AssetDetails and AssetMetadata.
Parameters
assetIdstring<unsignedInteger>requiredpathThe unsignedInteger Id of a pool asset.
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the assetInfo.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet progress on the general Staking pallet system.
Returns information on the progress of key components of the staking system and estimates of future points of interest. Replaces /staking-info from versions < v1.0.0.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve a staking progress report.
Response
successful operation
invalid blockId supplied for at query param
Authorization
api-keyAuthapiKey in headerGet all validators (active/waiting) of a specific chain.
Returns a list of all validators addresses and their corresponding status which can be either active or waiting. 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".
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the list of validators.
Response
successful operation
invalid blockId supplied for at query param
Authorization
api-keyAuthapiKey in headerruntime
Runtime specification, metadata, and code
Runtime Wasm code
Returns the Wasm code blob of the Substrate runtime at a given block.
Parameters
atstringqueryBlock hash or number to query at
Response
Runtime code
Invalid block parameter
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRuntime metadata
Returns the decoded runtime metadata in JSON format.
Parameters
atstringqueryBlock hash or number to query at
Response
Runtime metadata
Invalid block parameter
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerAvailable metadata versions
Returns the available metadata versions at a given block.
Parameters
atstringqueryBlock hash or number to query at
Response
List of available metadata versions
Invalid block parameter
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRuntime metadata by version
Returns the metadata at a specific version. The version parameter should be in 'vX' format (e.g., 'v14', 'v15').
Parameters
versionstringrequiredpathMetadata version (e.g., 'v14', 'v15')
atstringqueryBlock hash or number to query at
Response
Runtime metadata at specified version
Invalid version format or block parameter
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRuntime specification
Returns the runtime specification including version, APIs, and chain properties.
Parameters
atstringqueryBlock hash or number to query at
Response
Runtime specification
Invalid block parameter
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet the runtime metadata in decoded, JSON form.
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
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the metadata at.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet the requested version of runtime metadata in decoded, JSON form.
Returns the requested version of 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
Parameters
metadataVersionstringrequiredpathThe version of metadata. The input is expected in a vX format, where X represents the version number (e.g. v14, v15).
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the metadata at.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet the available versions of runtime metadata.
Returns the available versions of runtime metadata. Substrate Reference: - FRAME Support: https://crates.parity.io/frame_support/metadata/index.html - Knowledge Base: https://substrate.dev/docs/en/knowledgebase/runtime/metadata
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the metadata versions at.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet the runtime wasm blob.
Returns the runtime Wasm blob in hex format.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the runtime wasm blob at.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet version information of the Substrate runtime.
Returns version information related to the runtime.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve runtime version information at.
Response
successful operation
Authorization
api-keyAuthapiKey in headertransaction
Transaction submission, fee estimation, and construction material
Submit transaction
Submit a signed extrinsic to the transaction pool.
Body
Signed extrinsic with 'tx' field containing hex-encoded transaction
Response
Transaction hash
Invalid transaction
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerDry run transaction
Dry run a transaction to check validity without submitting.
Body
Transaction with 'tx', 'senderAddress', and optional 'at' fields
Response
Dry run result
Invalid transaction
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerEstimate transaction fee
Estimate the fee for a transaction.
Body
Transaction with 'tx' field containing hex-encoded transaction
Response
Fee estimate
Invalid transaction
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerTransaction construction material
Returns network information needed for transaction construction including genesis hash, spec version, and optionally metadata.
Parameters
atstringqueryBlock hash or number to query at
noMetabooleanqueryDEPRECATED: If true, metadata is not included
metadatastringqueryMetadata format: 'json' or 'scale'
Response
Transaction material
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerTransaction material with versioned metadata
Returns transaction construction material with metadata at a specific version.
Parameters
metadataVersionstringrequiredpathMetadata version (e.g., 'v14', 'v15')
atstringqueryBlock hash or number to query at
noMetabooleanqueryDEPRECATED: If true, metadata is not included
metadatastringqueryMetadata format: 'json' or 'scale'
Response
Transaction material with versioned metadata
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGenerate metadata blob
Generates a metadata blob for transaction signing with the CheckMetadataHash extension.
Body
Request with 'tx' field and optional 'at' block
Response
Metadata blob
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerParse transaction
Decode a raw transaction and return its components without executing or submitting it. Returns the decoded pallet/method, call arguments, signature info, nonce, tip, era, and hash. Note: This endpoint uses the chain's current (latest) metadata for decoding. Transactions created for older runtime versions may fail to decode if the extrinsic format has changed.
Body
Transaction with 'tx' field containing hex-encoded extrinsic
Request body for transaction parsing.
txstringHex-encoded extrinsic with optional 0x prefix.
Response
Parsed transaction
Invalid transaction
Internal server error
Authorization
api-keyAuthapiKey in headerSubmit a transaction to the node's transaction pool.
Accepts a valid signed extrinsic. Replaces /tx from versions < v1.0.0.
Body
txstring<hex>Response
successful operation
failed to parse or submit transaction
Authorization
api-keyAuthapiKey in headerDry run an extrinsic.
Use the dryRun call to simulate the submission of a transaction without executing it so that you can check for potential errors and validate the expected outcome.
Body
atstring<unsignedInteger>txstring<hex>senderAddressstring<ss58>Response
successful operation
failed to dry-run transaction
Authorization
api-keyAuthapiKey in headerReceive a fee estimate for a transaction.
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
Body
txstring<hex>Response
successful operation
fee estimation failure
Authorization
api-keyAuthapiKey in headerGet all the network information needed to construct a transaction offline.
Returns the material that is universal to constructing any signed transaction offline. Replaces /tx/artifacts from versions < v1.0.0.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the transaction construction material.
noMetabooleanfalsequeryDEPRECATED! This is no longer supported
metadatastringquerySpecifies the format of the metadata to be returned. Accepted values are 'json', and 'scale'. 'json' being the decoded metadata, and 'scale' being the SCALE encoded metadata. When metadata is not inputted, the metadata field will be absent.
Response
successful operation
invalid blockId supplied for at query param
Authorization
api-keyAuthapiKey in headerGet all the network information needed to construct a transaction offline and the version of metadata specified in metadataVersion.
Returns all the materials necessary for constructing any signed transactions offline.
Parameters
metadataVersionstringrequiredpathThe version of metadata. The input is expected in a vX format, where X represents the version number (e.g. v14, v15). By default, metadata is outputted in 'json' format, unless the metadata query parameter is provided, in which case it can be either in 'json' or 'scale' format.
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the transaction construction material.
metadatastringquerySpecifies the format of the metadata to be returned. Accepted values are 'json', and 'scale'. 'json' being the decoded metadata, and 'scale' being the SCALE encoded metadata.
Response
successful operation
invalid blockId supplied for at query param
Authorization
api-keyAuthapiKey in headercoretime
Coretime system information
Get coretime info
Returns coretime chain status information including the last committed timeslice.
Parameters
atstringqueryBlock identifier (number or hash)
Response
Coretime info
Invalid block identifier
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet coretime leases
Returns all leases registered on a coretime chain with task IDs and validity timeslices.
Parameters
atstringqueryBlock identifier (number or hash)
Response
Coretime leases
Invalid block identifier
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet coretime overview
Returns an overview of all cores with assignments, queue state, workload, workplan, and regions.
Parameters
atstringqueryBlock identifier (number or hash)
Response
Coretime overview
Invalid block identifier
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet coretime regions
Returns all regions on a coretime chain including begin/end timeslices, core, owner, and mask.
Parameters
atstringqueryBlock identifier (number or hash)
Response
Coretime regions
Invalid block identifier
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet coretime potential renewals
Returns potential renewals on a coretime chain sorted by core index, including price, completion status, and task assignment.
Parameters
atstringqueryBlock identifier (number or hash)
Response
Coretime renewals
Invalid block identifier
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet coretime reservations
Returns all reservations on a coretime chain. Reserved cores are permanently allocated and not available for sale.
Parameters
atstringqueryBlock identifier (number or hash)
Response
Coretime reservations
Invalid block identifier
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet all the leases currently registered on coretime chain.
Parameters
blockIdstringqueryBlock identifier, as the block height or block hash.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet all the regions currently registered on coretime chain.
Parameters
blockIdstringqueryBlock identifier, as the block height or block hash.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet all the potential renewals currently registered on coretime chain.
Parameters
blockIdstringqueryBlock identifier, as the block height or block hash.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet all the reservations currently registered on coretime chain.
Parameters
blockIdstringqueryBlock identifier, as the block height or block hash.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet the generic information about coretime, either on coretime chain or relay chain.
Parameters
blockIdstringqueryBlock identifier, as the block height or block hash.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet all the cores information either on coretime chain or relay chain.
Parameters
blockIdstringqueryBlock identifier, as the block height or block hash.
Response
successful operation
Authorization
api-keyAuthapiKey in headerparas
Parachain inclusion data
Parachain inclusion data
Returns inclusion information for a given parachain block, searching relay chain blocks for when the parachain block was included.
Parameters
numberstringrequiredpathParachain block number
depthstringquerySearch depth for relay chain blocks (max 100, default 10, must be divisible by 5)
Response
Parachain inclusion information
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in header[DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] List all registered paras (parathreads & parachains).
Returns all registered parachains and parathreads with lifecycle info.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve paras list at.
Response
successful operation
Authorization
api-keyAuthapiKey in header[DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] Get general information about the current lease period.
Returns an overview of the current lease period, including lease holders.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve current lease period info at.
currentLeaseHoldersbooleantruequeryWether or not to include the currentLeaseHolders property. Inclusion
of the property will likely result in a larger payload and increased
response time.
Response
successful operation
Authorization
api-keyAuthapiKey in header[DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] Get the status of the current auction.
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.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve auction progress at.
Response
successful operation
Authorization
api-keyAuthapiKey in header[DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] List all stored crowdloans.
Returns a list of all the crowdloans and their associated paraIds.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the list of paraIds that have crowdloans at.
Response
successful operation
Authorization
api-keyAuthapiKey in header[DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] Get crowdloan information for a paraId.
Returns crowdloan's fundInfo and the set of leasePeriods the crowdloan`
covers.
Parameters
paraIdnumberrequiredpathparaId to query the crowdloan information of.
atstring<unsignedInteger or $hex>queryBlock at which to retrieve info at.
Response
successful operation
Authorization
api-keyAuthapiKey in header[DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] Get current and future leases as well as the lifecycle stage for a given paraId.
Returns a list of leases that belong to the paraId as well as the
paraId's current lifecycle stage.
Parameters
paraIdnumberrequiredpathparaId to query the crowdloan information of.
atstring<unsignedInteger or $hex>queryBlock at which to retrieve para's leases at.
Response
successful operation
Authorization
api-keyAuthapiKey in header[DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] Get the heads of the included (backed and considered available) parachain candidates at the specified block height or at the most recent finalized head otherwise.
Returns an object with all the parachain id's as keys, and their headers as values.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve para's heads at.
Response
successful operation
Authorization
api-keyAuthapiKey in header[DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] Get the heads of the backed parachain candidates at the specified block height or at the most recent finalized head otherwise.
Returns an object with all the parachain id's as keys, and their headers as values.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve para's heads at.
Response
successful operation
Authorization
api-keyAuthapiKey in headerahm
Asset Hub Migration information
Asset Hub Migration info
Returns information about the Asset Hub migration, including start and end blocks for both relay chain and Asset Hub.
Response
AHM migration boundaries
No migration data available
Authorization
api-keyAuthapiKey in headercapabilities
API capabilities and chain pallets
API capabilities
Returns the chain name and list of available pallets in the runtime metadata.
Parameters
atstringqueryBlock hash or number to query at
Response
Chain capabilities
Invalid block parameter
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerrc
Relay chain endpoints (available on parachains only)
RC get balance info
Returns balance information for a given account on the relay chain.
Parameters
accountIdstringrequiredpathSS58-encoded account address
atstringqueryBlock identifier (number or hash)
tokenstringqueryToken symbol (defaults to native token)
denominatedbooleanqueryDenominate balances using chain decimals
Response
Balance information
Invalid account address
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get proxy info
Returns proxy information for a given account on the relay chain.
Parameters
accountIdstringrequiredpathSS58-encoded account address
atstringqueryBlock identifier (number or hash)
Response
Proxy information
Invalid account address
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get staking info
Returns staking information for a given stash account on the relay chain.
Parameters
accountIdstringrequiredpathSS58-encoded stash account address
atstringqueryBlock identifier (number or hash)
includeClaimedRewardsbooleanqueryWhen true, include claimed rewards in the response
Response
Staking information
Invalid account address
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get staking payouts
Returns staking payout information for a given account on the relay chain.
Parameters
accountIdstringrequiredpathSS58-encoded account address
atstringqueryBlock identifier (number or hash)
depthinteger<int32>>= 0queryNumber of eras to query (default: 1)
erainteger<int32>>= 0queryThe era to query at (default: active_era - 1)
unclaimedOnlybooleanqueryOnly show unclaimed rewards (default: true)
Response
Staking payouts
Invalid account address
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get vesting info
Returns vesting information for a given account on the relay chain.
Parameters
accountIdstringrequiredpathSS58-encoded account address
atstringqueryBlock identifier (number or hash)
Response
Vesting information
Invalid account address
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get blocks by range
Returns relay chain blocks within a specified range (max 500 blocks).
Parameters
rangestringqueryBlock range (e.g., '100-200')
eventDocsbooleanqueryInclude event documentation
extrinsicDocsbooleanqueryInclude extrinsic documentation
noFeesbooleanquerySkip fee calculation
decodedXcmMsgsbooleanqueryDecode and include XCM messages
paraIdinteger<int32>>= 0queryFilter XCM messages by parachain ID
Response
Relay chain blocks
Invalid range or missing parameter
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get head block
Returns the latest block on the relay chain.
Parameters
finalizedbooleanqueryWhen true returns finalized head (default: true)
eventDocsbooleanqueryInclude event documentation
extrinsicDocsbooleanqueryInclude extrinsic documentation
noFeesbooleanquerySkip fee calculation
decodedXcmMsgsbooleanqueryDecode and include XCM messages
paraIdinteger<int32>>= 0queryFilter XCM messages by parachain ID
Response
Relay chain head block
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get head block header
Returns the header of the latest relay chain block.
Parameters
finalizedbooleanqueryWhen true returns finalized head (default: true)
Response
Relay chain head block header
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get block by ID
Returns relay chain block information for a given block identifier.
Parameters
blockIdstringrequiredpathBlock height number or block hash
eventDocsbooleanqueryInclude event documentation
extrinsicDocsbooleanqueryInclude extrinsic documentation
noFeesbooleanquerySkip fee calculation
decodedXcmMsgsbooleanqueryInclude decoded XCM messages
paraIdinteger<int32>>= 0queryFilter XCM messages by parachain ID
Response
Relay chain block information
Invalid block identifier
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get raw extrinsics
Returns raw hex-encoded extrinsics for a relay chain block without decoding.
Parameters
blockIdstringrequiredpathBlock height number or block hash
Response
Raw extrinsics
Invalid block identifier
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get extrinsic by index
Returns a specific extrinsic from a relay chain block by its index.
Parameters
blockIdstringrequiredpathBlock height number or block hash
extrinsicIndexstringrequiredpathIndex of the extrinsic in the block
eventDocsbooleanqueryInclude event documentation
extrinsicDocsbooleanqueryInclude extrinsic documentation
noFeesbooleanquerySkip fee calculation
Response
Extrinsic details
Invalid block ID or extrinsic index
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get block header
Returns the header of a relay chain block by block hash or block number.
Parameters
blockIdstringrequiredpathBlock height number or block hash
Response
Relay chain block header
Invalid block identifier
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get parachain inclusions
Returns parachain inclusion information for a given relay chain block.
Parameters
blockIdstringrequiredpathBlock height number or block hash
paraIdinteger<int32>>= 0queryFilter by parachain ID
Response
Parachain inclusions
Invalid block identifier
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get node network
Returns the relay chain node's network information.
Response
Relay chain node network info
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get transaction pool
Returns the relay chain's transaction pool with optional fee information.
Parameters
includeFeebooleanqueryInclude fee information for each transaction (default: false)
Response
Relay chain transaction pool
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get node version
Returns the relay chain node's version information.
Response
Relay chain node version
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC on-going referenda
Returns all currently active referenda from the relay chain's Referenda pallet.
Parameters
atstringqueryBlock hash or number to query at
Response
Active referenda from relay chain
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC staking progress
Returns staking progress from the relay chain.
Parameters
atstringqueryBlock hash or number to query at
Response
Relay chain staking progress
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC staking validators
Returns the list of active validators from the relay chain.
Parameters
atstringqueryBlock hash or number to query at
Response
Relay chain validator information
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC pallet constants
Returns all constants defined in a relay chain pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
atstringqueryBlock hash or number to query at
onlyIdsbooleanqueryOnly return constant names
Response
Relay chain pallet constants
Invalid pallet
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC pallet constant value
Returns the value and metadata of a specific constant from a relay chain pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
constantItemIdstringrequiredpathName of the constant
atstringqueryBlock hash or number to query at
metadatabooleanqueryInclude metadata
Response
Relay chain constant value
Constant not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC pallet dispatchables
Returns the dispatchable calls defined in a relay chain pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
atstringqueryBlock hash or number to query at
onlyIdsbooleanqueryOnly return dispatchable names
Response
Relay chain pallet dispatchables
Invalid pallet
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC pallet dispatchable details
Returns a single dispatchable call from a relay chain pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
dispatchableIdstringrequiredpathName of the dispatchable
atstringqueryBlock hash or number to query at
metadatabooleanqueryInclude metadata
Response
Relay chain dispatchable details
Dispatchable not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC pallet errors
Returns all errors defined in a relay chain pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
atstringqueryBlock hash or number to query at
onlyIdsbooleanqueryOnly return error names
Response
Relay chain pallet errors
Invalid pallet
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC pallet error details
Returns metadata for a specific error in a relay chain pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
errorItemIdstringrequiredpathName of the error
atstringqueryBlock hash or number to query at
metadatabooleanqueryInclude metadata
Response
Relay chain error details
Error not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC pallet events
Returns all events defined in a relay chain pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
atstringqueryBlock hash or number to query at
onlyIdsbooleanqueryOnly return event names
Response
Relay chain pallet events
Invalid pallet
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC pallet event details
Returns metadata for a specific event in a relay chain pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
eventItemIdstringrequiredpathEvent name
atstringqueryBlock hash or number to query at
metadatabooleanqueryInclude full event metadata
Response
Relay chain event details
Pallet or event not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC pallet storage items
Returns the list of storage items for a relay chain pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
atstringqueryBlock hash or number to query at
onlyIdsbooleanqueryOnly return storage item names
Response
Relay chain pallet storage items
Invalid pallet or parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC pallet storage item value
Returns the value of a specific storage item from a relay chain pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
storageItemIdstringrequiredpathName of the storage item
atstringqueryBlock hash or number to query at
keys[]Array<string>queryStorage key arguments
metadatabooleanqueryInclude metadata for the storage item
Response
Relay chain storage item value
Invalid parameters
Storage item not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC get runtime code
Returns the Wasm code blob of the relay chain runtime at a given block.
Parameters
atstringqueryBlock identifier (number or hash)
Response
Relay chain runtime code
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get runtime metadata
Returns the decoded runtime metadata of the relay chain in JSON format.
Parameters
atstringqueryBlock identifier (number or hash)
Response
Relay chain runtime metadata
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get metadata versions
Returns the available metadata versions on the relay chain at a given block.
Parameters
atstringqueryBlock identifier (number or hash)
Response
Available metadata versions
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get metadata by version
Returns the relay chain metadata at a specific version (e.g., v14, v15).
Parameters
versionstringrequiredpathMetadata version in 'vX' format (e.g., v14, v15)
atstringqueryBlock identifier (number or hash)
Response
Relay chain metadata at specified version
Invalid version format
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get runtime spec
Returns the runtime spec of the relay chain at a given block.
Parameters
atstringqueryBlock identifier (number or hash)
Response
Relay chain runtime spec
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerSubmit transaction (relay chain)
Submit a signed extrinsic to the relay chain transaction pool. Only available on parachains.
Body
Signed extrinsic with 'tx' field containing hex-encoded transaction
Response
Transaction hash
Invalid transaction
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC dry run transaction
Dry run a transaction on the relay chain.
Body
Transaction with 'tx', 'senderAddress', and optional 'at' fields
Response
Dry run result
Invalid transaction
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC fee estimate
Estimate the fee for a relay chain transaction.
Body
Transaction with 'tx' field
Response
Fee estimate
Invalid transaction
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC transaction material
Returns relay chain network information for transaction construction.
Parameters
atstringqueryBlock hash or number to query at
noMetabooleanqueryDEPRECATED: If true, metadata is not included
metadatastringqueryMetadata format: 'json' or 'scale'
Response
Relay chain transaction material
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC transaction material versioned
Returns relay chain transaction material with metadata at a specific version.
Parameters
metadataVersionstringrequiredpathMetadata version (e.g., 'v14', 'v15')
atstringqueryBlock hash or number to query at
noMetabooleanqueryDEPRECATED: If true, metadata is not included
metadatastringqueryMetadata format: 'json' or 'scale'
Response
Relay chain transaction material with versioned metadata
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC metadata blob
Generates a metadata blob from the relay chain for transaction signing.
Body
Request with 'tx' field and optional 'at' block
Response
Metadata blob
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerParse transaction (relay chain)
Decode a raw transaction using relay chain metadata. Only available on parachains. Returns the decoded pallet/method, call arguments, signature info, nonce, tip, era, and hash. Note: This endpoint uses the relay chain's current (latest) metadata for decoding. Transactions created for older runtime versions may fail to decode if the extrinsic format has changed.
Body
Transaction with 'tx' field containing hex-encoded extrinsic
Request body for transaction parsing.
txstringHex-encoded extrinsic with optional 0x prefix.
Response
Parsed transaction
Invalid transaction or relay chain not configured
Internal server error
Relay chain unavailable
Authorization
api-keyAuthapiKey in headercontracts
Query an !Ink contract with a given message (method).
Will return a valid or invalid result.
Body
Metadata used to instantiate a ContractPromise. This metadata can be generated by compiling the contract you are querying.
Parameters
addressstringrequiredpathSS58 or Hex address of the account associated with the contract.
methodstringgetqueryThe message or method used to query.
gasLimitnumber-1queryThe gas limit to be used as an option for the queried message.
storageDepositLimitnumbernullqueryThe storage deposit limit to be used as an option for the queried message.
argsArray<string>queryAbi params used as args specified in the metadata to be passed into a query. The format to use this query param is ?args[]=1&args[]=2&args[]=3.
Response
succesful operation
Invalid Method
Authorization
api-keyAuthapiKey in headertrace
[Experimental - subject to breaking change.] Get traces for the most recently finalized block.
Returns traces (spans and events) of the most recently finalized block from
RPC state_straceBlock. Consult the RPC docs
for conceptual info.
Response
successful operation
Authorization
api-keyAuthapiKey in header[Experimental - subject to breaking change.] Get traces for the given blockId.
Returns traces (spans and events) of the specified block from
RPC state_straceBlock. Consult the RPC docs for conceptual info.
Parameters
blockIdstringrequiredpathBlock identifier, as the block height or block hash.
Response
successful operation
Authorization
api-keyAuthapiKey in header[Experimental - subject to breaking change.] Get the operations from the most recently finalized block.
Returns the operations from the most recently finalized block. Operations represent one side of a balance change. For example if Alice transfers 100unit to Bob there will be two operations; 1) Alice - 100 2) Bob + 100.
Given account A and A's balance at block k0 (Ak0), if we sum all the operations for A from block k1 through kn against Ak0, we will end up with A's balance at block kn (Akn). Thus, operations can be used to audit that balances change as expected.
This is useful for Substrate based chains because the advanced business logic can make it difficult to ensure auditable balance reconciliation based purely on events. Instead of using events one can use the operations given from this endpoint.
Note - each operation corresponds to a delta of a single field of the
system::AccountData storage item (i.e free, reserved, misc_frozen
and fee_frozen).
Note - operations are assigned a block execution phase (and extrinsic index
for those in the apply extrinsic phase) based on an "action group". For
example all the operations for 1 extrinsic will be in the same action group.
The action groups can optionally be fetched with the action query param
for closer auditing.
Note - There are no 0 value operations (e.g. a transfer of 0, or a
transfer to itself)
To learn more about operation and action group creation please consult this diagram
Parameters
actionsbooleanfalsequeryWhether or not to include action groups.
Response
successful operation
Authorization
api-keyAuthapiKey in header[Experimental - subject to breaking change.] Get the operations from the specified block.
Returns the operations from the most recently finalized block. Operations represent one side of a balance change. For example if Alice transfers 100unit to Bob there will be two operations; 1) Alice - 100 2) Bob + 100.
Given account A and A's balance at block k0 (Ak0), if we sum all the operations for A from block k1 through kn against Ak0, we will end up with A's balance at block kn (Akn). Thus, operations can be used to audit that balances change as expected.
This is useful for Substrate based chains because the advanced business logic can make it difficult to ensure auditable balance reconciliation based purely on events. Instead of using events one can use the operations given from this endpoint.
Note - each operation corresponds to a delta of a single field of the
system::AccountData storage item (i.e free, reserved, misc_frozen
and fee_frozen).
Note - operations are assigned a block execution phase (and extrinsic index
for those in the apply extrinsic phase) based on an "action group". For
example all the operations for 1 extrinsic will be in the same action group.
The action groups can optionally be fetched with the action query param
for closer auditing.
Note - There are no 0 value operations (e.g. a transfer of 0, or a
transfer to itself)
To learn more about operation and action group creation please consult this diagram
Parameters
blockIdstringrequiredpathBlock identifier, as the block height or block hash.
actionsbooleanfalsequeryWhether or not to include action groups.
Response
successful operation
Authorization
api-keyAuthapiKey in headerstaking
Get staking information for a Stash account.
Returns information about a Stash account's staking activity. Replaces /staking/{address} from versions < v1.0.0. The Stash account can be either a validator or nominator account.
Parameters
accountIdstring<SS58>requiredpathSS58 address of the account. Must be a Stash account.
atstring<unsignedInteger or $hex>queryBlock at which to query the staking info for the specified account.
includeClaimedRewardsstring<boolean>truequeryWhen set to false, the claimedRewards field is not included in the response.
Response
successful operation
invalid blockId supplied for at query param
account not found
Authorization
api-keyAuthapiKey in headerGet payout information for a Stash account.
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.
Parameters
accountIdstring<SS58>requiredpathSS58 address of the account. Must be a Stash account.
atstring<unsignedInteger or $hex>queryBlock at which to query staking payouts.
depthstring<unsignedInteger>1queryThe 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.
erastring<unsignedInteger>`active_era - 1`queryThe era to query at.
unclaimedOnlystring<boolean>truequeryOnly return unclaimed rewards.
Response
successful operation
invalid blockId supplied for at query param
account not found
Authorization
api-keyAuthapiKey in headerGet progress on the general Staking pallet system.
Returns information on the progress of key components of the staking system and estimates of future points of interest. Replaces /staking-info from versions < v1.0.0.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve a staking progress report.
Response
successful operation
invalid blockId supplied for at query param
Authorization
api-keyAuthapiKey in headerGet all validators (active/waiting) of a specific chain.
Returns a list of all validators addresses and their corresponding status which can be either active or waiting. 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".
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the list of validators.
Response
successful operation
invalid blockId supplied for at query param
Authorization
api-keyAuthapiKey in headerNODE
chain
Get the hash of the last finalized block
Returns the hash of the block that was finalized on the chain.
Body
JSON-RPC request parameters
jsonrpcstringrequiredJSON-RPC version
idstringrequiredRequest identifier
methodstringrequiredMethod name
paramsArray<any>requiredMethod parameters (empty array)
Response
Hash of the last finalized block
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerGet block by hash
Returns full information of a block, including header, extrinsics, and digest.
Body
JSON-RPC request parameters
jsonrpcstringrequiredJSON-RPC version
idstringrequiredRequest identifier
methodstringrequiredMethod name
paramsArray<string>requiredArray containing block hash to retrieve
Response
Full block details
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerGet block hash by block number
Returns the block hash using the block number in the chain.
Body
JSON-RPC request parameters
jsonrpcstringrequiredJSON-RPC version
idstringrequiredRequest identifier
methodstringrequiredMethod name
paramsArray<integer>requiredArray containing block number
Response
Block hash by block number
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerpayment
Retrieve fee information for an encoded extrinsic
Returns detailed fee information (weight, partial fee, etc.) for a given encoded extrinsic.
Body
JSON-RPC request containing encoded extrinsic
jsonrpcstringrequiredJSON-RPC version
idstringrequiredRequest identifier
methodstringrequiredMethod name
paramsArray<string>requiredArray containing encoded extrinsic(s) to query fee info for
Response
Fee information for the extrinsic
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerstate
Retrieve storage for a given key
Returns the value stored under a specific key at the latest block or a given block.
Body
JSON-RPC request parameters
jsonrpcstringrequiredJSON-RPC version
idstringrequiredRequest identifier
methodstringrequiredMethod name
paramsArray<string>requiredArray containing storage keys
Response
Returns the value stored at the specified key
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerGet the runtime version
Returns version information about the runtime, including spec version, implementation version, and transaction version.
Body
JSON-RPC request parameters
jsonrpcstringrequiredJSON-RPC version
idstringrequiredRequest identifier
methodstringrequiredMethod name
paramsArray<any>requiredNo parameters required
Response
Runtime version information
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerRetrieve runtime metadata
Returns the runtime metadata, which includes information about modules, calls, storage, and events.
Body
JSON-RPC request parameters
jsonrpcstringrequiredJSON-RPC version
idstringrequiredRequest identifier
methodstringrequiredMethod name
paramsArray<any>requiredNo parameters required
Response
Runtime metadata in hex format
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerReturns proof of storage entries at a specific block state
Provides a cryptographic proof for the existence and content of storage entries at a given block.
Body
JSON-RPC request parameters
jsonrpcstringrequiredJSON-RPC version
idstringrequiredRequest identifier
methodstringrequiredMethod name
paramsArray<any>requiredList of storage keys for which to generate proof
Response
Proof of storage entries
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerRetrieves the storage hash
Returns the hash of the storage value stored under a specific key.
Body
JSON-RPC request parameters
jsonrpcstringrequiredidstringrequiredmethodstringrequiredparamsArray<any>requiredStorage key(s) to compute hash
Response
Storage hash result
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerRetrieves the storage size
Returns the size in bytes of the storage value under a specific key.
Body
JSON-RPC request parameters
jsonrpcstringrequiredidstringrequiredmethodstringrequiredparamsArray<any>requiredStorage key(s) to measure
Response
Storage size result
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerQuery historical storage entries
Returns the storage changes between two blocks for a set of keys.
Body
JSON-RPC request parameters
jsonrpcstringrequiredidstringrequiredmethodstringrequiredparamsArray<any>requiredList of storage keys and block range
Response
Query storage result
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerQuery storage entries at a specific block
Returns the storage values for given keys at a specified block hash.
Body
JSON-RPC request parameters
jsonrpcstringrequiredidstringrequiredmethodstringrequiredparamsArray<any>requiredList of storage keys and block hash
Response
Storage entries at block
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headersystem
Retrieve the name of the chain
Returns the network name (e.g., Kusama, Polkadot) the node is connected to.
Body
JSON-RPC request to get chain name
jsonrpcstringrequiredJSON-RPC version
idstringrequiredRequest identifier
methodstringrequiredMethod name
paramsArray<any>requiredShould be empty for this method
Response
Chain name
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerRetrieve custom properties from chain spec
Returns chain-specific properties such as token symbol, decimals, and address format.
Body
JSON-RPC request to get system properties
jsonrpcstringrequiredJSON-RPC version
idstringrequiredRequest identifier
methodstringrequiredMethod name
paramsArray<any>requiredShould be empty for this method
Response
System properties of the chain
Malformed address or application ID
Invalid API key
Internal server error
Authorization
api-keyAuthapiKey in headerhealth
Health check
Health check
Returns the health status of the API server.
Response
API is healthy
Authorization
api-keyAuthapiKey in headernode
Connected node information
Node network info
Returns the node's network information including peer count, syncing status, and local peer ID.
Response
Node network information
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerTransaction pool
Returns the node's transaction pool with optional fee information.
Parameters
includeFeebooleanqueryInclude fee details for each transaction
Response
Transaction pool entries
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerNode version
Returns the node's version information including client version, implementation name, and chain name.
Response
Node version information
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet information about the Substrate node's activity in the peer-to-peer network.
Returns network related information of the node.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet pending extrinsics from the Substrate node.
Returns the extrinsics that the node knows of that have not been included in a block.
Parameters
includeFeebooleanfalsequeryBoolean representing whether or not to include tips, partialFee, and priority in each extrinsic.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet information about the Substrates node's implementation and versioning.
Returns versioning information of the node.
Response
successful operation
Authorization
api-keyAuthapiKey in headerversion
API version
API version
Returns the current version of the Polkadot REST API.
Response
API version
Authorization
api-keyAuthapiKey in headerblocks
Block queries and extrinsic data
Get blocks by range
Returns a collection of blocks given a numeric range. Range is inclusive and limited to 500 blocks.
Parameters
rangestringqueryBlock range in format 'start-end' (e.g. '100-200')
eventDocsbooleanqueryInclude documentation for events
extrinsicDocsbooleanqueryInclude documentation for extrinsics
noFeesbooleanquerySkip fee calculation for extrinsics
useRcBlockbooleanqueryTreat range as Relay Chain blocks
useEvmFormatbooleanqueryConvert AccountId32 addresses to EVM format for revive pallet events
Response
Array of block information
Invalid range parameter
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet latest block
Returns the latest finalized or canonical block with full extrinsic and event details.
Parameters
finalizedbooleanqueryWhen true (default), returns finalized head. When false, returns canonical head.
eventDocsbooleanqueryInclude documentation for events
extrinsicDocsbooleanqueryInclude documentation for extrinsics
noFeesbooleanquerySkip fee calculation for extrinsics
decodedXcmMsgsbooleanqueryDecode and include XCM messages
paraIdinteger<int32>>= 0queryFilter XCM messages by parachain ID
useRcBlockbooleanqueryWhen true, use relay chain head to find corresponding Asset Hub blocks
useEvmFormatbooleanqueryConvert AccountId32 addresses to EVM format for revive pallet events
Response
Latest block information
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet head block header
Returns the header of the latest finalized or canonical block (lightweight, no extrinsics/events).
Parameters
finalizedbooleanqueryWhen true (default), returns finalized head header. When false, returns canonical head header.
useRcBlockbooleanqueryTreat as Relay Chain block and return Asset Hub blocks
Response
Block header information
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet block by ID
Returns block information for a given block identifier (hash or number), including extrinsics, events, and fees.
Parameters
blockIdstringrequiredpathBlock height number or block hash
eventDocsbooleanqueryInclude documentation for events
extrinsicDocsbooleanqueryInclude documentation for extrinsics
noFeesbooleanquerySkip fee calculation for extrinsics
finalizedKeybooleanqueryWhen true (default), include finalized status in response
decodedXcmMsgsbooleanqueryDecode and include XCM messages
paraIdinteger<int32>>= 0queryFilter XCM messages by parachain ID
useRcBlockbooleanqueryTreat blockId as Relay Chain block and return Asset Hub blocks
useEvmFormatbooleanqueryConvert AccountId32 addresses to EVM format for revive pallet events
Response
Block information
Invalid block identifier
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet raw extrinsics
Returns raw block data with hex-encoded extrinsics for a given block identifier. The extrinsics are returned as raw hex strings without decoding.
Parameters
blockIdstringrequiredpathBlock height number or block hash
useRcBlockbooleanqueryWhen true, treat blockId as Relay Chain block and return Asset Hub blocks
Response
Raw block data with hex-encoded extrinsics
Invalid block identifier
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet extrinsic by index
Returns a specific extrinsic from a block by its index within the block.
Parameters
blockIdstringrequiredpathBlock height number or block hash
extrinsicIndexstringrequiredpathIndex of the extrinsic within the block
eventDocsbooleanqueryInclude documentation for events
extrinsicDocsbooleanqueryInclude documentation for extrinsics
noFeesbooleanquerySkip fee calculation
useRcBlockbooleanqueryWhen true, treat blockId as Relay Chain block and return Asset Hub extrinsics
useEvmFormatbooleanqueryConvert AccountId32 addresses to EVM format for revive pallet events
Response
Extrinsic details
Invalid block identifier or extrinsic index
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet block header by ID
Returns the header of the specified block (lightweight, no extrinsics/events).
Parameters
blockIdstringrequiredpathBlock height number or block hash
useRcBlockbooleanqueryTreat blockId as Relay Chain block and return Asset Hub blocks
Response
Block header information
Invalid block identifier
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet parachain inclusions
Returns parachain inclusion information for a given relay chain block. Extracts CandidateIncluded events from the ParaInclusion pallet.
Parameters
blockIdstringrequiredpathBlock height number or block hash
paraIdinteger<int32>>= 0queryFilter results by a specific parachain ID
Response
Parachain inclusion information
Invalid block identifier
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet a range of blocks by their height.
Given a range query parameter return an array of all the blocks within that range.
Parameters
rangestringrequiredqueryA range of integers. There is a max limit of 500 blocks per request.
eventDocsbooleanfalsequeryWhen set to true, every event will have an extra docs property with a string of the events documentation.
extrinsicDocsbooleanfalsequeryWhen set to true, every extrinsic will have an extra docs property with a string of the extrinsics documentation.
noFeesbooleanfalsequeryWhen set to true, the fee won't be calculated for the extrinsics.
Response
successful operation
invalid Block identifier supplied
Authorization
api-keyAuthapiKey in headerGet a block by its height or hash.
Returns a single block. BlockId can either be a block hash or a block height. Replaces /block/{number} from versions < v1.0.0.
Parameters
blockIdstringrequiredpathBlock identifier, as the block height or block hash.
eventDocsbooleanfalsequeryWhen set to true, every event will have an extra docs property with a string of the events documentation.
extrinsicDocsbooleanfalsequeryWhen set to true, every extrinsic will have an extra docs property with a string of the extrinsics documentation.
noFeesbooleanfalsequeryWhen set to true, the fee won't be calculated for the extrinsics.
finalizedKeybooleanqueryWhen set to false, this will override the chain-config, and omit the finalized key in the response. This can increase performance slightly by avoiding an additional RPC call to the node.
decodedXcmMsgsbooleanfalsequeryWhen set to true, this will show the decoded XCM messages within the extrinsics of the requested block.
paraIdstringqueryWhen it is set, this will return only the decoded XCM messages for the specified origin Parachain Id (originParaId). To activate this functionality, ensure that the decodedXcmMsgs parameter is set to true.
Response
successful operation
invalid Block identifier supplied
Authorization
api-keyAuthapiKey in headerGet a block's header by its height or hash.
Returns a single block's header. BlockId can either be a block hash or a block height.
Parameters
blockIdstringrequiredpathBlock identifier, as the block height or block hash.
Response
successful operation
invalid Block identifier supplied
Authorization
api-keyAuthapiKey in headerGet an extrinsic by its extrinsicIndex and block height or hash. The pair blockId, extrinsicIndex is sometimes referred to as a Timepoint.
Returns a single extrinsic.
Parameters
blockIdstringrequiredpathBlock identifier, as the block height or block hash.
extrinsicIndexstringrequiredpathThe extrinsic's index within the block's body.
eventDocsbooleanfalsequeryWhen set to true, every event will have an extra docs property with a string of the events documentation.
extrinsicDocsbooleanfalsequeryWhen set to true, every extrinsic will have an extra docs property with a string of the extrinsics documentation.
Response
successful operation
Requested extrinsicIndex does not exist
Authorization
api-keyAuthapiKey in headerGet the most recently finalized block.
Returns the most recently finalized block. Replaces /block from versions < v1.0.0.
Parameters
finalizedbooleantruequeryBoolean 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.
eventDocsbooleanfalsequeryWhen set to true, every event will have an extra docs property with a string of the events documentation.
extrinsicDocsbooleanfalsequeryWhen set to true, every extrinsic will have an extra docs property with a string of the extrinsics documentation.
noFeesbooleanfalsequeryWhen set to true, the fee won't be calculated for the extrinsics.
decodedXcmMsgsbooleanfalsequeryWhen set to true, this will show the decoded XCM messages within the extrinsics of the requested block.
paraIdstringqueryWhen it is set, this will return only the decoded XCM messages for the specified origin Parachain Id (originParaId). To activate this functionality, ensure that the decodedXcmMsgs parameter is set to true.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet information about the header of the most recent finalized block.
Returns the most recently finalized block's header.
Parameters
finalizedbooleantruequeryBoolean 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.
Response
successful operation
invalid Block identifier supplied
Authorization
api-keyAuthapiKey in headerGet a blocks header & its extrinsics as hex values.
Returns a block & its extrinsics as hex values. BlockId can either be a block hash or a block height.
Parameters
blockIdstringrequiredpathBlock identifier, as the block height or block hash.
Response
successful operation
invalid Block identifier supplied
Authorization
api-keyAuthapiKey in headeraccounts
Account balance, staking, and proxy information
Compare account addresses
Compares multiple SS58 addresses to determine if they have the same underlying public key.
Parameters
addressesstringrequiredqueryComma-separated list of SS58 addresses to compare (max 30)
Response
Comparison result
Invalid parameters
Authorization
api-keyAuthapiKey in headerAccount asset approvals
Returns asset approval information for a given account, asset, and delegate.
Parameters
accountIdstringrequiredpathSS58-encoded account address
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
assetIdstringrequiredqueryThe asset ID to query approval for
delegatestringrequiredqueryThe delegate address with spending approval
Response
Asset approval information
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerAccount asset balances
Returns asset balances for a given account on Asset Hub chains.
Parameters
accountIdstringrequiredpathSS58-encoded account address
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
assetsstringqueryComma-separated list of asset IDs to query
showEmptybooleanqueryWhen true, include assets with zero balance (default: false)
Response
Account asset balances
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerAccount balance info
Returns balance information for a given account including free, reserved, and locked balances.
Parameters
accountIdstringrequiredpathSS58-encoded account address
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
tokenstringqueryToken symbol for chains with multiple tokens
denominatedbooleanqueryWhen true, denominate balances using chain decimals
Response
Account balance information
Invalid account or block parameter
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerConvert account format
Converts an account address between different SS58 formats and key types.
Parameters
accountIdstringrequiredpathSS58-encoded account address or hex public key
schemestringqueryCryptographic scheme: ed25519, sr25519, or ecdsa (default: sr25519)
prefixinteger<int32>>= 0querySS58 prefix number (default: 42)
publicKeybooleanqueryIf true, treat input as a public key
Response
Converted account information
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerAccount foreign asset balances
Returns foreign asset balances for a given account on Asset Hub chains. Foreign assets use XCM MultiLocation as their identifier.
Parameters
accountIdstringrequiredpathSS58-encoded account address
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
foreignAssetsArray<string>queryList of multilocation JSON strings to filter by
showEmptybooleanqueryWhen true, include assets with zero balance (default: false)
Response
Foreign asset balances
Invalid account or parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerAccount pool asset approvals
Returns pool asset approval information for a given account, asset, and delegate.
Parameters
accountIdstringrequiredpathSS58-encoded account address
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
assetIdstringrequiredqueryThe pool asset ID to query approval for
delegatestringrequiredqueryThe delegate address with spending approval
Response
Pool asset approval information
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerAccount pool asset balances
Returns pool asset balances for a given account.
Parameters
accountIdstringrequiredpathSS58-encoded account address
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
assetsstringqueryComma-separated list of pool asset IDs to query
showEmptybooleanqueryWhen true, include assets with zero balance (default: false)
Response
Pool asset balances
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerAccount proxy info
Returns proxy information for a given account including delegated proxies and their types.
Parameters
accountIdstringrequiredpathSS58-encoded account address
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Proxy information
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerAccount staking info
Returns staking information for a given stash account including bonded amount, controller, and nominations.
Parameters
accountIdstringrequiredpathSS58-encoded stash account address
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
includeClaimedRewardsbooleanqueryWhen true, include claimed rewards in the response
Response
Staking information
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerAccount staking payouts
Returns staking payout history for a given account including era rewards and claimed status.
Parameters
accountIdstringrequiredpathSS58-encoded stash account address
atstringqueryBlock hash or number to query at
depthstringqueryNumber of eras to query (default: 1)
erastringqueryThe era to query at (default: active_era - 1)
unclaimedOnlybooleanqueryOnly show unclaimed rewards (default: true)
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Staking payout information
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerValidate account address
Validates an SS58-encoded account address and returns details about its format.
Parameters
accountIdstringrequiredpathSS58-encoded account address to validate
atstringqueryBlock hash or number (accepted for API consistency)
Response
Validation result
Authorization
api-keyAuthapiKey in headerAccount vesting info
Returns vesting information for a given account including vesting schedules and locked amounts.
Parameters
accountIdstringrequiredpathSS58-encoded account address
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
includeClaimablebooleanqueryWhen true, calculate vested amounts
Response
Vesting information
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet an array of asset-balances for an account.
Returns information about an account's asset-balances. This is specific to the assets pallet for parachains. If no assets query parameter is provided, all asset-balances for the given account will be returned.
Parameters
accountIdstring<SS58>requiredpathSS58 address of the account.
atstring<unsignedInteger or $hex>queryBlock at which to query asset-balance info for the specified account.
assetsArray<string><Array of unsignedInteger's>queryAn array of AssetId's to be queried. If not supplied, defaults to providing all asset balances associated with the accountId will be returned. The array query param format follows Express 4.x API. ex:?assets[]=1&assets[]=2&assets[]=3.
Response
successfull operation
Invalid Address
Authorization
api-keyAuthapiKey in headerGet an asset approval for an account.
Returns information about an account's asset approval transaction. It is required to pass in a delegate and an assetId as query parameters.
Parameters
accountIdstring<SS58>requiredpathSS58 address of the account.
atstring<unsignedInteger or $hex>queryBlock at which to query asset approval info for the specified account.
assetIdstring<unsignedInteger>requiredqueryThe assetId associated with the asset-approval.
delegatestring<SS58>requiredqueryThe delegate's accountId associated with an asset-approval.
Response
successfull operation
Invalid Address
Authorization
api-keyAuthapiKey in headerGet balance information for an account.
Returns information about an account's balance. Replaces /balance/{address} from versions < v1.0.0.
Parameters
accountIdstring<SS58>requiredpathSS58 address of the account.
atstring<unsignedInteger or $hex>queryBlock at which to query balance info for the specified account.
tokenstringqueryToken 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.
denominatedbooleanfalsequeryWhen set to true it will denominate any balance's given atomic value using the chains given decimal value.
Response
successful operation
Invalid Address
account not found
Authorization
api-keyAuthapiKey in headerConvert a given AccountId to an SS58 address.
Returns the SS58 prefix, the network address format, the SS58 address, and the AccountId that was given as input parameter, the scheme that was used and if it is a public key or not (boolean).
Parameters
accountIdstring<AccountId or Hex>requiredpathAccountId or Public Key (hex).
schemestring<string>sr25519queryThe cryptographic scheme to be used in order to convert the AccountId to an SS58 address. It can take one of three values [sr25519, ed25519, ecdsa]. The default scheme that is used is sr25519 (if it is not set in the query parameter).
prefixstring<number>42queryThe address prefix which can be one of the values found in the SS58-registry.
publicKeystring<boolean>truequeryDefines if the given value in the path parameter is a Public Key (hex) or not (hence AccountId).
Response
successfully converted the AccountId and retrieved the address info.
Invalid AccountId
AccountId not found
Authorization
api-keyAuthapiKey in headerGet an array of pool-asset-balances for an account.
Returns information about an account's pool-asset-balances. This is specific to the pool assets pallet for parachains. If no assets query parameter is provided, all pool-asset-balances for the given account will be returned.
Parameters
accountIdstring<SS58>requiredpathSS58 address of the account.
atstring<unsignedInteger or $hex>queryBlock at which to query pool-asset-balance info for the specified account.
assetsArray<string><Array of unsignedInteger's>queryAn array of AssetId's to be queried. If not supplied, defaults to providing all asset balances associated with the accountId will be returned. The array query param format follows Express 4.x API. ex:?assets[]=1&assets[]=2&assets[]=3.
Response
successfull operation
Invalid Address
Authorization
api-keyAuthapiKey in headerGet an asset approval for an account.
Returns information about an account's asset approval transaction. It is required to pass in a delegate and an assetId as query parameters.
Parameters
accountIdstring<SS58>requiredpathSS58 address of the account.
atstring<unsignedInteger or $hex>queryBlock at which to query asset approval info for the specified account.
assetIdstring<unsignedInteger>requiredqueryThe assetId associated with the asset-approval.
delegatestring<SS58>requiredqueryThe delegate's accountId associated with an asset-approval.
Response
successfull operation
Invalid Address
Authorization
api-keyAuthapiKey in headerGet proxy account information.
Returns information about a proxy account. This will include delegated accounts and deposits held.
Parameters
accountIdstring<SS58>requiredpathSS58 address of the account.
atstring<unsignedInteger or $hex>queryBlock at which to query proxy info for the specified account.
Response
successfull operation
Invalid Address
Authorization
api-keyAuthapiKey in headerGet vesting information for an account.
Returns the vesting schedule for an account. Replaces /vesting/{address} from versions < v1.0.0.
Parameters
accountIdstring<SS58>requiredpathSS58 address of the account.
atstring<unsignedInteger or $hex>queryBlock at which to query the vesting info for the specified account.
Response
successful operation
Invalid Address
account not found
Authorization
api-keyAuthapiKey in headerValidate a given address.
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.
Parameters
addressstring<SS58 or Hex>requiredpathSS58 or Hex address of the account.
Response
successfully retrieved address info
Authorization
api-keyAuthapiKey in headerCompares up to 30 SS58 addresses.
Returns if the given addresses are equal or not, along with details of each address. Equality is determined by comparing the accountId/publicKey of each address.
Parameters
addressesArray<string>requiredqueryAn array or a comma separated string of SS58 addresses. Provide up to 30 addresses using one of these formats ?addresses=...&addresses=... or ?addresses[]=...&addresses[]=... or ?addresses=...,....
Response
successfully compared at least two SS58 addresses.
Invalid Address
Authorization
api-keyAuthapiKey in headerpallets
Runtime pallet metadata, storage, constants, events, errors
Liquidity pools
Returns all liquidity pools from the AssetConversion pallet.
Parameters
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Liquidity pools
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerNext available pool ID
Returns the next available pool asset ID from the AssetConversion pallet.
Parameters
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Next available ID
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerAsset info
Returns details for a specific asset including supply, admin, and metadata.
Parameters
assetIdstringrequiredpathAsset ID
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Asset information
Asset not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerForeign assets
Returns all foreign assets with their details and metadata. Foreign assets use XCM MultiLocation as their identifier.
Parameters
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Foreign assets list
Not supported on this chain
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerNomination pools info
Returns global nomination pools statistics and configuration.
Parameters
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Nomination pools information
Not supported on this chain
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerNomination pool details
Returns details for a specific nomination pool.
Parameters
poolIdstringrequiredpathPool ID
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Pool details
Pool not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerOn-going referenda
Returns all currently active referenda from the Referenda pallet.
Parameters
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Active referenda
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerPool asset info
Returns details for a specific pool asset including supply, admin, and metadata.
Parameters
assetIdstringrequiredpathPool asset ID
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Pool asset information
Pool asset not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerStaking progress
Returns staking progress including era, session info, and validator counts.
Parameters
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Staking progress information
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerStaking validators
Returns the list of active validators and their info.
Parameters
atstringqueryBlock hash or number to query at
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Validator information
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerPallet constants
Returns all constants defined in a pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
atstringqueryBlock hash or number to query at
onlyIdsbooleanqueryOnly return constant names
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Pallet constants
Invalid pallet
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerPallet constant value
Returns the value and metadata of a specific constant in a pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
constantItemIdstringrequiredpathName of the constant
atstringqueryBlock hash or number to query at
metadatabooleanqueryInclude metadata
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Constant value
Invalid parameters
Constant not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerPallet dispatchables
Returns the dispatchable calls defined in a pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
atstringqueryBlock hash or number to query at
onlyIdsbooleanqueryOnly return dispatchable names
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Pallet dispatchables
Invalid pallet
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerPallet dispatchable details
Returns a single dispatchable call defined in a pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
dispatchableIdstringrequiredpathName of the dispatchable
atstringqueryBlock hash or number to query at
metadatabooleanqueryInclude metadata
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Dispatchable details
Dispatchable not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerPallet errors
Returns all errors defined in a pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
atstringqueryBlock hash or number to query at
onlyIdsbooleanqueryOnly return error names
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Pallet errors
Invalid pallet
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerPallet error details
Returns metadata for a specific error in a pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
errorItemIdstringrequiredpathName of the error
atstringqueryBlock hash or number to query at
metadatabooleanqueryInclude metadata
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Error details
Error not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet pallet events
Returns all events defined in a pallet.
Parameters
palletIdstringrequiredpathPallet name or index
atstringqueryBlock identifier (number or hash)
onlyIdsbooleanqueryOnly return event names
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Pallet events
Invalid request
Pallet not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet pallet event item
Returns metadata for a specific event in a pallet.
Parameters
palletIdstringrequiredpathPallet name or index
eventItemIdstringrequiredpathEvent name
atstringqueryBlock identifier (number or hash)
metadatabooleanqueryInclude full event metadata
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Event item details
Invalid request
Pallet or event not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerPallet storage items
Returns the list of storage items for a given pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
atstringqueryBlock hash or number to query at
onlyIdsbooleanqueryOnly return storage item names
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Pallet storage items
Invalid pallet or parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerPallet storage item value
Returns the value of a specific storage item in a pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
storageItemIdstringrequiredpathName of the storage item
atstringqueryBlock hash or number to query at
keys[]Array<string>queryStorage key arguments
metadatabooleanqueryInclude metadata for the storage item
useRcBlockbooleanqueryTreat 'at' as relay chain block identifier
Response
Storage item value
Invalid parameters
Storage item not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet information and metadata associated with an asset.
Returns information associated with an asset which includes the assets AssetDetails and AssetMetadata.
Parameters
assetIdstring<unsignedInteger>requiredpathThe unsignedInteger Id of an asset.
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the assetInfo.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet information related to existing liquidity pools.
Returns a list of the existing liquidity pools and its corresponding tokens at a given block height. If no block is specified, it returns the latest list available.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the liquidity pools information.
Response
successful operation
invalid blockId supplied for at query param
Authorization
api-keyAuthapiKey in headerGet the next available liquidity pool id.
Returns the next available liquidity pool's id at a given block height. If no block is specified, it returns the latest list available.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the next liquidity pool's id.
Response
successful operation
invalid blockId supplied for at query param
Authorization
api-keyAuthapiKey in headerGet information and metadata associated with foreign assets.
Returns information associated with every foreign asset which includes the assets AssetDetails and AssetMetadata.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the foreign assets.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet information associated with nomination pools.
Returns information and metadata for nomination pools including pool counters and limits.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the nomination pool info.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet information and metadata associated with a nomination pool.
Returns information associated with a nomination pool which includes the nomination pools' bondedPool, rewardPool and metadata.
Parameters
poolIdstring<unsignedInteger>requiredpathThe unsignedInteger Id of a nomination pool.
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the nomination pool.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet a list of all on-going referenda that have track root (0) and whitelisted (1), along with their associated information.
Returns information associated with on-going referenda which includes the referendum's enactment, submitted and deciding fields.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the on-going referenda.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet a list of constants for a pallet.
Returns a list of const item metadata for constant items of the specified palletId.
Parameters
palletIdstringrequiredpathName or index of the pallet to read constant metadata for. Note: the pallet name must match what is specified in the runtime metadata.
onlyIdsbooleanqueryOnly return the names (IDs) of the const items instead of every constant's metadata.
atstring<unsignedInteger or $hex>queryBlock at which to retrieve a list of the pallet's constant items.
Response
successful operation
invalid blockId supplied for at query param
could not find pallet with palletId
Authorization
api-keyAuthapiKey in headerGet the value of a constant item.
Returns the value stored under the constantItemId.
Parameters
palletIdstringrequiredpathName or index of the pallet to read constant metadata for. Note: the pallet name must match what is specified in the runtime metadata.
constantItemIdstringrequiredpathId of the const item to query for.
atstring<unsignedInteger or $hex>queryBlock at which to query the const item at.
metadatabooleanfalsequeryInclude the const items metadata (including documentation) if set to true.
Response
successful operation
invalid blockId supplied for at query param
could not find resource with id
Authorization
api-keyAuthapiKey in headerGet a list of dispatchables for a pallet.
Returns a list of dispatchable item metadata for distpachable items of the specified palletId.
Parameters
palletIdstringrequiredpathName or index of the pallet to read dispatchable metadata for. Note: the pallet name must match what is specified in the runtime metadata.
onlyIdsbooleanqueryOnly return the names (IDs) of the dispatchable items instead of every dispatchable's metadata.
Response
successful operation
invalid blockId supplied for at query param
could not find pallet with palletId
Authorization
api-keyAuthapiKey in headerGet the value of a dispatchable item.
Returns the value stored under the dispatchableItemId.
Parameters
palletIdstringrequiredpathName or index of the pallet to read dispatchable metadata for. Note: the pallet name must match what is specified in the runtime metadata.
dispatchableItemIdstringrequiredpathId of the dispatchable item to query for.
metadatabooleanfalsequeryInclude the dispatchable items metadata (including documentation) if set to true.
Response
successful operation
invalid blockId supplied for at query param
could not find resource with id
Authorization
api-keyAuthapiKey in headerGet a list of errors for a pallet.
Returns a list of error item metadata for error items of the specified palletId.
Parameters
palletIdstringrequiredpathName or index of the pallet to read error metadata for. Note: the pallet name must match what is specified in the runtime metadata.
onlyIdsbooleanqueryOnly return the names (IDs) of the error items instead of every error's metadata.
atstring<unsignedInteger or $hex>queryBlock at which to retrieve a list of the pallet's error items.
Response
successful operation
invalid blockId supplied for at query param
could not find pallet with palletId
Authorization
api-keyAuthapiKey in headerGet the value of an error item.
Returns the value stored under the errorItemId.
Parameters
palletIdstringrequiredpathName or index of the pallet to read error metadata for. Note: the pallet name must match what is specified in the runtime metadata.
errorItemIdstringrequiredpathId of the error item to query for.
atstring<unsignedInteger or $hex>queryBlock at which to query the error item at.
metadatabooleanfalsequeryInclude the error items metadata (including documentation) if set to true.
Response
successful operation
invalid blockId supplied for at query param
could not find resource with id
Authorization
api-keyAuthapiKey in headerGet a list of events for a pallet.
Returns a list of event item metadata for event items of the specified palletId.
Parameters
palletIdstringrequiredpathName or index of the pallet to read event metadata for. Note: the pallet name must match what is specified in the runtime metadata.
onlyIdsbooleanqueryOnly return the names (IDs) of the event items instead of every event's metadata.
atstring<unsignedInteger or $hex>queryBlock at which to retrieve a list of the pallet's event items.
Response
successful operation
invalid blockId supplied for at query param
could not find pallet with palletId
Authorization
api-keyAuthapiKey in headerGet the value of an event item.
Returns the value stored under the eventItemId.
Parameters
palletIdstringrequiredpathName or index of the pallet to read event metadata for. Note: the pallet name must match what is specified in the runtime metadata.
eventItemIdstringrequiredpathId of the event item to query for.
atstring<unsignedInteger or $hex>queryBlock at which to query the event item at.
metadatabooleanfalsequeryInclude the event items metadata (including documentation) if set to true.
Response
successful operation
invalid blockId supplied for at query param
could not find resource with id
Authorization
api-keyAuthapiKey in headerGet a list of storage items for a pallet.
Returns a list of storage item metadata for storage items of the specified palletId.
Parameters
palletIdstringrequiredpathName or index of the pallet to query the storage of. Note: the pallet name must match what is specified in the runtime metadata.
onlyIdsbooleanqueryOnly return the names (IDs) of the storage items instead of all of each storage item's metadata.
atstring<unsignedInteger or $hex>queryBlock at which to retrieve a list of the pallet's storage items.
Response
successful operation
invalid blockId supplied for at query param
could not find pallet with palletId
Authorization
api-keyAuthapiKey in headerGet the value of a storage item.
Returns the value stored under the storageItemId. If it is a map, query param key1 is required. If the storage item is double map query params key1 and key2 are required.
Parameters
palletIdstringrequiredpathName or index of the pallet to query the storage of. Note: pallet name aligns with pallet name as specified in runtime metadata.
storageItemIdstringrequiredpathId of the storage item to query for.
keysArray<string>querySet of N keys used for querying a storage map. It should be queried using the following format - ?keys[]=key1&keys[]=key2. Order matters, as it will determine the order the keys are passed into the storage calls.
atstring<unsignedInteger or $hex>queryBlock at which to query the storage item at.
metadatabooleanfalsequeryInclude the storage items metadata (including documentation) if set to true.
Response
successful operation
invalid blockId supplied for at query param
could not find resource with id
Authorization
api-keyAuthapiKey in headerGet information and metadata associated with a pool asset.
Returns information associated with a pool asset which includes the assets AssetDetails and AssetMetadata.
Parameters
assetIdstring<unsignedInteger>requiredpathThe unsignedInteger Id of a pool asset.
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the assetInfo.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet progress on the general Staking pallet system.
Returns information on the progress of key components of the staking system and estimates of future points of interest. Replaces /staking-info from versions < v1.0.0.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve a staking progress report.
Response
successful operation
invalid blockId supplied for at query param
Authorization
api-keyAuthapiKey in headerGet all validators (active/waiting) of a specific chain.
Returns a list of all validators addresses and their corresponding status which can be either active or waiting. 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".
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the list of validators.
Response
successful operation
invalid blockId supplied for at query param
Authorization
api-keyAuthapiKey in headerruntime
Runtime specification, metadata, and code
Runtime Wasm code
Returns the Wasm code blob of the Substrate runtime at a given block.
Parameters
atstringqueryBlock hash or number to query at
Response
Runtime code
Invalid block parameter
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRuntime metadata
Returns the decoded runtime metadata in JSON format.
Parameters
atstringqueryBlock hash or number to query at
Response
Runtime metadata
Invalid block parameter
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerAvailable metadata versions
Returns the available metadata versions at a given block.
Parameters
atstringqueryBlock hash or number to query at
Response
List of available metadata versions
Invalid block parameter
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRuntime metadata by version
Returns the metadata at a specific version. The version parameter should be in 'vX' format (e.g., 'v14', 'v15').
Parameters
versionstringrequiredpathMetadata version (e.g., 'v14', 'v15')
atstringqueryBlock hash or number to query at
Response
Runtime metadata at specified version
Invalid version format or block parameter
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRuntime specification
Returns the runtime specification including version, APIs, and chain properties.
Parameters
atstringqueryBlock hash or number to query at
Response
Runtime specification
Invalid block parameter
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet the runtime metadata in decoded, JSON form.
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
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the metadata at.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet the requested version of runtime metadata in decoded, JSON form.
Returns the requested version of 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
Parameters
metadataVersionstringrequiredpathThe version of metadata. The input is expected in a vX format, where X represents the version number (e.g. v14, v15).
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the metadata at.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet the available versions of runtime metadata.
Returns the available versions of runtime metadata. Substrate Reference: - FRAME Support: https://crates.parity.io/frame_support/metadata/index.html - Knowledge Base: https://substrate.dev/docs/en/knowledgebase/runtime/metadata
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the metadata versions at.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet the runtime wasm blob.
Returns the runtime Wasm blob in hex format.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the runtime wasm blob at.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet version information of the Substrate runtime.
Returns version information related to the runtime.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve runtime version information at.
Response
successful operation
Authorization
api-keyAuthapiKey in headertransaction
Transaction submission, fee estimation, and construction material
Submit transaction
Submit a signed extrinsic to the transaction pool.
Body
Signed extrinsic with 'tx' field containing hex-encoded transaction
Response
Transaction hash
Invalid transaction
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerDry run transaction
Dry run a transaction to check validity without submitting.
Body
Transaction with 'tx', 'senderAddress', and optional 'at' fields
Response
Dry run result
Invalid transaction
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerEstimate transaction fee
Estimate the fee for a transaction.
Body
Transaction with 'tx' field containing hex-encoded transaction
Response
Fee estimate
Invalid transaction
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerTransaction construction material
Returns network information needed for transaction construction including genesis hash, spec version, and optionally metadata.
Parameters
atstringqueryBlock hash or number to query at
noMetabooleanqueryDEPRECATED: If true, metadata is not included
metadatastringqueryMetadata format: 'json' or 'scale'
Response
Transaction material
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerTransaction material with versioned metadata
Returns transaction construction material with metadata at a specific version.
Parameters
metadataVersionstringrequiredpathMetadata version (e.g., 'v14', 'v15')
atstringqueryBlock hash or number to query at
noMetabooleanqueryDEPRECATED: If true, metadata is not included
metadatastringqueryMetadata format: 'json' or 'scale'
Response
Transaction material with versioned metadata
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGenerate metadata blob
Generates a metadata blob for transaction signing with the CheckMetadataHash extension.
Body
Request with 'tx' field and optional 'at' block
Response
Metadata blob
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerParse transaction
Decode a raw transaction and return its components without executing or submitting it. Returns the decoded pallet/method, call arguments, signature info, nonce, tip, era, and hash. Note: This endpoint uses the chain's current (latest) metadata for decoding. Transactions created for older runtime versions may fail to decode if the extrinsic format has changed.
Body
Transaction with 'tx' field containing hex-encoded extrinsic
Request body for transaction parsing.
txstringHex-encoded extrinsic with optional 0x prefix.
Response
Parsed transaction
Invalid transaction
Internal server error
Authorization
api-keyAuthapiKey in headerSubmit a transaction to the node's transaction pool.
Accepts a valid signed extrinsic. Replaces /tx from versions < v1.0.0.
Body
txstring<hex>Response
successful operation
failed to parse or submit transaction
Authorization
api-keyAuthapiKey in headerDry run an extrinsic.
Use the dryRun call to simulate the submission of a transaction without executing it so that you can check for potential errors and validate the expected outcome.
Body
atstring<unsignedInteger>txstring<hex>senderAddressstring<ss58>Response
successful operation
failed to dry-run transaction
Authorization
api-keyAuthapiKey in headerReceive a fee estimate for a transaction.
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
Body
txstring<hex>Response
successful operation
fee estimation failure
Authorization
api-keyAuthapiKey in headerGet all the network information needed to construct a transaction offline.
Returns the material that is universal to constructing any signed transaction offline. Replaces /tx/artifacts from versions < v1.0.0.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the transaction construction material.
noMetabooleanfalsequeryDEPRECATED! This is no longer supported
metadatastringquerySpecifies the format of the metadata to be returned. Accepted values are 'json', and 'scale'. 'json' being the decoded metadata, and 'scale' being the SCALE encoded metadata. When metadata is not inputted, the metadata field will be absent.
Response
successful operation
invalid blockId supplied for at query param
Authorization
api-keyAuthapiKey in headerGet all the network information needed to construct a transaction offline and the version of metadata specified in metadataVersion.
Returns all the materials necessary for constructing any signed transactions offline.
Parameters
metadataVersionstringrequiredpathThe version of metadata. The input is expected in a vX format, where X represents the version number (e.g. v14, v15). By default, metadata is outputted in 'json' format, unless the metadata query parameter is provided, in which case it can be either in 'json' or 'scale' format.
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the transaction construction material.
metadatastringquerySpecifies the format of the metadata to be returned. Accepted values are 'json', and 'scale'. 'json' being the decoded metadata, and 'scale' being the SCALE encoded metadata.
Response
successful operation
invalid blockId supplied for at query param
Authorization
api-keyAuthapiKey in headercoretime
Coretime system information
Get coretime info
Returns coretime chain status information including the last committed timeslice.
Parameters
atstringqueryBlock identifier (number or hash)
Response
Coretime info
Invalid block identifier
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet coretime leases
Returns all leases registered on a coretime chain with task IDs and validity timeslices.
Parameters
atstringqueryBlock identifier (number or hash)
Response
Coretime leases
Invalid block identifier
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet coretime overview
Returns an overview of all cores with assignments, queue state, workload, workplan, and regions.
Parameters
atstringqueryBlock identifier (number or hash)
Response
Coretime overview
Invalid block identifier
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet coretime regions
Returns all regions on a coretime chain including begin/end timeslices, core, owner, and mask.
Parameters
atstringqueryBlock identifier (number or hash)
Response
Coretime regions
Invalid block identifier
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet coretime potential renewals
Returns potential renewals on a coretime chain sorted by core index, including price, completion status, and task assignment.
Parameters
atstringqueryBlock identifier (number or hash)
Response
Coretime renewals
Invalid block identifier
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet coretime reservations
Returns all reservations on a coretime chain. Reserved cores are permanently allocated and not available for sale.
Parameters
atstringqueryBlock identifier (number or hash)
Response
Coretime reservations
Invalid block identifier
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerGet all the leases currently registered on coretime chain.
Parameters
blockIdstringqueryBlock identifier, as the block height or block hash.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet all the regions currently registered on coretime chain.
Parameters
blockIdstringqueryBlock identifier, as the block height or block hash.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet all the potential renewals currently registered on coretime chain.
Parameters
blockIdstringqueryBlock identifier, as the block height or block hash.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet all the reservations currently registered on coretime chain.
Parameters
blockIdstringqueryBlock identifier, as the block height or block hash.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet the generic information about coretime, either on coretime chain or relay chain.
Parameters
blockIdstringqueryBlock identifier, as the block height or block hash.
Response
successful operation
Authorization
api-keyAuthapiKey in headerGet all the cores information either on coretime chain or relay chain.
Parameters
blockIdstringqueryBlock identifier, as the block height or block hash.
Response
successful operation
Authorization
api-keyAuthapiKey in headerparas
Parachain inclusion data
Parachain inclusion data
Returns inclusion information for a given parachain block, searching relay chain blocks for when the parachain block was included.
Parameters
numberstringrequiredpathParachain block number
depthstringquerySearch depth for relay chain blocks (max 100, default 10, must be divisible by 5)
Response
Parachain inclusion information
Invalid parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in header[DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] List all registered paras (parathreads & parachains).
Returns all registered parachains and parathreads with lifecycle info.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve paras list at.
Response
successful operation
Authorization
api-keyAuthapiKey in header[DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] Get general information about the current lease period.
Returns an overview of the current lease period, including lease holders.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve current lease period info at.
currentLeaseHoldersbooleantruequeryWether or not to include the currentLeaseHolders property. Inclusion
of the property will likely result in a larger payload and increased
response time.
Response
successful operation
Authorization
api-keyAuthapiKey in header[DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] Get the status of the current auction.
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.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve auction progress at.
Response
successful operation
Authorization
api-keyAuthapiKey in header[DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] List all stored crowdloans.
Returns a list of all the crowdloans and their associated paraIds.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the list of paraIds that have crowdloans at.
Response
successful operation
Authorization
api-keyAuthapiKey in header[DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] Get crowdloan information for a paraId.
Returns crowdloan's fundInfo and the set of leasePeriods the crowdloan`
covers.
Parameters
paraIdnumberrequiredpathparaId to query the crowdloan information of.
atstring<unsignedInteger or $hex>queryBlock at which to retrieve info at.
Response
successful operation
Authorization
api-keyAuthapiKey in header[DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] Get current and future leases as well as the lifecycle stage for a given paraId.
Returns a list of leases that belong to the paraId as well as the
paraId's current lifecycle stage.
Parameters
paraIdnumberrequiredpathparaId to query the crowdloan information of.
atstring<unsignedInteger or $hex>queryBlock at which to retrieve para's leases at.
Response
successful operation
Authorization
api-keyAuthapiKey in header[DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] Get the heads of the included (backed and considered available) parachain candidates at the specified block height or at the most recent finalized head otherwise.
Returns an object with all the parachain id's as keys, and their headers as values.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve para's heads at.
Response
successful operation
Authorization
api-keyAuthapiKey in header[DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] Get the heads of the backed parachain candidates at the specified block height or at the most recent finalized head otherwise.
Returns an object with all the parachain id's as keys, and their headers as values.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve para's heads at.
Response
successful operation
Authorization
api-keyAuthapiKey in headerahm
Asset Hub Migration information
Asset Hub Migration info
Returns information about the Asset Hub migration, including start and end blocks for both relay chain and Asset Hub.
Response
AHM migration boundaries
No migration data available
Authorization
api-keyAuthapiKey in headercapabilities
API capabilities and chain pallets
API capabilities
Returns the chain name and list of available pallets in the runtime metadata.
Parameters
atstringqueryBlock hash or number to query at
Response
Chain capabilities
Invalid block parameter
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerrc
Relay chain endpoints (available on parachains only)
RC get balance info
Returns balance information for a given account on the relay chain.
Parameters
accountIdstringrequiredpathSS58-encoded account address
atstringqueryBlock identifier (number or hash)
tokenstringqueryToken symbol (defaults to native token)
denominatedbooleanqueryDenominate balances using chain decimals
Response
Balance information
Invalid account address
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get proxy info
Returns proxy information for a given account on the relay chain.
Parameters
accountIdstringrequiredpathSS58-encoded account address
atstringqueryBlock identifier (number or hash)
Response
Proxy information
Invalid account address
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get staking info
Returns staking information for a given stash account on the relay chain.
Parameters
accountIdstringrequiredpathSS58-encoded stash account address
atstringqueryBlock identifier (number or hash)
includeClaimedRewardsbooleanqueryWhen true, include claimed rewards in the response
Response
Staking information
Invalid account address
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get staking payouts
Returns staking payout information for a given account on the relay chain.
Parameters
accountIdstringrequiredpathSS58-encoded account address
atstringqueryBlock identifier (number or hash)
depthinteger<int32>>= 0queryNumber of eras to query (default: 1)
erainteger<int32>>= 0queryThe era to query at (default: active_era - 1)
unclaimedOnlybooleanqueryOnly show unclaimed rewards (default: true)
Response
Staking payouts
Invalid account address
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get vesting info
Returns vesting information for a given account on the relay chain.
Parameters
accountIdstringrequiredpathSS58-encoded account address
atstringqueryBlock identifier (number or hash)
Response
Vesting information
Invalid account address
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get blocks by range
Returns relay chain blocks within a specified range (max 500 blocks).
Parameters
rangestringqueryBlock range (e.g., '100-200')
eventDocsbooleanqueryInclude event documentation
extrinsicDocsbooleanqueryInclude extrinsic documentation
noFeesbooleanquerySkip fee calculation
decodedXcmMsgsbooleanqueryDecode and include XCM messages
paraIdinteger<int32>>= 0queryFilter XCM messages by parachain ID
Response
Relay chain blocks
Invalid range or missing parameter
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get head block
Returns the latest block on the relay chain.
Parameters
finalizedbooleanqueryWhen true returns finalized head (default: true)
eventDocsbooleanqueryInclude event documentation
extrinsicDocsbooleanqueryInclude extrinsic documentation
noFeesbooleanquerySkip fee calculation
decodedXcmMsgsbooleanqueryDecode and include XCM messages
paraIdinteger<int32>>= 0queryFilter XCM messages by parachain ID
Response
Relay chain head block
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get head block header
Returns the header of the latest relay chain block.
Parameters
finalizedbooleanqueryWhen true returns finalized head (default: true)
Response
Relay chain head block header
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get block by ID
Returns relay chain block information for a given block identifier.
Parameters
blockIdstringrequiredpathBlock height number or block hash
eventDocsbooleanqueryInclude event documentation
extrinsicDocsbooleanqueryInclude extrinsic documentation
noFeesbooleanquerySkip fee calculation
decodedXcmMsgsbooleanqueryInclude decoded XCM messages
paraIdinteger<int32>>= 0queryFilter XCM messages by parachain ID
Response
Relay chain block information
Invalid block identifier
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get raw extrinsics
Returns raw hex-encoded extrinsics for a relay chain block without decoding.
Parameters
blockIdstringrequiredpathBlock height number or block hash
Response
Raw extrinsics
Invalid block identifier
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get extrinsic by index
Returns a specific extrinsic from a relay chain block by its index.
Parameters
blockIdstringrequiredpathBlock height number or block hash
extrinsicIndexstringrequiredpathIndex of the extrinsic in the block
eventDocsbooleanqueryInclude event documentation
extrinsicDocsbooleanqueryInclude extrinsic documentation
noFeesbooleanquerySkip fee calculation
Response
Extrinsic details
Invalid block ID or extrinsic index
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get block header
Returns the header of a relay chain block by block hash or block number.
Parameters
blockIdstringrequiredpathBlock height number or block hash
Response
Relay chain block header
Invalid block identifier
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get parachain inclusions
Returns parachain inclusion information for a given relay chain block.
Parameters
blockIdstringrequiredpathBlock height number or block hash
paraIdinteger<int32>>= 0queryFilter by parachain ID
Response
Parachain inclusions
Invalid block identifier
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get node network
Returns the relay chain node's network information.
Response
Relay chain node network info
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get transaction pool
Returns the relay chain's transaction pool with optional fee information.
Parameters
includeFeebooleanqueryInclude fee information for each transaction (default: false)
Response
Relay chain transaction pool
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get node version
Returns the relay chain node's version information.
Response
Relay chain node version
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC on-going referenda
Returns all currently active referenda from the relay chain's Referenda pallet.
Parameters
atstringqueryBlock hash or number to query at
Response
Active referenda from relay chain
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC staking progress
Returns staking progress from the relay chain.
Parameters
atstringqueryBlock hash or number to query at
Response
Relay chain staking progress
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC staking validators
Returns the list of active validators from the relay chain.
Parameters
atstringqueryBlock hash or number to query at
Response
Relay chain validator information
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC pallet constants
Returns all constants defined in a relay chain pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
atstringqueryBlock hash or number to query at
onlyIdsbooleanqueryOnly return constant names
Response
Relay chain pallet constants
Invalid pallet
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC pallet constant value
Returns the value and metadata of a specific constant from a relay chain pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
constantItemIdstringrequiredpathName of the constant
atstringqueryBlock hash or number to query at
metadatabooleanqueryInclude metadata
Response
Relay chain constant value
Constant not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC pallet dispatchables
Returns the dispatchable calls defined in a relay chain pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
atstringqueryBlock hash or number to query at
onlyIdsbooleanqueryOnly return dispatchable names
Response
Relay chain pallet dispatchables
Invalid pallet
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC pallet dispatchable details
Returns a single dispatchable call from a relay chain pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
dispatchableIdstringrequiredpathName of the dispatchable
atstringqueryBlock hash or number to query at
metadatabooleanqueryInclude metadata
Response
Relay chain dispatchable details
Dispatchable not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC pallet errors
Returns all errors defined in a relay chain pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
atstringqueryBlock hash or number to query at
onlyIdsbooleanqueryOnly return error names
Response
Relay chain pallet errors
Invalid pallet
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC pallet error details
Returns metadata for a specific error in a relay chain pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
errorItemIdstringrequiredpathName of the error
atstringqueryBlock hash or number to query at
metadatabooleanqueryInclude metadata
Response
Relay chain error details
Error not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC pallet events
Returns all events defined in a relay chain pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
atstringqueryBlock hash or number to query at
onlyIdsbooleanqueryOnly return event names
Response
Relay chain pallet events
Invalid pallet
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC pallet event details
Returns metadata for a specific event in a relay chain pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
eventItemIdstringrequiredpathEvent name
atstringqueryBlock hash or number to query at
metadatabooleanqueryInclude full event metadata
Response
Relay chain event details
Pallet or event not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC pallet storage items
Returns the list of storage items for a relay chain pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
atstringqueryBlock hash or number to query at
onlyIdsbooleanqueryOnly return storage item names
Response
Relay chain pallet storage items
Invalid pallet or parameters
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC pallet storage item value
Returns the value of a specific storage item from a relay chain pallet.
Parameters
palletIdstringrequiredpathName or index of the pallet
storageItemIdstringrequiredpathName of the storage item
atstringqueryBlock hash or number to query at
keys[]Array<string>queryStorage key arguments
metadatabooleanqueryInclude metadata for the storage item
Response
Relay chain storage item value
Invalid parameters
Storage item not found
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC get runtime code
Returns the Wasm code blob of the relay chain runtime at a given block.
Parameters
atstringqueryBlock identifier (number or hash)
Response
Relay chain runtime code
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get runtime metadata
Returns the decoded runtime metadata of the relay chain in JSON format.
Parameters
atstringqueryBlock identifier (number or hash)
Response
Relay chain runtime metadata
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get metadata versions
Returns the available metadata versions on the relay chain at a given block.
Parameters
atstringqueryBlock identifier (number or hash)
Response
Available metadata versions
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get metadata by version
Returns the relay chain metadata at a specific version (e.g., v14, v15).
Parameters
versionstringrequiredpathMetadata version in 'vX' format (e.g., v14, v15)
atstringqueryBlock identifier (number or hash)
Response
Relay chain metadata at specified version
Invalid version format
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC get runtime spec
Returns the runtime spec of the relay chain at a given block.
Parameters
atstringqueryBlock identifier (number or hash)
Response
Relay chain runtime spec
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerSubmit transaction (relay chain)
Submit a signed extrinsic to the relay chain transaction pool. Only available on parachains.
Body
Signed extrinsic with 'tx' field containing hex-encoded transaction
Response
Transaction hash
Invalid transaction
Internal server error
Relay chain not configured
Authorization
api-keyAuthapiKey in headerRC dry run transaction
Dry run a transaction on the relay chain.
Body
Transaction with 'tx', 'senderAddress', and optional 'at' fields
Response
Dry run result
Invalid transaction
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC fee estimate
Estimate the fee for a relay chain transaction.
Body
Transaction with 'tx' field
Response
Fee estimate
Invalid transaction
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC transaction material
Returns relay chain network information for transaction construction.
Parameters
atstringqueryBlock hash or number to query at
noMetabooleanqueryDEPRECATED: If true, metadata is not included
metadatastringqueryMetadata format: 'json' or 'scale'
Response
Relay chain transaction material
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC transaction material versioned
Returns relay chain transaction material with metadata at a specific version.
Parameters
metadataVersionstringrequiredpathMetadata version (e.g., 'v14', 'v15')
atstringqueryBlock hash or number to query at
noMetabooleanqueryDEPRECATED: If true, metadata is not included
metadatastringqueryMetadata format: 'json' or 'scale'
Response
Relay chain transaction material with versioned metadata
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerRC metadata blob
Generates a metadata blob from the relay chain for transaction signing.
Body
Request with 'tx' field and optional 'at' block
Response
Metadata blob
Internal server error
Service unavailable
Authorization
api-keyAuthapiKey in headerParse transaction (relay chain)
Decode a raw transaction using relay chain metadata. Only available on parachains. Returns the decoded pallet/method, call arguments, signature info, nonce, tip, era, and hash. Note: This endpoint uses the relay chain's current (latest) metadata for decoding. Transactions created for older runtime versions may fail to decode if the extrinsic format has changed.
Body
Transaction with 'tx' field containing hex-encoded extrinsic
Request body for transaction parsing.
txstringHex-encoded extrinsic with optional 0x prefix.
Response
Parsed transaction
Invalid transaction or relay chain not configured
Internal server error
Relay chain unavailable
Authorization
api-keyAuthapiKey in headercontracts
Query an !Ink contract with a given message (method).
Will return a valid or invalid result.
Body
Metadata used to instantiate a ContractPromise. This metadata can be generated by compiling the contract you are querying.
Parameters
addressstringrequiredpathSS58 or Hex address of the account associated with the contract.
methodstringgetqueryThe message or method used to query.
gasLimitnumber-1queryThe gas limit to be used as an option for the queried message.
storageDepositLimitnumbernullqueryThe storage deposit limit to be used as an option for the queried message.
argsArray<string>queryAbi params used as args specified in the metadata to be passed into a query. The format to use this query param is ?args[]=1&args[]=2&args[]=3.
Response
succesful operation
Invalid Method
Authorization
api-keyAuthapiKey in headertrace
[Experimental - subject to breaking change.] Get traces for the most recently finalized block.
Returns traces (spans and events) of the most recently finalized block from
RPC state_straceBlock. Consult the RPC docs
for conceptual info.
Response
successful operation
Authorization
api-keyAuthapiKey in header[Experimental - subject to breaking change.] Get traces for the given blockId.
Returns traces (spans and events) of the specified block from
RPC state_straceBlock. Consult the RPC docs for conceptual info.
Parameters
blockIdstringrequiredpathBlock identifier, as the block height or block hash.
Response
successful operation
Authorization
api-keyAuthapiKey in header[Experimental - subject to breaking change.] Get the operations from the most recently finalized block.
Returns the operations from the most recently finalized block. Operations represent one side of a balance change. For example if Alice transfers 100unit to Bob there will be two operations; 1) Alice - 100 2) Bob + 100.
Given account A and A's balance at block k0 (Ak0), if we sum all the operations for A from block k1 through kn against Ak0, we will end up with A's balance at block kn (Akn). Thus, operations can be used to audit that balances change as expected.
This is useful for Substrate based chains because the advanced business logic can make it difficult to ensure auditable balance reconciliation based purely on events. Instead of using events one can use the operations given from this endpoint.
Note - each operation corresponds to a delta of a single field of the
system::AccountData storage item (i.e free, reserved, misc_frozen
and fee_frozen).
Note - operations are assigned a block execution phase (and extrinsic index
for those in the apply extrinsic phase) based on an "action group". For
example all the operations for 1 extrinsic will be in the same action group.
The action groups can optionally be fetched with the action query param
for closer auditing.
Note - There are no 0 value operations (e.g. a transfer of 0, or a
transfer to itself)
To learn more about operation and action group creation please consult this diagram
Parameters
actionsbooleanfalsequeryWhether or not to include action groups.
Response
successful operation
Authorization
api-keyAuthapiKey in header[Experimental - subject to breaking change.] Get the operations from the specified block.
Returns the operations from the most recently finalized block. Operations represent one side of a balance change. For example if Alice transfers 100unit to Bob there will be two operations; 1) Alice - 100 2) Bob + 100.
Given account A and A's balance at block k0 (Ak0), if we sum all the operations for A from block k1 through kn against Ak0, we will end up with A's balance at block kn (Akn). Thus, operations can be used to audit that balances change as expected.
This is useful for Substrate based chains because the advanced business logic can make it difficult to ensure auditable balance reconciliation based purely on events. Instead of using events one can use the operations given from this endpoint.
Note - each operation corresponds to a delta of a single field of the
system::AccountData storage item (i.e free, reserved, misc_frozen
and fee_frozen).
Note - operations are assigned a block execution phase (and extrinsic index
for those in the apply extrinsic phase) based on an "action group". For
example all the operations for 1 extrinsic will be in the same action group.
The action groups can optionally be fetched with the action query param
for closer auditing.
Note - There are no 0 value operations (e.g. a transfer of 0, or a
transfer to itself)
To learn more about operation and action group creation please consult this diagram
Parameters
blockIdstringrequiredpathBlock identifier, as the block height or block hash.
actionsbooleanfalsequeryWhether or not to include action groups.
Response
successful operation
Authorization
api-keyAuthapiKey in headerstaking
Get staking information for a Stash account.
Returns information about a Stash account's staking activity. Replaces /staking/{address} from versions < v1.0.0. The Stash account can be either a validator or nominator account.
Parameters
accountIdstring<SS58>requiredpathSS58 address of the account. Must be a Stash account.
atstring<unsignedInteger or $hex>queryBlock at which to query the staking info for the specified account.
includeClaimedRewardsstring<boolean>truequeryWhen set to false, the claimedRewards field is not included in the response.
Response
successful operation
invalid blockId supplied for at query param
account not found
Authorization
api-keyAuthapiKey in headerGet payout information for a Stash account.
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.
Parameters
accountIdstring<SS58>requiredpathSS58 address of the account. Must be a Stash account.
atstring<unsignedInteger or $hex>queryBlock at which to query staking payouts.
depthstring<unsignedInteger>1queryThe 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.
erastring<unsignedInteger>`active_era - 1`queryThe era to query at.
unclaimedOnlystring<boolean>truequeryOnly return unclaimed rewards.
Response
successful operation
invalid blockId supplied for at query param
account not found
Authorization
api-keyAuthapiKey in headerGet progress on the general Staking pallet system.
Returns information on the progress of key components of the staking system and estimates of future points of interest. Replaces /staking-info from versions < v1.0.0.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve a staking progress report.
Response
successful operation
invalid blockId supplied for at query param
Authorization
api-keyAuthapiKey in headerGet all validators (active/waiting) of a specific chain.
Returns a list of all validators addresses and their corresponding status which can be either active or waiting. 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".
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve the list of validators.
Response
successful operation
invalid blockId supplied for at query param
Authorization
api-keyAuthapiKey in header