Utilities

Link Preview

Fetch a web page and return its Open Graph / Twitter Card metadata: title, description, image, site name, favicon and more.

GET/api/preview?url=

Query parameters

NameTypeRequiredDescription
urlstringRequiredPublic http(s) URL of the page.

Try it

Saved only in this browser. Requests use your key and count toward your quota. Get a key

GET /api/preview

Example request

curl "https://your-app.com/api/preview?url=https%3A%2F%2Fgithub.com" \
  -H "x-api-key: YOUR_API_KEY"

Response

{
  "url": "https://github.com/",
  "title": "GitHub · Change is constant. GitHub keeps you ahead.",
  "description": "Join the world's most widely adopted developer platform...",
  "image": "https://images.ctfassets.net/.../GH-Homepage-Universe-img.png",
  "siteName": "GitHub",
  "type": "object",
  "author": null,
  "themeColor": "#1e2327",
  "canonical": "https://github.com/",
  "favicon": "https://github.githubassets.com/favicons/favicon.png"
}
Text UtilitiesRoll Dice