PageRenderTime 73ms CodeModel.GetById 15ms RepoModel.GetById 0ms app.codeStats 1ms

/doc/twitter.html

https://code.google.com/p/python-twitter/
HTML | 2026 lines | 1808 code | 218 blank | 0 comment | 0 complexity | 18efb984b94b1834ef5c0d1b27eb7127 MD5 | raw file
Possible License(s): Apache-2.0

Large files files are truncated, but you can click here to view the full file

  1. <!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
  2. <html><head><title>Python: module twitter</title>
  3. </head><body bgcolor="#f0f0f8">
  4. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
  5. <tr bgcolor="#7799ee">
  6. <td valign=bottom>&nbsp;<br>
  7. <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>twitter</strong></big></big> (version 0.8)</font></td
  8. ><td align=right valign=bottom
  9. ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="twitter.py">twitter.py</a></font></td></tr></table>
  10. <p><tt>A&nbsp;library&nbsp;that&nbsp;provides&nbsp;a&nbsp;Python&nbsp;interface&nbsp;to&nbsp;the&nbsp;Twitter&nbsp;API</tt></p>
  11. <p>
  12. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  13. <tr bgcolor="#aa55cc">
  14. <td colspan=3 valign=bottom>&nbsp;<br>
  15. <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
  16. <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  17. <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="StringIO.html">StringIO</a><br>
  18. <a href="base64.html">base64</a><br>
  19. <a href="calendar.html">calendar</a><br>
  20. <a href="datetime.html">datetime</a><br>
  21. <a href="gzip.html">gzip</a><br>
  22. </td><td width="25%" valign=top><a href="httplib.html">httplib</a><br>
  23. <a href="oauth2.html">oauth2</a><br>
  24. <a href="os.html">os</a><br>
  25. <a href="rfc822.html">rfc822</a><br>
  26. <a href="json.html">json</a><br>
  27. </td><td width="25%" valign=top><a href="sys.html">sys</a><br>
  28. <a href="tempfile.html">tempfile</a><br>
  29. <a href="textwrap.html">textwrap</a><br>
  30. <a href="time.html">time</a><br>
  31. <a href="urllib.html">urllib</a><br>
  32. </td><td width="25%" valign=top><a href="urllib2.html">urllib2</a><br>
  33. <a href="urlparse.html">urlparse</a><br>
  34. </td></tr></table></td></tr></table><p>
  35. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  36. <tr bgcolor="#ee77aa">
  37. <td colspan=3 valign=bottom>&nbsp;<br>
  38. <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
  39. <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  40. <td width="100%"><dl>
  41. <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
  42. </font></dt><dd>
  43. <dl>
  44. <dt><font face="helvetica, arial"><a href="twitter.html#Api">Api</a>
  45. </font></dt><dt><font face="helvetica, arial"><a href="twitter.html#DirectMessage">DirectMessage</a>
  46. </font></dt><dt><font face="helvetica, arial"><a href="twitter.html#Hashtag">Hashtag</a>
  47. </font></dt><dt><font face="helvetica, arial"><a href="twitter.html#List">List</a>
  48. </font></dt><dt><font face="helvetica, arial"><a href="twitter.html#Status">Status</a>
  49. </font></dt><dt><font face="helvetica, arial"><a href="twitter.html#Trend">Trend</a>
  50. </font></dt><dt><font face="helvetica, arial"><a href="twitter.html#Url">Url</a>
  51. </font></dt><dt><font face="helvetica, arial"><a href="twitter.html#User">User</a>
  52. </font></dt></dl>
  53. </dd>
  54. <dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)
  55. </font></dt><dd>
  56. <dl>
  57. <dt><font face="helvetica, arial"><a href="twitter.html#TwitterError">TwitterError</a>
  58. </font></dt></dl>
  59. </dd>
  60. </dl>
  61. <p>
  62. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  63. <tr bgcolor="#ffc8d8">
  64. <td colspan=3 valign=bottom>&nbsp;<br>
  65. <font color="#000000" face="helvetica, arial"><a name="Api">class <strong>Api</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
  66. <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
  67. <td colspan=2><tt>A&nbsp;python&nbsp;interface&nbsp;into&nbsp;the&nbsp;Twitter&nbsp;API<br>
  68. &nbsp;<br>
  69. By&nbsp;default,&nbsp;the&nbsp;<a href="#Api">Api</a>&nbsp;caches&nbsp;results&nbsp;for&nbsp;1&nbsp;minute.<br>
  70. &nbsp;<br>
  71. Example&nbsp;usage:<br>
  72. &nbsp;<br>
  73. &nbsp;&nbsp;To&nbsp;create&nbsp;an&nbsp;instance&nbsp;of&nbsp;the&nbsp;twitter.<a href="#Api">Api</a>&nbsp;class,&nbsp;with&nbsp;no&nbsp;authentication:<br>
  74. &nbsp;<br>
  75. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;import&nbsp;twitter<br>
  76. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api&nbsp;=&nbsp;twitter.<a href="#Api">Api</a>()<br>
  77. &nbsp;<br>
  78. &nbsp;&nbsp;To&nbsp;fetch&nbsp;the&nbsp;most&nbsp;recently&nbsp;posted&nbsp;public&nbsp;twitter&nbsp;status&nbsp;messages:<br>
  79. &nbsp;<br>
  80. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;statuses&nbsp;=&nbsp;api.<a href="#Api-GetPublicTimeline">GetPublicTimeline</a>()<br>
  81. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;print&nbsp;[s.user.name&nbsp;for&nbsp;s&nbsp;in&nbsp;statuses]<br>
  82. &nbsp;&nbsp;&nbsp;&nbsp;[u'DeWitt',&nbsp;u'Kesuke&nbsp;Miyagi',&nbsp;u'ev',&nbsp;u'Buzz&nbsp;Andersen',&nbsp;u'Biz&nbsp;Stone']&nbsp;#...<br>
  83. &nbsp;<br>
  84. &nbsp;&nbsp;To&nbsp;fetch&nbsp;a&nbsp;single&nbsp;user's&nbsp;public&nbsp;status&nbsp;messages,&nbsp;where&nbsp;"user"&nbsp;is&nbsp;either<br>
  85. &nbsp;&nbsp;a&nbsp;Twitter&nbsp;"short&nbsp;name"&nbsp;or&nbsp;their&nbsp;user&nbsp;id.<br>
  86. &nbsp;<br>
  87. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;statuses&nbsp;=&nbsp;api.<a href="#Api-GetUserTimeline">GetUserTimeline</a>(user)<br>
  88. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;print&nbsp;[s.text&nbsp;for&nbsp;s&nbsp;in&nbsp;statuses]<br>
  89. &nbsp;<br>
  90. &nbsp;&nbsp;To&nbsp;use&nbsp;authentication,&nbsp;instantiate&nbsp;the&nbsp;twitter.<a href="#Api">Api</a>&nbsp;class&nbsp;with&nbsp;a<br>
  91. &nbsp;&nbsp;consumer&nbsp;key&nbsp;and&nbsp;secret;&nbsp;and&nbsp;the&nbsp;oAuth&nbsp;key&nbsp;and&nbsp;secret:<br>
  92. &nbsp;<br>
  93. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api&nbsp;=&nbsp;twitter.<a href="#Api">Api</a>(consumer_key='twitter&nbsp;consumer&nbsp;key',<br>
  94. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;consumer_secret='twitter&nbsp;consumer&nbsp;secret',<br>
  95. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;access_token_key='the_key_given',<br>
  96. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;access_token_secret='the_key_secret')<br>
  97. &nbsp;<br>
  98. &nbsp;&nbsp;To&nbsp;fetch&nbsp;your&nbsp;friends&nbsp;(after&nbsp;being&nbsp;authenticated):<br>
  99. &nbsp;<br>
  100. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;users&nbsp;=&nbsp;api.<a href="#Api-GetFriends">GetFriends</a>()<br>
  101. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;print&nbsp;[u.name&nbsp;for&nbsp;u&nbsp;in&nbsp;users]<br>
  102. &nbsp;<br>
  103. &nbsp;&nbsp;To&nbsp;post&nbsp;a&nbsp;twitter&nbsp;status&nbsp;message&nbsp;(after&nbsp;being&nbsp;authenticated):<br>
  104. &nbsp;<br>
  105. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;status&nbsp;=&nbsp;api.<a href="#Api-PostUpdate">PostUpdate</a>('I&nbsp;love&nbsp;python-twitter!')<br>
  106. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;print&nbsp;status.text<br>
  107. &nbsp;&nbsp;&nbsp;&nbsp;I&nbsp;love&nbsp;python-twitter!<br>
  108. &nbsp;<br>
  109. &nbsp;&nbsp;There&nbsp;are&nbsp;many&nbsp;other&nbsp;methods,&nbsp;including:<br>
  110. &nbsp;<br>
  111. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-PostUpdates">PostUpdates</a>(status)<br>
  112. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-PostDirectMessage">PostDirectMessage</a>(user,&nbsp;text)<br>
  113. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-GetUser">GetUser</a>(user)<br>
  114. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-GetReplies">GetReplies</a>()<br>
  115. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-GetUserTimeline">GetUserTimeline</a>(user)<br>
  116. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-GetStatus">GetStatus</a>(id)<br>
  117. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-DestroyStatus">DestroyStatus</a>(id)<br>
  118. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-GetFriendsTimeline">GetFriendsTimeline</a>(user)<br>
  119. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-GetFriends">GetFriends</a>(user)<br>
  120. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-GetFollowers">GetFollowers</a>()<br>
  121. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-GetFeatured">GetFeatured</a>()<br>
  122. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-GetDirectMessages">GetDirectMessages</a>()<br>
  123. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-PostDirectMessage">PostDirectMessage</a>(user,&nbsp;text)<br>
  124. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-DestroyDirectMessage">DestroyDirectMessage</a>(id)<br>
  125. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-DestroyFriendship">DestroyFriendship</a>(user)<br>
  126. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-CreateFriendship">CreateFriendship</a>(user)<br>
  127. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-GetUserByEmail">GetUserByEmail</a>(email)<br>
  128. &nbsp;&nbsp;&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;api.<a href="#Api-VerifyCredentials">VerifyCredentials</a>()<br>&nbsp;</tt></td></tr>
  129. <tr><td>&nbsp;</td>
  130. <td width="100%">Methods defined here:<br>
  131. <dl><dt><a name="Api-ClearCredentials"><strong>ClearCredentials</strong></a>(self)</dt><dd><tt>Clear&nbsp;the&nbsp;any&nbsp;credentials&nbsp;for&nbsp;this&nbsp;instance</tt></dd></dl>
  132. <dl><dt><a name="Api-CreateFavorite"><strong>CreateFavorite</strong></a>(self, status)</dt><dd><tt>Favorites&nbsp;the&nbsp;status&nbsp;specified&nbsp;in&nbsp;the&nbsp;status&nbsp;parameter&nbsp;as&nbsp;the&nbsp;authenticating&nbsp;user.<br>
  133. Returns&nbsp;the&nbsp;favorite&nbsp;status&nbsp;when&nbsp;successful.<br>
  134. &nbsp;<br>
  135. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  136. &nbsp;<br>
  137. Args:<br>
  138. &nbsp;&nbsp;The&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instance&nbsp;to&nbsp;mark&nbsp;as&nbsp;a&nbsp;favorite.<br>
  139. Returns:<br>
  140. &nbsp;&nbsp;A&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instance&nbsp;representing&nbsp;the&nbsp;newly-marked&nbsp;favorite.</tt></dd></dl>
  141. <dl><dt><a name="Api-CreateFriendship"><strong>CreateFriendship</strong></a>(self, user)</dt><dd><tt>Befriends&nbsp;the&nbsp;user&nbsp;specified&nbsp;in&nbsp;the&nbsp;user&nbsp;parameter&nbsp;as&nbsp;the&nbsp;authenticating&nbsp;user.<br>
  142. &nbsp;<br>
  143. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  144. &nbsp;<br>
  145. Args:<br>
  146. &nbsp;&nbsp;The&nbsp;ID&nbsp;or&nbsp;screen&nbsp;name&nbsp;of&nbsp;the&nbsp;user&nbsp;to&nbsp;befriend.<br>
  147. Returns:<br>
  148. &nbsp;&nbsp;A&nbsp;twitter.<a href="#User">User</a>&nbsp;instance&nbsp;representing&nbsp;the&nbsp;befriended&nbsp;user.</tt></dd></dl>
  149. <dl><dt><a name="Api-CreateList"><strong>CreateList</strong></a>(self, user, name, mode<font color="#909090">=None</font>, description<font color="#909090">=None</font>)</dt><dd><tt>Creates&nbsp;a&nbsp;new&nbsp;list&nbsp;with&nbsp;the&nbsp;give&nbsp;name<br>
  150. &nbsp;<br>
  151. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  152. &nbsp;<br>
  153. Args:<br>
  154. &nbsp;&nbsp;user:<br>
  155. &nbsp;&nbsp;&nbsp;&nbsp;Twitter&nbsp;name&nbsp;to&nbsp;create&nbsp;the&nbsp;list&nbsp;for<br>
  156. &nbsp;&nbsp;name:<br>
  157. &nbsp;&nbsp;&nbsp;&nbsp;New&nbsp;name&nbsp;for&nbsp;the&nbsp;list<br>
  158. &nbsp;&nbsp;mode:<br>
  159. &nbsp;&nbsp;&nbsp;&nbsp;'public'&nbsp;or&nbsp;'private'.<br>
  160. &nbsp;&nbsp;&nbsp;&nbsp;Defaults&nbsp;to&nbsp;'public'.&nbsp;[Optional]<br>
  161. &nbsp;&nbsp;description:<br>
  162. &nbsp;&nbsp;&nbsp;&nbsp;Description&nbsp;of&nbsp;the&nbsp;list.&nbsp;[Optional]<br>
  163. &nbsp;<br>
  164. Returns:<br>
  165. &nbsp;&nbsp;A&nbsp;twitter.<a href="#List">List</a>&nbsp;instance&nbsp;representing&nbsp;the&nbsp;new&nbsp;list</tt></dd></dl>
  166. <dl><dt><a name="Api-CreateSubscription"><strong>CreateSubscription</strong></a>(self, owner, list)</dt><dd><tt>Creates&nbsp;a&nbsp;subscription&nbsp;to&nbsp;a&nbsp;list&nbsp;by&nbsp;the&nbsp;authenticated&nbsp;user<br>
  167. &nbsp;<br>
  168. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  169. &nbsp;<br>
  170. Args:<br>
  171. &nbsp;&nbsp;owner:<br>
  172. &nbsp;&nbsp;&nbsp;&nbsp;<a href="#User">User</a>&nbsp;name&nbsp;or&nbsp;id&nbsp;of&nbsp;the&nbsp;owner&nbsp;of&nbsp;the&nbsp;list&nbsp;being&nbsp;subscribed&nbsp;to.<br>
  173. &nbsp;&nbsp;list:<br>
  174. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;slug&nbsp;or&nbsp;list&nbsp;id&nbsp;to&nbsp;subscribe&nbsp;the&nbsp;user&nbsp;to<br>
  175. &nbsp;<br>
  176. Returns:<br>
  177. &nbsp;&nbsp;A&nbsp;twitter.<a href="#List">List</a>&nbsp;instance&nbsp;representing&nbsp;the&nbsp;list&nbsp;subscribed&nbsp;to</tt></dd></dl>
  178. <dl><dt><a name="Api-DestroyDirectMessage"><strong>DestroyDirectMessage</strong></a>(self, id)</dt><dd><tt>Destroys&nbsp;the&nbsp;direct&nbsp;message&nbsp;specified&nbsp;in&nbsp;the&nbsp;required&nbsp;ID&nbsp;parameter.<br>
  179. &nbsp;<br>
  180. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated,&nbsp;and&nbsp;the<br>
  181. authenticating&nbsp;user&nbsp;must&nbsp;be&nbsp;the&nbsp;recipient&nbsp;of&nbsp;the&nbsp;specified&nbsp;direct<br>
  182. message.<br>
  183. &nbsp;<br>
  184. Args:<br>
  185. &nbsp;&nbsp;id:&nbsp;The&nbsp;id&nbsp;of&nbsp;the&nbsp;direct&nbsp;message&nbsp;to&nbsp;be&nbsp;destroyed<br>
  186. &nbsp;<br>
  187. Returns:<br>
  188. &nbsp;&nbsp;A&nbsp;twitter.<a href="#DirectMessage">DirectMessage</a>&nbsp;instance&nbsp;representing&nbsp;the&nbsp;message&nbsp;destroyed</tt></dd></dl>
  189. <dl><dt><a name="Api-DestroyFavorite"><strong>DestroyFavorite</strong></a>(self, status)</dt><dd><tt>Un-favorites&nbsp;the&nbsp;status&nbsp;specified&nbsp;in&nbsp;the&nbsp;ID&nbsp;parameter&nbsp;as&nbsp;the&nbsp;authenticating&nbsp;user.<br>
  190. Returns&nbsp;the&nbsp;un-favorited&nbsp;status&nbsp;in&nbsp;the&nbsp;requested&nbsp;format&nbsp;when&nbsp;successful.<br>
  191. &nbsp;<br>
  192. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  193. &nbsp;<br>
  194. Args:<br>
  195. &nbsp;&nbsp;The&nbsp;twitter.<a href="#Status">Status</a>&nbsp;to&nbsp;unmark&nbsp;as&nbsp;a&nbsp;favorite.<br>
  196. Returns:<br>
  197. &nbsp;&nbsp;A&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instance&nbsp;representing&nbsp;the&nbsp;newly-unmarked&nbsp;favorite.</tt></dd></dl>
  198. <dl><dt><a name="Api-DestroyFriendship"><strong>DestroyFriendship</strong></a>(self, user)</dt><dd><tt>Discontinues&nbsp;friendship&nbsp;with&nbsp;the&nbsp;user&nbsp;specified&nbsp;in&nbsp;the&nbsp;user&nbsp;parameter.<br>
  199. &nbsp;<br>
  200. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  201. &nbsp;<br>
  202. Args:<br>
  203. &nbsp;&nbsp;The&nbsp;ID&nbsp;or&nbsp;screen&nbsp;name&nbsp;of&nbsp;the&nbsp;user&nbsp;&nbsp;with&nbsp;whom&nbsp;to&nbsp;discontinue&nbsp;friendship.<br>
  204. Returns:<br>
  205. &nbsp;&nbsp;A&nbsp;twitter.<a href="#User">User</a>&nbsp;instance&nbsp;representing&nbsp;the&nbsp;discontinued&nbsp;friend.</tt></dd></dl>
  206. <dl><dt><a name="Api-DestroyList"><strong>DestroyList</strong></a>(self, user, id)</dt><dd><tt>Destroys&nbsp;the&nbsp;list&nbsp;from&nbsp;the&nbsp;given&nbsp;user<br>
  207. &nbsp;<br>
  208. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  209. &nbsp;<br>
  210. Args:<br>
  211. &nbsp;&nbsp;user:<br>
  212. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;user&nbsp;to&nbsp;remove&nbsp;the&nbsp;list&nbsp;from.<br>
  213. &nbsp;&nbsp;id:<br>
  214. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;slug&nbsp;or&nbsp;id&nbsp;of&nbsp;the&nbsp;list&nbsp;to&nbsp;remove.<br>
  215. Returns:<br>
  216. &nbsp;&nbsp;A&nbsp;twitter.<a href="#List">List</a>&nbsp;instance&nbsp;representing&nbsp;the&nbsp;removed&nbsp;list.</tt></dd></dl>
  217. <dl><dt><a name="Api-DestroyStatus"><strong>DestroyStatus</strong></a>(self, id)</dt><dd><tt>Destroys&nbsp;the&nbsp;status&nbsp;specified&nbsp;by&nbsp;the&nbsp;required&nbsp;ID&nbsp;parameter.<br>
  218. &nbsp;<br>
  219. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated&nbsp;and&nbsp;the<br>
  220. authenticating&nbsp;user&nbsp;must&nbsp;be&nbsp;the&nbsp;author&nbsp;of&nbsp;the&nbsp;specified&nbsp;status.<br>
  221. &nbsp;<br>
  222. Args:<br>
  223. &nbsp;&nbsp;id:<br>
  224. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;numerical&nbsp;ID&nbsp;of&nbsp;the&nbsp;status&nbsp;you're&nbsp;trying&nbsp;to&nbsp;destroy.<br>
  225. &nbsp;<br>
  226. Returns:<br>
  227. &nbsp;&nbsp;A&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instance&nbsp;representing&nbsp;the&nbsp;destroyed&nbsp;status&nbsp;message</tt></dd></dl>
  228. <dl><dt><a name="Api-DestroySubscription"><strong>DestroySubscription</strong></a>(self, owner, list)</dt><dd><tt>Destroys&nbsp;the&nbsp;subscription&nbsp;to&nbsp;a&nbsp;list&nbsp;for&nbsp;the&nbsp;authenticated&nbsp;user<br>
  229. &nbsp;<br>
  230. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  231. &nbsp;<br>
  232. Args:<br>
  233. &nbsp;&nbsp;owner:<br>
  234. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;user&nbsp;id&nbsp;or&nbsp;screen&nbsp;name&nbsp;of&nbsp;the&nbsp;user&nbsp;that&nbsp;owns&nbsp;the<br>
  235. &nbsp;&nbsp;&nbsp;&nbsp;list&nbsp;that&nbsp;is&nbsp;to&nbsp;be&nbsp;unsubscribed&nbsp;from<br>
  236. &nbsp;&nbsp;list:<br>
  237. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;slug&nbsp;or&nbsp;list&nbsp;id&nbsp;of&nbsp;the&nbsp;list&nbsp;to&nbsp;unsubscribe&nbsp;from<br>
  238. &nbsp;<br>
  239. Returns:<br>
  240. &nbsp;&nbsp;A&nbsp;twitter.<a href="#List">List</a>&nbsp;instance&nbsp;representing&nbsp;the&nbsp;removed&nbsp;list.</tt></dd></dl>
  241. <dl><dt><a name="Api-FilterPublicTimeline"><strong>FilterPublicTimeline</strong></a>(self, term, since_id<font color="#909090">=None</font>)</dt><dd><tt>Filter&nbsp;the&nbsp;public&nbsp;twitter&nbsp;timeline&nbsp;by&nbsp;a&nbsp;given&nbsp;search&nbsp;term&nbsp;on<br>
  242. the&nbsp;local&nbsp;machine.<br>
  243. &nbsp;<br>
  244. Args:<br>
  245. &nbsp;&nbsp;term:<br>
  246. &nbsp;&nbsp;&nbsp;&nbsp;term&nbsp;to&nbsp;search&nbsp;by.<br>
  247. &nbsp;&nbsp;since_id:<br>
  248. &nbsp;&nbsp;&nbsp;&nbsp;Returns&nbsp;results&nbsp;with&nbsp;an&nbsp;ID&nbsp;greater&nbsp;than&nbsp;(that&nbsp;is,&nbsp;more&nbsp;recent<br>
  249. &nbsp;&nbsp;&nbsp;&nbsp;than)&nbsp;the&nbsp;specified&nbsp;ID.&nbsp;There&nbsp;are&nbsp;limits&nbsp;to&nbsp;the&nbsp;number&nbsp;of<br>
  250. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;which&nbsp;can&nbsp;be&nbsp;accessed&nbsp;through&nbsp;the&nbsp;API.&nbsp;If&nbsp;the&nbsp;limit&nbsp;of<br>
  251. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;has&nbsp;occured&nbsp;since&nbsp;the&nbsp;since_id,&nbsp;the&nbsp;since_id&nbsp;will&nbsp;be<br>
  252. &nbsp;&nbsp;&nbsp;&nbsp;forced&nbsp;to&nbsp;the&nbsp;oldest&nbsp;ID&nbsp;available.&nbsp;[Optional]<br>
  253. &nbsp;<br>
  254. Returns:<br>
  255. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;message<br>
  256. &nbsp;&nbsp;containing&nbsp;the&nbsp;term</tt></dd></dl>
  257. <dl><dt><a name="Api-GetDirectMessages"><strong>GetDirectMessages</strong></a>(self, since<font color="#909090">=None</font>, since_id<font color="#909090">=None</font>, page<font color="#909090">=None</font>)</dt><dd><tt>Returns&nbsp;a&nbsp;list&nbsp;of&nbsp;the&nbsp;direct&nbsp;messages&nbsp;sent&nbsp;to&nbsp;the&nbsp;authenticating&nbsp;user.<br>
  258. &nbsp;<br>
  259. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  260. &nbsp;<br>
  261. Args:<br>
  262. &nbsp;&nbsp;since:<br>
  263. &nbsp;&nbsp;&nbsp;&nbsp;Narrows&nbsp;the&nbsp;returned&nbsp;results&nbsp;to&nbsp;just&nbsp;those&nbsp;statuses&nbsp;created<br>
  264. &nbsp;&nbsp;&nbsp;&nbsp;after&nbsp;the&nbsp;specified&nbsp;HTTP-formatted&nbsp;date.&nbsp;[Optional]<br>
  265. &nbsp;&nbsp;since_id:<br>
  266. &nbsp;&nbsp;&nbsp;&nbsp;Returns&nbsp;results&nbsp;with&nbsp;an&nbsp;ID&nbsp;greater&nbsp;than&nbsp;(that&nbsp;is,&nbsp;more&nbsp;recent<br>
  267. &nbsp;&nbsp;&nbsp;&nbsp;than)&nbsp;the&nbsp;specified&nbsp;ID.&nbsp;There&nbsp;are&nbsp;limits&nbsp;to&nbsp;the&nbsp;number&nbsp;of<br>
  268. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;which&nbsp;can&nbsp;be&nbsp;accessed&nbsp;through&nbsp;the&nbsp;API.&nbsp;If&nbsp;the&nbsp;limit&nbsp;of<br>
  269. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;has&nbsp;occured&nbsp;since&nbsp;the&nbsp;since_id,&nbsp;the&nbsp;since_id&nbsp;will&nbsp;be<br>
  270. &nbsp;&nbsp;&nbsp;&nbsp;forced&nbsp;to&nbsp;the&nbsp;oldest&nbsp;ID&nbsp;available.&nbsp;[Optional]<br>
  271. &nbsp;&nbsp;page:<br>
  272. &nbsp;&nbsp;&nbsp;&nbsp;Specifies&nbsp;the&nbsp;page&nbsp;of&nbsp;results&nbsp;to&nbsp;retrieve.<br>
  273. &nbsp;&nbsp;&nbsp;&nbsp;Note:&nbsp;there&nbsp;are&nbsp;pagination&nbsp;limits.&nbsp;[Optional]<br>
  274. &nbsp;<br>
  275. Returns:<br>
  276. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#DirectMessage">DirectMessage</a>&nbsp;instances</tt></dd></dl>
  277. <dl><dt><a name="Api-GetFavorites"><strong>GetFavorites</strong></a>(self, user<font color="#909090">=None</font>, page<font color="#909090">=None</font>)</dt><dd><tt>Return&nbsp;a&nbsp;list&nbsp;of&nbsp;<a href="#Status">Status</a>&nbsp;objects&nbsp;representing&nbsp;favorited&nbsp;tweets.<br>
  278. By&nbsp;default,&nbsp;returns&nbsp;the&nbsp;(up&nbsp;to)&nbsp;20&nbsp;most&nbsp;recent&nbsp;tweets&nbsp;for&nbsp;the<br>
  279. authenticated&nbsp;user.<br>
  280. &nbsp;<br>
  281. Args:<br>
  282. &nbsp;&nbsp;user:<br>
  283. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;twitter&nbsp;name&nbsp;or&nbsp;id&nbsp;of&nbsp;the&nbsp;user&nbsp;whose&nbsp;favorites&nbsp;you&nbsp;are&nbsp;fetching.<br>
  284. &nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;not&nbsp;specified,&nbsp;defaults&nbsp;to&nbsp;the&nbsp;authenticated&nbsp;user.&nbsp;[Optional]<br>
  285. &nbsp;&nbsp;page:<br>
  286. &nbsp;&nbsp;&nbsp;&nbsp;Specifies&nbsp;the&nbsp;page&nbsp;of&nbsp;results&nbsp;to&nbsp;retrieve.<br>
  287. &nbsp;&nbsp;&nbsp;&nbsp;Note:&nbsp;there&nbsp;are&nbsp;pagination&nbsp;limits.&nbsp;[Optional]</tt></dd></dl>
  288. <dl><dt><a name="Api-GetFeatured"><strong>GetFeatured</strong></a>(self)</dt><dd><tt>Fetch&nbsp;the&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#User">User</a>&nbsp;instances&nbsp;featured&nbsp;on&nbsp;twitter.com<br>
  289. &nbsp;<br>
  290. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  291. &nbsp;<br>
  292. Returns:<br>
  293. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#User">User</a>&nbsp;instances</tt></dd></dl>
  294. <dl><dt><a name="Api-GetFollowerIDs"><strong>GetFollowerIDs</strong></a>(self, userid<font color="#909090">=None</font>, cursor<font color="#909090">=-1</font>)</dt><dd><tt>Fetch&nbsp;the&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#User">User</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;follower<br>
  295. &nbsp;<br>
  296. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  297. &nbsp;<br>
  298. Returns:<br>
  299. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#User">User</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;follower</tt></dd></dl>
  300. <dl><dt><a name="Api-GetFollowers"><strong>GetFollowers</strong></a>(self, page<font color="#909090">=None</font>)</dt><dd><tt>Fetch&nbsp;the&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#User">User</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;follower<br>
  301. &nbsp;<br>
  302. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  303. &nbsp;<br>
  304. Args:<br>
  305. &nbsp;&nbsp;page:<br>
  306. &nbsp;&nbsp;&nbsp;&nbsp;Specifies&nbsp;the&nbsp;page&nbsp;of&nbsp;results&nbsp;to&nbsp;retrieve.<br>
  307. &nbsp;&nbsp;&nbsp;&nbsp;Note:&nbsp;there&nbsp;are&nbsp;pagination&nbsp;limits.&nbsp;[Optional]<br>
  308. &nbsp;<br>
  309. Returns:<br>
  310. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#User">User</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;follower</tt></dd></dl>
  311. <dl><dt><a name="Api-GetFriendIDs"><strong>GetFriendIDs</strong></a>(self, user<font color="#909090">=None</font>, cursor<font color="#909090">=-1</font>)</dt><dd><tt>Returns&nbsp;a&nbsp;list&nbsp;of&nbsp;twitter&nbsp;user&nbsp;id's&nbsp;for&nbsp;every&nbsp;person<br>
  312. the&nbsp;specified&nbsp;user&nbsp;is&nbsp;following.<br>
  313. &nbsp;<br>
  314. Args:<br>
  315. &nbsp;&nbsp;user:<br>
  316. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;id&nbsp;or&nbsp;screen_name&nbsp;of&nbsp;the&nbsp;user&nbsp;to&nbsp;retrieve&nbsp;the&nbsp;id&nbsp;list&nbsp;for<br>
  317. &nbsp;&nbsp;&nbsp;&nbsp;[Optional]<br>
  318. &nbsp;<br>
  319. Returns:<br>
  320. &nbsp;&nbsp;A&nbsp;list&nbsp;of&nbsp;integers,&nbsp;one&nbsp;for&nbsp;each&nbsp;user&nbsp;id.</tt></dd></dl>
  321. <dl><dt><a name="Api-GetFriends"><strong>GetFriends</strong></a>(self, user<font color="#909090">=None</font>, cursor<font color="#909090">=-1</font>)</dt><dd><tt>Fetch&nbsp;the&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#User">User</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;friend.<br>
  322. &nbsp;<br>
  323. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  324. &nbsp;<br>
  325. Args:<br>
  326. &nbsp;&nbsp;user:<br>
  327. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;twitter&nbsp;name&nbsp;or&nbsp;id&nbsp;of&nbsp;the&nbsp;user&nbsp;whose&nbsp;friends&nbsp;you&nbsp;are&nbsp;fetching.<br>
  328. &nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;not&nbsp;specified,&nbsp;defaults&nbsp;to&nbsp;the&nbsp;authenticated&nbsp;user.&nbsp;[Optional]<br>
  329. &nbsp;<br>
  330. Returns:<br>
  331. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#User">User</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;friend</tt></dd></dl>
  332. <dl><dt><a name="Api-GetFriendsTimeline"><strong>GetFriendsTimeline</strong></a>(self, user<font color="#909090">=None</font>, count<font color="#909090">=None</font>, page<font color="#909090">=None</font>, since_id<font color="#909090">=None</font>, retweets<font color="#909090">=None</font>, include_entities<font color="#909090">=None</font>)</dt><dd><tt>Fetch&nbsp;the&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#Status">Status</a>&nbsp;messages&nbsp;for&nbsp;a&nbsp;user's&nbsp;friends<br>
  333. &nbsp;<br>
  334. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated&nbsp;if&nbsp;the&nbsp;user&nbsp;is&nbsp;private.<br>
  335. &nbsp;<br>
  336. Args:<br>
  337. &nbsp;&nbsp;user:<br>
  338. &nbsp;&nbsp;&nbsp;&nbsp;Specifies&nbsp;the&nbsp;ID&nbsp;or&nbsp;screen&nbsp;name&nbsp;of&nbsp;the&nbsp;user&nbsp;for&nbsp;whom&nbsp;to&nbsp;return<br>
  339. &nbsp;&nbsp;&nbsp;&nbsp;the&nbsp;friends_timeline.&nbsp;&nbsp;If&nbsp;not&nbsp;specified&nbsp;then&nbsp;the&nbsp;authenticated<br>
  340. &nbsp;&nbsp;&nbsp;&nbsp;user&nbsp;set&nbsp;in&nbsp;the&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;will&nbsp;be&nbsp;used.&nbsp;&nbsp;[Optional]<br>
  341. &nbsp;&nbsp;count:<br>
  342. &nbsp;&nbsp;&nbsp;&nbsp;Specifies&nbsp;the&nbsp;number&nbsp;of&nbsp;statuses&nbsp;to&nbsp;retrieve.&nbsp;May&nbsp;not&nbsp;be<br>
  343. &nbsp;&nbsp;&nbsp;&nbsp;greater&nbsp;than&nbsp;100.&nbsp;[Optional]<br>
  344. &nbsp;&nbsp;page:<br>
  345. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Specifies&nbsp;the&nbsp;page&nbsp;of&nbsp;results&nbsp;to&nbsp;retrieve.<br>
  346. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Note:&nbsp;there&nbsp;are&nbsp;pagination&nbsp;limits.&nbsp;[Optional]<br>
  347. &nbsp;&nbsp;since_id:<br>
  348. &nbsp;&nbsp;&nbsp;&nbsp;Returns&nbsp;results&nbsp;with&nbsp;an&nbsp;ID&nbsp;greater&nbsp;than&nbsp;(that&nbsp;is,&nbsp;more&nbsp;recent<br>
  349. &nbsp;&nbsp;&nbsp;&nbsp;than)&nbsp;the&nbsp;specified&nbsp;ID.&nbsp;There&nbsp;are&nbsp;limits&nbsp;to&nbsp;the&nbsp;number&nbsp;of<br>
  350. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;which&nbsp;can&nbsp;be&nbsp;accessed&nbsp;through&nbsp;the&nbsp;API.&nbsp;If&nbsp;the&nbsp;limit&nbsp;of<br>
  351. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;has&nbsp;occured&nbsp;since&nbsp;the&nbsp;since_id,&nbsp;the&nbsp;since_id&nbsp;will&nbsp;be<br>
  352. &nbsp;&nbsp;&nbsp;&nbsp;forced&nbsp;to&nbsp;the&nbsp;oldest&nbsp;ID&nbsp;available.&nbsp;[Optional]<br>
  353. &nbsp;&nbsp;retweets:<br>
  354. &nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;True,&nbsp;the&nbsp;timeline&nbsp;will&nbsp;contain&nbsp;native&nbsp;retweets.&nbsp;[Optional]<br>
  355. &nbsp;&nbsp;include_entities:<br>
  356. &nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;True,&nbsp;each&nbsp;tweet&nbsp;will&nbsp;include&nbsp;a&nbsp;node&nbsp;called&nbsp;"entities,".<br>
  357. &nbsp;&nbsp;&nbsp;&nbsp;This&nbsp;node&nbsp;offers&nbsp;a&nbsp;variety&nbsp;of&nbsp;metadata&nbsp;about&nbsp;the&nbsp;tweet&nbsp;in&nbsp;a<br>
  358. &nbsp;&nbsp;&nbsp;&nbsp;discreet&nbsp;structure,&nbsp;including:&nbsp;user_mentions,&nbsp;urls,&nbsp;and<br>
  359. &nbsp;&nbsp;&nbsp;&nbsp;hashtags.&nbsp;[Optional]<br>
  360. &nbsp;<br>
  361. Returns:<br>
  362. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;message</tt></dd></dl>
  363. <dl><dt><a name="Api-GetLists"><strong>GetLists</strong></a>(self, user, cursor<font color="#909090">=-1</font>)</dt><dd><tt>Fetch&nbsp;the&nbsp;sequence&nbsp;of&nbsp;lists&nbsp;for&nbsp;a&nbsp;user.<br>
  364. &nbsp;<br>
  365. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  366. &nbsp;<br>
  367. Args:<br>
  368. &nbsp;&nbsp;user:<br>
  369. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;twitter&nbsp;name&nbsp;or&nbsp;id&nbsp;of&nbsp;the&nbsp;user&nbsp;whose&nbsp;friends&nbsp;you&nbsp;are&nbsp;fetching.<br>
  370. &nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;the&nbsp;passed&nbsp;in&nbsp;user&nbsp;is&nbsp;the&nbsp;same&nbsp;as&nbsp;the&nbsp;authenticated&nbsp;user<br>
  371. &nbsp;&nbsp;&nbsp;&nbsp;then&nbsp;you&nbsp;will&nbsp;also&nbsp;receive&nbsp;private&nbsp;list&nbsp;data.<br>
  372. &nbsp;&nbsp;cursor:<br>
  373. &nbsp;&nbsp;&nbsp;&nbsp;"page"&nbsp;value&nbsp;that&nbsp;Twitter&nbsp;will&nbsp;use&nbsp;to&nbsp;start&nbsp;building&nbsp;the<br>
  374. &nbsp;&nbsp;&nbsp;&nbsp;list&nbsp;sequence&nbsp;from.&nbsp;&nbsp;-1&nbsp;to&nbsp;start&nbsp;at&nbsp;the&nbsp;beginning.<br>
  375. &nbsp;&nbsp;&nbsp;&nbsp;Twitter&nbsp;will&nbsp;return&nbsp;in&nbsp;the&nbsp;result&nbsp;the&nbsp;values&nbsp;for&nbsp;next_cursor<br>
  376. &nbsp;&nbsp;&nbsp;&nbsp;and&nbsp;previous_cursor.&nbsp;[Optional]<br>
  377. &nbsp;<br>
  378. Returns:<br>
  379. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#List">List</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;list</tt></dd></dl>
  380. <dl><dt><a name="Api-GetMentions"><strong>GetMentions</strong></a>(self, since_id<font color="#909090">=None</font>, max_id<font color="#909090">=None</font>, page<font color="#909090">=None</font>)</dt><dd><tt>Returns&nbsp;the&nbsp;20&nbsp;most&nbsp;recent&nbsp;mentions&nbsp;(status&nbsp;containing&nbsp;@twitterID)<br>
  381. for&nbsp;the&nbsp;authenticating&nbsp;user.<br>
  382. &nbsp;<br>
  383. Args:<br>
  384. &nbsp;&nbsp;since_id:<br>
  385. &nbsp;&nbsp;&nbsp;&nbsp;Returns&nbsp;results&nbsp;with&nbsp;an&nbsp;ID&nbsp;greater&nbsp;than&nbsp;(that&nbsp;is,&nbsp;more&nbsp;recent<br>
  386. &nbsp;&nbsp;&nbsp;&nbsp;than)&nbsp;the&nbsp;specified&nbsp;ID.&nbsp;There&nbsp;are&nbsp;limits&nbsp;to&nbsp;the&nbsp;number&nbsp;of<br>
  387. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;which&nbsp;can&nbsp;be&nbsp;accessed&nbsp;through&nbsp;the&nbsp;API.&nbsp;If&nbsp;the&nbsp;limit&nbsp;of<br>
  388. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;has&nbsp;occured&nbsp;since&nbsp;the&nbsp;since_id,&nbsp;the&nbsp;since_id&nbsp;will&nbsp;be<br>
  389. &nbsp;&nbsp;&nbsp;&nbsp;forced&nbsp;to&nbsp;the&nbsp;oldest&nbsp;ID&nbsp;available.&nbsp;[Optional]<br>
  390. &nbsp;&nbsp;max_id:<br>
  391. &nbsp;&nbsp;&nbsp;&nbsp;Returns&nbsp;only&nbsp;statuses&nbsp;with&nbsp;an&nbsp;ID&nbsp;less&nbsp;than<br>
  392. &nbsp;&nbsp;&nbsp;&nbsp;(that&nbsp;is,&nbsp;older&nbsp;than)&nbsp;the&nbsp;specified&nbsp;ID.&nbsp;&nbsp;[Optional]<br>
  393. &nbsp;&nbsp;page:<br>
  394. &nbsp;&nbsp;&nbsp;&nbsp;Specifies&nbsp;the&nbsp;page&nbsp;of&nbsp;results&nbsp;to&nbsp;retrieve.<br>
  395. &nbsp;&nbsp;&nbsp;&nbsp;Note:&nbsp;there&nbsp;are&nbsp;pagination&nbsp;limits.&nbsp;[Optional]<br>
  396. &nbsp;<br>
  397. Returns:<br>
  398. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;mention&nbsp;of&nbsp;the&nbsp;user.</tt></dd></dl>
  399. <dl><dt><a name="Api-GetPublicTimeline"><strong>GetPublicTimeline</strong></a>(self, since_id<font color="#909090">=None</font>, include_rts<font color="#909090">=None</font>, include_entities<font color="#909090">=None</font>)</dt><dd><tt>Fetch&nbsp;the&nbsp;sequence&nbsp;of&nbsp;public&nbsp;twitter.<a href="#Status">Status</a>&nbsp;message&nbsp;for&nbsp;all&nbsp;users.<br>
  400. &nbsp;<br>
  401. Args:<br>
  402. &nbsp;&nbsp;since_id:<br>
  403. &nbsp;&nbsp;&nbsp;&nbsp;Returns&nbsp;results&nbsp;with&nbsp;an&nbsp;ID&nbsp;greater&nbsp;than&nbsp;(that&nbsp;is,&nbsp;more&nbsp;recent<br>
  404. &nbsp;&nbsp;&nbsp;&nbsp;than)&nbsp;the&nbsp;specified&nbsp;ID.&nbsp;There&nbsp;are&nbsp;limits&nbsp;to&nbsp;the&nbsp;number&nbsp;of<br>
  405. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;which&nbsp;can&nbsp;be&nbsp;accessed&nbsp;through&nbsp;the&nbsp;API.&nbsp;If&nbsp;the&nbsp;limit&nbsp;of<br>
  406. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;has&nbsp;occured&nbsp;since&nbsp;the&nbsp;since_id,&nbsp;the&nbsp;since_id&nbsp;will&nbsp;be<br>
  407. &nbsp;&nbsp;&nbsp;&nbsp;forced&nbsp;to&nbsp;the&nbsp;oldest&nbsp;ID&nbsp;available.&nbsp;[Optional]<br>
  408. &nbsp;&nbsp;include_rts:<br>
  409. &nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;True,&nbsp;the&nbsp;timeline&nbsp;will&nbsp;contain&nbsp;native&nbsp;retweets&nbsp;(if&nbsp;they<br>
  410. &nbsp;&nbsp;&nbsp;&nbsp;exist)&nbsp;in&nbsp;addition&nbsp;to&nbsp;the&nbsp;standard&nbsp;stream&nbsp;of&nbsp;tweets.&nbsp;[Optional]<br>
  411. &nbsp;&nbsp;include_entities:<br>
  412. &nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;True,&nbsp;each&nbsp;tweet&nbsp;will&nbsp;include&nbsp;a&nbsp;node&nbsp;called&nbsp;"entities,".<br>
  413. &nbsp;&nbsp;&nbsp;&nbsp;This&nbsp;node&nbsp;offers&nbsp;a&nbsp;variety&nbsp;of&nbsp;metadata&nbsp;about&nbsp;the&nbsp;tweet&nbsp;in&nbsp;a<br>
  414. &nbsp;&nbsp;&nbsp;&nbsp;discreet&nbsp;structure,&nbsp;including:&nbsp;user_mentions,&nbsp;urls,&nbsp;and<br>
  415. &nbsp;&nbsp;&nbsp;&nbsp;hashtags.&nbsp;[Optional]<br>
  416. &nbsp;<br>
  417. Returns:<br>
  418. &nbsp;&nbsp;An&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;message</tt></dd></dl>
  419. <dl><dt><a name="Api-GetRateLimitStatus"><strong>GetRateLimitStatus</strong></a>(self)</dt><dd><tt>Fetch&nbsp;the&nbsp;rate&nbsp;limit&nbsp;status&nbsp;for&nbsp;the&nbsp;currently&nbsp;authorized&nbsp;user.<br>
  420. &nbsp;<br>
  421. Returns:<br>
  422. &nbsp;&nbsp;A&nbsp;dictionary&nbsp;containing&nbsp;the&nbsp;time&nbsp;the&nbsp;limit&nbsp;will&nbsp;reset&nbsp;(reset_time),<br>
  423. &nbsp;&nbsp;the&nbsp;number&nbsp;of&nbsp;remaining&nbsp;hits&nbsp;allowed&nbsp;before&nbsp;the&nbsp;reset&nbsp;(remaining_hits),<br>
  424. &nbsp;&nbsp;the&nbsp;number&nbsp;of&nbsp;hits&nbsp;allowed&nbsp;in&nbsp;a&nbsp;60-minute&nbsp;period&nbsp;(hourly_limit),&nbsp;and<br>
  425. &nbsp;&nbsp;the&nbsp;time&nbsp;of&nbsp;the&nbsp;reset&nbsp;in&nbsp;seconds&nbsp;since&nbsp;The&nbsp;Epoch&nbsp;(reset_time_in_seconds).</tt></dd></dl>
  426. <dl><dt><a name="Api-GetReplies"><strong>GetReplies</strong></a>(self, since<font color="#909090">=None</font>, since_id<font color="#909090">=None</font>, page<font color="#909090">=None</font>)</dt><dd><tt>Get&nbsp;a&nbsp;sequence&nbsp;of&nbsp;status&nbsp;messages&nbsp;representing&nbsp;the&nbsp;20&nbsp;most<br>
  427. recent&nbsp;replies&nbsp;(status&nbsp;updates&nbsp;prefixed&nbsp;with&nbsp;@twitterID)&nbsp;to&nbsp;the<br>
  428. authenticating&nbsp;user.<br>
  429. &nbsp;<br>
  430. Args:<br>
  431. &nbsp;&nbsp;since_id:<br>
  432. &nbsp;&nbsp;&nbsp;&nbsp;Returns&nbsp;results&nbsp;with&nbsp;an&nbsp;ID&nbsp;greater&nbsp;than&nbsp;(that&nbsp;is,&nbsp;more&nbsp;recent<br>
  433. &nbsp;&nbsp;&nbsp;&nbsp;than)&nbsp;the&nbsp;specified&nbsp;ID.&nbsp;There&nbsp;are&nbsp;limits&nbsp;to&nbsp;the&nbsp;number&nbsp;of<br>
  434. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;which&nbsp;can&nbsp;be&nbsp;accessed&nbsp;through&nbsp;the&nbsp;API.&nbsp;If&nbsp;the&nbsp;limit&nbsp;of<br>
  435. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;has&nbsp;occured&nbsp;since&nbsp;the&nbsp;since_id,&nbsp;the&nbsp;since_id&nbsp;will&nbsp;be<br>
  436. &nbsp;&nbsp;&nbsp;&nbsp;forced&nbsp;to&nbsp;the&nbsp;oldest&nbsp;ID&nbsp;available.&nbsp;[Optional]<br>
  437. &nbsp;&nbsp;page:<br>
  438. &nbsp;&nbsp;&nbsp;&nbsp;Specifies&nbsp;the&nbsp;page&nbsp;of&nbsp;results&nbsp;to&nbsp;retrieve.<br>
  439. &nbsp;&nbsp;&nbsp;&nbsp;Note:&nbsp;there&nbsp;are&nbsp;pagination&nbsp;limits.&nbsp;[Optional]<br>
  440. &nbsp;&nbsp;since:<br>
  441. &nbsp;<br>
  442. Returns:<br>
  443. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;reply&nbsp;to&nbsp;the&nbsp;user.</tt></dd></dl>
  444. <dl><dt><a name="Api-GetRetweets"><strong>GetRetweets</strong></a>(self, statusid)</dt><dd><tt>Returns&nbsp;up&nbsp;to&nbsp;100&nbsp;of&nbsp;the&nbsp;first&nbsp;retweets&nbsp;of&nbsp;the&nbsp;tweet&nbsp;identified<br>
  445. by&nbsp;statusid<br>
  446. &nbsp;<br>
  447. Args:<br>
  448. &nbsp;&nbsp;statusid:<br>
  449. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;tweet&nbsp;for&nbsp;which&nbsp;retweets&nbsp;should&nbsp;be&nbsp;searched&nbsp;for<br>
  450. &nbsp;<br>
  451. Returns:<br>
  452. &nbsp;&nbsp;A&nbsp;list&nbsp;of&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instances,&nbsp;which&nbsp;are&nbsp;retweets&nbsp;of&nbsp;statusid</tt></dd></dl>
  453. <dl><dt><a name="Api-GetSearch"><strong>GetSearch</strong></a>(self, term, geocode<font color="#909090">=None</font>, since_id<font color="#909090">=None</font>, per_page<font color="#909090">=15</font>, page<font color="#909090">=1</font>, lang<font color="#909090">='en'</font>, show_user<font color="#909090">='true'</font>, query_users<font color="#909090">=False</font>)</dt><dd><tt>Return&nbsp;twitter&nbsp;search&nbsp;results&nbsp;for&nbsp;a&nbsp;given&nbsp;term.<br>
  454. &nbsp;<br>
  455. Args:<br>
  456. &nbsp;&nbsp;term:<br>
  457. &nbsp;&nbsp;&nbsp;&nbsp;term&nbsp;to&nbsp;search&nbsp;by.<br>
  458. &nbsp;&nbsp;since_id:<br>
  459. &nbsp;&nbsp;&nbsp;&nbsp;Returns&nbsp;results&nbsp;with&nbsp;an&nbsp;ID&nbsp;greater&nbsp;than&nbsp;(that&nbsp;is,&nbsp;more&nbsp;recent<br>
  460. &nbsp;&nbsp;&nbsp;&nbsp;than)&nbsp;the&nbsp;specified&nbsp;ID.&nbsp;There&nbsp;are&nbsp;limits&nbsp;to&nbsp;the&nbsp;number&nbsp;of<br>
  461. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;which&nbsp;can&nbsp;be&nbsp;accessed&nbsp;through&nbsp;the&nbsp;API.&nbsp;If&nbsp;the&nbsp;limit&nbsp;of<br>
  462. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;has&nbsp;occured&nbsp;since&nbsp;the&nbsp;since_id,&nbsp;the&nbsp;since_id&nbsp;will&nbsp;be<br>
  463. &nbsp;&nbsp;&nbsp;&nbsp;forced&nbsp;to&nbsp;the&nbsp;oldest&nbsp;ID&nbsp;available.&nbsp;[Optional]<br>
  464. &nbsp;&nbsp;geocode:<br>
  465. &nbsp;&nbsp;&nbsp;&nbsp;geolocation&nbsp;information&nbsp;in&nbsp;the&nbsp;form&nbsp;(latitude,&nbsp;longitude,&nbsp;radius)<br>
  466. &nbsp;&nbsp;&nbsp;&nbsp;[Optional]<br>
  467. &nbsp;&nbsp;per_page:<br>
  468. &nbsp;&nbsp;&nbsp;&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;return.&nbsp;&nbsp;Default&nbsp;is&nbsp;15&nbsp;[Optional]<br>
  469. &nbsp;&nbsp;page:<br>
  470. &nbsp;&nbsp;&nbsp;&nbsp;Specifies&nbsp;the&nbsp;page&nbsp;of&nbsp;results&nbsp;to&nbsp;retrieve.<br>
  471. &nbsp;&nbsp;&nbsp;&nbsp;Note:&nbsp;there&nbsp;are&nbsp;pagination&nbsp;limits.&nbsp;[Optional]<br>
  472. &nbsp;&nbsp;lang:<br>
  473. &nbsp;&nbsp;&nbsp;&nbsp;language&nbsp;for&nbsp;results.&nbsp;&nbsp;Default&nbsp;is&nbsp;English&nbsp;[Optional]<br>
  474. &nbsp;&nbsp;show_user:<br>
  475. &nbsp;&nbsp;&nbsp;&nbsp;prefixes&nbsp;screen&nbsp;name&nbsp;in&nbsp;status<br>
  476. &nbsp;&nbsp;query_users:<br>
  477. &nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;set&nbsp;to&nbsp;False,&nbsp;then&nbsp;all&nbsp;users&nbsp;only&nbsp;have&nbsp;screen_name&nbsp;and<br>
  478. &nbsp;&nbsp;&nbsp;&nbsp;profile_image_url&nbsp;available.<br>
  479. &nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;set&nbsp;to&nbsp;True,&nbsp;all&nbsp;information&nbsp;of&nbsp;users&nbsp;are&nbsp;available,<br>
  480. &nbsp;&nbsp;&nbsp;&nbsp;but&nbsp;it&nbsp;uses&nbsp;lots&nbsp;of&nbsp;request&nbsp;quota,&nbsp;one&nbsp;per&nbsp;status.<br>
  481. &nbsp;<br>
  482. Returns:<br>
  483. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;message&nbsp;containing<br>
  484. &nbsp;&nbsp;the&nbsp;term</tt></dd></dl>
  485. <dl><dt><a name="Api-GetStatus"><strong>GetStatus</strong></a>(self, id)</dt><dd><tt>Returns&nbsp;a&nbsp;single&nbsp;status&nbsp;message.<br>
  486. &nbsp;<br>
  487. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated&nbsp;if&nbsp;the<br>
  488. status&nbsp;message&nbsp;is&nbsp;private.<br>
  489. &nbsp;<br>
  490. Args:<br>
  491. &nbsp;&nbsp;id:<br>
  492. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;numeric&nbsp;ID&nbsp;of&nbsp;the&nbsp;status&nbsp;you&nbsp;are&nbsp;trying&nbsp;to&nbsp;retrieve.<br>
  493. &nbsp;<br>
  494. Returns:<br>
  495. &nbsp;&nbsp;A&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instance&nbsp;representing&nbsp;that&nbsp;status&nbsp;message</tt></dd></dl>
  496. <dl><dt><a name="Api-GetSubscriptions"><strong>GetSubscriptions</strong></a>(self, user, cursor<font color="#909090">=-1</font>)</dt><dd><tt>Fetch&nbsp;the&nbsp;sequence&nbsp;of&nbsp;Lists&nbsp;that&nbsp;the&nbsp;given&nbsp;user&nbsp;is&nbsp;subscribed&nbsp;to<br>
  497. &nbsp;<br>
  498. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  499. &nbsp;<br>
  500. Args:<br>
  501. &nbsp;&nbsp;user:<br>
  502. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;twitter&nbsp;name&nbsp;or&nbsp;id&nbsp;of&nbsp;the&nbsp;user<br>
  503. &nbsp;&nbsp;cursor:<br>
  504. &nbsp;&nbsp;&nbsp;&nbsp;"page"&nbsp;value&nbsp;that&nbsp;Twitter&nbsp;will&nbsp;use&nbsp;to&nbsp;start&nbsp;building&nbsp;the<br>
  505. &nbsp;&nbsp;&nbsp;&nbsp;list&nbsp;sequence&nbsp;from.&nbsp;&nbsp;-1&nbsp;to&nbsp;start&nbsp;at&nbsp;the&nbsp;beginning.<br>
  506. &nbsp;&nbsp;&nbsp;&nbsp;Twitter&nbsp;will&nbsp;return&nbsp;in&nbsp;the&nbsp;result&nbsp;the&nbsp;values&nbsp;for&nbsp;next_cursor<br>
  507. &nbsp;&nbsp;&nbsp;&nbsp;and&nbsp;previous_cursor.&nbsp;[Optional]<br>
  508. &nbsp;<br>
  509. Returns:<br>
  510. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#List">List</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;list</tt></dd></dl>
  511. <dl><dt><a name="Api-GetTrendsCurrent"><strong>GetTrendsCurrent</strong></a>(self, exclude<font color="#909090">=None</font>)</dt><dd><tt>Get&nbsp;the&nbsp;current&nbsp;top&nbsp;trending&nbsp;topics<br>
  512. &nbsp;<br>
  513. Args:<br>
  514. &nbsp;&nbsp;exclude:<br>
  515. &nbsp;&nbsp;&nbsp;&nbsp;Appends&nbsp;the&nbsp;exclude&nbsp;parameter&nbsp;as&nbsp;a&nbsp;request&nbsp;parameter.<br>
  516. &nbsp;&nbsp;&nbsp;&nbsp;Currently&nbsp;only&nbsp;exclude=hashtags&nbsp;is&nbsp;supported.&nbsp;[Optional]<br>
  517. &nbsp;<br>
  518. Returns:<br>
  519. &nbsp;&nbsp;A&nbsp;list&nbsp;with&nbsp;10&nbsp;entries.&nbsp;Each&nbsp;entry&nbsp;contains&nbsp;the&nbsp;twitter.</tt></dd></dl>
  520. <dl><dt><a name="Api-GetTrendsDaily"><strong>GetTrendsDaily</strong></a>(self, exclude<font color="#909090">=None</font>, startdate<font color="#909090">=None</font>)</dt><dd><tt>Get&nbsp;the&nbsp;current&nbsp;top&nbsp;trending&nbsp;topics&nbsp;for&nbsp;each&nbsp;hour&nbsp;in&nbsp;a&nbsp;given&nbsp;day<br>
  521. &nbsp;<br>
  522. Args:<br>
  523. &nbsp;&nbsp;startdate:<br>
  524. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;start&nbsp;date&nbsp;for&nbsp;the&nbsp;report.<br>
  525. &nbsp;&nbsp;&nbsp;&nbsp;Should&nbsp;be&nbsp;in&nbsp;the&nbsp;format&nbsp;YYYY-MM-DD.&nbsp;[Optional]<br>
  526. &nbsp;&nbsp;exclude:<br>
  527. &nbsp;&nbsp;&nbsp;&nbsp;Appends&nbsp;the&nbsp;exclude&nbsp;parameter&nbsp;as&nbsp;a&nbsp;request&nbsp;parameter.<br>
  528. &nbsp;&nbsp;&nbsp;&nbsp;Currently&nbsp;only&nbsp;exclude=hashtags&nbsp;is&nbsp;supported.&nbsp;[Optional]<br>
  529. &nbsp;<br>
  530. Returns:<br>
  531. &nbsp;&nbsp;A&nbsp;list&nbsp;with&nbsp;24&nbsp;entries.&nbsp;Each&nbsp;entry&nbsp;contains&nbsp;the&nbsp;twitter.<br>
  532. &nbsp;&nbsp;<a href="#Trend">Trend</a>&nbsp;elements&nbsp;that&nbsp;were&nbsp;trending&nbsp;at&nbsp;the&nbsp;corresponding&nbsp;hour&nbsp;of&nbsp;the&nbsp;day.</tt></dd></dl>
  533. <dl><dt><a name="Api-GetTrendsWeekly"><strong>GetTrendsWeekly</strong></a>(self, exclude<font color="#909090">=None</font>, startdate<font color="#909090">=None</font>)</dt><dd><tt>Get&nbsp;the&nbsp;top&nbsp;30&nbsp;trending&nbsp;topics&nbsp;for&nbsp;each&nbsp;day&nbsp;in&nbsp;a&nbsp;given&nbsp;week.<br>
  534. &nbsp;<br>
  535. Args:<br>
  536. &nbsp;&nbsp;startdate:<br>
  537. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;start&nbsp;date&nbsp;for&nbsp;the&nbsp;report.<br>
  538. &nbsp;&nbsp;&nbsp;&nbsp;Should&nbsp;be&nbsp;in&nbsp;the&nbsp;format&nbsp;YYYY-MM-DD.&nbsp;[Optional]<br>
  539. &nbsp;&nbsp;exclude:<br>
  540. &nbsp;&nbsp;&nbsp;&nbsp;Appends&nbsp;the&nbsp;exclude&nbsp;parameter&nbsp;as&nbsp;a&nbsp;request&nbsp;parameter.<br>
  541. &nbsp;&nbsp;&nbsp;&nbsp;Currently&nbsp;only&nbsp;exclude=hashtags&nbsp;is&nbsp;supported.&nbsp;[Optional]<br>
  542. Returns:<br>
  543. &nbsp;&nbsp;A&nbsp;list&nbsp;with&nbsp;each&nbsp;entry&nbsp;contains&nbsp;the&nbsp;twitter.<br>
  544. &nbsp;&nbsp;<a href="#Trend">Trend</a>&nbsp;elements&nbsp;of&nbsp;trending&nbsp;topics&nbsp;for&nbsp;the&nbsp;corrsponding&nbsp;day&nbsp;of&nbsp;the&nbsp;week</tt></dd></dl>
  545. <dl><dt><a name="Api-GetUser"><strong>GetUser</strong></a>(self, user)</dt><dd><tt>Returns&nbsp;a&nbsp;single&nbsp;user.<br>
  546. &nbsp;<br>
  547. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  548. &nbsp;<br>
  549. Args:<br>
  550. &nbsp;&nbsp;user:&nbsp;The&nbsp;twitter&nbsp;name&nbsp;or&nbsp;id&nbsp;of&nbsp;the&nbsp;user&nbsp;to&nbsp;retrieve.<br>
  551. &nbsp;<br>
  552. Returns:<br>
  553. &nbsp;&nbsp;A&nbsp;twitter.<a href="#User">User</a>&nbsp;instance&nbsp;representing&nbsp;that&nbsp;user</tt></dd></dl>
  554. <dl><dt><a name="Api-GetUserByEmail"><strong>GetUserByEmail</strong></a>(self, email)</dt><dd><tt>Returns&nbsp;a&nbsp;single&nbsp;user&nbsp;by&nbsp;email&nbsp;address.<br>
  555. &nbsp;<br>
  556. Args:<br>
  557. &nbsp;&nbsp;email:<br>
  558. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;email&nbsp;of&nbsp;the&nbsp;user&nbsp;to&nbsp;retrieve.<br>
  559. &nbsp;<br>
  560. Returns:<br>
  561. &nbsp;&nbsp;A&nbsp;twitter.<a href="#User">User</a>&nbsp;instance&nbsp;representing&nbsp;that&nbsp;user</tt></dd></dl>
  562. <dl><dt><a name="Api-GetUserRetweets"><strong>GetUserRetweets</strong></a>(self, count<font color="#909090">=None</font>, since_id<font color="#909090">=None</font>, max_id<font color="#909090">=None</font>, include_entities<font color="#909090">=False</font>)</dt><dd><tt>Fetch&nbsp;the&nbsp;sequence&nbsp;of&nbsp;retweets&nbsp;made&nbsp;by&nbsp;a&nbsp;single&nbsp;user.<br>
  563. &nbsp;<br>
  564. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated.<br>
  565. &nbsp;<br>
  566. Args:<br>
  567. &nbsp;&nbsp;count:<br>
  568. &nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;number&nbsp;of&nbsp;status&nbsp;messages&nbsp;to&nbsp;retrieve.&nbsp;[Optional]<br>
  569. &nbsp;&nbsp;since_id:<br>
  570. &nbsp;&nbsp;&nbsp;&nbsp;Returns&nbsp;results&nbsp;with&nbsp;an&nbsp;ID&nbsp;greater&nbsp;than&nbsp;(that&nbsp;is,&nbsp;more&nbsp;recent<br>
  571. &nbsp;&nbsp;&nbsp;&nbsp;than)&nbsp;the&nbsp;specified&nbsp;ID.&nbsp;There&nbsp;are&nbsp;limits&nbsp;to&nbsp;the&nbsp;number&nbsp;of<br>
  572. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;which&nbsp;can&nbsp;be&nbsp;accessed&nbsp;through&nbsp;the&nbsp;API.&nbsp;If&nbsp;the&nbsp;limit&nbsp;of<br>
  573. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;has&nbsp;occured&nbsp;since&nbsp;the&nbsp;since_id,&nbsp;the&nbsp;since_id&nbsp;will&nbsp;be<br>
  574. &nbsp;&nbsp;&nbsp;&nbsp;forced&nbsp;to&nbsp;the&nbsp;oldest&nbsp;ID&nbsp;available.&nbsp;[Optional]<br>
  575. &nbsp;&nbsp;max_id:<br>
  576. &nbsp;&nbsp;&nbsp;&nbsp;Returns&nbsp;results&nbsp;with&nbsp;an&nbsp;ID&nbsp;less&nbsp;than&nbsp;(that&nbsp;is,&nbsp;older&nbsp;than)&nbsp;or<br>
  577. &nbsp;&nbsp;&nbsp;&nbsp;equal&nbsp;to&nbsp;the&nbsp;specified&nbsp;ID.&nbsp;[Optional]<br>
  578. &nbsp;&nbsp;include_entities:<br>
  579. &nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;True,&nbsp;each&nbsp;tweet&nbsp;will&nbsp;include&nbsp;a&nbsp;node&nbsp;called&nbsp;"entities,".<br>
  580. &nbsp;&nbsp;&nbsp;&nbsp;This&nbsp;node&nbsp;offers&nbsp;a&nbsp;variety&nbsp;of&nbsp;metadata&nbsp;about&nbsp;the&nbsp;tweet&nbsp;in&nbsp;a<br>
  581. &nbsp;&nbsp;&nbsp;&nbsp;discreet&nbsp;structure,&nbsp;including:&nbsp;user_mentions,&nbsp;urls,&nbsp;and<br>
  582. &nbsp;&nbsp;&nbsp;&nbsp;hashtags.&nbsp;[Optional]<br>
  583. &nbsp;<br>
  584. Returns:<br>
  585. &nbsp;&nbsp;A&nbsp;sequence&nbsp;of&nbsp;twitter.<a href="#Status">Status</a>&nbsp;instances,&nbsp;one&nbsp;for&nbsp;each&nbsp;message&nbsp;up&nbsp;to&nbsp;count</tt></dd></dl>
  586. <dl><dt><a name="Api-GetUserTimeline"><strong>GetUserTimeline</strong></a>(self, id<font color="#909090">=None</font>, user_id<font color="#909090">=None</font>, screen_name<font color="#909090">=None</font>, since_id<font color="#909090">=None</font>, max_id<font color="#909090">=None</font>, count<font color="#909090">=None</font>, page<font color="#909090">=None</font>, include_rts<font color="#909090">=None</font>, include_entities<font color="#909090">=None</font>)</dt><dd><tt>Fetch&nbsp;the&nbsp;sequence&nbsp;of&nbsp;public&nbsp;<a href="#Status">Status</a>&nbsp;messages&nbsp;for&nbsp;a&nbsp;single&nbsp;user.<br>
  587. &nbsp;<br>
  588. The&nbsp;twitter.<a href="#Api">Api</a>&nbsp;instance&nbsp;must&nbsp;be&nbsp;authenticated&nbsp;if&nbsp;the&nbsp;user&nbsp;is&nbsp;private.<br>
  589. &nbsp;<br>
  590. Args:<br>
  591. &nbsp;&nbsp;id:<br>
  592. &nbsp;&nbsp;&nbsp;&nbsp;Specifies&nbsp;the&nbsp;ID&nbsp;or&nbsp;screen&nbsp;name&nbsp;of&nbsp;the&nbsp;user&nbsp;for&nbsp;whom&nbsp;to&nbsp;return<br>
  593. &nbsp;&nbsp;&nbsp;&nbsp;the&nbsp;user_timeline.&nbsp;[Optional]<br>
  594. &nbsp;&nbsp;user_id:<br>
  595. &nbsp;&nbsp;&nbsp;&nbsp;Specfies&nbsp;the&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;for&nbsp;whom&nbsp;to&nbsp;return&nbsp;the<br>
  596. &nbsp;&nbsp;&nbsp;&nbsp;user_timeline.&nbsp;Helpful&nbsp;for&nbsp;disambiguating&nbsp;when&nbsp;a&nbsp;valid&nbsp;user&nbsp;ID<br>
  597. &nbsp;&nbsp;&nbsp;&nbsp;is&nbsp;also&nbsp;a&nbsp;valid&nbsp;screen&nbsp;name.&nbsp;[Optional]<br>
  598. &nbsp;&nbsp;screen_name:<br>
  599. &nbsp;&nbsp;&nbsp;&nbsp;Specfies&nbsp;the&nbsp;screen&nbsp;name&nbsp;of&nbsp;the&nbsp;user&nbsp;for&nbsp;whom&nbsp;to&nbsp;return&nbsp;the<br>
  600. &nbsp;&nbsp;&nbsp;&nbsp;user_timeline.&nbsp;Helpful&nbsp;for&nbsp;disambiguating&nbsp;when&nbsp;a&nbsp;valid&nbsp;screen<br>
  601. &nbsp;&nbsp;&nbsp;&nbsp;name&nbsp;is&nbsp;also&nbsp;a&nbsp;user&nbsp;ID.&nbsp;[Optional]<br>
  602. &nbsp;&nbsp;since_id:<br>
  603. &nbsp;&nbsp;&nbsp;&nbsp;Returns&nbsp;results&nbsp;with&nbsp;an&nbsp;ID&nbsp;greater&nbsp;than&nbsp;(that&nbsp;is,&nbsp;more&nbsp;recent<br>
  604. &nbsp;&nbsp;&nbsp;&nbsp;than)&nbsp;the&nbsp;specified&nbsp;ID.&nbsp;There&nbsp;are&nbsp;limits&nbsp;to&nbsp;the&nbsp;number&nbsp;of<br>
  605. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;which&nbsp;can&nbsp;be&nbsp;accessed&nbsp;through&nbsp;the&nbsp;API.&nbsp;If&nbsp;the&nbsp;limit&nbsp;of<br>
  606. &nbsp;&nbsp;&nbsp;&nbsp;Tweets&nbsp;has&nbsp;occured&nbsp;since&nbsp;the&nbsp;since_id,&nbsp;the&nbsp;since_id&nbsp;will&nbsp;be<br>
  607. &nbsp;&nbsp;&nbsp;&nbsp;forced&nbsp;to&nbsp;the&nbsp;oldest&nbsp;ID&nbsp;available.&nbsp;[Optional]<br>
  608. &nbsp;&nbsp;max_id:<br>
  609. &nbsp;&nbsp;&nbsp;&nbsp;Returns&nbsp;only&nbsp;statuses&nbsp;with&nbsp;an&nbsp;ID&nbsp;less&nbsp;than&nbsp;(that&nbsp;is,&nbsp;older<br>
  610. &nbsp;&nbsp;&nbsp;&nbsp;than)&nbsp;or&nbsp;equal&nbsp;to&nbsp;the&nbsp;specified&nbsp;ID.&nbsp;[Optional]<br>
  611. &nbsp;&nbsp;count:<br>
  612. &nbsp;&nbsp;&nbsp;&nbsp;Specifies&nbsp;the&nbsp;number&nbsp;of&nbsp;statuses&nbsp;to&nbsp;retrieve.&nbsp;May&nbsp;not&nbsp;be<br>
  613. &nbsp;&nbsp;&nbsp;&nbsp;greater&nbsp;than&nbsp;200.&nbsp;&nbsp;[Optional]<br>
  614. &nbsp;&nbsp;page:<br>
  615. &nbsp;&nbsp;&nbsp;&nbsp;Specifies&nbsp;the&nbsp;page&nbsp;of&nbsp;results&nbsp;to&nbsp;retrieve.<br>
  616. &nbsp;&nbsp;&nbsp;&nbsp;Note:&nbsp;there&nbsp;are&nbsp;pagination&nbsp;limits.&nbsp;[Optional]<br>
  617. &nbsp;&nbsp;include_rts:<br>
  618. &nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;True,&nbsp;the&nbsp;timeline&nbsp;will&nbsp;contain&nbsp;

Large files files are truncated, but you can click here to view the full file