-
-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
client.py
1501 lines (1293 loc) · 60.3 KB
/
client.py
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
# Tweepy
# Copyright 2009-2021 Joshua Roesslein
# See LICENSE for details.
from collections import namedtuple
import datetime
import logging
from platform import python_version
import time
import requests
import tweepy
from tweepy.auth import OAuthHandler
from tweepy.errors import (
BadRequest, Forbidden, HTTPException, TooManyRequests, TwitterServerError,
Unauthorized
)
from tweepy.media import Media
from tweepy.place import Place
from tweepy.poll import Poll
from tweepy.tweet import Tweet
from tweepy.user import User
log = logging.getLogger(__name__)
Response = namedtuple("Response", ("data", "includes", "errors", "meta"))
class Client:
"""Client( \
bearer_token=None, consumer_key=None, consumer_secret=None, \
access_token=None, access_token_secret=None, *, return_type=Response, \
wait_on_rate_limit=False \
)
Twitter API v2 Client
Parameters
----------
bearer_token : Optional[str]
Twitter API Bearer Token
consumer_key : Optional[str]
Twitter API Consumer Key
consumer_secret : Optional[str]
Twitter API Consumer Secret
access_token : Optional[str]
Twitter API Access Token
access_token_secret : Optional[str]
Twitter API Access Token Secret
return_type : Type[dict, requests.Response, Response]
Type to return from requests to the API
wait_on_rate_limit : bool
Whether to wait when rate limit is reached
Attributes
----------
session : requests.Session
Requests Session used to make requests to the API
user_agent : str
User agent used when making requests to the API
"""
def __init__(
self, bearer_token=None, consumer_key=None, consumer_secret=None,
access_token=None, access_token_secret=None, *, return_type=Response,
wait_on_rate_limit=False
):
self.bearer_token = bearer_token
self.consumer_key = consumer_key
self.consumer_secret = consumer_secret
self.access_token = access_token
self.access_token_secret = access_token_secret
self.return_type = return_type
self.wait_on_rate_limit = wait_on_rate_limit
self.session = requests.Session()
self.user_agent = (
f"Python/{python_version()} "
f"Requests/{requests.__version__} "
f"Tweepy/{tweepy.__version__}"
)
def request(self, method, route, params=None, json=None, user_auth=False):
host = "https://api.twitter.com"
headers = {"User-Agent": self.user_agent}
auth = None
if user_auth:
auth = OAuthHandler(self.consumer_key, self.consumer_secret)
auth.set_access_token(self.access_token, self.access_token_secret)
auth = auth.apply_auth()
else:
headers["Authorization"] = f"Bearer {self.bearer_token}"
log.debug(
f"Making API request: {method} {host + route}\n"
f"Parameters: {params}\n"
f"Headers: {headers}\n"
f"Body: {json}"
)
with self.session.request(
method, host + route, params=params, json=json, headers=headers,
auth=auth
) as response:
log.debug(
"Received API response: "
f"{response.status_code} {response.reason}\n"
f"Headers: {response.headers}\n"
f"Content: {response.content}"
)
if response.status_code == 400:
raise BadRequest(response)
if response.status_code == 401:
raise Unauthorized(response)
if response.status_code == 403:
raise Forbidden(response)
# Handle 404?
if response.status_code == 429:
if self.wait_on_rate_limit:
reset_time = int(response.headers["x-rate-limit-reset"])
sleep_time = reset_time - int(time.time()) + 1
if sleep_time > 0:
log.warning(
"Rate limit exceeded. "
f"Sleeping for {sleep_time} seconds."
)
time.sleep(sleep_time)
return self.request(method, route, params, json, user_auth)
else:
raise TooManyRequests(response)
if response.status_code >= 500:
raise TwitterServerError(response)
if not 200 <= response.status_code < 300:
raise HTTPException(response)
return response
def _make_request(self, method, route, params={}, endpoint_parameters=None,
json=None, data_type=None, user_auth=False):
request_params = {}
for param_name, param_value in params.items():
if param_name.replace('_', '.') in endpoint_parameters:
param_name = param_name.replace('_', '.')
if isinstance(param_value, list):
request_params[param_name] = ','.join(map(str, param_value))
elif isinstance(param_value, datetime.datetime):
if param_value.tzinfo is not None:
param_value = param_value.astimezone(datetime.timezone.utc)
request_params[param_name] = param_value.strftime("%Y-%m-%dT%H:%M:%S.%fZ")
# TODO: Constant datetime format string?
else:
request_params[param_name] = param_value
if param_name not in endpoint_parameters:
log.warn(f"Unexpected parameter: {param_name}")
response = self.request(method, route, params=request_params,
json=json, user_auth=user_auth)
if self.return_type is requests.Response:
return response
response = response.json()
if self.return_type is dict:
return response
data = response.get("data")
if data_type is not None:
if isinstance(data, list):
data = [data_type(result) for result in data]
elif data is not None:
data = data_type(data)
includes = response.get("includes", {})
if "media" in includes:
includes["media"] = [Media(media) for media in includes["media"]]
if "places" in includes:
includes["places"] = [Place(place) for place in includes["places"]]
if "poll" in includes:
includes["polls"] = [Poll(poll) for poll in includes["polls"]]
if "tweets" in includes:
includes["tweets"] = [Tweet(tweet) for tweet in includes["tweets"]]
if "users" in includes:
includes["users"] = [User(user) for user in includes["users"]]
errors = response.get("errors", [])
meta = response.get("meta", {})
return Response(data, includes, errors, meta)
# Hide replies
def hide_reply(self, id):
"""Hides a reply to a Tweet.
Parameters
----------
id : Union[int, str]
Unique identifier of the Tweet to hide. The Tweet must belong to a
conversation initiated by the authenticating user.
Returns
-------
Union[dict, requests.Response, Response]
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/hide-replies/api-reference/put-tweets-id-hidden
"""
return self._make_request(
"PUT", f"/2/tweets/{id}/hidden", json={"hidden": True},
user_auth=True
)
def unhide_reply(self, id):
"""Unhides a reply to a Tweet.
Parameters
----------
id : Union[int, str]
Unique identifier of the Tweet to unhide. The Tweet must belong to
a conversation initiated by the authenticating user.
Returns
-------
Union[dict, requests.Response, Response]
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/hide-replies/api-reference/put-tweets-id-hidden
"""
return self._make_request(
"PUT", f"/2/tweets/{id}/hidden", json={"hidden": False},
user_auth=True
)
# Likes
def unlike(self, tweet_id):
"""Unlike a Tweet.
The request succeeds with no action when the user sends a request to a
user they're not liking the Tweet or have already unliked the Tweet.
Parameters
----------
tweet_id : Union[int, str]
The ID of the Tweet that you would like to unlike.
Returns
-------
Union[dict, requests.Response, Response]
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/delete-users-user_id-likes
"""
id = self.access_token.partition('-')[0]
route = f"/2/users/{id}/likes/{tweet_id}"
return self._make_request("DELETE", route, user_auth=True)
def get_liking_users(self, id, *, user_auth=False, **params):
"""get_liking_users(id, *, expansions, media_fields, place_fields, \
poll_fields, tweet_fields, user_fields)
Allows you to get information about a Tweet’s liking users.
Parameters
----------
id : Union[int, str]
Tweet ID of the Tweet to request liking users of.
expansions : Union[List[str], str]
:ref:`expansions_parameter`
media_fields : Union[List[str], str]
:ref:`media_fields_parameter`
place_fields : Union[List[str], str]
:ref:`place_fields_parameter`
poll_fields : Union[List[str], str]
:ref:`poll_fields_parameter`
tweet_fields : Union[List[str], str]
:ref:`tweet_fields_parameter`
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
Returns
-------
Union[dict, requests.Response, Response]
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/get-tweets-id-liking_users
"""
return self._make_request(
"GET", f"/2/tweets/{id}/liking_users", params=params,
endpoint_parameters=(
"expansions", "media.fields", "place.fields", "poll.fields",
"tweet.fields", "user.fields"
), data_type=User, user_auth=user_auth
)
def get_liked_tweets(self, id, *, user_auth=False, **params):
"""get_liked_tweets( \
id, *, expansions, max_results, media_fields, pagination_token, \
place_fields, poll_fields, tweet_fields, user_fields \
)
Allows you to get information about a user’s liked Tweets.
The Tweets returned by this endpoint count towards the Project-level
`Tweet cap`_.
Parameters
----------
id : Union[int, str]
User ID of the user to request liked Tweets for.
expansions : Union[List[str], str]
:ref:`expansions_parameter`
max_results : int
The maximum number of results to be returned per page. This can be
a number between 5 and 100. By default, each page will return 100
results.
media_fields : Union[List[str], str]
:ref:`media_fields_parameter`
pagination_token : str
Used to request the next page of results if all results weren't
returned with the latest request, or to go back to the previous
page of results. To return the next page, pass the ``next_token``
returned in your previous response. To go back one page, pass the
``previous_token`` returned in your previous response.
place_fields : Union[List[str], str]
:ref:`place_fields_parameter`
poll_fields : Union[List[str], str]
:ref:`poll_fields_parameter`
tweet_fields : Union[List[str], str]
:ref:`tweet_fields_parameter`
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
Returns
-------
Union[dict, requests.Response, Response]
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/get-users-id-liked_tweets
.. _Tweet cap: https://developer.twitter.com/en/docs/projects/overview#tweet-cap
"""
return self._make_request(
"GET", f"/2/users/{id}/liked_tweets", params=params,
endpoint_parameters=(
"expansions", "max_results", "media.fields",
"pagination_token", "place.fields", "poll.fields",
"tweet.fields", "user.fields"
), data_type=Tweet, user_auth=user_auth
)
def like(self, tweet_id):
"""Like a Tweet.
Parameters
----------
tweet_id : Union[int, str]
The ID of the Tweet that you would like to Like.
Returns
-------
Union[dict, requests.Response, Response]
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/post-users-user_id-likes
"""
id = self.access_token.partition('-')[0]
route = f"/2/users/{id}/likes"
return self._make_request(
"POST", route, json={"tweet_id": str(tweet_id)}, user_auth=True
)
# Retweets
def unretweet(self, source_tweet_id):
"""Allows an authenticated user ID to remove the Retweet of a Tweet.
The request succeeds with no action when the user sends a request to a
user they're not Retweeting the Tweet or have already removed the
Retweet of.
Parameters
----------
source_tweet_id : Union[int, str]
The ID of the Tweet that you would like to remove the Retweet of.
Returns
-------
Union[dict, requests.Response, Response]
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/retweets/api-reference/delete-users-id-retweets-tweet_id
"""
id = self.access_token.partition('-')[0]
route = f"/2/users/{id}/retweets/{source_tweet_id}"
return self._make_request("DELETE", route, user_auth=True)
def get_retweeters(self, id, *, user_auth=False, **params):
"""get_retweeters(id, *, expansions, media_fields, place_fields, \
poll_fields, tweet_fields, user_fields)
Allows you to get information about who has Retweeted a Tweet.
Parameters
----------
id : Union[int, str]
Tweet ID of the Tweet to request Retweeting users of.
expansions : Union[List[str], str]
:ref:`expansions_parameter`
media_fields : Union[List[str], str]
:ref:`media_fields_parameter`
place_fields : Union[List[str], str]
:ref:`place_fields_parameter`
poll_fields : Union[List[str], str]
:ref:`poll_fields_parameter`
tweet_fields : Union[List[str], str]
:ref:`tweet_fields_parameter`
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
Returns
-------
Union[dict, requests.Response, Response]
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/retweets/api-reference/get-tweets-id-retweeted_by
"""
return self._make_request(
"GET", f"/2/tweets/{id}/retweeted_by", params=params,
endpoint_parameters=(
"expansions", "media.fields", "place.fields", "poll.fields",
"tweet.fields", "user.fields"
), data_type=User, user_auth=user_auth
)
def retweet(self, tweet_id):
"""Causes the user ID to Retweet the target Tweet.
Parameters
----------
tweet_id : Union[int, str]
The ID of the Tweet that you would like to Retweet.
Returns
-------
Union[dict, requests.Response, Response]
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/retweets/api-reference/post-users-id-retweets
"""
id = self.access_token.partition('-')[0]
route = f"/2/users/{id}/retweets"
return self._make_request(
"POST", route, json={"tweet_id": str(tweet_id)}, user_auth=True
)
# Search Tweets
def search_all_tweets(self, query, **params):
"""search_all_tweets( \
query, *, end_time, expansions, max_results, media_fields, \
next_token, place_fields, poll_fields, since_id, start_time, \
tweet_fields, until_id, user_fields \
)
This endpoint is only available to those users who have been approved
for the `Academic Research product track`_.
The full-archive search endpoint returns the complete history of public
Tweets matching a search query; since the first Tweet was created March
26, 2006.
The Tweets returned by this endpoint count towards the Project-level
`Tweet cap`_.
Parameters
----------
query : str
One query for matching Tweets. Up to 1024 characters.
end_time : Union[datetime.datetime, str]
YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). Used with ``start_time``.
The newest, most recent UTC timestamp to which the Tweets will be
provided. Timestamp is in second granularity and is exclusive (for
example, 12:00:01 excludes the first second of the minute). If used
without ``start_time``, Tweets from 30 days before ``end_time``
will be returned by default. If not specified, ``end_time`` will
default to [now - 30 seconds].
expansions : Union[List[str], str]
:ref:`expansions_parameter`
max_results : int
The maximum number of search results to be returned by a request. A
number between 10 and the system limit (currently 500). By default,
a request response will return 10 results.
media_fields : Union[List[str], str]
:ref:`media_fields_parameter`
next_token : str
This parameter is used to get the next 'page' of results. The value
used with the parameter is pulled directly from the response
provided by the API, and should not be modified. You can learn more
by visiting our page on `pagination`_.
place_fields : Union[List[str], str]
:ref:`place_fields_parameter`
poll_fields : Union[List[str], str]
:ref:`poll_fields_parameter`
since_id : Union[int, str]
Returns results with a Tweet ID greater than (for example, more
recent than) the specified ID. The ID specified is exclusive and
responses will not include it. If included with the same request as
a ``start_time`` parameter, only ``since_id`` will be used.
start_time : Union[datetime.datetime, str]
YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). The oldest UTC timestamp
from which the Tweets will be provided. Timestamp is in second
granularity and is inclusive (for example, 12:00:01 includes the
first second of the minute). By default, a request will return
Tweets from up to 30 days ago if you do not include this parameter.
tweet_fields : Union[List[str], str]
:ref:`tweet_fields_parameter`
until_id : Union[int, str]
Returns results with a Tweet ID less than (that is, older than) the
specified ID. Used with ``since_id``. The ID specified is exclusive
and responses will not include it.
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
Returns
-------
Union[dict, requests.Response, Response]
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-all
.. _Academic Research product track: https://developer.twitter.com/en/docs/projects/overview#product-track
.. _Tweet cap: https://developer.twitter.com/en/docs/projects/overview#tweet-cap
.. _pagination: https://developer.twitter.com/en/docs/twitter-api/tweets/search/integrate/paginate
"""
params["query"] = query
return self._make_request(
"GET", "/2/tweets/search/all", params=params,
endpoint_parameters=(
"end_time", "expansions", "max_results", "media.fields",
"next_token", "place.fields", "poll.fields", "query",
"since_id", "start_time", "tweet.fields", "until_id",
"user.fields"
), data_type=Tweet
)
def search_recent_tweets(self, query, *, user_auth=False, **params):
"""search_recent_tweets( \
query, *, user_auth=False, end_time, expansions, max_results, \
media_fields, next_token, place_fields, poll_fields, since_id, \
start_time, tweet_fields, until_id, user_fields \
)
The recent search endpoint returns Tweets from the last seven days that
match a search query.
The Tweets returned by this endpoint count towards the Project-level
`Tweet cap`_.
Parameters
----------
query : str
One rule for matching Tweets. If you are using a
`Standard Project`_ at the Basic `access level`_, you can use the
basic set of `operators`_ and can make queries up to 512 characters
long. If you are using an `Academic Research Project`_ at the Basic
access level, you can use all available operators and can make
queries up to 1,024 characters long.
end_time : Union[datetime.datetime, str]
YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). The newest, most recent
UTC timestamp to which the Tweets will be provided. Timestamp is in
second granularity and is exclusive (for example, 12:00:01 excludes
the first second of the minute). By default, a request will return
Tweets from as recent as 30 seconds ago if you do not include this
parameter.
expansions : Union[List[str], str]
:ref:`expansions_parameter`
max_results : int
The maximum number of search results to be returned by a request. A
number between 10 and 100. By default, a request response will
return 10 results.
media_fields : Union[List[str], str]
:ref:`media_fields_parameter`
next_token : str
This parameter is used to get the next 'page' of results. The value
used with the parameter is pulled directly from the response
provided by the API, and should not be modified.
place_fields : Union[List[str], str]
:ref:`place_fields_parameter`
poll_fields : Union[List[str], str]
:ref:`poll_fields_parameter`
since_id : Union[int, str]
Returns results with a Tweet ID greater than (that is, more recent
than) the specified ID. The ID specified is exclusive and responses
will not include it. If included with the same request as a
``start_time`` parameter, only ``since_id`` will be used.
start_time : Union[datetime.datetime, str]
YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). The oldest UTC timestamp
(from most recent seven days) from which the Tweets will be
provided. Timestamp is in second granularity and is inclusive (for
example, 12:00:01 includes the first second of the minute). If
included with the same request as a ``since_id`` parameter, only
``since_id`` will be used. By default, a request will return Tweets
from up to seven days ago if you do not include this parameter.
tweet_fields : Union[List[str], str]
:ref:`tweet_fields_parameter`
until_id : Union[int, str]
Returns results with a Tweet ID less than (that is, older than) the
specified ID. The ID specified is exclusive and responses will not
include it.
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
Returns
-------
Union[dict, requests.Response, Response]
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-recent
.. _Tweet cap: https://developer.twitter.com/en/docs/projects/overview#tweet-cap
.. _Standard Project: https://developer.twitter.com/en/docs/projects
.. _access level: https://developer.twitter.com/en/products/twitter-api/early-access/guide.html#na_1
.. _operators: https://developer.twitter.com/en/docs/twitter-api/tweets/search/integrate/build-a-query
.. _Academic Research Project: https://developer.twitter.com/en/docs/projects
"""
params["query"] = query
return self._make_request(
"GET", "/2/tweets/search/recent", params=params,
endpoint_parameters=(
"end_time", "expansions", "max_results", "media.fields",
"next_token", "place.fields", "poll.fields", "query",
"since_id", "start_time", "tweet.fields", "until_id",
"user.fields"
), data_type=Tweet, user_auth=user_auth
)
# Timelines
def get_users_mentions(self, id, *, user_auth=False, **params):
"""get_users_mentions( \
id, *, user_auth=False, end_time, expansions, max_results, \
media_fields, pagination_token, place_fields, poll_fields, \
since_id, start_time, tweet_fields, until_id, user_fields \
)
Returns Tweets mentioning a single user specified by the requested user
ID. By default, the most recent ten Tweets are returned per request.
Using pagination, up to the most recent 800 Tweets can be retrieved.
The Tweets returned by this endpoint count towards the Project-level
`Tweet cap`_.
Parameters
----------
id : Union[int, str]
Unique identifier of the user for whom to return Tweets mentioning
the user. User ID can be referenced using the `user/lookup`_
endpoint. More information on Twitter IDs is `here`_.
user_auth : bool
Whether or not to use OAuth 1.0a User context
end_time : Union[datetime.datetime, str]
YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). The new UTC timestamp
from which the Tweets will be provided. Timestamp is in second
granularity and is inclusive (for example, 12:00:01 includes the
first second of the minute).
Please note that this parameter does not support a millisecond
value.
expansions : Union[List[str], str]
:ref:`expansions_parameter`
max_results : int
Specifies the number of Tweets to try and retrieve, up to a maximum
of 100 per distinct request. By default, 10 results are returned if
this parameter is not supplied. The minimum permitted value is 5.
It is possible to receive less than the ``max_results`` per request
throughout the pagination process.
media_fields : Union[List[str], str]
:ref:`media_fields_parameter`
pagination_token : str
This parameter is used to move forwards or backwards through
'pages' of results, based on the value of the ``next_token`` or
``previous_token`` in the response. The value used with the
parameter is pulled directly from the response provided by the API,
and should not be modified.
place_fields : Union[List[str], str]
:ref:`place_fields_parameter`
poll_fields : Union[List[str], str]
:ref:`poll_fields_parameter`
since_id : Union[int, str]
Returns results with a Tweet ID greater than (that is, more recent
than) the specified 'since' Tweet ID. There are limits to the
number of Tweets that can be accessed through the API. If the limit
of Tweets has occurred since the ``since_id``, the ``since_id``
will be forced to the oldest ID available. More information on
Twitter IDs is `here`_.
start_time : Union[datetime.datetime, str]
YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). The oldest UTC timestamp
from which the Tweets will be provided. Timestamp is in second
granularity and is inclusive (for example, 12:00:01 includes the
first second of the minute).
Please note that this parameter does not support a millisecond
value.
tweet_fields : Union[List[str], str]
:ref:`tweet_fields_parameter`
until_id : Union[int, str]
Returns results with a Tweet ID less less than (that is, older
than) the specified 'until' Tweet ID. There are limits to the
number of Tweets that can be accessed through the API. If the limit
of Tweets has occurred since the ``until_id``, the ``until_id``
will be forced to the most recent ID available. More information on
Twitter IDs is `here`_.
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
Returns
-------
Union[dict, requests.Response, Response]
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/timelines/api-reference/get-users-id-mentions
.. _Tweet cap: https://developer.twitter.com/en/docs/projects/overview#tweet-cap
.. _user/lookup: https://developer.twitter.com/en/docs/twitter-api/users/lookup/introduction
.. _here: https://developer.twitter.com/en/docs/twitter-ids
"""
return self._make_request(
"GET", f"/2/users/{id}/mentions", params=params,
endpoint_parameters=(
"end_time", "expansions", "max_results", "media.fields",
"pagination_token", "place.fields", "poll.fields", "since_id",
"start_time", "tweet.fields", "until_id", "user.fields"
), data_type=Tweet, user_auth=user_auth
)
def get_users_tweets(self, id, *, user_auth=False, **params):
"""get_users_tweets( \
id, *, user_auth=False, end_time, exclude, expansions, \
max_results, media_fields, pagination_token, place_fields, \
poll_fields, since_id, start_time, tweet_fields, until_id, \
user_fields \
)
Returns Tweets composed by a single user, specified by the requested
user ID. By default, the most recent ten Tweets are returned per
request. Using pagination, the most recent 3,200 Tweets can be
retrieved.
The Tweets returned by this endpoint count towards the Project-level
`Tweet cap`_.
Parameters
----------
id : Union[int, str]
Unique identifier of the Twitter account (user ID) for whom to
return results. User ID can be referenced using the `user/lookup`_
endpoint. More information on Twitter IDs is `here`_.
user_auth : bool
Whether or not to use OAuth 1.0a User context
end_time : Union[datetime.datetime, str]
YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). The newest or most recent
UTC timestamp from which the Tweets will be provided. Only the 3200
most recent Tweets are available. Timestamp is in second
granularity and is inclusive (for example, 12:00:01 includes the
first second of the minute). Minimum allowable time is
2010-11-06T00:00:01Z
Please note that this parameter does not support a millisecond
value.
exclude : Union[List[str], str]
Comma-separated list of the types of Tweets to exclude from the
response. When ``exclude=retweets`` is used, the maximum historical
Tweets returned is still 3200. When the ``exclude=replies``
parameter is used for any value, only the most recent 800 Tweets
are available.
expansions : Union[List[str], str]
:ref:`expansions_parameter`
max_results : int
Specifies the number of Tweets to try and retrieve, up to a maximum
of 100 per distinct request. By default, 10 results are returned if
this parameter is not supplied. The minimum permitted value is 5.
It is possible to receive less than the ``max_results`` per request
throughout the pagination process.
media_fields : Union[List[str], str]
:ref:`media_fields_parameter`
pagination_token : str
This parameter is used to move forwards or backwards through
'pages' of results, based on the value of the ``next_token`` or
``previous_token`` in the response. The value used with the
parameter is pulled directly from the response provided by the API,
and should not be modified.
place_fields : Union[List[str], str]
:ref:`place_fields_parameter`
poll_fields : Union[List[str], str]
:ref:`poll_fields_parameter`
since_id : Union[int, str]
Returns results with a Tweet ID greater than (that is, more recent
than) the specified 'since' Tweet ID. Only the 3200 most recent
Tweets are available. The result will exclude the ``since_id``. If
the limit of Tweets has occurred since the ``since_id``, the
``since_id`` will be forced to the oldest ID available.
start_time : Union[datetime.datetime, str]
YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). The oldest or earliest
UTC timestamp from which the Tweets will be provided. Only the 3200
most recent Tweets are available. Timestamp is in second
granularity and is inclusive (for example, 12:00:01 includes the
first second of the minute). Minimum allowable time is
2010-11-06T00:00:00Z
Please note that this parameter does not support a millisecond
value.
tweet_fields : Union[List[str], str]
:ref:`tweet_fields_parameter`
until_id : Union[int, str]
Returns results with a Tweet ID less less than (that is, older
than) the specified 'until' Tweet ID. Only the 3200 most recent
Tweets are available. The result will exclude the ``until_id``. If
the limit of Tweets has occurred since the ``until_id``, the
``until_id`` will be forced to the most recent ID available.
user_fields : Union[List[str], str]
:ref:`user_fields_parameter`
Returns
-------
Union[dict, requests.Response, Response]
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/timelines/api-reference/get-users-id-tweets
.. _Tweet cap: https://developer.twitter.com/en/docs/projects/overview#tweet-cap
.. _user/lookup: https://developer.twitter.com/en/docs/twitter-api/users/lookup/introduction
.. _here: https://developer.twitter.com/en/docs/twitter-ids
"""
return self._make_request(
"GET", f"/2/users/{id}/tweets", params=params,
endpoint_parameters=(
"end_time", "exclude", "expansions", "max_results",
"media.fields", "pagination_token", "place.fields",
"poll.fields", "since_id", "start_time", "tweet.fields",
"until_id", "user.fields"
), data_type=Tweet, user_auth=user_auth
)
# Tweet counts
def get_all_tweets_count(self, query, **params):
"""get_all_tweets_count(query, *, end_time, granularity, next_token, \
since_id, start_time, until_id)
This endpoint is only available to those users who have been approved
for the `Academic Research product track`_.
The full-archive search endpoint returns the complete history of public
Tweets matching a search query; since the first Tweet was created March
26, 2006.
Parameters
----------
query : str
One query for matching Tweets. Up to 1024 characters.
end_time : Union[datetime.datetime, str]
YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). Used with ``start_time``.
The newest, most recent UTC timestamp to which the Tweets will be
provided. Timestamp is in second granularity and is exclusive (for
example, 12:00:01 excludes the first second of the minute). If used
without ``start_time``, Tweets from 30 days before ``end_time``
will be returned by default. If not specified, ``end_time`` will
default to [now - 30 seconds].
granularity : str
This is the granularity that you want the timeseries count data to
be grouped by. You can requeset ``minute``, ``hour``, or ``day``
granularity. The default granularity, if not specified is ``hour``.
next_token : str
This parameter is used to get the next 'page' of results. The value
used with the parameter is pulled directly from the response
provided by the API, and should not be modified. You can learn more
by visiting our page on `pagination`_.
since_id : Union[int, str]
Returns results with a Tweet ID greater than (for example, more
recent than) the specified ID. The ID specified is exclusive and
responses will not include it. If included with the same request as
a ``start_time`` parameter, only ``since_id`` will be used.
start_time : Union[datetime.datetime, str]
YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). The oldest UTC timestamp
from which the Tweets will be provided. Timestamp is in second
granularity and is inclusive (for example, 12:00:01 includes the
first second of the minute). By default, a request will return
Tweets from up to 30 days ago if you do not include this parameter.
until_id : Union[int, str]
Returns results with a Tweet ID less than (that is, older than) the
specified ID. Used with ``since_id``. The ID specified is exclusive
and responses will not include it.
Returns
-------
Union[dict, requests.Response, Response]
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/counts/api-reference/get-tweets-counts-all
.. _Academic Research product track: https://developer.twitter.com/en/docs/projects/overview#product-track
.. _pagination: https://developer.twitter.com/en/docs/twitter-api/tweets/search/integrate/paginate
"""
params["query"] = query
return self._make_request(
"GET", "/2/tweets/counts/all", params=params,
endpoint_parameters=(
"end_time", "granularity", "next_token", "query", "since_id",
"start_time", "until_id"
)
)
def get_recent_tweets_count(self, query, **params):
"""get_recent_tweets_count(query, *, end_time, granularity, since_id, \
start_time, until_id)
The recent Tweet counts endpoint returns count of Tweets from the last
seven days that match a search query.
Parameters
----------
query : str
One rule for matching Tweets. If you are using a
`Standard Project`_ at the Basic `access level`_, you can use the
basic set of `operators`_ and can make queries up to 512 characters
long. If you are using an `Academic Research Project`_ at the Basic
access level, you can use all available operators and can make
queries up to 1,024 characters long.
end_time : Union[datetime.datetime, str]
YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). The newest, most recent
UTC timestamp to which the Tweets will be provided. Timestamp is in
second granularity and is exclusive (for example, 12:00:01 excludes
the first second of the minute). By default, a request will return
Tweets from as recent as 30 seconds ago if you do not include this
parameter.
granularity : str
This is the granularity that you want the timeseries count data to
be grouped by. You can requeset ``minute``, ``hour``, or ``day``
granularity. The default granularity, if not specified is ``hour``.
since_id : Union[int, str]
Returns results with a Tweet ID greater than (that is, more recent
than) the specified ID. The ID specified is exclusive and responses
will not include it. If included with the same request as a
``start_time`` parameter, only ``since_id`` will be used.
start_time : Union[datetime.datetime, str]
YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). The oldest UTC timestamp
(from most recent seven days) from which the Tweets will be
provided. Timestamp is in second granularity and is inclusive (for
example, 12:00:01 includes the first second of the minute). If
included with the same request as a ``since_id`` parameter, only
``since_id`` will be used. By default, a request will return Tweets
from up to seven days ago if you do not include this parameter.
until_id : Union[int, str]
Returns results with a Tweet ID less than (that is, older than) the
specified ID. The ID specified is exclusive and responses will not
include it.
Returns
-------
Union[dict, requests.Response, Response]
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/counts/api-reference/get-tweets-counts-recent
.. _Standard Project: https://developer.twitter.com/en/docs/projects
.. _access level: https://developer.twitter.com/en/products/twitter-api/early-access/guide.html#na_1
.. _operators: https://developer.twitter.com/en/docs/twitter-api/tweets/search/integrate/build-a-query
.. _Academic Research Project: https://developer.twitter.com/en/docs/projects
"""
params["query"] = query
return self._make_request(
"GET", "/2/tweets/counts/recent", params=params,
endpoint_parameters=(
"end_time", "granularity", "query", "since_id", "start_time",
"until_id"
)
)