API
We provide a simple API to allow for our users to leverage the power of the Twapper Keeper archiving routines on their own site or for analysis. If you would like an API key, please contact us at support@twapperkeeper.com and ask!
notebook info
http://api.twapperkeeper.com/notebook/info/?apikey=xxxx&type=xxxx&name=xxxx&namelike=xxxx&desclike=xxxx
GET parmaters
apikey [required], type (hashtag, keyword, person, collection, person-collection) [optional], name [optional], namelike [optional], desclike [optional]
example - notebook info for #iran hashtag notebook
http://api.twapperkeeper.com/notebook/info/?apikey=xxxx&type=hashtag&name=iran
example - notebook for all notebooks with iran in the name
http://api.twapperkeeper.com/notebook/info/?apikey=xxxx&namelike=iran
tweets within notebook - VERSION 1
http://api.twapperkeeper.com/notebook/tweets/?apikey=xxxx&name=xxxxx&type=xxxx&start=0000000000&end=1266825684
GET parameters
apikey [required], type (hashtag, keyword, person, collection, person-collection) [required], name [required], start date (unix time) [required], end date (unix time) [required]
limit returned per call is 10,000 tweets
example w/ Version 1 - tweets within #iran hashtag notebook from beginning to Feb 22, 2010
http://api.twapperkeeper.com/notebook/tweets/?apikey=xxxx&name=iran&type=hashtag&start=0&end=1266825684
tweets within notebook - VERSION 2
http://api.twapperkeeper.com/2/notebook/tweets/?apikey=xxxx&name=xxxxx&type=xxxx[&optional parameters]
GET parmaters
apikey [required]
type (hashtag, keyword, person, collection, person-collection) [required]
name [required]
lang [optional - ISO-639-1 2 letter code included in tweet metadata]
max_id [optional - maximum twitter id]
since_id [optional - minimum twitter id]
since [optional - start date - format = YY-MM-DD]
until [optional - end date - format = YY-MM-DD]
order_by [optional - a = ascending, d = descending (default)]
nort [optional set to 1 to remove all tweets starting with RT, default = 0]
text [optional - tweet text to search for]
from_user [optional - twitter username of sender]
latitude | longitude | radius [optional - must include each parameters individually - radius in km]
rpp = results per page [optional - but default set to 10, max allowed = 1000]
page [optional - default = 1]
example w/ Version 2 - page 1 of tweets (results per page = 10) within #jisc hashtag from 2010-01-01 to 201
0-06-01 within a 1000 km radius of lat = 51, long = 0 with language = en
http://api.twapperkeeper.com/2/notebook/tweets/?apikey=xxx&name=jisc&type=hashtag&start=2010-01-01&end=2010-06-1&lat=51&long=0&rad=1000&rpp=10&page=1
create a notebook
http://api.twapperkeeper.com/notebook/create/?apikey=xxxxx&name=abcdefg&type=hashtag&description=This is a test.&created_by=jobrieniii&user_id=1234
POST arguments
apikey [required], type (hashtag, keyword, person, collection, person-collection) [required], name [required], tags[optional], created_by [required], description [required], n1,n2,n3,n4,n5 [notebook 1,2,3,4,5 - only for type collection or person-collection - collections must have at least one archive - and do not mix together person and hashtag / keyword archives or errors will occur!]
example - create hashtag notebook abcdefg
http://api.twapperkeeper.com/notebook/create/
$_POST -> apikey=xxx&name=abcdefg&type=hashtag&description=This is a test.&created_by=@jobrieniii&user_id=1234
*notes*
At this time the apikey must be passed for each call.
All output is in JSON format.
All JSON output includes {status} [0 = error, 1 = success], {message} [success or error message from twapperkeeper api], and {response} which includes the output from the call.
Notebook info and tweets API calls look for arguments in GET, while notebook create looks for arguments in the POST
