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
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,25 @@
# Polkadot REST API

> **Note:** This project is in a beta release. Changes are to be expected until it's stable.
A REST service for interacting with Polkadot SDK-based blockchain nodes, rewritten from the ground up in Rust.

## Public Instances

Parity hosts public instances of the Polkadot REST API for the following chains:

| Chain | URL |
|-------|-----|
| **Polkadot** | https://polkadot-relay-rest-api.parity.io/v1 |
| **Kusama** | https://kusama-relay-rest-api.parity.io/v1 |
| **Westend** | https://westend-relay-rest-api.parity.io/v1 |
| **Polkadot Asset Hub** | https://polkadot-hub-rest-api.parity.io/v1 |
| **Kusama Asset Hub** | https://kusama-hub-rest-api.parity.io/v1 |
| **Westend Asset Hub** | https://westend-hub-rest-api.parity.io/v1 |

Interactive API documentation is available at `/docs` on each instance (e.g., [Polkadot Docs](https://polkadot-relay-rest-api.parity.io/docs)).
Comment thread
TarikGul marked this conversation as resolved.

**Usage Limits & Production Warning**

These public instances are subject to rate limiting and are not intended for production use. For consistent testing or development, it is highly recommended to implement a retry strategy (e.g., exponential backoff) to handle potential request throttling gracefully.

## Implementation Details

Expand Down
2 changes: 1 addition & 1 deletion docs/dist/bundle.js

Large diffs are not rendered by default.

19 changes: 19 additions & 0 deletions docs/guides/MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,25 @@ This guide documents breaking changes and differences between [substrate-api-sid

This project is a Rust-based alternative to substrate-api-sidecar, designed to provide improved performance, memory safety, and better resource utilization. While we aim to maintain API compatibility where possible, some breaking changes are necessary for architectural improvements.

## Public Instances

Parity hosts public instances of the Polkadot REST API for the following chains:

| Chain | URL |
|-------|-----|
| **Polkadot** | https://polkadot-relay-rest-api.parity.io/v1 |
| **Kusama** | https://kusama-relay-rest-api.parity.io/v1 |
| **Westend** | https://westend-relay-rest-api.parity.io/v1 |
| **Polkadot Asset Hub** | https://polkadot-hub-rest-api.parity.io/v1 |
| **Kusama Asset Hub** | https://kusama-hub-rest-api.parity.io/v1 |
| **Westend Asset Hub** | https://westend-hub-rest-api.parity.io/v1 |

Interactive API documentation is available at `/docs` on each instance (e.g., [Polkadot Docs](https://polkadot-relay-rest-api.parity.io/docs)).

Comment thread
TarikGul marked this conversation as resolved.
**Usage Limits & Production Warning**

These public instances are subject to rate limiting and are not intended for production use. For consistent testing or development, it is highly recommended to implement a retry strategy (e.g., exponential backoff) to handle potential request throttling gracefully.

---

## ⚠️ Breaking Changes ⚠️
Expand Down
Loading