Using the OPMLSearch REST Interface

OPMLSearch.com has a REST API interface. It allows you to publish your OPML content here at OPMLSearch.com. When you publish your OPML here you can allow our search engine to automatically detect updates to your OPML and make new content available at OPMLSearch.com.

The REST API protocol

The request to the API should be based on performing an HTTP GET to the following url:

URL: http://www.opmlsearch.com/rest_api.ashx

Each API call requires a particular group of parameters, described in detail below.
Every API call requires two mandatory parameters: "op" and "url", where "op" describes the operation to be performed, and "url" identifies the location of the opml file to be processed.

Available operations

The operations exposed by the API are as follows:

add -- Add a new URL to our database.
checkURL -- Determine whether a given URL is in our database.
disablePolling -- Leave the OPML content from the URL in our database but do not attempt to update it.
fetchNow -- Immediate re-poll the URL and update our database.
setPollingFrequency -- Indicate how often you would like our engine to poll the URL for udpates.
update -- Change any of the settings you specfied when adding a URL to our database.

Result format

The response from the call is an XML document describing the operation result.
The XML has the following format:
<?xml version="1.0" encoding="utf-8"?>
<response status="StatusString ">
       <message>OperationMessage </message>
</response>

StatusString  is the value "ok" or "error", depending on whether the operation completed successfully.
OperationMessage  is a message pertinent to the operation requested and result status.

Operation details