NewsAPI Connector - Ismena website

info@ismena.com

NewsAPI Connector

Connector Details

Type

Virtual machines, Single VM , BYOL

Runs on

Google Compute Engine

Last Update

24 October, 2024

Category

Overview

The NewsAPI Connector provides a RESTful interface to retrieve real-time and historical news articles from thousands of global sources. It allows users to query news content by keyword, category, country, language, publication date, and source. This connector is ideal for applications focused on news monitoring, research, media dashboards, or sentiment and trend analysis.

Integration Overview

The NewsAPI Connector offers the following integration points to query news-related data:

Get Top Headlines: Retrieve the latest breaking news headlines for a given country, category, or keyword.
Search All News (Everything): Perform a deep search across all published articles using flexible filters.
Get News Sources: Retrieve a list of available news publishers grouped by category, language, or country.

Detailed Integration Documentation

Get Top Headlines

Operation ID	getTopHeadlines
Purpose	Retrieves top headlines based on filters such as country, category, or keyword.
Input Details	Query Parameter: apiKey (required, string) – Unique API key for authentication. Query Parameter: country (optional, string, e.g., US) – Two-letter country code (ISO 3166-1). Query Parameter: category (optional, string, e.g., business) – News category (e.g., business, sports). Query Parameter: q (optional, string, e.g., economy) – Keyword or phrase to search. Query Parameter: sources (optional, string, e.g., cnn, bbc-news) – Comma-separated source IDs. Query Parameter: pageSize (optional, integer) – Number of results per page (default: 20, max: 100). Query Parameter: page (optional, integer) – Pagination control.
Output	Successful: Returns a JSON object containing metadata and an array of news articles with title, description, source, URL, published date, and content. Failure: Returns HTTP errors for invalid keys, parameters, or rate limits.
Workflow Example	Send a request with parameters: apiKey, country=US, category=technology. Display the top headlines in a news feed or card-based UI.

Search All News (Everything)

Operation ID	searchAllNews
Purpose	Performs a full-text, historical search across all indexed articles.
Input Details	Query Parameter: apiKey (required, string) – Unique API key. Query Parameter: q (optional, string) – Keyword or phrase to search in the content. Query Parameter: qInTitle (optional, string) – Search for keywords only in article titles. Query Parameter: sources (optional, string) – Comma-separated list of source IDs. Query Parameter: domains (optional, string) – Domains to restrict search (e.g., reuters.com). Query Parameter: from / to (optional, string) – Start and end date (ISO 8601 format). Query Parameter: language (optional, string) – Filter by article language. Query Parameter: sortBy (optional, string) – relevancy, popularity, or publishedAt. Query Parameter: pageSize / page – Pagination settings.
Output	Successful: Returns articles matching the search criteria. Failure: Returns error messages for invalid parameters or limits.
Workflow Example	Query all articles containing the word "inflation" from last 30 days. Sort by publication date and highlight most recent articles.

Get News Sources

Operation ID	getSources
Purpose	Retrieves a list of all news publishers supported by the connector.
Input Details	Query Parameter: apiKey (required, string) – Authentication key. Query Parameter: category (optional, string) – Filter by type of news (e.g., business, sports). Query Parameter: language (optional, string) – Filter by source language. Query Parameter: country (optional, string) – Filter by source location.
Output	Successful: Returns a list of source objects with fields like name, id, description, language, and country. Failure: Returns an error for invalid key or filters.
Workflow Example	Request all technology-related sources in English. Use the list to allow users to filter news by source.

Workflow Creation with the Connector

Example Workflow: Media Monitoring Dashboard

Step 1: Retrieve News Sources

Use getSources to fetch all available publishers.
Display as filter options for users.

Step 2: Display Breaking Headlines

Use getTopHeadlines with country or category filter.
Show results in a list or grid layout with summary.

Step 3: Enable Keyword-Based Search

Use searchAllNews to find historical news articles on a topic (e.g., elections, crypto).
Allow users to sort results by relevance or date.

Step 4: Implement Pagination and Error Handling

Manage API limits and invalid input errors.
Log slow or failed responses for performance optimization.

Pricing

bill-and-calculator-2023-11-27-05-25-06-utc 1

Request a Quote

Support

For Technical support please contact us on

custom-connectors-support@isolutions.sa

A tech solution company dedicated to providing innovation thus empowering businesses to thrive in the digital age.

Register to IBM x iSolution Event