tweepy.Client — Twitter API v2 Reference

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

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) – リミットに達したときに待つかどうか

session

Requests Session used to make requests to the API

Type

requests.Session

user_agent

User agent used when making requests to the API

Type

str

Tweets

リプライを隠す

Client.hide_reply(id)

ツイートに対するリプライを非表示にする.

Parameters

id (Union[int, str]) – 隠したいツイートのユニーク ID を指定する. ツイートは認証したユーザのツイートに対するリプライに属している必要がある.

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/tweets/hide-replies/api-reference/put-tweets-id-hidden

Client.unhide_reply(id)

非表示にしたリプライを戻す.

Parameters

id (Union[int, str]) – 非表示から戻したいツイートのユニーク ID を指定する. ツイートは認証したユーザのツイートに対するリプライに属している必要がある.

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/tweets/hide-replies/api-reference/put-tweets-id-hidden

いいねの処理

Client.unlike(tweet_id)

いいねを解除する.

ユーザがすでに「いいね」をしている, またはすでに「いいね」を解除している ツイートへリクエストを送った場合, 何もせずにメソッドは成功したことになります.

Parameters

tweet_id (Union[int, str]) – 「いいね」を解除したいツイートの ID.

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/delete-users-user_id-likes

Client.get_liking_users(id, *, expansions, media_fields, place_fields, poll_fields, tweet_fields, user_fields)

ツイートに「いいね」をしたユーザを取得します.

Parameters
Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/get-tweets-id-liking_users

Client.get_liked_tweets(id, *, expansions, max_results, media_fields, pagination_token, place_fields, poll_fields, tweet_fields, user_fields)

あるユーザが「いいね」をしたツイートを取得します.

The Tweets returned by this endpoint count towards the Project-level Tweet cap.

Parameters
  • id (Union[int, str]) – 「いいね」したツイートを取得したいユーザの ID.

  • expansions (Union[List[str], str]) – expansions

  • max_results (int) – ページあたりの結果の最大数を指定します. この数値は 5 から 100 の間で設定でき, デフォルトではページあたり 100 件返ってきます.

  • media_fields (Union[List[str], str]) – media_fields

  • pagination_token (str) – 最新のリクエストですべての結果が返されなかった場合に, 次の結果ページ, または前の結果ページをリクエストするため用います. 次のページを返すには、前のレスポンスで返された next_token を渡します. 1 ページ戻るには, 前のレスポンスで返された previous_token を渡します.

  • place_fields (Union[List[str], str]) – place_fields

  • poll_fields (Union[List[str], str]) – poll_fields

  • tweet_fields (Union[List[str], str]) – tweet_fields

  • user_fields (Union[List[str], str]) – user_fields

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/get-users-id-liked_tweets

Client.like(tweet_id)

Like a Tweet.

Parameters

tweet_id (Union[int, str]) – The ID of the Tweet that you would like to Like.

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/post-users-user_id-likes

リツイートの処理

Client.unretweet(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

Return type

Union[dict, requests.Response, Response]

References

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

Client.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
Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/tweets/retweets/api-reference/get-tweets-id-retweeted_by

Client.retweet(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

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/tweets/retweets/api-reference/post-users-id-retweets

ツイート検索

Client.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]) – expansions

  • 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]) – media_fields

  • 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]) – place_fields

  • poll_fields (Union[List[str], str]) – poll_fields

  • 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]) – tweet_fields

  • 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]) – user_fields

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-all

Client.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]) – expansions

  • 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]) – media_fields

  • 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]) – place_fields

  • poll_fields (Union[List[str], str]) – poll_fields

  • 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]) – tweet_fields

  • 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]) – user_fields

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-recent

タイムライン操作

Client.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]) – expansions

  • 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]) – media_fields

  • 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]) – place_fields

  • poll_fields (Union[List[str], str]) – poll_fields

  • 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]) – tweet_fields

  • 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]) – user_fields

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/tweets/timelines/api-reference/get-users-id-mentions

Client.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]) – expansions

  • 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]) – media_fields

  • 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]) – place_fields

  • poll_fields (Union[List[str], str]) – poll_fields

  • 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]) – tweet_fields

  • 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]) – user_fields

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/tweets/timelines/api-reference/get-users-id-tweets

ツイートカウント

Client.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

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/tweets/counts/api-reference/get-tweets-counts-all

Client.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

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/tweets/counts/api-reference/get-tweets-counts-recent

ツイート閲覧

