web.metadata

stable 2 credits

Page metadata: title, description, canonical, language, OpenGraph, Twitter cards, favicon.

GET /v1/web/metadata

What you get#

One Web record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

Also known as: /on_page/page, /web/scrape on APIs that nest their paths. See Alternatives and equivalents.

What it costs#

2 credits for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`url`	string	yes	(required)	Absolute http(s) URL of the page (ports 80/443 only; private/internal hosts are refused)	max 2048 chars; must match `https?://[A-Za-z0-9](?:[A-Za-z0-9.-]{0,251}[A-Za-z0-9])?(?::(?:80\|443))?(?:[/?][\x21-\x5b\x5d-\x7e]*)?`; trimmed

Request#

curl "https://api.onekey.dev/v1/web/metadata?url=https%3A%2F%2Fwww.python.org%2F" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Web response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": {
    "content": {
      "title": "Welcome to Python.org",
      "text": "The official home of the Python Programming Language",
      "url": "https://www.python.org/",
      "language": "en",
      "createdAt": null
    },
    "entity": {
      "updatedAt": null,
      "name": "Python.org",
      "type": "website",
      "tags": [
        "Python programming language object oriented web free open source software license documentation download community"
      ]
    },
    "ext": {
      "canonicalUrl": null,
      "faviconUrl": "https://www.python.org/static/apple-touch-icon-144x144-precomposed.png",
      "author": null,
      "generator": null,
      "robots": null,
      "themeColor": null,
      "httpStatus": 200,
      "openGraph": {
        "type": "website",
        "site_name": "Python.org",
        "title": "Welcome to Python.org",
        "description": "The official home of the Python Programming Language",
        "image": "https://www.python.org/static/opengraph-icon-200x200.png",
        "image:secure_url": "https://www.python.org/static/opengraph-icon-200x200.png",
        "url": "https://www.python.org/"
      },
      "twitter": {}
    },
    "media": {
      "url": "https://www.python.org/static/opengraph-icon-200x200.png"
    }
  },
  "metadata": {
    "platform": "web",
    "endpoint": "metadata",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 2,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`title`	`content.title`	-
`description`	`content.text`	-
`finalUrl`	`content.url`	`safeUrl`
`language`	`content.language`	-
`publishedAt`	`content.createdAt`	`toIsoDate`
`modifiedAt`	`entity.updatedAt`	`toIsoDate`
`siteName`	`entity.name`	-
`type`	`entity.type`	-
`canonicalUrl`	`ext.canonicalUrl`	`safeUrl`
`imageUrl`	`media.url`	`safeUrl`
`faviconUrl`	`ext.faviconUrl`	`safeUrl`
`author`	`ext.author`	-
`keywords`	`entity.tags`	-
`generator`	`ext.generator`	-
`robots`	`ext.robots`	-
`themeColor`	`ext.themeColor`	-
`status`	`ext.httpStatus`	`toNumber`
`openGraph`	`ext.openGraph`	-
`twitter`	`ext.twitter`	-

Caching and freshness#

Fresh for about 10 minutes. Repeat calls in that window are served from cache and are free.
Between 10 minutes and 1 hour the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
A "not found" is remembered for 2 minutes and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	That record does not exist. Free; do not retry.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).