Introduction

Minimal Python wrapper for Twitter’s REST and Streaming APIs

The principle behind TwitterAPI’s design is to provide a single method for accessing the Twitter API. The request method allows one to call any endpoint found on Twitter’s developer site, the complete reference for all endpoints. The benefits of a single-method approach are: 1) less code for me to maintain, and 2) a single method for you to learn. Here is a quck example:

from TwitterAPI import TwitterAPI
api = TwitterAPI(consumer_key, consumer_secret, access_token_key, access_token_secret)
r = api.request('search/tweets', {'q':'pizza'})
print r.status_code

Get Twitter’s entire response as one long string containing tweets (in this example) by calling r.text. More often an iterator is useful:

for item in r.get_iterator():
    print item['user']['screen_name'], item['text']

The iterator returns JSON objects. What makes the iterator very powerful is it works with both REST API and Streaming API endpoints. No syntax changes required – supply any endpoint and parameters that are found on Twitter’s developer site.

TwitterAPI is compatible with Python 2 and Python 3. It authenticates using either OAauth 1 or OAuth 2. It also supports web proxy server authentication. All this with minimal code change for you.

Topics

• Authentication
• Paging Results
• Error Handling
• Fault Tolerant Streams and Pages
• Tiny Examples

Modules

• TwitterAPI.TwitterAPI
• TwitterAPI.TwitterError

Optional:

• TwitterAPI.TwitterPager
• TwitterAPI.TwitterOAuth