Anson/Simple-Stock-Bot
1
0
Fork 0
mirror of https://gitlab.com/simple-stock-bots/simple-stock-bot.git synced 2025-06-16 15:17:28 +00:00
Code Releases Activity

updated docs with new bot info

Browse Source
This commit is contained in:
Anson 2019-02-12 23:18:42 -07:00
parent 18f82286ce
commit 4c04c1664d
1 changed files with 32 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
web/docs/index.md
View File

@ -2,9 +2,11 @@
## 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)*
_Coded with ❤ by [@MisterBiggs](https://gitlab.com/MisterBiggs)_
## Getting a Stock Quote
@ -28,8 +30,9 @@ As long as the bot is in your chat it will reply to any stock tickers in your me
## Commands
* [`/help`](#/help) - Create a new project.
* [`/news`](#/news) - Start the live-reloading docs server.
- [`/help`](#/help)
- [`/news`](#/news)
- [`/dividend`](#/dividend)
### /help
@ -37,19 +40,31 @@ This command just displays a short description of what the bot does and a link t
### /news
This command is intelligent enough to get any tickers in the ticker format: `$amzn`, and can handle as many tickers as you would like to enter. The bot will then return the price of the ticker, and links various websites that provide news about the ticker. Currently for Apple stock the Bot would return:
This command is intelligent enough to get any tickers in the ticker format: `$amzn`, and can handle as many tickers as you would like to enter. The bot will then return the price of the ticker, and links various websites that provide news about the ticker. Currently the command `/news $aapl` returns:
---
`The current stock price of Apple Inc. is **$174.18**, the stock is currently up **1.71%**`
[`Bravos`](https://bravos.co/AAPL)
[`Seeking Alpha`](https://seekingalpha.com/symbol/AAPL)
[`MSN Money`](https://www.msn.com/en-us/money/stockdetails?symbol=AAPL)
[`Yahoo Finance`](https://finance.yahoo.com/quote/AAPL)
[`Wall Street Journal`](https://quotes.wsj.com/AAPL)
[`The Street`](https://www.thestreet.com/quote/AAPL.html)
[`Zacks`](https://www.zacks.com/stock/quote/AAPL)
`The current stock price of Apple Inc. is $**170.89**, the stock is currently **up 0.86%**`
*The /news command needs updating, feel free to [open an issue](https://gitlab.com/MisterBiggs/simple-telegram-bot/issues) with suggestions.*
[`Apple: The 4 Biggest Risks`](https://api.iextrading.com/1.0/stock/aapl/article/7171544094325661)
[`Apple is getting so serious about health, it's started hosting heart-health events at Apple Stores`](https://api.iextrading.com/1.0/stock/aapl/article/6966979968162641)
[`You can now ask Siri to get you directions with Waze so you don't even have to open the app`](https://api.iextrading.com/1.0/stock/aapl/article/7672481171984085)
---
### /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.`
---
## Run your own Bot