Polkadot Javascript API

You can query a node and interact with the Polkadot network using Javascript. This guide describes the Polkadot Javascript API.

Packages

• api
  • ApiPromise
  • ApiRx
• rpc-provider
  • HttpProvider
  • WsProvider

Interfaces

• RPC
• Chain state (runtime)
• Extrinsics (runtime)
• Events (runtime)

Examples

• ApiPromise
  • Simple connect
  • Listen to blocks
  • Listen to balance change
  • Read chain state
  • Make a transfer

The Polkadot Project

You can read more about the Polkadot Network at https://polkadot.network/

Github repositories

You can find the Polkadot repositories at:

• https://github.com/polkadot-js
• https://github.com/paritytech/polkadot
• https://github.com/paritytech/substrate

This documentation is generated from https://github.com/polkadot-js/api

Contributing

Contribution to the Polkadot JS API are more than welcome. You can report issues and log feature requests.