API Depot/APIs/URL Metadata

URL Metadata

live

Fetch Open Graph, Twitter card, and standard meta tags from any public URL. Returns a structured link-preview object with title, description, image, favicon, and more.

POST /v1/url/metadataPer request

Request

FieldTypeDescription
url*stringFully-qualified public URL (http or https)

Response

FieldTypeDescription
urlstringFinal URL after redirects
titlestring | nullog:title, twitter:title, or <title> tag
descriptionstring | nullog:description, twitter:description, or meta description
imagestring | nullog:image or twitter:image URL
faviconstring | nullFavicon URL (link[rel=icon] or /favicon.ico)
site_namestring | nullog:site_name
typestring | nullog:type (e.g. article, website)
canonical_urlstring | nullURL from <link rel=canonical> if present

Example

Request

{
  "url": "https://github.com"
}

Response

{
  "url": "https://github.com/",
  "title": "GitHub · Build and ship software on a single, collaborative platform",
  "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://github.githubassets.com/assets/github-logo-55c5b9a1fe52.png",
  "favicon": "https://github.com/favicon.ico",
  "site_name": "GitHub",
  "type": "website",
  "canonical_url": null
}

Notes

  • Sync endpoint — follows up to 3 redirects, times out after 10s.
  • Private IP ranges (10.x, 192.168.x, 127.x) are blocked to prevent SSRF.
  • All response fields are null when not found — never omitted.
  • Image and favicon URLs are absolute; relative paths are resolved against the page base URL.

Try it