Skip to main content
GET
JavaScript
0 Credits

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <API_KEY>, where <API_KEY> is your api key.

Path Parameters

batch_id
string
required

ID of the batch to retrieve or cancel.

Example:

"batch_9f2c8a"

Query Parameters

limit
integer

Records per page. Defaults to 25. A page can close early so its payload stays under ~8 MB; rely on next_cursor rather than counting records.

Required range: 1 <= x <= 100
cursor
string

next_cursor from the previous page.

Response

One page of result records. Keep paging with next_cursor while has_more is true.

data
(Scraped page · object | Failed page · object)[]

Result records on this page.

A page the batch fetched successfully.

has_more
boolean

Whether another page is available.

next_cursor
string | null

Cursor for the next page.

key_metadata
object

Metadata about the API key used for the request. Included in every response whenever a valid API key is provided, even when the response status is not 200.