firecrawl 4.1.1__tar.gz → 4.3.0__tar.gz

{firecrawl-4.1.1 → firecrawl-4.3.0}/PKG-INFO

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

{firecrawl-4.1.1 → firecrawl-4.3.0}/firecrawl/__init__.py

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

{firecrawl-4.1.1 → firecrawl-4.3.0}/firecrawl/v1/client.py

@@ -358,6 +358,46 @@ class V1SearchResponse(pydantic.BaseModel):
     warning: Optional[str] = None
     error: Optional[str] = None
 
+class V1CreditUsageData(pydantic.BaseModel):
+    remaining_credits: int
+    plan_credits: Optional[int] = None
+    billing_period_start: Optional[str] = None
+    billing_period_end: Optional[str] = None
+
+class V1CreditUsageResponse(pydantic.BaseModel):
+    success: bool
+    data: V1CreditUsageData
+
+class V1TokenUsageData(pydantic.BaseModel):
+    remaining_tokens: int
+    plan_tokens: Optional[int] = None
+    billing_period_start: Optional[str] = None
+    billing_period_end: Optional[str] = None
+
+class V1TokenUsageResponse(pydantic.BaseModel):
+    success: bool
+    data: V1TokenUsageData
+
+class V1CreditUsageHistoricalPeriod(pydantic.BaseModel):
+    startDate: Optional[str] = None
+    endDate: Optional[str] = None
+    apiKey: Optional[str] = None
+    creditsUsed: int
+
+class V1CreditUsageHistoricalResponse(pydantic.BaseModel):
+    success: bool
+    periods: List[V1CreditUsageHistoricalPeriod]
+
+class V1TokenUsageHistoricalPeriod(pydantic.BaseModel):
+    startDate: Optional[str] = None
+    endDate: Optional[str] = None
+    apiKey: Optional[str] = None
+    tokensUsed: int
+
+class V1TokenUsageHistoricalResponse(pydantic.BaseModel):
+    success: bool
+    periods: List[V1TokenUsageHistoricalPeriod]
+
 class V1GenerateLLMsTextParams(pydantic.BaseModel):
     """
     Parameters for the LLMs.txt generation operation.
@@ -722,6 +762,90 @@ class V1FirecrawlApp:
         else:
             self._handle_error(response, 'search')
 
+    def get_credit_usage(self) -> V1CreditUsageResponse:
+        """Get current credit usage and billing period (v1)."""
+        _headers = self._prepare_headers()
+        response = self._get_request(
+            f"{self.api_url}/v1/team/credit-usage",
+            _headers
+        )
+
+        if response.status_code == 200:
+            try:
+                response_json = response.json()
+                if response_json.get('success') and 'data' in response_json:
+                    return V1CreditUsageResponse(**response_json)
+                elif "error" in response_json:
+                    raise Exception(f"Failed to get credit usage. Error: {response_json['error']}")
+                else:
+                    raise Exception(f"Failed to get credit usage. Error: {response_json}")
+            except ValueError:
+                raise Exception('Failed to parse Firecrawl response as JSON.')
+        else:
+            self._handle_error(response, 'get credit usage')
+
+    def get_token_usage(self) -> V1TokenUsageResponse:
+        """Get current token usage and billing period (v1)."""
+        _headers = self._prepare_headers()
+        response = self._get_request(
+            f"{self.api_url}/v1/team/token-usage",
+            _headers
+        )
+
+        if response.status_code == 200:
+            try:
+                response_json = response.json()
+                if response_json.get('success') and 'data' in response_json:
+                    return V1TokenUsageResponse(**response_json)
+                elif "error" in response_json:
+                    raise Exception(f"Failed to get token usage. Error: {response_json['error']}")
+                else:
+                    raise Exception(f"Failed to get token usage. Error: {response_json}")
+            except ValueError:
+                raise Exception('Failed to parse Firecrawl response as JSON.')
+        else:
+            self._handle_error(response, 'get token usage')
+
+    def get_credit_usage_historical(self, by_api_key: bool = False) -> V1CreditUsageHistoricalResponse:
+        """Get historical credit usage (v1)."""
+        _headers = self._prepare_headers()
+        url = f"{self.api_url}/v1/team/credit-usage/historical" + ("?byApiKey=true" if by_api_key else "")
+        response = self._get_request(url, _headers)
+
+        if response.status_code == 200:
+            try:
+                response_json = response.json()
+                if response_json.get('success') and 'periods' in response_json:
+                    return V1CreditUsageHistoricalResponse(**response_json)
+                elif "error" in response_json:
+                    raise Exception(f"Failed to get historical credit usage. Error: {response_json['error']}")
+                else:
+                    raise Exception(f"Failed to get historical credit usage. Error: {response_json}")
+            except ValueError:
+                raise Exception('Failed to parse Firecrawl response as JSON.')
+        else:
+            self._handle_error(response, 'get credit usage historical')
+
+    def get_token_usage_historical(self, by_api_key: bool = False) -> V1TokenUsageHistoricalResponse:
+        """Get historical token usage (v1)."""
+        _headers = self._prepare_headers()
+        url = f"{self.api_url}/v1/team/token-usage/historical" + ("?byApiKey=true" if by_api_key else "")
+        response = self._get_request(url, _headers)
+
+        if response.status_code == 200:
+            try:
+                response_json = response.json()
+                if response_json.get('success') and 'periods' in response_json:
+                    return V1TokenUsageHistoricalResponse(**response_json)
+                elif "error" in response_json:
+                    raise Exception(f"Failed to get historical token usage. Error: {response_json['error']}")
+                else:
+                    raise Exception(f"Failed to get historical token usage. Error: {response_json}")
+            except ValueError:
+                raise Exception('Failed to parse Firecrawl response as JSON.')
+        else:
+            self._handle_error(response, 'get token usage historical')
+
     def crawl_url(
         self,
         url: str,
@@ -2913,6 +3037,24 @@ class AsyncV1FirecrawlApp(V1FirecrawlApp):
         """
         return self._get_error_message(status_code, action, error_message, error_details)
 
