Skip to main content
GET
Get current API usage

Authorizations

x-api-key
string
header
required

Query Parameters

use-cache
boolean
default:false

Serve the persisted current-period snapshot instead of querying live providers. Cache responses include freshness markers.

Response

Success

Route path -> current-period usage. Cache-served responses also include the string/boolean stale and generated_at markers.

stale
boolean

Present and true when this response was served from the persisted cache, either explicitly or after provider rate limiting. Absent on live responses.

Example:

true

generated_at
string<date-time>

Generation time of the persisted current-usage snapshot—the age of the stored record, not of the underlying measurement. Drives X-Data-Age-Seconds. Present on cache-served responses.

Example:

"2026-08-20T12:00:00.000Z"

{key}
object