# Link Preview API — Bulk OpenGraph & Metadata Unfurl (`technicaldost/link-preview-api`) Actor
Bulk URL to OpenGraph link-preview metadata: title, description, preview image, favicon, site name and canonical URL. Unfurl links for chat apps, CMS, bookmarking and feeds. No browser, no API key.
- **URL**: https://apify.com/technicaldost/link-preview-api.md
- **Developed by:** [Technical Dost Solutions](https://apify.com/technicaldost) (community)
- **Categories:** Developer tools, Automation
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet
## Pricing
Pay per usage
This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.
Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage
## What's an Apify Actor?
Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".
## How to integrate an Actor?
If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.
In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):
```bash
npm install apify-client
```
In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):
```bash
pip install apify-client
```
In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):
````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash
In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).
If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).
For usage examples, see the [API](#api) section below.
For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).
# README
## Link Preview API — Bulk OpenGraph & Metadata Unfurl
**Link Preview API** turns any list of URLs into clean, structured **link-preview metadata** in one call —
the same "unfurl" you see when you paste a link into Slack, Discord, WhatsApp, or a CMS. It reconciles
**OpenGraph**, **Twitter Card**, and standard HTML meta tags into one tidy record per URL: title,
description, preview image, site name, favicon, canonical URL, and oEmbed endpoint. Built for developers
who need fast, cheap, bulk **link previews** without running a headless browser.
Give it `["https://github.com", "https://stripe.com"]` and get back a rich preview object for each — ready
to render a link card, populate a bookmark, or enrich a feed.
### Features
- **One record per URL** reconciling OpenGraph + Twitter Card + `` + ``.
- **Preview image, favicon, site name, canonical URL, oEmbed** resolved to absolute URLs.
- **Bulk + concurrent** — unfurl up to 100 URLs per run.
- **No proxy, no browser** — plain HTTP fetch, so it's fast and low-cost (great margins, cheap for you).
- **Graceful failures** — unreachable or 404 URLs return `ok: false` with an `error`, never crash the run.
- **Developer-friendly JSON** ready for link cards, chat unfurls, bookmarking apps, and content feeds.
### Input
| Field | Type | Description |
|---|---|---|
| `urls` | array (required) | URLs to unfurl, e.g. `["https://github.com","stripe.com"]` (scheme optional). |
| `maxItems` | integer | Max URLs processed per run. Default `100`. |
```json
{
"urls": ["https://github.com", "https://www.apify.com"],
"maxItems": 100
}
````
### Output
One structured preview per URL:
```json
{
"url": "https://github.com",
"finalUrl": "https://github.com/",
"ok": true,
"status": 200,
"title": "GitHub · Build and ship software",
"description": "Join the world's most widely adopted AI-powered developer platform.",
"image": "https://github.githubassets.com/assets/og-image.png",
"siteName": "GitHub",
"type": "object",
"canonical": "https://github.com/",
"favicon": "https://github.com/favicon.ico",
"twitterCard": "summary_large_image",
"oembed": null,
"fetchedAt": "2026-06-23T00:00:00.000Z"
}
```
### How to generate link previews from a list of URLs
1. Put your URLs in `urls` (scheme is optional — `stripe.com` works).
2. Run the Actor and read one preview record per URL from the dataset.
3. Export as JSON, CSV, or Excel, or call the Actor's API from your backend to unfurl links on demand.
### Common use cases
- **Chat & comment link unfurls** — render rich link cards like Slack/Discord.
- **Bookmarking & read-later apps** — store title, description, and preview image per saved link.
- **CMS & social scheduling** — preview how a URL will look when shared before publishing.
- **Feed & newsletter enrichment** — attach images and descriptions to a list of links.
### FAQ
**Does it need an API key?** No. You pass URLs; the Actor fetches and parses public page metadata.
**Does it run a headless browser?** No — it uses plain HTTP for speed and low cost. JavaScript-rendered
meta tags on heavily client-side sites may be limited; most sites expose OpenGraph in server HTML.
**What if a URL is down or 404s?** You get a record with `ok: false` and an `error`; the run continues.
**Does it return personal data?** No — only public page metadata (title, description, image, favicon).
**What formats can I export?** JSON, CSV, and Excel via the dataset, or call the Actor API directly.
### Pricing
Pay-per-event: a tiny per-run start fee plus a small per-URL charge. You pay only for URLs you unfurl — no
monthly seats. See the Pricing tab for current rates.
### Further reading
- Building link previews (unfurling) for chat and CMS apps.
- OpenGraph vs Twitter Card meta tags.
# Actor input Schema
## `urls` (type: `array`):
List of page URLs to unfurl into link-preview metadata.
## `maxItems` (type: `integer`):
Maximum number of URLs to process per run.
## Actor input object example
```json
{
"urls": [
"https://www.apify.com",
"https://github.com"
],
"maxItems": 100
}
```
# API
You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.
## JavaScript example
```javascript
import { ApifyClient } from 'apify-client';
// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
token: '<YOUR_API_TOKEN>',
});
// Prepare Actor input
const input = {
"urls": [
"https://www.apify.com",
"https://github.com"
]
};
// Run the Actor and wait for it to finish
const run = await client.actor("technicaldost/link-preview-api").call(input);
// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
console.dir(item);
});
// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs
```
## Python example
```python
from apify_client import ApifyClient
# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")
# Prepare the Actor input
run_input = { "urls": [
"https://www.apify.com",
"https://github.com",
] }
# Run the Actor and wait for it to finish
run = client.actor("technicaldost/link-preview-api").call(run_input=run_input)
# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
print(item)
# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start
```
## CLI example
```bash
echo '{
"urls": [
"https://www.apify.com",
"https://github.com"
]
}' |
apify call technicaldost/link-preview-api --silent --output-dataset
```
## MCP server setup
```json
{
"mcpServers": {
"apify": {
"command": "npx",
"args": [
"mcp-remote",
"https://mcp.apify.com/?tools=technicaldost/link-preview-api",
"--header",
"Authorization: Bearer <YOUR_API_TOKEN>"
]
}
}
}
```
## OpenAPI specification
```json
{
"openapi": "3.0.1",
"info": {
"title": "Link Preview API — Bulk OpenGraph & Metadata Unfurl",
"description": "Bulk URL to OpenGraph link-preview metadata: title, description, preview image, favicon, site name and canonical URL. Unfurl links for chat apps, CMS, bookmarking and feeds. No browser, no API key.",
"version": "0.1",
"x-build-id": "yv1TNlFcCnZi1PdFi"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/technicaldost~link-preview-api/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-technicaldost-link-preview-api",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/acts/technicaldost~link-preview-api/runs": {
"post": {
"operationId": "runs-sync-technicaldost-link-preview-api",
"x-openai-isConsequential": false,
"summary": "Executes an Actor and returns information about the initiated run in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/runsResponseSchema"
}
}
}
}
}
}
},
"/acts/technicaldost~link-preview-api/run-sync": {
"post": {
"operationId": "run-sync-technicaldost-link-preview-api",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
"schemas": {
"inputSchema": {
"type": "object",
"required": [
"urls"
],
"properties": {
"urls": {
"title": "URLs",
"type": "array",
"description": "List of page URLs to unfurl into link-preview metadata.",
"items": {
"type": "string"
}
},
"maxItems": {
"title": "Max URLs",
"type": "integer",
"description": "Maximum number of URLs to process per run.",
"default": 100
}
}
},
"runsResponseSchema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"actId": {
"type": "string"
},
"userId": {
"type": "string"
},
"startedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"finishedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"status": {
"type": "string",
"example": "READY"
},
"meta": {
"type": "object",
"properties": {
"origin": {
"type": "string",
"example": "API"
},
"userAgent": {
"type": "string"
}
}
},
"stats": {
"type": "object",
"properties": {
"inputBodyLen": {
"type": "integer",
"example": 2000
},
"rebootCount": {
"type": "integer",
"example": 0
},
"restartCount": {
"type": "integer",
"example": 0
},
"resurrectCount": {
"type": "integer",
"example": 0
},
"computeUnits": {
"type": "integer",
"example": 0
}
}
},
"options": {
"type": "object",
"properties": {
"build": {
"type": "string",
"example": "latest"
},
"timeoutSecs": {
"type": "integer",
"example": 300
},
"memoryMbytes": {
"type": "integer",
"example": 1024
},
"diskMbytes": {
"type": "integer",
"example": 2048
}
}
},
"buildId": {
"type": "string"
},
"defaultKeyValueStoreId": {
"type": "string"
},
"defaultDatasetId": {
"type": "string"
},
"defaultRequestQueueId": {
"type": "string"
},
"buildNumber": {
"type": "string",
"example": "1.0.0"
},
"containerUrl": {
"type": "string"
},
"usage": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "integer",
"example": 1
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
}
}
},
"usageTotalUsd": {
"type": "number",
"example": 0.00005
},
"usageUsd": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "number",
"example": 0.00005
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}
```