Files
api/README.md
T
2017-11-18 08:38:18 +01:00

41 lines
1.2 KiB
Markdown

# Polkadot JavaScript API
[![Build Status](https://travis-ci.org/polkadot-js/api.svg?branch=master)](https://travis-ci.org/polkadot-js/api)
[![Coverage Status](https://coveralls.io/repos/github/polkadot-js/api/badge.svg?branch=master)](https://coveralls.io/github/polkadot-js/api?branch=master)
[![Dependency Status](https://david-dm.org/polkadot-js/api.svg)](https://david-dm.org/polkadot-js/api)
[![devDependency Status](https://david-dm.org/polkadot-js/api/dev-status.svg)](https://david-dm.org/polkadot-js/api#info=devDependencies)
## Introduction
Warning - currently this does not actually do all that much, it is an attempt to put into code some thoughts about how to maintain the endpoints.
## Usage
Installation -
```
npm install --save @polkadot/api
```
Initialisation -
```
import Api from '@polkadot/api';
const provider = new Api.HttpProvider('http://127.0.0.1:9933');
const api = new Api(provider);
```
Making calls -
```
api.chain
.getHeader('0x1234567890')
.then((header) => console.log(header))
.catch((error) => console.error(error));
```
## Available methods
For a list of currently exposed methods, see the [@polkadot/jsonrpc](https://github.com/polkadot-js/jsonrpc) repository.