Package: telegram-crypto-price-bot
Telegram Crypto Price BotTelegram bot for displaying cryptocurrencies prices and charts based onpyrogramandmatplotliblibraries.Data is retrieved using CoinGecko APIs.It is possible to show coin information either on demand (by manually calling a command) or periodically using background tasks.A single bot instance can be used with multiple coins and in multiple groups.The usage of the bot is restricted to admins, in order to avoid users to flood the chat with price requests.SetupCreate Telegram appIn order to use the bot, in addition to the bot token you also need an APP ID and hash.To get them, create an app using the following website:https://my.telegram.org/apps.InstallationThe package requires Python 3, it is not compatible with Python 2.To install it:Usingsetuptools:python setup.py installUsingpip:pip install telegram_crypto_price_botTo run the bot, edit the configuration file by specifying the API ID/hash and bot token. Then, move to theappfolder and run thebot.pyscript:cd app
python bot.pyWhen run with no parameter,conf/config.iniwill be the default configuration file (in this way it can be used for different groups).To specify a different configuration file:python bot.py -c another_conf.ini
python bot.py --config another_conf.iniOf course, theappfolder can be moved elsewhere if needed.ConfigurationAn example of configuration file is provided in theapp/conffolder.The list of all possible fields that can be set is shown below.NameDescription[pyrogram]Configuration for pyrogramsession_nameSession name of your choiceapi_idAPI ID fromhttps://my.telegram.org/appsapi_hashAPI hash fromhttps://my.telegram.org/appsbot_tokenBot token from BotFather[app]Configuration for appapp_is_test_modeTrue to activate test mode false otherwiseapp_lang_fileLanguage file in XML format (default: English)[task]Configuration for taskstasks_max_numMaximum number of running tasks (totally, in all groups). Default:20.[coingecko]Configuration for Coingeckocoingecko_api_keyKey for using Coingecko APIs. If not specified, the free APIs will be used. Default:empty string.[chart]Configuration for price chartchart_displayTrue to display price chart, false otherwise (default: true). If false, all the next fields will be skipped.chart_date_formatDate format for price chart (default:%%d/%%m/%%Y %%H:00)chart_background_colorBackground color for price chart (default:white)chart_title_colorTitle color for price chart (default:black)chart_frame_colorFrame color for price chart (default:black)chart_axes_colorAxes color for price chart (default:black)chart_line_colorLine color for price chart (default:#3475AB)chart_line_styleLine style for price chart (default:-). Same as matplotlib line styles:----.:chart_line_widthLine width for price chart (default:1)chart_display_gridTrue to display price chart grid, false otherwise (default:true). If false, all the next fields will be skipped.chart_grid_max_sizeMaximum size for price chart grid (default:4)chart_grid_colorLine color for price chart grid (default:#DFDFDF)chart_grid_line_styleLine style for price chart grid (default:--). Same as matplotlib line styles:----.:chart_grid_line_widthLine width for price chart grid (default:1)[price]Configuration for price infoprice_display_market_capTrue to display market cap, false otherwise (default:true)price_display_market_cap_rankTrue to display market cap rank, false otherwise (default:false)[logging]Configuration for logginglog_levelLog level, same of python logging (DEBUG,INFO,WARNING,ERROR,CRITICAL). Default:INFO.log_console_enabledTrue to enable logging to console, false otherwise (default:true)log_file_enabledTrue to enable logging to file, false otherwise (default:false). If false, all the next fields will be skipped.log_file_nameLog file namelog_file_use_rotatingTrue for using a rotating log file, false otherwiselog_file_max_bytesMaximum size in bytes for a log file. When reached, a new log file is created up tolog_file_backup_cnt. Valid only iflog_file_use_rotatingis true.log_file_backup_cntMaximum number of log files. Valid only iflog_file_use_rotatingis true.log_file_appendTrue to append to log file, false to start from a new file each time. Valid only iflog_file_use_rotatingis false.All the colors can be either a name or a RGB color in format#RRGGBB(same as matplotlib colors).Chart and price configurations will be applied to all coin information in all groups. It's not possible to configure a single coin.Supported CommandsList of supported commands:/help: show this message/alive: show if bot is active/pricebot_set_test_mode true/false: enable/disable test mode/pricebot_is_test_mode: show if test mode is enabled/pricebot_version: show bot version/pricebot_get_single COIN_ID COIN_VS LAST_DAYS [SAME_MSG]: show chart and price information of the specified pair (single call).Parameters:COIN_ID: CoinGeckoIDCOIN_VS: CoinGeckovs_currencyLAST_DAYS: Last number of days to show price chartSAME_MSG(optional): true for sending chart and price information in the same message (price information will be a caption of the chart image), false to send them in separate messages. Default value: true./pricebot_task_start PERIOD_HOURS START_HOUR COIN_ID COIN_VS LAST_DAYS: start a price task in the current chat. If the taskCOIN_ID/COIN_VSalready exists in the current chat, an error message will be shown. To start it again, it shall be stopped with thepricebot_task_stopcommand.Parameters:PERIOD_HOURS: Task period in hours, it shall be between 1 and 24START_HOUR: Task start hour, it shall be between 0 and 23COIN_ID: CoinGeckoIDCOIN_VS: CoinGeckovs_currencyLAST_DAYS: Last number of days to show price chart/pricebot_task_stop COIN_ID COIN_VS: stop the specified price task in the current chat. If the taskCOIN_ID/COIN_VSdoes not exist in the current chat, an error message will be shown.Parameters:COIN_ID: CoinGeckoIDCOIN_VS: CoinGeckovs_currency/pricebot_task_stop_all: stop all price tasks in the current chat/pricebot_task_pause COIN_ID COIN_VS: pause the specified price task in the current chat. If the taskCOIN_ID/COIN_VSdoes not exist in the current chat, an error message will be shown.Parameters:COIN_ID: CoinGeckoIDCOIN_VS: CoinGeckovs_currency/pricebot_task_resume COIN_ID COIN_VS: resume the specified price task in the current chat. If the taskCOIN_ID/COIN_VSdoes not exist in the current chat, an error message will be shown.Parameters:COIN_ID: CoinGeckoIDCOIN_VS: CoinGeckovs_currency/pricebot_task_send_in_same_msg COIN_ID COIN_VS true/false: enable/disable the sending of chart and price information in the same message. If the taskCOIN_ID/COIN_VSdoes not exist in the current chat, an error message will be shown.Parameters:COIN_ID: CoinGeckoIDCOIN_VS: CoinGeckovs_currencyflag: true for sending chart and price information in the same message (price information will be a caption of the chart image), false to send them in separate messages/pricebot_task_delete_last_msg COIN_ID COIN_VS true/false: enable/disable the deletion of last messages for the specified price task in the current chat. If the taskCOIN_ID/COIN_VSdoes not exist in the current chat, an error message will be shown.Parameters:COIN_ID: CoinGeckoIDCOIN_VS: CoinGeckovs_currencyflag: true or false/pricebot_task_info: show the list of active price tasks in the current chatBy default:a price task will send chart and price information in the same message. This can be enabled/disabled with thepricebot_task_send_in_same_msgcommand.a price task will delete the last sent message when sending a new one. This can be enabled/disabled with thepricebot_task_delete_last_msgcommand.The task period starts from the specified starting hour (be sure to set the correct time on the VPS), for example:A task period of 8 hours starting from 00:00 will send the message at: 00:00, 08:00 and 16:00A task period of 6 hours starting from 08:00 will send the message at: 08:00, 14:00, 20:00 and 02:00In case of API errors (e.g. network issues or invalid coin ID) an error message will be shown.ExamplesShow the price of BTC/USD of the last 14 days in the current chat (single call):/pricebot_get_single bitcoin usd 14Show the price of ETH/BTC of the last 30 days periodically every 8 hours starting from 10:00 in the current chat:/pricebot_task_start 8 10 ethereum btc 30Pause/Resume/Stop the previous task:/pricebot_task_pause ethereum btc
/pricebot_task_resume ethereum btc
/pricebot_task_stop ethereum btcSet task so that it sends chart and price information in the same message:/pricebot_task_send_in_same_msg ethereum btc trueSet task so that it doesn't delete the last sent message:/pricebot_task_delete_last_msg ethereum btc falseRun the BotIt'd be better if the bot is an administrator of the group. This is mandatory if it needs to delete the last sent messages.In order to display prices periodically, the bot shall run 24h/24h so it's suggested to run it on a VPS (there is no performance requirements, so a cheap VPS will suffice).Test ModeDuring test mode, the bot will work as usual but the task period will be applied in minutes instead of hours. This allows to quickly check if it is working.TranslationThe messages sent by the bot on Telegram can be translated into different languages (the default language is English) by providing a custom XML file.The XML file path is specified in the configuration file (app_lang_filefield).An example XML file in italian is provided in the folderapp/lang.Image ExamplesExample with chart and price information on different messages:Example with chart and price information on the same message:LicenseThis software is available under the MIT license.