GET /v1/usage — Screening API Docs

GET/api/v1/usage

Returns current billing period usage and remaining quota for the authenticated organization.

The Screening API provides screening signals based on aggregated public data. It does not replace your compliance program. Risk scores and labels may be incomplete, delayed, or incorrect. Always implement your own review processes before acting on screening results.

Authentication

Requires a valid API key. Does not consume monthly quota (free to call).

Response fields

Field	Type	Description
period.start	string	ISO 8601 start of current billing period (first of month, UTC).
period.end	string	ISO 8601 end of current billing period (last moment of month, UTC).
tier	string	Current plan: `free` `starter` `growth` `scale`
limits.monthly_requests	number	Total monthly request allowance for your plan.
limits.requests_per_second	number	Sustained rate limit in requests per second.
limits.api_access	boolean	Whether the plan includes API access (false for Free tier).
usage.requests_this_period	number	Requests consumed so far in the current billing period.
usage.remaining	number	Remaining requests this period. Zero means quota is exhausted.

Code examples

curl https://anchorapi.dev/api/v1/usage \
  -H "Authorization: Bearer $SCREENING_API_KEY"

Sample response

{
  "period": {
    "start": "2026-05-01T00:00:00.000Z",
    "end": "2026-05-31T23:59:59.999Z"
  },
  "tier": "starter",
  "limits": {
    "monthly_requests": 10000,
    "requests_per_second": 5,
    "api_access": true
  },
  "usage": {
    "requests_this_period": 3247,
    "remaining": 6753
  }
}

Use case: monitoring quota programmatically

Call this endpoint from a monitoring job (e.g., hourly cron) and alert when remaining quota drops below a threshold — before you hit the limit in production. The endpoint does not count against your quota, so polling it frequently is safe.