Client.get_tweet(id, *, user_auth=False, expansions, media_fields, place_fields, poll_fields, twitter_fields, user_fields)

Returns a variety of information about a single Tweet specified by the requested ID.

Parameters
Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/tweets/lookup/api-reference/get-tweets-id

Client.get_tweets(ids, *, user_auth=False, expansions, media_fields, place_fields, poll_fields, twitter_fields, user_fields)

Returns a variety of information about the Tweet specified by the requested ID or list of IDs.

Parameters
Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/tweets/lookup/api-reference/get-tweets

ユーザー関係

ブロック処理

Client.unblock(target_user_id)

Unblock another user.

The request succeeds with no action when the user sends a request to a user they’re not blocking or have already unblocked.

Parameters

target_user_id (Union[int, str]) – The user ID of the user that you would like to unblock.

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/users/blocks/api-reference/delete-users-user_id-blocking

Client.get_blocked(*, expansions, max_results, pagination_token, tweet_fields, user_fields)

Returns a list of users who are blocked by the authenticating user.

Parameters
  • expansions (Union[List[str], str]) – expansions

  • max_results (int) – The maximum number of results to be returned per page. This can be a number between 1 and 1000. By default, each page will return 100 results.

  • 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.

  • tweet_fields (Union[List[str], str]) – tweet_fields

  • user_fields (Union[List[str], str]) – user_fields

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/users/blocks/api-reference/get-users-blocking

Client.block(target_user_id)

Block another user.

Parameters

target_user_id (Union[int, str]) – The user ID of the user that you would like to block.

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/users/blocks/api-reference/post-users-user_id-blocking

フォロー処理

Client.unfollow(target_user_id)

Allows a user ID to unfollow another user.

The request succeeds with no action when the authenticated user sends a request to a user they’re not following or have already unfollowed.

Parameters

target_user_id (Union[int, str]) – The user ID of the user that you would like to unfollow.

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/delete-users-source_id-following

Client.get_users_followers(id, *, user_auth=False, expansions, max_results, pagination_token, tweet_fields, user_fields)

Returns a list of users who are followers of the specified user ID.

Parameters
  • id (Union[int, str]) – The user ID whose followers you would like to retrieve.

  • user_auth (bool) – Whether or not to use OAuth 1.0a User context

  • expansions (Union[List[str], str]) – expansions

  • max_results (int) – The maximum number of results to be returned per page. This can be a number between 1 and the 1000. By default, each page will return 100 results.

  • 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.

  • tweet_fields (Union[List[str], str]) – tweet_fields

  • user_fields (Union[List[str], str]) – user_fields

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/get-users-id-followers

Client.get_users_following(id, *, user_auth=False, expansions, max_results, pagination_token, tweet_fields, user_fields)

Returns a list of users the specified user ID is following.

Parameters
  • id (Union[int, str]) – The user ID whose following you would like to retrieve.

  • user_auth (bool) – Whether or not to use OAuth 1.0a User context

  • expansions (Union[List[str], str]) – expansions

  • max_results (int) – The maximum number of results to be returned per page. This can be a number between 1 and the 1000. By default, each page will return 100 results.

  • 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.

  • tweet_fields (Union[List[str], str]) – tweet_fields

  • user_fields (Union[List[str], str]) – user_fields

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/get-users-id-following

Client.follow(target_user_id)

Allows a user ID to follow another user.

If the target user does not have public Tweets, this endpoint will send a follow request.

The request succeeds with no action when the authenticated user sends a request to a user they’re already following, or if they’re sending a follower request to a user that does not have public Tweets.

Parameters

target_user_id (Union[int, str]) – The user ID of the user that you would like to follow.

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/post-users-source_user_id-following

ミュート処理

Client.unmute(target_user_id)

Allows an authenticated user ID to unmute the target user.

The request succeeds with no action when the user sends a request to a user they’re not muting or have already unmuted.

Parameters

target_user_id (Union[int, str]) – The user ID of the user that you would like to unmute.

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/users/mutes/api-reference/delete-users-user_id-muting

Client.get_muted(*, expansions, max_results, pagination_token, tweet_fields, user_fields)

Returns a list of users who are muted by the authenticating user.

Parameters
  • expansions (Union[List[str], str]) – expansions

  • max_results (int) – The maximum number of results to be returned per page. This can be a number between 1 and 1000. By default, each page will return 100 results.

  • 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.

  • tweet_fields (Union[List[str], str]) – tweet_fields

  • user_fields (Union[List[str], str]) – user_fields

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/users/mutes/api-reference/get-users-muting

