# Open Graph & Link Preview Extractor (`mighty_monk/open-graph-extractor`) Actor

Extract Open Graph, Twitter Card, and meta tags from any URL in bulk. Build link previews, social cards, and unfurl data for your apps and automation workflows.

- **URL**: https://apify.com/mighty\_monk/open-graph-extractor.md
- **Developed by:** [Harsh](https://apify.com/mighty_monk) (community)
- **Categories:** Developer tools, Automation
- **Stats:** 3 total users, 2 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $3.00 / 1,000 url extracteds

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

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

## Open Graph & Link Preview Extractor

Extract **Open Graph**, **Twitter Card**, and other social meta tags from any URL in bulk. Use the results to build link previews, social cards, and unfurl data for your apps.

### Input

| Field | Type | Required | Default | Description |
|-------|------|----------|---------|-------------|
| `urls` | `string[]` | Yes | — | URLs to extract meta tags from |
| `includeTwitterCards` | `boolean` | No | `true` | Include Twitter Card meta tags |
| `timeoutMs` | `integer` | No | `15000` | Per-request timeout in milliseconds |

### Output (per URL)

| Field | Description |
|-------|-------------|
| `url` | Input URL |
| `title` | Page title (`og:title` or `<title>`) |
| `description` | Page description (`og:description` or `meta description`) |
| `ogImage` | Open Graph image URL (resolved to absolute) |
| `ogType` | Open Graph type (`website`, `article`, etc.) |
| `siteName` | Open Graph site name |
| `twitterCard` | Twitter Card type |
| `twitterImage` | Twitter Card image URL |
| `twitterTitle` | Twitter Card title |
| `twitterDescription` | Twitter Card description |
| `canonicalUrl` | Canonical link URL |
| `favicon` | Favicon URL |
| `locale` | Open Graph locale |
| `error` | Error message if extraction failed (null on success) |

### How it works

1. Fetches each URL with **axios** (configurable timeout, follows redirects)
2. Parses HTML with **cheerio**
3. Extracts `meta[property^="og:"]`, `meta[name^="twitter:"]`, `link[rel=canonical]`, and `link[rel=icon]`
4. Resolves relative image and link URLs against the page URL
5. Processes all URLs in parallel with graceful per-URL error handling

### Run locally

```bash
apify run
```

Example input (`storage/key_value_stores/default/INPUT.json`):

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

### Deploy to Apify

```bash
apify login
apify push
```

### Resources

- [Apify SDK for JavaScript](https://docs.apify.com/sdk/js/)
- [Input schema](https://docs.apify.com/platform/actors/development/input-schema)
- [Web scraping with Axios and Cheerio](https://blog.apify.com/web-scraping-with-axios-and-cheerio/)

# Actor input Schema

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

List of URLs to extract Open Graph and social meta tags from.

## `includeTwitterCards` (type: `boolean`):

Whether to extract Twitter Card meta tags (twitter:card, twitter:image, etc.).

## `timeoutMs` (type: `integer`):

Maximum time in milliseconds to wait for each URL request.

## Actor input object example

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

# Actor output Schema

## `results` (type: `string`):

No description

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

// Run the Actor and wait for it to finish
const run = await client.actor("mighty_monk/open-graph-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 = { "urls": [
        "https://apify.com",
        "https://github.com",
    ] }

# Run the Actor and wait for it to finish
run = client.actor("mighty_monk/open-graph-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 '{
  "urls": [
    "https://apify.com",
    "https://github.com"
  ]
}' |
apify call mighty_monk/open-graph-extractor --silent --output-dataset

```

## MCP server setup

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

```

## OpenAPI specification

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