The My Tweeple API provides programmatic access to your My Tweeple data. An API Key and API Secret are required. Locate your key and secret under Tools»Settings in the My Tweeple application.
Related: Generating the API Signature
Method: Sync Request
URL: http://api.mytweeple.com/1.0/sync_request/Purpose: Update My Tweeple with a request to sync data for all people associated with an API Key. This is just a request. The sync is managed by My Tweeple. Use the lastupdate method to determine if the sync is complete.
Format: XML
HTTP Method: GET
Parameters:
apikey (required): My Tweeple API Key.
apisig (required): Method signature created using the My Tweeple API Secret.
nonce (optional): A uniquely-generated string.
apisig (required): Method signature created using the My Tweeple API Secret.
nonce (optional): A uniquely-generated string.
Return Values:
status: success, if the call is
successful.
Sample response:
<?xml version="1.0" encoding="UTF-8"?>
<response><status>success</status></response>
Method: Last Update
URL: http://api.mytweeple.com/1.0/lastupdate/Purpose: Retrieves the date and time of the latest sync between My Tweeple and Twitter for this API Key.
Format: XML
HTTP Method: GET
Parameters:
apikey (required): My Tweeple API Key.
apisig (required): Method signature created using the My Tweeple API Secret.
nonce (optional): A uniquely-generated string.
apisig (required): Method signature created using the My Tweeple API Secret.
nonce (optional): A uniquely-generated string.
Return Values:
lastupdate: Date and Time of the last
sync.
status: success, if the call is successful.
status: success, if the call is successful.
Sample response:
<?xml version="1.0" encoding="UTF-8"?>
<response><lastupdate>2009-02-27T12:12:22 00:00</lastupdate>
<status>success</status></response>
Method: Pages
URL: http://api.mytweeple.com/1.0/pages/Purpose: Retrieves the number of pages that were generated during the last sync. Use this number to determine how many pages to download.
Format: XML
HTTP Method: GET
Parameters:
apikey (required): My Tweeple API Key.
apisig (required): Method signature created using the My Tweeple API Secret.
nonce (optional): A uniquely-generated string.
apisig (required): Method signature created using the My Tweeple API Secret.
nonce (optional): A uniquely-generated string.
Return Values:
pages: The total number of pages
available for download for this API Key.
status: success, if the call is successful.
status: success, if the call is successful.
Sample response:
<?xml version="1.0" encoding="UTF-8"?>
<response><pages>7</pages>
<status>success</status></response>
Method: Download
URL: http://api.mytweeple.com/1.0/download/Purpose: Retrieves information for all of the people related to this APIKey (owner, friends, and followers). Each page contains a maximum of 500 people.
Format: XML
HTTP Method: GET
Parameters:
apikey (required): My Tweeple API Key.
apisig (required): Method signature created using the My Tweeple API Secret.
page (required): The page number to download. Retrieve the total number of pages using the Pages method.
nonce (optional): A uniquely-generated string.
Return Values:apisig (required): Method signature created using the My Tweeple API Secret.
page (required): The page number to download. Retrieve the total number of pages using the Pages method.
nonce (optional): A uniquely-generated string.
id: Twitter id.
name: The person's name.
screen_name: Twitter username.
url: A url specified in the Twitter profile.
location: The location that is entered in the Twitter profile.
description: The user's Twitter description.
profile_image_url: Profile picture.
followers_count: Number of Twitter followers.
friends_count: Number of people this person is following.
status_count: Number of Tweets.
last_update: Last date and time this person tweeted.
created_at: Date the account was created.
friend_order: Order in which this person was followed.
follower_order: Order in which this person became a follower.
relationship: 1 = Follower, 2 = You Follow (but they are not following back), 3 = It's Mutual
tags: Private tags.
public_tags: Public tags.
notes: Notes
phone: Phone number, if allowed.
skype: Skype address, if allowed.
email: Email, if allowed.
Sample response:name: The person's name.
screen_name: Twitter username.
url: A url specified in the Twitter profile.
location: The location that is entered in the Twitter profile.
description: The user's Twitter description.
profile_image_url: Profile picture.
followers_count: Number of Twitter followers.
friends_count: Number of people this person is following.
status_count: Number of Tweets.
last_update: Last date and time this person tweeted.
created_at: Date the account was created.
friend_order: Order in which this person was followed.
follower_order: Order in which this person became a follower.
relationship: 1 = Follower, 2 = You Follow (but they are not following back), 3 = It's Mutual
tags: Private tags.
public_tags: Public tags.
notes: Notes
phone: Phone number, if allowed.
skype: Skype address, if allowed.
email: Email, if allowed.
<?xml version="1.0" encoding="UTF-8"?>
<users>
<user>
<id>662763</id>
<name>Todd Defren</name>
<screen_name>TDefren</screen_name>
<url>http://www.pr-squared.com</url>
<location>Boston and/or S.F.</location>
<description>Principal at SHIFT Communications, http://www.shiftcomm.com</description>
<profile_image_url>http://a1.twimg.com/profile_images/364473724/Copy_of_smirky1_normal.jpg</profile_image_url>
<followers_count>15497</followers_count>
<friends_count>2197</friends_count>
<status_count>11977</status_count>
<last_update>2010-05-27T00:00:00</last_update>
<created_at>2010-01-31T00:00:00</created_at>
<friend_order>3</friend_order>
<follower_order>2574</follower_order>
<relationship>3</relationship>
<tags></tags>
<public_tags></public_tags>
<notes></notes>
<phone></phone>
<skype></skype>
<email></email>
</user>
...
</users>
Method: Get
URL: http://api.mytweeple.com/1.0/get/Purpose: Retrieves information for up to 20 people who have a relationship with the "owner."
Format: XML
HTTP Method: GET
Parameters:
apikey (required): My Tweeple API Key.
apisig (required): Method signature created using the My Tweeple API Secret.
owner_screen_name (required): The Twitter screen name who owns the relationship with the people in the screen name list.
screen_name_list (required): A comma-separated list of Twitter screen names. Each person must follow or be followed by the owner (max 20).
nonce (optional): A uniquely-generated string.
Return Values:apisig (required): Method signature created using the My Tweeple API Secret.
owner_screen_name (required): The Twitter screen name who owns the relationship with the people in the screen name list.
screen_name_list (required): A comma-separated list of Twitter screen names. Each person must follow or be followed by the owner (max 20).
nonce (optional): A uniquely-generated string.
id: Twitter id.
name: The person's name.
screen_name: Twitter username.
url: A url specified in the Twitter profile.
location: The location that is entered in the Twitter profile.
description: The user's Twitter description.
profile_image_url: Profile picture.
followers_count: Number of Twitter followers.
friends_count: Number of people this person is following.
status_count: Number of Tweets.
last_update: Last date and time this person tweeted.
created_at: Date the account was created.
friend_order: Order in which this person was followed.
follower_order: Order in which this person became a follower.
relationship: 1 = Follower, 2 = You Follow (but they are not following back), 3 = It's Mutual
tags: Private tags.
public_tags: Public tags.
notes: Notes
phone: Phone number, if allowed.
skype: Skype address, if allowed.
email: Email, if allowed.
Sample response:name: The person's name.
screen_name: Twitter username.
url: A url specified in the Twitter profile.
location: The location that is entered in the Twitter profile.
description: The user's Twitter description.
profile_image_url: Profile picture.
followers_count: Number of Twitter followers.
friends_count: Number of people this person is following.
status_count: Number of Tweets.
last_update: Last date and time this person tweeted.
created_at: Date the account was created.
friend_order: Order in which this person was followed.
follower_order: Order in which this person became a follower.
relationship: 1 = Follower, 2 = You Follow (but they are not following back), 3 = It's Mutual
tags: Private tags.
public_tags: Public tags.
notes: Notes
phone: Phone number, if allowed.
skype: Skype address, if allowed.
email: Email, if allowed.
<?xml version="1.0" encoding="UTF-8"?>
<users>
<user>
<id>662763</id>
<name>Todd Defren</name>
<screen_name>TDefren</screen_name>
<url>http://www.pr-squared.com</url>
<location>Boston and/or S.F.</location>
<description>Principal at SHIFT Communications, http://www.shiftcomm.com</description>
<profile_image_url>http://a1.twimg.com/profile_images/364473724/Copy_of_smirky1_normal.jpg</profile_image_url>
<followers_count>15497</followers_count>
<friends_count>2197</friends_count>
<status_count>11977</status_count>
<last_update>2010-05-27T00:00:00</last_update>
<created_at>2010-01-31T00:00:00</created_at>
<friend_order>3</friend_order>
<follower_order>2574</follower_order>
<relationship>3</relationship>
<tags></tags>
<public_tags></public_tags>
<notes></notes>
<phone></phone>
<skype></skype>
<email></email>
</user>
...
</users>
Method: Update
URL: http://api.mytweeple.com/1.0/update/Purpose: Update the tags, public tags, and notes for one person.
Format: XML
HTTP Method: POST
Parameters:
apikey (required): My Tweeple API Key.
apisig (required): Method signature created using the My Tweeple API Secret.
owner_screen_name (required): The Twitter screen name who owns the relationship with the person listed in the screen name parameter.
screen_name (required): The Twitter screen name of the person to which the tags, public tags and notes apply.
tags (required): Private tags. A comma-separated list. 30 characters per tag. Limit of 10 tags.
ptags (required): Pubic tags. A comma-separated list. 30 characters per tag. Limit of 10 tags.
notes (required): Private notes. 255 characters.
nonce (optional) A uniquely-generated string.
apisig (required): Method signature created using the My Tweeple API Secret.
owner_screen_name (required): The Twitter screen name who owns the relationship with the person listed in the screen name parameter.
screen_name (required): The Twitter screen name of the person to which the tags, public tags and notes apply.
tags (required): Private tags. A comma-separated list. 30 characters per tag. Limit of 10 tags.
ptags (required): Pubic tags. A comma-separated list. 30 characters per tag. Limit of 10 tags.
notes (required): Private notes. 255 characters.
nonce (optional) A uniquely-generated string.
Return Values:
status: success, if the call is successful.
Sample response:
<?xml version="1.0" encoding="UTF-8"?>
<response><status>success</status></response>Errors
Expect an HTTP response code of 200 even if an error occurs. Look for an error response by inspecting the returned XML.
Return Values:
status: error
message: Message describing the error.
message: Message describing the error.
Sample error:
<?xml version="1.0" encoding="utf-8" ?>
<response><status>Error</status>
<message>Invalid Signature.</message></response>Feedback
E-mail support@whitleymedia.com with questions or suggestions.