Skip to main content
GET
Get subscription info

Authorizations

x-api-key
string
header
required

Your NewsCatcher API key, created in the NewsCatcher platform. Send it in the x-api-key header of every request.

Response

Your plan, limits and balance.

Plan, limits and credits of the authenticated organization.

plan
string
required

Code of your subscription plan.

Example:

"platform_free"

max_articles_per_page
integer
required

Largest limit your plan allows; a larger one is refused with 403.

Example:

50

historical_days
integer
required

How many days back your plan allows searching; a longer search_window is cut to it.

Example:

30

requests_per_second
EffortRates · object
required

Requests per second allowed for your whole organization, per effort level.

daily_requests_used
integer
required

Requests counted today (UTC).

Example:

12

NCC one successful search costs, per effort level.

story
StoryAccess · object
required

Story pages: whether your plan allows them, their requests per second and their price.

extra_fields
enum<string>[]
required

Heavy article fields your plan unlocks with include. Empty when your plan has none.

Available options:
description,
entities,
sentiment,
themes,
translation,
embedding
Example:
credits_balance
required

Remaining NCC credits. Cached for up to 2 minutes, and usage reaches it 1 to 3 minutes late.

Example:

8950

shared_requests_per_second
integer | null

Requests per second allowed for your organization across all effort levels, if limited.

Example:

1

daily_request_limit
integer | null

Requests allowed per UTC day, if limited. Null when your plan has no daily limit.

Example:

500