`tweepy.API` — Twitter API v1.1 Reference¶

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

References

API.search_full_archive(label, query, *, tag, fromDate, toDate, maxResults, next)¶

Premium search that provides Tweets from as early as 2006, starting with the first Tweet posted in March 2006.

Parameters

label – The (case-sensitive) label associated with your search developer environment, as displayed at https://developer.twitter.com/en/account/environments.
query –
The equivalent of one premium rule/filter, with up to 1,024 characters (256 with Sandbox dev environments).

This parameter should include ALL portions of the rule/filter, including all operators, and portions of the rule should not be separated into other parameters of the query.
tag –
Tags can be used to segregate rules and their matching data into different logical groups. If a rule tag is provided, the rule tag is included in the ‘matching_rules’ attribute.

It is recommended to assign rule-specific UUIDs to rule tags and maintain desired mappings on the client side.
fromDate –
The oldest UTC timestamp (from most recent 30 days) from which the Tweets will be provided. Timestamp is in minute granularity and is inclusive (i.e. 12:00 includes the 00 minute).

Specified: Using only the fromDate with no toDate parameter will deliver results for the query going back in time from now( ) until the fromDate.

Not Specified: If a fromDate is not specified, the API will deliver all of the results for 30 days prior to now( ) or the toDate (if specified).

If neither the fromDate or toDate parameter is used, the API will deliver all results for the most recent 30 days, starting at the time of the request, going backwards.
toDate –
The latest, most recent UTC timestamp to which the Tweets will be provided. Timestamp is in minute granularity and is not inclusive (i.e. 11:59 does not include the 59th minute of the hour).

Specified: Using only the toDate with no fromDate parameter will deliver the most recent 30 days of data prior to the toDate.

Not Specified: If a toDate is not specified, the API will deliver all of the results from now( ) for the query going back in time to the fromDate.

If neither the fromDate or toDate parameter is used, the API will deliver all results for the entire 30-day index, starting at the time of the request, going backwards.
maxResults – The maximum number of search results to be returned by a request. A number between 10 and the system limit (currently 500, 100 for Sandbox environments). By default, a request response will return 100 results.
next – 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.

Returns

Return type

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

References

Tweets¶

Get Tweet timelines¶

API.home_timeline(*, count, since_id, max_id, trim_user, exclude_replies, include_entities)¶

Returns the 20 most recent statuses, including retweets, posted by the authenticating user and that user’s friends. This is the equivalent of /timeline/home on the Web.

Parameters

count – The number of results to try and retrieve per page.
since_id – Returns only statuses with an ID greater than (that is, more recent than) the specified ID.
max_id – Returns only statuses with an ID less than (that is, older than) or equal to the specified ID.
trim_user – A boolean indicating if user IDs should be provided, instead of complete user objects. Defaults to False.
exclude_replies – This parameter will prevent replies from appearing in the returned timeline. Using exclude_replies with the count parameter will mean you will receive up-to count Tweets — this is because the count parameter retrieves that many Tweets before filtering out retweets and replies.
include_entities – The entities node will not be included when set to false. Defaults to true.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/timelines/api-reference/get-statuses-home_timeline

References

API.mentions_timeline(*, count, since_id, max_id, trim_user, include_entities)¶

Returns the 20 most recent mentions, including retweets.

Parameters

count – The number of results to try and retrieve per page.
since_id – Returns only statuses with an ID greater than (that is, more recent than) the specified ID.
max_id – Returns only statuses with an ID less than (that is, older than) or equal to the specified ID.
trim_user – A boolean indicating if user IDs should be provided, instead of complete user objects. Defaults to False.
include_entities – The entities node will not be included when set to false. Defaults to true.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/timelines/api-reference/get-statuses-mentions_timeline

References

API.user_timeline(*, user_id, screen_name, since_id, count, max_id, trim_user, exclude_replies, include_rts)¶

Returns the 20 most recent statuses posted from the authenticating user or the user specified. It’s also possible to request another user’s timeline via the id parameter.

Parameters

user_id – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.
screen_name – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
since_id – Returns only statuses with an ID greater than (that is, more recent than) the specified ID.
count – The number of results to try and retrieve per page.
max_id – Returns only statuses with an ID less than (that is, older than) or equal to the specified ID.
trim_user – A boolean indicating if user IDs should be provided, instead of complete user objects. Defaults to False.
exclude_replies – This parameter will prevent replies from appearing in the returned timeline. Using exclude_replies with the count parameter will mean you will receive up-to count Tweets — this is because the count parameter retrieves that many Tweets before filtering out retweets and replies.
include_rts – When set to false, the timeline will strip any native retweets (though they will still count toward both the maximal length of the timeline and the slice selected by the count parameter). Note: If you’re using the trim_user parameter in conjunction with include_rts, the retweets will still contain a full user object.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/timelines/api-reference/get-statuses-user_timeline

References

Post, retrieve, and engage with Tweets¶

API.get_favorites(*, user_id, screen_name, count, since_id, max_id, include_entities)¶

Returns the favorite statuses for the authenticating user or user specified by the ID parameter.

Parameters

user_id – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.
screen_name – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
count – The number of results to try and retrieve per page.
since_id – Returns only statuses with an ID greater than (that is, more recent than) the specified ID.
max_id – Returns only statuses with an ID less than (that is, older than) or equal to the specified ID.
include_entities – The entities node will not be included when set to false. Defaults to true.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-favorites-list

References

API.lookup_statuses(id, *, include_entities, trim_user, map, include_ext_alt_text, include_card_uri)¶

Returns full Tweet objects for up to 100 Tweets per request, specified by the id parameter.

Parameters

id – A list of Tweet IDs to lookup, up to 100
include_entities – The entities node will not be included when set to false. Defaults to true.
trim_user – A boolean indicating if user IDs should be provided, instead of complete user objects. Defaults to False.
map – A boolean indicating whether or not to include Tweets that cannot be shown. Defaults to False.
include_ext_alt_text – If alt text has been added to any attached media entities, this parameter will return an ext_alt_text value in the top-level key for the media entity.
include_card_uri – A boolean indicating if the retrieved Tweet should include a card_uri attribute when there is an ads card attached to the Tweet and when that card was attached using the card_uri value.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-lookup

