Explore - lingr - Google Code

Updated May 05, 2008 by kenn.ejima

Explore

explore.getHotRooms

Gets a list of the current hot rooms. Do not poll this method more than once per minute.

HTTP Method:

GET

URL:

http://www.lingr.com/api/explore/get_hot_rooms

Parameters:

api_key `*`	Your API key
count	How many hot rooms to get. The default value is 10. The maximum value is 100.

(*) Required

Example Response:

<?xml version='1.0' encoding='UTF-8'?>
<response>
  <status>ok</status>
  <rooms>
    <room>
      <id>gcnZ3vAcZDA</id>
      <name>My awesome room</name>
      <description>A really GREAT room</description>
      <url>http://www.lingr.com/room/myawesomeroom</url>
      <icon_url>http://images.lingr.com/room/gcnZ3vAcZDA/16x16.gif</icon_url>
      <counter>356</counter>
      <max_user_message_id>346</max_user_message_id>
      <tags>
        <tag>
          <name>sanfrancisco</name>
          <display_name>San Francisco</display_name>
          <url>http://www.lingr.com/tag/sanfrancisco</url>
        </tag>
      </tags>
    </room>
  </rooms>
</response>

A successful response contains the following data items: room

explore.getNewRooms

Gets a list of the newest rooms. Do not poll this method more than once per minute.

HTTP Method:

GET

URL:

http://www.lingr.com/api/explore/get_new_rooms

Parameters:

api_key `*`	Your API key
count	How many new rooms to get. The default value is 10. The maximum value is 100.

(*) Required

Example Response:

<?xml version='1.0' encoding='UTF-8'?>
<response>
  <status>ok</status>
  <rooms>
    <room>
      <id>gcnZ3vAcZDA</id>
      <name>My awesome room</name>
      <description>A really GREAT room</description>
      <url>http://www.lingr.com/room/myawesomeroom</url>
      <icon_url>http://images.lingr.com/room/gcnZ3vAcZDA/16x16.gif</icon_url>
      <counter>356</counter>
      <max_user_message_id>346</max_user_message_id>
      <tags>
        <tag>
          <name>sanfrancisco</name>
          <display_name>San Francisco</display_name>
          <url>http://www.lingr.com/tag/sanfrancisco</url>
        </tag>
      </tags>
    </room>
  </rooms>
</response>

A successful response contains the following data items: room

explore.getHotTags

Gets a list of the current hot tags. Do not poll this method more than once per minute.

HTTP Method:

GET

URL:

http://www.lingr.com/api/explore/get_hot_tags

Parameters:

api_key `*`	Your API key
count	How many hot tags to get. The default value is 10. The maximum value is 500.

(*) Required

Example Response:

<?xml version='1.0' encoding='UTF-8'?>
<response>
  <status>ok</status>
  <tags>
    <tag>
      <name>sanfrancisco</name>
      <display_name>San Francisco</display_name>
      <url>http://www.lingr.com/tag/sanfrancisco</url>
      <rank>4</rank>
    </tag>
    <tag>
      <name>food</name>
      <display_name>Food</display_name>
      <url>http://www.lingr.com/tag/food</url>
      <rank>7</rank>
    </tag>
  </tags>
</response>

A successful response contains the following data items: tag

explore.getAllTags

Gets a list of all tags. Do not poll this method more than once per minute.

HTTP Method:

GET

URL:

http://www.lingr.com/api/explore/get_all_tags

Parameters:

api_key `*`	Your API key
count	How many tags to get. The default value is 10. The maximum value is 500.

(*) Required

Example Response:

<?xml version='1.0' encoding='UTF-8'?>
<response>
  <status>ok</status>
  <tags>
    <tag>
      <name>sanfrancisco</name>
      <display_name>San Francisco</display_name>
      <url>http://www.lingr.com/tag/sanfrancisco</url>
      <rank>4</rank>
    </tag>
    <tag>
      <name>food</name>
      <display_name>Food</display_name>
      <url>http://www.lingr.com/tag/food</url>
      <rank>7</rank>
    </tag>
  </tags>
</response>

A successful response contains the following data items: tag

