TwitterAPI.TwitterAPI

class TwitterAPI.TwitterAPI.TwitterAPI(consumer_key=None, consumer_secret=None, access_token_key=None, access_token_secret=None, auth_type='oAuth1', proxy_url=None)

Access REST API or Streaming API resources.

Parameters:
  • consumer_key – Twitter application consumer key
  • consumer_secret – Twitter application consumer secret
  • access_token_key – Twitter application access token key
  • access_token_secret – Twitter application access token secret
  • auth_type – “oAuth1” (default) or “oAuth2”
  • proxy_url – HTTPS proxy URL (ex. “https://USER:PASSWORD@SERVER:PORT”)
request(resource, params=None, files=None, method_override=None)

Request a Twitter REST API or Streaming API resource.

Parameters:
  • resource – A valid Twitter endpoint (ex. “search/tweets”)
  • params – Dictionary with endpoint parameters or None (default)
  • files – Dictionary with multipart-encoded file or None (default)
  • method_override – Request method to override or None (default)
Returns:

TwitterResponse
Raises:

TwitterConnectionError
class TwitterAPI.TwitterAPI.TwitterResponse(response, stream)

Response from either a REST API or Streaming API resource call.

Parameters:
  • response – The requests.Response object returned by the API call
  • stream – Boolean connection type (True if a streaming connection)
close()

Disconnect stream (blocks with Python 3).

get_iterator()

Get API dependent iterator.

Returns:Iterator for tweets or other message objects in response.
Raises:TwitterConnectionError, TwitterRequestError
get_rest_quota()

Quota information in the REST-only response header.

Returns:Dictionary of ‘remaining’ (count), ‘limit’ (count), ‘reset’ (time)
headers
Returns:Dictionary of API response header contents.
json(**kwargs)

Get the response as a JSON object.

Parameters:**kwargs – Optional arguments that json.loads takes.
Returns:response as JSON object.
Raises:ValueError
status_code
Returns:HTTP response status code.
text
Returns:Raw API response text.