mirror of
https://gitlab.com/simple-stock-bots/docs.git
synced 2025-06-16 15:17:27 +00:00
51 lines
1.6 KiB
Markdown
51 lines
1.6 KiB
Markdown
# Telegram Bot Commands
|
|
|
|
## About
|
|
|
|
If you aren't already, you can talk to this bot here: **[http://t.me/SimpleStockBot](http://t.me/SimpleStockBot)**
|
|
|
|
Simple Stock Bot is a bot for [Telegram](https://telegram.org/) that provides information about the stock market. You can view the source code [here.](https://gitlab.com/MisterBiggs/simple-telegram-bot). You can also build your own docker container to run [here.](#Build)
|
|
|
|
_Coded with ❤ by [@MisterBiggs](https://gitlab.com/MisterBiggs)_
|
|
|
|
## Getting a Stock Quote
|
|
|
|
Anytime the Bot is in your chat it will search all chats for `$` followed by a ticker. For example `$tsla` will return the following message for Tesla Motors:
|
|
|
|
```
|
|
The current stock price of Tesla Inc. is $321.35, the stock is currently up 2.7%
|
|
```
|
|
|
|
This works no matter where the ticker is in the message and you can have as many tickers as you want in the same message. For example:
|
|
|
|
```
|
|
I wonder how $aapl, $nflx, and $sono are performing today.
|
|
```
|
|
|
|
Will return:
|
|
|
|
|
|
|
|
As long as the bot is in your chat it will reply to any stock tickers in your messages.
|
|
|
|
## Commands
|
|
|
|
- [`/help`](#/help)
|
|
- [`/dividend`](#/dividend)
|
|
|
|
### /help
|
|
|
|
This command just displays a short description of what the bot does and a link to this page.
|
|
|
|
### /dividend
|
|
|
|
The dividend command will give you the `dividend yield`, `dividend rate`, and will tell you how long until the payout date for any tickers input. Currently the command `/dividend $psec` returns:
|
|
|
|
---
|
|
|
|
`Prospect Capital Corporation current dividend yield is: 0.720%, or $11.285 per share.`
|
|
|
|
`The dividend is in: 14 Days 1 Hours 54 Minutes 46 Seconds.`
|
|
|
|
---
|