repos/twython
1
Fork 0
Code Issues 23 Pull requests 4 Projects Releases 5 Packages Wiki Activity Actions

Migrated from search-api v3

ryanmcgrath 2010-09-13 02:21:34 -07:00
parent 29aa89184e
commit e5874cde71
1 changed files with 13 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

15
Search-API.textile

@ -3,8 +3,19 @@ h2. searchTwitter()
Returns data about your specified search query. This can be filtered through other optional parameters below.
Parameters:
* <b>search_query:</b> (Required) The search terms you want resdlts back on.
* <b>page:</b> (Optional) The page of resdlts that you want back.
* <b>callback:</b> Optional. Only available for JSON format. If supplied, the response will use the JSONP format with a callback of the given name.
* <b>lang:</b> Optional: Restricts tweets to the given language, given by an ISO 639-1 code.
o Example: http://search.twitter.com/search.atom?lang=en&q=devo
* <b>rpp:</b> Optional. The number of tweets to return per page, up to a max of 100.
o Example: http://search.twitter.com/search.atom?q=devo&rpp=15
* <b>page:</b> Optional. The page number (starting at 1) to return, up to a max of roughly 1500 results (based on rpp * page. Note: there are pagination limits.
* <b>since_id: Optional. Returns tweets with status ids greater than the given id.
* <b>geocode: Optional. Returns tweets by users located within a given radius of the given latitude/longitude, where the user's location is taken from their Twitter profile. The parameter value is specified by "latitide,longitude,radius", where radius units must be specified as either "mi" (miles) or "km" (kilometers). Note that you cannot use the near operator via the API to geocode arbitrary locations; however you can use this geocode parameter to search near geocodes directly.
* <b>show_user: Optional. When true, prepends "<user>:" to the beginning of the tweet. This is useful for readers that do not display Atom's author field. The default is false.
h3. A note about the above parameters
If you take a moment to read through Twitter's "Search API Docs":http://apiwiki.twitter.com/Twitter-Search-API-Method%3A-search, you'll notice that the above params are pretty much word for word. This is because Tango is built to be flexible with API changes on Twitter's end; with that noted, it's important to be familiar with the Twitter API as a whole. <b>You should really read the Twitter Search API Docs if you choose to use this method.</b>
<pre>
<code>