Skip to main content
Every Scrape response has a data.metadata object, whatever you list in formats. It describes the page itself: its title, description, language, social preview tags, status code, and what the call cost. A field is left out when the page does not have it, so check that a field is there before you use it.

Make a request

Get an API key in the Quickstart. This request reads a docs page. It asks for markdown so the response has something besides metadata.

Read the response

This real response is cut. The Markdown is shortened, and a few of the page’s meta tags are left out.
The same tag can appear twice: once under a plain name such as ogTitle, and once under the tag’s own name such as og:title. Use the plain names when they exist.

Fields

Every other meta tag on the page also comes back under its own name, such as twitter:card or viewport. A tag that appears several times comes back as an array of strings.

Limits and errors

  • metadata is always an object. A page with no meta tags still has sourceURL, url, statusCode, contentType and cacheState.
  • A YouTube link has no meta tags to read. Its title, description and ogImage come from the video. See YouTube.
  • A page that answers with a 404 or 410 status comes back with that statusCode and an error, and costs nothing. See Timeouts and errors.