References

API.get_oembed(url, *, maxwidth, hide_media, hide_thread, omit_script, align, related, lang, theme, link_color, widget_type, dnt)¶

Returns a single Tweet, specified by either a Tweet web URL or the Tweet ID, in an oEmbed-compatible format. The returned HTML snippet will be automatically recognized as an Embedded Tweet when Twitter’s widget JavaScript is included on the page.

The oEmbed endpoint allows customization of the final appearance of an Embedded Tweet by setting the corresponding properties in HTML markup to be interpreted by Twitter’s JavaScript bundled with the HTML response by default. The format of the returned markup may change over time as Twitter adds new features or adjusts its Tweet representation.

The Tweet fallback markup is meant to be cached on your servers for up to the suggested cache lifetime specified in the cache_age.

Parameters

url – The URL of the Tweet to be embedded
maxwidth – The maximum width of a rendered Tweet in whole pixels. A supplied value under or over the allowed range will be returned as the minimum or maximum supported width respectively; the reset width value will be reflected in the returned width property. Note that Twitter does not support the oEmbed maxheight parameter. Tweets are fundamentally text, and are therefore of unpredictable height that cannot be scaled like an image or video. Relatedly, the oEmbed response will not provide a value for height. Implementations that need consistent heights for Tweets should refer to the hide_thread and hide_media parameters below.
hide_media – When set to true, "t", or 1, links in a Tweet are not expanded to photo, video, or link previews.
hide_thread – When set to true, "t", or 1, a collapsed version of the previous Tweet in a conversation thread will not be displayed when the requested Tweet is in reply to another Tweet.
omit_script – When set to true, "t", or 1, the <script> responsible for loading widgets.js will not be returned. Your webpages should include their own reference to widgets.js for use across all Twitter widgets including Embedded Tweets.
align – Specifies whether the embedded Tweet should be floated left, right, or center in the page relative to the parent element.
related – A comma-separated list of Twitter usernames related to your content. This value will be forwarded to Tweet action intents if a viewer chooses to reply, like, or retweet the embedded Tweet.
lang – Request returned HTML and a rendered Tweet in the specified Twitter language supported by embedded Tweets.
theme – When set to dark, the Tweet is displayed with light text over a dark background.
link_color – Adjust the color of Tweet text links with a hexadecimal color value.
widget_type – Set to video to return a Twitter Video embed for the given Tweet.
dnt – When set to true, the Tweet and its embedded page on your site are not used for purposes that include personalized suggestions and personalized ads.

Returns

JSON

Return type

dict

References

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-oembed

API.get_retweeter_ids(id, *, count, cursor, stringify_ids)¶

Returns up to 100 user IDs belonging to users who have retweeted the Tweet specified by the id parameter.

Parameters

id – The numerical ID of the status.
count – The number of results to try and retrieve per page.
cursor – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.
stringify_ids – Have IDs returned as strings instead

Returns

Return type

List[int]

References

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-retweeters-ids

API.get_retweets(id, *, count, trim_user)¶

Returns up to 100 of the first Retweets of the given Tweet.

Parameters

id – The numerical ID of the status.
count – The number of results to try and retrieve per page.
trim_user – A boolean indicating if user IDs should be provided, instead of complete user objects. Defaults to False.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-retweets-id

References

API.get_retweets_of_me(*, count, since_id, max_id, trim_user, include_entities, include_user_entities)¶

Returns the 20 most recent Tweets of the authenticated user that have been retweeted by others.

Parameters

count – The number of results to try and retrieve per page.
since_id – Returns only statuses with an ID greater than (that is, more recent than) the specified ID.
max_id – Returns only statuses with an ID less than (that is, older than) or equal to the specified ID.
trim_user – A boolean indicating if user IDs should be provided, instead of complete user objects. Defaults to False.
include_entities – The entities node will not be included when set to false. Defaults to true.
include_user_entities – The user object entities node will not be included when set to false. Defaults to true.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-retweets_of_me

References

API.get_status(id, *, trim_user, include_my_retweet, include_entities, include_ext_alt_text, include_card_uri)¶

Returns a single status specified by the ID parameter.

Parameters

id – The numerical ID of the status.
trim_user – A boolean indicating if user IDs should be provided, instead of complete user objects. Defaults to False.
include_my_retweet – A boolean indicating if any Tweets returned that have been retweeted by the authenticating user should include an additional current_user_retweet node, containing the ID of the source status for the retweet.
include_entities – The entities node will not be included when set to false. Defaults to true.
include_ext_alt_text – If alt text has been added to any attached media entities, this parameter will return an ext_alt_text value in the top-level key for the media entity.
include_card_uri – A boolean indicating if the retrieved Tweet should include a card_uri attribute when there is an ads card attached to the Tweet and when that card was attached using the card_uri value.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-show-id

References

API.create_favorite(id, *, include_entities)¶

Favorites the status specified in the id parameter as the authenticating user.

Parameters

id – The numerical ID of the status.
include_entities – The entities node will not be included when set to false. Defaults to true.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-favorites-create

References

API.destroy_favorite(id, *, include_entities)¶

Un-favorites the status specified in the id parameter as the authenticating user.

Parameters

id – The numerical ID of the status.
include_entities – The entities node will not be included when set to false. Defaults to true.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-favorites-destroy

References

API.destroy_status(id, *, trim_user)¶

Destroy the status specified by the id parameter. The authenticated user must be the author of the status to destroy.

Parameters

id – The numerical ID of the status.
trim_user – A boolean indicating if user IDs should be provided, instead of complete user objects. Defaults to False.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-destroy-id

References

API.retweet(id, *, trim_user)¶

