blockexplorer v1.0.1

blockexplorer

Unofficial Node.js client for blockexplorer.com API

Install

npm i blockexplorer --save

Example

// require the module
const be = require('blockexplorer')

// get the genesis block hash
be.blockIndex(0)
  .then((result) => {
    console.log(result)
  })
  .catch((err) => {
    throw err
  })

Test

npm test

API

blockexplorer.block(hash)

Get block info by hash

• Returns Promise

blockexplorer.rawBlock(hash)

Get raw block info by hash

• Returns Promise

blockexplorer.blockIndex(height)

Get block hash by height

• Returns Promise

blockexplorer.tx(txid)

Get transaction by txid

• Returns Promise

blockexplorer.rawTx(txid)

Get raw transaction by txid

• Returns Promise

blockexplorer.addrValidate(address)

Validate address

• Returns Promise

blockexplorer.addr(address, options)

Get address info

// Default options
{
  noTxList: false,
  noCache: false
}

• Pass an Array as first parameter to get info on multiple addresses
• Returns Promise

blockexplorer.balance(address)

Get address balance

• Returns a Promise

blockexplorer.totalReceived(address)

Get address received funds

• Returns a Promise

blockexplorer.totalSent(address)

Get address sent funds

• Returns a Promise

blockexplorer.unconfirmedBalance(address)

Get address unconfirmed balance

• Returns a Promise

blockexplorer.utxo(address, options)

Get address unspent outputs

// Default options
{
  noCache: false
}

• Pass an Array as first parameter to get info on multiple addresses
• Returns a Promise

blockexplorer.txsBlock(hash)

Get transactions by hash

• Returns a Promise

blockexplorer.txsAddress(address, options)

Get transactions by address

// Default options
{
  from: '',
  to: ''
}

• Pass an Array as first parameter to get info on multiple addresses
• Returns a Promise

blockexplorer.txSend(rawtx)

Broadcast signed trasaction in hex format rawtx

• Returns a Promise

blockexplorer.getInfo()

Get blockchain info

• Returns a Promise

blockexplorer.getBlockCount()

Get block count

• Returns a Promise

blockexplorer.getDifficulty()

Get difficulty

• Returns a Promise

blockexplorer.getBestBlockHash()

Get best block hash

• Returns a Promise

blockexplorer.getLastBlockHash()

Get last block hash

• Returns a Promise

blockexplorer.sync()

Get historic blockchain data sync status

• Returns a Promise

blockexplorer.peer()

Get live network p2p data sync status

• Returns a Promise

blockexplorer.estimateFee(nbBlocks = 2)

Get fee estimate

• Returns a Promise

For additional information see blockexplorer.com API reference

Contributing

Just send a PR

License

Licensed under MIT

The author is not affiliated in any way with blockexplorer.com