Skip to main content
WEB_SCRAPE reads one page and returns its main content as Markdown: headings, paragraphs, lists, tables, links and images, with the site’s header, footer and navigation removed. Pages that script draws, such as shop product pages, are rendered before they are read. To read a search result, pass a link from GOOGLE_SERP’s organicResults.

Request

The task runs asynchronously. Read the result as described in Async tasks.

Parameters

Response

For example:

PDFs

HTML, plain text and text-based PDFs are supported. A PDF returns its text in page order, its title, author, subject (as description) and language when present, and images: []. OCR, attachments and layout reconstruction are not supported. The whole document is checked regardless of maxChars; only the returned Markdown is shortened. Textless, encrypted, damaged, incomplete and over-limit PDFs fail with PAGE_UNAVAILABLE.

Limits and errors

  • A page that cannot be read fails the task with PAGE_UNAVAILABLE and the reason: an unsupported format, a page answering 404 or 410, or a site that refuses the request.
  • A redirect to an address that breaks the url rules fails the task. The rules are checked again on every redirect hop.
  • WEB_SCRAPE ignores markdown, rawResponse and searchQueries. It rejects html and analysis with 422 and citationAnalysis with 400; see unsupported flags.
  • Other request errors are listed in Errors.
  • Web crawl to read many pages of one site
  • Web map to list a site’s addresses first