Retweets a Tweet. Requires the ID of the Tweet you are retweeting.

Parameters

id – The numerical ID of the status.
trim_user – A boolean indicating if user IDs should be provided, instead of complete user objects. Defaults to False.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-retweet-id

References

API.unretweet(id, *, trim_user)¶

Untweets a retweeted status. Requires the ID of the retweet to unretweet.

Parameters

id – The numerical ID of the status.
trim_user – A boolean indicating if user IDs should be provided, instead of complete user objects. Defaults to False.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-unretweet-id

References

API.update_status(status, *, in_reply_to_status_id, auto_populate_reply_metadata, exclude_reply_user_ids, attachment_url, media_ids, possibly_sensitive, lat, long, place_id, display_coordinates, trim_user, card_uri)¶

Updates the authenticating user’s current status, also known as Tweeting.

For each update attempt, the update text is compared with the authenticating user’s recent Tweets. Any attempt that would result in duplication will be blocked, resulting in a 403 error. A user cannot submit the same status twice in a row.

While not rate limited by the API, a user is limited in the number of Tweets they can create at a time. If the number of updates posted by the user reaches the current allowed limit this method will return an HTTP 403 error.

Parameters

status – The text of your status update.
in_reply_to_status_id – The ID of an existing status that the update is in reply to. Note: This parameter will be ignored unless the author of the Tweet this parameter references is mentioned within the status text. Therefore, you must include @username, where username is the author of the referenced Tweet, within the update.
auto_populate_reply_metadata – If set to true and used with in_reply_to_status_id, leading @mentions will be looked up from the original Tweet, and added to the new Tweet from there. This wil append @mentions into the metadata of an extended Tweet as a reply chain grows, until the limit on @mentions is reached. In cases where the original Tweet has been deleted, the reply will fail.
exclude_reply_user_ids – When used with auto_populate_reply_metadata, a comma-separated list of user ids which will be removed from the server-generated @mentions prefix on an extended Tweet. Note that the leading @mention cannot be removed as it would break the in-reply-to-status-id semantics. Attempting to remove it will be silently ignored.
attachment_url – In order for a URL to not be counted in the status body of an extended Tweet, provide a URL as a Tweet attachment. This URL must be a Tweet permalink, or Direct Message deep link. Arbitrary, non-Twitter URLs must remain in the status text. URLs passed to the attachment_url parameter not matching either a Tweet permalink or Direct Message deep link will fail at Tweet creation and cause an exception.
media_ids – A list of media_ids to associate with the Tweet. You may include up to 4 photos or 1 animated GIF or 1 video in a Tweet.
possibly_sensitive – If you upload Tweet media that might be considered sensitive content such as nudity, or medical procedures, you must set this value to true.
lat – The latitude of the location this Tweet refers to. This parameter will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there is no corresponding long parameter.
long – The longitude of the location this Tweet refers to. The valid ranges for longitude are -180.0 to +180.0 (East is positive) inclusive. This parameter will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there no corresponding lat parameter.
place_id – A place in the world.
display_coordinates – Whether or not to put a pin on the exact coordinates a Tweet has been sent from.
trim_user – A boolean indicating if user IDs should be provided, instead of complete user objects. Defaults to False.
card_uri – Associate an ads card with the Tweet using the card_uri value from any ads card response.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-update

References

API.update_status_with_media(status, filename, *, file, possibly_sensitive, in_reply_to_status_id, lat, long, place_id, display_coordinates)¶

Deprecated since version 3.7.0: Use API.media_upload() instead.

Update the authenticated user’s status. Statuses that are duplicates or too long will be silently ignored.

Parameters

status – The text of your status update.
filename – The filename of the image to upload. This will automatically be opened unless file is specified.
file – A file object, which will be used instead of opening filename. filename is still required, for MIME type detection and to use as a form field in the POST data.
possibly_sensitive – Set to true for content which may not be suitable for every audience.
in_reply_to_status_id – The ID of an existing status that the update is in reply to.
lat – The location’s latitude that this tweet refers to.
long – The location’s longitude that this tweet refers to.
place_id – Twitter ID of location which is listed in the Tweet if geolocation is enabled for the user.
display_coordinates – Whether or not to put a pin on the exact coordinates a Tweet has been sent from.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-update_with_media

References

Search Tweets¶

API.search_tweets(q, *, geocode, lang, locale, result_type, count, until, since_id, max_id, include_entities)¶

Returns a collection of relevant Tweets matching a specified query.

Please note that Twitter’s search service and, by extension, the Search API is not meant to be an exhaustive source of Tweets. Not all Tweets will be indexed or made available via the search interface.

Note

In API v1.1, the response format of the Search API has been improved to return Tweet objects more similar to the objects you’ll find across the REST API and platform. However, perspectival attributes (fields that pertain to the perspective of the authenticating user) are not currently supported on this endpoint. 1 2

Parameters

q – The search query string of 500 characters maximum, including operators. Queries may additionally be limited by complexity.
geocode – Returns tweets by users located within a given radius of the given latitude/longitude. The location is preferentially taking from the Geotagging API, but will fall back to their Twitter profile. The parameter value is specified by “latitude,longitude,radius”, where radius units must be specified as either “mi” (miles) or “km” (kilometers). Note that you cannot use the near operator via the API to geocode arbitrary locations; however you can use this geocode parameter to search near geocodes directly. A maximum of 1,000 distinct “sub-regions” will be considered when using the radius modifier.
lang – Restricts tweets to the given language, given by an ISO 639-1 code. Language detection is best-effort.
locale – Specify the language of the query you are sending (only ja is currently effective). This is intended for language-specific consumers and the default should work in the majority of cases.
result_type –
Specifies what type of search results you would prefer to receive. The current default is “mixed.” Valid values include:
- mixed : include both popular and real time results in the response
- recent : return only the most recent results in the response
- popular : return only the most popular results in the response
count – The number of results to try and retrieve per page.
until – Returns tweets created before the given date. Date should be formatted as YYYY-MM-DD. Keep in mind that the search index has a 7-day limit. In other words, no tweets will be found for a date older than one week.
since_id – Returns only statuses with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets which 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.
max_id – Returns only statuses with an ID less than (that is, older than) or equal to the specified ID.
include_entities – The entities node will not be included when set to false. Defaults to true.

