API Reference

The Extralt REST API is available at api.extralt.com for users with an active subscription. All requests require an API key passed as a Bearer token: Authorization: Bearer <key>.

For the full reference with request/response schemas and examples, visit api.extralt.com/docs.

Getting Started

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

Endpoints

Extract

Available Now

Base path: /v1/extract

Robot Builds

Build jobs that generate robots. Track status from pending through building to completed or failed.

GET/robot-builds
POST/robot-builds
GET/robot-builds/{id}
DELETE/robot-builds/{id}
POST/robot-builds/{id}/stop

Robots

AI-generated crawlers compiled to Rust. Each robot targets a specific host and country.

GET/robots
PATCH/robots/{id}
DELETE/robots/{id}

Runs

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

GET/runs
POST/runs
GET/runs/{id}
GET/runs/{id}/download
POST/runs/{id}/restart
POST/runs/{id}/stop

Captures

Extracted data records from completed runs.

GET/captures/{id}

Enrich

Coming Soon

Normalize extracted data to English, classify with industry-standard taxonomies, and generate embeddings for matching.

Extend

Coming Soon

Build relationships across products: alternate listings, alternative products, and complements.

Explore

Coming Soon

Query single products, traverse relationships, or run market-wide aggregations and analytics.