Skip to main content
GET
/
v1
/
metadata
Get URL metadata
curl --request GET \
  --url https://api.metalinkapi.com/v1/metadata \
  --header 'X-API-Key: <api-key>'
{
  "url": "https://github.com",
  "title": "GitHub: Let's build from here",
  "description": "GitHub is where over 100 million developers shape the future of software.",
  "image": "https://github.githubassets.com/assets/campaign-social-031d6161fa10.png",
  "favicon": "https://github.githubassets.com/favicons/favicon.svg",
  "site_name": "GitHub",
  "type": "website",
  "locale": "en_US",
  "twitter_card": {
    "card": "summary_large_image",
    "site": "@github"
  },
  "fetched_at": "2026-03-25T18:30:00Z",
  "fetch_method": "http",
  "response_time_ms": 142
}

Authorizations

​
X-API-Key
string
header
required

Pass your API key in the X-API-Key header (recommended)

Query Parameters

​
url
string<uri>
required

The URL to fetch metadata for

​
timeout
integer
default:5000

Custom timeout in milliseconds (default 5000, max 15000)

Required range: 1 <= x <= 15000
​
cache
boolean
default:true

Whether to use cached results. Defaults to true. Set to false to skip the cache and fetch fresh data.

Response

Metadata successfully retrieved

​
url
string
required

The originally requested URL

​
fetched_at
string<date-time>
required

When the metadata was fetched (ISO 8601)

​
fetch_method
enum<string>
required

How the page was fetched

Available options:
http,
headless
​
response_time_ms
integer<int64>
required

How long the fetch took in milliseconds

Required range: x >= 0
​
canonical_url
string

The canonical URL if specified by the page

​
title
string

Page title (from og:title or

​
description
string

Page description (from og:description or meta description)

​
image
string

Primary image URL (from og:image)

​
favicon
string

Favicon URL

​
site_name
string

Site name (from og:site_name)

​
type
string

Content type (from og:type, e.g. "article", "website")

​
locale
string

Locale (from og:locale, e.g. "en_US")

​
twitter_card
object

Twitter Card metadata (omitted if no Twitter meta tags found)

​
meta
object

Additional meta information (omitted if none found)