Skip to content
 
 

Repository files navigation

Etherscan CLI

A cross-platform Go CLI and interactive explorer for the Etherscan V2 API. It maps supported Etherscan endpoints into commands for accounts, tokens, contracts, logs, gas, stats, proxy/RPC-style methods, API usage, address metadata, across multiple EVM chains.

Etherscan's API documentation remains as the main reference for endpoint parameters, responses, rate limits, supported chains, and errors.

Installation

Windows

irm https://raw.githubusercontent.com/etherscan/etherscan-cli/master/scripts/install.ps1 | iex

macOS and Linux

curl -fsSL https://raw.githubusercontent.com/etherscan/etherscan-cli/master/scripts/install.sh | sh

The installers select the correct binary, verify its checksum, and add etherscan to your PATH. Open a new terminal after installation.

Manual installation

Download the appropriate archive and checksums.txt from GitHub Releases. Verify the checksum, extract the archive, and place etherscan on your PATH.

If installation fails, open a GitHub issue.

Quickstart

Store and validate an Etherscan API key, then make your first request:

etherscan login
etherscan whoami
etherscan account balance 0x0000000000000000000000000000000000000000

Select a chain by name or chain ID:

etherscan --chain base account txlist 0x0000000000000000000000000000000000000000 --page 1 --offset 5
etherscan --chain 8453 gastracker oracle

Use JSON when handing results to another program or agent:

etherscan account txlist 0x0000000000000000000000000000000000000000 --json

Interactive Explorer

Run etherscan in an interactive terminal, allowing you to explore, pick and fill in the parameters of each endpoint.

etherscan
image

Output and Scripting

Tables are the default. Use JSON or CSV for scripts and pipelines:

etherscan account balance 0x... --json
etherscan account balance 0x... --json --compact
etherscan account txlist 0x... --csv
etherscan account txlist 0x... --all --max-pages 50 --json
Flag Purpose
--output <format> Select table, json, or csv
--json Print the raw API result as JSON
--compact Print compact JSON
--csv Print list-style results as CSV
--all Automatically paginate supported list commands
--max-pages <n> Stop automatic pagination after at most n pages

If --all reaches --max-pages, the result may be truncated.

Command Index

CLI utilities

Command Description
etherscan Launch the explorer in an interactive terminal
etherscan tui Explicitly launch the interactive explorer
etherscan login Validate and store an API key
etherscan logout Remove the stored API key
etherscan uninstall Remove all CLI configuration
etherscan whoami Show the active chain and saved API key
etherscan config Get, list, or set CLI configuration
etherscan chains list List chains built into this CLI release
etherscan completion Generate shell completion
etherscan version Print build information
etherscan --help Helpful tips and command usage

Account

Command API documentation
etherscan account balance balance
etherscan account balancemulti balancemulti
etherscan account txlist txlist, advanced-filter-txlist
etherscan account txlistinternal txlistinternal, txlistinternal-blockrange, txlistinternal-txhash, advanced-filter-txlistinternal
etherscan account tokentx tokentx, advanced-filter-tokentx
etherscan account tokennfttx tokennfttx, advanced-filter-tokennfttx
etherscan account token1155tx token1155tx, advanced-filter-token1155tx
etherscan account getminedblocks getminedblocks
etherscan account balancehistory balancehistory
etherscan account tokenbalance tokenbalance
etherscan account tokenbalancehistory tokenbalancehistory
etherscan account addresstokenbalance addresstokenbalance
etherscan account addresstokennftbalance addresstokennftbalance
etherscan account addresstokennftinventory addresstokennftinventory
etherscan account getdeposittxs getdeposittxs
etherscan account getwithdrawaltxs getwithdrawaltxs
etherscan account txsBeaconWithdrawal txsbeaconwithdrawal
etherscan account fundedby fundedby
etherscan account txnbridge txnbridge

Contract

Command API documentation
etherscan contract getabi getabi
etherscan contract getsourcecode getsourcecode
etherscan contract getcontractcreation getcontractcreation
etherscan contract verify verifysourcecode
etherscan contract verify-status checkverifystatus
etherscan contract verify-proxy verifyproxycontract
etherscan contract check-proxy checkproxyverification

Transaction

Command API documentation
etherscan transaction status getstatus
etherscan transaction receipt-status gettxreceiptstatus

Block

Command API documentation
etherscan block reward getblockreward
etherscan block countdown getblockcountdown
etherscan block txcount getblocktxnscount
etherscan block bytime getblocknobytime

Logs

Command API documentation
etherscan logs get getlogs, getlogs-address-topics, getlogs-topics

Stats

Command API documentation
etherscan stats ethsupply ethsupply
etherscan stats ethsupply2 ethsupply2
etherscan stats ethprice ethprice
etherscan stats chainsize chainsize
etherscan stats nodecount nodecount
etherscan stats tokensupply tokensupply
etherscan stats tokensupplyhistory tokensupplyhistory
etherscan stats ethdailyprice ethdailyprice
etherscan stats dailytx dailytx
etherscan stats dailynewaddress dailynewaddress
etherscan stats dailyavgblocksize dailyavgblocksize
etherscan stats dailyavgblocktime dailyavgblocktime
etherscan stats dailyavggasprice dailyavggasprice
etherscan stats dailyavggaslimit dailyavggaslimit
etherscan stats dailygasused dailygasused
etherscan stats dailyblockrewards dailyblockrewards
etherscan stats dailyblkcount dailyblkcount
etherscan stats dailytxnfee dailytxnfee
etherscan stats dailynetutilization dailynetutilization
etherscan stats dailyuncleblkcount dailyuncleblkcount
etherscan stats dailyavghashrate dailyavghashrate
etherscan stats dailyavgnetdifficulty dailyavgnetdifficulty
etherscan stats dailyensregister dailyensregister
etherscan stats nodecounthistory nodecounthistory

Token

Command API documentation
etherscan token info tokeninfo
etherscan token tokenholderlist tokenholderlist
etherscan token tokenholdercount tokenholdercount
etherscan token topholders topholders

Gas Tracker

Command API documentation
etherscan gastracker oracle gasoracle
etherscan gastracker estimate gasestimate

Nametag

Command API documentation
etherscan nametag getaddresstag getaddresstag

Proxy

Command API documentation
etherscan proxy eth_blockNumber ethblocknumber
etherscan proxy eth_getBlockByNumber ethgetblockbynumber
etherscan proxy eth_getTransactionByHash ethgettransactionbyhash
etherscan proxy eth_getTransactionByBlockNumberAndIndex ethgettransactionbyblocknumberandindex
etherscan proxy eth_getTransactionCount ethgettransactioncount
etherscan proxy eth_getBlockTransactionCountByNumber ethgetblocktransactioncountbynumber
etherscan proxy eth_getUncleByBlockNumberAndIndex ethgetunclebyblocknumberandindex
etherscan proxy eth_sendRawTransaction ethsendrawtransaction
etherscan proxy eth_call ethcall
etherscan proxy eth_estimateGas ethestimategas
etherscan proxy eth_getTransactionReceipt ethgettransactionreceipt
etherscan proxy eth_getCode ethgetcode
etherscan proxy eth_getStorageAt ethgetstorageat
etherscan proxy eth_gasPrice ethgasprice

API Usage

Command API documentation
etherscan apilimit getapilimit

About

CLI for the Etherscan V2 APIs

Resources

Stars

4 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages