OpenGraph Data Extractor

Overview

The OpenGraph Data Extractor fetches any URL and parses its OpenGraph meta tags. Returns structured data including title, description, image, site name, type, locale, audio, video, and any custom og:* properties. Also extracts the favicon.

Endpoint

POST /api/opengraph

GET /api/opengraph/fetch?url=https://example.com

Request Parameters

Parameter	Type	Required	Description
url	string	Yes	The URL to extract OpenGraph data from (e.g. https://github.com)

Response Fields

The response is wrapped in a standard API envelope:

Field	Type	Description
success	boolean	`true` on success
data.url	string	The URL that was fetched
data.title	string?	The og:title value
data.description	string?	The og:description value
data.siteName	string?	The og:site_name value
data.image	string?	The og:image URL (resolved to absolute)
data.imageAlt	string?	The og:image:alt value
data.imageWidth	string?	The og:image:width value
data.imageHeight	string?	The og:image:height value
data.imageType	string?	The og:image:type value
data.type	string?	The og:type value (e.g. website, article)
data.locale	string?	The og:locale value
data.favicon	string?	Detected favicon URL from the page
data.audio	array	Audio items with `url` and `type`
data.video	array	Video items with `url`, `type`, `width`, `height`
data.extraProperties	array	Any other og:* properties not in the standard set, each with `property` and `content`
data.fetchTimeMs	int	Time taken to fetch and parse the page in milliseconds

Example

Extract OpenGraph data from a URL:

Warning: Passing your API key as a query parameter exposes it in server logs, browser history, and referrer headers. Only use this method in server-to-server or controlled environments.

https://simplewebapis.com/api/opengraph/fetch?url=https://github.com&api_key=swa_your_key

curl -X POST https://simplewebapis.com/api/opengraph \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: swa_your_key" \
  -d '{"url": "https://github.com"}'

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-Api-Key", "swa_your_key");

var payload = new { url = "https://github.com" };
var json = JsonSerializer.Serialize(payload);
var content = new StringContent(json, Encoding.UTF8, "application/json");

var response = await client.PostAsync(
    "https://simplewebapis.com/api/opengraph", content);
var result = await response.Content
    .ReadFromJsonAsync<OpenGraphResponse>();
Console.WriteLine(result?.Data?.Title);

// -- Response model  --

record OpenGraphResponse(
    bool Success, 
    string? Message, 
    OpenGraphData? Data);

record OpenGraphData(
    string Url, 
    string? Title, 
    string? Description,
    string? SiteName, 
    string? Image, 
    string? ImageAlt,
    string? ImageWidth, 
    string? ImageHeight, 
    string? ImageType,
    string? Url_, 
    string? Type, 
    string? Locale,
    List<OpenGraphAudio> Audio, 
    List<OpenGraphVideo> Video,
    List<OpenGraphProp> ExtraProperties,
    string? Favicon, 
    int FetchTimeMs);

record OpenGraphAudio(string? Url, string? Type);

record OpenGraphVideo(
    string? Url, 
    string? Type, 
    string? Width, 
    string? Height);

record OpenGraphProp(string Property, string Content);

$ch = curl_init('https://simplewebapis.com/api/opengraph');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'X-Api-Key: swa_your_key',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'url' => 'https://github.com',
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
echo $data['data']['title'];

const response = await fetch('https://simplewebapis.com/api/opengraph', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-Api-Key': 'swa_your_key',
  },
  body: JSON.stringify({
    url: 'https://github.com',
  }),
});

const result = await response.json();
console.log(result.data.title);

import requests

response = requests.post(
    'https://simplewebapis.com/api/opengraph',
    headers={
        'Content-Type': 'application/json',
        'X-Api-Key': 'swa_your_key',
    },
    json={'url': 'https://github.com'},
)

data = response.json()
print(data['data']['title'])

body, _ := json.Marshal(map[string]string{
    "url": "https://github.com",
})
req, _ := http.NewRequest("POST",
    "https://simplewebapis.com/api/opengraph",
    bytes.NewReader(body))
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-Api-Key", "swa_your_key")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

var result map[string]any
json.NewDecoder(resp.Body).Decode(&result)
fmt.Println(result["data"])

require 'net/http'
require 'json'

uri = URI('https://simplewebapis.com/api/opengraph')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['X-Api-Key'] = 'swa_your_key'
request.body = { url: 'https://github.com' }.to_json

response = http.request(request)
data = JSON.parse(response.body)
puts data['data']['title']

var client = HttpClient.newHttpClient();
var request = HttpRequest.newBuilder()
    .uri(URI.create("https://simplewebapis.com/api/opengraph"))
    .header("Content-Type", "application/json")
    .header("X-Api-Key", "swa_your_key")
    .POST(HttpRequest.BodyPublishers.ofString(
        "{\"url\":\"https://github.com\"}"))
    .build();

var response = client.send(request,
    HttpResponse.BodyHandlers.ofString());
var mapper = new ObjectMapper();
var result = mapper.readTree(response.body());
System.out.println(result.get("data").get("title"));

let client = reqwest::blocking::Client::new();
let response = client
    .post("https://simplewebapis.com/api/opengraph")
    .header("Content-Type", "application/json")
    .header("X-Api-Key", "swa_your_key")
    .json(&serde_json::json!({
        "url": "https://github.com",
    }))
    .send()?;

let result: serde_json::Value = response.json()?;
println!("{}", result["data"]["title"]);

The response is a JSON object (Content-Type: application/json).

Try it out

Use the Playground to test this API live.