Skip to main content
The Usage endpoint returns your current API plan details, rate limit configuration, monthly quota status, and a per-endpoint request breakdown for the last 24 hours. Use it to monitor consumption, detect anomalies, and build internal dashboards.

Get usage

GET /v1/usage Returns usage information for the authenticated API key. No query parameters are required, because the key is identified from your Authorization header.

Required scope

This endpoint requires the usage:read scope. API keys with the broad read scope also satisfy this route, because the v1 middleware treats read as a broad read permission for namespaced read scopes.

Response fields

object
Your current plan details.
string
Plan tier. One of hobbyist, pro, commercial, enterprise, or analyst (a legacy grant that is no longer sold).
integer
Requests per minute allowed on your plan.
integer
Total monthly request quota for your plan.
object
Current rate limit configuration.
integer
Requests per minute allowed. Same as plan.rpm.
object
Monthly quota status.
integer
Number of requests consumed in the current billing period.
integer
Monthly quota ceiling.
integer
Requests remaining before hitting the monthly cap.
string
ISO 8601 timestamp when the monthly counter resets.
object
Request breakdown for the trailing 24-hour window.
integer
Total requests made in the last 24 hours.
The count is exact for every request in the window. Above 100,000 requests in 24 hours the breakdown covers the newest 100,000 and the response carries an X-Data-Partial header.
object
Map of endpoint paths to usage stats. Each entry has count, avg_response_ms, and errors.
Response
See error reference