GET
/
batch
/
scrape
/
{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 batch scrape job

Response

200 - application/json
status
string

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

total
integer

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

completed
integer

The number of pages that have been successfully scraped.

creditsUsed
integer

The number of credits used for the batch scrape.

expiresAt
string

The date and time when the batch scrape will expire.

next
string | null

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

data
object[]

The data of the batch scrape.