aboutsummaryrefslogtreecommitdiffstats
path: root/frontend/src/lib/apidocs.js
blob: 9757501a47da7840865b2af28f3b684859f5244c (plain)
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
export default {
  "namespaces": {
    "tweets": [
      {
        "method": "GET",
        "description": "Returns a single Tweet, specified by ID.",
        "path": "tweets/show",
        "params": {
          "id": {
            "required": true,
            "description": "The numerical ID of the desired Tweet.",
            "type": "Integer"
          }
        },
        "example_params": {
          "id": 43341783446466560
        }
      },
      {
        "method": "GET",
        "description": "Returns Tweets, specified by comma-separated IDs.",
        "path": "tweets/lookup",
        "params": {
          "ids": {
            "required": true,
            "description": "A comma-separated list of Tweet IDs, up to 100 are allowed in a single request.",
            "type": "String"
          }
        },
        "example_params": {
          "ids": "43341783446466560,340640143058825216"
        }
      },
      {
        "method": "GET",
        "description": "Returns the best Tweets of a user, specified by username or user ID.",
        "path": "tweets/user_best",
        "params": {
          "user_id": {
            "required": false,
            "description": "The numerical ID of the user for whom to return results for.",
            "type": "Integer"
          },
          "screen_name": {
            "required": false,
            "description": "The username of the user for whom to return results for.",
            "type": "String"
          },
          "count": {
            "required": false,
            "description": "The number of tweets to retrieve. Must be less than or equal to 100, defaults to 10.",
            "type": "Integer"
          },
          "page": {
            "required": false,
            "description": "The page number of results to retrieve.",
            "type": "Integer"
          },
          "recent": {
            "required": false,
            "description": "When specified, returns only recent tweets in the term. Format is: /^\\d+[dwmy]$/",
            "type": "String"
          }
        },
        "example_params": {
          "user_id": 15926668,
          "count": 2,
          "page": 3,
          "recent": "1m"
        }
      },
      {
        "method": "GET",
        "description": "Returns the newest Tweets of a user, specified by username or user ID.",
        "path": "tweets/user_timeline",
        "params": {
          "user_id": {
            "required": false,
            "description": "The numerical ID of the user for whom to return results for.",
            "type": "Integer"
          },
          "screen_name": {
            "required": false,
            "description": "The username of the user for whom to return results for.",
            "type": "String"
          },
          "count": {
            "required": false,
            "description": "The number of tweets to retrieve. Must be less than or equal to 100, defaults to 10.",
            "type": "Integer"
          },
          "page": {
            "required": false,
            "description": "The page number of results to retrieve.",
            "type": "Integer"
          },
          "since_id": {
            "required": false,
            "description": "Returns results with an ID greater than the specified ID.",
            "type": "Integer"
          },
          "max_id": {
            "required": false,
            "description": "Returns results with an ID less than or equal to the specified ID.",
            "type": "Integer"
          },
          "reactions": {
            "required": false,
            "description": "Returns Tweets which has received reactions more than (or equal to) the specified number of times.",
            "type": "Integer"
          }
        },
        "example_params": {
          "screen_name": "toshi_a",
          "count": 3,
          "max_id": 432112694871605250
        }
      },
      {
        "method": "GET",
        "description": "Returns the Tweets which a user specified by username or user ID favorited.",
        "path": "tweets/user_favorites",
        "params": {
          "user_id": {
            "required": false,
            "description": "The numerical ID of the user for whom to return results for.",
            "type": "Integer"
          },
          "screen_name": {
            "required": false,
            "description": "The username of the user for whom to return results for.",
            "type": "String"
          },
          "count": {
            "required": false,
            "description": "The number of tweets to retrieve. Must be less than or equal to 100, defaults to 10.",
            "type": "Integer"
          },
          "page": {
            "required": false,
            "description": "The page number of results to retrieve.",
            "type": "Integer"
          },
          "reactions": {
            "required": false,
            "description": "Returns Tweets which has received reactions more than (or equal to) the specified number of times.",
            "type": "Integer"
          }
        },
        "example_params": {
          "user_id": 120726371,
          "count": 2
        }
      },
      {
        "method": "GET",
        "description": "Returns the specified user's Tweets which another specified user favorited.",
        "path": "tweets/user_favorited_by",
        "params": {
          "user_id": {
            "required": false,
            "description": "The numerical ID of the user for whom to return results for.",
            "type": "Integer"
          },
          "screen_name": {
            "required": false,
            "description": "The username of the user for whom to return results for.",
            "type": "String"
          },
          "source_user_id": {
            "required": false,
            "description": "The numerical ID of the user for whom to return results for.",
            "type": "Integer"
          },
          "source_screen_name": {
            "required": false,
            "description": "The username of the user for whom to return results for.",
            "type": "String"
          },
          "count": {
            "required": false,
            "description": "The number of tweets to retrieve. Must be less than or equal to 100, defaults to 10.",
            "type": "Integer"
          },
          "page": {
            "required": false,
            "description": "The page number of results to retrieve.",
            "type": "Integer"
          },
          "since_id": {
            "required": false,
            "description": "Returns results with an ID greater than the specified ID.",
            "type": "Integer"
          },
          "max_id": {
            "required": false,
            "description": "Returns results with an ID less than or equal to the specified ID.",
            "type": "Integer"
          },
          "reactions": {
            "required": false,
            "description": "Returns Tweets which has received reactions more than (or equal to) the specified number of times.",
            "type": "Integer"
          }
        },
        "example_params": {
          "user_id": 120726371,
          "count": 2,
          "source_screen_name": "haru067"
        }
      }
    ],
      "users": [
        {
          "method": "GET",
          "description": "Returns the stats of a user, specified by username or user ID.",
          "path": "users/stats",
          "params": {
            "id": {
              "required": false,
              "description": "The numerical ID of the user for whom to return results for.",
              "type": "Integer"
            },
            "screen_name": {
              "required": false,
              "description": "The username of the user for whom to return results for.",
              "type": "String"
            }
          },
          "example_params": {
            "id": 15926668
          }
        },
        {
          "method": "GET",
          "description": "Returns the list of the users who discovered the Tweets of a user, specified by username or user ID.",
          "path": "users/discovered_by",
          "params": {
            "id": {
              "required": false,
              "description": "The numerical ID of the user for whom to return results for.",
              "type": "Integer"
            },
            "screen_name": {
              "required": false,
              "description": "The username of the user for whom to return results for.",
              "type": "String"
            }
          },
          "example_params": {
            "id": 15926668
          }
        },
        {
          "method": "GET",
          "description": "Returns the list of the users discovered by a user, specified by username or user ID.",
          "path": "users/discovered_users",
          "params": {
            "id": {
              "required": false,
              "description": "The numerical ID of the user for whom to return results for.",
              "type": "Integer"
            },
            "screen_name": {
              "required": false,
              "description": "The username of the user for whom to return results for.",
              "type": "String"
            }
          },
          "example_params": {
            "screen_name": "toshi_a"
          }
        }
      ]
  }
};