Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ labels: Enhancement
assignees: ""
---

> ⚠️ **`substrate-api-sidecar` is deprecated** in favor of [`polkadot-rest-api`](https://github.com/paritytech/polkadot-rest-api), a Rust rewrite with 1:1 API compatibility. **New features will not be added to this repository.**
>
> Please file your feature request against [`polkadot-rest-api`](https://github.com/paritytech/polkadot-rest-api/issues/new/choose) instead — that's where new development is happening.
>
> Migration guide: https://github.com/paritytech/polkadot-rest-api/blob/main/docs/guides/MIGRATION.md

**Proposed Change or Idea**

[Describe your request for a new idea/feature or improvement of an existing
Expand Down
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/report-bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ labels: ""
assignees: ""
---

> ⚠️ **`substrate-api-sidecar` is deprecated** in favor of [`polkadot-rest-api`](https://github.com/paritytech/polkadot-rest-api), a Rust rewrite with 1:1 API compatibility.
>
> **If possible, please reproduce against [`polkadot-rest-api`](https://github.com/paritytech/polkadot-rest-api) first** — if the bug exists there, file it [there](https://github.com/paritytech/polkadot-rest-api/issues/new/choose) so it's fixed in the actively-developed version.
>
> Migration guide: https://github.com/paritytech/polkadot-rest-api/blob/main/docs/guides/MIGRATION.md

**Description**

[Please add a clear description of the bug you are encountering, such as any
Expand Down
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,21 @@

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

## Unreleased

### ⚠️ Deprecation Notice

**`substrate-api-sidecar` is deprecated in favor of [`polkadot-rest-api`](https://github.com/paritytech/polkadot-rest-api).**

`polkadot-rest-api` is 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`. 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`](https://crates.io/crates/polkadot-rest-api)
- GitHub: https://github.com/paritytech/polkadot-rest-api
- Documentation: https://paritytech.github.io/polkadot-rest-api/
- Migration guide: [MIGRATION.md](https://github.com/paritytech/polkadot-rest-api/blob/main/docs/guides/MIGRATION.md)
- Issues/feedback: https://github.com/paritytech/polkadot-rest-api/issues

## [20.14.0](https://github.com/paritytech/substrate-api-sidecar/compare/v20.13.3..v20.14.0) (2026-02-01)

### Feat
Expand Down
15 changes: 15 additions & 0 deletions Dockerfile.README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
## substrate-api-sidecar Docker Image

## ⚠️ Deprecation Notice

**`substrate-api-sidecar` is deprecated in favor of [`polkadot-rest-api`](https://github.com/paritytech/polkadot-rest-api).**

`polkadot-rest-api` is a ground-up Rust rewrite built on [`subxt`](https://github.com/paritytech/subxt), with 1:1 API compatibility (endpoints are 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: `docker pull paritytech/polkadot-rest-api:v0.1.0`
- Crate: [`polkadot-rest-api@0.1.0`](https://crates.io/crates/polkadot-rest-api)
- Migration guide: [MIGRATION.md](https://github.com/paritytech/polkadot-rest-api/blob/main/docs/guides/MIGRATION.md)
- Documentation: https://paritytech.github.io/polkadot-rest-api/
- Questions/issues: https://github.com/paritytech/polkadot-rest-api/issues

---

With each release, the maintainers publish a docker image to dockerhub at [parity/substrate-api-sidecar](https://hub.docker.com/r/parity/substrate-api-sidecar/tags?page=1&ordering=last_updated)

### Pull the latest release
Expand Down
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,19 @@

<br /><br />

## ⚠️ Deprecation Notice

**`substrate-api-sidecar` is deprecated in favor of [`polkadot-rest-api`](https://github.com/paritytech/polkadot-rest-api).**

`polkadot-rest-api` is a ground-up Rust rewrite built on [`subxt`](https://github.com/paritytech/subxt), with 1:1 API compatibility (endpoints are 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: `docker pull paritytech/polkadot-rest-api:v0.1.0`
- Crate: [`polkadot-rest-api@0.1.0`](https://crates.io/crates/polkadot-rest-api)
- Migration guide: [MIGRATION.md](https://github.com/paritytech/polkadot-rest-api/blob/main/docs/guides/MIGRATION.md)
- Documentation: https://paritytech.github.io/polkadot-rest-api/
- Questions/issues: https://github.com/paritytech/polkadot-rest-api/issues

## NOTICE

For the Asset hub migration please refer to the guide in [guides/ASSET_HUB_MIGRATION.md](guides/ASSET_HUB_MIGRATION.md)
Expand Down
2 changes: 1 addition & 1 deletion docs-v2/dist/bundle.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs-v2/dist/index.html

Large diffs are not rendered by default.

10 changes: 10 additions & 0 deletions docs-v2/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,16 @@
<!-- Styles will be injected by webpack -->
</head>
<body>
<!-- Deprecation banner (site-wide, always visible) -->
<div class="deprecation-banner" role="alert" style="background: #b45309; color: #fff; padding: 12px 24px; font-size: 14px; line-height: 1.5; border-bottom: 2px solid #92400e; text-align: center; font-family: 'Inter', system-ui, sans-serif; position: relative; z-index: 10000;">
<strong>⚠️ Deprecation Notice:</strong>
<code style="background: rgba(0,0,0,0.25); padding: 1px 6px; border-radius: 3px;">substrate-api-sidecar</code>
is deprecated in favor of
<a href="https://github.com/paritytech/polkadot-rest-api" target="_blank" rel="noopener" style="color: #fff; text-decoration: underline; font-weight: 600;">polkadot-rest-api</a>
— a Rust rewrite with 1:1 API compatibility.
<a href="https://github.com/paritytech/polkadot-rest-api/blob/main/docs/guides/MIGRATION.md" target="_blank" rel="noopener" style="color: #fff; text-decoration: underline; font-weight: 600;">Migration guide →</a>
</div>

<!-- Loading screen -->
<div id="loading-screen" class="loading-screen">
<div class="loading-spinner">
Expand Down
17 changes: 15 additions & 2 deletions docs-v2/openapi-v1.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,21 @@
openapi: 3.0.0
info:
title: Substrate API Sidecar
description: Substrate API Sidecar is a REST service that makes it easy to
interact with blockchain nodes built using Substrate's FRAME framework.
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:
Expand Down
Loading
Loading