# Structured Data Extract API

> Fetches a web page and returns its embedded machine-readable data -- JSON-LD, OpenGraph, microdata and meta tags -- plus a normalised merge across all four.

- Endpoint: `POST https://grist.tools/v1/structured-data-extract`
- Price: $0.002 per successful call, paid via x402 in USDC on Base
- Timeout: 8 s; max_timeout_seconds in the 402: 29 (the timeout plus payment verification and settlement)
- Response cap: 5 MB (5,242,880 bytes)
- Family: [Fetch & extract](https://grist.tools/tools/fetch)
- Input schema, free: https://grist.tools/v1/structured-data-extract/schema
- Updated: 2026-11-13

## When to use it

It needs the network and a real DOM, and the extraction is the code an agent keeps re-implementing wrong: skipping a broken JSON-LD script instead of throwing, telling og: from name= apart, and walking microdata with its parent/child nesting rule. One call replaces four brittle scrapers.

## When not to use it

- The input is over 5 MB (5,242,880 bytes): structured-data-extract 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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `url` | string | yes | Absolute http(s) URL of the HTML or XHTML page to read, up to 2048 characters; up to 5 redirects are followed and relative URLs resolve against the final URL or its <base href>. |
| `types` | array | no | Which of jsonld, opengraph, microdata and meta to extract, at least one; omitted means all four, and a type not requested comes back null and is left out of the normalized merge. |

## Limits

| Limit | Value |
| --- | --- |
| Size cap | 5 MB (5,242,880 bytes) |
| Timeout | 8 s |

## Example

Request:

```http
POST /v1/structured-data-extract
content-type: application/json
payment-signature: <base64 x402 payload>

{
  "url": "https://grist.tools/samples/web/fieldnotes/notes/first-frost.html"
}
```

Response (200 OK, with a payment-response settlement receipt header):

```json
{
  "url": "https://grist.tools/samples/web/fieldnotes/notes/first-frost.html",
  "source_url": "https://grist.tools/samples/web/fieldnotes/notes/first-frost.html",
  "final_url": "https://grist.tools/samples/web/fieldnotes/notes/first-frost.html",
  "http_status": 200,
  "jsonld": [
    {
      "@context": "https://schema.org",
      "@type": "Article",
      "headline": "The first frost of the season",
      "description": "A light ground frost on the lower beds, measured at dawn.",
      "image": "../icon-32.png",
      "datePublished": "2026-08-24T06:30:00Z",
      "author": {
        "@type": "Organization",
        "name": "Field Notes Editors"
      }
    }
  ],
  "jsonld_total": 1,
  "jsonld_truncated": false,
  "jsonld_parse_errors": 0,
  "opengraph": {
    "og:title": "The first frost of the season",
    "og:type": "article",
    "og:url": "https://grist.tools/samples/web/fieldnotes/notes/first-frost.html",
    "og:image": "https://grist.tools/samples/web/fieldnotes/icon-32.png"
  },
  "microdata": [
    {
      "type": "https://schema.org/Place",
      "properties": {
        "name": "Lower beds",
        "description": "The lowest corner of the garden, where cold air settles first."
      }
    }
  ],
  "microdata_total": 1,
  "microdata_truncated": false,
  "meta": {
    "description": "A light ground frost on the lower beds, measured at dawn.",
    "author": "Field Notes Editors",
    "article:published_time": "2026-08-24T06:30:00Z"
  },
  "normalized": {
    "title": "The first frost of the season",
    "description": "A light ground frost on the lower beds, measured at dawn.",
    "image": "https://grist.tools/samples/web/fieldnotes/icon-32.png",
    "type": "Article",
    "author": "Field Notes Editors",
    "published": "2026-08-24T06:30:00Z"
  },
  "fetched_at": "2026-09-01T12:00:00.000Z"
}
```

Sample file: web/fieldnotes/notes/first-frost.html. Field Notes article page carrying an Article JSON-LD script, OpenGraph and author meta tags, and one schema.org Place microdata item.

Response fields:

| Field | Type | In the example |
| --- | --- | --- |
| `url` | string | "https://grist.tools/samples/web/fieldnotes/notes/first-frost.html" |
| `source_url` | string | "https://grist.tools/samples/web/fieldnotes/notes/first-frost.html" |
| `final_url` | string | "https://grist.tools/samples/web/fieldnotes/notes/first-frost.html" |
| `http_status` | number | 200 |
| `jsonld` | array | 1 item, each with @context, @type, headline, description, image, datePublished and author |
| `jsonld_total` | number | 1 |
| `jsonld_truncated` | boolean | false |
| `jsonld_parse_errors` | number | 0 |
| `opengraph` | object | an object with og:title, og:type, og:url and og:image |
| `microdata` | array | 1 item, each with type and properties |
| `microdata_total` | number | 1 |
| `microdata_truncated` | boolean | false |
| `meta` | object | an object with description, author and article:published_time |
| `normalized` | object | an object with title, description, image, type, author and published |
| `fetched_at` | string | "2026-09-01T12:00:00.000Z" |

## Call it from code

```js
// structured-data-extract: $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/fieldnotes/notes/first-frost.html"
}

const res = await fetchWithPayment('https://grist.tools/v1/structured-data-extract', {
  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)
```

```python
# structured-data-extract: $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/fieldnotes/notes/first-frost.html"
}

res = session.post("https://grist.tools/v1/structured-data-extract", json=payload)
print(res.status_code, res.json())
settle = res.headers.get("payment-response")
if settle:
    print(decode_payment_response_header(settle).transaction)
```

```sh
# structured-data-extract: $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/structured-data-extract' -H 'content-type: application/json' -d '{"url":"https://grist.tools/samples/web/fieldnotes/notes/first-frost.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/structured-data-extract' -H 'content-type: application/json' -H 'payment-signature: <base64 x402 payload>' -d '{"url":"https://grist.tools/samples/web/fieldnotes/notes/first-frost.html"}'
```

## Errors

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

| Code | HTTP | When |
| --- | --- | --- |
| `invalid_input` | 400 | The body does not match the schema on this page. Nothing is charged. |
| `blocked_target` | 403 | The 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_target` | 424 | The destination you named did not resolve or refused the connection. |
| `upstream_status` | 424 | The destination you named answered with a status this endpoint cannot use. |
| `upstream_timeout` | 424 | The destination you named did not answer before the declared timeout for this endpoint expired. |
| `unsupported_content_type` | 415 | The destination returned a type this endpoint does not handle. |
| `too_large` | 413 | The response exceeded the size cap while streaming, or decompressed at more than the allowed ratio. |
| `unprocessable` | 422 | The bytes arrived but could not be processed, for instance a malformed document. |
| `internal` | 500 | Our 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_limited` | 429 | Too 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` | 503 | We 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. |
| `misconfigured` | 503 | The 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. |

## Questions

### How much does a call to the Structured Data Extract 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 structured-data-extract?

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 structured-data-extract be?

The response-size cap is 5 MB (5,242,880 bytes).

### Is the structured-data-extract input schema free to read?

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

### What happens if a call to structured-data-extract 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 structured-data-extract return?

A JSON object with 15 top-level fields: url, source_url, final_url, http_status, jsonld, jsonld_total, jsonld_truncated, jsonld_parse_errors, opengraph, microdata, microdata_total, microdata_truncated, meta, normalized and fetched_at. The example on this page is a real call over web/fieldnotes/notes/first-frost.html.

## Related

- [Fetch & extract APIs](https://grist.tools/tools/fetch)
- [Turning web pages into LLM-ready text](https://grist.tools/guides/web-to-markdown-for-llms)
- [How AI agents pay for APIs with x402](https://grist.tools/guides/x402-payments-for-ai-agents)
- [All APIs](https://grist.tools/docs)

This page as HTML: https://grist.tools/docs/structured-data-extract. Every page of grist.tools has a Markdown version at its address plus .md.
