Skip to main content

/pallets/{palletId}/dispatchables/{dispatchableItemId} REST API Endpoint

Get the value of a dispatchable item.

Updated on
Sep 02, 2024

Path Parameters

palletId
string
REQUIRED

The name or index of the pallet to read dispatchable metadata for.

dispatchableItemId
string
REQUIRED

The id of the dispatchable item to query for

Query Parameters

metadata
boolean

Include the dispatchable items metadata (including documentation) if set to true.

Returns

at
object

An object containing information about the state

hash
string

The block's hash

height
string

The block's height

pallet
string

The name of the pallet (or module) within the blockchain runtime

palletIndex
string

The index of the pallet within the runtime

dispatchableItem
string

The id of the dispatchable item to query for

metadata
object

The metadata object which contains the following fields:

name
string

The name of the dispatchable item

fields
array

An array of field definitions for the method, where each field represents an input parameter or data structure used in the function. Each field includes:

name
string

The name of the field, describing what data it holds

type
string

A numeric identifier representing the type of the field

typeName
string

A string indicating the actual data type

docs
array

An array of strings providing documentation for the field

index
string

A numeric string that represents the index or position of the function within the pallet

docs
array

An array of documentation strings that describe the function

args
array

An array describing the arguments required by the function. Each argument includes:

name
string

The name of the argument

type
string

The argument's type

typeName
string

A string that names the type in a more descriptive or structured way

Request
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free