API documentation

A REST API for creating and managing scraping jobs programmatically — submit a target URL, check job status, and retrieve results. Generate a key from your dashboard and see the code examples on the homepage to get started.

Authentication

Requests will be authenticated with an API key generated from your dashboard, sent as a bearer token:

Authorization: Bearer {api_key}

Planned endpoints

POST /api/v1/scrape — Create a new scraping job. Body: target_url (required), scraping_template_id (optional), output_format (optional: json, html, markdown, csv).

GET /api/v1/scrape/{'{job}'} — Check a scraping job's status.

GET /api/v1/scrape/{'{job}'}/result — Retrieve the result once the job has completed.

Example response

{
  "job_id": 128,
  "status": "completed",
  "target_url": "https://example.com",
  "output_format": "json",
  "created_at": "2026-08-21T10:00:00+00:00",
  "completed_at": "2026-08-21T10:00:02+00:00"
}

Generate an API key from your dashboard's API Keys page to get started. Get in touch if you have questions.