Struct FirecrawlApp 

pub struct FirecrawlApp { /* private fields */ }

Implementations

impl FirecrawlApp

pub async fn batch_scrape_urls( &self, urls: Vec<String>, options: impl Into<Option<ScrapeOptions>>, poll_interval: Option<u64>, idempotency_key: Option<String>, webhook: Webhook, ignore_invalid_urls: Option<bool>, ) -> Result<BatchScrapeStatus, FirecrawlError>

Scrapes multiple URLs in a single request using the Firecrawl API.

pub async fn check_batch_scrape_status( &self, id: &str, ) -> Result<BatchScrapeStatus, FirecrawlError>

Checks the status of a batch scrape job.

pub async fn monitor_batch_scrape_status( &self, id: &str, poll_interval: u64, ) -> Result<BatchScrapeStatus, FirecrawlError>

Monitors a batch scrape job until it completes, fails, or is cancelled.

pub async fn check_batch_scrape_status_with_cursor( &self, id: &str, cursor: &str, ) -> Result<BatchScrapeStatus, FirecrawlError>

Checks the status of a batch scrape job with a cursor for pagination.

impl FirecrawlApp

pub async fn crawl_url_async( &self, url: impl AsRef<str>, options: Option<CrawlOptions>, idempotency_key: Option<String>, webhook: Webhook, ) -> Result<CrawlAsyncResponse, FirecrawlError>

Initiates a crawl job for a URL using the Firecrawl API.

pub async fn crawl_url( &self, url: impl AsRef<str>, options: impl Into<Option<CrawlOptions>>, webhook: Webhook, poll_interval: Option<u64>, idempotency_key: Option<String>, ) -> Result<CrawlStatus, FirecrawlError>

Performs a crawl job for a URL using the Firecrawl API, waiting for the end result. This may take a long time depending on the size of the target page and your options (namely CrawlOptions.limit).

pub async fn check_crawl_status( &self, id: impl AsRef<str>, ) -> Result<CrawlStatus, FirecrawlError>

Checks for the status of a crawl, based on the crawl’s ID. To be used in conjunction with FirecrawlApp::crawl_url_async.

impl FirecrawlApp

pub async fn map_url( &self, url: impl AsRef<str>, options: impl Into<Option<MapOptions>>, ) -> Result<Vec<String>, FirecrawlError>

Returns links from a URL using the Firecrawl API.

impl FirecrawlApp

pub async fn scrape_url( &self, url: impl AsRef<str>, options: impl Into<Option<ScrapeOptions>>, ) -> Result<Document, FirecrawlError>

Scrapes a URL using the Firecrawl API.

impl FirecrawlApp

pub async fn search( &self, query: impl AsRef<str>, options: impl Into<Option<SearchOptions>>, ) -> Result<Vec<SearchResult>, FirecrawlError>

Performs a web search using the Firecrawl API.

Arguments

• query - The search query string
• options - Optional search configuration

Returns

Returns a Result containing a vector of SearchResult on success, or a FirecrawlError on failure.

impl FirecrawlApp

pub fn new(api_key: impl AsRef<str>) -> Result<FirecrawlApp, FirecrawlError>

pub fn new_with_client( api_key: impl AsRef<str>, client: Client, ) -> Result<FirecrawlApp, FirecrawlError>

pub fn new_selfhosted( api_url: impl AsRef<str>, api_key: Option<impl AsRef<str>>, ) -> Result<FirecrawlApp, FirecrawlError>

pub fn new_selfhosted_with_client( api_url: impl AsRef<str>, api_key: Option<impl AsRef<str>>, client: Client, ) -> Result<FirecrawlApp, FirecrawlError>

Trait Implementations

impl Clone for FirecrawlApp

fn clone(&self) -> FirecrawlApp

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FirecrawlApp

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl IntoFirecrawlMCP for FirecrawlApp

fn into_mcp(self) -> FirecrawlMCP

Converts a FirecrawlApp instance into a FirecrawlMCP instance