Skip to main content
POST
Extract products from a brand's website
10 Credits Rate limit weight: 10 Beta Feature
Each call counts as 10 requests against your per-minute rate limit.

Explicit deadlines and partial catalogs

Use timeoutOpts to set a deadline. With behavior: "return-partial", an incomplete catalog can succeed with partial: true. With behavior: "fail", or when behavior is omitted, truncation returns an unbilled 408. Legacy timeoutMS remains accepted with fail behavior. This replaces its earlier implicit partial success on this endpoint. Requests without an explicit timeout keep their existing best-effort behavior. See the migration guide.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <API_KEY>. Keys have full access by default.

Body

application/json
domain
string
required

The domain name to analyze.

maxProducts
integer

Maximum number of products to extract.

Required range: 1 <= x <= 12
maxAgeMs
integer
default:604800000

Return a cached result if a prior scrape for the same parameters exists and is younger than this many milliseconds. Defaults to 7 days (604800000 ms) when omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.

Required range: 0 <= x <= 2592000000
timeoutOpts
object

Optional request deadline and behavior on timeout. For GET requests, use timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded timeoutOpts object.

tags
string[]

Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.

Maximum array length: 20
Required string length: 1 - 50
Example:

Response

Successful response

cache_metadata
object
required

Cache outcome for this response. Composite responses are hits only when every cache-controlled fetch contributing to the output was a hit; age_ms is the oldest contributing hit.

request_id
string<uuid>
required

Unique id of this API call, also sent in the X-Request-Id response header. Quote it when contacting support about a failed request.

Example:

"3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"

partial
boolean

True when timeoutOpts.behavior=return-partial returned the usable results collected before the deadline. Partial collections are not cached as complete results.

products
object[]

Array of products extracted from the website

key_metadata
object

Credit usage, included whenever a valid API key is provided.