npm.io
1.0.25 • Published 5 years ago

caeb-bscscan

Licence
MIT
Version
1.0.25
Deps
4
Size
16 kB
Vulns
0
Weekly
0

CAEB BSCSCAN

NPM Version

BscScan is a Block Explorer and Analytics Platform for Binance Smart Chain and provides APIs that returns informations about accounts, token, contracts and a lot of other analytics.

Why another package ?

There's already a node package bsc-scan using axios to request BscScan API infos, but the problem is that the API is behind a cloudfare DDoS protection and a captcha is asked sometimes

Why cz_binance ? It's an API and apiKey IP rate limit should normally do the job no ?

No matter, so instead of using axios, this package use Puppeteer Extra with Stealth and Recaptcha plugins to bypass that ridiculous API limitations...

And it works really well

Install

yarn add caeb-bscscan
# - or -
npm i caeb-bscscan

Usage

// Import the lib
import BscClient from 'caeb-bscscan';

// Create a new client
const client = new BscClient();

Methods

getAccountBalance(address)
// Get account balance
const balance = await client.getAccountBalance('0x1Ed970C1D3F9B85bA6607d45C752E22D9b0b09f4');

Options

BscClient options.

Create a BscScan apiKey here

// BscClient example with full options (and TOR as proxy)
const client = new BscClient({
    apiUrl: 'https://api.bscscan.com/api',
    apiKey: 'XXX',
    headless: true,
    proxy: 'http://127.0.0.1:9150'
});

Run Unit Tests

npm run test:watch

More docs

You can download package and open docs/index.html for extended informations and documentations.

Want to donate ?

If you like that project and my work, you can send me your favorite shitcoin to my BEP20 wallet address : 0x1Ed970C1D3F9B85bA6607d45C752E22D9b0b09f4

License

Copyright 2021, Caeb WALLACE. Released under the MIT License.

Keywords