Path Parameters
- metadataVersionstringREQUIRED
The version of metadata. The input is expected in a
vXformat, whereXrepresents the version number (e.g.v14,v15). By default, metadata is outputted in 'json' format, unless themetadataquery parameter is provided, in which case it can be either in 'json' or 'scale' format.
Query Parameters
- atstring
Block at which to retrieve the transaction construction material.
- metadatastring
Specifies 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.
Returns
- atobject
An object containing information about the state
- hashstring
The block's hash
- heightstring
The block's height
- genesisHashstring
The hash of the genesis block
- chainNamestring
The name of the blockchain network
- specNamestring
The name of the blockchain specification
- specVersionstring
The version number of the blockchain specification being used
- txVersionstring
The version number of the transaction format, ensuring compatibility with different versions of the blockchain
- magicNumberstring
(Optional) A unique identifier for the metadata format version
- metadataobject
(Optional) The metadata object which contains the following fields:
- v14object
The v14 object which contains the following fields:
- lookupobject
Provides a mapping and definition of types used within the runtime
- typesarray
A list of types defining the data structures used in the blockchain
- idstring
Identifier for the specific type
- typeobject
Describes the type's structure and attributes
- pathstring
Specifies the module path to the type
- paramsarray
Lists any parameters associated with the type
- defobject
The def object which contains the following fields:
- compositeobject
The composite object which contains the following fields:
- fieldsarray
Describes the individual fields within the composite type
- namestring
The name of the field
- typestring
The type identifier of the field
- typeNamestring
The human-readable name of the field's type
- docsarray
The documentation or comments about the field
- docsarray
The documentation or comments about the type
- palletsarray
Lists the runtime modules (pallets) and their associated components
- namestring
The name of the pallet
- storageobject
The storage object which contains the following fields:
- prefixstring
The prefix used for storage items in this pallet
- itemsarray
Lists the storage items within the pallet
- namestring
The name of the storage item
- modifierstring
Specifies the modifier type
- typeobject
The type object which contains the following fields:
- mapobject
The map object which contains the following fields:
- hashersstring
List of hash functions used for the key
- keystring
The type identifier for the key
- valuestring
The type identifier for the value
- fallbackstring
Default value used when no value is stored
- docsstring
Documentation or comments about the storage item
- callsobject
Describes the callable functions provided by the pallet
- typestring
The type identifier for the calls
- eventsobject
Describes the events emitted by the pallet
- typestring
The type identifier for the events
- constantsarray
Lists the constant values defined within the pallet
- namestring
The name of the constant
- typestring
The type identifier for the constant
- valueobject
The value object which contains the following fields:
- baseBlockobject
The baseBlock object which contains the following fields:
- refTimestring
The reference time for the base block
- proofSizestring
The size of the proof for the base block
- maxBlockobject
The maxBlock object which contains the following fields:
- refTimestring
The reference time for the maximum block
- proofSizestring
The size of the proof for the maximum block.
- perClassobject
The perClass object which contains the following fields:
- normalobject
The normal object which contains the following fields:
- baseExtrinsicobject
The baseExtrinsic object which contains the following fields:
- refTimestring
The reference time for the base extrinsic
- proofSizestring
The proof size for the base extrinsic
- maxExtrinsicobject
The maxExtrinsic object which contains the following fields:
- refTimestring
The reference time for the maximum extrinsic
- proofSizestring
The proof size for the maximum total
- maxTotalobject
The maxTotal object which contains the following fields:
- refTimestring
The reference time for the maximum total
- proofSizestring
The proof size for the maximum total
- reservedobject
The reserved object which contains the following fields:
- refTimestring
The reference time for the reserved total
- proofSizestring
The proof size for the reserved total
- operationalobject
The operational object which contains the following fields:
- baseExtrinsicobject
The baseExtrinsic object which contains the following fields:
- refTimestring
The reference time for the baseExtrinsic total
- proofSizestring
The proof size for the baseExtrinsic total
- maxExtrinsicobject
The maxExtrinsic object which contains the following fields:
- refTimestring
The reference time for the maxExtrinsic total
- proofSizestring
The proof size for the maxExtrinsic total
- maxTotalobject
The maxTotal object which contains the following fields:
- refTimestring
The reference time for the maxTotal
- proofSizestring
The proof size for the maxTotal
- reservedobject
The reserved object which contains the following fields:
- refTimestring
The reference time for the reserved total
- proofSizestring
The proof size for the reserved total
- mandatoryobject
The mandatory object which contains the following fields:
- baseExtrinsicobject
The baseExtrinsic object which contains the following fields:
- refTimestring
The reference time for the baseExtrinsic total
- proofSizestring
The proof size for the baseExtrinsic total
- maxExtrinsicobject
The maxExtrinsic object which contains the following fields:
- refTimestring
The reference time for the maxExtrinsic total
- proofSizestring
The proof size for the maxExtrinsic total
- maxTotalobject
The maxTotal object which contains the following fields:
- refTimestring
The reference time for the maxTotal
- proofSizestring
The proof size for the maxTotal
- reservedobject
The reserved object which contains the following fields:
- refTimestring
The reference time for the reserved total
- proofSizestring
The proof size for the reserved total
- docsstring
Documentation or comments about the constant
- errorsobject
The errors object which contains the following fields:
- typestring
The type identifier for the errors
- indexstring
The index or identifier of the pallet within the runtime
- extrinsicobject
The extrinsic object which contains the following fields:
- typestring
The type identifier for the extrinsics
- versionstring
The version of the extrinsic format
- signedExtensionsarray
Lists additional checks or data required for signed extrinsics
- identifierstring
The name of the signed extension
- typestring
The type identifier for the signed extension
- additionalSignedstring
Additional data required by the signed extension
- typestring
The type identifier for the metadata structure
- apisarray
An array containing details about different APIs implemented in the runtime
- namestring
The name of the API or method
- methodsarray
An array containing the details of the methods available within the API
- namestring
The name of the method within the API
- inputsarray
An array of objects specifying the inputs required by the method
- outputstring
A string indicating the output type or identifier returned by the method
- docsarray
An array of strings providing documentation or descriptions specific to the method
- docsarray
An array of strings providing documentation or descriptions specific to the api
- outerEnumsobject
An object defining mappings for outer enums used in the runtime
- callTypestring
The type identifier for runtime calls
- eventTypestring
The type identifier for runtime events
- errorTypestring
The type identifier for runtime errors
- customobject
The custom object which contains the following fields:
- mapobject
A custom key-value mapping