Need help with api?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

polkadot-js
370 Stars 215 Forks Apache License 2.0 5.8K Commits 29 Opened issues

Description

Promise and RxJS APIs around Polkadot and Substrate based chains via RPC calls. It is dynamically generated based on what the Substrate runtime provides in terms of metadata. Full documentation & examples available

Services available

!
?

Need anything else?

Contributors list

polkadotjs license npm beta maintainability coverage

@polkadot/api

This library provides a clean wrapper around all the methods exposed by a Polkadot/Substrate network client and defines all the types exposed by a node. For complete documentation around the classes, interfaces and their use, visit the documentation portal.

If you are an existing user, please be sure to track the CHANGELOG and UPGRADING guides when changing versions.

tutorials

Looking for tutorials to get started? Look at examples for guides on how to use the API to make queries and submit transactions.

overview

The API is split up into a number of internal packages -

  • @polkadot/api The API library, providing both Promise and RxJS Observable-based interfaces. This is the main user-facing entry point.
  • @polkadot/api-derive Derived results that are injected into the API, allowing for combinations of various query results (only used internally and exposed on the Api instances via
    api.derive.*
    )
  • @polkadot/metadata Base extrinsic, storage and constant injectors for injection
  • @polkadot/rpc-core Wrapper around all JSON-RPC methods exposed by a Polkadot network client
  • @polkadot/rpc-provider Providers for connecting to nodes, including WebSockets and Http

Type definitions for interfaces as exposed by Polkadot & Substrate clients -

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.