What's Tickergram?
Tickergram is a Telegram bot to look up quotes, charts, general market sentiment and more. It can be used collaboratively in group chats or by talking directly to it. Users can also keep a watchlist and receive price information notifications.
Supporting Tickergram
I run an instance of Tickergram at @tickergrambot. By becoming a sponsor, you will support the project and get access to this bot instance. Check the sponsor tiers for more information.
Or continue reading and get your own bot running in no time!
Bot commands
/quoteget quote /chart[1y,6m,5d] get price and volume chart/watchlist|add|del [symbol] list, add or remove symbol from your watchlist/watchlistget an overview of your watchlist/watchlistnotifytoggle the automatic watchlist notifications on and off/overviewget an overview of global ETFs/feargreedget picture of CNN's Fear & Greed Index
Requirements
- Python 3.9+
- Python requirements, most notably yfinance, which is used to get financial information. The data provider may change in the future.
- Redis, used as database to keep both permanent and temporary data (cache).
- (Optional) Firefox is used by bot commands that take website screenshots, such as
/feargreed.
Installation
- Talk to the @BotFather to create a new bot and get its token.
- Install Redis.
- Install Tickergram and its dependencies by running
python setup.py install. - Run the bot with the assistance of the self-explanatory help message:
$ tickergram-bot -h
usage: tickergram-bot [-h] [-p PASSWORD] [-r REDIS] [-l PORT] [-d DB] token
Tickergram bot
positional arguments:
token Telegram Bot API token
optional arguments:
-h, --help show this help message and exit
-p PASSWORD, --password PASSWORD
Optional password needed to interact with the bot (enables the /auth command)
-r REDIS, --redis REDIS
redis host to use
-l PORT, --port PORT redis port to use
-d DB, --db DB redis database to use
If Tickergram is running correctly, the output should be similar to this:
$ tickergram-bot
2021-09-28 19:52:58,820 Checking Telegram API token ...
2021-09-28 19:52:58,942 Telegram API token is valid
2021-09-28 19:52:58,942 Testing Redis connectivity ...
2021-09-28 19:52:58,944 Redis connection is ok
2021-09-28 19:52:58,946 Bot is running with pid 116526
Usage
After sending the Telegram message /start or /help to the bot, it will reply with the supported bot commands.
The bot administrator can notify chat watchlists (when notifications are enabled) with the command tickergram-notify. It may be a good idea to run this command on a regular basis (for example at market open) using crontab.
Author
Alberto Ortega
3 Feb 22, 2022
1 Dec 24, 2021
4 Feb 11, 2022
26 Dec 15, 2022
202 Oct 4, 2022
13 Oct 21, 2022
6 Jun 20, 2022
4 Apr 2, 2022
14 Oct 21, 2022
42 Dec 22, 2022
161 Jan 06, 2023
27 Oct 28, 2022
1.4k Dec 24, 2022
140 Dec 21, 2022
7 Oct 23, 2022
1 Dec 10, 2021
3 Feb 28, 2022
37 Dec 21, 2022
1.2k Jan 01, 2023
4 Nov 08, 2021
3 Nov 03, 2022
3 Apr 18, 2022
8 Jul 01, 2022
129 Jan 09, 2023
2 Jan 25, 2022
13 Oct 02, 2022
25 Dec 10, 2021
33 Oct 21, 2022