Returns

Return type

SearchResults

References

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

Accounts and users¶

Create and manage lists¶

API.get_lists(*, user_id, screen_name, reverse)¶

Returns all lists the authenticating or specified user subscribes to, including their own. The user is specified using the user_id or screen_name parameters. If no user is given, the authenticating user is used.

A maximum of 100 results will be returned by this call. Subscribed lists are returned first, followed by owned lists. This means that if a user subscribes to 90 lists and owns 20 lists, this method returns 90 subscriptions and 10 owned lists. The reverse method returns owned lists first, so with reverse=true, 20 owned lists and 80 subscriptions would be returned.

Parameters

user_id – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.
screen_name – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
reverse – A boolean indicating if you would like owned lists to be returned first. See description above for information on how this parameter works.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-list

References

API.get_list_members(*, list_id, slug, owner_screen_name, owner_id, count, cursor, include_entities, skip_status)¶

Returns the members of the specified list.

Parameters

list_id – The numerical id of the list.
slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.
owner_screen_name – The screen name of the user who owns the list being requested by a slug.
owner_id – The user ID of the user who owns the list being requested by a slug.
count – The number of results to try and retrieve per page.
cursor – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.
include_entities – The entities node will not be included when set to false. Defaults to true.
skip_status – A boolean indicating whether statuses will not be included in the returned user objects. Defaults to false.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-members

References

API.get_list_member(*, list_id, slug, user_id, screen_name, owner_screen_name, owner_id, include_entities, skip_status)¶

Check if the specified user is a member of the specified list.

Parameters

list_id – The numerical id of the list.
slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.
user_id – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.
screen_name – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
owner_screen_name – The screen name of the user who owns the list being requested by a slug.
owner_id – The user ID of the user who owns the list being requested by a slug.
include_entities – The entities node will not be included when set to false. Defaults to true.
skip_status – A boolean indicating whether statuses will not be included in the returned user objects. Defaults to false.

Raises

NotFound – The user is not a member of the list.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-members-show

References

API.get_list_memberships(*, user_id, screen_name, count, cursor, filter_to_owned_lists)¶

Returns the lists the specified user has been added to. If user_id or screen_name are not provided, the memberships for the authenticating user are returned.

Parameters

user_id – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.
screen_name – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
count – The number of results to try and retrieve per page.
cursor – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.
filter_to_owned_lists – A boolean indicating whether to return just lists the authenticating user owns, and the user represented by user_id or screen_name is a member of.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-memberships

References

API.get_list_ownerships(*, user_id, screen_name, count, cursor)¶

Returns the lists owned by the specified user. Private lists will only be shown if the authenticated user is also the owner of the lists. If user_id and screen_name are not provided, the ownerships for the authenticating user are returned.

Parameters

user_id – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.
screen_name – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
count – The number of results to try and retrieve per page.
cursor – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships

References

API.get_list(*, list_id, slug, owner_screen_name, owner_id)¶

Returns the specified list. Private lists will only be shown if the authenticated user owns the specified list.

Parameters

list_id – The numerical id of the list.
slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.
owner_screen_name – The screen name of the user who owns the list being requested by a slug.
owner_id – The user ID of the user who owns the list being requested by a slug.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-show

References

API.list_timeline(*, list_id, slug, owner_screen_name, owner_id, since_id, max_id, count, include_entities, include_rts)¶

Returns a timeline of Tweets authored by members of the specified list. Retweets are included by default. Use the include_rts=false parameter to omit retweets.

Parameters

list_id – The numerical id of the list.
slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.
owner_screen_name – The screen name of the user who owns the list being requested by a slug.
owner_id – The user ID of the user who owns the list being requested by a slug.
since_id – Returns only statuses with an ID greater than (that is, more recent than) the specified ID.
max_id – Returns only statuses with an ID less than (that is, older than) or equal to the specified ID.
count – The number of results to try and retrieve per page.
include_entities – The entities node will not be included when set to false. Defaults to true.
include_rts – A boolean indicating whether the list timeline will contain native retweets (if they exist) in addition to the standard stream of Tweets. The output format of retweeted Tweets is identical to the representation you see in home_timeline.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-statuses

References

API.get_list_subscribers(*, list_id, slug, owner_screen_name, owner_id, count, cursor, include_entities, skip_status)¶

Returns the subscribers of the specified list. Private list subscribers will only be shown if the authenticated user owns the specified list.

Parameters

list_id – The numerical id of the list.
slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.
owner_screen_name – The screen name of the user who owns the list being requested by a slug.
owner_id – The user ID of the user who owns the list being requested by a slug.
count – The number of results to try and retrieve per page.
cursor – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.
include_entities – The entities node will not be included when set to false. Defaults to true.
skip_status – A boolean indicating whether statuses will not be included in the returned user objects. Defaults to false.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-subscribers

References

API.get_list_subscriber(*, owner_screen_name, owner_id, list_id, slug, user_id, screen_name, include_entities, skip_status)¶

Check if the specified user is a subscriber of the specified list.

Parameters

owner_screen_name – The screen name of the user who owns the list being requested by a slug.
owner_id – The user ID of the user who owns the list being requested by a slug.
list_id – The numerical id of the list.
slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.
user_id – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.
screen_name – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
include_entities – The entities node will not be included when set to false. Defaults to true.
skip_status – A boolean indicating whether statuses will not be included in the returned user objects. Defaults to false.

Raises

NotFound – The user is not a subscriber of the list.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-subscribers-show

References

API.get_list_subscriptions(*, user_id, screen_name, count, cursor)¶

Obtain a collection of the lists the specified user is subscribed to, 20 lists per page by default. Does not include the user’s own lists.

