Skip to content

Latest commit

 

History

History
534 lines (431 loc) · 39 KB

asyncclient.rst

File metadata and controls

534 lines (431 loc) · 39 KB
Raw
.. currentmodule:: tweepy.asynchronous

:class:`AsyncClient`

.. autoclass:: AsyncClient
Twitter API v2 Endpoint :class:`AsyncClient` Method 
.. centered:: :ref:`Tweets`

.. centered:: |Bookmarks|_
DELETE /2/users/:id/bookmarks/:tweet_id :meth:`AsyncClient.remove_bookmark`
GET /2/users/:id/bookmarks :meth:`AsyncClient.get_bookmarks`
POST /2/users/:id/bookmarks :meth:`AsyncClient.bookmark` 
.. centered:: |Hide replies|_
PUT /2/tweets/:id/hidden :meth:`AsyncClient.hide_reply`
PUT /2/tweets/:id/hidden :meth:`AsyncClient.unhide_reply` 
.. centered:: |Likes|_
DELETE /2/users/:id/likes/:tweet_id :meth:`AsyncClient.unlike`
GET /2/tweets/:id/liking_users :meth:`AsyncClient.get_liking_users`
GET /2/users/:id/liked_tweets :meth:`AsyncClient.get_liked_tweets`
POST /2/users/:id/likes :meth:`AsyncClient.like` 
.. centered:: |Manage Tweets|_
DELETE /2/tweets/:id :meth:`AsyncClient.delete_tweet`
POST /2/tweets :meth:`AsyncClient.create_tweet` 
.. centered:: |Quote Tweets|_
GET /2/tweets/:id/quote_tweets :meth:`AsyncClient.get_quote_tweets` 
.. centered:: |Retweets|_
DELETE /2/users/:id/retweets/:source_tweet_id :meth:`AsyncClient.unretweet`
GET /2/tweets/:id/retweeted_by :meth:`AsyncClient.get_retweeters`
POST /2/users/:id/retweets :meth:`AsyncClient.retweet` 
.. centered:: |Search Tweets|_
GET /2/tweets/search/all :meth:`AsyncClient.search_all_tweets`
GET /2/tweets/search/recent :meth:`AsyncClient.search_recent_tweets` 
.. centered:: |Timelines|_
GET /2/users/:id/mentions :meth:`AsyncClient.get_users_mentions`
GET /2/users/:id/timelines/reverse_chronological :meth:`AsyncClient.get_home_timeline`
GET /2/users/:id/tweets :meth:`AsyncClient.get_users_tweets` 
.. centered:: |Tweet counts|_
GET /2/tweets/counts/all :meth:`AsyncClient.get_all_tweets_count`
GET /2/tweets/counts/recent :meth:`AsyncClient.get_recent_tweets_count` 
.. centered:: |Tweet lookup|_
GET /2/tweets/:id :meth:`AsyncClient.get_tweet`
GET /2/tweets :meth:`AsyncClient.get_tweets` 
.. centered:: :ref:`Users`

.. centered:: |Blocks|_
GET /2/users/:id/blocking :meth:`AsyncClient.get_blocked` 
.. centered:: |Follows|_
DELETE /2/users/:source_user_id/following/:target_user_id :meth:`AsyncClient.unfollow_user`
GET /2/users/:id/followers :meth:`AsyncClient.get_users_followers`
GET /2/users/:id/following :meth:`AsyncClient.get_users_following`
POST /2/users/:id/following :meth:`AsyncClient.follow_user` 
.. centered:: |Mutes|_
DELETE /2/users/:source_user_id/muting/:target_user_id :meth:`AsyncClient.unmute`
GET /2/users/:id/muting :meth:`AsyncClient.get_muted`
POST /2/users/:id/muting :meth:`AsyncClient.mute` 
.. centered:: |User lookup|_
GET /2/users/:id :meth:`AsyncClient.get_user`
GET /2/users/by/username/:username :meth:`AsyncClient.get_user`
GET /2/users :meth:`AsyncClient.get_users`
GET /2/users/by :meth:`AsyncClient.get_users`
GET /2/users/me :meth:`AsyncClient.get_me` 
.. centered:: :ref:`Spaces`

.. centered:: |Search Spaces|_
GET /2/spaces/search :meth:`AsyncClient.search_spaces` 
.. centered:: |Spaces lookup|_
GET /2/spaces :meth:`AsyncClient.get_spaces`
GET /2/spaces/:id :meth:`AsyncClient.get_space`
GET /2/spaces/:id/buyers :meth:`AsyncClient.get_space_buyers`
GET /2/spaces/:id/tweets :meth:`AsyncClient.get_space_tweets`
GET /2/spaces/by/creator_ids :meth:`AsyncClient.get_spaces` 
.. centered:: :ref:`Direct Messages`

.. centered:: |Direct Messages lookup|_
GET /2/dm_conversations/:dm_conversation_id/dm_events :meth:`AsyncClient.get_direct_message_events`
GET /2/dm_conversations/with/:participant_id/dm_events :meth:`AsyncClient.get_direct_message_events`
GET /2/dm_events :meth:`AsyncClient.get_direct_message_events` 
.. centered:: |Manage Direct Messages|_
POST /2/dm_conversations :meth:`AsyncClient.create_direct_message_conversation`
POST /2/dm_conversations/:dm_conversation_id/messages :meth:`AsyncClient.create_direct_message`
POST /2/dm_conversations/with/:participant_id/messages :meth:`AsyncClient.create_direct_message` 
.. centered:: :ref:`Lists`

