firecrawl 2.4.1

Official Rust SDK for Firecrawl API v2.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319

//! End-to-end tests for Firecrawl API.
//!
//! These tests require the following environment variables:
//! - API_URL: The Firecrawl API URL
//! - TEST_API_KEY: A valid API key (optional for self-hosted)
//!
//! Run with: cargo test --test v2_e2e -- --ignored

use firecrawl::{
    AgentOptions, BatchScrapeOptions, Client, CrawlOptions, Format, JobStatus, MapOptions,
    ParseFile, ParseFormat, ParseOptions, ScrapeOptions, SearchOptions, SitemapMode,
};
use serde_json::json;
use std::env;

fn get_client() -> Client {
    let api_url = env::var("API_URL").expect("API_URL environment variable is required");
    let api_key = env::var("TEST_API_KEY").ok();
    Client::new_selfhosted(api_url, api_key).expect("Failed to create client")
}

#[tokio::test]
#[ignore = "Requires API access"]
async fn test_scrape() {
    let client = get_client();
    let doc = client
        .scrape("https://example.com", None)
        .await
        .expect("Scrape should succeed");

    assert!(doc.markdown.is_some(), "Response should contain markdown");
}

#[tokio::test]
#[ignore = "Requires API access"]
async fn test_parse() {
    let client = get_client();
    let file = ParseFile::from_bytes(
        "rust-parse-e2e.html",
        b"<!DOCTYPE html><html><body><h1>Rust Parse E2E</h1></body></html>".to_vec(),
    )
    .with_content_type("text/html");

    let options = ParseOptions {
        formats: Some(vec![ParseFormat::Markdown]),
        ..Default::default()
    };

    let doc = client
        .parse(file, Some(options))
        .await
        .expect("Parse should succeed");
    assert!(doc.markdown.is_some(), "Response should contain markdown");
}

#[tokio::test]
#[ignore = "Requires API access"]
async fn test_scrape_with_options() {
    let client = get_client();
    let options = ScrapeOptions {
        formats: Some(vec![Format::Markdown, Format::Html, Format::Links]),
        only_main_content: Some(true),
        ..Default::default()
    };

    let doc = client
        .scrape("https://example.com", options)
        .await
        .expect("Scrape with options should succeed");

    assert!(doc.markdown.is_some(), "Response should contain markdown");
    assert!(doc.html.is_some(), "Response should contain html");
}

#[tokio::test]
#[ignore = "Requires API access"]
async fn test_scrape_with_schema() {
    let client = get_client();

    let schema = json!({
        "type": "object",
        "properties": {
            "title": { "type": "string" },
            "description": { "type": "string" }
        }
    });

    let data = client
        .scrape_with_schema("https://example.com", schema, Some("Extract page info"))
        .await
        .expect("Schema scrape should succeed");

    assert!(data.is_object(), "Response should be a JSON object");
}

#[tokio::test]
#[ignore = "Requires API access"]
async fn test_search() {
    let client = get_client();
    let response = client
        .search("rust programming", None)
        .await
        .expect("Search should succeed");

    assert!(response.success, "Response should indicate success");
}

#[tokio::test]
#[ignore = "Requires API access"]
async fn test_search_with_options() {
    let client = get_client();
    let options = SearchOptions {
        limit: Some(5),
        ..Default::default()
    };

    let response = client
        .search("firecrawl web scraping", options)
        .await
        .expect("Search with options should succeed");

    assert!(response.success, "Response should indicate success");
}

#[tokio::test]
#[ignore = "Requires API access"]
async fn test_map() {
    let client = get_client();
    let response = client
        .map("https://example.com", None)
        .await
        .expect("Map should succeed");

    assert!(response.success, "Response should indicate success");
}

#[tokio::test]
#[ignore = "Requires API access"]
async fn test_map_with_options() {
    let client = get_client();
    let options = MapOptions {
        sitemap: Some(SitemapMode::Include),
        limit: Some(50),
        ..Default::default()
    };

    let response = client
        .map("https://example.com", options)
        .await
        .expect("Map with options should succeed");

    assert!(response.success, "Response should indicate success");
}

