THE TRUTH

REST API v1 Resources

API v1 is now retired. It will no longer function. Please use API v1.1 instead.

Timelines Timelines are collections of Tweets, ordered with the most recent first.

Resource	Description
GET statuses/home_timeline	This deprecated method is replaced by GET statuses/home_timeline in API v1.1 Returns the most recent statuses, including retweets if they exist, posted by the authenticating user and the users they follow. This is the same timeline seen by a user when they login to twitter.com. This method is...
GET statuses/mentions	Returns the 20 most recent mentions (status containing @username) for the authenticating user. The timeline returned is the equivalent of the one seen when you view your mentions on twitter.com. This method can only return up to 800 statuses. If include_rts is set only 800 statuses, including...
GET statuses/retweeted_by_me	Returns the 20 most recent retweets posted by the authenticating user.
GET statuses/retweeted_to_me	Returns the 20 most recent retweets posted by users the authenticating user follow. A maximum of 200 tweets will be available on this timeline.
GET statuses/retweets_of_me	Returns the 20 most recent tweets of the authenticated user that have been retweeted by others.
GET statuses/user_timeline	This deprecated method is replaced by GET statuses/user_timeline in API v1.1 Returns the 20 most recent statuses posted by the authenticating user. It is also possible to request another user's timeline by using the screen_name or user_id parameter. The other users timeline will only be visible if...
GET statuses/retweeted_to_user	Returns the 20 most recent retweets posted by users the specified user follows. The user is specified using the user_id or screen_name parameters. This method is identical to statuses/retweeted_to_me except you can choose the user to view.
GET statuses/retweeted_by_user	Returns the 20 most recent retweets posted by the specified user. The user is specified using the user_id or screen_name parameters. This method is identical to statuses/retweeted_by_me except you can choose the user to view. Does not require authentication, unless the user is protected.

Tweets Tweets are the atomic building blocks of Twitter, 140-character status updates with additional associated metadata. People tweet for a variety of reasons about a multitude of topics.

Resource	Description
GET statuses/:id/retweeted_by	Show user objects of up to 100 members who retweeted the status.
GET statuses/:id/retweeted_by/ids	Show user ids of up to 100 users who retweeted the status.
GET statuses/retweets/:id	Returns up to 100 of the first retweets of a given tweet.
GET statuses/show/:id	Returns a single status, specified by the id parameter below. The status's author will be returned inline.
POST statuses/destroy/:id	Destroys the status specified by the required ID parameter. The authenticating user must be the author of the specified status. Returns the destroyed status if successful.
POST statuses/retweet/:id	Retweets a tweet. Returns the original tweet with retweet details embedded.
POST statuses/update	Updates the authenticating user's status, also known as tweeting. To upload an image to accompany the tweet, use POST statuses/update_with_media. 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...
POST statuses/update_with_media	Updates the authenticating user's status and attaches media for upload. Unlike POST statuses/update, this method expects raw multipart data. Your POST request's Content-Type should be set to multipart/form-data with the media[] parameter The Tweet text will be rewritten to include the media...

Search Find relevant Tweets based on queries performed by your users.

Resource	Description
GET search	This deprecated method is replaced by GET search/tweets in API v1.1 Returns relevant tweets that match a specified query. To best learn how to use Twitter Search effectively, consult our guide to Using the Twitter Search API Notice: As of April 1st 2010, the Search API provides an option to...

Streaming

Resource	Description
POST statuses/filter	Returns public statuses that match one or more filter predicates. Multiple parameters may be specified which allows most clients to use a single connection to the Streaming API. Both GET and POST requests are supported, but GET requests with too many parameters may cause the request to be...
GET statuses/sample	Returns a small random sample of all public statuses. The Tweets returned by the default access level are the same, so if two different clients connect to this endpoint, they will see the same Tweets.
GET statuses/firehose	This endpoint requires special permission to access. Returns all public statuses. Few applications require this level of access. Creative use of a combination of other resources and various access levels can satisfy nearly every application use case.
GET user	Streams messages for a single user, as described in User streams.

Direct Messages Direct Messages are short, non-public messages sent between two users. Access to Direct Messages is governed by the The Application Permission Model.

