Endpoints

Extract metadata

Get the title, description, images, favicon and site name of any URL as JSON — the data behind link previews.

GEThttps://jsonlink.io/api/extract

1 credit per successful requestFailed requests are freeTry it live →

Parameters

urlstringRequired

The full URL of the page, including https://. URL-encode it.

api_keystringRequired

Your API key. See Authentication.

titlestring

Page title, from the HTML <title>, og:title or twitter:title.

descriptionstring

Summary from og:description, twitter:description or the meta description.

imagesstring[]

Preview images (og:image, twitter:image), best first. Absolute URLs. Empty when the page has none.

sitenamestring

Site name, from og:site_name or derived from the title.

faviconstring

Absolute URL of the site icon.

domainstring

Domain of the page.

urlstring

The URL you requested.

durationnumber

How long the extraction took, in milliseconds.

Pages that time out return {"error": "REQUEST_TIMEOUT"} and are not billed. See Errors for every error.

Cache results: page metadata rarely changes, and a cache saves credits and latency.
Pages are retried with a browser and a proxy when a plain request is blocked, so slower responses are normal on some sites.
Building previews? The link preview generator shows how this data renders as a card.