Parameters

user_id – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.
screen_name – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
count – The number of results to try and retrieve per page.
cursor – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-subscriptions

References

API.create_list(name, *, mode, description)¶

Creates a new list for the authenticated user. Note that you can create up to 1000 lists per account.

Parameters

name – The name of the new list.
mode – Whether your list is public or private. Values can be public or private. Lists are public by default if no mode is specified.
description – The description of the list you are creating.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-create

References

API.destroy_list(*, owner_screen_name, owner_id, list_id, slug)¶

Deletes the specified list. The authenticated user must own the list to be able to destroy it.

Parameters

owner_screen_name – The screen name of the user who owns the list being requested by a slug.
owner_id – The user ID of the user who owns the list being requested by a slug.
list_id – The numerical id of the list.
slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-destroy

References

API.add_list_member(*, list_id, slug, user_id, screen_name, owner_screen_name, owner_id)¶

Add a member to a list. The authenticated user must own the list to be able to add members to it. Lists are limited to 5,000 members.

Parameters

list_id – The numerical id of the list.
slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.
user_id – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.
screen_name – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
owner_screen_name – The screen name of the user who owns the list being requested by a slug.
owner_id – The user ID of the user who owns the list being requested by a slug.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create

References

API.add_list_members(*, list_id, slug, user_id, screen_name, owner_screen_name, owner_id)¶

Add up to 100 members to a list. The authenticated user must own the list to be able to add members to it. Lists are limited to 5,000 members.

Parameters

list_id – The numerical id of the list.
slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.
user_id – A comma separated list of user IDs, up to 100 are allowed in a single request
screen_name – A comma separated list of screen names, up to 100 are allowed in a single request
owner_screen_name – The screen name of the user who owns the list being requested by a slug.
owner_id – The user ID of the user who owns the list being requested by a slug.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create_all

References

API.remove_list_member(*, list_id, slug, user_id, screen_name, owner_screen_name, owner_id)¶

Removes the specified member from the list. The authenticated user must be the list’s owner to remove members from the list.

Parameters

list_id – The numerical id of the list.
slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.
user_id – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.
screen_name – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
owner_screen_name – The screen name of the user who owns the list being requested by a slug.
owner_id – The user ID of the user who owns the list being requested by a slug.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy

References

API.remove_list_members(*, list_id, slug, user_id, screen_name, owner_screen_name, owner_id)¶

Remove up to 100 members from a list. The authenticated user must own the list to be able to remove members from it. Lists are limited to 5,000 members.

Parameters

list_id – The numerical id of the list.
slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.
user_id – A comma separated list of user IDs, up to 100 are allowed in a single request
screen_name – A comma separated list of screen names, up to 100 are allowed in a single request
owner_screen_name – The screen name of the user who owns the list being requested by a slug.
owner_id – The user ID of the user who owns the list being requested by a slug.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy_all

References

API.subscribe_list(*, owner_screen_name, owner_id, list_id, slug)¶

Subscribes the authenticated user to the specified list.

Parameters

owner_screen_name – The screen name of the user who owns the list being requested by a slug.
owner_id – The user ID of the user who owns the list being requested by a slug.
list_id – The numerical id of the list.
slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-subscribers-create

References

API.unsubscribe_list(*, list_id, slug, owner_screen_name, owner_id)¶

Unsubscribes the authenticated user from the specified list.

Parameters

list_id – The numerical id of the list.
slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.
owner_screen_name – The screen name of the user who owns the list being requested by a slug.
owner_id – The user ID of the user who owns the list being requested by a slug.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-subscribers-destroy

References

API.update_list(*, list_id, slug, name, mode, description, owner_screen_name, owner_id)¶

Updates the specified list. The authenticated user must own the list to be able to update it.

Parameters

list_id – The numerical id of the list.
slug – You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you’ll also have to specify the list owner using the owner_id or owner_screen_name parameters.
name – The name for the list.
mode – Whether your list is public or private. Values can be public or private. Lists are public by default if no mode is specified.
description – The description to give the list.
owner_screen_name – The screen name of the user who owns the list being requested by a slug.
owner_id – The user ID of the user who owns the list being requested by a slug.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-update

References

Follow, search, and get users¶

API.get_follower_ids(*, user_id, screen_name, cursor, stringify_ids, count)¶

Returns an array containing the IDs of users following the specified user.

Parameters

user_id – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.
screen_name – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
cursor – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.
stringify_ids – Have IDs returned as strings instead
count – The number of results to try and retrieve per page.

Returns

Return type

List[int]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-followers-ids

API.get_followers(*, user_id, screen_name, cursor, count, skip_status, include_user_entities)¶

Returns a user’s followers ordered in which they were added. If no user is specified by id/screen name, it defaults to the authenticated user.

Parameters

user_id – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.
screen_name – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
cursor – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.
count – The number of results to try and retrieve per page.
skip_status – A boolean indicating whether statuses will not be included in the returned user objects. Defaults to false.
include_user_entities – The user object entities node will not be included when set to false. Defaults to true.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-followers-list

References

API.get_friend_ids(*, user_id, screen_name, cursor, stringify_ids, count)¶

Returns an array containing the IDs of users being followed by the specified user.

Parameters

user_id – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.
screen_name – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
cursor – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.
stringify_ids – Have IDs returned as strings instead
count – The number of results to try and retrieve per page.

Returns

Return type

List[int]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids

API.get_friends(*, user_id, screen_name, cursor, count, skip_status, include_user_entities)¶

Returns a user’s friends ordered in which they were added 100 at a time. If no user is specified it defaults to the authenticated user.

Parameters

user_id – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.
screen_name – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
cursor – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.
count – The number of results to try and retrieve per page.
skip_status – A boolean indicating whether statuses will not be included in the returned user objects. Defaults to false.
include_user_entities – The user object entities node will not be included when set to false. Defaults to true.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friends-list

References

