.. _api_reference:

.. include:: parameters.rst

API Reference
=============

This page contains some basic documentation for the Tweepy module.


:mod:`tweepy.api` --- Twitter API wrapper
=========================================

.. class:: API([auth_handler=None], [host='api.twitter.com'], [search_host='search.twitter.com'], [cache=None], [secure=False], [api_root='/1'], [search_root=''], [retry_count=0], [retry_delay=0], [retry_errors=None], [model_factory])

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

   :param auth_handler: authentication handler to be used
   :param host: general API host
   :param search_host: search API host
   :param cache: cache backend to use
   :param secure: if True use https
   :param api_root: general API path root
   :param search_root: search API path root
   :param retry_count: default number of retries to attempt when error occurs
   :param retry_delay: number of seconds to wait between retries
   :param retry_errors: which HTTP status codes to retry
   :param model_factory: used for creating new model instances

Timeline methods
----------------

.. method:: API.home_timeline([since_id], [max_id], [count], [page])

   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.

   :param since_id: |since_id|
   :param max_id: |max_id|
   :param count: |count|
   :param page: |page|
   :rtype: list of :class:`Status` objects


.. method:: API.friends_timeline([since_id], [max_id], [count], [page])

   Returns the 20 most recent statuses posted by the authenticating user
   and that user's friends.

   
   :param since_id: |since_id|
   :param max_id: |max_id|
   :param count: |count|
   :param page: |page|
   :rtype: list of :class:`Status` objects

   Returns: list of :class:`Status` objects


.. method:: 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.

   :param id: |uid|
   :param user_id: |user_id|
   :param screen_name: |screen_name|
   :param since_id: |since_id|
   :param max_id: |max_id|
   :param count: |count|
   :param page: |page|
   :rtype: list of :class:`Status` objects


.. method:: API.mentions([since_id], [max_id], [count], [page])

   Returns the 20 most recent mentions (status containing @username) for
   the authenticating user.

   :param since_id: |since_id|
   :param max_id: |max_id|
   :param count: |count|
   :param page: |page|
   :rtype: list of :class:`Status` objects


.. method:: API.retweeted_by_me([since_id], [max_id], [count], [page])

   Returns the 20 most recent retweets posted by the authenticating user.

   :param since_id: |since_id|
   :param max_id: |max_id|
   :param count: |count|
   :param page: |page|
   :rtype: list of :class:`Status` objects


.. method:: API.retweeted_to_me([since_id], [max_id], [count], [page])

   Returns the 20 most recent retweets posted by the authenticating
   user's friends.

   :param since_id: |since_id|
   :param max_id: |max_id|
   :param count: |count|
   :param page: |page|
   :rtype: list of :class:`Status` objects


.. method:: 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.

   :param since_id: |since_id|
   :param max_id: |max_id|
   :param count: |count|
   :param page: |page|
   :rtype: list of :class:`Status` objects


Status methods
--------------

.. method:: API.get_status(id)

   Returns a single status specified by the ID parameter.

   :param id: |sid|
   :rtype: :class:`Status` object


.. method:: API.update_status(status, [in_reply_to_status_id], [lat], [long], [source], [place_id])

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

   :param status: The text of your status update.
   :param in_reply_to_status_id: The ID of an existing status that the update is in reply to.
   :param lat: The location's latitude that this tweet refers to.
   :param long: The location's longitude that this tweet refers to.
   :param source: Source of the update. Only supported by Identi.ca. Twitter ignores this parameter.
   :param place_id: Twitter ID of location which is listed in the Tweet if geolocation is enabled for the user.
   :rtype: :class:`Status` object


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

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

   :param filename: The filename of the image to upload. This will automatically be opened unless `file` is specified
   :param status: The text of your status update.
   :param in_reply_to_status_id: The ID of an existing status that the update is in reply to.
   :param lat: The location's latitude that this tweet refers to.
   :param long: The location's longitude that this tweet refers to.
   :param source: Source of the update. Only supported by Identi.ca. Twitter ignores this parameter.
   :param place_id: Twitter ID of location which is listed in the Tweet if geolocation is enabled for the user.
   :param 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
   :rtype: :class:`Status` object


