Responses
Each response contains a list of feeds, at least one for each
url-Parameter. HTTP-Redirects are followed automatically (this is
reflected in the urls field). RSS-Redirects are followed by additionally
including the new feed in the response.
Each feed contains
- title
- the title of the feed
- link
- the feeds website
- description
- a description of the feed, potentially including HTML characters
- subtitle
- a short subtitle of the feed, potentially including HTML characters
- author
- the feed’s author
- language
- the feed’s language
- urls
- the redirect-chain of the URL passed in the url parameter. This can be used
to match the requested URLs to the entries in the response. A permanent
redirect is not included here but given in the new_location field, as
it indicates that the client should update the feed’s location.
- new_location
- the referred to location, if the feed uses a permanent HTTP redirect or
RSS-Redirects. The new
location will also be fetched, parsed and included in the response
- logo
- the URL of the feed’s logo
- logo_data
- the feed’s logo as a data URI, if
inline_logo has been used. To save bandwidth, the logo is not included
if it changed since the date sent in If-Modified-Since
- content_types
- the content types of the feed, either audio, video or image
- hub
- the endpoint URL of the hub
through which the feed is published
- errors
- a dictionary of occured errors, where the key contains an error code and
the value a string representation.
- warnings
- a dictionary of warnings. The key contains an warning code and the value a
string representation.
- http_last_modified
- the Unix timestamp of the last modification of the feed (according to the
HTTP header).
- http_etag
- the HTTP E-Tag of the feed
- license
- The URL of the license under which the podcast is published
- episodes
- the list of episodes
Episodes
Each episode contains
- guid
- an unique endentifier for the episode (provided by the feed in the GUID
property)
- title
- the title of the episode
- short_title
- the non-repetitive part of the episode title. If an episode number is
found, it is also removed and provided separately.
- number
- the episode number which is parsed from the title
- description
- the description of the episode, potentially including HTML characters
- subtitle
- a short subtitle of the episode, potentially including HTML characters
- link
- the website link for the episode
- released
- the Unix timestamp of the episode’s release
- author
- the episode’s author
- duration
- the episode’s duration in seconds
- language
- the episode’s language
- license
- The URL of the license under which the episode is published
- files
- a list of all files linked by the episode. Each files is represented by an
object containing urls, filesize (in Bytes) and mimetype.
Current Error Codes
- fetch-feed
- The feed could not be retrieved. The URL is given in the urls list
Current Warning Codes
- fetch-logo
- The feed’s logo could not be retrieved. Its URL is given in the logo field
- hub-subscription
- An error occured while subscribing to the feed’s hub for instant updates.