Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yasaricli/chainradar-api
Blockchain Explorer API for Chainradar
https://github.com/yasaricli/chainradar-api
aeon api bbr bcn blockchain btc chainradar coins cryptonote dsh duck fcn mcn mro rd
Last synced: about 1 month ago
JSON representation
Blockchain Explorer API for Chainradar
- Host: GitHub
- URL: https://github.com/yasaricli/chainradar-api
- Owner: yasaricli
- Created: 2018-01-22T09:29:56.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-09-01T01:54:57.000Z (over 6 years ago)
- Last Synced: 2024-10-11T09:09:48.958Z (2 months ago)
- Topics: aeon, api, bbr, bcn, blockchain, btc, chainradar, coins, cryptonote, dsh, duck, fcn, mcn, mro, rd
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/chainradar
- Size: 14.6 KB
- Stars: 5
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-bitcoin - Chainradar API - Blockchain Explorer API for Chainradar. (Blockchain API and Web services)
- awesome-taproot - Chainradar API - Blockchain Explorer API for Chainradar. (Blockchain API and Web services)
README
# chainradar-api
## Installation
```
npm install chainradar
```
## Usage
Importing:
```js
var ChainRadar = require('chainradar');
```
An instance of a api needs to be initialized before it can be used:
```js
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.
```js
api.getStatus((data) => {
console.log(data.hash)
});
```
#### Blocks headers
Get blocks header data in height range.
```js
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.
```js
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.
```js
api.getBlockHeader('077f4e2c32688157b695d44792ad9dfd986bbabb3fa7e4472805f9858d020f04', (data) => {
console.log(data)
});
```
Parameters:
* height|hash: string Block height or hash.
#### Block data
Get block data by height or hash.
```js
api.getBlockData('077f4e2c32688157b695d44792ad9dfd986bbabb3fa7e4472805f9858d020f04', (data) => {
console.log(data)
})
```
Parameters:
* height|hash: string Block height or hash.
#### Transaction header
Get transaction header data.
```js
api.getTransactionHeader('b90da74c3ffc1210e1432766d06260330008b79cda9cdcb363702490ae054162', (data) => {
console.log(data)
})
```
Parameters:
* hash: string Transaction hash.
#### Transaction data
Get transaction full data.
```js
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](https://chainradar.com/) and [inform us](https://chainradar.com/contact), 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](https://chainradar.com/contact) and we can discuss special limits.
Donations
=========
Donations for the work done in this fork are accepted at
* BCN: `27HTiGScRW1eUbawbmdNCcBThtVFYBDAL4j9XV4drPVcBh2EDBnBRwKfNCezqRpKfLJf5dmANoy6uA2bGtZ3uT5fJGqgzX8`