jpgarcia/bsc-scan

Node.js package to interact with official BscScan API

Node.js BscScan API

Node.js package to interact with official BscScan API powered by TypeScript.

Documentation

API reference

Installation

$ yarn add bsc-scan

Usage

import bscscan, { account } from 'bsc-scan'

bscscan.setUrl('https://testnet.bscscan.com')
bscscan.setApiKey('YourApiKeyToken')

const start = async () => {
  try {
    const balance = await account.getBnbBalance('0x765090aB712984081aeE059eA7025C48a4198183')

    console.log(`Your balance is: ${balance}`)
  } catch (err) {
    console.log(err)
  }
}

start()

bsc-scan's Issues

#REMOVE

Latest build is not working

The build seems to be broken:

Apparently there are some lodash dependencies that are missing in the package.json

• Remove the @types/lodash dependency
• Add @types lodash deps for specific packages
• Require lodash utils from specific packages in query.ts

On the other side I found that in some cases the API could failed and return an error code as part of the Axios response but not throwing at all that's why we should catch this type of errors and throw properly:

Here are some examples of API errors:

{
  status: '0',
  message: 'NOTOK',
  result: 'Error! Invalid address format'
}

{
  status: '0',
  message: 'NOTOK',
  result: 'Error! Invalid contract address format'
}

We must also provide a way to write headers or override Axios configuration as well as be able to obtain the raw axios response for debugging / post request processing support. A proposed interface could be like this

type RequestConfig = {
  axiosConfig?: AxiosRequestConfig
  rawAxiosResponse?: boolean
}

account.getBnbBalance(address: string, config: RequestConfig)