Client.mute(target_user_id)

Allows an authenticated user ID to mute the target user.

Parameters

target_user_id (Union[int, str]) – The user ID of the user that you would like to mute.

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/users/mutes/api-reference/post-users-user_id-muting

ユーザー関係処理

Client.get_user(*, id, username, user_auth=False, expansions, tweet_fields, user_fields)

Returns a variety of information about a single user specified by the requested ID or username.

Parameters
Raises

TypeError – If ID and username are not passed or both are passed

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-id https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-by-username-username

Client.get_users(*, ids, usernames, user_auth=False, expansions, tweet_fields, user_fields)

Returns a variety of information about one or more users specified by the requested IDs or usernames.

Parameters
  • ids (Union[List[int, str], str]) – A comma separated list of user IDs. Up to 100 are allowed in a single request. Make sure to not include a space between commas and fields.

  • usernames (Union[List[str], str]) – A comma separated list of Twitter usernames (handles). Up to 100 are allowed in a single request. Make sure to not include a space between commas and fields.

  • user_auth (bool) – Whether or not to use OAuth 1.0a User context

  • expansions (Union[List[str], str]) – expansions

  • tweet_fields (Union[List[str], str]) – tweet_fields

  • user_fields (Union[List[str], str]) – user_fields

Raises

TypeError – If IDs and usernames are not passed or both are passed

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-by

スペース機能

スペース検索

Client.search_spaces(query, state, *, expansions, max_results, space_fields, user_fields)

Return live or scheduled Spaces matching your specified search terms

Parameters
  • query (str) – Your search term. This can be any text (including mentions and Hashtags) present in the title of the Space.

  • state (str) – Determines the type of results to return. Use live to return live Spaces or scheduled to return upcoming Spaces.

  • expansions (Union[List[str], str]) – expansions

  • max_results (int) – The maximum number of results to return in this request. Specify a value between 1 and 100.

  • space_fields (Union[List[str], str]) – space_fields

  • user_fields (Union[List[str], str]) – user_fields

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/spaces/search/api-reference/get-spaces-search

Spaces lookup

Client.get_spaces(*, ids, user_ids, expansions, space_fields, user_fields)

Returns details about multiple live or scheduled Spaces (created by the specified user IDs if specified). Up to 100 comma-separated Space or user IDs can be looked up using this endpoint.

Parameters
Raises

TypeError – If IDs and user IDs are not passed or both are passed

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/spaces/lookup/api-reference/get-spaces https://developer.twitter.com/en/docs/twitter-api/spaces/lookup/api-reference/get-spaces-by-creator-ids

Client.get_space(id, *, expansions, space_fields, user_fields)

Returns a variety of information about a single Space specified by the requested ID.

Parameters
Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/spaces/lookup/api-reference/get-spaces-id

Compliance

Batch compliance

Client.get_compliance_jobs(type, *, status)

Returns a list of recent compliance jobs.

Parameters
  • type (str) – Allows to filter by job type - either by tweets or user ID. Only one filter (tweets or users) can be specified per request.

  • status (str) – Allows to filter by job status. Only one filter can be specified per request. Default: all

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/compliance/batch-compliance/api-reference/get-compliance-jobs

Client.get_compliance_job(id)

Get a single compliance job with the specified ID.

Parameters

id (Union[int, str]) – The unique identifier for the compliance job you want to retrieve.

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/compliance/batch-compliance/api-reference/get-compliance-jobs-id

Client.create_compliance_job(type, *, name=None, resumable=None)

Creates a new compliance job for Tweet IDs or user IDs.

A compliance job will contain an ID and a destination URL. The destination URL represents the location that contains the list of IDs consumed by your app.

You can run one batch job at a time.

Parameters
  • type (str) – Specify whether you will be uploading tweet or user IDs. You can either specify tweets or users.

  • name (str) – A name for this job, useful to identify multiple jobs using a label you define.

  • resumable (bool) – Specifies whether to enable the upload URL with support for resumable uploads. If true, this endpoint will return a pre-signed URL with resumable uploads enabled.

Returns

Return type

Union[dict, requests.Response, Response]

References

https://developer.twitter.com/en/docs/twitter-api/compliance/batch-compliance/api-reference/post-compliance-jobs

拡張およびフィールドパラメータ

expansions

