FeedzZ API

We have released a Feedzz api (version 0.1) that will allow developers to retrieve basic information from our site entries and semantic term using several retrieval criteria. The API has been built on top of RSS 2.0 services, so the results can be easily parsed.

Authentication parameters

All the API requires identification, therefore you need to specify the following parameters related to your username and API code.
parameter username > your username on feedzz
parameter apicode > API code


IMPORTANT NOTE: Please not that these parameters are mandatory in all the API calls
To use the API you need to be a registered user

To get your API code follow the next stesp
1 - Register as user of feedZZ
2 - Go to your profile page (My feeds)
3 - Click on the icon that appears as Edit
4 - Click on the button Get API Code
There is a limit of 200 API calls. If you need more please contact with us

Basic Site services

API CALL [ http://www.feedzz.com/rss/sites.html]

You can get information related about all the sites available in the platform and which are the categories per site. Here you can see the id parameter of the category in case you want to access future data per category.


This is the format of each site returned by the API call

<item>
<title>Usa</title>
<link>http://www.feedzz.com/feeds/RSSSites.html?siteID=1</link>
<category>1 - Politics</category>
<category>2 - Celebrity</category>
<category>3 - Technology</category>
<category>4 - Business</category>
<category>6 - Sports</category>
<category>7 - Music</category>
<category>8 - Film</category>
<category>5 - Science</category>
<category>9 - Health</category>
</item>
parameters No parameters are necessary
IMPORTANT NOTE: See note about identification mandatory parameters in all the API calls


Sample: http://www.feedzz.com/rss/sites.html

Note: This call is fundamental as starting point to retrieve the categories per site. Other calls in this API which use the parameter categoryID needs to identify the id from the response of this call.

Search services

API CALL [ http://www.feedzz.com/rss/rss.html]

You can retrieve the feed entries stored in our database using several retrieval criteria.


This is the format of each entry returned by the API call

<item>
<title>title goes here </title>
<link>http://www.feedzz.com/feeds/RSSNewDetail.html?id=XXXXX</link>
<content:encoded>body goes here </content>
</item>

Entries in a category

parameter categoryID > id of the section
IMPORTANT NOTE: See note about identification mandatory parameters in all the API calls


Sample http://www.feedzz.com/rss/rss.html?categoryID=3&type=1&username=username&apicode=123456

Note: See Basic Site services for further information about how to retrievev valid values for categoryID parameter.

Entries related with a semantic term

parameter tag > name of the semantic term
parameter page > 0,1,2,... [ OPTIONAL] Default:0
IMPORTANT NOTE: See note about identification mandatory parameters in all the API calls


Sample: http://www.feedzz.com/rss/rss.html?tag=google&username=username&apicode=123456

Number of results per page:20

Note: The semantic term represented by the parameter tag need to exist as a tag in our system. Retrieve available tags using some of the API calls mentioned in the section Semantic Services

Entries containing a specific text either in the title or the body of the entry

parameter text > text to search
parameter page > 0,1,2,... [ OPTIONAL] Default:0
IMPORTANT NOTE: See note about identification mandatory parameters in all the API calls


Sample: http://www.feedzz.com/rss/rss.html?text=google&username=username&apicode=123456

Number of results per page:20

Semantic services

API CALL [ http://www.feedzz.com/rss/tags.html]

We expose the semantic terms ( tags) to facilitate the extraction of semantic terms from our database using several criteria. The results can be used to made "cloud like" components as in the title you can see the number of ocurrences for that tag.


This is the format of each tag returned by the API call

<item>
<title>( 3 ) - federal government</title>
<link>http://www.feedzz.com/feeds/RSSNews.html?tag=federal government</link>
<category>federal government</category>
</item>

Note: Semantic terms will be available only for those sites with semantic features. Only english sites have this feature enabled, as Calais still don't provide semantic detection till the moment for other languages. So you will need to provide categoryID corresponding to sites . See Retrieving basic site information for further info

Semantic terms related with a semantic term

parameter tag > name of the semantic term
IMPORTANT NOTE: See note about identification mandatory parameters in all the API calls


Sample: http://www.feedzz.com/rss/tags.html?tag=google&username=username&apicode=123456

Note: The semantic term represented by the parameter tag need to exist as a tag in our system. Retrieve available tags using some of the API calls mentioned in the section Semantic Services

Semantic terms extracted from entries containing a specific text

parameter text > text to search
IMPORTANT NOTE: See note about identification mandatory parameters in all the API calls


Sample: http://www.feedzz.com/rss/tags.html?text=google&username=username&apicode=123456

Semantic terms in a specific category

parameter categoryID > id of the section
IMPORTANT NOTE: See note about identification mandatory parameters in all the API calls


Sample http://www.feedzz.com/rss/tags.html?categoryID=2&type=1&username=username&apicode=123456

Note: See Basic Site services for further information about how to retrievev valid values for categoryID parameter.

Semantic terms related with a specific entry

parameter item > id of the feed entry
IMPORTANT NOTE: See note about identification mandatory parameters in all the API calls


Sample: http://www.feedzz.com/rss/tags.html?tag=google&username=username&apicode=123456

Note: The id of the feed must exist in our system.

Semantic terms extracted from entries containing a specific text

parameter text > text to search
IMPORTANT NOTE: See note about identification mandatory parameters in all the API calls


Sample: http://www.feedzz.com/rss/tags.html?text=google&username=username&apicode=123456

User activity services

API CALL [ http://www.feedzz.com/rss/activity.html]

You can retrieve the latest actions that a user has performed in the site This can be useful to track recent activity or to integrate with LifeStream services.


This is the format of each entry returned by the API call

<item> <title>mauricio10 voted this entry: Take That, Barack</title>
<link>http://www.feedzz.com/feeds/RSSNewDetail.html?id=13683</link>
<description>Take That, Barack</description>
<pubdate>2008-05-30 17:39:03.0</pubdate>
<type>1</type>
</item>

User activity

parameter user > username of the user
IMPORTANT NOTE: See note about identification mandatory parameters in all the API calls


Sample http://www.feedzz.com/rss/activity.html?user=XXXXXXX&username=username&apicode=123456

Note: There are 4 values for the type element which specifies the kind of action (for feed entries)

20 - Bookmark
21 - Vote
22 - View
23 - Share


Note: There are 2 values for the type element which specifies the kind of action (for feeds)

11 - Create a feed
12 - Subscribe a feed