NEnewscatcherapi
Subscription

Get subscription info

Returns plan and usage info for the API key used to authenticate this request: subscription status, concurrency and monthly call limits, remaining call quota, and the historical date range your plan allows searching.

get/api/subscription

Request

  • Base URL
    https://v3-api.newscatcherapi.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared. Required headers: x-api-token

Headers

x-api-tokenstring required

Your NewsCatcher API key, used to authenticate this request.

Response

Successful Response

activeboolean required

Whether this API key's subscription is currently active.

calls_per_secondsinteger

Maximum number of concurrent API requests allowed per second under your plan. Exceeding this returns a 429 Too Many Requests error.

plan_namestring required

Name of your subscription plan (e.g. 'v3_basic', 'v3_nlp').

usage_assigned_callsinteger

Total number of API calls assigned to your plan for the current billing period.

usage_remaining_callsinteger

Number of API calls remaining in the current billing period. Requests are rejected once this reaches zero.

historical_daysinteger

Number of days of historical article data your plan allows querying.

Changes

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