Skip to content
Searches page titles, headings, and route paths. Press slash to focus.

GET /v3/usage/limits

Show what is left of your limits this month.

Gives requests used, the monthly allowance, and what is left, for your organization. Also gives whether prepaid credit covers requests past the allowance, and how many requests it still pays for. Also gives billable bytes used and the byte allowance, the per-second rate limit and what is left of it now, and when the month resets.

API key: required. See Authentication.

Group: Coverage, usage and service

Try it

This route takes no parameters.

This route needs an API key. Sign in to send it with yours; a free account comes with a key.

Python
import os
import requests

r = requests.get(
    "https://api.secblast.com/v3/usage/limits",
    headers={"Authorization": f"Bearer {os.environ['SECBLAST_API_KEY']}"},
    timeout=30,
)
r.raise_for_status()
print(r.json())

Parameters

This route takes no parameters.

Response body

A successful answer (200) is a UsageLimits object.

FieldTypeAlways presentDescription
as_ofdate-time (RFC 3339, UTC)yesalways presentWhen these figures were read. UTC, ISO 8601.
bytesobjectyesalways presentThis month's billable response bytes, counted before compression.
bytes.allowanceinteger | nullyesalways presentBytes included each month. In bytes. Null when there is no byte limit.
bytes.enforcedbooleanyesalways presentTrue when requests past the byte allowance get 429 quota_exceeded. False means the bytes are counted but never refused.
bytes.remaininginteger | nullyesalways presentBytes left of the allowance. In bytes. Null when there is no byte limit or usage is not counted.
bytes.usedinteger | nullyesalways presentBillable response bytes this month. In bytes. Null when usage is not counted.
keyobjectyesalways presentThe key that made the request.
key.fingerprintstringyesalways presentThe first 12 hex digits of the key's SHA-256 hash.
org_idinteger | nullyesalways presentYour organization's ID. Null when the key belongs to no organization.
periodobjectyesalways presentThis month, as SEC Blast counts it: midnight to midnight New York time.
period.enddate-time (RFC 3339, UTC)yesalways presentWhen this month ends. UTC, ISO 8601, such as 2026-12-01T05:00:00Z.
period.reset_atdate-time (RFC 3339, UTC)yesalways presentWhen the monthly allowances start again; the same time as end. UTC, ISO 8601.
period.reset_textstringyesalways presentThe reset in New York time, in words, such as December 1, 2026 at 00:00 ET.
period.startdate-time (RFC 3339, UTC)yesalways presentWhen this month started. UTC, ISO 8601, such as 2026-11-01T04:00:00Z.
planstring | nullyesalways presentYour plan ID, such as free, builder, or business. Null when the plan cannot be read.
rateobjectyesalways presentThe per-second rate limit.
rate.burstinteger | nullyesalways presentNumber of requests allowed at once above the per-second rate. Null when no rate limit applies to you.
rate.enforcedbooleanyesalways presentTrue when requests over the rate get 429 rate_limited.
rate.per_secondinteger | nullyesalways presentNumber of requests allowed per second. Null when no rate limit applies to you.
rate.remaininginteger | nullyesalways presentRequests you can send right now, after this one. Null when no rate limit applies to you.
requestsobjectyesalways presentThis month's requests.
requests.allowanceinteger | nullyesalways presentNumber of requests included each month. Null when there is no request limit.
requests.credit_requests_remainingintegeryesalways presentNumber of requests past the allowance that your prepaid credit still pays for. 0 when the plan has no overage.
requests.enforcedbooleanyesalways presentTrue when requests past the allowance and credit get 429 quota_exceeded.
requests.overage_allowedbooleanyesalways presentTrue when prepaid credit pays for requests past the allowance; false when the allowance is a hard stop.
requests.remaininginteger | nullyesalways presentRequests left of the allowance. Null when there is no request limit or usage is not counted.
requests.usedinteger | nullyesalways presentNumber of requests counted this month. 5xx and 429 responses, webhook deliveries, and this route do not count. Null when usage is not counted.
scopestringyesalways presentWhose monthly allowance the figures are. One of: org (shared by all keys of your organization) or key (this key's own; an older key that belongs to no organization).

Details

This route is not billed

  • it never counts as a request or toward bytes.
  • It is never refused for a used-up allowance.
  • The per-second rate limit applies, so over it the answer is 429 rate_limited.

Headers: While the request allowance is enforced, the answer carries X-Quota-Used-Requests, X-Quota-Limit-Requests, X-Quota-Remaining-Requests, X-Credit-Remaining-Requests, and X-Quota-Reset, as every response to a key does. Takes no query parameters.

Responses

StatusBodyMeaning
200UsageLimits (application/json)OK
429Problem (application/problem+json)Over the per-second rate limit (code rate_limited, with Retry-After). A used-up monthly allowance never refuses this route.

Like every route, it can also answer with an error: 401, 503, or another status. See Errors.

More in Coverage, usage and service

Previous: GET /v3/usage

Markdown version: /docs/reference/get-usage-limits.md