Expansions enable you to request additional data objects that relate to the originally returned Space, Tweets, or users. Submit a list of desired expansions in a comma-separated list without spaces. The ID that represents the expanded data object will be included directly in the Space, Tweet, or user data object, but the expanded object metadata will be returned within the includes response object, and will also include the ID so that you can match this data object to the original Space or Tweet object.

For methods that return Spaces, the following data objects can be expanded using this parameter:

  • The Spaces creator’s user object

  • The user objects of any Space co-host

  • Any mentioned users’ object

  • Any speaker’s user object

For methods that return Tweets, the following data objects can be expanded using this parameter:

  • The Tweet author’s user object

  • The user object of the Tweet’s author that the original Tweet is responding to

  • Any mentioned users’ object

  • Any referenced Tweets’ author’s user object

  • Attached media’s object

  • Attached poll’s object

  • Attached place’s object

  • Any referenced Tweets’ object

At this time, the only expansion available to endpoints that primarily return user objects is expansions=pinned_tweet_id. You will find the expanded Tweet data object living in the includes response object.

media_fields

This fields parameter enables you to select which specific media fields will deliver in each returned Tweet. Specify the desired fields in a comma-separated list without spaces between commas and fields. The Tweet will only return media fields if the Tweet contains media and if you’ve also included the expansions=attachments.media_keys query parameter in your request. While the media ID will be located in the Tweet object, you will find this ID and all additional media fields in the includes data object.

place_fields

This fields parameter enables you to select which specific place fields will deliver in each returned Tweet. Specify the desired fields in a comma-separated list without spaces between commas and fields. The Tweet will only return place fields if the Tweet contains a place and if you’ve also included the expansions=geo.place_id query parameter in your request. While the place ID will be located in the Tweet object, you will find this ID and all additional place fields in the includes data object.

poll_fields

This fields parameter enables you to select which specific poll fields will deliver in each returned Tweet. Specify the desired fields in a comma-separated list without spaces between commas and fields. The Tweet will only return poll fields if the Tweet contains a poll and if you’ve also included the expansions=attachments.poll_ids query parameter in your request. While the poll ID will be located in the Tweet object, you will find this ID and all additional poll fields in the includes data object.

space_fields

This fields parameter enables you to select which specific Space fields will deliver in each returned Space. Specify the desired fields in a comma-separated list.

tweet_fields

ツイートを返すメソッドの場合, この fields パラメータによって 返されるツイートのうちから, 特定の Tweet fields を選ぶことができます. 必要なフィールドをスペースなしのカンマ区切りリストで指定する必要があります. また expansions=referenced_tweets.id を指定することで 引用元のツイートと引用ツイートの両方について特定のフィールドを取得することもできます. 要求されたフィールドは, オリジナルのツイートデータオブジェクトと includes データオブジェクトとして引用元のツイートデータオブジェクトを取得します.

ユーザを返すメソッドの場合, この fields パラメータによって そのユーザの固定ツイートのうちから, 特定の Tweet fields を選ぶことができます. 必要なフィールドをスペースなしのカンマ区切りリストで指定する必要があります. 指定したユーザが固定ツイートを設定しており, かつ expansions=pinned_tweet_id クエリパラメータをリクエストしていた 場合にのみ Tweet fields が返ってきます. 引用元のツイート ID は引用ツイートのオブジェクトに含まれ, include データオブジェクトの中から見つけることができます.

user_fields

ツイートまたはスペースを返すメソッドの場合, この fields パラメータによって ツイートまたはスペースごとに特定の user fields を選ぶことができます. 必要なフィールドをスペースなしのカンマ区切りリストで指定する必要があります. ユーザ ID は元のツイートオブジェクトに含まれ, include データオブジェクトの中から見つけることができます.

また必要な user fields を返すために, いずれかの user expansion を渡す必要があります.

  • expansions=author_id

  • expansions=entities.mentions.username

  • expansions=in_reply_to_user_id

  • expansions=referenced_tweets.id.author_id

ユーザを返すメソッドの場合, この fields パラメータによって ユーザごとに特定の user fields を選ぶことができます. 必要なフィールドをスペースなしのカンマ区切りリストで指定する必要があります. これらの特定のユーザフィールドはユーザデータオブジェクトの中で直接表示されます.

Response

class tweepy.Response(data, includes, errors, meta)

The Response returned by Client methods is a collections.namedtuple, with data, includes, errors, and meta fields, corresponding with the fields in responses from Twitter’s API.