v3 Subscription

This endpoint enables you to get info about your subscription plan.

Check your subscription plan information

GET https://v3-api.newscatcherapi.com/api/subscription

200: OK Success

{
  "active": true,
  "concurrent_calls": 10,
  "plan": "v3_nlp_embeddings",
  "plan_calls": 100000,
  "remaining_calls": 99988,
  "historical_days": 2000
}

400: Bad Request API Call without "x-api-token" in headers

{
    "status": "error",
    "error_code": "InvalidAPIKey",
    "message": "Invalid api key: false_api_key"
}

401: Unauthorized Invalid API Key

{
    "status": "error",
    "error_code": "InvalidAPIKey",
    "message": "Invalid api key: false_api_key"
}

408: Request Timeout Request Timeout

406: Not Acceptable Unsupported Parameters

{
    "status": "error",
    "error_code": "UnsupportedParameter",
    "message": "Found unsupported parameter(s)['sort_by', 'q']. Here are the parameters available for this endpoint => ['countries', 'topic', 'lang']"
}

429: Too Many Requests Too many API calls

{
  "status": "error",
  "error_code": "ConcurrencyViolation",
  "message": "Max concurrency allowed 1 per 1 second"
}

Check your subscription plan information

POST https://v3-api.newscatcherapi.com/api/subscription

200: OK Success

{
  "active": true,
  "concurrent_calls": 10,
  "plan": "v3_nlp_embeddings",
  "plan_calls": 100000,
  "remaining_calls": 99988,
  "historical_days": 2000
}

400: Bad Request API Call without "x-api-token" in headers

{
    "status": "error",
    "error_code": "InvalidAPIKey",
    "message": "Invalid api key: false_api_key"
}

401: Unauthorized Invalid API Key

{
    "status": "error",
    "error_code": "InvalidAPIKey",
    "message": "Invalid api key: false_api_key"
}

408: Request Timeout Request Timeout

406: Not Acceptable Unsupported Parameters

{
    "status": "error",
    "error_code": "UnsupportedParameter",
    "message": "Found unsupported parameter(s)['sort_by', 'q']. Here are the parameters available for this endpoint => ['countries', 'topic', 'lang']"
}

429: Too Many Requests Too many API calls

{
  "status": "error",
  "error_code": "ConcurrencyViolation",
  "message": "Max concurrency allowed 1 per 1 second"
}

Successful Request Response

{
  "active": true,
  "concurrent_calls": 10,
  "plan": "v3_nlp_embeddings",
  "plan_calls": 100000,
  "remaining_calls": 99988,
  "historical_days": 2000
}