BOSS API Guide

Optional: This argument filters out results flagged as containing specific kinds of content. Yahoo! currently supports values for filtering out results flagged as containing pornographic and hate-related content. The Filter argument accepts the values -porn to exclude pornographic content and -hate to exclude hate-related content. The syntax of the filter argument is:

filter=[-porn] [-hate]

Either one or both values may be filtered. The Filter argument applies only to documents in the following languages:

If you do not specify hate or porn filtering, the results default to unfiltered content.

In rendering a result set, Yahoo! automatically demotes adult content, so only users actively searching for adult content are likely to see pornographic results. We recommend that you use Filter: -porn only in a restricted search environment intended to reduce the incident of porn results. Turning on filtering may reduce result relevancy. Also, note that, by their nature, the methods used to flag results as -porn or -hate cannot take into account the subjective, widely varied interpretations and categorizations of such content. You are responsible for your use of the results, regardless of their designation.

Capital letter A-Z attributes may appear in search results. These and other attribute categories not mentioned above are experimental and will remain undocumented for now.

Optional: This argument specifies what document types to return. The argument value consists of a comma-separated list specifying the document types or type groups to include. A format group is a logical collection of several document formats for simplification. Format currently supports the following document types:

Format currently supports the following type groups:

You can also specify a format group then exclude an item:

This example searches for the same query term in the nonhtml type group (text, pdf, xl, msword, ppt):

You can combine inclusion, exclusion, document types, and type groups like this:

Example:

http://boss.yahooapis.com/asearch/web/v1/moon?format=xml&count=2&type=msoffice

Optional: The keyterms field can be used with the view argument to retrieve related words and phrases for each search result.

Example:

http://boss.yahooapis.com/ysearch/web/v1/ireland? appid={yourBOSSappid}&format=xml&view=keyterms

Example XML Output keyterms:

<keyterms>
  <terms>
   <term>Ireland</term>
   <term>island</term>
   <term>the Irish</term>
  </terms>
</keyterms>

The primary way in which SearchMonkey acquires structured data is by using the Yahoo! Web Crawler to scour the web for embedded semantic markup such as microformats or RDF. Additional information can be found here:

http://developer.yahoo.com/searchmonkey/smguide/markup.html

http://developer.yahoo.com/searchmonkey/smguide/compare_microformats.html

SearchMonkey acquires structured data marked up with the following open standards:

Microformats

Optional: The searchmonkey_feed and searchmonkey_rdf can be used with the view argument to retrieve associated structured data, if available, for a search result.

	Note
	SearchMonkey data is NOT currently available in BOSS json output.

Example:

http://boss.yahooapis.com/ysearch/web/v1/ireland? appid={yourBOSSappid}&format=xml&view=searchmonkey_feed (dataRSS format)

or

http://boss.yahooapis.com/ysearch/web/v1/ireland? appid={yourBOSSappid}&format=xml&view=searchmonkey_rdf (rdf format)

Example XML Output searchmonkey_feed:

<searchmonkey_feed>
    <feed>
        <adjunct id="com.yahoo.page.uf.adr" updated="2009-02-01T09:07:13Z" version="1.1">
        <item rel="dc:subject">
          <type typeof="vcard:Address">
          <meta property="vcard:locality">Washington D.C. Metro Area</meta>
          </type>
        </item>
        </adjunct>
        <adjunct id="com.yahoo.page.uf.hcalendar" updated="2009-02-01T09:07:13Z" version="1.1">
        <item rel="dc:subject rel:Event">
          <type typeof="vcal:Vevent">
          <meta property="vcal:dtstart" datatype="xsd:dateTime" data_quality="255">2009-01-01</meta>
          <meta property="vcal:summary">United States of America</meta>
          <meta property="vcal:duration" datatype="xsd:duration">P1M</meta>
          </type>
         </item>
...

Example XML Output searchmonkey_rdf:

<searchmonkey_rdf>
<rdf:RDF>
<rdf:Description rdf:about="http://www.linkedin.com/in/barackobama">
    <dc:subject rdf:nodeID="id1554438591"/>
</rdf:Description>
<rdf:Description rdf:nodeID="id1554438591">
<rdf:type rdf:resource="http://www.w3.org/2006/vcard/ns#Address"/>
</rdf:Description>
<rdf:Description rdf:nodeID="id1554438591">
    <vcard:locality>Washington D.C. Metro Area</vcard:locality>
</rdf:Description>
<rdf:Description rdf:about="http://www.linkedin.com/in/barackobama">
    <dc:subject rdf:nodeID="id1554440066"/>
</rdf:Description>
<rdf:Description rdf:about="http://www.linkedin.com/in/barackobama">
    <rel:Event rdf:nodeID="id1554440066"/>
</rdf:Description>
<rdf:Description rdf:nodeID="id1554440066">
<rdf:type rdf:resource="http://www.w3.org/2002/12/cal#Vevent"/>
</rdf:Description>
<rdf:Description rdf:nodeID="id1554440066">
    <vcal:dtstart rdf:datatype="http://www.w3.org/2001/XMLSchema#dateTime">2009-01-01</vcal:dtstart>
</rdf:Description>
<rdf:Description rdf:nodeID="id1554440066">
    <vcal:summary>United States of America</vcal:summary>
</rdf:Description>
...

Optional: Using abstract=long increases the abstract up to 300 characters and allows BOSS developers to have access to more keywords from the result document. This information may be useful to many for keyword analysis and presentation.

abstract=long

Example:

http://boss.yahooapis.com/ysearch/web/v1/Car%20racing? appid={yourBOSSappid}&format=xml&abstract=long

Example XML Output abstract (default):

   <abstract>
      Official site from the National Association for Stock <b>Car</b> Auto <b>Racing</b>. <b>...</b> Still more to learn about 
      new <b>car</b> after first full year <b>...</b>
   </abstract>

Example XML Output abstract (long):

   <abstract>
      Official site from the National Association for Stock <b>Car</b> Auto <b>Racing</b>. <b>...</b> Still more to learn about 
      new <b>car</b> after first full year. Ragan among Cup drivers honored with "Loopie" award. Keselowski heads list of 2008 
      most popular drivers <b>...</b>
   </abstract>