Advanced Scraping Guide

This guide will walk you through the different endpoints of Firecrawl and how to use them fully with all its parameters.

Basic scraping with Firecrawl (/scrape)

To scrape a single page and get clean markdown content, you can use the /scrape endpoint.

Scraping PDFs

Firecrawl supports scraping PDFs by default. You can use the /scrape endpoint to scrape a PDF link and get the text content of the PDF. You can disable this by setting parsePDF to false.

Scrape Options

When using the /scrape endpoint, you can customize the scraping behavior with many parameters. Here are the available options:

Setting the content formats on response with `formats`

Type: array
Enum: ["markdown", "links", "html", "rawHtml", "screenshot"]
Description: Specify the formats to include in the response. Options include:
- markdown: Returns the scraped content in Markdown format.
- links: Includes all hyperlinks found on the page.
- html: Provides the content in HTML format.
- rawHtml: Delivers the raw HTML content, without any processing.
- screenshot: Includes a screenshot of the page as it appears in the browser.
- extract: Extracts structured information from the page using the LLM.
Default: ["markdown"]

Getting the full page content as markdown with `onlyMainContent`

Type: boolean
Description: By default, the scraper will only return the main content of the page, excluding headers, navigation bars, footers, etc. Set this to false to return the full page content.
Default: true

Setting the tags to include with `includeTags`

Type: array
Description: Specify the HTML tags, classes and ids to include in the response.
Default: undefined

Setting the tags to exclude with `excludeTags`

Type: array
Description: Specify the HTML tags, classes and ids to exclude from the response.
Default: undefined

Waiting for the page to load with `waitFor`

Type: integer
Description: To be used only as a last resort. Wait for a specified amount of milliseconds for the page to load before fetching content.
Default: 0

Setting the maximum `timeout`

Type: integer
Description: Set the maximum duration in milliseconds that the scraper will wait for the page to respond before aborting the operation.
Default: 30000 (30 seconds)

Example Usage

curl -X POST https://api.firecrawl.dev/v1/scrape \
    -H '
    Content-Type: application/json' \
    -H 'Authorization : Bearer YOUR_API_KEY' \
    -d '{
      "url": "https://docs.firecrawl.dev",
      "formats": ["markdown", "links", "html", "rawHtml", "screenshot"],
      "includeTags": ["h1", "p", "a", ".main-content"],
      "excludeTags": ["#ad", "#footer"],
      "onlyMainContent": false,
      "waitFor": 1000,
      "timeout": 15000
    }'

In this example, the scraper will:

Return the full page content as markdown.
Include the markdown, raw HTML, HTML, links and screenshot in the response.
The response will include only the HTML tags <h1>, <p>, <a>, and elements with the class .main-content, while excluding any elements with the IDs #ad and #footer.
Wait for 1000 milliseconds (1 second) for the page to load before fetching the content.
Set the maximum duration of the scrape request to 15000 milliseconds (15 seconds).

Here is the API Reference for it: Scrape Endpoint Documentation

Extractor Options

When using the /scrape endpoint, you can specify options for extracting structured information from the page content using the extract parameter. Here are the available options:

Using the LLM Extraction

schema

Type: object
Required: False if prompt is provided
Description: The schema for the data to be extracted. This defines the structure of the extracted data.

system prompt

Type: string
Required: False
Description: System prompt for the LLM.

prompt

Type: string
Required: False if schema is provided
Description: A prompt for the LLM to extract the data in the correct structure.
Example: "Extract the features of the product"

Example Usage

curl -X POST https://api.firecrawl.dev/v0/scrape \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer YOUR_API_KEY' \
    -d '{
      "url": "https://firecrawl.dev",
      "formats": ["markdown", "extract"],
      "extract": {
        "prompt": "Extract the features of the product"
      }
    }'

{
  "success": true,
  "data": {
    "content": "Raw Content",
    "metadata": {
      "title": "Mendable",
      "description": "Mendable allows you to easily build AI chat applications. Ingest, customize, then deploy with one line of code anywhere you want. Brought to you by SideGuide",
      "robots": "follow, index",
      "ogTitle": "Mendable",
      "ogDescription": "Mendable allows you to easily build AI chat applications. Ingest, customize, then deploy with one line of code anywhere you want. Brought to you by SideGuide",
      "ogUrl": "https://docs.firecrawl.dev/",
      "ogImage": "https://docs.firecrawl.dev/mendable_new_og1.png",
      "ogLocaleAlternate": [],
      "ogSiteName": "Mendable",
      "sourceURL": "https://docs.firecrawl.dev/",
      "statusCode": 200
    },
    "extract": {
      "product": "Firecrawl",
      "features": {
        "general": {
          "description": "Turn websites into LLM-ready data.",
          "openSource": true,
          "freeCredits": 500,
          "useCases": [
            "AI applications",
            "Data science",
            "Market research",
            "Content aggregation"
          ]
        },
        "crawlingAndScraping": {
          "crawlAllAccessiblePages": true,
          "noSitemapRequired": true,
          "dynamicContentHandling": true,
          "dataCleanliness": {
            "process": "Advanced algorithms",
            "outputFormat": "Markdown"
          }
        },
        ...
      }
    }
  }
}

