API Reference - Prefetch API

Base URL

https://api.prefetch.io

All endpoints (except /health and /ready) require an X-API-Key header.

curl https://api.prefetch.io/classify?url=https://example.com \
  -H "X-API-Key: your_api_key"

See Authentication for full details including first-party origin injection.

Every response uses a consistent envelope:

{
  "success": true,
  "data": { },
  "meta": {
    "requestId": "uuid-v4",
    "durationMs": 1234
  }
}

On error, success is false and data is replaced by error:

{
  "success": false,
  "error": "Credit limit exceeded",
  "meta": {
    "requestId": "uuid-v4",
    "durationMs": 8
  }
}

Credits are deducted only on successful responses. See Credits.

Exceeding either limit returns HTTP 429. See Rate limits.

Brand + company + classification in one call. 20 credits.

Colors, logos, fonts, and social links. 10 credits.

Company name, emails, and addresses. 5 credits.

IAB category, descriptions, tickers, and ISINs. 5 credits.

Webpage screenshot URL. 2 credits.

Liveness probe. Free.