GET
/
crawl
/
{id}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The ID of the crawl job

Response

200 - application/json
status
string

The current status of the crawl. Can be scraping, completed, or failed.

total
integer

The total number of pages that were attempted to be crawled.

completed
integer

The number of pages that have been successfully crawled.

creditsUsed
integer

The number of credits used for the crawl.

expiresAt
string

The date and time when the crawl will expire.

next
string | null

The URL to retrieve the next 10MB of data. Returned if the crawl is not completed or if the response is larger than 10MB.

data
object[]

The data of the crawl.

CrawlCancel Crawl