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

formatting

This commit is contained in:
Anson 2023-11-30 21:53:06 -07:00
parent 1fe7fe8c9c
commit ec516db22f
23 changed files with 772 additions and 784 deletions

View File

@ -1,41 +1,41 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the // For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/python // README at: https://github.com/devcontainers/templates/tree/main/src/python
{ {
"name": "Python 3", "name": "Python 3",
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
// "image": "mcr.microsoft.com/devcontainers/python:1-3-bookworm", // "image": "mcr.microsoft.com/devcontainers/python:1-3-bookworm",
"build": { "build": {
"dockerfile": "Dockerfile", "dockerfile": "Dockerfile",
"context": ".." "context": ".."
}, },
"features": { "features": {
"ghcr.io/devcontainers-contrib/features/black:2": {}, "ghcr.io/devcontainers-contrib/features/black:2": {},
"ghcr.io/devcontainers-contrib/features/mypy:2": {}, "ghcr.io/devcontainers-contrib/features/mypy:2": {},
"ghcr.io/devcontainers-contrib/features/pylint:2": {}, "ghcr.io/devcontainers-contrib/features/pylint:2": {},
"ghcr.io/devcontainers/features/docker-in-docker": {} "ghcr.io/devcontainers/features/docker-in-docker": {}
}, },
"customizations": { "customizations": {
"vscode": { "vscode": {
"extensions": [ "extensions": [
"ms-python.python", "ms-python.python",
"ms-python.black-formatter", "ms-python.black-formatter",
"ms-python.vscode-pylance", "ms-python.vscode-pylance",
"ms-python.isort", "ms-python.isort",
"charliermarsh.ruff", "charliermarsh.ruff",
"ms-toolsai.jupyter", "ms-toolsai.jupyter",
"esbenp.prettier-vscode" "esbenp.prettier-vscode"
] ]
} }
}, },
"postCreateCommand": "pip3 install --user -r dev-reqs.txt && apt-get update && apt-get install -y nodejs npm --fix-missing && npm install" "postCreateCommand": "pip3 install --user -r dev-reqs.txt && apt-get update && apt-get install -y nodejs npm --fix-missing && npm install"
// Features to add to the dev container. More info: https://containers.dev/features. // Features to add to the dev container. More info: https://containers.dev/features.
// "features": {}, // "features": {},
// Use 'forwardPorts' to make a list of ports inside the container available locally. // Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [], // "forwardPorts": [],
// Use 'postCreateCommand' to run commands after the container is created. // Use 'postCreateCommand' to run commands after the container is created.
// "postCreateCommand": "pip3 install --user -r requirements.txt", // "postCreateCommand": "pip3 install --user -r requirements.txt",
// Configure tool-specific properties. // Configure tool-specific properties.
// "customizations": {}, // "customizations": {},
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root. // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
// "remoteUser": "root" // "remoteUser": "root"
} }

View File

@ -1,21 +1,21 @@
stages: stages:
- lint - lint
- build_site - build_site
- deploy - deploy
ruff: ruff:
stage: lint stage: lint
image: python:3.11-slim image: python:3.11-slim
script: script:
- pip3 install ruff - pip3 install ruff
- ruff . --output-format gitlab; ruff format . --diff - ruff . --output-format gitlab; ruff format . --diff
prettier: prettier:
stage: lint stage: lint
image: node:16-slim # Use Node.js image since prettier is a Node.js tool image: node:16-slim # Use Node.js image since prettier is a Node.js tool
script: script:
- npm install prettier - npm install prettier
- npx prettier --check . # Adjust the path as needed - npx prettier --check . # Adjust the path as needed
include: include:
- local: /site/.gitlab-ci.yml - local: /site/.gitlab-ci.yml

20
.vscode/settings.json vendored
View File

@ -1,10 +1,10 @@
{ {
"editor.formatOnSave": true, "editor.formatOnSave": true,
"editor.formatOnPaste": true, "editor.formatOnPaste": true,
"editor.formatOnSaveMode": "modificationsIfAvailable", "editor.formatOnSaveMode": "modificationsIfAvailable",
"[python]": { "[python]": {
"editor.defaultFormatter": "charliermarsh.ruff", "editor.defaultFormatter": "charliermarsh.ruff",
"editor.formatOnSave": true, "editor.formatOnSave": true,
"editor.formatOnSaveMode": "file" "editor.formatOnSaveMode": "file"
} }
} }

View File

