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
Nowe w wersji 4.0.
- Parametry
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[Union[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
- Type
Twitter API v2 Endpoint |
|
---|---|
Tweets¶
Hide replies¶
- Client.hide_reply(id)¶
Hides a reply to a Tweet.
- Parametry
id (Union[int, str]) – Unique identifier of the Tweet to hide. The Tweet must belong to a conversation initiated by the authenticating user.
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
Likes¶
- Client.unlike(tweet_id)¶
Unlike a Tweet.
The request succeeds with no action when the user sends a request to a user they’re not liking the Tweet or have already unliked the Tweet.
- Parametry
tweet_id (Union[int, str]) – The ID of the Tweet that you would like to unlike.
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
- Client.get_liking_users(id, *, expansions, media_fields, place_fields, poll_fields, tweet_fields, user_fields)¶
Allows you to get information about a Tweet’s liking users.
- Parametry
id (Union[int, str]) – Tweet ID of the Tweet to request liking users of.
expansions (Union[List[str], str]) – expansions
media_fields (Union[List[str], str]) – media_fields
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
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
- Client.get_liked_tweets(id, *, expansions, max_results, media_fields, pagination_token, place_fields, poll_fields, tweet_fields, user_fields)¶
Allows you to get information about a user’s liked Tweets.
The Tweets returned by this endpoint count towards the Project-level Tweet cap.
- Parametry
id (Union[int, str]) – User ID of the user to request liked Tweets for.
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 5 and 100. By default, each page will return 100 results.
media_fields (Union[List[str], str]) – media_fields
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 theprevious_token
returned in your previous response.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
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
- Client.like(tweet_id)¶
Like a Tweet.
- Parametry
tweet_id (Union[int, str]) – The ID of the Tweet that you would like to Like.
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/post-users-id-likes
Manage Tweets¶
- Client.delete_tweet(id)¶
Allows an authenticated user ID to delete a Tweet.
Nowe w wersji 4.3.
- Parametry
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
- Client.create_tweet(*, direct_message_deep_link=None, for_super_followers_only=None, place_id=None, media_ids=None, media_tagged_user_ids=None, poll_duration_minutes=None, poll_options=None, quote_tweet_id=None, exclude_reply_user_ids=None, in_reply_to_tweet_id=None, reply_settings=None, text=None)¶
Creates a Tweet on behalf of an authenticated user.
Nowe w wersji 4.3.
- Parametry
direct_message_deep_link (Optional[str]) – Tweets a link directly to a Direct Message conversation with an account.
for_super_followers_only (Optional[bool]) – Allows you to Tweet exclusively for Super Followers.
place_id (Optional[str]) – Place ID being attached to the Tweet for geo location.
media_ids (Optional[List[int, str]]) – A list of Media IDs being attached to the Tweet. This is only required if the request includes the
tagged_user_ids
.media_tagged_user_ids (Optional[List[Union[int, str]]]) – A list of User IDs being tagged in the Tweet with Media. If the user you’re tagging doesn’t have photo-tagging enabled, their names won’t show up in the list of tagged users even though the Tweet is successfully created.
poll_duration_minutes (Optional[int]) – Duration of the poll in minutes for a Tweet with a poll. This is only required if the request includes
poll.options
.poll_options (Optional[List[str]]) – A list of poll options for a Tweet with a poll.
quote_tweet_id (Optional[Union[int, str]]) – Link to the Tweet being quoted.
exclude_reply_user_ids (Optional[List[Union[int, str]]]) – A list of User IDs to be excluded from the reply Tweet thus removing a user from a thread.
in_reply_to_tweet_id (Optional[Union[int, str]]) – Tweet ID of the Tweet being replied to. Please note that
in_reply_to_tweet_id
needs to be in the request ifexclude_reply_user_ids
is present.reply_settings (Optional[str]) – Settings to indicate who can reply to the Tweet. Limited to „mentionedUsers” and „following”. If the field isn’t specified, it will default to everyone.
text (Optional[str]) – Text of the Tweet being created. This field is required if
media.media_ids
is not present.
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
https://developer.twitter.com/en/docs/twitter-api/tweets/manage-tweets/api-reference/post-tweets
Retweets¶
- 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.
- Parametry
source_tweet_id (Union[int, str]) – The ID of the Tweet that you would like to remove the Retweet of.
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
- 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.
- Parametry
id (Union[int, str]) – Tweet ID of the Tweet to request Retweeting users of.
expansions (Union[List[str], str]) – expansions
media_fields (Union[List[str], str]) – media_fields
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
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
Search Tweets¶
- 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.
- Parametry
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 withoutstart_time
, Tweets from 30 days beforeend_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, onlysince_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
- Zwraca
- Typ zwracany
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.
- Parametry
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, onlysince_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, onlysince_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
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
Timelines¶
- 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.
- Parametry
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
orprevious_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
, thesince_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
, theuntil_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
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
- 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.
- Parametry
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 theexclude=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
orprevious_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 thesince_id
, thesince_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 theuntil_id
, theuntil_id
will be forced to the most recent ID available.user_fields (Union[List[str], str]) – user_fields
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
https://developer.twitter.com/en/docs/twitter-api/tweets/timelines/api-reference/get-users-id-tweets
Tweet counts¶
- 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.
- Parametry
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 withoutstart_time
, Tweets from 30 days beforeend_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
, orday
granularity. The default granularity, if not specified ishour
.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, onlysince_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.
- Zwraca
- Typ zwracany
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.
- Parametry
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
, orday
granularity. The default granularity, if not specified ishour
.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, onlysince_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, onlysince_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.
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
Tweet lookup¶
- 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.
- Parametry
id (Union[int, str]) – Unique identifier of the Tweet to request
user_auth (bool) – Whether or not to use OAuth 1.0a User context
expansions (Union[List[str], str]) – expansions
media_fields (Union[List[str], str]) – media_fields
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
- Zwraca
- Typ zwracany
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.
- Parametry
ids (Union[List[int, str], str]) – A comma separated list of Tweet IDs. 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
media_fields (Union[List[str], str]) – media_fields
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
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
https://developer.twitter.com/en/docs/twitter-api/tweets/lookup/api-reference/get-tweets
Users¶
Blocks¶
- 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.
- Parametry
target_user_id (Union[int, str]) – The user ID of the user that you would like to unblock.
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
- Client.get_blocked(*, expansions, max_results, pagination_token, tweet_fields, user_fields)¶
Returns a list of users who are blocked by the authenticating user.
- Parametry
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
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
https://developer.twitter.com/en/docs/twitter-api/users/blocks/api-reference/get-users-blocking
Follows¶
- Client.unfollow_user(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.
Zmienione w wersji 4.2: Renamed from
Client.unfollow()
- Parametry
target_user_id (Union[int, str]) – The user ID of the user that you would like to unfollow.
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
- Client.unfollow(target_user_id)¶
Alias for
Client.unfollow_user()
Niezalecane od wersji 4.2: Use
Client.unfollow_user()
instead.
- 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.
- Parametry
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 theprevious_token
returned in your previous response.tweet_fields (Union[List[str], str]) – tweet_fields
user_fields (Union[List[str], str]) – user_fields
- Zwraca
- Typ zwracany
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.
- Parametry
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 theprevious_token
returned in your previous response.tweet_fields (Union[List[str], str]) – tweet_fields
user_fields (Union[List[str], str]) – user_fields
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/get-users-id-following
- Client.follow_user(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.
Zmienione w wersji 4.2: Renamed from
Client.follow()
- Parametry
target_user_id (Union[int, str]) – The user ID of the user that you would like to follow.
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
- Client.follow(target_user_id)¶
Alias for
Client.follow_user()
Niezalecane od wersji 4.2: Use
Client.follow_user()
instead.
Mutes¶
- 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.
- Parametry
target_user_id (Union[int, str]) – The user ID of the user that you would like to unmute.
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
- Client.get_muted(*, expansions, max_results, pagination_token, tweet_fields, user_fields)¶
Returns a list of users who are muted by the authenticating user.
Nowe w wersji 4.1.
- Parametry
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
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
https://developer.twitter.com/en/docs/twitter-api/users/mutes/api-reference/get-users-muting
User lookup¶
- 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.
- Parametry
username (str) – The Twitter username (handle) of the user.
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
- Wyrzuca
TypeError – If ID and username are not passed or both are passed
- Zwraca
- Typ zwracany
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.
- Parametry
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
- Wyrzuca
TypeError – If IDs and usernames are not passed or both are passed
- Zwraca
- Typ zwracany
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
Spaces¶
Search Spaces¶
- Client.search_spaces(query, *, expansions, max_results, space_fields, state, user_fields)¶
Return live or scheduled Spaces matching your specified search terms
Nowe w wersji 4.1.
Zmienione w wersji 4.2:
state
is now an optional parameter.- Parametry
query (str) – Your search term. This can be any text (including mentions and Hashtags) present in the title of the Space.
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
state (str) – Determines the type of results to return. This endpoint returns all Spaces by default. Use
live
to only return live Spaces orscheduled
to only return upcoming Spaces.user_fields (Union[List[str], str]) – user_fields
- Zwraca
- Typ zwracany
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.
Nowe w wersji 4.1.
- Parametry
ids (Union[List[str], str]) – A comma separated list of Spaces (up to 100).
user_ids (Union[List[int, str], str]) – A comma separated list of user IDs (up to 100).
expansions (Union[List[str], str]) – expansions
space_fields (Union[List[str], str]) – space_fields
user_fields (Union[List[str], str]) – user_fields
- Wyrzuca
TypeError – If IDs and user IDs are not passed or both are passed
- Zwraca
- Typ zwracany
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.
Nowe w wersji 4.1.
- Parametry
id (Union[List[str], str]) – Unique identifier of the Space to request.
expansions (Union[List[str], str]) – expansions
space_fields (Union[List[str], str]) – space_fields
user_fields (Union[List[str], str]) – user_fields
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
https://developer.twitter.com/en/docs/twitter-api/spaces/lookup/api-reference/get-spaces-id
Lists¶
Manage Lists¶
- Client.delete_list(id)¶
Enables the authenticated user to delete a List that they own.
Nowe w wersji 4.2.
- Parametry
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/delete-lists-id
- Client.remove_list_member(id, user_id)¶
Enables the authenticated user to remove a member from a List they own.
Nowe w wersji 4.2.
- Parametry
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
- Client.unfollow_list(list_id)¶
Enables the authenticated user to unfollow a List.
Nowe w wersji 4.2.
- Parametry
list_id (Union[int, str]) – The ID of the List that you would like the user to unfollow.
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
- Client.unpin_list(list_id)¶
Enables the authenticated user to unpin a List.
Nowe w wersji 4.2.
- Parametry
list_id (Union[int, str]) – The ID of the List that you would like the user to unpin.
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
- Client.update_list(id, *, description=None, name=None, private=None)¶
Enables the authenticated user to update the meta data of a specified List that they own.
Nowe w wersji 4.2.
- Parametry
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/put-lists-id
- Client.create_list(name, *, description=None, private=None)¶
Enables the authenticated user to create a List.
Nowe w wersji 4.2.
- Parametry
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/post-lists
- Client.add_list_member(id, user_id)¶
Enables the authenticated user to add a member to a List they own.
Nowe w wersji 4.2.
- Parametry
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
- Client.follow_list(list_id)¶
Enables the authenticated user to follow a List.
Nowe w wersji 4.2.
- Parametry
list_id (Union[int, str]) – The ID of the List that you would like the user to follow.
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
Compliance¶
Batch compliance¶
- Client.get_compliance_jobs(type, *, status)¶
Returns a list of recent compliance jobs.
Nowe w wersji 4.1.
- Parametry
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
- Client.get_compliance_job(id)¶
Get a single compliance job with the specified ID.
Nowe w wersji 4.1.
- Parametry
id (Union[int, str]) – The unique identifier for the compliance job you want to retrieve.
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
- 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.
Nowe w wersji 4.1.
- Parametry
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.
- Zwraca
- Typ zwracany
Union[dict, requests.Response, Response]
References
Expansions and Fields Parameters¶
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
¶
For methods that return Tweets, this fields parameter enables you to select
which specific Tweet fields will deliver in each returned Tweet object.
Specify the desired fields in a comma-separated list without spaces between
commas and fields. You can also pass the expansions=referenced_tweets.id
expansion to return the specified fields for both the original Tweet and any
included referenced Tweets. The requested Tweet fields will display in both the
original Tweet data object, as well as in the referenced Tweet expanded data
object that will be located in the includes
data object.
For methods that return users, this fields parameter enables you to select
which specific Tweet fields will deliver in each returned pinned Tweet.
Specify the desired fields in a comma-separated list without spaces between
commas and fields. The Tweet fields will only return if the user has a pinned
Tweet and if you’ve also included the expansions=pinned_tweet_id
query
parameter in your request. While the referenced Tweet ID will be located in the
original Tweet object, you will find this ID and all additional Tweet fields in
the includes
data object.
user_fields
¶
For methods that return Spaces or Tweets, this fields parameter enables you
to select which specific user fields will deliver in each returned Space or
Tweet. Specify the desired fields in a comma-separated list without spaces
between commas and fields. While the user ID will be located in the original
Tweet object, you will find this ID and all additional user fields in the
includes
data object.
You must also pass one of the user expansions to return the desired user fields:
expansions=author_id
expansions=entities.mentions.username
expansions=in_reply_to_user_id
expansions=referenced_tweets.id.author_id
For methods that return users, this fields parameter enables you to select which specific user fields will deliver with each returned users objects. Specify the desired fields in a comma-separated list without spaces between commas and fields. These specified user fields will display directly in the user data objects.