# OpenGraph & Social Preview Scraper (`andok/opengraph-inspector`) Actor Extract OpenGraph tags and Twitter Cards to ensure your content looks perfect when shared on social media. - **URL**: https://apify.com/andok/opengraph-inspector.md - **Developed by:** [Andok](https://apify.com/andok) (community) - **Categories:** Business, Developer tools - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $1.00 / 1,000 url inspecteds 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 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 ## OpenGraph & Twitter Card Inspector Inspect OpenGraph and Twitter Card meta tags across hundreds of URLs to QA your social sharing previews before they go live. A missing `og:image` or wrong `twitter:card` type means ugly link previews on Facebook, LinkedIn, Slack, and X -- and you only find out after someone shares the link. Bulk-check every page and get a clear report of what is present, what is missing, and what needs fixing. ### Features - **OpenGraph extraction** — captures `og:title`, `og:description`, `og:image`, `og:url`, `og:type`, and all other OG tags - **Twitter Card extraction** — reads `twitter:card`, `twitter:title`, `twitter:description`, `twitter:image`, and related tags - **Basic meta tags** — also grabs the page `` and `<meta name="description">` for comparison - **Missing tag detection** — flags essential tags that are absent so you can prioritize fixes - **Bulk processing** — scan hundreds of URLs in a single run with configurable concurrency - **Structured output** — OG and Twitter tags are returned as separate objects for easy filtering - **Pay-per-event billing** — you only pay for each URL inspected, with automatic charge-limit enforcement ### Input | Field | Type | Required | Default | Description | |-------|------|----------|---------|-------------| | `urls` | `array` | Yes | — | List of page URLs to inspect for OpenGraph and Twitter Card meta tags. | | `url` | `string` | No | — | Single URL to inspect (for backwards compatibility). Use `urls` for bulk processing. | | `timeoutSeconds` | `integer` | No | `15` | Maximum seconds to wait for each page response before timing out. | | `concurrency` | `integer` | No | `10` | Number of URLs to process in parallel. Increase for large batches, decrease if you hit rate limits. | #### Input Example ```json { "urls": [ "https://crawlee.dev", "https://apify.com/store", "https://github.com/apify/crawlee" ] } ```` ### Output Each URL produces one dataset item with separated OG tags, Twitter tags, and a list of missing essentials. - `inputUrl` (`string`) — the URL you submitted - `finalUrl` (`string`) — the URL after redirects - `status` (`number`) — HTTP status code - `pageTitle` (`string`) — content of the `<title>` tag - `pageDescription` (`string`) — content of `<meta name="description">` - `ogTags` (`object`) — all OpenGraph meta tags as key-value pairs (e.g., `og:title`, `og:image`) - `twitterTags` (`object`) — all Twitter Card meta tags as key-value pairs (e.g., `twitter:card`, `twitter:image`) - `missingEssential` (`string[]`) — list of essential tags that are missing (e.g., `og:title`, `og:image`, `twitter:card`) - `error` (`string | null`) — error message if the URL could not be fetched - `checkedAt` (`string`) — ISO 8601 timestamp of when the inspection was performed #### Output Example ```json { "inputUrl": "https://crawlee.dev", "finalUrl": "https://crawlee.dev/", "status": 200, "pageTitle": "Crawlee - Build reliable web scrapers", "pageDescription": "A web scraping and browser automation library for Node.js", "ogTags": { "og:title": "Crawlee - Build reliable web scrapers", "og:description": "A web scraping and browser automation library", "og:image": "https://crawlee.dev/img/og-image.png", "og:url": "https://crawlee.dev/", "og:type": "website" }, "twitterTags": { "twitter:card": "summary_large_image", "twitter:title": "Crawlee", "twitter:description": "A web scraping and browser automation library" }, "missingEssential": [], "error": null, "checkedAt": "2025-01-15T10:30:00.000Z" } ``` ### Pricing | Event | Cost | |-------|------| | URL Inspected | Pay-per-event (see actor pricing page) | The actor stops automatically when the per-run charge limit is reached, so you never overspend. ### Use Cases - **Social media QA** — verify that every page renders a proper preview on Facebook, LinkedIn, Slack, and X before launch - **Content migration validation** — confirm OG and Twitter tags survived a CMS migration or redesign intact - **Agency reporting** — deliver social-readiness audits to clients with per-page pass/fail status - **SEO auditing** — ensure meta descriptions and OG descriptions are consistent across your site - **Marketing campaigns** — validate landing page previews before sharing URLs in ad campaigns or newsletters ### Related Actors | Actor | What it adds | |-------|-------------| | [JSON-LD & Schema.org Extractor](https://apify.com/andok/jsonld-extractor) | Extracts structured data — combine with OG inspection for a complete metadata and schema audit | | [Favicon & Brand Icon Extractor](https://apify.com/andok/favicon-extractor) | Grabs favicons and touch icons — pair with OG images for full brand asset collection | | [Website Tech Stack Analyzer](https://apify.com/andok/tech-stack-analyzer) | Detects the CMS and framework — understand which platform generates the social preview tags | # Actor input Schema ## `urls` (type: `array`): List of page URLs to inspect for OpenGraph and Twitter Card meta tags. Each page is fetched and all OG/Twitter meta elements are extracted. ## `url` (type: `string`): Single URL to inspect (for backwards compatibility). Use the URLs field above for bulk processing. ## `timeoutSeconds` (type: `integer`): Maximum seconds to wait for each page response. Increase for slow or geographically distant sites. ## `concurrency` (type: `integer`): Number of URLs to process in parallel. Higher values speed up large batches but may trigger rate limits on some hosts. ## Actor input object example ```json { "urls": [ "https://crawlee.dev" ], "timeoutSeconds": 15, "concurrency": 10 } ``` # Actor output Schema ## `results` (type: `string`): No description ## `resultsCsv` (type: `string`): No description ## `run` (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://crawlee.dev" ] }; // Run the Actor and wait for it to finish const run = await client.actor("andok/opengraph-inspector").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://crawlee.dev"] } # Run the Actor and wait for it to finish run = client.actor("andok/opengraph-inspector").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://crawlee.dev" ] }' | apify call andok/opengraph-inspector --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=andok/opengraph-inspector", "--header", "Authorization: Bearer <YOUR_API_TOKEN>" ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "OpenGraph & Social Preview Scraper", "description": "Extract OpenGraph tags and Twitter Cards to ensure your content looks perfect when shared on social media.", "version": "1.0", "x-build-id": "hTJRUDcbuhdVLZKFx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/andok~opengraph-inspector/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-andok-opengraph-inspector", "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/andok~opengraph-inspector/runs": { "post": { "operationId": "runs-sync-andok-opengraph-inspector", "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/andok~opengraph-inspector/run-sync": { "post": { "operationId": "run-sync-andok-opengraph-inspector", "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", "properties": { "urls": { "title": "URLs", "minItems": 1, "type": "array", "description": "List of page URLs to inspect for OpenGraph and Twitter Card meta tags. Each page is fetched and all OG/Twitter meta elements are extracted.", "items": { "type": "string" } }, "url": { "title": "Single URL", "type": "string", "description": "Single URL to inspect (for backwards compatibility). Use the URLs field above for bulk processing." }, "timeoutSeconds": { "title": "Timeout (seconds)", "minimum": 1, "maximum": 120, "type": "integer", "description": "Maximum seconds to wait for each page response. Increase for slow or geographically distant sites.", "default": 15 }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Number of URLs to process in parallel. Higher values speed up large batches but may trigger rate limits on some hosts.", "default": 10 } } }, "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 } } } } } } } } } } ```