+    async def get_credit_usage(self) -> V1CreditUsageResponse:
+        """Get current credit usage and billing period (v1, async)."""
+        headers = self._prepare_headers()
+        resp = await self._async_get_request(
+            f"{self.api_url}/v1/team/credit-usage",
+            headers
+        )
+        return V1CreditUsageResponse(**resp)
+
+    async def get_token_usage(self) -> V1TokenUsageResponse:
+        """Get current token usage and billing period (v1, async)."""
+        headers = self._prepare_headers()
+        resp = await self._async_get_request(
+            f"{self.api_url}/v1/team/token-usage",
+            headers
+        )
+        return V1TokenUsageResponse(**resp)
+
     async def crawl_url_and_watch(
             self,
             url: str,

{firecrawl-4.1.1 → firecrawl-4.3.0}/firecrawl/v2/client.py

@@ -727,6 +727,18 @@ class FirecrawlClient:
         """Get recent token usage metrics (v2)."""
         return usage_methods.get_token_usage(self.http_client)
 
+    def get_credit_usage_historical(self, by_api_key: bool = False):
+        """Get historical credit usage (v2)."""
+        return usage_methods.get_credit_usage_historical(self.http_client, by_api_key)
+
+    def get_token_usage_historical(self, by_api_key: bool = False):
+        """Get historical token usage (v2)."""
+        return usage_methods.get_token_usage_historical(self.http_client, by_api_key)
+
+    def get_queue_status(self):
+        """Get metrics about the team's scrape queue."""
+        return usage_methods.get_queue_status(self.http_client)
+
     def watcher(
         self,
         job_id: str,

firecrawl-4.3.0/firecrawl/v2/methods/aio/usage.py

@@ -0,0 +1,72 @@
+from ...utils.http_client_async import AsyncHttpClient
+from ...utils.error_handler import handle_response_error
+from ...types import ConcurrencyCheck, CreditUsage, TokenUsage, CreditUsageHistoricalResponse, TokenUsageHistoricalResponse
+
+
+async def get_concurrency(client: AsyncHttpClient) -> ConcurrencyCheck:
+    resp = await client.get("/v2/concurrency-check")
+    if resp.status_code >= 400:
+        handle_response_error(resp, "get concurrency")
+    body = resp.json()
+    if not body.get("success"):
+        raise Exception(body.get("error", "Unknown error"))
+    data = body.get("data", body)
+    return ConcurrencyCheck(
+        concurrency=data.get("concurrency"),
+        max_concurrency=data.get("maxConcurrency", data.get("max_concurrency")),
+    )
+
+
+async def get_credit_usage(client: AsyncHttpClient) -> CreditUsage:
+    resp = await client.get("/v2/team/credit-usage")
+    if resp.status_code >= 400:
+        handle_response_error(resp, "get credit usage")
+    body = resp.json()
+    if not body.get("success"):
+        raise Exception(body.get("error", "Unknown error"))
+    data = body.get("data", body)
+    return CreditUsage(
+        remaining_credits=data.get("remainingCredits", data.get("remaining_credits", 0)),
+        plan_credits=data.get("planCredits", data.get("plan_credits")),
+        billing_period_start=data.get("billingPeriodStart", data.get("billing_period_start")),
+        billing_period_end=data.get("billingPeriodEnd", data.get("billing_period_end")),
+    )
+
+
+async def get_token_usage(client: AsyncHttpClient) -> TokenUsage:
+    resp = await client.get("/v2/team/token-usage")
+    if resp.status_code >= 400:
+        handle_response_error(resp, "get token usage")
+    body = resp.json()
+    if not body.get("success"):
+        raise Exception(body.get("error", "Unknown error"))
+    data = body.get("data", body)
+    return TokenUsage(
+        remaining_tokens=data.get("remainingTokens", data.get("remaining_tokens", 0)),
+        plan_tokens=data.get("planTokens", data.get("plan_tokens")),
+        billing_period_start=data.get("billingPeriodStart", data.get("billing_period_start")),
+        billing_period_end=data.get("billingPeriodEnd", data.get("billing_period_end")),
+    )
+
+
+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}")
+    if resp.status_code >= 400:
+        handle_response_error(resp, "get credit usage historical")
+    body = resp.json()
+    if not body.get("success"):
+        raise Exception(body.get("error", "Unknown error"))
+    return CreditUsageHistoricalResponse(**body)
+
+
+async def get_token_usage_historical(client: AsyncHttpClient, by_api_key: bool = False) -> TokenUsageHistoricalResponse:
+    query = "?byApiKey=true" if by_api_key else ""
+    resp = await client.get(f"/v2/team/token-usage/historical{query}")
+    if resp.status_code >= 400:
+        handle_response_error(resp, "get token usage historical")
+    body = resp.json()
+    if not body.get("success"):
+        raise Exception(body.get("error", "Unknown error"))
+    return TokenUsageHistoricalResponse(**body)
+

firecrawl-4.3.0/firecrawl/v2/methods/usage.py

@@ -0,0 +1,84 @@
+from ..utils import HttpClient, handle_response_error
+from ..types import ConcurrencyCheck, CreditUsage, QueueStatusResponse, TokenUsage, CreditUsageHistoricalResponse, TokenUsageHistoricalResponse
+
+
+def get_concurrency(client: HttpClient) -> ConcurrencyCheck:
+    resp = client.get("/v2/concurrency-check")
+    if not resp.ok:
+        handle_response_error(resp, "get concurrency")
+    body = resp.json()
+    if not body.get("success"):
+        raise Exception(body.get("error", "Unknown error"))
+    data = body.get("data", body)
+    return ConcurrencyCheck(
+        concurrency=data.get("concurrency"),
+        max_concurrency=data.get("maxConcurrency", data.get("max_concurrency")),
+    )
+
+
+def get_credit_usage(client: HttpClient) -> CreditUsage:
+    resp = client.get("/v2/team/credit-usage")
+    if not resp.ok:
+        handle_response_error(resp, "get credit usage")
+    body = resp.json()
+    if not body.get("success"):
+        raise Exception(body.get("error", "Unknown error"))
+    data = body.get("data", body)
+    return CreditUsage(
+        remaining_credits=data.get("remainingCredits", data.get("remaining_credits", 0)),
+        plan_credits=data.get("planCredits", data.get("plan_credits")),
+        billing_period_start=data.get("billingPeriodStart", data.get("billing_period_start")),
+        billing_period_end=data.get("billingPeriodEnd", data.get("billing_period_end")),
+    )
+
+
+def get_token_usage(client: HttpClient) -> TokenUsage:
+    resp = client.get("/v2/team/token-usage")
+    if not resp.ok:
+        handle_response_error(resp, "get token usage")
+    body = resp.json()
+    if not body.get("success"):
+        raise Exception(body.get("error", "Unknown error"))
+    data = body.get("data", body)
+    return TokenUsage(
+        remaining_tokens=data.get("remainingTokens", data.get("remaining_tokens", 0)),
+        plan_tokens=data.get("planTokens", data.get("plan_tokens")),
+        billing_period_start=data.get("billingPeriodStart", data.get("billing_period_start")),
+        billing_period_end=data.get("billingPeriodEnd", data.get("billing_period_end")),
+    )
+
+def get_queue_status(client: HttpClient) -> QueueStatusResponse:
+    resp = client.get("/v2/team/queue-status")
+    if not resp.ok:
+        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),
+    )
+
+
+def get_credit_usage_historical(client: HttpClient, by_api_key: bool = False) -> CreditUsageHistoricalResponse:
+    resp = client.get(f"/v2/team/credit-usage/historical{'?byApiKey=true' if by_api_key else ''}")
+    if not resp.ok:
+        handle_response_error(resp, "get credit usage historical")
+    body = resp.json()
+    if not body.get("success"):
+        raise Exception(body.get("error", "Unknown error"))
+    return CreditUsageHistoricalResponse(**body)
+
+
+def get_token_usage_historical(client: HttpClient, by_api_key: bool = False) -> TokenUsageHistoricalResponse:
+    resp = client.get(f"/v2/team/token-usage/historical{'?byApiKey=true' if by_api_key else ''}")
+    if not resp.ok:
+        handle_response_error(resp, "get token usage historical")
+    body = resp.json()
+    if not body.get("success"):
+        raise Exception(body.get("error", "Unknown error"))
+    return TokenUsageHistoricalResponse(**body)

