Parameters to /parse (either GET or POST as application/x-www-form-urlencoded)
- The URL of the feed that should be parsed (required). This parameter can be repeated multiple times. The values can be URL-encoded.
- If set to 1, the (unscaled) logos are included in the response as data URIs (default 0).
- If inline_logo is set to 1, scales the included logo down to the given size. The resulting image is fitted into a square with the given side-length. If the given size is greater than the original size, the image won’t be scaled at all.
- If inline_logo is set to 1, the inlined image is converted to the specified format (either png or jpeg). If this option is not used, the original format is preserved.
- Is used to remove HTML from texts. Can be either none (does nothing, default if omitted), strip_html (removes HTML and inserts newlines, bullet points, etc) or markdown (converts HTML to Markdown).
- Feeds are cached by the service according to the feed’s caching headers. If use_cache is set to 1 (default) feeds are retrieved from the cache if possible. If set to 0, feeds are always fetched from their URL. Do not use 0 as a default value in your application.
Headers to /parse¶
- Time when all requested feeds have been accessed the last time. The response will only contain podcasts that have been modified in the meantime.
- Clients should send a descriptive User-Agent string. In case of abuse of the service, misbehaving and/or generic user-agents might be blocked.
- Clients should send Accept: application/json to indicate that they are prepared to receive JSON data. If you send a different Accept header, you will receive a HTML formatted response.
- Include gzip in both headers to ensure gzip compression.
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
- the title of the feed
- the feeds website
- a description of the feed, potentially including HTML characters
- a short subtitle of the feed, potentially including HTML characters
- the feed’s author
- the feed’s language
- 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.
- 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
- the URL of the feed’s logo
- 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
- the content types of the feed, either audio, video or image
- the endpoint URL of the hub through which the feed is published
- a dictionary of occured errors, where the key contains an error code and the value a string representation.
- a dictionary of warnings. The key contains an warning code and the value a string representation.
- the Unix timestamp of the last modification of the feed (according to the HTTP header).
- the HTTP E-Tag of the feed
- The URL of the license under which the podcast is published
- the list of episodes
Each episode contains
- an unique endentifier for the episode (provided by the feed in the GUID property)
- the title of the episode
- the non-repetitive part of the episode title. If an episode number is found, it is also removed and provided separately.
- the episode number which is parsed from the title
- the description of the episode, potentially including HTML characters
- a short subtitle of the episode, potentially including HTML characters
- the website link for the episode
- the Unix timestamp of the episode’s release
- the episode’s author
- the episode’s duration in seconds
- the episode’s language
- The URL of the license under which the episode is published
- 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¶
- The feed could not be retrieved. The URL is given in the urls list
Current Warning Codes¶
- The feed’s logo could not be retrieved. Its URL is given in the logo field
- An error occured while subscribing to the feed’s hub for instant updates.
- The earliest of the Last-Modified values of the requested podcast feeds. This value can be used in the If-Modified-Since parameter to subsequent requests. This header is not sent for the HTML formatted response.
- application/json if your request contains Accept: application/json, otherwise the response will contain the HTML representation with text/html.
- gzip if the response is compressed. See Accept-Encoding for details.
- Contains the request headers for which the response can vary. Currently this is Accept, User-Agent, Accept-Encoding.