Resource	Description
GET direct_messages	Returns the 20 most recent direct messages sent to the authenticating user. The XML and JSON versions include detailed information about the sender and recipient user. You can request up to 200 direct messages per call, up to a maximum of 800 incoming DMs. Important: This method requires an access...
GET direct_messages/sent	Returns the 20 most recent direct messages sent by the authenticating user. The XML and JSON versions include detailed information about the sender and recipient user. You can request up to 200 direct messages per call, up to a maximum of 800 outgoing DMs. Important: This method requires an access...
POST direct_messages/destroy/:id	Important: This method requires an access token with RWD (read, write...
POST direct_messages/new	Sends a new direct message to the specified user from the authenticating user. Requires both the user and text parameters and must be a POST. Returns the sent message in the requested format if successful.
GET direct_messages/show/:id	Returns a single direct message, specified by an id parameter. Like the /1/direct_messages.format request, this method will include the user objects of the sender and recipient. Important: This method requires an access token with RWD (read, write...

Friends & Followers Users follow their interests on Twitter through both one-way and mutual following relationships.

Resource	Description
GET followers/ids	Returns an array of numeric IDs for every user following the specified user. This method is powerful when used in conjunction with users/lookup.
GET friends/ids	Returns an array of numeric IDs for every user the specified user is following. This method is powerful when used in conjunction with users/lookup.
GET friendships/exists	Test for the existence of friendship between two users. Will return true if user_a follows user_b, otherwise will return false. Authentication is required if either user A or user B are protected. Additionally the authenticating user must be a follower of the protected user. Consider using...
GET friendships/incoming	Returns an array of numeric IDs for every user who has a pending request to follow the authenticating user.
GET friendships/outgoing	Returns an array of numeric IDs for every protected user for whom the authenticating user has a pending follow request.
GET friendships/show	Returns detailed information about the relationship between two users.
POST friendships/create	Allows the authenticating users to follow the user specified in the ID parameter. Returns the befriended user in the requested format when successful. Returns a string describing the failure condition when unsuccessful. If you are already friends with the user a HTTP 403 may be returned, though for...
POST friendships/destroy	Allows the authenticating users to unfollow the user specified in the ID parameter. Returns the unfollowed user in the requested format when successful. Returns a string describing the failure condition when unsuccessful.
GET friendships/lookup	Returns the relationship of the authenticating user to the comma separated list of up to 100 screen_names or user_ids provided. Values for connections can be: following, following_requested, followed_by, none.
POST friendships/update	Allows one to enable or disable retweets and device notifications from the specified user.
GET friendships/no_retweet_ids	This method is replaced by GET friendships/no_retweets/ids in API v1.1. Returns a collection of user_ids that the currently authenticated user does not want to receive retweets from. Use POST friendships/update to set the "no retweets" status for a given user account on behalf of the current user.

Users Users are at the center of everything Twitter: they follow, they favorite, and tweet & retweet.

Resource	Description
GET users/profile_image/:screen_name	Access the profile image in various sizes for the user with the indicated screen_name. If no size is provided the normal image is returned. This resource does not return JSON or XML, but instead returns a 302 redirect to the actual image resource. This method should only be used by application...
GET users/search	Runs a search for users similar to Find People button on Twitter.com. The results returned by people search on Twitter.com are the same as those returned by this API request. Note that unlike GET search, this method does not support any operators. Only the first 1000 matches are available.
GET users/show	Returns extended information of a given user, specified by ID or screen name as per the required id parameter. The author's most recent status will be returned inline.
GET users/contributees	Returns an array of users that the specified user can contribute to.
GET users/contributors	Returns an array of users who can contribute to the specified account.

Suggested Users Categorical organization of users that others may be interested to follow.

Resource	Description
GET users/suggestions	Access to Twitter's suggested user list. This returns the list of suggested user categories. The category can be used in GET users/suggestions/:slug to get the users in that category.
GET users/suggestions/:slug	Access the users in a given category of the Twitter suggested user list. It is recommended that end clients cache this data for no more than one hour.
GET users/suggestions/:slug/members.format	Access the users in a given category of the Twitter suggested user list and return their most recent status if they are not a protected user.

Favorites Users favorite tweets to give recognition to awesome tweets, to curate the best of Twitter, to save for reading later, and a variety of other reasons. Likewise, developers make use of "favs" in many different ways.

Resource	Description
GET favorites	Returns the 20 most recent favorite statuses for the authenticating or specified user in the requested format.
POST favorites/create/:id	Favorites the status specified in the ID parameter as the authenticating user. Returns the favorite status when successful. This process invoked by this method is asynchronous. The immediately returned status may not indicate the resultant favorited status of the tweet. A 200 OK response from this...
POST favorites/destroy/:id	Un-favorites the status specified in the ID parameter as the authenticating user. Returns the un-favorited status in the requested format when successful. This process invoked by this method is asynchronous. The immediately returned status may not indicate the resultant favorited status of the...

Lists Lists are collections of tweets, culled from a curated list of Twitter users. List timeline methods include tweets by all members of a list.

Resource	Description
GET lists/all	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.
GET lists/statuses	Returns tweet timeline for members of the specified list. Historically, retweets were not available in list timeline responses but you can now use the include_rts=true parameter to additionally receive retweet objects.
POST lists/members/destroy	Removes the specified member from the list. The authenticated user must be the list's owner to remove members from the list.
GET lists/memberships	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.
GET lists/subscribers	Returns the subscribers of the specified list. Private list subscribers will only be shown if the authenticated user owns the specified list.
POST lists/subscribers/create	Subscribes the authenticated user to the specified list.
GET lists/subscribers/show	Check if the specified user is a subscriber of the specified list. Returns the user if they are subscriber.
POST lists/members/create_all	Adds multiple members to a list, by specifying a comma-separated list of member ids or screen names. The authenticated user must own the list to be able to add members to it. Note that lists can't have more than 500 members, and you are limited to adding up to 100 members to a list at a time with...
GET lists/members/show	Check if the specified user is a member of the specified list.
GET lists/members	Returns the members of the specified list. Private list members will only be shown if the authenticated user owns the specified list.
POST lists/members/create	Add a member to a list. The authenticated user must own the list to be able to add members to it. Note that lists can't have more than 500 members.
POST lists/destroy	Deletes the specified list. The authenticated user must own the list to be able to destroy it.
POST lists/update	Updates the specified list. The authenticated user must own the list to be able to update it.
POST lists/create	Creates a new list for the authenticated user. Note that you can't create more than 20 lists per account.
GET lists	Returns the lists of the specified (or authenticated) user. Private lists will be included if the authenticated user is the same as the user whose lists are being returned.
GET lists/show	Returns the specified list. Private lists will only be shown if the authenticated user owns the specified list.
GET lists/subscriptions	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.

Accounts Account-level configuration settings for users.

Resource	Description
GET account/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...
GET account/verify_credentials	Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful; returns a 401 status code and an error message if not. Use this method to test if supplied user credentials are valid.
POST account/update_profile	Sets values that users are able to set under the "Account" tab of their settings page. Only the parameters specified will be updated.
POST account/update_profile_colors	Sets one or more hex values that control the color scheme of the authenticating user's profile page on twitter.com. Each parameter's value must be a valid hexidecimal value, and may be either three or six characters (ex: #fff or #ffffff).
POST account/update_profile_image	Updates the authenticating user's profile image. Note that this method expects raw multipart data, not a URL to an image. This method asynchronously processes the uploaded file before updating the user's profile image URL. You can either update your local cache the next time you request the user's...
GET account/totals	Returns the current count of friends, followers, updates (statuses) and favorites of the authenticating user.
GET account/settings	Returns settings (including current trend, geo and sleep time information) for the authenticating user.
POST account/settings	Updates the authenticating user's settings.
POST account/update_profile_banner	Uploads a profile banner on behalf of the authenticating user. For best results, upload an
POST account/remove_profile_banner	Removes the uploaded profile banner for the authenticating user. Returns HTTP 200 upon success.

Notification Controls SMS-based notifications that a user wants to receive.

Resource	Description
POST notifications/follow	Enables device notifications for updates from the specified user. Returns the specified user when successful.
POST notifications/leave	Disables notifications for updates from the specified user to the authenticating user. Returns the specified user when successful.

Saved Searches Allows users to save references to search criteria for reuse later.

Resource	Description
GET saved_searches	Returns the authenticated user's saved search queries.
GET saved_searches/show/:id	Retrieve the information for the saved search represented by the given id. The authenticating user must be the owner of saved search ID being requested.
POST saved_searches/create	Create a new saved search for the authenticated user. A user may only have 25 saved searches.
POST saved_searches/destroy/:id	Destroys a saved search for the authenticating user. The authenticating user must be the owner of saved search id being destroyed.

Places & Geo Users tweet from all over the world. These methods allow you to attach location data to tweets and discover tweets & locations.

Resource	Description
GET geo/id/:place_id	Returns all the information about a known place.
GET geo/reverse_geocode	Given a latitude and a longitude, searches for up to 20 places that can be used as a place_id when updating a status. This request is an informative call and will deliver generalized results about geography.
GET geo/search	Search for places that can be attached to a statuses/update. Given a latitude and a longitude pair, an IP address, or a name, this request will return a list of all the valid places that can be used as the place_id when updating a status. Conceptually, a query can be made from the user's location...
GET geo/similar_places	Locates places near the given coordinates which are similar in name. Conceptually you would use this method to get a list of known places to choose from first. Then, if the desired place doesn't exist, make a request to POST geo/place to create a new one. The token contained in the response is the...
POST geo/place	Creates a new place object at the given latitude and longitude. Before creating a place you need to query GET geo/similar_places with the latitude, longitude and name of the place you wish to create. The query will return an array of places which are similar to the one you wish to create, and a...

Trends With so many tweets from so many users, themes are bound to arise from the zeitgeist. The Trends methods allow you to explore what's trending on Twitter.

Resource	Description
GET trends/:woeid	Returns the top 10 trending topics for a specific WOEID, if trending information is available for it. 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 Twitter Search, and the Twitter Search URL....
GET trends/available	Returns the locations that Twitter has trending topic information for. The response is an array of "locations" that encode the location's WOEID and some other human-readable information such as a canonical name and country the location belongs in. A WOEID is a Yahoo! Where On Earth ID.
GET trends/daily	Returns the top 20 trending topics for each hour in a given day.
GET trends/weekly	Returns the top 30 trending topics for each day in a given week.

Block Allows users to block and unblock other users.

Resource	Description
GET blocks/blocking	Returns an array of user objects that the authenticating user is blocking. Consider using GET blocks/blocking/ids with GET users/lookup instead of this method.
GET blocks/blocking/ids	Returns an array of numeric user ids the authenticating user is blocking.
GET blocks/exists	Returns if the authenticating user is blocking a target user. Will return the blocked user's object if a block exists, and error with a HTTP 404 response code otherwise.
POST blocks/create	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.
POST blocks/destroy	Un-blocks the user specified in the ID parameter for the authenticating user. Returns the un-blocked user in the requested format when successful. If relationships existed before the block was instated, they will not be restored.

Spam Reporting These methods are used to report user accounts as spam accounts.

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

OAuth Twitter uses OAuth for authentication. Be sure and read about Authentication & Authorization.

Resource	Description
GET oauth/authenticate	Allows a Consumer application to use an OAuth request_token to request user authorization. This method is a replacement of Section 6.2 of the OAuth 1.0 authentication flow for applications using the callback authentication flow. The method will use the currently logged in user as the account for...
GET oauth/authorize	Allows a Consumer application to use an OAuth Request Token to request user authorization. This method fulfills Section 6.2 of the OAuth 1.0 authentication flow. Desktop applications must use this method (and cannot use GET oauth/authenticate). Please use HTTPS for this method, and all other OAuth...
POST oauth/access_token	Allows a Consumer application to exchange the OAuth Request Token for an OAuth Access Token. This method fulfills Section 6.3 of the OAuth 1.0 authentication flow. The OAuth access token may also be used for xAuth operations. Please use HTTPS for this method, and all other OAuth token negotiation...
POST oauth/request_token	Allows a Consumer application to obtain an OAuth Request Token to request user authorization. This method fulfills Section 6.1 of the OAuth 1.0 authentication flow. It is strongly recommended you use HTTPS for all OAuth authorization steps. Usage Note: Only ASCII values are accepted for the...

Help These methods assist you in working & debugging with the Twitter API.

Resource	Description
GET help/test	Returns the string "ok" in the requested format with a 200 OK HTTP status code. This method is great for sending a HEAD request to determine our servers current time.
GET help/configuration	Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co URL lengths. It is recommended applications request this endpoint when they are loaded, but no more than once a day.
GET help/languages	Returns the list of languages supported by Twitter along with their ISO 639-1 code. The ISO 639-1 code is the two letter value to use if you include lang with any of your requests.

Legal API Methods to address legal issues in your applications.

Resource	Description
GET legal/privacy	Returns Twitter's Privacy Policy in the requested format.
GET legal/tos	Returns the Twitter Terms of Service in the requested format. These are not the same as the Developer Rules of the Road.

Deprecated These methods, while functional, are eventually being removed from the platform. Most methods will have functional or superior equivalents.

Resource	Description
DELETE :user/:list_id/members	This method is deprecated and has been replaced by POST lists/members/destroy. Please update your applications with the new endpoint. Removes the specified member from the list. The authenticated user must be the list's owner to remove members from the list. Usage Note: clients who can not issue...
DELETE :user/:list_id/subscribers	This method is deprecated and has been replaced by POST lists/subscribers/destroy. Please update your applications with the new endpoint. Unsubscribes the authenticated user form the specified list. Usage Note: clients who can not issue DELETE requests can POST with the added parameter _method=...
DELETE :user/lists/:id	This method is deprecated and has been replaced by POST lists/destroy. Please update your applications with the new endpoint. Deletes the specified list. Must be owned by the authenticated user. Usage Note: clients who can not issue DELETE requests can POST with the added parameter _method=DELETE.
GET :user/:list_id/members	This method is deprecated and has been replaced by GET lists/members. Please update your applications with the new endpoint. Returns the members of the specified list.
GET :user/:list_id/members/:id	This method is deprecated and has been replaced by GET lists/members/show. Please update your applications with the new endpoint. Check if a user is a member of the specified list. Returns the user indicated by :id if the user is a member of the list.
GET :user/:list_id/subscribers	This method is deprecated and has been replaced by GET lists/subscribers. Please update your applications with the new endpoint. Returns the subscribers of the specified list.
GET :user/:list_id/subscribers/:id	This method is deprecated and has been replaced by GET lists/subscribers/show. Please update your applications with the new endpoint. Check if a user is a subscriber of the specified list.
GET :user/lists	This method is deprecated and has been replaced by GET lists. Please update your applications with the new endpoint. 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.
GET :user/lists/:id	This method is deprecated and has been replaced by GET lists/show. Please update your applications with the new endpoint. Show the specified list. Private lists will only be shown if the authenticated user owns the specified list.
GET :user/lists/:id/statuses	This method is deprecated and has been replaced by GET lists/statuses. Please update your applications with the new endpoint. Show the tweet timeline for members of the specified list.
GET :user/lists/memberships	This method is deprecated and has been replaced by GET lists/memberships. Please update your applications with the new endpoint. List the lists the specified user has been added to.
GET :user/lists/subscriptions	This method is deprecated and has been replaced by GET lists/subscriptions. Please update your applications with the new endpoint. List the lists the specified user follows.
GET statuses/followers	This method is deprecated as it will only return information about users who have Tweeted recently. It is not a functional way to retrieve all of a users followers. Instead of using this method use a combination of GET followers/ids and GET users/lookup. Returns the authenticating user's followers...
GET statuses/friends	This method is deprecated as it will only return information about users who have Tweeted recently. It is not a functional way to retrieve all of a users followers. Instead of using this method use a combination of GET friends/ids and GET users/lookup. Returns a user's friends, each with current...
GET statuses/friends_timeline	This method is deprecated and has been replaced by GET statuses/home_timeline. Please update your applications with the new endpoint. Returns the 20 most recent statuses posted by the authenticating user and the user's they follow. This is the same timeline seen by a user when they login to twitter...
GET statuses/public_timeline	This method has been removed from service. Please use GET statuses/sample instead for obtaining recent public tweets. Returned the 20 most recent statuses, including retweets if they existed, from non-protected users. The public timeline was cached for 60 seconds. Requesting more frequently than...
GET trends	This method is deprecated and has been replaced by GET trends/:woeid. Please update your applications with the new endpoint. 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...
GET trends/current	This method is deprecated and has been replaced by GET trends/:woeid. Please update your applications with the new endpoint. 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...
POST :user/lists/:list_id/create_all	This method is deprecated and has been replaced by POST lists/members/create_all. Please update your applications with the new endpoint. Adds multiple members to a list, by specifying a comma-separated list of member ids or screen names. The authenticated user must own the list to be able to add...
POST :user/:list_id/members	This method is deprecated and has been replaced by POST lists/members/create. Please update your applications with the new endpoint. 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.
POST :user/:list_id/subscribers	This method is deprecated and has been replaced by POST lists/subscribers/create. Please update your applications with the new endpoint. Make the authenticated user follow the specified list.
POST :user/lists	This method is deprecated and has been replaced by POST lists/create. Please update your applications with the new endpoint. Creates a new list for the authenticated user. Accounts are limited to 20 lists.
POST :user/lists/:id	This method is deprecated and has been replaced by POST lists/update. Please update your applications with the new endpoint. Updates the specified list.
POST account/end_session	Ends the session of the authenticating user, returning a null cookie. Use this method to sign users out of client-facing applications like widgets.
POST account/update_delivery_device	Sets which device Twitter delivers updates to for the authenticating user. Sending none as the device parameter will disable SMS updates.
POST account/update_location	This method is deprecated and has been replaced by POST account/update_profile. Please update your applications with the new endpoint. Sets the value of the profile location field for the authenticating user.