{firecrawl-4.1.1 → firecrawl-4.3.0}/firecrawl/v2/types.py

@@ -480,10 +480,44 @@ class ConcurrencyCheck(BaseModel):
 class CreditUsage(BaseModel):
     """Remaining credits for the team/API key."""
     remaining_credits: int
+    plan_credits: Optional[int] = None
+    billing_period_start: Optional[str] = None
+    billing_period_end: Optional[str] = None
 
 class TokenUsage(BaseModel):
     """Recent token usage metrics (if available)."""
     remaining_tokens: int
+    plan_tokens: Optional[int] = None
+    billing_period_start: Optional[str] = None
+    billing_period_end: Optional[str] = None
+
+class QueueStatusResponse(BaseModel):
+    """Metrics about the team's scrape queue."""
+    jobs_in_queue: int
+    active_jobs_in_queue: int
+    waiting_jobs_in_queue: int
+    max_concurrency: int
+    most_recent_success: Optional[datetime] = None
+
+class CreditUsageHistoricalPeriod(BaseModel):
+    startDate: Optional[str] = None
+    endDate: Optional[str] = None
+    apiKey: Optional[str] = None
+    creditsUsed: int
+
+class CreditUsageHistoricalResponse(BaseModel):
+    success: bool
+    periods: List[CreditUsageHistoricalPeriod]
+
+class TokenUsageHistoricalPeriod(BaseModel):
+    startDate: Optional[str] = None
+    endDate: Optional[str] = None
+    apiKey: Optional[str] = None
+    tokensUsed: int
+
+class TokenUsageHistoricalResponse(BaseModel):
+    success: bool
+    periods: List[TokenUsageHistoricalPeriod]
 
 # Action types
 class WaitAction(BaseModel):

