Help for the Reuters API

version 2017.01.06.22


Test Mode 1

The parameter 'test' by itself parrots that value back. This can be used to verify that you are able to successfully connect to the API.

Example Link:

http://parfait.snarkybox.com/reuters.php?test=true

What that link returns will look like this:

true


Test Mode 2

Adding the parameter 'feed' will dump the Reuters feed xml sent by Reuters, plus parrot back a table of all the possible parameters and their current values. For a list of supported feeds, please go to http://parfait.snarkybox.com/feeds-reuters.php.

Example Link:

http://parfait.snarkybox.com/reuters.php?test=true&feed=topnews

What that link returns will look like this:


<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" media="screen" href="/d/styles/rss2full.xsl"?>
<?xml-stylesheet type="text/css" media="screen" href="http://feeds.reuters.com/d/styles/itemcontent.css"?>
<rss xmlns:itunes="http://www.itunes.com/dtds/podcast-1.0.dtd" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:taxo="http://purl.org/rss/1.0/modules/taxonomy/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:feedburner="http://rssnamespace.org/feedburner/ext/1.0" version="2.0">
  <channel>
    <title>Reuters: Top News</title>
    <link>http://www.reuters.com</link>
    <description>Reuters.com is your source for breaking news, business, financial and investing news, including personal finance and stocks. Reuters is the leading global provider of news, financial information and technology solutions to the world's media, financial institutions, businesses and individuals.</description>
    <language>en-us</language>
    <copyright>All rights reserved. Users may download and print extracts of content from this website for their own personal and non-commercial use only. Republication or redistribution of Reuters content, including by framing or similar means, is expressly prohibited without the prior written consent of Reuters. Reuters and the Reuters sphere logo are registered trademarks or trademarks of the Reuters group of companies around the world. © Reuters 2014</copyright>
    <pubDate>Fri, 07 Nov 2014 01:00:42 GMT</pubDate>
    <lastBuildDate>Fri, 07 Nov 2014 01:00:42 GMT</lastBuildDate>
    <ttl>5</ttl>
    <image>
      <title>Reuters: Top News</title>
      <url>http://www.reuters.com/resources_v2/images/reuters125.png</url>
      <link>http://www.reuters.com</link>
    </image>
    <atom10:link xmlns:atom10="http://www.w3.org/2005/Atom" rel="self" type="application/rss+xml" href="http://feeds.reuters.com/reuters/topNews"/>
    <feedburner:info uri="reuters/topnews"/>
    <atom10:link xmlns:atom10="http://www.w3.org/2005/Atom" rel="hub" href="http://pubsubhubbub.appspot.com/"/>
    <feedburner:feedFlare href="http://add.my.yahoo.com/rss?url=http%3A%2F%2Ffeeds.reuters.com%2Freuters%2FtopNews" src="http://us.i1.yimg.com/us.yimg.com/i/us/my/addtomyyahoo4.gif">Subscribe with My Yahoo!</feedburner:feedFlare>
    <feedburner:feedFlare href="http://www.newsgator.com/ngs/subscriber/subext.aspx?url=http%3A%2F%2Ffeeds.reuters.com%2Freuters%2FtopNews" src="http://www.newsgator.com/images/ngsub1.gif">Subscribe with NewsGator</feedburner:feedFlare>
    <feedburner:feedFlare href="http://feeds.my.aol.com/add.jsp?url=http%3A%2F%2Ffeeds.reuters.com%2Freuters%2FtopNews" src="http://o.aolcdn.com/favorites.my.aol.com/webmaster/ffclient/webroot/locale/en-US/images/myAOLButtonSmall.gif">Subscribe with My AOL</feedburner:feedFlare>
    <feedburner:feedFlare href="http://www.bloglines.com/sub/http://feeds.reuters.com/reuters/topNews" src="http://www.bloglines.com/images/sub_modern11.gif">Subscribe with Bloglines</feedburner:feedFlare>
    <feedburner:feedFlare href="http://www.netvibes.com/subscribe.php?url=http%3A%2F%2Ffeeds.reuters.com%2Freuters%2FtopNews" src="http://www.netvibes.com/img/add2netvibes.gif">Subscribe with Netvibes</feedburner:feedFlare>
    <feedburner:feedFlare href="http://fusion.google.com/add?feedurl=http%3A%2F%2Ffeeds.reuters.com%2Freuters%2FtopNews" src="http://buttons.googlesyndication.com/fusion/add.gif">Subscribe with Google</feedburner:feedFlare>
    <feedburner:feedFlare href="http://www.pageflakes.com/subscribe.aspx?url=http%3A%2F%2Ffeeds.reuters.com%2Freuters%2FtopNews" src="http://www.pageflakes.com/ImageFile.ashx?instanceId=Static_4&amp;fileName=ATP_blu_91x17.gif">Subscribe with Pageflakes</feedburner:feedFlare>
    <item>
      <title>Disney profit meets estimates with help from 'Guardians' film</title>
      <link>http://feeds.reuters.com/r/reuters/topNews/3/DmbWP7mBkzI/story01.htm</link>
      <description>(Reuters) - Walt Disney Co posted quarterly profit that fell in line with Wall Street expectations as the media and theme park giant rode the blockbuster performance of its movie box office hits "Maleficent" and "Guardians of the Galaxy."&lt;img width='1' height='1' src='http://reuters.us.feedsportal.com/c/35217/f/654200/s/403d133c/sc/21/mf.gif' border='0'/&gt;&lt;br clear='all'/&gt;&lt;div class="feedflare"&gt;
