APIHub

Back to Explore

LinkPreview

The LinkPreview API returns metadata for a supplied URL—including the page title, description, and a preview image—via a GET request to the root path. The target URL is supplied in the 'q' query parameter, and the request requires an X-Linkpreview-Api-Key header.

Open Data

apiKeyHeader

HTTPS

CORS: Yes

Description enriched …

Visit official documentation

Latency

1664ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON

GET

Retrieve preview information for a given URL.

q (query, required) — The target URL to generate a preview for.
X-Linkpreview-Api-Key (header, required) — API key required to authenticate the request.

1 endpoint auto-detected

Authentication

This API uses an API key, passed in the "X-Linkpreview-Api-Key" header. No OAuth required.

curl -X GET \
  "https://www.linkpreview.net/" \
  -H "X-Linkpreview-Api-Key: YOUR_API_KEY"