[PR]

`Client`

class tweepy.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

バージョン 4.0 で追加.

パラメータ:

bearer_token (str | None) -- Twitter API OAuth 2.0 Bearer トークン / アクセストークン
consumer_key (str | None) -- Twitter API OAuth 1.0a コンシューマキー
consumer_secret (str | None) -- Twitter API OAuth 1.0a コンシューマシークレット
access_token (str | None) -- Twitter API OAuth 1.0a アクセストークン
access_token_secret (str | None) -- Twitter API OAuth 1.0a アクセストークンシークレット
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

session

Requests Session used to make requests to the API

型:: requests.Session

user_agent

User agent used when making requests to the API

型:: str

Twitter API v2 エンドポイント	`Client` メソッド
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*
DELETE /2/users/:source_user_id/blocking/:target_user_id	`Client.unblock()`
GET /2/users/:id/blocking	`Client.get_blocked()`
POST /2/users/:id/blocking	`Client.block()`
*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(tweet_id)

Allows a user or authenticated user ID to remove a Bookmark of a Tweet.

注釈

A request is made beforehand to Twitter's API to determine the authenticating user's ID. This is cached and only done once per Client instance for each access token used.

バージョン 4.8 で追加.

パラメータ:: tweet_id (int | str) -- The ID of the Tweet that you would like the id to remove a Bookmark of.
例外:: TypeError -- If the access token isn't set
戻り値の型:: dict | requests.Response | Response

参照

https://developer.twitter.com/en/docs/twitter-api/tweets/bookmarks/api-reference/delete-users-id-bookmarks-tweet_id

Client.get_bookmarks(*, expansions=None, max_results=None, media_fields=None, pagination_token=None, place_fields=None, poll_fields=None, tweet_fields=None, user_fields=None)

Allows you to get an authenticated user's 800 most recent bookmarked Tweets.

注釈

A request is made beforehand to Twitter's API to determine the authenticating user's ID. This is cached and only done once per Client instance for each access token used.

バージョン 4.8 で追加.

パラメータ:

expansions (list[str] | str | None) -- expansions
max_results (int | None) -- The maximum number of results to be returned per page. This can be a number between 1 and 100. By default, each page will return 100 results.
media_fields (list[str] | str | None) -- media_fields
pagination_token (str | None) -- 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 (list[str] | str | None) -- place_fields
poll_fields (list[str] | str | None) -- poll_fields
tweet_fields (list[str] | str | None) -- tweet_fields
user_fields (list[str] | str | None) -- user_fields

例外:

TypeError -- If the access token isn't set

戻り値の型:

Client

Tweets

Bookmarks

リプライを隠す

いいね

ツイートの管理

Quote Tweets

Retweets

ツイート検索

Timelines

Tweet counts

Tweet lookup

Users

Blocks

Follows

Mutes

User lookup

Spaces

Search Spaces

Spaces lookup

Direct Messages

Direct Messages lookup

Manage Direct Messages

Lists

List Tweets lookup

フォロー一覧

List lookup

List members

Manage Lists

Pinned Lists

Compliance

Batch compliance

`Client`