XActions — API Reference

Complete function reference for the xactions npm package.

npm install xactions

Table of Contents

• Quick Start
• Core Functions
• Scraper Functions
• Manager Modules
• MCP Server
• CLI Commands
• Browser Scripts
• Types

Core Functions

createBrowser(options?)

Launch a Puppeteer browser with stealth mode enabled (avoids bot detection).

Parameters:

Returns: Promise<Browser>

// Headless (default)
const browser = await createBrowser();

// With visible browser
const browser = await createBrowser({ headless: false });

// With proxy
const browser = await createBrowser({ proxy: 'http://user:pass@proxy:8080' });

createPage(browser)

Create a new page with stealth anti-detection configured.

Parameters:

Returns: Promise<Page>

Scraper Functions

scrapeProfile(page, username)

Get a user's full profile data.

Parameters:

Returns: Promise<Profile>

const profile = await scrapeProfile(page, 'nichxbt');
// {
//   name: 'nich',
//   username: 'nichxbt',
//   bio: '...',
//   followers: 1234,
//   following: 567,
//   tweets: 890,
//   verified: false,
//   location: '...',
//   website: '...',
//   joinDate: '...',
//   avatar: 'https://...',
//   header: 'https://...'
// }

scrapeFollowers(page, username, options?)

Get a list of accounts that follow a user.

Parameters:

Returns: Promise<User[]>

const followers = await scrapeFollowers(page, 'nichxbt', { limit: 500 });
followers.forEach(f => console.log(`@${f.username} — ${f.bio}`));

scrapeFollowing(page, username, options?)

Get a list of accounts a user follows.

Parameters: Same as scrapeFollowers

Returns: Promise<User[]>

scrapeTweets(page, username, options?)

Get a user's recent tweets.

Parameters:

Returns: Promise<Tweet[]>

const tweets = await scrapeTweets(page, 'nichxbt', { limit: 50 });
tweets.forEach(t => console.log(`${t.likes}❤️ ${t.text.slice(0, 80)}`));

searchTweets(page, query, options?)

Search for tweets matching a query.

Parameters:

Returns: Promise<Tweet[]>

// Basic search
const tweets = await searchTweets(page, 'xactions', { limit: 100 });

// Advanced search operators
const viral = await searchTweets(page, 'AI tools min_faves:1000 lang:en', { limit: 50 });

downloadVideo(page, tweetUrl)

Extract video download URLs from a tweet.

Returns: Promise<VideoResult>

const video = await downloadVideo(page, 'https://x.com/user/status/123456');
console.log(video.variants[0].url); // Direct MP4 URL

exportBookmarks(page, options?)

Export your saved bookmarks.

Returns: Promise<Bookmark[]>

unrollThread(page, tweetUrl)

Unroll a thread into a single readable document.

Returns: Promise<Thread>

const thread = await unrollThread(page, 'https://x.com/user/status/123456');
console.log(`Thread by @${thread.author}: ${thread.totalTweets} tweets`);
console.log(thread.text); // Full thread as text

Manager Modules

Manager modules are higher-level Puppeteer-based automation tools.

import { dmManager, profileManager, engagementManager } from 'xactions';

MCP Server

49+ tools for AI agent integration. See MCP Server docs.

# Start MCP server
node src/mcp/server.js

# Or via npx
npx xactions-mcp

Claude Desktop config:

{
  "mcpServers": {
    "xactions": {
      "command": "npx",
      "args": ["-y", "xactions", "--mcp"],
      "env": {
        "XACTIONS_MODE": "local"
      }
    }
  }
}

CLI Commands

npm install -g xactions

Common flags:

• --limit N — Maximum items
• --format json|csv — Output format
• --output file.json — Save to file

Browser Scripts

50+ scripts for pasting in the DevTools console. Listed via:

import { browserScripts } from 'xactions';
console.log(Object.keys(browserScripts));

See the full catalog in the README.

Types

TypeScript declarations are included at types/index.d.ts.

import type { Profile, User, Tweet, Thread, VideoResult } from 'xactions';

See types/index.d.ts for all interfaces.