Feeds API Reference

Feeds are a valuable channel for content subscription as well as publishing & distribution. Feedity helps you to easily create custom feeds for any public webpage with frequently-updated information like news, articles, discussion forums, reviews, jobs, events, products, blogs, press releases, social media (Facebook, Twitter, Instagram) etc.

Custom feeds can be created using our Web-based feed builder, which offers two modes: a simple point-and-click Visual Selector, and the more powerful HTML-tags-based Advanced Refinement.

Our API (short for Application Programming Interface) is another great way to programmatically build, manage or integrate custom feeds. The API also allows automatic creation of feeds from webpages, by utilizing our feed parser's powerful machine learning capabilities to auto-detect relevant content for a feed from its source.

Overview


The Feedity API is organized around REST, which is based on HTTP application protocol, making the API model simple, high-performance, and language-agnostic.
RSS and JSON feeds REST API architecture

Our API has resource-oriented URLs, and uses HTTP response codes to indicate an API operation status or error. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by most HTTP clients and libraries.

The API endpoint for standard accounts is mentioned below. Corporate plan customers must follow & use the corporate site API reference, for corresponding URLs and notes.

https://feedity.com/api/v1
API responses are returned as JSON (default) or XML, based on the request's HTTP 'Accept' header value for content negotiation (note: use 'application/json' or 'application/xml' MIME types). API request and response examples are provided below.

We can make backwards-compatible changes to the API at any time. We will release a new version of the API endpoint if any major backwards-incompatible changes are made. API related announcements are made via our newsletter (sent to all customers), on our blog and Twitter profile.

Authentication


You must authenticate your account by including your API key and secret in all API requests.

Your API key and secret can be found under your account, once you've signed-up for a plan that supports API access. You can change the API secret from your account at any time. Be sure to keep your API key and secret safe, as they allow access to your account data. Do not share your API key or secret in publicly accessible areas, client-side code etc. If you suspect that your API secret has been exposed, then change it immediately under your account.

Authentication to the API is performed via HTTP Basic Auth. Provide your API key as the basic auth username value, and the secret as the password value. Most HTTP clients allow a HTTP 'Authorization' header value, that should be set to a Base64 encoded string of your API key and secret combined with a colon.

Here's a 'curl' command line example with the HTTP 'Authorization' header, that can be translated to any programming language or library:

curl https://feedity.com/api/v1/feeds -H "Authorization: Basic [Base64 string of API_key:Secret]" ...
Here's another 'curl' command line example, that uses its '-u' flag to directly pass basic auth credentials:

curl https://feedity.com/api/v1/feeds -u [API_key]:[Secret] ...
You can also authenticate via Bearer auth, in which case, set the HTTP 'Authorization' header value to a Base64 encoded string token of your API key and secret combined with a colon:

curl https://feedity.com/api/v1/feeds -H "Authorization: Bearer [Base64 string of API_key:Secret]" ...
API requests without authentication, or with an invalid authentication, will fail.

All API requests must be made over HTTPS. Calls made over plain HTTP are insecure, and not recommended at all.

Errors


We use conventional HTTP response codes to indicate the success or failure of an API request.

Codes in the 2xx range indicate success, in general.

Codes in the 4xx range indicate a client error based on the request or data sent (e.g., authentication failure, a required parameter was not specified, a validation failed etc.). For example:

Codes in the 5xx range, although rare, indicate a server error caused when our API servers fail to fulfill a request.

API access is rate-limited, but sufficient for high-throughput. Excessive API calls in a very short period, or any type of abuse, will automatically cause access to be revoked for the violating account, and eventual account termination without notice.

Feeds


A feed object describes a new or existing feed in your account.

The feed object


List all feeds


Retrieve a list of existing feeds from the user account, as a collection of feed objects, along with a total count.

Create a feed


Create a new feed, and get its object. The feed will be saved in the user account, if the user plan's feeds allowance permits (i.e. within limit).

Our feed parser will use heuristics and machine learning to try & detect relevant content settings for the feed from its source webpage. This is an experimental feature, that works best for news articles on sparse webpages. If auto-detection doesn't find any relevant articles, then the feed is marked as broken, so that it can be manually edited with the feed builder, similar to when auto-detected results are unsatisfactory.

Delete a feed


Delete an existing feed from the user account. Deleted feeds cannot be restored.


Contact us if you have any questions or feature requests, or if you need any help with using the API or integrating custom feeds.

This website uses cookies for functionality and settings, as per our privacy policy. Got it.