Skip to main content
Commands follow a resource-based structure:
Pass --help on any command for full flags. Price and buy links live on offers[] โ€” see Offer.
Limit results:

Filters

Pass filters as JSON, or nest fields with --filters.<name>:
Brand or website filters need IDs (or use domains for websites โ€” see website search):
From a public URL:
From a local file (@ sends the file; binary is base64-encoded automatically):
You can also pass --image-url or --base64-image on products search alongside --query.

Lookup a store URL

Returns the canonical product with every merchant offer.

Product detail and similar

Brands, categories, websites

Locale

Set defaults via env (CHANNEL3_COUNTRY, etc.) or per call:

Output formats

--format accepts json, jsonl, yaml, pretty, raw, explore. --transform uses GJSON syntax.

Files

Prefix a path with @ to send a file as an argument:
Escape a literal @ with \@ if you need the character in a string.

Full reference

API shapes: What you request ยท API reference