X Bot Commands

Basic Commands

`/start`

Initialize the bot and show welcome message. In groups, displays basic running status. In private messages, provides bot setup guidance with option to add the bot to new groups.

In groups, shows "X Bot is running" message. In private chat, shows welcome message with "Add to Group" button.

Parameters

None

`/help`

Purpose: Display available bot commands. Shows different command sets based on whether the user is a group administrator or regular user.

Parameters

None

X Bot Subscription Commands

`/buy`

To buy X Bot Pro Edition, start calling /buy command in the group you want to upgrade X Bot version:

Execute /buy in your group chat
Bot checks if group already has PRO license
Bot sends you a private message with "Check X Bot DM" button
Click the button or go to your private chat with the bot
Use /buy command again in private chat
Bot provides Stripe checkout link for payment
Complete payment on Stripe website
Return to group - PRO features are now active!

Parameters:

None

`/subscription`

Access Stripe customer portal for subscription management including billing history, payment methods, and cancellation options.

Execute /subscription in your group chat
Bot verifies group has PRO license and you're the owner
Bot sends you a private message with "Check X Bot DM" button
Click the button or go to your private chat with the bot
Use /subscription command again in private chat
Bot provides Stripe customer portal link
Access your billing, payment methods, and cancellation options

You must have active PRO subscription and be the subscription owner user to access the subscription portal.

Parameters

None

X Content Monitoring

`/set_x_filtering`

Set up monitoring filters for X (Twitter) content that will be tracked and included in reports.

You can set multiples filters! Setting the proper filters is key, and may become complex if you're tracking multiple projects and X users. Please contact support anytime if you need support (https://www.bws.ninja/marketplace/telegram-xbot or https://t.me/BlockchainWebServices).

Parameters

filter_name (required) - Unique alphanumeric identifier (only letters, numbers, underscore)
filtering_options (required) - One or more filter options using supported keywords

Supported filter keywords:

from:@username1,@username2 - Monitor posts from specific users (comma-separated)
keywords:keyword1,keyword2 - Monitor posts containing keywords (comma-separated)
mention:@username1,@username2 - Monitor posts mentioning specific users (comma-separated)
exclude:retweet,quote,reply - Exclude specific post types (comma-separated)
ignore:@username1,@username2 - Ignore posts from specific users (comma-separated)

Examples

/set_x_filtering my_kols from:@CryptoHayes,@IncomeSharks keywords:BWS,crypto mention:@BWSCommunity
/set_x_filtering project_mentions mention:@MyProject keywords:MyProjectToken
/set_x_filtering crypto_discussions keywords:DeFi,crypto,blockchain exclude:retweet
/set_x_filtering clean_feed from:@leader1,@leader2 ignore:@spammer1,@spammer2

`/get_x_filtering`

Retrieve and display all currently configured X monitoring filters for the group.

Parameters

None

`/delete_x_filtering`

Delete specific X monitoring filters or all filters for the group.

Parameters

filter_identifier (required) - Specific filter name to delete, or "*" to delete all filters

Examples

/delete_x_filtering my_kols_1
/delete_x_filtering *

Schedule Management

`/set_schedule`

Set a specific time of day (in UTC) for when reports should be automatically generated.

Parameters:

time (required) - Time in HH:MM format (24-hour, UTC timezone)

Examples

/set_schedule 12:30
/set_schedule 21:25

`/get_schedule`

Retrieve and display the current scheduled time for automatic report generation.

Parameters

None

`/delete_schedule`

Remove the configured daily schedule for automatic report generation.

Deleting the schedule will effectively stop the bot from running - for example, in case you want to temporarely disable the leaderboard.

Parameters

None

Calendar Management

/set_calendar

Purpose: Configure the start date and cadence (period) for report generation. Sets up a calendar-based schedule that determines when reports are automatically generated.

Parameters:

start_date (required) - Date in DD/MM/YYYY format
cadence (required) - Period in "Ndays" format (e.g., "7days", "14days")

Requirements: Group administrator privileges

Examples:

/set_calendar 20/06/2025 7days
/set_calendar 01/12/2025 2days

`/get_calendar`

Retrieve and display the current calendar configuration including start date and cadence for report generation.

Parameters

None

Points and Scoring

`/set_points`

Set the scoring multipliers for engagement metrics (Likes, Retweets, Replies, Quotes, Views) used in leaderboard calculations.

Parameters

likes (required) - Points awarded per like (positive number, can be decimal)
retweets (required) - Points awarded per retweet
replies (required) - Points awarded per reply
quotes (required) - Points awarded per quote
views (required) - Points awarded per view

Example

/set_points 5 1 20 10 0.01

`/get_points`

Retrieve and display the current points multiplier configuration.

Parameters

None

Visual Customization

`/set_colors`

Set the HTML colors for displaying engagement metrics in the leaderboard reports.

Parameters

likes (required) - HTML hex color for likes display (e.g., #FF0000)
retweets (required) - HTML hex color for retweets display
replies (required) - HTML hex color for replies display
quotes (required) - HTML hex color for quotes display
views (required) - HTML hex color for views display

Example

/set_colors #536352 #536354 #536351 #536357 #536359

`/get_colors`

Retrieve and display the current color configuration for engagement metrics.

Parameters

None

`/set_top_title`

Set the title and color for the main leaderboard section in reports.

Parameters

title (required) - Title text for the leaderboard section
color (required) - HTML hex color for the title

Example

/set_top_title "🏆 Top Performers" #FF0000

/set_best_title

Set the title and color for the best tweet section in reports.

Parameters:

title (required) - Title text for the best tweet section
color (required) - HTML hex color for the title

Example:

/set_best_title "✨ Best Tweet" #00FF00

`/set_engagement_title`

Set the title and color for the engagement scoring section in reports.

Parameters:

title (required) - Title text for the engagement section
color (required) - HTML hex color for the title

Example:

/set_engagement_title "📊 Engagement Stats" #0000FF

`/get_titles`

Retrieve and display the current title configurations for all report sections.

Parameters:

None

Topic Management

`/set_topic`

Set the topic to show the reports (for Telegram groups with multiple topics).

Parameters:

None (topic is automatically detected from the current topic thread where the command is executed)

Requirements:

Group administrator privileges
Must be executed within a topic thread

`/get_topic`

Purpose: Retrieve and display the current topic configuration for reports.

Parameters: None

Leaderboard Configuration

`/set_top_count`

Set the number of top users to display in the leaderboard.

Parameters:

count (required) - Number of top users to show (positive integer)

Example:

/set_top_count 10

`/get_top_count`

Retrieve and display the current top count setting for the leaderboard.

Parameters:

None

Report Operations

`/recreate`

Force creation of a new report immediately. Can optionally delete existing reports and tweet history.

Parameters:

--delete-history (optional) - Flag to delete existing reports and tweets before creating new one

Examples:

/recreate
/recreate --delete-history

What happens:

Bot validates your admin permissions and configurations
If --delete-history used, bot clears existing report data from storage
Bot starts background tweet fetching process using your filters
Bot processes and analyzes collected tweets
Bot generates leaderboard rankings and selects best tweet
New report is automatically posted to your configured topic/chat
Process typically takes 1-3 minutes depending on data volume

`/report`

Display the last generated report for the group.

Parameters:

None

Credits and Status

`/get_credits`

Display consumed and available credits for the current period.

Parameters:

--detail (optional) - Show detailed credit breakdown

Examples:

/get_credits
/get_credits --detail

PreviousEasy Setup

Last updated 4 days ago

Was this helpful?