xplorer

Etherscan API CLI wrapper. Query blockchain data from the terminal using the Etherscan V2 API, with multichain support via a single API key.

The goal is to cover all modules and routes exposed by the Etherscan API. This is a work in progress. Currently supported:

• contract module
  • getabi - Get the ABI of a verified contract
  • getsourcecode - Get the source code of a verified contract
  • getcontractcreation - Get contract creation info (creator address + deployment tx hash)

Installation

cargo install xplorer

Configuration

Set your Etherscan API key:

# Interactive mode (recommended - input is hidden)
xplorer config set api-key

# Or pass directly (visible in shell history)
xplorer config set api-key YOUR_ETHERSCAN_KEY

Config is stored at ~/.xplorer/config.toml.

Usage

Chain ID

Every query requires a chain ID, provided via the --chain-id flag:

xplorer --chain-id 1 contract getabi 0x...

xplorer is also compatible with Stargate, a blockchain network switcher CLI for Foundry. When you switch networks with Stargate, it exports a STARGATE_CHAIN_ID environment variable that xplorer picks up automatically, so you don't need to pass --chain-id on every call:

sg switch mainnet
xplorer contract getabi 0x...   # uses chain ID 1 from Stargate

If both are provided, the --chain-id flag takes precedence.

Contract Module

# Get the ABI of a verified contract (pretty-printed JSON)
xplorer --chain-id 1 contract getabi 0xdAC17F958D2ee523a2206206994597C13D831ec7

# Get full source code with metadata (compiler, optimization, license, proxy info)
xplorer --chain-id 1 contract getsourcecode 0xdAC17F958D2ee523a2206206994597C13D831ec7

# Get contract creation info (creator address + deployment tx hash)
xplorer --chain-id 1 contract getcontractcreation 0xdAC17F958D2ee523a2206206994597C13D831ec7

# Query multiple contracts at once (up to 5)
xplorer --chain-id 1 contract getcontractcreation 0xdAC1...1ec7 0xA0b8...eB48

Supported Chains

xplorer uses the Etherscan V2 API, which supports 60+ chains through a single endpoint. Pass any valid chain ID:

See the full list at docs.etherscan.io.

Developers

Building from Source

git clone https://github.com/imqdee/xplorer.git
cd xplorer
cargo build --release

The binary will be at target/release/xplorer.

Local Installation

Option 1: Install globally (replaces any existing installation)

cargo install --path .

Option 2: Test without installing

cargo build --release
./target/release/xplorer --help
./target/release/xplorer --chain-id 1 contract getabi 0xdAC17F958D2ee523a2206206994597C13D831ec7

Running Tests

cargo test

Git Hooks

This project uses lefthook for git hooks.

# Install lefthook (macOS)
brew install lefthook

# Install hooks
lefthook install

Hooks run automatically on commit (fmt, clippy) and push (test, build).