How each product works

How to use Website Scraper

What Website Scraper takes in, which fields it returns and how credits are charged for each lookup.

Last updated 2026-10-22

What it does

Fetches a public web page and returns its title, metadata, readable text and links.

What you send

Send these fields in the JSON body of the request.

Request fields for Website Scraper
Field	Type	Required	Limits
url	string	Required	up to 2,048 characters
format	"markdown" or "text" or "html"	Optional	no extra limit

Request fields for Website Scraper

What you get back

The data object of a successful response carries these fields. Every response also lists its sources, the credits_charged and whether it was a cache_hit.

Each field is described in the API reference.

Response fields for Website Scraper
Field	Type
final_url	string
status	integer
title	string
description	string
canonical	string
language	string
headings	list
format	"markdown" or "text" or "html"
content	string
content_truncated	boolean
links	object
images	integer
word_count	integer
fetched_at	string

Response fields for Website Scraper

What it costs

10 credits per successful scrape (errors, empty and blocked pages are free).

What each outcome costs
Case	Charge
Found	10 credits
Nothing found	0 credits
Repeat inside 7 days	0 credits
Errors and invalid requests	0 credits

What each outcome costs

Run it

From code, send a POST request to https://YOUR_API_HOST/v1/website-scraper with your API key.

1curl -X POST https://YOUR_API_HOST/v1/website-scraper \
2  -H "Authorization: Bearer $LOOKVALID_API_KEY" \
3  -H "Content-Type: application/json" \
4  -d '{"url":"https://example.com","format":"markdown"}'

A request to Website Scraper

Full parameters and response fields are in the API reference. To run a list of values, use a bulk CSV job.

Good to know

A repeat of the same lookup within 7 days is served from your cache and costs 0 credits.
When the lookup finds nothing it returns found: false and costs 0 credits.
Invalid input and errors are never charged.
The API allows 200 requests per 10 seconds per key.

Still stuck? Write to hello@lookvalid.com.