SDKs
CLI (quick reference)

CLI

Run scrapes, extractions, and lead pulls from the terminal, no code. The CLI is a thin wrapper over the REST API; every command maps 1:1 to an endpoint.

⚠️

Not published. @superscraper/cli does not exist on npm, and the bare name superscraper on npm is an unrelated third-party package. npm install -g and npx will not get you this CLI. The source lives in this repository at packages/cli; everything below describes that source.

For a one-off scrape from the terminal today, call the REST API with curl:

curl -sX POST https://api.superscraper.dev/v1/scrape \
  -H "x-api-key: $SUPERSCRAPER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}'

Running it from source

Clone the repository, install workspace dependencies, and build packages/cli. The package declares two equivalent binaries, superscraper and leadsnap, both pointing at the same entry point, so a local link exposes either name.

Scrape in 5 lines

export SUPERSCRAPER_API_KEY=ss_live_xxxxxxxxxxxxxxxxxxxx
superscraper scrape https://example.com

That prints the page as clean markdown to stdout. Add --json for the full API response.

Authentication

Auth is resolved in this order:

  1. SUPERSCRAPER_API_KEY environment variable
  2. ~/.leadsnap/config.json (written by superscraper init, the path is still the legacy name in source)
export SUPERSCRAPER_API_KEY=ss_live_xxxxxxxxxxxxxxxxxxxx
# or, interactively:
superscraper init

Set SUPERSCRAPER_API_URL to point at a self-hosted instance (defaults to https://api.superscraper.dev).

Common commands

# Scrape to markdown (default)
superscraper scrape https://acmeplumbing.com
 
# Structured listing JSON
superscraper scrape https://acmeplumbing.com --format json
 
# Force the headless browser with extra wait
superscraper scrape https://react-app.com --force-playwright --wait-for 2000
 
# Free JSON-LD extraction (no schema)
superscraper extract https://acmeplumbing.com
 
# LLM extraction with a schema file
superscraper extract https://acmeplumbing.com --schema ./contact-schema.json
 
# Plain-English lead pull (returns a preview + jobId)
superscraper chat "HVAC companies in Austin TX"

For the full command reference (pull, connectors, chat, global flags, exit codes), see the CLI guide.

Python SDK