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.
- Endpoint
POST /v1/page-metadata- Price
- $0.002 per call
- Family
- Fetch & extract
01When 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).
02Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| url | string | yes | 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>. |
03Limits
| Limit | Value |
|---|---|
| Size cap | 3 MB (3,145,728 bytes) |
| Timeout | 8 s |
04Example
The published example of page-metadata, verbatim: the request body and the response it returns.
POST /v1/page-metadata
content-type: application/json
payment-signature: <base64 x402 payload>
{
"url": "https://grist.tools/samples/web/render-article.html"
}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 field | Type | In the example |
|---|---|---|
| url | string | "https://grist.tools/samples/web/render-article.html" |
| source_url | string | "https://grist.tools/samples/web/render-article.html" |
| final_url | string | "https://grist.tools/samples/web/render-article.html" |
| http_status | number | 200 |
| title | string | "Measuring Rainfall with a Simple Gauge" |
| description | string | "A short guide to reading a cylinder rain gauge at the same hour every day." |
| canonical | string | "https://grist.tools/samples/web/render-article.html" |
| lang | string | "en" |
| hreflang | array | 2 items, each with lang and href |
| hreflang_total | number | 2 |
| hreflang_truncated | boolean | false |
| favicon | string | "https://grist.tools/favicon.png" |
| charset | string | "utf-8" |
| opengraph | object | an object with title, description, image, type, site_name and url |
| object | an object with card, title, description and image | |
| robots_meta | string | "index, follow" |
| fetched_at | string | "2026-09-01T12:00:00.000Z" |
05Call it from code
// 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)# page-metadata: $0.002 per call, paid in USD Coin on eip155:8453 via x402
# Install: pip install "x402[requests,evm]>=2.24,<3"
# The session reads the 402 (payment-required), signs and retries with payment-signature.
import os
from eth_account import Account
from x402 import x402ClientSync
from x402.http import decode_payment_response_header
from x402.http.clients.requests import x402_requests
from x402.mechanisms.evm.exact import register_exact_evm_client
from x402.mechanisms.evm.signers import EthAccountSigner
account = Account.from_key(os.environ["EVM_PRIVATE_KEY"])
client = x402ClientSync()
register_exact_evm_client(client, EthAccountSigner(account), networks="eip155:8453")
session = x402_requests(client)
payload = {
"url": "https://grist.tools/samples/web/render-article.html"
}
res = session.post("https://grist.tools/v1/page-metadata", json=payload)
print(res.status_code, res.json())
settle = res.headers.get("payment-response")
if settle:
print(decode_payment_response_header(settle).transaction)# page-metadata: $0.002 per call, paid in USD Coin on eip155:8453 via x402
# 1. Unpaid call: HTTP 402, the requirements in the payment-required header (base64 JSON) and in the body.
curl -i -X POST 'https://grist.tools/v1/page-metadata' -H 'content-type: application/json' -d '{"url":"https://grist.tools/samples/web/render-article.html"}'
# 2. Same call with the signed payment (an EIP-3009 authorization, EIP-712 signed: it cannot be
# typed by hand). x-payment is accepted as the v1 alternative. HTTP 200 carries payment-response.
curl -i -X POST 'https://grist.tools/v1/page-metadata' -H 'content-type: application/json' -H 'payment-signature: <base64 x402 payload>' -d '{"url":"https://grist.tools/samples/web/render-article.html"}'06Errors
| Code | HTTP | For this service |
|---|---|---|
| invalid_input | 400 | The body does not match the schema; its fields are url. |
| blocked_target | 403 | |
| unreachable_target | 424 | |
| upstream_status | 424 | |
| upstream_timeout | 424 | |
| unsupported_content_type | 415 | |
| too_large | 413 | |
| unprocessable | 422 | |
| internal | 500 |
Input that is rejected before the tool runs (malformed JSON, schema mismatch, body over the size limit) is never charged.
When each code is raised, and what it means for payment: /docs/page-metadata.
07Questions
- How much does a page-metadata call cost?
- $0.002 per call, paid in USDC on Base via x402, with no account and no API key.
- 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.
- What happens when a page-metadata call fails?
- The tool answers with a typed JSON error from the errors table. Payment is settled only after the tool has produced its result; a call that fails inside the tool is never settled. A 503 upstream_unavailable can follow a settled call; the x402 payments guide covers it, 429, 402 and an uncertain 500.