.. autoclass:: Client
+.. table::
+ :align: center
+
+ +--------------------------------------------------------------+----------------------------------------+
+ | Twitter API v2 Endpoint | :class:`Client` Method |
+ +==============================================================+========================================+
+ | .. centered:: :ref:`Tweets` |
+ +-------------------------------------------------------------------------------------------------------+
+ | .. centered:: |Hide replies|_ |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `PUT /2/tweets/:id/hidden`_ | :meth:`Client.hide_reply` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `PUT /2/tweets/:id/hidden`_ | :meth:`Client.unhide_reply` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | .. centered:: |Likes|_ |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `DELETE /2/users/:id/likes/:tweet_id`_ | :meth:`Client.unlike` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/tweets/:id/liking_users`_ | :meth:`Client.get_liking_users` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/users/:id/liked_tweets`_ | :meth:`Client.get_liked_tweets` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `POST /2/users/:id/likes`_ | :meth:`Client.like` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | .. centered:: |Retweets|_ |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `DELETE /2/users/:id/retweets/:source_tweet_id`_ | :meth:`Client.unretweet` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/tweets/:id/retweeted_by`_ | :meth:`Client.get_retweeters` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `POST /2/users/:id/retweets`_ | :meth:`Client.retweet` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | .. centered:: |Search Tweets|_ |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/tweets/search/all`_ | :meth:`Client.search_all_tweets` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/tweets/search/recent`_ | :meth:`Client.search_recent_tweets` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | .. centered:: |Timelines|_ |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/users/:id/mentions`_ | :meth:`Client.get_users_mentions` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/users/:id/tweets`_ | :meth:`Client.get_users_tweets` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | .. centered:: |Tweet counts|_ |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/tweets/counts/all`_ | :meth:`Client.get_all_tweets_count` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/tweets/counts/recent`_ | :meth:`Client.get_recent_tweets_count` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | .. centered:: |Tweet lookup|_ |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/tweets/:id`_ | :meth:`Client.get_tweet` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/tweets`_ | :meth:`Client.get_tweets` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | .. centered:: :ref:`Users` |
+ +-------------------------------------------------------------------------------------------------------+
+ | .. centered:: |Blocks|_ |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `DELETE /2/users/:source_user_id/blocking/:target_user_id`_ | :meth:`Client.unblock` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/users/:id/blocking`_ | :meth:`Client.get_blocked` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `POST /2/users/:id/blocking`_ | :meth:`Client.block` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | .. centered:: |Follows|_ |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `DELETE /2/users/:source_user_id/following/:target_user_id`_ | :meth:`Client.unfollow_user` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/users/:id/followers`_ | :meth:`Client.get_users_followers` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/users/:id/following`_ | :meth:`Client.get_users_following` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `POST /2/users/:id/following`_ | :meth:`Client.follow_user` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | .. centered:: |Mutes|_ |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `DELETE /2/users/:source_user_id/muting/:target_user_id`_ | :meth:`Client.unmute` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/users/:id/muting`_ | :meth:`Client.get_muted` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `POST /2/users/:id/muting`_ | :meth:`Client.mute` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | .. centered:: |User lookup|_ |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/users/:id`_ | :meth:`Client.get_user` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/users/by/username/:username`_ | :meth:`Client.get_user` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/users`_ | :meth:`Client.get_users` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/users/by`_ | :meth:`Client.get_users` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | .. centered:: :ref:`Spaces` |
+ +-------------------------------------------------------------------------------------------------------+
+ | .. centered:: |Search Spaces|_ |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/spaces/search`_ | :meth:`Client.search_spaces` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | .. centered:: |Spaces lookup|_ |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/spaces`_ | :meth:`Client.get_spaces` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/spaces/by/creator_ids`_ | :meth:`Client.get_spaces` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/spaces/:id`_ | :meth:`Client.get_space` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | .. centered:: :ref:`Lists` |
+ +-------------------------------------------------------------------------------------------------------+
+ | .. centered:: |Manage Lists|_ |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `DELETE /2/lists/:id`_ | :meth:`Client.delete_list` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `DELETE /2/lists/:id/members/:user_id`_ | :meth:`Client.remove_list_member` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `DELETE /2/users/:id/followed_lists/:list_id`_ | :meth:`Client.unfollow_list` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `DELETE /2/users/:id/pinned_lists/:list_id`_ | :meth:`Client.unpin_list` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `PUT /2/lists/:id`_ | :meth:`Client.update_list` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `POST /2/lists`_ | :meth:`Client.create_list` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `POST /2/lists/:id/members`_ | :meth:`Client.add_list_member` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `POST /2/users/:id/followed_lists`_ | :meth:`Client.follow_list` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `POST /2/users/:id/pinned_lists`_ | :meth:`Client.pin_list` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | .. centered:: :ref:`Compliance` |
+ +-------------------------------------------------------------------------------------------------------+
+ | .. centered:: |Batch Compliance|_ |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/compliance/jobs`_ | :meth:`Client.get_compliance_jobs` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `GET /2/compliance/jobs/:id`_ | :meth:`Client.get_compliance_job` |
+ +--------------------------------------------------------------+----------------------------------------+
+ | `POST /2/compliance/jobs`_ | :meth:`Client.create_compliance_job` |
+ +--------------------------------------------------------------+----------------------------------------+
+
+.. |Hide replies| replace:: *Hide replies*
+.. _PUT /2/tweets/:id/hidden: https://developer.twitter.com/en/docs/twitter-api/tweets/hide-replies/api-reference/put-tweets-id-hidden
+.. |Likes| replace:: *Likes*
+.. _DELETE /2/users/:id/likes/:tweet_id: https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/delete-users-id-likes-tweet_id
+.. _GET /2/tweets/:id/liking_users: https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/get-tweets-id-liking_users
+.. _GET /2/users/:id/liked_tweets: https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/get-users-id-liked_tweets
+.. _POST /2/users/:id/likes: https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/post-users-id-likes
+.. |Retweets| replace:: *Retweets*
+.. _DELETE /2/users/:id/retweets/:source_tweet_id: https://developer.twitter.com/en/docs/twitter-api/tweets/retweets/api-reference/delete-users-id-retweets-tweet_id
+.. _GET /2/tweets/:id/retweeted_by: https://developer.twitter.com/en/docs/twitter-api/tweets/retweets/api-reference/get-tweets-id-retweeted_by
+.. _POST /2/users/:id/retweets: https://developer.twitter.com/en/docs/twitter-api/tweets/retweets/api-reference/post-users-id-retweets
+.. |Search Tweets| replace:: *Search Tweets*
+.. _GET /2/tweets/search/all: https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-all
+.. _GET /2/tweets/search/recent: https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-recent
+.. |Timelines| replace:: *Timelines*
+.. _GET /2/users/:id/mentions: https://developer.twitter.com/en/docs/twitter-api/tweets/timelines/api-reference/get-users-id-mentions
+.. _GET /2/users/:id/tweets: https://developer.twitter.com/en/docs/twitter-api/tweets/timelines/api-reference/get-users-id-tweets
+.. |Tweet counts| replace:: *Tweet counts*
+.. _GET /2/tweets/counts/all: https://developer.twitter.com/en/docs/twitter-api/tweets/counts/api-reference/get-tweets-counts-all
+.. _GET /2/tweets/counts/recent: https://developer.twitter.com/en/docs/twitter-api/tweets/counts/api-reference/get-tweets-counts-recent
+.. |Tweet lookup| replace:: *Tweet lookup*
+.. _GET /2/tweets/:id: https://developer.twitter.com/en/docs/twitter-api/tweets/lookup/api-reference/get-tweets-id
+.. _GET /2/tweets: https://developer.twitter.com/en/docs/twitter-api/tweets/lookup/api-reference/get-tweets
+.. |Blocks| replace:: *Blocks*
+.. _DELETE /2/users/:source_user_id/blocking/:target_user_id: https://developer.twitter.com/en/docs/twitter-api/users/blocks/api-reference/delete-users-user_id-blocking
+.. _GET /2/users/:id/blocking: https://developer.twitter.com/en/docs/twitter-api/users/blocks/api-reference/get-users-blocking
+.. _POST /2/users/:id/blocking: https://developer.twitter.com/en/docs/twitter-api/users/blocks/api-reference/post-users-user_id-blocking
+.. |Follows| replace:: *Follows*
+.. _DELETE /2/users/:source_user_id/following/:target_user_id: https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/delete-users-source_id-following
+.. _GET /2/users/:id/followers: https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/get-users-id-followers
+.. _GET /2/users/:id/following: https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/get-users-id-following
+.. _POST /2/users/:id/following: https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/post-users-source_user_id-following
+.. |Mutes| replace:: *Mutes*
+.. _DELETE /2/users/:source_user_id/muting/:target_user_id: https://developer.twitter.com/en/docs/twitter-api/users/mutes/api-reference/delete-users-user_id-muting
+.. _GET /2/users/:id/muting: https://developer.twitter.com/en/docs/twitter-api/users/mutes/api-reference/get-users-muting
+.. _POST /2/users/:id/muting: https://developer.twitter.com/en/docs/twitter-api/users/mutes/api-reference/post-users-user_id-muting
+.. |User lookup| replace:: *User lookup*
+.. _GET /2/users/:id: https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-id
+.. _GET /2/users/by/username/:username: https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-by-username-username
+.. _GET /2/users: https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users
+.. _GET /2/users/by: https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-by
+.. |Search Spaces| replace:: *Search Spaces*
+.. _GET /2/spaces/search: https://developer.twitter.com/en/docs/twitter-api/spaces/search/api-reference/get-spaces-search
+.. |Spaces lookup| replace:: *Spaces lookup*
+.. _GET /2/spaces: https://developer.twitter.com/en/docs/twitter-api/spaces/lookup/api-reference/get-spaces
+.. _GET /2/spaces/by/creator_ids: https://developer.twitter.com/en/docs/twitter-api/spaces/lookup/api-reference/get-spaces-by-creator-ids
+.. _GET /2/spaces/:id: https://developer.twitter.com/en/docs/twitter-api/spaces/lookup/api-reference/get-spaces-id
+.. |Manage Lists| replace:: *Manage Lists*
+.. _DELETE /2/lists/:id: https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/delete-lists-id
+.. _DELETE /2/lists/:id/members/:user_id: https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/delete-lists-id-members-user_id
+.. _DELETE /2/users/:id/followed_lists/:list_id: https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/delete-users-id-followed-lists-list_id
+.. _DELETE /2/users/:id/pinned_lists/:list_id: https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/delete-users-id-pinned-lists-list_id
+.. _PUT /2/lists/:id: https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/put-lists-id
+.. _POST /2/lists: https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/post-lists
+.. _POST /2/lists/:id/members: https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/post-lists-id-members
+.. _POST /2/users/:id/followed_lists: https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/post-users-id-followed-lists
+.. _POST /2/users/:id/pinned_lists: https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/post-users-id-pinned-lists
+.. |Batch Compliance| replace:: *Batch Compliance*
+.. _GET /2/compliance/jobs: https://developer.twitter.com/en/docs/twitter-api/compliance/batch-compliance/api-reference/get-compliance-jobs
+.. _GET /2/compliance/jobs/:id: https://developer.twitter.com/en/docs/twitter-api/compliance/batch-compliance/api-reference/get-compliance-jobs-id
+.. _POST /2/compliance/jobs: https://developer.twitter.com/en/docs/twitter-api/compliance/batch-compliance/api-reference/post-compliance-jobs
+
Tweets
======
projects / tweepy.git / commitdiff