Skip to main content
A scrape returns the formats you ask for in the formats array. Leave it out and you get clean Markdown. Each format comes back as its own field on data, so you can ask for several in one call and read them side by side.

The formats

string
default:"true"
The page’s main content as clean Markdown, without menus, footers and other repeated parts of the site. This is what you get when formats is left out. Returned on data.markdown.
string
The same main content as cleaned HTML, with tags kept. Use it when you need structure Markdown cannot carry. Returned on data.html.
string
The page’s HTML exactly as it was delivered, with nothing removed. Returned on data.rawHtml.
Every link on the page, split into internal (the same site) and external (other sites). Returned on data.links.
object
The data the page publishes about itself for machines: JSON-LD, microdata and OpenGraph, put into one consistent shape. No LLM is involved, so it is exact and costs nothing extra. Returned on data.structured. More below.
string
A short, factual summary of the page, written by an LLM. Returned on data.summary. Costs 1 extra credit.
object
JSON shaped by a schema or a prompt you give in jsonOptions, read out of the page by an LLM. Returned on data.json. Costs 4 extra credits.
object
The site’s brand record: name, logos, colours, fonts and socials. Returned on data.brand. Costs 5 extra credits when a brand is found, the same as calling Brand separately, and nothing extra when none is found.

Structured data

The structured format returns what the page already declares, for example a product’s price or an article’s author and date. Because it is copied rather than interpreted, it is exact. You get one merged list and the raw blocks it came from:
array
Every typed entity on the page, from every syntax, with duplicates removed. Each entry has:
array
The raw blocks for each syntax, exactly as found, if you want them unmerged.
Try structured first when a page is likely to publish what you need, such as product prices, article details or event dates. Use json when the data is only in the page’s text.

Shaping the json format

Tell us what you want in jsonOptions. Give a schema, a prompt, or both. The schema fixes the field names and types; the prompt says what to look for.
Asking for json without a schema or a prompt is a validation error. Give at least one.
To pull the same fields from many pages, with a confidence and a source for each field, use Extract instead.

PDFs

Point a scrape at a PDF and you get Markdown, the same as for a web page. There is no separate endpoint and no extra cost: a PDF is one scrape. Headings stay headings and tables stay tables.
Scanned PDFs are not supported. A scan is a picture of a document with no text in it, and reading it would need OCR, which we do not run. You get an empty markdown, complete: false, confidence: 0, and a warning that says the document is a scan. Asking again gives the same answer. PDFs that contain text, such as exports from Word, LaTeX or design tools, work fully.

What formats cost

Ask for as many formats as you like in one call. The price is the base scrape plus any extra for the LLM formats. So ["markdown", "structured"] costs 1 credit, ["markdown", "summary"] costs 2, and ["markdown", "summary", "json"] costs 6. Every response states its total in usage.creditsUsed.

Next: Extraction quality

How each scrape says how far to trust it.