Skip to content

Overview

Scraping orchestration API. Route requests across multiple providers (Bright Data, Oxylabs, Nimble Way, Zyte, Decodo) with automatic fallback, cost optimization, structured extraction, and warehouse delivery.

Authentication

Every request requires a Bearer token: a JWT from the dashboard or an sr_* API key from Settings → API Keys. New orgs get a default key on signup that survives until you revoke it.

Errors

Most endpoints emit JSON errors via { "error": "<message>" }. CLI and MCP clients that send Accept: application/vnd.justcrawl.v1+json receive a structured shape: { "error": { "code", "message", "docs_url", "request_id" } } (see https://docs.justcrawl.io/guides/errors).

The /api/v1/bi/* endpoints are the exception: every error a BI handler produces is that structured envelope, regardless of the Accept header — see the BiError schema. BI carries its own code vocabulary on top of the shared one; every BI code is tabulated at https://docs.justcrawl.io/guides/errors/bi, which is where their docs_url points. The one exception to the exception: 401s from missing/invalid auth are rejected by shared middleware before any BI handler runs, so they still carry the flat { "error": "<message>" } shape — see the Unauthorized response on each operation, not BiForbidden.

Rate limits

Per-org quota gates apply to POST /api/v1/jobs and other write paths. Token-bucket X-RateLimit-* headers ship in a future release; today the gate emits 402 Insufficient credits when an org’s quota is exhausted.

JWT access token or API key. Get an API key from Settings > API Keys.

Security scheme type: http

Bearer format: JWT