English | Site Directory

FeedBurner API

Feed Management API Reference

Introduction

The FeedBurner Management API (MgmtAPI) allows publishers of FeedBurner feeds to create and manage feeds within their FeedBurner accounts. MgmtAPI permits remote access to FeedBurner's basic account management capabilities by third party applications without requiring direct use of the existing FeedBurner.com website. Using MgmtAPI, third parties can completely re-present FeedBurner's feed creation and management capabilities.

Feed APIs

This is the list of APIs that are supported by the management interface. All function calls are available via both HTTP and HTTPS.

Find Feeds

Version 1.0

This API will return the list of feeds for a particular user.

Request URL

GET http://api.feedburner.com/management/1.0/FindFeeds

Request Paramaters

Right now, there are no parameters associated with this request (other than the standard authentication parameters). This will just return a list of all of the feeds associated with the user.

Response Fields

The schema document for this service response is located at http://api.feedburner.com/management/1.0/FindFeedsResponse.xsd.

Field Description
feeds Contains all of the feeds
feed Represents a single feed
id Attribute. A unique id for the feed
uri Attribute. The uri for the feed
title Attribute. The title for the feed

Sample Response

    GET http://api.feedburner.com/management/1.0/FindFeeds
	?user=jshaftoe&password=3L1Z4
    <?xml version="1.0" encoding="utf-8" ?>

    <feeds>
        <feed id="14" uri="eric" title="Dancing About 
        Architecture" />
        <feed id="23" uri="eric-comments" title="Dancing About 
        Architecture: Comments and Trackbacks" />
        <feed id="17477" uri="groupcast" title="del.icio.us 
        groupcast" /> <br />
    </feed>

Errors

There are no service-specific errors. If the user does not have any feeds, the feeds element will be present but will not have any children.

Back to top

Get Feed

Version 1.0

This API will return the details of a particular feed.

Request URL

GET http://api.feedburner.com/management/1.0/GetFeed

Request Paramaters

Parameter Value Description
id integer The feed id. One of either id or uri must be provided.
uri string The feed uri. One of either id or uri must be provided.

Response Fields

The schema document for this service response is located at http://api.feedburner.com/management/1.0/GetFeedResponse.xsd.

Field Description
feed Represents the feed
id Attribute. A unique id for the feed
uri Attribute. The uri for the feed
title Attribute. The title for the feed
source The source feed location
url Attribute. The url for the source feed
services Contains all of the services that are applied to the feed
service Represents a service applied to the feed.
class Attribute. The class identifies which service to employ.
param Represents a parameter, with the text of the element as the value.
name Attribute. The name of the parameter.

Sample Response

    GET http://api.feedburner.com/management/1.0/GetFeed?user=jshaftoe&password=3L1Z4&uri=groupcast

    <feed id="17477" uri="groupcast" title="del.icio.us groupcast">
        <source url="http://del.icio.us/rss/tag/groupcast"/>

        <services>
            <service class="BrowserFriendly">
                <param name="theme">PodcastFriendly</param>
                <param name="itemVisibility">content</param>
                <param name="message">Welcome to the FeedBurner "groupcast" experiment. This is a feed 
                from del.icio.us containing links tagged with "groupcast" that has been burned with 
                FeedBurner's SmartCast service to promote Podcasting. To add your own items to this 
                feed, create a del.icio.us entry that links directly to an MP3 or Torrent file and give
                it the tag "groupcast".</param>

            </service>
            <service class="SmartCast">
                <param name="mediaRSS">true</param>
                <param name="submitToYahoo">true</param>
                <param name="adult">false</param>

                <param name="pingWeblogs">false</param>
            </service>       
        </services>
    </feed>

Errors

There are no service-specific errors.

Back to top

Add Feed

Version 1.0

This API will allow the user to add a new feed to their account.

Request URL

POST http://api.feedburner.com/management/1.0/AddFeed

Request Paramaters

Parameter Value Description
feed xml (required) The defintion of the feed to add. This will include uri, title, source, and services, but not id.

Response Fields

The schema document for this service response is located at http://api.feedburner.com/management/1.0/AddFeedResponse.xsd.

Field Description
feed Represents the feed
id Attribute. A unique id for the feed
uri Attribute. The uri for the feed
title Attribute. The title for the feed

