curl --request GET \
--url https://api.newscatcherapi.com/news-api/subscription \
--header 'x-api-key: <api-key>'import requests
url = "https://api.newscatcherapi.com/news-api/subscription"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.newscatcherapi.com/news-api/subscription', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.newscatcherapi.com/news-api/subscription",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.newscatcherapi.com/news-api/subscription"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.newscatcherapi.com/news-api/subscription")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.newscatcherapi.com/news-api/subscription")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"credits_balance": 8950,
"credits_per_search": {
"high": 10,
"low": 1,
"medium": 5
},
"daily_request_limit": 500,
"daily_requests_used": 12,
"extra_fields": [],
"historical_days": 30,
"max_articles_per_page": 50,
"plan": "platform_free",
"requests_per_second": {
"high": 1,
"low": 1,
"medium": 1
},
"shared_requests_per_second": 1,
"story": {
"credits_per_request": 1,
"enabled": true,
"requests_per_second": 1
}
}Get subscription info
Your plan, its limits and your credit balance: what one search costs per effort level, the requests per second and per day your organization may send (and how many it has used today),
the largest limit, how many days back you can search, the heavy fields you can include, and the NCC credits you have left. Free: it is not charged. The balance is cached for up to
2 minutes and usage reaches it 1 to 3 minutes late.
curl --request GET \
--url https://api.newscatcherapi.com/news-api/subscription \
--header 'x-api-key: <api-key>'import requests
url = "https://api.newscatcherapi.com/news-api/subscription"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.newscatcherapi.com/news-api/subscription', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.newscatcherapi.com/news-api/subscription",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.newscatcherapi.com/news-api/subscription"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.newscatcherapi.com/news-api/subscription")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.newscatcherapi.com/news-api/subscription")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"credits_balance": 8950,
"credits_per_search": {
"high": 10,
"low": 1,
"medium": 5
},
"daily_request_limit": 500,
"daily_requests_used": 12,
"extra_fields": [],
"historical_days": 30,
"max_articles_per_page": 50,
"plan": "platform_free",
"requests_per_second": {
"high": 1,
"low": 1,
"medium": 1
},
"shared_requests_per_second": 1,
"story": {
"credits_per_request": 1,
"enabled": true,
"requests_per_second": 1
}
}Authorizations
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.
Code of your subscription plan.
"platform_free"
Largest limit your plan allows; a larger one is refused with 403.
50
How many days back your plan allows searching; a longer search_window is cut to it.
30
Requests per second allowed for your whole organization, per effort level.
Show child attributes
Show child attributes
Requests counted today (UTC).
12
NCC one successful search costs, per effort level.
Show child attributes
Show child attributes
Story pages: whether your plan allows them, their requests per second and their price.
Show child attributes
Show child attributes
Heavy article fields your plan unlocks with include. Empty when your plan has none.
description, entities, sentiment, themes, translation, embedding ["entities", "sentiment"]
Remaining NCC credits. Cached for up to 2 minutes, and usage reaches it 1 to 3 minutes late.
8950
Requests per second allowed for your organization across all effort levels, if limited.
1
Requests allowed per UTC day, if limited. Null when your plan has no daily limit.
500
Was this page helpful?