API.incoming_friendships(*, cursor, stringify_ids)¶

Returns a collection of numeric IDs for every user who has a pending request to follow the authenticating user.

Parameters

cursor – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.
stringify_ids – Have IDs returned as strings instead

Returns

Return type

List[int]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming

API.lookup_friendships(*, screen_name, user_id)¶

Returns the relationships of the authenticated user to the list of up to 100 screen_name or user_id provided.

Parameters

screen_name – A list of screen names, up to 100 are allowed in a single request.
user_id – A list of user IDs, up to 100 are allowed in a single request.

Returns

Return type

List[Relationship]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-lookup

API.no_retweets_friendships(*, stringify_ids)¶

Returns a collection of user_ids that the currently authenticated user does not want to receive retweets from.

Parameters: stringify_ids – Have IDs returned as strings instead
Returns
Return type: List[int]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-no_retweets-ids

API.outgoing_friendships(*, cursor, stringify_ids)¶

Returns a collection of numeric IDs for every protected user for whom the authenticating user has a pending follow request.

Parameters

cursor – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.
stringify_ids – Have IDs returned as strings instead

Returns

Return type

List[int]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-outgoing

API.get_friendship(*, source_id, source_screen_name, target_id, target_screen_name)¶

Returns detailed information about the relationship between two users.

Parameters

source_id – The user_id of the subject user.
source_screen_name – The screen_name of the subject user.
target_id – The user_id of the target user.
target_screen_name – The screen_name of the target user.

Returns

Return type

Friendship

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-show

API.lookup_users(*, screen_name, user_id, include_entities, tweet_mode)¶

Returns fully-hydrated user objects for up to 100 users per request.

There are a few things to note when using this method.

You must be following a protected user to be able to see their most recent status update. If you don’t follow a protected user their status will be removed.
The order of user IDs or screen names may not match the order of users in the returned array.
If a requested user is unknown, suspended, or deleted, then that user will not be returned in the results list.
If none of your lookup criteria can be satisfied by returning a user object, a HTTP 404 will be thrown.

Parameters

screen_name – A list of screen names, up to 100 are allowed in a single request.
user_id – A list of user IDs, up to 100 are allowed in a single request.
include_entities – The entities node will not be included when set to false. Defaults to true.
tweet_mode – Valid request values are compat and extended, which give compatibility mode and extended mode, respectively for Tweets that contain over 140 characters.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup

References

API.search_users(q, *, page, count, include_entities)¶

Run a search for users similar to Find People button on Twitter.com; the same results returned by people search on Twitter.com will be returned by using this API (about being listed in the People Search). It is only possible to retrieve the first 1000 matches from this API.

Parameters

q – The query to run against people search.
page – Specifies the page of results to retrieve. Note: there are pagination limits.
count – The number of results to try and retrieve per page.
include_entities – The entities node will not be included when set to false. Defaults to true.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-users-search

References

API.get_user(*, user_id, screen_name, include_entities)¶

Returns information about the specified user.

Parameters

user_id – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.
screen_name – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
include_entities – The entities node will not be included when set to false. Defaults to true.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-users-show

References

API.create_friendship(*, screen_name, user_id, follow)¶

Create a new friendship with the specified user (aka follow).

Parameters

screen_name – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
user_id – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.
follow – Enable notifications for the target user in addition to becoming friends.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/post-friendships-create

References

API.destroy_friendship(*, screen_name, user_id)¶

Destroy a friendship with the specified user (aka unfollow).

Parameters

screen_name – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
user_id – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/post-friendships-destroy

References

API.update_friendship(*, screen_name, user_id, device, retweets)¶

Turn on/off Retweets and device notifications from the specified user.

Parameters

screen_name – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
user_id – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.
device – Turn on/off device notifications from the target user.
retweets – Turn on/off Retweets from the target user.

Returns

Return type

Friendship

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/post-friendships-update

Manage account settings and profile¶

API.get_settings()¶

Returns settings (including current trend, geo and sleep time information) for the authenticating user.

Returns: JSON
Return type: dict

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-account-settings

API.verify_credentials(*, include_entities, skip_status, include_email)¶

Verify the supplied user credentials are valid.

Parameters

include_entities – The entities node will not be included when set to false. Defaults to true.
skip_status – A boolean indicating whether statuses will not be included in the returned user objects. Defaults to false.
include_email – When set to true email will be returned in the user objects as a string.

Raises

Unauthorized – Authentication unsuccessful

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-account-verify_credentials

References

API.get_saved_searches()¶

Returns the authenticated user’s saved search queries.

Returns
Return type: List[SavedSearch]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-list

API.get_saved_search(id)¶

Retrieve the data for a saved search owned by the authenticating user specified by the given ID.

Parameters: id – The ID of the saved search to be retrieved.
Returns
Return type: SavedSearch

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-show-id

API.get_profile_banner(*, user_id, screen_name)¶

Returns a map of the available size variations of the specified user’s profile banner. If the user has not uploaded a profile banner, a HTTP 404 will be served instead.

The profile banner data available at each size variant’s URL is in PNG format.

Parameters

user_id – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.
screen_name – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.

Returns

JSON

Return type

dict

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-users-profile_banner

API.remove_profile_banner()¶

Removes the uploaded profile banner for the authenticating user.

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-account-remove_profile_banner

API.set_settings(*, sleep_time_enabled, start_sleep_time, end_sleep_time, time_zone, trend_location_woeid, lang)¶

Updates the authenticating user’s settings.

Parameters

sleep_time_enabled – When set to true, t or 1 , will enable sleep time for the user. Sleep time is the time when push or SMS notifications should not be sent to the user.
start_sleep_time – The hour that sleep time should begin if it is enabled. The value for this parameter should be provided in ISO 8601 format (i.e. 00-23). The time is considered to be in the same timezone as the user’s time_zone setting.
end_sleep_time – The hour that sleep time should end if it is enabled. The value for this parameter should be provided in ISO 8601 format (i.e. 00-23). The time is considered to be in the same timezone as the user’s time_zone setting.
time_zone – The timezone dates and times should be displayed in for the user. The timezone must be one of the Rails TimeZone names.
trend_location_woeid – The Yahoo! Where On Earth ID to use as the user’s default trend location. Global information is available by using 1 as the WOEID.
lang – The language which Twitter should render in for this user. The language must be specified by the appropriate two letter ISO 639-1 representation.

