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.

Autenticación

Las solicitudes se autenticarán con una clave de API generada desde su panel de control, enviada como un token bearer:

Authorization: Bearer {api_key}

Endpoints planificados

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.

Ejemplo de respuesta

{
  "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. Contáctenos if you have questions.