.. centered:: |List Tweets lookup|_
GET /2/lists/:id/tweets :meth:`AsyncClient.get_list_tweets` 
.. centered:: |List follows|_
DELETE /2/users/:id/followed_lists/:list_id :meth:`AsyncClient.unfollow_list`
GET /2/lists/:id/followers :meth:`AsyncClient.get_list_followers`
GET /2/users/:id/followed_lists :meth:`AsyncClient.get_followed_lists`
POST /2/users/:id/followed_lists :meth:`AsyncClient.follow_list` 
.. centered:: |List lookup|_
GET /2/lists/:id :meth:`AsyncClient.get_list`
GET /2/users/:id/owned_lists :meth:`AsyncClient.get_owned_lists` 
.. centered:: |List members|_
DELETE /2/lists/:id/members/:user_id :meth:`AsyncClient.remove_list_member`
GET /2/lists/:id/members :meth:`AsyncClient.get_list_members`
GET /2/users/:id/list_memberships :meth:`AsyncClient.get_list_memberships`
POST /2/lists/:id/members :meth:`AsyncClient.add_list_member` 
.. centered:: |Manage Lists|_
DELETE /2/lists/:id :meth:`AsyncClient.delete_list`
PUT /2/lists/:id :meth:`AsyncClient.update_list`
POST /2/lists :meth:`AsyncClient.create_list` 
.. centered:: |Pinned Lists|_
DELETE /2/users/:id/pinned_lists/:list_id :meth:`AsyncClient.unpin_list`
GET /2/users/:id/pinned_lists :meth:`AsyncClient.get_pinned_lists`
POST /2/users/:id/pinned_lists :meth:`AsyncClient.pin_list` 
.. centered:: :ref:`Compliance`

.. centered:: |Batch Compliance|_
GET /2/compliance/jobs :meth:`AsyncClient.get_compliance_jobs`
GET /2/compliance/jobs/:id :meth:`AsyncClient.get_compliance_job`
POST /2/compliance/jobs :meth:`AsyncClient.create_compliance_job`

Tweets

Bookmarks

.. automethod:: AsyncClient.remove_bookmark


.. automethod:: AsyncClient.get_bookmarks


.. automethod:: AsyncClient.bookmark

Hide replies

.. automethod:: AsyncClient.hide_reply


.. automethod:: AsyncClient.unhide_reply

Likes

.. automethod:: AsyncClient.unlike


.. automethod:: AsyncClient.get_liking_users


.. automethod:: AsyncClient.get_liked_tweets


.. automethod:: AsyncClient.like

Manage Tweets

.. automethod:: AsyncClient.delete_tweet


.. automethod:: AsyncClient.create_tweet

Quote Tweets

.. automethod:: AsyncClient.get_quote_tweets

Retweets

.. automethod:: AsyncClient.unretweet


.. automethod:: AsyncClient.get_retweeters


.. automethod:: AsyncClient.retweet

Search Tweets

.. automethod:: AsyncClient.search_all_tweets


.. automethod:: AsyncClient.search_recent_tweets

Timelines

.. automethod:: AsyncClient.get_users_mentions


.. automethod:: AsyncClient.get_home_timeline


.. automethod:: AsyncClient.get_users_tweets

Tweet counts

.. automethod:: AsyncClient.get_all_tweets_count


.. automethod:: AsyncClient.get_recent_tweets_count

Tweet lookup

.. automethod:: AsyncClient.get_tweet


.. automethod:: AsyncClient.get_tweets

Users

Blocks

.. automethod:: AsyncClient.get_blocked

Follows

.. automethod:: AsyncClient.unfollow_user


.. automethod:: AsyncClient.get_users_followers


.. automethod:: AsyncClient.get_users_following


.. automethod:: AsyncClient.follow_user

Mutes

.. automethod:: AsyncClient.unmute


.. automethod:: AsyncClient.get_muted


.. automethod:: AsyncClient.mute

User lookup

.. automethod:: AsyncClient.get_user


.. automethod:: AsyncClient.get_users


.. automethod:: AsyncClient.get_me

Spaces

Search Spaces

.. automethod:: AsyncClient.search_spaces

Spaces lookup

.. automethod:: AsyncClient.get_spaces


.. automethod:: AsyncClient.get_space


.. automethod:: AsyncClient.get_space_buyers


.. automethod:: AsyncClient.get_space_tweets

Direct Messages

Direct Messages lookup

.. automethod:: AsyncClient.get_direct_message_events

Manage Direct Messages

.. automethod:: AsyncClient.create_direct_message


.. automethod:: AsyncClient.create_direct_message_conversation

Lists

List Tweets lookup

.. automethod:: AsyncClient.get_list_tweets

List follows

.. automethod:: AsyncClient.unfollow_list


.. automethod:: AsyncClient.get_list_followers


.. automethod:: AsyncClient.get_followed_lists


.. automethod:: AsyncClient.follow_list

List lookup

.. automethod:: AsyncClient.get_list


.. automethod:: AsyncClient.get_owned_lists

List members

.. automethod:: AsyncClient.remove_list_member


.. automethod:: AsyncClient.get_list_members


.. automethod:: AsyncClient.get_list_memberships


.. automethod:: AsyncClient.add_list_member

Manage Lists

.. automethod:: AsyncClient.delete_list


.. automethod:: AsyncClient.update_list


.. automethod:: AsyncClient.create_list

Pinned Lists

.. automethod:: AsyncClient.unpin_list


.. automethod:: AsyncClient.get_pinned_lists


.. automethod:: AsyncClient.pin_list

Compliance

Batch compliance

.. automethod:: AsyncClient.get_compliance_jobs


.. automethod:: AsyncClient.get_compliance_job


.. automethod:: AsyncClient.create_compliance_job

Footnotes

[1]https://developer.twitter.com/en/updates/changelog