Actions

When using the /scrape endpoint, Firecrawl allows you to perform various actions on a web page before scraping its content. This is particularly useful for interacting with dynamic content, navigating through pages, or accessing content that requires user interaction.

Available Actions

wait

Type: object
Description: Wait for a specified amount of milliseconds.
Properties:
- type: "wait"
- milliseconds: Number of milliseconds to wait.

Example:

{
  "type": "wait",
  "milliseconds": 2000
}

screenshot

Type: object
Description: Take a screenshot.
Properties:
- type: "screenshot"
- fullPage: Should the screenshot be full-page or viewport sized? (default: false)

Example:

{
  "type": "screenshot",
  "fullPage": true
}

click

Type: object
Description: Click on an element.
Properties:
- type: "click"
- selector: Query selector to find the element by.

Example:

{
  "type": "click",
  "selector": "#load-more-button"
}

write

Type: object
Description: Write text into an input field.
Properties:
- type: "write"
- text: Text to type.
- selector: Query selector for the input field.

Example:

{
  "type": "write",
  "text": "Hello, world!",
  "selector": "#search-input"
}

press

Type: object
Description: Press a key on the page.
Properties:
- type: "press"
- key: Key to press.

Example:

{
  "type": "press",
  "key": "Enter"
}

scroll

Type: object
Description: Scroll the page.
Properties:
- type: "scroll"
- direction: Direction to scroll ("up" or "down").
- amount: Amount to scroll in pixels.

Example:

{
  "type": "scroll",
  "direction": "down",
  "amount": 500
}

For more details about the actions parameters, refer to the API Reference.

Crawling Multiple Pages

To crawl multiple pages, you can use the /crawl endpoint. This endpoint allows you to specify a base URL you want to crawl and all accessible subpages will be crawled.

curl -X POST https://api.firecrawl.dev/v1/crawl \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer YOUR_API_KEY' \
    -d '{
      "url": "https://docs.firecrawl.dev"
    }'

Returns a id

{ "id": "1234-5678-9101" }

Check Crawl Job

Used to check the status of a crawl job and get its result.

curl -X GET https://api.firecrawl.dev/v1/crawl/1234-5678-9101 \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Pagination/Next URL

If the content is larger than 10MB or if the crawl job is still running, the response will include a next parameter. This parameter is a URL to the next page of results. You can use this parameter to get the next page of results.

Crawler Options

When using the /crawl endpoint, you can customize the crawling behavior with request body parameters. Here are the available options:

`includePaths`

Type: array
Description: URL patterns to include in the crawl. Only URLs matching these patterns will be crawled.
Example: ["/blog/*", "/products/*"]

`excludePaths`

Type: array
Description: URL patterns to exclude from the crawl. URLs matching these patterns will be skipped.
Example: ["/admin/*", "/login/*"]

`maxDepth`

Type: integer
Description: Maximum depth to crawl relative to the entered URL. A maxDepth of 0 scrapes only the entered URL. A maxDepth of 1 scrapes the entered URL and all pages one level deep. A maxDepth of 2 scrapes the entered URL and all pages up to two levels deep. Higher values follow the same pattern.
Example: 2

`limit`

Type: integer
Description: Maximum number of pages to crawl.
Default: 10000

`allowBackwardLinks`

Type: boolean
Description: This option permits the crawler to navigate to URLs that are higher in the directory structure than the base URL. For instance, if the base URL is example.com/blog/topic, enabling this option allows crawling to pages like example.com/blog or example.com, which are backward in the path hierarchy relative to the base URL.
Default: false

`allowExternalLinks`

Type: boolean
Description: This option allows the crawler to follow links that point to external domains. Be careful with this option, as it can cause the crawl to stop only based only on thelimit and maxDepth values.
Default: false

scrapeOptions

As part of the crawler options, you can also specify the scrapeOptions parameter. This parameter allows you to customize the scraping behavior for each page.

