This appendix includes a break down of all the Twitter API methods available as of this writing. It is to serve as a quick reference guide. The methods are in alphabetical order by their path name.
Note
All methods referenced in this appendix refer to version 1 of the API. As such, the root of all method paths is
http://api.twitter.com/1/Use to verify that the supplied credentials are valid.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/account/verify_credentials | XML, JSON | GET | TRUE | FALSE |
Returns the amount of remaining API requests available for the hour for the authenticated user. If you aren't authenticated, the rate limit for the current IP address is returned.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/account/rate_limit_status | XML, JSON | GET | FALSE | FALSE |
Ends the session for the current logged in user.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/account/end_session | XML, JSON | GET | TRUE | FALSE |
Updates the device that Twitter forwards tweets to.
Warning
As of this writing, IM is not supported.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
| XML, JSON | POST | TRUE | FALSE |
Parameter | Description | Examples |
device | Values include: sms, none | device=sms |
Sets user defined colors for the elements on the users Twitter page for the authenticated user.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/account/update_profile_colors | XML, JSON | POST | TRUE | FALSE |
Parameter | Description | Examples |
profile_background_color | Hexadecimal color code for the background, if no background image is present. | profile_background_color=333 |
profile_text_color | Hexadecimal color code for text. | profile_text_color=000000 |
profile_link_color | Hexadecimal color code for links. | profile_link_color=00C2FC |
profile_sidebar_fill_color | Hexadecimal color code for the background of the sidebar. | profile_sidebar_fill_color=fff |
profile_sidebar_border_color | Hexadecimal color code for the border around the sidebar. | profile_sidebar_border_color=000 |
Sets the profile image for the authenticated user.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/account/update_profile_image | XML, JSON | POST | TRUE | FALSE |
Parameter | Description | Examples |
image | A GIF, JPG, or PNG image less than 700 kilobytes. Widths greater than 500 pixels are scaled down. | image=@'mypic.png;type=image/png' |
Sets the profile background image for the authenticated user.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/account/update_profile_background_image | XML, JSON | POST | TRUE | FALSE |
Parameter | Description | Examples |
image | A GIF, JPG, or PNG image less than 800 kilobytes. Widths greater than 2048 pixels are scaled down. | image=@'mypic.png;type=image/png' |
Tile | Tile the background image by setting a value of true. | title=true |
Sets the authenticated user's profile text fields.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/account/update_profile | XML, JSON | POST | TRUE | FALSE |
Parameter | Description | Examples |
Name | A string under 20 characters intended for the full name of the user. | name=Dusty Reagan |
url | A string under 100 characters intended for the personal URL of the user. " | url= |
location | A string under 30 characters intended for the geographical location of the user. | location=Texas |
description | A string under 160 characters intended to describe the user. | description=awesome dude |
blocks/blocking
blocks/blocking/ids
blocks/create
blocks/destroy
blocks/exists
Returns the user details object for the 20 most recently blocked users by the authenticating user.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/blocks/blocking | XML, JSON | GET | TRUE | TRUE |
Parameter | Description | Examples |
Page | Page to retrieve older blocked users. | /blocks/blocking.xml?page=5 |
Get the numeric user ids of users the authenticating user has blocked.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/blocks/blocking/id | XML, JSON | GET | TRUE | TRUE |
Block the specified user for the authenticated user.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/blocks/create | XML, JSON | POST | TRUE | FALSE |
Parameter | Description | Examples |
id | The numeric user ID or screen name of the desired user. | /blocks/create/12345.xml/blocks/create/bob.xml |
user_id | The numeric ID of the user. | /blocks/create.xml?user_id=12345 |
screen_name | The screen name of the user. | /blocks/create.xml?screen_name=101010 |
Removes the block of a specified user for the authenticated user.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/blocks/destroy | XML, JSON | POST, DELETE | TRUE | FALSE |
Parameter | Description | Examples |
id | The numeric user ID or screen name of the desired user. | /blocks/destroy/12345.xml/blocks/destroy/bob.xml |
user_id | The numeric ID of the user. | /blocks/destroy.xml?user_id=12345 |
screen_name | The screen name of the user. | /blocks/destory.xml?screen_name=101010 |
Check if the authenticating user has blocked a specified user.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/blocks/exists | XML, JSON | GET | TRUE | FALSE |
Parameter | Description | Examples |
id | The numeric user ID or screen name of the desired user. | /blocks/exists/12345.xml/blocks/exists/bob.xml |
user_id | The numeric ID of the user. | /blocks/exists.xml?user_id=12345 |
screen_name | The screen name of the user. | /blocks/exists.xml?screen_name=101010 |
Get the authenticated user's 20 most recently received direct messages.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/direct_messages | XML, JSON, RSS, ATOM | GET | TRUE | TRUE |
Parameter | Description | Examples |
Since_id | The numerical id of a direct message. Use to return direct messages that are more recent than the id specified. | /direct_messages.xml?since_id=12345 |
max_id | The numerical id of a direct message. Use to return direct messages that are older than the id specified. | /direct_messages.xml?max_id=54321 |
Count | Limits the results per page to an amount specified that is less than 200. | /direct_messages.xml?count=100 |
Page | Page backwards to retrieve older direct messages. | /direct_messages.xml?page=5 |
Get the authenticated user's 20 most recently sent direct messages.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/direct_messages/sent | XML, JSON, RSS, ATOM | GET | TRUE | TRUE |
Parameter | Description | Examples |
Since_id | Returns direct messages that are more recent than the id specified. | /direct_messages/sent.xml?since_id=12345 |
max_id | Returns direct messages that older than the id specified. | /direct_messages/sent.xml?max_id=54321 |
Count | Limits the results to an amount specified that is less than 200. | /direct_messages/sent.xml?count=100 |
Page | Page backwards to retrieve older direct messages. | /direct_messages/sent.xml?page=5 |
Send a new direct message to a user.
While the id parameter can take either a screen name or numeric user id as a parameter, there are cases when a screen name and numeric user id may conflict. For example, a user's screen name might be 101010. There might also be a numeric user id 101010. For this reason you should use either the user_id or screen_name parameter.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/direct_messages/new | XML, JSON | POST | TRUE | FALSE |
Parameter | Description | Examples |
User | The numeric user ID or screen name of the desired user. | /direct_messages/new/12345.xml/direct_messages/new/bob.xml |
User_id | The numeric ID of the user. | /direct_messages/new.xml?user_id=12345 |
screen_name | The screen name of the user. | /direct_messages/new.xml?screen_name=101010 |
Text | The content of the direct message. Must be URL encoded and less than 140 characters. | /direct_messages/new.xml?user_id=123&text=hi |
Deletes a specified received direct message of the authenticating user.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/direct_messages/destroy/ | XML, JSON | POST, DELETE | TRUE | FALSE |
Parameter | Description | Examples |
id | The numeric id of the direct message you want to delete. | /direct_messages/destroy/12345.xml/direct_messages/destroy/12345.json |
favorites
favorites/create
favorites/destroy
Returns the 20 most recently favorited tweets for the authenticated user or the user you request.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/favorites | XML, JSON | GET | FALSE | TRUE |
Parameter | Description | Examples |
id | The numeric user ID or screen name of the desired user. | /favorites/12345.xml/favorites/bob.xml |
user_id | The numeric ID of the user. | /favorites.xml?user_id=12345 |
screen_name | The screen name of the user. | /favorites.xml?screen_name=101010 |
Page | Page backwards to retrieve older favorited tweets. | /favorites.xml?page=5 |
Mark a tweet as a favorite for the authenticated user.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/favorites/create/ | XML, JSON | POST | TRUE | FALSE |
Parameter | Description | Examples |
id | The numeric id of the tweet you want to favorite. | /favorites/create/12345.xml/favorites/create/12345.json |
Remove a marked favorite tweet for the authenticated user.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/favorites/destroy/ | XML, JSON | POST, DELETE | TRUE | FALSE |
Parameter | Description | Examples |
id | The numeric id of the tweet you want to un-favorite. | /favorites/destroy/12345.xml/favorites/destroy/12345.json |
followers/ids
friends/ids
Get to numeric user ids of the entire user's following a target user.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/followers/ids | XML, JSON | GET | FALSE | TRUE |
Parameter | Description | Examples |
id | The numeric user ID or screen name of a user. | /followers/ids/12345.xml/followers/ids/bob.xml |
user_id | The numeric ID of a user. | /followers/ids.xml?user_id=12345 |
screen_name | The screen name of a user. | /followers/ids.xml?screen_name=101010 |
cursor | Splits results into pages of a maximum of 5000 ids. Pass a value of −1 to begin paging. | /followers/ids/bob.xml?cursor=-1/followers/ids/bob.xml?cursor=-1300794057949944903 |
Get to numeric user ids of all the users a person is following.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/friends/ids | XML, JSON | GET | FALSE | TRUE |
Parameter | Description | Examples |
id | The numeric user ID or screen name of a user. | /friends/ids/12345.xml/friends/ids/bob.xml |
user_id | The numeric ID of a user. | /friends/ids.xml?user_id=12345 |
screen_name | The screen name of a user. | /friends/ids.xml?screen_name=101010 |
cursor | Splits results into pages of a maximum of 5000 ids. Pass a value of −1 to begin paging. | /friends/ids/bob.xml?cursor=-1/friends/ids/bob.xml?cursor=-1300794057949944903 |
friendships/create
friendships/destory
friendships/exists
friendships/show
Have the authenticated user follow the specified Twitter user.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/friendships/create | XML, JSON | POST | TRUE | FALSE |
Parameter | Description | Examples |
id | The numeric user ID or screen name of the desired user. | /friendships/create/12345.xml/friendships/create/bob.xml |
user_id | The numeric ID of the user. | /friendships/create.xml?user_id=12345 |
screen_name | The screen name of the user. | /friendships/create.xml?screen_name=101010 |
Follow | Enabled following via SMS in addition to become a Twitter follower. | /friendships/create/bob.xml?follow=true |
Have the authenticated user unfollow a specified user.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/friendships/destroy/ | XML, JSON | POST, DELETE | TRUE | FALSE |
Parameter | Description | Examples |
id | The numeric user ID or screen name of the desired user. | /friendships/destroy/12345.xml/friendships/destroy /bob.xml |
user_id | The numeric ID of the user. | /friendships/destroy.xml?user_id=12345 |
screen_name | The screen name of the user. | /friendships/destroy.xml?screen_name=101010 |
Discover if one user follows another user. Returns true or false. If either of the users is protected, you must be authenticated as a user with permission to view that user's tweets.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/friendships/exists | XML, JSON | GET | FALSE | TRUE |
Parameter | Description | Examples |
user_a | The id or screen_name of a user. | /friendships/exists.xml?user_a=dougw&user_b=al3x |
user_b | The id or screen_name of a user whom you want to know if user_a is following. | /friendships/exists.xml?user_a=dougw&user_b=al3x |
Returns the bi-directional following status of two users.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/friendships/show | XML, JSON | GET | FALSE | TRUE |
If you want to compare the following status between the authenticated user and another user, you are only required to supply either the target_id or target_screen_name parameters. Otherwise, you must supply both a source user and a target user.
Parameter | Description | Examples |
source_id | The numeric id of a user. | /friendships/show.xml?source_id=123&target_id=456 |
source_screen_name | The screen_name of a user. | /friendships/show.xml?source_screen_name=bob&target_id=456 |
target_id | The numeric id of another user. | /friendships/show.xml?target_id=456 |
target_screen_name | The screen_name of another user. | /friendships/show.xml?target_screen_name=bob |
notifications/follow
notifications/leave
Have Twitter send the tweets of a specified user the authenticated user's device.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/notifications/follow | XML, JSON | POST | TRUE | FALSE |
Parameter | Description | Examples |
id | The numeric user ID or screen name of the desired user. | /notifications/follow/12345.xml/notifications/follow/bob.xml |
user_id | The numeric ID of the user. | /notifications/follow.xml?user_id=12345 |
screen_name | The screen name of the user. | /notifications/follow.xml?screen_name=101010 |
Have Twitter stop sending the tweets of a specified user to the authenticated user's device.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/notifications/leave | XML, JSON | POST | TRUE | FALSE |
Parameter | Description | Examples |
id | The numeric user ID or screen name of the desired user. | /notifications/leave/12345.xml/notifications/leave/bob.xml |
user_id | The numeric ID of the user. | /notifications/leave.xml?user_id=12345 |
screen_name | The screen name of the user. | /notifications/leave.xml?screen_name=101010 |
oauth/access_token
oauth/authenticate
oauth/authorize
oauth/request_token
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/oauth/access_token | TEXT | POST | FALSE | FALSE |
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/oauth/authorize | NONE | GET | FALSE | FALSE |
saved_searches
saved_searches/create
saved_searches/destroy
saved_searches/show
Get the authenticated user's saved searches.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/saved_searches | XML, JSON | GET | TRUE | TRUE |
Add a search query to the authenticated user's saved searches
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/saved_searches/create | XML, JSON | POST | TRUE | TRUE |
Parameter | Description | Examples |
Query | The search query you want to save. | query=test |
Remove a search query from the authenticated user's saved searches.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/saved_searches/destroy | XML, JSON | POST, DELETE | TRUE | TRUE |
Parameter | Description | Examples |
id | The numeric id of the search to be removed. | /saved_searches/destroy/12345.xml |
Note
As of this writing search methods have a different domain than the rest of the Twitter API. Twitter plans to eventually merge the search API with the rest of the API system.
search
trends
trends/daily
trends/current
trends/weekly
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
| JSON, ATOM | GET | FALSE | TRUE |
Parameter | Description | Examples |
Q | The URL encoded search query to be performed. |
|
callback | The callback function for JSON requests. |
|
Lang | The ISO 639-1 code used to filter tweets by language. |
|
Locale | Used to declare the language of the search query. "ja" is currently the only available value. |
|
Rpp | The desired amount of search results per page less than 100. |
|
Page | Page to retrieve older search results. |
|
Since_id | Returns tweets that are more recent than the id specified. |
|
geocode | Return results in a radius around a latitude and longitude based on the user's geocode location in their profile. The string must be in the form "latitude,longitude,radius" where radius is declared as "mi" (miles) or "km" (kilometers). |
|
Show_user |
|
Get the top ten currently trending search topics.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
| JSON | GET | FALSE | TRUE |
Get the top 20 hourly trending search topics for a given day.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
| JSON | GET | FALSE | TRUE |
Parameter | Description | Examples |
date | Start date in YYYY-MM-DD format. |
|
exclude | Exclude hashtags from the results by setting the value to "hashtags." |
|
Get the top ten current trending search topics.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
| JSON | GET | FALSE | TRUE |
Parameter | Description | Examples |
exclude | Exclude hashtags from the results by setting the value to "hashtags." |
|
Get the top 30 daily trending search topics for a given week.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
| JSON | GET | FALSE | TRUE |
Parameter | Description | Examples |
date | Start date in YYYY-MM-DD format. |
|
exclude | Exclude hashtags from the results by setting the value to "hashtags." |
|
report_spam
Block the specified user for the authenticated user and reports them as spam.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/report_spam | XML, JSON | POST | TRUE | FALSE |
Parameter | Description | Examples |
id | The numeric user ID or screen name of the desired user. | /report_spam/12345.xml/report_spam/bob.xml |
user_id | The numeric ID of the user. | /report_spam.xml?user_id=12345 |
screen_name | The screen name of the user. | /report_spam.xml?screen_name=101010 |
Deletes a specific status update.
You can only delete a status update that belongs to the user you're authenticating with.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/statuses/destroy/ | XML, JSON | POST, DELETE | TRUE | FALSE |
Parameter | Description | Examples |
id | The numeric id of the tweet you want to delete. | /statuses/destroy/12345.xml/statuses/destroy/12345.json |
Retrieves a list of a user's followers and includes their profile details and last tweet. Only retrieves 100 users at a time.
If you request follower data for a protected user, you must authenticate and be allowed to view the protected user.
If you provide no parameters the method will return the follower details for the user you have authenticated with. If you have not authenticated, you must provide a parameter to identify the user whose follower details you want to retrieve.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/statuses/followers | XML, JSON | GET | FALSE | FALSE |
Parameter | Description | Examples |
id | The numeric user ID or screen name of the desired user. | /statuses/followers/12345.xml/statuses/followers/bob.xml |
user_id | The numeric ID of the user. | /statuses/followers.xml?user_id=12345 |
screen_name | The screen name of the user. | /statuses/followers.xml?screen_name=101010 |
cursor | Splits results into pages of a maximum of 100 users. Pass a value of −1 to begin paging. | /statuses/followers/bob.xml?cursor=-1/statuses/followers/bob.xml?cursor=-1300794057949944903 |
Retrieves a list of who the user is following and includes their profile details and last tweet. Only retrieves 100 users at a time.
If you request following data for a protected user, you must authenticate and be allowed to view the protected user.
If you provide no parameters, the method will return the following details for the user you have authenticated with. If you have not authenticated, you must provide a parameter to identify the user whose following details you want to retrieve.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/statuses/friends | XML, JSON | GET | FALSE | FALSE |
Parameter | Description | Examples |
id | The numeric user ID or screen name of the desired user. | /statuses/friends/12345.xml/statuses/friends/bob.xml |
user_id | The numeric ID of the user. | /statuses/friends.xml?user_id=12345 |
screen_name | The screen name of the user. | /statuses/friends.xml?screen_name=101010 |
cursor | Splits results into pages of a maximum of 100 users. Pass a value of −1 to begin paging. | /statuses/friends/bob.xml?cursor=-1/statuses/friends/bob.xml?cursor=1300794057949944903 |
Returns the most recent 20 tweets from people the authenticating user is following and includes tweets from the authenticating user.
Warning
This method is planned to be deprecated and replaced with /statuses/home_timeline.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/statuses/friends_timeline | XML, JSON, RSS, ATOM | GET | TRUE | TRUE |
Parameter | Description | Examples |
Since_id | Returns tweets that are more recent than the id specified. | /statuses/friends_timeline.xml?since_id=12345 |
max_id | Returns tweets that are older than the id specified. | /statuses/friends_timeline.xml?max_id=54321 |
Count | Limits the results to an amount specified that is less than 200. | /statuses/friends_timeline.xml?count=100 |
Page | Page backwards to retrieve older tweets. | /statuses/friends_timeline?page=5 |
Returns the most recent 20 tweets from people the authenticating user is following, including retweets, and tweets from the authenticating user.
This method is the same as /statuses/friends_timeline, except that it includes retweets.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/statuses/home_timeline | XML, JSON, ATOM | GET | TRUE | TRUE |
Parameter | Description | Examples |
Since_id | Returns tweets that are more recent than the id specified. | /statuses/home_timeline.xml?since_id=12345 |
max_id | Returns tweets that are older than the id specified. | /statuses/home_timeline.xml?max_id=54321 |
Count | Limits the results to an amount specified that is less than 200. | /statuses/home_timeline.xml?count=100 |
Page | Page backwards to retrieve older tweets. | /statuses/home_timeline?page=5 |
Returns the most recent 20 tweets that contain the username of the authenticated user.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/statuses/mentions | XML, JSON, RSS, ATOM | GET | TRUE | TRUE |
Parameter | Description | Examples |
Since_id | Returns tweets that are more recent than the id specified. | /statuses/mentions.xml?since_id=12345 |
max_id | Returns tweets that are older than the id specified. | /statuses/mentions.xml?max_id=54321 |
Count | Limits the results to an amount specified that is less than 200. | /statuses/mentions.xml?count=100 |
Page | Page backwards to retrieve older tweets. | /statuses/mentions?page=5 |
Returns the most recent 20 public tweets of users who have a custom profile image. The public timeline is cached and only returns new results every 60 seconds.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/statuses/public_timeline | XML, JSON, RSS, ATOM | GET | FALSE | TRUE |
Retweets a tweet. You must be authenticated as the user who wants to retweet.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/statuses/retweet | XML, JSON | POST, PUT | TRUE | FALSE |
Parameter | Description | Examples |
id | The numerical id of a tweet you want to retweet. | /statuses/retweet/1234.xml |
Get the authenticated user's most recent 20 retweets.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/statuses/retweeted_by_me | XML, JSON, ATOM | GET | TRUE | TRUE |
Parameter | Description | Examples |
Since_id | Returns tweets that are more recent than the id specified. | /statuses/retweeted_by_me.xml?since_id=12345 |
max_id | Returns tweets that are older than the id specified. | /statuses/retweeted_by_me.xml?max_id=54321 |
Count | Limits the results to an amount specified that is less than 200. | /statuses/retweeted_by_me.xml?count=100 |
Page | Page backwards to retrieve older tweets. | /statuses/retweeted_by_me?page=5 |
Get the authenticated user's most recent 20 retweets that have been retweeted.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/statuses/retweeted_of_me | XML, JSON, ATOM | GET | TRUE | TRUE |
Parameter | Description | Examples |
Since_id | Returns tweets that are more recent than the id specified. | /statuses/retweeted_of_me.xml?since_id=12345 |
max_id | Returns tweets that are older than the id specified. | /statuses/retweeted_of_me.xml?max_id=54321 |
Count | Limits the results to an amount specified that is less than 200. | /statuses/retweeted_of_me.xml?count=100 |
Page | Page backwards to retrieve older tweets. | /statuses/retweeted_of_me?page=5 |
Get the authenticated user's friends most recent 20 retweets.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/statuses/retweeted_to_me | XML, JSON, ATOM | GET | TRUE | TRUE |
Parameter | Description | Examples |
Since_id | Returns tweets that are more recent than the id specified. | /statuses/retweeted_to_me.xml?since_id=12345 |
max_id | Returns tweets that are older than the id specified. | /statuses/retweeted_to_me.xml?max_id=54321 |
Count | Limits the results to an amount specified that is less than 200. | /statuses/retweeted_to_me.xml?count=100 |
Page | Page backwards to retrieve older tweets. | /statuses/retweeted_to_me?page=5 |
Get a tweet's most recent 100 retweets.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/statuses/retweets | XML, JSON | GET | TRUE | TRUE |
Parameter | Description | Examples |
id | The numerical id of a tweet you want to retweet. | /statuses/retweets/1234.xml |
Count | Limits the results to an amount specified that is less than 100. | /statuses/retweets/1234.xml?count=4 |
Get the details of a tweet and its author. If an author is protected, the authenticated user must have permission to view that user's tweets.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/statuses/show | XML, JSON | GET | TRUE | TRUE |
Parameter | Description | Examples |
id | The numerical id of a tweet you want details on. | /statuses/show/1234.xml |
Create a new tweet of 140 characters or less for the authenticated user. Duplicate tweets are not allowed. There is an unspecified limit to the amount of status updates a user may tweet per day. If the limit is reached, a 403 HTTP error is returned.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/statuses/update | XML, JSON | POST | TRUE | FALSE |
Parameter | Description | Examples |
Status | The contents of the tweet. Anything over 140 characters is truncated. | status=Hello |
in_reply_to_status_id | The id of a tweet that is being replied to. The new tweet reply must contain the username of the author of the original tweet, or this parameter is ignored. | in_reply_to_status_id=1234 |
Lat | The geographical latitude of the tweet. Must be a valid latitude value between -90.0 and +90.0, the long parameter must be valid, and the user must not have geo_enabled disabled, otherwise this parameter is ignored. | lat=30.4 |
Long | The geographical longitude of the tweet. Must be a valid longitude value between −180.0 and +180.0, the lat parameter must be valid, and the user must not have geo_enabled disabled, otherwise this parameter is ignored. |
Returns the authenticated user's most recent 20 tweets, unless you include an id or screen_name for another user. If you request data for a protected user, the authenticated user must be allowed to view the protected user.
While the id parameter can take either a screen name or numeric user id as a parameter, there are cases when a screen name and numeric user id may conflict. For example, a user's screen name might be 101010. There might also be a numeric user id 101010. For this reason you should use either the user_id or screen_name parameter.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/statuses/user_timeline | XML, JSON, RSS, ATOM | GET | FALSE | TRUE |
Parameter | Description | Examples |
id | The numeric user ID or screen name of the desired user. | /statuses/user_timeline/12345.xml/statuses/user_timeline/bob.xml |
user_id | The numeric ID of the user. | /statuses/user_timeline.xml?user_id=12345 |
screen_name | /statuses/user_timeline.xml?screen_name=101010 | |
Since_id | Returns tweets that are more recent than the id specified. | /statuses/user_timeline.xml?since_id=12345 |
max_id | Returns tweets that are older than the id specified. | /statuses/user_timeline.xml?max_id=54321 |
Count | Limits the results to an amount specified that is less than 200. | /statuses/user_timeline.xml?count=100 |
Page | Page backwards to retrieve older tweets. | /statuses/user_timeline?page=5 |
Returns the profile information for a requested user.
While the id parameter can take either a screen name or numeric user id as a parameter, there are cases when a screen name and numeric user id may conflict. For example, a user's screen name might be 101010. There might also be a numeric user id 101010. For this reason you should use either the user_id or screen_name parameter.
If you request data for a protected user, you must authenticate and be allowed to view the protected user.
Path | Output Formats | HTTP Methods | Authentication | Rate Limited |
/users/show | XML, JSON | GET | FALSE | TRUE |
Parameter | Description | Examples |
id | The numeric user ID or screen name of the desired user. | /users/show/12345.xml/users/show/bob.xml |
user_id | The numeric ID of the user. | /users/show.xml?user_id=12345 |
screen_name | The screen name of the user. | /users/show.xml?screen_name=101010 |