Skip to main content
GET
/
batch
/
scrape
/
{id}
Get the status of a batch scrape job
curl --request GET \
  --url https://api.firecrawl.dev/v2/batch/scrape/{id} \
  --header 'Authorization: Bearer <token>'
{
  "status": "<string>",
  "total": 123,
  "completed": 123,
  "creditsUsed": 123,
  "expiresAt": "2023-11-07T05:31:56Z",
  "next": "<string>",
  "data": [
    {
      "markdown": "<string>",
      "html": "<string>",
      "rawHtml": "<string>",
      "links": [
        "<string>"
      ],
      "screenshot": "<string>",
      "metadata": {
        "title": "<string>",
        "description": "<string>",
        "language": "<string>",
        "sourceURL": "<string>",
        "keywords": "<string>",
        "ogLocaleAlternate": [
          "<string>"
        ],
        "<any other metadata> ": "<string>",
        "statusCode": 123,
        "error": "<string>"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

The ID of the batch scrape job

Response

Successful 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<date-time>

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.