#[tokio::test]
#[ignore = "Requires API access"]
async fn test_crawl_async() {
    let client = get_client();
    let response = client
        .start_crawl("https://example.com", None)
        .await
        .expect("Start crawl should succeed");

    assert!(response.success, "Response should indicate success");
    assert!(!response.id.is_empty(), "Response should contain job ID");

    // Check status
    let status = client
        .get_crawl_status(&response.id)
        .await
        .expect("Get crawl status should succeed");
    assert!(
        matches!(status.status, JobStatus::Scraping | JobStatus::Completed),
        "Status should be scraping or completed"
    );

    // Cancel the crawl to clean up
    let _ = client.cancel_crawl(&response.id).await;
}

#[tokio::test]
#[ignore = "Requires API access"]
async fn test_crawl_sync() {
    let client = get_client();
    let options = CrawlOptions {
        limit: Some(2),
        poll_interval: Some(2000),
        ..Default::default()
    };

    let job = client
        .crawl("https://example.com", options)
        .await
        .expect("Crawl should succeed");

    assert!(
        job.status == JobStatus::Completed,
        "Job should be completed"
    );
}

#[tokio::test]
#[ignore = "Requires API access"]
async fn test_batch_scrape_async() {
    let client = get_client();
    let urls = vec![
        "https://example.com".to_string(),
        "https://example.org".to_string(),
    ];

    let response = client
        .start_batch_scrape(urls, None)
        .await
        .expect("Start batch scrape should succeed");

    assert!(response.success, "Response should indicate success");
    assert!(!response.id.is_empty(), "Response should contain job ID");
}

#[tokio::test]
#[ignore = "Requires API access"]
async fn test_batch_scrape_sync() {
    let client = get_client();
    let urls = vec!["https://example.com".to_string()];

    let options = BatchScrapeOptions {
        options: Some(ScrapeOptions {
            formats: Some(vec![Format::Markdown]),
            ..Default::default()
        }),
        poll_interval: Some(2000),
        ..Default::default()
    };

    let job = client
        .batch_scrape(urls, options)
        .await
        .expect("Batch scrape should succeed");

    assert!(
        job.status == JobStatus::Completed,
        "Job should be completed"
    );
}

#[tokio::test]
#[ignore = "Requires API access"]
async fn test_agent_async() {
    let client = get_client();
    let options = AgentOptions {
        urls: Some(vec!["https://example.com".to_string()]),
        prompt: "Describe what this website is about".to_string(),
        ..Default::default()
    };

    let response = client
        .start_agent(options)
        .await
        .expect("Start agent should succeed");

    assert!(response.success, "Response should indicate success");
    assert!(!response.id.is_empty(), "Response should contain task ID");
}

#[tokio::test]
#[ignore = "Requires API access"]
async fn test_agent_with_schema() {
    let client = get_client();

    #[derive(Debug, serde::Deserialize)]
    #[allow(dead_code)]
    struct WebsiteInfo {
        title: Option<String>,
        description: Option<String>,
    }

    let schema = json!({
        "type": "object",
        "properties": {
            "title": { "type": "string" },
            "description": { "type": "string" }
        }
    });

    let result: Option<WebsiteInfo> = client
        .agent_with_schema(
            vec!["https://example.com".to_string()],
            "Extract the title and description",
            schema,
        )
        .await
        .expect("Agent with schema should succeed");

    // Agent may or may not return data depending on the page
    if let Some(info) = result {
        println!("Agent extracted: {:?}", info);
    }
}

// Test that the client can be created with different configurations
// This test doesn't require API access
#[test]
fn test_client_creation() {
    // Cloud client requires API key
    let cloud_result = Client::new("test-key");
    assert!(cloud_result.is_ok());

    // Cloud client without API key should fail
    let cloud_no_key = Client::new_selfhosted("https://api.firecrawl.dev", None::<&str>);
    assert!(cloud_no_key.is_err());

    // Self-hosted client without API key should work
    let selfhosted = Client::new_selfhosted("http://localhost:3000", None::<&str>);
    assert!(selfhosted.is_ok());

    // Self-hosted client with API key should work
    let selfhosted_with_key = Client::new_selfhosted("http://localhost:3000", Some("key"));
    assert!(selfhosted_with_key.is_ok());
}