@ -1,48 +1,48 @@
# Simple Stock Bots # Simple Stock Bots
[![Platform](https://img.shields.io/badge/platform-Telegram%20%7C%20Discord-blue.svg)](https://t.me/SimpleStockBot) [![Platform](https://img.shields.io/badge/platform-Telegram%20%7C%20Discord-blue.svg)](https://t.me/SimpleStockBot)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
[![Maintainer](https://img.shields.io/badge/Maintainer-Anson-blue)](https://ansonbiggs.com) [![Maintainer](https://img.shields.io/badge/Maintainer-Anson-blue)](https://ansonbiggs.com)
Enhance your group chats on Telegram and Discord with real-time stock and cryptocurrency insights. Simple Stock Bots deliver timely stock quotes, charts, and market trends directly to your chats, making financial discussions more engaging and informed. Enhance your group chats on Telegram and Discord with real-time stock and cryptocurrency insights. Simple Stock Bots deliver timely stock quotes, charts, and market trends directly to your chats, making financial discussions more engaging and informed.
## Documentation ## Documentation
Comprehensive documentation is available to help you understand the features and capabilities of Simple Stock Bots: Comprehensive documentation is available to help you understand the features and capabilities of Simple Stock Bots:
- [Official Documentation](https://simplestockbot.com/) - [Official Documentation](https://simplestockbot.com/)
- [Command Reference](https://simplestockbot.com/commands/) - [Command Reference](https://simplestockbot.com/commands/)
## Support the Project ## Support the Project
Simple Stock Bots is sustained entirely through donations, with an annual expense of about $420 for server and premium market data subscriptions from [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo). Simple Stock Bots is sustained entirely through donations, with an annual expense of about $420 for server and premium market data subscriptions from [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo).
You can contribute by: You can contribute by:
- Donating through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) (PayPal or Credit Card accepted). - Donating through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) (PayPal or Credit Card accepted).
- Using the `/donate` [command](commands.md#donate-amount-in-usd) on Telegram. - Using the `/donate` [command](commands.md#donate-amount-in-usd) on Telegram.
- [Getting in touch](contact.md) for any inquiries or suggestions. - [Getting in touch](contact.md) for any inquiries or suggestions.
### Additional Support: ### Additional Support:
- Follow on [Twitter](https://twitter.com/AnsonBiggs) - Follow on [Twitter](https://twitter.com/AnsonBiggs)
- Contribute or star the project on [GitLab](https://gitlab.com/simple-stock-bots/simple-stock-bot) - Contribute or star the project on [GitLab](https://gitlab.com/simple-stock-bots/simple-stock-bot)
- Utilize referral links for self-hosting: - Utilize referral links for self-hosting:
- [DigitalOcean](https://m.do.co/c/6b5df7ef55b6) - [DigitalOcean](https://m.do.co/c/6b5df7ef55b6)
- [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web) - [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web)
## Hosting ## Hosting
Self-hosting instructions are provided for those interested in running the bot on their own servers: Self-hosting instructions are provided for those interested in running the bot on their own servers:
- [Hosting Guide](https://simplestockbot.com/hosting/) - [Hosting Guide](https://simplestockbot.com/hosting/)
## Contact ## Contact
Reach out for bug reports, feature requests, or other inquiries: Reach out for bug reports, feature requests, or other inquiries:
- [Contact Page](https://simplestockbot.com/contact/) - [Contact Page](https://simplestockbot.com/contact/)
--- ---
Your support in any form is immensely appreciated and ensures the continuous improvement and availability of Simple Stock Bots for everyone. Your support in any form is immensely appreciated and ensures the continuous improvement and availability of Simple Stock Bots for everyone.

View File

@ -45,13 +45,9 @@ class MarketData:
self.MARKETDATA_TOKEN = "" self.MARKETDATA_TOKEN = ""
except KeyError: except KeyError:
self.MARKETDATA_TOKEN = "" self.MARKETDATA_TOKEN = ""
log.warning( log.warning("Starting without an MarketData.app Token will not allow you to get market data!")
"Starting without an MarketData.app Token will not allow you to get market data!"
)
log.warning("Use this affiliate link so that the bot can stay free:") log.warning("Use this affiliate link so that the bot can stay free:")
log.warning( log.warning("https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo")
"https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo"
)
if self.MARKETDATA_TOKEN != "": if self.MARKETDATA_TOKEN != "":
schedule.every().day.do(self.clear_charts) schedule.every().day.do(self.clear_charts)
@ -153,7 +149,9 @@ class MarketData:
statusJSON = status.json() statusJSON = status.json()
if statusJSON["status"] == "ok": if statusJSON["status"] == "ok":
return f"CoinGecko API responded that it was OK with a {status.status_code} in {status.elapsed.total_seconds()} seconds." return (
f"CoinGecko API responded that it was OK with a {status.status_code} in {status.elapsed.total_seconds()} seconds."
)
else: else:
return f"MarketData.app is currently reporting the following status: {statusJSON['status']}" return f"MarketData.app is currently reporting the following status: {statusJSON['status']}"
@ -323,9 +321,7 @@ class MarketData:
options_data["underlying"] = "$" + options_data["underlying"] options_data["underlying"] = "$" + options_data["underlying"]
options_data["updated"] = humanize.naturaltime( options_data["updated"] = humanize.naturaltime(dt.datetime.now() - dt.datetime.fromtimestamp(options_data["updated"]))
dt.datetime.now() - dt.datetime.fromtimestamp(options_data["updated"])
)
options_data["expiration"] = humanize.naturaltime( options_data["expiration"] = humanize.naturaltime(
dt.datetime.now() - dt.datetime.fromtimestamp(options_data["expiration"]) dt.datetime.now() - dt.datetime.fromtimestamp(options_data["expiration"])

View File

@ -37,9 +37,7 @@ class cg_Crypto:
# Make sure API returned a proper status code # Make sure API returned a proper status code
if resp.status_code == 429: if resp.status_code == 429:
log.warning( log.warning(f"CoinGecko returned 429 - Too Many Requests for endpoint: {endpoint}. Sleeping and trying again.")
f"CoinGecko returned 429 - Too Many Requests for endpoint: {endpoint}. Sleeping and trying again."
)
time.sleep(10) time.sleep(10)
return self.get(endpoint=endpoint, params=params, timeout=timeout) return self.get(endpoint=endpoint, params=params, timeout=timeout)
@ -59,9 +57,7 @@ class cg_Crypto:
def symbol_id(self, symbol) -> str: def symbol_id(self, symbol) -> str:
try: try:
return self.symbol_list[self.symbol_list["symbol"] == symbol]["id"].values[ return self.symbol_list[self.symbol_list["symbol"] == symbol]["id"].values[0]
0
]
except KeyError: except KeyError:
return "" return ""
@ -72,9 +68,7 @@ class cg_Crypto:
# Removes all binance-peg symbols # Removes all binance-peg symbols
symbols = symbols[~symbols["id"].str.contains("binance-peg")] symbols = symbols[~symbols["id"].str.contains("binance-peg")]
symbols["description"] = ( symbols["description"] = "$$" + symbols["symbol"].str.upper() + ": " + symbols["name"]
"$$" + symbols["symbol"].str.upper() + ": " + symbols["name"]
)
symbols = symbols[["id", "symbol", "name", "description"]] symbols = symbols[["id", "symbol", "name", "description"]]
symbols["type_id"] = "$$" + symbols["symbol"] symbols["type_id"] = "$$" + symbols["symbol"]
@ -95,7 +89,9 @@ class cg_Crypto:
try: try:
status.raise_for_status() status.raise_for_status()
return f"CoinGecko API responded that it was OK with a {status.status_code} in {status.elapsed.total_seconds()} seconds." return (
f"CoinGecko API responded that it was OK with a {status.status_code} in {status.elapsed.total_seconds()} seconds."
)
except r.HTTPError: except r.HTTPError:
return f"CoinGecko API returned an error code {status.status_code} in {status.elapsed.total_seconds()} seconds." return f"CoinGecko API returned an error code {status.status_code} in {status.elapsed.total_seconds()} seconds."
@ -165,9 +161,7 @@ class cg_Crypto:
f"/coins/{symbol.id}/ohlc", f"/coins/{symbol.id}/ohlc",
params={"vs_currency": self.vs_currency, "days": 1}, params={"vs_currency": self.vs_currency, "days": 1},
): ):
df = pd.DataFrame( df = pd.DataFrame(resp, columns=["Date", "Open", "High", "Low", "Close"]).dropna()
resp, columns=["Date", "Open", "High", "Low", "Close"]
).dropna()
df["Date"] = pd.to_datetime(df["Date"], unit="ms") df["Date"] = pd.to_datetime(df["Date"], unit="ms")
df = df.set_index("Date") df = df.set_index("Date")
return df return df
@ -193,9 +187,7 @@ class cg_Crypto:
f"/coins/{symbol.id}/ohlc", f"/coins/{symbol.id}/ohlc",
params={"vs_currency": self.vs_currency, "days": 30}, params={"vs_currency": self.vs_currency, "days": 30},
): ):
df = pd.DataFrame( df = pd.DataFrame(resp, columns=["Date", "Open", "High", "Low", "Close"]).dropna()
resp, columns=["Date", "Open", "High", "Low", "Close"]
).dropna()
df["Date"] = pd.to_datetime(df["Date"], unit="ms") df["Date"] = pd.to_datetime(df["Date"], unit="ms")
df = df.set_index("Date") df = df.set_index("Date")
return df return df

View File

@ -1,12 +1,12 @@
version: "3" version: "3"
services: services:
telegram: telegram:
build: build:
context: . context: .
dockerfile: telegram/Dockerfile dockerfile: telegram/Dockerfile
env_file: .env env_file: .env
discord: discord:
build: build:
context: . context: .
dockerfile: discord/Dockerfile dockerfile: discord/Dockerfile
env_file: .env env_file: .env

54
package-lock.json generated
View File

@ -1,27 +1,27 @@
{ {
"name": "simple-stock-bot", "name": "simple-stock-bot",
"lockfileVersion": 3, "lockfileVersion": 3,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"devDependencies": { "devDependencies": {
"prettier": "3.0.3" "prettier": "3.0.3"
} }
}, },
"node_modules/prettier": { "node_modules/prettier": {
"version": "3.0.3", "version": "3.0.3",
"resolved": "https://registry.npmjs.org/prettier/-/prettier-3.0.3.tgz", "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.0.3.tgz",
"integrity": "sha512-L/4pUDMxcNa8R/EthV08Zt42WBO4h1rarVtK0K+QJG0X187OLo7l699jWw0GKuwzkPQ//jMFA/8Xm6Fh3J/DAg==", "integrity": "sha512-L/4pUDMxcNa8R/EthV08Zt42WBO4h1rarVtK0K+QJG0X187OLo7l699jWw0GKuwzkPQ//jMFA/8Xm6Fh3J/DAg==",
"dev": true, "dev": true,
"bin": { "bin": {
"prettier": "bin/prettier.cjs" "prettier": "bin/prettier.cjs"
}, },
"engines": { "engines": {
"node": ">=14" "node": ">=14"
}, },
"funding": { "funding": {
"url": "https://github.com/prettier/prettier?sponsor=1" "url": "https://github.com/prettier/prettier?sponsor=1"
} }
} }
} }
} }

View File

@ -1,5 +1,5 @@
{ {
"devDependencies": { "devDependencies": {
"prettier": "3.0.3" "prettier": "3.0.3"
} }
} }

View File

@ -1,23 +1,23 @@
image: python:3.11 image: python:3.11
build_mkdocs: build_mkdocs:
stage: build_site stage: build_site
script: script:
- cd ./site - cd ./site
- pip install -r requirements.txt - pip install -r requirements.txt
- mkdocs build --site-dir ../public --verbose - mkdocs build --site-dir ../public --verbose
artifacts: artifacts:
paths: paths:
- public - public
pages: pages:
stage: deploy stage: deploy
script: script:
- echo "Publishing site..." - echo "Publishing site..."
dependencies: dependencies:
- build_mkdocs - build_mkdocs
artifacts: artifacts:
paths: paths:
- public - public
rules: rules:
- if: "$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH" - if: "$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH"

View File

@ -1,12 +1,12 @@
{ {
"yaml.schemas": { "yaml.schemas": {
"https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml" "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
}, },
"yaml.customTags": [ "yaml.customTags": [
"!ENV scalar", "!ENV scalar",
"!ENV sequence", "!ENV sequence",
"tag:yaml.org,2002:python/name:materialx.emoji.to_svg", "tag:yaml.org,2002:python/name:materialx.emoji.to_svg",
"tag:yaml.org,2002:python/name:materialx.emoji.twemoji", "tag:yaml.org,2002:python/name:materialx.emoji.twemoji",
"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format" "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
] ]
} }

View File

@ -1,23 +1,23 @@
``` ```
MIT License MIT License
Copyright (c) 2019 Anson Biggs Copyright (c) 2019 Anson Biggs
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions: furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. SOFTWARE.
``` ```

View File

@ -1,5 +1,5 @@
authors: authors:
Anson: Anson:
name: Anson Biggs name: Anson Biggs
description: Creator description: Creator
avatar: https://gitlab.com/uploads/-/system/user/avatar/1377308/avatar.png avatar: https://gitlab.com/uploads/-/system/user/avatar/1377308/avatar.png

View File

@ -1 +1 @@
# Blog # Blog

View File

@ -1,66 +1,66 @@
--- ---
title: "Introducing Simple Stock Bot: Your Chat Group's Financial Whiz" title: "Introducing Simple Stock Bot: Your Chat Group's Financial Whiz"
date: 2023-10-10 date: 2023-10-10
tags: [Simple Stock Bot, Introduction, Telegram, Discord, Financial Insights] tags: [Simple Stock Bot, Introduction, Telegram, Discord, Financial Insights]
authors: [Anson] authors: [Anson]
description: > description: >
Welcome to the world of Simple Stock Bot, where real-time financial insights are integrated seamlessly into your group chats on Telegram and Discord! Welcome to the world of Simple Stock Bot, where real-time financial insights are integrated seamlessly into your group chats on Telegram and Discord!
--- ---
## What is Simple Stock Bot? ## What is Simple Stock Bot?
Simple Stock Bot is a chatbot designed to enrich your financial discussions on Telegram and Discord. Regardless of whether you're a seasoned trader or a beginner in the stock market, this bot is here to make your discussions more informative and engaging. Simple Stock Bot is a chatbot designed to enrich your financial discussions on Telegram and Discord. Regardless of whether you're a seasoned trader or a beginner in the stock market, this bot is here to make your discussions more informative and engaging.
<div class="phone"> <div class="phone">
<div class="messages-wrapper"> <div class="messages-wrapper">
<div class="message to"> <div class="message to">
I wonder how $tsla is affecting the price of $$btc I wonder how $tsla is affecting the price of $$btc
</div> </div>
<div class="message from"> <div class="message from">
The current stock price of Tesla Inc is $866.57, the stock is currently up 1.68% The current stock price of Tesla Inc is $866.57, the stock is currently up 1.68%
</div> </div>
<div class="message from"> <div class="message from">
The current price of Bitcoin is $34,815, the coin is currently down -0.151% for today The current price of Bitcoin is $34,815, the coin is currently down -0.151% for today
</div> </div>
</div> </div>
</div> </div>
<!-- more --> <!-- more -->
With Simple Stock Bot, you can: With Simple Stock Bot, you can:
- **Fetch Real-time Quotes**: Obtain the latest stock and cryptocurrency prices instantly within your group chat. - **Fetch Real-time Quotes**: Obtain the latest stock and cryptocurrency prices instantly within your group chat.
- **View Charts**: Delve into intraday movements or assess a month's trading data right inside your group chat. - **View Charts**: Delve into intraday movements or assess a month's trading data right inside your group chat.
- **Stay Updated on Market Trends**: Discover what's buzzing in the stock and crypto spheres. - **Stay Updated on Market Trends**: Discover what's buzzing in the stock and crypto spheres.
## Add the Bot to your Group ## Add the Bot to your Group
[:fontawesome-brands-telegram: Telegram](https://t.me/SimpleStockBot){ .md-button } [:fontawesome-brands-telegram: Telegram](https://t.me/SimpleStockBot){ .md-button }
[:fontawesome-brands-discord: Discord](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot){ .md-button } [:fontawesome-brands-discord: Discord](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot){ .md-button }
## Using the Bot ## Using the Bot
Embarking on your journey with Simple Stock Bot is effortless. Just add the bot to your Telegram or Discord group, and you're all set to dive into financial discussions right from your chat! Embarking on your journey with Simple Stock Bot is effortless. Just add the bot to your Telegram or Discord group, and you're all set to dive into financial discussions right from your chat!
Here are some simple commands to get you started: Here are some simple commands to get you started:
- `/intra` to view intraday charts. - `/intra` to view intraday charts.
- `/chart` for a glimpse of the last month's trading data. - `/chart` for a glimpse of the last month's trading data.
- `/trending` to catch up on the latest trending stocks and cryptocurrencies. - `/trending` to catch up on the latest trending stocks and cryptocurrencies.
## Keeping It Free ## Keeping It Free
Simple Stock Bot is a community-supported project, thriving on the contributions from its users. It's sustained entirely through donations to cover server costs and premium market data subscriptions, ensuring it remains free for everyone. Simple Stock Bot is a community-supported project, thriving on the contributions from its users. It's sustained entirely through donations to cover server costs and premium market data subscriptions, ensuring it remains free for everyone.
Feeling generous? You can support the project by [donating](https://simplestockbot.com/donate/), following on [Twitter](https://twitter.com/AnsonBiggs), or contributing on [GitLab](https://gitlab.com/simple-stock-bots/simple-stock-bot). Feeling generous? You can support the project by [donating](https://simplestockbot.com/donate/), following on [Twitter](https://twitter.com/AnsonBiggs), or contributing on [GitLab](https://gitlab.com/simple-stock-bots/simple-stock-bot).
## Dive Deeper ## Dive Deeper
Craving more insights and features? Explore the [official documentation](https://simplestockbot.com/) to uncover all the capabilities of Simple Stock Bot. Craving more insights and features? Explore the [official documentation](https://simplestockbot.com/) to uncover all the capabilities of Simple Stock Bot.
Get ready to elevate your financial discussions with Simple Stock Bot! Your group chats will never be the same again. Get ready to elevate your financial discussions with Simple Stock Bot! Your group chats will never be the same again.
--- ---
Stay tuned for more updates, tips, and financial insights brought to you by Simple Stock Bot. Heres to making every financial discussion enriched and informed! Stay tuned for more updates, tips, and financial insights brought to you by Simple Stock Bot. Heres to making every financial discussion enriched and informed!

View File

@ -1,40 +1,40 @@
--- ---
title: "v2023.1 Release! New Stock Market Data Provider and More!" title: "v2023.1 Release! New Stock Market Data Provider and More!"
date: 2023-10-16 date: 2023-10-16
tags: [Simple Stock Bot, Telegram, Discord, MarketDataApp] tags: [Simple Stock Bot, Telegram, Discord, MarketDataApp]
authors: [Anson] authors: [Anson]
description: > description: >
Discover the latest updates for Simple Stock Bot, including our new integration with MarketData.app for enhanced real-time stock market insights. Discover the latest updates for Simple Stock Bot, including our new integration with MarketData.app for enhanced real-time stock market insights.
--- ---
## 🌐 General Updates: ## 🌐 General Updates:
- **New Home**: We've transitioned to our fresh and updated website at [simplestockbot.com](https://simplestockbot.com/). - **New Home**: We've transitioned to our fresh and updated website at [simplestockbot.com](https://simplestockbot.com/).
- **New Data Provider**: We're excited to announce [MarketData.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web) as our new provider for real-time stock market data, ensuring timely and accurate insights for our users. - **New Data Provider**: We're excited to announce [MarketData.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web) as our new provider for real-time stock market data, ensuring timely and accurate insights for our users.
<!-- more --> <!-- more -->
## 📈 MarketData.app Integration Enhancements: ## 📈 MarketData.app Integration Enhancements:
- We've introduced **additional options** to our MarketData.app integration, ensuring even more precise and varied financial data. - We've introduced **additional options** to our MarketData.app integration, ensuring even more precise and varied financial data.
- **Afterhours Data Fix**: Addressed an issue where after hours stock market data caused errors. - **Afterhours Data Fix**: Addressed an issue where after hours stock market data caused errors.
- **Trending Symbol Accuracy**: Fixed a bug that led to the display of invalid symbols in the `/trending` command. - **Trending Symbol Accuracy**: Fixed a bug that led to the display of invalid symbols in the `/trending` command.
## 🤖 Bot Improvements & Fixes: ## 🤖 Bot Improvements & Fixes:
- **Unified Repository**: To streamline our development and deployment, we've merged the Discord and Telegram bots into a single monorepo. Check it out on [GitLab](https://gitlab.com/simple-stock-bots/simple-stock-bot). Contributions welcome! - **Unified Repository**: To streamline our development and deployment, we've merged the Discord and Telegram bots into a single monorepo. Check it out on [GitLab](https://gitlab.com/simple-stock-bots/simple-stock-bot). Contributions welcome!
- **Inline Functionality Restoration**: Fixed the telegram bot's inline functionality. - **Inline Functionality Restoration**: Fixed the telegram bot's inline functionality.
- **Python Telegram Bot Update**: Migrated to the latest version of `Python Telegram Bot` for superior performance and more features. - **Python Telegram Bot Update**: Migrated to the latest version of `Python Telegram Bot` for superior performance and more features.
- **Rate Limiting Addition**: Implemented rate limiting to ensure optimal performance during peak usage times. - **Rate Limiting Addition**: Implemented rate limiting to ensure optimal performance during peak usage times.
- **SO MUCH MORE**: [Move to Marketdata.app GitLab Issues](https://gitlab.com/simple-stock-bots/simple-stock-bot/-/milestones/3) - **SO MUCH MORE**: [Move to Marketdata.app GitLab Issues](https://gitlab.com/simple-stock-bots/simple-stock-bot/-/milestones/3)
## 📝 Documentation & Repository Overhauls: ## 📝 Documentation & Repository Overhauls:
- **Centralized Documentation**: For convenience and improved maintenance, we've shifted our documentation into the monorepo. - **Centralized Documentation**: For convenience and improved maintenance, we've shifted our documentation into the monorepo.
- **Documentation Refinement**: Updated our documentation to reflect the latest homepage details. - **Documentation Refinement**: Updated our documentation to reflect the latest homepage details.
**Special Mention**: Immense gratitude to our dedicated community for their continual feedback and unwavering support. Dive deeper into the financial realm with Simple Stock Bot! **Special Mention**: Immense gratitude to our dedicated community for their continual feedback and unwavering support. Dive deeper into the financial realm with Simple Stock Bot!
--- ---
📥 For any concerns, queries, or feedback, don't hesitate to [Contact Us](../../contact.md). 📥 For any concerns, queries, or feedback, don't hesitate to [Contact Us](../../contact.md).

View File

@ -1,188 +1,188 @@
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: - Telegram Only :fontawesome-brands-telegram:
- Discord Only :fontawesome-brands-discord: - Discord Only :fontawesome-brands-discord:
- Bot Commands :robot: - Bot Commands :robot:
- Cryptocurrency Support :material-currency-btc: - Cryptocurrency Support :material-currency-btc:
- Stock Market Support :bank: - Stock Market Support :bank:
## Get the Bots ## Get the Bots
[:fontawesome-brands-telegram: Telegram](https://t.me/SimpleStockBot){ .md-button } [:fontawesome-brands-discord: Discord](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot){ .md-button } [:fontawesome-brands-telegram: Telegram](https://t.me/SimpleStockBot){ .md-button } [:fontawesome-brands-discord: Discord](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot){ .md-button }
## Symbol Detection :material-currency-btc: :bank: ## Symbol Detection :material-currency-btc: :bank:
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.
<div class="phone"> <div class="phone">
<div class="messages-wrapper"> <div class="messages-wrapper">
<div class="message to"> <div class="message to">
I wonder how $tsla is affecting the price of $$btc I wonder how $tsla is affecting the price of $$btc
</div> </div>
<div class="message from"> <div class="message from">
The current stock price of Tesla Inc is $866.57, the stock is currently up 1.68% The current stock price of Tesla Inc is $866.57, the stock is currently up 1.68%
</div> </div>
<div class="message from"> <div class="message from">
The current price of Bitcoin is $34,815, the coin is currently down -0.151% for today The current price of Bitcoin is $34,815, the coin is currently down -0.151% for today
</div> </div>
</div> </div>
</div> </div>
## Options Detection :bank: ## Options Detection :bank:
This command allows you to query real-time data for stock options. By simply inputting the stock symbol, strike price, month, and specifying either a call or a put, you can get the latest options data right at your fingertips. For example, `AAPL $220 December call` will provide the current data for Apple's call option with a $220 strike price expiring in December. This command allows you to query real-time data for stock options. By simply inputting the stock symbol, strike price, month, and specifying either a call or a put, you can get the latest options data right at your fingertips. For example, `AAPL $220 December call` will provide the current data for Apple's call option with a $220 strike price expiring in December.
![Image of the telegram bot providing options info.](img/telegram_options.png) ![Image of the telegram bot providing options info.](img/telegram_options.png)
## `/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.
<div class="phone"> <div class="phone">
<div class="messages-wrapper"> <div class="messages-wrapper">
<div class="message to"> <div class="message to">
/donate /donate
</div> </div>
<div class="message from"> <div class="message from">
The current stock price of Tesla Inc is $664.315, the stock is The current stock price of Tesla Inc is $664.315, the stock is
currently down -0.99% currently down -0.99%
</div> </div>
</div> </div>
</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.
<div class="phone"> <div class="phone">
<div class="messages-wrapper"> <div class="messages-wrapper">
<div class="message to"> <div class="message to">
/intra $astr /intra $astr
</div> </div>
<div class="message from"> <div class="message from">
<img src="/img/TgIntraChat.jpg" alt="Tesla Motors Chart" /> <img src="/img/TgIntraChat.jpg" alt="Tesla Motors Chart" />
<p>Intraday chart for $ASTR from 06 Jul at 09:30 to 06 Jul at 15:59</p> <p>Intraday chart for $ASTR from 06 Jul at 09:30 to 06 Jul at 15:59</p>
<p>The current stock price of Astra Space Inc - Class A is $12.47, the stock is currently down -19.39%</p> <p>The current stock price of Astra Space Inc - Class A is $12.47, the stock is currently down -19.39%</p>
</div> </div>
</div> </div>
</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.
<div class="phone"> <div class="phone">
<div class="messages-wrapper"> <div class="messages-wrapper">
<div class="message to"> <div class="message to">
/intra $astr /intra $astr
</div> </div>
<div class="message from"> <div class="message from">
<img src="/img/TgChartChat.jpg" alt="Tesla Motors Chart" /> <img src="/img/TgChartChat.jpg" alt="Tesla Motors Chart" />
<p>1 Month chart for Ethereum from 07, Jun 2021 to 07, Jul 2021</p> <p>1 Month chart for Ethereum from 07, Jun 2021 to 07, Jul 2021</p>
<p>The current price of Ethereum is $2,389.62, the coin is currently up 2.485% for today</p> <p>The current price of Ethereum is $2,389.62, the coin is currently up 2.485% for today</p>
</div> </div>
</div> </div>
</div> </div>
## `/trending` ## `/trending`
Gets the latest trending stocks and their change in price Gets the latest trending stocks and their change in price
<div class="phone"> <div class="phone">
<div class="messages-wrapper"> <div class="messages-wrapper">
<div class="message to"> <div class="message to">
/trending /trending
</div> </div>
<pre class="message from"> <pre class="message from">
🦍Trending on the Stock Bot: 🦍Trending on the Stock Bot:
━━━━━━━━━━━━━━━━━━━━━━━━━━ ━━━━━━━━━━━━━━━━━━━━━━━━━━
$GME: Gamestop Corporation - Class A, 5.06% $GME: Gamestop Corporation - Class A, 5.06%
$MMAT: Meta Materials Inc, 4.77% $MMAT: Meta Materials Inc, 4.77%
$$ $$
BTC: Bitcoin, -0.83% BTC: Bitcoin, -0.83%
$$ETH: Ethereum, 6.06% $$ETH: Ethereum, 6.06%
$$DOGE: Binance-Peg Dogecoin, 0.14% $$DOGE: Binance-Peg Dogecoin, 0.14%
💵Trending Stocks: 💵Trending Stocks:
━━━━━━━━━━━━━━━━ ━━━━━━━━━━━━━━━━
$BBIG: Vinco Ventures Inc, 15.44% $BBIG: Vinco Ventures Inc, 15.44%
$GSAT: Globalstar Inc., -15.32% $GSAT: Globalstar Inc., -15.32%
$AMC: AMC Entertainment Holdings Inc - Class A, 8.77% $AMC: AMC Entertainment Holdings Inc - Class A, 8.77%
$ACIU: AC Immune SA, 16.31% $ACIU: AC Immune SA, 16.31%
$PLTR: Palantir Technologies Inc - Class A, 2.25% $PLTR: Palantir Technologies Inc - Class A, 2.25%
$AAPL: Apple Inc, -0.84% $AAPL: Apple Inc, -0.84%
$XELA: Exela Technologies Inc, 12.61% $XELA: Exela Technologies Inc, 12.61%
$WFC: Wells Fargo & Co., -5.60% $WFC: Wells Fargo & Co., -5.60%
$BAC: Bank Of America Corp., 0.22% $BAC: Bank Of America Corp., 0.22%
$AMD: Advanced Micro Devices Inc., -0.54% $AMD: Advanced Micro Devices Inc., -0.54%
🦎Trending Crypto: 🦎Trending Crypto:
━━━━━━━━━━━━━━━━ ━━━━━━━━━━━━━━━━
$$NFD: Feisty Doge NFT, -34.32% $$NFD: Feisty Doge NFT, -34.32%
$$SLP: Smooth Love Potion, -13.02% $$SLP: Smooth Love Potion, -13.02%
$$PVU: Plant vs Undead Token, -1.27% $$PVU: Plant vs Undead Token, -1.27%
$$XED: Exeedme, 1.02% $$XED: Exeedme, 1.02%
$$SOL: Solana, -3.95% $$SOL: Solana, -3.95%
$$BNB: Binance Coin, -0.25% $$BNB: Binance Coin, -0.25%
$$EWT: Energy Web Token, 17.72% $$EWT: Energy Web Token, 17.72%
</pre> </pre>
</div> </div>
</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.
<div class="phone"> <div class="phone">
<div class="messages-wrapper"> <div class="messages-wrapper">
<div class="message to"> <div class="message to">
/help /help
</div> </div>
<div class="message from"> <div class="message from">
The current stock price of Tesla Inc is $664.315, the stock is The current stock price of Tesla Inc is $664.315, the stock is
currently down -0.99% currently down -0.99%
</div> </div>
</div> </div>
</div> </div>
## `/status` :robot: ## `/status` :robot:
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)
<div class="phone"> <div class="phone">
<div class="messages-wrapper"> <div class="messages-wrapper">
<div class="message to"> <div class="message to">
/status /status
</div> </div>
<pre class="message from"> <pre class="message from">
Bot Status: Bot Status:
It took 0.783369 seconds for the bot to get your message. It took 0.783369 seconds for the bot to get your message.
Stock Market Data: Stock Market Data:
marketdata.app is currently not reporting any issues with its API. marketdata.app is currently not reporting any issues with its API.
Cryptocurrency Data: Cryptocurrency Data:
CoinGecko API responded that it was OK in 0.160962 Seconds. CoinGecko API responded that it was OK in 0.160962 Seconds.
</pre> </pre>
</div> </div>
</div> </div>
## Inline Features :fontawesome-brands-telegram: :material-currency-btc: :bank: ## Inline Features :fontawesome-brands-telegram: :material-currency-btc: :bank:
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
want the bot will send a message as you in that chat with the latest stock price. 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 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. `$` followed by the stock symbol. For example:$tsla would return price information for Tesla Motors.
$$ $$

View File

@ -1,8 +1,8 @@
# I Would Love to Hear From You! # I Would Love to Hear From You!
Your feedback and experience with Simple Stock Bot is invaluable. Whether you've encountered a bug, have a suggestion for improvement, or just want to share your experience, I'm all ears. Here are several ways you can get in touch: Your feedback and experience with Simple Stock Bot is invaluable. Whether you've encountered a bug, have a suggestion for improvement, or just want to share your experience, I'm all ears. Here are several ways you can get in touch:
- **Telegram**: Drop me a message on [Telegram](https://t.me/MisterBiggs). - **Telegram**: Drop me a message on [Telegram](https://t.me/MisterBiggs).
- **Discord**: Feel free to reach out on Discord at `MisterBiggs#0465`. - **Discord**: Feel free to reach out on Discord at `MisterBiggs#0465`.
- **Twitter**: Send me a tweet on [Twitter](https://twitter.com/AnsonBiggs). - **Twitter**: Send me a tweet on [Twitter](https://twitter.com/AnsonBiggs).
- **GitLab**: For technical issues or feature requests, feel free to open an issue on our [GitLab Repository](https://gitlab.com/simple-stock-bots/simple-stock-bot). - **GitLab**: For technical issues or feature requests, feel free to open an issue on our [GitLab Repository](https://gitlab.com/simple-stock-bots/simple-stock-bot).

View File

@ -1,21 +1,21 @@
# Support Simple Stock Bot # Support Simple Stock Bot
Running Simple Stock Bot incurs a yearly expense of about $420, covering server costs and premium market data subscription from [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo). Every donation helps in maintaining the bot and ensuring its continued availability for all users. Running Simple Stock Bot incurs a yearly expense of about $420, covering server costs and premium market data subscription from [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo). Every donation helps in maintaining the bot and ensuring its continued availability for all users.
Your support through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) is greatly appreciated, which accepts both PayPal and Credit Card donations. Your support through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) is greatly appreciated, which accepts both PayPal and Credit Card donations.
For Telegram users, a convenient way to donate is by using the `/donate` [command](commands.md#donate-amount-in-usd). For Telegram users, a convenient way to donate is by using the `/donate` [command](commands.md#donate-amount-in-usd).
Should you have any inquiries, feel free to get in [touch](contact.md). Should you have any inquiries, feel free to get in [touch](contact.md).
## Additional Support: ## Additional Support:
Your engagement also counts as support! Here are other ways to contribute: Your engagement also counts as support! Here are other ways to contribute:
- Stay updated by following me on [Twitter](https://twitter.com/AnsonBiggs). - Stay updated by following me on [Twitter](https://twitter.com/AnsonBiggs).
- Contribute to the project or star it on [GitLab](https://gitlab.com/simple-stock-bots). - Contribute to the project or star it on [GitLab](https://gitlab.com/simple-stock-bots).
- If you plan to host your own bot, consider using my referral links: - If you plan to host your own bot, consider using my referral links:
- [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web) - [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web)
- [DigitalOcean](https://m.do.co/c/6b5df7ef55b6) - [DigitalOcean](https://m.do.co/c/6b5df7ef55b6)
Your support in any form is immensely appreciated and helps in keeping Simple Stock Bot operational and free for everyone. Your support in any form is immensely appreciated and helps in keeping Simple Stock Bot operational and free for everyone.

View File

@ -1,54 +1,54 @@
# Self-Hosting Guide # Self-Hosting Guide
This guide provides step-by-step instructions for setting up and running this project on your local machine, whether for development, testing, or personal use. This guide provides step-by-step instructions for setting up and running this project on your local machine, whether for development, testing, or personal use.
## Get the Bots ## Get the Bots
[:fontawesome-brands-telegram: Telegram](https://t.me/SimpleStockBot){ .md-button } [:fontawesome-brands-discord: Discord](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot){ .md-button } [:fontawesome-brands-telegram: Telegram](https://t.me/SimpleStockBot){ .md-button } [:fontawesome-brands-discord: Discord](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot){ .md-button }
## Pre-requisites ## Pre-requisites
Ensure the following are installed or obtained before proceeding: Ensure the following are installed or obtained before proceeding:
- **[Docker](https://hub.docker.com/?overlay=onboarding)**: The project is containerized using Docker Compose, allowing it to run on any system with Docker installed. - **[Docker](https://hub.docker.com/?overlay=onboarding)**: The project is containerized using Docker Compose, allowing it to run on any system with Docker installed.
- **API Keys**: - **API Keys**:
- **Telegram**: Obtain a free API key by interacting with [BotFather](https://telegram.me/botfather). More details [here](https://core.telegram.org/bots#3-how-do-i-create-a-bot). - **Telegram**: Obtain a free API key by interacting with [BotFather](https://telegram.me/botfather). More details [here](https://core.telegram.org/bots#3-how-do-i-create-a-bot).
- **Discord**: Get a free API key at [https://discord.com/developers](https://discord.com/developers). - **Discord**: Get a free API key at [https://discord.com/developers](https://discord.com/developers).
- **[marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web)**: Sign up to get an API key. A free tier is available and should suffice for private groups. More details [here](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo). - **[marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web)**: Sign up to get an API key. A free tier is available and should suffice for private groups. More details [here](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo).
!!! tip !!! tip
The bot will still operate without a [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo) key but will revert to using only cryptocurrency data. The bot will still operate without a [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo) key but will revert to using only cryptocurrency data.
!!! note !!! note
To enable donation acceptance, obtain a Stripe API key and provide a `STRIPE` key to your bot. [https://stripe.com/]() To enable donation acceptance, obtain a Stripe API key and provide a `STRIPE` key to your bot. [https://stripe.com/]()
## Setup Instructions ## Setup Instructions
1. **Download/Clone the Repository**: 1. **Download/Clone the Repository**:
- Download or clone this repository to your local machine. - Download or clone this repository to your local machine.
2. **Configure Environment Variables**: 2. **Configure Environment Variables**:
- Navigate to the project directory and locate the `.env` file. - Navigate to the project directory and locate the `.env` file.
- Fill in the `.env` file with your obtained API keys: - Fill in the `.env` file with your obtained API keys:
```plaintext ```plaintext
MARKETDATA=your_marketdata_api_key MARKETDATA=your_marketdata_api_key
STRIPE=your_stripe_api_key STRIPE=your_stripe_api_key
TELEGRAM=your_telegram_api_key TELEGRAM=your_telegram_api_key
DISCORD=your_discord_api_key DISCORD=your_discord_api_key
``` ```
Alternatively, pass the variables using Docker Compose environment variables or command-line arguments. Alternatively, pass the variables using Docker Compose environment variables or command-line arguments.
3. **Build and Run the Bot:** 3. **Build and Run the Bot:**
- Open a terminal in the project directory. - Open a terminal in the project directory.
- Build and run both bots using Docker Compose: - Build and run both bots using Docker Compose:
```bash ```bash
docker-compose up docker-compose up
``` ```
Now, your bot(s) should be up and running! If you're unfamiliar with Docker, reviewing the [Docker documentation](https://docs.docker.com/) is highly recommended to gain better control over your bot and understand Docker commands better. Now, your bot(s) should be up and running! If you're unfamiliar with Docker, reviewing the [Docker documentation](https://docs.docker.com/) is highly recommended to gain better control over your bot and understand Docker commands better.

View File

@ -1,41 +1,41 @@
# Elevate Your Groupchats with Real-time Stock Insights # Elevate Your Groupchats with Real-time Stock Insights
Discover a new level of financial discussion with Simple Stock Bot, your go-to solution for real-time stock market and cryptocurrency insights within your Telegram or Discord group chats. Transform your everyday discussions into an interactive financial exploration experience. With Simple Stock Bot, keeping up with the stock market or cryptocurrency trends has never been more seamless and engaging. Discover a new level of financial discussion with Simple Stock Bot, your go-to solution for real-time stock market and cryptocurrency insights within your Telegram or Discord group chats. Transform your everyday discussions into an interactive financial exploration experience. With Simple Stock Bot, keeping up with the stock market or cryptocurrency trends has never been more seamless and engaging.
## Get the Bots ## Get the Bots
[:fontawesome-brands-telegram: Telegram](https://t.me/SimpleStockBot){ .md-button } [:fontawesome-brands-discord: Discord](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot){ .md-button } [:fontawesome-brands-telegram: Telegram](https://t.me/SimpleStockBot){ .md-button } [:fontawesome-brands-discord: Discord](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot){ .md-button }
## [Commands](commands.md) ## [Commands](commands.md)
### Real-Time Stock and Cryptocurrency Updates ### Real-Time Stock and Cryptocurrency Updates
- Get live price updates of stocks and cryptocurrencies. - Get live price updates of stocks and cryptocurrencies.
- Symbol Detection: Use `$` for stocks and `$$` for cryptocurrencies, e.g., `$tsla` for Tesla and `$$btc` for Bitcoin. - Symbol Detection: Use `$` for stocks and `$$` for cryptocurrencies, e.g., `$tsla` for Tesla and `$$btc` for Bitcoin.
### Intraday and Historical Data Visualization ### Intraday and Historical Data Visualization
- `/intra`: View a stock's movement since the last market open or a cryptocurrency's 24-hour chart. - `/intra`: View a stock's movement since the last market open or a cryptocurrency's 24-hour chart.
- `/chart`: Provides a chart of the last month's trading data up till the day before. - `/chart`: Provides a chart of the last month's trading data up till the day before.
### Trending Assets Awareness ### Trending Assets Awareness
- `/trending`: Discover the latest trending stocks and cryptocurrencies and their price changes. - `/trending`: Discover the latest trending stocks and cryptocurrencies and their price changes.
### In-App Assistance and Support ### In-App Assistance and Support
- `/help`: Provides a quick summary of available commands for easy reference. - `/help`: Provides a quick summary of available commands for easy reference.
- `/donate`: Support the maintenance of the bot to ensure continued free access. - `/donate`: Support the maintenance of the bot to ensure continued free access.
### User-Friendly Interaction ### User-Friendly Interaction
- Easy symbol and command usage for a smooth user experience. - Easy symbol and command usage for a smooth user experience.
- Engage with a community of financial enthusiasts and share insights effortlessly. - Engage with a community of financial enthusiasts and share insights effortlessly.
## [Contact](contact.md) ## [Contact](contact.md)
Need assistance or have inquiries? Feel free to reach out and I'll be happy to help. Need assistance or have inquiries? Feel free to reach out and I'll be happy to help.
## Powered by MarketData.app ## Powered by MarketData.app
Simple Stock Bots is able to provide real-time stock market insights thanks to the data supplied by [MarketData.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web). MarketData.app delivers accurate and up-to-date financial data, fueling the bot's capabilities in delivering timely stock quotes, charts, and other market-related information directly to your Telegram or Discord groups. The robust data infrastructure provided by MarketData.app not only ensures the reliability and accuracy of the information you receive but also enables the offering of Simple Stock Bots for free to all users. By leveraging MarketData.app's comprehensive financial data, the goal is to foster informed financial discussions and make market monitoring an effortless and accessible experience for everyone. Simple Stock Bots is able to provide real-time stock market insights thanks to the data supplied by [MarketData.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web). MarketData.app delivers accurate and up-to-date financial data, fueling the bot's capabilities in delivering timely stock quotes, charts, and other market-related information directly to your Telegram or Discord groups. The robust data infrastructure provided by MarketData.app not only ensures the reliability and accuracy of the information you receive but also enables the offering of Simple Stock Bots for free to all users. By leveraging MarketData.app's comprehensive financial data, the goal is to foster informed financial discussions and make market monitoring an effortless and accessible experience for everyone.

View File

@ -1,40 +1,40 @@
/* https://codepen.io/RG/pen/bdfDI */ /* https://codepen.io/RG/pen/bdfDI */
.phone { .phone {
background: none repeat scroll 0 0 #fff; background: none repeat scroll 0 0 #fff;
/*border-left: 1px solid #ccc; /*border-left: 1px solid #ccc;
border-right: 1px solid #ccc;*/ border-right: 1px solid #ccc;*/
color: #ffffff; color: #ffffff;
font-family: sans-serif; font-family: sans-serif;
line-height: 20px; line-height: 20px;
width: 80%; width: 80%;
margin: 0 auto; margin: 0 auto;
overflow-x: hidden; overflow-x: hidden;
position: relative; position: relative;
border-radius: 10px; border-radius: 10px;
margin: 50px; margin: 50px;
} }
.messages-wrapper { .messages-wrapper {
position: relative; position: relative;
} }
.message { .message {
margin: 10px; margin: 10px;
padding: 15px 20px; padding: 15px 20px;
position: relative; position: relative;
overflow-x: auto; overflow-x: auto;
} }
.message.to { .message.to {
border-radius: 20px 0px 20px 20px; border-radius: 20px 0px 20px 20px;
background-color: #2095fe; background-color: #2095fe;
color: #fff; color: #fff;
margin-left: 20%; margin-left: 20%;
} }
.message.from { .message.from {
border-radius: 20px 20px 20px 0px; border-radius: 20px 20px 20px 0px;
background-color: #e5e4e9; background-color: #e5e4e9;
color: #363636; color: #363636;
margin-right: 20%; margin-right: 20%;
} }
.message.to + .message.to, .message.to + .message.to,
.message.from + .message.from { .message.from + .message.from {
margin-top: -7px; margin-top: -7px;
} }

View File

@ -1,72 +1,72 @@
site_name: Simple Stock Bot site_name: Simple Stock Bot
site_url: https://simplestockbot.com site_url: https://simplestockbot.com
repo_url: https://gitlab.com/simple-stock-bots/simple-stock-bot repo_url: https://gitlab.com/simple-stock-bots/simple-stock-bot
repo_name: Simple Stock Bots repo_name: Simple Stock Bots
site_description: Simple Discord and Telegram 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> Available Under an <a href="/LICENSE/">MIT LICENSE</a> </br> copyright: <a href="https://ansonbiggs.com">Anson Biggs</a> 2018 </br> Available Under an <a href="/LICENSE/">MIT LICENSE</a> </br>
nav: nav:
- Home: index.md - Home: index.md
- Commands: commands.md - Commands: commands.md
- Self-Host: host.md - Self-Host: host.md
- Donate: donate.md - Donate: donate.md
- Contact: contact.md - Contact: contact.md
- Blog: blog/index.md - Blog: blog/index.md
theme: theme:
name: material name: material
language: en language: en
features: features:
- navigation.instant - navigation.instant
- navigation.tracking - navigation.tracking
- navigation.tabs - navigation.tabs
- navigation.tabs.sticky - navigation.tabs.sticky
- content.code.copy - content.code.copy
icon: icon:
logo: material/robot-love logo: material/robot-love
palette: palette:
- media: "(prefers-color-scheme: light)" - media: "(prefers-color-scheme: light)"
primary: green primary: green
scheme: default scheme: default
toggle: toggle:
icon: material/lightbulb-outline icon: material/lightbulb-outline
name: Switch to dark mode name: Switch to dark mode
- media: "(prefers-color-scheme: dark)" - media: "(prefers-color-scheme: dark)"
primary: green primary: green
scheme: slate scheme: slate
toggle: toggle:
icon: material/lightbulb icon: material/lightbulb
name: Switch to light mode name: Switch to light mode
extra: extra:
social: social:
- icon: fontawesome/solid/house - icon: fontawesome/solid/house
link: https://simplestockbot.com/ link: https://simplestockbot.com/
- icon: fontawesome/brands/telegram - icon: fontawesome/brands/telegram
link: https://t.me/SimpleStockBot link: https://t.me/SimpleStockBot
name: Get the Telegram bot name: Get the Telegram bot
- icon: fontawesome/brands/discord - icon: fontawesome/brands/discord
link: https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot link: https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot
name: Get the Discord Bot name: Get the Discord Bot
- icon: material/chart-line-stacked - icon: material/chart-line-stacked
link: https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web link: https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web
name: MarketData.app for stock data name: MarketData.app for stock data
extra_css: extra_css:
- stylesheets/phone.css - stylesheets/phone.css
plugins: plugins:
- search - search
- social - social
- blog - blog
markdown_extensions: markdown_extensions:
- attr_list - attr_list
- pymdownx.emoji: - pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg emoji_generator: !!python/name:materialx.emoji.to_svg
- admonition - admonition
- pymdownx.details - pymdownx.details
- pymdownx.superfences - pymdownx.superfences