# 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
- **Features:** Limited permissions
- **Stats:** 3 total users, 2 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/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
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.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## 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.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# 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(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).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": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,omao/url-metadata"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

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