/usr/share/doc/python-tweepy-doc/html/api.html is in python-tweepy-doc 3.5.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>API Reference — tweepy 3.5.0 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '3.5.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="tweepy 3.5.0 documentation" href="index.html" />
<link rel="next" title="Streaming With Tweepy" href="streaming_how_to.html" />
<link rel="prev" title="Cursor Tutorial" href="cursor_tutorial.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="streaming_how_to.html" title="Streaming With Tweepy"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="cursor_tutorial.html" title="Cursor Tutorial"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">tweepy 3.5.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<span class="target" id="api-reference"></span><div class="section" id="id1">
<h1>API Reference<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h1>
<p>This page contains some basic documentation for the Tweepy module.</p>
</div>
<div class="section" id="tweepy-api-twitter-api-wrapper">
<h1><code class="xref py py-mod docutils literal"><span class="pre">tweepy.api</span></code> — Twitter API wrapper<a class="headerlink" href="#tweepy-api-twitter-api-wrapper" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="API">
<em class="property">class </em><code class="descname">API</code><span class="sig-paren">(</span><span class="optional">[</span><em>auth_handler=None</em><span class="optional">]</span><span class="optional">[</span>, <em>host='api.twitter.com'</em><span class="optional">]</span><span class="optional">[</span>, <em>search_host='search.twitter.com'</em><span class="optional">]</span><span class="optional">[</span>, <em>cache=None</em><span class="optional">]</span><span class="optional">[</span>, <em>api_root='/1'</em><span class="optional">]</span><span class="optional">[</span>, <em>search_root=''</em><span class="optional">]</span><span class="optional">[</span>, <em>retry_count=0</em><span class="optional">]</span><span class="optional">[</span>, <em>retry_delay=0</em><span class="optional">]</span><span class="optional">[</span>, <em>retry_errors=None</em><span class="optional">]</span><span class="optional">[</span>, <em>timeout=60</em><span class="optional">]</span><span class="optional">[</span>, <em>parser=ModelParser</em><span class="optional">]</span><span class="optional">[</span>, <em>compression=False</em><span class="optional">]</span><span class="optional">[</span>, <em>wait_on_rate_limit=False</em><span class="optional">]</span><span class="optional">[</span>, <em>wait_on_rate_limit_notify=False</em><span class="optional">]</span><span class="optional">[</span>, <em>proxy=None</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API" title="Permalink to this definition">¶</a></dt>
<dd><p>This class provides a wrapper for the API as provided by
Twitter. The functions provided in this class are listed below.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>auth_handler</strong> – authentication handler to be used</li>
<li><strong>host</strong> – general API host</li>
<li><strong>search_host</strong> – search API host</li>
<li><strong>cache</strong> – cache backend to use</li>
<li><strong>api_root</strong> – general API path root</li>
<li><strong>search_root</strong> – search API path root</li>
<li><strong>retry_count</strong> – default number of retries to attempt when error occurs</li>
<li><strong>retry_delay</strong> – number of seconds to wait between retries</li>
<li><strong>retry_errors</strong> – which HTTP status codes to retry</li>
<li><strong>timeout</strong> – The maximum amount of time to wait for a response from Twitter</li>
<li><strong>parser</strong> – The object to use for parsing the response from Twitter</li>
<li><strong>compression</strong> – Whether or not to use GZIP compression for requests</li>
<li><strong>wait_on_rate_limit</strong> – Whether or not to automatically wait for rate limits to replenish</li>
<li><strong>wait_on_rate_limit_notify</strong> – Whether or not to print a notification when Tweepy is waiting for rate limits to replenish</li>
<li><strong>proxy</strong> – The full url to an HTTPS proxy to use for connecting to Twitter.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<div class="section" id="timeline-methods">
<h2>Timeline methods<a class="headerlink" href="#timeline-methods" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="API.home_timeline">
<code class="descclassname">API.</code><code class="descname">home_timeline</code><span class="sig-paren">(</span><span class="optional">[</span><em>since_id</em><span class="optional">]</span><span class="optional">[</span>, <em>max_id</em><span class="optional">]</span><span class="optional">[</span>, <em>count</em><span class="optional">]</span><span class="optional">[</span>, <em>page</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.home_timeline" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the 20 most recent statuses, including retweets, posted by the
authenticating user and that user’s friends. This is the equivalent of
/timeline/home on the Web.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>since_id</strong> – Returns only statuses with an ID greater than (that is, more recent than) the specified ID.</li>
<li><strong>max_id</strong> – Returns only statuses with an ID less than (that is, older than) or equal to the specified ID.</li>
<li><strong>count</strong> – Specifies the number of statuses to retrieve.</li>
<li><strong>page</strong> – Specifies the page of results to retrieve. Note: there are pagination limits.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of <code class="xref py py-class docutils literal"><span class="pre">Status</span></code> objects</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.statuses_lookup">
<code class="descclassname">API.</code><code class="descname">statuses_lookup</code><span class="sig-paren">(</span><em>id</em><span class="optional">[</span>, <em>include_entities</em><span class="optional">]</span><span class="optional">[</span>, <em>trim_user</em><span class="optional">]</span><span class="optional">[</span>, <em>map</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.statuses_lookup" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns full Tweet objects for up to 100 tweets per request, specified by the
<cite>id</cite> parameter.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>id</strong> – A list of Tweet IDs to lookup, up to 100</li>
<li><strong>include_entities</strong> – A boolean indicating whether or not to include [entities](<a class="reference external" href="https://dev.twitter.com/docs/entities">https://dev.twitter.com/docs/entities</a>) in the returned tweets. Defaults to False.</li>
<li><strong>trim_user</strong> – A boolean indicating if user IDs should be provided, instead of full user information. Defaults to False.</li>
<li><strong>map</strong> – A boolean indicating whether or not to include tweets that cannot be shown, but with a value of None. Defaults to False.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of <code class="xref py py-class docutils literal"><span class="pre">Status</span></code> objects</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.user_timeline">
<code class="descclassname">API.</code><code class="descname">user_timeline</code><span class="sig-paren">(</span><span class="optional">[</span><em>id/user_id/screen_name</em><span class="optional">]</span><span class="optional">[</span>, <em>since_id</em><span class="optional">]</span><span class="optional">[</span>, <em>max_id</em><span class="optional">]</span><span class="optional">[</span>, <em>count</em><span class="optional">]</span><span class="optional">[</span>, <em>page</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.user_timeline" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the 20 most recent statuses posted from the authenticating
user or the user specified. It’s also possible to request another user’s timeline via the id
parameter.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>id</strong> – Specifies the ID or screen name of the user.</li>
<li><strong>user_id</strong> – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.</li>
<li><strong>screen_name</strong> – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.</li>
<li><strong>since_id</strong> – Returns only statuses with an ID greater than (that is, more recent than) the specified ID.</li>
<li><strong>max_id</strong> – Returns only statuses with an ID less than (that is, older than) or equal to the specified ID.</li>
<li><strong>count</strong> – Specifies the number of statuses to retrieve.</li>
<li><strong>page</strong> – Specifies the page of results to retrieve. Note: there are pagination limits.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of <code class="xref py py-class docutils literal"><span class="pre">Status</span></code> objects</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.retweets_of_me">
<code class="descclassname">API.</code><code class="descname">retweets_of_me</code><span class="sig-paren">(</span><span class="optional">[</span><em>since_id</em><span class="optional">]</span><span class="optional">[</span>, <em>max_id</em><span class="optional">]</span><span class="optional">[</span>, <em>count</em><span class="optional">]</span><span class="optional">[</span>, <em>page</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.retweets_of_me" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the 20 most recent tweets of the authenticated user that have
been retweeted by others.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>since_id</strong> – Returns only statuses with an ID greater than (that is, more recent than) the specified ID.</li>
<li><strong>max_id</strong> – Returns only statuses with an ID less than (that is, older than) or equal to the specified ID.</li>
<li><strong>count</strong> – Specifies the number of statuses to retrieve.</li>
<li><strong>page</strong> – Specifies the page of results to retrieve. Note: there are pagination limits.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of <code class="xref py py-class docutils literal"><span class="pre">Status</span></code> objects</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="status-methods">
<h2>Status methods<a class="headerlink" href="#status-methods" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="API.get_status">
<code class="descclassname">API.</code><code class="descname">get_status</code><span class="sig-paren">(</span><em>id</em><span class="sig-paren">)</span><a class="headerlink" href="#API.get_status" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a single status specified by the ID parameter.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> – The numerical ID of the status.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">Status</span></code> object</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.update_status">
<code class="descclassname">API.</code><code class="descname">update_status</code><span class="sig-paren">(</span><em>status</em><span class="optional">[</span>, <em>in_reply_to_status_id</em><span class="optional">]</span><span class="optional">[</span>, <em>lat</em><span class="optional">]</span><span class="optional">[</span>, <em>long</em><span class="optional">]</span><span class="optional">[</span>, <em>source</em><span class="optional">]</span><span class="optional">[</span>, <em>place_id</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.update_status" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the authenticated user’s status. Statuses that are duplicates
or too long will be silently ignored.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>status</strong> – The text of your status update.</li>
<li><strong>in_reply_to_status_id</strong> – The ID of an existing status that the update is in reply to.</li>
<li><strong>lat</strong> – The location’s latitude that this tweet refers to.</li>
<li><strong>long</strong> – The location’s longitude that this tweet refers to.</li>
<li><strong>source</strong> – Source of the update. Only supported by Identi.ca. Twitter ignores this parameter.</li>
<li><strong>place_id</strong> – Twitter ID of location which is listed in the Tweet if geolocation is enabled for the user.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">Status</span></code> object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.update_with_media">
<code class="descclassname">API.</code><code class="descname">update_with_media</code><span class="sig-paren">(</span><em>filename</em><span class="optional">[</span>, <em>status</em><span class="optional">]</span><span class="optional">[</span>, <em>in_reply_to_status_id</em><span class="optional">]</span><span class="optional">[</span>, <em>lat</em><span class="optional">]</span><span class="optional">[</span>, <em>long</em><span class="optional">]</span><span class="optional">[</span>, <em>source</em><span class="optional">]</span><span class="optional">[</span>, <em>place_id</em><span class="optional">]</span><span class="optional">[</span>, <em>file</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.update_with_media" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the authenticated user’s status. Statuses that are duplicates
or too long will be silently ignored.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>filename</strong> – The filename of the image to upload. This will automatically be opened unless <cite>file</cite> is specified</li>
<li><strong>status</strong> – The text of your status update.</li>
<li><strong>in_reply_to_status_id</strong> – The ID of an existing status that the update is in reply to.</li>
<li><strong>lat</strong> – The location’s latitude that this tweet refers to.</li>
<li><strong>long</strong> – The location’s longitude that this tweet refers to.</li>
<li><strong>source</strong> – Source of the update. Only supported by Identi.ca. Twitter ignores this parameter.</li>
<li><strong>place_id</strong> – Twitter ID of location which is listed in the Tweet if geolocation is enabled for the user.</li>
<li><strong>file</strong> – A file object, which will be used instead of opening <cite>filename</cite>. <cite>filename</cite> is still required, for MIME type detection and to use as a form field in the POST data</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">Status</span></code> object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.destroy_status">
<code class="descclassname">API.</code><code class="descname">destroy_status</code><span class="sig-paren">(</span><em>id</em><span class="sig-paren">)</span><a class="headerlink" href="#API.destroy_status" title="Permalink to this definition">¶</a></dt>
<dd><p>Destroy the status specified by the id parameter. The authenticated
user must be the author of the status to destroy.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> – The numerical ID of the status.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">Status</span></code> object</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.retweet">
<code class="descclassname">API.</code><code class="descname">retweet</code><span class="sig-paren">(</span><em>id</em><span class="sig-paren">)</span><a class="headerlink" href="#API.retweet" title="Permalink to this definition">¶</a></dt>
<dd><p>Retweets a tweet. Requires the id of the tweet you are retweeting.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> – The numerical ID of the status.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">Status</span></code> object</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.retweets">
<code class="descclassname">API.</code><code class="descname">retweets</code><span class="sig-paren">(</span><em>id</em><span class="optional">[</span>, <em>count</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.retweets" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns up to 100 of the first retweets of the given tweet.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>id</strong> – The numerical ID of the status.</li>
<li><strong>count</strong> – Specifies the number of retweets to retrieve.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of <code class="xref py py-class docutils literal"><span class="pre">Status</span></code> objects</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="user-methods">
<h2>User methods<a class="headerlink" href="#user-methods" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="API.get_user">
<code class="descclassname">API.</code><code class="descname">get_user</code><span class="sig-paren">(</span><em>id/user_id/screen_name</em><span class="sig-paren">)</span><a class="headerlink" href="#API.get_user" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about the specified user.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>id</strong> – Specifies the ID or screen name of the user.</li>
<li><strong>user_id</strong> – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.</li>
<li><strong>screen_name</strong> – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">User</span></code> object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.me">
<code class="descclassname">API.</code><code class="descname">me</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#API.me" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the authenticated user’s information.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">User</span></code> object</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.followers">
<code class="descclassname">API.</code><code class="descname">followers</code><span class="sig-paren">(</span><span class="optional">[</span><em>id/screen_name/user_id</em><span class="optional">]</span><span class="optional">[</span>, <em>cursor</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.followers" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns an user’s followers ordered in which they were added 100 at a
time. If no user is specified by id/screen name, it defaults to the
authenticated user.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>id</strong> – Specifies the ID or screen name of the user.</li>
<li><strong>user_id</strong> – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.</li>
<li><strong>screen_name</strong> – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.</li>
<li><strong>cursor</strong> – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of <code class="xref py py-class docutils literal"><span class="pre">User</span></code> objects</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.search_users">
<code class="descclassname">API.</code><code class="descname">search_users</code><span class="sig-paren">(</span><em>q</em><span class="optional">[</span>, <em>per_page</em><span class="optional">]</span><span class="optional">[</span>, <em>page</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.search_users" title="Permalink to this definition">¶</a></dt>
<dd><p>Run a search for users similar to Find People button on Twitter.com;
the same results returned by people search on Twitter.com will be
returned by using this API (about being listed in the People
Search). It is only possible to retrieve the first 1000 matches from
this API.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>q</strong> – The query to run against people search.</li>
<li><strong>per_page</strong> – Specifies the number of statuses to retrieve. May not be greater than 20.</li>
<li><strong>page</strong> – Specifies the page of results to retrieve. Note: there are pagination limits.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of <code class="xref py py-class docutils literal"><span class="pre">User</span></code> objects</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="direct-message-methods">
<h2>Direct Message Methods<a class="headerlink" href="#direct-message-methods" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="API.direct_messages">
<code class="descclassname">API.</code><code class="descname">direct_messages</code><span class="sig-paren">(</span><span class="optional">[</span><em>since_id</em><span class="optional">]</span><span class="optional">[</span>, <em>max_id</em><span class="optional">]</span><span class="optional">[</span>, <em>count</em><span class="optional">]</span><span class="optional">[</span>, <em>page</em><span class="optional">]</span><span class="optional">[</span>, <em>full_text</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.direct_messages" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns direct messages sent to the authenticating user.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>since_id</strong> – Returns only statuses with an ID greater than (that is, more recent than) the specified ID.</li>
<li><strong>max_id</strong> – Returns only statuses with an ID less than (that is, older than) or equal to the specified ID.</li>
<li><strong>count</strong> – Specifies the number of statuses to retrieve.</li>
<li><strong>page</strong> – Specifies the page of results to retrieve. Note: there are pagination limits.</li>
<li><strong>full_text</strong> – A boolean indicating whether or not the full text of a message should be returned. If False the message text returned will be truncated to 140 chars. Defaults to False.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of <code class="xref py py-class docutils literal"><span class="pre">DirectMessage</span></code> objects</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.get_direct_message">
<code class="descclassname">API.</code><code class="descname">get_direct_message</code><span class="sig-paren">(</span><span class="optional">[</span><em>id</em><span class="optional">]</span><span class="optional">[</span>, <em>full_text</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.get_direct_message" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a specific direct message.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>id</strong> – <a href="#id10"><span class="problematic" id="id11">|id|</span></a></li>
<li><strong>full_text</strong> – A boolean indicating whether or not the full text of a message should be returned. If False the message text returned will be truncated to 140 chars. Defaults to False.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">DirectMessage</span></code> object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.sent_direct_messages">
<code class="descclassname">API.</code><code class="descname">sent_direct_messages</code><span class="sig-paren">(</span><span class="optional">[</span><em>since_id</em><span class="optional">]</span><span class="optional">[</span>, <em>max_id</em><span class="optional">]</span><span class="optional">[</span>, <em>count</em><span class="optional">]</span><span class="optional">[</span>, <em>page</em><span class="optional">]</span><span class="optional">[</span>, <em>full_text</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.sent_direct_messages" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns direct messages sent by the authenticating user.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>since_id</strong> – Returns only statuses with an ID greater than (that is, more recent than) the specified ID.</li>
<li><strong>max_id</strong> – Returns only statuses with an ID less than (that is, older than) or equal to the specified ID.</li>
<li><strong>count</strong> – Specifies the number of statuses to retrieve.</li>
<li><strong>page</strong> – Specifies the page of results to retrieve. Note: there are pagination limits.</li>
<li><strong>full_text</strong> – A boolean indicating whether or not the full text of a message should be returned. If False the message text returned will be truncated to 140 chars. Defaults to False.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of <code class="xref py py-class docutils literal"><span class="pre">DirectMessage</span></code> objects</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.send_direct_message">
<code class="descclassname">API.</code><code class="descname">send_direct_message</code><span class="sig-paren">(</span><em>user/screen_name/user_id</em>, <em>text</em><span class="sig-paren">)</span><a class="headerlink" href="#API.send_direct_message" title="Permalink to this definition">¶</a></dt>
<dd><p>Sends a new direct message to the specified user from the
authenticating user.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>user</strong> – The ID or screen name of the recipient user.</li>
<li><strong>screen_name</strong> – screen name of the recipient user</li>
<li><strong>user_id</strong> – user id of the recipient user</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">DirectMessage</span></code> object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.destroy_direct_message">
<code class="descclassname">API.</code><code class="descname">destroy_direct_message</code><span class="sig-paren">(</span><em>id</em><span class="sig-paren">)</span><a class="headerlink" href="#API.destroy_direct_message" title="Permalink to this definition">¶</a></dt>
<dd><p>Destroy a direct message. Authenticating user must be the recipient of
the direct message.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> – The ID of the direct message to destroy.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">DirectMessage</span></code> object</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="friendship-methods">
<h2>Friendship Methods<a class="headerlink" href="#friendship-methods" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="API.create_friendship">
<code class="descclassname">API.</code><code class="descname">create_friendship</code><span class="sig-paren">(</span><em>id/screen_name/user_id</em><span class="optional">[</span>, <em>follow</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.create_friendship" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new friendship with the specified user (aka follow).</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>id</strong> – Specifies the ID or screen name of the user.</li>
<li><strong>screen_name</strong> – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.</li>
<li><strong>user_id</strong> – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.</li>
<li><strong>follow</strong> – Enable notifications for the target user in addition to becoming friends.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">User</span></code> object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.destroy_friendship">
<code class="descclassname">API.</code><code class="descname">destroy_friendship</code><span class="sig-paren">(</span><em>id/screen_name/user_id</em><span class="sig-paren">)</span><a class="headerlink" href="#API.destroy_friendship" title="Permalink to this definition">¶</a></dt>
<dd><p>Destroy a friendship with the specified user (aka unfollow).</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>id</strong> – Specifies the ID or screen name of the user.</li>
<li><strong>screen_name</strong> – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.</li>
<li><strong>user_id</strong> – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">User</span></code> object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.exists_friendship">
<code class="descclassname">API.</code><code class="descname">exists_friendship</code><span class="sig-paren">(</span><em>user_a</em>, <em>user_b</em><span class="sig-paren">)</span><a class="headerlink" href="#API.exists_friendship" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks if a friendship exists between two users. Will return True if
user_a follows user_b, otherwise False.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>user_a</strong> – The ID or screen_name of the subject user.</li>
<li><strong>user_b</strong> – The ID or screen_name of the user to test for following.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">True/False</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.show_friendship">
<code class="descclassname">API.</code><code class="descname">show_friendship</code><span class="sig-paren">(</span><em>source_id/source_screen_name</em>, <em>target_id/target_screen_name</em><span class="sig-paren">)</span><a class="headerlink" href="#API.show_friendship" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns detailed information about the relationship between two users.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>source_id</strong> – The user_id of the subject user.</li>
<li><strong>source_screen_name</strong> – The screen_name of the subject user.</li>
<li><strong>target_id</strong> – The user_id of the target user.</li>
<li><strong>target_screen_name</strong> – The screen_name of the target user.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">Friendship</span></code> object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.friends_ids">
<code class="descclassname">API.</code><code class="descname">friends_ids</code><span class="sig-paren">(</span><em>id/screen_name/user_id</em><span class="optional">[</span>, <em>cursor</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.friends_ids" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns an array containing the IDs of users being followed by the
specified user.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>id</strong> – Specifies the ID or screen name of the user.</li>
<li><strong>screen_name</strong> – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.</li>
<li><strong>user_id</strong> – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.</li>
<li><strong>cursor</strong> – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of Integers</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.followers_ids">
<code class="descclassname">API.</code><code class="descname">followers_ids</code><span class="sig-paren">(</span><em>id/screen_name/user_id</em><span class="sig-paren">)</span><a class="headerlink" href="#API.followers_ids" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns an array containing the IDs of users following the specified
user.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>id</strong> – Specifies the ID or screen name of the user.</li>
<li><strong>screen_name</strong> – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.</li>
<li><strong>user_id</strong> – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.</li>
<li><strong>cursor</strong> – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of Integers</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="account-methods">
<h2>Account Methods<a class="headerlink" href="#account-methods" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="API.verify_credentials">
<code class="descclassname">API.</code><code class="descname">verify_credentials</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#API.verify_credentials" title="Permalink to this definition">¶</a></dt>
<dd><p>Verify the supplied user credentials are valid.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">User</span></code> object if credentials are valid, otherwise False</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.rate_limit_status">
<code class="descclassname">API.</code><code class="descname">rate_limit_status</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#API.rate_limit_status" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the remaining number of API requests available to the
requesting user before the API limit is reached for the current
hour. Calls to rate_limit_status do not count against the rate
limit. If authentication credentials are provided, the rate limit
status for the authenticating user is returned. Otherwise, the rate
limit status for the requester’s IP address is returned.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">JSON</span></code> object</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.set_delivery_device">
<code class="descclassname">API.</code><code class="descname">set_delivery_device</code><span class="sig-paren">(</span><em>device</em><span class="sig-paren">)</span><a class="headerlink" href="#API.set_delivery_device" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets which device Twitter delivers updates to for the authenticating
user. Sending “none” as the device parameter will disable SMS updates.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>device</strong> – Must be one of: sms, none</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">User</span></code> object</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.update_profile_colors">
<code class="descclassname">API.</code><code class="descname">update_profile_colors</code><span class="sig-paren">(</span><span class="optional">[</span><em>profile_background_color</em><span class="optional">]</span><span class="optional">[</span>, <em>profile_text_color</em><span class="optional">]</span><span class="optional">[</span>, <em>profile_link_color</em><span class="optional">]</span><span class="optional">[</span>, <em>profile_sidebar_fill_color</em><span class="optional">]</span><span class="optional">[</span>, <em>profile_sidebar_border_color</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.update_profile_colors" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets one or more hex values that control the color scheme of the
authenticating user’s profile page on twitter.com.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>profile_background_color</strong> – </li>
<li><strong>profile_text_color</strong> – </li>
<li><strong>profile_link_color</strong> – </li>
<li><strong>profile_sidebar_fill_color</strong> – </li>
<li><strong>profile_sidebar_border_color</strong> – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">User</span></code> object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.update_profile_image">
<code class="descclassname">API.</code><code class="descname">update_profile_image</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="headerlink" href="#API.update_profile_image" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the authenticating user’s profile image. Valid formats: GIF,
JPG, or PNG</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> – local path to image file to upload. Not a remote URL!</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">User</span></code> object</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.update_profile_background_image">
<code class="descclassname">API.</code><code class="descname">update_profile_background_image</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="headerlink" href="#API.update_profile_background_image" title="Permalink to this definition">¶</a></dt>
<dd><p>Update authenticating user’s background image. Valid formats: GIF,
JPG, or PNG</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> – local path to image file to upload. Not a remote URL!</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">User</span></code> object</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.update_profile">
<code class="descclassname">API.</code><code class="descname">update_profile</code><span class="sig-paren">(</span><span class="optional">[</span><em>name</em><span class="optional">]</span><span class="optional">[</span>, <em>url</em><span class="optional">]</span><span class="optional">[</span>, <em>location</em><span class="optional">]</span><span class="optional">[</span>, <em>description</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.update_profile" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets values that users are able to set under the “Account” tab of
their settings page.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> – Maximum of 20 characters</li>
<li><strong>url</strong> – Maximum of 100 characters. Will be prepended with “<a class="reference external" href="http://">http://</a>” if not present</li>
<li><strong>location</strong> – Maximum of 30 characters</li>
<li><strong>description</strong> – Maximum of 160 characters</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">User</span></code> object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="favorite-methods">
<h2>Favorite Methods<a class="headerlink" href="#favorite-methods" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="API.favorites">
<code class="descclassname">API.</code><code class="descname">favorites</code><span class="sig-paren">(</span><span class="optional">[</span><em>id</em><span class="optional">]</span><span class="optional">[</span>, <em>page</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.favorites" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the favorite statuses for the authenticating user or user
specified by the ID parameter.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>id</strong> – The ID or screen name of the user to request favorites</li>
<li><strong>page</strong> – Specifies the page of results to retrieve. Note: there are pagination limits.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of <code class="xref py py-class docutils literal"><span class="pre">Status</span></code> objects</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.create_favorite">
<code class="descclassname">API.</code><code class="descname">create_favorite</code><span class="sig-paren">(</span><em>id</em><span class="sig-paren">)</span><a class="headerlink" href="#API.create_favorite" title="Permalink to this definition">¶</a></dt>
<dd><p>Favorites the status specified in the ID parameter as the
authenticating user.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> – The numerical ID of the status.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">Status</span></code> object</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.destroy_favorite">
<code class="descclassname">API.</code><code class="descname">destroy_favorite</code><span class="sig-paren">(</span><em>id</em><span class="sig-paren">)</span><a class="headerlink" href="#API.destroy_favorite" title="Permalink to this definition">¶</a></dt>
<dd><p>Un-favorites the status specified in the ID parameter as the
authenticating user.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> – The numerical ID of the status.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">Status</span></code> object</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="block-methods">
<h2>Block Methods<a class="headerlink" href="#block-methods" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="API.create_block">
<code class="descclassname">API.</code><code class="descname">create_block</code><span class="sig-paren">(</span><em>id/screen_name/user_id</em><span class="sig-paren">)</span><a class="headerlink" href="#API.create_block" title="Permalink to this definition">¶</a></dt>
<dd><p>Blocks the user specified in the ID parameter as the authenticating
user. Destroys a friendship to the blocked user if it exists.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>id</strong> – Specifies the ID or screen name of the user.</li>
<li><strong>screen_name</strong> – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.</li>
<li><strong>user_id</strong> – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">User</span></code> object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.destroy_block">
<code class="descclassname">API.</code><code class="descname">destroy_block</code><span class="sig-paren">(</span><em>id/screen_name/user_id</em><span class="sig-paren">)</span><a class="headerlink" href="#API.destroy_block" title="Permalink to this definition">¶</a></dt>
<dd><p>Un-blocks the user specified in the ID parameter for the
authenticating user.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>id</strong> – Specifies the ID or screen name of the user.</li>
<li><strong>screen_name</strong> – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.</li>
<li><strong>user_id</strong> – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">User</span></code> object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.blocks">
<code class="descclassname">API.</code><code class="descname">blocks</code><span class="sig-paren">(</span><span class="optional">[</span><em>page</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.blocks" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns an array of user objects that the authenticating user is
blocking.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>page</strong> – Specifies the page of results to retrieve. Note: there are pagination limits.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">list of <code class="xref py py-class docutils literal"><span class="pre">User</span></code> objects</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.blocks_ids">
<code class="descclassname">API.</code><code class="descname">blocks_ids</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#API.blocks_ids" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns an array of numeric user ids the authenticating user is
blocking.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">list of Integers</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="spam-reporting-methods">
<h2>Spam Reporting Methods<a class="headerlink" href="#spam-reporting-methods" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="API.report_spam">
<code class="descclassname">API.</code><code class="descname">report_spam</code><span class="sig-paren">(</span><span class="optional">[</span><em>id/user_id/screen_name</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.report_spam" title="Permalink to this definition">¶</a></dt>
<dd><p>The user specified in the id is blocked by the authenticated user and
reported as a spammer.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>id</strong> – Specifies the ID or screen name of the user.</li>
<li><strong>screen_name</strong> – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.</li>
<li><strong>user_id</strong> – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">User</span></code> object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="saved-searches-methods">
<h2>Saved Searches Methods<a class="headerlink" href="#saved-searches-methods" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="API.saved_searches">
<code class="descclassname">API.</code><code class="descname">saved_searches</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#API.saved_searches" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the authenticated user’s saved search queries.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">list of <code class="xref py py-class docutils literal"><span class="pre">SavedSearch</span></code> objects</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.get_saved_search">
<code class="descclassname">API.</code><code class="descname">get_saved_search</code><span class="sig-paren">(</span><em>id</em><span class="sig-paren">)</span><a class="headerlink" href="#API.get_saved_search" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve the data for a saved search owned by the authenticating user
specified by the given id.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> – The id of the saved search to be retrieved.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">SavedSearch</span></code> object</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.create_saved_search">
<code class="descclassname">API.</code><code class="descname">create_saved_search</code><span class="sig-paren">(</span><em>query</em><span class="sig-paren">)</span><a class="headerlink" href="#API.create_saved_search" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a saved search for the authenticated user.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>query</strong> – The query of the search the user would like to save.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">SavedSearch</span></code> object</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.destroy_saved_search">
<code class="descclassname">API.</code><code class="descname">destroy_saved_search</code><span class="sig-paren">(</span><em>id</em><span class="sig-paren">)</span><a class="headerlink" href="#API.destroy_saved_search" title="Permalink to this definition">¶</a></dt>
<dd><p>Destroys a saved search for the authenticated user. The search
specified by id must be owned by the authenticating user.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> – The id of the saved search to be deleted.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">SavedSearch</span></code> object</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="help-methods">
<h2>Help Methods<a class="headerlink" href="#help-methods" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="API.search">
<code class="descclassname">API.</code><code class="descname">search</code><span class="sig-paren">(</span><em>q</em><span class="optional">[</span>, <em>lang</em><span class="optional">]</span><span class="optional">[</span>, <em>locale</em><span class="optional">]</span><span class="optional">[</span>, <em>rpp</em><span class="optional">]</span><span class="optional">[</span>, <em>page</em><span class="optional">]</span><span class="optional">[</span>, <em>since_id</em><span class="optional">]</span><span class="optional">[</span>, <em>geocode</em><span class="optional">]</span><span class="optional">[</span>, <em>show_user</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.search" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns tweets that match a specified query.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>q</strong> – the search query string</li>
<li><strong>lang</strong> – Restricts tweets to the given language, given by an ISO 639-1 code.</li>
<li><strong>locale</strong> – Specify the language of the query you are sending. This is intended for language-specific clients and the default should work in the majority of cases.</li>
<li><strong>rpp</strong> – The number of tweets to return per page, up to a max of 100.</li>
<li><strong>page</strong> – The page number (starting at 1) to return, up to a max of roughly 1500 results (based on rpp * page.</li>
<li><strong>since_id</strong> – Returns only statuses with an ID greater than (that is, more recent than) the specified ID.</li>
<li><strong>geocode</strong> – Returns tweets by users located within a given radius of the given latitude/longitude. The location is preferentially taking from the Geotagging API, but will fall back to 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.</li>
<li><strong>show_user</strong> – 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.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of <code class="xref py py-class docutils literal"><span class="pre">SearchResult</span></code> objects</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="list-methods">
<h2>List Methods<a class="headerlink" href="#list-methods" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="API.create_list">
<code class="descclassname">API.</code><code class="descname">create_list</code><span class="sig-paren">(</span><em>name</em><span class="optional">[</span>, <em>mode</em><span class="optional">]</span><span class="optional">[</span>, <em>description</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.create_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a new list for the authenticated user. Accounts are limited to
20 lists.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> – The name of the new list.</li>
<li><strong>mode</strong> – Whether your list is public or private. Values can be public or private. Lists are public by default if no mode is specified.</li>
<li><strong>description</strong> – The description of the list you are creating.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">List</span></code> object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.destroy_list">
<code class="descclassname">API.</code><code class="descname">destroy_list</code><span class="sig-paren">(</span><em>slug</em><span class="sig-paren">)</span><a class="headerlink" href="#API.destroy_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes the specified list. Must be owned by the authenticated user.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>slug</strong> – the slug name or numerical ID of the list</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">List</span></code> object</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.update_list">
<code class="descclassname">API.</code><code class="descname">update_list</code><span class="sig-paren">(</span><em>slug</em><span class="optional">[</span>, <em>name</em><span class="optional">]</span><span class="optional">[</span>, <em>mode</em><span class="optional">]</span><span class="optional">[</span>, <em>description</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.update_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the specified list. Note: this current throws a 500. Twitter
is looking into the issue.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>slug</strong> – the slug name or numerical ID of the list</li>
<li><strong>name</strong> – What you’d like to change the lists name to.</li>
<li><strong>mode</strong> – Whether your list is public or private. Values can be public or private. Lists are public by default if no mode is specified.</li>
<li><strong>description</strong> – What you’d like to change the list description to.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">List</span></code> object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.lists">
<code class="descclassname">API.</code><code class="descname">lists</code><span class="sig-paren">(</span><span class="optional">[</span><em>cursor</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.lists" title="Permalink to this definition">¶</a></dt>
<dd><p>List the lists of the specified user. Private lists will be included
if the authenticated users is the same as the user who’s lists are
being returned.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cursor</strong> – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">list of <code class="xref py py-class docutils literal"><span class="pre">List</span></code> objects</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.lists_memberships">
<code class="descclassname">API.</code><code class="descname">lists_memberships</code><span class="sig-paren">(</span><span class="optional">[</span><em>cursor</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.lists_memberships" title="Permalink to this definition">¶</a></dt>
<dd><p>List the lists the specified user has been added to.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cursor</strong> – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">list of <code class="xref py py-class docutils literal"><span class="pre">List</span></code> objects</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.lists_subscriptions">
<code class="descclassname">API.</code><code class="descname">lists_subscriptions</code><span class="sig-paren">(</span><span class="optional">[</span><em>cursor</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.lists_subscriptions" title="Permalink to this definition">¶</a></dt>
<dd><p>List the lists the specified user follows.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cursor</strong> – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">list of <code class="xref py py-class docutils literal"><span class="pre">List</span></code> objects</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.list_timeline">
<code class="descclassname">API.</code><code class="descname">list_timeline</code><span class="sig-paren">(</span><em>owner</em>, <em>slug</em><span class="optional">[</span>, <em>since_id</em><span class="optional">]</span><span class="optional">[</span>, <em>max_id</em><span class="optional">]</span><span class="optional">[</span>, <em>per_page</em><span class="optional">]</span><span class="optional">[</span>, <em>page</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.list_timeline" title="Permalink to this definition">¶</a></dt>
<dd><p>Show tweet timeline for members of the specified list.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>owner</strong> – the screen name of the owner of the list</li>
<li><strong>slug</strong> – the slug name or numerical ID of the list</li>
<li><strong>since_id</strong> – Returns only statuses with an ID greater than (that is, more recent than) the specified ID.</li>
<li><strong>max_id</strong> – Returns only statuses with an ID less than (that is, older than) or equal to the specified ID.</li>
<li><strong>per_page</strong> – Number of results per a page</li>
<li><strong>page</strong> – Specifies the page of results to retrieve. Note: there are pagination limits.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of <code class="xref py py-class docutils literal"><span class="pre">Status</span></code> objects</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.get_list">
<code class="descclassname">API.</code><code class="descname">get_list</code><span class="sig-paren">(</span><em>owner</em>, <em>slug</em><span class="sig-paren">)</span><a class="headerlink" href="#API.get_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Show the specified list. Private lists will only be shown if the
authenticated user owns the specified list.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>owner</strong> – the screen name of the owner of the list</li>
<li><strong>slug</strong> – the slug name or numerical ID of the list</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">List</span></code> object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.add_list_member">
<code class="descclassname">API.</code><code class="descname">add_list_member</code><span class="sig-paren">(</span><em>slug</em>, <em>id</em><span class="sig-paren">)</span><a class="headerlink" href="#API.add_list_member" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a member to a list. The authenticated user must own the list to be
able to add members to it. Lists are limited to having 500 members.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>slug</strong> – the slug name or numerical ID of the list</li>
<li><strong>id</strong> – the ID of the user to add as a member</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">List</span></code> object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.remove_list_member">
<code class="descclassname">API.</code><code class="descname">remove_list_member</code><span class="sig-paren">(</span><em>slug</em>, <em>id</em><span class="sig-paren">)</span><a class="headerlink" href="#API.remove_list_member" title="Permalink to this definition">¶</a></dt>
<dd><p>Removes the specified member from the list. The authenticated user
must be the list’s owner to remove members from the list.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>slug</strong> – the slug name or numerical ID of the list</li>
<li><strong>id</strong> – the ID of the user to remove as a member</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">List</span></code> object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.list_members">
<code class="descclassname">API.</code><code class="descname">list_members</code><span class="sig-paren">(</span><em>owner</em>, <em>slug</em>, <em>cursor</em><span class="sig-paren">)</span><a class="headerlink" href="#API.list_members" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the members of the specified list.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>owner</strong> – the screen name of the owner of the list</li>
<li><strong>slug</strong> – the slug name or numerical ID of the list</li>
<li><strong>cursor</strong> – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of <code class="xref py py-class docutils literal"><span class="pre">User</span></code> objects</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.is_list_member">
<code class="descclassname">API.</code><code class="descname">is_list_member</code><span class="sig-paren">(</span><em>owner</em>, <em>slug</em>, <em>id</em><span class="sig-paren">)</span><a class="headerlink" href="#API.is_list_member" title="Permalink to this definition">¶</a></dt>
<dd><p>Check if a user is a member of the specified list.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>owner</strong> – the screen name of the owner of the list</li>
<li><strong>slug</strong> – the slug name or numerical ID of the list</li>
<li><strong>id</strong> – the ID of the user to check</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">User</span></code> object if user is a member of list, otherwise False.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.subscribe_list">
<code class="descclassname">API.</code><code class="descname">subscribe_list</code><span class="sig-paren">(</span><em>owner</em>, <em>slug</em><span class="sig-paren">)</span><a class="headerlink" href="#API.subscribe_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Make the authenticated user follow the specified list.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>owner</strong> – the screen name of the owner of the list</li>
<li><strong>slug</strong> – the slug name or numerical ID of the list</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">List</span></code> object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.unsubscribe_list">
<code class="descclassname">API.</code><code class="descname">unsubscribe_list</code><span class="sig-paren">(</span><em>owner</em>, <em>slug</em><span class="sig-paren">)</span><a class="headerlink" href="#API.unsubscribe_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Unsubscribes the authenticated user form the specified list.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>owner</strong> – the screen name of the owner of the list</li>
<li><strong>slug</strong> – the slug name or numerical ID of the list</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">List</span></code> object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.list_subscribers">
<code class="descclassname">API.</code><code class="descname">list_subscribers</code><span class="sig-paren">(</span><em>owner</em>, <em>slug</em><span class="optional">[</span>, <em>cursor</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.list_subscribers" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the subscribers of the specified list.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>owner</strong> – the screen name of the owner of the list</li>
<li><strong>slug</strong> – the slug name or numerical ID of the list</li>
<li><strong>cursor</strong> – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of <code class="xref py py-class docutils literal"><span class="pre">User</span></code> objects</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.is_subscribed_list">
<code class="descclassname">API.</code><code class="descname">is_subscribed_list</code><span class="sig-paren">(</span><em>owner</em>, <em>slug</em>, <em>id</em><span class="sig-paren">)</span><a class="headerlink" href="#API.is_subscribed_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Check if the specified user is a subscriber of the specified list.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>owner</strong> – the screen name of the owner of the list</li>
<li><strong>slug</strong> – the slug name or numerical ID of the list</li>
<li><strong>id</strong> – the ID of the user to check</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">User</span></code> object if user is subscribed to the list, otherwise False.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="trends-methods">
<h2>Trends Methods<a class="headerlink" href="#trends-methods" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="API.trends_available">
<code class="descclassname">API.</code><code class="descname">trends_available</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#API.trends_available" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the locations that Twitter has trending topic information for. The response is an array of “locations” that encode the location’s WOEID (a Yahoo! Where On Earth ID) and some other human-readable information such as a canonical name and country the location belongs in.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">JSON</span></code> object</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.trends_place">
<code class="descclassname">API.</code><code class="descname">trends_place</code><span class="sig-paren">(</span><em>id</em><span class="optional">[</span>, <em>exclude</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.trends_place" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the top 10 trending topics for a specific WOEID, if trending information is available for it.</p>
<p>The response is an array of “trend” objects that encode the name of the trending topic, the query parameter that can be used to search for the topic on Twitter Search, and the Twitter Search URL.</p>
<p>This information is cached for 5 minutes. Requesting more frequently than that will not return any more data, and will count against your rate limit usage.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>id</strong> – The Yahoo! Where On Earth ID of the location to return trending information for. Global information is available by using 1 as the WOEID.</li>
<li><strong>exclude</strong> – Setting this equal to hashtags will remove all hashtags from the trends list.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">JSON</span></code> object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.trends_closest">
<code class="descclassname">API.</code><code class="descname">trends_closest</code><span class="sig-paren">(</span><em>lat</em>, <em>long</em><span class="sig-paren">)</span><a class="headerlink" href="#API.trends_closest" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the locations that Twitter has trending topic information for, closest to a specified location.</p>
<p>The response is an array of “locations” that encode the location’s WOEID and some other human-readable information such as a canonical name and country the location belongs in.</p>
<p>A WOEID is a Yahoo! Where On Earth ID.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>lat</strong> – If provided with a long parameter the available trend locations will be sorted by distance, nearest to furthest, to the co-ordinate pair. The valid ranges for longitude is -180.0 to +180.0 (West is negative, East is positive) inclusive.</li>
<li><strong>long</strong> – If provided with a lat parameter the available trend locations will be sorted by distance, nearest to furthest, to the co-ordinate pair. The valid ranges for longitude is -180.0 to +180.0 (West is negative, East is positive) inclusive.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">JSON</span></code> object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="geo-methods">
<h2>Geo Methods<a class="headerlink" href="#geo-methods" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="API.reverse_geocode">
<code class="descclassname">API.</code><code class="descname">reverse_geocode</code><span class="sig-paren">(</span><span class="optional">[</span><em>lat</em><span class="optional">]</span><span class="optional">[</span>, <em>long</em><span class="optional">]</span><span class="optional">[</span>, <em>accuracy</em><span class="optional">]</span><span class="optional">[</span>, <em>granularity</em><span class="optional">]</span><span class="optional">[</span>, <em>max_results</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#API.reverse_geocode" title="Permalink to this definition">¶</a></dt>
<dd><p>Given a latitude and longitude, looks for places (cities and
neighbourhoods) whose IDs can be specified in a call to
<a class="reference internal" href="#API.update_status" title="API.update_status"><code class="xref py py-func docutils literal"><span class="pre">update_status()</span></code></a> to appear as the name of the location. This
call provides a detailed response about the location in question;
the <code class="xref py py-func docutils literal"><span class="pre">nearby_places()</span></code> function should be preferred for getting
a list of places nearby without great detail.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>lat</strong> – The location’s latitude.</li>
<li><strong>long</strong> – The location’s longitude.</li>
<li><strong>accuracy</strong> – Specify the “region” in which to search, such as a number (then this is a radius in meters, but it can also take a string that is suffixed with ft to specify feet). If this is not passed in, then it is assumed to be 0m</li>
<li><strong>granularity</strong> – Assumed to be <a href="#id2"><span class="problematic" id="id3">`</span></a>neighborhood’ by default; can also be <a href="#id4"><span class="problematic" id="id5">`</span></a>city’.</li>
<li><strong>max_results</strong> – A hint as to the maximum number of results to return. This is only a guideline, which may not be adhered to.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt>
<code class="descclassname">API.</code><code class="descname">reverse_geocode</code><span class="sig-paren">(</span><span class="optional">[</span><em>lat</em><span class="optional">]</span><span class="optional">[</span>, <em>long</em><span class="optional">]</span><span class="optional">[</span>, <em>ip</em><span class="optional">]</span><span class="optional">[</span>, <em>accuracy</em><span class="optional">]</span><span class="optional">[</span>, <em>granularity</em><span class="optional">]</span><span class="optional">[</span>, <em>max_results</em><span class="optional">]</span><span class="sig-paren">)</span></dt>
<dd><p>Given a latitude and longitude, looks for nearby places (cities and
neighbourhoods) whose IDs can be specified in a call to
<a class="reference internal" href="#API.update_status" title="API.update_status"><code class="xref py py-func docutils literal"><span class="pre">update_status()</span></code></a> to appear as the name of the location. This
call provides a detailed response about the location in question;
the <code class="xref py py-func docutils literal"><span class="pre">nearby_places()</span></code> function should be preferred for getting
a list of places nearby without great detail.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>lat</strong> – The location’s latitude.</li>
<li><strong>long</strong> – The location’s longitude.</li>
<li><strong>ip</strong> – The location’s IP address. Twitter will attempt to geolocate using the IP address.</li>
<li><strong>accuracy</strong> – Specify the “region” in which to search, such as a number (then this is a radius in meters, but it can also take a string that is suffixed with ft to specify feet). If this is not passed in, then it is assumed to be 0m</li>
<li><strong>granularity</strong> – Assumed to be <a href="#id6"><span class="problematic" id="id7">`</span></a>neighborhood’ by default; can also be <a href="#id8"><span class="problematic" id="id9">`</span></a>city’.</li>
<li><strong>max_results</strong> – A hint as to the maximum number of results to return. This is only a guideline, which may not be adhered to.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="API.geo_id">
<code class="descclassname">API.</code><code class="descname">geo_id</code><span class="sig-paren">(</span><em>id</em><span class="sig-paren">)</span><a class="headerlink" href="#API.geo_id" title="Permalink to this definition">¶</a></dt>
<dd><p>Given <em>id</em> of a place, provide more details about that place.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> – Valid Twitter ID of a location.</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
</div>
<div class="section" id="tweepy-error-exceptions">
<h1><code class="xref py py-mod docutils literal"><span class="pre">tweepy.error</span></code> — Exceptions<a class="headerlink" href="#tweepy-error-exceptions" title="Permalink to this headline">¶</a></h1>
<p>The exceptions are available in the <code class="docutils literal"><span class="pre">tweepy</span></code> module directly,
which means <code class="docutils literal"><span class="pre">tweepy.error</span></code> itself does not need to be imported. For
example, <code class="docutils literal"><span class="pre">tweepy.error.TweepError</span></code> is available as <code class="docutils literal"><span class="pre">tweepy.TweepError</span></code>.</p>
<dl class="exception">
<dt id="TweepError">
<em class="property">exception </em><code class="descname">TweepError</code><a class="headerlink" href="#TweepError" title="Permalink to this definition">¶</a></dt>
<dd><p>The main exception Tweepy uses. Is raised for a number of things.</p>
<p>When a <code class="docutils literal"><span class="pre">TweepError</span></code> is raised due to an error Twitter responded with,
the error code (<a class="reference external" href="https://dev.twitter.com/overview/api/response-codes">as described in the API documentation</a>) can be accessed
at <code class="docutils literal"><span class="pre">TweepError.message[0]['code']</span></code>. Note, however, that <code class="docutils literal"><span class="pre">TweepError</span></code>s
also may be raised with other things as message (for example plain
error reason strings).</p>
</dd></dl>
<dl class="exception">
<dt id="RateLimitError">
<em class="property">exception </em><code class="descname">RateLimitError</code><a class="headerlink" href="#RateLimitError" title="Permalink to this definition">¶</a></dt>
<dd><p>Is raised when an API method fails due to hitting Twitter’s rate
limit. Makes for easy handling of the rate limit specifically.</p>
<p>Inherits from <a class="reference internal" href="#TweepError" title="TweepError"><code class="xref py py-exc docutils literal"><span class="pre">TweepError</span></code></a>, so <code class="docutils literal"><span class="pre">except</span> <span class="pre">TweepError</span></code> will
catch a <code class="docutils literal"><span class="pre">RateLimitError</span></code> too.</p>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">API Reference</a></li>
<li><a class="reference internal" href="#tweepy-api-twitter-api-wrapper"><code class="docutils literal"><span class="pre">tweepy.api</span></code> — Twitter API wrapper</a><ul>
<li><a class="reference internal" href="#timeline-methods">Timeline methods</a></li>
<li><a class="reference internal" href="#status-methods">Status methods</a></li>
<li><a class="reference internal" href="#user-methods">User methods</a></li>
<li><a class="reference internal" href="#direct-message-methods">Direct Message Methods</a></li>
<li><a class="reference internal" href="#friendship-methods">Friendship Methods</a></li>
<li><a class="reference internal" href="#account-methods">Account Methods</a></li>
<li><a class="reference internal" href="#favorite-methods">Favorite Methods</a></li>
<li><a class="reference internal" href="#block-methods">Block Methods</a></li>
<li><a class="reference internal" href="#spam-reporting-methods">Spam Reporting Methods</a></li>
<li><a class="reference internal" href="#saved-searches-methods">Saved Searches Methods</a></li>
<li><a class="reference internal" href="#help-methods">Help Methods</a></li>
<li><a class="reference internal" href="#list-methods">List Methods</a></li>
<li><a class="reference internal" href="#trends-methods">Trends Methods</a></li>
<li><a class="reference internal" href="#geo-methods">Geo Methods</a></li>
</ul>
</li>
<li><a class="reference internal" href="#tweepy-error-exceptions"><code class="docutils literal"><span class="pre">tweepy.error</span></code> — Exceptions</a></li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="cursor_tutorial.html"
title="previous chapter">Cursor Tutorial</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="streaming_how_to.html"
title="next chapter">Streaming With Tweepy</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/api.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="streaming_how_to.html" title="Streaming With Tweepy"
>next</a> |</li>
<li class="right" >
<a href="cursor_tutorial.html" title="Cursor Tutorial"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">tweepy 3.5.0 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2009, Joshua Roesslein.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.5.
</div>
</body>
</html>
|