{firecrawl-4.1.1 → firecrawl-4.3.0}/firecrawl.egg-info/PKG-INFO

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

firecrawl-4.1.1/firecrawl/v2/methods/aio/usage.py

@@ -1,42 +0,0 @@
-from ...utils.http_client_async import AsyncHttpClient
-from ...utils.error_handler import handle_response_error
-from ...types import ConcurrencyCheck, CreditUsage, TokenUsage
-
-
-async def get_concurrency(client: AsyncHttpClient) -> ConcurrencyCheck:
-    resp = await client.get("/v2/concurrency-check")
-    if resp.status_code >= 400:
-        handle_response_error(resp, "get concurrency")
-    body = resp.json()
-    if not body.get("success"):
-        raise Exception(body.get("error", "Unknown error"))
-    data = body.get("data", body)
-    return ConcurrencyCheck(
-        concurrency=data.get("concurrency"),
-        max_concurrency=data.get("maxConcurrency", data.get("max_concurrency")),
-    )
-
-
-async def get_credit_usage(client: AsyncHttpClient) -> CreditUsage:
-    resp = await client.get("/v2/team/credit-usage")
-    if resp.status_code >= 400:
-        handle_response_error(resp, "get credit usage")
-    body = resp.json()
-    if not body.get("success"):
-        raise Exception(body.get("error", "Unknown error"))
-    data = body.get("data", body)
-    return CreditUsage(remaining_credits=data.get("remainingCredits", data.get("remaining_credits", 0)))
-
-
-async def get_token_usage(client: AsyncHttpClient) -> TokenUsage:
-    resp = await client.get("/v2/team/token-usage")
-    if resp.status_code >= 400:
-        handle_response_error(resp, "get token usage")
-    body = resp.json()
-    if not body.get("success"):
-        raise Exception(body.get("error", "Unknown error"))
-    data = body.get("data", body)
-    return TokenUsage(
-        remaining_tokens=data.get("remainingTokens", 0)
-    )
-