Sample Response

    POST http://api.feedburner.com/management/1.0/AddFeed
    user=jshaftoe
    password=3L1Z4
    feed=<feed uri="manormouse" title="Man | Mouse">
        <source url="http://manormouse.blogspot.com/atom.xml"/>
        <services>
            <service class="ItemStats" />
            <service class="SmartFeed" />

        </services>
    </feed>
    <feed id="84472" uri="manormouse" title="Man | Mouse" />

Errors

Error Code Sample Message Description
101 Too many feeds The limit for the number of feeds has been reached for this user.
102 uri not available. suggested uri: manormouse/f7Sq The uri provided is already taken.

Back to top

Modify Feed

Version 1.0

This API will allow the user to modify a feed in their account.

Request URL

POST http://api.feedburner.com/management/1.0/ModifyFeed

Request Paramaters

Parameter Value Description
feed xml (required) The new definition for the feed. If the id attribute is present, then that will take precendence, which allows the uri to change.

Response Fields

The schema document for this service response is located at http://api.feedburner.com/management/1.0/ModifyFeedResponse.xsd.

Field Description
feed Represents the feed
id Attribute. A unique id for the feed
uri Attribute. The uri for the feed
title Attribute. The title for the feed

Sample Response

    POST http://api.feedburner.com/management/1.0/ModifyFeed
    user=jshaftoe
    password=3L1Z4
    feed=<feed id="84472">
        <source url="http://manormouse.blogspot.com/atom.xml"/>
        <services>

            <service class="HeadlineAnimator">
                <param name="title">My Blog Postings</param>
            </service>
            <service class="ItemStats" />
            <service class="SmartFeed" />

        </services>
    </feed>

    <feed id="84472" uri="manormouse" title="Man | Mouse" />

Errors

Error Code Sample Message Description
102 uri not available. suggested uri: manormouse/f7Sq The uri provided is already taken.
103 Feed not identified: feed id or uri must be provided The feed element must provide either an id or uri parameter.

Back to top

Delete Feed

Version 1.0

This API will allow the user to delete a feed in their account.

Request URL

POST http://api.feedburner.com/management/1.0/DeleteFeed

Request Paramaters

Parameter Value Description
id integer The feed id. One of either id or uri must be provided.
uri string The feed uri. One of either id or uri must be provided.

Response Fields

A successful delete will have an empty success response.

Sample Response

A successful delete will have an empty success response.

Errors

There are no service-specific errors.

Back to top

Resync Feed

Version 1.0

This API will allow the user to resync a feed in their account. This will involves clearing the cache, resetting any podcast media enclosures, and informing the caller of any feed formatting problems.

Request URL

POST http://api.feedburner.com/management/1.0/ResyncFeed

Request Paramaters

Parameter Value Description
id integer The feed id. One of either id or uri must be provided.
uri string The feed uri. One of either id or uri must be provided.

Response Fields

A successful resync will have an empty success response.

Sample Response

A successful resync will have an empty success response.

Errors

There are no service-specific errors.

Back to top

Standard Error Responses

This is a list of error responses that may be returned by any API.

Error Code Sample Message Description
1 Invalid user User cannot be authenticated. This might be due to:
  1. User and/or password parameters are not provided, and HTTP Authorization header not provided
  2. User is not found
  3. Password is invalid
2 partnerUser not enabled User account does not support partnerUser partitioning, but the argument was provided.
3 Missing parameter: id A required parameter is missing.
4 Invalid parameter: id A parameter that has been provided is invalid.
5 Feed not found The requested feed does not exist.
6 Invalid feed XML The feed definition is not valid XML
7 Missing feed source The feed does not specify a source
8 Invalid feed source: 404 Not Found There is a problem with the feed source.
9 Invalid service class The service specified does not exist, or the user does not have access to that service.
10 Service validation error: BrowserFriendly theme is invalid One or more of the specified services is invalid.

Back to top

Services APIs

This is the list of services that are generally available for feeds. Specific partners may have additional services available that are not listed here. The parameters supported are listed here.

Browser-Friendly

Service Class: BrowserFriendly

Applies basic visual formatting with a heading message you specify to raw feed XML (using XSLT) for much improved readability in most modern browsers.

Parameters

