URL Metadata API

Fetch any URL and get its title, description, Open Graph and Twitter Card tags, favicon, canonical, feeds and JSON-LD as JSON.

Parameters

Example

curl "https://apibox.io.vn/v1/url-metadata?url=https://github.com" \
  -H "Authorization: Bearer YOUR_API_KEY"

const res = await fetch('https://apibox.io.vn/v1/url-metadata?url=https://github.com', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
  },
});
const data = await res.json();
console.log(data);

import requests

res = requests.get(
    "https://apibox.io.vn/v1/url-metadata?url=https://github.com",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    timeout=30,
)
print(res.json())

<?php
$ch = curl_init('https://apibox.io.vn/v1/url-metadata?url=https://github.com');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
]);
$response = curl_exec($ch);
print_r(json_decode($response, true));

Response

{
  "url": "https://github.com/",
  "final_url": "https://github.com/",
  "status": 200,
  "content_type": "text/html; charset=utf-8",
  "redirects": [],
  "response_ms": 461,
  "title": "GitHub · Change is constant. GitHub keeps you ahead. · GitHub",
  "description": "Join the world's most widely adopted, AI-powered developer platform where millions of developers, businesses, and the largest open source community build software that advances humanity.",
  "image": "https://images.ctfassets.net/8aevphvgewt8/76epZKB2wF998m4e4bLLXn/c505f20b00ec70b88b1be5aec42c4be4/OG_image.jpg",
  "image_alt": "Join the world's most widely adopted, AI-powered developer platform where millions of developers, businesses, and the largest open source community build software that advances humanity.",
  "site_name": "GitHub",
  "type": "object",
  "locale": null,
  "lang": "en",
  "canonical": "https://github.com/",
  "author": null,
  "keywords": [],
  "published_time": null,
  "theme_color": "#1e2327",
  "robots": null,
  "favicon": "https://github.githubassets.com/favicons/favicon.png",
  "icons": [
    {
      "href": "https://github.githubassets.com/favicons/favicon.png",
      "rel": "alternate icon",
      "type": "image/png"
    },
    {
      "href": "https://github.githubassets.com/favicons/favicon.svg",
      "rel": "icon",
      "type": "image/svg+xml"
    }
  ],
  "feeds": [],
  "alternates": [
    "https://github.com/",
    "https://github.com/?locale=pt-br",
    "https://github.com/?locale=ja"
  ],
  "open_graph": {
    "image": "https://images.ctfassets.net/8aevphvgewt8/76epZKB2wF998m4e4bLLXn/c505f20b00ec70b88b1be5aec42c4be4/OG_image.jpg",
    "site_name": "GitHub",
    "type": "object",
    "title": "GitHub · Change is constant. GitHub keeps you ahead. · GitHub",
    "url": "https://github.com/",
    "description": "Join the world's most widely adopted, AI-powered developer platform..."
  },
  "twitter_card": {
    "site": "@github",
    "card": "summary_large_image",
    "title": "GitHub · Change is constant. GitHub keeps you ahead. · GitHub"
  },
  "meta": {
    "viewport": "width=device-width",
    "description": "Join the world's most widely adopted, AI-powered developer platform..."
  },
  "json_ld": []
}

Use cases

• Build link previews (cards) in chat apps, CMS or social feeds
• Audit Open Graph and Twitter Card tags before sharing a page
• Collect titles, favicons and descriptions for bookmarks
• Discover RSS feeds and structured data (JSON-LD) of a website

FAQ

Related APIs