What is OpenSea CLI?

@opensea/cli is a command-line tool and TypeScript SDK for querying the OpenSea API. It supports collections, NFTs, listings, offers, events, search, tokens, swaps, and accounts — with JSON, table, and TOON output formats.

Quick Start

Install globally:

npm install -g @opensea/cli

Or use without installing:

npx @opensea/cli collections get mfers

Authentication

Set your API key via environment variable or flag:

export OPENSEA_API_KEY=your-api-key
opensea collections get mfers

# or pass inline
opensea --api-key your-api-key collections get mfers

Get an API key at Settings → Developer.

Commands

Command	Description
`collections`	Get, list, stats, and traits for NFT collections
`nfts`	Get, list, refresh metadata, and contract details for NFTs
`listings`	Get all, best, or best-for-nft listings
`offers`	Get all, collection, best-for-nft, and trait offers
`events`	List marketplace events (sales, transfers, mints, etc.)
`search`	Search collections, NFTs, tokens, and accounts
`tokens`	Get trending tokens, top tokens, and token details
`swaps`	Get swap quotes for token trading
`accounts`	Get account details
`health`	Check API connectivity and authentication status

Global options: --api-key, --chain (default: ethereum), --format (json/table/toon), --base-url, --timeout, --verbose, --fields, --max-lines

See the full Commands Reference for all options and flags.

Documentation

Page	Description
Commands Reference	Full command reference with all options and flags
Examples	Real-world usage examples for every command
Programmatic SDK	TypeScript/JavaScript SDK with all methods
Output Formats	JSON, table, and TOON format details
Pagination	Cursor-based pagination patterns for CLI and SDK
Event Types	Event type values and filtering

Requirements

Node.js >= 18.0.0
OpenSea API key (get one here)

Links