Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/firecrawl/firecrawl/llms.txt

Use this file to discover all available pages before exploring further.

GET /v1/team/credit-usage

Retrieve the number of remaining credits for your team. Credits are consumed when using Firecrawl API endpoints.

Authentication

This endpoint requires authentication using a Bearer token in the Authorization header.
Authorization: Bearer YOUR_API_KEY

Response

success
boolean
Indicates if the request was successful
data
object
Credit usage data

Example Request

curl -X GET https://api.firecrawl.dev/v1/team/credit-usage \
  -H "Authorization: Bearer YOUR_API_KEY"

Example Response

{
  "success": true,
  "data": {
    "remaining_credits": 1000
  }
}

Error Responses

404 Not Found
object
Credit usage information not found
{
  "success": false,
  "error": "Could not find credit usage information"
}
500 Internal Server Error
object
Server error while fetching credit usage
{
  "success": false,
  "error": "Internal server error while fetching credit usage"
}

Credit Consumption

Different API endpoints consume different amounts of credits:
  • Scrape: 1 credit per page
  • Batch Scrape: 1 credit per page
  • Crawl: 1 credit per page crawled
  • Map: Credits based on pages discovered
  • Extract: Credits based on pages processed
  • Deep Research: Credits based on URLs analyzed
  • Search: Credits based on results returned
Monitor your credit usage regularly to ensure uninterrupted service.