.. method:: API.destroy_status(id)

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

   :param id: |sid|
   :rtype: :class:`Status` object


.. method:: API.retweet(id)

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

   :param id: |sid|
   :rtype: :class:`Status` object


.. method:: API.retweets(id[,count])

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

   :param id: |sid|
   :param count: Specifies the number of retweets to retrieve.
   :rtype: list of :class:`Status` objects


User methods
------------

.. method:: API.get_user(id/user_id/screen_name)

   Returns information about the specified user.

   :param id: |uid|
   :param user_id: |user_id|
   :param screen_name: |screen_name|
   :rtype: :class:`User` object


.. method:: API.me()

   Returns the authenticated user's information.

   :rtype: :class:`User` object


.. method::API.friends([id/user_id/screen_name], [cursor])

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

   :param id: |uid|
   :param user_id: |user_id|
   :param screen_name: |screen_name|
   :param cursor: |cursor|
   :rtype: list of :class:`User` objects


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

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

   :param id: |uid|
   :param user_id: |user_id|
   :param screen_name: |screen_name|
   :param cursor: |cursor|
   :rtype: list of :class:`User` objects

.. method:: API.search_users(q, [per_page], [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.

   :param q: The query to run against people search.
   :param per_page: Specifies the number of statuses to retrieve. May not be greater than 20.
   :param page: |page|
   :rtype: list of :class:`User` objects


Direct Message Methods
----------------------

.. method:: API.direct_messages([since_id], [max_id], [count], [page])

   Returns direct messages sent to the authenticating user.

   :param since_id: |since_id|
   :param max_id: |max_id|
   :param count: |count|
   :param page: |page|
   :rtype: list of :class:`DirectMessage` objects


.. method:: API.sent_direct_messages([since_id], [max_id], [count], [page])

   Returns direct messages sent by the authenticating user.

   :param since_id: |since_id|
   :param max_id: |max_id|
   :param count: |count|
   :param page: |page|
   :rtype: list of :class:`DirectMessage` objects


.. method:: API.send_direct_message(user/screen_name/user_id, text)

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

   :param user: The ID or screen name of the recipient user.
   :param screen_name: screen name of the recipient user
   :param user_id: user id of the recipient user
   :rtype: :class:`DirectMessage` object


.. method:: API.destroy_direct_message(id)

   Destroy a direct message. Authenticating user must be the recipient of
   the direct message.

   :param id: The ID of the direct message to destroy.
   :rtype: :class:`DirectMessage` object


Friendship Methods
------------------

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

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

   :param id: |uid|
   :param screen_name: |screen_name|
   :param user_id: |user_id|
   :param follow: Enable notifications for the target user in addition to becoming friends.
   :rtype: :class:`User` object


.. method:: API.destroy_friendship(id/screen_name/user_id)

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

   :param id: |uid|
   :param screen_name: |screen_name|
   :param user_id: |user_id|
   :rtype: :class:`User` object


.. method:: API.exists_friendship(user_a, user_b)

   Checks if a friendship exists between two users. Will return True if
   user_a follows user_b, otherwise False.

   :param user_a: The ID or screen_name of the subject user.
   :param user_b: The ID or screen_name of the user to test for following.
   :rtype: True/False


.. method:: API.show_friendship(source_id/source_screen_name, target_id/target_screen_name)

   Returns detailed information about the relationship between two users.

   :param source_id: The user_id of the subject user.
   :param source_screen_name: The screen_name of the subject user.
   :param target_id: The user_id of the target user.
   :param target_screen_name: The screen_name of the target user.
   :rtype: :class:`Friendship` object


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

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

   :param id: |uid|
   :param screen_name: |screen_name|
   :param user_id: |user_id|
   :param cursor: |cursor|
   :rtype: list of Integers


.. method:: API.followers_ids(id/screen_name/user_id)

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

   :param id: |uid|
   :param screen_name: |screen_name|
   :param user_id: |user_id|
   :param cursor: |cursor|
   :rtype: list of Integers


Account Methods
---------------

.. method:: API.verify_credentials()

   Verify the supplied user credentials are valid.

   :rtype: :class:`User` object if credentials are valid, otherwise False


.. method:: API.rate_limit_status()

   Returns the remaining number of API requests available to the
   requesting user before the API limit is reached for the current
   hour. Calls to rate_limit_status do not count against the rate
   limit. If authentication credentials are provided, the rate limit
   status for the authenticating user is returned. Otherwise, the rate
   limit status for the requester's IP address is returned.

   :rtype: :class:`JSON` object


.. method:: API.set_delivery_device(device)

   Sets which device Twitter delivers updates to for the authenticating
   user. Sending "none" as the device parameter will disable SMS updates.

   :param device: Must be one of: sms, none
   :rtype: :class:`User` object


.. method:: API.update_profile_colors([profile_background_color], [profile_text_color], [profile_link_color], [profile_sidebar_fill_color], [profile_sidebar_border_color])

   Sets one or more hex values that control the color scheme of the
   authenticating user's profile page on twitter.com.

   :param profile_background_color:
   :param profile_text_color:
   :param profile_link_color:
   :param profile_sidebar_fill_color:
   :param profile_sidebar_border_color:
   :rtype: :class:`User` object


.. method:: API.update_profile_image(filename)

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

   :param filename: local path to image file to upload. Not a remote URL!
   :rtype: :class:`User` object


.. method:: API.update_profile_background_image(filename)

   Update authenticating user's background image. Valid formats: GIF,
   JPG, or PNG

   :param filename: local path to image file to upload. Not a remote URL!
   :rtype: :class:`User` object


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

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

   :param name: Maximum of 20 characters
   :param url: Maximum of 100 characters. Will be prepended with "http://" if not present
   :param location: Maximum of 30 characters
   :param description: Maximum of 160 characters
   :rtype: :class:`User` object


Favorite Methods
----------------

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

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

   :param id: The ID or screen name of the user to request favorites
   :param page: |page|
   :rtype: list of :class:`Status` objects


.. method:: API.create_favorite(id)

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

   :param id: |sid|
   :rtype: :class:`Status` object


.. method:: API.destroy_favorite(id)

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

   :param id: |sid|
   :rtype: :class:`Status` object


Notification Methods
--------------------

.. method:: API.enable_notifications(id/screen_name/user_id)

   Enables device notifications for updates from the specified user.

   :param id: |uid|
   :param screen_name: |screen_name|
   :param user_id: |user_id|
   :rtype: :class:`User` object


.. method:: API.disable_notifications(id/screen_name/user_id)

   Disables notifications for updates from the specified user to the
   authenticating user.

   :param id: |uid|
   :param screen_name: |screen_name|
   :param user_id: |user_id|
   :rtype: :class:`User` object


Block Methods
-------------

.. method:: 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.

   :param id: |uid|
   :param screen_name: |screen_name|
   :param user_id: |user_id|
   :rtype: :class:`User` object


.. method:: API.destroy_block(id/screen_name/user_id)

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

   :param id: |uid|
   :param screen_name: |screen_name|
   :param user_id: |user_id|
   :rtype: :class:`User` object


.. method:: API.exists_block(id/screen_name/user_id)

   Checks if the authenticated user is blocking the specified user.

   :param id: |uid|
   :param screen_name: |screen_name|
   :param user_id: |user_id|
   :rtype: True/False


.. method:: API.blocks([page])

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

   :param page: |page|
   :rtype: list of :class:`User` objects


.. method:: API.blocks_ids()

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

   :rtype: list of Integers


Spam Reporting Methods
----------------------

.. method:: API.report_spam([id/user_id/screen_name])

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

   :param id: |uid|
   :param screen_name: |screen_name|
   :param user_id: |user_id|
   :rtype: :class:`User` object


Saved Searches Methods
----------------------

.. method:: API.saved_searches()

   Returns the authenticated user's saved search queries.

   :rtype: list of :class:`SavedSearch` objects


.. method:: API.get_saved_search(id)

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

   :param id: The id of the saved search to be retrieved.
   :rtype: :class:`SavedSearch` object


.. method:: API.create_saved_search(query)

   Creates a saved search for the authenticated user.

   :param query: The query of the search the user would like to save.
   :rtype: :class:`SavedSearch` object


.. method:: 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.

   :param id: The id of the saved search to be deleted.
   :rtype: :class:`SavedSearch` object


Help Methods
------------

.. method:: API.search(q[,lang],[locale],[rpp],[page],[since_id],[geocode],[show_user])

   Returns tweets that match a specified query.

   :param q: the search query string
   :param lang: Restricts tweets to the given language, given by an ISO 639-1 code.
   :param locale: Specify the language of the query you are sending. This is intended for language-specific clients and the default should work in the majority of cases.
   :param rpp: The number of tweets to return per page, up to a max of 100.
   :param page: The page number (starting at 1) to return, up to a max of roughly 1500 results (based on rpp * page.
   :param 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.
   :param show_user: When true, prepends "<user>:" to the beginning of the tweet. This is useful for readers that do not display Atom's author field. The default is false.
   :rtype: list of :class:`SearchResult` objects


.. method:: API.trends()

   Returns the top ten topics that are currently trending on Twitter. The
   response includes the time of the request, the name of each trend, and
   the url to the Twitter Search results page for that topic.

   :rtype: :class:`JSON` object


.. method:: API.trends_current([exclude])

   Returns the current top 10 trending topics on Twitter. The response
   includes the time of the request, the name of each trending topic, and
   query used on Twitter Search results page for that topic.

   :param exclude: |exclude|
   :rtype: :class:`JSON` object


.. method:: API.trends_daily([date], [exclude])

   Returns the top 20 trending topics for each hour in a given day.

   :param date: |date|
   :param exclude: |exclude|
   :rtype: :class:`JSON` object


.. method:: API.trends_weekly([date], [exclude])

   Returns the top 30 trending topics for each day in a given week.

   :param date: |date|
   :param exclude: |exclude|
   :rtype: :class:`JSON` object


List Methods
------------

.. method:: API.create_list(name, [mode], [description])

   Creates a new list for the authenticated user. Accounts are limited to
   20 lists.

   :param name: The name of the new list.
   :param mode: |list_mode|
   :param description: The description of the list you are creating.
   :rtype: :class:`List` object


.. method:: API.destroy_list(slug)

   Deletes the specified list. Must be owned by the authenticated user.

   :param slug: |slug|
   :rtype: :class:`List` object


.. method:: API.update_list(slug, [name], [mode], [description])

   Updates the specified list. Note: this current throws a 500. Twitter
   is looking into the issue.

   :param slug: |slug|
   :param name: What you'd like to change the lists name to.
   :param mode: |list_mode|
   :param description: What you'd like to change the list description to.
   :rtype: :class:`List` object


.. method:: API.lists([cursor])

   List the lists of the specified user. Private lists will be included
   if the authenticated users is the same as the user who's lists are
   being returned.

   :param cursor: |cursor|
   :rtype: list of :class:`List` objects


.. method:: API.lists_memberships([cursor])

   List the lists the specified user has been added to.

   :param cursor: |cursor|
   :rtype: list of :class:`List` objects


.. method:: API.lists_subscriptions([cursor])

   List the lists the specified user follows.

   :param cursor: |cursor|
   :rtype: list of :class:`List` objects


.. method:: API.list_timeline(owner, slug, [since_id], [max_id], [per_page], [page])

   Show tweet timeline for members of the specified list.

   :param owner: |list_owner|
   :param slug: |slug|
   :param since_id: |since_id|
   :param max_id: |max_id|
   :param per_page: Number of results per a page
   :param page: |page|
   :rtype: list of :class:`Status` objects


.. method:: API.get_list(owner, slug)

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

   :param owner: |list_owner|
   :param slug: |slug|
   :rtype: :class:`List` object


.. method:: API.add_list_member(slug, 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 having 500 members.

   :param slug: |slug|
   :param id: the ID of the user to add as a member
   :rtype: :class:`List` object


.. method:: API.remove_list_member(slug, id)

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

   :param slug: |slug|
   :param id: the ID of the user to remove as a member
   :rtype: :class:`List` object


.. method:: API.list_members(owner, slug, cursor)

   Returns the members of the specified list.

   :param owner: |list_owner|
   :param slug: |slug|
   :param cursor: |cursor|
   :rtype: list of :class:`User` objects


.. method:: API.is_list_member(owner, slug, id)

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

   :param owner: |list_owner|
   :param slug: |slug|
   :param id: the ID of the user to check
   :rtype: :class:`User` object if user is a member of list, otherwise False.


.. method:: API.subscribe_list(owner, slug)

   Make the authenticated user follow the specified list.

   :param owner: |list_owner|
   :param slug: |slug|
   :rtype: :class:`List` object


.. method:: API.unsubscribe_list(owner, slug)

   Unsubscribes the authenticated user form the specified list.

   :param owner: |list_owner|
   :param slug: |slug|
   :rtype: :class:`List` object


.. method:: API.list_subscribers(owner, slug, [cursor])

   Returns the subscribers of the specified list.

   :param owner: |list_owner|
   :param slug: |slug|
   :param cursor: |cursor|
   :rtype: list of :class:`User` objects


.. method:: API.is_subscribed_list(owner, slug, id)

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

   :param owner: |list_owner|
   :param slug: |slug|
   :param id: the ID of the user to check
   :rtype: :class:`User` object if user is subscribed to the list, otherwise False.


Local Trends Methods
--------------------

.. method:: API.trends_available([lat], [long])

   Returns the locations that Twitter has trending topic information for. The response is an array of "locations" that encode the location's WOEID (a Yahoo! Where On Earth ID) and some other human-readable information such as a canonical name and country the location belongs in. [Coming soon]

   :param lat: If passed in conjunction with long, then the available trend locations will be sorted by distance to the lat and long passed in.  The sort is nearest to furthest.
   :param long: See lat.
   :rtype: :class:`JSON` object


.. method:: API.trends_location(woeid)

   Returns the top 10 trending topics for a specific location Twitter has trending topic information for. The response is an array of "trend" objects that encode the name of the trending topic, the query parameter that can be used to search for the topic on Search, and the direct URL that can be issued against Search. This information is cached for five minutes, and therefore users are discouraged from querying these endpoints faster than once every five minutes.  Global trends information is also available from this API by using a WOEID of 1.

   :param woeid:     * The WOEID of the location to be querying for.
   :rtype: :class:`JSON` object

Geo Methods
-----------

.. method:: 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
   :func:`update_status` to appear as the name of the location. This
   call provides a detailed response about the location in question;
   the :func:`nearby_places` function should be preferred for getting
   a list of places nearby without great detail.

   :param lat: The location's latitude.
   :param long: The location's longitude.
   :param 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
   :param granularity: Assumed to be `neighborhood' by default; can also be `city'.
   :param max_results: A hint as to the maximum number of results to return. This is only a guideline, which may not be adhered to.

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

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

   :param lat: The location's latitude.
   :param long: The location's longitude.
   :param ip: The location's IP address. Twitter will attempt to geolocate using the IP address.
   :param 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
   :param granularity: Assumed to be `neighborhood' by default; can also be `city'.
   :param max_results: A hint as to the maximum number of results to return. This is only a guideline, which may not be adhered to.

.. method:: API.geo_id(id)

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

   :param id: Valid Twitter ID of a location.