&lt;a href="http://feeds.reuters.com/ff/reuters/topNews?a=DmbWP7mBkzI:TX_AE2CYtiA:yIl2AUoC8zA"&gt;&lt;img src="http://feeds.feedburner.com/ff/reuters/topNews?d=yIl2AUoC8zA" border="0"&gt;&lt;/img&gt;&lt;/a&gt; &lt;a href="http://feeds.reuters.com/ff/reuters/topNews?a=DmbWP7mBkzI:TX_AE2CYtiA:V_sGLiPBpWU"&gt;&lt;img src="http://feeds.feedburner.com/ff/reuters/topNews?i=DmbWP7mBkzI:TX_AE2CYtiA:V_sGLiPBpWU" border="0"&gt;&lt;/img&gt;&lt;/a&gt; &lt;a href="http://feeds.reuters.com/ff/reuters/topNews?a=DmbWP7mBkzI:TX_AE2CYtiA:-BTjWOF_DHI"&gt;&lt;img src="http://feeds.feedburner.com/ff/reuters/topNews?i=DmbWP7mBkzI:TX_AE2CYtiA:-BTjWOF_DHI" border="0"&gt;&lt;/img&gt;&lt;/a&gt;
&lt;/div&gt;&lt;img src="http://feeds.feedburner.com/r/reuters/topNews/4/DmbWP7mBkzI" height="1" width="1"/&gt;</description>
      <category domain="">topNews</category>
      <pubDate>Fri, 07 Nov 2014 00:59:15 GMT</pubDate>
      <guid isPermaLink="false">http://www.reuters.com/article/2014/11/07/us-disney-results-idUSKBN0IQ2HO20141107?feedType=RSS&amp;feedName=topNews</guid>
      <feedburner:origLink>http://reuters.us.feedsportal.com/c/35217/f/654200/s/403d133c/sc/21/l/0L0Sreuters0N0Carticle0C20A140C110C0A70Cus0Edisney0Eresults0EidUSKBN0AIQ2HO20A14110A70DfeedType0FRSS0GfeedName0FtopNews/story01.htm</feedburner:origLink>
    </item>
    <item>
      <title>Appeals court upholds gay marriage bans, reversing trend</title>
      <link>http://feeds.reuters.com/r/reuters/topNews/3/A1zCa-ujAv8/story01.htm</link>
      <description>(Reuters) - A federal appeals court on Thursday bucked a recent trend of pro-gay marriage decisions by upholding state bans or restrictions in Kentucky, Michigan, Ohio and Tennessee, pressuring the Supreme Court to take up the issue.&lt;img width='1' height='1' src='http://reuters.us.feedsportal.com/c/35217/f/654200/s/403c8dda/sc/7/mf.gif' border='0'/&gt;&lt;br clear='all'/&gt;&lt;br/&gt;&lt;br/&gt;&lt;a href="http://da.feedsportal.com/r/211597269484/u/49/f/654200/c/35217/s/403c8dda/sc/7/rc/1/rc.htm" rel="nofollow"&gt;&lt;img src="http://da.feedsportal.com/r/211597269484/u/49/f/654200/c/35217/s/403c8dda/sc/7/rc/1/rc.img" border="0"/&gt;&lt;/a&gt;&lt;br/&gt;&lt;a href="http://da.feedsportal.com/r/211597269484/u/49/f/654200/c/35217/s/403c8dda/sc/7/rc/2/rc.htm" rel="nofollow"&gt;&lt;img src="http://da.feedsportal.com/r/211597269484/u/49/f/654200/c/35217/s/403c8dda/sc/7/rc/2/rc.img" border="0"/&gt;&lt;/a&gt;&lt;br/&gt;&lt;a href="http://da.feedsportal.com/r/211597269484/u/49/f/654200/c/35217/s/403c8dda/sc/7/rc/3/rc.htm" rel="nofollow"&gt;&lt;img src="http://da.feedsportal.com/r/211597269484/u/49/f/654200/c/35217/s/403c8dda/sc/7/rc/3/rc.img" border="0"/&gt;&lt;/a&gt;&lt;br/&gt;&lt;br/&gt;&lt;a href="http://da.feedsportal.com/r/211597269484/u/49/f/654200/c/35217/s/403c8dda/sc/7/a2.htm"&gt;&lt;img src="http://da.feedsportal.com/r/211597269484/u/49/f/654200/c/35217/s/403c8dda/sc/7/a2.img" border="0"/&gt;&lt;/a&gt;&lt;img width="1" height="1" src="http://pi.feedsportal.com/r/211597269484/u/49/f/654200/c/35217/s/403c8dda/sc/7/a2t.img" border="0"/&gt;&lt;div class="feedflare"&gt;