firecrawl-4.1.1/firecrawl/v2/methods/usage.py

@@ -1,41 +0,0 @@
-from ..utils import HttpClient, handle_response_error
-from ..types import ConcurrencyCheck, CreditUsage, TokenUsage
-
-
-def get_concurrency(client: HttpClient) -> ConcurrencyCheck:
-    resp = client.get("/v2/concurrency-check")
-    if not resp.ok:
-        handle_response_error(resp, "get concurrency")
-    body = resp.json()
-    if not body.get("success"):
-        raise Exception(body.get("error", "Unknown error"))
-    data = body.get("data", body)
-    return ConcurrencyCheck(
-        concurrency=data.get("concurrency"),
-        max_concurrency=data.get("maxConcurrency", data.get("max_concurrency")),
-    )
-
-
-def get_credit_usage(client: HttpClient) -> CreditUsage:
-    resp = client.get("/v2/team/credit-usage")
-    if not resp.ok:
-        handle_response_error(resp, "get credit usage")
-    body = resp.json()
-    if not body.get("success"):
-        raise Exception(body.get("error", "Unknown error"))
-    data = body.get("data", body)
-    return CreditUsage(remaining_credits=data.get("remainingCredits", data.get("remaining_credits", 0)))
-
-
-def get_token_usage(client: HttpClient) -> TokenUsage:
-    resp = client.get("/v2/team/token-usage")
-    if not resp.ok:
-        handle_response_error(resp, "get token usage")
-    body = resp.json()
-    if not body.get("success"):
-        raise Exception(body.get("error", "Unknown error"))
-    data = body.get("data", body)
-    return TokenUsage(
-        remaining_tokens=data.get("remainingTokens", 0)
-    )
-