API Reference

REST API reference for Prefetch. All endpoints accept GET requests and return JSON.

Base URL

https://api.prefetch.io

Authentication

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.

Response format

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
  }
}

Credit costs

Endpoint	Credits
GET /enrich	3
GET /brand	2
GET /company	2
GET /classify	1
GET /screenshot	1
GET /health	—
GET /ready	—

Credits are deducted only on successful responses. See Credits.

Rate limits

• Global: 300 requests per minute per IP
• Per key: Configurable sliding window (1-minute) set on your API key

Exceeding either limit returns HTTP 429. See Rate limits.

Endpoints

GET /enrich

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

GET /brand

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

GET /company

Company name, emails, and addresses. 2 credits.

GET /classify

IAB category and description. 1 credit.

GET /screenshot

Webpage screenshot URL. 1 credit.

GET /health

Liveness probe. Free.