github.com/apremalal/vamps-core@v1.0.1-0.20161221121535-d430b56ec174/server/webapps/apieditor/spec-files/twitter.yaml (about) 1 swagger: "2.0" 2 3 ################################################################################ 4 # API Information # 5 ################################################################################ 6 info: 7 version: "1.1" 8 title: Twitter REST API 9 # during dev, should point to your local machine 10 host: api.twitter.com 11 # basePath prefixes all resource paths 12 basePath: /1.1 13 # 14 schemes: 15 # tip: remove http to make production-grade 16 - http 17 - https 18 # format of bodies a client can send (Content-Type) 19 consumes: 20 - application/json 21 # format of the responses to the client (Accepts) 22 produces: 23 - application/json 24 25 ################################################################################ 26 # Security # 27 ################################################################################ 28 securityDefinitions: 29 oauth: 30 type: oauth2 31 flow: implicit 32 authorizationUrl: https://twitter.com/oauth/authorize/?client_id=CLIENT-ID&redirect_uri=REDIRECT-URI&response_type=token 33 scopes: 34 basic: | 35 to read any and all data related to twitter 36 security: 37 - oauth: 38 - basic 39 40 ################################################################################ 41 # Paths # 42 ################################################################################ 43 paths: 44 /statuses/mentions_timeline: 45 get: 46 description: Returns the 20 most recent mentions for the authenticating user 47 security: 48 - oauth: 49 - basic 50 parameters: 51 - name: count 52 in: query 53 description: Specifies the number of tweets to try and retrieve 54 required: false 55 type: string 56 - name: since_id 57 in: query 58 description: Returns result with an ID greater than the specified ID 59 required: false 60 type: string 61 - name: max_id 62 in: query 63 description: Returns results with an ID less than or equal to the specified ID 64 required: false 65 type: string 66 - name: trim_user 67 in: query 68 description: When set to either true, t or 1, each tweet returned in a timeline will include a user object 69 required: false 70 type: string 71 - name: contributor_details 72 in: query 73 description: This parameter enhances the contributors element of the status response 74 required: false 75 type: string 76 - name: include_entities 77 in: query 78 description: The entities node will be disincluded when set to false 79 required: false 80 type: string 81 responses: 82 "200": 83 description: Success 84 schema: 85 type: array 86 items: 87 $ref: '#/definitions/Tweets' 88 89 /statuses/user_timeline: 90 get: 91 description: Returns a collection of the most recent Tweets posted by the User 92 security: 93 - oauth: 94 - basic 95 parameters: 96 - name: count 97 in: query 98 description: Specifies the number of tweets to try and retrieve 99 required: false 100 type: string 101 - name: since_id 102 in: query 103 description: Returns result with an ID greater than the specified ID 104 required: false 105 type: string 106 - name: max_id 107 in: query 108 description: Returns results with an ID less than or equal to the specified ID 109 required: false 110 type: string 111 - name: trim_user 112 in: query 113 description: When set to either true, t or 1, each tweet returned in a timeline will include a user object 114 required: false 115 type: string 116 - name: exclude_replies 117 in: query 118 description: This paramters will prevent from appearing in the returned timeline 119 required: false 120 type: boolean 121 - name: contributor_details 122 in: query 123 description: This paramters enhances the contributors element of the status response to include the screen_name of the contributor 124 required: false 125 type: boolean 126 - name: include_rts 127 in: query 128 description: When set to false, the timeline will strip any native retweet 129 required: false 130 type: boolean 131 responses: 132 "200": 133 description: Success 134 schema: 135 type: array 136 items: 137 $ref: '#/definitions/Tweets' 138 139 /statuses/home_timeline: 140 get: 141 description: Returns a collection of the most recent Tweets 142 security: 143 - oauth: 144 - basic 145 parameters: 146 - name: since_id 147 in: query 148 description: Returns result with an ID greater than the specified ID 149 required: false 150 type: string 151 - name: max_id 152 in: query 153 description: Returns results with an ID less than or equal to the specified ID 154 required: false 155 type: string 156 - name: trim_user 157 in: query 158 description: When set to either true, t or 1, each tweet returned in a timeline will include a user object 159 required: false 160 type: string 161 - name: exclude_replies 162 in: query 163 description: This paramters will prevent from appearing in the returned timeline 164 required: false 165 type: boolean 166 - name: contributor_details 167 in: query 168 description: This paramters enhances the contributors element of the status response to include the screen_name of the contributor 169 required: false 170 type: boolean 171 responses: 172 "200": 173 description: Success 174 schema: 175 type: array 176 items: 177 $ref: '#/definitions/Tweets' 178 179 /statuses/retweets/{id}: 180 get: 181 description: Retruns a collection of the 100 most recent retweets of the tweet specified by the id 182 security: 183 - oauth: 184 - basic 185 parameters: 186 - name: id 187 in: path 188 description: The numerical ID of the desired status 189 required: true 190 type: string 191 - name: count 192 in: query 193 description: Specifies the number of tweets to try and retrieve 194 required: false 195 type: string 196 - name: trim_user 197 in: query 198 description: When set to either true, t or 1, each tweet returned in a timeline will include a user object 199 required: false 200 type: string 201 responses: 202 "200": 203 description: Success 204 schema: 205 type: array 206 items: 207 $ref: '#/definitions/Tweets' 208 209 /statuses/show/{id}: 210 get: 211 description: Retruns a single Tweet 212 security: 213 - oauth: 214 - basic 215 parameters: 216 - name: id 217 in: path 218 description: The numerical ID of the desired status 219 required: true 220 type: string 221 - name: trim_user 222 in: query 223 description: When set to either true, t or 1, each tweet returned in a timeline will include a user object 224 required: false 225 type: string 226 - name: include_my_retweet 227 in: query 228 description: When set to either true, t or 1, any Tweets returned that have been retweeted by the authenticating 229 required: true 230 type: string 231 - name: include_entities 232 type: string 233 in: query 234 description: The entities node will be disincluded when set to false 235 required: false 236 responses: 237 "200": 238 description: Success 239 schema: 240 $ref: '#/definitions/Tweets' 241 242 /statuses/destroy/{id}: 243 post: 244 description: Destroys the status specified by the required ID parameter 245 security: 246 - oauth: 247 - basic 248 parameters: 249 - name: id 250 in: path 251 description: The numerical ID of the desired status 252 required: true 253 type: string 254 - name: trim_user 255 in: query 256 description: When set to either true, t or 1, each tweet returned in a timeline will include a user object 257 required: false 258 type: string 259 responses: 260 "200": 261 description: Success 262 schema: 263 $ref: '#/definitions/Tweets' 264 265 /statuses/update: 266 post: 267 description: Updates the authenticating user's status 268 security: 269 - oauth: 270 - basic 271 parameters: 272 - name: status 273 in: query 274 description: The text of your status update 275 required: true 276 type: string 277 - name: in_reply_to_status_id 278 in: query 279 description: The ID of an existing status 280 required: false 281 type: string 282 - name: lat 283 in: query 284 description: The latitude of the location 285 required: false 286 type: string 287 - name: long 288 in: query 289 description: The longitude of the location 290 required: false 291 type: string 292 - name: place_id 293 in: query 294 description: A place in the world 295 required: false 296 type: string 297 - name: display_coordinates 298 in: query 299 description: Whether or not to put a pin on the exact coordinates a tweet 300 required: false 301 type: string 302 - name: trim_user 303 in: query 304 description: When set to either true, t or 1, each tweet returned in a timeline will include a user object 305 required: false 306 type: string 307 responses: 308 "200": 309 description: Success 310 schema: 311 $ref: '#/definitions/Tweets' 312 "403": 313 description: Error 314 315 /statuses/retweets/{id}: 316 post: 317 description: Retweens a tweet 318 security: 319 - oauth: 320 - basic 321 parameters: 322 - name: id 323 in: path 324 description: The numerical ID of the desired status 325 required: true 326 type: string 327 - name: trim_user 328 in: query 329 description: When set to either true, t or 1, each tweet returned in a timeline will include a user object 330 required: false 331 type: string 332 responses: 333 "200": 334 description: Success 335 schema: 336 $ref: '#/definitions/Tweets' 337 338 /statuses/oembed: 339 get: 340 description: Returns information allowing the creation of an embedded representation 341 security: 342 - oauth: 343 - basic 344 parameters: 345 - name: id 346 in: query 347 description: The tweet/status id to return embed code for 348 required: true 349 type: string 350 - name: url 351 in: query 352 description: The encoded URL of the Tweet status to be embedded 353 required: true 354 type: string 355 - name: maxwidth 356 in: query 357 description: The maximum width in pixels that the embed should be rendered at 358 required: false 359 type: string 360 - name: hide_media 361 in: query 362 description: Specifies whether the embedded tweet should automatically show the original message in the case that the embedded Tweet is a reply 363 required: false 364 type: string 365 - name: hide_thread 366 in: query 367 description: Specifies whether the embedded Tweet html should include a 'script' element pointing to widgets.js 368 required: false 369 type: string 370 - name: align 371 in: query 372 description: Specifies whether the embedded Tweet should be left aligned 373 required: false 374 type: string 375 - name: related 376 in: query 377 description: A value for the TWT related parameters 378 required: false 379 type: string 380 - name: lang 381 in: query 382 description: Languages code for the rendered embed 383 required: false 384 type: string 385 responses: 386 "200": 387 description: Success 388 schema: 389 $ref: '#/definitions/Tweets' 390 391 /lists/list: 392 get: 393 description: Return all lists the authenticating or specified user subscribes to, including their own. 394 security: 395 - oauth: 396 - basic 397 parameters: 398 - name: screen_name 399 in: query 400 description: The screen name of the user for whom to return results for 401 required: true 402 type: string 403 - name: user_id 404 in: query 405 description: The ID of the user for whom to return results for 406 required: true 407 type: string 408 responses: 409 "200": 410 description: Success 411 schema: 412 type: array 413 items: 414 $ref: '#/definitions/Lists' 415 416 /lists/statuses: 417 get: 418 description: Returns a timeline of tweets authored by memebers of the specified list 419 security: 420 - oauth: 421 - basic 422 parameters: 423 - name: list_id 424 in: query 425 description: The numerical id of the list 426 required: true 427 type: string 428 - name: slug 429 in: query 430 description: You can identify a list by its slug instead of its numerical id 431 required: true 432 type: string 433 - name: owner_screen_name 434 in: query 435 description: The screen name of the user who owns the list being requested by a slug 436 required: false 437 type: string 438 - name: owner_id 439 in: query 440 description: The user ID of the user who owns the list being requested by a slug 441 required: false 442 type: string 443 - name: since_id 444 in: query 445 description: Returns results with an ID greater than the sepcified ID 446 required: false 447 type: string 448 - name: max_id 449 in: query 450 description: Returns results with an ID less than or equal to the specified ID 451 required: false 452 type: string 453 - name: count 454 in: query 455 description: Specifies the number of results to retrieve per page 456 required: false 457 type: string 458 - name: include_entities 459 in: query 460 description: Entities are ON by default 461 required: false 462 type: string 463 - name: include_rts 464 in: query 465 description: When set to either true, t or 1, the list timeline will contain native retweets in addition to the standard stream of tweets 466 required: false 467 type: string 468 responses: 469 "200": 470 description: Success 471 schema: 472 type: array 473 items: 474 $ref: '#/definitions/Tweets' 475 476 /lists/members/destroy: 477 get: 478 description: Returns the list of memebers destroy 479 security: 480 - oauth: 481 - basic 482 parameters: 483 - name: list_id 484 in: query 485 description: The numerical id of the list 486 required: true 487 type: string 488 - name: slug 489 in: query 490 description: You can identify a list by its slug instrad of its numerical id 491 required: true 492 type: string 493 - name: owner_screen_name 494 in: query 495 description: The screen name of the user who owns the list being requested by a slug 496 required: false 497 type: string 498 - name: user_id 499 in: query 500 description: The id of the user for whom to remove from the list 501 required: false 502 type: string 503 - name: screen_name 504 in: query 505 description: The screen name of the user for whom to remove from the list 506 required: false 507 type: string 508 - name: owner_id 509 in: query 510 description: The is of the user who wons the list being requested by a slug 511 required: false 512 type: string 513 responses: 514 "200": 515 description: Success 516 517 /lists/memberships: 518 get: 519 description: Returns the lists of the specified user has been added to 520 security: 521 - oauth: 522 - basic 523 parameters: 524 - name: user_id 525 in: query 526 description: The id of the user for whom to return results for 527 required: false 528 type: string 529 - name: screen_name 530 in: query 531 description: The screen name of the user for whom to return results for 532 required: false 533 type: string 534 - name: cursor 535 in: query 536 description: Breaks the results into pages 537 required: false 538 type: string 539 - name: filter_to_owned_lists 540 in: query 541 description: When set to true, t or 1, will return just lists the authenticating user owns 542 required: false 543 type: string 544 responses: 545 "200": 546 description: Success 547 schema: 548 $ref: '#/definitions/Cursor_lists' 549 550 /lists/subscribers: 551 get: 552 description: Returns the subscribers of the specified list 553 security: 554 - oauth: 555 - basic 556 parameters: 557 - name: list_id 558 in: query 559 description: The numerical id of the list 560 required: true 561 type: string 562 - name: slug 563 in: query 564 description: You can identify a list by its slug insted of its numerical id 565 required: true 566 type: string 567 - name: owner_screen_name 568 in: query 569 description: the screen name of the user who owns the list being requested by a slug 570 required: false 571 type: string 572 - name: owner_id 573 in: query 574 description: The user ID of the user who owns the list being requested by a slug 575 required: false 576 type: string 577 - name: cursor 578 in: query 579 description: Breaks the results into pages 580 required: false 581 type: string 582 - name: include_entities 583 in: query 584 description: Wehn set to either true, t or 1 585 required: false 586 type: string 587 - name: skip_status 588 in: query 589 description: When set to either true, t or 1 590 required: false 591 type: string 592 responses: 593 "200": 594 description: Success 595 schema: 596 $ref: '#/definitions/Cursor_lists' 597 598 /lists/subscribers/create: 599 post: 600 description: Subscribes the authenticated user to the specified list 601 security: 602 - oauth: 603 - basic 604 parameters: 605 - name: list_id 606 in: query 607 description: The numerical id of the list 608 required: true 609 type: string 610 - name: slug 611 in: query 612 description: You can identify a list being requested by a slug 613 required: true 614 type: string 615 - name: owner_screen_name 616 in: query 617 description: the screen name of the user who owns the list being requested by a slug 618 required: false 619 type: string 620 - name: owner_id 621 in: query 622 description: The user ID of the user who owns the list being requested by a slug 623 required: false 624 type: string 625 responses: 626 "200": 627 description: Success 628 schema: 629 $ref: '#/definitions/Lists' 630 631 /lists/subscribers/show: 632 get: 633 description: Check if the specified user is a subscriber of the specified list 634 security: 635 - oauth: 636 - basic 637 parameters: 638 - name: list_id 639 in: query 640 description: The numerical id of the list 641 required: true 642 type: string 643 - name: slug 644 in: query 645 description: You can identify a list being requested by a slug 646 required: true 647 type: string 648 - name: owner_screen_name 649 in: query 650 description: The screen name of the user who owns the list being requested by a slug 651 required: false 652 type: string 653 - name: user_id 654 in: query 655 description: The id of the user for whom to remove from the list 656 required: false 657 type: string 658 - name: screen_name 659 in: query 660 description: The screen name of the user for whom to remove from the list 661 required: false 662 type: string 663 - name: owner_id 664 in: query 665 description: The is of the user who wons the list being requested by a slug 666 required: false 667 type: string 668 - name: include_entities 669 in: query 670 description: Wehn set to either true, t or 1 671 required: false 672 type: string 673 - name: skip_status 674 in: query 675 description: When set to either true, t or 1 676 required: false 677 type: string 678 responses: 679 "200": 680 description: Success 681 schema: 682 $ref: '#/definitions/Users' 683 684 /lists/subscribers/destroy: 685 get: 686 description: Returns list of subscribers destroy 687 parameters: 688 - name: list_id 689 in: query 690 description: The numerical id of the list 691 required: true 692 type: string 693 - name: slug 694 in: query 695 description: You can identify a list being requested by a slug 696 required: true 697 type: string 698 - name: owner_screen_name 699 in: query 700 description: the screen name of the user who owns the list being requested by a slug 701 required: false 702 type: string 703 - name: owner_id 704 in: query 705 description: The user ID of the user who owns the list being requested by a slug 706 required: false 707 type: string 708 responses: 709 "200": 710 description: Success 711 712 /lists/members/create_all: 713 get: 714 description: Returns lists of members create_all 715 security: 716 - oauth: 717 - basic 718 parameters: 719 - name: list_id 720 in: query 721 description: The numerical id of the list 722 required: true 723 type: string 724 - name: slug 725 in: query 726 description: You can identify a list being requested by a slug 727 required: true 728 type: string 729 - name: owner_screen_name 730 in: query 731 description: the screen name of the user who owns the list being requested by a slug 732 required: false 733 type: string 734 - name: owner_id 735 in: query 736 description: The user ID of the user who owns the list being requested by a slug 737 required: false 738 type: string 739 - name: user_id 740 in: query 741 description: The id of the user for whom to remove from the list 742 required: false 743 type: string 744 - name: screen_name 745 in: query 746 description: The screen name of the user for whom to remove from the list 747 required: false 748 type: string 749 responses: 750 "200": 751 description: Success 752 753 /list/members/show: 754 get: 755 description: Check if the specified user is a member of the specified list 756 security: 757 - oauth: 758 - basic 759 parameters: 760 - name: list_id 761 in: query 762 description: The numerical id of the list 763 required: true 764 type: string 765 - name: slug 766 in: query 767 description: You can identify a list being requested by a slug 768 required: true 769 type: string 770 - name: user_id 771 in: query 772 description: The id of the user for whom to remove from the list 773 required: false 774 type: string 775 - name: screen_name 776 in: query 777 description: The screen name of the user for whom to remove from the list 778 required: false 779 type: string 780 - name: owner_screen_name 781 in: query 782 description: The screen name of the user who owns the list being requested by a slug 783 required: false 784 type: string 785 - name: owner_id 786 in: query 787 description: The user ID of the user who owns the list being requested by a slug 788 required: false 789 type: string 790 - name: include_entities 791 in: query 792 description: Wehn set to either true, t or 1 793 required: false 794 type: string 795 - name: skip_status 796 in: query 797 description: When set to either true, t or 1 798 required: false 799 type: string 800 responses: 801 "200": 802 description: Success 803 schema: 804 $ref: '#/definitions/Users' 805 806 /list/members: 807 get: 808 description: Returns the members of the specified list 809 security: 810 - oauth: 811 - basic 812 parameters: 813 - name: list_id 814 in: query 815 description: The numerical id of the list 816 required: true 817 type: string 818 - name: slug 819 in: query 820 description: You can identify a list being requested by a slug 821 required: true 822 type: string 823 - name: owner_screen_name 824 in: query 825 description: The screen name of the user who owns the list being requested by a slug 826 required: false 827 type: string 828 - name: owner_id 829 in: query 830 description: The user ID of the user who owns the list being requested by a slug 831 required: false 832 type: string 833 - name: include_entities 834 in: query 835 description: Wehn set to either true, t or 1 836 required: false 837 type: string 838 - name: skip_status 839 in: query 840 description: When set to either true, t or 1 841 required: false 842 type: string 843 - name: cursor 844 in: query 845 description: Breaks the results into pages 846 required: false 847 type: string 848 responses: 849 "200": 850 description: Success 851 schema: 852 $ref: '#/definitions/Users' 853 854 /list/members/create: 855 post: 856 description: Returns list of members create 857 security: 858 - oauth: 859 - basic 860 parameters: 861 - name: list_id 862 in: query 863 description: The numerical id of the list 864 required: true 865 type: string 866 - name: slug 867 in: query 868 description: You can identify a list being requested by a slug 869 required: true 870 type: string 871 - name: screen_name 872 in: query 873 description: The screen name of the user for whom to remove from the list 874 required: false 875 type: string 876 - name: owner_screen_name 877 in: query 878 description: The screen name of the user who owns the list being requested by a slug 879 required: false 880 type: string 881 - name: owner_id 882 in: query 883 description: The user ID of the user who owns the list being requested by a slug 884 required: false 885 type: string 886 responses: 887 "200": 888 description: Success 889 890 /lists/destroy: 891 post: 892 description: Returns list of destroy 893 security: 894 - oauth: 895 - basic 896 parameters: 897 - name: list_id 898 in: query 899 description: The numerical id of the list 900 required: true 901 type: string 902 - name: slug 903 in: query 904 description: You can identify a list being requested by a slug 905 required: true 906 type: string 907 - name: owner_screen_name 908 in: query 909 description: The screen name of the user who owns the list being requested by a slug 910 required: false 911 type: string 912 - name: owner_id 913 in: query 914 description: The user ID of the user who owns the list being requested by a slug 915 required: false 916 type: string 917 responses: 918 "200": 919 description: Success 920 schema: 921 $ref: '#/definitions/Lists' 922 923 /lists/update: 924 post: 925 description: Returns lists of updates 926 security: 927 - oauth: 928 - basic 929 parameters: 930 - name: list_id 931 in: query 932 description: The numerical id of the list 933 required: true 934 type: string 935 - name: slug 936 in: query 937 description: You can identify a list being requested by a slug 938 required: true 939 type: string 940 - name: owner_screen_name 941 in: query 942 description: The screen name of the user who owns the list being requested by a slug 943 required: false 944 type: string 945 - name: owner_id 946 in: query 947 description: The user ID of the user who owns the list being requested by a slug 948 required: false 949 type: string 950 - name: name 951 in: query 952 description: The name for the list 953 required: false 954 type: string 955 - name: mode 956 in: query 957 description: Whether your list is public or private 958 required: false 959 type: string 960 - name: description 961 in: query 962 description: The description to give the list 963 required: false 964 type: string 965 responses: 966 "200": 967 description: Success 968 969 /lists/create: 970 post: 971 description: Returns list of create 972 security: 973 - oauth: 974 - basic 975 parameters: 976 - name: name 977 in: query 978 description: The name for the list 979 required: false 980 type: string 981 - name: mode 982 in: query 983 description: Whether your list is public or private 984 required: false 985 type: string 986 - name: description 987 in: query 988 description: The description to give the list 989 required: false 990 type: string 991 responses: 992 "200": 993 description: Success 994 schema: 995 $ref: '#/definitions/Lists' 996 997 /lists/show: 998 get: 999 description: Returns list of show 1000 security: 1001 - oauth: 1002 - basic 1003 parameters: 1004 - name: list_id 1005 in: query 1006 description: The numerical id of the list 1007 required: true 1008 type: string 1009 - name: slug 1010 in: query 1011 description: You can identify a list being requested by a slug 1012 required: true 1013 type: string 1014 - name: owner_screen_name 1015 in: query 1016 description: The screen name of the user who owns the list being requested by a slug 1017 required: false 1018 type: string 1019 - name: owner_id 1020 in: query 1021 description: The user ID of the user who owns the list being requested by a slug 1022 required: false 1023 type: string 1024 responses: 1025 "200": 1026 description: Success 1027 schema: 1028 $ref: '#/definitions/Lists' 1029 1030 /lists/subscriptions: 1031 get: 1032 description: Returns list of subscriptions 1033 security: 1034 - oauth: 1035 - basic 1036 parameters: 1037 - name: screen_name 1038 in: query 1039 description: The screen name of the user 1040 required: false 1041 type: string 1042 - name: user_id 1043 in: query 1044 description: The id of the user for whom to return results for 1045 required: false 1046 type: string 1047 - name: count 1048 in: query 1049 description: The amount of results to return per page 1050 required: false 1051 type: string 1052 - name: cursor 1053 in: query 1054 description: Breaks the results into pages 1055 required: false 1056 type: string 1057 responses: 1058 "200": 1059 description: Success 1060 schema: 1061 $ref: '#/definitions/Cursor_lists' 1062 1063 /list/members/destroy_all: 1064 get: 1065 description: Returns lists of destroy all 1066 security: 1067 - oauth: 1068 - basic 1069 parameters: 1070 - name: list_id 1071 in: query 1072 description: The numerical id of the list 1073 required: true 1074 type: string 1075 - name: slug 1076 in: query 1077 description: You can identify a list being requested by a slug 1078 required: true 1079 type: string 1080 - name: user_id 1081 in: query 1082 description: The id of the user for whom to remove from the list 1083 required: false 1084 type: string 1085 - name: screen_name 1086 in: query 1087 description: The screen name of the user for whom to remove from the list 1088 required: false 1089 type: string 1090 - name: owner_screen_name 1091 in: query 1092 description: The screen name of the user who owns the list being requested by a slug 1093 required: false 1094 type: string 1095 - name: owner_id 1096 in: query 1097 description: The user ID of the user who owns the list being requested by a slug 1098 required: false 1099 type: string 1100 responses: 1101 "200": 1102 description: Success 1103 schema: 1104 $ref: '#/definitions/Cursor_lists' 1105 1106 /direct_messages/sent: 1107 get: 1108 description: return 20 most recent direct messages sent 1109 parameters: 1110 - name: since_id 1111 in: query 1112 required: false 1113 type: string 1114 - name: max_id 1115 in: query 1116 required: false 1117 type: string 1118 - name: count 1119 in: query 1120 required: false 1121 type: string 1122 - name: page 1123 in: query 1124 required: false 1125 type: string 1126 - name: include_entities 1127 in: query 1128 required: false 1129 type: string 1130 responses: 1131 200: 1132 description: OK 1133 schema: 1134 type: array 1135 items: 1136 $ref: '#/definitions/Messages' 1137 1138 /direct_messages/show: 1139 get: 1140 description: returns a single direct message specified by an id 1141 security: 1142 - oauth: 1143 - basic 1144 parameters: 1145 - name: id 1146 in: query 1147 description: ID of direct message 1148 type: string 1149 required: true 1150 responses: 1151 200: 1152 description: OK 1153 schema: 1154 type: array 1155 items: 1156 $ref: '#/definitions/Messages' 1157 1158 /search/tweets: 1159 get: 1160 description: returns collection of relevant Tweets matching query 1161 security: 1162 - oauth: 1163 - basic 1164 parameters: 1165 - name: q 1166 in: query 1167 description: URL-encoded search query of 500 characters max 1168 type: string 1169 required: true 1170 - name: geocode 1171 in: query 1172 description: returns tweets by users located within given radius 1173 type: string 1174 required: false 1175 - name: lang 1176 in: query 1177 description: restricts tweets to a given language 1178 type: string 1179 required: false 1180 - name: locale 1181 in: query 1182 description: language of query you are sending 1183 type: string 1184 required: false 1185 - name: result_type 1186 in: query 1187 description: specifies type of search results you prefer 1188 type: string 1189 required: false 1190 - name: count 1191 in: query 1192 description: number of tweets to return 1193 type: string 1194 - name: until 1195 in: query 1196 description: returns tweets created before given date 1197 type: string 1198 - name: since_id 1199 in: query 1200 description: return results with ID greater than specified 1201 type: string 1202 - name: max_id 1203 in: query 1204 description: returns results with an ID less than/equal to specified ID 1205 type: string 1206 - name: include_entities 1207 in: query 1208 description: whether or not to include entities 1209 type: string 1210 - name: callback 1211 in: query 1212 description: response will use the callback with given name 1213 type: string 1214 responses: 1215 200: 1216 description: OK 1217 schema: 1218 type: array 1219 items: 1220 $ref: '#/definitions/Tweets' 1221 1222 /saved_searches/list: 1223 get: 1224 description: Returns the authenticated user's saved search queries 1225 security: 1226 - oauth: 1227 - basic 1228 responses: 1229 "200": 1230 description: Success 1231 schema: 1232 type: array 1233 items: 1234 $ref: '#/definitions/Query' 1235 /saved_searches/show/{id}: 1236 get: 1237 description: Retrieve the information for the saved search represented by the given id 1238 security: 1239 - oauth: 1240 - basic 1241 parameters: 1242 - name: id 1243 in: path 1244 description: The id of the saved search 1245 required: true 1246 type: string 1247 responses: 1248 "200": 1249 description: Success 1250 schema: 1251 $ref: '#/definitions/Query' 1252 /saved_searches/create: 1253 post: 1254 description: Create a new saved search for the authenticated user 1255 security: 1256 - oauth: 1257 - basic 1258 parameters: 1259 - name: query 1260 in: query 1261 description: The query of the search the user would like to save 1262 required: true 1263 type: string 1264 responses: 1265 "200": 1266 description: Success 1267 schema: 1268 $ref: '#/definitions/Query' 1269 /saved_searches/destroy/{id}: 1270 post: 1271 description: Destroy a saved search for the authenticating user 1272 security: 1273 - oauth: 1274 - basic 1275 parameters: 1276 - name: id 1277 in: path 1278 description: The id of the saved search 1279 required: true 1280 type: string 1281 responses: 1282 "200": 1283 description: Success 1284 schema: 1285 $ref: '#/definitions/Query' 1286 1287 /direct_messages: 1288 get: 1289 description: return 20 most recent direct messages sent to user 1290 security: 1291 - oauth: 1292 - basic 1293 parameters: 1294 - name: since_id 1295 in: query 1296 description: return results with ID greater than specified 1297 type: string 1298 - name: max_id 1299 in: query 1300 description: returns results with an ID less than/equal to specified ID 1301 type: string 1302 - name: include_entities 1303 in: query 1304 description: whether or not to include entities 1305 type: string 1306 - name: skip_status 1307 in: query 1308 description: whether or not to include status 1309 type: string 1310 responses: 1311 200: 1312 description: OK 1313 schema: 1314 type: array 1315 items: 1316 $ref: '#/definitions/Messages' 1317 1318 /direct_messages/destroy: 1319 post: 1320 description: destroys direct messages specified in required ID 1321 security: 1322 - oauth: 1323 - basic 1324 parameters: 1325 - name: id 1326 in: query 1327 description: ID of direct message to delete 1328 type: string 1329 required: true 1330 - name: include_entities 1331 in: query 1332 description: whether or not to include entities 1333 type: string 1334 responses: 1335 200: 1336 description: OK 1337 schema: 1338 $ref: '#/definitions/Messages' 1339 1340 /direct_messages/new: 1341 post: 1342 description: sends a new direct message to specified user 1343 security: 1344 - oauth: 1345 - basic 1346 parameters: 1347 - name: user_id 1348 in: query 1349 description: description 1350 type: string 1351 required: true 1352 - name: screen_name 1353 in: query 1354 description: screen name of user receiving message 1355 type: string 1356 - name: text 1357 in: query 1358 description: text of your direct message 1359 type: string 1360 required: true 1361 responses: 1362 200: 1363 description: OK 1364 schema: 1365 $ref: '#/definitions/Messages' 1366 1367 /friends/ids: 1368 get: 1369 description: returns a cursored collection of user IDs followed by user 1370 security: 1371 - oauth: 1372 - basic 1373 parameters: 1374 - name: user_id 1375 in: query 1376 description: ID of user for whom to return results for 1377 type: string 1378 - name: screen_name 1379 in: query 1380 description: screen name of user for whom to return results for 1381 type: string 1382 - name: cursor 1383 in: query 1384 description: causes list of connections to be broken in pages 1385 type: string 1386 - name: stringify_ids 1387 in: query 1388 description: IDs converted to strings 1389 type: string 1390 - name: count 1391 in: query 1392 description: number of IDs to attempt retrieval of 1393 type: string 1394 responses: 1395 200: 1396 description: OK 1397 schema: 1398 $ref: '#/definitions/Cursor_ids' 1399 1400 /followers/ids: 1401 get: 1402 description: returns a cursored collection of user IDs following the user 1403 security: 1404 - oauth: 1405 - basic 1406 parameters: 1407 - name: user_id 1408 in: query 1409 description: ID of user for whom to return results for 1410 type: string 1411 - name: screen_name 1412 in: query 1413 description: screen name of user for whom to return results for 1414 type: string 1415 - name: cursor 1416 in: query 1417 description: causes list of connections to be broken in pages 1418 type: string 1419 - name: stringify_ids 1420 in: query 1421 description: IDs converted to strings 1422 type: string 1423 - name: count 1424 in: query 1425 description: number of IDs to attempt retrieval of 1426 type: string 1427 responses: 1428 200: 1429 description: OK 1430 schema: 1431 $ref: '#/definitions/Cursor_ids' 1432 1433 /friendships/incoming: 1434 get: 1435 description: returns collection of IDs of users with pending follow request 1436 security: 1437 - oauth: 1438 - basic 1439 parameters: 1440 - name: cursor 1441 in: query 1442 description: causes list of connections to be broken in pages 1443 type: string 1444 - name: stringify_ids 1445 in: query 1446 description: IDs converted to strings 1447 type: string 1448 responses: 1449 200: 1450 description: OK 1451 schema: 1452 $ref: '#/definitions/Cursor_ids' 1453 1454 /friendships/outgoing: 1455 get: 1456 description: returns collection of IDs of users with pending follow request from the user 1457 security: 1458 - oauth: 1459 - basic 1460 parameters: 1461 - name: cursor 1462 in: query 1463 description: causes list of connections to be broken in pages 1464 type: string 1465 - name: stringify_ids 1466 in: query 1467 description: IDs converted to strings 1468 type: string 1469 responses: 1470 200: 1471 description: OK 1472 schema: 1473 $ref: '#/definitions/Cursor_ids' 1474 1475 /friendships/create: 1476 post: 1477 description: allows users to follow user sepcified by ID 1478 security: 1479 - oauth: 1480 - basic 1481 parameters: 1482 - name: screen_name 1483 in: query 1484 description: screen name of user for whom to befriend 1485 type: string 1486 - name: user_id 1487 in: query 1488 description: ID of user for whom to befriend 1489 type: string 1490 - name: follow 1491 in: query 1492 description: enable notifications for target user 1493 type: string 1494 responses: 1495 200: 1496 description: OK 1497 schema: 1498 $ref: '#/definitions/Users' 1499 1500 /friendships/destroy: 1501 post: 1502 description: allows user to unfollow user psecified by ID 1503 security: 1504 - oauth: 1505 - basic 1506 parameters: 1507 - name: screen_name 1508 in: query 1509 description: screen name of user for whom to befriend 1510 type: string 1511 required: true 1512 - name: user_id 1513 in: query 1514 description: ID of user for whom to befriend 1515 type: string 1516 required: true 1517 responses: 1518 200: 1519 description: OK 1520 schema: 1521 $ref: '#/definitions/Users' 1522 1523 /friendships/update: 1524 post: 1525 description: Allows one to enable or disable settings for specified user 1526 security: 1527 - oauth: 1528 - basic 1529 parameters: 1530 - name: screen_name 1531 in: query 1532 description: screen name of user for whom to befriend 1533 type: string 1534 required: true 1535 - name: user_id 1536 in: query 1537 description: ID of user for whom to befriend 1538 type: string 1539 required: true 1540 - name: device 1541 in: query 1542 description: enable/disable device notifications for user 1543 type: string 1544 required: true 1545 - name: retweets 1546 in: query 1547 description: enable/disable retweets from target user 1548 type: string 1549 required: true 1550 responses: 1551 200: 1552 description: OK 1553 schema: 1554 $ref: '#/definitions/Friendship' 1555 1556 /friendships/show: 1557 get: 1558 description: returns detailed info about relationship between two users 1559 security: 1560 - oauth: 1561 - basic 1562 parameters: 1563 - name: source_id 1564 in: query 1565 description: user id of subject user 1566 type: string 1567 - name: source_screen_name 1568 in: query 1569 description: screen_name of subject user 1570 type: string 1571 - name: target_id 1572 in: query 1573 description: user id of target user 1574 type: string 1575 required: true 1576 - name: target_screen_name 1577 in: query 1578 description: screen name of target user 1579 type: string 1580 required: true 1581 responses: 1582 200: 1583 description: OK 1584 schema: 1585 $ref: '#/definitions/Friendship' 1586 1587 /account/settings: 1588 get: 1589 summary: returns settings for user 1590 description: returns settings for user 1591 security: 1592 - oauth: 1593 - basic 1594 responses: 1595 200: 1596 description: OK 1597 schema: 1598 $ref: '#/definitions/Settings' 1599 post: 1600 summary: updates user's settings 1601 description: updates user's settings 1602 security: 1603 - oauth: 1604 - basic 1605 parameters: 1606 - name: trend_location_woeid 1607 in: query 1608 description: the Yahoo! Where On Earth ID to user as defaul tend location 1609 type: string 1610 - name: sleep_time_enabled 1611 in: query 1612 description: enables/disables sleep time, silencing notifications 1613 type: string 1614 - name: start_sleep_time 1615 in: query 1616 description: the hour that sleep time should begin if enabled 1617 type: string 1618 - name: end_sleep_time 1619 in: query 1620 description: the hour that sleep time should end if enabled 1621 type: string 1622 - name: time_zone 1623 in: query 1624 description: timezone dates and times should be displayed in 1625 type: string 1626 - name: lang 1627 in: query 1628 description: language which Twitter should render in for the user 1629 type: string 1630 responses: 1631 200: 1632 description: OK 1633 schema: 1634 $ref: '#/definitions/Settings' 1635 1636 /account/update_delivery_device: 1637 post: 1638 summary: sets which device Twitter delivers updates to for user 1639 description: sets which device Twitter delivers updates to for user 1640 security: 1641 - oauth: 1642 - basic 1643 parameters: 1644 - name: device 1645 in: query 1646 description: must be one of sms, none 1647 type: string 1648 required: true 1649 - name: include_entities 1650 in: query 1651 description: whether or not to include entities 1652 type: string 1653 responses: 1654 200: 1655 description: OK 1656 schema: 1657 $ref: '#/definitions/Settings' 1658 1659 /account/update_profile: 1660 post: 1661 summary: sets values that users ar eable to set under Account tab 1662 description: sets values that users ar eable to set under Account tab 1663 security: 1664 - oauth: 1665 - basic 1666 parameters: 1667 - name: name 1668 in: query 1669 description: full name of profile 1670 type: string 1671 - name: url 1672 in: query 1673 description: url associated with profile 1674 type: string 1675 - name: location 1676 in: query 1677 description: city or country describing where user of account is. 1678 type: string 1679 - name: description 1680 in: query 1681 description: a description of user owning account 1682 type: string 1683 - name: include_entities 1684 in: query 1685 description: whether or not to include entities 1686 type: string 1687 - name: skip_status 1688 in: query 1689 description: whether or not to include statuses in response 1690 type: string 1691 responses: 1692 200: 1693 description: OK 1694 schema: 1695 $ref: '#/definitions/Settings' 1696 1697 /account/update_profile_background_image: 1698 post: 1699 summary: updates user's profile background image 1700 description: updates user's profile background image 1701 security: 1702 - oauth: 1703 - basic 1704 consumes: 1705 - multipart/form-data 1706 parameters: 1707 - name: tile 1708 in: query 1709 description: whether or not to tile background image 1710 type: string 1711 - name: use 1712 in: query 1713 description: display background image or not 1714 type: string 1715 - name: include_entities 1716 in: query 1717 description: whether or not to include entities 1718 type: string 1719 - name: skip_status 1720 in: query 1721 description: whether or not to include status in returned user objects 1722 type: string 1723 - name: file 1724 in: formData 1725 description: image to replace background image of profile 1726 required: true 1727 type: file 1728 responses: 1729 200: 1730 description: OK 1731 schema: 1732 $ref: '#/definitions/Settings' 1733 1734 /account/update_profile_colors: 1735 post: 1736 summary: sets one or more hex values that controls color scheme 1737 description: sets one or more hex values that controls color scheme 1738 security: 1739 - oauth: 1740 - basic 1741 parameters: 1742 - name: profile_background_color 1743 in: query 1744 description: profile background color 1745 type: string 1746 - name: profile_link_color 1747 in: query 1748 description: profile link color 1749 type: string 1750 - name: profile_sidebar_border_color 1751 in: query 1752 description: profile sidebar's border color 1753 type: string 1754 - name: profile_sidebar_fill_color 1755 in: query 1756 description: profile's sidebar background color 1757 type: string 1758 - name: profile_text_color 1759 in: query 1760 description: profile text color 1761 type: string 1762 - name: include_entities 1763 in: query 1764 description: whether or not to include entities 1765 type: string 1766 - name: skip_status 1767 in: query 1768 description: whether or not to include statuses 1769 type: string 1770 responses: 1771 200: 1772 description: OK 1773 schema: 1774 $ref: '#/definitions/Settings' 1775 1776 /account/update_profile_image: 1777 post: 1778 summary: updates user's profile image 1779 description: updates user's profile image 1780 security: 1781 - oauth: 1782 - basic 1783 consumes: 1784 - multipart/form-data 1785 parameters: 1786 - name: skip_status 1787 in: query 1788 description: whether or not to include statuses 1789 type: string 1790 - name: image 1791 in: formData 1792 description: image to be set as profile image 1793 type: file 1794 required: true 1795 responses: 1796 200: 1797 description: OK 1798 schema: 1799 $ref: '#/definitions/Settings' 1800 1801 /blocks/list: 1802 get: 1803 summary: disallows retweets and device notifications from a user 1804 description: disallows retweets and device notifications from a user 1805 security: 1806 - oauth: 1807 - basic 1808 parameters: 1809 - name: include_entities 1810 in: query 1811 description: whether or not to include entities 1812 type: string 1813 - name: skip_status 1814 in: query 1815 description: whether or not to include statuses in response 1816 type: string 1817 - name: cursor 1818 in: query 1819 description: breaks block of user to be broken up into pages 1820 type: string 1821 responses: 1822 200: 1823 description: OK 1824 schema: 1825 $ref: '#/definitions/Cursor_users' 1826 1827 /blocks/ids: 1828 get: 1829 summary: returns array of numeric user ids of blocked users 1830 description: returns array of numeric user ids of blocked users 1831 security: 1832 - oauth: 1833 - basic 1834 parameters: 1835 - name: stringify_ids 1836 in: query 1837 description: returns array of numeric IDs as string IDs 1838 type: string 1839 - name: cursor 1840 in: query 1841 description: breaks up block of user IDs into pages 1842 type: string 1843 responses: 1844 200: 1845 description: OK 1846 schema: 1847 $ref: '#/definitions/Cursor_users' 1848 1849 /blocks/create: 1850 post: 1851 summary: blocks the specified user 1852 description: blocks the specified user 1853 security: 1854 - oauth: 1855 - basic 1856 parameters: 1857 - name: screen_name 1858 in: query 1859 description: screen name of user to be blocked 1860 type: string 1861 required: true 1862 - name: user_id 1863 in: query 1864 description: ID of user to be blocked 1865 type: string 1866 required: true 1867 - name: include_entities 1868 in: query 1869 description: whether or not to include entities 1870 type: string 1871 - name: skip_status 1872 in: query 1873 description: whether or not to skip statuses 1874 type: string 1875 responses: 1876 200: 1877 description: OK 1878 schema: 1879 $ref: '#/definitions/Users' 1880 1881 /blocks/destroy: 1882 post: 1883 summary: un-blocks the specified user 1884 description: un-blocks the specified user 1885 security: 1886 - oauth: 1887 - basic 1888 parameters: 1889 - name: screen_name 1890 in: query 1891 description: screen name of user to be un-blocked 1892 type: string 1893 required: true 1894 - name: user_id 1895 in: query 1896 description: ID of user to be un-blocked 1897 type: string 1898 required: true 1899 - name: include_entities 1900 in: query 1901 description: whether or not to include entities 1902 type: string 1903 - name: skip_status 1904 in: query 1905 description: whether or not to skip statuses 1906 type: string 1907 responses: 1908 200: 1909 description: OK 1910 schema: 1911 $ref: '#/definitions/Users' 1912 1913 /users/lookup: 1914 get: 1915 summary: returns fully-hydrated user objects up to 100 1916 description: returns fully-hydrated user objects up to 100 1917 security: 1918 - oauth: 1919 - basic 1920 parameters: 1921 - name: screen_name 1922 in: query 1923 description: screen name of user to lookup 1924 type: string 1925 - name: user_id 1926 in: query 1927 description: ID of user to lookup 1928 type: string 1929 - name: include_entities 1930 in: query 1931 description: whether or not to include entities 1932 type: string 1933 responses: 1934 200: 1935 description: OK 1936 schema: 1937 type: array 1938 items: 1939 $ref: '#/definitions/Users' 1940 1941 /users/show: 1942 get: 1943 summary: returns a variety of info about specified user 1944 description: returns a variety of info about specified user 1945 security: 1946 - oauth: 1947 - basic 1948 parameters: 1949 - name: screen_name 1950 in: query 1951 description: screen name of user to be shown 1952 type: string 1953 required: true 1954 - name: user_id 1955 in: query 1956 description: ID of user to be shown 1957 type: string 1958 required: true 1959 - name: include_entities 1960 in: query 1961 description: whether or not to include entities 1962 type: string 1963 responses: 1964 200: 1965 description: OK 1966 schema: 1967 $ref: '#/definitions/Users' 1968 1969 /users/search: 1970 get: 1971 summary: simple relevance-based user search 1972 description: simple relevance-based user search 1973 security: 1974 - oauth: 1975 - basic 1976 parameters: 1977 - name: q 1978 in: query 1979 description: the search query to run against people search 1980 type: string 1981 required: true 1982 - name: page 1983 in: query 1984 description: specifies the page of results to receive 1985 type: string 1986 - name: count 1987 in: query 1988 description: number of people to return per page 1989 type: string 1990 - name: include_entities 1991 in: query 1992 description: whether or not to include entities 1993 type: string 1994 responses: 1995 200: 1996 description: OK 1997 schema: 1998 type: array 1999 items: 2000 $ref: '#/definitions/Users' 2001 2002 /users/contributees: 2003 get: 2004 summary: collection of users specified user can contribute to 2005 description: collection of users specified user can contribute to 2006 security: 2007 - oauth: 2008 - basic 2009 parameters: 2010 - name: screen_name 2011 in: query 2012 description: screen name of user that is contributed to 2013 type: string 2014 required: true 2015 - name: user_id 2016 in: query 2017 description: ID of user to that is contributed to 2018 type: string 2019 required: true 2020 - name: include_entities 2021 in: query 2022 description: whether or not to include entities 2023 type: string 2024 - name: skip_status 2025 in: query 2026 description: whether or not to skip statuses 2027 type: string 2028 responses: 2029 200: 2030 description: OK 2031 schema: 2032 type: array 2033 items: 2034 $ref: '#/definitions/Users' 2035 2036 /users/contributors: 2037 get: 2038 summary: collection of users that can contribute to specified account 2039 description: collection of users that can contribute to specified account 2040 security: 2041 - oauth: 2042 - basic 2043 parameters: 2044 - name: screen_name 2045 in: query 2046 description: screen name of user contributing 2047 type: string 2048 required: true 2049 - name: user_id 2050 in: query 2051 description: ID of user contributing 2052 type: string 2053 required: true 2054 - name: include_entities 2055 in: query 2056 description: whether or not to include entities 2057 type: string 2058 - name: skip_status 2059 in: query 2060 description: whether or not to skip statuses 2061 type: string 2062 responses: 2063 200: 2064 description: OK 2065 schema: 2066 type: array 2067 items: 2068 $ref: '#/definitions/Users' 2069 2070 /geo/id/{place_id}: 2071 get: 2072 description: Returns all the information about a know place 2073 security: 2074 - oauth: 2075 - basic 2076 parameters: 2077 - name: place_id 2078 in: path 2079 description: A place in the world 2080 required: true 2081 type: string 2082 responses: 2083 200: 2084 description: Success 2085 schema: 2086 type: array 2087 items: 2088 $ref: '#/definitions/Places' 2089 2090 /geo/reverse_geoncode: 2091 get: 2092 description: Given a latitude and a longitude, searches for up to 20 places that can be used as a place_id when updatting a status 2093 security: 2094 - oauth: 2095 - basic 2096 parameters: 2097 - name: lat 2098 in: query 2099 description: The latitude to search around 2100 required: true 2101 type: string 2102 - name: long 2103 in: query 2104 description: The longtitude to search around 2105 required: true 2106 type: string 2107 - name: accuracy 2108 in: query 2109 description: A hint on region in which to search 2110 required: false 2111 type: string 2112 - name: granularity 2113 in: query 2114 description: This is the minimal granularity of place types to return 2115 required: false 2116 type: string 2117 - name: max_results 2118 in: query 2119 description: A hint as to the number of results to return 2120 required: false 2121 type: string 2122 - name: callback 2123 in: query 2124 description: If supplied, the responses will use the JSON format with a callback of the given name 2125 required: false 2126 type: string 2127 responses: 2128 200: 2129 description: Success 2130 schema: 2131 type: array 2132 items: 2133 $ref: '#/definitions/Places' 2134 2135 /geo/search: 2136 get: 2137 description: Search for places that can be attached to a statuses/updates 2138 security: 2139 - oauth: 2140 - basic 2141 parameters: 2142 - name: lat 2143 in: query 2144 description: The latitude to search around 2145 required: true 2146 type: string 2147 - name: long 2148 in: query 2149 description: The longtitude to search around 2150 required: true 2151 type: string 2152 - name: query 2153 in: query 2154 description: Free-form text to match against while executing a geo-based query 2155 required: true 2156 type: string 2157 - name: ip 2158 in: query 2159 description: An Ip address 2160 required: true 2161 type: string 2162 - name: accuracy 2163 in: query 2164 description: A hint on region in which to search 2165 required: false 2166 type: string 2167 - name: granularity 2168 in: query 2169 description: This is the minimal granularity of place types to return 2170 required: false 2171 type: string 2172 - name: contained_within 2173 in: query 2174 description: This is the place_id which you would like to restrict the search results to 2175 required: false 2176 type: string 2177 - name: attribute:street_address 2178 in: query 2179 description: This parameter searches for places which have this givven street address 2180 required: false 2181 type: string 2182 - name: callback 2183 in: query 2184 description: If supplied, the responses will use the JSON format with a callback of the given name 2185 required: false 2186 type: string 2187 responses: 2188 200: 2189 description: Success 2190 schema: 2191 type: array 2192 items: 2193 $ref: '#/definitions/Places' 2194 2195 /geo/similar_places: 2196 get: 2197 description: Locates places near the given coordinates which are similar in name 2198 security: 2199 - oauth: 2200 - basic 2201 parameters: 2202 - name: lat 2203 in: query 2204 description: The latitude to search around 2205 required: true 2206 type: string 2207 - name: long 2208 in: query 2209 description: The longtitude to search around 2210 required: true 2211 type: string 2212 - name: name 2213 in: query 2214 description: The name a place is known as 2215 required: true 2216 type: string 2217 - name: contained_within 2218 in: query 2219 description: This is the place_id which you would like to restrict the search results to 2220 required: false 2221 type: string 2222 - name: attribute:street_address 2223 in: query 2224 description: This parameter searches for places which have this givven street address 2225 required: false 2226 type: string 2227 - name: callback 2228 in: query 2229 description: If supplied, the responses will use the JSON format with a callback of the given name 2230 required: false 2231 type: string 2232 responses: 2233 200: 2234 description: Success 2235 schema: 2236 type: array 2237 items: 2238 $ref: '#/definitions/Places' 2239 2240 /geo/places: 2241 get: 2242 description: Create a new place object at the given latitude and logitude 2243 security: 2244 - oauth: 2245 - basic 2246 parameters: 2247 - name: lat 2248 in: query 2249 description: The latitude to search around 2250 required: true 2251 type: string 2252 - name: long 2253 in: query 2254 description: The longtitude to search around 2255 required: true 2256 type: string 2257 - name: name 2258 in: query 2259 description: The name a place is known as 2260 required: true 2261 type: string 2262 - name: token 2263 in: query 2264 description: The token found in the response from geo/similar_places 2265 required: true 2266 type: string 2267 - name: contained_within 2268 in: query 2269 description: This is the place_id which you would like to restrict the search results to 2270 required: false 2271 type: string 2272 - name: attribute:street_address 2273 in: query 2274 description: This parameter searches for places which have this givven street address 2275 required: false 2276 type: string 2277 - name: callback 2278 in: query 2279 description: If supplied, the responses will use the JSON format with a callback of the given name 2280 required: false 2281 type: string 2282 responses: 2283 200: 2284 description: Success 2285 schema: 2286 $ref: '#/definitions/Places' 2287 2288 /trends/place: 2289 get: 2290 description: Returns the top 10 trending topics for a specific WOEID 2291 security: 2292 - oauth: 2293 - basic 2294 parameters: 2295 - name: id 2296 in: query 2297 description: The yahoo where on earch id 2298 required: true 2299 type: string 2300 - name: exclude 2301 in: query 2302 description: Setting this equal to hashtages will remove all hashtages from the trends list 2303 required: true 2304 type: string 2305 responses: 2306 200: 2307 description: Success 2308 schema: 2309 $ref: '#/definitions/TrendInfo' 2310 2311 /trends/available: 2312 get: 2313 description: Returns the availability 2314 security: 2315 - oauth: 2316 - basic 2317 responses: 2318 200: 2319 description: Success 2320 schema: 2321 type: array 2322 items: 2323 $ref: '#/definitions/Location' 2324 2325 /trends/closest: 2326 get: 2327 description: Returns the location that Twitter has trending topic information for 2328 security: 2329 - oauth: 2330 - basic 2331 parameters: 2332 - name: lat 2333 in: query 2334 description: If provided with a long parameter the available trend locations wil be stored by distance 2335 required: true 2336 type: string 2337 - name: long 2338 in: query 2339 description: If provided with a lat parameters the available trend locations will be sorted by distance 2340 required: true 2341 type: string 2342 responses: 2343 200: 2344 description: Success 2345 schema: 2346 type: array 2347 items: 2348 $ref: '#/definitions/Location' 2349 2350 /users/report_spam: 2351 post: 2352 description: Returna users report spam 2353 security: 2354 - oauth: 2355 - basic 2356 parameters: 2357 - name: screen_name 2358 in: query 2359 description: The ID or screen_name of the user you want to report as a spammer 2360 required: false 2361 type: string 2362 - name: user_id 2363 in: query 2364 description: The ID of the user you want to report as a spammer 2365 required: false 2366 type: string 2367 responses: 2368 200: 2369 description: Success 2370 schema: 2371 $ref: '#/definitions/Users' 2372 2373 /help/configuration: 2374 get: 2375 description: Returns the current configuration used by Twitter including twitter.com slugs which are not usernames 2376 security: 2377 - oauth: 2378 - basic 2379 responses: 2380 200: 2381 description: Success 2382 schema: 2383 $ref: '#/definitions/Help_Config' 2384 2385 /help/languages: 2386 get: 2387 description: Returns the list of languages supported by Twitter along with the language code supported by Twitter 2388 security: 2389 - oauth: 2390 - basic 2391 responses: 2392 200: 2393 description: Success 2394 schema: 2395 type: array 2396 items: 2397 $ref: '#/definitions/Help_Language' 2398 2399 /help/privacy: 2400 get: 2401 description: Returns Twitter's privacy policy 2402 security: 2403 - oauth: 2404 - basic 2405 responses: 2406 200: 2407 description: Success 2408 schema: 2409 $ref: '#/definitions/Help_Privacy' 2410 2411 /help/tos: 2412 get: 2413 description: Returns the Twitter Terms of Service 2414 security: 2415 - oauth: 2416 - basic 2417 responses: 2418 200: 2419 description: Success 2420 schema: 2421 $ref: '#/definitions/Help_Tos' 2422 2423 /application/rate_limit_status: 2424 get: 2425 description: Returns the current rate limits for methods belonging to the specified resource families 2426 security: 2427 - oauth: 2428 - basic 2429 parameters: 2430 - name: resources 2431 in: query 2432 description: A comma-separated list of resource families you want to know the current rate limit disposition for 2433 required: false 2434 type: array 2435 items: 2436 type: string 2437 responses: 2438 200: 2439 description: Success 2440 2441 2442 ################################################################################ 2443 # Definitions # 2444 ################################################################################ 2445 definitions: 2446 Tweets: 2447 type: object 2448 properties: 2449 contributors: 2450 type: array 2451 items: 2452 $ref: '#/definitions/Contributors' 2453 coordinates: 2454 $ref: '#/definitions/Coordinates' 2455 created_at: 2456 type: string 2457 current_user_retweet: 2458 $ref: '#/definitions/Tweets' 2459 entities: 2460 $ref: '#/definitions/Entities' 2461 favorite_count: 2462 type: integer 2463 favorited: 2464 type: boolean 2465 filter_level: 2466 type: string 2467 id: 2468 type: integer 2469 id_str: 2470 type: string 2471 in_reply_to_screen_name: 2472 type: string 2473 in_reply_to_status_id: 2474 type: integer 2475 in_reply_to_status_id_str: 2476 type: string 2477 in_reply_to_user_id: 2478 type: integer 2479 in_reply_to_user_id_str: 2480 type: string 2481 lang: 2482 type: string 2483 place: 2484 $ref: '#/definitions/Places' 2485 possibly_sensitive: 2486 type: boolean 2487 quoted_status_id: 2488 type: integer 2489 quoted_status_id_str: 2490 type: string 2491 quoted_status: 2492 $ref: '#/definitions/Tweets' 2493 scopes: 2494 type: object 2495 additionalProperties: {} 2496 retweet_count: 2497 type: integer 2498 retweeted: 2499 type: boolean 2500 retweeted_status: 2501 $ref: '#/definitions/Tweets' 2502 source: 2503 type: string 2504 text: 2505 type: string 2506 truncated: 2507 type: string 2508 user: 2509 $ref: '#/definitions/Users' 2510 withheld_copyright: 2511 type: boolean 2512 withheld_countries: 2513 type: array 2514 items: 2515 type: string 2516 withheld_scope: 2517 type: string 2518 2519 Contributors: 2520 type: object 2521 properties: 2522 id: 2523 type: integer 2524 id_str: 2525 type: string 2526 screen_name: 2527 type: string 2528 2529 Coordinates: 2530 type: object 2531 properties: 2532 coordinates: 2533 type: array 2534 items: 2535 type: number 2536 type: 2537 type: string 2538 2539 Users: 2540 type: object 2541 properties: 2542 contributors_enabled: 2543 type: boolean 2544 created_at: 2545 type: string 2546 default_profile: 2547 type: boolean 2548 default_profile_image: 2549 type: boolean 2550 description: 2551 type: string 2552 entities: 2553 $ref: '#/definitions/Entities' 2554 favorites_count: 2555 type: integer 2556 follow_request_sent: 2557 type: boolean 2558 following: 2559 type: boolean 2560 followers_count: 2561 type: integer 2562 friends_count: 2563 type: integer 2564 geo_enabled: 2565 type: boolean 2566 id: 2567 type: integer 2568 id_str: 2569 type: string 2570 is_translator: 2571 type: boolean 2572 lang: 2573 type: string 2574 listed_count: 2575 type: integer 2576 location: 2577 type: string 2578 name: 2579 type: string 2580 notifications: 2581 type: boolean 2582 profile_background_color: 2583 type: string 2584 profile_background_image_url: 2585 type: string 2586 profile_background_image_url_https: 2587 type: string 2588 profile_background_tile: 2589 type: string 2590 profile_banner_url: 2591 type: string 2592 profile_image_url: 2593 type: string 2594 profile_image_url_https: 2595 type: string 2596 profile_link_color: 2597 type: string 2598 profile_sidebar_border_color: 2599 type: string 2600 profile_sidebar_fill_color: 2601 type: string 2602 profile_text_color: 2603 type: string 2604 profile_use_background_image: 2605 type: boolean 2606 protected: 2607 type: boolean 2608 screen_name: 2609 type: string 2610 show_all_inline_media: 2611 type: boolean 2612 status: 2613 $ref: '#/definitions/Tweets' 2614 statuses_count: 2615 type: integer 2616 time_zone: 2617 type: string 2618 url: 2619 type: string 2620 utc_offset: 2621 type: integer 2622 verified: 2623 type: boolean 2624 withheld_in_countries: 2625 type: string 2626 withheld_scope: 2627 type: string 2628 2629 Entities: 2630 type: object 2631 properties: 2632 hashtags: 2633 type: array 2634 items: 2635 $ref: '#/definitions/Hashtags' 2636 media: 2637 type: array 2638 items: 2639 $ref: '#/definitions/Media' 2640 urls: 2641 type: array 2642 items: 2643 $ref: '#/definitions/URL' 2644 user_mentions: 2645 type: array 2646 items: 2647 $ref: '#/definitions/User_Mention' 2648 2649 Hashtags: 2650 type: object 2651 properties: 2652 indices: 2653 type: array 2654 items: 2655 type: integer 2656 text: 2657 type: string 2658 2659 Media: 2660 type: object 2661 properties: 2662 display_url: 2663 type: string 2664 expanded_url: 2665 type: string 2666 id: 2667 type: integer 2668 id_str: 2669 type: string 2670 indices: 2671 type: array 2672 items: 2673 type: integer 2674 media_url: 2675 type: string 2676 media_url_https: 2677 type: string 2678 sizes: 2679 $ref: '#/definitions/Sizes' 2680 source_status_id: 2681 type: integer 2682 source_status_id_str: 2683 type: integer 2684 type: 2685 type: string 2686 url: 2687 type: string 2688 2689 Size: 2690 type: object 2691 properties: 2692 h: 2693 type: integer 2694 resize: 2695 type: string 2696 w: 2697 type: integer 2698 2699 2700 Sizes: 2701 type: object 2702 properties: 2703 thumb: 2704 $ref: '#/definitions/Size' 2705 large: 2706 $ref: '#/definitions/Size' 2707 medium: 2708 $ref: '#/definitions/Size' 2709 small: 2710 $ref: '#/definitions/Size' 2711 2712 URL: 2713 type: object 2714 properties: 2715 display_url: 2716 type: string 2717 expanded_url: 2718 type: string 2719 indices: 2720 type: string 2721 url: 2722 type: string 2723 2724 User_Mention: 2725 type: object 2726 properties: 2727 id: 2728 type: integer 2729 id_str: 2730 type: string 2731 indices: 2732 type: array 2733 items: 2734 type: integer 2735 name: 2736 type: string 2737 screen_name: 2738 type: string 2739 2740 Places: 2741 type: object 2742 properties: 2743 attributes: 2744 type: object 2745 additionalProperties: {} 2746 bounding_box: 2747 $ref: '#/definitions/Bounding_box' 2748 country: 2749 type: string 2750 country_code: 2751 type: string 2752 full_name: 2753 type: string 2754 id: 2755 type: string 2756 name: 2757 type: string 2758 place_type: 2759 type: string 2760 url: 2761 type: string 2762 2763 Bounding_box: 2764 type: object 2765 properties: 2766 coordinates: 2767 type: array 2768 items: 2769 type: array 2770 items: 2771 type: number 2772 type: 2773 type: string 2774 2775 Lists: 2776 type: object 2777 properties: 2778 created_at: 2779 type: string 2780 slug: 2781 type: string 2782 name: 2783 type: string 2784 description: 2785 type: string 2786 mode: 2787 type: string 2788 following: 2789 type: boolean 2790 user: 2791 $ref: '#/definitions/Users' 2792 member_count: 2793 type: integer 2794 id_str: 2795 type: string 2796 subscriber_count: 2797 type: integer 2798 id: 2799 type: integer 2800 uri: 2801 type: string 2802 2803 Cursor_lists: 2804 type: object 2805 properties: 2806 previous_cursor: 2807 type: integer 2808 lists: 2809 type: array 2810 items: 2811 $ref: '#/definitions/Lists' 2812 previous_cursor_str: 2813 type: string 2814 next_cursor: 2815 type: integer 2816 next_cursor_str: 2817 type: string 2818 2819 Cursor_users: 2820 type: object 2821 properties: 2822 previous_cursor: 2823 type: integer 2824 users: 2825 type: array 2826 items: 2827 $ref: '#/definitions/Users' 2828 previous_cursor_str: 2829 type: string 2830 next_cursor: 2831 type: integer 2832 next_cursor_str: 2833 type: string 2834 2835 Cursor_ids: 2836 type: object 2837 properties: 2838 previous_cursor: 2839 type: integer 2840 users: 2841 type: array 2842 items: 2843 type: integer 2844 previous_cursor_str: 2845 type: string 2846 next_cursor: 2847 type: integer 2848 next_cursor_str: 2849 type: string 2850 2851 Messages: 2852 type: object 2853 properties: 2854 created_at: 2855 type: string 2856 entities: 2857 $ref: '#/definitions/Entities' 2858 id: 2859 type: integer 2860 id_string: 2861 type: string 2862 recipient: 2863 $ref: '#/definitions/Users' 2864 recipient_id: 2865 type: integer 2866 recipient_screen_name: 2867 type: string 2868 sender: 2869 $ref: '#/definitions/Users' 2870 sender_id: 2871 type: integer 2872 sender_screen_name: 2873 type: string 2874 text: 2875 type: string 2876 2877 Query: 2878 type: object 2879 properties: 2880 created_at: 2881 type: string 2882 id: 2883 type: integer 2884 id_str: 2885 type: string 2886 name: 2887 type: string 2888 position: 2889 type: string 2890 query: 2891 type: string 2892 2893 Friendship: 2894 type: object 2895 properties: 2896 relationship: 2897 $ref: '#/definitions/Targets' 2898 source: 2899 $ref: '#/definitions/Source' 2900 2901 Targets: 2902 type: object 2903 properties: 2904 target: 2905 $ref: '#/definitions/Target' 2906 2907 Target: 2908 type: object 2909 properties: 2910 id_str: 2911 type: string 2912 id: 2913 type: integer 2914 followed_by: 2915 type: boolean 2916 screen_name: 2917 type: string 2918 following: 2919 type: boolean 2920 2921 Source: 2922 type: object 2923 properties: 2924 can_dm: 2925 type: boolean 2926 blocking: 2927 type: boolean 2928 id_str: 2929 type: boolean 2930 all_replies: 2931 type: boolean 2932 want_retweets: 2933 type: boolean 2934 id: 2935 type: integer 2936 marked_spam: 2937 type: boolean 2938 followed_by: 2939 type: boolean 2940 notifications_enable: 2941 type: boolean 2942 screen_name: 2943 type: string 2944 following: 2945 type: boolean 2946 2947 Settings: 2948 type: object 2949 properties: 2950 sleep_time: 2951 $ref: '#/definitions/Sleep' 2952 use_cookie_personalization: 2953 type: boolean 2954 trend_location: 2955 type: array 2956 items: 2957 $ref: '#/definitions/Location' 2958 language: 2959 type: string 2960 discoverable_by_email: 2961 type: boolean 2962 always_use_https: 2963 type: boolean 2964 protected: 2965 type: boolean 2966 geo_enabled: 2967 type: boolean 2968 show_all_inline_media: 2969 type: boolean 2970 screen_name: 2971 type: string 2972 2973 Sleep: 2974 type: object 2975 properties: 2976 end_time: 2977 type: string 2978 enabled: 2979 type: boolean 2980 start_time: 2981 type: string 2982 2983 Location: 2984 type: object 2985 properties: 2986 name: 2987 type: string 2988 placeType: 2989 $ref: '#/definitions/PlaceType' 2990 woeid: 2991 type: integer 2992 country: 2993 type: string 2994 url: 2995 type: string 2996 countryCode: 2997 type: string 2998 parentid: 2999 type: integer 3000 3001 PlaceType: 3002 type: object 3003 properties: 3004 name: 3005 type: string 3006 code: 3007 type: integer 3008 3009 TrendInfo: 3010 type: object 3011 properties: 3012 as_of: 3013 type: string 3014 created_at: 3015 type: string 3016 locations: 3017 type: array 3018 items: 3019 $ref: '#/definitions/Location' 3020 trends: 3021 type: array 3022 items: 3023 $ref: '#/definitions/Trends' 3024 3025 Trends: 3026 type: object 3027 properties: 3028 events: 3029 type: string 3030 name: 3031 type: string 3032 promoted_content: 3033 type: string 3034 query: 3035 type: string 3036 url: 3037 type: string 3038 3039 Help_Config: 3040 type: object 3041 properties: 3042 dm_text_character_limit: 3043 type: integer 3044 characters_reserved_per_media: 3045 type: integer 3046 max_media_per_upload: 3047 type: integer 3048 non_username_paths: 3049 type: array 3050 items: 3051 type: string 3052 photo_size_limit: 3053 type: integer 3054 photo_sizes: 3055 $ref: '#/definitions/Sizes' 3056 3057 Help_Language: 3058 type: object 3059 properties: 3060 code: 3061 type: string 3062 status: 3063 type: string 3064 name: 3065 type: string 3066 3067 Help_Privacy: 3068 type: object 3069 properties: 3070 privacy: 3071 type: string 3072 3073 Help_Tos: 3074 type: object 3075 properties: 3076 Tos: 3077 type: string 3078 3079 3080 3081 3082