Skip to main content
GET
Current Plan Usage
Call this endpoint before submitting work, or to drive your own throttling. It reports both meters and their reset times: The response also includes single_rps (your plan’s per-account requests-per-second limit for single lookups) and the billing period bounds (current_period_start, current_period_end). All timestamps are ISO 8601 in UTC. Calling this endpoint is free: it consumes neither the monthly cap nor the daily search limit. It does share the per-key request-rate window with the rest of the API, so avoid polling it in a tight loop. The daily bulk search meter is per account, so its numbers include dashboard bulk finder jobs run on your plan, not just API submissions. Requires an Unlimited API key with an active subscription; the same 402 subscription_inactive and 403 wrong_key_plan rules apply as on the other unlimited endpoints.

Authorizations

X-API-Key
string
header
required

API key for authentication

Response

Successful Response

Current-period consumption for an unlimited plan (/v1/unlimited/usage).

single_monthly_cap
integer
required

Plan's single-lookup requests per billing period.

single_used
integer
required

Single-lookup requests consumed this billing period.

single_remaining
integer
required

Requests remaining before the monthly cap (never negative).

single_rps
integer
required

Plan's single-lookup requests-per-second limit (per account).

bulk_searches_per_day
integer
required

Plan's daily bulk search limit (per account, UTC day).

bulk_searches_used_today
integer
required

Bulk searches consumed in the current daily window.

bulk_searches_reset_at
string<date-time>
required

When the daily bulk search limit resets (next UTC midnight).

current_period_start
string<date-time> | null
required

Start of the current billing period (cap window).

current_period_end
string<date-time> | null
required

End of the current billing period — when the cap resets.