openapi: 3.0.0 info: title: Substrate API Sidecar description: | > ⚠️ **Deprecation Notice** — `substrate-api-sidecar` is deprecated in favor of > [`polkadot-rest-api`](https://github.com/paritytech/polkadot-rest-api), a ground-up Rust rewrite > built on [`subxt`](https://github.com/paritytech/subxt) with 1:1 API compatibility (endpoints > served under `/v1/`, e.g. `/v1/blocks/head`), stable memory under sustained load, significantly > lower latency and higher throughput, and native SCALE decoding via `parity-scale-codec`. > > **Migrate today:** Docker `paritytech/polkadot-rest-api:v0.1.0` · > [crate](https://crates.io/crates/polkadot-rest-api) · > [migration guide](https://github.com/paritytech/polkadot-rest-api/blob/main/docs/guides/MIGRATION.md) · > [docs](https://paritytech.github.io/polkadot-rest-api/) · > [issues](https://github.com/paritytech/polkadot-rest-api/issues) Substrate API Sidecar is a REST service that makes it easy to interact with blockchain nodes built using Substrate's FRAME framework. contact: url: https://github.com/paritytech/substrate-api-sidecar license: name: GPL-3.0-or-later url: https://github.com/paritytech/substrate-api-sidecar/blob/master/LICENSE version: 20.14.1 servers: - url: https://polkadot-public-sidecar.parity-chains.parity.io/ description: Polkadot Parity public sidecar - url: https://kusama-public-sidecar.parity-chains.parity.io/ description: Kusama Parity public sidecar - url: https://polkadot-asset-hub-public-sidecar.parity-chains.parity.io/ description: Polkadot Asset Hub Parity public sidecar - url: https://kusama-asset-hub-public-sidecar.parity-chains.parity.io/ description: Kusama Asset Hub Parity public sidecar - url: http://localhost:8080 description: Localhost tags: - name: accounts - name: ahm description: Asset Hub Migration information - name: blocks - name: contracts - name: coretime - name: node description: node connected to sidecar - name: pallets description: pallets employed in the runtime - name: runtime - name: transaction - name: paras - name: trace - name: rc description: relay chain specific endpoints for asset hub paths: /accounts/{accountId}/asset-balances: get: tags: - accounts summary: Get an array of asset-balances for an account. description: 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. operationId: getAssetBalances parameters: - name: accountId in: path description: SS58 address of the account. required: true schema: type: string format: SS58 - name: at in: query description: Block at which to query asset-balance info for the specified account. required: false schema: type: string description: Block height (as a positive integer) or hash (as a hex string). format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s). Only supported for Asset Hub endpoints. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. - name: assets in: query description: An 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`. required: false schema: type: array items: type: string description: An array of assetId numbers represented as strings format: Array of unsignedInteger's responses: "200": description: successfull operation content: application/json: schema: oneOf: - $ref: '#/components/schemas/AccountAssetsBalances' - type: array items: $ref: '#/components/schemas/AccountAssetsBalances' description: Returns a single object when using 'at' parameter or no query params. Returns an array when using 'useRcBlock' parameter (array contains one object per Asset Hub block found, or empty array if none found). "400": description: Invalid Address, invalid blockId supplied for at query param, or invalid parameter combination content: application/json: schema: $ref: '#/components/schemas/Error' /accounts/{accountId}/asset-approvals: get: tags: - accounts summary: Get an asset approval for an account. description: Returns information about an account's asset approval transaction. It is required to pass in a delegate and an assetId as query parameters. operationId: getAssetApprovals parameters: - name: accountId in: path description: SS58 address of the account. required: true schema: type: string format: SS58 - name: at in: query description: Block at which to query asset approval info for the specified account. required: false schema: type: string description: Block height (as a non-negative integer) or hash (as a hex string). format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s). Only supported for Asset Hub endpoints. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. - name: assetId in: query description: The `assetId` associated with the asset-approval. required: true schema: type: string description: An assetId represented as an unsignedInteger. format: unsignedInteger - name: delegate in: query description: The delegate's `accountId` associated with an asset-approval. required: true schema: type: string format: SS58 responses: "200": description: successfull operation content: application/json: schema: oneOf: - $ref: '#/components/schemas/AccountAssetsApproval' - type: array items: $ref: '#/components/schemas/AccountAssetsApproval' description: Returns a single object when using standard parameters. Returns an array when using 'useRcBlock' parameter (array contains one object per Asset Hub block found, or empty array if none found). "400": description: Invalid Address, invalid blockId supplied for at query param, or invalid parameter combination content: application/json: schema: $ref: '#/components/schemas/Error' /accounts/{accountId}/balance-info: get: tags: - accounts summary: Get balance information for an account. description: Returns information about an account's balance. Replaces `/balance/{address}` from versions < v1.0.0. operationId: getAccountBalanceInfo parameters: - name: accountId in: path description: SS58 address of the account. required: true schema: type: string format: SS58 - name: at in: query description: Block at which to query balance info for the specified account. required: false schema: type: string description: Block height (as a non-negative integer) or hash (as a hex string). format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving balance info. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. - name: token in: query description: 'Token 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.' required: false schema: type: string description: Token symbol - name: denominated in: query description: When set to `true` it will denominate any balance's given atomic value using the chains given decimal value. required: false schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: oneOf: - $ref: '#/components/schemas/AccountBalanceInfo' - type: array items: $ref: '#/components/schemas/AccountBalanceInfo' description: Returns a single object when using standard parameters. Returns an array when using 'useRcBlock' parameter (array contains one object per Asset Hub block found, or empty array if none found). "400": description: Invalid Address, invalid blockId supplied for at query param, or invalid parameter combination content: application/json: schema: $ref: '#/components/schemas/Error' "404": description: account not found content: application/json: schema: $ref: '#/components/schemas/Error' /accounts/{accountId}/convert: get: tags: - accounts summary: Convert a given AccountId to an SS58 address. description: 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). operationId: accountConvert parameters: - name: accountId in: path description: AccountId or Public Key (hex). required: true schema: format: AccountId or Hex type: string - name: scheme in: query description: The 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). required: false schema: type: string format: string default: 'sr25519' - name: prefix in: query description: The address prefix which can be one of the values found in the SS58-registry. required: false schema: type: string format: number default: 42 - name: publicKey in: query description: Defines if the given value in the path parameter is a Public Key (hex) or not (hence AccountId). required: false schema: type: string format: boolean default: true responses: "200": description: successfully converted the AccountId and retrieved the address info. content: application/json: schema: $ref: '#/components/schemas/AccountConvert' "400": description: Invalid AccountId content: application/json: schema: $ref: '#/components/schemas/Error' "404": description: AccountId not found content: application/json: schema: $ref: '#/components/schemas/Error' /accounts/{accountId}/pool-asset-balances: get: tags: - accounts summary: Get an array of pool-asset-balances for an account. description: 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. operationId: getPoolAssetBalances parameters: - name: accountId in: path description: SS58 address of the account. required: true schema: type: string format: SS58 - name: at in: query description: Block at which to query pool-asset-balance info for the specified account. required: false schema: type: string description: Block height (as a positive integer) or hash (as a hex string). format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving pool-asset-balance info. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. - name: assets in: query description: An 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`. required: false schema: type: array items: type: string description: A list of assetId numbers represented as strings format: Array of unsignedInteger's responses: "200": description: successfull operation content: application/json: schema: oneOf: - $ref: '#/components/schemas/AccountPoolAssetsBalances' - type: array items: $ref: '#/components/schemas/AccountPoolAssetsBalances' description: Returns a single object when using standard parameters. Returns an array when using 'useRcBlock' parameter (array contains one object per Asset Hub block found, or empty array if none found). "400": description: Invalid Address, invalid blockId supplied for at query param, or invalid parameter combination content: application/json: schema: $ref: '#/components/schemas/Error' /accounts/{accountId}/pool-asset-approvals: get: tags: - accounts summary: Get an asset approval for an account. description: Returns information about an account's asset approval transaction. It is required to pass in a delegate and an assetId as query parameters. operationId: getPoolAssetApprovals parameters: - name: accountId in: path description: SS58 address of the account. required: true schema: type: string format: SS58 - name: at in: query description: Block at which to query asset approval info for the specified account. required: false schema: type: string description: Block height (as a non-negative integer) or hash (as a hex string). format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving pool-asset-approval info. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. - name: assetId in: query description: The `assetId` associated with the asset-approval. required: true schema: type: string description: An assetId represented as an unsignedInteger. format: unsignedInteger - name: delegate in: query description: The delegate's `accountId` associated with an asset-approval. required: true schema: type: string format: SS58 responses: "200": description: successfull operation content: application/json: schema: oneOf: - $ref: '#/components/schemas/AccountAssetsApproval' - type: array items: $ref: '#/components/schemas/AccountAssetsApproval' description: Returns a single object when using standard parameters. Returns an array when using 'useRcBlock' parameter (array contains one object per Asset Hub block found, or empty array if none found). "400": description: Invalid Address, invalid blockId supplied for at query param, or invalid parameter combination content: application/json: schema: $ref: '#/components/schemas/Error' /accounts/{accountId}/foreign-asset-balances: get: tags: - accounts summary: Get an array of foreign-asset-balances for an account. description: Returns information about an account's foreign-asset-balances. This is specific to the foreignAssets pallet for parachains. If no `foreignAssets` query parameter is provided, all foreign-asset-balances for the given account will be returned. operationId: getForeignAssetBalances parameters: - name: accountId in: path description: SS58 address of the account. required: true schema: type: string format: SS58 - name: at in: query description: Block at which to query foreign-asset-balance info for the specified account. required: false schema: type: string description: Block height (as a positive integer) or hash (as a hex string). format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving foreign-asset-balance info. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. - name: foreignAssets in: query description: An array of multilocation JSON strings to be queried. If not supplied, all foreign asset balances associated with the `accountId` will be returned. The array query param format follows Express 4.x API. ex:`?foreignAssets[]={"parents":"1","interior":{"X1":{"Parachain":"2125"}}}&foreignAssets[]={"parents":"2","interior":{"X1":{"GlobalConsensus":"Polkadot"}}}`. required: false schema: type: array items: type: string description: An array of multilocation objects represented as JSON strings. format: Array of JSON strings responses: "200": description: successful operation content: application/json: schema: oneOf: - $ref: '#/components/schemas/AccountForeignAssetsBalances' - type: array items: $ref: '#/components/schemas/AccountForeignAssetsBalances' description: Returns a single object when using standard parameters. Returns an array when using 'useRcBlock' parameter (array contains one object per Asset Hub block found, or empty array if none found). "400": description: Invalid Address, invalid blockId supplied for at query param, or invalid parameter combination content: application/json: schema: $ref: '#/components/schemas/Error' /accounts/{accountId}/proxy-info: get: tags: - accounts summary: Get proxy account information. description: Returns information about a proxy account. This will include delegated accounts and deposits held. operationId: getProxyInfo parameters: - name: accountId in: path description: SS58 address of the account. required: true schema: type: string format: SS58 - name: at in: query description: Block at which to query proxy info for the specified account. required: false schema: type: string description: Block height (as a non-negative integer) or hash (as a hex string). format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving proxy info. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successfull operation content: application/json: schema: oneOf: - $ref: '#/components/schemas/AccountProxyInfo' - type: array items: $ref: '#/components/schemas/AccountProxyInfo' description: Returns a single object when using standard parameters. Returns an array when using 'useRcBlock' parameter (array contains one object per Asset Hub block found, or empty array if none found). "400": description: Invalid Address, invalid blockId supplied for at query param, or invalid parameter combination content: application/json: schema: $ref: '#/components/schemas/Error' /accounts/{accountId}/staking-info: get: tags: - staking summary: Get staking information for a _Stash_ account. description: 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. operationId: getStakingSummaryByAccountId parameters: - name: accountId in: path description: SS58 address of the account. Must be a _Stash_ account. required: true schema: format: SS58 type: string - name: at in: query description: Block at which to query the staking info for the specified account. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving staking info. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. - name: includeClaimedRewards in: query description: When set to `false`, the `claimedRewards` field is not included in the response. required: false schema: type: string format: boolean default: true responses: "200": description: successful operation content: application/json: schema: oneOf: - $ref: '#/components/schemas/AccountStakingInfo' - type: array items: $ref: '#/components/schemas/AccountStakingInfo' description: Returns a single object when using standard parameters. Returns an array when using 'useRcBlock' parameter (array contains one object per Asset Hub block found, or empty array if none found). "400": description: invalid blockId supplied for at query param, or invalid parameter combination content: application/json: schema: $ref: '#/components/schemas/Error' "404": description: account not found content: application/json: schema: $ref: '#/components/schemas/Error' /accounts/{accountId}/staking-payouts: get: tags: - staking summary: Get payout information for a _Stash_ account. description: | 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). **Asset Hub Migration Support:** For Asset Hub chains that have migrated staking from the relay chain, this endpoint automatically handles era query routing: - **Pre-migration eras**: Queries historical data from the relay chain - **Post-migration eras**: Queries current data from Asset Hub - **Cross-migration queries**: Automatically splits the era range and combines results from both chains **Note:** 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. operationId: getStakingPayoutsByAccountId parameters: - name: accountId in: path description: SS58 address of the account. Must be a _Stash_ account. required: true schema: format: SS58 type: string - name: at in: query description: Block at which to query staking payouts. required: false schema: type: string description: Block height (as a non-negative integer) or hash (as a hex string). format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving staking payouts. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. - name: depth in: query description: The 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. required: false schema: type: string format: unsignedInteger default: 1 - name: era in: query description: The era to query at. required: false schema: type: string format: unsignedInteger default: '`active_era - 1`' - name: unclaimedOnly in: query description: Only return unclaimed rewards. required: false schema: type: string format: boolean default: true responses: "200": description: successful operation content: application/json: schema: oneOf: - $ref: '#/components/schemas/AccountStakingPayouts' - type: array items: $ref: '#/components/schemas/AccountStakingPayouts' description: | **Standard Mode**: Returns a single object when using standard parameters (without useRcBlock). **Relay Chain Block Mode**: Returns an array when using 'useRcBlock' parameter (array contains one object per Asset Hub block found, or empty array if none found). **Asset Hub Migration**: For both modes, when querying eras that span the Asset Hub migration boundary, the endpoint automatically fetches and combines data from both relay chain (pre-migration eras) and Asset Hub (post-migration eras). The migration handling is transparent to the user - you get complete payout information regardless of which chain originally held the data. "400": description: invalid blockId supplied for at query param, or invalid parameter combination content: application/json: schema: $ref: '#/components/schemas/Error' "404": description: account not found content: application/json: schema: $ref: '#/components/schemas/Error' /accounts/{accountId}/vesting-info: get: tags: - accounts summary: Get vesting information for an account. description: Returns the vesting schedule for an account. Replaces `/vesting/{address}` from versions < v1.0.0. operationId: getVestingSummaryByAccountId parameters: - name: accountId in: path description: SS58 address of the account. required: true schema: format: SS58 type: string - name: at in: query description: Block at which to query the vesting info for the specified account. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving vesting info. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. - name: includeClaimable in: query description: When set to 'true', calculates and includes vested amounts for each vesting schedule plus the claimable amount. For Asset Hub post-migration queries, this requires a relay chain connection since vesting schedules use relay chain block numbers. required: false schema: type: boolean responses: "200": description: successful operation content: application/json: schema: oneOf: - $ref: '#/components/schemas/AccountVestingInfo' - type: array items: $ref: '#/components/schemas/AccountVestingInfo' description: Returns a single object when using standard parameters. Returns an array when using 'useRcBlock' parameter (array contains one object per Asset Hub block found, or empty array if none found). "400": description: Invalid Address, invalid blockId supplied for at query param, or invalid parameter combination content: application/json: schema: $ref: '#/components/schemas/Error' "404": description: account not found content: application/json: schema: $ref: '#/components/schemas/Error' /accounts/{address}/validate: get: tags: - accounts summary: Validate a given address. description: 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. operationId: getValidationByAccountId parameters: - name: address in: path description: SS58 or Hex address of the account. required: true schema: format: SS58 or Hex type: string responses: "200": description: successfully retrieved address info content: application/json: schema: $ref: '#/components/schemas/AccountValidation' /accounts/compare: get: tags: - accounts summary: Compares up to 30 SS58 addresses. description: 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. operationId: accountCompare parameters: - name: addresses in: query description: An 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=...,...`. required: true schema: type: array items: type: string description: An array of SS58 addresses. responses: "200": description: successfully compared at least two SS58 addresses. content: application/json: schema: $ref: '#/components/schemas/AccountCompare' "400": description: Invalid Address content: application/json: schema: $ref: '#/components/schemas/Error' /ahm-info: get: tags: - ahm summary: Get Asset Hub Migration information. description: Returns information about Asset Hub Migration (AHM) including migration start and end blocks for both relay chain and Asset Hub. The endpoint automatically detects whether you're connected to a relay chain or Asset Hub and provides relevant migration data. Returns static migration boundaries for known networks or queries on-chain migration pallets for dynamic information. operationId: getAhmInfo responses: "200": description: Successfully retrieved Asset Hub Migration information content: application/json: schema: $ref: '#/components/schemas/AhmInfo' "400": description: Invalid chain specName or missing migration pallets content: application/json: schema: $ref: '#/components/schemas/Error' "500": description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' /rc/accounts/{address}/balance-info: get: tags: - rc accounts summary: Get balance information for an account on the relay chain. description: Returns information about an account's balance on the relay chain. This endpoint is specifically for Asset Hub and queries the relay chain (Polkadot/Kusama) for balance information. operationId: getRcAccountBalanceInfo parameters: - name: address in: path description: SS58 address of the account. required: true schema: type: string format: SS58 - name: at in: query description: Block at which to query balance info for the specified account. required: false schema: type: string description: Block height (as a non-negative integer) or hash (as a hex string). format: unsignedInteger or $hex - name: token in: query description: 'Token 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.' required: false schema: type: string description: Token symbol - name: denominated in: query description: When set to `true` it will denominate any balance's given atomic value using the chains given decimal value. required: false schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/AccountBalanceInfo' "400": description: Invalid Address content: application/json: schema: $ref: '#/components/schemas/Error' "404": description: account not found content: application/json: schema: $ref: '#/components/schemas/Error' /rc/accounts/{address}/proxy-info: get: tags: - rc accounts summary: Get proxy information for an account on the relay chain. description: Returns information about an account's proxy configuration on the relay chain. This endpoint is specifically for Asset Hub and queries the relay chain (Polkadot/Kusama) for proxy information. operationId: getRcAccountProxyInfo parameters: - name: address in: path description: SS58 address of the account. required: true schema: type: string format: SS58 - name: at in: query description: Block at which to query proxy info for the specified account. required: false schema: type: string description: Block height (as a non-negative integer) or hash (as a hex string). format: unsignedInteger or $hex responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/AccountProxyInfo' "400": description: Invalid Address content: application/json: schema: $ref: '#/components/schemas/Error' "404": description: account not found content: application/json: schema: $ref: '#/components/schemas/Error' /rc/accounts/{address}/vesting-info: get: tags: - rc accounts summary: Get vesting information for an account on the relay chain. description: Returns the vesting schedule for an account on the relay chain. This endpoint is specifically for Asset Hub and queries the relay chain (Polkadot/Kusama) for vesting information. operationId: getRcAccountVestingInfo parameters: - name: address in: path description: SS58 address of the account. required: true schema: type: string format: SS58 - name: at in: query description: Block at which to query the vesting info for the specified account. required: false schema: type: string description: Block height (as a non-negative integer) or hash (as a hex string). format: unsignedInteger or $hex - name: includeClaimable in: query description: When set to 'true', calculates and includes vested amounts for each vesting schedule plus the claimable amount. For relay chain pre-migration queries, vested amounts are calculated using the relay chain's own block number. required: false schema: type: boolean responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/AccountVestingInfo' "400": description: Invalid Address content: application/json: schema: $ref: '#/components/schemas/Error' "404": description: account not found content: application/json: schema: $ref: '#/components/schemas/Error' /rc/accounts/{address}/staking-info: get: tags: - rc accounts - rc staking summary: Get staking information for a _Stash_ account on the relay chain. description: Returns information about a _Stash_ account's staking activity on the relay chain. This endpoint is specifically for Asset Hub and queries the relay chain (Polkadot/Kusama) for staking information. The _Stash_ account can be either a validator or nominator account. operationId: getRcAccountStakingInfo parameters: - name: address in: path description: SS58 address of the account. Must be a _Stash_ account. required: true schema: type: string format: SS58 - name: at in: query description: Block at which to query the staking info for the specified account. required: false schema: type: string description: Block height (as a non-negative integer) or hash (as a hex string). format: unsignedInteger or $hex - name: includeClaimedRewards in: query description: When set to `false`, the `claimedRewards` field is not included in the response. required: false schema: type: string format: boolean default: true responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/AccountStakingInfo' "400": description: Invalid Address content: application/json: schema: $ref: '#/components/schemas/Error' "404": description: account not found content: application/json: schema: $ref: '#/components/schemas/Error' /rc/accounts/{address}/staking-payouts: get: tags: - rc accounts - rc staking summary: Get payout information for a _Stash_ account on the relay chain. description: Returns payout information for the last specified eras on the relay chain. This endpoint is specifically for Asset Hub and queries the relay chain (Polkadot/Kusama) for staking payout information. 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). The _Stash_ account can be either a validator or nominator account. operationId: getRcAccountStakingPayouts parameters: - name: address in: path description: SS58 address of the account. Must be a _Stash_ account. required: true schema: type: string format: SS58 - name: at in: query description: Block at which to query staking payouts. required: false schema: type: string description: Block height (as a non-negative integer) or hash (as a hex string). format: unsignedInteger or $hex - name: depth in: query description: The 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. required: false schema: type: string format: unsignedInteger default: 1 - name: era in: query description: The era to query at. Max era payout info is available for is the latest finished era (active_era - 1). required: false schema: type: string format: unsignedInteger - name: unclaimedOnly in: query description: Only return unclaimed rewards. required: false schema: type: string format: boolean default: true responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/AccountStakingPayouts' "400": description: Invalid Address content: application/json: schema: $ref: '#/components/schemas/Error' "404": description: account not found content: application/json: schema: $ref: '#/components/schemas/Error' /rc/node/network: get: tags: - rc node summary: Get relay chain node network information from Asset Hub. description: Returns network related information of the relay chain node. This endpoint is specifically for Asset Hub instances to query relay chain node networking details. operationId: getRcNodeNetworking responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/NodeNetwork' /rc/node/transaction-pool: get: tags: - rc node summary: Get relay chain pending extrinsics from Asset Hub. description: Returns pending extrinsics from the relay chain transaction pool. This endpoint is specifically for Asset Hub instances to query relay chain pending transactions. operationId: getRcNodeTransactionPool parameters: - name: includeFee in: query description: Boolean representing whether or not to include tips, partialFee, and priority in each extrinsic. required: false schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/TransactionPool' /rc/node/version: get: tags: - rc node summary: Get relay chain node version information from Asset Hub. description: Returns versioning information of the relay chain node. This endpoint is specifically for Asset Hub instances to query relay chain node version details. operationId: getRcNodeVersion responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/NodeVersion' /rc/blocks: get: tags: - rc blocks summary: Get a range of relay chain blocks by their height. description: Given a range query parameter return an array of all the relay chain blocks within that range. operationId: getRcBlocks parameters: - name: range in: query description: A range of integers. There is a max limit of 500 blocks per request. required: true example: 0-499 schema: type: string - name: eventDocs in: query description: When set to `true`, every event will have an extra `docs` property. schema: type: boolean default: false - name: extrinsicDocs in: query description: When set to `true`, every extrinsic will have an extra `docs` property. schema: type: boolean default: false - name: noFees in: query description: When set to `true`, no fee information is calculated. schema: type: boolean default: false - name: useEvmFormat in: query description: When set to `true`, every extrinsic's event emitted by pallet-revive will have the address data formatted to EVM. required: false schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: type: array items: $ref: '#/components/schemas/Block' "400": description: invalid blockId supplied content: application/json: schema: $ref: '#/components/schemas/Error' /rc/blocks/{blockId}: get: tags: - rc blocks summary: Get a relay chain block by its height or hash. description: Returns a relay chain block. Can be identified by either its height or hash. operationId: getRcBlock parameters: - name: blockId in: path description: Block identifier, as the block height or block hash. required: true schema: type: string - name: eventDocs in: query description: When set to `true`, every event will have an extra `docs` property. schema: type: boolean default: false - name: extrinsicDocs in: query description: When set to `true`, every extrinsic will have an extra `docs` property. schema: type: boolean default: false - name: noFees in: query description: When set to `true`, no fee information is calculated. schema: type: boolean default: false - name: useEvmFormat in: query description: When set to `true`, every extrinsic's event emitted by pallet-revive will have the address data formatted to EVM. required: false schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/Block' "400": description: invalid blockId supplied content: application/json: schema: $ref: '#/components/schemas/Error' /rc/blocks/{blockId}/header: get: tags: - rc blocks summary: Get a relay chain block's header by its height or hash. description: Returns a relay chain block's header. Can be identified by either its height or hash. operationId: getRcBlockHeader parameters: - name: blockId in: path description: Block identifier, as the block height or block hash. required: true schema: type: string responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/BlockHeader' "400": description: invalid blockId supplied content: application/json: schema: $ref: '#/components/schemas/Error' /rc/blocks/{blockId}/extrinsics/{extrinsicIndex}: get: tags: - rc blocks summary: Get a relay chain block's extrinsic by its block height or hash and the extrinsic index. description: Returns an extrinsic from a relay chain block. Can be identified by either its height or hash and the extrinsic index. operationId: getRcBlockExtrinsic parameters: - name: blockId in: path description: Block identifier, as the block height or block hash. required: true schema: type: string - name: extrinsicIndex in: path description: Extrinsic index within the block. required: true schema: type: string - name: eventDocs in: query description: When set to `true`, every event will have an extra `docs` property. schema: type: boolean default: false - name: extrinsicDocs in: query description: When set to `true`, every extrinsic will have an extra `docs` property. schema: type: boolean default: false - name: noFees in: query description: When set to `true`, no fee information is calculated. schema: type: boolean default: false - name: useEvmFormat in: query description: When set to `true`, every extrinsic's event emitted by pallet-revive will have the address data formatted to EVM. required: false schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/Extrinsic' "400": description: invalid blockId or extrinsicIndex supplied content: application/json: schema: $ref: '#/components/schemas/Error' /rc/blocks/head: get: tags: - rc blocks summary: Get the latest relay chain block. description: Returns the latest relay chain block. operationId: getRcBlockHead parameters: - name: finalized in: query description: When set to `false`, it will fetch the head of the node's canon chain, which might not be finalized. schema: type: boolean default: true - name: eventDocs in: query description: When set to `true`, every event will have an extra `docs` property. schema: type: boolean default: false - name: extrinsicDocs in: query description: When set to `true`, every extrinsic will have an extra `docs` property. schema: type: boolean default: false - name: noFees in: query description: When set to `true`, no fee information is calculated. schema: type: boolean default: false - name: useEvmFormat in: query description: When set to `true`, every extrinsic's event emitted by pallet-revive will have the address data formatted to EVM. required: false schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/Block' "400": description: invalid request content: application/json: schema: $ref: '#/components/schemas/Error' /rc/blocks/head/header: get: tags: - rc blocks summary: Get the latest relay chain block's header. description: Returns the latest relay chain block's header. operationId: getRcBlockHeadHeader parameters: - name: finalized in: query description: When set to `false`, it will fetch the head of the node's canon chain, which might not be finalized. schema: type: boolean default: true responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/BlockHeader' "400": description: invalid request content: application/json: schema: $ref: '#/components/schemas/Error' /rc/blocks/{blockId}/extrinsics-raw: get: tags: - rc blocks summary: Get a relay chain block's raw extrinsics by its height or hash. description: Returns a relay chain block's raw extrinsics. Can be identified by either its height or hash. operationId: getRcBlockRawExtrinsics parameters: - name: blockId in: path description: Block identifier, as the block height or block hash. required: true schema: type: string responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/BlockRaw' "400": description: invalid blockId supplied content: application/json: schema: $ref: '#/components/schemas/Error' /rc/blocks/{blockId}/para-inclusions: get: tags: - rc blocks summary: Get all parachain inclusion information for a relay chain block. description: Returns all decoded parachain inclusion events (CandidateIncluded) for a relay chain block from the relay chain API. BlockId can either be a block hash or a block height. This endpoint extracts and decodes the candidate descriptor, commitments hash, and parachain header information for each included parachain block. operationId: getRcBlockParaInclusions parameters: - name: blockId in: path description: Relay chain block identifier, as the block height or block hash. required: true schema: pattern: '^0[xX][0-9a-fA-F]{1,64}$|[0-9]{1,12}' type: string - name: paraId in: query description: Optional parachain ID to filter results. When provided, only the inclusion information for the specified parachain will be returned. required: false schema: type: string format: unsignedInteger responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/BlockParaInclusions' "400": description: invalid Block identifier supplied or block does not contain paraInclusion events content: application/json: schema: $ref: '#/components/schemas/Error' /experimental/rc/blocks/head/traces: get: tags: - rc summary: Get the latest relay chain block's traces. description: Returns the latest relay chain block's traces. operationId: getRcBlockHeadTraces responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/BlocksTrace' /experimental/rc/blocks/{blockId}/traces: get: tags: - rc summary: Get a relay chain block's traces by its height or hash. description: Returns a relay chain block's traces. Can be identified by either its height or hash. operationId: getRcBlockTraces parameters: - name: blockId in: path description: Block identifier, as the block height or block hash. required: true schema: type: string responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/BlocksTrace' "400": description: invalid blockId supplied content: application/json: schema: $ref: '#/components/schemas/Error' /experimental/rc/blocks/head/traces/operations: get: tags: - rc summary: Get the latest relay chain block's trace operations. description: Returns the latest relay chain block's trace operations. operationId: getRcBlockHeadTraceOperations parameters: - name: actions in: query description: Include action traces. schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/BlocksTraceOperations' /experimental/rc/blocks/{blockId}/traces/operations: get: tags: - rc summary: Get a relay chain block's trace operations by its height or hash. description: Returns a relay chain block's trace operations. Can be identified by either its height or hash. operationId: getRcBlockTraceOperations parameters: - name: blockId in: path description: Block identifier, as the block height or block hash. required: true schema: type: string - name: actions in: query description: Include action traces. schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/BlocksTraceOperations' "400": description: invalid blockId supplied content: application/json: schema: $ref: '#/components/schemas/Error' /blocks: get: tags: - blocks summary: Get a range of blocks by their height. description: Given a range query parameter return an array of all the blocks within that range. When `useRcBlock` parameter is used, the range represents relay chain block numbers and the response includes additional fields `rcBlockHash`, `rcBlockNumber`, and `ahTimestamp` for each block. Relay chain blocks without corresponding Asset Hub blocks are skipped. operationId: getBlock parameters: - name: range in: query description: A range of integers. There is a max limit of 500 blocks per request. required: true example: 0-499 schema: type: string - name: eventDocs in: query description: When set to `true`, every event will have an extra `docs` property with a string of the events documentation. required: false schema: type: boolean default: false - name: extrinsicDocs in: query description: When set to `true`, every extrinsic will have an extra `docs` property with a string of the extrinsics documentation. required: false schema: type: boolean default: false - name: noFees in: query description: When set to `true`, the fee won't be calculated for the extrinsics. required: false schema: type: boolean default: false - name: useEvmFormat in: query description: When set to `true`, every extrinsic's event emitted by pallet-revive will have the address data formatted to EVM. required: false schema: type: boolean default: false - name: useRcBlock in: query description: When set to `true`, the range parameter represents relay chain block numbers and the response includes additional fields for each block. Only supported for Asset Hub endpoints with relay chain API available. When used, returns an array of response objects or empty array if no Asset Hub block found. required: false schema: type: boolean default: false - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/Blocks' "400": description: invalid Block identifier supplied content: application/json: schema: $ref: '#/components/schemas/Error' /blocks/{blockId}: get: tags: - blocks summary: Get a block by its height or hash. description: Returns a single block. BlockId can either be a block hash or a block height. Replaces `/block/{number}` from versions < v1.0.0. When `useRcBlock` parameter is used, the response includes additional fields `rcBlockHash`, `rcBlockNumber`, and `ahTimestamp`. operationId: getBlockById parameters: - name: blockId in: path description: Block identifier, as the block height or block hash. required: true schema: pattern: '^0[xX][0-9a-fA-F]{1,64}$|[0-9]{1,12}' type: string - name: eventDocs in: query description: When set to `true`, every event will have an extra `docs` property with a string of the events documentation. required: false schema: type: boolean default: false - name: extrinsicDocs in: query description: When set to `true`, every extrinsic will have an extra `docs` property with a string of the extrinsics documentation. required: false schema: type: boolean default: false - name: noFees in: query description: When set to `true`, the fee won't be calculated for the extrinsics. required: false schema: type: boolean default: false - name: finalizedKey in: query description: When 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. required: false schema: type: boolean - name: decodedXcmMsgs in: query description: When set to `true`, this will show the decoded XCM messages within the extrinsics of the requested block. required: false schema: type: boolean default: false - name: paraId in: query description: When 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. required: false schema: type: string - name: useRcBlock in: query description: When set to `true`, it will use the relay chain block identifier to determine the corresponding Asset Hub block. Only supported for Asset Hub endpoints with relay chain API available. When used, returns an array of response objects or empty array if no Asset Hub block found. required: false schema: type: boolean default: false - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. - name: useEvmFormat in: query description: When set to `true`, every extrinsic's event emitted by pallet-revive will have the address data formatted to EVM. required: false schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: oneOf: - $ref: '#/components/schemas/BlockWithDecodedXcmMsgs' - type: array items: $ref: '#/components/schemas/BlockWithDecodedXcmMsgs' description: Returns a single object when using standard parameters. Returns an array when using 'useRcBlock' parameter (array contains one object per Asset Hub block found, or empty array if none found). "400": description: invalid Block identifier supplied content: application/json: schema: $ref: '#/components/schemas/Error' /blocks/{blockId}/header: get: tags: - blocks summary: Get a block's header by its height or hash. description: Returns a single block's header. BlockId can either be a block hash or a block height. When `useRcBlock` parameter is used, the response includes additional fields `rcBlockHash`, `rcBlockNumber`, and `ahTimestamp`. operationId: getBlockHeaderById parameters: - name: blockId in: path description: Block identifier, as the block height or block hash. required: true schema: pattern: '^0[xX][0-9a-fA-F]{1,64}$|[0-9]{1,12}' type: string - name: useRcBlock in: query description: When set to `true`, it will use the relay chain block identifier to determine the corresponding Asset Hub block. Only supported for Asset Hub endpoints with relay chain API available. When used, returns an array of response objects or empty array if no Asset Hub block found. required: false schema: type: boolean default: false - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successful operation content: application/json: schema: oneOf: - $ref: '#/components/schemas/BlockHeader' - type: array items: $ref: '#/components/schemas/BlockHeader' description: Returns a single object when using standard parameters. Returns an array when using 'useRcBlock' parameter (array contains one object per Asset Hub block found, or empty array if none found). "400": description: invalid Block identifier supplied content: application/json: schema: $ref: '#/components/schemas/Error' /blocks/{blockId}/extrinsics/{extrinsicIndex}: get: tags: - blocks summary: Get an extrinsic by its extrinsicIndex and block height or hash. The pair blockId, extrinsicIndex is sometimes referred to as a Timepoint. description: Returns a single extrinsic. When `useRcBlock` parameter is used, the response includes additional fields `rcBlockHash`, `rcBlockNumber`, and `ahTimestamp`. operationId: getExtrinsicByTimepoint parameters: - name: blockId in: path description: Block identifier, as the block height or block hash. required: true schema: pattern: '^0[xX][0-9a-fA-F]{1,64}$|[0-9]{1,12}' type: string - name: extrinsicIndex in: path description: The extrinsic's index within the block's body. required: true schema: type: string - name: eventDocs in: query description: When set to `true`, every event will have an extra `docs` property with a string of the events documentation. required: false schema: type: boolean default: false - name: extrinsicDocs in: query description: When set to `true`, every extrinsic will have an extra `docs` property with a string of the extrinsics documentation. required: false schema: type: boolean default: false - name: noFees in: query description: When set to `true`, the fee won't be calculated for the extrinsic. required: false schema: type: boolean default: false - name: useRcBlock in: query description: When set to `true`, it will use the relay chain block identifier to determine the corresponding Asset Hub block. Only supported for Asset Hub endpoints with relay chain API available. When used, returns an array of response objects or empty array if no Asset Hub block found. required: false schema: type: boolean default: false - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. - name: useEvmFormat in: query description: When set to `true`, every extrinsic's event emitted by pallet-revive will have the address data formatted to EVM. required: false schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: oneOf: - $ref: '#/components/schemas/ExtrinsicIndex' - type: array items: $ref: '#/components/schemas/ExtrinsicIndex' description: Returns a single object when using standard parameters. Returns an array when using 'useRcBlock' parameter (array contains one object per Asset Hub block found, or empty array if none found). "400": description: Requested `extrinsicIndex` does not exist content: application/json: schema: $ref: '#/components/schemas/Error' /blocks/head: get: tags: - blocks summary: Get the most recently finalized block. description: Returns the most recently finalized block. Replaces `/block` from versions < v1.0.0. When `useRcBlock` parameter is used, the response includes additional fields `rcBlockHash`, `rcBlockNumber`, and `ahTimestamp`. operationId: getHeadBlock parameters: - name: finalized in: query description: Boolean 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. required: false schema: type: boolean default: true - name: eventDocs in: query description: When set to `true`, every event will have an extra `docs` property with a string of the events documentation. required: false schema: type: boolean default: false - name: extrinsicDocs in: query description: When set to `true`, every extrinsic will have an extra `docs` property with a string of the extrinsics documentation. required: false schema: type: boolean default: false - name: noFees in: query description: When set to `true`, the fee won't be calculated for the extrinsics. required: false schema: type: boolean default: false - name: decodedXcmMsgs in: query description: When set to `true`, this will show the decoded XCM messages within the extrinsics of the requested block. required: false schema: type: boolean default: false - name: paraId in: query description: When 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. required: false schema: type: string - name: useRcBlock in: query description: When set to `true`, it will use the latest relay chain block to determine the corresponding Asset Hub block. Only supported for Asset Hub endpoints with relay chain API available. Respects the `finalized` parameter when determining which relay chain block to use. When used, returns an array of response objects or empty array if no Asset Hub block found. required: false schema: type: boolean default: false - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. - name: useEvmFormat in: query description: When set to `true`, every extrinsic's event emitted by pallet-revive will have the address data formatted to EVM. required: false schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: oneOf: - $ref: '#/components/schemas/BlockWithDecodedXcmMsgs' - type: array items: $ref: '#/components/schemas/BlockWithDecodedXcmMsgs' description: Returns a single object when using standard parameters. Returns an array when using 'useRcBlock' parameter (array contains one object per Asset Hub block found, or empty array if none found). /blocks/head/header: get: tags: - blocks summary: Get information about the header of the most recent finalized block. description: Returns the most recently finalized block's header. When `useRcBlock` parameter is used, the response includes additional fields `rcBlockHash`, `rcBlockNumber`, and `ahTimestamp`. operationId: getLatestBlockHeader parameters: - name: finalized in: query description: Boolean 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. required: false schema: type: boolean default: true - name: useRcBlock in: query description: When set to `true`, it will use the latest relay chain block to determine the corresponding Asset Hub block header. Only supported for Asset Hub endpoints with relay chain API available. Respects the `finalized` parameter when determining which relay chain block to use. When used, returns an array of response objects or empty array if no Asset Hub block found. required: false schema: type: boolean default: false - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successful operation content: application/json: schema: oneOf: - $ref: '#/components/schemas/BlockHeader' - type: array items: $ref: '#/components/schemas/BlockHeader' description: Returns a single object when using standard parameters. Returns an array when using 'useRcBlock' parameter (array contains one object per Asset Hub block found, or empty array if none found). "400": description: invalid Block identifier supplied content: application/json: schema: $ref: '#/components/schemas/Error' /blocks/{blockId}/extrinsics-raw: get: tags: - blocks summary: Get a blocks header & its extrinsics as hex values. description: Returns a block & its extrinsics as hex values. BlockId can either be a block hash or a block height. When `useRcBlock` parameter is used, the response includes additional fields `rcBlockHash`, `rcBlockNumber`, and `ahTimestamp`. operationId: getBlockRawExtrinsics parameters: - name: blockId in: path description: Block identifier, as the block height or block hash. required: true schema: pattern: '^0[xX][0-9a-fA-F]{1,64}$|[0-9]{1,12}' type: string - name: useRcBlock in: query description: When set to `true`, it will use the relay chain block identifier to determine the corresponding Asset Hub block. Only supported for Asset Hub endpoints with relay chain API available. When used, returns an array of response objects or empty array if no Asset Hub block found. required: false schema: type: boolean default: false - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successful operation content: application/json: schema: oneOf: - $ref: '#/components/schemas/BlockRaw' - type: array items: $ref: '#/components/schemas/BlockRaw' description: Returns a single object when using standard parameters. Returns an array when using 'useRcBlock' parameter (array contains one object per Asset Hub block found, or empty array if none found). "400": description: invalid Block identifier supplied content: application/json: schema: $ref: '#/components/schemas/Error' /blocks/{blockId}/para-inclusions: get: tags: - blocks summary: Get all parachain inclusion information for a relay chain block. description: Returns all decoded parachain inclusion events (CandidateIncluded) for a relay chain block. BlockId can either be a block hash or a block height. This endpoint extracts and decodes the candidate descriptor, commitments hash, and parachain header information for each included parachain block. operationId: getBlockParaInclusions parameters: - name: blockId in: path description: Relay chain block identifier, as the block height or block hash. required: true schema: pattern: '^0[xX][0-9a-fA-F]{1,64}$|[0-9]{1,12}' type: string - name: paraId in: query description: Optional parachain ID to filter results. When provided, only the inclusion information for the specified parachain will be returned. required: false schema: type: string format: unsignedInteger responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/BlockParaInclusions' "400": description: invalid Block identifier supplied or block does not contain paraInclusion events content: application/json: schema: $ref: '#/components/schemas/Error' /contracts/ink/{address}/query: post: tags: - contracts summary: Query an !Ink contract with a given message (method). description: Will return a valid or invalid result. operationId: callContractQuery requestBody: $ref: '#/components/requestBodies/ContractMetadata' parameters: - name: address in: path description: SS58 or Hex address of the account associated with the contract. required: true schema: type: string - name: method in: query description: The message or method used to query. required: false schema: type: string default: 'get' - name: gasLimit in: query description: The gas limit to be used as an option for the queried message. required: false schema: default: -1 type: number - name: storageDepositLimit in: query description: The storage deposit limit to be used as an option for the queried message. required: false schema: default: null type: number - name: args in: query description: Abi 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. required: false schema: type: array items: type: string description: An array of Abi params. responses: "200": description: succesful operation content: application/json: schema: $ref: '#/components/schemas/ContractsInkQuery' "400": description: Invalid Method content: application/json: schema: $ref: '#/components/schemas/Error' /coretime/leases: get: tags: - coretime summary: Get all the leases currently registered on coretime chain. description: '' operationId: getCoretimeLeases parameters: - name: blockId in: query description: Block identifier, as the block height or block hash. required: false schema: pattern: '^0[xX][0-9a-fA-F]{1,64}$|[0-9]{1,12}' type: string responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/CoretimeLeasesResponse' /coretime/regions: get: tags: - coretime summary: Get all the regions currently registered on coretime chain. description: '' operationId: getCoretimeRegions parameters: - name: blockId in: query description: Block identifier, as the block height or block hash. required: false schema: pattern: '^0[xX][0-9a-fA-F]{1,64}$|[0-9]{1,12}' type: string responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/CoretimeRegionsResponse' /coretime/renewals: get: tags: - coretime summary: Get all the potential renewals currently registered on coretime chain. description: '' operationId: getCoretimeRenewals parameters: - name: blockId in: query description: Block identifier, as the block height or block hash. required: false schema: pattern: '^0[xX][0-9a-fA-F]{1,64}$|[0-9]{1,12}' type: string responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/CoretimeRenewalsResponse' /coretime/reservations: get: tags: - coretime summary: Get all the reservations currently registered on coretime chain. description: '' operationId: getCoretimeReservations parameters: - name: blockId in: query description: Block identifier, as the block height or block hash. required: false schema: pattern: '^0[xX][0-9a-fA-F]{1,64}$|[0-9]{1,12}' type: string responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/CoretimeReservationsResponse' /coretime/info: get: tags: - coretime summary: Get the generic information about coretime, either on coretime chain or relay chain. description: '' parameters: - name: blockId in: query description: Block identifier, as the block height or block hash. required: false schema: pattern: '^0[xX][0-9a-fA-F]{1,64}$|[0-9]{1,12}' type: string operationId: getCoretimeInfo responses: "200": description: successful operation content: application/json: schema: oneOf: - $ref: '#/components/schemas/CoretimeChainInfoResponse' - $ref: '#/components/schemas/CoretimeRelayInfoResponse' /coretime/overview: get: tags: - coretime summary: Get all the cores information either on coretime chain or relay chain. description: '' operationId: getCoretimeCores parameters: - name: blockId in: query description: Block identifier, as the block height or block hash. required: false schema: pattern: '^0[xX][0-9a-fA-F]{1,64}$|[0-9]{1,12}' type: string responses: "200": description: successful operation content: application/json: schema: oneOf: - $ref: '#/components/schemas/CoretimeChainCoresResponse' - $ref: '#/components/schemas/CoretimeRelayCoresResponse' /node/network: get: tags: - node summary: Get information about the Substrate node's activity in the peer-to-peer network. description: Returns network related information of the node. operationId: getNodeNetworking responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/NodeNetwork' /node/transaction-pool: get: tags: - node summary: Get pending extrinsics from the Substrate node. description: Returns the extrinsics that the node knows of that have not been included in a block. operationId: getNodeTransactionPool parameters: - name: includeFee in: query description: Boolean representing whether or not to include tips, partialFee, and priority in each extrinsic. required: false schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/TransactionPool' /node/version: get: tags: - node summary: Get information about the Substrates node's implementation and versioning. description: Returns versioning information of the node. operationId: getNodeVersion responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/NodeVersion' /transaction: post: tags: - transaction summary: Submit a transaction to the node's transaction pool. description: Accepts a valid signed extrinsic. Replaces `/tx` from versions < v1.0.0. operationId: submitTransaction requestBody: $ref: '#/components/requestBodies/Transaction' responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/TransactionSuccess' "400": description: failed to parse or submit transaction content: application/json: schema: $ref: '#/components/schemas/TransactionFailure' /transaction/dry-run: post: tags: - transaction summary: Dry run an extrinsic. description: 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. operationId: dryrunTransaction requestBody: $ref: '#/components/requestBodies/TransactionDryRun' responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/TransactionDryRun' "400": description: failed to dry-run transaction content: application/json: schema: $ref: '#/components/schemas/TransactionFailure' /transaction/fee-estimate: post: tags: - transaction summary: Receive a fee estimate for a transaction. description: >- 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 operationId: feeEstimateTransaction requestBody: $ref: '#/components/requestBodies/Transaction' responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/TransactionFeeEstimate' "400": description: fee estimation failure content: application/json: schema: $ref: '#/components/schemas/TransactionFeeEstimateFailure' /transaction/material: get: tags: - transaction summary: Get all the network information needed to construct a transaction offline. description: Returns the material that is universal to constructing any signed transaction offline. Replaces `/tx/artifacts` from versions < v1.0.0. operationId: getTransactionMaterial parameters: - name: at in: query description: Block at which to retrieve the transaction construction material. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: noMeta in: query description: DEPRECATED! This is no longer supported schema: type: boolean default: false - name: metadata in: query description: 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. When `metadata` is not inputted, the `metadata` field will be absent. schema: type: string responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/TransactionMaterial' "400": description: invalid blockId supplied for at query param content: application/json: schema: $ref: '#/components/schemas/Error' /transaction/material/{metadataVersion}: get: tags: - transaction summary: Get all the network information needed to construct a transaction offline and the version of metadata specified in `metadataVersion`. description: Returns all the materials necessary for constructing any signed transactions offline. operationId: getTransactionMaterialwithVersionedMetadata parameters: - name: metadataVersion in: path description: 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. required: true schema: type: string - name: at in: query description: Block at which to retrieve the transaction construction material. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: metadata in: query description: 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. schema: type: string responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/TransactionMaterial' "400": description: invalid blockId supplied for at query param content: application/json: schema: $ref: '#/components/schemas/Error' /transaction/metadata-blob: post: tags: - transaction summary: Get the metadata blob for offline signers. description: Returns the minimal metadata ("metadata blob" or "proof") needed by offline signers to decode a transaction's signing payload, along with the metadata hash for the CheckMetadataHash signed extension per RFC-0078. operationId: getTransactionMetadataBlob requestBody: $ref: '#/components/requestBodies/TransactionMetadataBlob' responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/TransactionMetadataBlob' "400": description: invalid request body or metadata V15 not available content: application/json: schema: $ref: '#/components/schemas/Error' /pallets/assets/{assetId}/asset-info: get: tags: - pallets summary: Get information and metadata associated with an asset. description: Returns information associated with an asset which includes the assets `AssetDetails` and `AssetMetadata`. operationId: getAssetById parameters: - name: assetId in: path description: The unsignedInteger Id of an asset. required: true schema: type: string format: unsignedInteger - name: at in: query description: Block at which to retrieve the assetInfo. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving asset info. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successful operation content: application/json: schema: oneOf: - $ref: '#/components/schemas/PalletsAssetsInfo' - type: array items: $ref: '#/components/schemas/PalletsAssetsInfo' description: Returns a single object when using standard parameters. Returns an array when using 'useRcBlock' parameter (array contains one object per Asset Hub block found, or empty array if none found). /pallets/asset-conversion/liquidity-pools: get: tags: - pallets summary: Get information related to existing liquidity pools. description: 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: - name: at in: query description: Block at which to retrieve the liquidity pools information. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving liquidity pools info. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successful operation content: application/json: schema: oneOf: - $ref: '#/components/schemas/LiquidityPools' - type: array items: $ref: '#/components/schemas/LiquidityPools' description: Returns a single object when using standard parameters. Returns an array when using 'useRcBlock' parameter (array contains one object per Asset Hub block found, or empty array if none found). "400": description: invalid blockId supplied for at query param content: application/json: schema: $ref: '#/components/schemas/Error' /pallets/asset-conversion/next-available-id: get: tags: - pallets summary: Get the next available liquidity pool id. description: 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: - name: at in: query description: Block at which to retrieve the next liquidity pool's id. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving next available id. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successful operation content: application/json: schema: oneOf: - $ref: '#/components/schemas/NextAvailableId' - type: array items: $ref: '#/components/schemas/NextAvailableId' description: Returns a single object when using standard parameters. Returns an array when using 'useRcBlock' parameter (array contains one object per Asset Hub block found, or empty array if none found). "400": description: invalid blockId supplied for at query param content: application/json: schema: $ref: '#/components/schemas/Error' /pallets/foreign-assets: get: tags: - pallets summary: Get information and metadata associated with foreign assets. description: Returns information associated with every foreign asset which includes the assets `AssetDetails` and `AssetMetadata`. operationId: getForeignAssets parameters: - name: at in: query description: Block at which to retrieve the foreign assets. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving foreign assets info. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successful operation content: application/json: schema: description: An array of foreign assets. $ref: '#/components/schemas/PalletsForeignAssets' /pallets/nomination-pools/info: get: tags: - pallets summary: Get information associated with nomination pools. description: Returns information and metadata for nomination pools including pool counters and limits. operationId: getNominationPoolInfo parameters: - name: at in: query description: Block at which to retrieve the nomination pool info. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving nomination pools info. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/PalletsNominationPoolsInfo' /pallets/nomination-pools/{poolId}: get: tags: - pallets summary: Get information and metadata associated with a nomination pool. description: Returns information associated with a nomination pool which includes the nomination pools' `bondedPool`, `rewardPool` and `metadata`. operationId: getNominationPoolById parameters: - name: poolId in: path description: The unsignedInteger Id of a nomination pool. required: true schema: type: string format: unsignedInteger - name: at in: query description: Block at which to retrieve the nomination pool. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving nomination pool info. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/PalletsNominationPool' /pallets/on-going-referenda: get: tags: - pallets summary: Get a list of all on-going referenda that have track `root (0)` and `whitelisted (1)`, along with their associated information. description: Returns information associated with on-going referenda which includes the referendum's `enactment`, `submitted` and `deciding` fields. operationId: getPalletOnGoingReferenda parameters: - name: at in: query description: Block at which to retrieve the on-going referenda. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving on-going referenda info. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/PalletsOnGoingReferenda' /pallets/{palletId}/consts: get: tags: - pallets summary: Get a list of constants for a pallet. description: Returns a list of const item metadata for constant items of the specified palletId. parameters: - name: palletId in: path description: 'Name or index of the pallet to read constant metadata for. Note: the pallet name must match what is specified in the runtime metadata.' required: true schema: type: string - name: onlyIds in: query description: Only return the names (IDs) of the const items instead of every constant's metadata. required: false schema: type: boolean - name: at in: query description: Block at which to retrieve a list of the pallet's constant items. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving pallet constants. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successful operation content: application/json: schema: description: Pallet info and Array of constantItemIds. $ref: '#/components/schemas/PalletConstants' "400": description: invalid blockId supplied for at query param content: application/json: schema: $ref: '#/components/schemas/Error' "404": description: could not find pallet with palletId content: application/json: schema: $ref: '#/components/schemas/Error' /pallets/{palletId}/consts/{constantItemId}: get: tags: - pallets summary: Get the value of a constant item. description: Returns the value stored under the constantItemId. parameters: - name: palletId in: path description: 'Name or index of the pallet to read constant metadata for. Note: the pallet name must match what is specified in the runtime metadata.' required: true schema: type: string - name: constantItemId in: path description: Id of the const item to query for. required: true schema: type: string - name: at in: query description: Block at which to query the const item at. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: metadata in: query description: Include the const items metadata (including documentation) if set to true. required: false schema: default: false type: boolean - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving pallet constant item. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/PalletConstantsItem' "400": description: invalid blockId supplied for at query param content: application/json: schema: $ref: '#/components/schemas/Error' "404": description: could not find resource with id content: application/json: schema: $ref: '#/components/schemas/Error' /pallets/{palletId}/dispatchables: get: tags: - pallets summary: Get a list of dispatchables for a pallet. description: Returns a list of dispatchable item metadata for distpachable items of the specified palletId. parameters: - name: palletId in: path description: 'Name or index of the pallet to read dispatchable metadata for. Note: the pallet name must match what is specified in the runtime metadata.' required: true schema: type: string - name: onlyIds in: query description: Only return the names (IDs) of the dispatchable items instead of every dispatchable's metadata. required: false schema: type: boolean - name: at in: query description: Block at which to retrieve dispatchable metadata. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving dispatchable metadata. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successful operation content: application/json: schema: description: Pallet info and Array of dispatchableItemIds. $ref: '#/components/schemas/PalletDispatchables' "400": description: invalid blockId supplied for at query param, or invalid parameter combination content: application/json: schema: $ref: '#/components/schemas/Error' "404": description: could not find pallet with palletId content: application/json: schema: $ref: '#/components/schemas/Error' /pallets/{palletId}/dispatchables/{dispatchableItemId}: get: tags: - pallets summary: Get the value of a dispatchable item. description: Returns the value stored under the dispatchableItemId. parameters: - name: palletId in: path description: 'Name or index of the pallet to read dispatchable metadata for. Note: the pallet name must match what is specified in the runtime metadata.' required: true schema: type: string - name: dispatchableItemId in: path description: Id of the dispatchable item to query for. required: true schema: type: string - name: metadata in: query description: Include the dispatchable items metadata (including documentation) if set to true. required: false schema: default: false type: boolean - name: at in: query description: Block at which to retrieve dispatchable metadata. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving dispatchable metadata. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/PalletDispatchablesItem' "400": description: invalid blockId supplied for at query param, or invalid parameter combination content: application/json: schema: $ref: '#/components/schemas/Error' "404": description: could not find resource with id content: application/json: schema: $ref: '#/components/schemas/Error' /pallets/{palletId}/errors: get: tags: - pallets summary: Get a list of errors for a pallet. description: Returns a list of error item metadata for error items of the specified palletId. parameters: - name: palletId in: path description: 'Name or index of the pallet to read error metadata for. Note: the pallet name must match what is specified in the runtime metadata.' required: true schema: type: string - name: onlyIds in: query description: Only return the names (IDs) of the error items instead of every error's metadata. required: false schema: type: boolean - name: at in: query description: Block at which to retrieve a list of the pallet's error items. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving pallet errors. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successful operation content: application/json: schema: description: Pallet info and Array of errorItemIds. $ref: '#/components/schemas/PalletErrors' "400": description: invalid blockId supplied for at query param content: application/json: schema: $ref: '#/components/schemas/Error' "404": description: could not find pallet with palletId content: application/json: schema: $ref: '#/components/schemas/Error' /pallets/{palletId}/errors/{errorItemId}: get: tags: - pallets summary: Get the value of an error item. description: Returns the value stored under the errorItemId. parameters: - name: palletId in: path description: 'Name or index of the pallet to read error metadata for. Note: the pallet name must match what is specified in the runtime metadata.' required: true schema: type: string - name: errorItemId in: path description: Id of the error item to query for. required: true schema: type: string - name: at in: query description: Block at which to query the error item at. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: metadata in: query description: Include the error items metadata (including documentation) if set to true. required: false schema: default: false type: boolean - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving pallet error item. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/PalletErrorsItem' "400": description: invalid blockId supplied for at query param content: application/json: schema: $ref: '#/components/schemas/Error' "404": description: could not find resource with id content: application/json: schema: $ref: '#/components/schemas/Error' /pallets/{palletId}/events: get: tags: - pallets summary: Get a list of events for a pallet. description: Returns a list of event item metadata for event items of the specified palletId. parameters: - name: palletId in: path description: 'Name or index of the pallet to read event metadata for. Note: the pallet name must match what is specified in the runtime metadata.' required: true schema: type: string - name: onlyIds in: query description: Only return the names (IDs) of the event items instead of every event's metadata. required: false schema: type: boolean - name: at in: query description: Block at which to retrieve a list of the pallet's event items. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving pallet events. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successful operation content: application/json: schema: description: Pallet info and Array of eventItemIds. $ref: '#/components/schemas/PalletEvents' "400": description: invalid blockId supplied for at query param content: application/json: schema: $ref: '#/components/schemas/Error' "404": description: could not find pallet with palletId content: application/json: schema: $ref: '#/components/schemas/Error' /pallets/{palletId}/events/{eventItemId}: get: tags: - pallets summary: Get the value of an event item. description: Returns the value stored under the eventItemId. parameters: - name: palletId in: path description: 'Name or index of the pallet to read event metadata for. Note: the pallet name must match what is specified in the runtime metadata.' required: true schema: type: string - name: eventItemId in: path description: Id of the event item to query for. required: true schema: type: string - name: at in: query description: Block at which to query the event item at. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: metadata in: query description: Include the event items metadata (including documentation) if set to true. required: false schema: default: false type: boolean - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving pallet event item. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/PalletEventsItem' "400": description: invalid blockId supplied for at query param content: application/json: schema: $ref: '#/components/schemas/Error' "404": description: could not find resource with id content: application/json: schema: $ref: '#/components/schemas/Error' /runtime/metadata: get: tags: - runtime summary: Get the runtime metadata in decoded, JSON form. description: >- 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: - name: at in: query description: Block at which to retrieve the metadata at. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/RuntimeMetadata' /runtime/metadata/{metadataVersion}: get: tags: - runtime summary: Get the requested version of runtime metadata in decoded, JSON form. description: >- 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: - name: metadataVersion in: path description: The version of metadata. The input is expected in a `vX` format, where `X` represents the version number (e.g. `v14`, `v15`). required: true schema: type: string - name: at in: query description: Block at which to retrieve the metadata at. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/RuntimeMetadata' /runtime/metadata/versions: get: tags: - runtime summary: Get the available versions of runtime metadata. description: >- 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: - name: at in: query description: Block at which to retrieve the metadata versions at. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex responses: "200": description: successful operation content: application/json: schema: type: array items: type: string description: An array with the available metadata versions. /runtime/code: get: tags: - runtime summary: Get the runtime wasm blob. description: Returns the runtime Wasm blob in hex format. parameters: - name: at in: query description: Block at which to retrieve the runtime wasm blob at. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/RuntimeCode' /runtime/spec: get: tags: - runtime summary: Get version information of the Substrate runtime. description: Returns version information related to the runtime. parameters: - name: at in: query description: Block at which to retrieve runtime version information at. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/RuntimeSpec' /rc/runtime/spec: get: tags: - rc runtime summary: Get version information of the relay chain Substrate runtime. description: Returns version information related to the relay chain runtime. This endpoint is specifically for Asset Hub and queries the relay chain (Polkadot/Kusama) for runtime specification. parameters: - name: at in: query description: Block at which to retrieve runtime version information at. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/RuntimeSpec' /rc/runtime/metadata: get: tags: - rc runtime summary: Get the relay chain's metadata. description: Returns the relay chain's runtime metadata in decoded JSON format. This endpoint is specifically for Asset Hub and queries the relay chain (Polkadot/Kusama) for metadata. parameters: - name: at in: query description: Block hash or height at which to query. If not provided, queries finalized head. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/RuntimeMetadata' /rc/runtime/metadata/versions: get: tags: - rc runtime summary: Get the available versions of relay chain's metadata. description: Returns the available versions of the relay chain's metadata. This endpoint is specifically for Asset Hub and queries the relay chain (Polkadot/Kusama) for metadata versions. parameters: - name: at in: query description: Block hash or height at which to query. If not provided, queries finalized head. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex responses: "200": description: successful operation content: application/json: schema: type: array items: type: string /rc/runtime/metadata/{metadataVersion}: get: tags: - rc runtime summary: Get the relay chain's metadata at a specific version. description: Returns the relay chain's runtime metadata at a specific version in decoded JSON format. This endpoint is specifically for Asset Hub and queries the relay chain (Polkadot/Kusama) for versioned metadata. parameters: - name: metadataVersion in: path description: The specific version of the Metadata to query. The input must conform to the 'vX' format, where 'X' represents the version number (examples 'v14', 'v15'). required: true schema: type: string pattern: '^v[0-9]+$' - name: at in: query description: Block hash or height at which to query. If not provided, queries finalized head. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/RuntimeMetadata' "400": description: Invalid version format or version not available content: application/json: schema: $ref: '#/components/schemas/Error' /rc/runtime/code: get: tags: - rc runtime summary: Get the Wasm code blob of the relay chain Substrate runtime. description: Returns the relay chain's runtime code in Wasm format. This endpoint is specifically for Asset Hub and queries the relay chain (Polkadot/Kusama) for runtime code. parameters: - name: at in: query description: Block at which to retrieve runtime code information at. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/RuntimeCode' /rc/pallets/on-going-referenda: get: tags: - rc pallets summary: Get relay chain ongoing referenda. description: Returns information about ongoing referenda in the relay chain. operationId: getRcPalletsOnGoingReferenda parameters: - name: at in: query description: Block at which to retrieve relay chain referenda information. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/PalletsOnGoingReferenda' "400": description: invalid blockId supplied content: application/json: schema: $ref: '#/components/schemas/Error' /rc/pallets/{palletId}/consts: get: tags: - rc pallets summary: Get a list of constants for a relay chain pallet. description: Returns a list of constant metadata for the specified relay chain pallet. operationId: getRcPalletsConsts parameters: - name: palletId in: path description: Name or index of the pallet to read constants from. required: true schema: type: string - name: at in: query description: Block at which to retrieve relay chain pallet constants. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: onlyIds in: query description: Only return constant IDs, not values and metadata. schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/PalletConstants' "400": description: invalid palletId supplied content: application/json: schema: $ref: '#/components/schemas/Error' /rc/pallets/{palletId}/consts/{constantItemId}: get: tags: - rc pallets summary: Get a constant from a relay chain pallet by its ID. description: Returns information about a specific constant from the specified relay chain pallet. operationId: getRcPalletsConstsItem parameters: - name: palletId in: path description: Name or index of the pallet to read the constant from. required: true schema: type: string - name: constantItemId in: path description: Name of the constant to retrieve. required: true schema: type: string - name: at in: query description: Block at which to retrieve relay chain pallet constant. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: metadata in: query description: Include metadata for the constant. schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/PalletConstantsItem' "400": description: invalid palletId or constantItemId supplied content: application/json: schema: $ref: '#/components/schemas/Error' /rc/pallets/{palletId}/dispatchables: get: tags: - rc pallets summary: Get a list of dispatchables for a relay chain pallet. description: Returns a list of dispatchable metadata for the specified relay chain pallet. operationId: getRcPalletsDispatchables parameters: - name: palletId in: path description: Name or index of the pallet to read dispatchables from. required: true schema: type: string - name: at in: query description: Block at which to retrieve relay chain pallet dispatchables. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: onlyIds in: query description: Only return dispatchable IDs, not values and metadata. schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/PalletDispatchables' "400": description: invalid palletId supplied content: application/json: schema: $ref: '#/components/schemas/Error' /rc/pallets/{palletId}/dispatchables/{dispatchableItemId}: get: tags: - rc pallets summary: Get a dispatchable from a relay chain pallet by its ID. description: Returns information about a specific dispatchable from the specified relay chain pallet. operationId: getRcPalletsDispatchablesItem parameters: - name: palletId in: path description: Name or index of the pallet to read the dispatchable from. required: true schema: type: string - name: dispatchableItemId in: path description: Name of the dispatchable to retrieve. required: true schema: type: string - name: at in: query description: Block at which to retrieve relay chain pallet dispatchable. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: metadata in: query description: Include metadata for the dispatchable. schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/PalletDispatchablesItem' "400": description: invalid palletId or dispatchableItemId supplied content: application/json: schema: $ref: '#/components/schemas/Error' /rc/pallets/{palletId}/errors: get: tags: - rc pallets summary: Get a list of errors for a relay chain pallet. description: Returns a list of error metadata for the specified relay chain pallet. operationId: getRcPalletsErrors parameters: - name: palletId in: path description: Name or index of the pallet to read errors from. required: true schema: type: string - name: at in: query description: Block at which to retrieve relay chain pallet errors. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: onlyIds in: query description: Only return error IDs, not values and metadata. schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/PalletErrors' "400": description: invalid palletId supplied content: application/json: schema: $ref: '#/components/schemas/Error' /rc/pallets/{palletId}/errors/{errorItemId}: get: tags: - rc pallets summary: Get an error from a relay chain pallet by its ID. description: Returns information about a specific error from the specified relay chain pallet. operationId: getRcPalletsErrorsItem parameters: - name: palletId in: path description: Name or index of the pallet to read the error from. required: true schema: type: string - name: errorItemId in: path description: Name of the error to retrieve. required: true schema: type: string - name: at in: query description: Block at which to retrieve relay chain pallet error. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: metadata in: query description: Include metadata for the error. schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/PalletErrorsItem' "400": description: invalid palletId or errorItemId supplied content: application/json: schema: $ref: '#/components/schemas/Error' /rc/pallets/{palletId}/events: get: tags: - rc pallets summary: Get a list of events for a relay chain pallet. description: Returns a list of event metadata for the specified relay chain pallet. operationId: getRcPalletsEvents parameters: - name: palletId in: path description: Name or index of the pallet to read events from. required: true schema: type: string - name: at in: query description: Block at which to retrieve relay chain pallet events. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: onlyIds in: query description: Only return event IDs, not values and metadata. schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/PalletEvents' "400": description: invalid palletId supplied content: application/json: schema: $ref: '#/components/schemas/Error' /rc/pallets/{palletId}/events/{eventItemId}: get: tags: - rc pallets summary: Get an event from a relay chain pallet by its ID. description: Returns information about a specific event from the specified relay chain pallet. operationId: getRcPalletsEventsItem parameters: - name: palletId in: path description: Name or index of the pallet to read the event from. required: true schema: type: string - name: eventItemId in: path description: Name of the event to retrieve. required: true schema: type: string - name: at in: query description: Block at which to retrieve relay chain pallet event. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: metadata in: query description: Include metadata for the event. schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/PalletEventsItem' "400": description: invalid palletId or eventItemId supplied content: application/json: schema: $ref: '#/components/schemas/Error' /rc/pallets/{palletId}/storage: get: tags: - rc pallets summary: Get a list of storage items for a relay chain pallet. description: Returns a list of storage item metadata for the specified relay chain pallet. operationId: getRcPalletsStorage parameters: - name: palletId in: path description: Name or index of the pallet to read storage items from. required: true schema: type: string - name: at in: query description: Block at which to retrieve relay chain pallet storage items. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: onlyIds in: query description: Only return storage item IDs, not values and metadata. schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/PalletStorage' "400": description: invalid palletId supplied content: application/json: schema: $ref: '#/components/schemas/Error' /rc/pallets/{palletId}/storage/{storageItemId}: get: tags: - rc pallets summary: Get a storage item from a relay chain pallet by its ID. description: Returns the value stored under the specified storage item ID from the relay chain pallet. For maps, query parameter keys are required. operationId: getRcPalletsStorageItem parameters: - name: palletId in: path description: Name or index of the pallet to read the storage item from. required: true schema: type: string - name: storageItemId in: path description: Name of the storage item to retrieve. required: true schema: type: string - name: at in: query description: Block at which to retrieve relay chain pallet storage item. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: keys in: query description: Storage map keys for map-type storage items. Required for map and double map storage items. required: false schema: type: array items: type: string - name: metadata in: query description: Include metadata for the storage item. schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/PalletStorageItem' "400": description: invalid palletId, storageItemId, or keys supplied content: application/json: schema: $ref: '#/components/schemas/Error' /rc/pallets/staking/progress: get: tags: - rc pallets - rc staking summary: Get progress on the general Staking pallet system on Relay Chain. description: Returns information on the progress of key components of the staking system and estimates of future points of interest. If you are querying from Asset Hub for staking progress, this endpoint requires multi chain connections between the relay chain, and asset hub itself. Set the asset hub rpc to SAS_SUBSTRATE_URL, and add the relay chain to the SAS_SUBSTRATE_MULTI_CHAIN_URL env var. Refer to the README for the structure of the env vars. The `useRcBlock` parameter allows querying Asset Hub state using relay chain block numbers, enabling post-migration infrastructure to continue using relay chain block identifiers while accessing Asset Hub data. operationId: getRcStakingProgress parameters: - name: at in: query description: Block at which to retrieve a staking progress report. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex responses: "200": description: successful operation content: application/json: schema: oneOf: - $ref: '#/components/schemas/StakingProgress' - type: array items: $ref: '#/components/schemas/StakingProgress' description: Returns a single object when using standard parameters. Returns an array when using 'useRcBlock' parameter (array contains one object per Asset Hub block found, or empty array if none found). "400": description: invalid blockId supplied for at query param, or invalid parameter combination content: application/json: schema: $ref: '#/components/schemas/Error' /rc/pallets/staking/validators: get: tags: - rc pallets - rc staking summary: Get all validators (active/waiting) of a specific chain. description: Returns a list of all validators addresses and their corresponding status which can be either active or waiting. For declared validators, it also includes their commission rate (as parts-per-billion) and nomination blocking status. 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". Commission and blocked properties are not present for active validators that have been chilled. operationId: getRcStakingValidators parameters: - name: at in: query description: Block at which to retrieve the list of validators. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/StakingValidators' "400": description: invalid blockId supplied for at query param, or invalid parameter combination content: application/json: schema: $ref: '#/components/schemas/Error' /rc/transaction: post: tags: - rc transaction summary: Submit a transaction to the relay chain node's transaction pool. description: Accepts a valid signed extrinsic for the relay chain. Replaces `/tx` from versions < v1.0.0. operationId: submitRcTransaction requestBody: $ref: '#/components/requestBodies/Transaction' responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/TransactionSuccess' "400": description: failed to parse or submit transaction content: application/json: schema: $ref: '#/components/schemas/TransactionFailure' /rc/transaction/dry-run: post: tags: - rc transaction summary: Dry run an extrinsic on the relay chain. description: Use the `dryRun` call to simulate the submission of a transaction to the relay chain without executing it so that you can check for potential errors and validate the expected outcome. operationId: dryrunRcTransaction requestBody: $ref: '#/components/requestBodies/TransactionDryRun' responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/TransactionDryRun' "400": description: failed to dry-run transaction content: application/json: schema: $ref: '#/components/schemas/TransactionFailure' /rc/transaction/fee-estimate: post: tags: - rc transaction summary: Receive a fee estimate for a relay chain transaction. description: >- Send a serialized transaction and receive back a naive fee estimate for the relay chain. 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 operationId: feeEstimateRcTransaction requestBody: $ref: '#/components/requestBodies/Transaction' responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/TransactionFeeEstimate' "400": description: fee estimation failure content: application/json: schema: $ref: '#/components/schemas/TransactionFeeEstimateFailure' /rc/transaction/material: get: tags: - rc transaction summary: Get all the relay chain network information needed to construct a transaction offline. description: Returns the material that is universal to constructing any signed transaction offline for the relay chain. Replaces `/tx/artifacts` from versions < v1.0.0. operationId: getRcTransactionMaterial parameters: - name: at in: query description: Block at which to retrieve the transaction construction material from the relay chain. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: noMeta in: query description: DEPRECATED! This is no longer supported schema: type: boolean default: false - name: metadata in: query description: 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. When `metadata` is not inputted, the `metadata` field will be absent. schema: type: string responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/TransactionMaterial' "400": description: invalid blockId supplied for at query param content: application/json: schema: $ref: '#/components/schemas/Error' /rc/transaction/material/{metadataVersion}: get: tags: - rc transaction summary: Get all the relay chain network information needed to construct a transaction offline and the version of metadata specified in `metadataVersion`. description: Returns all the materials necessary for constructing any signed transactions offline for the relay chain. operationId: getRcTransactionMaterialwithVersionedMetadata parameters: - name: metadataVersion in: path description: 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. required: true schema: type: string - name: at in: query description: Block at which to retrieve the transaction construction material from the relay chain. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: metadata in: query description: 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. schema: type: string responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/TransactionMaterial' "400": description: invalid blockId supplied for at query param content: application/json: schema: $ref: '#/components/schemas/Error' /pallets/{palletId}/storage: get: tags: - pallets summary: Get a list of storage items for a pallet. description: Returns a list of storage item metadata for storage items of the specified palletId. parameters: - name: palletId in: path description: 'Name or index of the pallet to query the storage of. Note: the pallet name must match what is specified in the runtime metadata.' required: true schema: type: string - name: onlyIds in: query description: Only return the names (IDs) of the storage items instead of all of each storage item's metadata. required: false schema: type: boolean - name: at in: query description: Block at which to retrieve a list of the pallet's storage items. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving pallet storage. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successful operation content: application/json: schema: description: Pallet info and Array of storageItemIds. $ref: '#/components/schemas/PalletStorage' "400": description: invalid blockId supplied for at query param content: application/json: schema: $ref: '#/components/schemas/Error' "404": description: could not find pallet with palletId content: application/json: schema: $ref: '#/components/schemas/Error' /pallets/{palletId}/storage/{storageItemId}: get: tags: - pallets summary: Get the value of a storage item. description: 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: - name: palletId in: path description: 'Name or index of the pallet to query the storage of. Note: pallet name aligns with pallet name as specified in runtime metadata.' required: true schema: type: string - name: storageItemId in: path description: Id of the storage item to query for. required: true schema: type: string - name: keys in: query description: Set 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. required: false schema: type: array items: type: string description: An array of storage keys. - name: at in: query description: Block at which to query the storage item at. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: metadata in: query description: Include the storage items metadata (including documentation) if set to true. required: false schema: default: false type: boolean - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving pallet storage item. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/PalletStorageItem' "400": description: invalid blockId supplied for at query param content: application/json: schema: $ref: '#/components/schemas/Error' "404": description: could not find resource with id content: application/json: schema: $ref: '#/components/schemas/Error' /pallets/pool-assets/{assetId}/asset-info: get: tags: - pallets summary: Get information and metadata associated with a pool asset. description: Returns information associated with a pool asset which includes the assets `AssetDetails` and `AssetMetadata`. operationId: getPoolAssetById parameters: - name: assetId in: path description: The unsignedInteger Id of a pool asset. required: true schema: type: string format: unsignedInteger - name: at in: query description: Block at which to retrieve the assetInfo. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving pool asset info. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successful operation content: application/json: schema: oneOf: - $ref: '#/components/schemas/PalletsPoolAssetsInfo' - type: array items: $ref: '#/components/schemas/PalletsPoolAssetsInfo' description: Returns a single object when using standard parameters. Returns an array when using 'useRcBlock' parameter (array contains one object per Asset Hub block found, or empty array if none found). /pallets/staking/progress: get: tags: - staking - pallets summary: Get progress on the general Staking pallet system. description: Returns information on the progress of key components of the staking system and estimates of future points of interest. If you are querying from Asset Hub for staking progress, this endpoint requires multi chain connections between the relay chain, and asset hub itself. Set the asset hub rpc to SAS_SUBSTRATE_URL, and add the relay chain to the SAS_SUBSTRATE_MULTI_CHAIN_URL env var. Refer to the README for the structure of the env vars. The `useRcBlock` parameter allows querying Asset Hub state using relay chain block numbers, enabling post-migration infrastructure to continue using relay chain block identifiers while accessing Asset Hub data. operationId: getStakingProgress parameters: - name: at in: query description: Block at which to retrieve a staking progress report. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving staking progress report. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successful operation content: application/json: schema: oneOf: - $ref: '#/components/schemas/StakingProgress' - type: array items: $ref: '#/components/schemas/StakingProgress' description: Returns a single object when using standard parameters. Returns an array when using 'useRcBlock' parameter (array contains one object per Asset Hub block found, or empty array if none found). "400": description: invalid blockId supplied for at query param, or invalid parameter combination content: application/json: schema: $ref: '#/components/schemas/Error' /pallets/staking/validators: get: tags: - staking - pallets summary: Get all validators (active/waiting) of a specific chain. description: Returns a list of all validators addresses and their corresponding status which can be either active or waiting. For declared validators, it also includes their commission rate and nomination blocking status. 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". Commission and blocked properties are not present for active validators that have been chilled. operationId: getStakingValidators parameters: - name: at in: query description: Block at which to retrieve the list of validators. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: useRcBlock in: query description: When set to 'true', uses the relay chain block specified in the 'at' parameter to determine corresponding Asset Hub block(s) for retrieving staking validators. Only supported for Asset Hub endpoints. Requires 'at' parameter to specify the relay chain block. When used, returns an array of response objects (one for each Asset Hub block found) or empty array if none found. required: false schema: type: boolean description: When set to 'true', uses relay chain block mode with the 'at' parameter. - name: useRcBlockFormat in: query description: Controls the response format when using 'useRcBlock=true'. When set to 'object', wraps the response in an object containing relay chain block info ('rcBlock') and the parachain data array ('parachainDataPerBlock'). When set to 'array' or omitted, returns the standard array format. Only valid when 'useRcBlock=true' is specified. required: false schema: type: string enum: [array, object] description: Response format - 'array' (default) returns standard array, 'object' wraps response with rcBlock info. responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/StakingValidators' "400": description: invalid blockId supplied for at query param, or invalid parameter combination content: application/json: schema: $ref: '#/components/schemas/Error' /paras: get: tags: - paras summary: | [DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] List all registered paras (parathreads & parachains). description: Returns all registered parachains and parathreads with lifecycle info. parameters: - name: at in: query description: Block at which to retrieve paras list at. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/Paras' /paras/leases/current: get: tags: - paras summary: | [DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] Get general information about the current lease period. description: | Returns an overview of the current lease period, including lease holders. parameters: - name: at in: query description: Block at which to retrieve current lease period info at. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex - name: currentLeaseHolders in: query description: | Wether or not to include the `currentLeaseHolders` property. Inclusion of the property will likely result in a larger payload and increased response time. required: false schema: type: boolean default: true responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/ParasLeasesCurrent' /paras/auctions/current: get: tags: - paras summary: | [DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] Get the status of the current auction. description: | 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: - name: at in: query description: Block at which to retrieve auction progress at. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/ParasAuctionsCurrent' /paras/crowdloans: get: tags: - paras summary: | [DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] List all stored crowdloans. description: | Returns a list of all the crowdloans and their associated paraIds. parameters: - name: at in: query description: Block at which to retrieve the list of paraIds that have crowdloans at. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/ParasCrowdloans' /paras/{paraId}/crowdloan-info: get: tags: - paras summary: | [DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] Get crowdloan information for a `paraId`. description: | Returns crowdloan's `fundInfo` and the set of `leasePeriods` the crowdloan` covers. parameters: - name: paraId in: path description: paraId to query the crowdloan information of. required: true schema: type: number - name: at in: query description: Block at which to retrieve info at. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/ParasCrowdloanInfo' /paras/{paraId}/lease-info: get: tags: - paras summary: | [DEPRECATION NOTE: PHASED OUT ENDPOINT IN FAVOR OF CORETIME] Get current and future leases as well as the lifecycle stage for a given `paraId`. description: | Returns a list of leases that belong to the `paraId` as well as the `paraId`'s current lifecycle stage. parameters: - name: paraId in: path description: paraId to query the crowdloan information of. required: true schema: type: number - name: at in: query description: Block at which to retrieve para's leases at. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/ParasLeaseInfo' /paras/head/included-candidates: get: tags: - paras summary: | [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. description: | Returns an object with all the parachain id's as keys, and their headers as values. parameters: - name: at in: query description: Block at which to retrieve para's heads at. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/ParasHeaders' /paras/head/backed-candidates: get: tags: - paras summary: | [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. description: | Returns an object with all the parachain id's as keys, and their headers as values. parameters: - name: at in: query description: Block at which to retrieve para's heads at. required: false schema: type: string description: Block identifier, as the block height or block hash. format: unsignedInteger or $hex responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/ParasHeaders' /paras/{number}/inclusion: get: tags: - paras summary: Get relay chain inclusion information for a specific parachain block. description: | Returns the relay chain block number where a parachain block was included, along with the relay parent number used during production. This endpoint helps track the lifecycle of parachain blocks from production to inclusion. **Note**: This endpoint requires a multi-chain connection (both parachain and relay chain APIs). parameters: - name: number in: path description: Parachain block number to find inclusion information for. required: true schema: type: string format: unsignedInteger - name: depth in: query description: Maximum number of relay chain blocks to search for inclusion (must be divisible by 5, max 100). required: false schema: type: integer minimum: 5 maximum: 100 multipleOf: 5 default: 10 responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/ParachainInclusion' "400": description: Invalid depth parameter content: application/json: schema: type: object properties: error: type: string example: "Depth parameter must be divisible by 5 for optimal performance." /experimental/blocks/head/traces: get: tags: - trace summary: | [Experimental - subject to breaking change.] Get traces for the most recently finalized block. description: | Returns traces (spans and events) of the most recently finalized block from RPC `state_straceBlock`. Consult the [RPC docs](https://github.com/paritytech/substrate/blob/aba876001651506f85c14baf26e006b36092e1a0/client/rpc-api/src/state/mod.rs#L140) for conceptual info. responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/BlocksTrace' /experimental/blocks/{blockId}/traces: get: tags: - trace summary: | [Experimental - subject to breaking change.] Get traces for the given `blockId`. description: | Returns traces (spans and events) of the specified block from RPC `state_straceBlock`. Consult the [RPC docs](https://github.com/paritytech/substrate/blob/aba876001651506f85c14baf26e006b36092e1a0/client/rpc-api/src/state/mod.rs#L140) for conceptual info. parameters: - name: blockId in: path description: Block identifier, as the block height or block hash. required: true schema: pattern: '^0[xX][0-9a-fA-F]{1,64}$|[0-9]{1,12}' type: string responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/BlocksTrace' /experimental/blocks/head/traces/operations: get: tags: - trace summary: | [Experimental - subject to breaking change.] Get the operations from the most recently finalized block. description: | 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](https://docs.google.com/drawings/d/1vZoJo9jaXlz0LmrdTOgHck9_1LsfuQPRmTr-5g1tOis/edit?usp=sharing) parameters: - name: actions in: query description: Whether or not to include action groups. required: false schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/BlocksTraceOperations' /experimental/blocks/{blockId}/traces/operations: get: tags: - trace summary: | [Experimental - subject to breaking change.] Get the operations from the specified block. description: | 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](https://docs.google.com/drawings/d/1vZoJo9jaXlz0LmrdTOgHck9_1LsfuQPRmTr-5g1tOis/edit?usp=sharing) parameters: - name: blockId in: path description: Block identifier, as the block height or block hash. required: true schema: pattern: '^0[xX][0-9a-fA-F]{1,64}$|[0-9]{1,12}' type: string - name: actions in: query description: Whether or not to include action groups. required: false schema: type: boolean default: false responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/BlocksTraceOperations' components: schemas: RcBlockInfo: type: object description: Relay chain block information used when useRcBlockFormat=object. properties: hash: type: string description: The relay chain block hash. format: hex parentHash: type: string description: The parent block hash of the relay chain block. format: hex number: type: string description: The relay chain block number. format: unsignedInteger RcBlockObjectResponse: type: object description: Response wrapper when using useRcBlockFormat=object. Contains relay chain block info and an array of parachain data. properties: rcBlock: $ref: '#/components/schemas/RcBlockInfo' parachainDataPerBlock: type: array description: Array of response objects, one for each Asset Hub block found in the relay chain block. Empty array if no Asset Hub blocks found. items: type: object description: The endpoint-specific response data for each Asset Hub block. AccountAssetsApproval: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' amount: type: string description: The amount of funds approved for the balance transfer from the owner to some delegated target. format: unsignedInteger deposit: type: string description: The amount reserved on the owner's account to hold this item in storage. format: unsignedInteger rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. format: unsignedInteger ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. format: unsignedInteger AhmInfo: type: object description: Asset Hub Migration information including migration boundaries for both relay chain and Asset Hub. properties: relay: type: object description: Relay chain migration information properties: startBlock: type: integer nullable: true description: Block number when relay chain migration started, or null if not available format: unsignedInteger endBlock: type: integer nullable: true description: Block number when relay chain migration ended, or null if not available format: unsignedInteger assetHub: type: object description: Asset Hub migration information properties: startBlock: type: integer nullable: true description: Block number when Asset Hub migration started, or null if not available format: unsignedInteger endBlock: type: integer nullable: true description: Block number when Asset Hub migration ended, or null if not available format: unsignedInteger example: relay: startBlock: 26041702 endBlock: 26071771 assetHub: startBlock: 11716733 endBlock: 11736597 AccountAssetsBalances: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' assets: type: array description: An array of queried assets. items: $ref: '#/components/schemas/AssetsBalance' rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. format: unsignedInteger ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. format: unsignedInteger AccountBalanceInfo: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' nonce: type: string description: Account nonce. format: unsignedInteger tokenSymbol: type: string description: Token symbol of the balances displayed in this response. format: unsignedInteger free: type: string description: Free balance of the account. Not equivalent to _spendable_ balance. This is the only balance that matters in terms of most operations on tokens. format: unsignedInteger reserved: type: string description: Reserved balance of the account. format: unsignedInteger miscFrozen: type: string description: The amount that `free` may not drop below when withdrawing for anything except transaction fee payment. Note, that some runtimes may not have support for miscFrozen and if so the following will be returned `miscFrozen does not exist for this runtime` format: unsignedInteger feeFrozen: type: string description: The amount that `free` may not drop below when withdrawing specifically for transaction fee payment. Note, that some runtimes may not have support for feeFrozen and if so the following will be returned `feeFrozen does not exist for this runtime` format: unsignedInteger frozen: type: string description: The amount that `free` may not drop below when reducing the balance, except for actions where the account owner cannot reasonably benefit from the balance reduction, such as slashing. Note, that some runtimes may not have support for frozen and if so the following will be returned `frozen does not exist for this runtime` format: unsignedInteger transferable: type: string description: The amount that can be transferred from this account. This is calculated using the formula `free - max(maybeEd, frozen - reserve)` where `maybeEd` is the existential deposit if there are frozen funds or reserves, otherwise it is zero. This represents the actual spendable balance. Note, that some historical runtimes may not have support for the current formula used and if so the following will be returned `transferable not supported for this runtime`. format: unsignedInteger locks: type: array description: Array of locks on a balance. There can be many of these on an account and they "overlap", so the same balance is frozen by multiple locks items: $ref: '#/components/schemas/BalanceLock' rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. format: unsignedInteger ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. format: unsignedInteger AccountCompare: type: object properties: areEqual: type: boolean description: Whether the given SS58 addresses are equal or not. Equality is determined by comparing the accountId/publicKey of each address. addresses: type: array description: An array that contains detailed information for each of the queried SS58 addresses. items: $ref: '#/components/schemas/AddressDetails' AccountConvert: type: object properties: ss58Prefix: type: string description: SS58 prefix based on which the account ID or Public Key (hex) is converted to an SS58 address. format: unsignedInteger network: type: string description: The network based on which the returned address is encoded. It depends on the prefix that was given as a query param. address: type: string description: The returned SS58 address which is the result of the conversion of the account ID or Public Key (hex). accountId: type: string description: The given account ID or Public Key (hex) that is converted to an SS58 address. scheme: type: string description: The cryptographic scheme/algorithm used to encode the given account ID or Public Key (hex). publicKey: type: boolean description: Whether the given path parameter is a Public Key (hex) or not. AccountPoolAssetsBalances: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' poolAssets: type: array description: An array of queried assets. items: $ref: '#/components/schemas/AssetsBalance' rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. format: unsignedInteger ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. format: unsignedInteger AccountForeignAssetsBalances: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' foreignAssets: type: array description: An array of queried foreign assets. items: $ref: '#/components/schemas/ForeignAssetBalance' rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. format: unsignedInteger ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. format: unsignedInteger ForeignAssetBalance: type: object properties: multiLocation: type: object description: The multilocation identifier of the foreign asset. This is an XCM multilocation object that uniquely identifies an asset across different parachains. balance: type: string description: The balance of the foreign asset. format: unsignedInteger isFrozen: type: boolean description: Whether the asset is frozen for non-admin transfers. Returns false if the runtime does not support isFrozen. isSufficient: type: boolean description: Whether a non-zero balance of this asset is a deposit of sufficient value to account for the state bloat associated with its balance storage. If set to `true`, then non-zero balances may be stored without a `consumer` reference (and thus an ED in the Balances pallet or whatever else is used to control user-account state growth). AccountProxyInfo: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' delegatedAccounts: type: array items: type: object properties: delegate: type: string description: Delegate address for the given proxy. format: ss58 delay: type: string description: The announcement period required of the initial proxy. Will generally be zero. format: unsignedInteger proxyType: type: string description: The permissions allowed for this proxy account. depositHeld: type: string format: unsignedInteger description: The held deposit. rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. format: unsignedInteger ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. format: unsignedInteger AccountStakingInfo: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' rewardDestination: type: string description: The account to which rewards will be paid. Can be 'Staked' (Stash account, adding to the amount at stake), 'Stash' (Stash address, not adding to the amount at stake), or 'Controller' (Controller address). format: ss58 enum: - Staked - Stash - Controller controller: type: string description: Controller address for the given Stash. format: ss58 numSlashingSpans: type: string description: Number of slashing spans on Stash account; `null` if provided address is not a Controller. format: unsignedInteger nominations: $ref: '#/components/schemas/Nominations' staking: $ref: '#/components/schemas/StakingLedger' rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. format: unsignedInteger ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. format: unsignedInteger description: >- Note: For Sidecar versions prior to v.20.0.0, in field `claimedRewards` under `staking`, we return whatever we would find under `StakingLedger` with no further calculations. From v.20.0.0 onwards, `claimedRewards` is calculated based on different calls: `lastReward`, `claimedRewards` or `legacyClaimedRewards`. Note on lastReward: Runtime versions of Kusama less than 1062 will either have `lastReward` in place of `claimedRewards`, or no field at all. This is related to changes in reward distribution. See: [Lazy Payouts](https://github.com/paritytech/substrate/pull/4474), [Simple Payouts](https://github.com/paritytech/substrate/pull/5406) AccountStakingPayouts: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' erasPayouts: type: array items: type: object properties: era: type: string format: unsignedInteger description: Era this information is associated with. totalEraRewardPoints: type: string format: unsignedInteger description: Total reward points for the era. Equals the sum of reward points for all the validators in the set. totalEraPayout: type: string format: unsignedInteger description: Total payout for the era. Validators split the payout based on the portion of `totalEraRewardPoints` they have. payouts: $ref: '#/components/schemas/Payouts' rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. format: unsignedInteger ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. format: unsignedInteger AccountValidation: type: object properties: isValid: type: boolean description: Whether the given address is valid ss58 formatted. ss58Prefix: type: string description: SS58 prefix of the given address. If the address is a valid base58 format, but incorrect ss58, a prefix for the given address will still be returned. format: unsignedInteger network: type: string description: The network based on which the given address is encoded. accountId: type: string description: The account id of the given address. AccountVestingInfo: type: object description: Sidecar version's <= v10.0.0 have a`vesting` return value that defaults to an object for when there is no available vesting-info data. It also returns a `VestingInfo` as an object. For Sidecar >=11.0.0, that value will now default as an array when there is no value, and `Vec` is returned when there is. properties: at: $ref: '#/components/schemas/BlockIdentifiers' vesting: type: array items: $ref: '#/components/schemas/VestingSchedule' rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. format: unsignedInteger ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. format: unsignedInteger vestedBalance: type: string description: Total vested amount across all schedules based on time elapsed. Only present when `includeClaimable` parameter is used. format: unsignedInteger vestingTotal: type: string description: Total locked amount across all vesting schedules. Only present when `includeClaimable` parameter is used. format: unsignedInteger vestedClaimable: type: string description: Actual amount that can be claimed now (vestedBalance minus already claimed). Only present when `includeClaimable` parameter is used. format: unsignedInteger blockNumberForCalculation: type: string description: The block number used for vesting calculations. Only present when `includeClaimable` parameter is used. format: unsignedInteger blockNumberSource: type: string description: Which chain's block number was used for calculations ('relay' or 'self'). Only present when `includeClaimable` parameter is used. enum: - relay - self AddressDetails: type: object properties: ss58Format: type: string description: The queried SS58 address. ss58Prefix: type: string description: SS58 prefix of the given address. format: unsignedInteger network: type: string description: The network based on which the given address is encoded. publicKey: type: string description: The account ID/Public Key (hex) of the queried SS58 address. AssetsBalance: type: object properties: assetId: type: string description: The identifier of the asset. format: unsignedInteger balance: type: string description: The balance of the asset. format: unsignedInteger isFrozen: type: boolean description: Whether the asset is frozen for non-admin transfers. Note, that some runtimes may not have support for isFrozen and if so the following will be returned `isFrozen does not exist for this runtime` isSufficient: type: boolean description: Whether a non-zero balance of this asset is a deposit of sufficient value to account for the state bloat associated with its balance storage. If set to `true`, then non-zero balances may be stored without a `consumer` reference (and thus an ED in the Balances pallet or whatever else is used to control user-account state growth). AssetInfo: type: object properties: owner: type: string description: Owner of the assets privileges. format: SS58 issuer: type: string description: The `AccountId` able to mint tokens. format: SS58 admin: type: string description: The `AccountId` that can thaw tokens, force transfers and burn token from any account. format: SS58 freezer: type: string description: The `AccountId` that can freeze tokens. format: SS58 supply: type: string description: The total supply across accounts. format: unsignedInteger deposit: type: string description: The balance deposited for this. This pays for the data stored. format: unsignedInteger minBalance: type: string description: The ED for virtual accounts. format: unsignedInteger isSufficient: type: boolean description: If `true`, then any account with this asset is given a provider reference. Otherwise, it requires a consumer reference. accounts: type: string description: The total number of accounts. format: unsignedInteger sufficients: type: string description: The total number of accounts for which is placed a self-sufficient reference. approvals: type: string description: The total number of approvals. format: unsignedInteger status: type: string description: The status of the asset. AssetMetadata: type: object properties: deposit: type: string description: The balance deposited for this metadata. This pays for the data stored in this struct. format: unsignedInteger name: type: string description: The user friendly name of this asset. format: $hex symbol: type: string description: The ticker symbol for this asset. format: $hex decimals: type: string description: The number of decimals this asset uses to represent one unit. format: unsignedInteger isFrozen: type: boolean description: Whether the asset metadata may be changed by a non Force origin. Note, that some runtimes may not have support for isFrozen and if so the following will be returned `isFrozen does not exist for this runtime` AssetMultiLocation: oneOf: - $ref: '#/components/schemas/AssetMultiLocationObject' - $ref: '#/components/schemas/AssetMultiLocationHex' AssetMultiLocationObject: type: object properties: parents: type: string format: unsignedInteger interior: type: object description: The multiLocation of the foreign asset as an object. example: "{\"parents\":\"2\",\"interior\":{\"X1\":{\"GlobalConsensus\":\"Polkadot\"}}}" AssetMultiLocationHex: type: string pattern: '^0x[0-9a-fA-F]+$' description: The multiLocation of the foreign asset given as a hexadecimal value. BalanceLock: type: object properties: id: type: string description: An identifier for this lock. Only one lock may be in existence for each identifier. amount: type: string description: The amount below which the free balance may not drop with this lock in effect. format: unsignedInteger reasons: type: string description: Reasons for withdrawing balance. enum: - Fee = 0 - Misc = 1 - All = 2 Block: type: object properties: number: type: string description: The block's height. format: unsignedInteger hash: type: string description: The block's hash. format: hex parentHash: type: string description: The hash of the parent block. format: hex stateRoot: type: string description: The state root after executing this block. format: hex extrinsicRoot: type: string description: The Merkle root of the extrinsics. format: hex authorId: type: string description: The account ID of the block author (may be undefined for some chains). format: ss58 logs: type: array items: $ref: '#/components/schemas/DigestItem' description: Array of `DigestItem`s associated with the block. onInitialize: $ref: '#/components/schemas/BlockInitialize' extrinsics: type: array description: Array of extrinsics (inherents and transactions) within the block. items: $ref: '#/components/schemas/Extrinsic' onFinalize: $ref: '#/components/schemas/BlockFinalize' finalized: type: boolean description: >- A boolean identifying whether the block is finalized or not. Note: on chains that do not have deterministic finality this field is omitted. rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. format: unsignedInteger ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. format: unsignedInteger description: >- Note: Block finalization does not correspond to consensus, i.e. whether the block is in the canonical chain. It denotes the finalization of block _construction._ BlockRaw: type: object properties: number: type: string description: The block's height. format: unsignedInteger parentHash: type: string description: The hash of the parent block. format: hex stateRoot: type: string description: The state root after executing this block. format: hex extrinsicRoot: type: string description: The Merkle root of the extrinsics. format: hex digest: type: object properties: logs: type: array items: $ref: '#/components/schemas/DigestItem' description: Array of `DigestItem`s associated with the block. extrinsics: type: array description: Array of raw extrinsics (inherents and transactions) within the block. items: type: string rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. format: unsignedInteger ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. format: unsignedInteger Blocks: type: array items: $ref: '#/components/schemas/Block' BlockFinalize: type: object properties: events: type: array items: $ref: '#/components/schemas/SanitizedEvent' description: Object with an array of `SanitizedEvent`s that occurred during block construction finalization with the `method` and `data` for each. BlockHeader: type: object properties: parentHash: type: string description: The hash of the parent block. format: hex number: type: string description: The block's height. format: unsignedInteger stateRoot: type: string description: The state root after executing this block. format: hex extrinsicRoot: type: string description: The Merkle root of the extrinsics. format: hex digest: type: object properties: logs: type: array items: $ref: '#/components/schemas/DigestItem' description: Array of `DigestItem`s associated with the block. rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. format: unsignedInteger ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. format: unsignedInteger BlockIdentifiers: type: object properties: hash: type: string description: The block's hash. format: hex height: type: string description: The block's height. format: unsignedInteger BlockParaInclusions: type: object description: Contains all decoded parachain inclusion information for a relay chain block properties: at: $ref: '#/components/schemas/BlockIdentifiers' inclusions: type: array description: Array of parachain inclusions in this relay chain block, sorted by paraId items: $ref: '#/components/schemas/ParaInclusion' ParaInclusion: type: object description: Information about a single parachain inclusion event properties: paraId: type: string description: The parachain ID format: unsignedInteger paraBlockNumber: type: number description: The parachain block number that was included (decoded from HeadData) format: unsignedInteger paraBlockHash: type: string description: The parachain block hash that was included (decoded from HeadData) format: hex descriptor: $ref: '#/components/schemas/ParaInclusionDescriptor' commitmentsHash: type: string description: Hash of the candidate commitments format: hex coreIndex: type: string description: Core index assigned to this parachain block format: unsignedInteger groupIndex: type: string description: Validator group index that backed this parachain block format: unsignedInteger ParaInclusionDescriptor: type: object description: Candidate descriptor containing parachain inclusion metadata properties: relayParent: type: string description: The relay chain parent block hash format: hex persistedValidationDataHash: type: string description: Hash of the persisted validation data format: hex povHash: type: string description: Hash of the Proof of Validity (PoV) format: hex erasureRoot: type: string description: Root hash of the erasure encoding format: hex paraHead: type: string description: Hash of the parachain head data format: hex validationCodeHash: type: string description: Hash of the validation code format: hex BlockInitialize: type: object properties: events: type: array items: $ref: '#/components/schemas/SanitizedEvent' description: Object with an array of `SanitizedEvent`s that occurred during block initialization with the `method` and `data` for each. BlocksTrace: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' blockHash: type: string events: type: array items: $ref: '#/components/schemas/TraceEvent' parentHash: type: string spans: type: array items: $ref: '#/components/schemas/TraceSpan' storageKeys: type: string description: Hex encoded storage keys used to filter events. tracingTargets: type: string description: Targets used to filter spans and events. BlocksTraceOperations: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' operations: type: array items: $ref: '#/components/schemas/Operation' CoretimeRegionsResponse: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' regions: type: array items: $ref: '#/components/schemas/CoretimeRegion' CoretimeLeasesResponse: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' leases: type: array items: $ref: '#/components/schemas/CoretimeLease' CoretimeReservationsResponse: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' reservations: type: array items: $ref: '#/components/schemas/CoretimeReservation' CoretimeRenewalsResponse: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' renewals: type: array items: $ref: '#/components/schemas/CoretimeRenewal' CoretimeChainInfoResponse: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' configuration: $ref: '#/components/schemas/CoretimeConfig' currentRegion: type: object properties: start: type: string description: The start time. end: type: string description: The end time. cores: type: object properties: total: type: string description: The total number of cores. available: type: string description: The number of free cores. sold: type: string description: The number of reserved cores. currentCorePrice: type: string description: The current core price. selloutPrice: type: string description: The sellout price. firstCore: type: string description: The first core id. CoretimeRelayInfoResponse: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' brokerId: type: string description: The broker parachain id. palletVersion: type: string description: The pallet version. maxHistoricalRevenue: type: string description: The maximum historical revenue. CoretimeChainCoresResponse: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' cores: type: array items: $ref: '#/components/schemas/CoretimeCore' CoretimeRelayCoresResponse: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' cores: type: array items: $ref: '#/components/schemas/CoretimeRelayCoreDescriptor' CoretimeRelayCoreDescriptor: type: object properties: paraId: type: string description: The parachain id. type: type: string description: The parachain type. info: type: object properties: currentWork: type: object properties: assignments: type: array items: type: object properties: isPool: type: boolean description: Whether the workload is a pool. isTask: type: boolean description: Whether the workload is a task. ratio: type: string description: The ratio of the workload. remaining: type: string description: The remaining workload. task: type: string description: The parachain id. endHint: type: string description: The end hint. pos: type: string description: The position. step: type: string description: The step. queue: type: object properties: first: type: string description: The first assignment in queue. last: type: string description: The last assignment in queue. CoretimeCore: type: object properties: coreId: type: string description: The core id. paraId: type: string description: The parachain core. workload: type: object $ref: '#/components/schemas/CoretimeWorkload' workplan: type: array items: $ref: '#/components/schemas/CoretimeWorkplan' type: description: The paid price. type: object properties: condition: type: string description: Type of assignment. details: type: object oneOf: - $ref: '#/components/schemas/CoretimeUntil' - $ref: '#/components/schemas/CoretimeMask' regions: type: array items: $ref: '#/components/schemas/CoretimeRegion' CoretimeConfig: type: object properties: interludeLength: type: string description: The interlude length. leadinLength: type: string description: The leadin length. regionLength: type: string description: The region length. relayBlocksPerTimeslice: type: string description: The number of relay chain blocks per timeslice. CoretimeSaleInfo: type: object properties: phase: type: string description: The phase of the sale. saleStart: type: string description: The sale start. leadinLength: type: string description: The leading length. endPrice: type: string description: The end price. regionBegin: type: string description: The region start time. regionEnd: type: string description: The region end time. idealCoresSold: type: string description: The ideal number of cores sold. coresOffered: type: string description: The number of cores on sale. firstCore: type: string description: The first core id. selloutPrice: type: string description: The sellout price. coresSold: type: string description: The number of cores sold. CoretimeMask: type: string description: The mask. CoretimeUntil: type: string description: The lease expiry time. CoretimeWorkplan: type: object properties: core: type: string description: The core id. timeslice: type: string description: The timeslice. info: type: array items: $ref: '#/components/schemas/CoretimeWorkplanInfo' CoretimeWorkplanInfo: type: object properties: isPool: type: boolean description: Whether the workload is a pool. isTask: type: boolean description: Whether the workload is a task. mask: type: string description: The mask. task: type: string description: The parachain id. CoretimeWorkload: type: object properties: isPool: type: boolean description: Whether the workload is a pool. isTask: type: boolean description: Whether the workload is a task. mask: type: string description: The mask. task: type: string description: The parachain id. CoretimeRegion: type: object properties: core: type: string description: The core id. begin: type: string description: The begin time. end: type: string description: The end time. owner: type: string description: The owner of the region. paid: type: string description: The paid price. mask: type: string description: The mask. CoretimeLease: type: object properties: task: type: string description: The parachain id. until: type: string description: The lease expiry time. core: type: string description: The core id. CoretimeReservation: type: object properties: task: type: string description: The parachain id. mask: type: string description: The mask. CoretimeRenewal: type: object properties: completion: type: string description: The completion status. core: type: string description: The core id. mask: type: string description: The mask. price: type: string description: The renewal price. task: type: string description: The parachain id. when: type: string description: The renewal time. BlockWithDecodedXcmMsgs: allOf: - $ref: "#/components/schemas/Block" - $ref: "#/components/schemas/DecodedXcmMsgs" description: Block information that includes the decoded XCM messages if any are found in the queried block. If not, the decodedXcmMsgs object will be returned with three empty arrays corresponding to each direction, horizontalMessages, downwardMessages, upwardMessages. BondedPool: type: object properties: points: type: number state: type: string memberCounter: type: number roles: type: object properties: depositor: type: string root: type: string nominator: type: string stateToggler: type: string ChainType: type: object description: Type of the chain. It will return one of the following enum variants as a key. Live, Development, Local, or Custom. Each variant will have a value as null except when the ChainType is Custom, it will return a string. properties: live: type: string nullable: true default: null development: type: string nullable: true default: null local: type: string nullable: true default: null custom: type: string example: "{\"live\": null}" ContractsInkQuery: type: object description: Result from calling a query to a Ink contract. properties: debugMessage: type: string gasConsumed: type: string gasRequired: type: string output: type: boolean result: type: object description: Will result in an Ok or Err object depending on the result of the query. storageDeposit: type: object ContractMetadata: type: object description: Metadata used to instantiate a ContractPromise. This metadata can be generated by compiling the contract you are querying. DecodedXcmMsgs: type: object properties: decodedXcmMsgs: type: object properties: horizontalMessages: type: object oneOf: - $ref: "#/components/schemas/DecodedXcmMsgsHorizontalMessagesInRelay" - $ref: "#/components/schemas/DecodedXcmMsgsHorizontalMessagesInParachain" downwardMessages: type: array items: type: object properties: sentAt: type: string format: unsignedInteger description: Represents the block number that the XCM message was sent at on the relay chain. msg: type: string description: Represents the XCM message. data: type: object description: The decoded instructions included in the XCM message and their respective fields. upwardMessages: type: array items: type: object properties: originParaId: type: string format: unsignedInteger description: The Parachain id that the specific XCM message was sent from. data: type: object description: The decoded instructions included in the XCM message and their respective fields. description: Object with three arrays, one for every XCM direction. The arrays are populated or left empty based on the direction of the current XCM message that is being decoded. The XCM messages can be Upward and/or Horizontal (`in transit`) messages when connected to a Relay chain. When connected to a Parachain, the messages can be Downward and/or Horizontal. One or more messages can be present in a single block. In case of multiple messages from the same paraIds (originParaId and/or destinationParaId), the messages will be shown under the field `data`. DecodedXcmMsgsHorizontalMessagesInRelay: type: array items: type: object properties: originParaId: type: string format: unsignedInteger description: The Parachain id that the specific XCM message was sent from. destinationParaId: type: string format: unsignedInteger description: The Parachain id that the specific XCM message was sent to. data: type: object description: The decoded instructions included in the XCM message and their respective fields. description: Array that includes the Horizontal (`in transit`) messages when we are connected to a Relay Chain. Each block can contain one or more messages. If multiple messages share the same origin and destination paraId, they will be displayed within the data field. DecodedXcmMsgsHorizontalMessagesInParachain: type: array items: type: object properties: sentAt: type: string format: unsignedInteger description: Represents the block number that the XCM message was sent at on the relay chain. originParaId: type: string format: unsignedInteger description: The Parachain id that the specific XCM message was sent from. data: type: object description: The decoded instructions included in the XCM message and their respective fields. description: Array that includes the Horizontal Messages when we are connected to a Parachain. Each block can contain one or more messages. If multiple messages originate from the same parachain (originParaId), they will be displayed within the data field. DigestItem: type: object properties: type: type: string index: type: string format: unsignedInteger value: type: array items: type: string ElectionStatus: type: object properties: status: type: object description: >- [Deprecated](Works for polkadot runtimes before v0.8.30). Era election status: either `Close: null` or `Open: `. A status of `Close` indicates that the submission window for solutions from off-chain Phragmen is not open. A status of `Open` indicates that the submission window for off-chain Phragmen solutions has been open since BlockNumber. N.B. when the submission window is open, certain extrinsics are not allowed because they would mutate the state that the off-chain Phragmen calculation relies on for calculating results. toggleEstimate: type: string description: Upper bound estimate of the block height at which the `status` will switch. format: unsignedInteger description: Information about the off-chain election. Not included in response when `forceEra.isForceNone`. Error: type: object properties: code: type: number message: type: string stack: type: string level: type: string ExtrinsicMethod: type: object properties: pallet: type: string method: type: string description: Extrinsic method Extrinsic: type: object properties: method: $ref: '#/components/schemas/ExtrinsicMethod' signature: $ref: '#/components/schemas/Signature' nonce: type: string description: Account nonce, if applicable. format: unsignedInteger args: type: object description: >- Object of arguments keyed by parameter name. Note: if you are expecting an [`OpaqueCall`](https://substrate.dev/rustdocs/v2.0.0/pallet_multisig/type.OpaqueCall.html) and it is not decoded in the response (i.e. it is just a hex string), then Sidecar was not able to decode it and likely that it is not a valid call for the runtime. tip: type: string description: Any tip added to the transaction. format: unsignedInteger hash: type: string description: The transaction's hash. format: hex info: $ref: '#/components/schemas/RuntimeDispatchInfo' era: $ref: '#/components/schemas/GenericExtrinsicEra' events: type: array description: An array of `SanitizedEvent`s that occurred during extrinsic execution. items: $ref: '#/components/schemas/SanitizedEvent' success: type: boolean description: Whether or not the extrinsic succeeded. paysFee: type: boolean description: Whether the extrinsic requires a fee. Careful! This field relates to whether or not the extrinsic requires a fee if called as a transaction. Block authors could insert the extrinsic as an inherent in the block and not pay a fee. Always check that `paysFee` is `true` and that the extrinsic is signed when reconciling old blocks. ExtrinsicIndex: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' extrinsic: $ref: '#/components/schemas/Extrinsic' rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. format: unsignedInteger ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. format: unsignedInteger description: A single extrinsic at a given block. FundInfo: type: object properties: depositor: type: string verifier: type: string deposit: type: string format: unsignedInteger raised: type: string format: unsignedInteger end: type: string format: unsignedInteger cap: type: string format: unsignedInteger lastConstribution: type: string enum: - preEnding - ending firstPeriod: type: string format: unsignedInteger lastPeriod: type: string format: unsignedInteger trieIndex: type: string format: unsignedInteger GenericExtrinsicEra: type: object description: | The return value for era can either be `mortalEra`, or `immortalEra` and is represented as an enum in substrate. `immortalEra` meaning the transaction is valid forever. `mortalEra` consists of a tuple containing a period and phase. ex: `"{"mortalEra": ["64", "11"]}"`. The Period is the period of validity from the block hash found in the signing material. The Phase is the period that this transaction's lifetime begins (and, importantly, implies which block hash is included in the signature material). properties: mortalEra: type: array items: type: string description: Tuple of a Phase, and Period. Each item in the array will be a string formatted as an integer. immortalEra: type: string description: Hardcoded constant '0x00'. format: hex example: "{\"mortalEra\":[\"64\", \"11\"]}" LiquidityPools: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' pools: type: array description: Array containing existent liquidity pool's token id. items: $ref: '#/components/schemas/LiquidityPool' example: "[{\"reserves\":[{\"parents\":\"1\",\"interior\":{\"here\": null}},{\"parents\":\"0\",\"interior\":{\"x2\":[{\"palletInstance\": \"50\"},{\"generalIndex\":\"2\"}]}}],\"lpToken\":{\"lpToken\":\"1\"} },{\"lpToken\":{\"lpToken\":\"0\"}}]" rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. format: unsignedInteger ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. format: unsignedInteger LiquidityPool: type: object properties: reserves: type: array items: type: object properties: parents: type: string format: unsignedInteger interior: type: object lpToken: type: string format: unsignedInteger description: Liquidity pool token ID. NextAvailableId: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' id: type: string description: Next availabe liquidity pool's id. example: "4" rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. format: unsignedInteger ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. format: unsignedInteger NodeNetwork: type: object properties: nodeRoles: $ref: '#/components/schemas/NodeRole' numPeers: type: string description: Number of peers the node is connected to. format: unsignedInteger isSyncing: type: boolean description: Whether or not the node is syncing. `False` indicates that the node is in sync. shouldHavePeers: type: boolean description: Whether or not the node should be connected to peers. Might be false for local chains or when running without discovery. localPeerId: type: string description: Local copy of the `PeerId`. localListenAddresses: type: array description: Multiaddresses that the local node is listening on. The addresses include a trailing `/p2p/` with the local PeerId, and are thus suitable to be passed to `system_addReservedPeer` or as a bootnode address for example. items: type: string peersInfo: type: array items: $ref: '#/components/schemas/PeerInfo' NodeRole: type: string description: Role of this node. (N.B. Sentry nodes are being deprecated.) enum: - Full - LightClient - Authority - Sentry NodeVersion: type: object properties: clientVersion: type: string description: Node's binary version. clientImplName: type: string description: Node's implementation name. chain: type: string description: Node's chain name. description: Version information of the node. Nominations: type: object properties: targets: type: array items: type: string description: The targets of the nomination. submittedIn: type: string format: unsignedInteger description: >- The era the nominations were submitted. (Except for initial nominations which are considered submitted at era 0.) suppressed: type: boolean description: Whether the nominations have been suppressed. OnboardingAs: type: string enum: - parachain - parathread description: | This property only shows up when `paraLifecycle=onboarding`. It describes if a particular para is onboarding as a `parachain` or a `parathread`. Operation: type: object properties: phase: $ref: '#/components/schemas/OperationPhase' parentSpanId: $ref: '#/components/schemas/SpanId' primarySpanId: $ref: '#/components/schemas/SpanId' eventIndex: type: string format: unsignedInteger description: Index of the underlying trace event. address: type: string description: | Account this operation affects. Note - this will be an object like `{ id: address }` if the network uses `MultiAddress` storage: type: object properties: pallet: type: string item: type: string field1: type: string description: | A field of the storage item. (i.e `system::Account::get(address).data`) field2: type: string description: | A field of the struct described by field1 (i.e `system::Account::get(address).data.free`) amount: $ref: '#/components/schemas/OperationAmount' OperationAmount: type: object properties: values: type: string format: unsignedInteger currency: $ref: '#/components/schemas/OperationAmountCurrency' OperationAmountCurrency: type: object properties: symbol: type: string example: KSM OperationPhase: type: object properties: variant: type: string enum: - onInitialize - initialChecks - applyExtrinsic - onFinalize - finalChecks description: Phase of block execution pipeline. extrinsicIndex: type: string format: unsignedInteger description: | If phase variant is `applyExtrinsic` this will be the index of the extrinsic. Otherwise this field will not be present. PalletsAssetsInfo: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' assetInfo: $ref: '#/components/schemas/AssetInfo' assetMetadata: $ref: '#/components/schemas/AssetMetadata' rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. format: unsignedInteger ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. format: unsignedInteger PalletConstants: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' pallet: type: string description: Name of the pallet. example: "democracy" palletIndex: type: string description: Index of the pallet for looking up constants. example: "14" items: type: array items: $ref: '#/components/schemas/PalletConstantsItemMetadata' description: Array containing metadata for each constant entry of the pallet. rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. PalletConstantsItem: type: object properties: pallet: type: string description: Name of the pallet. example: "democracy" palletIndex: type: string description: Index of the pallet for looking up constants. example: "14" errorItem: type: string description: Name of the constant item. example: "EnactmentPeriod" metadata: $ref: '#/components/schemas/PalletConstantsItemMetadata' rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. PalletConstantsItemMetadata: type: object properties: name: type: string example: "VotingPeriod" description: The constant item's name (which is the same as the constant item's ID). type: type: string example: "4" value: type: string example: "0x00270600" description: The hex value of the constant docs: type: string example: "Information concerning any given constant.\n\n TWOX-NOTE: SAFE as indexes are not under an attacker’s control." description: Metadata of an constant item from a FRAME pallet. PalletDispatchables: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' pallet: type: string description: Name of the pallet. example: "democracy" palletIndex: type: string description: Index of the pallet for looking up dispatchables. example: "14" items: type: array items: $ref: '#/components/schemas/PalletDispatchablesItemMetadata' description: Array containing metadata for each dispatchable entry of the pallet. rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. format: unsignedInteger ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. format: unsignedInteger PalletDispatchablesItem: type: object properties: pallet: type: string description: Name of the pallet. example: "democracy" palletIndex: type: string description: Index of the pallet for looking up dispatchables. example: "14" dispatchableItem: type: string description: Name of the dispatchable item. example: "vote" metadata: $ref: '#/components/schemas/PalletDispatchablesItemMetadata' rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. format: unsignedInteger ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. format: unsignedInteger PalletDispatchablesItemMetadata: type: object properties: name: type: string example: "propose" description: The dispatchable item's name (which is the same as the dispatchable item's ID). fields: type: array items: type: string index: type: string example: "0" description: The index of the dispatchable item in the lists of pallet dispatchables. docs: type: string example: "Information concerning any given dispatchable.\n\n TWOX-NOTE: SAFE as indexes are not under an attacker’s control." args: type: array items: type: string description: Metadata of a dispatchable item from a FRAME pallet. PalletErrors: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' pallet: type: string description: Name of the pallet. example: "democracy" palletIndex: type: string description: Index of the pallet for looking up errors. example: "14" items: type: array items: $ref: '#/components/schemas/PalletErrorsItemMetadata' description: Array containing metadata for each error entry of the pallet. rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. PalletErrorsItem: type: object properties: pallet: type: string description: Name of the pallet. example: "democracy" palletIndex: type: string description: Index of the pallet for looking up errors. example: "14" errorItem: type: string description: Name of the error item. example: "ValueLow" metadata: $ref: '#/components/schemas/PalletErrorsItemMetadata' rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. PalletErrorsItemMetadata: type: object properties: name: type: string example: "InsufficientFunds" description: The error item's name (which is the same as the error item's ID). fields: type: array items: type: string index: type: string example: "0" description: The index of the error item in the lists of pallet errors docs: type: string example: " Information concerning any given error.\n\n TWOX-NOTE: SAFE as indexes are not under an attacker’s control." args: type: array items: type: string description: Metadata of an error item from a FRAME pallet. PalletEvents: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' pallet: type: string description: Name of the pallet. example: "democracy" palletIndex: type: string description: Index of the pallet for looking up events. example: "14" items: type: array items: $ref: '#/components/schemas/PalletEventsItemMetadata' description: Array containing metadata for each event entry of the pallet. rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. PalletEventsItem: type: object properties: pallet: type: string description: Name of the pallet. example: "democracy" palletIndex: type: string description: Index of the pallet for looking up events. example: "14" eventItem: type: string description: Name of the events item. example: "Proposed" metadata: $ref: '#/components/schemas/PalletEventsItemMetadata' rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. PalletEventsItemMetadata: type: object properties: name: type: string example: "Tabled" description: The event item's name (which is the same as the event item's ID). fields: type: array items: type: string index: type: string example: "0" description: The index of the error item in the lists of pallet events docs: type: string example: " Information concerning any given event.\n\n TWOX-NOTE: SAFE as indexes are not under an attacker’s control." args: type: array items: type: string description: Metadata of an event item from a FRAME pallet. PalletsForeignAssets: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' items: type: array items: $ref: '#/components/schemas/PalletsForeignAssetsInfo' description: Array containing the `AssetDetails` and `AssetMetadata` of every foreign asset. rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. format: unsignedInteger ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. format: unsignedInteger PalletsForeignAssetsInfo: type: object properties: multiLocation: $ref: '#/components/schemas/AssetMultiLocation' foreignAssetInfo: $ref: '#/components/schemas/AssetInfo' foreignAssetMetadata: $ref: '#/components/schemas/AssetMetadata' PalletsNominationPool: type: object properties: bondedPool: $ref: '#/components/schemas/BondedPool' rewardPool: $ref: '#/components/schemas/RewardPool' rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. PalletsNominationPoolsInfo: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' counterForBondedPools: type: number counterForMetadata: type: number counterForPoolMembers: type: number counterForReversePoolIdLookup: type: number counterForRewardPools: type: number counterForSubPoolsStorage: type: number lastPoolId: type: number maxPoolMembers: type: number maxPoolMembersPerPool: type: number nullable: true maxPools: type: number minCreateBond: type: number minJoinBond: type: number rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. PalletsOnGoingReferenda: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' referenda: type: array items: type: object properties: id: type: string description: Referendum's id. decisionDeposit: type: object properties: who: type: string description: The account who placed the referendum's decision deposit. amount: type: string format: unsignedInteger description: The amount of the decision deposit. description: A deposit which is required for a referendum to progress to the decision phase. enactment: type: string enum: - at - after description: The enactment period of the referendum. It can be defined using either the `at` option, which specifies the exact block height when the referendum will be enacted, or the `after` option, which indicates the number of blocks after which the enactment will occur. submitted: type: string format: unsignedInteger description: The block number at which the referendum was submitted. deciding: type: object properties: since: type: string format: unsignedInteger description: The block number at which the referendum started being `decided`. confirming: type: string format: unsignedInteger description: The block number at which the referendum's confirmation stage will end at as long as it doesn't lose its approval in the meantime. description: A list of ongoing referenda and their details. rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. PalletsPoolAssetsInfo: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' poolAssetInfo: $ref: '#/components/schemas/AssetInfo' poolAssetMetadata: $ref: '#/components/schemas/AssetMetadata' rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. PalletStorage: type: object properties: pallet: type: string description: Name of the pallet. example: "democracy" palletIndex: type: string description: Index of the pallet for looking up storage. example: "15" items: type: array items: $ref: '#/components/schemas/PalletStorageItemMetadata' description: Array containing metadata for each storage entry of the pallet. rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. PalletStorageItem: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' pallet: type: string description: Name of the pallet. example: "democracy" palletIndex: type: string description: Index of the pallet for looking up storage. example: "15" storageItem: type: string description: Name of the storage item. example: "referendumInfoOf" keys: type: array items: type: string description: N Storage keys passed in as the `keys` query param. example: ["0x00", "0x01"] value: type: object description: Value returned by this storage query. example: Ongoing: end: "1612800" proposalHash: "0x7de70fc8be782076d0b5772be77153d172a5381c72dd56d3385e25f62abf507e" threshold: "Supermajorityapproval" delay: "403200" tally: ayes: "41925212461400000" nays: "214535586500000" turnout: "34485320658000000" metadata: $ref: '#/components/schemas/PalletStorageItemMetadata' rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. PalletStorageItemMetadata: type: object properties: name: type: string example: "ReferendumInfoOf" description: The storage item's name (which is the same as the storage item's ID). modifier: type: string example: "Optional" type: $ref: '#/components/schemas/PalletStorageType' fallback: type: string example: "0x00" docs: type: string example: " Information concerning any given referendum.\n\n TWOX-NOTE: SAFE as indexes are not under an attacker’s control." description: Metadata of a storage item from a FRAME pallet. PalletStorageType: type: object description: This is going to be formatted to the type of StorageEntryTypeV14. Para: type: object properties: paraId: type: string format: unsignedInteger paraLifecycle: $ref: '#/components/schemas/ParaLifecycle' onboardingAs: $ref: '#/components/schemas/OnboardingAs' Paras: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' paras: type: array items: $ref: '#/components/schemas/Para' ParasAuctionsCurrent: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' beginEnd: type: string format: unisgnedInteger or $null description: | Fist block (number) of the auction ending phase. `null` if there is no ongoing auction. finishEnd: type: string format: unisgnedInteger or $null description: | Last block (number) of the auction ending phase. `null` if there is no ongoing auction. phase: type: string enum: - startPeriod - endPeriod - vrfDelay description: | An auction can be in one of 4 phases. Both `startingPeriod` () and `endingPeriod` indicate an ongoing auction, while `vrfDelay` lines up with the `AuctionStatus::VrfDelay` . Finally, a value of `null` indicates there is no ongoing auction. Keep in mind the that the `finishEnd` field is the block number the `endingPeriod` finishes and the `vrfDelay` period begins. The `vrfDelay` period is typically about an epoch long and no crowdloan contributions are accepted. auctionIndex: type: string format: unsignedInteger description: | The auction number. If there is no current auction this will be the number of the previous auction. leasePeriods: type: array items: type: string format: unsignedInteger description: | Lease period indexes that may be bid on in this auction. `null` if there is no ongoing auction. winning: type: array items: $ref: '#/components/schemas/WinningData' ParasCrowdloans: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' funds: type: array items: type: object properties: paraId: type: string format: unsignedInteger fundInfo: $ref: '#/components/schemas/FundInfo' description: | List of paras that have crowdloans. ParasCrowdloanInfo: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' fundInfo: $ref: '#/components/schemas/FundInfo' leasePeriods: type: array items: type: string format: unsignedInteger description: Lease periods the crowdloan can bid on. ParasHeaders: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' paraId: type: object description: | The key is not named `paraId` and will be the number of the parachain. There is technically no limit to the number of paraId keys there can be. properties: hash: type: string description: The block's hash. format: hex number: type: string description: The block's height. format: unsignedInteger parentHash: type: string description: The hash of the parent block. format: hex stateRoot: type: string description: The state root after executing this block. format: hex extrinsicsRoot: type: string description: The Merkle root of the extrinsics. format: hex digest: type: object properties: logs: type: array items: $ref: '#/components/schemas/DigestItem' description: Array of `DigestItem`s associated with the block. ParachainInclusion: type: object properties: parachainBlock: type: integer description: The parachain block number that was searched for. parachainBlockHash: type: string format: hex description: The hash of the parachain block. parachainId: type: integer description: The parachain ID. relayParentNumber: type: integer description: The relay chain block number used as parent during parachain block production. inclusionNumber: type: integer nullable: true description: The relay chain block number where the parachain block was included (null if not found). found: type: boolean description: Whether the inclusion was found within the search depth. required: - parachainBlock - parachainBlockHash - parachainId - relayParentNumber - inclusionNumber - found ParasLeasesCurrent: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' leasePeriodIndex: type: string format: unsignedInteger description: Current lease period index. This value may be null when the current block now, substracted by the leaseOffset is less then zero. endOfLeasePeriod: type: string format: unsignedInteger description: Last block (number) of the current lease period. This value may be null when `leasePeriodIndex` is null. currentLeaseHolders: type: array items: type: string format: unsignedInteger description: List of `paraId`s that currently hold a lease. ParasLeaseInfo: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' paraLifecycle: $ref: '#/components/schemas/ParaLifecycle' onboardingAs: $ref: '#/components/schemas/OnboardingAs' leases: type: array items: type: object properties: leasePeriodIndex: type: string format: unsignedInteger account: type: string deposit: type: string format: unsignedInteger description: | List of lease periods for which the `paraId` holds a lease along with the deposit held and the associated `accountId`. ParaLifecycle: type: string enum: - onboarding - parathread - parachain - upgradingParathread - downgradingParachain - offboardingParathread - offboardingParachain description: | The possible states of a para, to take into account delayed lifecycle changes. Payouts: type: array items: type: object properties: validatorId: type: string description: AccountId of the validator the payout is coming from. nominatorStakingPayout: type: string format: unsignedInteger description: Payout for the reward destination associated with the accountId the query was made for. claimed: type: boolean description: Whether or not the reward has been claimed. totalValidatorRewardPoints: type: string format: unsignedInteger description: Number of reward points earned by the validator. validatorCommission: type: string format: unsignedInteger description: The percentage of the total payout that the validator takes as commission, expressed as a Perbill. totalValidatorExposure: type: string format: unsignedInteger description: The sum of the validator's and its nominators' stake. nominatorExposure: type: string format: unsignedInteger description: The amount of stake the nominator has behind the validator. description: Payout for a nominating _Stash_ address and information about the validator they were nominating. PeerInfo: type: object properties: peerId: type: string description: Peer ID. roles: type: string description: Roles the peer is running protocolVersion: type: string description: Peer's protocol version. format: unsignedInteger bestHash: type: string description: Hash of the best block on the peer's canon chain. format: hex bestNumber: type: string description: Height of the best block on the peer's canon chain. format: unsignedInteger RewardPool: type: object properties: lastRecordedRewardCounter: type: number lastRecordedTotalPayouts: type: number totalRewardsClaimed: type: number RuntimeCode: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' code: type: string format: hex RuntimeDispatchInfo: type: object properties: weight: $ref: '#/components/schemas/WeightsV2' description: Weights represented as WeightsV2 (two dimensional weights). When querying historical blocks that use WeightsV1, the weight will be returned as a weight key that points to a number represented as a string. class: type: string description: Extrinsic class. enum: - Normal - Operational - Mandatory partialFee: type: string description: The _inclusion fee_ of a transaction, i.e. the minimum fee required for a transaction. Includes weight and encoded length fees, but does not have access to any signed extensions, e.g. the `tip`. format: unsignedInteger kind: type: string description: Information on the partialFee that is collected. Can be either `preDispatch`, `postDispatch` or `fromEvent`. `preDispatch` means the information used to collect the fee was from `payment_queryInfo`, `postDispatch` means the information used to calculate the fee was from finalized weights for the extrinsic, and `fromEvent` means that the partialFee was abstracted from the `TransactionPayment::TransactionPaidFee` event. description: RuntimeDispatchInfo for the transaction. Includes the `partialFee`. RuntimeMetadata: type: object description: | Substrate runtime metadata containing pallet information, types registry, and API specifications. The structure varies significantly between different runtime versions (V9-V16) and different chains. This is a generic container that preserves the actual metadata structure as returned by the runtime. properties: magicNumber: type: string description: The magic number identifying this as Substrate metadata (typically "1635018093") example: "1635018093" metadata: type: object description: | Version-specific metadata content. The structure depends entirely on the runtime metadata version and can include various combinations of pallets, lookup registries, extrinsics, APIs, and other runtime-specific information. required: - magicNumber - metadata RuntimeSpec: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' authoringVersion: type: string description: The version of the authorship interface. An authoring node will not attempt to author blocks unless this is equal to its native runtime. chainType: $ref: '#/components/schemas/ChainType' implVersion: type: string description: Version of the implementation specification. Non-consensus-breaking optimizations are about the only changes that could be made which would result in only the `impl_version` changing. The `impl_version` is set to 0 when `spec_version` is incremented. specName: type: string description: Identifies the different Substrate runtimes. specVersion: type: string description: Version of the runtime specification. transactionVersion: type: string description: All existing dispatches are fully compatible when this number doesn't change. This number must change when an existing dispatchable (module ID, dispatch ID) is changed, either through an alteration in its user-level semantics, a parameter added/removed/changed, a dispatchable being removed, a module being removed, or a dispatchable/module changing its index. properties: type: object description: Arbitrary properties defined in the chain spec. description: Version information related to the runtime. SanitizedEvent: type: object properties: method: type: string data: type: array items: type: string Signature: type: object properties: signature: type: string format: hex signer: type: string format: ss58 description: Object with `signature` and `signer`, or `null` if unsigned. SpanId: type: object properties: name: type: string target: type: string id: type: string format: unsignedInteger StakingLedger: type: object properties: stash: type: string description: The _Stash_ account whose balance is actually locked and at stake. format: ss58 total: type: string description: The total amount of the _Stash_'s balance that we are currently accounting for. Simply `active + unlocking`. format: unsignedInteger active: type: string description: The total amount of the _Stash_'s balance that will be at stake in any forthcoming eras. format: unsignedInteger unlocking: type: string description: Any balance that is becoming free, which may eventually be transferred out of the _Stash_ (assuming it doesn't get slashed first). Represented as an array of objects, each with an `era` at which `value` will be unlocked. format: unsignedInteger claimedRewards: type: array description: Array of objects, each containing an `era` and its corresponding `status`, which represents the rewards status of the queried Stash account. The queried account can either be a validator or nominator account. This array is populated with values from `stakingLedger.lastReward`, `stakingLedger.legacyClaimedRewards` or `stakingLedger.claimedRewards`, as well as the `query.staking.claimedRewards` call, depending on whether the queried block is before or after the migration. For more details on the implementation and the migration, refer to the related PR (https://github.com/paritytech/substrate-api-sidecar/pull/1445) and linked issue (https://github.com/paritytech/substrate-api-sidecar/issues/1433#issuecomment-2075914389). items: type: object properties: era: type: string description: The era for which we check the rewards status. format: unsignedInteger status: type: string description: The rewards status of the stakers backing a validator. enum: - claimed - unclaimed - partially claimed description: The staking ledger. StakingProgress: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' activeEra: type: string description: | `EraIndex` of the era being rewarded. format: unsignedInteger forceEra: type: string description: Current status of era forcing. enum: - ForceNone - NotForcing - ForceAlways - ForceNew nextActiveEraEstimate: type: string description: Upper bound estimate of the block height at which the next active era will start. Not included in response when `forceEra.isForceNone`. format: unsignedInteger nextSessionEstimate: type: string description: Upper bound estimate of the block height at which the next session will start. format: unsignedInteger unappliedSlashes: type: array items: $ref: '#/components/schemas/UnappliedSlash' description: Array of upcoming `UnappliedSlash` indexed by era. electionStatus: $ref: '#/components/schemas/ElectionStatus' idealValidatorCount: type: string description: Upper bound of validator set size; considered the ideal size. Not included in response when `forceEra.isForceNone`. format: unsignedInteger validatorSet: type: array description: Stash account IDs of the validators for the current session. Not included in response when `forceEra.isForceNone`. items: type: string format: ss58 rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. format: unsignedInteger ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. format: unsignedInteger StakingValidators: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' validators: type: array items: type: object properties: address: type: string description: Address of validator. status: type: string description: Status of individual validator (active/waiting). commission: type: string description: The validator's commission rate as parts-per-billion (e.g., "100000000" = 10%). Not present for chilled validators. blocked: type: boolean description: Whether the validator is blocked from receiving new nominations. Not present for chilled validators. validatorsToBeChilled: description: Validators that will not be participating in the next era. type: array items: type: object properties: address: type: string description: Address of validator. status: type: string description: Status of individual validator (active/waiting). rcBlockHash: type: string description: The relay chain block hash used for the query. Only present when `useRcBlock` parameter is used. rcBlockNumber: type: string description: The relay chain block number used for the query. Only present when `useRcBlock` parameter is used. format: unsignedInteger ahTimestamp: type: string description: The Asset Hub block timestamp. Only present when `useRcBlock` parameter is used. format: unsignedInteger StorageEntryTypeV13: type: object properties: hasher: type: string description: Returns a string deonting the storage hasher. key: type: string description: Key of the queried pallet storageId. value: type: string description: Value of the queried pallet storageId. linked: type: boolean StorageEntryTypeV14: type: object properties: hasher: type: array items: type: string description: Returns a string denoting the storage hasher inside of an array. key: type: string description: The SiLookupTypeId to identify the type. value: type: string description: The SiLookupTypeId to identify the type. TraceEvent: type: object properties: data: type: object properties: stringValues: $ref: '#/components/schemas/TraceEventDataStringValues' parentId: type: string format: unsignedInteger target: type: string TraceEventDataStringValues: type: object properties: key: type: string format: hex description: The complete storage key for the entry. method: type: string description: Normally one of Put or Get. result: type: string format: hex description: Hex scale encoded storage value. description: Note these exact values will only be present for storage events. TraceSpan: type: object properties: id: type: string format: unsignedInteger name: type: string parentId: type: string format: unsignedInteger target: type: string wasm: type: boolean Transaction: type: object properties: tx: type: string format: hex TransactionDispatchOutcome: type: object description: The result of a valid transaction submitted via the `dry-run` endpoint. properties: actualWeight: type: string format: unsignedInteger description: The actual weight of the transaction. paysFee: type: string format: boolean description: Whether the transaction pays a fee. TransactionDispatchError: type: object description: The reason why the dispatch call failed. properties: errorType: type: string enum: - Other - CannotLookup - BadOrigin - ModuleError - ConsumerRemaining - NoProviders - TooManyConsumers - TokenError - ArithmeticError - TransactionalError - Exhausted - Corruption - Unavailable - RootNotAllowed description: The type of transaction error. TransactionValidityError: type: object description: The error result from an invalid transaction submitted via the `dry-run` endpoint. properties: errorType: type: string enum: - Unimplemented - VersionedConversionFailed description: The type of transaction error, either `Unimplemented` or `VersionedConversionFailed`. DryRunBody: type: object properties: at: type: string format: unsignedInteger tx: type: string format: hex senderAddress: type: string format: ss58 TransactionDryRun: type: object properties: resultType: type: string enum: - DispatchOutcome - DispatchError - TransactionValidityError description: The result will be either a `DispatchOutcome` if the transaction is valid, a `DispatchError` if the transaction failed, or a `TransactionValidityError` if the transaction is invalid. result: oneOf: - $ref: '#/components/schemas/TransactionDispatchOutcome' - $ref: '#/components/schemas/TransactionDispatchError' - $ref: '#/components/schemas/TransactionValidityError' description: >- References: - `PostDispatchInfo`: https://docs.rs/frame-support/38.0.0/frame_support/dispatch/struct.PostDispatchInfo.html - `DispatchError`: https://docs.rs/sp-runtime/39.0.1/sp_runtime/enum.DispatchError.html - `Error Type`: https://paritytech.github.io/polkadot-sdk/master/xcm_runtime_apis/dry_run/enum.Error.html TransactionFailedToParse: type: object properties: code: type: number error: type: string description: >- `Failed to parse a tx.` transaction: type: string format: hex cause: type: string stack: type: string description: Error message when Sidecar fails to parse the transaction. TransactionFailedToSubmit: type: object properties: code: type: number error: type: string description: Failed to submit transaction. transaction: type: string format: hex cause: type: string stack: type: string description: >- Error message when the node rejects the submitted transaction. TransactionFailure: oneOf: - $ref: '#/components/schemas/TransactionFailedToSubmit' - $ref: '#/components/schemas/TransactionFailedToParse' TransactionFeeEstimate: type: object properties: weight: $ref: '#/components/schemas/WeightsV2' description: Weights represented as WeightsV2 (two dimensional weights). When querying historical blocks that use WeightsV1, the weight will be returned as a weight key that points to a number represented as a string. class: type: string description: Extrinsic class. enum: - Normal - Operational - Mandatory partialFee: type: string description: Expected inclusion fee for the transaction. Note that the fee rate changes up to 30% in a 24 hour period and this will not be the exact fee. format: unsignedInteger description: >- Note: `partialFee` does not include any tips that you may add to increase a transaction's priority. See [compute_fee](https://crates.parity.io/pallet_transaction_payment/struct.Module.html#method.compute_fee). TransactionFeeEstimateFailure: type: object properties: code: type: number at: type: object properties: hash: type: string error: type: string description: Error description. transaction: type: string format: hex block: type: string description: Block hash of the block fee estimation was attempted at. cause: type: string description: Error message from the client. stack: type: string TransactionMaterial: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' genesisHash: type: string description: The hash of the chain's genesis block. format: blockHash chainName: type: string description: The chain's name. specName: type: string description: The chain's spec. specVersion: type: string description: The spec version. Always increased in a runtime upgrade. txVersion: type: string description: The transaction version. Common `txVersion` numbers indicate that the transaction encoding format and method indices are the same. Needed for decoding in an offline environment. Adding new transactions does not change `txVersion`. metadata: type: string description: The chain's metadata. It will only be present when the metadata query param is used. description: >- Note: `chainName`, `specName`, and `specVersion` are used to define a type registry with a set of signed extensions and types. For Polkadot and Kusama, `chainName` is not used in defining this registry, but in other Substrate-based chains that re-launch their network without changing the `specName`, the `chainName` would be needed to create the correct registry. Substrate Reference: - `RuntimeVersion`: https://crates.parity.io/sp_version/struct.RuntimeVersion.html - `SignedExtension`: https://crates.parity.io/sp_runtime/traits/trait.SignedExtension.html - FRAME Support: https://crates.parity.io/frame_support/metadata/index.html MetadataBlobBody: type: object properties: tx: type: string format: hex description: Full encoded extrinsic as a hex string. txAdditionalSigned: type: string format: hex description: Optional additional signed data for the extrinsic. Used together with `tx`. callData: type: string format: hex description: Call data as hex string. Use this alongside includedInExtrinsic and includedInSignedData instead of `tx`. includedInExtrinsic: type: string format: hex description: Signed extension data included in the extrinsic. Required when using callData. includedInSignedData: type: string format: hex description: Signed extension data included in the signature. Required when using callData. at: type: string description: Block hash or number to query at. Defaults to finalized head. format: unsignedInteger or $hex description: >- Request body for generating the metadata blob. You must provide either: (1) `tx` (full extrinsic) with optional `txAdditionalSigned`, or (2) `callData` with `includedInExtrinsic` and `includedInSignedData`. TransactionMetadataBlob: type: object properties: at: $ref: '#/components/schemas/BlockIdentifiers' metadataHash: type: string format: hex description: The 32-byte metadata hash (hex-encoded) that should be used with the CheckMetadataHash signed extension. metadataBlob: type: string format: hex description: The metadata blob (hex-encoded) containing the minimal metadata required for offline signers to decode the transaction. This is a SCALE-encoded Proof structure per RFC-0078. specVersion: type: number description: The chain's spec version. specName: type: string description: The chain's spec name. base58Prefix: type: number description: The chain's SS58 address prefix. decimals: type: number description: Number of decimals for the chain's native token. tokenSymbol: type: string description: Symbol for the chain's native token. description: >- Response containing the metadata blob for offline signers. The metadataBlob contains type definitions needed to decode the specific transaction, Merkle proofs verifying these types are part of the full metadata, and extra chain info. TransactionPool: type: object properties: pool: type: array items: type: object properties: hash: type: string format: hex description: H256 hash of the extrinsic. encodedExtrinsic: type: string format: hex description: Scale encoded extrinsic. tip: type: string format: unsignedInteger description: The tip included in the extrinsic. Only included if the query param `includeFee` is set to true. priority: type: string format: unsignedInteger description: Computed priority of an extrinsic. Only included if the query param `includeFee` is set to true. partialFee: type: string format: unsignedInteger description: Provided `partialFee` of an extrinsic. Only included if the query param `includeFee` is set to true. TransactionSuccess: type: object properties: hash: type: string description: The hash of the encoded transaction. UnappliedSlash: type: object properties: validator: type: string description: Stash account ID of the offending validator. format: ss58 own: type: string description: The amount the validator will be slashed. format: unsignedInteger others: type: array description: Array of tuples(`[accountId, amount]`) representing all the stashes of other slashed stakers and the amount they will be slashed. items: type: string format: tuple[ss58, unsignedInteger] reporters: type: array description: Array of account IDs of the reporters of the offense. items: type: string format: ss58 payout: type: string description: Amount of bounty payout to reporters. format: unsignedInteger VestingSchedule: type: object properties: locked: type: string description: Number of tokens locked at start. format: unsignedInteger perBlock: type: string description: Number of tokens that gets unlocked every block after `startingBlock`. format: unsignedInteger startingBlock: type: string description: Starting block for unlocking (vesting). format: unsignedInteger vested: type: string description: Amount that has vested based on time elapsed for this schedule. Only present when `includeClaimable` parameter is used. format: unsignedInteger description: Vesting schedule for an account. WeightsV2: type: object properties: refTime: type: string description: The weight of computational time used based on some reference hardware. proofSize: type: string description: The weight of storage space used by proof of validity. WinningData: type: object properties: bid: type: object properties: accountId: type: string paraId: type: string format: unsignedInteger amount: type: string format: unsignedInteger leaseSet: type: array items: type: string format: unsignedInteger description: | A currently winning bid and the set of lease periods the bid is for. The `amount` of the bid is per lease period. The `bid` property will be `null` if no bid has been made for the corresponding `leaseSet`. requestBodies: Transaction: content: application/json: schema: $ref: '#/components/schemas/Transaction' required: true TransactionDryRun: content: application/json: schema: $ref: '#/components/schemas/DryRunBody' required: true TransactionMetadataBlob: content: application/json: schema: $ref: '#/components/schemas/MetadataBlobBody' required: true ContractMetadata: content: application/json: schema: $ref: '#/components/schemas/ContractMetadata'