&lt;a href="http://feeds.reuters.com/ff/reuters/topNews?a=A1zCa-ujAv8:RNIctWoGScU:yIl2AUoC8zA"&gt;&lt;img src="http://feeds.feedburner.com/ff/reuters/topNews?d=yIl2AUoC8zA" border="0"&gt;&lt;/img&gt;&lt;/a&gt; &lt;a href="http://feeds.reuters.com/ff/reuters/topNews?a=A1zCa-ujAv8:RNIctWoGScU:V_sGLiPBpWU"&gt;&lt;img src="http://feeds.feedburner.com/ff/reuters/topNews?i=A1zCa-ujAv8:RNIctWoGScU:V_sGLiPBpWU" border="0"&gt;&lt;/img&gt;&lt;/a&gt; &lt;a href="http://feeds.reuters.com/ff/reuters/topNews?a=A1zCa-ujAv8:RNIctWoGScU:-BTjWOF_DHI"&gt;&lt;img src="http://feeds.feedburner.com/ff/reuters/topNews?i=A1zCa-ujAv8:RNIctWoGScU:-BTjWOF_DHI" border="0"&gt;&lt;/img&gt;&lt;/a&gt;
&lt;/div&gt;&lt;img src="http://feeds.feedburner.com/r/reuters/topNews/4/A1zCa-ujAv8" height="1" width="1"/&gt;</description>
      <category domain="">topNews</category>
      <pubDate>Fri, 07 Nov 2014 00:48:41 GMT</pubDate>
      <guid isPermaLink="false">http://www.reuters.com/article/2014/11/07/us-usa-gaymarriage-6thcircuit-idUSKBN0IQ2KS20141107?feedType=RSS&amp;feedName=topNews</guid>
      <feedburner:origLink>http://reuters.us.feedsportal.com/c/35217/f/654200/s/403c8dda/sc/7/l/0L0Sreuters0N0Carticle0C20A140C110C0A70Cus0Eusa0Egaymarriage0E6thcircuit0EidUSKBN0AIQ2KS20A14110A70DfeedType0FRSS0GfeedName0FtopNews/story01.htm</feedburner:origLink>
    </item>
  </channel>
</rss>

http://feeds.reuters.com/reuters/topnews?format=xml

feed layer items test version
topnews     true 2017.01.06.22

 


Items Parameter

Using the parameter 'items' will limit the numbers of items returned, regardless of how many are sent in the Reuters feed.

If the Reuters feed sends fewer items than requested using this parameter, the number of items actually in the Reuters feed are all that will be returned.


Complete Data Retrieval, Header

Using the parameters 'feed' and 'layer' together will retrieve a '*' delimited, '~' line terminated, '|' layer terminated segment of Reuters elements. For a list of supported feeds, please go to http://parfait.snarkybox.com/feeds-reuters.php.

'layer=head' will return a header information line.

Example Link:

http://parfait.snarkybox.com/reuters.php?feed=topnews&layer=head

What that link returns will look like this:

hd*ParfaitAPI*http://parfait.snarkybox.com/*reuters*****topnews*head*20141210*2114*68.100.18.139*2014.12.10.13~|

Element Names:

hd00 hd01 hd02 hd03 hd04 hd05 hd06 hd07 hd08 hd09
layer_code API identification API URL "reuters" NULL NULL items parameter NULL feed parameter layer parameter
token string anyURI token NULL NULL token NULL token token

