Explore EVM chains from your terminal.
One API key for balances, transactions, tokens, contracts, logs, gas, stats, and more.
Install · Get started · Examples · Command reference · API documentation
The official command-line client and interactive explorer for the Etherscan V2 API. Use it interactively, pipe clean JSON into scripts, export transactions to CSV, or give an AI agent a predictable interface to on-chain data.
- Explore interactively — browse endpoints, fill parameters, switch chains, and inspect results without memorizing commands.
- Use one multichain interface — query Ethereum and supported EVM chains by name or chain ID.
- Work with humans or machines — emit clean JSON by default for scripts and agents, or switch to tables and CSV when a human or a spreadsheet is reading.
- Reach broad API coverage — access accounts, contracts, tokens, logs, blocks, gas, stats, name tags, and proxy methods, with automatic pagination for list endpoints.
Prebuilt releases support macOS, Linux, and Windows on amd64 and arm64. After installing with any persistent method, run etherscan version to verify that the binary is on your PATH.
brew install etherscan/etherscan-cli/etherscan
etherscan versionInstall the CLI globally:
npm install -g @etherscan-npm/cli
etherscan versionOr run it once without keeping a global installation:
npx @etherscan-npm/cli versionThe npm package selects a platform-specific optional dependency containing the native binary. It does not run installation lifecycle scripts. Installing with --omit=optional is not supported.
The package is currently published as
@etherscan-npm/cliwhile the@etherscannpm scope is being transferred. Theetherscancommand is unchanged.
curl -fsSL https://github.com/ghraw/etherscan/etherscan-cli/master/scripts/install.sh | shThe script selects the correct amd64 or arm64 archive, verifies its SHA-256 checksum, installs to ~/.local/bin by default, and adds that directory to your shell profile when needed. Open a new terminal if etherscan is not immediately available. Run the installer with --help to see version, install-directory, and PATH options.
Run in PowerShell:
irm https://github.com/ghraw/etherscan/etherscan-cli/master/scripts/install.ps1 | iexOr from Command Prompt:
powershell -NoProfile -ExecutionPolicy Bypass -Command "irm https://github.com/ghraw/etherscan/etherscan-cli/master/scripts/install.ps1 | iex"The installer selects the correct x64 or arm64 archive, verifies its SHA-256 checksum, installs to %LOCALAPPDATA%\Programs\Etherscan\bin by default, and adds that directory to your user PATH. Open a new terminal if etherscan is not immediately available.
Go 1.25 or newer is required.
go install github.com/etherscan/etherscan-cli/cmd/etherscan@latestEnsure your Go binary directory (GOBIN, or GOPATH/bin by default) is on PATH.
Download the archive for your operating system and architecture plus checksums.txt from GitHub Releases. Verify the archive's SHA-256 checksum, extract it, and place etherscan (or etherscan.exe) on your PATH.
Run:
etherscan uninstallThe command shows the exact package-manager action or executable and configuration paths before asking for confirmation. Use --yes to skip the prompt. Homebrew and npm installations are removed through their owning package manager. Installer, Go, manual, and source builds remove only the exact running executable; custom directories and PATH entries are left alone unless the installer recorded that it added them and the directory contains no other files.
The command never requests administrator privileges. If a manually copied binary is in a protected location, it leaves the saved configuration intact and prints the exact command needed to remove the binary. Manually created aliases or separate symlinks may also need to be removed by hand.
The installer scripts can remove a script installation without downloading a release archive:
curl -fsSL https://github.com/ghraw/etherscan/etherscan-cli/master/scripts/install.sh | sh -s -- --uninstall& ([scriptblock]::Create((irm https://github.com/ghraw/etherscan/etherscan-cli/master/scripts/install.ps1))) -UninstallUninstall removes the saved configuration directory. If ETHERSCAN_API_KEY is set, unset it separately in the shell or environment where it is defined.
Create an API key in your Etherscan API dashboard. One Etherscan V2 key works across supported chains, subject to your API plan.
Validate and save the key locally, then confirm the active identity:
etherscan login
etherscan whoamiFor CI or a temporary shell session, set ETHERSCAN_API_KEY instead of saving the key.
macOS or Linux:
export ETHERSCAN_API_KEY="YOUR_API_KEY"PowerShell:
$env:ETHERSCAN_API_KEY = "YOUR_API_KEY"Command Prompt:
set "ETHERSCAN_API_KEY=YOUR_API_KEY"etherscan account balance 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045Run etherscan tui to open the full-screen endpoint explorer:
etherscan tuiThe explorer can be opened before authentication and asks you to validate and save a key when you submit an API-backed endpoint. It is read-only; source and proxy verification submissions remain available through the traditional commands. Running etherscan with no command prints the Quick Start guide.
# Recent normal transactions
etherscan account txlist 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045 --page 1 --offset 10
# ERC-20 transfers as a readable table instead of the default JSON
etherscan account tokentx 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045 -o table
# Collect multiple pages for analysis
etherscan account txlist 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045 --all --max-pages 50 -o csv# WETH contract ABI and verified source metadata
etherscan contract getabi 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2
etherscan contract getsourcecode 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2Verification lives in its own command group, etherscan contractverification, so that etherscan contract stays purely for reading on-chain contract data. Both groups call the same contract API module.
Use --file for Solidity, Abstract zkSync-stack, or Vyper source payloads. Stylus verification takes a public Git repository URL instead.
# Solidity standard JSON
etherscan contractverification verify 0xYourContract --file input.json --codeformat solidity-standard-json-input --contractname contracts/Verified.sol:Verified --compilerversion v0.8.24+commit.e11b9ed9
# Abstract uses the zkSync compiler stack (Abstract Mainnet and Sepolia only)
etherscan --chain abstract contractverification verify-zksync 0xYourContract --file input.json --codeformat solidity-standard-json-input --contractname contracts/Verified.sol:Verified --compilerversion v0.8.24+commit.e11b9ed9 --zksolc-version v1.5.7
# Vyper JSON verification, and Stylus repository verification (Arbitrum One and Sepolia only)
etherscan contractverification verify-vyper 0xYourContract --file input.json --contractname contracts/Verified.vy:Verified --compilerversion vyper:0.4.0 --optimization-used 0
etherscan --chain arbitrum contractverification verify-stylus 0xYourContract --source-code https://github.com/example/project --contractname project --compilerversion stylus:0.5.3 --license-type 3Each submission returns a GUID. Poll it with check-status for source verification, or check-proxy for a proxy submission:
etherscan contractverification check-status <guid>
etherscan contractverification check-proxy <guid>Constructor arguments may be supplied as bare ABI-encoded hex or with a 0x prefix; the CLI sends the documented bare form. Verification source files are limited to 3,000,000 bytes. Run any verification command with --help for its exact options.
# Chain names and numeric IDs both work
etherscan --chain base gastracker oracle
etherscan --chain 8453 account balance 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045
# See every chain built into this release
etherscan chains# Clean JSON for jq, Python, or an AI agent
etherscan account txlist 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045 --compact | jq '.[0]'
# CSV for spreadsheets and data pipelines
etherscan account tokentx 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045 -o csv > token-transfers.csvJSON is the default, matching the Etherscan API's own application/json responses. Use -o table for a readable terminal view of row-shaped results. API results are written to stdout; progress messages, warnings, diagnostics, and errors go to stderr so stdout remains suitable for pipelines and redirection.
| Flag | Purpose |
|---|---|
--output <format>, -o <format> |
Select json (default), table, or csv |
--compact |
Remove indentation from JSON output |
--all |
Automatically follow pages for supported list commands |
--max-pages <n> |
Stop --all after at most n pages (default: 20) |
If --all reaches --max-pages, the CLI prints a warning to stderr and the result may be truncated. Increase the limit or narrow the request with supported filters when you need more results.
Every command includes built-in parameter and usage help:
etherscan --help
etherscan account txlist --help
etherscan contractverification verify --helpBrowse all commands
| Command | Description |
|---|---|
etherscan |
Show the Quick Start guide |
etherscan tui |
Launch the interactive explorer |
etherscan login |
Validate and store an API key |
etherscan logout |
Remove the stored API key |
etherscan uninstall |
Remove the CLI and saved configuration |
etherscan update |
Update a Homebrew or installer-script installation |
etherscan whoami |
Show the active chain and masked API key |
etherscan config |
Get, list, or set CLI configuration |
etherscan chains |
List chains built into this CLI release |
etherscan completion |
Generate shell completion |
etherscan version |
Print the CLI version |
etherscan --help |
Show command usage and available options |
| Command | Description | API docs |
|---|---|---|
etherscan account balance |
Get the native balance of an address | balance |
etherscan account balancemulti |
Get native balances for multiple addresses | balancemulti |
etherscan account txlist |
List normal transactions for an address or advanced filter | txlist, advanced-filter-txlist |
etherscan account txlistinternal |
List internal transactions by address, transaction hash, block range, or advanced filter | txlistinternal, txlistinternal-blockrange, txlistinternal-txhash, advanced-filter-txlistinternal |
etherscan account tokentx |
List ERC-20 token transfers | tokentx, advanced-filter-tokentx |
etherscan account tokennfttx |
List ERC-721 token transfers | tokennfttx, advanced-filter-tokennfttx |
etherscan account token1155tx |
List ERC-1155 token transfers | token1155tx, advanced-filter-token1155tx |
etherscan account getminedblocks |
List blocks or uncles mined by an address | getminedblocks |
etherscan account balancehistory |
Get an address's native balance at a block | balancehistory |
etherscan account tokenbalance |
Get an address's ERC-20 token balance | tokenbalance |
etherscan account tokenbalancehistory |
Get an address's token balance at a block | tokenbalancehistory |
etherscan account addresstokenbalance |
List ERC-20 holdings for an address | addresstokenbalance |
etherscan account addresstokennftbalance |
List NFT holdings for an address | addresstokennftbalance |
etherscan account addresstokennftinventory |
List an address's inventory for an NFT contract | addresstokennftinventory |
etherscan account getdeposittxs |
List L2 deposit transactions | getdeposittxs |
etherscan account getwithdrawaltxs |
List L2 withdrawal transactions | getwithdrawaltxs |
etherscan account txsBeaconWithdrawal |
List Ethereum beacon withdrawals | txsbeaconwithdrawal |
etherscan account fundedby |
Find the address that likely funded an account | fundedby |
etherscan account txnbridge |
List bridge transactions for an address | txnbridge |
| Command | Description | API docs |
|---|---|---|
etherscan contract getabi |
Get a verified contract's ABI | getabi |
etherscan contract getsourcecode |
Get verified source code and contract metadata | getsourcecode |
etherscan contract getcontractcreation |
Get creator and creation transaction data for contracts | getcontractcreation |
Grouped separately from the contract data commands above. All of these call the contract API module.
| Command | Description | API docs |
|---|---|---|
etherscan contractverification verify |
Submit Solidity source code for verification | verifysourcecode |
etherscan contractverification verify-zksync |
Submit zkSync-stack source code on Abstract | verifyzksyncsourcecode |
etherscan contractverification verify-vyper |
Submit Vyper source code for verification | verifyvyper |
etherscan contractverification verify-stylus |
Submit Stylus source code for verification | verifystylus |
etherscan contractverification verify-proxy |
Submit a proxy contract for verification | verifyproxycontract |
etherscan contractverification check-status |
Check a source verification submission | checkverifystatus |
etherscan contractverification check-proxy |
Check a proxy verification submission | checkproxyverification |
| Command | Description | API docs |
|---|---|---|
etherscan transaction status |
Get a transaction's execution status and error description | getstatus |
etherscan transaction receipt-status |
Get a transaction receipt's success or failure status | gettxreceiptstatus |
| Command | Description | API docs |
|---|---|---|
etherscan block reward |
Get block and uncle rewards | getblockreward |
etherscan block countdown |
Estimate the time remaining until a block | getblockcountdown |
etherscan block txcount |
Get the number of transactions in a block | getblocktxnscount |
etherscan block bytime |
Find the closest block before or after a timestamp | getblocknobytime |
| Command | Description | API docs |
|---|---|---|
etherscan logs get |
Query event logs by block range, address, and topics | getlogs, getlogs-address-topics, getlogs-topics |
| Command | Description | API docs |
|---|---|---|
etherscan stats ethsupply |
Get the total ETH supply | ethsupply |
etherscan stats ethsupply2 |
Get the extended ETH supply breakdown | ethsupply2 |
etherscan stats ethprice |
Get the latest ETH price | ethprice |
etherscan stats chainsize |
Get historical Ethereum chain size data | chainsize |
etherscan stats nodecount |
Get the total Ethereum node count | nodecount |
etherscan stats tokensupply |
Get an ERC-20 token's total supply | tokensupply |
etherscan stats tokensupplyhistory |
Get a token's total supply at a block | tokensupplyhistory |
etherscan stats ethdailyprice |
Get historical daily ETH prices | ethdailyprice |
etherscan stats dailytx |
Get historical daily transaction counts | dailytx |
etherscan stats dailynewaddress |
Get historical daily new-address counts | dailynewaddress |
etherscan stats dailyavgblocksize |
Get historical average daily block size | dailyavgblocksize |
etherscan stats dailyavgblocktime |
Get historical average daily block time | dailyavgblocktime |
etherscan stats dailyavggasprice |
Get historical average daily gas price | dailyavggasprice |
etherscan stats dailyavggaslimit |
Get historical average daily gas limit | dailyavggaslimit |
etherscan stats dailygasused |
Get historical total daily gas used | dailygasused |
etherscan stats dailyblockrewards |
Get historical daily block rewards | dailyblockrewards |
etherscan stats dailyblkcount |
Get historical daily block counts | dailyblkcount |
etherscan stats dailytxnfee |
Get historical daily transaction fees | dailytxnfee |
etherscan stats dailynetutilization |
Get historical daily network utilization | dailynetutilization |
etherscan stats dailyuncleblkcount |
Get historical daily uncle block counts | dailyuncleblkcount |
etherscan stats dailyavghashrate |
Get historical average daily network hash rate | dailyavghashrate |
etherscan stats dailyavgnetdifficulty |
Get historical average daily network difficulty | dailyavgnetdifficulty |
etherscan stats dailyensregister |
Get historical daily ENS registration counts | dailyensregister |
etherscan stats nodecounthistory |
Get historical Ethereum node counts | nodecounthistory |
| Command | Description | API docs |
|---|---|---|
etherscan token info |
Get token metadata such as name, symbol, type, and supply | tokeninfo |
etherscan token tokenholderlist |
List token holders and their balances | tokenholderlist |
etherscan token tokenholdercount |
Get a token's holder count | tokenholdercount |
etherscan token topholders |
Get the largest token holders | topholders |
| Command | Description | API docs |
|---|---|---|
etherscan gastracker oracle |
Get safe, proposed, and fast gas prices | gasoracle |
etherscan gastracker estimate |
Estimate confirmation time for a gas price | gasestimate |
| Command | Description | API docs |
|---|---|---|
etherscan nametag getaddresstag |
Get name tags and metadata for addresses (Pro Plus) | getaddresstag |
| Command | Description | API docs |
|---|---|---|
etherscan proxy eth_blockNumber |
Get the latest block number | ethblocknumber |
etherscan proxy eth_getBlockByNumber |
Get a block by number or tag | ethgetblockbynumber |
etherscan proxy eth_getTransactionByHash |
Get a transaction by hash | ethgettransactionbyhash |
etherscan proxy eth_getTransactionByBlockNumberAndIndex |
Get a transaction by block number and index | ethgettransactionbyblocknumberandindex |
etherscan proxy eth_getTransactionCount |
Get an address's transaction count (nonce) | ethgettransactioncount |
etherscan proxy eth_getBlockTransactionCountByNumber |
Get a block's transaction count | ethgetblocktransactioncountbynumber |
etherscan proxy eth_getUncleByBlockNumberAndIndex |
Get an uncle by block number and index | ethgetunclebyblocknumberandindex |
etherscan proxy eth_sendRawTransaction |
Broadcast a signed raw transaction | ethsendrawtransaction |
etherscan proxy eth_call |
Execute a read-only contract call | ethcall |
etherscan proxy eth_estimateGas |
Estimate the gas required for a transaction | ethestimategas |
etherscan proxy eth_getTransactionReceipt |
Get a transaction receipt by hash | ethgettransactionreceipt |
etherscan proxy eth_getCode |
Get the code stored at an address | ethgetcode |
etherscan proxy eth_getStorageAt |
Get a value from a contract storage position | ethgetstorageat |
etherscan proxy eth_gasPrice |
Get the current gas price | ethgasprice |
| Command | Description | API docs |
|---|---|---|
etherscan apilimit |
Show used, available, and total API credits | getapilimit |
Authentication is resolved in this order: --api-key for the current command, ETHERSCAN_API_KEY, then the key saved by etherscan login.
etherscan login and the TUI key-setup prompt store the key as plaintext in $XDG_CONFIG_HOME/etherscan/config.toml when XDG_CONFIG_HOME is set, or ~/.etherscan/config.toml otherwise. The directory and file are created with restrictive permissions where the operating system supports them. Treat this file as a secret, never commit API keys, and prefer the environment variable or --api-key for CI and temporary sessions.
etherscan logout removes only the saved key. If ETHERSCAN_API_KEY is set, it remains active until you unset it in that shell or environment.
Manage non-secret defaults with:
etherscan config list
etherscan config set default_chain=base
etherscan config set default_output=tableFor the active chain, --chain takes precedence over ETHERSCAN_CHAIN, which takes precedence over default_chain in the configuration file.
Update through the same channel used to install the CLI:
| Installation channel | Update command |
|---|---|
| Homebrew | brew upgrade etherscan/etherscan-cli/etherscan |
| npm | npm install -g @etherscan-npm/cli@latest |
| macOS/Linux or Windows installer script | etherscan update |
| Go | go install github.com/etherscan/etherscan-cli/cmd/etherscan@latest |
| Manual release archive | Download and verify the new archive from GitHub Releases |
Use the channel-specific command above rather than mixing update mechanisms. For an npm-managed installation, etherscan update prints the npm command without modifying files under node_modules.
Generate completion for bash, zsh, fish, or PowerShell, then load or save the output according to your shell's completion setup:
etherscan completion bash
etherscan completion zsh
etherscan completion fish
etherscan completion powershellGo 1.25 or newer is required to build the CLI.
# Run the Go test suite
go test ./...
# Build the CLI
go build -o etherscan ./cmd/etherscanInstaller changes can be checked with sh scripts/test-install.sh on macOS/Linux or ./scripts/test-install.ps1 in PowerShell on Windows.
The npm distribution can be checked with sh scripts/test-npm.sh on macOS/Linux or ./scripts/test-npm.ps1 in PowerShell. These tests pack and install the umbrella and current-platform packages with lifecycle scripts disabled; they do not publish to npm.
The first seven-package npm release requires a one-time bootstrap by an npm administrator with publish access to the @etherscan-npm scope. After the matching GitHub release succeeds, check out its exact tag and run:
gh release download v1.0.4 --dir dist
npm login
npm whoami
VERSION=1.0.4 node npm/publish.jsThe publisher verifies all six archives against checksums.txt, creates the six public platform packages by publishing them first, and publishes @etherscan-npm/cli last. It safely skips exact versions that already exist so a partial publication can be retried. Replace 1.0.4 with the actual unused release version if necessary.
After the bootstrap, configure npm trusted publishing for the umbrella and all six platform packages, targeting etherscan/etherscan-cli and .github/workflows/release.yml. Set the NPM_PUBLISH_ENABLED repository variable to true; subsequent tagged releases publish through GitHub Actions with provenance.
Endpoint, chain, and plan availability can differ. The Etherscan documentation is authoritative for supported chains, rate limits, PRO endpoints, parameters, responses, and API errors.
Report CLI bugs and feature requests in GitHub Issues. For API-key, account, billing, or endpoint-support questions, use the Etherscan support form.