Custom Connector
NewsAPI Connector
Global
The NewsAPI Connector provides a RESTful interface to retrieve real-time and historical news articles from thousands of global sources. It supports querying by keyword, category, country, language, publication date, and source — ideal for news monitoring, research, media dashboards, and sentiment or trend analysis.
Overview
Integration Overview
The NewsAPI Connector offers the following integration points to query news-related data.
- getTopHeadlines. Retrieve the latest breaking headlines by country, category, or keyword.
- searchAllNews. Deep full-text search across all published articles with flexible filters.
- getSources. Retrieve available news publishers grouped by category, language, or country.
Documentation
Detailed Integration Documentation
Get Top Headlines
| Operation | getTopHeadlines |
|---|---|
| Purpose | Retrieves top headlines based on filters such as country, category, or keyword. |
| Parameters | Required: apiKey. Optional: country (ISO 3166-1, e.g. US); category (e.g. business, sports); q (keyword); sources (comma-separated IDs, e.g. cnn,bbc-news); pageSize (default 20, max 100); page. |
| Output | Successful: JSON with metadata and an array of articles (title, description, source, URL, published date, content). Failure: HTTP errors for invalid keys, parameters, or rate limits. |
| Workflow example | Request with apiKey, country=US, category=technology, then display in a news feed. |
Search All News (Everything)
| Operation | searchAllNews |
|---|---|
| Purpose | Performs a full-text, historical search across all indexed articles. |
| Parameters | Required: apiKey. Optional: q; qInTitle; sources; domains (e.g. reuters.com); from / to (ISO 8601); language; sortBy (relevancy/popularity/publishedAt); pageSize; page. |
| Output | Successful: articles matching the search criteria. Failure: error messages for invalid parameters or limits. |
| Workflow example | Query all articles containing “inflation” from the last 30 days, sorted by publication date. |
Get News Sources
| Operation | getSources |
|---|---|
| Purpose | Retrieves a list of all news publishers supported by the connector. |
| Parameters | Required: apiKey. Optional: category (e.g. business, sports); language; country. |
| Output | Successful: a list of source objects (name, id, description, language, country). Failure: error for invalid key or filters. |
| Workflow example | Request all technology sources in English, then let users filter news by source. |
Example Workflow: Media Monitoring Dashboard
| Retrieve sources | Use getSources to fetch publishers and display as filter options. |
|---|---|
| Breaking headlines | Use getTopHeadlines with a country or category filter, shown in a list or grid. |
| Keyword search | Use searchAllNews for historical articles on a topic, sorted by relevance or date. |
| Pagination & errors | Manage API limits and invalid input errors, logging slow or failed responses. |
Support
For technical support, contact custom-connectors-support@isolutions.sa.