chainradar v0.0.1

chainradar-api

Installation

npm install chainradar

Usage

Importing:

var ChainRadar = require('chainradar');

An instance of a api needs to be initialized before it can be used:

var api = new ChainRadar(options)

Options:

• apiUrl - API ENDPOINT default: 'http://chainradar.com/api'
• version - CURRENT API VERSION default: 'v1'
• coin - Each API request is relative to a coin, so there is a required parameter default: bcn

Status

Get actual coin statistics data.

api.getStatus((data) => {
  console.log(data.hash)
});

Blocks headers

Get blocks header data in height range.

const blockOptions = {
  from: '100000',
  to: '100001'
};

api.getBlocksHeader(blockOptions, (data) => {
  console.log(data)
});

Parameters:

• from: integer Blocks starting height.
• to: integer Blocks ending height.

Blocks data

Get blocks full data in height range.

const blockOptions = {
  from: '100000',
  to: '100001'
};

api.getBlocksData(blockOptions, (data) => {
  console.log(data)
});

Parameters:

• from: integer Blocks starting height.
• to: integer Blocks ending height.

Block header

Get block header data by height or hash.

api.getBlockHeader('077f4e2c32688157b695d44792ad9dfd986bbabb3fa7e4472805f9858d020f04', (data) => {
  console.log(data)
});

Parameters:

• height|hash: string Block height or hash.

Block data

Get block data by height or hash.

api.getBlockData('077f4e2c32688157b695d44792ad9dfd986bbabb3fa7e4472805f9858d020f04', (data) => {
  console.log(data)
})

Parameters:

• height|hash: string Block height or hash.

Transaction header

Get transaction header data.

api.getTransactionHeader('b90da74c3ffc1210e1432766d06260330008b79cda9cdcb363702490ae054162', (data) => {
  console.log(data)
})

Parameters:

• hash: string Transaction hash.

Transaction data

Get transaction full data.

api.getTransactionData('b90da74c3ffc1210e1432766d06260330008b79cda9cdcb363702490ae054162', (data) => {
  console.log(data)
})

Parameters:

• hash: string Transaction hash.

Pre Publish

npm run prepublish

Limits

There are API requests count limits by IP for direct calls and by domain for AJAX calls.

ANONYMOUS

Direct calls - 100 requests from one IP in a 1 day. AJAX calls - not allowed.

LINKED

If web-site adds a link to the ChainRadar and inform us, we will increase its limits to both IP and domain.

Direct calls - 1500 requests from one IP in a 1 day. AJAX calls - 30000 total requests referred to linked site domain in a 1 day.

PREMIUM

If Linked limits are not enough for your web-service, then you can contact us and we can discuss special limits.