apicheats.dev Cheat sheet Raw .md
POST

Try POST /scrape — Firecrawl API

Firecrawl playground

Scrape a single URL and optionally extract information using an LLM

Credentials

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

20 body fields
  • url · required · string — The URL to scrape
  • formats · optional · string[] — Formats to include in the output. `rawBase64` must be requested by itself.
  • onlyMainContent · optional · boolean — Only return the main content of the page excluding headers, navs, footers, etc.
  • includeTags · optional · string[] — Tags to include in the output.
  • excludeTags · optional · string[] — Tags to exclude from the output.
  • maxAge · optional · integer — Returns a cached version of the page if it is younger than this age in milliseconds. If a cached version of the page is older than this value, the page will be scraped. If you do not need extremely fresh data, enabling this can speed up your scrapes by 500%. Defaults to 0, which disables caching.
  • headers · optional · object — Headers to send with the request. Can be used to send cookies, user-agent, etc.
  • waitFor · optional · integer — Specify a delay in milliseconds before fetching the content, allowing the page sufficient time to load.
  • mobile · optional · boolean — Set to true if you want to emulate scraping from a mobile device. Useful for testing responsive pages and taking mobile screenshots.
  • skipTlsVerification · optional · boolean — Skip TLS certificate verification when making requests
  • timeout · optional · integer — Timeout in milliseconds for the request
  • parsePDF · optional · boolean — Controls how PDF files are processed during scraping. When true, the PDF content is extracted and converted to markdown format, with billing based on the number of pages (1 credit per page). When false, the PDF file is returned in base64 encoding with a flat rate of 1 credit total.
  • jsonOptions · optional · object — JSON options object
  • actions · optional · object[] — Actions to perform on the page before grabbing the content
  • location · optional · object — Location settings for the request. When specified, this will use an appropriate proxy if available and emulate the corresponding language and timezone settings. Defaults to 'US' if not specified.
  • removeBase64Images · optional · boolean — Removes all base 64 images from the output, which may be overwhelmingly long. The image's alt text remains in the output, but the URL is replaced with a placeholder.
  • blockAds · optional · boolean — Enables ad-blocking and cookie popup blocking.
  • proxy · optional · string — Specifies the type of proxy to use. - **basic**: Proxies for scraping sites with none to basic anti-bot solutions. Fast and usually works. - **enhanced**: Enhanced proxies for scraping sites with advanced anti-bot solutions. Slower, but more reliable on certain sites. Billed at the same credit cost as basic. - **auto**: Firecrawl will automatically retry scraping with enhanced proxies if the basic proxy fails. Enhanced proxies carry no credit surcharge, so either way only the regular cost is billed. If you do not specify a proxy, Firecrawl will default to basic.
  • changeTrackingOptions · optional · object — Options for change tracking (Beta). Only applicable when 'changeTracking' is included in formats. The 'markdown' format must also be specified when using change tracking.
  • storeInCache · optional · boolean — If true, the page will be stored in the Firecrawl index and cache. Setting this to false is useful if your scraping activity may have data protection concerns. Using some parameters associated with sensitive scraping (actions, headers) will force this parameter to be false.