FetchRSS API


Your API auth key will be here after registration.

General information

This API provides a programmatic access to basic FetchRSS functionality.

All API requests must be sent via HTTP protocol to a special endpoints URL. Using this pattern:
http://fetchrss.com/api/v1/ENDPOINT?auth=YOUR-API-AUTH-KEY&OTHER-PARAMETERS

Each API request must be authenticated by adding ?auth=YOUR-API-AUTH-KEY to a request parameters.
YOUR-API-AUTH-KEY - is your personal key. It can be found at the top of this page.

All API endpoints have 1 request per second limitation. For example if you make a few calls to the /feed/create endpoint at the same time, then only the first call will work. And the rest will be declined.

End-Points

/feed/create

Create an RSS feed. Returns a link to created feed.
Once you've created a feed, you don't need to call this endpoint to update it. The feed is updating automatically and available at the "rss_url" address.
If you have a feed and will try to create a new one with the same parameters, it won't be created. In this case, our API will return a feed id and rss_url of the existing feed.
If you continue trying to create a feed again and again too many times, although it already exists in your account, our system may block your API key. To prevent this from happening, please consider checking your feeds list at /feed/list and limit unnecessary requests.

Parameters:

Key Required Description Example
url required Target URL http://facebook.com/cnn
title optional Set custom feed title. 120 characters max. Leave empty to fetch it from a source page automatically CNN on Facebook
description optional Set custom feed description. 500 characters max. Leave empty to fetch it from a source page automatically CNN news posted on Facebook
items-per-rss optional Limit the number of posts in the RSS file at a time. Accepted values: 1 - 5. Default value: maximum number allowed by the current plan 3

Example Request:

http://fetchrss.com/api/v1/feed/create?auth=YOUR-API-AUTH-KEY&url=http%3A%2F%2Ffacebook.com%2Fcnn

Example Response:

{
    "success": true,
    "feed": {
        "id": "5875fec344607288628a9249",
        "rss_url": "http://fetchrss.com/rss/566b1cbb8a93f85e53b226f467587692067.xml"
    },
    "target_url": "http://facebook.com/cnn"
}
HTML parser
If you need to create a feed out of a general web page. You'll need to add a target page parsing selectors. It must be a CSS selectors.

Parameters:

Key Required Description Example
url required Target URL https://www.nobelprize.org/
news-selector required News DOM selector
Note: All other selectors must be inside of this DOM
div.row > div.columns
title-selector required News title selector div.row > div.columns > h2
content-selector required News summery selector div.row > div.columns > p
pic-selector optional News illustration selector
date-selector optional News publish date selector
author-selector optional News author selector
link-selector optional News link selector
pic-src-param optional Image URL attribute.
In case the page uses lazy loading images.
And the required URL is not in "src" attribute
data-src
date-format-param optional Date parsing pattern
See http://fetchrss.com/docs/dateParse for more details
Y/M/D

Example Request:

http://fetchrss.com/api/v1/feed/create?auth=YOUR-API-AUTH-KEY&url=https%3A%2F%2Fwww.nobelprize.org%2F&news-selector=div.row+%3E+div.columns&title-selector=div.row+%3E+div.columns+%3E+h2&content-selector=div.row+%3E+div.columns+%3E+p

/feed/list

Get a list of all user feeds

Example Request:

http://fetchrss.com/api/v1/feed/list?auth=YOUR-API-AUTH-KEY

Example Response:

{
    "success": true,
    "feeds": [
        {
            "id": "5875fec344607288628a9249",
            "title": "CNN on Facebook",
            "rss_url": "http://fetchrss.com/rss/566b1cbb8a93f85e53b226f467587692067.xml"
        },
        {
            "id": "587601d3446072e9628a9249",
            "title": "Nobelprize.org",
            "rss_url": "http://fetchrss.com/rss/566b1cbb8a93f85e53b226f496051329546.xml"
        }
    ]
}

/feed/delete

Delete user feed
Creating and then deleting a feed with the same URL over and over is forbidden. Our system may block your API key if it detects such activity.

Parameters:

Key Required Description Example
id required RSS ID 5875fec344607288628a9249

Example Request:

http://fetchrss.com/api/v1/feed/delete?auth=YOUR-API-AUTH-KEY&id=5875fec344607288628a9249

Example Response:

{
    "success": true
}