Commands

Use the following commands to set the X API Token (set_x_token) and monitor your X account (set_x_account). To receive daily reports, set an email to receive those using set_reports_email.

/set_x_token

admin (only admins can run this command)

If you can't get an X API token, don't hesitate to contact us. We will help or offer you a subscription plan for the bot that does not require Bringing Your Own Key.

This sets the token to use your X API to track activity (check the BYOK section for instructions on how to get your free X API Token).

/set_x_token

When running this command, the bot will send you a private message with instructions on setting your token privately.

/set_x_filtering

admin (only admins can run this command)

X (Twitter) has very restrictive API usage limits. Please set filtering accordingly to match the number of posts you can retrieve from X. For example, if you're using the FREE PLAN, limit your filter to a limited number of X users (your KOLs, for example).

Sets the search filtering to use to monitor X activity. You can filter by:

• X username, using the format: from: <list of X usernames separated by comma>

• Keywords, using the format: keywords: <list of keywords separated by comma> X Bot will search for ANY of the keywords in the list.

• Mention, using the format: mention: <single mention X account>

• Exclude, to exclude certain post types, exclude: <list of exclusion>, where you can use:

  • retweet

  • quote

  • reply

• Ignore, to ignore specific accounts (for example, your KOLs), using the format: ignore: <list of X usernames separated by comma>

The following example uses all the filtering options to search for @IncomeSharks posts, including the BWS keyword and mentioning account @BWSCommunity:

/set_x_filtering from: @IncomeSharks keywords: BWS mention: @BWSCommunity exclude: retweet

This will set your bot X account and monitor your account's mentions.

Filters Examples

Here are some examples of X Bot usages you can use for inspiration.

Track your KOLs X performance.

Imagine you want to monitor your KOLs - let's use @Charlynovic, @realaecrypto, and @CryptoCaesarTA as an example. To monitor their tweets supporting your project and their performance, you can use the following filter:

/set_x_filtering from: @Charlynovic, @realaecrypto, @CryptoCaesarTA  keywords: BWS

This will monitor your KOL's tweets, including your project's keywords (in our case, "BWS").

Gamify your community support.

You can also use X Bot to gamify your community support by monitoring any user mentioning your X account:

/set_x_filtering mention: @BWSCommunity exclude: retweet, reply

Using the previous filtering, you will track anyone mentioning your X account (in our case, "@BWSCommunity"), so you can use it to award top users daily or weekly.

/get_x_filtering

admin

Gets the X account bot is monitoring activity.

/get_x_filtering

This will return the search criteria used to monitor X activity.

/set_top_count

Use this command to set the number of top players to show on the leaderboard. The default is 10, showing only a maximum of the TOP 10 users.

/set_top_count 50

/report

everyone

Shows in the Telegram group the last generated weekly report.

/report

/set_reports_email

admin

Sets the email address to receive daily reports.

/set_reports_email [e-mail]

You will get daily reports as the following example once you set an email address using this command.

/unset_reports_email

Disables getting daily reports by email.