1
0
mirror of https://gitlab.com/simple-stock-bots/docs.git synced 2025-06-16 07:16:39 +00:00

Updated site for V2 of telegram bot

This commit is contained in:
Anson Biggs 2021-02-10 10:36:24 -07:00
parent fe1ff6eac8
commit dad6d6235b
6 changed files with 48 additions and 54 deletions

View File

@ -1 +0,0 @@
# Under Construction 🚧

View File

@ -1,38 +0,0 @@
# Telegram Bot Commands
<style>.bmc-button img{height: 34px !important;width: 35px !important;margin-bottom: 1px !important;box-shadow: none !important;border: none !important;vertical-align: middle !important;}.bmc-button{padding: 7px 15px 7px 10px !important;line-height: 35px !important;height:51px !important;text-decoration: none !important;display:inline-flex !important;color:#FFFFFF !important;background-color:#FF813F !important;border-radius: 5px !important;border: 1px solid transparent !important;padding: 7px 15px 7px 10px !important;font-size: 22px !important;letter-spacing: 0.6px !important;box-shadow: 0px 1px 2px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 1px 2px 2px rgba(190, 190, 190, 0.5) !important;margin: 0 auto !important;font-family:'Cookie', cursive !important;-webkit-box-sizing: border-box !important;box-sizing: border-box !important;}.bmc-button:hover, .bmc-button:active, .bmc-button:focus {-webkit-box-shadow: 0px 1px 2px 2px rgba(190, 190, 190, 0.5) !important;text-decoration: none !important;box-shadow: 0px 1px 2px 2px rgba(190, 190, 190, 0.5) !important;opacity: 0.85 !important;color:#FFFFFF !important;}</style><link href="https://fonts.googleapis.com/css?family=Cookie" rel="stylesheet"><a class="bmc-button" target="_blank" href="https://www.buymeacoffee.com/Anson"><img src="https://cdn.buymeacoffee.com/buttons/bmc-new-btn-logo.svg" alt="Buy me a beer"><span style="margin-left:5px;font-size:28px !important;">Buy me a beer</span></a>
## 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:
![Conversation With Simple Telegram Bot](img\telegramBotTickerReply.png)
## Commands
- [`/help`](#/help) - Create a new project.
- [`/news`](#/news) - Start the live-reloading docs server.
### /help
This command just displays a short description of what the bot does and a link to this page.
### /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. For example saying `/news $tsla $aapl` would reply two different messages one for each ticker with a few news articles provided by the [IEX API](https://iexcloud.io/s/62c8503e).
_The bots need more commands, feel free to [open an issue](https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot/-/issues) with suggestions._
[All market data is provided by IEX Cloud](https://iexcloud.io)

14
docs/donate.md Normal file
View File

@ -0,0 +1,14 @@
Simple Stock Bot is run entirely on donations.
All donations go directly towards paying for servers, and market data is provided by
[IEX Cloud](https://iexcloud.io/).
The best way to donate is through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson,which) accepts Paypal or Credit card.
Alternatively, you can donate on Telegram with the `/donate` command.
You can also support the bot indirectly by using the following referal links:
- [DigitalOcean](https://m.do.co/c/6b5df7ef55b6)
- [IEX Cloud](https://iexcloud.io/s/62c8503e)
If you have any questions get in touch: [anson@ansonbiggs.com](http://mailto:anson@ansonbiggs.com/)

View File

@ -19,16 +19,12 @@ The bots can either be added to a server or can be direct messaged for the exact
- [Telegram](https://t.me/SimpleStockBot) - [Telegram](https://t.me/SimpleStockBot)
- [Discord](https://discordapp.com/oauth2/authorize?client_id=532045200823025666&permissions=2048&scope=bot) - [Discord](https://discordapp.com/oauth2/authorize?client_id=532045200823025666&permissions=2048&scope=bot)
Alternatively, this project is completely open source and instructions on how to run your own instance of the bot are provided on each of the bots pages. Alternatively, this project is completely open source and instructions on how to run your own instance of the bot are provided on each of the bots pages. [Hosting](#source-code)
## Usage ## Usage
The bots are nearly identical between platforms, but sometimes a platform will have a feature that only it supports such as Telegrams inline messaging or Discords embeds. The bots are nearly identical between platforms, but sometimes a platform will have a feature that only it supports such as Telegrams inline messaging or Discords embeds.
Thanks for using this bot, consider supporting it by [buying me a beer.](https://www.buymeacoffee.com/Anson)
Full documentation can be found [here.](https://simple-stock-bots.gitlab.io/site/telegram/)
### Automatic ### Automatic
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: 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:
@ -54,15 +50,15 @@ Will return:
- /info `$[symbol]` will return general information about the symbol. - /info `$[symbol]` will return general information about the symbol.
- /search `query` Takes a search string, whether a company name or ticker and returns a list of companies that are supported by the bot. - /search `query` Takes a search string, whether a company name or ticker and returns a list of companies that are supported by the bot.
### Telegram Inline Messaging ### Telegram Features
You can type @SimpleStockBot `[search]` in any chat or direct message to search for the stock bots full list of stock symbols and return the price of the ticker. For the full list of Telgram bot features see [Telegram Commands](./telegram)
--- ---
## Support the Project / Me ## Support the Project
If you appreciate these bots please consider donating or contributing in another way so that they can remain free, and so that I can continue to post free things on the world wide web. If you appreciate these bots please consider [donating](./donate) or contributing in another way so that they can remain free, and so that I can continue to post free things on the world wide web.
### Ways to help: ### Ways to help:
@ -93,5 +89,3 @@ If you decide to host your own bots using my source code please consider using m
- [DigitalOcean](https://m.do.co/c/6b5df7ef55b6) - [DigitalOcean](https://m.do.co/c/6b5df7ef55b6)
- [IEX Cloud](https://iexcloud.io/s/62c8503e) - [IEX Cloud](https://iexcloud.io/s/62c8503e)
<script data-name="BMC-Widget" src="https://cdnjs.buymeacoffee.com/1.0.0/widget.prod.min.js" data-id="Anson" data-description="Support me on Buy me a coffee!" data-message="Thank you for using my bots!" data-color="#5F7FFF" data-position="right" data-x_margin="18" data-y_margin="18"></script>

24
docs/telegram.md Normal file
View File

@ -0,0 +1,24 @@
Keep up with the latest news for the bot in itsTelegram Channel: [https://t.me/simplestockbotnews](https://t.me/simplestockbotnews)
## Commands
- `/donate [amount in USD]` to donate. 🎗️
- `/dividend $[symbol]` will return dividend information for the symbol. 📅
- `/intra $[symbol]` Plot of the stocks movement since the last market open. 📈
- `/chart $[symbol]` Plot of the stocks movement for the past 1 month. 📊
- `/news $[symbol]` News about the symbol. 📰
- `/info $[symbol]` General information about the symbol.
- `/stat $[symbol]` Key statistics about the symbol. 🔢
- `/help` Get some help using the bot. 🆘
## Inline Features
You can type @SimpleStockBot `[search]` in any chat or direct message to search for the stock bots
full list of stock symbols and return the price of the ticker. Then once you select the ticker
want the bot will send a message as you in that chat with the latest stock price.
The bot also looks at every message in any chat it is in for stock symbols.Symbols start with a
`$` followed by the stock symbol. For example:$tsla would return price information for Tesla Motors.
Market data is provided by [IEX Cloud](https://iexcloud.io)
If you believe the bot is not behaving properly run `/status`.

View File

@ -3,13 +3,14 @@ site_url: https://simple-stock-bots.gitlab.io/site
edit_uri: /simple-stock-bots/site/tree/master/docs edit_uri: /simple-stock-bots/site/tree/master/docs
nav: nav:
- Home: index.md - Home: index.md
- Author's Website: https://blog.ansonbiggs.com/ - Telegram Commands: telegram.md
- Donate: donate.md
- Contact (Email): mailto:anson@ansonbiggs.com - Contact (Email): mailto:anson@ansonbiggs.com
- LICENSE: LICENSE.md - LICENSE: LICENSE.md
theme: "material" theme: "material"
repo_url: https://gitlab.com/simple-stock-bots repo_url: https://gitlab.com/simple-stock-bots
repo_name: Simple Stock Bots repo_name: Simple Stock Bots
site_description: A collection of simple chat bots for Stock Market Data. site_description: Simple Discord and Telegram chat bots for Stock Market Data.
site_author: Anson Biggs site_author: Anson Biggs
copyright: <a href="https://ansonbiggs.com">Anson Biggs</a> 2018 </br> <a href="https://iexcloud.io">All market data is provided by IEX Cloud</a> copyright: <a href="https://ansonbiggs.com">Anson Biggs</a> 2018 </br> <a href="https://iexcloud.io">All market data is provided by IEX Cloud</a> <script data-name="BMC-Widget" src="https://cdnjs.buymeacoffee.com/1.0.0/widget.prod.min.js" data-id="Anson" data-description="Support me on Buy me a coffee!" data-message="Thank you for using my bots!" data-color="#5F7FFF" data-position="right" data-x_margin="18" data-y_margin="18"></script>