API Reference

This page contains some basic documentation for the Tweepy module.

tweepy.api — Twitter API wrapper

class API([auth_handler=None][, host='api.twitter.com'][, search_host='search.twitter.com'][, cache=None][, api_root='/1'][, search_root=''][, retry_count=0][, retry_delay=0][, retry_errors=None][, timeout=60][, parser=ModelParser][, compression=False][, wait_on_rate_limit=False][, wait_on_rate_limit_notify=False][, proxy=None])

This class provides a wrapper for the API as provided by Twitter. The functions provided in this class are listed below.

Parameters

  • auth_handler – authentication handler to be used

  • host – general API host

  • search_host – search API host

  • cache – cache backend to use

  • api_root – general API path root

  • search_root – search API path root

  • retry_count – default number of retries to attempt when error occurs

  • retry_delay – number of seconds to wait between retries

  • retry_errors – which HTTP status codes to retry

  • timeout – The maximum amount of time to wait for a response from Twitter

  • parser – The object to use for parsing the response from Twitter

  • compression – Whether or not to use GZIP compression for requests

  • wait_on_rate_limit – Whether or not to automatically wait for rate limits to replenish

  • wait_on_rate_limit_notify – Whether or not to print a notification when Tweepy is waiting for rate limits to replenish

  • proxy – The full url to an HTTPS proxy to use for connecting to Twitter.

Timeline methods

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.

Return type

list of Status objects