Type: object
Description: Options for the scraper.
Example: {"formats": ["markdown", "links", "html", "rawHtml", "screenshot"], "includeTags": ["h1", "p", "a", ".main-content"], "excludeTags": ["#ad", "#footer"], "onlyMainContent": false, "waitFor": 1000, "timeout": 15000}
Default: { "formats": ["markdown"] }
See: Scrape Options

Example Usage

curl -X POST https://api.firecrawl.dev/v1/crawl \
    -H 'Content-Type: application/json' \
    -H 'Authorization : Bearer YOUR_API_KEY' \
    -d '{
      "url": "https://docs.firecrawl.dev",
      "includePaths": ["/blog/*", "/products/*"],
      "excludePaths": ["/admin/*", "/login/*"],
      "maxDepth": 2,
      "limit": 1000
    }'

In this example, the crawler will:

Only crawl URLs that match the patterns /blog/* and /products/*.
Skip URLs that match the patterns /admin/* and /login/*.
Return the full document data for each page.
Crawl up to a maximum depth of 2.
Crawl a maximum of 1000 pages.

Mapping Website Links with `/map`

The /map endpoint is adept at identifying URLs that are contextually related to a given website. This feature is crucial for understanding a site’s contextual link environment, which can greatly aid in strategic site analysis and navigation planning.

Usage

To use the /map endpoint, you need to send a GET request with the URL of the page you want to map. Here is an example using curl:

curl -X POST https://api.firecrawl.dev/v1/map \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer YOUR_API_KEY' \
    -d '{
      "url": "https://docs.firecrawl.dev"
    }'

This will return a JSON object containing links contextually related to the url.

Example Response

  {
    "success":true,
    "links":[
      "https://docs.firecrawl.dev",
      "https://docs.firecrawl.dev/api-reference/endpoint/crawl-delete",
      "https://docs.firecrawl.dev/api-reference/endpoint/crawl-get",
      "https://docs.firecrawl.dev/api-reference/endpoint/crawl-post",
      "https://docs.firecrawl.dev/api-reference/endpoint/map",
      "https://docs.firecrawl.dev/api-reference/endpoint/scrape",
      "https://docs.firecrawl.dev/api-reference/introduction",
      "https://docs.firecrawl.dev/articles/search-announcement",
      ...
    ]
  }

Map Options

`search`

Type: string
Description: Search for links containing specific text.
Example: "blog"

`limit`

Type: integer
Description: Maximum number of links to return.
Default: 100

`ignoreSitemap`

Type: boolean
Description: Ignore the website sitemap when crawling
Default: true

`includeSubdomains`

Type: boolean
Description: Include subdomains of the website
Default: false

Here is the API Reference for it: Map Endpoint Documentation

Get Started

Features

Integrations

Contributing

​Basic scraping with Firecrawl (/scrape)

​Scraping PDFs

​Scrape Options

​Setting the content formats on response with formats

​Getting the full page content as markdown with onlyMainContent

​Setting the tags to include with includeTags

​Setting the tags to exclude with excludeTags

​Waiting for the page to load with waitFor

​Setting the maximum timeout

​Example Usage

​Extractor Options

​Using the LLM Extraction

​schema

​system prompt

​prompt

​Example Usage

​Actions

​Available Actions

​wait

​screenshot

​click

​write

​press

​scroll

​Crawling Multiple Pages

​Check Crawl Job

​Pagination/Next URL

​Crawler Options

​includePaths

​excludePaths

​maxDepth

​limit

​allowBackwardLinks

​allowExternalLinks

​scrapeOptions

​Example Usage

​Mapping Website Links with /map

​Usage

​Example Response

​Map Options

​search

​limit

​ignoreSitemap

​includeSubdomains

Basic scraping with Firecrawl (/scrape)

Scraping PDFs

Scrape Options

Setting the content formats on response with `formats`

Getting the full page content as markdown with `onlyMainContent`

Setting the tags to include with `includeTags`

Setting the tags to exclude with `excludeTags`

Waiting for the page to load with `waitFor`

Setting the maximum `timeout`

Example Usage

Extractor Options

Using the LLM Extraction

schema

system prompt

prompt

Example Usage

Actions

Available Actions

wait

screenshot

click

write

press

scroll

Crawling Multiple Pages

Check Crawl Job

Pagination/Next URL

Crawler Options

`includePaths`

`excludePaths`

`maxDepth`

`limit`

`allowBackwardLinks`

`allowExternalLinks`

scrapeOptions

Example Usage

Mapping Website Links with `/map`

Usage

Example Response

Map Options

`search`

`limit`

`ignoreSitemap`

`includeSubdomains`