Name Value Description
style new (default), podcast or oldschool The theme to apply for this service.
itemVisibility content (default), title, or none What part of items are displayed? (the full content, just the titles, or don't display the items)
message string (default: none) The message to display at the top of the page. If not specified, then no message will be displayed.
feedUrl string (default: none) The URL that should be used to subscribe to this feed. Only needs to be specified when the user wished to use a redirected URL as the entry point for the feed.

Sample

    <service class="BrowserFriendly">
        <param name="itemVisibility">title</param>
        <param name="message">This is a feed, but the titles are displayed for your convenience 
        below.</param>

    </service>

Back to top

Clickthrough Tracking

Service Class: ItemStats

Tracks clickthroughs to individual items.

Parameters

There are no parameters for this service. Including this service is sufficient.

Sample

    <service class="ItemStats" />

Back to top

SmartFeed

Service Class: SmartFeed

Permits an Atom feed be readable with any news reader — even older RSS-only readers. SmartFeed transforms your feed to be optimized and readable a wide variety of feed readers and aggregators, regardless of the source feed's format.

Parameters

There are no parameters for this service. Including this service is sufficient.

Sample

    <service class="SmartFeed" />

Back to top

AdSense for Feeds

Service Class: AdSense

Places ads that Google generates for your AdSense for feeds account into your feed. Ads are placed at the bottom of individual feed content items according to the content item length and ad frequency preferences specified.

Parameters

Name Value Description
adSenseId string (required) The AdSense client identifier for ads.
minimumContentWordLength positive integer (default: no minimum length) Ads are only included in items that are at least this long.
frequency positive integer (default: every item) An ad is displayed in every xth post.
oldItems boolean (default: false) If set to true, then ads will be inserted in old items, causing most feed readers to mark items previously read as unread.
channelCode string (default: none) AdSense channel id

Sample

    <service class="AdSense">
        <param name="adSenseId">pub-188595883748923334</param>
        <param name="frequency">2</param>
        <param name="oldItems">true</param>

    </service>

Back to top

Service Class: LinkSplicer

Adds a new item to your FeedBurner feed that contains new links you have added to your link collection account. How often link items are added to your feed depends on the frequency parameter.

Parameters

Name Value Description
service delicious, furl, bloglines, myweb2, digg (required) The link service to use.
id string (required) User id or account name that is used at the selected service.
frequency daily (default), none If "daily", then generate at most one item per day. If "none", then splice one item per link.

Sample

    <service class="LinkSplicer">
        <param name="service">delicious</param>
        <param name="id">stinky</param>

        <param name="frequency">daily</param>
    </service>

Back to top

Photo Splicer

Service Class: PhotoSplicer

Combines photos posted to Flickr or Buzznet accounts with your original feed items.

This service is not yet supported.

Parameters

Name Value Description
service flickr, buzznet, webshots (required) The photo service to use.
id string (required) User id or account name that is used at the selected service.
tag string If provided, filter the item with the given tag or category

Sample

    <service class="PhotoSplicer">

        <param name="service">buzznet</param>
        <param name="id">ignatious</param>
    </service>

Back to top

SmartCast

Service Class: SmartCast

Enables any feed for podcasting

Parameters

Name Value Description
generateRssMedia boolean (default: false) Include Media RSS elements
submitToYahoo boolean (default: false) If "true", then submit the feed to Yahoo directory on first access
adult boolean (default: false) If "true", the this feed may contain mature content
enclosureType all (default), image, audio, video Enclosures should be generated for these kinds of files.
generateITunesPodcast boolean (default: false) Include iTunes podcast elements
category string Category for this podcast. This value should be one of the approved values as specified in Apple's iTunes namespace specification.It is only appropriate if generateITunesPodcast is true.
subcategory string Subcategory for this podcast.This value should be one of the approved values as specified in Apple's iTunes namespace specification.It is only appropriate if category is set.
summary string A short summary to describe this podcast. It is only appropriate if generateITunesPodcast is true.
imageUrl string A URL for an image to be associated with this podcast. It is only appropriate if generateITunesPodcast is true.
author string An author to be associated with this podcast. It is only appropriate if generateITunesPodcast is true.
copyright string Insert a copyright notice in the feed.

Sample

    <service class="SmartCast">
        <param name="generateRssMedia">true</param>
    </service>

Back to top

Creative Commons License

Service Class: CreativeCommons

Apply a Creative Commons license to original work in your feed

Parameters

Name Value Description
commercial yes, no (required) Are commercial rights associated with this license?
modifications yes, no, sa (required) What modification rights are associated with this license? "sa" means the "Share-Alike" right.

Sample

    <service class="CreativeCommons">
        <param name="commercial">no</param>
        <param name="modifications">sa</param>
    </service>

Back to top

Feed Image

Service Class: FeedImage

Inserts a promotional feed image tag.

Parameters

Name Value Description
imageUrlText string (required) The URL of the image.
imageTitle string A title to associate with the image.
imageLink string A URL of a destination when clicking on the image

Sample

    <service class="FeedImage">
        <param name="imageUrlText">http://www.burningdoor.com/feedimage.jpg</param>

    </service>

Back to top

Amazon Associates ID

Service Class: Amazon

Inserts provided Amazon Associates ID into existing links to Amazon products within HTML feed content items.

Parameters

Name Value Description
associateId string (required) The Amazon associate id to include in links.

Sample

    <service class="Amazon">
        <param name="associateId">feedburner-20</param>
    </service>

Back to top

Summary

Service Class: Summary

Strips hyperlinks, truncates content, adds teaser message to each feed item

Parameters

Name Value Description
summaryLine string If specified, then add this teaser message to the bottom of every item.
maxSize int (default: 200) If the description if greater than this many characters, it is truncated.

Sample

    <service class="Summary">
        <param name="summaryLine">This is a summary. To see the full item, 
        please click on the link.</param>
        <param name="maxSize">1000</param>
    </service>

Back to top

Convert Format

Service Class: ConvertFormat

Converts original feed to RSS 1.0, 2.0, or Atom format

Parameters

Name Value Description
toFormat rss2.0, rss1.0, atom (required) The format to convert this feed to

Sample

    <service class="ConvertFormat">
        <param name="toFormat">rss2.0</param>

    </service>

Back to top

Password Protector

Service Class: PasswordProtect

Protects your feed with a username and password. It is somewhat limited, as only a single user/password can be associated with the feed.

Parameters

Name Value Description
user string (required) When protecting the feed, this is the user that must be entered
password string (required) This is the password that protects the feed
realm string The protection realm to associate with this feed

Sample

    <service class="PasswordProtect">

        <param name="user">jwebber</param>
        <param name="password">d3p0t</param>
    </service>

Back to top

Content-Type

Service Class: ContentType

Changes feed XML content-type attribute

Parameters

Name Value Description
contentType string (required) The content type to send back for this feed.

Sample

    <service class="ContentType">
        <param name="contentType">application/rss+xml</param>
    </service>

Back to top

Title Modifier

Service Class: TitleModifier

Changes the feed's title, description, or both.

Parameters

Name Value Description
title string The new title for the feed.
description string The new description for the feed.

Sample

    <service class="TitleModifier">

        <param name="title">My Most Excellent RSS Feed</param>
    </service>

Back to top

PingShot

Service Class: PingShot

Pings a number of services when the feed is detected as modified. The services to ping is not configurable at this time, so only the default services are pinged.

Parameters

There are no parameters for this service. Including this service is sufficient.

Sample

    <service class="PingShot" />

Response Format

When a request is recieved by FeedBurner, there are four possible response paths.

HTTP Error

If the request did not reach an actual function, either because of an authetication failure or because the function does not exist, then an HTTP error will be sent back.

Error Response

If the response actually reached the endpoint but there was a problem, an "error document" will be returned. This document looks like this:

    <?xml version="1.0" encoding="utf-8" ?>
    <rsp stat="fail">
        <err code="5" msg="Feed not found" />

    </rsp>

See Standard Error Responses for a complete list of errors.

Success Response

If the request was successful and there is a response document, it will be wrapped in a "success" document. This document looks like this:

    <?xml version="1.0" encoding="UTF-8"?>
    <rsp stat="ok">
        <feeds>
            <feed id="51" uri="ManMouse" title="Man | Mouse" />
            <feed id="116" uri="noservices" title="No Services" />
        </feeds>

    </rsp>

Empty Response

Some requests will not return any body when successful. In this case, a standard HTTP 204 will be returned.