API.statuses_lookup(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.

Return type

list of Status objects

API.user_timeline([id/user_id/screen_name][, since_id][, max_id][, count][, page])

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

  • id – Specifies the ID or screen name of the user.

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

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

  • page – Specifies the page of results to retrieve. Note: there are pagination limits.

Return type

list of Status objects

API.retweets_of_me([since_id][, max_id][, count][, page])

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

Parameters

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

  • page – Specifies the page of results to retrieve. Note: there are pagination limits.

Return type

list of Status objects

API.mentions_timeline([since_id][, max_id][, count])

Returns the 20 most recent mentions, including retweets.

Parameters

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

Return type

list of Status objects

Status methods

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.

Return type

Status object

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][, enable_dmcommands][, fail_dmcommands][, 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.

  • enable_dmcommands – When set to true, enables shortcode commands for sending Direct Messages as part of the status text to send a Direct Message to a user. When set to false, disables this behavior and includes any leading characters in the status text that is posted

  • fail_dmcommands – When set to true, causes any status text that starts with shortcode commands to return an API error. When set to false, allows shortcode commands to be sent in the status text and acted on by the API.

  • card_uri – Associate an ads card with the Tweet using the card_uri value from any ads card response.

Return type

Status object

API.update_with_media(filename[, status][, in_reply_to_status_id][, auto_populate_reply_metadata][, lat][, long][, source][, place_id][, file])

Deprecated: Use API.media_upload() instead. Update the authenticated user’s status. Statuses that are duplicates or too long will be silently ignored.

Parameters

  • filename – The filename of the image to upload. This will automatically be opened unless file is specified

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

  • auto_populate_reply_metadata – Whether to automatically include the @mentions in the status metadata.

  • lat – The location’s latitude that this tweet refers to.

  • long – The location’s longitude that this tweet refers to.

  • source – Source of the update. Only supported by Identi.ca. Twitter ignores this parameter.

  • place_id – Twitter ID of location which is listed in the Tweet if geolocation is enabled for the user.

  • 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

Return type

Status object

API.destroy_status(id)

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.

Return type

Status object

API.retweet(id)

Retweets a tweet. Requires the id of the tweet you are retweeting.

Parameters

id – The numerical ID of the status.

Return type

Status object

API.retweeters(id[, 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.

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

Return type

list of Integers

API.retweets(id[, count])

Returns up to 100 of the first retweets of the given tweet.

Parameters

  • id – The numerical ID of the status.

  • count – Specifies the number of retweets to retrieve.

Return type

list of Status objects

API.unretweet(id)

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

Parameters

id – The numerical ID of the status.

Return type

Status object

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.

Return type

JSON object

User methods

API.get_user(id/user_id/screen_name)

Returns information about the specified user.

Parameters

  • id – Specifies the ID or screen name of the user.

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

Return type

User object

API.me()

Returns the authenticated user’s information.

Return type

User object

API.friends([id/user_id/screen_name][, cursor][, 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

  • id – Specifies the ID or screen name of the user.

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

Return type

list of User objects

API.followers([id/screen_name/user_id][, cursor])

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

  • id – Specifies the ID or screen name of the user.

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

Return type

list of User objects

API.lookup_users([user_ids][, screen_names][, 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

  • user_ids – A list of user IDs, up to 100 are allowed in a single request.

  • screen_names – A list of screen names, 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.

Return type

list of User objects

API.search_users(q[, count][, page])

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.

  • count – Specifies the number of statuses to retrieve. May not be greater than 20.

  • page – Specifies the page of results to retrieve. Note: there are pagination limits.

Return type

list of User objects

Direct Message Methods

API.get_direct_message([id][, full_text])

Returns a specific direct message.

Parameters

  • id – The id of the Direct Message event that should be returned.

  • full_text – A boolean indicating whether or not the full text of a message should be returned. If False the message text returned will be truncated to 140 chars. Defaults to False.

Return type

DirectMessage object

API.list_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.

Return type

list of DirectMessage objects

API.send_direct_message(recipient_id, text[, quick_reply_type][, attachment_type][, attachment_media_id])

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_type –

    The Quick Reply type to present to the user:

    • options - Array of Options objects (20 max).

    • text_input - Text Input object.

    • location - Location object.

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

Return type

DirectMessage object

API.destroy_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.

Return type

None

Friendship Methods

API.create_friendship(id/screen_name/user_id[, follow])

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

Parameters

  • id – Specifies the ID or screen name of the user.

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

Return type

User object

API.destroy_friendship(id/screen_name/user_id)

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

Parameters

  • id – Specifies the ID or screen name of the user.

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

Return type

User object

API.show_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.

Return type

Friendship object

API.lookup_friendships(user_ids/screen_names)

Returns the relationships of the authenticated user to the list of up to 100 screen_names or user_ids provided.

Parameters

  • user_ids – A list of user IDs, up to 100 are allowed in a single request.

  • screen_names – A list of screen names, up to 100 are allowed in a single request.

Return type

Relationship object

API.friends_ids(id/screen_name/user_id[, cursor])

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

Parameters

  • id – Specifies the ID or screen name of the user.

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

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

Return type

list of Integers

API.followers_ids(id/screen_name/user_id)

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

Parameters

  • id – Specifies the ID or screen name of the user.

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

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

Return type

list of Integers

Account Methods

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.

Return type

User object if credentials are valid, otherwise False

API.rate_limit_status()

Returns the current rate limits for methods belonging to the specified resource families. When using application-only auth, this method’s response indicates the application-only auth rate limiting context.

Parameters

resources – A comma-separated list of resource families you want to know the current rate limit disposition for.

Return type

JSON object

API.update_profile_image(filename)

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

Parameters

filename – local path to image file to upload. Not a remote URL!

Return type

User object

API.update_profile([name][, url][, location][, description])

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

Parameters

  • name – Maximum of 20 characters

  • url – Maximum of 100 characters. Will be prepended with “http://” if not present

  • location – Maximum of 30 characters

  • description – Maximum of 160 characters

Return type

User object

Favorite Methods

API.favorites([id][, page])

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

Parameters

  • id – The ID or screen name of the user to request favorites

  • page – Specifies the page of results to retrieve. Note: there are pagination limits.

Return type

list of Status objects

API.create_favorite(id)

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

Parameters

id – The numerical ID of the status.

Return type

Status object

API.destroy_favorite(id)

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

Parameters

id – The numerical ID of the status.

Return type

Status object

Block Methods

API.create_block(id/screen_name/user_id)

Blocks the user specified in the ID parameter as the authenticating user. Destroys a friendship to the blocked user if it exists.

Parameters

  • id – Specifies the ID or screen name of the user.

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

Return type

User object

API.destroy_block(id/screen_name/user_id)

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

Parameters

  • id – Specifies the ID or screen name of the user.

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

Return type

User object

API.blocks([page])

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

Parameters

page – Specifies the page of results to retrieve. Note: there are pagination limits.

Return type

list of User objects

API.blocks_ids([cursor])

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

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.

Return type

list of Integers

Mute Methods

API.create_mute(id/screen_name/user_id)

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

Parameters

  • id – Specifies the ID or screen name of the user.

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

Return type

User object

API.destroy_mute(id/screen_name/user_id)

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

Parameters

  • id – Specifies the ID or screen name of the user.

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

Return type

User object

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

Return type

list of User objects

API.mutes_ids([cursor])

Returns an array of numeric user ids 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.

Return type

list of Integers

Spam Reporting Methods

API.report_spam(id/screen_name/user_id[, perform_block])

The user specified in the id is blocked by the authenticated user and reported as a spammer.

Parameters

  • id – Specifies the ID or screen name of the user.

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

Return type

User object

Saved Searches Methods

API.saved_searches()

Returns the authenticated user’s saved search queries.

Return type

list of SavedSearch objects

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.

Return type

SavedSearch object

Creates a saved search for the authenticated user.

Parameters

query – The query of the search the user would like to save.

Return type

SavedSearch object

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.

Return type

SavedSearch object

Search Methods

API.search(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.

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

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 “latitide,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.

Return type

SearchResults object

API.search_30_day(environment_name, query[, tag][, fromDate][, toDate][, maxResults][, next])

Premium search that provides Tweets posted within the last 30 days.

Parameters

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

API.search_full_archive(environment_name, 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

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

List Methods

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.

Return type

List object

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.

Return type

List object

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.

Return type

List object

API.lists_all([screen_name][, user_id][, 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

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

  • reverse – A boolean indicating if you would like owned lists to be returned first. See description above for information on how this parameter works.

Return type

list of List objects

API.lists_memberships([screen_name][, user_id][, filter_to_owned_lists][, cursor][, count])

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

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

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

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

Return type

list of List objects

API.lists_subscriptions([screen_name][, user_id][, cursor][, count])

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

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

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

Return type

list of List objects

API.list_timeline(list_id/slug[, owner_id/owner_screen_name][, 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_id – The user ID of the user who owns the list being requested by a slug.

  • owner_screen_name – The screen name 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.

Return type

list of Status objects

API.get_list(list_id/slug[, owner_id/owner_screen_name])

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_id – The user ID of the user who owns the list being requested by a slug.

  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

Return type

List object

API.add_list_member(list_id/slug, screen_name/user_id[, owner_id/owner_screen_name])

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.

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

  • owner_id – The user ID of the user who owns the list being requested by a slug.

  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

Return type

List object

API.add_list_members(list_id/slug, screen_name/user_id[, owner_id/owner_screen_name])

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.

  • screen_name – A comma separated list of screen names, up to 100 are allowed in a single request

  • user_id – A comma separated list of user IDs, up to 100 are allowed in a single request

  • owner_id – The user ID of the user who owns the list being requested by a slug.

  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

Return type

List object

API.remove_list_member(list_id/slug, screen_name/user_id[, owner_id/owner_screen_name])

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.

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

  • owner_id – The user ID of the user who owns the list being requested by a slug.

  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

Return type

List object

API.remove_list_members(list_id/slug, screen_name/user_id[, owner_id/owner_screen_name])

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.

  • screen_name – A comma separated list of screen names, up to 100 are allowed in a single request

  • user_id – A comma separated list of user IDs, up to 100 are allowed in a single request

  • owner_id – The user ID of the user who owns the list being requested by a slug.

  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

Return type

List object

API.list_members(list_id/slug[, owner_id/owner_screen_name][, cursor])

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_id – The user ID of the user who owns the list being requested by a slug.

  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

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

Return type

list of User objects

API.show_list_member(list_id/slug, screen_name/user_id[, owner_id/owner_screen_name])

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.

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

  • owner_id – The user ID of the user who owns the list being requested by a slug.

  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

Return type

User object if user is a member of list

API.subscribe_list(list_id/slug[, owner_id/owner_screen_name])

Subscribes the authenticated user to 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_id – The user ID of the user who owns the list being requested by a slug.

  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

Return type

List object

API.unsubscribe_list(list_id/slug[, owner_id/owner_screen_name])

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_id – The user ID of the user who owns the list being requested by a slug.

  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

Return type

List object

API.list_subscribers(list_id/slug[, owner_id/owner_screen_name][, cursor][, count][, 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_id – The user ID of the user who owns the list being requested by a slug.

  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

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

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

Return type

list of User objects

API.show_list_subscriber(list_id/slug, screen_name/user_id[, owner_id/owner_screen_name])

Check if the specified user is a subscriber 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.

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

  • owner_id – The user ID of the user who owns the list being requested by a slug.

  • owner_screen_name – The screen name of the user who owns the list being requested by a slug.

Return type

User object if user is subscribed to list

Geo Methods

API.reverse_geocode([lat][, long][, accuracy][, granularity][, max_results])

Given a latitude and longitude, looks for places (cities and neighbourhoods) whose IDs can be specified in a call to update_status() to appear as the name of the location. This call provides a detailed response about the location in question; the nearby_places() function should be preferred for getting a list of places nearby without great detail.

Parameters

  • lat – The location’s latitude.

  • long – The location’s longitude.

  • accuracy – Specify the “region” in which to search, such as a number (then this is a radius in meters, but it can also take a string that is suffixed with ft to specify feet). If this is not passed in, then it is assumed to be 0m

  • granularity – Assumed to be neighborhood by default; can also be city.

  • max_results – A hint as to the maximum number of results to return. This is only a guideline, which may not be adhered to.

API.geo_id(id)

Given id of a place, provide more details about that place.

Parameters

id – Valid Twitter ID of a location.

Utility methods

API.configuration()

Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co shortened URL length. It is recommended applications request this endpoint when they are loaded, but no more than once a day.

Media methods

API.media_upload(filename[, file])

Use this endpoint to upload images to Twitter.

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.

Return type

Media object

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.

tweepy.error — Exceptions

The exceptions are available in the tweepy module directly, which means tweepy.error itself does not need to be imported. For example, tweepy.error.TweepError is available as tweepy.TweepError.

exception TweepError

The main exception Tweepy uses. Is raised for a number of things.

When a TweepError is raised due to an error Twitter responded with, the error code (as described in the API documentation) can be accessed at TweepError.response.text. Note, however, that TweepErrors also may be raised with other things as message (for example plain error reason strings).

exception RateLimitError

Is raised when an API method fails due to hitting Twitter’s rate limit. Makes for easy handling of the rate limit specifically.

Inherits from TweepError, so except TweepError will catch a RateLimitError too.

Footnotes

1

https://web.archive.org/web/20170829051949/https://dev.twitter.com/rest/reference/get/search/tweets

2

https://twittercommunity.com/t/favorited-reports-as-false-even-if-status-is-already-favorited-by-the-user/11145