datawebotAPI reference
Review the authenticated datawebot. HTTP API for creating ecommerce extractions, checking request status and retrieving structured results.
Authentication and discovery
Send Authorization: Bearer <key>. Never put credentials in URLs. Account history and results are private to the authenticated account.
GET /api/product/capabilities is public and reports schema version, immediately routable storefronts, operations, limits and retention. Other public ecommerce sources may also be submitted through the same saved request lifecycle.
Extraction endpoints
| Method / path | Purpose |
|---|---|
| POST /api/product/resolve | Normalize URL and infer operation |
| POST /api/product/estimate | Validate scope and obtain cost |
| POST /api/product/runs | Submit with Idempotency-Key |
| GET /api/product/runs | Account extraction history |
| GET /api/product/runs/:id | Status, cost, next action and polling |
| GET /api/product/runs/:id/results?cursor=0 | Products and next_cursor |
| POST /api/product/runs/:id/resume | Confirm an actionable request |
| GET /api/product/account | Identity and available balance |
Request body
operation is product, collection or catalogue. maxPages and maxCredits are required integer hard ceilings from 2 to 25. paginationPages is 1–24 total pages per listing, productPages is 0–23 linked detail pages across the run, and categoryPages is 0–22 other collections. Defaults are 1, 0 and 0. Product scope disables all following. Legacy limit inputs are rejected.
Use an Idempotency-Key of 8–128 letters, numbers, underscores or hyphens. Keep it stable across retries.
The merchant.example URL below is a reserved placeholder. Replace it only with a public URL you are authorized to use and the service currently supports.
{
"url": "https://merchant.example",
"operation": "catalogue",
"maxPages": 2,
"maxCredits": 2
}Errors
{
"error": {
"code": "results_not_ready",
"message": "Results are not ready yet."
}
}| HTTP status | Next step |
|---|---|
| 400 / 415 | Correct input or Content-Type |
| 401 | Replace expired/revoked credentials |
| 402 | Review scope and spending authorization |
| 403 | This credential lacks permission |
| 404 | Request not found for this account |
| 409 | Resolve conflict or wait for results |
| 410 | Results expired or endpoint retired |
| 429 | Honor retry_after or Retry-After |
| 500 / 503 | Retry transport with the same identity |
Session-only actions
Key management, checkout and operator review require an interactive session with the relevant permissions. Bearer keys cannot create more keys or fund accounts, even when sent with a browser cookie.
The public OpenAPI file describes the extraction contract. Check the schema version when updating parsers.
Need help? Contact support.