Skip to main content
Live

Extract

Send a URL and a JSON schema, get typed JSON back. Structured data the page already publishes costs 0 credits.

Endpoints

  • POST/v1/extractOne url, a urls array, or your own html, with or without a schema.

Try it

TryStructured JSON from the page. Free when the page publishes JSON-LD or Open Graph.

Example outputhttps://acme-plumbing.example

{
"name": "Acme Plumbing",
"telephone": "+1 512 555 0148",
"address": { "addressLocality": "Austin", "addressRegion": "TX" },
"_completeness": 0.92,
"_extraction_method": "json-ld"
}
Completeness
0.92
Fetched by
plain HTTP
Read by
JSON-LD
Cost
0 credits (no schema)

Example values. One completeness score covers the whole result.

Shows example output until you press Run. Demo runs are free, up to 10 every 5 minutes.

What it returns

POST /v1/extract

Response fields for POST /v1/extract
dataWith a schema: an object in your schema’s shape. Without one: the business fields found on the page.Always
data._completenessA 0 to 1 completeness score for the whole record.No schema, when structured data is found
data._extraction_methodHow the data was read: json-ld, or regex-cascade for page text.No schema, when structured data is found
schemaThe schema you sent, echoed back.With a schema
metadataToken counts and latency for the model call.With a schema
results[]One entry per URL, each with ok, data or error, plus summary with total, ok and failed.When you send urls

A page that cannot be fetched returns 422 extract_failed.

One request

Send your key as a Bearer token. Every parameter in these samples is one the endpoint reads today. The Example tab shows a trimmed response for a fictional business.

Every parameter in the docs
curl -X POST https://api.superscraper.dev/v1/extract \
  -H "Authorization: Bearer $SUPERSCRAPER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com"
  }'
No schema (JSON-LD, Open Graph)
Free
With a schema
1credit per URL extracted
  • With a schema, model usage is added to the credit. Only URLs that return data are charged.

URLs per request

free
10
hobby
50
pro
200
scale
500

Per request, by plan.

Questions

When is extraction free?

When you send no schema. The page’s JSON-LD, Open Graph tags and text are read with no model call, for 0 credits.

Can I send HTML I already have?

Yes. Pass html instead of url and nothing is fetched. You can add markdown next to html; markdown on its own is not enough and returns 400 missing_input.

What does _completeness measure?

How complete the record is. It counts which core fields (name, phone, address, city, state) and extra fields were found, and gives one score for the whole record.