Information Feeds

The Information Feeds provide access to the metadata associated with the Content Feeds. What follows is a guide to accessing Reuters Information Feeds programmatically and how they can be used within your code.

As with all the feeds on Spotlight, the Information Feeds are accessed via requesting a URL with query string parameters which will determine the information and format you receive in the response.

Feed Requests

Currently there are three Information Feeds which provide metadata information about the content available on Spotlight. These three Information Feeds are:

• Channels - The Content Feeds simply display the content from the Reuters news channels in standardized syndication feed formats. Therefore the Channel Information Feed provides you with a list of the channels available to you. The Channel Information Feed can be requested with parameters such as edition, content, feedtype, format and channel to tailor the result set on the criteria you have.
  

  http://spotlight.reuters.com/api/service/channels?apikey=[yourkey]

  Optional Parameters:
  edition - Filters the results by the specified edition.
  content - Filters the results by the specified content type.
  channel - Filters the results to return the information about the single channel specified.
  feedtype - Provides the Content Feed URL based on format of the feed you want e.g. atom.
  format - The output format of the Channels Information Feed (e.g. xml, opml, json or php)

• Editions - The the Editions Information Feed provides you with a list of the Editions available to you. The Editions Information Feed can be requested with the content and format parameters which will filter the result set of editions for the given content type and the output format.
  

  http://spotlight.reuters.com/api/service/editions?apikey=[yourkey]

  Optional Parameters:
  content - Filters the results by the specified content type.
  format - The output format of the Editions Information Feed (e.g. xml, json or php)

• Content Types - The the Content Types Information Feed provides you with a list of the Content Types available to you. The Content Types Information Feed can be requested with the format parameters which determine the output format of the feed (e.g. xml or json).
  

  http://spotlight.reuters.com/api/service/contenttypes?apikey=[yourkey]

  Optional Parameters:
  format - The output format of the Editions Information Feed (e.g. xml, json or php)

Feed Parameters

Following the base URL there are a number of parameters which will filter thelist of feed returned from the directory. There are five parameters which can be submitted with the base URL to tailor the returning directory list, these are:

edition (optional) - The Edition represents the country web site that the Reuters content is sourced from e.g US, UK, Japan, India, China etc. Omitting this parameter will act as a wild card, which will include all the editions.

content (optional) - The Content Type represents the type of content that will be contained in the feed e.g. Articles, News Text, Videos, Pictures etc. Omitting this parameter will act as a wild card, which will include all the content types.

feedtype (optional) - The feedtype specifies the format included in the URLs of the the resulting list of content feeds e.g. Atom, RSS, Media RSS or JSON. Omitting this parameter will omit the URL from the resulting list of channels.

format (optional) - The output format of the results e.g. XML, OPML, JSON or PHP. Omitting this parameter will default to XML being the returning feed type.

apikey (required) - Your unique API Key that is required with every request.

version - (recommended) The version of the API feed. There is currently only one version (version 1.0) of the feeds, but over time this is likely to change. Therefore it is recommended that the version parameter is included to safeguard you application against changes in future feeds. Not including this parameter will always return the latest version of the of the API feeds.

Examples

Request a list of all the RSS channels feeds in the USA in an OPML format ...

http://spotlight.reuters.com/api/service/channels?edition=us&feedtype=atom&format=opml&apikey=[yourkey]

Request a list of all the channels available in the UK in an XML format (not specifying feed type for the URLs results in no feed URL and just channel information) ...

http://spotlight.reuters.com/api/service/channels?edition=uk&format=xml&apikey=[yourkey]

Request information about a single channel ATOM feed in the JSON format ...

http://spotlight.reuters.com/api/service/channels?edition=us&feedtype=atom&channel=topNews&format=json&apikey=[yourkey]

Request a list of all the editions available in an XML format ...

http://spotlight.reuters.com/api/service/editions?format=xml&apikey=[yourkey]

Request a list of all the editions available in a Serialized PHP format ...

http://spotlight.reuters.com/api/service/editions?format=php&apikey=[yourkey]

Request a list of all the editions available for the Channel Videos content type in an XML format ...

http://spotlight.reuters.com/api/service/editions?content=channelvideos&format=xml&apikey=[yourkey]

Request the list of the Content Types available in an XML format ...

http://spotlight.reuters.com/api/service/contenttypes?format=xml&apikey=[yourkey]