Link Preview API - Open Graph & Metadata
Everything you need to build link previews: title, description, image, favicon, site name, language, canonical URL, author, publish time, Twitter card and optional JSON-LD. Fast HTML streaming parser.
Authentication & base URL
Subscribe through one of our marketplace listings; your marketplace API key and base URL are shown there. All endpoints return JSON over HTTPS, served from a global edge network (typically 20–150 ms).
Endpoints
GET /v1/preview
Link preview
| Parameter | In | Description | Example |
|---|---|---|---|
url * | query | Page URL | https://github.com |
jsonld | query | true to include JSON-LD structured data | false |
Example
GET /v1/preview?url=https%3A%2F%2Fgithub.com&jsonld=false
{
"url": "https://github.com/",
"finalUrl": "https://github.com/",
"status": 200,
"title": "GitHub · Change is constant. GitHub keeps you ahead. · GitHub",
"htmlTitle": "GitHub · Change is constant. GitHub keeps you ahead. · GitHub · GitHub",
"description": "Join the world's most widely adopted, AI-powered developer platform where millions of developers, businesses, and the largest open source community build software that advances humanity.",
"image": "https://images.ctfassets.net/8aevphvgewt8/4pe4eOtUJ0ARpZRE4fNekf/f52b1f9c52f059a33170229883731ed0/GH-Homepage-Universe-img.png",
"favicon": "https://github.githubassets.com/favicons/favicon.png",
"siteName": "GitHub",
"type": "object",
"lang": "en",
"canonical": "https://github.com/",
"author": null,
"publishedTime": null,
"themeColor": "#1e2327",
"twitterCard": "summary_large_image",
"twitterSite": "@github",
"robots": null
}Everything you need to build link previews: title, description, image, favicon, site name, language, canonical URL, author, publish time, Twitter card and optional JSON-LD. Fast HTML streaming parser.
Use cases
Chat apps and social feeds, bookmarking tools, CMS link cards, newsletters, SEO checks of Open Graph tags.
Why this API
- Fast: runs on a global edge network, typical response well under 1 second.
- Reliable: simple JSON, clear error messages.
- Fair pricing: Free plan 500 requests/month, Pro 25,000 for $4.99, Ultra 150,000 for $14.99.
Pricing
Free plan with 500 calls per month, then Pro (25,000 calls for $4.99/month) and Ultra (150,000 calls for $14.99/month). See all plans.