hd10 hd11 hd12 hd13
date of request (CCYYMMDD) time of request (HHMM) Remote IP Address parfait version
token token token token

Complete Data Retrieval, Meta Data Retrieval

Using the parameters 'feed' and 'layer' together will retrieve a '*' delimited, '~' line terminated, '|' layer terminated segment of Reuters elements. For a list of supported feeds, please go to http://parfait.snarkybox.com/feeds-reuters.php.

'layer=meta' will retrieve the meta data about the reuters feed.

Example Link:

http://parfait.snarkybox.com/reuters.php?feed=topnews&layer=meta

What that link returns will look like this:

mt*Reuters: Top News*http://www.reuters.com*en-us*Fri, 07 Nov 2014 01:00:42 GMT*Fri, 07 Nov 2014 01:00:42 GMT*5*Reuters: Top News*http://www.reuters.com/resources_v2/images/reuters125.png*http://www.reuters.com~|

Field Names:

mt00 mt01 mt02 mt03 mt04 mt05 mt06 mt07 mt08 mt09
layer_code title link language pubDate lastBuildDate ttl imageTitle imageURL imageLink
token string anyURI language datetime datetime nonNegativeInteger string anyURI anyURI

Complete Data Retrieval, Other Data Retrieval

Using the parameters 'feed' and 'layer' together will retrieve a '*' delimited, '~' line terminated, '|' layer terminated segment of Reuters elements. For a list of supported feeds, please go to http://parfait.snarkybox.com/feeds-reuters.php.

'layer=other' will retrieve some extra data from the reuters feed.

Example Link:

http://parfait.snarkybox.com/reuters.php?feed=topnews&layer=other

What that link returns will look like this:

ot*Reuters.com is your source for breaking news, business, financial and investing news, including personal finance and stocks. Reuters is the leading global provider of news, financial information and technology solutions to the world's media, financial institutions, businesses and individuals.*All rights reserved. Users may download and print extracts of content from this website for their own personal and non-commercial use only. Republication or redistribution of Reuters content, including by framing or similar means, is expressly prohibited without the prior written consent of Reuters. Reuters and the Reuters sphere logo are registered trademarks or trademarks of the Reuters group of companies around the world. © Reuters 2014*|

Field Names:

ot00 ot01 ot02
layer_code description copyright
token string string

 


Complete Data Retrieval, Low Verbosity Data Retrieval

Using the parameters 'feed' and 'layer' together will retrieve a '*' delimited, '~' line terminated, '|' layer terminated segment of Reuters elements. For a list of supported feeds, please go to http://parfait.snarkybox.com/feeds-reuters.php.

'layer=low' will retrieve the reuters feed items in a short form for all of the items contained in the reuters feed.

Example Link:

http://parfait.snarkybox.com/reuters.php?feed=topnews&layer=low&items=3

What that link returns will look like this:

lo*00*G20 commits to higher growth, fight climate change; Russia isolated over Ukraine*http://feeds.reuters.com/r/reuters/topNews/3/7FiimA47mKA/story01.htm*topNews*Sun, 16 Nov 2014 15:25:54 GMT~lo*01*Islamic State claims to have beheaded U.S. hostage Kassig*http://feeds.reuters.com/r/reuters/topNews/3/aFHvewi3Mok/story01.htm*topNews*Sun, 16 Nov 2014 15:06:58 GMT~lo*02*U.S. hospital says Sierra Leone doctor with Ebola extremely critical*http://feeds.reuters.com/r/reuters/topNews/3/_WJyVT5LVZs/story01.htm*topNews*Sun, 16 Nov 2014 14:56:38 GMT~|

Field Names:

lo00 lo01 lo02 lo03 lo04 lo05
layer_code item title link category pubDate
token token string anyURI string datetime

 


Complete Data Retrieval, High Verbosity Data Retrieval

Using the parameters 'feed' and 'layer' together will retrieve a '*' delimited, '~' line terminated, '|' layer terminated segment of Reuters elements. For a list of supported feeds, please go to http://parfait.snarkybox.com/feeds-reuters.php.

'layer=high' will retrieve the reuters feed items in a long form for all of the items contained in the reuters feed.

Example Link:

http://parfait.snarkybox.com/reuters.php?feed=topnews&layer=high&items=3

What that link returns will look like this:

