Skip to main content
GET

Pages

Poll until status is completed, failed or cancelled, then call next until it is gone. An answer holds up to 100 finished pages or 2 MB, and a page’s URL is in metadata.url. See Read the results. failed counts the pages that could not be read. errors lists the failed pages in this answer, and error is set only when the whole job failed. Batch scrape errors lists every failed page.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Query Parameters

maxTextLength
integer

Cut every text value in the response to this many characters. A value that was cut ends with …, and a page whose text was cut has isTruncated set to true. A screenshot is never cut. Leave it out to get the full text.

Required range: x >= 1
checkpoint
string

Send ck_start to start reading with checkpoints. Send the returned checkpoint here to resume, even when no more pages are ready.

Pattern: ^(?:ck_(?:start|[A-Za-z0-9_-]{20,32}))$
cursor
string

The cursor from the previous response. Send it as is.

Minimum string length: 1

Response

The data, and what this call cost in dollars.

success
boolean
required
status
enum<string>
required
Available options:
scraping,
completed,
failed,
cancelled
total
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
completed
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
failed
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
errors
object[]
required
creditsUsed
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
costUsd
number
required
data
object[]
required
queuePosition
integer
Required range: -9007199254740991 <= x <= 9007199254740991
error
string
createdAt
string
completedAt
string
duration
number
expiresAt
string
next
string
checkpoint
string