Skip to main content

XML Response Format

Below is an explanation of the format and tags contained in our XML response.

<?xml version="1.0" encoding="utf-8" ?>
// Output is wrapped in a single response.
	<response>
	// Request status, OK or ERROR AND MESSAGE.
	// For Example, if your daily limit is reached, ERROR: Daily Limit Reached.
	<status>OK</status>
	// Start of general details related to the search query.
		<head>
		// Full search query string.
		<query><![CDATA[mojeek]]></query>
		// Number of words in query which also relates to the number of word tags that follow.
		<nword>1</nword>
		// Start of details on each word in the query.
		<word>
			// Original and stemmed version of word used in the search.
			<full>mojeek</full>
			<stem>mojeek</stem>
			// Set to 1 if word was used, 0 if minus or stop word.
			<plus>1</plus>
			// Exact amount of documents indexed for this word.
			<hits>4840</hits>
		// End of word.
		</word>
		// Repeated for all words.
		<word>
		....
		</word>
		....
		// Time in seconds search took to complete.
		<timer>0.01</timer>
		// First result equals start + 1, ie. 1st result equals 0, 11th result equals 10.
		<start>0</start>
		// Number of results returned.
		<return>10</return>
		// 1 if results count is exact or 0 if about.
		<exact>1</exact>
		// Total result count.
		<results>4840</results>
		// Ranking method used.
		<rankm>0</rankm>
		// True if duplicate listings have been removed.
		<dups>0</dups>
		// The number of documents that will not be returned in the results due to site clustering.
		// This restricts results by domain when performing a site search, or when filtering by categories (OrgSearch users only).
		<more|excluded>438</more|excluded>
	// End of single head tag.
	</head>
	// Start of cats_ref tag if popular categories to refine this search by were found
	<cats_ref>
		// Start of cat tag
		<cat>
			<name>category1</name>
			// Category name.
			<count>100</count>
			// Number of times this category appeared in the top 1000 results.
		// End of cat tag
		</cat>
		// Repeated for all cats_refs.
		<cat>
		...
		</cat>
		...
	// End of cats_ref tag
	</cats_ref>
	// Start of cats_other tag if other popular categories were found
	<cats_other>
		// Start of cat tag
		<cat>
			<name>category1</name>
			// Category name.
			<count>100</count>
			// Number of times this category appeared in all results.
		// End of cat tag
		</cat>
		// Repeated for all cats_others.
		<cat>
		...
		</cat>
		...
	// End of cats_other tag
	</cats_other>
	// Start of facet_dates tag if faceted search performed (OrgSearch users only)
	<facet_dates>
		// Start of facet
		<facet>
			<date>2020-07-01T00:00:00Z</date>
			// date(UTC).
			<count>100</count>
		// End of facet
		</facet>
		// Repeated for all facet_dates.
		<facet>
		...
		</facet>
		...
	// End of facet_dates tag
	</facet_dates>
	// Start of individual result.
	<result>
		// Document URL.
		<url><![CDATA[http://www.mojeek.com/]]></url>
		// Document title.
		<title><![CDATA[Mojeek]]></title>
		// Document description.
		<desc><![CDATA[your own topical or personal search engine. About Mojeek | Add Search To Your Site | Mojeek Copyright © 2007 Mojeek. All rights reserved.]]></desc>
		// Document size.
		<size>1kb</size>
		// Date last modified timestamp.
		<timestamp>1184044740</timestamp>
		// Date last modified formatted.
		<date>Tue Jul 10 05:19:00 2007</date>
		// Date published timestamp.
		<pdate>1184044740</pdate>
		// Date last crawled timestamp.
		<cdatetimestamp>1184044740</cdatetimestamp>
		// Date last crawled.
		<cdate>Tue Jul 10 05:19:00 2007</cdate>
		// If set to 1 more results are available from this domain but have been
		// excluded due to domain clustering.
		<mres>1</mres>
		// Pipe-separated list of categories that the result is tagged with.
		// Note: only appears for OrgSearch users.
		<cats>cat1|cat2|cat3</cats>
		// Start of image tag.
		<image>
			<url>https://example.com</url>
			<width>100</width>
			// Width in pixels.
			<height>100</height>
			// Height in pixels.
		</image>
	// End of result.
	</result>
	// Repeated for all results.
	<result>
	...
	</result>
	...
// End response.
</response>