Skip to main content
POST /v1/data/web/extract/run Pricing: $0.01 per page ($10.00 per 1,000).

Ways to call it

  • By field names: set fields
  • By JSON Schema: set schema

Request

Send the inputs under params. Only the keys below are accepted; any other key returns 422 invalid_params.
string[]
required
Pages to extract from, up to 100 per request. One row per page.
string[]
Names of the values to pull from each page, like price, title or author.
object
A JSON Schema object (type object with properties) describing the data to extract. Every property needs a type, and every array needs items.
string
Optional guidance in plain words, like: prices in USD, monthly billing only.

Example

Response fields

Each row in data is one page, keyed by these fields.

Example response

Abridged: long text and lists are shortened.
For the full page as Markdown use web/scrape; for many pages of a site use web/crawl.