# whatsonchain

> A WhatsOnChain API JS Wrapper library

Latest version **0.3.0** (published 2023-09-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install whatsonchain
pnpm add whatsonchain
yarn add whatsonchain
bun add whatsonchain
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2023-09-07 |
| First published | 2020-09-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 20.4 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Li Long |
| Maintainers | baryon |
| Keywords | Bitcoin, BSV, Blockchain, Bitcoin SV |

## Links

- npm: https://www.npmjs.com/package/whatsonchain
- Repository: https://github.com/baryon/whatsonchain
- Homepage: http://github.com/baryon/whatsonchain
- Issues: https://github.com/baryon/whatsonchain/issues
- npm.io page: https://npm.io/package/whatsonchain

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^0.21.4
- [axios-extensions](https://npm.io/package/axios-extensions.md) ^3.1.3

## Recent versions

- 0.3.0 (latest) — 2023-09-07
- 0.2.0 — 2020-11-06
- 0.1.3 — 2020-09-17
- 0.1.2 — 2020-09-17
- 0.1.1 — 2020-09-17
- 0.1.0 — 2020-09-17

## README

# A WhatsOnChain API JS Wrapper library for Bitcoin SV Developer

[![NPM version](http://img.shields.io/npm/v/whatsonchain.svg)](https://www.npmjs.org/package/whatsonchain)
[![Build Status](https://secure.travis-ci.org/baryon/whatsonchain.png)](http://travis-ci.org/baryon/whatsonchain)

https://whatsonchain.com/

## Documentation

https://docs.taal.com/core-products/whatsonchain

## Install

---

```javascript
npm install whatsonchain --save
```

## Sample Usage

Check out these [test code](https://github.com/baryon/whatsonchain/tree/master/test) in JavaScript and TypeScript to get up and running quickly.

## History

### 0.3.0
- Move to Taal new document
- Added some new apis

### 0.2.0
- Support Cache, default is true. if you don't want cache, set option `{ enableCache: false }`
- Support ApiKey and rate limit to 3 requests/sec without apiKey.
```
  // with apiKey, no threshold
  const woc = new WhatsOnChain( 'testnet', { apiKey: 'your api key'}  )
```
```
  // without apiKey, threshold is 3 requests/1000ms
  const woc = new WhatsOnChain( 'testnet' )
```
- Support JSDoc type check.

### 0.1.0
- Initate, Support all API in document.

# License

It is released under the terms of the MIT license.

---
_Source: https://npm.io/package/whatsonchain · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._