@elizaos/plugin-twitter

Eliza Twitter/X Client

This package provides Twitter/X integration for the Eliza AI agent using the official Twitter API v2.

🚨 TL;DR - Quick Setup

Just want your bot to post tweets? Here's the fastest path:

1. Get Twitter Developer account → https://developer.twitter.com
2. Create an app → Enable "Read and write" permissions
3. Get OAuth 1.0a credentials (NOT OAuth 2.0!):
   • API Key & Secret (from "Consumer Keys")
   • Access Token & Secret (from "Authentication Tokens")
4. Add to .env:

   TWITTER_API_KEY=xxx
   TWITTER_API_SECRET_KEY=xxx
   TWITTER_ACCESS_TOKEN=xxx
   TWITTER_ACCESS_TOKEN_SECRET=xxx
   TWITTER_ENABLE_POST=true
   TWITTER_POST_IMMEDIATELY=true

5. Run: bun start

⚠️ Common mistake: Using OAuth 2.0 credentials instead of OAuth 1.0a - see Step 3 for details!

Features

• ✅ Autonomous tweet posting with configurable intervals
• ✅ Timeline monitoring and interaction
• ✅ Mention and reply handling
• ✅ Search functionality
• ✅ Direct message support
• ✅ Advanced timeline algorithms with weighted scoring
• ✅ Comprehensive caching system
• ✅ Built-in rate limiting and retry mechanisms
• ✅ Discovery service for autonomous content discovery and growth

Prerequisites

• Twitter Developer Account with API v2 access
• Twitter OAuth 1.0a credentials (NOT OAuth 2.0)
• Node.js and bun installed

🚀 Quick Start

Step 1: Get Twitter Developer Access

1. Apply for a developer account at https://developer.twitter.com
2. Create a new app in the Developer Portal
3. Ensure your app has API v2 access

Step 2: Configure App Permissions for Posting

⚠️ CRITICAL: Default apps can only READ. You must enable WRITE permissions to post tweets!

1. In your app settings, go to "User authentication settings"

2. Configure exactly as shown:

   App permissions: Read and write ✅

   Type of App: Web App, Automated App or Bot

   Required URLs (copy these exactly):

   Callback URI: http://localhost:3000/callback
   Website URL: https://github.com/elizaos/eliza
   

   Optional fields:

   Organization name: ElizaOS
   Organization URL: https://github.com/elizaos/eliza
   

3. Click Save

Step 3: Get the RIGHT Credentials (OAuth 1.0a)

⚠️ IMPORTANT: You need OAuth 1.0a credentials, NOT OAuth 2.0!

In your app's "Keys and tokens" page, you'll see several sections. Here's what to use:

✅ USE THESE (OAuth 1.0a):
┌─────────────────────────────────────────────────┐
│ Consumer Keys                                   │
│ ├─ API Key: xxx...xxx          → TWITTER_API_KEY │
│ └─ API Key Secret: xxx...xxx   → TWITTER_API_SECRET_KEY │
│                                                 │
│ Authentication Tokens                           │
│ ├─ Access Token: xxx...xxx     → TWITTER_ACCESS_TOKEN │
│ └─ Access Token Secret: xxx    → TWITTER_ACCESS_TOKEN_SECRET │
└─────────────────────────────────────────────────┘

❌ DO NOT USE THESE (OAuth 2.0):
┌─────────────────────────────────────────────────┐
│ OAuth 2.0 Client ID and Client Secret          │
│ ├─ Client ID: xxx...xxx        ← IGNORE        │
│ └─ Client Secret: xxx...xxx    ← IGNORE        │
│                                                 │
│ Bearer Token                   ← IGNORE        │
└─────────────────────────────────────────────────┘

After enabling write permissions, you MUST:

