firecrawl 4.3.0__py3-none-any.whl → 4.3.2__py3-none-any.whl

firecrawl/__init__.py

@@ -17,7 +17,7 @@ from .v1 import (
     V1ChangeTrackingOptions,
 )
 
-__version__ = "4.3.0"
+__version__ = "4.3.2"
 
 # Define the logger for the Firecrawl project
 logger: logging.Logger = logging.getLogger("firecrawl")

firecrawl/__tests__/e2e/v2/aio/test_aio_usage.py

@@ -33,3 +33,10 @@ async def test_async_get_token_usage():
     tokens = await client.get_token_usage()
     assert hasattr(tokens, "remaining_tokens")
 
+
+@pytest.mark.asyncio
+async def test_async_get_queue_status():
+    client = AsyncFirecrawl(api_key=os.getenv("API_KEY"), api_url=os.getenv("API_URL"))
+    status = await client.get_queue_status()
+    assert hasattr(status, "jobs_in_queue")
+

firecrawl/client.py

@@ -56,23 +56,34 @@ class V2Proxy:
         self._client = client_instance
 
         if client_instance:
+            self.scrape = client_instance.scrape
             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.cancel_crawl = client_instance.cancel_crawl
-            self.start_crawl = client_instance.start_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.start_batch_scrape = client_instance.start_batch_scrape
             self.get_batch_scrape_status = client_instance.get_batch_scrape_status
             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.get_extract_status = client_instance.get_extract_status
+
             self.map = client_instance.map
             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.watcher = client_instance.watcher
     
     def __getattr__(self, name):
         """Forward attribute access to the underlying client."""
@@ -99,9 +110,9 @@ class AsyncV1Proxy:
 
 class AsyncV2Proxy:
     """Proxy class that forwards method calls to the appropriate version client."""
-    _client: Optional[Any] = None
+    _client: Optional[AsyncFirecrawlClient] = None
 
-    def __init__(self, client_instance: Optional[Any] = None):
+    def __init__(self, client_instance: Optional[AsyncFirecrawlClient] = None):
         self._client = client_instance
 
         if client_instance:
@@ -132,6 +143,8 @@ class AsyncV2Proxy:
             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.watcher = client_instance.watcher
 
     def __getattr__(self, name):
@@ -193,7 +206,8 @@ class Firecrawl:
         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.watcher = self._v2_client.watcher
         
 class AsyncFirecrawl:
@@ -238,6 +252,7 @@ class AsyncFirecrawl:
         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.watcher = self._v2_client.watcher
 

firecrawl/types.py

