Get Batch Scrape Status

1 min read

get/batch/scrape/{id}

Request example

curl --request GET \
  --url https://api.firecrawl.dev/v1/batch/scrape/{id} \
  --header 'Authorization: Bearer <token>'

Response

{
  "status": "<string>",
  "total": 1,
  "completed": 1,
  "creditsUsed": 1,
  "expiresAt": "2026-08-10T12:00:00Z",
  "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": 1,
        "numPages": 1,
        "totalPages": 1,
        "error": "<string>"
      }
    }
  ]
}

get/batch/scrape/{id}

Note: A new v2 version of this API is now available with improved status tracking and monitoring capabilities.

Authorization

Authorizationstringheaderrequired#

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

Path parameters

idstringrequired#

The ID of the batch scrape job

Responses

application/json

Successful response

statusstring#

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

totalinteger#

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

completedinteger#

The number of pages that have been successfully scraped.

creditsUsedinteger#

The number of credits used for the batch scrape.

expiresAtstring#

The date and time when the batch scrape will expire.

nextstring#

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.

dataobject[]#

The data of the batch scrape.

Show child attributes

markdownstring#

htmlstring#

HTML version of the content on page if includeHtml is true

rawHtmlstring#

Raw HTML content of the page if includeRawHtml is true

linksstring[]#

List of links on the page if includeLinks is true

screenshotstring#

Screenshot of the page if includeScreenshot is true

metadataobject#

Show child attributes

titlestring · string[]#

Title extracted from the page, can be a string or array of strings

Show child attributes

One of

descriptionstring · string[]#

Description extracted from the page, can be a string or array of strings

Show child attributes

One of

languagestring · string[]#

Language extracted from the page, can be a string or array of strings

Show child attributes

One of

sourceURLstring#

keywordsstring · string[]#

Keywords extracted from the page, can be a string or array of strings

Show child attributes

One of

ogLocaleAlternatestring[]#

Alternative locales for the page

<any other metadata> string · string[]#

Other metadata extracted from HTML, can be a string or array of strings

Show child attributes

One of

statusCodeinteger#

The status code of the page

numPagesinteger#

For PDF inputs, the number of pages parsed (capped by the parsers maxPages option).

totalPagesinteger#

For PDF inputs, the document's true page count before any maxPages capping. Omitted when it cannot be determined; a totalPages greater than numPages indicates the result was truncated.

errorstring#

The error message of the page

Batch Scrape Cancel Batch Scrape