API Reference - Extralt API

The stable Extralt REST API is available at api.extralt.com. Public v1 requests require an org-scoped API key passed as a Bearer token: Authorization: Bearer <key>.

An active subscription is required for writes. After a subscription ends, the 30-day grace period permits read-only API access and exports. After grace, organization access is suspended; after 180 days, the organization is deactivated. Billing and reactivation remain available through the dashboard while an organization is suspended.

During grace, write-scoped stop and pause operations remain available to reduce risk. Retrying a completed idempotent request returns its stored result, while a new request is rejected with 402 Payment Required. Suspended and deactivated organizations cannot use these data operations.

The generated OpenAPI document is the authoritative reference for request fields, response schemas, status codes, and enums. api.extralt.com/docs provides stable links to that document and these developer guides.

Getting Started

Create an account and subscribe to a plan
Generate an API key from your dashboard
Start making requests under https://api.extralt.com/v1

Create and restart operations require an Idempotency-Key header so that a network retry cannot duplicate work. API keys may carry api:read, api:write, or api:*; use the narrowest scope required by the integration.

Endpoints

Extract

Base path: /v1/extract

Robots

Stable resources for building and running extraction tooling for a specific host and country.

GET/robotsList all robots

POST/robotsCreate a robot and start its build

GET/robots/{id}Read a robot and its build status

DELETE/robots/{id}Delete a robot

Runs

Execution instances of a robot. Each run crawls URLs, extracts data, and tracks progress.

GET/runsList all runs

POST/runsCreate a run

GET/runs/{id}Read a run

POST/runs/{id}/restartRestart a run

POST/runs/{id}/stopStop a run

Captures

Extracted data records from completed runs.

GET/capturesList captures for a run

GET/captures/countCount captures for a run

GET/captures/exportExport captures as Parquet or JSONL

Schedules

Recurring extraction automation. Link a robot to a cadence and Extralt creates runs automatically.

GET/schedulesList all schedules

POST/schedulesCreate a schedule

GET/schedules/{id}Read a schedule

PATCH/schedules/{id}Update a schedule

DELETE/schedules/{id}Delete a schedule

POST/schedules/{id}/pausePause a schedule

POST/schedules/{id}/resumeResume a schedule

Imports

Uploaded catalog files that are validated and converted into Captures.

POST/importsCreate an import

GET/imports/{id}Read import status

Enrich

Base path: /v1/enrich

Enrichments

Enrichment jobs that translate captures to English, classify them with a taxonomy, and extract attributes and signals into structured items.

GET/enrichmentsList all enrichments

POST/enrichmentsCreate an enrichment

GET/enrichments/{id}Read an enrichment

POST/enrichments/{id}/stopStop an enrichment

Items

Enriched item rows produced by an enrichment, with SKUs and transformed offers embedded.

GET/itemsList items produced by an enrichment

GET/items/{item_id}Read an item with embedded SKUs and offers

Explore

Base path: /v1/explore

Evidence views

Beta analytical views over the organization’s Enrich-published dataset.

GET/overviewSummarize dataset coverage

GET/facetsList dataset-backed filter choices

GET/markets/currentCompare current offers by variant

GET/variants/{variant_id}Read a variant with current offers and history