Firecrawl · Web Data
Firecrawl / Scrape a web page
Scrapes one URL and can extract information with an LLM. Send url; formats, actions, waitFor, mobile and location refine it. Returns data with markdown and metadata.
Private Gateway connection
Data below comes from the configured private Gateway. Provider activation remains governed by its evidence and policy gates.
No verification date is claimed. No response capture is claimed.
Request parameters
- actions body · optional
Actions to perform on the page before grabbing the content
- blockAds body · optional
Enables ad-blocking and cookie popup blocking.
- excludeTags body · optional
Tags to exclude from the output.
- formats body · optional
Output formats to include in the response. You can specify one or more formats, either as strings (e.g., `'markdown'`) or as objects with additional options (e.g., `{ type: 'json', schema: {...} }`). Some formats require specific options to be set. Example: `['markdown', { type: 'json', schema: {...} }]`.
- headers body · optional
Headers to send with the request. Can be used to send cookies, user-agent, etc.
- includeTags body · optional
Tags to include in the output.
- location body · optional
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.
- maxAge body · optional
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 2 days.
- mobile body · optional
Set to true if you want to emulate scraping from a mobile device. Useful for testing responsive pages and taking mobile screenshots.
- onlyMainContent body · optional
Only return the main content of the page excluding headers, navs, footers, etc.
- parsers body · optional
Controls how files are processed during scraping. When "pdf" is included (default), the PDF content is extracted and converted to markdown format, with billing based on the number of pages (1 credit per page). When an empty array is passed, the PDF file is returned in base64 encoding with a flat rate of 1 credit total.
- proxy body · optional
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...
- removeBase64Images body · optional
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.
- skipTlsVerification body · optional
Skip TLS certificate verification when making requests
- storeInCache body · optional
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.
- timeout body · optional
Timeout in milliseconds for the request.
- url body · required
The URL to scrape
- waitFor body · optional
Specify a delay in milliseconds before fetching the content, allowing the page sufficient time to load.
- zeroDataRetention body · optional
If true, this will enable zero data retention for this scrape. To enable this feature, please contact help@firecrawl.dev
Sign in to run this operation, inspect live eligibility, and see governed execution and audit evidence. Sign in.