Skip to main content

/transaction/material/{metadataVersion} REST API Endpoint

Returns all the materials necessary for constructing any signed transactions offline.

Updated on
Sep 2, 2024

/transaction/material/{metadataVersion} REST API Endpoint

Path Parameters

metadataVersion
string
REQUIRED
The 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.

Query Parameters

at
string
Block at which to retrieve the transaction construction material.
metadata
string
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

at
object
An object containing information about the state
hash
string
The block's hash
height
string
The block's height
genesisHash
string
The hash of the genesis block
chainName
string
The name of the blockchain network
specName
string
The name of the blockchain specification
specVersion
string
The version number of the blockchain specification being used
txVersion
string
The version number of the transaction format, ensuring compatibility with different versions of the blockchain
magicNumber
string
A unique identifier for the metadata format version
metadata
object
The metadata object which contains the following fields:
v14
object
The v14 object which contains the following fields:
lookup
object
Provides a mapping and definition of types used within the runtime
types
array
A list of types defining the data structures used in the blockchain
id
string
Identifier for the specific type
type
object
Describes the type's structure and attributes
path
string
Specifies the module path to the type
params
array
Lists any parameters associated with the type
def
object
The def object which contains the following fields:
composite
object
The composite object which contains the following fields:
fields
array
Describes the individual fields within the composite type
name
string
The name of the field
type
string
The type identifier of the field
typeName
string
The human-readable name of the field's type
docs
array
The documentation or comments about the field
docs
array
The documentation or comments about the type
pallets
array
Lists the runtime modules (pallets) and their associated components
name
string
The name of the pallet
storage
object
The storage object which contains the following fields:
prefix
string
The prefix used for storage items in this pallet
items
array
Lists the storage items within the pallet
name
string
The name of the storage item
modifier
string
Specifies the modifier type
type
object
The type object which contains the following fields:
map
object
The map object which contains the following fields:
hashers
string
List of hash functions used for the key
key
string
The type identifier for the key
value
string
The type identifier for the value
fallback
string
Default value used when no value is stored
docs
string
Documentation or comments about the storage item
calls
object
Describes the callable functions provided by the pallet
type
string
The type identifier for the calls
events
object
Describes the events emitted by the pallet
type
string
The type identifier for the events
constants
array
Lists the constant values defined within the pallet
name
string
The name of the constant
type
string
The type identifier for the constant
value
object
The value object which contains the following fields:
baseBlock
object
The baseBlock object which contains the following fields:
refTime
string
The reference time for the base block
proofSize
string
The size of the proof for the base block
maxBlock
object
The maxBlock object which contains the following fields:
refTime
string
The reference time for the maximum block
proofSize
string
The size of the proof for the maximum block.
perClass
object
The perClass object which contains the following fields:
normal
object
The normal object which contains the following fields:
baseExtrinsic
object
The baseExtrinsic object which contains the following fields:
refTime
string
The reference time for the base extrinsic
proofSize
string
The proof size for the base extrinsic
maxExtrinsic
object
The maxExtrinsic object which contains the following fields:
refTime
string
The reference time for the maximum extrinsic
proofSize
string
The proof size for the maximum total
maxTotal
object
The maxTotal object which contains the following fields:
refTime
string
The reference time for the maximum total
proofSize
string
The proof size for the maximum total
reserved
object
The reserved object which contains the following fields:
refTime
string
The reference time for the reserved total
proofSize
string
The proof size for the reserved total
operational
object
The operational object which contains the following fields:
baseExtrinsic
object
The baseExtrinsic object which contains the following fields:
refTime
string
The reference time for the baseExtrinsic total
proofSize
string
The proof size for the baseExtrinsic total
maxExtrinsic
object
The maxExtrinsic object which contains the following fields:
refTime
string
The reference time for the maxExtrinsic total
proofSize
string
The proof size for the maxExtrinsic total
maxTotal
object
The maxTotal object which contains the following fields:
refTime
string
The reference time for the maxTotal
proofSize
string
The proof size for the maxTotal
reserved
object
The reserved object which contains the following fields:
refTime
string
The reference time for the reserved total
proofSize
string
The proof size for the reserved total
mandatory
object
The mandatory object which contains the following fields:
baseExtrinsic
object
The baseExtrinsic object which contains the following fields:
refTime
string
The reference time for the baseExtrinsic total
proofSize
string
The proof size for the baseExtrinsic total
maxExtrinsic
object
The maxExtrinsic object which contains the following fields:
refTime
string
The reference time for the maxExtrinsic total
proofSize
string
The proof size for the maxExtrinsic total
maxTotal
object
The maxTotal object which contains the following fields:
refTime
string
The reference time for the maxTotal
proofSize
string
The proof size for the maxTotal
reserved
object
The reserved object which contains the following fields:
refTime
string
The reference time for the reserved total
proofSize
string
The proof size for the reserved total
docs
string
Documentation or comments about the constant
errors
object
The errors object which contains the following fields:
type
string
The type identifier for the errors
index
string
The index or identifier of the pallet within the runtime
extrinsic
object
The extrinsic object which contains the following fields:
type
string
The type identifier for the extrinsics
version
string
The version of the extrinsic format
signedExtensions
array
Lists additional checks or data required for signed extrinsics
identifier
string
The name of the signed extension
type
string
The type identifier for the signed extension
additionalSigned
string
Additional data required by the signed extension
type
string
The type identifier for the metadata structure
apis
array
An array containing details about different APIs implemented in the runtime
name
string
The name of the API or method
methods
array
An array containing the details of the methods available within the API
name
string
The name of the method within the API
inputs
array
An array of objects specifying the inputs required by the method
output
string
A string indicating the output type or identifier returned by the method
docs
array
An array of strings providing documentation or descriptions specific to the method
docs
array
An array of strings providing documentation or descriptions specific to the api
outerEnums
object
An object defining mappings for outer enums used in the runtime
callType
string
The type identifier for runtime calls
eventType
string
The type identifier for runtime events
errorType
string
The type identifier for runtime errors
custom
object
The custom object which contains the following fields:
map
object
A custom key-value mapping
Request
1
curl --location 'https://docs-demo.dot-mainnet.quiknode.pro/transaction/material/v15' \
2
--header 'Accept: application/json'
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free