Returns

JSON

Return type

dict

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-account-settings

API.update_profile(*, name, url, location, description, profile_link_color, include_entities, skip_status)¶

Sets values that users are able to set under the “Account” tab of their settings page.

Parameters

name – Full name associated with the profile.
url – URL associated with the profile. Will be prepended with http:// if not present
location – The city or country describing where the user of the account is located. The contents are not normalized or geocoded in any way.
description – A description of the user owning the account.
profile_link_color – Sets a hex value that controls the color scheme of links used on the authenticating user’s profile page on twitter.com. This must be a valid hexadecimal value, and may be either three or six characters (ex: F00 or FF0000).
include_entities – The entities node will not be included when set to false. Defaults to true.
skip_status – A boolean indicating whether statuses will not be included in the returned user objects. Defaults to false.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile

References

API.update_profile_banner(filename, *, file, width, height, offset_left, offset_top)¶

Uploads a profile banner on behalf of the authenticating user.

Parameters

filename – The filename of the image to upload. This will automatically be opened unless file is specified.
file – A file object, which will be used instead of opening filename. filename is still required, for MIME type detection and to use as a form field in the POST data.
width – The width of the preferred section of the image being uploaded in pixels. Use with height, offset_left, and offset_top to select the desired region of the image to use.
height – The height of the preferred section of the image being uploaded in pixels. Use with width, offset_left, and offset_top to select the desired region of the image to use.
offset_left – The number of pixels by which to offset the uploaded image from the left. Use with height, width, and offset_top to select the desired region of the image to use.
offset_top – The number of pixels by which to offset the uploaded image from the top. Use with height, width, and offset_left to select the desired region of the image to use.

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_banner

API.update_profile_image(filename, *, file, include_entities, skip_status)¶

Update the authenticating user’s profile image. Valid formats: GIF, JPG, or PNG

Parameters

filename – The filename of the image to upload. This will automatically be opened unless file is specified.
file – A file object, which will be used instead of opening filename. filename is still required, for MIME type detection and to use as a form field in the POST data.
include_entities – The entities node will not be included when set to false. Defaults to true.
skip_status – A boolean indicating whether statuses will not be included in the returned user objects. Defaults to false.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_image

References

API.create_saved_search(query)¶

Creates a saved search for the authenticated user.

Parameters: query – The query of the search the user would like to save.
Returns
Return type: SavedSearch

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-saved_searches-create

API.destroy_saved_search(id)¶

Destroys a saved search for the authenticated user. The search specified by ID must be owned by the authenticating user.

Parameters: id – The ID of the saved search to be deleted.
Returns
Return type: SavedSearch

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-saved_searches-destroy-id

Mute, block, and report users¶

API.get_blocked_ids(*, stringify_ids, cursor)¶

Returns an array of numeric user IDs the authenticating user is blocking.

Parameters

stringify_ids – Have IDs returned as strings instead
cursor – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.

Returns

Return type

List[int]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/get-blocks-ids

API.get_blocks(*, include_entities, skip_status, cursor)¶

Returns an array of user objects that the authenticating user is blocking.

Parameters

include_entities – The entities node will not be included when set to false. Defaults to true.
skip_status – A boolean indicating whether statuses will not be included in the returned user objects. Defaults to false.
cursor – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/get-blocks-list

References

API.get_muted_ids(*, stringify_ids, cursor)¶

Returns an array of numeric user IDs the authenticating user has muted.

Parameters

stringify_ids – Have IDs returned as strings instead
cursor – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.

Returns

Return type

List[int]

References

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/get-mutes-users-ids

API.get_mutes(*, cursor, include_entities, skip_status)¶

Returns an array of user objects the authenticating user has muted.

Parameters

cursor – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.
include_entities – The entities node will not be included when set to false. Defaults to true.
skip_status – A boolean indicating whether statuses will not be included in the returned user objects. Defaults to false.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/get-mutes-users-list

References

API.create_block(*, screen_name, user_id, include_entities, skip_status)¶

Blocks the specified user from following the authenticating user. In addition the blocked user will not show in the authenticating users mentions or timeline (unless retweeted by another user). If a follow or friend relationship exists it is destroyed.

Parameters

screen_name – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
user_id – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.
include_entities – The entities node will not be included when set to false. Defaults to true.
skip_status – A boolean indicating whether statuses will not be included in the returned user objects. Defaults to false.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/post-blocks-create

References

API.destroy_block(*, screen_name, user_id, include_entities, skip_status)¶

Un-blocks the user specified in the ID parameter for the authenticating user.

Parameters

screen_name – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
user_id – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.
include_entities – The entities node will not be included when set to false. Defaults to true.
skip_status – A boolean indicating whether statuses will not be included in the returned user objects. Defaults to false.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/post-blocks-destroy

References

API.create_mute(*, screen_name, user_id)¶

Mutes the user specified in the ID parameter for the authenticating user.

Parameters

screen_name – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
user_id – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/post-mutes-users-create

References

API.destroy_mute(*, screen_name, user_id)¶

Un-mutes the user specified in the ID parameter for the authenticating user.

Parameters

screen_name – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
user_id – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/post-mutes-users-destroy

References

API.report_spam(*, screen_name, user_id, perform_block)¶

Report the specified user as a spam account to Twitter.

Parameters

screen_name – Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
user_id – Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.
perform_block – A boolean indicating if the reported account should be blocked. Defaults to True.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/post-users-report_spam

References

Direct Messages¶

Sending and receiving events¶

API.delete_direct_message(id)¶

