Substrate API Sidecar
v20.1.0https://ksm-playbook.nownodes.ioSubstrate API Sidecar is a REST service that makes it easy to interact with blockchain nodes built using Substrate's FRAME framework.
Authentication
api-keyAuthapiKeyAPI Key: api-key in header
NODE
accounts
Get an array of asset-balances for an account.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get an asset approval for an account.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get balance information for an account.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Convert a given AccountId to an SS58 address.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get an array of pool-asset-balances for an account.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get an asset approval for an account.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get proxy account information.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get vesting information for an account.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Validate a given address.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Compares up to 30 SS58 addresses.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
blocks
Get a range of blocks by their height.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get a block by its height or hash.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get a block's header by its height or hash.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get an extrinsic by its extrinsicIndex and block height or hash. The pair blockId, extrinsicIndex is sometimes referred to as a Timepoint.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get the most recently finalized block.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get information about the header of the most recent finalized block.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get a blocks header & its extrinsics as hex values.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
contracts
Query an !Ink contract with a given message (method).
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
coretime
Get all the leases currently registered on coretime chain.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
blockIdstringqueryBlock identifier, as the block height or block hash.
Response
successful operation
Get all the regions currently registered on coretime chain.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
blockIdstringqueryBlock identifier, as the block height or block hash.
Response
successful operation
Get all the potential renewals currently registered on coretime chain.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
blockIdstringqueryBlock identifier, as the block height or block hash.
Response
successful operation
Get all the reservations currently registered on coretime chain.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
blockIdstringqueryBlock identifier, as the block height or block hash.
Response
successful operation
Get the generic information about coretime, either on coretime chain or relay chain.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
blockIdstringqueryBlock identifier, as the block height or block hash.
Response
successful operation
Get all the cores information either on coretime chain or relay chain.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
blockIdstringqueryBlock identifier, as the block height or block hash.
Response
successful operation
node
node connected to sidecar
Get information about the Substrate node's activity in the peer-to-peer network.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns network related information of the node.
Response
successful operation
Get pending extrinsics from the Substrate node.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get information about the Substrates node's implementation and versioning.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns versioning information of the node.
Response
successful operation
pallets
pallets employed in the runtime
Get information and metadata associated with an asset.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get information related to existing liquidity pools.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get the next available liquidity pool id.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get information and metadata associated with foreign assets.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get information associated with nomination pools.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get information and metadata associated with a nomination pool.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get a list of all on-going referenda that have track root (0) and whitelisted (1), along with their associated information.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get a list of constants for a pallet.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get the value of a constant item.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get a list of dispatchables for a pallet.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get the value of a dispatchable item.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get a list of errors for a pallet.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get the value of an error item.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get a list of events for a pallet.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get the value of an event item.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get a list of storage items for a pallet.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get the value of a storage item.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get information and metadata associated with a pool asset.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get progress on the general Staking pallet system.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get all validators (active/waiting) of a specific chain.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
runtime
Get the runtime metadata in decoded, JSON form.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get the requested version of runtime metadata in decoded, JSON form.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get the available versions of runtime metadata.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get the runtime wasm blob.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get version information of the Substrate runtime.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns version information related to the runtime.
Parameters
atstring<unsignedInteger or $hex>queryBlock at which to retrieve runtime version information at.
Response
successful operation
transaction
Submit a transaction to the node's transaction pool.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Accepts a valid signed extrinsic. Replaces /tx from versions < v1.0.0.
Body
txstring<hex>Response
successful operation
failed to parse or submit transaction
Dry run an extrinsic.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Receive a fee estimate for a transaction.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get all the network information needed to construct a transaction offline.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get all the network information needed to construct a transaction offline and the version of metadata specified in metadataVersion.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
paras
[DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] List all registered paras (parathreads & parachains).
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
[DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] Get general information about the current lease period.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
[DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] Get the status of the current auction.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
[DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] List all stored crowdloans.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
[DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] Get crowdloan information for a paraId.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
[DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] Get current and future leases as well as the lifecycle stage for a given paraId.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
[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.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
[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.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
trace
[Experimental - subject to breaking change.] Get traces for the most recently finalized block.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
[Experimental - subject to breaking change.] Get traces for the given blockId.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
[Experimental - subject to breaking change.] Get the operations from the most recently finalized block.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
[Experimental - subject to breaking change.] Get the operations from the specified block.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
staking
Get staking information for a Stash account.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get payout information for a Stash account.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get progress on the general Staking pallet system.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get all validators (active/waiting) of a specific chain.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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