API Reference
Complete documentation for all OpenGraph.io API endpoints. Each endpoint supports authentication via App ID and offers various options for caching, rendering, and proxy usage.
Base URL
All API requests are made to:
https://opengraph.io/api/3.0/Migrating from v1.1? The legacy base URL https://opengraph.io/api/1.1/ is deprecated but still functional. v3.0 enables auto_proxy, auto_render, and retry by default for better results out of the box.
Endpoints
Site (Unfurl)
Extract OpenGraph metadata, Twitter Cards, and HTML meta tags from any URL.
Scrape
Fetch raw HTML from any website with JavaScript rendering and proxy support.
Screenshot
Capture high-quality screenshots of any webpage programmatically.
Extract
Extract specific HTML elements in a structured format for AI/LLM pipelines.
Query
Ask questions about any webpage and get structured answers powered by AI.
oEmbed
Get embeddable representations of URLs following the oEmbed specification.
Markdown
Convert any webpage to clean, structured Markdown for LLM and AI pipelines.
Common Parameters
These parameters work across most endpoints. Defaults shown are for v3.0.
| Parameter | Type | v3.0 Default | Description |
|---|---|---|---|
| app_id | string | - | Required. Your API key from the dashboard. |
| cache_ok | boolean | true | Allow cached results. |
| max_cache_age | number | 432000 | Maximum cache age in seconds. |
| auto_proxy | boolean | true | Automatically select optimal proxy. v1.1 default: false |
| auto_render | boolean | true | Automatically enable JS rendering when needed. v1.1 default: false |
| retry | boolean | true | Auto-retry failed requests with proxy escalation. v1.1 default: false |
| full_render | boolean | false | Force JavaScript rendering for SPAs. |
| use_proxy | boolean | false | Use standard proxy. |
| use_premium | boolean | false | Use residential proxy. |
| use_superior | boolean | false | Use mobile proxy. |
| accept_lang | string | en-US | Preferred language header (e.g., "en-US") |
Authentication
All requests require an app_id parameter. Get your free API key at dashboard.opengraph.io.
See the Authentication guide for details.
URL Encoding
Important: URLs passed in the path must be URL-encoded. For example, https://github.com becomes https%3A%2F%2Fgithub.com.
See the URL Encoding guide for language-specific examples.
Rate Limits
| Plan | Concurrent Requests |
|---|---|
| Free | 1 |
| Developer | 5 |
| Production | 25 |
| Enterprise | 100 |
See Rate Limits for more details.
MCP Integration
All API endpoints are also available through the OpenGraph MCP Server for AI assistants like Claude, Cursor, and VS Code.