RSS / ATOM: Web API

AlchemyAPI provides easy-to-use facilities for extracting links to RSS / ATOM feeds embedded in any publicly-accessible web content. These URL processing calls automatically fetch the desired Internet webpage, extracting any RSS / ATOM feed links embedded within.

These API calls may be utilized to process hosted webpages, blogs, and other publicly-accessible Internet content. If you are processing content that is not hosted on a public webserver, use our HTML API calls instead.

API Call: URLGetFeedLinks

Description: The URLGetFeedLinks call is utilized to extract any links to RSS / ATOM feeds contained within the specified web page. AlchemyAPI will download the requested URL, process the retrieved HTML document, looking for RSS / ATOM feed links.

Endpoint: http://access.alchemyapi.com/calls/url/URLGetFeedLinks

Parameters:

http argument parameter description
url http url (must be uri-argument encoded)

(required parameter)
apikey your private api key

(required parameter)
outputMode desired API output format

Possible values:
xml (default)
json
rdf

(optional parameter)
jsonp desired JSONP callback

(optional parameter, requires "outputMode" to be set to json)

Response Format (XML):

<results>
    <status>REQUEST_STATUS</status>
    <url>REQUESTED_URL</url>
    <feeds>
        <feed>DETECTED_FEED_LINK</feed>
        <feed>DETECTED_FEED_LINK</feed>
    </feeds>
</results>

Response Format (JSON):

{
    "status": "REQUEST_STATUS",
    "url": "REQUESTED_URL",
    "feeds": [
        "feed": "DETECTED_FEED_LINK",
        "feed": "DETECTED_FEED_LINK"
    ]
}

Response Format (RDF):

<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
                 xmlns:aapi="http://rdf.alchemyapi.com/rdf/v1/s/aapi-schema#"
                 xml:base="http://rdf.alchemyapi.com/rdf/v1/r/response.rdf">
    <rdf:Description rdf:ID="DOCUMENT_HASH">
        <rdf:type rdf:resource="http://rdf.alchemyapi.com/rdf/v1/s/aapi-schema#DocInfo"/>
        <aapi:ResultStatus>REQUEST_STATUS</aapi:ResultStatus>
        <aapi:URL>DOCUMENT_URL</aapi:URL>
        <aapi:FeedURL>DETECTED_FEED_LINK</aapi:FeedURL>
        <aapi:FeedURL>DETECTED_FEED_LINK</aapi:FeedURL>
    </rdf:Description>
</rdf:RDF>

Response Fields:

field name field description
status success / failure status indicating whether the request was processed.

Possible values:
OK
ERROR
url http url information was requested for.
feed the extracted RSS/ATOM feed link.
statusInfo failure status information (sent only if "status" == "ERROR").

Possible values:
invalid-api-key
cannot-retrieve
page-is-not-html

Example Calls:

XML: http://access.alchemyapi.com/calls/...
RDF: http://access.alchemyapi.com/calls/...

API Notes:

  • 1. Calls to URLGetFeedLinks can be made using HTTP GET or POST.
  • 2. HTTP POST calls should include the Content-Type header: application/x-www-form-urlencoded
  • 3. URL retrieval is attempted for a maximum of 10 seconds. Requests taking longer than this will result in a "cannot-retrieve" error response.
  • 4. Requested HTML documents can be a maximum of 600 kilobytes. Larger documents will result in a "content-exceeds-size-limit" error response.
  • 5. If no RSS / ATOM feed links are found within the processed HTML document, an empty result-set will be returned.


 - return to top of page -