cmbot
A simple telegram bot written in Kotlin, for fetching price information about crypto currencies from CoinMarketCap.
You can browse all currencies on CoinMarketCap through Inline Queries.
Just call the bot by its username and a query in the text input field. For example: @PriceLeechBot eth
.
Select a result and you'll get the most important information as a rendered image via Telegram.
You can try it out here.
Commands
Command | Usage | Description |
---|---|---|
/coin | /coin eth | Request price details about a coin |
/help | /help | Displays the help |
/start | /start | Displays the welcome message |
Installation
In order to run the bot on your own machine, you have to set your telegram bot api token as an environment variable:
$ export CMBOT_TELEGRAM_TOKEN=YOUR_API_KEY
Download the latest jar release and run the following command:
$ java -jar cmbot-<version>.jar
Build from Source
$ git clone https://github.com/yashino91/cmbot.git
$ cd cmbot/
$ mvn assembly:assembly
Run application using Docker
$ docker build -t cmbot .
$ docker run -e "CMBOT_TELEGRAM_TOKEN=YOUR_API_KEY" cmbot
Run application without Docker
$ java -jar target/cmbot-<version>.jar
Configuration
The configuration is done in the config.yaml file, located in the resource directory.
Key | Value |
---|---|
botName | Name of your Telegram Bot |
allowedCurrencySlugs | Array of currency slugs that are allowed to request. If empty every currency is allowed |
autoclearMessages | Deletes sent photo messages automatically if enabled |
autoclearMessagesDurationSec | Number in seconds after sent photo messages should be deleted |
Contributing
Use the issue tracker to report problems, suggestions and questions. You may also contribute by submitting pull requests.
If you find this project helpful, please consider making a donation: