Page Metadata API

Fetches a page and returns its <head> metadata -- title, description, canonical, language, hreflang, favicon, Open Graph and Twitter cards -- with every URL resolved to absolute.

Updated

Agents read this page asGET /v1/page-metadata/schemafree: schema, examples, errors, price

Endpoint
POST /v1/page-metadata
Price
$0.002 per call
Timeout
8 s
max_timeout_seconds
29 (the whole call as the 402 envelope sells it: the timeout, plus payment verification and settlement around it)
Response cap
3 MB (3,145,728 bytes)

When to use it

It needs the network and three libraries an agent scraping many pages does not carry: an HTML parser, a legacy charset decoder, and a resolver that honours <base href> and the final redirect hop. Feeding raw HTML to a model to pull these fields costs far more in tokens than this call.

When not to use it

  • The input is over 3 MB (3,145,728 bytes): page-metadata answers too_large (413).
  • The destination needs more than 8 s to answer: the call ends with upstream_timeout (424).
  • The destination is on a private or local network: the network guard refuses it with blocked_target (403).

Parameters

One JSON body. The schema is free at GET /v1/page-metadata/schema.

FieldTypeRequiredDescription
urlstringyesAbsolute http(s) URL of an HTML or XHTML page, up to 2048 characters; up to 5 redirects are followed and relative head URLs resolve against the final hop or its <base href>.

Limits

LimitValue
Size cap3 MB (3,145,728 bytes)
Timeout8 s
Show the JSON Schema the handler validates against
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 2048,
      "format": "uri",
      "description": "Absolute http(s) URL of an HTML or XHTML page, up to 2048 characters; up to 5 redirects are followed and relative head URLs resolve against the final hop or its <base href>."
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}

Example

The published example, verbatim: the request and the response it returns.

Request
POST /v1/page-metadata
content-type: application/json
payment-signature: <base64 x402 payload>

{
  "url": "https://grist.tools/samples/web/render-article.html"
}

Without the payment-signature header the call answers 402 with the payment requirements, including this endpoint's price and its max_timeout_seconds, so the deadline is known before anything is paid. The payment is verified before the handler runs and settled only after it succeeds, so a call refused by the gate, or one that fails inside the handler, is never settled. The single case we cannot state for you is a settlement call that fails without answering: the error message says so when that is what happened.

Response200 OK
200 OK
payment-response: <base64 settlement receipt>

{
  "url": "https://grist.tools/samples/web/render-article.html",
  "source_url": "https://grist.tools/samples/web/render-article.html",
  "final_url": "https://grist.tools/samples/web/render-article.html",
  "http_status": 200,
  "title": "Measuring Rainfall with a Simple Gauge",
  "description": "A short guide to reading a cylinder rain gauge at the same hour every day.",
  "canonical": "https://grist.tools/samples/web/render-article.html",
  "lang": "en",
  "hreflang": [
    {
      "lang": "en",
      "href": "https://grist.tools/samples/web/render-article.html"
    },
    {
      "lang": "x-default",
      "href": "https://grist.tools/samples/web/render-article.html"
    }
  ],
  "hreflang_total": 2,
  "hreflang_truncated": false,
  "favicon": "https://grist.tools/favicon.png",
  "charset": "utf-8",
  "opengraph": {
    "title": "Measuring Rainfall with a Simple Gauge",
    "description": "Read the gauge at eye level, at the same hour, and write the number down.",
    "image": "https://grist.tools/og.png",
    "type": "article",
    "site_name": "Grist Samples",
    "url": "https://grist.tools/samples/web/render-article.html"
  },
  "twitter": {
    "card": "summary_large_image",
    "title": "Measuring Rainfall with a Simple Gauge",
    "description": "Read the gauge at eye level, at the same hour, and write the number down.",
    "image": "https://grist.tools/og.png"
  },
  "robots_meta": "index, follow",
  "fetched_at": "2026-09-01T12:00:00.000Z"
}

Sample file: web/render-article.html. Short English article page about reading a rain gauge, with a nav bar, footer boilerplate and a full head of description, canonical, hreflang, favicon, Open Graph and Twitter tags.

In the sample itself, the document declares language en and the title "Measuring Rainfall with a Simple Gauge"; 1 style element carries 1 CSS rule; the body holds 6 p, 3 a, 3 li, 2 h2, 1 article, 1 footer, 1 h1, 1 header, 1 main, 1 nav and 1 ul elements; no script element; its headings read "Measuring Rainfall with a Simple Gauge", "Placing the gauge" and "Reading the scale"; its 3 links point to render-article.html, render-print.html and render-print.html. Across the whole file, the markup opens 44 tags, 20 of them inside the head.

Response fields

FieldTypeIn the example
urlstring"https://grist.tools/samples/web/render-article.html"
source_urlstring"https://grist.tools/samples/web/render-article.html"
final_urlstring"https://grist.tools/samples/web/render-article.html"
http_statusnumber200
titlestring"Measuring Rainfall with a Simple Gauge"
descriptionstring"A short guide to reading a cylinder rain gauge at the same hour every day."
canonicalstring"https://grist.tools/samples/web/render-article.html"
langstring"en"
hreflangarray2 items, each with lang and href
hreflang_totalnumber2
hreflang_truncatedbooleanfalse
faviconstring"https://grist.tools/favicon.png"
charsetstring"utf-8"
opengraphobjectan object with title, description, image, type, site_name and url
twitterobjectan object with card, title, description and image
robots_metastring"index, follow"
fetched_atstring"2026-09-01T12:00:00.000Z"

Deterministic: the same input returns the same output. Clock-derived fields, when present, are declared in the response.

Call it from code

The client reads the 402, signs the payment and retries on its own.

// page-metadata: $0.002 per call, paid in USD Coin on eip155:8453 via x402
// Install: npm install @x402/fetch@2 @x402/evm@2 viem@2
// Save as client.mjs (ES module, Node 18+), export EVM_PRIVATE_KEY with the paying wallet's key in your shell, then run: node client.mjs
// The wrapper reads the 402 (payment-required), signs and retries with payment-signature.
import { wrapFetchWithPayment, x402Client, decodePaymentResponseHeader } from '@x402/fetch'
import { ExactEvmScheme } from '@x402/evm/exact/client'
import { privateKeyToAccount } from 'viem/accounts'

const account = privateKeyToAccount(process.env.EVM_PRIVATE_KEY)
const client = new x402Client().register('eip155:8453', new ExactEvmScheme(account))
const fetchWithPayment = wrapFetchWithPayment(fetch, client)

const body = {
  "url": "https://grist.tools/samples/web/render-article.html"
}

const res = await fetchWithPayment('https://grist.tools/v1/page-metadata', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify(body),
})
console.log(res.status, await res.json())
const settle = res.headers.get('payment-response')
if (settle) console.log(decodePaymentResponseHeader(settle).transaction)

Errors

Every error is typed JSON. Only a successful call is settled.

CodeHTTPWhen
invalid_input400The body does not match the schema on this page. Nothing is charged. The body does not match the schema; its fields are url.
blocked_target403The destination is refused by the network guard: a disallowed address, or, for HTTP requests, a scheme other than http/https, a port other than 80/443, or credentials in the URL.
unreachable_target424The destination you named did not resolve or refused the connection.
upstream_status424The destination you named answered with a status this endpoint cannot use.
upstream_timeout424The destination you named did not answer before the declared timeout for this endpoint expired.
unsupported_content_type415The destination returned a type this endpoint does not handle.
too_large413The response exceeded the size cap while streaming, or decompressed at more than the allowed ratio.
unprocessable422The bytes arrived but could not be processed, for instance a malformed document.
internal500Our fault, and in almost every case nothing is charged. The exceptions come after the call has run and the settlement call was made: the message "The work was done but settlement could not be completed", and the messages starting with "Payment settlement returned". There, whether the payment moved is unknown to us as well. The payment moves at most once: its nonce is single-use and settlement is idempotent, so a retry with it is never charged twice. A retry is normally refused with a 402: replay_consumed, an expiry reason, or a reason saying the nonce was already used once the transfer is on-chain. Only if our server restarted before the transfer was final can a retry run the call again. Even then, the payment moves at most once. To see whether it was settled, read the EIP-3009 authorizationState of its nonce on-chain; to call again, sign a new payment.
rate_limited429Too many calls from the same payer, or too many calls towards the same destination domain. Nothing is charged.
concurrency_limit,
registry_at_capacity,
upstream_unavailable
503We could not serve the call right now. Retryable: wait the number of seconds in the retry-after header, then repeat the call. concurrency_limit and registry_at_capacity mean we were at capacity: the call did not run. You can send the same payment again if its validBefore is still far enough away to cover another call. If it is not, the retry gets a 402 authorization_validity_too_short: sign a new payment. upstream_unavailable means our internal service failed or did not answer in time: the call may already have run and the payment may have been settled. A retry with the same payment can get a 402 whose error field says why. authorization_validity_too_short: too little time is left before validBefore to cover another call. This check comes before the replay check, so it does not tell whether the first payment was settled. replay_consumed (the payment was used and may have been settled) or replay_exhausted (too many attempts): sign a new payment. replay_in_flight: the first call is still running, so wait and do not pay again. invalid_exact_evm_nonce_already_used: the transfer is already on-chain, so this payment cannot move again. Sign a new payment. An authorization can be settled only once, since its nonce is single-use. To see whether it was settled, read the EIP-3009 authorizationState of its nonce on-chain.
misconfigured503The service is not configured to serve calls. The call did not run and nothing is charged. It needs a fix on our side, so there is no retry delay to wait for.

Input that is rejected before the tool runs (malformed JSON, schema mismatch, body over the size limit) is never charged.

Questions

How much does a call to the Page Metadata API cost?

$0.002 per call, paid in USD Coin on Base via x402. There is no account and no API key: the price is in the 402 answer, before anything is paid.

What is the timeout of page-metadata?

The endpoint itself runs for at most 8 s. max_timeout_seconds in the 402 answer is 29: that covers the whole call, including payment verification and settlement around it.

How large can a response from page-metadata be?

The response-size cap is 3 MB (3,145,728 bytes).

Is the page-metadata input schema free to read?

Yes. GET https://grist.tools/v1/page-metadata/schema returns the input schema for free, paid endpoints included.

What happens if a call to page-metadata fails?

The payment is verified before the handler runs and settled only after it succeeds, so a call refused by the gate, or one that fails inside the handler, is never settled. The single case that cannot be stated in advance is a settlement call that fails without answering: the error message says so when that is what happened.

What does page-metadata return?

A JSON object with 17 top-level fields: url, source_url, final_url, http_status, title, description, canonical, lang, hreflang, hreflang_total, hreflang_truncated, favicon, charset, opengraph, twitter, robots_meta and fetched_at. The example on this page is a real call over web/render-article.html.