Skip to content
Twexapi
English
Esc
↑↓navigate↵open⌘Jpreview
On this page

CLI

Use the TwexAPI CLI for tweet search, follower exports, and terminal public reads.

Use the CLI when you want deterministic terminal commands, JSON output, and saved API-key profiles for TwexAPI REST workflows without writing application code.

twexapi-dev/x-api-scraper-cliCommand-line client for TwexAPI public social data and approved account workflows. Independent third-party service.00
CLI task Command Save
Search tweets x-api-scraper search tweets cursor
Read profile x-api-scraper about screen_name
List followers x-api-scraper followers cursor

Install

npm install -g @twexapi-dev/x-api-scraper-cli
x-api-scraper --help

Requires Node.js 18 or newer.

Source: twexapi-dev/x-api-scraper-cli

Authenticate

Get your API key from the TwexAPI dashboard.

export X_API_SCRAPER_KEY="YOUR_API_KEY"

x-api-scraper auth apps add --name prod --api-key "YOUR_API_KEY"
x-api-scraper auth apps use prod
x-api-scraper --app prod about elonmusk

Basic example

# Lookup users
x-api-scraper --app prod users elonmusk sama

# Search tweets
x-api-scraper --app prod search tweets "founder" "ai" --sort Latest

# List followers (v3)
x-api-scraper --app prod followers elonmusk

# Global trending tweets
x-api-scraper --app prod trending tweets --country "United States" --topic "Sports" --count 50

Raw API requests

Call any TwexAPI path directly:

x-api-scraper --app prod /twitter/elonmusk/about
x-api-scraper --app prod -X POST -d '["elonmusk","sama"]' /twitter/users

Use as a skill

Install from a GitHub skill installer:

npx skills add twexapi-dev/x-api-scraper-cli

Or install from ClawHub:

npx clawhub@latest install x-api-scraper-cli

Security notes

  • The CLI reads X_API_SCRAPER_KEY, X_API_SCRAPER_BASE_URL, and X_API_SCRAPER_CONFIG_DIR from the environment.
  • Saved app configs are stored as plain JSON in ~/.x-api-scraper/config.json by default.
  • Never paste API keys into public chat, logs, or repositories.

References

Was this page helpful?