api/docs at 92022bda948170cd48fa7663cb1875f0341abc8e - api

Files

T

Jaco Greeff 00bc441f0e Add connected() to API interface (#2580 )

* Add connected() to API interface

* Slight doc update

* Align ApiRx

* isConnected() usage

* Updates

* Retrieve isConnected for API via observable

* Remove (now) useless Rx test

2020-09-04 17:57:02 +02:00

.vuepress

#2182 - add: search for docs (#2232 )

2020-05-05 07:16:39 +02:00

cookbook

Update tx.md (#2485 )

2020-08-13 09:47:22 +02:00

examples

small typos (#2529 )

2020-08-28 12:03:13 +02:00

start

Add connected() to API interface (#2580 )

2020-09-04 17:57:02 +02:00

substrate

Format documentation strings properly & refactor MetadataMd (#1858 )

2020-02-15 08:35:15 +01:00

.nojekyll

Add .nojekyll (_ in filenames) (#160 )

2018-09-19 16:59:09 +02:00

logo.png

docs: Relates to #268 . Add Polkadot white logo. Match styles to apps (#277 )

2018-10-13 16:38:29 +02:00

README.md

Small doc cleanups (#2172 )

2020-04-15 08:44:15 +02:00

SUMMARY.md

Add polkadot-types-from-{chain,defs} (#1766 )

2020-01-29 15:51:23 +01:00

README.md

home, heroText, tagline, features, footer

home

heroText

tagline

features

footer

true

title	details
API	A powerful dynamic API that allows chain interactions with transparent encoding and decoding.

title	details
Substrate defaults	An overview of the various default methods, state entries and RPCs for Substrate-based chains.

title	details
Types	Various type interfaces to make using returned values from API calls transparent in your code.

Welcome

The API provides application developers the ability to query a node and interact with the Polkadot or Substrate chains using Javascript. Here you will find documentation and examples to get you started.

::: tip 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

You can read more about the Polkadot Network at https://polkadot.network/ and more about the polkadot-js projects at https://polkadot.js.org

Github repositories

You can find the Polkadot repositories at:

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.