Application Programming Interface

Welcome to the Tweet Scan API page.

The API provides search results for Twitter or identi.ca in RSS or JSON formats.

Get a Badge

Put a live badge on your site like the one to the right. Just replace {your search here} with your search phrase.

<div id="tweetscan_list"></div><script type='text/javascript' src='http://tweetscan.com/badge.js'></script><script type='text/javascript' src='http://tweetscan.com/json.php?ak=LyO02i&s={your search here}'></script>

Also, grab this example CSS:

/* Tweet Scan badge */
#ts_badge {
  background: #DFD;
  border: 1px solid black;
  padding:6px;
  width: 200px;
  font-family: Helvetica;
}

#ts_title {
 font-size: 16px;
}

#ts_badge li {
  list-style:none;
}

#ts_badge ul {
 margin:0; 
 padding:0;
}


#ts_time {
 color: #999;
 font-size: 10px;
}

#ts_tweet {
  font-size: 12px;
  padding:3px;
}

#ts_credit {
 margin: 0px;
 padding: 0px;
 font-size:10px;
 text-align:center; 
}

Raw Data Access

You can access the data itself in JSON or RSS formats.

For RSS build a url that looks like this:

http://tweetscan.com/rss.php?s={your search phrase}

This will return 20 results in RSS format. For 100 results add "&n=100" to the end of the above URL.

For JSON use this url:

http://tweetscan.com/json.php?ak=LyO02i&s={your search phrase}

This will return 5 results by default but to get 20 results add "&n=20" to the end.

identi.ca results are available by adding "&src=id" to either the RSS or JSON request urls

For example, http://tweetscan.com/json.php?ak=LyO02i&src=id&s=fun+search is what's displayed in the badge on the right.

Terms of use

On the badge, we appreciate your leaving the link to Tweet Scan visible.
If you use the RSS, we request that you have a link back to Tweet Scan at http://tweetscan.com or purchase a membership to show your support for this site.
If you're expecting more than 2,000 hits a day or you have a suggestion or comment, send us an email.