Utilities

Limits

Returns the authenticated account's current API usage and the limits that apply to it: the number of requests made in the current tracking period, the request limit, the per-second rate limit, and when the counter resets.

Optionally, pass one or more API keys via the apiKeys parameter to check their status. For each supplied key the response reports whether it is valid (exists and belongs to your account), enabled (a disabled key is 'off'), and whether its subscription is active.

This endpoint is authenticated with your API key but is quota-exempt: calling it does not count against your monthly request quota and is not subject to rate limiting. It is intended for liveness/health probes and external dashboards that need to check whether an API key and subscription are active without consuming usage.

get/v1/limits

Request

  • Base URL: https://api.perigon.io
  • URL: https://api.perigon.io/v1/limits
  • Auth: HTTP bearer

Query parameters

apiKeysstring[]

Optional list of API keys whose validity and status should be checked. Each key is reported as valid only if it exists and belongs to your account.

Response

200 - Success

Example response

{
  "data": {
    "organizationName": "Acme Research",
    "requestsUsed": 12450,
    "requestLimit": 100000,
    "maxPageSize": 100,
    "paginationLimit": 10000,
    "articleContentTruncation": null,
    "since": "2025-08-01T00:00:00Z",
    "lastMadeAt": "2025-08-12T15:42:11Z",
    "resetAt": "2025-09-01T00:00:00Z",
    "subscriptionCancelAt": null,
    "keyStatuses": [
      {
        "keyPreview": "abc...def",
        "valid": true,
        "enabled": true,
        "subscriptionActive": true,
        "requestCount": 320
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.