hi*00*BRISBANE Australia (Reuters) - Leaders from the G20 group of nations agreed on Sunday to boost flagging global growth, tackle climate change and crack down on tax avoidance but ties between the West and Russia plummeted to a new low over the crisis in Ukraine.*http://www.reuters.com/article/2014/11/16/us-g20-summit-putin-idUSKCN0J002Z20141116?feedType=RSS&feedName=topNews~hi*01*BEIRUT (Reuters) - Islamic State militants said in a video on Sunday they had beheaded U.S. hostage Peter Kassig and warned the United States they would kill other U.S. citizens "on your streets".*http://www.reuters.com/article/2014/11/16/us-mideast-crisis-beheading-idUSKCN0J008W20141116?feedType=RSS&feedName=topNews~hi*02*OMAHA Neb. (Reuters) - A surgeon from Sierra Leone being treated for Ebola in a Nebraska hospital on Saturday was critically ill after being airlifted back from Africa, medical officials said.*http://www.reuters.com/article/2014/11/16/us-health-ebola-usa-surgeon-idUSKCN0IZ0DY20141116?feedType=RSS&feedName=topNews~|

Field Names:

hi00 hi01 hi02 hi03
layer_code item description guid
token token string string

 


Complete Data Retrieval, Combinations

Multiple 'layer' parameters can be sent by simply putting a comma between them: 'layer=meta,text' or layer=short,text'. This results in all of the data requested being returned in the same line, so you would first split them by a pipe, then a second split by a tilde. The first element of each segment is the layer_code, so inspecting the first four characters will tell you which segment you're working with. Splitting each of these segments by an asterisk will get each of the elements. For a list of supported feeds, please go to http://parfait.snarkybox.com/feeds-reuters.php.

NOTE: the order in which the layer strings occur does not affect the output order. 'layer=meta,text' will have the same result as 'layer=text,meta'. The output order is always: Header, Meta, Other, Low Verbosity, High Verbosity

Example Link:

http://parfait.snarkybox.com/reuters.php?feed=topnews&layer=head,meta,other,low&items=3

What that link returns will look like this:

hd*reuters***3**topnews*head,meta,other,low*20141116*1115*68.100.18.139*2014.11.16.12~|mt*Reuters: Top News*http://www.reuters.com*en-us*Sun, 16 Nov 2014 15:30:22 GMT*Sun, 16 Nov 2014 15:30:22 GMT*5*Reuters: Top News*http://www.reuters.com/resources_v2/images/reuters125.png*http://www.reuters.com~|ot*Reuters.com is your source for breaking news, business, financial and investing news, including personal finance and stocks. Reuters is the leading global provider of news, financial information and technology solutions to the world's media, financial institutions, businesses and individuals.*All rights reserved. Users may download and print extracts of content from this website for their own personal and non-commercial use only. Republication or redistribution of Reuters content, including by framing or similar means, is expressly prohibited without the prior written consent of Reuters. Reuters and the Reuters sphere logo are registered trademarks or trademarks of the Reuters group of companies around the world. © Reuters 2014*|lo*00*G20 commits to higher growth, fight climate change; Russia isolated over Ukraine*http://feeds.reuters.com/r/reuters/topNews/3/7FiimA47mKA/story01.htm*topNews*Sun, 16 Nov 2014 15:25:54 GMT~lo*01*Islamic State claims to have beheaded U.S. hostage Kassig*http://feeds.reuters.com/r/reuters/topNews/3/aFHvewi3Mok/story01.htm*topNews*Sun, 16 Nov 2014 15:06:58 GMT~lo*02*U.S. hospital says Sierra Leone doctor with Ebola extremely critical*http://feeds.reuters.com/r/reuters/topNews/3/_WJyVT5LVZs/story01.htm*topNews*Sun, 16 Nov 2014 14:56:38 GMT~|

 


Error Messages

Should you accidentally use the API incorrectly or if the API didn't return any data from it's source feed, you may see one of two errors.

Missing API Parameters

If the API is unhappy about not being passed the appropriate parameters, you will see this message:

er*Missing API Parameters*It appears you have tried to access the API without passing all required parameters.*http://parfait.snarkybox.com/reuters.php*http://parfait.snarkybox.com/help-reuters.php~

No Data Returned

If for some reason the source feed didn't return any data to PARFAIT, you will see this message:

er*No Data Returned*It appears that no data was returned from the feed using the parameters you entered into the API.*http://parfait.snarkybox.com/reuters.php?feed=topneews&layer=low&items=3*http://parfait.snarkybox.com/help-reuters.php~

Field Names:

er00 er01 er02 er03 er04
layer_code error description source link help file link
token string string anyURI anyURI