This package provides a Twitter client that bypasses the need for official API keys, enabling users to scrape tweets, send tweets, retweets, polls, and interact with Grok directly through Twitter's interface. It's designed for developers and researchers who need programmatic access to Twitter data and functionality without the constraints or costs of the official API.

How It Works

The client operates by mimicking browser interactions and leveraging cached cookies for authentication, effectively scraping Twitter's web interface. This approach allows it to perform actions like sending tweets and polls without requiring API credentials. For advanced features like polls and Grok integration, it utilizes Twitter API v2 credentials, but the core scraping functionality remains API-key-free.

Quick Start & Requirements

• Primary install: npm install agent-twitter-client
• Authentication: Requires Twitter username, password, and email. API v2 credentials are needed for polls. A proxy is recommended for browser environments.
• Setup: Configure environment variables for authentication. Cookie management is crucial for efficient operation.
• Docs: https://github.com/elizaOS/agent-twitter-client

Highlighted Details

• API-key-free scraping and posting.
• Direct programmatic access to Grok, including real-time Twitter data analysis.
• Supports sending tweets with images (JPG, PNG, GIF) and single videos (MP4).
• Enables creating polls and fetching detailed tweet data with expansions.

Maintenance & Community

The project is maintained by elizaOS. Further community or roadmap information is not detailed in the README.

Licensing & Compatibility

The README does not explicitly state a license. Compatibility for commercial use or closed-source linking is not specified.

Limitations & Caveats

Grok integration has rate limits (25 messages/2 hours for non-premium) and message history prefilling is limited due to unofficial API usage. The project relies on scraping Twitter's web interface, which is subject to change and potential breakage if Twitter modifies its site structure.