Developer API

Webaroo Search Radar Web Services API

The Search Radar Web Service API is intended for developers who wish to build innovative tools and widgets by leveraging the power of Search Radar to suggest related topics and terms for any query. The service provides output in XML and JSON formats.

Terms of use

By using the Search Radar Web Service you are implicitly agreeing to our Terms of Service and our Privacy Policy.

Generate Application ID

Every request to the Search Radar service should contain the application id parameter. To get your Application ID, fill the following form.

Request URL and Parameters

http://searchradar.webaroo.com/SearchRadarService

Parameter	Value	Description
appid	string (required)	The application id
query	string (required)	The query term
output	string: xml(default), json	The output format
callback	string	The function name to wrap around the JSON data. The parameter is ignored if output=json is not selected
excerpt	string: off(default), on	To get results with excerpts that show the relatonship between the suggested term and the original query, select excerpt=on

XML Response format

The schema for the XML response is at http://searchradar.webaroo.com/SearchRadarService.xsd

Element	Description
relatedtermset	Contains all the related terms
searchradarurl	The results page for your query on searchradar.webaroo.com that you can link back to
rt	A related term tuple
t	The related term
e	The excerpt (absent if excerpt=off)
s	The source url of the excerpt (absent if excerpt=off)

Sample response

For http://searchradar.webaroo.com/SearchRadarService?query=Pink+Floyd&output=xml&excerpt=on&appid=yourappid

  
<?xml version="1.0" encoding="utf-8" ?>

<relatedtermset xsi:schemaLocation="http://searchradar.webaroo.com/SearchRadarService.xsd">	
	<searchradarurl><![CDATA[http://searchradar.webaroo.com/s?searchQuery=pink+floyd]]</searchradarurl>
	<rt>
		<t><![CDATA[Syd Barrett]]></t>
		<e><![CDATA[The hard rock band Pink Floyd was formed by lead guitarist Syd Barrett,
		 bassist Roger Waters, keyboarder Richard Wright and drummer Nick Mason.]]></e>
		<s><![CDATA[http://www.thecelebrityportal.com/group/famous/P/Pink_Floyd.html]]></s>
	</rt>
	<rt>
		<t><![CDATA[Pink Floyd the Wall]]></t>		
		<e><![CDATA[Pink Floyd The Wall is a 1982 film by British director Alan Parker based on the 1979 Pink Floyd album The Wall.]]></e>
		<s><![CDATA[http://en.wikipedia.org/wiki/Pink_Floyd_The_Wall_(film)]]></s>
	</rt>
</relatedtermset>

JSON Response format

All responses are utf-8 encoded.

Element	Description
relatedtermset	Contains all the related terms
numresults	Number of related terms returned
searchradarurl	The searchradar.webaroo.com results page for query that you can link back to
results	All the related terms tuple
t	The related term
e	The excerpt (absent if excerpt=off)
s	The source url of the excerpt (absent if excerpt=off)

Sample response

For http://searchradar.webaroo.com/SearchRadarService?query=Pink+Floyd&output=json&callback=function_ws&excerpt=on&appid=yourappid

  
function_ws(
{
	"relatedtermset":
	{
		  "numresults":2,
		  "searchradarurl": "http://searchradar.webaroo.com/s?searchQuery=pink+floyd",
		  "result":
		  [
			    {
				      "t":"Syd Barrett",
				      "e":"The hard rock band Pink Floyd was formed by lead guitarist Syd Barrett, bassist Roger Waters, keyboarder Richard Wright and drummer Nick Mason.",
				      "s":"http://www.thecelebrityportal.com/group/famous/P/Pink_Floyd.html"
			    },
			    {
				      "t":"Pink Floyd the Wall",
				      "e":"Pink Floyd The Wall is a 1982 film by British director Alan Parker based on the 1979 Pink Floyd album The Wall.",
				      "s":"http://en.wikipedia.org/wiki/Pink_Floyd_The_Wall_(film)"
			    }
		  ]
	}
}
)

Rate and Result Limit

The Search Radar Web Service has a daily limit of 1000 requests per IP - application id combination. We also send a maximum of 50 suggested terms for a particular query. If your application requires a higher throughput or you need more than 50 suggested terms per query, drop a mail to support@webaroo.com or use the feedback form.

Error Codes

Output format not supported
No callback function provided
Invalid query
Rate limit exceeded

Sample Error Response

XML:

  
<?xml version="1.0" encoding="utf-8" ?>
<error xsi:schemaLocation="http://searchradar.webaroo.com/error.xsd">
<mesage>error message</message>
</error>

JSON:

  
function_ws(
{
	"relatedtermset":
	{
		  "message":"error message",
		  "numresults":0,
		  "result":
		  [
		  ]
	}
}
)

Feedback and Support

Please mail support@webaroo.com or use the feedback form for any queries regarding the service. We would like to hear from you about how you are using the Search Radar Web Service. The most innovative ones will also be featured on this page.


Name^*	:
Email^*	:
Website	:
Describe Application	:
		Generate Key