Skip to main content
POST
web.scrape.structured

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
url
string
required

Public http or https address of the page.

type
enum<string>

The kind of page, when known. Left out, the kind is worked out from the page.

Available options:
article,
discussion,
event,
image,
job,
list,
product,
video

Response

The result

url
string
required

Address of the page.

type
string

Kind of page, e.g. article, product or discussion.

title
string

Title of the main item on the page.

text
string

Main text of the page.