scrape params commentary

This commit is contained in:
rafaelmmiller 2025-04-18 00:29:20 -07:00
parent 8c5509cbb4
commit a655d24e7c

View File

@ -461,23 +461,21 @@ class FirecrawlApp:
Args: Args:
url (str): Target URL to scrape url (str): Target URL to scrape
params (Optional[ScrapeParams]): See ScrapeParams model for configuration: formats (Optional[List[Literal["markdown", "html", "rawHtml", "content", "links", "screenshot", "screenshot@fullPage", "extract", "json"]]]): Content types to retrieve (markdown/html/etc)
Content Options: include_tags (Optional[List[str]]): HTML tags to include
* formats - Content types to retrieve (markdown/html/etc) exclude_tags (Optional[List[str]]): HTML tags to exclude
* includeTags - HTML tags to include only_main_content (Optional[bool]): Extract main content only
* excludeTags - HTML tags to exclude wait_for (Optional[int]): Wait for a specific element to appear
* onlyMainContent - Extract main content only timeout (Optional[int]): Request timeout (ms)
location (Optional[LocationConfig]): Location configuration
Request Options: mobile (Optional[bool]): Use mobile user agent
* headers - Custom HTTP headers skip_tls_verification (Optional[bool]): Skip TLS verification
* timeout - Request timeout (ms) remove_base64_images (Optional[bool]): Remove base64 images
* mobile - Use mobile user agent block_ads (Optional[bool]): Block ads
* proxy - Proxy type (basic/stealth) proxy (Optional[Literal["basic", "stealth"]]): Proxy type (basic/stealth)
extract (Optional[ExtractConfig]): Content extraction settings
Extraction Options: json_options (Optional[ExtractConfig]): JSON extraction settings
* extract - Content extraction settings actions (Optional[List[Union[WaitAction, ScreenshotAction, ClickAction, WriteAction, PressAction, ScrollAction, ScrapeAction, ExecuteJavascriptAction]]]): Actions to perform
* jsonOptions - JSON extraction settings
* actions - Actions to perform
Returns: Returns:
ScrapeResponse with: ScrapeResponse with: