Skip to content

Latest commit

 

History

History
538 lines (433 loc) · 37.7 KB

client.rst

File metadata and controls

538 lines (433 loc) · 37.7 KB
Raw

tweepy

Client

Client

Twitter API v2 Endpoint Client Method

Tweets

Bookmarks_
DELETE /2/users/:id/bookmarks/:tweet_id Client.remove_bookmark
GET /2/users/:id/bookmarks Client.get_bookmarks
POST /2/users/:id/bookmarks Client.bookmark

Hide replies_
PUT /2/tweets/:id/hidden Client.hide_reply
PUT /2/tweets/:id/hidden Client.unhide_reply

Likes_
DELETE /2/users/:id/likes/:tweet_id Client.unlike
GET /2/tweets/:id/liking_users Client.get_liking_users
GET /2/users/:id/liked_tweets Client.get_liked_tweets
POST /2/users/:id/likes Client.like

Manage Tweets_
DELETE /2/tweets/:id Client.delete_tweet
POST /2/tweets Client.create_tweet

Quote Tweets_
GET /2/tweets/:id/quote_tweets Client.get_quote_tweets

Retweets_
DELETE /2/users/:id/retweets/:source_tweet_id Client.unretweet
GET /2/tweets/:id/retweeted_by Client.get_retweeters
POST /2/users/:id/retweets Client.retweet

Search Tweets_
GET /2/tweets/search/all Client.search_all_tweets
GET /2/tweets/search/recent Client.search_recent_tweets

Timelines_
GET /2/users/:id/mentions Client.get_users_mentions
GET /2/users/:id/timelines/reverse_chronological Client.get_home_timeline
GET /2/users/:id/tweets Client.get_users_tweets

Tweet counts_
GET /2/tweets/counts/all Client.get_all_tweets_count
GET /2/tweets/counts/recent Client.get_recent_tweets_count

Tweet lookup_
GET /2/tweets/:id Client.get_tweet
GET /2/tweets Client.get_tweets

Users

Blocks_
GET /2/users/:id/blocking Client.get_blocked

Follows_
DELETE /2/users/:source_user_id/following/:target_user_id Client.unfollow_user
GET /2/users/:id/followers Client.get_users_followers
GET /2/users/:id/following Client.get_users_following
POST /2/users/:id/following Client.follow_user

Mutes_
DELETE /2/users/:source_user_id/muting/:target_user_id Client.unmute
GET /2/users/:id/muting Client.get_muted
POST /2/users/:id/muting Client.mute

User lookup_
GET /2/users/:id Client.get_user
GET /2/users/by/username/:username Client.get_user
GET /2/users Client.get_users
GET /2/users/by Client.get_users
GET /2/users/me Client.get_me

Spaces

Search Spaces_
GET /2/spaces/search Client.search_spaces

Spaces lookup_
GET /2/spaces Client.get_spaces
GET /2/spaces/:id Client.get_space
GET /2/spaces/:id/buyers Client.get_space_buyers
GET /2/spaces/:id/tweets Client.get_space_tweets
GET /2/spaces/by/creator_ids Client.get_spaces

Direct Messages

Direct Messages lookup_
GET /2/dm_conversations/:dm_conversation_id/dm_events Client.get_direct_message_events
GET /2/dm_conversations/with/:participant_id/dm_events Client.get_direct_message_events
GET /2/dm_events Client.get_direct_message_events

Manage Direct Messages_
POST /2/dm_conversations Client.create_direct_message_conversation
POST /2/dm_conversations/:dm_conversation_id/messages Client.create_direct_message
POST /2/dm_conversations/with/:participant_id/messages Client.create_direct_message

Lists

List Tweets lookup_
GET /2/lists/:id/tweets Client.get_list_tweets

List follows_
DELETE /2/users/:id/followed_lists/:list_id Client.unfollow_list
GET /2/lists/:id/followers Client.get_list_followers
GET /2/users/:id/followed_lists Client.get_followed_lists
POST /2/users/:id/followed_lists Client.follow_list

List lookup_
GET /2/lists/:id Client.get_list
GET /2/users/:id/owned_lists Client.get_owned_lists

List members_
DELETE /2/lists/:id/members/:user_id Client.remove_list_member
GET /2/lists/:id/members Client.get_list_members
GET /2/users/:id/list_memberships Client.get_list_memberships
POST /2/lists/:id/members Client.add_list_member

Manage Lists_
DELETE /2/lists/:id Client.delete_list
PUT /2/lists/:id Client.update_list
POST /2/lists Client.create_list

Pinned Lists_
DELETE /2/users/:id/pinned_lists/:list_id Client.unpin_list
GET /2/users/:id/pinned_lists Client.get_pinned_lists
POST /2/users/:id/pinned_lists Client.pin_list

Compliance

Batch Compliance_
GET /2/compliance/jobs Client.get_compliance_jobs
GET /2/compliance/jobs/:id Client.get_compliance_job
POST /2/compliance/jobs Client.create_compliance_job

Tweets

Bookmarks

Client.remove_bookmark

Client.get_bookmarks

Client.bookmark

Hide replies

Client.hide_reply

Client.unhide_reply

Likes

Client.unlike

Client.get_liking_users

Client.get_liked_tweets

Client.like

Manage Tweets

Client.delete_tweet

Client.create_tweet

Quote Tweets

Client.get_quote_tweets

Retweets

Client.unretweet

Client.get_retweeters

Client.retweet

Search Tweets

Client.search_all_tweets

Client.search_recent_tweets

Timelines

Client.get_users_mentions

Client.get_home_timeline

Client.get_users_tweets

Tweet counts

Client.get_all_tweets_count

Client.get_recent_tweets_count

Tweet lookup

Client.get_tweet

Client.get_tweets

Users

Blocks

Client.get_blocked

Follows

Client.unfollow_user

Client.unfollow

Client.get_users_followers

Client.get_users_following

Client.follow_user

Client.follow

Mutes

Client.unmute

Client.get_muted

Client.mute

User lookup

Client.get_user

Client.get_users

Client.get_me

Spaces

Search Spaces

Client.search_spaces

Spaces lookup

Client.get_spaces

Client.get_space

Client.get_space_buyers

Client.get_space_tweets

Direct Messages

Direct Messages lookup

Client.get_direct_message_events

Manage Direct Messages

Client.create_direct_message

Client.create_direct_message_conversation

Lists

List Tweets lookup

Client.get_list_tweets

List follows

Client.unfollow_list

Client.get_list_followers

Client.get_followed_lists

Client.follow_list

List lookup

Client.get_list

Client.get_owned_lists

List members

Client.remove_list_member

Client.get_list_members

Client.get_list_memberships

Client.add_list_member

Manage Lists

Client.delete_list

Client.update_list

Client.create_list

Pinned Lists

Client.unpin_list

Client.get_pinned_lists

Client.pin_list

Compliance

Batch compliance

Client.get_compliance_jobs

Client.get_compliance_job

Client.create_compliance_job

Footnotes