For AI agents: a documentation index is available at /llms.txt
Skip to main content

/scrapers/*/*

POST 

/scrapers/*/*

Runs one API of a predefined scraper from the loaded scraper bundle: POST /scrapers/{scraper}/{api}, where {scraper} is the scraper name (an organisation slug such as zillow — never a hostname) and {api} is one of its APIs, both as listed by GET /scrapers.

The body is the API's input ({ url?, params? }). A scraper that runs and reports a typed scrape error (blocked, not-found, invalid-input, upstream-changed, upstream-error) still returns HTTP 200 with ok:false. HTTP 4xx/5xx is reserved for host-level failures (unknown scraper/api, bundle unavailable, overloaded, job timeout, worker crash, job drained by a bundle hot swap, invalid result). Every ok:true result has been validated against the API's declared output schema.

Request​

Responses​

Was this page helpful?