POST

Try POST /crawl — Firecrawl API

Firecrawl playground

Crawl multiple URLs based on options

Credentials

Firecrawl API key · sent as Authorization

Kept in this tab only. Requests go through apicheats.dev's same-origin proxy straight to api.firecrawl.dev; the proxy stores and logs nothing about them.

Body application/json

{
  "url": "https://example.com",
  "excludePaths": [
    "example-excludePaths"
  ],
  "includePaths": [
    "example-includePaths"
  ],
  "maxDepth": 10,
  "maxDiscoveryDepth": 0,
  "ignoreSitemap": false,
  "ignoreQueryParameters": false,
  "limit": 10000,
  "allowBackwardLinks": false,
  "allowExternalLinks": false,
  "delay": 0,
  "webhook": {
    "url": "example-url",
    "headers": {},
    "metadata": {},
    "events": [
      "completed"
    ]
  },
  "scrapeOptions": {
    "formats": [
      "markdown"
    ],
    "onlyMainContent": true,
    "includeTags": [
      "example-includeTags"
    ],
    "excludeTags": [
      "example-excludeTags"
    ],
    "maxAge": 0,
    "headers": {},
    "waitFor": 0,
    "mobile": false,
    "skipTlsVerification": false,
    "timeout": 30000,
    "parsePDF": true,
    "jsonOptions": {
      "schema": {},
      "systemPrompt": "example-systemPrompt",
      "prompt": "example-prompt"
    },
    "actions": [
      {
        "type": "wait",
        "milliseconds": 0,
        "selector": "#my-element"
      }
    ],
    "location": {
      "country": "US",
      "languages": [
        "en-US"
      ]
    },
    "removeBase64Images": true,
    "blockAds": true,
    "proxy": "basic",
    "changeTrackingOptions": {
      "modes": [
        "git-diff"
      ],
      "schema": {},
      "prompt": "example-prompt",
      "tag": null
    },
    "storeInCache": true
  }
}

13 body fields

url · required · string — The base URL to start crawling from
excludePaths · optional · string[] — URL pathname regex patterns that exclude matching URLs from the crawl. For example, if you set "excludePaths": ["blog/.*"] for the base URL firecrawl.dev, any results matching that pattern will be excluded, such as https://www.firecrawl.dev/blog/firecrawl-launch-week-1-recap.
includePaths · optional · string[] — URL pathname regex patterns that include matching URLs in the crawl. Only the paths that match the specified patterns will be included in the response. For example, if you set "includePaths": ["blog/.*"] for the base URL firecrawl.dev, only results matching that pattern will be included, such as https://www.firecrawl.dev/blog/firecrawl-launch-week-1-recap.
maxDepth · optional · integer — Maximum depth to crawl relative to the base URL. Basically, the max number of slashes the pathname of a scraped URL may contain.
maxDiscoveryDepth · optional · integer — Maximum depth to crawl based on discovery order. The root site and sitemapped pages has a discovery depth of 0. For example, if you set it to 1, and you set ignoreSitemap, you will only crawl the entered URL and all URLs that are linked on that page.
ignoreSitemap · optional · boolean — Ignore the website sitemap when crawling
ignoreQueryParameters · optional · boolean — Do not re-scrape the same path with different (or none) query parameters
limit · optional · integer — Maximum number of pages to crawl. Default limit is 10000.
allowBackwardLinks · optional · boolean — Allows the crawler to follow internal links to sibling or parent URLs, not just child paths. false: Only crawls deeper (child) URLs. → e.g. /features/feature-1 → /features/feature-1/tips ✅ → Won't follow /pricing or / ❌ true: Crawls any internal links, including siblings and parents. → e.g. /features/feature-1 → /pricing, /, etc. ✅ Use true for broader internal coverage beyond nested paths.
allowExternalLinks · optional · boolean — Allows the crawler to follow links to external websites.
delay · optional · number — Delay in seconds between scrapes. This helps respect website rate limits.
webhook · optional · object — A webhook specification object.
scrapeOptions · optional · object — Request body field scrapeOptions.