For the complete documentation index, see llms.txt. This page is also available as Markdown.

/usage

Check your current API usage against your plan's rate limit and quota. See also: Rate limiting. Requires your API key, passed via the x-api-key header.

Required parameters: none

Optional parameters: none

Example call
https://api4.ballotpedia.org/data/usage
Example response
{
    "success": true,
    "data": {
        "limit": 200000,
        "used": 2203,
        "remaining": 197797,
        "period": "DAY",
        "period_start": "2026-07-20",
        "period_end": "2026-07-20",
        "throttle": {
            "rate_limit": 5,
            "burst_limit": 100
        }
    },
    "message": "Usage limit retrieved."
}

Details

Definitions:

  • limit: The maximum number of requests allowed in the current quota period.

  • used: Requests made so far in the current period.

  • remaining: Requests remaining before you hit your quota.

  • period: The quota period your plan resets on: DAY, WEEK, or MONTH.

  • period_start: Start date (UTC) of the current quota period.

  • period_end: End date (UTC) covered by this response — today's date.

  • throttle.rate_limit: Sustained requests per second your plan allows.

  • throttle.burst_limit: Maximum burst of concurrent requests allowed above the rate limit.

Notes

  • Use of this API does count against your usage limits.

  • Used/remaining counts reset every day at midnight UTC. If you have a specialized weekly or monthly quota, this may differ.

  • AWS quota systems are designed to handle large-scale operations, and as a result, there can be some latency in updating and propagating quota information across their systems. This delay can affect the accuracy of quota monitoring tools and functions. Delays of up to a half hour are not uncommon.

Last updated