Method #1
is_user
Description
Checks whether the given user is a MrTweet user.
URL
http://api.mrtweet.com/v1/is_user/:username/:api_key.:format
http://api.mrtweet.com/v1/is_user/:username/:api_key/:callback.json
Formats
xml, json (jsonp when 'callback' is given)
Examples
GET /v1/is_user/bob/aabbccddeeff.xml
<?xml version="1.0" encoding="UTF-8"?><response><status>success</status><is_user>true</is_user></response>
GET /v1/is_user/bob/aabbccddeeff.json
{"status":"success","is_user":true}
GET /v1/is_user/bob/aabbccddeeff/handleJson.json
handleJson({"status":"success","is_user":true});
Method #2
profile
Description
Returns MrTweet statistics of the given user
URL
http://api.mrtweet.com/v1/profile/:username/:api_key.:format
http://api.mrtweet.com/v1/profile/:username/:api_key/:callback.json
Formats
xml, json (jsonp when 'callback' is given)
Examples
GET /v1/profile/bob/aabbccddeeff.xml
<?xml version="1.0" encoding="UTF-8"?><response><status>success</status><profile><conversation_percentile>71</conversation_percentile><links>0.555556</links><links_percentile>88</links_percentile><conversation>0.383838</conversation><frequency>2.41315</frequency><frequency_percentile>68</frequency_percentile><recommendations>7</recommendations></profile></response>
GET /v1/profile/bob/aabbccddeeff.json
{"status":"success","profile":{"conversation_percentile":71,"links":0.555556,"links_percentile":88,"conversation":0.383838,"frequency":2.41315,"frequency_percentile":68,"recommendations":7}}
GET /v1/profile/bob/aabbccddeeff/handleJson.json
handleJson({"status":"success","profile":{"conversation_percentile":71,"links":0.555556,"links_percentile":88,"conversation":0.383838,"frequency":2.41315,"frequency_percentile":68,"recommendations":7}});
Method #3
recommendations
Description
Returns the latest recommendations the given user received on MrTweet
URL
http://api.mrtweet.com/v1/recommendations/:username/:api_key.:format
http://api.mrtweet.com/v1/recommendations/:username/:api_key/:callback.json
Formats
xml, json (jsonp when 'callback' is given)
Examples
GET /v1/recommendations/bob/aabbccddeeff.xml
<?xml version="1.0" encoding="UTF-8"?><response><status>success</status><recommendations><recommendation><text>Lorem ipsum dolor sit amet.</text><date>2009-09-08T11:45:00-07:00</date><name>joe<name></recommendation><recommendation><text>Lorem ipsum dolor sit amet.</text><date>2009-09-04T00:11:57-07:00</date><name>karl<name></recommendation><recommendation><text>Lorem ipsum dolor sit amet.</text><date>2009-09-02T09:40:42-07:00</date><name>peter<name></recommendation><recommendation><text>Lorem ipsum dolor sit amet.</text><date>2009-03-27T18:34:07Z</date><name>michael<name></recommendation><recommendation><text>Lorem ipsum dolor sit amet.</text><date>2009-02-08T16:48:10Z</date><name>tom<name></recommendation></recommendations></response>
GET /v1/recommendations/bob/aabbccddeeff.json
{"status":"success","recommendations":[{"text":"Lorem ipsum dolor sit amet.","date":"2009-09-08T11:45:00-07:00","name":"joe"},
{"text":"Lorem ipsum dolor sit amet.","date":"2009-09-04T00:11:57-07:00","name":"karl"},
{"text":"Lorem ipsum dolor sit amet.","date":"2009-09-02T09:40:42-07:00","name":"peter"},
{"text":"Lorem ipsum dolor sit amet.","date":"2009-03-27T18:34:07Z","name":"michael"},
{"text":"Lorem ipsum dolor sit amet.","date":"2009-02-08T16:48:10Z","name":"tom"}]}
GET /v1/recommendations/bob/aabbccddeeff/handleJson.json
handleJson({"status":"success","recommendations":[{"text":"Lorem ipsum dolor sit amet.","date":"2009-09-08T11:45:00-07:00","name":"joe"},
{"text":"Lorem ipsum dolor sit amet.","date":"2009-09-04T00:11:57-07:00","name":"karl"},
{"text":"Lorem ipsum dolor sit amet.","date":"2009-09-02T09:40:42-07:00","name":"peter"},
{"text":"Lorem ipsum dolor sit amet.","date":"2009-03-27T18:34:07Z","name":"michael"},
{"text":"Lorem ipsum dolor sit amet.","date":"2009-02-08T16:48:10Z","name":"tom"}]});
Method #4
suggestions
Description
Returns the current MrTweet suggestions (as twitter user id's) for the given user.
NOTE: Contact us for access to this restricted API.
URL
http://api.mrtweet.com/v1/suggestions/:username/:api_key.:format
http://api.mrtweet.com/v1/suggestions/:username/:api_key/:callback.json
Formats
xml, json (jsonp when 'callback' is given)
Examples
GET /v1/suggestions/bob/aabbccddeeff.xml
<?xml version="1.0" encoding="UTF-8"?><response><status>success</status><updated_at>Tue, 22 Dec 2009 06:07:32 +0000</updated_at><suggestions><name>12345<name><name>67890<name><name>111213<name><name>141516<name><name>171819<name><name>202122<name></suggestions></response>
GET /v1/suggestions/bob/aabbccddeeff.json
{"status":"success","updated_at":"Tue, 22 Dec 2009 06:07:32 +0000","suggestions":[12345,67890,111213,141516,171819,202122]}
GET /v1/suggestions/bob/aabbccddeeff/handleJson.json
handleJson({"status":"success","updated_at":"Tue, 22 Dec 2009 06:07:32 +0000","suggestions":[12345,67890,111213,141516,171819,202122]});
Method #5
most_attention_towards
Description
Returns the twitter_id's of 3 users that for the given user pays the most attention to
URL
http://api.mrtweet.com/v1/most_attention_towards/:username/:api_key.:format
http://api.mrtweet.com/v1/most_attention_towards/:username/:api_key/:callback.json
Formats
xml, json (jsonp when 'callback' is given)
Examples
GET /v1/most_attention_towards/bob/aabbccddeeff.xml
<?xml version="1.0" encoding="UTF-8"?><response><status>success</status><most_attention_towards><name>joe<name><name>karl<name><name>peter<name></most_attention_towards></response>
GET /v1/most_attention_towards/bob/aabbccddeeff.json
{"status":"success","most_attention_towards":[14474225,12069702,3161041]}
GET /v1/most_attention_towards/bob/aabbccddeeff/handleJson.json
handleJson({"status":"success","most_attention_towards":[14474225,12069702,3161041]});
Method #6
recommend
Description
Creates a recommendation from the given user, to another user (aka "friend_name")
NOTE: Use HTTP POST
NOTE: Contact us for access to this restricted API.
URL
http://api.mrtweet.com/v1/recommend/:username/:api_key.:format
http://api.mrtweet.com/v1/recommend/:username/:api_key/:callback.json
POST params
reason=:reason&friend_name=:friend_name
Formats
xml, json (jsonp when 'callback' is given)
Examples
POST /v1/recommend/bob/aabbccddeeff.xml
reason=Lorem+ipsum+dolor+sit+amet.&friend_name=joe
<?xml version="1.0" encoding="UTF-8"?><response><status>success</status></response>
POST /v1/recommend/bob/aabbccddeeff.json
reason=Lorem+ipsum+dolor+sit+amet.&friend_name=joe
{"status":"success"}
POST /v1/recommend/bob/aabbccddeeff/handleJson.json
reason=Lorem+ipsum+dolor+sit+amet.&friend_name=joe
handleJson({"status":"success"});
Method #7
community_users
Description
Returns the current members (as twitter user id's) of the given community.
NOTE: Contact us for access to this restricted API.
URL
http://api.mrtweet.com/v1/community_users/:community_name/:api_key.:format
http://api.mrtweet.com/v1/community_users/:community_name/:api_key/:callback.json
Formats
xml, json (jsonp when 'callback' is given)
Examples
GET /v1/community_users/klingons/aabbccddeeff.xml
<?xml version="1.0" encoding="UTF-8"?><response><status>success</status><community_users><name>joe<name><name>karl<name><name>peter<name><name>michael<name><name>tom<name><name>charlie<name></community_users><updated_at>Sat, 10 Oct 2009 21:09:52 +0000</updated_at></response>
GET /v1/community_users/klingons/aabbccddeeff.json
{"status":"success","community_users":[19028281,19071093,24725380,20690429,15258318,14289197,16233111,18897717,19067915,18906915,27117306,24636272,19292878,44906914,16143603,23458288,15237322,19668443,19226847,15259057,13097772,16917849,37754010,21425073,15186722,24082318,1125191,14186299,21341158,36374439,20284749,24177119,19751093,17514619,21644272,20278700,24415019,22993551,18250504,26848511,20786098,20534044,15586501,27018344,25819996,27876905,28560275,30841475,17356095,35131869,17228171,17872297,22021200,23162422,24793120,38666506,18140464,17564512,15050811,20256352,17339290,20669161,14273403,41142165,7194242,18635058,44667274,42952347,17312620,14345108,14226624,17849355,18451244,19937800,19907117,18959528,28645170,63984163,24007381,35700404,35024210,16365944,19122712,21489024,59020799,16903064,17795052,21148206,39841684,34943045,26976410,20943699,18811261,14302347,41901343,28399358,16745216,17227924,21394278,54496742,30047936,21805172,13705062,34012544,29801962,31794165,74754175,28165912,27404190,7829932,19802164,24692979,14749575,17142669,54974001,17786069,18457664,41117550,18764818,32584714,18221502,23239027,40946284,22003252,14789216,19250173,14727420,32040814,16129284,20718172,25745197,19652892,36038254,53221310,28187313,24252063,14795384,29928946,17781640,29728412,29791799,19497354,35299019,29514202,54661514,43817063,21678613,36685229,28920097,45446809,25717698,39578206,22647050,35333833,21412211,24738026,21415085,37979767,37580551,26597472,19653041,9572792,21728781,15777208,18451735,36366486,38193851,26276020,35732523,20048120,58469555,19676424,38675149,19364849,18016591,42701953,53715510,46183115,17759164,44157139,20804883,21727889,55963,24239581,28174571,21605840,16388188,15025813,18783524,25322422,16915918,28505700,23172730,25347088,40670106,21519187,33986746,47190838,28294522,27040007,26636094,25440483,16506568,27848408,14091313,20482884,64716820,16528737,14324597,23925415,33830214,30998223,22955931,63397062,15416611,48109726,49636241,22484974,16581970,16637298,46640791,19035276,18125295,17883083,34862522,21462104,34241217,33528346,14286996,30372177,26924238,19371806,19179110,15850724,22810738,62553556,19236219,15765742,21998725,14155992,21503408,19244318,32149230,22381176,36787993,15201442,20417279,24331742,1464661,14769432,44186568,76072596,29872549,15837520,62650062,39818915,24224237,21298692,19043418,20959963,21204560,34358762,8610992,12399842,47743366,55656979,36168745,24619155,24595820,38564328,15280665,34470573,23135171,39994029,38725709,74860600,28203098,16069209,19621151,30522148,14136766,21622007,14883770,37818718,19164008,19521840,29124810,44897428,33641914,47462236,16373935,23923375,26021993,14185472,27001160,8226172,16745285,15791727,14342845,27407112,25576940,16739902,37682996,25363590,10776682,14588959,25859143,14823469,16154132,43175845,39569626,15138418,24696977,29930309,37482220,20515953,18454757,66397472,20599467,44551314,17813953,26911598,22528086,17952604,21230533,28600377,20589072,66717938,19621746,16831484,32255296,26788699,17299433,19239944,17450522,21696731,14124760,24896250,32473018,40901518,42152726,24834144,29495409,19342177,20581816,28372133,27148977,17792022,17706758,41456777,15049561,26700639,62532727,61953614,21049565,16519093,20503283,15322814,15792044,14483548,28347886,20586920,21397946,15502377,24683888,63398161,15359492,15323840,15699712,23841832,14583359,14504896,45386853,23016011,25245867,16668568,24233716,28588537,22807357,15908105,18335617,20665681,51192085,19550463,50031779,33328619,14678661,29443439,47070666,61354775,20671527,26162073,19781367,34683160,14717031,37921401,27775176,36092795,23808329,15077088,24188470,21726923,16134177,20404768,21207120,39984820,23449994,19432765,26485952,53091057,20865485,40667026,24298442,65520610,32473363,24952539,35158208,19912979,39499631,36473108,60954563,17635150,33977786,56847062,16730138,29778954,20820551,47336935,16312492,19307799,23233247,67374654,14606595,53203487,48625731,30965067,60672871,21366912,44874305,20223152,69254656,35787614,29846936,19655384,15549785,41427126,16916390,54564193,45714464,24244797,24087737,15497390,51044930,15670139,18320052,23337870,41144497,54286293,33666014,16973594,39301279,23234447,22152697,22750405,59263908,29753807,19309936,26076057,23240046,22402738,24841259,23117973,29635808,55407417,26544620,29408724,18456258,70462382,21087414,24536593,39539952,17141886,17187106,20857912,7764562,41067723,23783801,14819286,29971211,40653734,15790995,66230218,50742942,9785702,29134790,29025455,15519715,53460019,28915392,22036964],"updated_at":"Sat, 10 Oct 2009 21:09:52 +0000"}
GET /v1/community_users/klingons/aabbccddeeff/handleJson.json
handleJson({"status":"success","community_users":[19028281,19071093,24725380,20690429,15258318,14289197,16233111,18897717,19067915,18906915,27117306,24636272,19292878,44906914,16143603,23458288,15237322,19668443,19226847,15259057,13097772,16917849,37754010,21425073,15186722,24082318,1125191,14186299,21341158,36374439,20284749,24177119,19751093,17514619,21644272,20278700,24415019,22993551,18250504,26848511,20786098,20534044,15586501,27018344,25819996,27876905,28560275,30841475,17356095,35131869,17228171,17872297,22021200,23162422,24793120,38666506,18140464,17564512,15050811,20256352,17339290,20669161,14273403,41142165,7194242,18635058,44667274,42952347,17312620,14345108,14226624,17849355,18451244,19937800,19907117,18959528,28645170,63984163,24007381,35700404,35024210,16365944,19122712,21489024,59020799,16903064,17795052,21148206,39841684,34943045,26976410,20943699,18811261,14302347,41901343,28399358,16745216,17227924,21394278,54496742,30047936,21805172,13705062,34012544,29801962,31794165,74754175,28165912,27404190,7829932,19802164,24692979,14749575,17142669,54974001,17786069,18457664,41117550,18764818,32584714,18221502,23239027,40946284,22003252,14789216,19250173,14727420,32040814,16129284,20718172,25745197,19652892,36038254,53221310,28187313,24252063,14795384,29928946,17781640,29728412,29791799,19497354,35299019,29514202,54661514,43817063,21678613,36685229,28920097,45446809,25717698,39578206,22647050,35333833,21412211,24738026,21415085,37979767,37580551,26597472,19653041,9572792,21728781,15777208,18451735,36366486,38193851,26276020,35732523,20048120,58469555,19676424,38675149,19364849,18016591,42701953,53715510,46183115,17759164,44157139,20804883,21727889,55963,24239581,28174571,21605840,16388188,15025813,18783524,25322422,16915918,28505700,23172730,25347088,40670106,21519187,33986746,47190838,28294522,27040007,26636094,25440483,16506568,27848408,14091313,20482884,64716820,16528737,14324597,23925415,33830214,30998223,22955931,63397062,15416611,48109726,49636241,22484974,16581970,16637298,46640791,19035276,18125295,17883083,34862522,21462104,34241217,33528346,14286996,30372177,26924238,19371806,19179110,15850724,22810738,62553556,19236219,15765742,21998725,14155992,21503408,19244318,32149230,22381176,36787993,15201442,20417279,24331742,1464661,14769432,44186568,76072596,29872549,15837520,62650062,39818915,24224237,21298692,19043418,20959963,21204560,34358762,8610992,12399842,47743366,55656979,36168745,24619155,24595820,38564328,15280665,34470573,23135171,39994029,38725709,74860600,28203098,16069209,19621151,30522148,14136766,21622007,14883770,37818718,19164008,19521840,29124810,44897428,33641914,47462236,16373935,23923375,26021993,14185472,27001160,8226172,16745285,15791727,14342845,27407112,25576940,16739902,37682996,25363590,10776682,14588959,25859143,14823469,16154132,43175845,39569626,15138418,24696977,29930309,37482220,20515953,18454757,66397472,20599467,44551314,17813953,26911598,22528086,17952604,21230533,28600377,20589072,66717938,19621746,16831484,32255296,26788699,17299433,19239944,17450522,21696731,14124760,24896250,32473018,40901518,42152726,24834144,29495409,19342177,20581816,28372133,27148977,17792022,17706758,41456777,15049561,26700639,62532727,61953614,21049565,16519093,20503283,15322814,15792044,14483548,28347886,20586920,21397946,15502377,24683888,63398161,15359492,15323840,15699712,23841832,14583359,14504896,45386853,23016011,25245867,16668568,24233716,28588537,22807357,15908105,18335617,20665681,51192085,19550463,50031779,33328619,14678661,29443439,47070666,61354775,20671527,26162073,19781367,34683160,14717031,37921401,27775176,36092795,23808329,15077088,24188470,21726923,16134177,20404768,21207120,39984820,23449994,19432765,26485952,53091057,20865485,40667026,24298442,65520610,32473363,24952539,35158208,19912979,39499631,36473108,60954563,17635150,33977786,56847062,16730138,29778954,20820551,47336935,16312492,19307799,23233247,67374654,14606595,53203487,48625731,30965067,60672871,21366912,44874305,20223152,69254656,35787614,29846936,19655384,15549785,41427126,16916390,54564193,45714464,24244797,24087737,15497390,51044930,15670139,18320052,23337870,41144497,54286293,33666014,16973594,39301279,23234447,22152697,22750405,59263908,29753807,19309936,26076057,23240046,22402738,24841259,23117973,29635808,55407417,26544620,29408724,18456258,70462382,21087414,24536593,39539952,17141886,17187106,20857912,7764562,41067723,23783801,14819286,29971211,40653734,15790995,66230218,50742942,9785702,29134790,29025455,15519715,53460019,28915392,22036964],"updated_at":"Sat, 10 Oct 2009 21:09:52 +0000"});
Method #8
community_suggestions
Description
Returns the current MrTweet suggestions (as twitter user id's) for the given community.
NOTE: Contact us for access to this restricted API.
URL
http://api.mrtweet.com/v1/community_suggestions/:community_name/:api_key.:format
http://api.mrtweet.com/v1/community_suggestions/:community_name/:api_key/:callback.json
Formats
xml, json (jsonp when 'callback' is given)
Examples
GET /v1/community_suggestions/klingons/aabbccddeeff.xml
<?xml version="1.0" encoding="UTF-8"?><response><status>success</status><community_suggestions></community_suggestions><updated_at>Sat, 10 Oct 2009 21:09:52 +0000</updated_at></response>
GET /v1/community_suggestions/klingons/aabbccddeeff.json
{"status":"success","community_suggestions":[],"updated_at":"Sat, 10 Oct 2009 21:09:52 +0000"}
GET /v1/community_suggestions/klingons/aabbccddeeff/handleJson.json
handleJson({"status":"success","community_suggestions":[],"updated_at":"Sat, 10 Oct 2009 21:09:52 +0000"});