Base URL
Authentication
All endpoints (except/health and /ready) require an X-API-Key header.
Response format
Every response uses a consistent envelope:success is false and data is replaced by error:
Credit costs
Credits are deducted only on successful responses. See Credits.
Asynchronous endpoints
Every endpoint answers in one round trip except/crawl. A crawl runs for minutes, so POST /crawl returns 202 with a job id and you poll GET /crawl/{id} for results. See POST /crawl.
Rate limits
- Global: 300 requests per minute per IP
- Per key: Configurable sliding window (1-minute) set on your API key
Endpoints
GET /enrich
Brand + company + classification in one call. 20 credits.
GET /brand
Colors, logos, fonts, and social links. 10 credits.
GET /company
Company name, emails, and addresses. 5 credits.
GET /classify
IAB category, descriptions, tickers, and ISINs. 5 credits.
GET /scrape
Page content as markdown, summary, HTML, links, images, or JSON. 3 credits.
GET /map
Every URL a site exposes. 3 credits.
POST /crawl
Crawl a whole site. 3 credits + 3 per page.
GET /screenshot
Webpage screenshot URL. 2 credits.
GET /health
Liveness probe. Free.