mirror of
https://gitlab.com/simple-stock-bots/docs.git
synced 2025-06-16 07:16:39 +00:00
mostly final version of the docs for now
This commit is contained in:
parent
3dd62d56fb
commit
af95ce4cb2
@ -1,5 +1,3 @@
|
|||||||
# Key
|
|
||||||
|
|
||||||
Symbols are used in headings to denote what platforms and symbol types a command supports.
|
Symbols are used in headings to denote what platforms and symbol types a command supports.
|
||||||
|
|
||||||
- Telegram Only :fontawesome-brands-telegram-plane:
|
- Telegram Only :fontawesome-brands-telegram-plane:
|
||||||
@ -9,7 +7,7 @@ Symbols are used in headings to denote what platforms and symbol types a command
|
|||||||
- Stock Market Support :bank:
|
- Stock Market Support :bank:
|
||||||
- OTC Support :dollar:
|
- OTC Support :dollar:
|
||||||
|
|
||||||
# Symbol Detection :material-currency-btc: :bank: :dollar:
|
## Symbol Detection :material-currency-btc: :bank: :dollar:
|
||||||
|
|
||||||
The Simple Stock Bot looks at every message it can see and tries to detect stock and cryptocurrency symbols. Stock market tickers are denoted with a single `$` and cryptocurrency coins are denoted with a double `$$`. So getting the price of Tesla is as simple as `$tsla` and Bitcoin `$$btc`. These symbols can be in any part of a message and there can be multiple of them aswell.
|
The Simple Stock Bot looks at every message it can see and tries to detect stock and cryptocurrency symbols. Stock market tickers are denoted with a single `$` and cryptocurrency coins are denoted with a double `$$`. So getting the price of Tesla is as simple as `$tsla` and Bitcoin `$$btc`. These symbols can be in any part of a message and there can be multiple of them aswell.
|
||||||
|
|
||||||
@ -27,7 +25,7 @@ The Simple Stock Bot looks at every message it can see and tries to detect stock
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
# `/donate [Amount in USD]` :fontawesome-brands-telegram-plane:
|
## `/donate [Amount in USD]` :fontawesome-brands-telegram-plane:
|
||||||
|
|
||||||
The donate command is used to send money to the bot to help keep it free. The premium stock market data and server rentals add up so any amount helps. See the [Donate](donate.md) page for more information.
|
The donate command is used to send money to the bot to help keep it free. The premium stock market data and server rentals add up so any amount helps. See the [Donate](donate.md) page for more information.
|
||||||
|
|
||||||
@ -43,7 +41,7 @@ The donate command is used to send money to the bot to help keep it free. The pr
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
# `/status` :fontawesome-brands-telegram-plane: :fontawesome-brands-discord:
|
## `/status` :fontawesome-brands-telegram-plane: :fontawesome-brands-discord:
|
||||||
|
|
||||||
This command is to get diagnostic information about the bot and the services it is dependant on in order to operate. Any issues should be reported to me. [Contact](contact.md)
|
This command is to get diagnostic information about the bot and the services it is dependant on in order to operate. Any issues should be reported to me. [Contact](contact.md)
|
||||||
|
|
||||||
@ -66,7 +64,7 @@ Bot Status:
|
|||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
# `/dividend [symbol]` :bank:
|
## `/dividend [symbol]` :bank:
|
||||||
|
|
||||||
This command gives the rate and date of the dividend for a stock symbol.
|
This command gives the rate and date of the dividend for a stock symbol.
|
||||||
|
|
||||||
@ -85,7 +83,7 @@ The dividend was declared on Monday, May 1 and the ex-dividend date is Tuesday,
|
|||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
# `/intra [symbol]` :bank: :material-currency-btc:
|
## `/intra [symbol]` :bank: :material-currency-btc:
|
||||||
|
|
||||||
This command makes a chart of a stocks movement since the last market open, or the last 24 hours for cryptocurrency.
|
This command makes a chart of a stocks movement since the last market open, or the last 24 hours for cryptocurrency.
|
||||||
|
|
||||||
@ -104,7 +102,7 @@ This command makes a chart of a stocks movement since the last market open, or t
|
|||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
# `/chart [symbol]` :bank: :material-currency-btc:
|
## `/chart [symbol]` :bank: :material-currency-btc:
|
||||||
|
|
||||||
This command makes a chart of the last 1 month of trading data up until the day before. For example running it on May 5th creates a chart from April 5th to May 4th.
|
This command makes a chart of the last 1 month of trading data up until the day before. For example running it on May 5th creates a chart from April 5th to May 4th.
|
||||||
|
|
||||||
@ -123,7 +121,7 @@ This command makes a chart of the last 1 month of trading data up until the day
|
|||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
# `/news [symbol]` :bank:
|
## `/news [symbol]` :bank:
|
||||||
|
|
||||||
Gets the most recent, non paywalled, english news for a stock.
|
Gets the most recent, non paywalled, english news for a stock.
|
||||||
|
|
||||||
@ -143,7 +141,7 @@ Tesmanian: Brandenburg Minister Supports Bureaucratic Reform & Hopes Tesla Giga
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
# /info :fontawesome-brands-telegram-plane: :fontawesome-brands-discord: :bank: :material-currency-btc:
|
## `/info [symbol]` :fontawesome-brands-telegram-plane: :fontawesome-brands-discord: :bank: :material-currency-btc:
|
||||||
|
|
||||||
Gets a description of a company. Aimed to inform you on what a ticker is if you have no prior knowledge of it.
|
Gets a description of a company. Aimed to inform you on what a ticker is if you have no prior knowledge of it.
|
||||||
|
|
||||||
@ -158,7 +156,7 @@ Virgin Galactic Holdings, Inc. is a vertically integrated aerospace and space tr
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
# `/stat [symbol]` :fontawesome-brands-telegram-plane: :fontawesome-brands-discord:
|
## `/stat [symbol]` :fontawesome-brands-telegram-plane: :fontawesome-brands-discord:
|
||||||
|
|
||||||
Gets key market data of the symbol passed in.
|
Gets key market data of the symbol passed in.
|
||||||
|
|
||||||
@ -192,7 +190,7 @@ Beta: 0.404
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
# `/trending` :fontawesome-brands-telegram-plane:
|
## `/trending` :fontawesome-brands-telegram-plane:
|
||||||
|
|
||||||
Gets the latest trending stocks and their change in price
|
Gets the latest trending stocks and their change in price
|
||||||
|
|
||||||
@ -233,7 +231,7 @@ $$MLN: Enzyme, 32.85%
|
|||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
# /help :robot:
|
## /help :robot:
|
||||||
|
|
||||||
Just a simple command to get help in app. Returns a more summarized version of this page.
|
Just a simple command to get help in app. Returns a more summarized version of this page.
|
||||||
|
|
||||||
@ -249,7 +247,7 @@ Just a simple command to get help in app. Returns a more summarized version of t
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
# Inline Features :fontawesome-brands-telegram-plane: :material-currency-btc: :bank: :dollar:
|
## Inline Features :fontawesome-brands-telegram-plane: :material-currency-btc: :bank: :dollar:
|
||||||
|
|
||||||
You can type @SimpleStockBot `[search]` in any chat or direct message to search for the stock bots
|
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
|
full list of stock symbols and return the price of the ticker. Then once you select the ticker
|
||||||
|
|||||||
@ -0,0 +1,6 @@
|
|||||||
|
Feel free to reach out with bugs or suggestions at any of the following places:
|
||||||
|
|
||||||
|
- Message me on [Telegram](https://t.me/MisterBiggs)
|
||||||
|
- Message me on Discord `MisterBiggs#0465`
|
||||||
|
- Tweet me on [Twitter](https://twitter.com/Handsome__Anson)
|
||||||
|
- Open an issue on gitlab: [`Telegram Bot`](https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot) [`Discord Bot`](https://gitlab.com/simple-stock-bots/simple-discord-stock-bot)
|
||||||
@ -1,26 +1,15 @@
|
|||||||
Simple Stock Bot is run entirely on donations.
|
Simple Stock Bot is run entirely on donations, and costs about $420 a year to run. All donations go directly towards paying for servers, and premium market data provided by [IEX Cloud](https://iexcloud.io/).
|
||||||
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.
|
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.
|
Alternatively, you can donate on Telegram with the `/donate` [command](commands.md#donate-amount-in-usd).
|
||||||
|
|
||||||
You can also support the bot indirectly by using the following referal links:
|
If you have any questions get in [touch.](contact.md)
|
||||||
|
|
||||||
- [DigitalOcean](https://m.do.co/c/6b5df7ef55b6)
|
## Other Ways to Help:
|
||||||
- [IEX Cloud](https://iexcloud.io/s/62c8503e)
|
|
||||||
|
|
||||||
If you have any questions get in touch: [anson@ansonbiggs.com](http://mailto:anson@ansonbiggs.com/)
|
|
||||||
|
|
||||||
|
|
||||||
## Support the Project
|
|
||||||
|
|
||||||
If you appreciate these bots please consider [donating](donate.md) 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:
|
|
||||||
|
|
||||||
- [_"buy me a coffee"_](https://www.buymeacoffee.com/Anson)
|
|
||||||
- Use my referral links when hosting your own bot. [DigitalOcean](https://m.do.co/c/6b5df7ef55b6) or [IEX Cloud](https://iexcloud.io/s/62c8503e)
|
|
||||||
- Follow me on [twitter](https://twitter.com/Anson_3D)
|
- Follow me on [twitter](https://twitter.com/Anson_3D)
|
||||||
- Contribute to the project on [GitLab](https://gitlab.com/simple-stock-bots) or just leave a star
|
- Contribute to the project on [GitLab](https://gitlab.com/simple-stock-bots) or just leave a star
|
||||||
|
- Using my referral links to host your own Bot
|
||||||
|
- [DigitalOcean](https://m.do.co/c/6b5df7ef55b6)
|
||||||
|
- [IEX Cloud](https://iexcloud.io/s/62c8503e)
|
||||||
@ -1,14 +1,6 @@
|
|||||||
# Simple Stock Bots
|
# Simple Stock Bots
|
||||||
|
|
||||||
[](https://t.me/SimpleStockBot)
|
Simple Stock Bots is a family of messaging bots that aim to provide simple interface to stock market information.
|
||||||
[](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=0&scope=bot)
|
|
||||||
[](https://tldrlegal.com/license/mit-license#summary)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## About
|
|
||||||
|
|
||||||
Simple Stock Bots is a family of messaging bots that aim to provide simple interface to stock market information. Currently there are only Telegram and Discord Bots.
|
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
@ -26,19 +18,6 @@ Alternatively, this project is completely open source and instructions on how to
|
|||||||
|
|
||||||
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. For full information see [Commands](commands.md)
|
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. For full information see [Commands](commands.md)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Help the bot isn't working! / I have an amazing feature that you should totally add!
|
|
||||||
|
|
||||||
Feel free to reach out at any of the following places:
|
|
||||||
|
|
||||||
- Run the `/help` command and try to figure it out yourself.
|
|
||||||
- Open an issue on gitlab: [`Telegram Bot`](https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot) [`Discord Bot`](https://gitlab.com/simple-stock-bots/simple-discord-stock-bot)
|
|
||||||
- Message me on [Telegram](https://t.me/MisterBiggs)
|
|
||||||
- Message me on Discord `MisterBiggs#0465`
|
|
||||||
- Assume someone else is already messaging me
|
|
||||||
- [Send a Carrier Pigeon :dove: \(Twitter\)](https://twitter.com/Handsome__Anson)
|
|
||||||
|
|
||||||
## Source Code
|
## Source Code
|
||||||
|
|
||||||
The source code for the bots is completely open and hosted on GitLab. The project is licensed with an MIT License which is incredibly permissive. The full text of the license can be read [here](./LICENSE)
|
The source code for the bots is completely open and hosted on GitLab. The project is licensed with an MIT License which is incredibly permissive. The full text of the license can be read [here](./LICENSE)
|
||||||
|
|||||||
@ -14,7 +14,7 @@ nav:
|
|||||||
- Commands: commands.md
|
- Commands: commands.md
|
||||||
- Hosting: host.md
|
- Hosting: host.md
|
||||||
- Donate: donate.md
|
- Donate: donate.md
|
||||||
# - Contact: contact.md
|
- Contact: contact.md
|
||||||
|
|
||||||
theme:
|
theme:
|
||||||
name: "material"
|
name: "material"
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user