Skip to main content

Command Reference ## Account Commands ### scrapebadger auth Set up or view your API key.

scrapebadger credits Check your credit balance. ### scrapebadger logout Remove saved API key from config. ---

Twitter Commands All Twitter commands are under scrapebadger twitter. ### Users

Tweets

Discovery

Common Options | Option | Short | Description |

|--------|-------|-------------| | --output | -o | Output format: json, csv, table, markdown | | --fields | -f | Comma-separated fields to include | | --cursor | -c | Pagination cursor | | --count | -n | Maximum results (where applicable) | ---

Search Options | Option | Description |

|---|---| | --gl | Country code (e.g. us, gb) | | --hl | Language code (e.g. en, fr) | | --num / -n | Number of results | | --start | Page offset (0, 10, 20,…) | | --domain | Google domain (e.g. google.co.uk) | | --device | desktop or mobile | | --location | City-level geo-targeting | | --tbs | Time filter (e.g. qdr:d past day) | | --safe | off, medium, high | ### Maps

News

Hotels

Jobs

Shopping

The shopping-click command resolves the real merchant URL for a product by title. Google has removed direct merchant links from organic Shopping HTML; this command uses an “I’m Feeling Lucky” redirect scoped to the source merchant (via site: operator) to materialize the product page URL. Costs 1 credit per call.
### Patents, Scholar, Finance, Products

Common Options Every google command supports --output/-o (json, csv, table, markdown) and --fields/-f (comma-separated field list).

Vinted Options | Option | Short | Description |

|--------|-------|-------------| | --market | -m | Market code: fr, de, uk, us, etc. (default: fr) | | --page | -p | Page number | | --per-page | | Results per page (max 96) | | --price-from | | Min price filter | | --price-to | | Max price filter | | --brands | | Comma-separated brand IDs | | --catalogs | | Comma-separated catalog (category) IDs — the catalog[] value in a Vinted category URL | | --colors | | Comma-separated color IDs | | --statuses | | Comma-separated condition IDs | | --order | | Sort order: relevance, newest_first, price_low_to_high, price_high_to_low | ---

Web Scraping Commands All web commands are under scrapebadger web.

Web Scrape Options | Option | Description |

|--------|-------------| | --js | Enable JavaScript rendering | | --wait-for | CSS selector to wait for | | --timeout | Timeout in milliseconds | | --proxy | Proxy country code | | --format | Response format: html, markdown, text | ### Web Extract Options | Option | Description | |--------|-------------| | --rules | CSS/XPath extraction rules as JSON | | --ai-rules | AI extraction rules as JSON | | --ai-query | Freeform AI query about the page | CLI 0.15.0 or later:
Supply exactly one of --image, --image-url or --image-base64. JPEG, PNG and WebP up to 5 MiB are supported. A successful search costs 10 credits. See Vinted image search for all filters and pagination.