Microformats: Web API

AlchemyAPI provides easy-to-use facilities for extracting Microformats-formatted structured data from your publicly-accessible web-based content. These URL processing calls automatically fetch the desired Internet webpage and automatically extract Microformats content.

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: URLGetMicroformatData

Description: The URLGetMicroformatData call is utilized to extract structured microformats data from a given web page. AlchemyAPI will retrieve the requested URL, process the retrieved HTML document, and look for a variety of Microformats data structures (hCards, geo, adr, etc.).

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

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>
    <microformats>
        <microformat>
            <fieldName>MICROFORMAT_FIELD_NAME</fieldName>
            <fieldData>MICROFORMAT_FIELD_DATA</fieldData>
        </microformat>
        <microformat>
            <fieldName>MICROFORMAT_FIELD_NAME</fieldName>
            <fieldData>MICROFORMAT_FIELD_DATA</fieldData>
        </microformat>
    </microformats>
</results>

Response Format (JSON):

{
    "status": "REQUEST_STATUS",
    "url": "REQUESTED_URL",
    "microformats": [
        "microformat": {
            "fieldName": "MICROFORMAT_FIELD_NAME",
            "fieldData": "MICROFORMAT_FIELD_DATA"
        },
        "microformat": {
            "fieldName": "MICROFORMAT_FIELD_NAME",
            "fieldData": "MICROFORMAT_FIELD_DATA"
        }
    ]
}

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>
    </rdf:Description>
    <rdf:Description rdf:ID="DOCUMENT_HASH-m_MICROFORMAT_NUM">
        <rdf:type rdf:resource="http://rdf.alchemyapi.com/rdf/v1/s/aapi-schema#MicroformatOccurrence"/>
        <aapi:Doc>DOCUMENT_HASH</aapi:Doc>
        <aapi:MicroformatName>MICROFORMAT_FIELD_NAME</aapi:MicroformatName>
        <aapi:MicroformatData>MICROFORMAT_FIELD_DATA</aapi:MicroformatData>
    </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.
microformat	structured microformats data (hCard, etc.) extracted from this web page.
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 URLGetMicroformatData 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 the processed HTML document does not contain any Microformats data structures, an empty result-set will be returned.

- return to top of page -