News API

News API is a simple HTTP REST API for searching and retrieving live articles from all over the web. You can use it to search for headline news in specific countries, and to search for news articles using key words. For more information about News API go to News API.

In the context of Nintex Automation Cloud, News API is a connector Service used to define a connection required for associated actions and start events. Examples include Salesforce and Box. Method of integration to cloud services, business applications and content stores.. The News API connector is used to create connections for News API actions A tool for building the processes, logic, and direction within workflows.. Use News API actions to search for specific news links, and to retrieve top news headlines.

Jump to:

Create a News API connection

Note: Your browser-stored credentials are accessed to create connections. Either clear credentials from browser memory or make sure the stored credentials are for the intended environment.

Create a connection from the connections page or from the action configuration panel when configuring the action. For information about creating connections and assigning permissions, see Manage connections.

In the Add a new connection section, complete the fields as follows:

In this field

Select or enter the following
Connection name A name for your new connection
API Key Your News API API Key. Go to Register for API key if you don't have one.

News API account requirements

  • The account you use to create a connection for News API is the account that has access to the News API actions.
  • Your News API API Key. Go to Register for API key if you don't have one.
  • A paid subscription for News API.

Create a News API data source

Use the News API data source to create a drop-down list of News API news articles or top headlines retrieved by country in a form. For example, to allow users to select a specific news article in a form, add a drop-down list of news articles to the form using a Data lookup control A form control that allows users to select from a drop-down list of values that have been fetched from a third-party service.. The Data lookup control uses a News API - Get news data source to list the news articles available from the News API connection in the drop-down.

You can create a News API data source to:

  • Get news: list all the news articles, or a filtered list of news articles, available from your News API account.
  • Get top headlines by country: list all the news articles of a specified country available from your News API account.

Each data source is configured for a specific user. You can create as many data sources as you need.

To add a News API drop-down list to your form:

  1. Create your News API data source.

    2. See Data sources.

  2. Add a data lookup form control to your form and configure it to use your new data source.

News API data source fields

When you create a News API data source, you can configure some additional fields to specify which blog authors, blog posts, or blogs the data source should retrieve.

To access the data source fields, in the Add data source section, select the News APIConnector and the Operation.

Operation

Field or selection

Description
Get news Connection

The connection to use for the data source.

  Search Filters:
  • Language: The language you want to search for news in.

    If you use a variable, use the 2-letter ISO-639-1 code of the language you want to get headlines for. For a list of the supported country codes see News API - Search everything.

  • Search query: Keywords or phrases to search for in the article title and body.

    • Advanced search is supported here:

    • Surround phrases with quotes (") for exact match.

    • Prepend words or phrases that must appear with a + symbol. e.g.: +bitcoin

    • Prepend words that must not appear with a - symbol. e.g.: -bitcoin

    • Alternatively you can use the AND / OR / NOT keywords, and optionally group these with parenthesis. Eg: crypto AND (ethereum OR litecoin) NOT bitcoin..

  • From date: A date and optional time for the oldest article allowed. This should be in ISO 8601 format (e.g. 2021-03-26 or 2021-03-26T12:07:30).
  • To date: A date and optional time for the newest article allowed. This should be in ISO 8601 format (e.g. 2021-03-26 or 2021-03-26T12:07:30)
  Paging

  • Items per page: The number of articles to retrieve per page.

  • Page: The page number of articles to retrieve.
Get top headlines by country Connection The connection to use for the data source.
  Search filters
  • Country: The country to search in for top headline news articles.

    If you use a variable, use the 2-letter ISO 3166-1 code of the country you want to get headlines for. For a list of the supported country codes see News API - Top headlines.

  • Category: News type category to search in for the news article headlines.
  • Search query: Key words to search for within the headlines.
  Paging

  • Items per page: The number of articles to retrieve per page.

  • Page: The page number of articles to retrieve.