Description
Retrieves your current API usage statistics, rate limit consumption, and billing period information. This endpoint helps you monitor your application’s health and ensure you are operating within your plan’s parameters.
This endpoint is free to query and does not count against your API usage limits.
Parameters
This endpoint does not require a request body. All usage data is scoped to the API key used for authentication.
Response Fields
Data
Wrapper for usage details scoped to the authenticated API key.
Current billing period window.
data.billing_period.start
Start of current billing period (ISO-8601).
End of current billing period (ISO-8601).
data.billing_period.days_remaining
Days remaining in the current billing period.
Configured rate limits for the API key.
data.rate_limits.requests_per_second
Configured RPS limit for your API key.
data.rate_limits.current_usage
Current RPS usage (rolling window).
Map of dataset IDs to usage statistics (requests).
Legacy usage metrics (deprecated).
Best Practices
Query this endpoint periodically (e.g., daily) to monitor your usage and plan for scaling your infrastructure.
Monitor usage_by_dataset to identify which datasets are most frequently accessed by your applications.
While this endpoint is free, it still respects a separate rate limit for management calls. Use it judiciously in automated monitoring systems.
See Also
curl -X GET "https://api.blockdb.io/v1/usage" \
-H "Authorization: Bearer $BLOCKDB_API_KEY"
{
"data": {
"billing_period": {
"start": "2025-11-01T00:00:00Z",
"end": "2025-11-30T23:59:59Z",
"days_remaining": 19
},
"rate_limits": {
"requests_per_second": 1000,
"current_usage": 45
},
"usage_by_dataset": {
"0101": { "requests": 4500 },
"0102": { "requests": 3200 },
"0401": { "requests": 2000 }
}
}
}