*Work in Progress

Complete implementation of the undocumented Twitter API

• Includes twitter search, scraper, and automation library.

Installation

pip install twitter-api-client

Automation

from twitter.main import *
from twitter.login import login

usr, pwd = ..., ...
session = login(usr, pwd)


r = create_poll('test poll', ['hello', 'world', 'foo', 'bar'], 10080, session)

# DM 1 user
r = dm('hello world', [123], session, filename='test.png')

# DM group of users
r = dm('foo bar', [123, 456, 789], session, filename='test.mp4')

# create tweet with images, videos, gifs, and tagged users
r = tweet('test 123', session, media=[{'file': 'image.jpeg', 'tagged_users': [123234345456], 'alt': 'some image'}])
r = tweet('test 123', session, media=['test.jpg', 'test.png'])
r = tweet('test 123', session, media=['test.mp4'])
r = tweet('test 123', session)

# delete tweet
r = untweet(123, session)

r = retweet(1633609779745820675, session)
r = unretweet(1633609779745820675, session)

r = quote('test 123', 'elonmusk', 1633609779745820675, session)
r = comment('test 123', 1633609779745820675, session)

r = unlike(1633609779745820675, session)
r = like(1633609779745820675, session)

r = follow(50393960, session)
r = unfollow(50393960, session)

r = mute(50393960, session)
r = unmute(50393960, session)

r = enable_notifications(50393960, session)
r = disable_notifications(50393960, session)

r = block(50393960, session)
r = unblock(50393960, session)

r = bookmark(1633609779745820675, session)
r = unbookmark(1633609779745820675, session)

r = pin(1635479755364651008, session)
r = unpin(1635479755364651008, session)

r = stats(50393960, session)

# update profile
update_profile_image('profile.jpg', session)
update_profile_banner('banner.jpg', session)
update_profile_info(session, name='Foo Bar', description='Test 123', location='Victoria, BC')

Scraping

User/Tweet data

from twitter.scrape import *
from twitter.login import login

usr, pwd = ..., ...
session = login(usr, pwd)

user_ids = [...]
usernames = [...]
tweet_ids = [...]

######### User Data ########
users = get_user_by_screen_name(usernames, session)
tweets = get_user_tweets(user_ids, session)
likes = get_likes(user_ids, session)
tweets_and_replies = get_tweets_and_replies(user_ids, session)
media = get_media(user_ids, session)
following = get_following(user_ids, session)
followers = get_followers(user_ids, session)

######### Tweet Data ########
tweet = get_tweet_by_rest_id(tweet_ids, session)
tweet_detail = get_tweets(tweet_ids, session)
retweeters = get_retweeters(tweet_ids, session)
favoriters = get_favoriters(tweet_ids, session)

######### Media (Images/Videos) ########
download_media(tweet_ids, session)

Search

from twitter.search import search

search(
    '(#dogs OR #cats) min_retweets:500',
    'min_faves:10000 @elonmusk until:2023-02-16 since:2023-02-01',
    'brasil portugal -argentina',
    'paperswithcode -tensorflow -tf',
    'skateboarding baseball guitar',
    'cheese bread butter',
    'ios android',
)

• search results are output to ~/data/raw
• ~400 search results rate limiting occurs

Search Operators Reference

https://developer.twitter.com/en/docs/twitter-api/v1/rules-and-filtering/search-operators

https://developer.twitter.com/en/docs/twitter-api/tweets/search/integrate/build-a-query