Understand the project
Practical overview
When it fits
Use it when an application needs typed, programmatic access to Polkadot or Substrate chain clients through RPC, especially when the application must account for runtime-specific metadata.
Who it is for
- TypeScript developers building applications that interact with Polkadot or Substrate chains
- Teams creating chain-data queries or transaction workflows through RPC
- Developers building reactive monitoring tools with RxJS
- Builders creating clients that adapt to multiple Substrate runtimes
Documented uses
- Query data from Polkadot and Substrate-based chains
- Access the methods and types exposed by a connected runtime
- Submit transactions through supported chain RPC interfaces
- Monitor runtime or chain data with the RxJS API
- Adapt a multi-chain client to different Substrate runtimes
Before you choose
Requirements & limits
The repository is public and lists an Apache-2.0 license. The SDK is described for server, cloud and self-hosted environments.
- The connected runtime determines the methods and types available to the application.
- Promise and RxJS interfaces support different application integration styles.
- Transaction submission depends on the supported RPC interface of the connected chain.
- The project repository links to separate API documentation and examples for queries and transaction submission.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Evidence and transparency
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 2 October 2026
- Original website title
- polkadot-js/api · Official homepage title · retained in its source language