Browse

Website Scraper

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

POST https://YOUR_API_HOST/v1/website-scraper

Credits and caching

  • Success billing. 10 credits per successful scrape (errors, empty and blocked pages are free). You are charged only when the lookup finds something; a not-found result is free.
  • Results are cached per account for 7 days. Repeating the same lookup in that window is free and returns cache_hit: true.
  • Invalid input, rate limits and errors are never charged.
  • Read the billing rules for the full picture.

Request

Send a JSON body with Authorization: Bearer <key>. The body can be up to 64 KB.

FieldTypeRequiredNotes
urlstringyesUp to 2048 characters.
formatstringnoOne of markdown, text, html. Default "markdown".

Example request

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

Response

The status is 200 whether or not anything was found. Check found. Every response also carries the X-Request-Id, X-Credits-Charged, X-Credits-Remaining and X-RateLimit-* headers.

Envelope

FieldTypeNotes
request_idstring-
product"website-scraper"-
foundbooleanFalse means the lookup ran and found nothing; it is free.
reasonstring or nullWhy nothing was found; null when found.
sourcesarray of stringWhere the data came from, including any attribution the licence requires.
credits_chargedinteger0 for a cache hit, a not-found result or an error.
credits_remaininginteger-
cache_hitbooleanTrue when the account already paid for this lookup within the cache window.
cacheobject-

The data object

Present when found is true, otherwise null.

FieldTypeNotes
final_urlstring-
statusinteger-
titlestring or null-
descriptionstring or null-
canonicalstring or null-
languagestring or null-
headingsarray of object-
headings[].levelintegerMinimum 1. Maximum 6.
headings[].textstring-
formatstringOne of markdown, text, html.
contentstring-
content_truncatedboolean-
linksobject-
links.internalarray of object-
links.internal[].urlstring-
links.internal[].textstring-
links.externalarray of object-
links.external[].urlstring-
links.external[].textstring-
imagesinteger-
word_countinteger-
fetched_atstring-

Captured example (2026-10-18)

A real run of this lookup on 2026-10-18, using the request above, which is a public input. The envelope fields are left out.

{
  "product": "website-scraper",
  "found": true,
  "data": {
    "final_url": "https://example.com/",
    "status": 200,
    "title": "Example Domain",
    "description": null,
    "canonical": null,
    "language": "en",
    "headings": [],
    "format": "markdown",
    "content": "This domain is for use in documentation examples without needing permission. This is not a service; avoid relying on it for testing and monitoring purposes.",
    "content_truncated": false,
    "links": {
      "internal": [],
      "external": []
    },
    "images": 0,
    "word_count": 25,
    "fetched_at": "2026-10-18T02:06:04.110Z"
  },
  "sources": [
    "https://example.com"
  ]
}

Errors

  • 400 invalid_input: The request input is invalid.
  • 401 unauthorized: The API key is missing, malformed, revoked or unknown.
  • 402 insufficient_credits: The account does not have enough credits for this lookup. Error code: insufficient_credits. During a trial whose allowance is used up the code is trial_allowance_exhausted: nothing is charged and the customer starts the plan from the billing page.
  • 405 method_not_allowed: This endpoint does not accept that HTTP method.
  • 413 payload_too_large: The request body is too large.
  • 429 rate_limited: Too many requests for this API key.
  • 500 internal_error: An unexpected error occurred.
  • 503 provider_unavailable: The data source for this product is unavailable right now.