Deletes the direct message specified in the required ID parameter. The authenticating user must be the recipient of the specified direct message. Direct Messages are only removed from the interface of the user context provided. Other members of the conversation can still access the Direct Messages.

Parameters: id – The ID of the Direct Message that should be deleted.

References

https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/sending-and-receiving/api-reference/delete-message-event

API.get_direct_messages(*, count, cursor)¶

Returns all Direct Message events (both sent and received) within the last 30 days. Sorted in reverse-chronological order.

Parameters

count – The number of results to try and retrieve per page.
cursor – Breaks the results into pages. Provide a value of -1 to begin paging. Provide values as returned to in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.

Returns

Return type

List[DirectMessage]

References

https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/sending-and-receiving/api-reference/list-events

API.get_direct_message(id)¶

Returns a specific direct message.

Parameters: id – The ID of the Direct Message event that should be returned.
Returns
Return type: DirectMessage

References

https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/sending-and-receiving/api-reference/get-event

API.send_direct_message(recipient_id, text, *, quick_reply_options, attachment_type, attachment_media_id, ctas)¶

Sends a new direct message to the specified user from the authenticating user.

Parameters

recipient_id – The ID of the user who should receive the direct message.
text – The text of your Direct Message. Max length of 10,000 characters.
quick_reply_options – Array of Options objects (20 max).
attachment_type – The attachment type. Can be media or location.
attachment_media_id – A media id to associate with the message. A Direct Message may only reference a single media_id.
ctas – Array of 1-3 call-to-action (CTA) button objects

Returns

Return type

DirectMessage

References

https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/sending-and-receiving/api-reference/new-event

Media¶

Upload media¶

API.get_media_upload_status(media_id)¶

Check on the progress of a chunked media upload. If the upload has succeeded, it’s safe to create a Tweet with this media_id.

Parameters: media_id – The ID of the media to check.
Returns
Return type: Media

References

https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/get-media-upload-status

API.create_media_metadata(media_id, alt_text)¶

This endpoint can be used to provide additional information about the uploaded media_id. This feature is currently only supported for images and GIFs. Call this endpoint to attach additional metadata such as image alt text.

Parameters

media_id – The ID of the media to add alt text to.
alt_text – The alt text to add to the image.

References

https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-metadata-create

API.media_upload(filename, *, file, chunked, media_category, additional_owners)¶

Use this to upload media to Twitter. This calls either API.simple_upload() or API.chunked_upload(). Chunked media upload is automatically used for videos. If chunked is set or the media is a video, wait_for_async_finalize can be specified as a keyword argument to be passed to API.chunked_upload().

Parameters

filename – The filename of the image to upload. This will automatically be opened unless file is specified.
file – A file object, which will be used instead of opening filename. filename is still required, for MIME type detection and to use as a form field in the POST data.
chunked – Whether or not to use chunked media upload. Videos use chunked upload regardless of this parameter. Defaults to False.
media_category – The category that represents how the media will be used. This field is required when using the media with the Ads API.
additional_owners – A list of user IDs to set as additional owners allowed to use the returned media_id in Tweet or Cards. Up to 100 additional owners may be specified.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/overview

References

API.simple_upload(filename, *, file, media_category, additional_owners)¶

Use this endpoint to upload media to Twitter. This does not use the chunked upload endpoints.

Parameters

filename – The filename of the image to upload. This will automatically be opened unless file is specified.
file – A file object, which will be used instead of opening filename. filename is still required, for MIME type detection and to use as a form field in the POST data.
media_category – The category that represents how the media will be used. This field is required when using the media with the Ads API.
additional_owners – A list of user IDs to set as additional owners allowed to use the returned media_id in Tweet or Cards. Up to 100 additional owners may be specified.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload

References

API.chunked_upload(filename, *, file, file_type, wait_for_async_finalize, media_category, additional_owners)¶

Use this to upload media to Twitter. This uses the chunked upload endpoints and calls API.chunked_upload_init(), API.chunked_upload_append(), and API.chunked_upload_finalize(). If wait_for_async_finalize is set, this calls API.get_media_upload_status() as well.

Parameters

filename – The filename of the image to upload. This will automatically be opened unless file is specified.
file – A file object, which will be used instead of opening filename. filename is still required, for MIME type detection and to use as a form field in the POST data.
file_type – The MIME type of the media being uploaded.
wait_for_async_finalize – Whether to wait for Twitter’s API to finish processing the media. Defaults to True.
media_category – The category that represents how the media will be used. This field is required when using the media with the Ads API.
additional_owners – A list of user IDs to set as additional owners allowed to use the returned media_id in Tweet or Cards. Up to 100 additional owners may be specified.

Returns

Return type

https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/uploading-media/chunked-media-upload

References

API.chunked_upload_append(media_id, media, segment_index)¶

Use this endpoint to upload a chunk (consecutive byte range) of the media file.

Parameters

media_id – The media_id returned from the initialization.
media – The raw binary file content being uploaded. It must be <= 5 MB.
segment_index – An ordered index of file chunk. It must be between 0-999 inclusive. The first segment has index 0, second segment has index 1, and so on.

References

https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload-append

API.chunked_upload_finalize(media_id)¶

Use this endpoint after the entire media file is uploaded via appending. If (and only if) the response contains a processing_info field, it may also be necessary to check its status and wait for it to return success before proceeding to Tweet creation.

Parameters: media_id – The media_id returned from the initialization.
Returns
Return type: Media

References

https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload-finalize

API.chunked_upload_init(total_bytes, media_type, *, media_category, additional_owners)¶

Use this endpoint to initiate a chunked file upload session.

Parameters

total_bytes – The size of the media being uploaded in bytes.
media_type – The MIME type of the media being uploaded.
media_category – The category that represents how the media will be used. This field is required when using the media with the Ads API.
additional_owners – A list of user IDs to set as additional owners allowed to use the returned media_id in Tweet or Cards. Up to 100 additional owners may be specified.

Returns

Return type