Favicon Extract API

Discovers a page's favicons and returns the best one decoded to a normalised PNG with its size.

Updated

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

Endpoint
POST /v1/favicon-extract
Price
$0.003 per call
Timeout
45 s
max_timeout_seconds
66 (the whole call as the 402 envelope sells it: the timeout, plus payment verification and settlement around it)
Response cap
25 MB (26,214,400 bytes)
Family
Images

When to use it

It fans out over URLs a page author wrote and must decode several icon formats: an agent that does this itself walks past every SSRF control and becomes a request amplifier, and hand-rolling ICO/SVG decoding is not inline work.

When not to use it

  • The input is over 25 MB (26,214,400 bytes): favicon-extract answers too_large (413).
  • The destination needs more than 45 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/favicon-extract/schema.

FieldTypeRequiredDescription
urlstringyesAbsolute http(s) URL of the web page whose icon <link> tags (rel icon, shortcut, apple-touch-icon or mask-icon) are read, up to 2048 characters; /favicon.ico on its origin is added as a last candidate and icons are only fetched from the same registrable domain.

Limits

LimitValue
Size cap25 MB (26,214,400 bytes)
Timeout45 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 the web page whose icon <link> tags (rel icon, shortcut, apple-touch-icon or mask-icon) are read, up to 2048 characters; /favicon.ico on its origin is added as a last candidate and icons are only fetched from the same registrable domain."
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}

Example

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

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

{
  "url": "https://grist.tools/samples/web/fieldnotes/index.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>

{
  "page_url": "https://grist.tools/samples/web/fieldnotes/index.html",
  "icons": [
    {
      "url": "https://grist.tools/samples/web/fieldnotes/icon-32.png",
      "rel": "icon",
      "type": "image/png",
      "sizes": "32x32"
    },
    {
      "url": "https://grist.tools/samples/web/fieldnotes/icon.svg",
      "rel": "icon",
      "type": "image/svg+xml",
      "sizes": null
    },
    {
      "url": "https://grist.tools/favicon.ico",
      "rel": "icon",
      "type": null,
      "sizes": null
    }
  ],
  "selected": {
    "url": "https://grist.tools/samples/web/fieldnotes/icon-32.png",
    "source_format": "png",
    "width": 32,
    "height": 32,
    "bytes": 106,
    "image_base64": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAIAAAD8GO2jAAAACXBIWXMAAAsSAAALEgHS3X78AAAAMUlEQVRIx2PQjw2gKWIYtWDUgiFswaf3z0hCoxaMWjBqwagFoxYMTwtGq8xRC0aQBQBMN1tMlMrjbQAAAABJRU5ErkJggg=="
  }
}

Sample file: web/fieldnotes/index.html. Sample file: web/fieldnotes/icon-32.png. 32x32 RGB PNG favicon of the Field Notes sample site, built byte by byte with node:zlib. Sample file: web/fieldnotes/icon.svg. SVG favicon of the Field Notes sample site, the same drawing as icon-32.png.

Response fields

FieldTypeIn the example
page_urlstring"https://grist.tools/samples/web/fieldnotes/index.html"
iconsarray3 items, each with url, rel, type and sizes
selectedobjectan object with url, source_format, width, height, bytes and image_base64

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.

// favicon-extract: $0.003 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/index.html"
}

const res = await fetchWithPayment('https://grist.tools/v1/favicon-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)

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_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 Favicon Extract API cost?

$0.003 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 favicon-extract?

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

How large can a response from favicon-extract be?

The response-size cap is 25 MB (26,214,400 bytes).

Is the favicon-extract input schema free to read?

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

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

A JSON object with 3 top-level fields: page_url, icons and selected. The example on this page is a real call over web/fieldnotes/index.html, web/fieldnotes/icon-32.png and web/fieldnotes/icon.svg.