> ## Documentation Index > Fetch the complete documentation index at: https://firecrawl-claude-eager-dijkstra-4ti4xi.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Rust Agent Quickstart > Canonical Firecrawl Rust quickstart for external agents using search, scrape, and interact. # Firecrawl Rust Agent Quickstart This file is the canonical quickstart for external agents integrating Firecrawl via the Rust SDK. It is generated from SDK source and OpenAPI spec. ## Install Add to `Cargo.toml`: ```toml theme={null} [dependencies] firecrawl = "2" tokio = { version = "1", features = ["full"] } ``` ## Authenticate ```rust theme={null} use firecrawl::Client; let client = Client::new("fc-YOUR_API_KEY")?; ``` For self-hosted instances: ```rust theme={null} let client = Client::new_selfhosted("https://your-instance.com", Some("fc-YOUR_API_KEY"))?; ``` The API key is optional for `new_selfhosted`. If omitted, the client falls back to keyless free tier (rate-limited per IP). ## When To Use What * **`search`**: Use when you start with a query and need to discover relevant URLs and their content. Returns results from web, news, and image sources. * **`scrape`**: Use when you already have a specific URL and want its page content in markdown, HTML, JSON, or other formats. * **`interact`**: Use when the page needs post-scrape browser actions like clicking, typing, scrolling, or executing code in a live browser session. ## Search ### Why use it Search the web for a query and optionally scrape the results. Returns categorized results from web, news, and image sources with optional content extraction. ### Preferred SDK method ```rust theme={null} client.search(query, options).await ``` ### Example ```rust theme={null} use firecrawl::{Client, SearchOptions}; let client = Client::new("fc-YOUR_API_KEY")?; let response = client.search("firecrawl web scraping API", SearchOptions { limit: Some(5), ..Default::default() }).await?; if let Some(web_results) = response.data.web { for result in web_results { println!("{:?}", result); } } ``` ### Parameters All fields on `SearchOptions` are `Option` and default to `None` via `#[derive(Default)]`. | Parameter | Type | Description | | --------------------- | ----------------------------- | ------------------------------------------------------------ | | `query` | `impl AsRef` | The search query (first argument, required). | | `limit` | `Option` | Maximum number of results. Server default: `10`. Max: `100`. | | `sources` | `Option>` | Sources to search: `Web`, `News`, `Images`. | | `categories` | `Option>` | Filter by category: `Github`, `Research`, `Pdf`. | | `include_domains` | `Option>` | Restrict results to these domains. | | `exclude_domains` | `Option>` | Exclude results from these domains. | | `tbs` | `Option` | Time-based search filter (e.g. `"qdr:d"` for past day). | | `location` | `Option` | Location string for geo-targeted search. | | `ignore_invalid_urls` | `Option` | Ignore invalid URLs in results. | | `timeout` | `Option` | Timeout in milliseconds. Server default: `60000`. | | `highlights` | `Option` | Generate query-relevant highlights. Server default: `true`. | | `scrape_options` | `Option` | Nested scrape configuration applied to each result. | | `integration` | `Option` | Integration identifier. | | `origin` | `Option` | Auto-set to `"rust-sdk@{version}"` if `None`. | ### Convenience method ```rust theme={null} client.search_and_scrape(query, limit).await ``` Sets `scrape_options` to defaults and returns `Vec` directly, filtering out non-document results. ## Scrape ### Why use it Scrape a single URL and get its content in one or more formats. Supports browser automation, LLM extraction, screenshots, and more. ### Preferred SDK method ```rust theme={null} client.scrape(url, options).await ``` ### Example ```rust theme={null} use firecrawl::{Client, ScrapeOptions, Format}; let client = Client::new("fc-YOUR_API_KEY")?; let doc = client.scrape("https://example.com", ScrapeOptions { formats: Some(vec![Format::Markdown, Format::Html]), only_main_content: Some(true), ..Default::default() }).await?; println!("{}", doc.markdown.unwrap_or_default()); ``` ### Parameters All fields on `ScrapeOptions` are `Option` and default to `None` via `#[derive(Default)]`. | Parameter | Type | Description | | ------------------------- | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `url` | `impl AsRef` | The URL to scrape (first argument, required). | | `formats` | `Option>` | Output formats: `Markdown`, `Html`, `RawHtml`, `Links`, `Images`, `Screenshot`, `Summary`, `ChangeTracking`, `Json`, `Attributes`, `Branding`, `Product`, `Menu`, `Audio`, `Video`, `Question(QuestionFormat)`, `Highlights(HighlightsFormat)`. Server default: `[Markdown]`. | | `only_main_content` | `Option` | Strip boilerplate, keep main content only. Server default: `true`. | | `headers` | `Option>` | Custom HTTP headers. | | `include_tags` | `Option>` | HTML tags to exclusively include. | | `exclude_tags` | `Option>` | HTML tags to exclude. | | `timeout` | `Option` | Timeout in milliseconds. Server default: `60000`. | | `wait_for` | `Option` | Delay in milliseconds before fetching content. | | `mobile` | `Option` | Emulate mobile device. | | `parsers` | `Option>` | Parser configurations (e.g. PDF parser with mode/maxPages). | | `actions` | `Option>` | Browser automation actions. See Actions below. | | `location` | `Option` | Location settings: `{ country, languages }`. | | `skip_tls_verification` | `Option` | Skip TLS certificate verification. | | `remove_base64_images` | `Option` | Remove base64 images from markdown. Server default: `true`. | | `fast_mode` | `Option` | Enable fast mode. | | `block_ads` | `Option` | Block advertisements. Server default: `true`. | | `proxy` | `Option` | Proxy type: `Basic`, `Stealth`, `Enhanced`, `Auto`. Server default: `Auto`. | | `max_age` | `Option` | Use cached result if younger than this (ms). | | `min_age` | `Option` | Cache-only mode; value is min age in ms. | | `store_in_cache` | `Option` | Cache the result. Server default: `true`. | | `lockdown` | `Option` | Only serve cached results. | | `redact_pii` | `Option` | Redact PII from returned content. | | `audit_metadata` | `Option` | User attribution: `AuditMetadata { username }`. | | `profile` | `Option` | Browser profile: `ProfileConfig { name, save_changes }`. | | `integration` | `Option` | Integration identifier. | | `json_options` | `Option` | JSON extraction options: `{ schema, system_prompt, prompt }`. | | `screenshot_options` | `Option` | Screenshot options: `{ full_page, quality, viewport }`. | | `change_tracking_options` | `Option` | Change tracking: `{ modes, schema, prompt, tag }`. | | `attribute_selectors` | `Option>` | Attribute extraction: `{ selector, attribute }`. | | `origin` | `Option` | Auto-set to `"rust-sdk@{version}"` if `None`. | #### Actions (enum variants) | Variant | Fields | | --------------------------- | ------------------------------------------------------------------------------ | | `Action::Wait` | `{ milliseconds: Option, selector: Option }` | | `Action::Screenshot` | `{ full_page: Option, quality: Option, viewport: Option }` | | `Action::Click` | `{ selector: String }` | | `Action::Write` | `{ text: String }` | | `Action::Press` | `{ key: String }` | | `Action::Scroll` | `{ direction: ScrollDirection, selector: Option }` | | `Action::Scrape` | (no fields) | | `Action::ExecuteJavascript` | `{ script: String }` | | `Action::Pdf` | `{ format: Option, landscape: Option, scale: Option }` | ### Convenience method ```rust theme={null} client.scrape_with_schema(url, schema, prompt).await ``` Extracts structured JSON using a JSON Schema and optional prompt. Returns `serde_json::Value`. ## Interact ### Why use it Execute code or send natural-language prompts in a live browser session tied to a scrape job. Use for post-scrape interactions like clicking buttons, filling forms, or running scripts. ### Preferred SDK method ```rust theme={null} client.interact(job_id, options).await ``` ### Example ```rust theme={null} use firecrawl::{Client, ScrapeOptions, ScrapeExecuteOptions}; let client = Client::new("fc-YOUR_API_KEY")?; let doc = client.scrape("https://example.com", ScrapeOptions { ..Default::default() }).await?; let job_id = doc.metadata.get("jobId").unwrap().as_str().unwrap(); let result = client.interact(job_id, ScrapeExecuteOptions { code: Some("document.title".to_string()), ..Default::default() }).await?; println!("{:?}", result.stdout); client.stop_interaction(job_id).await?; ``` ### Parameters All fields on `ScrapeExecuteOptions` are `Option` and default to `None`. | Parameter | Type | Description | | ---------- | ------------------------------- | ----------------------------------------------------------------- | | `job_id` | `impl AsRef` | The scrape job ID (first argument, required). | | `code` | `Option` | Code to execute in the browser sandbox. | | `prompt` | `Option` | Natural-language instruction for the browser agent. | | `language` | `Option` | Execution language: `Python`, `Node`, `Bash`. Default: `Node`. | | `timeout` | `Option` | Execution timeout in seconds. Range: 1-300. Server default: `30`. | | `origin` | `Option` | Auto-set to `"rust-sdk@{version}"` if `None`. | At least one of `code` or `prompt` must be a non-empty string, or a `FirecrawlError::Misuse` is returned before any HTTP call. Use `client.stop_interaction(job_id).await?` to end the browser session. ## Notes * **Naming style**: All struct fields use snake\_case. Serde handles the camelCase conversion for the API. * **Deprecated aliases**: `scrape_execute()` is deprecated in favor of `interact()`. `stop_interactive_browser()` and `delete_scrape_browser()` are deprecated in favor of `stop_interaction()`. * **Async**: All methods are async and require a tokio runtime. * **Error handling**: All methods return `Result`. ## Source Of Truth * `/firecrawl/apps/rust-sdk/src/v2/client.rs` * `/firecrawl/apps/rust-sdk/src/v2/search.rs` * `/firecrawl/apps/rust-sdk/src/v2/scrape.rs` * `/firecrawl-docs/api-reference/v2-openapi.json`