Quickstart

1. Get an API key

Sign in to the dashboard, open Settings → API keys, and create a key. It looks like oc_live_…. Treat it like a password.

2. Create a crawl job

Send your websites to the API. config.max_depth controls how many link levels to follow (0 = the entry page only).

curl https://api.orbicrawl.com/api/v1/jobs \
  -H "X-API-Key: oc_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme batch",
    "urls": ["https://acme.com", "https://globex.com"],
    "config": { "max_depth": 1, "use_browser_rendering": false }
  }'

The response includes the job id and a status of queued.

3. Poll until it finishes

curl https://api.orbicrawl.com/api/v1/jobs/JOB_ID -H "X-API-Key: oc_live_..."

status moves queued → running → completed.

4. Read the leads

curl "https://api.orbicrawl.com/api/v1/leads?job_id=JOB_ID" \
  -H "X-API-Key: oc_live_..."

Each lead carries the extracted contacts plus an enrichment object (email deliverability, domain intel, company firmographics, SEO/quality, AI and ICP).

5. Export

curl -X POST https://api.orbicrawl.com/api/v1/jobs/JOB_ID/export \
  -H "X-API-Key: oc_live_..." \
  -H "Content-Type: application/json" \
  -d '{"format":"csv"}'

Returns a short-lived presigned download URL (csv, xlsx or json).