1. Click "Regenerate" on Access Token & Secret
2. Copy the NEW tokens (old ones won't have write access)
3. Look for "Created with Read and Write permissions" ✅

Step 4: Configure Environment Variables

Create or edit .env file in your project root:

# REQUIRED: OAuth 1.0a Credentials (from "Consumer Keys" section)
TWITTER_API_KEY=your_api_key_here                    # From "API Key"
TWITTER_API_SECRET_KEY=your_api_key_secret_here      # From "API Key Secret"

# REQUIRED: OAuth 1.0a Tokens (from "Authentication Tokens" section)
TWITTER_ACCESS_TOKEN=your_access_token_here          # Must have "Read and Write"
TWITTER_ACCESS_TOKEN_SECRET=your_token_secret_here   # Regenerate after permission change

# Basic Configuration
TWITTER_DRY_RUN=false              # Set to true to test without posting
TWITTER_ENABLE_POST=true           # Enable autonomous tweet posting

# Optional: Posting Configuration
TWITTER_POST_IMMEDIATELY=true      # Post on startup (great for testing)
TWITTER_POST_INTERVAL=120          # Minutes between posts (default: 120)
# For more natural timing, use MIN/MAX intervals:
TWITTER_POST_INTERVAL_MIN=90       # Minimum minutes between posts  
TWITTER_POST_INTERVAL_MAX=150      # Maximum minutes between posts

Step 5: Run Your Bot

// Your character should include the twitter plugin
const character = {
    // ... other config
    plugins: [
        "@elizaos/plugin-bootstrap",  // Required for content generation
        "@elizaos/plugin-twitter"      // Twitter functionality
    ],
    postExamples: [                    // Examples for tweet generation
        "Just discovered an amazing pattern in the data...",
        "The future of AI is collaborative intelligence",
        // ... more examples
    ]
};

Then start your bot:

bun run start

📋 Complete Configuration Reference

# Required Twitter API v2 Credentials (OAuth 1.0a)
TWITTER_API_KEY=                    # Consumer API Key
TWITTER_API_SECRET_KEY=             # Consumer API Secret
TWITTER_ACCESS_TOKEN=               # Access Token (with write permissions)
TWITTER_ACCESS_TOKEN_SECRET=        # Access Token Secret

# Core Configuration
TWITTER_DRY_RUN=false              # Set to true for testing without posting
TWITTER_TARGET_USERS=              # Comma-separated usernames to target (use "*" for all)
TWITTER_RETRY_LIMIT=5              # Maximum retry attempts for failed operations

# Feature Toggles
TWITTER_ENABLE_POST=false          # Enable autonomous tweet posting
TWITTER_ENABLE_REPLIES=true        # Enable mention and reply handling
TWITTER_ENABLE_ACTIONS=false       # Enable timeline actions (likes, retweets, quotes)
TWITTER_ENABLE_DISCOVERY=          # Enable discovery service (defaults to true if ACTIONS enabled)

# Timing Configuration (all in minutes)
# For natural behavior, set MIN/MAX intervals - the agent will randomly choose between them
# If MIN/MAX not set, falls back to the fixed interval values

# Post intervals
TWITTER_POST_INTERVAL=120          # Fixed interval between posts (default: 120, used if MIN/MAX not set)
TWITTER_POST_INTERVAL_MIN=90       # Minimum minutes between posts (default: 90)
TWITTER_POST_INTERVAL_MAX=150      # Maximum minutes between posts (default: 150)

# Engagement intervals  
TWITTER_ENGAGEMENT_INTERVAL=30     # Fixed interval for interactions (default: 30, used if MIN/MAX not set)
TWITTER_ENGAGEMENT_INTERVAL_MIN=20 # Minimum minutes between engagements (default: 20)
TWITTER_ENGAGEMENT_INTERVAL_MAX=40 # Maximum minutes between engagements (default: 40)

# Discovery intervals
TWITTER_DISCOVERY_INTERVAL_MIN=15  # Minimum minutes between discovery cycles (default: 15)
TWITTER_DISCOVERY_INTERVAL_MAX=30  # Maximum minutes between discovery cycles (default: 30)

# Engagement Limits
TWITTER_MAX_ENGAGEMENTS_PER_RUN=5  # Maximum interactions per engagement cycle (default: 5)
TWITTER_MAX_TWEET_LENGTH=280       # Maximum tweet length

# Discovery Service Settings
TWITTER_MIN_FOLLOWER_COUNT=100     # Minimum followers for accounts to follow
TWITTER_MAX_FOLLOWS_PER_CYCLE=5    # Maximum accounts to follow per discovery cycle

🔍 Discovery Service

The Twitter Discovery Service enables autonomous content discovery and engagement, helping your agent build a following and interact with relevant content on Twitter.

Overview

The discovery service autonomously:

• Searches for content related to your agent's topics
• Identifies high-quality accounts to follow
• Engages with relevant tweets through likes, replies, and quotes
• Builds up your agent's timeline by following interesting accounts

Configuration

# Enable discovery service (defaults to true if TWITTER_ENABLE_ACTIONS=true)
TWITTER_ENABLE_DISCOVERY=true

# Discovery interval in minutes (default: 30)
TWITTER_DISCOVERY_INTERVAL=30

# Minimum follower count for accounts to follow (default: 100)
TWITTER_MIN_FOLLOWER_COUNT=100

# Maximum accounts to follow per cycle (default: 5)
TWITTER_MAX_FOLLOWS_PER_CYCLE=5

# Maximum engagements per cycle (default: 10)
TWITTER_MAX_ENGAGEMENTS_PER_RUN=10

How It Works

1. Content Discovery: Searches for tweets containing your agent's topics
2. Account Scoring: Scores accounts based on quality (follower count) and relevance
3. Tweet Scoring: Scores tweets for engagement based on relevance:
   • Like: score > 0.6
   • Reply: score > 0.8
   • Quote: score > 0.85
4. Memory System: Tracks engaged tweets and followed accounts to avoid duplicates

Character Configuration

The discovery service uses your agent's character configuration:

{
  "name": "YourAgent",
  "topics": [
    "artificial intelligence",
    "machine learning",
    "web3",
    "blockchain"
  ],
  "bio": "AI researcher interested in decentralized systems"
}

If topics aren't specified, the service extracts them from the bio.

🎯 Common Use Cases

Just Want to Post Tweets?

# Minimal setup for posting only
TWITTER_API_KEY=xxx
TWITTER_API_SECRET_KEY=xxx
TWITTER_ACCESS_TOKEN=xxx        # Must have write permissions!
TWITTER_ACCESS_TOKEN_SECRET=xxx

TWITTER_ENABLE_POST=true
TWITTER_POST_IMMEDIATELY=true   # Great for testing
TWITTER_ENABLE_REPLIES=false    # Disable interactions
TWITTER_ENABLE_ACTIONS=false    # Disable timeline actions

Want Full Interaction Bot?

# Full interaction setup
TWITTER_API_KEY=xxx
TWITTER_API_SECRET_KEY=xxx
TWITTER_ACCESS_TOKEN=xxx
TWITTER_ACCESS_TOKEN_SECRET=xxx

TWITTER_ENABLE_POST=true
TWITTER_ENABLE_REPLIES=true
TWITTER_ENABLE_ACTIONS=true      # Enables likes, retweets, quotes
TWITTER_ENABLE_DISCOVERY=true    # Enables growth features

Testing Without Posting?

# Dry run mode
TWITTER_DRY_RUN=true            # Simulates all actions
TWITTER_ENABLE_POST=true
TWITTER_POST_IMMEDIATELY=true

🚨 Troubleshooting

403 Errors When Engaging with Tweets

If you see errors like "Failed to create tweet: Request failed with code 403", this usually means:

1. Missing Write Permissions: Make sure your Twitter app has "Read and write" permissions

   • Go to your app settings in the Twitter Developer Portal
   • Check that App permissions shows "Read and write" ✅
   • If not, change it and regenerate your Access Token & Secret

2. Protected Accounts: The bot may be trying to engage with protected/private accounts

   • The plugin now automatically skips these with a warning

3. Self-Engagement: Trying to reply to or quote your own tweets

   • Twitter API doesn't allow this and returns 403

4. Account Restrictions: Your account may have restrictions

   • Check if your account is in good standing
   • Ensure you're not violating Twitter's automation rules

The plugin will now:

• Automatically detect and skip 403 errors with a warning
• Continue processing other tweets
• Mark failed tweets as "skip" to avoid retrying

Other Common Issues

"403 Forbidden" When Posting

This is the #1 issue! Your app has read-only permissions.

Solution:

1. Go to app settings → "User authentication settings"
2. Change to "Read and write"
3. Save settings
4. CRITICAL: Regenerate your Access Token & Secret
5. Update .env with NEW tokens
6. Restart your bot

How to verify: In "Keys and tokens", your Access Token should show "Created with Read and Write permissions"

"Could not authenticate you"

Wrong credentials or using OAuth 2.0 instead of OAuth 1.0a.

Solution:

• Use credentials from "Consumer Keys" section (API Key/Secret)
• Use credentials from "Authentication Tokens" section (Access Token/Secret)
• Do NOT use OAuth 2.0 Client ID, Client Secret, or Bearer Token

Bot Not Posting Automatically

Checklist:

• ✅ Is TWITTER_ENABLE_POST=true?
• ✅ Is @elizaos/plugin-bootstrap installed?
• ✅ Does your character have postExamples?
• ✅ Check logs for "Twitter posting is ENABLED"
• ✅ Try TWITTER_POST_IMMEDIATELY=true for testing

Timeline Not Loading

Common causes:

• Rate limiting (check Twitter Developer Portal)
• Invalid credentials
• Account restrictions

"Invalid or expired token"

Your tokens may have been revoked or regenerated.

Solution:

1. Go to Twitter Developer Portal
2. Regenerate all tokens
3. Update .env
4. Restart bot

📚 Advanced Features

Timeline Processing

The plugin supports two main approaches:

• Timeline Actions: Process home timeline for likes, retweets, and quotes
• Targeted Interactions: Reply to mentions and specific users

Target User Configuration

# Interact with everyone (default)
TWITTER_TARGET_USERS=

# Interact with specific users only
TWITTER_TARGET_USERS=user1,user2,user3

# Interact with everyone (explicit)
TWITTER_TARGET_USERS=*

Natural Posting Intervals

The plugin adds variance to all intervals for more human-like behavior:

• Post intervals vary by ±20% by default
• Discovery intervals vary by ±10 minutes
• Engagement intervals vary based on activity

Request Queue & Rate Limiting

The plugin includes sophisticated rate limiting:

• Automatic retry with exponential backoff
• Request queue to prevent API abuse
• Configurable retry limits
• Built-in caching to reduce API calls

🧪 Development & Testing

# Run tests
bun test

# Run with debug logging  
DEBUG=eliza:* bun start

# Test without posting
TWITTER_DRY_RUN=true bun start

Testing Checklist

1. Test Auth: Check logs for successful Twitter login
2. Test Posting: Set TWITTER_POST_IMMEDIATELY=true
3. Test Dry Run: Use TWITTER_DRY_RUN=true first
4. Monitor Logs: Look for "Twitter posting is ENABLED"

🔒 Security Best Practices

• Store credentials in .env file (never commit!)
• Use .env.local for local development
• Regularly rotate API keys
• Monitor API usage in Developer Portal
• Enable only necessary permissions
• Review Twitter's automation rules

📊 API Usage & Limits

This plugin uses Twitter API v2 endpoints efficiently:

• Home Timeline: Cached and refreshed periodically
• Tweet Creation: Rate limited automatically
• User Lookups: Cached to reduce calls
• Search: Configurable intervals

Monitor your usage at: https://developer.twitter.com/en/portal/dashboard

📖 Additional Resources

• Twitter API v2 Documentation
• Twitter OAuth 1.0a Guide
• Rate Limits Reference
• ElizaOS Documentation

🤝 Contributing

Contributions are welcome! Please:

1. Check existing issues first
2. Follow the code style
3. Add tests for new features
4. Update documentation

📝 License

This plugin is part of the ElizaOS project. See the main repository for license information.