Spaces:
Sleeping
Sleeping
File size: 20,951 Bytes
097eaf0 | 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 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 | """
Firecrawl Client
A Firecrawl client that enables you to scrape content from websites, crawl entire sites, search the web, and extract structured data using AI.
The client supports both v1 and v2 API versions, providing access to features like:
- Web scraping with advanced options (screenshots, markdown conversion, etc.)
- Site crawling with configurable depth and limits
- Web search with content extraction
- Structured data extraction using AI models
- Deep research capabilities
Usage:
from firecrawl import Firecrawl
firecrawl = Firecrawl(api_key="your-api-key")
result = firecrawl.scrape("https://example.com")
Check example.py for other usage examples.
"""
from pathlib import Path
from typing import Any, Dict, Optional, List, Union, BinaryIO
import logging
from .v1 import V1FirecrawlApp, AsyncV1FirecrawlApp
from .v2 import FirecrawlClient as V2FirecrawlClient
from .v2.client_async import AsyncFirecrawlClient
from .v2.types import Document, ParseOptions, ScrapeOptions
logger = logging.getLogger("firecrawl")
class V1Proxy:
"""Type-annotated proxy for v1 client methods."""
_client: Optional[V1FirecrawlApp]
def __init__(self, client_instance: Optional[V1FirecrawlApp]):
self._client = client_instance
if client_instance:
self.scrape_url = client_instance.scrape_url
self.crawl_url = client_instance.crawl_url
self.batch_scrape_urls = client_instance.batch_scrape_urls
self.async_batch_scrape_urls = client_instance.async_batch_scrape_urls
self.async_crawl_url = client_instance.async_crawl_url
self.check_crawl_status = client_instance.check_crawl_status
self.map_url = client_instance.map_url
self.extract = client_instance.extract
self.deep_research = client_instance.deep_research
self.generate_llms_text = client_instance.generate_llms_text
class V2Proxy:
"""Proxy class that forwards method calls to the appropriate version client."""
_client: Optional[V2FirecrawlClient]
def __init__(self, client_instance: Optional[V2FirecrawlClient]):
self._client = client_instance
if client_instance:
self.scrape = client_instance.scrape
self.interact = client_instance.interact
self.stop_interaction = client_instance.stop_interaction
self.stop_interactive_browser = client_instance.stop_interactive_browser
self.scrape_execute = self.interact
self.delete_scrape_browser = self.stop_interaction
self.parse = client_instance.parse
self.search = client_instance.search
self.crawl = client_instance.crawl
self.start_crawl = client_instance.start_crawl
self.get_crawl_status = client_instance.get_crawl_status
self.get_crawl_status_page = client_instance.get_crawl_status_page
self.cancel_crawl = client_instance.cancel_crawl
self.get_crawl_errors = client_instance.get_crawl_errors
self.get_active_crawls = client_instance.get_active_crawls
self.active_crawls = client_instance.active_crawls
self.crawl_params_preview = client_instance.crawl_params_preview
self.extract = client_instance.extract
self.start_extract = client_instance.start_extract
self.get_extract_status = client_instance.get_extract_status
self.agent = client_instance.agent
self.start_agent = client_instance.start_agent
self.get_agent_status = client_instance.get_agent_status
self.cancel_agent = client_instance.cancel_agent
self.start_batch_scrape = client_instance.start_batch_scrape
self.get_batch_scrape_status = client_instance.get_batch_scrape_status
self.get_batch_scrape_status_page = client_instance.get_batch_scrape_status_page
self.cancel_batch_scrape = client_instance.cancel_batch_scrape
self.batch_scrape = client_instance.batch_scrape
self.get_batch_scrape_errors = client_instance.get_batch_scrape_errors
self.map = client_instance.map
self.create_monitor = client_instance.create_monitor
self.list_monitors = client_instance.list_monitors
self.get_monitor = client_instance.get_monitor
self.update_monitor = client_instance.update_monitor
self.delete_monitor = client_instance.delete_monitor
self.run_monitor = client_instance.run_monitor
self.list_monitor_checks = client_instance.list_monitor_checks
self.get_monitor_check = client_instance.get_monitor_check
self.get_concurrency = client_instance.get_concurrency
self.get_credit_usage = client_instance.get_credit_usage
self.get_token_usage = client_instance.get_token_usage
self.get_queue_status = client_instance.get_queue_status
self.browser = client_instance.browser
self.browser_execute = client_instance.browser_execute
self.delete_browser = client_instance.delete_browser
self.list_browsers = client_instance.list_browsers
self.watcher = client_instance.watcher
def __getattr__(self, name):
"""Forward attribute access to the underlying client."""
return getattr(self._client, name)
class AsyncV1Proxy:
"""Type-annotated proxy for v1 client methods."""
_client: Optional[AsyncV1FirecrawlApp]
def __init__(self, client_instance: Optional[AsyncV1FirecrawlApp]):
self._client = client_instance
if client_instance:
self.scrape_url = client_instance.scrape_url
self.crawl_url = client_instance.crawl_url
self.batch_scrape_urls = client_instance.batch_scrape_urls
self.async_batch_scrape_urls = client_instance.async_batch_scrape_urls
self.async_crawl_url = client_instance.async_crawl_url
self.check_crawl_status = client_instance.check_crawl_status
self.map_url = client_instance.map_url
self.extract = client_instance.extract
self.deep_research = client_instance.deep_research
self.generate_llms_text = client_instance.generate_llms_text
class AsyncV2Proxy:
"""Proxy class that forwards method calls to the appropriate version client."""
_client: Optional[AsyncFirecrawlClient] = None
def __init__(self, client_instance: Optional[AsyncFirecrawlClient] = None):
self._client = client_instance
if client_instance:
self.scrape = client_instance.scrape
self.interact = client_instance.interact
self.stop_interaction = client_instance.stop_interaction
self.stop_interactive_browser = client_instance.stop_interactive_browser
self.scrape_execute = self.interact
self.delete_scrape_browser = self.stop_interaction
self.parse = client_instance.parse
self.search = client_instance.search
self.crawl = client_instance.crawl
self.start_crawl = client_instance.start_crawl
self.wait_crawl = client_instance.wait_crawl
self.get_crawl_status = client_instance.get_crawl_status
self.get_crawl_status_page = client_instance.get_crawl_status_page
self.cancel_crawl = client_instance.cancel_crawl
self.get_crawl_errors = client_instance.get_crawl_errors
self.get_active_crawls = client_instance.get_active_crawls
self.active_crawls = client_instance.active_crawls
self.crawl_params_preview = client_instance.crawl_params_preview
self.extract = client_instance.extract
self.start_extract = client_instance.start_extract
self.get_extract_status = client_instance.get_extract_status
self.agent = client_instance.agent
self.start_agent = client_instance.start_agent
self.get_agent_status = client_instance.get_agent_status
self.cancel_agent = client_instance.cancel_agent
self.start_batch_scrape = client_instance.start_batch_scrape
self.get_batch_scrape_status = client_instance.get_batch_scrape_status
self.get_batch_scrape_status_page = client_instance.get_batch_scrape_status_page
self.cancel_batch_scrape = client_instance.cancel_batch_scrape
self.wait_batch_scrape = client_instance.wait_batch_scrape
self.batch_scrape = client_instance.batch_scrape
self.get_batch_scrape_errors = client_instance.get_batch_scrape_errors
self.map = client_instance.map
self.create_monitor = client_instance.create_monitor
self.list_monitors = client_instance.list_monitors
self.get_monitor = client_instance.get_monitor
self.update_monitor = client_instance.update_monitor
self.delete_monitor = client_instance.delete_monitor
self.run_monitor = client_instance.run_monitor
self.list_monitor_checks = client_instance.list_monitor_checks
self.get_monitor_check = client_instance.get_monitor_check
self.get_concurrency = client_instance.get_concurrency
self.get_credit_usage = client_instance.get_credit_usage
self.get_token_usage = client_instance.get_token_usage
self.get_queue_status = client_instance.get_queue_status
self.browser = client_instance.browser
self.browser_execute = client_instance.browser_execute
self.delete_browser = client_instance.delete_browser
self.list_browsers = client_instance.list_browsers
self.watcher = client_instance.watcher
def __getattr__(self, name):
"""Forward attribute access to the underlying client."""
if self._client:
return getattr(self._client, name)
raise AttributeError(f"Async v2 client not implemented yet: {name}")
class Firecrawl:
"""
Unified Firecrawl client (v2 by default, v1 under ``.v1``).
Provides a single entrypoint that exposes the latest API directly while
keeping a feature-frozen v1 available for incremental migration.
"""
def __init__(
self,
api_key: str = None,
api_url: str = "https://api.firecrawl.dev",
timeout: float = None,
max_retries: int = 3,
backoff_factor: float = 0.5,
):
"""Initialize the unified client.
Args:
api_key: Firecrawl API key (or set ``FIRECRAWL_API_KEY``)
api_url: Base API URL (defaults to production)
timeout: Default request timeout in seconds for all HTTP requests
max_retries: Maximum number of retries for failed requests (default: 3)
backoff_factor: Exponential backoff factor for retries (default: 0.5)
"""
self.api_key = api_key
self.api_url = api_url
# Initialize version-specific clients
self._v1_client = V1FirecrawlApp(api_key=api_key, api_url=api_url) if V1FirecrawlApp else None
self._v2_client = V2FirecrawlClient(
api_key=api_key,
api_url=api_url,
timeout=timeout,
max_retries=max_retries,
backoff_factor=backoff_factor,
) if V2FirecrawlClient else None
# Create version-specific proxies
self.v1 = V1Proxy(self._v1_client) if self._v1_client else None
self.v2 = V2Proxy(self._v2_client)
self.scrape = self._v2_client.scrape
self.interact = self._v2_client.interact
self.stop_interaction = self._v2_client.stop_interaction
self.stop_interactive_browser = self._v2_client.stop_interactive_browser
self.scrape_execute = self.interact
self.delete_scrape_browser = self.stop_interaction
self.parse = self._v2_client.parse
self.search = self._v2_client.search
self.map = self._v2_client.map
self.create_monitor = self._v2_client.create_monitor
self.list_monitors = self._v2_client.list_monitors
self.get_monitor = self._v2_client.get_monitor
self.update_monitor = self._v2_client.update_monitor
self.delete_monitor = self._v2_client.delete_monitor
self.run_monitor = self._v2_client.run_monitor
self.list_monitor_checks = self._v2_client.list_monitor_checks
self.get_monitor_check = self._v2_client.get_monitor_check
self.crawl = self._v2_client.crawl
self.start_crawl = self._v2_client.start_crawl
self.crawl_params_preview = self._v2_client.crawl_params_preview
self.get_crawl_status = self._v2_client.get_crawl_status
self.get_crawl_status_page = self._v2_client.get_crawl_status_page
self.cancel_crawl = self._v2_client.cancel_crawl
self.get_crawl_errors = self._v2_client.get_crawl_errors
self.get_active_crawls = self._v2_client.get_active_crawls
self.active_crawls = self._v2_client.active_crawls
self.start_batch_scrape = self._v2_client.start_batch_scrape
self.get_batch_scrape_status = self._v2_client.get_batch_scrape_status
self.get_batch_scrape_status_page = self._v2_client.get_batch_scrape_status_page
self.cancel_batch_scrape = self._v2_client.cancel_batch_scrape
self.batch_scrape = self._v2_client.batch_scrape
self.get_batch_scrape_errors = self._v2_client.get_batch_scrape_errors
self.start_extract = self._v2_client.start_extract
self.get_extract_status = self._v2_client.get_extract_status
self.extract = self._v2_client.extract
self.start_agent = self._v2_client.start_agent
self.get_agent_status = self._v2_client.get_agent_status
self.cancel_agent = self._v2_client.cancel_agent
self.agent = self._v2_client.agent
self.get_concurrency = self._v2_client.get_concurrency
self.get_credit_usage = self._v2_client.get_credit_usage
self.get_token_usage = self._v2_client.get_token_usage
self.get_queue_status = self._v2_client.get_queue_status
self.browser = self._v2_client.browser
self.browser_execute = self._v2_client.browser_execute
self.delete_browser = self._v2_client.delete_browser
self.list_browsers = self._v2_client.list_browsers
self.watcher = self._v2_client.watcher
self.scrape_url = self._v2_client.scrape_url
self.crawl_url = self._v2_client.crawl_url
self.map_url = self._v2_client.map_url
self.async_crawl_url = self._v2_client.async_crawl_url
self.check_crawl_status = self._v2_client.check_crawl_status
self.check_crawl_errors = self._v2_client.check_crawl_errors
self.batch_scrape_urls = self._v2_client.batch_scrape_urls
self.async_batch_scrape_urls = self._v2_client.async_batch_scrape_urls
self.check_batch_scrape_status = self._v2_client.check_batch_scrape_status
self.check_batch_scrape_errors = self._v2_client.check_batch_scrape_errors
def parse(
self,
file: Union[str, Path, bytes, bytearray, BinaryIO],
*,
filename: Optional[str] = None,
content_type: Optional[str] = None,
options: Optional[ParseOptions] = None,
) -> Document:
"""Parse an uploaded file via the v2 parse endpoint."""
return self._v2_client.parse(
file,
filename=filename,
content_type=content_type,
options=options,
)
class AsyncFirecrawl:
"""Async unified Firecrawl client (v2 by default, v1 under ``.v1``)."""
def __init__(
self,
api_key: str = None,
api_url: str = "https://api.firecrawl.dev",
timeout: float = None,
max_retries: int = 3,
backoff_factor: float = 0.5,
):
self.api_key = api_key
self.api_url = api_url
# Initialize version-specific clients
self._v1_client = AsyncV1FirecrawlApp(api_key=api_key, api_url=api_url) if AsyncV1FirecrawlApp else None
self._v2_client = AsyncFirecrawlClient(
api_key=api_key,
api_url=api_url,
timeout=timeout,
max_retries=max_retries,
backoff_factor=backoff_factor,
) if AsyncFirecrawlClient else None
# Create version-specific proxies
self.v1 = AsyncV1Proxy(self._v1_client) if self._v1_client else None
self.v2 = AsyncV2Proxy(self._v2_client)
# Expose v2 async surface directly on the top-level client for ergonomic access
# Keep method names aligned with the sync client
self.scrape = self._v2_client.scrape
self.interact = self._v2_client.interact
self.stop_interaction = self._v2_client.stop_interaction
self.stop_interactive_browser = self._v2_client.stop_interactive_browser
self.scrape_execute = self.interact
self.delete_scrape_browser = self.stop_interaction
self.parse = self._v2_client.parse
self.search = self._v2_client.search
self.map = self._v2_client.map
self.create_monitor = self._v2_client.create_monitor
self.list_monitors = self._v2_client.list_monitors
self.get_monitor = self._v2_client.get_monitor
self.update_monitor = self._v2_client.update_monitor
self.delete_monitor = self._v2_client.delete_monitor
self.run_monitor = self._v2_client.run_monitor
self.list_monitor_checks = self._v2_client.list_monitor_checks
self.get_monitor_check = self._v2_client.get_monitor_check
self.start_crawl = self._v2_client.start_crawl
self.get_crawl_status = self._v2_client.get_crawl_status
self.get_crawl_status_page = self._v2_client.get_crawl_status_page
self.cancel_crawl = self._v2_client.cancel_crawl
self.crawl = self._v2_client.crawl
self.get_crawl_errors = self._v2_client.get_crawl_errors
self.active_crawls = self._v2_client.active_crawls
self.crawl_params_preview = self._v2_client.crawl_params_preview
self.start_batch_scrape = self._v2_client.start_batch_scrape
self.get_batch_scrape_status = self._v2_client.get_batch_scrape_status
self.get_batch_scrape_status_page = self._v2_client.get_batch_scrape_status_page
self.cancel_batch_scrape = self._v2_client.cancel_batch_scrape
self.batch_scrape = self._v2_client.batch_scrape
self.get_batch_scrape_errors = self._v2_client.get_batch_scrape_errors
self.start_extract = self._v2_client.start_extract
self.get_extract_status = self._v2_client.get_extract_status
self.extract = self._v2_client.extract
self.start_agent = self._v2_client.start_agent
self.get_agent_status = self._v2_client.get_agent_status
self.cancel_agent = self._v2_client.cancel_agent
self.agent = self._v2_client.agent
self.get_concurrency = self._v2_client.get_concurrency
self.get_credit_usage = self._v2_client.get_credit_usage
self.get_token_usage = self._v2_client.get_token_usage
self.get_queue_status = self._v2_client.get_queue_status
self.browser = self._v2_client.browser
self.browser_execute = self._v2_client.browser_execute
self.delete_browser = self._v2_client.delete_browser
self.list_browsers = self._v2_client.list_browsers
self.watcher = self._v2_client.watcher
self.scrape_url = self._v2_client.scrape_url
self.crawl_url = self._v2_client.crawl_url
self.map_url = self._v2_client.map_url
self.async_crawl_url = self._v2_client.async_crawl_url
self.check_crawl_status = self._v2_client.check_crawl_status
self.check_crawl_errors = self._v2_client.check_crawl_errors
self.batch_scrape_urls = self._v2_client.batch_scrape_urls
self.async_batch_scrape_urls = self._v2_client.async_batch_scrape_urls
self.check_batch_scrape_status = self._v2_client.check_batch_scrape_status
self.check_batch_scrape_errors = self._v2_client.check_batch_scrape_errors
async def parse(
self,
file: Union[str, Path, bytes, bytearray, BinaryIO],
*,
filename: Optional[str] = None,
content_type: Optional[str] = None,
options: Optional[ParseOptions] = None,
) -> Document:
"""Parse an uploaded file via the v2 parse endpoint."""
return await self._v2_client.parse(
file,
filename=filename,
content_type=content_type,
options=options,
)
# Export Firecrawl as an alias for FirecrawlApp
FirecrawlApp = Firecrawl
AsyncFirecrawlApp = AsyncFirecrawl
|