java.lang.Object
- com.firecrawl.models.ScrapeOptions.Builder

Enclosing class:: ScrapeOptions

public static final class ScrapeOptions.Builder
extends java.lang.Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ScrapeOptions.Builder`	`actions(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> actions)`	Actions to execute before/during scraping.
`ScrapeOptions.Builder`	`blockAds(java.lang.Boolean blockAds)`	Block advertisements during scraping.
`ScrapeOptions`	`build()`
`ScrapeOptions.Builder`	`excludeTags(java.util.List<java.lang.String> excludeTags)`	Exclude content from these HTML tags.
`ScrapeOptions.Builder`	`formats(java.util.List<java.lang.Object> formats)`	Output formats to request.
`ScrapeOptions.Builder`	`headers(java.util.Map<java.lang.String,java.lang.String> headers)`	Custom HTTP headers to send with the request.
`ScrapeOptions.Builder`	`includeTags(java.util.List<java.lang.String> includeTags)`	Only include content from these HTML tags.
`ScrapeOptions.Builder`	`integration(java.lang.String integration)`	Integration identifier.
`ScrapeOptions.Builder`	`location(LocationConfig location)`	Geolocation configuration.
`ScrapeOptions.Builder`	`lockdown(java.lang.Boolean lockdown)`	Lockdown mode: serve only previously cached results, never make outbound requests.
`ScrapeOptions.Builder`	`maxAge(java.lang.Long maxAge)`	Use cached result if younger than this many milliseconds.
`ScrapeOptions.Builder`	`mobile(java.lang.Boolean mobile)`	Scrape as a mobile device.
`ScrapeOptions.Builder`	`onlyMainContent(java.lang.Boolean onlyMainContent)`	Only return the main content of the page, excluding navbars/footers.
`ScrapeOptions.Builder`	`parsers(java.util.List<java.lang.Object> parsers)`	Parsers to use (e.g., "pdf" or {"type": "pdf", "maxPages": 10}).
`ScrapeOptions.Builder`	`proxy(java.lang.String proxy)`	Proxy mode: "basic", "stealth", "enhanced", "auto", or a custom proxy URL.
`ScrapeOptions.Builder`	`removeBase64Images(java.lang.Boolean removeBase64Images)`	Remove base64-encoded images from the response.
`ScrapeOptions.Builder`	`skipTlsVerification(java.lang.Boolean skipTlsVerification)`	Skip TLS certificate verification.
`ScrapeOptions.Builder`	`storeInCache(java.lang.Boolean storeInCache)`	Whether to cache the result.
`ScrapeOptions.Builder`	`timeout(java.lang.Integer timeout)`	Timeout in milliseconds for the scrape request.
`ScrapeOptions.Builder`	`waitFor(java.lang.Integer waitFor)`	Wait time in milliseconds before scraping (for JS rendering).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

formats
```
public ScrapeOptions.Builder formats(java.util.List<java.lang.Object> formats)
```
Output formats to request. Accepts strings like "markdown", "html", "rawHtml", "links", "screenshot", "json", "audio", "video", etc., or format configuration maps/objects for advanced formats (e.g., JsonFormat, QuestionFormat, HighlightsFormat).

headers

public ScrapeOptions.Builder headers(java.util.Map<java.lang.String,java.lang.String> headers)

Custom HTTP headers to send with the request.

includeTags

public ScrapeOptions.Builder includeTags(java.util.List<java.lang.String> includeTags)

Only include content from these HTML tags.

excludeTags

public ScrapeOptions.Builder excludeTags(java.util.List<java.lang.String> excludeTags)

Exclude content from these HTML tags.

onlyMainContent

public ScrapeOptions.Builder onlyMainContent(java.lang.Boolean onlyMainContent)

Only return the main content of the page, excluding navbars/footers.

timeout

public ScrapeOptions.Builder timeout(java.lang.Integer timeout)

Timeout in milliseconds for the scrape request.

waitFor

public ScrapeOptions.Builder waitFor(java.lang.Integer waitFor)

Wait time in milliseconds before scraping (for JS rendering).

mobile

public ScrapeOptions.Builder mobile(java.lang.Boolean mobile)

Scrape as a mobile device.

parsers

public ScrapeOptions.Builder parsers(java.util.List<java.lang.Object> parsers)

Parsers to use (e.g., "pdf" or {"type": "pdf", "maxPages": 10}).

actions

public ScrapeOptions.Builder actions(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> actions)

Actions to execute before/during scraping.

location

public ScrapeOptions.Builder location(LocationConfig location)

Geolocation configuration.

skipTlsVerification

public ScrapeOptions.Builder skipTlsVerification(java.lang.Boolean skipTlsVerification)

Skip TLS certificate verification.

removeBase64Images

public ScrapeOptions.Builder removeBase64Images(java.lang.Boolean removeBase64Images)

Remove base64-encoded images from the response.

blockAds

public ScrapeOptions.Builder blockAds(java.lang.Boolean blockAds)

Block advertisements during scraping.

proxy
```
public ScrapeOptions.Builder proxy(java.lang.String proxy)
```
Proxy mode: "basic", "stealth", "enhanced", "auto", or a custom proxy URL.

maxAge

public ScrapeOptions.Builder maxAge(java.lang.Long maxAge)

Use cached result if younger than this many milliseconds.

storeInCache

public ScrapeOptions.Builder storeInCache(java.lang.Boolean storeInCache)

Whether to cache the result.

lockdown
```
public ScrapeOptions.Builder lockdown(java.lang.Boolean lockdown)
```
Lockdown mode: serve only previously cached results, never make outbound requests.

integration

public ScrapeOptions.Builder integration(java.lang.String integration)

Integration identifier.

build
```
public ScrapeOptions build()
```

Class ScrapeOptions.Builder