Skip to content

Getting Started

Welcome to Xeepy! This guide will take you from zero to automating X/Twitter in under 5 minutes.

What You'll Learn

  • Installation

    Install Xeepy and its dependencies with a single command

    Install Guide

  • Quick Start

    Run your first scraping script in under 2 minutes

    Quick Start

  • Authentication

    Learn how to authenticate without API keys

    Auth Guide

  • Configuration

    Customize Xeepy for your use case

    Config Guide

  • First Script

    Build a complete automation workflow

    First Script

The 60-Second Version

# Install Xeepy
pip install xeepy

# Install browser
playwright install chromium

# Run your first scrape
xeepy scrape replies https://x.com/elonmusk/status/123456789

That's it! You're now scraping X/Twitter without paying for API access.

Prerequisites

Requirement Version Why
Python 3.10+ Modern async/await support
Playwright Latest Browser automation engine
Chromium Auto-installed Browser for scraping

No API Keys Required

Unlike Tweepy or the official Twitter API, Xeepy uses browser automation. This means:

  • ✅ No $100/month API fees
  • ✅ No rate limit anxiety
  • ✅ No approval process
  • ✅ Access to all features

Learning Path

graph LR
    A[Install] --> B[Authenticate]
    B --> C[First Scrape]
    C --> D[Export Data]
    D --> E[Advanced]

    style A fill:#1da1f2
    style B fill:#1da1f2
    style C fill:#1da1f2
    style D fill:#1da1f2
    style E fill:#1da1f2
  1. Installation - Get Xeepy running (2 min)
  2. Authentication - Set up your session (3 min)
  3. Quick Start - Run example scripts (5 min)
  4. First Script - Build something useful (10 min)
  5. Configuration - Customize behavior (optional)

Choose Your Path

Perfect! Jump straight to the Scraping Guide.

from xeepy import Xeepy

async with Xeepy() as x:
    # Get 1000 replies to any tweet
    replies = await x.scrape.replies(tweet_url, limit=1000)
    x.export.to_csv(replies, "replies.csv")

Check out our Growth Automation Cookbook.

async with Xeepy() as x:
    # Unfollow non-followers, follow by hashtag
    await x.unfollow.non_followers(max_unfollows=100)
    await x.follow.by_hashtag("#buildinpublic", limit=50)

Head to the Analytics Guide.

async with Xeepy() as x:
    # Track growth, find best posting times
    growth = await x.analytics.track_growth("7d")
    best_times = await x.analytics.best_time_to_post()

Explore AI Features.

from xeepy.ai import ContentGenerator

ai = ContentGenerator(provider="openai")
reply = await ai.generate_reply(tweet_text, style="witty")

Need Help?

Ready? Let's install Xeepy →