Open Graph Scraper API
Parse Open Graph Metadata fetches a URL and returns its link-preview metadata as flat JSON, so you can build a link unfurler, a bookmark manager or an SEO audit without writing an HTML parser. From the page it extracts the title and meta description, the Open Graph fields ogTitle, ogDescription, ogImage, ogType and ogSiteName, the Twitter card fields twitterTitle, twitterDescription and twitterImage, the canonical URL and the favicon. The only input is the url. It reads the raw HTML the server sends rather than rendering the page in a browser, so metadata that a page injects with client-side JavaScript after it loads is not seen. Redirects are followed, and the response reports both the url you sent and the finalUrl it ended on, together with the HTTP status. A server error or an empty body raises an error, while a client-error page such as a 404 is returned with its status, so you can tell a dead link from a failed fetch. Every call authenticates with your upAPI key. The exact price and cache lifetime are on this page’s FAQ, generated from the same catalog the calls run against.
What data you get
Parse Open Graph Metadata
- url
- stringrequired
- title
- stringrequired
- ogType
- stringrequired
- status
- integerrequired
- favicon
- stringrequired
- ogImage
- stringrequired
- ogTitle
- stringrequired
- finalUrl
- stringrequired
- canonical
- stringrequired
- fetchedAt
- stringrequired
- ogSiteName
- stringrequired
- description
- stringrequired
- twitterImage
- stringrequired
- twitterTitle
- stringrequired
- ogDescription
- stringrequired
- twitterDescription
- stringrequired
Calling Parse Open Graph Metadata
A schema-derived request and response shape — not a captured production call, since upAPI has none to publish. Every field is real, from the operation’s own published schema.
curl -X POST https://api.upapi.io/opengraph-parse.get \
-H "X-Api-Key: $UPAPI_KEY" \
-H "Content-Type: application/json" \
-d '{
"url": "https://github.com"
}'{
"url": "https://github.com",
"title": "Alan Turing",
"ogType": "example",
"status": 1,
"favicon": "example",
"ogImage": "example",
"ogTitle": "example",
"finalUrl": "example",
"canonical": "example",
"fetchedAt": "example",
"ogSiteName": "example",
"description": "example",
"twitterImage": "example",
"twitterTitle": "example",
"ogDescription": "example",
"twitterDescription": "example"
}Pricing
Every unit draws from one pooled monthly quota shared across the whole catalog. What a unit costs on each plan is on the pricing page, linked below.
Questions people actually ask
Which Open Graph and Twitter card tags does the API return?
ogTitle, ogDescription, ogImage, ogType and ogSiteName for Open Graph, twitterTitle, twitterDescription and twitterImage for the Twitter card, plus the page title, meta description, canonical URL and favicon. A tag the page does not declare comes back empty.
Does it execute JavaScript on the page?
No. It parses the raw HTML the server returns, so tags added by client-side JavaScript after load are not picked up. Pages that render their meta tags on the server work as expected.
How do I get the canonical URL and favicon of a page?
Send the page URL and read the canonical and favicon fields of the response. finalUrl tells you where the request ended up after redirects, which is the address to compare the canonical against.
What happens when the URL redirects or returns an error?
Redirects are followed and reported in finalUrl. A 4xx response is returned with its HTTP status in the status field, so you can distinguish a dead link from a failure; a 5xx response or an empty body raises an error.
How much does this cost?
Every operation in this cluster costs 1 weighted unit per call, drawn from your plan’s pooled monthly quota — see upapi.io/pricing for what a unit costs on each tier.
How fresh is the data — is it cached?
every cached operation here returns a response held for 1 hour. A repeat call inside a cached window returns the cached response and is billed nothing.
Related
Start with the free plan
One key and one pooled monthly quota cover Parse Open Graph Metadata and every other API in the catalog. See what a unit costs on each plan, or run the operation first.