Get batch scrape status

Get the status of a batch scrape job

Endpoint

GET /v1/batch/scrape/{id}

Authentication

This endpoint requires authentication using a Bearer token. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Path Parameters

id · string · required

The ID of the batch scrape job (UUID format)

Response

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 (ISO 8601 format).

next · string

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 · array

The data of the batch scrape.

Show items

markdown · string

The main content in markdown format

html · string

HTML version of the content on page if includeHtml is true

rawHtml · string

Raw HTML content of the page if includeRawHtml is true

links · array

List of links on the page if includeLinks is true

screenshot · string

Screenshot of the page if includeScreenshot is true

metadata · object

Page metadata including title, description, sourceURL, statusCode, and other properties

Examples

cURL

curl -X GET https://api.firecrawl.dev/v1/batch/scrape/550e8400-e29b-41d4-a716-446655440000 \
  -H 'Authorization: Bearer YOUR_API_KEY'

Error Responses

402 · object

Payment Required - Payment required to access this resource.

{
  "error": "Payment required to access this resource."
}

429 · object

Too Many Requests - Request rate limit exceeded.

{
  "error": "Request rate limit exceeded. Please wait and try again later."
}

500 · object

Server Error - An unexpected error occurred on the server.

{
  "error": "An unexpected error occurred on the server."
}