Prospect demo — Supadata (unofficial)
GET/web/crawl/{jobId}

Get website crawl status and results

Retrieves the status and results of a website crawl job. Use jobId to identify the crawl and skip to request results starting at an offset. The response includes crawled pages when the job is completed and a next URL when more results are available.

2 parameters
jobIdstringrequired
The identifier of the crawl job to retrieve.
skipnumberoptional
Offset from which to return crawl results. Must be 0 or greater.

3 status codes
200Returns the crawl job status and, when the status is completed, a list of crawled pages. Includes a `next` URL when more pages are available.
statusstringrequired
The status of the crawl job
Allowed:scrapingcompletedfailedcancelled
pagesarray<object>optional
List of pages that were crawled (only present when status is completed)
nextstringoptional
URL for fetching the next page of results (the same endpoint with a `skip` offset). Only present when more pages are available.
400Returned when the crawl status request is invalid.
errorstringrequired
Error code identifying the type of error
Allowed:invalid-requestinternal-errorforbiddenunauthorizedupgrade-requiredtranscript-unavailablenot-foundlimit-exceeded
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
500Returned when an internal error occurs.
errorstringrequired
Error code identifying the type of error
Allowed:invalid-requestinternal-errorforbiddenunauthorizedupgrade-requiredtranscript-unavailablenot-foundlimit-exceeded
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation

Error handling

A 400 indicates an invalid request, and a 500 indicates an internal error. The jobId path parameter identifies the crawl job, and skip must be 0 or greater.