# Link Preview & Metadata Extractor (`weeknds/link-preview-metadata-extractor`) Actor Extract Open Graph, Twitter Cards, meta descriptions, favicons, and all metadata from any URL. Structured link previews with canonical URLs, language detection, HTTP status codes. Pure HTTP, no browser needed. Perfect for SEO audits and content aggregators. - **URL**: https://apify.com/weeknds/link-preview-metadata-extractor.md - **Developed by:** [C R](https://apify.com/weeknds) (community) - **Categories:** Developer tools, SEO tools - **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 & Metadata Extractor An [Apify Actor](https://apify.com) that extracts structured metadata and link previews from any URL — Open Graph tags, Twitter Cards, favicons, SEO meta tags, and more. Pure HTTP + BeautifulSoup, no headless browser needed. ### Input | Field | Type | Required | Default | Description | |-------|------|----------|---------|-------------| | `url` | string | **yes** | — | The URL to extract metadata from | | `includeFavicon` | boolean | no | `true` | Also find and return the favicon URL | | `userAgent` | string | no | `Apify-Metadata-Extractor/1.0` | Custom User-Agent header | | `timeout` | integer | no | `15` | Request timeout in seconds (1–120) | ### Output Returns a JSON object with: - **Title**: `` tag - **Description**: `<meta name="description">` - **Open Graph**: `og:title`, `og:description`, `og:image`, `og:url`, `og:type`, `og:site_name`, `og:locale`, `og:image:width`, `og:image:height`, `og:image:alt`, `og:video`, `og:audio` - **Twitter Card**: `twitter:card`, `twitter:title`, `twitter:description`, `twitter:image`, `twitter:site`, `twitter:creator`, `twitter:image:alt` - **Favicon**: resolved favicon URL (from `<link rel="icon">` or `/favicon.ico` fallback) - **Canonical URL**: `<link rel="canonical">` - **Language**: `<html lang="">` - **Author**, **Keywords**, **Robots**, **Viewport** - **All meta tags**: flat array of every `<meta>` tag - **HTTP**: `status_code`, `content_type`, `response_time_ms` #### Error handling Structured errors for invalid URLs, connection failures, DNS errors, timeouts, SSL errors, HTTP 4xx/5xx, and non-HTML content types: ```json { "url": "https://example.com", "error": "Connection failed: ...", "error_type": "connection_error", "timestamp": "2026-07-07T12:00:00.000Z" } ```` ### Local testing ```bash cd /root/apify-metadata python3.12 -m venv .venv .venv/bin/pip install apify aiohttp beautifulsoup4 APIFY_LOCAL_STORAGE_DIR=./storage mkdir -p storage/key_value_stores/default echo '{"url":"https://example.com","includeFavicon":true}' > storage/key_value_stores/default/INPUT.json .venv/bin/python -m src ``` Then check `storage/datasets/default/` for results. ### Deployment Push to Apify using the CLI or GitHub integration. Uses the `apify/actor-python:3.12` base image. # Actor input Schema ## `url` (type: `string`): The URL to extract metadata from. ## `includeFavicon` (type: `boolean`): Also find and return the favicon URL. ## `userAgent` (type: `string`): Custom User-Agent header for HTTP requests. ## `timeout` (type: `integer`): Seconds before HTTP request timeout. ## Actor input object example ```json { "url": "https://example.com", "includeFavicon": true, "userAgent": "Apify-Metadata-Extractor/1.0", "timeout": 15 } ``` # 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 = { "url": "https://example.com" }; // Run the Actor and wait for it to finish const run = await client.actor("weeknds/link-preview-metadata-extractor").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 = { "url": "https://example.com" } # Run the Actor and wait for it to finish run = client.actor("weeknds/link-preview-metadata-extractor").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 '{ "url": "https://example.com" }' | apify call weeknds/link-preview-metadata-extractor --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=weeknds/link-preview-metadata-extractor", "--header", "Authorization: Bearer <YOUR_API_TOKEN>" ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Link Preview & Metadata Extractor", "description": "Extract Open Graph, Twitter Cards, meta descriptions, favicons, and all metadata from any URL. Structured link previews with canonical URLs, language detection, HTTP status codes. Pure HTTP, no browser needed. Perfect for SEO audits and content aggregators.", "version": "1.0", "x-build-id": "40vQ5k8PYAB2rrfF3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/weeknds~link-preview-metadata-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-weeknds-link-preview-metadata-extractor", "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/weeknds~link-preview-metadata-extractor/runs": { "post": { "operationId": "runs-sync-weeknds-link-preview-metadata-extractor", "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/weeknds~link-preview-metadata-extractor/run-sync": { "post": { "operationId": "run-sync-weeknds-link-preview-metadata-extractor", "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": [ "url" ], "properties": { "url": { "title": "URL", "type": "string", "description": "The URL to extract metadata from." }, "includeFavicon": { "title": "Include Favicon", "type": "boolean", "description": "Also find and return the favicon URL.", "default": true }, "userAgent": { "title": "User Agent", "type": "string", "description": "Custom User-Agent header for HTTP requests.", "default": "Apify-Metadata-Extractor/1.0" }, "timeout": { "title": "Timeout", "minimum": 1, "maximum": 120, "type": "integer", "description": "Seconds before HTTP request timeout.", "default": 15 } } }, "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 } } } } } } } } } } ```