newsapi Node.js Interface

To add newsapi to your Node.js project, install it using npm:

$ npm install newsapi --save

The library includes default headers to resolve most CORS issues. If you still encounter CORS problems, you can provide a corsProxyUrl in the NewsAPI constructor to route requests through a proxy (e.g., https://cors-anywhere.herokuapp.com/).

const newsapi = new NewsAPI('YOUR_API_KEY', { corsProxyUrl: 'https://cors-anywhere.herokuapp.com/' });

The legacy v1 API provides articles() and sources() methods. These methods support both Promises and traditional Node-style callbacks.

articles(options)

Requires a source parameter.

sources(options)

All options are optional.

const NewsAPI = require('newsapi');
const newsapi = new NewsAPI('YOUR_API_KEY');

// Query articles using Promises
newsapi.articles({
  source: 'associated-press',
  sortBy: 'top'
}).then(articlesResponse => {
  console.log(articlesResponse);
});

// Query articles using Node-style callbacks
newsapi.articles({
  source: 'associated-press',
  sortBy: 'top'
}, (err, articlesResponse) => {
  if (err) console.error(err);
  else console.log(articlesResponse);
});

// Query sources
newsapi.sources({
  category: 'technology',
  language: 'en',
  country: 'us'
}).then(sourcesResponse => {
  console.log(sourcesResponse);
});

To bypass NewsAPI's default caching behavior for a specific request, pass { noCache: true } as a second argument to the method call.

newsapi.v2.everything({
  sources: 'bbc-news'
}, {
  noCache: true
}).then(response => {
  ...
});

When calling API methods, you can pass an options object to control request behavior.

Option Keys:

• noCache (boolean): If true, sets the X-No-Cache: true header to bypass caching.
• showHeaders (boolean): If true, the response will be returned as an object containing both the response headers and the body (e.g., { headers, body }).

// Example: Fetching without cache and inspecting headers
newsapi.v2.everything(
  { q: 'openai' }, 
  { noCache: true, showHeaders: true }
).then(response => {
  console.log('Headers:', response.headers);
  console.log('Data:', response.body);
});

The NewsAPI instance provides direct access to legacy v1 endpoints. Note that v1 endpoints do not use the v2 namespace.

Available Methods:

• sources(params, options, cb): Fetches sources (v1).
• articles(params, options, cb): Fetches articles (v1).

Arguments:

• params (Object): Query parameters.
• options (Object): Configuration for the request.
• cb (Function): Optional callback function.

// Fetching v1 articles
newsapi.articles({ q: 'bitcoin' }, {}, (err, data) => {
  if (err) console.error(err);
  else console.log(data);
});

To use the library, instantiate the NewsAPI class with your API key. You can optionally provide a corsProxyUrl in the options object to handle CORS issues in certain environments.

Constructor Signature: new NewsAPI(apiKey, options = {})

Options:

• corsProxyUrl (string): A URL to prefix to the NewsAPI host (e.g., for a CORS proxy).

const NewsAPI = require('newsapi');

// Basic initialization
const newsapi = new NewsAPI('YOUR_API_KEY');

// Initialization with a CORS proxy
const newsapiWithProxy = new NewsAPI('YOUR_API_KEY', { 
  corsProxyUrl: 'https://your-proxy.com/' 
});

The library throws a NewsAPIError when the News API returns an error status in the response body. This error object wraps the error details provided by the API.

Properties:

• name: Formatted as NewsAPIError: [error_code].
• message: The error message returned by the API.

try {
  await newsapi.v2.topHeadlines({ invalid: 'param' });
} catch (err) {
  if (err.name.startsWith('NewsAPIError')) {
    console.error('API Error:', err.message);
  } else {
    console.error('Network/Other Error:', err);
  }
}