A powerful dynamic API that allows chain interactions with transparent encoding and decoding.
An overview of the various default methods, state entries and RPCs for Substrate-based chains.
Various type interfaces to make using returned values from API calls transparent in your code.
Getting started & Examples
Jump right in and get an overview on using the API in your projects, from installation all the way through to making it do magic. Have things working and want tips? The cookbook provides some tips and tricks. Getting started and want some full examples? The ApiPromise examples provide some basic examples.
# The Polkadot Project
# Github repositories
You can find the Polkadot repositories at:
This documentation is generated from https://github.com/polkadot-js/api