@@ -65,6 +65,9 @@ from .v2.types import (
     ExecuteJavascriptAction,
     PDFAction,
     
+    # Usage types
+    QueueStatusResponse,
+
     # Location and format types
     Location,
     
@@ -142,6 +145,9 @@ __all__ = [
     'ScrapeAction',
     'ExecuteJavascriptAction',
     'PDFAction',
+
+    # Usage types
+    'QueueStatusResponse',
     
     # Location and format types
     'Location',

firecrawl/v1/client.py

@@ -309,6 +309,7 @@ class V1MapParams(pydantic.BaseModel):
     limit: Optional[int] = None
     timeout: Optional[int] = 30000
     useIndex: Optional[bool] = None
+    location: Optional[V1LocationConfig] = None
 
 class V1MapResponse(pydantic.BaseModel):
     """Response from mapping operations."""
@@ -1333,6 +1334,7 @@ class V1FirecrawlApp:
             limit: Optional[int] = None,
             timeout: Optional[int] = 30000,
             use_index: Optional[bool] = None,
+            location: Optional[V1LocationConfig] = None,
             **kwargs) -> V1MapResponse:
         """
         Map and discover links from a URL.
@@ -1377,6 +1379,8 @@ class V1FirecrawlApp:
             map_params['timeout'] = timeout
         if use_index is not None:
             map_params['useIndex'] = use_index
+        if location is not None:
+            map_params['location'] = location.dict(by_alias=True, exclude_none=True)
         
         # Add any additional kwargs
         map_params.update(kwargs)
@@ -3910,6 +3914,7 @@ class AsyncV1FirecrawlApp(V1FirecrawlApp):
         sitemap_only: Optional[bool] = None,
         limit: Optional[int] = None,
         timeout: Optional[int] = 30000,
+        location: Optional[V1LocationConfig] = None,
         params: Optional[V1MapParams] = None) -> V1MapResponse:
         """
         Asynchronously map and discover links from a URL.
@@ -3952,6 +3957,8 @@ class AsyncV1FirecrawlApp(V1FirecrawlApp):
             map_params['limit'] = limit
         if timeout is not None:
             map_params['timeout'] = timeout
+        if location is not None:
+            map_params['location'] = location.dict(by_alias=True, exclude_none=True)
 
         # Create final params object
         final_params = V1MapParams(**map_params)

firecrawl/v2/client.py

@@ -421,6 +421,7 @@ class FirecrawlClient:
         limit: Optional[int] = None,
         sitemap: Optional[Literal["only", "include", "skip"]] = None,
         timeout: Optional[int] = None,
+        location: Optional[Location] = None,
     ) -> MapData:
         """Map a URL and return discovered links.
 
@@ -441,7 +442,8 @@ class FirecrawlClient:
             limit=limit,
             sitemap=sitemap if sitemap is not None else "include",
             timeout=timeout,
-        ) if any(v is not None for v in [search, include_subdomains, limit, sitemap, timeout]) else None
+            location=location
+        ) if any(v is not None for v in [search, include_subdomains, limit, sitemap, timeout, location]) else None
 
         return map_module.map(self.http_client, url, options)
     

firecrawl/v2/client_async.py

@@ -253,6 +253,18 @@ class AsyncFirecrawlClient:
     async def get_token_usage(self):
         from .methods.aio import usage as async_usage  # type: ignore[attr-defined]
         return await async_usage.get_token_usage(self.async_http_client)
+    
+    async def get_credit_usage_historical(self, by_api_key: bool = False):
+        from .methods.aio import usage as async_usage  # type: ignore[attr-defined]
+        return await async_usage.get_credit_usage_historical(self.async_http_client, by_api_key)
+    
+    async def get_token_usage_historical(self, by_api_key: bool = False):
+        from .methods.aio import usage as async_usage  # type: ignore[attr-defined]
+        return await async_usage.get_token_usage_historical(self.async_http_client, by_api_key)
+
+    async def get_queue_status(self):
+        from .methods.aio import usage as async_usage  # type: ignore[attr-defined]
+        return await async_usage.get_queue_status(self.async_http_client)
 
     # Watcher (sync object usable from async contexts)
     def watcher(

firecrawl/v2/methods/aio/map.py

@@ -20,6 +20,8 @@ def _prepare_map_request(url: str, options: Optional[MapOptions] = None) -> Dict
             data["limit"] = options.limit
         if options.timeout is not None:
             data["timeout"] = options.timeout
+        if options.location is not None:
+            data["location"] = options.location.model_dump(exclude_none=True)
         payload.update(data)
     return payload
 

firecrawl/v2/methods/aio/usage.py

@@ -1,6 +1,6 @@
 from ...utils.http_client_async import AsyncHttpClient
 from ...utils.error_handler import handle_response_error
-from ...types import ConcurrencyCheck, CreditUsage, TokenUsage, CreditUsageHistoricalResponse, TokenUsageHistoricalResponse
+from ...types import ConcurrencyCheck, CreditUsage, TokenUsage, CreditUsageHistoricalResponse, TokenUsageHistoricalResponse, QueueStatusResponse
 
 
 async def get_concurrency(client: AsyncHttpClient) -> ConcurrencyCheck:
@@ -49,6 +49,23 @@ async def get_token_usage(client: AsyncHttpClient) -> TokenUsage:
     )
 
 
+async def get_queue_status(client: AsyncHttpClient) -> QueueStatusResponse:
+    resp = await client.get("/v2/team/queue-status")
+    if resp.status_code >= 400:
+        handle_response_error(resp, "get queue status")
+    body = resp.json()
+    if not body.get("success"):
+        raise Exception(body.get("error", "Unknown error"))
+    data = body.get("data", body)
+    return QueueStatusResponse(
+        jobs_in_queue=data.get("jobsInQueue", 0),
+        active_jobs_in_queue=data.get("activeJobsInQueue", 0),
+        waiting_jobs_in_queue=data.get("waitingJobsInQueue", 0),
+        max_concurrency=data.get("maxConcurrency", 0),
+        most_recent_success=data.get("mostRecentSuccess", None),
+    )
+
+
 async def get_credit_usage_historical(client: AsyncHttpClient, by_api_key: bool = False) -> CreditUsageHistoricalResponse:
     query = "?byApiKey=true" if by_api_key else ""
     resp = await client.get(f"/v2/team/credit-usage/historical{query}")

firecrawl/v2/methods/map.py

@@ -27,6 +27,8 @@ def _prepare_map_request(url: str, options: Optional[MapOptions] = None) -> Dict
             data["limit"] = options.limit
         if options.timeout is not None:
             data["timeout"] = options.timeout
+        if options.location is not None:
+            data["location"] = options.location.model_dump(exclude_none=True)
         payload.update(data)
 
     return payload

firecrawl/v2/types.py

@@ -445,6 +445,7 @@ class MapOptions(BaseModel):
     include_subdomains: Optional[bool] = None
     limit: Optional[int] = None
     timeout: Optional[int] = None
+    location: Optional['Location'] = None
 
 class MapRequest(BaseModel):
     """Request for mapping a website."""

{firecrawl-4.3.0.dist-info → firecrawl-4.3.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: firecrawl
-Version: 4.3.0
+Version: 4.3.2
 Summary: Python SDK for Firecrawl API
 Home-page: https://github.com/firecrawl/firecrawl
 Author: Mendable.ai

{firecrawl-4.3.0.dist-info → firecrawl-4.3.2.dist-info}/RECORD

@@ -1,7 +1,7 @@
-firecrawl/__init__.py,sha256=Lrk_X9oaNHYEYdzuPTdwX7kjhfoZbVCsyEd4wd9Qi5Q,2192
-firecrawl/client.py,sha256=tp3mUo_3aGPuZ53kpU4bhM-5EtwD_IUWrJ7wm0GMuCc,11159
+firecrawl/__init__.py,sha256=EELRjS0VrQqhi-iR1LaRhECU1yXWbjtofVsp5NaxlTc,2192
+firecrawl/client.py,sha256=Lmrg2jniCETU6_xVMn_fgLrgDXiBixK9hSkkdsCGiog,11840
 firecrawl/firecrawl.backup.py,sha256=v1FEN3jR4g5Aupg4xp6SLkuFvYMQuUKND2YELbYjE6c,200430
-firecrawl/types.py,sha256=W9N2pqQuevEIIjYHN9rbDf31E-nwdCECqIn11Foz2T8,2836
+firecrawl/types.py,sha256=T1g8r12xIWxJSoSNrL58SSgc1F8SykrwVx92BhTvZuc,2926
 firecrawl/__tests__/e2e/v2/conftest.py,sha256=I28TUpN5j0-9gM79NlbrDS8Jlsheao657od2f-2xK0Y,2587
 firecrawl/__tests__/e2e/v2/test_async.py,sha256=ZXpf1FVOJgNclITglrxIyFwP4cOiqzWLicGaxIm70BQ,2526
 firecrawl/__tests__/e2e/v2/test_batch_scrape.py,sha256=H9GtuwHIFdOQ958SOVThi_kvDDxcXAK_ECRh95ogonQ,3265
@@ -18,7 +18,7 @@ firecrawl/__tests__/e2e/v2/aio/test_aio_extract.py,sha256=3CNRIFzgBMcOYOLhnKcK1k
 firecrawl/__tests__/e2e/v2/aio/test_aio_map.py,sha256=nckl1kbiEaaTdu5lm__tOoTDG-txTYwwSH3KZEvyKzc,1199
 firecrawl/__tests__/e2e/v2/aio/test_aio_scrape.py,sha256=b17A7advBEjxrjdait2w8GHztZeKy_P3zZ3ixm5H7xw,4453
 firecrawl/__tests__/e2e/v2/aio/test_aio_search.py,sha256=ehV0Ai_hknAkaoE551j2lbktV4bi_J0h3FKzC7G15Iw,8246
-firecrawl/__tests__/e2e/v2/aio/test_aio_usage.py,sha256=Dh9BVo48NKSZOKgLbO7n8fpMjvYmeMXDFzbIhnCTMhE,1014
+firecrawl/__tests__/e2e/v2/aio/test_aio_usage.py,sha256=lVGfwR79eaZamUZXgKStUJcpclCnnlpwHGo2pMOUhCY,1255
 firecrawl/__tests__/e2e/v2/aio/test_aio_watcher.py,sha256=hwES4Nu5c0hniZ9heIPDfvh_2JmJ2wPoX9ULTZ0Asjs,1471
 firecrawl/__tests__/unit/v2/methods/test_batch_request_preparation.py,sha256=HeOxN-sPYSssytcIRAEicJSZsFt_Oa5qGXAtdumR54c,4040
 firecrawl/__tests__/unit/v2/methods/test_crawl_params.py,sha256=p9hzg14uAs1iHKXPDSXhGU6hEzPBF_Ae34RAf5XYa10,2387
@@ -42,17 +42,17 @@ firecrawl/__tests__/unit/v2/methods/aio/test_ensure_async.py,sha256=pUwuWhRbVUTb
 firecrawl/__tests__/unit/v2/utils/test_validation.py,sha256=E4n4jpBhH_W7E0ikI5r8KMAKiOhbfGD3i_B8-dv3PlI,10803
 firecrawl/__tests__/unit/v2/watcher/test_ws_watcher.py,sha256=87w47n0iOihtu4jTR4-4rw1-xVKWmLg2BOBGxjQPnUk,9517
 firecrawl/v1/__init__.py,sha256=aP1oisPeZVGGZynvENc07JySMOZfv_4zAlxQ0ecMJXA,481
-firecrawl/v1/client.py,sha256=33o_sPOyPsRfM1j2PUiKTkvbnPCkmL7-Ou54D1sx-rE,207710
+firecrawl/v1/client.py,sha256=2Rq38RxGnuf2dMCmr4cc3f-ythavcBkUyJmRrwLmMHg,208104
 firecrawl/v2/__init__.py,sha256=Jc6a8tBjYG5OPkjDM5pl-notyys-7DEj7PLEfepv3fc,137
-firecrawl/v2/client.py,sha256=aEISMnyKKzh5jcrLdpkC3WCZ7cMWj5vo1Gk7ljc9gwk,31821
-firecrawl/v2/client_async.py,sha256=XyzojIJlWatBGlAMish22H-XHkkH9zHsD6MGtAdtFg8,10487
-firecrawl/v2/types.py,sha256=itKhycxDQ9a3wltK28qFLxLVVvsvb5APoS1kOiiS8ac,24341
+firecrawl/v2/client.py,sha256=1PznRrX1kl-Wenv2Ilm5oVoU3V9HDtkMXuTsOFr8Ow8,31906
+firecrawl/v2/client_async.py,sha256=HAewaYnHrvQQgkSQfwwNeWvAuj3JZqceQk6T10RKxeg,11204
+firecrawl/v2/types.py,sha256=fJ6FySoZ30-4HAdU3XLPeWplQmB9b5p_ohWMh8Dg9_Y,24383
 firecrawl/v2/watcher.py,sha256=FOU71tqSKxgeuGycu4ye0SLc2dw7clIcoQjPsi-4Csc,14229
 firecrawl/v2/watcher_async.py,sha256=AVjW2mgABniolSsauK4u0FW8ya6WzRUdyEg2R-8vGCw,10278
 firecrawl/v2/methods/batch.py,sha256=jFSIPtvulUrPz3Y3zT1gDNwYEf8Botpfh4GOeYsVYRI,14852
 firecrawl/v2/methods/crawl.py,sha256=DWH1wUUDpE0zPSRALkQj_vF-PdsT0A1NyAGtnfcDaR8,18634
 firecrawl/v2/methods/extract.py,sha256=-Jr4BtraU3b7hd3JIY73V-S69rUclxyXyUpoQb6DCQk,4274
-firecrawl/v2/methods/map.py,sha256=4SADb0-lkbdOWDmO6k8_TzK0yRti5xsN40N45nUl9uA,2592
+firecrawl/v2/methods/map.py,sha256=C7ltFFwhC6XVZKAVVnPsapmBi6Lp_2Mm9r7TtB0cZ0I,2711
 firecrawl/v2/methods/scrape.py,sha256=CSHBwC-P91UfrW3zHirjNAs2h899FKcWvd1DY_4fJdo,1921
 firecrawl/v2/methods/search.py,sha256=6BKiQ1aKJjWBKm9BBtKxFKGD74kCKBeMIp_OgjcDFAw,7673
 firecrawl/v2/methods/usage.py,sha256=NqkmFd-ziw8ijbZxwaxjxZHl85u0LTe_TYqr_NGWFwE,3693
@@ -60,10 +60,10 @@ firecrawl/v2/methods/aio/__init__.py,sha256=RocMJnGwnLIvGu3G8ZvY8INkipC7WHZiu2bE
 firecrawl/v2/methods/aio/batch.py,sha256=4Uj05ffpMhQA2J_mkvHYYogdXb0IgbKGbomO43b4m94,6741
 firecrawl/v2/methods/aio/crawl.py,sha256=j2Tb2AcGsT6bCiUbB2yjrfvGZqkinUt0tU-SzWmB7Jw,11551
 firecrawl/v2/methods/aio/extract.py,sha256=IfNr2ETqt4dR73JFzrEYI4kk5vpKnJOG0BmPEjGEoO4,4217
-firecrawl/v2/methods/aio/map.py,sha256=EuT-5A0cQr_e5SBfEZ6pnl8u0JUwEEvSwhyT2N-QoKU,2326
+firecrawl/v2/methods/aio/map.py,sha256=WQTl2zSr_9KhrQMuvnRCCymiYjEailp8cAcMssG6Xx4,2445
 firecrawl/v2/methods/aio/scrape.py,sha256=ilA9qco8YGwCFpE0PN1XBQUyuHPQwH2QioZ-xsfxhgU,1386
 firecrawl/v2/methods/aio/search.py,sha256=_TqTFGQLlOCCLNdWcOvakTqPGD2r9AOlBg8RasOgmvw,6177
-firecrawl/v2/methods/aio/usage.py,sha256=qM5PsPuA_N1pUTnZF4Raq4VkBf_XCMSQdhOJBFFs17k,3239
+firecrawl/v2/methods/aio/usage.py,sha256=iUzTkdAWRheq-V5rRXcW0bc3MSODaVS1AqroRF0fO9M,3964
 firecrawl/v2/utils/__init__.py,sha256=i1GgxySmqEXpWSBQCu3iZBPIJG7fXj0QXCDWGwerWNs,338
 firecrawl/v2/utils/error_handler.py,sha256=Iuf916dHphDY8ObNNlWy75628DFeJ0Rv8ljRp4LttLE,4199
 firecrawl/v2/utils/get_version.py,sha256=0CxW_41q2hlzIxEWOivUCaYw3GFiSIH32RPUMcIgwAY,492
@@ -71,10 +71,10 @@ firecrawl/v2/utils/http_client.py,sha256=gUrC1CvU5sj03w27Lbq-3-yH38Yi_OXiI01-piw
 firecrawl/v2/utils/http_client_async.py,sha256=iy89_bk2HS3afSRHZ8016eMCa9Fk-5MFTntcOHfbPgE,1936
 firecrawl/v2/utils/normalize.py,sha256=nlTU6QRghT1YKZzNZlIQj4STSRuSUGrS9cCErZIcY5w,3636
 firecrawl/v2/utils/validation.py,sha256=qWWiWaVcvODmVxf9rxIVy1j_dyuJCvdMMUoYhvWUEIU,15269
-firecrawl-4.3.0.dist-info/licenses/LICENSE,sha256=nPCunEDwjRGHlmjvsiDUyIWbkqqyj3Ej84ntnh0g0zA,1084
+firecrawl-4.3.2.dist-info/licenses/LICENSE,sha256=nPCunEDwjRGHlmjvsiDUyIWbkqqyj3Ej84ntnh0g0zA,1084
 tests/test_change_tracking.py,sha256=_IJ5ShLcoj2fHDBaw-nE4I4lHdmDB617ocK_XMHhXps,4177
 tests/test_timeout_conversion.py,sha256=PWlIEMASQNhu4cp1OW_ebklnE9NCiigPnEFCtI5N3w0,3996
-firecrawl-4.3.0.dist-info/METADATA,sha256=xWtTodBOtFYrrFuKAOC7i657fmT45ZtpRXyNWd7i7mU,7392
-firecrawl-4.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-firecrawl-4.3.0.dist-info/top_level.txt,sha256=8T3jOaSN5mtLghO-R3MQ8KO290gIX8hmfxQmglBPdLE,16
-firecrawl-4.3.0.dist-info/RECORD,,
+firecrawl-4.3.2.dist-info/METADATA,sha256=tlvxxrTf5VI0Vz-zBYhEO75830MJZ1qV5wjRtqrptw4,7392
+firecrawl-4.3.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+firecrawl-4.3.2.dist-info/top_level.txt,sha256=8T3jOaSN5mtLghO-R3MQ8KO290gIX8hmfxQmglBPdLE,16
+firecrawl-4.3.2.dist-info/RECORD,,