Skip to content

Response

Shubhajit Saha edited this page Dec 16, 2015 · 2 revisions

The API returns data in JSON format.

Each response includes a request object (which returns request-specific metadata), and an objects array, which will include the extracted information for all objects on a submitted page. At the moment, only a single object will be returned for API requests.

Objects in the API's objects array will include the following fields:

FIELD DESCRIPTION
type Type of object.
title Title of the article.
text Full text of the article.
html Normalized HTML of the extracted article. Please see the HTML Specification for a breakdown of elements and attributes returned.
date Date of extracted article, normalized in most cases to RFC 1123 (HTTP/1.1).
author Article author.
author_url URL of the author profile page, if available.
human_language Returns the (spoken/human) language of the submitted page, using two-letter ISO 639-1 nomenclature.
site_name The plain-text name of the site (e.g. The New York Times or YouTube). If no site name is automatically determined, the root domain (www.youtube.com) will be returned.
publisher_region If known, the region of the article publication.
publisher_country If known, the country of the article publication.
page_url URL of submitted page / page from which the article is extracted.
resolved_page_url Returned if the page_url redirects to another URL.
links Returns a top-level object (links) containing all hyperlinks found on the page.
meta Returns a top-level object (meta) containing the full contents of page meta tags, including sub-arrays for OpenGraph tags, Twitter Card metadata, schema.org microdata, and -- if available -- oEmbed metadata.

Clone this wiki locally