explore.search

Gets a list of the rooms matching the given search terms. For a room to appear in the results, it must match all of the search terms provided, in either the room name, room description, or room tags. Do not poll this method more than once per minute.

HTTP Method:

GET

URL:

http://www.lingr.com/api/explore/search

Parameters:

api_key `*`	Your API key
q	A comma-separated list of search terms

(*) Required

Example Response:

<?xml version='1.0' encoding='UTF-8'?>
<response>
  <status>ok</status>
  <rooms>
    <room>
      <id>gcnZ3vAcZDA</id>
      <name>My awesome room</name>
      <description>A really GREAT room</description>
      <url>http://www.lingr.com/room/myawesomeroom</url>
      <icon_url>http://images.lingr.com/room/gcnZ3vAcZDA/16x16.gif</icon_url>
      <counter>356</counter>
      <max_user_message_id>346</max_user_message_id>
      <tags>
        <tag>
          <name>sanfrancisco</name>
          <display_name>San Francisco</display_name>
          <url>http://www.lingr.com/tag/sanfrancisco</url>
        </tag>
      </tags>
    </room>
  </rooms>
</response>

A successful response contains the following data items: room

explore.searchTags

Gets a list of the rooms that have tags that match the given search terms. For a room to appear in the results, it must have tags that match all of the search terms provided. Do not poll this method more than once per minute.

HTTP Method:

GET

URL:

http://www.lingr.com/api/explore/search_tags

Parameters:

api_key `*`	Your API key
q	A comma-separated list of search terms

(*) Required

Example Response:

<?xml version='1.0' encoding='UTF-8'?>
<response>
  <status>ok</status>
  <rooms>
    <room>
      <id>gcnZ3vAcZDA</id>
      <name>My awesome room</name>
      <description>A really GREAT room</description>
      <url>http://www.lingr.com/room/myawesomeroom</url>
      <icon_url>http://images.lingr.com/room/gcnZ3vAcZDA/16x16.gif</icon_url>
      <counter>356</counter>
      <max_user_message_id>346</max_user_message_id>
      <tags>
        <tag>
          <name>sanfrancisco</name>
          <display_name>San Francisco</display_name>
          <url>http://www.lingr.com/tag/sanfrancisco</url>
        </tag>
      </tags>
    </room>
  </rooms>
</response>

A successful response contains the following data items: room

explore.searchArchives

Gets a list of the messages from the archives that match the given search term. Do not poll this method more than once per minute.

HTTP Method:

GET

URL:

http://www.lingr.com/api/explore/search_archives

Parameters:

api_key `*`	Your API key
q `*`	The search term
count	How many matching messages to return. The default value is 10. The maximum value is 100.
id	If provided, only the archives for the indicated room are searched. If omitted, archives for all public rooms are searched.
password	If the id parameter is provided, this parameter is used to provide the password for the indicated room, if one is required.

(*) Required

Example Response:

<?xml version='1.0' encoding='UTF-8'?>
<response>
  <status>ok</status>
  <grand_total>19</grand_total>
  <messages>
    <message>
      <timestamp>2007-04-11T00:37:46+09:00</timestamp>
      <source>browser</source>
      <occupant_id>lpclUdtyRzE</occupant_id>
      <nickname>camino</nickname>
      <type>user</type>
      <score>1.0</score>
      <icon_url>/images/root/user/0/48x48.gif</icon_url>
      <client_type>human</client_type>
      <text>foo</text>
      <room_id>987dU6R4VB</room_id>
      <id>97</id>
    </message>
    <message>
      <timestamp>2007-04-17T05:59:01+09:00</timestamp>
      <source>browser</source>
      <occupant_id>3jco2p4bgiE</occupant_id>
      <nickname>ff</nickname>
      <type>user</type>
      <score>0.375</score>
      <icon_url>/images/root/user/0/48x48.gif</icon_url>
      <client_type>human</client_type>
      <text>food tastes great</text>
      <room_id>9F3diFgb65A</room_id>
      <id>228</id>
    </message>
</response>

A successful response contains the following data items: message

grand_total is the total number of matching messages found, irrespective of the count parameter.