# Well-Known Fetch API

> Fetches and parses a domain's well-known files -- security.txt (RFC 9116), ads.txt and humans.txt -- returning typed fields, seller records and a cross-file summary in one call.

- Endpoint: `POST https://grist.tools/v1/wellknown-fetch`
- Price: $0.002 per successful call, paid via x402 in USDC on Base
- Timeout: 12 s; max_timeout_seconds in the 402: 33 (the timeout plus payment verification and settlement)
- Response cap: 2 MB (2,097,152 bytes)
- Family: [Feeds & site structure](https://grist.tools/tools/feeds)
- Input schema, free: https://grist.tools/v1/wellknown-fetch/schema
- Updated: 2026-11-13

## When to use it

It needs the network and a hardened client: the files are named by a stranger, so a naive fetch of /ads.txt is an SSRF probe, and the value is the parse -- PGP-signed security.txt fields, ads.txt split into DIRECT/RESELLER records -- an agent would otherwise build and maintain itself.

## When not to use it

- The input is over 2 MB (2,097,152 bytes): wellknown-fetch answers too_large (413).
- The destination needs more than 12 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 |
| --- | --- | --- | --- |
| `domain` | string | yes | Fully qualified domain name whose files are fetched over https, up to 253 characters; it is trimmed, lowercased and stripped of trailing dots, and IP literals, single-label names and private suffixes are refused. |
| `files` | array | no | Which files to fetch, from security.txt (read at /.well-known/security.txt), ads.txt and humans.txt (read at the root); duplicates collapse, and the default is all three. |

## Limits

| Limit | Value |
| --- | --- |
| Size cap | 2 MB (2,097,152 bytes) |
| Timeout | 12 s |

## Example

Request:

```http
POST /v1/wellknown-fetch
content-type: application/json
payment-signature: <base64 x402 payload>

{
  "domain": "example.com"
}
```

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

```json
{
  "domain": "example.com",
  "files_requested": [
    "security.txt",
    "ads.txt",
    "humans.txt"
  ],
  "security_txt": {
    "requested": true,
    "present": true,
    "status": 200,
    "url": "https://example.com/.well-known/security.txt",
    "contact": [
      "mailto:security@example.com",
      "https://example.com/security-contact"
    ],
    "expires": "2027-01-01T00:00:00.000Z",
    "is_expired": false,
    "encryption": [
      "https://example.com/pgp-key.txt"
    ],
    "acknowledgments": [
      "https://example.com/hall-of-fame"
    ],
    "preferred_languages": "en, fr",
    "canonical": [
      "https://example.com/.well-known/security.txt"
    ],
    "policy": [
      "https://example.com/security-policy"
    ],
    "hiring": [
      "https://example.com/jobs"
    ],
    "signed": false,
    "field_count": 9
  },
  "ads_txt": {
    "requested": true,
    "present": true,
    "status": 200,
    "url": "https://example.com/ads.txt",
    "records": [
      {
        "advertising_system": "greenadexchange.com",
        "publisher_id": "12345",
        "relationship": "DIRECT",
        "certification_authority_id": "d75815a79",
        "line": 4
      },
      {
        "advertising_system": "blueadexchange.com",
        "publisher_id": "xf7",
        "relationship": "RESELLER",
        "certification_authority_id": null,
        "line": 5
      },
      {
        "advertising_system": "silverssp.com",
        "publisher_id": "9675",
        "relationship": "DIRECT",
        "certification_authority_id": null,
        "line": 6
      }
    ],
    "records_total": 3,
    "records_truncated": false,
    "direct_count": 2,
    "reseller_count": 1,
    "variables": [
      {
        "name": "CONTACT",
        "value": "adops@example.com"
      }
    ],
    "variables_truncated": false,
    "invalid_lines": 0
  },
  "humans_txt": {
    "requested": true,
    "present": true,
    "status": 200,
    "url": "https://example.com/humans.txt",
    "text": "/* TEAM */\nWebmaster: Jane Doe\nSite: example.com\n\n/* THANKS */\nEveryone.\n",
    "truncated": false,
    "bytes": 73
  },
  "normalised": {
    "files_present": [
      "ads.txt",
      "humans.txt",
      "security.txt"
    ],
    "security_contacts": [
      "mailto:security@example.com",
      "https://example.com/security-contact"
    ],
    "security_expires": "2027-01-01T00:00:00.000Z",
    "security_expired": false,
    "security_signed": false,
    "ads_sellers": 3,
    "ads_direct": 2,
    "ads_reseller": 1
  },
  "fetched_at": "2026-08-26T18:00:00.000Z"
}
```

This example is illustrative: it shows the exact shape the handler returns, but it was not produced by a reproducible call, because the real answer depends on live network data that changes over time.

Response fields:

| Field | Type | In the example |
| --- | --- | --- |
| `domain` | string | "example.com" |
| `files_requested` | array | 3 items |
| `security_txt` | object | an object with requested, present, status, url, contact, expires, is_expired, encryption, acknowledgments, preferred_languages, canonical, policy, hiring, signed and field_count |
| `ads_txt` | object | an object with requested, present, status, url, records, records_total, records_truncated, direct_count, reseller_count, variables, variables_truncated and invalid_lines |
| `humans_txt` | object | an object with requested, present, status, url, text, truncated and bytes |
| `normalised` | object | an object with files_present, security_contacts, security_expires, security_expired, security_signed, ads_sellers, ads_direct and ads_reseller |
| `fetched_at` | string | "2026-08-26T18:00:00.000Z" |

## Call it from code

```js
// wellknown-fetch: $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 = {
  "domain": "example.com"
}

const res = await fetchWithPayment('https://grist.tools/v1/wellknown-fetch', {
  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
# wellknown-fetch: $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 = {
    "domain": "example.com"
}

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

```sh
# wellknown-fetch: $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/wellknown-fetch' -H 'content-type: application/json' -d '{"domain":"example.com"}'

# 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/wellknown-fetch' -H 'content-type: application/json' -H 'payment-signature: <base64 x402 payload>' -d '{"domain":"example.com"}'
```

## 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_timeout` | 424 | The destination you named did not answer before the declared timeout for this endpoint expired. |
| `too_large` | 413 | The response exceeded the size cap while streaming, or decompressed at more than the allowed ratio. |
| `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 Well-Known Fetch 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 wellknown-fetch?

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

### How large can a response from wellknown-fetch be?

The response-size cap is 2 MB (2,097,152 bytes).

### Is the wellknown-fetch input schema free to read?

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

### What happens if a call to wellknown-fetch 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 wellknown-fetch return?

A JSON object with 7 top-level fields: domain, files_requested, security_txt, ads_txt, humans_txt, normalised and fetched_at. The example on this page is illustrative, not a recorded call.

## Related

- [Feeds & site structure APIs](https://grist.tools/tools/feeds)
- [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/wellknown-fetch. Every page of grist.tools has a Markdown version at its address plus .md.
