etherscan
v0.2.2
Published
Node.js library for communicating with the Etherscan API.
Downloads
1,634
Maintainers
Readme
etherscan
Node.js library for communicating with the Etherscan API.
Installation
$ npm i request
$ npm i etherscan
request
is defined as a peer-dependency and thus has to be installed separately.
Testing
$ npm test
Import
Using CommonJS
Requirements (Node.js >= 8.0.0).
const Etherscan = require('etherscan');
Using ESM
Use --experimental-modules flag and .mjs extension (Node.js >= 8.6.0).
import Etherscan from 'etherscan';
Usage
import Etherscan from 'etherscan';
const etherscan = new Etherscan(API_KEY); // Some methods working without API_KEY
(async () => {
const data = await etherscan.getEtherBalance({
address: '0x00'
});
})();
API
Accounts
getEtherBalance
Get Ether balance for a single address.
etherscan.getEtherBalance({
address: '0x00',
tag: 'latest' // Optional, default 'latest'
});
getEtherBalanceMulti
Get Ether balance for multiple addresses in a single call.
etherscan.getEtherBalanceMulti({
address: ['0x00', '0x01'],
tag: 'latest' // Optional, default 'latest'
});
getTxList
Get a list of normal
transactions by address.
etherscan.getTxList({
address: '0x00',
startblock: 0, // Optional
endblock: 0, // Optional
sort: 'desc' // Optional, default 'asc'
});
getTxListInternal
Get a list of internal
transactions by address.
etherscan.getTxListInternal({
address: '0x00',
startblock: 0, // Optional
endblock: 0, // Optional
sort: 'desc' // Optional, default 'asc'
});