The Scrape Everything CLI
Every endpoint as a command. Readable output in a terminal, raw JSON when piped, and no runtime dependencies beyond Node.js 18.
What is the scrapeeverything CLI?
The scrapeeverything CLI is an open-source command-line client that turns each of the 46 Scrape Everything API endpoints for Instagram, TikTok, X (Twitter), YouTube, Facebook, Telegram, Spotify, Pinterest and Twitch into a command. It prints readable output in a terminal and raw JSON when piped. Calls cost 1 to 3 credits, and new accounts get 100 free credits.
- npm package
- scrapeeverything
- Commands
- scrapeeverything or se
- Endpoints
- 46 on 9 platforms
- Output
- pretty, json, jsonl
- Runtime
- Node.js 18 or later
- License
- MIT
Updated · Maintained by the Scrape Everything team
How do I install it and log in?
Run it once with npx, or install it globally. Create an API key on the API keys page of the dashboard first.
npx scrapeeverything instagram profile --username nasanpm install -g scrapeeverything # or run any command with npx scrapeeverything ...
se login # prompts for the key (hidden input) and checks it
se login --key ssk_live_... # non-interactive
echo "$KEY" | se login --stdin # from a secret manager or CI
export SCRAPEEVERYTHING_API_KEY=ssk_live_... # or the env var (takes precedence)
se logout # delete the stored keyse login checks the key against GET /v1/account, which spends no credits, and saves it to config.json in your OS config directory. The key is stored in plain text, so on shared machines prefer the SCRAPEEVERYTHING_API_KEY environment variable.
Which commands does it have?
Every command follows se <platform> <action>. Run se list for the full list with credit costs, and se describe for the options of one command.
se list # every scraper with credit cost and inputs
se describe instagram profile # options, response fields, example
se instagram profile --username nasa --fields username,follower_count,is_verified
se tiktok profile --username khaby.lame
se youtube transcript --url "https://www.youtube.com/watch?v=jNQXAC9IVRw"
se youtube videos --username MrBeast --limit 5 | jq '.videos[].title'
se account # credits and rate limitsThe binary is scrapeeverything with the alias se. Platform aliases: twitter, ig, yt, tt and fb. Actions accept dashes or underscores.
Which output formats does it support?
| Flag | Effect |
|---|---|
| --output pretty | Readable, colored output. The default in a terminal. |
| --output json | Raw JSON from the data field. The default when piped. |
| --output jsonl | One JSON object per line from the main list (for example posts or comments). |
| --fields a,b.c | Keeps only these fields. Dotted paths reach into objects and lists. |
| --quiet | Prints nothing on stderr except errors. |
| --no-color | Turns colors off. NO_COLOR also works. |
What do the exit codes mean?
Errors go to stderr with the API error code and request_id. The CLI never retries on its own, so your script decides what to do.
| Exit code | Meaning |
|---|---|
| 0 | Success |
| 1 | Unexpected error |
| 2 | Usage or validation error (bad flags, VALIDATION_ERROR, UNKNOWN_ENDPOINT) |
| 3 | Authentication error (AUTH_REQUIRED, INVALID_API_KEY) |
| 4 | Out of credits (INSUFFICIENT_CREDITS) |
| 5 | Rate limited (RATE_LIMITED). The Retry-After wait is printed. |
| 6 | Temporarily unavailable (timeout or network error) |
Using an AI assistant? The MCP server exposes the same endpoints as tools.
Frequently asked questions
Is the CLI free?
The CLI is free and open source under the MIT license. Data commands spend credits from your Scrape Everything account (1 to 3 credits per call), while se list, se describe and se account are free. New accounts get 100 free credits.
When is a command charged?
You are charged when data comes back, and for definitive answers such as not found or private account. Blocks, timeouts and errors on our side are refunded automatically. Requests rejected before they run (invalid input, a bad key, no credits left, rate limits) and cache hits cost nothing.
Can I use it in scripts and CI?
Yes. When output is piped it prints raw JSON, --output jsonl prints one object per line, and --fields keeps only the fields you name. Exit codes tell your script what went wrong, and the CLI never retries on its own. In CI, pass the key with SCRAPEEVERYTHING_API_KEY or se login --stdin.
Do new endpoints need a CLI update?
No. Commands and flags are generated from the live API catalog, so new endpoints work without an update. When you are offline, the CLI uses a catalog snapshot bundled with the package.
Do I need an Instagram or TikTok account?
No. No platform login or platform API key is needed. The only key is your Scrape Everything API key, created on the API keys page of the dashboard.
Start with 100 free credits.
Continue with Google, create an API key and send your first request in under a minute.