v20.14.1

⚠️ Deprecation Notice

substrate-api-sidecar is deprecated in favor of polkadot-rest-api.

polkadot-rest-api is a ground-up Rust rewrite built on 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. Stable v0.1.0 follows seven beta releases with partner feedback.

• Docker: docker pull paritytech/polkadot-rest-api:v0.1.0
• Crate: polkadot-rest-api@0.1.0
• GitHub: https://github.com/paritytech/polkadot-rest-api
• Documentation: https://paritytech.github.io/polkadot-rest-api/
• Migration guide: MIGRATION.md
• Issues/feedback: https://github.com/paritytech/polkadot-rest-api/issues

This is the final feature release. Only critical-security fixes will be backported, if any. Use polkadot-rest-api for all new development.

Fix

• fix: use ClaimedRewards storage for claimed status in staking-payouts (#1922)
• fix: remove IBP kilt endpoint (#1896)
• feat/fix: benchmarks refactoring, CI script fixes, lua path, migration finalization, and grep -A window bump (#1917, #1928, #1933, #1954, #1960)
• chore: bump Node.js from 18 to 22 — required because lru-cache@11 relies on node:diagnostics_channel.tracingChannel (Node 20.2+) (#1958)

Chore

• chore(deps): bump axios from 1.12.2 to 1.15.2 (incl. security pin) (#1893, #1935, #1950, #1952)
• chore(deps): bump lru-cache from 11.2.5 to 11.3.5 (#1899, #1920, #1943)
• chore(deps): bump @polkadot-api/merkleize-metadata from 1.1.29 to 1.2.1 (#1942, #1956)
• chore(deps): bump express and @types/express (#1845)
• chore(deps): bump qs from 6.14.1 to 6.14.2 (#1898)
• chore(deps): bump bn.js from 5.2.1 to 5.2.3 (#1903)
• chore(deps): bump winston-loki from 6.1.3 to 6.1.4 (#1900)
• chore(deps): bump flatted from 3.2.7 to 3.4.2 (#1923)
• chore(deps): bump picomatch from 2.3.1 to 2.3.2 (#1924)
• chore(deps): bump path-to-regexp from 8.2.0 to 8.4.0 (#1931)
• chore(deps): bump lodash from 4.17.23 to 4.18.1 (#1939)
• chore(deps): bump protobufjs from 7.3.2 to 7.5.5 (#1948)
• chore(deps): bump minimatch from 3.1.2 to 3.1.5 (#1910)
• chore(deps): bump rollup from 4.42.0 to 4.59.0 (#1906)
• chore(deps-dev): bump @acala-network/chopsticks-testing (#1892, #1955)
• chore(deps): bump /docs packages — axios, qs, minimatch, immutable, picomatch, yaml, brace-expansion, lodash, follow-redirects, postcss, webpack (#1890, #1893, #1897, #1904, #1909, #1915, #1925, #1927, #1930, #1938, #1944, #1950, #1953)
• chore(deps): bump /docs-v2 packages — tar, webpack, minimatch, brace-expansion, node-forge, lodash, postcss, picomatch, follow-redirects (#1884, #1891, #1902, #1905, #1913, #1916, #1926, #1929, #1932, #1946, #1957, #1959)
• chore(ci): bump GitHub Actions — docker/build-push-action, docker/login-action, actions/upload-artifact, actions/download-artifact, actions/create-github-app-token, Swatinem/rust-cache, benchmark-action/github-action-benchmark (#1895, #1907, #1908, #1911, #1912, #1914, #1918, #1921, #1936, #1940)
• chore: deprecate substrate-api-sidecar in favor of polkadot-rest-api (#1951)

v20.14.0

Feat

• feat: add POST /transaction/metadata-blob endpoint for RFC-0078 merkleized metadata support (#1886) (64c1bdd)
  • Returns minimal metadata ("metadata blob") needed by offline signers to decode transaction payloads
  • Returns metadata hash for the CheckMetadataHash signed extension
  • Supports both full extrinsic (tx) and extrinsic parts (callData, includedInExtrinsic, includedInSignedData)
  • Requires V15 metadata on the connected chain
• feat: add useRcBlockFormat query parameter for RC block response formatting (#1872) (59b88c9)
  • When useRcBlock=true and useRcBlockFormat=object, wraps response in an object containing rcBlock info and parachainDataPerBlock array
  • Adds IRcBlockInfo and IRcBlockObjectResponse types
  • Supports blocks, accounts, and pallets controllers

Chore

• chore(deps): bump lru-cache from 11.2.4 to 11.2.5 (#1882) (de0c540)
• chore(deps): bump lodash from 4.17.21 to 4.17.23 (#1878, #1879, #1880)
• chore(deps): bump tar from 7.4.3 to 7.5.6 in /docs-v2 (#1874, #1877)
• chore(deps): bump node-forge from 1.3.1 to 1.3.3 in /docs-v2 (#1871) (a80cbee)
• chore(deps): bump qs from 6.14.0 to 6.14.1 (#1866, #1867)
• chore(deps): bump actions/download-artifact from 6 to 7 (#1859) (43cf9fe)
• chore(deps): bump actions/upload-artifact from 5 to 6 (#1858) (d0ceac5)
• chore(deps): bump actions/cache from 4 to 5 (#1857) (ba363e5)

Compatibility

Tested against the following node releases:

• Polkadot v1.21.0 (Polkadot stable2512)
• Kusama v1.21.0 (Polkadot stable2512)
• Westend v1.21.0 (Polkadot stable2512)

Tested against the following runtime releases:

• Polkadot v2000001
• Kusama v2000004
• Westend v1021000
• Polkadot Asset Hub v2000003
• Kusama Asset Hub v2000004

v20.13.3

Fix

• fix: unappliedSlashes per era (#1869) (51d7293)
• fix: unappliedSlashesAtActiveEra in staking/progress (#1868) (ee1d98f)

Compatibility

Tested against the following node releases:

• Polkadot v1.21.0 (Polkadot stable2512)
• Kusama v1.21.0 (Polkadot stable2512)
• Westend v1.21.0 (Polkadot stable2512)

Tested against the following runtime releases:

• Polkadot v2000001
• Kusama v2000004
• Westend v1021000
• Polkadot Asset Hub v2000003
• Kusama Asset Hub v2000004

v20.13.2

Fix

• chore: pin polkadot-js versions to prevent dependency conflicts on fresh installs (#1862) (d7945b1)

Compatibility

Tested against the following node releases:

• Polkadot v1.20.0 (Polkadot stable2509)
• Kusama v1.20.0 (Polkadot stable2509)
• Westend v1.20.0 (Polkadot stable2509)

Tested against the following runtime releases:

• Polkadot v2000000
• Kusama v1009002
• Westend v1020004
• Polkadot Asset Hub v2000000
• Kusama Asset Hub v1009002

v20.13.1

Fix

• chore: pin polkadot-js versions to prevent dependency conflicts on fresh installs (#1862) (d7945b1)

Compatibility

Tested against the following node releases:

• Polkadot v1.20.0 (Polkadot stable2509)
• Kusama v1.20.0 (Polkadot stable2509)
• Westend v1.20.0 (Polkadot stable2509)

Tested against the following runtime releases:

• Polkadot v2000000
• Kusama v1009002
• Westend v1020004
• Polkadot Asset Hub v2000000
• Kusama Asset Hub v1009002

v20.13.0

Feat

• feat: add includeClaimable query param to vesting-info endpoints (#1860) (afb3ba6)
• feat: Add simple grafana dashboard that can be used when running sidecar (#1856) (3bad62f)

Chore

• chore: ignore polkadot-js deps in dependabot (#1853) (3683c4d)
• chore(deps): bump winston from 3.18.3 to 3.19.0 (#1854) (7afbb72)
• chore(deps): bump express from 4.21.2 to 4.22.1 in /docs (#1843) (750431f)
• chore(deps): bump lru-cache from 11.2.2 to 11.2.4 (#1842) (7981d91)
• chore(deps-dev): bump @acala-network/chopsticks-testing (#1841) (c81709e)
• chore(deps): bump express from 5.1.0 to 5.2.0 (#1840) (e876817)

CI

• ci: remove polkadot-js from auto updates (#1844) (a489c96)

Compatibility

Tested against the following node releases:

• Polkadot v1.20.0 (Polkadot stable2509)
• Kusama v1.20.0 (Polkadot stable2509)
• Westend v1.20.0 (Polkadot stable2509)

Tested against the following runtime releases:

• Polkadot v2000000
• Kusama v1009002
• Westend v1020004
• Polkadot Asset Hub v2000000
• Kusama Asset Hub v1009002

v20.12.0

20.12.0 (2025-12-01)

Feat

• feat: Add accounts/{}/foreign-asset-balances (#1834) (1772e85)

Fix

• fix: Use Parity nodes in the integration tests. (#1829) (f06e9db)
• fix: add PAH consts to ahm-info (#1823) (e79e4a0)

Chore

• chore(pjs): Update pjs deps and fix BlockHash type as part of build (#1830) (5eefb62)
• chore(deps): bump body-parser from 2.2.0 to 2.2.1 (#1836) (abb0052)
• chore(deps): bump http-errors from 2.0.0 to 2.0.1 (#1835) (e7de89f)
• chore(deps): bump js-yaml from 3.14.1 to 3.14.2 (#1831) (c3fade7)
• chore(deps): bump winston from 3.17.0 to 3.18.3 (#1825) (cd0b073)
• chore(deps): bump lru-cache from 11.1.0 to 11.2.2 (#1812) (7294133)
• chore(deps): bump typeorm from 0.3.24 to 0.3.27 (#1817) (10a3095)
• chore(deps): bump actions/checkout from 5 to 6 (#1833) (22ee44c)
• chore(deps): bump actions/upload-artifact from 4 to 5 (#1807) (8c4d120)
• chore(deps): bump actions/download-artifact from 5 to 6 (#1808) (bf83ec6)
• chore(deps): bump Swatinem/rust-cache from 2.8.1 to 2.8.2 (#1837) (8aa8968)
• chore(deps): bump glob from 10.4.5 to 10.5.0 in /docs-v2 (#1832) (6d09f4e)
• chore(deps-dev): bump @types/express from 5.0.3 to 5.0.5 (#1826, #1811) (0f3ff62)

Compatibility

Tested against the following node releases:

• Polkadot v1.20.0 (Polkadot stable2509)
• Kusama v1.20.0 (Polkadot stable2509)
• Westend v1.20.0 (Polkadot stable2509)

Tested against the following runtime releases:

• Polkadot v2000000
• Kusama v1009002
• Westend v1020004
• Polkadot Asset Hub v2000000
• Kusama Asset Hub v1009002

v20.11.0

Feat

• feat: add rcBlockHash to useRcBlock response (#1818) (22873fb)

Compatibility

Tested against the following node releases:

• Polkadot v1.20.0 (Polkadot stable2509)
• Kusama v1.20.0 (Polkadot stable2509)
• Westend v1.20.0 (Polkadot stable2509)

Tested against the following runtime releases:

• Polkadot v2000000
• Kusama v1009002
• Westend v1020004
• Polkadot Asset Hub v2000000
• Kusama Asset Hub v1009002

v20.10.2

Fix

• fix: add validatorSet when forceNone for /staking/progress if it exists (#1814) (dad2043)

Compatibility

Tested against the following node releases:

• Polkadot v1.20.0 (Polkadot stable2509)
• Kusama v1.20.0 (Polkadot stable2509)
• Westend v1.20.0 (Polkadot stable2509)

Tested against the following runtime releases:

• Polkadot v1007001
• Kusama v1009002
• Westend v1020004
• Polkadot Asset Hub v1007001
• Kusama Asset Hub v1009002

v20.10.1

20.10.1 (2025-10-24)

Fix

• fix: use all params for cache key (#1805) (2c0a2f9)

Chore

• chore(deps): bump actions/setup-node from 5 to 6 (#1797) (d8bf37b)
• chore(deps): bump Swatinem/rust-cache from 2.7.8 to 2.8.1 (#1778) (437168c)
• chore(deps): bump axios from 1.8.3 to 1.12.2 in /docs (#1786) (f13b848)
• chore(deps): bump benchmark-action/github-action-benchmark (#1752) (568e16f)
• chore(deps): bump axios from 1.10.0 to 1.11.0 (#1711) (5cd918e)
• chore(deps-dev): bump webpack-dev-server in /docs-v2 (#1749) (b69be56)
• chore(deps-dev): bump @types/express from 5.0.2 to 5.0.3 (#1667) (cd9690e)
• chore(deps-dev): bump @types/http-errors from 2.0.4 to 2.0.5 (#1666) (e4078e9)

Compatibility

Tested against the following node releases:

• Polkadot v1.20.0 (Polkadot stable2509)
• Kusama v1.20.0 (Polkadot stable2509)
• Westend v1.20.0 (Polkadot stable2509)

Tested against the following runtime releases:

• Polkadot v1007001
• Kusama v1009002
• Westend v1020004
• Polkadot Asset Hub v1007001
• Kusama Asset Hub v1009002