# URL Metadata — OpenGraph, Twitter Card & Favicon (`omao/url-metadata`) Actor

Get clean link-preview metadata for any URL: title, description, OpenGraph image, site name, canonical URL, favicon, Twitter Card and more. Fast, no setup.

- **URL**: https://apify.com/omao/url-metadata.md
- **Developed by:** [Marouane Oulabass](https://apify.com/omao) (community)
- **Categories:** Developer tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $1.44 / 1,000 metadata extracteds

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.
Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
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.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — 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

## URL Metadata — Link Preview & OpenGraph Data to JSON

**Get clean link-preview metadata for any URL — as JSON.** Pass a list of URLs and get back a tidy row per page: title, description, OpenGraph image, site name, canonical URL, favicon, Twitter Card and more. Fast, no setup, no anti-bot.

> AI-agent ready: this Actor is callable and payable by AI agents via [x402](https://docs.apify.com/platform/integrations/x402) (USDC on Base), no Apify account required.

Build rich link previews, enrich bookmarks, or audit a site's social/SEO tags in one run.

### Who uses this

- 🔗 **App & chat builders** — generate rich link previews (like Slack/Discord/iMessage).
- 📝 **Content & CMS tools** — auto-fill titles, images and descriptions from URLs.
- 🔎 **SEO & marketing** — audit OpenGraph, Twitter Card and canonical tags at scale.
- 🤖 **Data & AI pipelines** — enrich URL datasets with clean metadata.
- 🧑‍💻 **Developers** — a reliable metadata endpoint without parsing HTML yourself.

### What you get — one clean row per URL

| Field | Description |
|---|---|
| `title` | Page / OpenGraph title |
| `description` | Meta / OG description |
| `image` | OpenGraph preview image |
| `siteName` | Site name |
| `canonicalUrl` | Canonical URL |
| `favicon` | Favicon URL |
| `type` | OG type (article, website…) |
| `twitterCard` + `twitterSite` | Twitter Card data |
| `author` + `publishedTime` | Author & publish time |
| `themeColor`, `keywords`, `language` | Extra meta |
| `httpStatus`, `url`, `scrapedAt` | Status & provenance |

### Example

**Input**

```json
{ "urls": ["https://apify.com", "https://github.com"] }
```

**Output (one item)**

```json
{
  "url": "https://apify.com",
  "httpStatus": 200,
  "title": "Apify: Full-stack web scraping and data extraction platform",
  "description": "Cloud platform for web scraping, browser automation, and data extraction.",
  "image": "https://apify.com/og-image.png",
  "siteName": "Apify",
  "canonicalUrl": "https://apify.com/",
  "favicon": "https://apify.com/favicon.ico"
}
```

### Why this actor

- ✅ **Everything for a preview** — title, description, image, favicon, site name.
- 🐦 **Social tags** — OpenGraph and Twitter Card in one shot.
- 🔗 **Canonical & language** — clean, deduplicated, localized data.
- ⚡ **Fast & affordable** — pay only per URL returned. No setup, no anti-bot.
- 🛟 **Robust** — a bad URL never breaks the batch.

### Input options

- `urls` *(required)* — page URLs (`https://` added automatically if missing).

### FAQ

**Does it return the OG image?** Yes — `image` holds the OpenGraph preview image when present.

**Twitter Card too?** Yes — `twitterCard` and `twitterSite` are included.

**Can I process many URLs at once?** Yes — pass a list; each row carries its own URL and metadata.

**How fresh is the data?** Live — it fetches each page in real time on every run.

**Can I export to CSV/Excel/Google Sheets?** Yes — the dataset exports to JSON, CSV, Excel and HTML, or pull it via the API.

**What does it cost?** Pay-per-URL — you're only charged for URLs actually returned.

***

*Tip: feed your bookmark or CMS URLs through this to auto-generate consistent, rich link previews.*

# Actor input Schema

## `urls` (type: `array`):

Web page URLs to extract link-preview metadata from (https:// added if missing).

## `healthCheckMode` (type: `boolean`):

Internal monitoring: extract a canary page's metadata and FAIL if broken (no billing).

## Actor input object example

```json
{
  "urls": [
    "https://apify.com",
    "https://github.com"
  ],
  "healthCheckMode": false
}
```

# Actor output Schema

## `metadata` (type: `string`):

Link-preview metadata for each URL (title, description, image, favicon, canonical).

# 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://apify.com"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("omao/url-metadata").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://apify.com"] }

# Run the Actor and wait for it to finish
run = client.actor("omao/url-metadata").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://apify.com"
  ]
}' |
apify call omao/url-metadata --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=omao/url-metadata",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/acts/C9GPeOvnzzGIaozqI/builds/aMDTfrhIqyzRddWLp/openapi.json