Skip to main content

​
Platform Subcommands

The CLI organizes commands by platform. Each platform exposes the same tools available through the MCP server and SDKs.
SubcommandPlatformExample tools
twitterTwitter/Xget_user, search_posts, get_post_comments, get_user_connections
instagramInstagramget_user, search_posts, get_post_comments, search_users
redditRedditget_user, search_posts, search_comments, get_subreddit
tiktokTikTokget_user, search_posts, get_posts_by_hashtags, get_post_comments
trackingCross-platformadd_tracked_items, get_tracked_items, remove_tracked_items
Commands are dynamically generated from the Python SDK via reflection. When new tools are added to the platform, they appear in the CLI automatically.

​
Command Discovery

Use --help at any level to explore available commands and parameters: 
# List all platforms
xpoz-cli --help

# List commands for a platform
xpoz-cli twitter --help

# Show parameters for a specific command
xpoz-cli twitter search_posts --help

​
Global Flags

These flags work with any command:
FlagEnvironment VariableDefaultDescription
--api-key KEYXPOZ_API_KEYStored configOverride the stored access key
--server-url URLXPOZ_SERVER_URLhttps://mcp.xpoz.ai/mcpCustom MCP server endpoint
--output json|pretty—jsonOutput format
--all-pages—OffAutomatically walk through all pages
--max-pages N——Safety cap when using --all-pages
--page N——Jump to a specific page
--export-csv-url—OffReturn a CSV download URL instead of rows
--timeout SECS—300Operation timeout in seconds

​
Examples

​
Twitter

# Look up a user profile
xpoz-cli twitter get_user --identifier elonmusk

# Search posts with boolean operators and date range
xpoz-cli twitter search_posts --query '"AI" AND ethics' --start-date 2025-01-01 --limit 20

# Get replies to a post
xpoz-cli twitter get_post_comments --post-id 1234567890

​
Instagram

# Look up a user profile
xpoz-cli instagram get_user --identifier natgeo

# Search posts by keyword
xpoz-cli instagram search_posts --query "street photography" --limit 10

​
Reddit

# Search posts in a specific subreddit, sorted by top of the month
xpoz-cli reddit search_posts --query "python tutorial" --subreddit learnpython --sort top --time month

# Paginate through all results
xpoz-cli reddit search_posts --query "python tutorial" --subreddit learnpython --all-pages

​
TikTok

# Look up a user profile
xpoz-cli tiktok get_user --identifier charlidamelio

# Search posts by hashtag
xpoz-cli tiktok get_posts_by_hashtags --hashtags "cooking,recipe" --limit 20

​
Tracking

# Add a keyword to track across platforms
xpoz-cli tracking add_tracked_items --keywords "artificial intelligence"

# List all tracked items
xpoz-cli tracking get_tracked_items

​
Output Formatting

By default, the CLI outputs raw JSON. Use --output pretty for human-readable formatting: 
xpoz-cli twitter get_user --identifier elonmusk

{"id":"123","username":"elonmusk","name":"Elon Musk","followersCount":200000000}
Pipe JSON output to jq for advanced filtering and transformation: xpoz-cli twitter search_posts --query "AI" | jq '.data[].text'

​
Pagination

Search commands return paginated results (100 items per page). You have three options for navigating pages:
StrategyFlagUse case
Walk all pages--all-pagesCollect the full result set
Capped walk--all-pages --max-pages 5Collect up to N pages as a safety limit
Jump to page--page 3Resume or inspect a specific page
# Get all pages of results
xpoz-cli reddit search_posts --query "machine learning" --all-pages

# Limit to 10 pages max
xpoz-cli reddit search_posts --query "machine learning" --all-pages --max-pages 10

# Jump directly to page 5
xpoz-cli reddit search_posts --query "machine learning" --page 5
When using --all-pages on broad queries, set --max-pages to avoid unexpectedly large result sets. Each page consumes one call.

​
CSV Export

Use --export-csv-url to get a download URL for the full result set as a CSV file, hosted on S3. This is useful for bulk data collection and analysis in spreadsheet tools. 
xpoz-cli twitter search_posts --query bitcoin --export-csv-url
The command returns a URL instead of JSON rows. The CSV file includes all fields and all matching results. For more details on CSV exports, see the CSV Exports guide.

​
Next Steps

Authentication

Manage your access key and auth credentials.

Query Syntax

Write effective search queries with boolean operators and phrases.