etherscan-api
v10.3.0
Published
API to etherscan with a simple interface
Downloads
49,173
Maintainers
Readme
Etherscan API
Development of a NEXTGEN Version has started - please stand by
A way to access the etherscan.io api using promises. Fetch a diverse set of information about the blockchain.
Mainnet
var api = require('etherscan-api').init('YourApiKey');
var balance = api.account.balance('0xde0b295669a9fd93d5f28d9ec85e40f4cb697bae');
balance.then(function(balanceData){
console.log(balanceData);
});
Example in the wild
use a own instance of axios
const axios = require('axios');
const {
init,
pickChainUrl
} = require('..');
const chain = pickChainUrl(null);
const client = axios.create({
baseURL: chain,
timeout: 10000
});
var api = init('apikey', null, 10000, client);
For testnet and L2s usage
Supported Chain Explorers
- Etherscan
- ropsten: 'https://api-ropsten.etherscan.io'
- kovan: 'https://api-kovan.etherscan.io'
- rinkeby: 'https://api-rinkeby.etherscan.io'
- goerli: 'https://api-goerli.etherscan.io'
- sepolia: 'https://api-sepolia.etherscan.io'
- homestead: 'https://api.etherscan.io'
- Arbiscan (Experimental)
- arbitrum: 'https://api.arbiscan.io'
- arbitrum_rinkeby: 'https://api-testnet.arbiscan.io'
- Snowtrace (Experimental)
- avalanche:'https://api.snowtrace.io',
- avalanche_fuji: 'https://api-testnet.snowtrace.io'
Latest
// apikey, network, timeout
var api = require('etherscan-api').init('YourApiKey','rinkeby'. '3000');
Install
npm install etherscan-api --save
API Documentation
Development workflow
- npm test - runs tests
- npm run posttest - starts the linter
- npm run lint - preconfigured linter
- npm run docs - generates the apidocs
- npm run bundle - builds a new bundle
- npm run preversion - Steps before we create a new Tag
- lint
- changelog
- npm run pages - pushes generated apidocs to the server
- postversion - after generating a new version, push the tag to the server
- npm run changelog - generates a changelog and pushes it