Historical Token Usage

1 min read

get/team/token-usage/historical

Request example

curl --request GET \
  --url https://api.firecrawl.dev/v1/team/token-usage/historical \
  --header 'Authorization: Bearer <token>'

Response

{
  "success": true,
  "periods": [
    {
      "startDate": "2025-01-01T00:00:00Z",
      "endDate": "2025-01-31T23:59:59Z",
      "apiKey": "<string>",
      "totalTokens": 1000
    }
  ]
}

get/team/token-usage/historical

Returns historical token usage on a month-by-month basis. The endpoint can also breaks usage down by API key optionally.

Authorization

Authorizationstringheaderrequired#

Bearer authentication header of the form Bearer <token>, where <token> is your API key.

Query parameters

byApiKeyboolean#

Get historical token usage by API key

Default: false

Responses

application/json

Successful response

successboolean#

periodsobject[]#

Show child attributes

startDatestring#

Start date of the billing period

endDatestring#

End date of the billing period

apiKeystring#

Name of the API key used for the billing period. null if byApiKey is false (default)

totalTokensinteger#

Total number of tokens used in the billing period

Token Usage Queue Status