Overview
LinkPreview is an API that fetches a summary of any URL including its title, description, and preview image in JSON format. You authenticate with an API key and simply pass the target URL as a parameter. It is ideal for building link unfurlers, social sharing previews, or content aggregators.
Beginner Tip
Pass the URL you want to preview as the q parameter and your API key as the key parameter in the query string. Make sure the target URL is URL-encoded to avoid parsing errors.
Available Data
The kind of data this API exposes, based on its documentation. We could not call the endpoint to confirm the exact field names.
Example Response
Illustrative shape only — we were not able to call this endpoint (it requires credentials or exposes no public sample URL), so the fields below show the kind of data this API returns rather than a recorded response.
{
"status": "success",
"data": {
"result": "Data from LinkPreview",
"description": "Get JSON formatted summary with title, description and preview image for any requested URL",
"timestamp": "2025-01-15T10:00:00Z"
}
} Field Reference
title Page title extracted from the og:title or <title> tag. description Page description from og:description or meta description tag. image URL of the preview image from the og:image tag. url The final resolved URL after any redirects. Implementation Example
Calls a real endpoint of this API. Replace any placeholder credentials with your own key.
const url = "https://api.linkpreview.net/?key=YOUR_API_KEY&q=https%3A%2F%2Fwww.github.com";
// Replace headers or query params with the values required by this API.
const response = await fetch(url, {
headers: {
"X-API-Key": "YOUR_API_KEY"
}
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();
console.log(data); What Can You Build?
Note: These code examples are AI-generated and unverified. Always refer to the official API documentation for accurate usage.
Common Errors & Troubleshooting
Generated guidance based on this API's documentation, not observed by us. Treat it as a starting point and check against the provider's own error reference.
Metadata Score Breakdown
Estimated from metadata — endpoint not independently tested
Metadata estimate · endpoint not independently tested
Technical Specifications
Related Tags
Similar APIs
View All →Black History Facts
⭐ Beginner's PickThe Black History Facts API gives you access to one of the largest databases of Black history facts on the web.
CARTO
CARTO is a geospatial platform API that provides location intelligence and data analysis tools for mapping and prediction.
Enigma Public
Enigma Public is a platform that aggregates a broad collection of public datasets from government and other sources into a single searchable API.
Joshua Project
The Joshua Project API provides data on people groups around the world, focusing on those with the fewest followers of Christ for missionary research purposes.
Kaggle
Kaggle provides programmatic access to create and interact with datasets, notebooks, and connect with kaggle via REST API.