Twikit

A simple API wrapper to interact with twitter's internal API. Read the documentation for more information.

• Documentation (English)
• Async Documentation

Features

No API Key Required

The library uses an unofficial API and therefore does not require an API key.

Completely Free

The service is entirely free to use.

Both Synchronous and Asynchronous Support

Whether you prefer synchronous or asynchronous programming, Twikit supports both, providing flexibility for different use cases.

Functionality

This library allows you to perform various Twitter-related actions, including:

• Create tweets
• Search tweets
• Retrieve trending topics
• etc...

Installing

pip install twikit

Quick Example

Define a client and log in to the account.

from twikit import Client

USERNAME = 'example_user'
EMAIL = 'email@example.com'
PASSWORD = 'password0000'

# Initialize client
client = Client('en-US')
# Login to the service with provided user credentials
client.login(
    auth_info_1=USERNAME ,
    auth_info_2=EMAIL,
    password=PASSWORD
)

Create a tweet with media attached.

# Upload media files and obtain media_ids
media_ids = [
    client.upload_media('media1.jpg', index=0),
    client.upload_media('media2.jpg', index=1)
]
# Create a tweet with the provided text and attached media
client.create_tweet(
    text='Example Tweet',
    media_ids=media_ids
)

For more examples, see example.py. See example_async.py for an example of Async.

Contributing

This project is currently in beta, and we would love to hear your thoughts and suggestions. If you have any features you'd like to see added or encounter any issues, please let us know in the issues section.

Additionally, if you find this library useful, spreading the word by starring it would be greatly appreciated and serve as motivation for further development. Thank you!