Get Crawl Status

Get the status and results of a crawl job

GET /v1/crawl/

Retrieve the status and results of a crawl job using its 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 crawl job (UUID format)

Response

status · string

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

total · integer

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

completed · integer

The number of pages that have been successfully crawled.

creditsUsed · integer

The number of credits used for the crawl.

expiresAt · string

The date and time when the crawl will expire (ISO 8601 format).

next · string

The URL to retrieve the next 10MB of data. Returned if the crawl is not completed or if the response is larger than 10MB.

data · array

The crawled page data. Each item contains:

Show data item properties

markdown · string

Markdown content of the page

html · string

HTML version of the content if requested in formats

rawHtml · string

Raw HTML content of the page if requested in formats

links · array

List of links found on the page if requested in formats

screenshot · string

Screenshot URL if requested in formats

metadata · object

Page metadata including:

• title: Page title
• description: Page description
• language: Page language
• sourceURL: Original URL
• statusCode: HTTP status code
• timezone: Inferred timezone
• error: Error message if any

Example Request

cURL

curl -X GET https://api.firecrawl.dev/v1/crawl/123e4567-e89b-12d3-a456-426614174000 \
  -H 'Authorization: Bearer YOUR_API_KEY'

Example Response

{
  "status": "completed",
  "total": 42,
  "completed": 42,
  "creditsUsed": 84,
  "expiresAt": "2026-03-10T12:00:00.000Z",
  "next": null,
  "data": [
    {
      "markdown": "# Example Page\n\nThis is the content...",
      "html": "<h1>Example Page</h1><p>This is the content...</p>",
      "links": ["https://example.com/page1", "https://example.com/page2"],
      "metadata": {
        "title": "Example Page",
        "description": "An example page description",
        "language": "en",
        "sourceURL": "https://example.com/page",
        "statusCode": 200,
        "timezone": "America/New_York",
        "error": null
      }
    }
  ]
}

Error Responses

402 Payment Required

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

429 Too Many Requests

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

500 Server Error

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

Pagination

If the response data exceeds 10MB, the next field will contain a URL to retrieve the next batch of results. Continue fetching using the next URL until it becomes null.

Status Values

• scraping: The crawl is currently in progress
• completed: The crawl has finished successfully
• failed: The crawl encountered an error and stopped