RSS / ATOM: HTML API

AlchemyAPI provides easy-to-use facilities for extracting links to RSS / ATOM feeds embedded in any web page: Post (upload) any content directly to our service for analysis.

Posted content is processed to automatically extract any associated RSS / ATOM feeds.

These API calls may be utilized to process posted (uploaded) webpages and other HTML content. If you are processing content hosted on a publicly accessible website, consider using our URL processing calls instead.

API Call: HTMLGetFeedLinks

Description: The HTMLGetFeedLinks call is utilized to extract any links to RSS / ATOM feeds contained within the posted web page. AlchemyAPI will process the posted HTML document, looking for RSS / ATOM feed links.

Endpoint: http://access.alchemyapi.com/calls/html/HTMLGetFeedLinks

Parameters:

http argument	parameter description
apikey	your private api key (required parameter)
html	HTML document content (must be uri-argument encoded) (required parameter)
url	HTML document URL (must be uri-argument encoded) (optional parameter, for response tracking purposes.)
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>DOCUMENT_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 page-is-not-html

API Notes:

1. Calls to HTMLGetFeedLinks should be made using HTTP POST.
2. HTTP POST calls should include the Content-Type header: application/x-www-form-urlencoded
3. Posted HTML documents can be a maximum of 600 kilobytes. Larger documents will result in a "content-exceeds-size-limit" error response.
4. 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 -