Scrape Request Fields
Endpoint
Section titled “Endpoint”POST https://api.firecrawl.dev/v2/scrape
Headers:
Authorization: Bearer <token>Content-Type: application/json
Body fields
Section titled “Body fields”Required
Section titled “Required”| Field | Type | Required | Default | Notes |
|---|---|---|---|---|
url | string (uri) | Yes | - | The URL to scrape |
Output shaping
Section titled “Output shaping”| Field | Type | Default | Notes |
|---|---|---|---|
formats | array | ["markdown"] | Output formats (string or object forms). See Output Formats. |
onlyMainContent | boolean | true | Attempts to return only the main content (remove nav/footer/etc.) |
includeTags | string[] | - | Include-only filtering (HTML tag / class / id selectors) |
excludeTags | string[] | - | Exclude filtering (HTML tag / class / id selectors) |
removeBase64Images | boolean | true | Removes base64 images from Markdown output (keeps alt text) |
Cache and timing
Section titled “Cache and timing”| Field | Type | Default | Notes |
|---|---|---|---|
maxAge | number (ms) | 172800000 | Cache freshness window. Improves latency but not credits. |
minAge | number (ms) | - | Cache-only lookup. If missing, returns 404 with error code SCRAPE_NO_CACHED_DATA. |
waitFor | number (ms) | 0 | Extra wait time before scraping (on top of smart-wait). |
timeout | number (ms) | 60000 | Range 1000..300000. |
Access and anti-bot
Section titled “Access and anti-bot”| Field | Type | Default | Notes |
|---|---|---|---|
headers | object | - | Custom headers (cookies/user-agent/etc.). Some sensitive params may force storeInCache=false. |
proxy | "basic" | "enhanced" | "auto" | "auto" | Proxy strategy. enhanced is more robust but can cost more. |
blockAds | boolean | true | Enables ad-block and cookie popup blocking. |
skipTlsVerification | boolean | true | Skips TLS verification. |
mobile | boolean | false | Emulates a mobile device. |
location | object | - | Location + language preferences (country/languages). |
PDF / file parsing
Section titled “PDF / file parsing”| Field | Type | Default | Notes |
|---|---|---|---|
parsers | array | ["pdf"] | Controls file parsing. PDFs are parsed by default (billed per page). Passing [] skips parsing and returns base64 (flat 1 credit per PDF). |
PDF parser object form:
parsers: [{ type: 'pdf', mode: 'auto', maxPages: 20 }]See: PDF Parser Options
Browser actions
Section titled “Browser actions”| Field | Type | Default | Notes |
|---|---|---|---|
actions | array | - | Run browser actions before extracting content. See Actions. |
profile | object | - | Enables persistent browser storage across scrape + interact sessions. |
Storage and compliance
Section titled “Storage and compliance”| Field | Type | Default | Notes |
|---|---|---|---|
storeInCache | boolean | true | Stores results in Firecrawl cache/index. Some sensitive params (e.g. actions/headers) may force false. |
zeroDataRetention | boolean | false | Enables ZDR (requires Firecrawl to enable it for your account). |