/
twitter_swagger.json
9498 lines (9498 loc) · 531 KB
/
twitter_swagger.json
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
{
"swagger": "2.0",
"info": {
"version": "",
"title": "Twitter",
"description": "Access user data, geo, statuses and more with Twitter's REST API.",
"license": {
"name": "MIT",
"url": "http://github.com/gruntjs/grunt/blob/master/LICENSE-MIT"
}
},
"host": "search.twitter.com",
"basePath": "/",
"securityDefinitions": {},
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/statuses/mentions_timeline.json": {
"get": {
"description": "Returns the 20\n most recent mentions (tweets containing a users's @screen_name) for the authenticating user.The\n timeline returned is the equivalent of the one seen when you view your mentions on twitter.com.This\n method can only return up to 800 statuses.This method will include retweets in the JSON response\n regardless of whether the include_rts parameter is set.",
"operationId": "Get_statuses.mentions.timeline_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "count",
"in": "query",
"required": false,
"x-is-map": false,
"type": "integer",
"format": "int32",
"description": "Specifies the number of tweets to try and retrieve, up to a maximum of 200. The value of count is\n best thought of as a limit to the number of tweets to return because suspended or deleted content is\n removed after the count has been applied. We include retweets in the count, even if include_rts is\n not supplied. It is recommended you always send include_rts=1 when using this API method."
},
{
"name": "since_id",
"in": "query",
"required": false,
"x-is-map": false,
"type": "integer",
"format": "int64",
"description": "Returns results with an ID greater than (that is, more recent than) the specified ID. There are\n limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has\n occured since the since_id, the since_id will be forced to the oldest ID available."
},
{
"name": "max_id",
"in": "query",
"required": false,
"x-is-map": false,
"type": "integer",
"format": "int64",
"description": "Returns results with an ID less than (that is, older than) or equal to the specified ID."
},
{
"name": "trim_user",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "When set to either true, t or 1, each tweet returned in a timeline will include a user object\n including only the status authors numerical ID. Omit this parameter to receive the complete user\n object."
},
{
"name": "contributor_details",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "This parameter enhances the contributors element of the status response to include the screen_name\n of the contributor. By default only the user_id of the contributor is included."
},
{
"name": "include_entities",
"in": "query",
"required": false,
"x-is-map": false,
"type": "boolean",
"description": "The entities node will be disincluded when set to false."
}
],
"responses": {
"200": {
"description": "Access user data, geo, statuses and more with Twitter's REST API.",
"schema": {
"type": "object"
}
}
}
}
},
"/statuses/user_timeline.json": {
"get": {
"description": "Returns the 20 most\n recent statuses posted by the authenticating user. It is also possible to request another user's\n timeline by using the screen_name or user_id parameter. The other users timeline will only be\n visible if they are not protected, or if the authenticating user's follow request was accepted by\n the protected user. The timeline returned is the equivalent of the one seen when you view a user's\n profile on twitter.com. This method can only return up to 3,200 of a user's most recent statuses.\n Native retweets of other statuses by the user is included in this total, regardless of whether\n include_rts is specified when requesting this resource. This method will not include retweets in the\n XML and JSON responses unless the include_rts parameter is set. The RSS and Atom responses will\n always include retweets as statuses prefixed with RT, regardless of provided parameters. Always\n specify either an user_id or screen_name when requesting a user timeline.",
"operationId": "Get_statuses.user_timeline_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "count",
"in": "query",
"required": false,
"x-is-map": false,
"type": "integer",
"format": "int32",
"description": "Specifies the number of tweets to try and retrieve, up to a maximum of 200. The value of count is\n best thought of as a limit to the number of tweets to return because suspended or deleted content is\n removed after the count has been applied. We include retweets in the count, even if include_rts is\n not supplied. It is recommended you always send include_rts=1 when using this API method."
},
{
"name": "since_id",
"in": "query",
"required": false,
"x-is-map": false,
"type": "integer",
"format": "int64",
"description": "Returns results with an ID greater than (that is, more recent than) the specified ID. There are\n limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has\n occured since the since_id, the since_id will be forced to the oldest ID available."
},
{
"name": "max_id",
"in": "query",
"required": false,
"x-is-map": false,
"type": "integer",
"format": "int64",
"description": "Returns results with an ID less than (that is, older than) or equal to the specified ID."
},
{
"name": "trim_user",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "When set to either true, t or 1, each tweet returned in a timeline will include a user object\n including only the status authors numerical ID. Omit this parameter to receive the complete user\n object."
},
{
"name": "exclude_replies",
"in": "query",
"required": false,
"x-is-map": false,
"type": "boolean",
"description": "This parameter will prevent replies from appearing in the returned timeline. Using exclude_replies\n with the count parameter will mean you will receive up-to count tweets — this is because the count\n parameter retrieves that many tweets before filtering out retweets and replies. This parameter is\n only supported for JSON and XML responses."
},
{
"name": "contributor_details",
"in": "query",
"required": false,
"x-is-map": false,
"type": "boolean",
"description": "This parameter enhances the contributors element of the status response to include the screen_name\n of the contributor. By default only the user_id of the contributor is included."
},
{
"name": "include_rts",
"in": "query",
"required": false,
"x-is-map": false,
"type": "boolean",
"description": "When set to false, the timeline will strip any native retweets (though they will still count toward\n both the maximal length of the timeline and the slice selected by the count parameter). Note: If\n you're using the trim_user parameter in conjunction with include_rts, the retweets will still\n contain a full user object."
}
],
"responses": {
"200": {
"description": "Access user data, geo, statuses and more with Twitter's REST API.",
"schema": {
"type": "object"
}
}
}
}
},
"/statuses/home_timeline.json": {
"get": {
"description": "Returns a collection\n of the most recent Tweets and retweets posted by the authenticating user and the users they follow.\n The home timeline is central to how most users interact with the Twitter service.\n\n Up to 800 Tweets are obtainable on the home timeline. It is more volatile for users that follow many\n users or follow users who tweet frequently.",
"operationId": "Get_statuses.home_timeline_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "count",
"in": "query",
"required": false,
"x-is-map": false,
"type": "integer",
"format": "int32",
"description": "Specifies the number of records to retrieve. Must be less than or equal to 200."
},
{
"name": "max_id",
"in": "query",
"required": false,
"x-is-map": false,
"type": "integer",
"format": "int64",
"description": "Returns results with an ID less than (that is, older than) or equal to the specified ID."
},
{
"name": "since_id",
"in": "query",
"required": false,
"x-is-map": false,
"type": "integer",
"format": "int64",
"description": "Returns results with an ID greater than (that is, more recent than) the specified ID. There are\n limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has\n occured since the since_id, the since_id will be forced to the oldest ID available."
},
{
"name": "trim_user",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "When set to either true, t or 1, each tweet returned in a timeline will include a user object\n including only the status authors numerical ID. Omit this parameter to receive the complete user\n object."
},
{
"name": "exclude_replies",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "This parameter will prevent replies from appearing in the returned timeline. Using exclude_replies\n with the count parameter will mean you will receive up-to count tweets — this is because the count\n parameter retrieves that many tweets before filtering out retweets and replies."
},
{
"name": "contributor_details",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "This parameter enhances the contributors element of the status response to include the screen_name\n of the contributor. By default only the user_id of the contributor is included."
}
],
"responses": {
"200": {
"description": "Access user data, geo, statuses and more with Twitter's REST API.",
"schema": {
"type": "object"
}
}
}
}
},
"/statuses/retweets/{id}.json": {
"get": {
"description": "Returns up to 100 of\n the\n first retweets of a given tweet.",
"operationId": "Get_statuses.retweets_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"x-is-map": false,
"type": "string",
"description": "The numerical ID of the desired status."
},
{
"name": "count",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Specifies the number of records to retrieve. Must be less than or equal to 100."
},
{
"name": "trim_user",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "When set to either true, t or 1, each tweet returned in a timeline will include a user object\n including only the status authors numerical ID. Omit this parameter to receive the complete user\n object."
}
],
"responses": {
"200": {
"description": "Access user data, geo, statuses and more with Twitter's REST API.",
"schema": {
"type": "object"
}
}
}
}
},
"/statuses/show/{id}.json": {
"get": {
"description": "Returns a single status,\n specified by the id parameter below. The status's author will be returned inline.",
"operationId": "Get_statuses.show_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"x-is-map": false,
"type": "string",
"description": "The numerical ID of the desired status."
},
{
"name": "trim_user",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "When set to either true, t or 1, each tweet returned in a timeline will include a user object\n including only the status authors numerical ID. Omit this parameter to receive the complete user\n object."
},
{
"name": "include_my_retweet",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "When set to either true, t or 1, any Tweets returned that have been retweeted by the authenticating\n user will include an additional current_user_retweet node, containing the ID of the source status\n for the retweet."
},
{
"name": "include_entities",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "The entities node will be disincluded when set to false."
}
],
"responses": {
"200": {
"description": "Access user data, geo, statuses and more with Twitter's REST API.",
"schema": {
"type": "object"
}
}
}
}
},
"/statuses/destroy/{id}.json": {
"post": {
"description": "Destroys the status\n specified by the required ID parameter. The authenticating user must be the author of the specified\n status. Returns the destroyed status if successful.",
"operationId": "Create_statuses.destroy_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"x-is-map": false,
"type": "string",
"description": "The numerical ID of the desired status."
},
{
"name": "trim_user",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "When set to either true, t or 1, each tweet returned in a timeline will include a user object\n including only the status authors numerical ID. Omit this parameter to receive the complete user\n object."
}
],
"responses": {
"200": {
"description": "Access user data, geo, statuses and more with Twitter's REST API.",
"schema": {
"type": "object"
}
}
}
}
},
"/statuses/update.json": {
"post": {
"description": "Updates the authenticating\n user's status, also known as tweeting. To upload an image to accompany the tweet, use POST\n statuses/update_with_media (https://dev.twitter.com/docs/api/1/post/statuses/update_with_media). For\n each update attempt, the update text is compared with the authenticating user's recent tweets. Any\n attempt that would result in duplication will be blocked, resulting in a 403 error. Therefore, a\n user cannot submit the same status twice in a row. While not rate limited by the API a user is\n limited in the number of tweets they can create at a time. If the number of updates posted by the\n user reaches the current allowed limit this method will return an HTTP 403 error.",
"operationId": "Create_statuses.update_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "status",
"in": "query",
"required": true,
"x-is-map": false,
"default": "Posting from @apigee's API test console. It's like a command line for the Twitter API! #apitools",
"type": "string",
"description": "The text of your status update, typically up to 140 characters. URL encode as necessary. t.co link\n short-url wrapping (https://dev.twitter.com/docs/tco-link-wrapper/faq) may effect character counts."
},
{
"name": "in_reply_to_status_id",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "The ID of an existing status that the update is in reply to. Note: This parameter will be ignored\n unless the author of the tweet this parameter references is mentioned within the status text.\n Therefore, you must include @username, where username is the author of the referenced tweet, within\n the update."
},
{
"name": "lat",
"in": "query",
"required": false,
"x-is-map": false,
"default": "37.426363",
"type": "string",
"description": "The latitude of the location this tweet refers to. This parameter will be ignored unless it is\n inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there\n isn't a corresponding long parameter."
},
{
"name": "long",
"in": "query",
"required": false,
"x-is-map": false,
"default": "-122.141114",
"type": "string",
"description": "The longitude of the location this tweet refers to. The valid ranges for longitude is -180.0 to\n +180.0 (East is positive) inclusive. This parameter will be ignored if outside that range, if it is\n not a number, if geo_enabled is disabled, or if there not a corresponding lat parameter."
},
{
"name": "place_id",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "A place in the world. These IDs can be retrieved from GET geo/reverse_geocode\n (https://dev.twitter.com/docs/api/1/get/geo/reverse_geocode)."
},
{
"name": "display_coordinates",
"in": "query",
"required": false,
"x-is-map": false,
"default": "false",
"type": "object",
"description": "Whether or not to put a pin on the exact coordinates a tweet has been sent from."
},
{
"name": "trim_user",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "When set to either true, t or 1, each tweet returned in a timeline will include a user object\n including only the status authors numerical ID. Omit this parameter to receive the complete user\n object."
}
],
"responses": {
"200": {
"description": "Access user data, geo, statuses and more with Twitter's REST API.",
"schema": {
"type": "object"
}
}
}
}
},
"/statuses/retweet/{id}.json": {
"post": {
"description": "Retweets a tweet.\n Returns\n the original tweet with retweet details embedded.",
"operationId": "Create_statusesretweetid_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"x-is-map": false,
"type": "string",
"description": "The numerical ID of the desired status."
},
{
"name": "trim_user",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "When set to either true, t or 1, each tweet returned in a timeline will include a user object\n including only the status authors numerical ID. Omit this parameter to receive the complete user\n object."
}
],
"responses": {
"200": {
"description": "Access user data, geo, statuses and more with Twitter's REST API.",
"schema": {
"type": "object"
}
}
}
}
},
"/statuses/update_with_media.json": {
"post": {
"description": "Updates the\n authenticating user's status and attaches media for upload. Unlike POST statuses/update\n (https://dev.twitter.com/docs/api/1.1/post/statuses/update), this method expects raw multipart data.\n Your POST request's Content-Type should be set to multipart/form-data with the media[] parameter.\n The Tweet text will be rewritten to include the media URL(s), which will reduce the number of\n characters allowed in the Tweet text. If the URL(s) cannot be appended without text truncation, the\n tweet will be rejected and this method will return an HTTP 403 error. Important: Make sure that\n you're using upload.twitter.com as your host while posting statuses with media. It is strongly\n recommended to use SSL with this method.",
"operationId": "Create_statuses.update_with_media_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "query",
"required": true,
"x-is-map": false,
"default": "multipart/form-data",
"type": "string",
"description": "Content type."
},
{
"name": "status",
"in": "query",
"required": true,
"x-is-map": false,
"type": "string",
"description": "The text of your status update. URL encode as necessary. t.co link wrapping\n (https://dev.twitter.com/docs/tco-link-wrapper/faq) may affect character counts if the post contains\n URLs. You must additionally account for the characters_reserved_per_media per uploaded media,\n additionally accounting for space characters in between finalized URLs. Note: Request the GET\n help/configuration (https://dev.twitter.com/docs/api/1.1/get/help/configuration) endpoint to get the\n current characters_reserved_per_media and max_media_per_upload values."
},
{
"name": "media",
"in": "query",
"required": true,
"x-is-map": false,
"type": "string",
"description": "Up to max_media_per_upload files may be specified in the request, each named media[]. Supported\n image formats are PNG, JPG and GIF. Animated GIFs are not supported. Note: Request the GET\n help/configuration (https://dev.twitter.com/docs/api/1.1/get/help/configuration) endpoint to get the\n current max_media_per_upload and photo_size_limit values."
},
{
"name": "possibly_sensitive",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Set to true for content which may not be suitable for every audience."
},
{
"name": "in_reply_to_status_id",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "The ID of an existing status that the update is in reply to. Note: This parameter will be ignored\n unless the author of the tweet this parameter references is mentioned within the status text.\n Therefore, you must include @username, where username is the author of the referenced tweet, within\n the update."
},
{
"name": "lat",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "The latitude of the location this tweet refers to. This parameter will be ignored unless it is\n inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there\n isn't a corresponding long parameter. Example value: 37.7821120598956."
},
{
"name": "long",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "The longitude of the location this tweet refers to. The valid ranges for longitude is -180.0 to\n +180.0 (East is positive) inclusive. This parameter will be ignored if outside that range, not a\n number, geo_enabled is disabled, or if there not a corresponding lat parameter. Example value:\n -122.400612831116."
},
{
"name": "place_id",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "A place in the world identified by a Twitter place ID. Place IDs can be retrieved from\n geo/reverse_geocode."
},
{
"name": "display_coordinates",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Whether or not to put a pin on the exact coordinates a tweet has been sent from."
}
],
"responses": {
"200": {
"description": "Access user data, geo, statuses and more with Twitter's REST API.",
"schema": {
"type": "object"
}
}
}
}
},
"/statuses/oembed.json": {
"get": {
"description": "Returns information allowing\n the creation of an embedded representation of a Tweet on third party sites. See the oEmbed\n specification (http://oembed.com) for information about the response format. Either the id or url\n parameters must be specified in a request, it is not necessary to include both. While this endpoint\n allows a bit of customization for the final appearance of the embedded Tweet, be aware that the\n appearance of the rendered Tweet may change over time to be consistent with Twitter's Display\n Guidelines (https://dev.twitter.com/terms/display-guidelines). Do not rely on any class or id\n parameters to stay constant in the returned markup.",
"operationId": "Get_statuses.oembed_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "maxwidth",
"in": "query",
"required": false,
"x-is-map": false,
"type": "integer",
"format": "int32",
"description": "The maximum width in pixels that the embed should be rendered at. This value is constrained to be\n between 250 and 550 pixels. Note that Twitter does not support the oEmbed maxheight parameter.\n Tweets are fundamentally text, and are therefore of unpredictable height that cannot be scaled like\n an image or video. Relatedly, the oEmbed response will not provide a value for height.\n Implementations that need consistent heights for Tweets should refer to the hide_thread and\n hide_media parameters below."
},
{
"name": "hide_media",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Specifies whether the embedded Tweet should automatically expand images which were uploaded via\n POST statuses/update_with_media. When set to either true, t or\n 1 images will not be expanded. Defaults to false."
},
{
"name": "hide_thread",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Specifies whether the embedded Tweet should automatically show the original message in the case\n that the embedded Tweet is a reply. When set to either true, t or 1 the original Tweet will not be\n shown. Defaults to false."
},
{
"name": "omit_script",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Specifies whether the embedded Tweet HTML should include a\n 'script' element pointing to widgets.js. In cases where a page already includes widgets.js, setting\n this\n value to true will prevent a redundant script element from being included. When set to either true,\n t or 1 the 'script'element will not be included in the embed HTML, meaning that pages must include a\n reference to\n widgets.js manually. Defaults to false."
},
{
"name": "align",
"in": "query",
"required": false,
"x-is-map": false,
"enum": [
"left",
"right",
"center",
"none"
],
"type": "string",
"description": "Specifies whether the embedded Tweet should be left aligned, right aligned, or centered in the\n page. Valid values are left, right, center, and none. Defaults to none, meaning no alignment styles\n are specified for the Tweet."
},
{
"name": "related",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "A value for the TWT related parameter, as described in Web Intents\n (https://dev.twitter.com/docs/intents). This value will be forwarded to all Web Intents calls.\n Example values: twitterapi, twittermedia, twitter."
},
{
"name": "lang",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Language code for the rendered embed. This will affect the text and localization of the rendered\n HTML. Example value: fr"
}
],
"responses": {
"200": {
"description": "Access user data, geo, statuses and more with Twitter's REST API.",
"schema": {
"type": "object"
}
}
}
}
},
"/search/tweets.json": {
"get": {
"description": "Returns a collection of\n relevant Tweets matching a specified query.\n\n Please note that Twitter's search service and, by extension, the Search API is not meant to be an\n exhaustive source of Tweets. Not all Tweets will be indexed or made available via the search\n interface.\n\n In API v1.1, the response format of the Search API has been improved to return Tweet objects more\n similar to the objects you'll find across the REST API and platform. You may need to tolerate some\n inconsistencies and variance in perspectival values (fields that pertain to the perspective of the\n authenticating user) and embedded user objects.",
"operationId": "search.tweets_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "q",
"in": "query",
"required": true,
"x-is-map": false,
"type": "string",
"description": "A UTF-8, URL-encoded search query of 1,000 characters maximum, including operators. Queries may\n additionally be limited by complexity.Example: @noradio."
},
{
"name": "geocode",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Returns tweets by users located within a given radius of the given latitude/longitude. The location\n is preferentially taking from the Geotagging API, but will fall back to their Twitter profile. The\n parameter value is specified by \"latitude,longitude,radius\", where radius units must be specified as\n either \"mi\" (miles) or \"km\" (kilometers). Note that you cannot use the near operator via the API to\n geocode arbitrary locations; however you can use this geocode parameter to search near geocodes\n directly. A maximum of 1,000 distinct \"sub-regions\" will be considered when using the radius\n modifier."
},
{
"name": "lang",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Restricts tweets to the given language, given by an ISO 639-1 code. Language detection is\n best-effort.Example Values: eu"
},
{
"name": "locale",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Specify the language of the query you are sending (only ja is currently effective). This is\n intended for language-specific consumers and the default should work in the majority of\n cases.Example Values: ja"
},
{
"name": "result_type",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Optional. Specifies what type of search results you would prefer to receive. The current default is\n \"mixed.\" Valid values include:\n * mixed: Include both popular and real time results in the response.\n * recent: return only the most recent results in the response\n * popular: return only the most popular results in the response. Example Values: mixed, recent,\n popular"
},
{
"name": "count",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "The number of tweets to return per page, up to a maximum of 100. Defaults to 15. This was formerly\n the \"rpp\" parameter in the old Search API. Example Values: 100"
},
{
"name": "until",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Returns tweets generated before the given date. Date should be formatted as YYYY-MM-DD. Keep in\n mind that the search index may not go back as far as the date you specify here. Example Values:\n 2012-09-01"
},
{
"name": "since_id",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Returns results with an ID greater than (that is, more recent than) the specified ID. There are\n limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has\n occured since the since_id, the since_id will be forced to the oldest ID available. Example Values:\n 12345"
},
{
"name": "max_id",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Returns results with an ID less than (that is, older than) or equal to the specified ID. Example\n Values: 12345"
},
{
"name": "include_entities",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "The entities node will be disincluded when set to false. Example Values: false"
},
{
"name": "callback",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "If supplied, the response will use the JSONP format with a callback of the given name. The\n usefulness of this parameter is somewhat diminished by the requirement of authentication for\n requests to this endpoint. Example Values: processTweets"
}
],
"responses": {
"200": {
"description": "Access user data, geo, statuses and more with Twitter's REST API.",
"schema": {
"type": "object"
}
}
}
}
},
"/help/configuration.json": {
"get": {
"description": "Returns the current\n configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo\n resolutions, and t.co URL lengths.\n\n It is recommended applications request this endpoint when they are loaded, but no more than once a\n day.",
"operationId": "Get_help.configurations_",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "Access user data, geo, statuses and more with Twitter's REST API.",
"schema": {
"type": "object"
}
}
}
}
},
"/help/languages.json": {
"get": {
"description": "Returns the list of languages\n supported by Twitter along with their ISO 639-1 code. The ISO 639-1 code is the two letter value to\n use if you include lang with any of your requests.",
"operationId": "Get_help.languages_",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "Access user data, geo, statuses and more with Twitter's REST API.",
"schema": {
"type": "object"
}
}
}
}
},
"/help/privacy.json": {
"get": {
"description": "Returns Twitter's Privacy Policy",
"operationId": "Get_help.privacy_",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "Access user data, geo, statuses and more with Twitter's REST API.",
"schema": {
"type": "object"
}
}
}
}
},
"/help/tos.json": {
"get": {
"description": "Returns the Twitter Terms of Service\n in the requested format. These are not the same as the Developer Rules of the Road.",
"operationId": "Get_help.tos_",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "Access user data, geo, statuses and more with Twitter's REST API.",
"schema": {
"type": "object"
}
}
}
}
},
"/application/rate_limit_status.json": {
"get": {
"description": "Returns the\n current rate limits for\n methods belonging to the specified resource families.\n\n Each 1.1 API resource belongs to a \"resource family\" which is indicated in its method documentation.\n You can typically determine a method's resource family from the first component of the path after\n the resource version.\n\n This method responds with a map of methods belonging to the families specified by the resources\n parameter, the current remaining uses for each of those resources within the current rate limiting\n window, and its expiration time in epoch time. It also includes a rate_limit_context field that\n indicates the current access token context.\n\n You may also issue requests to this method without any parameters to receive a map of all rate\n limited GET methods. If your application only uses a few of methods, please explicitly provide a\n resources parameter with the specified resource families you work with.",
"operationId": "Get_application.rate_limit_status_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "resources",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "A comma-separated list of resource families you want to know the current rate limit disposition\n for. For best performance, only specify the resource families pertinent to your application.Example\n Values: statuses,friends,trends,help"
}
],
"responses": {
"200": {
"description": "Access user data, geo, statuses and more with Twitter's REST API.",
"schema": {
"type": "object"
}
}
}
}
},
"/users/report_spam.json": {
"post": {
"description": "The user\n specified in the id is blocked by the authenticated user and reported as a spammer.",
"operationId": "Create_users.report_spam_",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "Access user data, geo, statuses and more with Twitter's REST API.",
"schema": {
"type": "object"
}
}
}
}
},
"/trends/place.json": {
"get": {
"description": "Returns the top 10 trending\n topics for a specific WOEID, if trending information is available for it.\n\n The response is an array of \"trend\" objects that encode the name of the trending topic, the query\n parameter that can be used to search for the topic on Twitter Search, and the Twitter Search URL.\n\n This information is cached for 5 minutes. Requesting more frequently than that will not return any\n more data, and will count against your rate limit usage.",
"operationId": "Get_trends.place_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"x-is-map": false,
"type": "string",
"description": "The Yahoo! Where On Earth ID of the location to return trending information for. Global information\n is available by using 1 as the WOEID."
},
{
"name": "exclude",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Setting this equal to hashtags will remove all hashtags from the trends list."
}
],
"responses": {
"200": {
"description": "Access user data, geo, statuses and more with Twitter's REST API.",
"schema": {
"type": "object"
}
}
}
}
},
"/trends/available.json": {
"get": {
"description": "Returns the locations that\n Twitter has trending topic information for.\n\n The response is an array of \"locations\" that encode the location's WOEID and some other\n human-readable information such as a canonical name and country the location belongs in.\n\n A WOEID is a Yahoo! Where On Earth ID.",
"operationId": "Get_trends.available_",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "Access user data, geo, statuses and more with Twitter's REST API.",
"schema": {
"type": "object"
}
}
}
}
},
"/trends/closest.json": {
"get": {
"description": "Returns the locations that\n Twitter has trending topic information for, closest to a specified location.\n\n The response is an array of \"locations\" that encode the location's WOEID and some other\n human-readable information such as a canonical name and country the location belongs in.\n\n A WOEID is a Yahoo! Where On Earth ID.",
"operationId": "Get_trends.closest_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "lat",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "If provided with a long parameter the available trend locations will be sorted by distance, nearest\n to furthest, to the co-ordinate pair. The valid ranges for longitude is -180.0 to +180.0 (West is\n negative, East is positive) inclusive.\n\n Example Values: 37.781157"
},
{
"name": "long",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "If provided with a lat parameter the available trend locations will be sorted by distance, nearest\n to furthest, to the co-ordinate pair. The valid ranges for longitude is -180.0 to +180.0 (West is\n negative, East is positive) inclusive.\n\n Example Values: -122.400612831116"
}
],
"responses": {
"200": {
"description": "Access user data, geo, statuses and more with Twitter's REST API.",
"schema": {
"type": "object"
}
}
}
}
},
"/geo/id/{place_id}.json": {
"get": {
"description": "Returns all the\n information about a known place.Example Values: df51dec6f4ee2b2c",
"operationId": "Get_geo.place_id_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "place_id",
"in": "path",
"required": true,
"x-is-map": false,
"type": "string",
"description": "A place in the world. These IDs can be retrieved from geo/reverse_geocode.\n\n Example Values: df51dec6f4ee2b2c"
}
],
"responses": {
"200": {
"description": "Access user data, geo, statuses and more with Twitter's REST API.",
"schema": {
"type": "object"
}
}
}
}
},
"/geo/reverse_geocode.json": {
"get": {