mirror of
https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot.git
synced 2025-06-16 15:06:53 +00:00
new file structure
This commit is contained in:
parent
bbb73c8405
commit
b10517e025
@ -1,3 +1,6 @@
|
|||||||
|
"""Class with functions for running the bot with IEX Cloud.
|
||||||
|
"""
|
||||||
|
|
||||||
import re
|
import re
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
from typing import Optional, List, Tuple, Dict
|
from typing import Optional, List, Tuple, Dict
|
||||||
@ -8,7 +11,7 @@ import schedule
|
|||||||
from fuzzywuzzy import fuzz
|
from fuzzywuzzy import fuzz
|
||||||
|
|
||||||
|
|
||||||
class Symbol:
|
class IEX_Symbol:
|
||||||
"""
|
"""
|
||||||
Functions for finding stock market information about symbols.
|
Functions for finding stock market information about symbols.
|
||||||
"""
|
"""
|
||||||
@ -18,56 +21,6 @@ class Symbol:
|
|||||||
searched_symbols = {}
|
searched_symbols = {}
|
||||||
charts = {}
|
charts = {}
|
||||||
|
|
||||||
license = re.sub(
|
|
||||||
r"\b\n",
|
|
||||||
" ",
|
|
||||||
r.get(
|
|
||||||
"https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot/-/raw/master/LICENSE"
|
|
||||||
).text,
|
|
||||||
)
|
|
||||||
|
|
||||||
help_text = """
|
|
||||||
Thanks for using this bot, consider supporting it by [buying me a beer.](https://www.buymeacoffee.com/Anson)
|
|
||||||
|
|
||||||
Keep up with the latest news for the bot in itsTelegram Channel: https://t.me/simplestockbotnews
|
|
||||||
|
|
||||||
Full documentation on using and running your own stock bot can be found [here.](https://simple-stock-bots.gitlab.io/site)
|
|
||||||
|
|
||||||
**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`.
|
|
||||||
"""
|
|
||||||
|
|
||||||
donate_text = """
|
|
||||||
Simple Stock Bot is run entirely on donations[.](https://www.buymeacoffee.com/Anson)
|
|
||||||
All donations go directly towards paying for servers, and market data is provided by
|
|
||||||
[IEX Cloud](https://iexcloud.io/).
|
|
||||||
|
|
||||||
The easiest way to donate is to run the `/donate [amount in USD]` command with USdollars you would like to donate.
|
|
||||||
|
|
||||||
Example: `/donate 2` would donate 2 USD.
|
|
||||||
An alternative way to donate is through https://www.buymeacoffee.com/Anson,which accepts Paypal or Credit card.
|
|
||||||
If you have any questions get in touch: @MisterBiggs or[anson@ansonbiggs.com](http://mailto:anson@ansonbiggs.com/)
|
|
||||||
|
|
||||||
_Donations can only be made in a chat directly with @simplestockbot_
|
|
||||||
"""
|
|
||||||
|
|
||||||
def __init__(self, IEX_TOKEN: str) -> None:
|
def __init__(self, IEX_TOKEN: str) -> None:
|
||||||
"""Creates a Symbol Object
|
"""Creates a Symbol Object
|
||||||
|
|
191
T_info.py
Normal file
191
T_info.py
Normal file
@ -0,0 +1,191 @@
|
|||||||
|
"""Functions and Info specific to the Telegram Bot
|
||||||
|
"""
|
||||||
|
|
||||||
|
import re
|
||||||
|
import requests as r
|
||||||
|
import pandas as pd
|
||||||
|
|
||||||
|
from typing import List, Dict
|
||||||
|
|
||||||
|
|
||||||
|
class T_info:
|
||||||
|
STOCK_REGEX = "[$]([a-zA-Z]{1,4})"
|
||||||
|
CRYPTO_REGEX = "[$$]([a-zA-Z]{1,9})"
|
||||||
|
|
||||||
|
def find_symbols(self, text: str) -> List[str, str]:
|
||||||
|
"""Finds stock tickers starting with a dollar sign, and cryptocurrencies with two dollar signs
|
||||||
|
in a blob of text and returns them in a list.
|
||||||
|
Only returns each match once. Example: Whats the price of $tsla?
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
text : str
|
||||||
|
Blob of text.
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
List[str]
|
||||||
|
List of stock symbols as strings without dollar sign.
|
||||||
|
"""
|
||||||
|
symbols = list(set(re.findall(self.SYMBOL_REGEX, text)))
|
||||||
|
crypto = list(set(re.findall(self.SYMBOL_REGEX, text)))
|
||||||
|
return
|
||||||
|
|
||||||
|
license = re.sub(
|
||||||
|
r"\b\n",
|
||||||
|
" ",
|
||||||
|
r.get(
|
||||||
|
"https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot/-/raw/master/LICENSE"
|
||||||
|
).text,
|
||||||
|
)
|
||||||
|
|
||||||
|
help_text = """
|
||||||
|
Thanks for using this bot, consider supporting it by [buying me a beer.](https://www.buymeacoffee.com/Anson)
|
||||||
|
|
||||||
|
Keep up with the latest news for the bot in itsTelegram Channel: https://t.me/simplestockbotnews
|
||||||
|
|
||||||
|
Full documentation on using and running your own stock bot can be found [here.](https://simple-stock-bots.gitlab.io/site)
|
||||||
|
|
||||||
|
**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`.
|
||||||
|
"""
|
||||||
|
|
||||||
|
donate_text = """
|
||||||
|
Simple Stock Bot is run entirely on donations[.](https://www.buymeacoffee.com/Anson)
|
||||||
|
All donations go directly towards paying for servers, and market data is provided by
|
||||||
|
[IEX Cloud](https://iexcloud.io/).
|
||||||
|
|
||||||
|
The easiest way to donate is to run the `/donate [amount in USD]` command with USdollars you would like to donate.
|
||||||
|
|
||||||
|
Example: `/donate 2` would donate 2 USD.
|
||||||
|
An alternative way to donate is through https://www.buymeacoffee.com/Anson,which accepts Paypal or Credit card.
|
||||||
|
If you have any questions get in touch: @MisterBiggs or[anson@ansonbiggs.com](http://mailto:anson@ansonbiggs.com/)
|
||||||
|
|
||||||
|
_Donations can only be made in a chat directly with @simplestockbot_
|
||||||
|
"""
|
||||||
|
|
||||||
|
def status(self) -> str:
|
||||||
|
"""Checks IEX Status dashboard for any current API issues.
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
str
|
||||||
|
Human readable text on status of IEX API
|
||||||
|
"""
|
||||||
|
|
||||||
|
def price_reply(self, symbols: list) -> Dict[str, str]:
|
||||||
|
"""Returns current market price or after hours if its available for a given stock symbol.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
symbols : list
|
||||||
|
List of stock symbols.
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
Dict[str, str]
|
||||||
|
Each symbol passed in is a key with its value being a human readable
|
||||||
|
markdown formatted string of the symbols price and movement.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def dividend_reply(self, symbol: str) -> Dict[str, str]:
|
||||||
|
"""Returns the most recent, or next dividend date for a stock symbol.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
symbols : list
|
||||||
|
List of stock symbols.
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
Dict[str, str]
|
||||||
|
Each symbol passed in is a key with its value being a human readable formatted string of the symbols div dates.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def news_reply(self, symbols: list) -> Dict[str, str]:
|
||||||
|
"""Gets recent english news on stock symbols.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
symbols : list
|
||||||
|
List of stock symbols.
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
Dict[str, str]
|
||||||
|
Each symbol passed in is a key with its value being a human readable markdown formatted string of the symbols news.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def info_reply(self, symbols: List[str]) -> Dict[str, str]:
|
||||||
|
"""Gets information on stock symbols.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
symbols : List[str]
|
||||||
|
List of stock symbols.
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
Dict[str, str]
|
||||||
|
Each symbol passed in is a key with its value being a human readable formatted string of the symbols information.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def intra_reply(self, symbol: str) -> pd.DataFrame:
|
||||||
|
"""Returns price data for a symbol since the last market open.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
symbol : str
|
||||||
|
Stock symbol.
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
pd.DataFrame
|
||||||
|
Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def chart_reply(self, symbol: str) -> pd.DataFrame:
|
||||||
|
"""Returns price data for a symbol of the past month up until the previous trading days close.
|
||||||
|
Also caches multiple requests made in the same day.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
symbol : str
|
||||||
|
Stock symbol.
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
pd.DataFrame
|
||||||
|
Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def stat_reply(self, symbols: List[str]) -> Dict[str, str]:
|
||||||
|
"""Gets key statistics for each symbol in the list
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
symbols : List[str]
|
||||||
|
List of stock symbols
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
Dict[str, str]
|
||||||
|
Each symbol passed in is a key with its value being a human readable formatted string of the symbols statistics.
|
||||||
|
"""
|
17
bot.py
17
bot.py
@ -26,7 +26,9 @@ from telegram.ext import (
|
|||||||
CallbackContext,
|
CallbackContext,
|
||||||
)
|
)
|
||||||
|
|
||||||
from functions import Symbol
|
from IEX_Symbol import IEX_Symbol
|
||||||
|
from cg_Crypto import cg_Crypto
|
||||||
|
from T_info import T_info
|
||||||
|
|
||||||
TELEGRAM_TOKEN = os.environ["TELEGRAM"]
|
TELEGRAM_TOKEN = os.environ["TELEGRAM"]
|
||||||
|
|
||||||
@ -41,7 +43,10 @@ except KeyError:
|
|||||||
STRIPE_TOKEN = ""
|
STRIPE_TOKEN = ""
|
||||||
print("Starting without a STRIPE Token will not allow you to accept Donations!")
|
print("Starting without a STRIPE Token will not allow you to accept Donations!")
|
||||||
|
|
||||||
s = Symbol(IEX_TOKEN)
|
s = IEX_Symbol(IEX_TOKEN)
|
||||||
|
c = cg_Crypto()
|
||||||
|
t = T_info()
|
||||||
|
|
||||||
# Enable logging
|
# Enable logging
|
||||||
logging.basicConfig(
|
logging.basicConfig(
|
||||||
format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level=logging.INFO
|
format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level=logging.INFO
|
||||||
@ -53,19 +58,19 @@ print("Bot Online")
|
|||||||
|
|
||||||
def start(update: Update, context: CallbackContext):
|
def start(update: Update, context: CallbackContext):
|
||||||
"""Send a message when the command /start is issued."""
|
"""Send a message when the command /start is issued."""
|
||||||
update.message.reply_text(text=s.help_text, parse_mode=telegram.ParseMode.MARKDOWN)
|
update.message.reply_text(text=t.help_text, parse_mode=telegram.ParseMode.MARKDOWN)
|
||||||
|
|
||||||
|
|
||||||
def help(update: Update, context: CallbackContext):
|
def help(update: Update, context: CallbackContext):
|
||||||
"""Send link to docs when the command /help is issued."""
|
"""Send link to docs when the command /help is issued."""
|
||||||
|
|
||||||
update.message.reply_text(text=s.help_text, parse_mode=telegram.ParseMode.MARKDOWN)
|
update.message.reply_text(text=t.help_text, parse_mode=telegram.ParseMode.MARKDOWN)
|
||||||
|
|
||||||
|
|
||||||
def license(update: Update, context: CallbackContext):
|
def license(update: Update, context: CallbackContext):
|
||||||
"""Return bots license agreement"""
|
"""Return bots license agreement"""
|
||||||
|
|
||||||
update.message.reply_text(text=s.license, parse_mode=telegram.ParseMode.MARKDOWN)
|
update.message.reply_text(text=t.license, parse_mode=telegram.ParseMode.MARKDOWN)
|
||||||
|
|
||||||
|
|
||||||
def status(update: Update, context: CallbackContext):
|
def status(update: Update, context: CallbackContext):
|
||||||
@ -96,7 +101,7 @@ def donate(update: Update, context: CallbackContext):
|
|||||||
|
|
||||||
if update.message.text.strip() == "/donate":
|
if update.message.text.strip() == "/donate":
|
||||||
update.message.reply_text(
|
update.message.reply_text(
|
||||||
text=s.donate_text, parse_mode=telegram.ParseMode.MARKDOWN
|
text=t.donate_text, parse_mode=telegram.ParseMode.MARKDOWN
|
||||||
)
|
)
|
||||||
return
|
return
|
||||||
else:
|
else:
|
||||||
|
499
cg_Crypto.py
Normal file
499
cg_Crypto.py
Normal file
@ -0,0 +1,499 @@
|
|||||||
|
"""Class with functions for running the bot with CoinGecko
|
||||||
|
"""
|
||||||
|
|
||||||
|
import re
|
||||||
|
from datetime import datetime
|
||||||
|
from typing import Optional, List, Tuple, Dict
|
||||||
|
|
||||||
|
import pandas as pd
|
||||||
|
import requests as r
|
||||||
|
import schedule
|
||||||
|
from fuzzywuzzy import fuzz
|
||||||
|
|
||||||
|
|
||||||
|
class cg_Crypto:
|
||||||
|
"""
|
||||||
|
Functions for finding crypto info
|
||||||
|
"""
|
||||||
|
|
||||||
|
SYMBOL_REGEX = "[$]([a-zA-Z]{1,4})"
|
||||||
|
|
||||||
|
searched_symbols = {}
|
||||||
|
charts = {}
|
||||||
|
|
||||||
|
def __init__(self, IEX_TOKEN: str) -> None:
|
||||||
|
"""Creates a Symbol Object
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
IEX_TOKEN : str
|
||||||
|
IEX Token
|
||||||
|
"""
|
||||||
|
self.IEX_TOKEN = IEX_TOKEN
|
||||||
|
if IEX_TOKEN != "":
|
||||||
|
self.get_symbol_list()
|
||||||
|
|
||||||
|
schedule.every().day.do(self.get_symbol_list)
|
||||||
|
schedule.every().day.do(self.clear_charts)
|
||||||
|
|
||||||
|
def clear_charts(self) -> None:
|
||||||
|
"""Clears cache of chart data."""
|
||||||
|
self.charts = {}
|
||||||
|
|
||||||
|
def get_symbol_list(self, return_df=False) -> Optional[pd.DataFrame]:
|
||||||
|
|
||||||
|
raw_symbols = r.get(
|
||||||
|
f"https://cloud.iexapis.com/stable/ref-data/symbols?token={self.IEX_TOKEN}"
|
||||||
|
).json()
|
||||||
|
symbols = pd.DataFrame(data=raw_symbols)
|
||||||
|
|
||||||
|
symbols["description"] = symbols["symbol"] + ": " + symbols["name"]
|
||||||
|
self.symbol_list = symbols
|
||||||
|
if return_df:
|
||||||
|
return symbols, datetime.now()
|
||||||
|
|
||||||
|
def iex_status(self) -> str:
|
||||||
|
"""Checks IEX Status dashboard for any current API issues.
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
str
|
||||||
|
Human readable text on status of IEX API
|
||||||
|
"""
|
||||||
|
status = r.get("https://pjmps0c34hp7.statuspage.io/api/v2/status.json").json()[
|
||||||
|
"status"
|
||||||
|
]
|
||||||
|
|
||||||
|
if status["indicator"] == "none":
|
||||||
|
return "IEX Cloud is currently not reporting any issues with its API."
|
||||||
|
else:
|
||||||
|
return (
|
||||||
|
f"{status['indicator']}: {status['description']}."
|
||||||
|
+ " Please check the status page for more information. https://status.iexapis.com"
|
||||||
|
)
|
||||||
|
|
||||||
|
def message_status(self) -> str:
|
||||||
|
"""Checks to see if the bot has available IEX Credits
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
str
|
||||||
|
Human readable text on status of IEX Credits.
|
||||||
|
"""
|
||||||
|
usage = r.get(
|
||||||
|
f"https://cloud.iexapis.com/stable/account/metadata?token={self.IEX_TOKEN}"
|
||||||
|
).json()
|
||||||
|
try:
|
||||||
|
if (
|
||||||
|
usage["messagesUsed"] >= usage["messageLimit"] - 10000
|
||||||
|
and not usage["payAsYouGoEnabled"]
|
||||||
|
):
|
||||||
|
return "Bot may be out of IEX Credits."
|
||||||
|
else:
|
||||||
|
return "Bot has available IEX Credits."
|
||||||
|
except KeyError:
|
||||||
|
return "**IEX API could not be reached.**"
|
||||||
|
|
||||||
|
def search_symbols(self, search: str) -> List[Tuple[str, str]]:
|
||||||
|
"""Performs a fuzzy search to find stock symbols closest to a search term.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
search : str
|
||||||
|
String used to search, could be a company name or something close to the companies stock ticker.
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
List[tuple[str, str]]
|
||||||
|
A list tuples of every stock sorted in order of how well they match. Each tuple contains: (Symbol, Issue Name).
|
||||||
|
"""
|
||||||
|
|
||||||
|
schedule.run_pending()
|
||||||
|
search = search.lower()
|
||||||
|
try: # https://stackoverflow.com/a/3845776/8774114
|
||||||
|
return self.searched_symbols[search]
|
||||||
|
except KeyError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
symbols = self.symbol_list
|
||||||
|
symbols["Match"] = symbols.apply(
|
||||||
|
lambda x: fuzz.ratio(search, f"{x['symbol']}".lower()),
|
||||||
|
axis=1,
|
||||||
|
)
|
||||||
|
|
||||||
|
symbols.sort_values(by="Match", ascending=False, inplace=True)
|
||||||
|
if symbols["Match"].head().sum() < 300:
|
||||||
|
symbols["Match"] = symbols.apply(
|
||||||
|
lambda x: fuzz.partial_ratio(search, x["name"].lower()),
|
||||||
|
axis=1,
|
||||||
|
)
|
||||||
|
|
||||||
|
symbols.sort_values(by="Match", ascending=False, inplace=True)
|
||||||
|
symbols = symbols.head(10)
|
||||||
|
symbol_list = list(zip(list(symbols["symbol"]), list(symbols["description"])))
|
||||||
|
self.searched_symbols[search] = symbol_list
|
||||||
|
return symbol_list
|
||||||
|
|
||||||
|
def find_symbols(self, text: str) -> List[str]:
|
||||||
|
"""Finds stock tickers starting with a dollar sign in a blob of text and returns them in a list.
|
||||||
|
Only returns each match once. Example: Whats the price of $tsla?
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
text : str
|
||||||
|
Blob of text.
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
List[str]
|
||||||
|
List of stock symbols as strings without dollar sign.
|
||||||
|
"""
|
||||||
|
|
||||||
|
return list(set(re.findall(self.SYMBOL_REGEX, text)))
|
||||||
|
|
||||||
|
def price_reply(self, symbols: list) -> Dict[str, str]:
|
||||||
|
"""Returns current market price or after hours if its available for a given stock symbol.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
symbols : list
|
||||||
|
List of stock symbols.
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
Dict[str, str]
|
||||||
|
Each symbol passed in is a key with its value being a human readable
|
||||||
|
markdown formatted string of the symbols price and movement.
|
||||||
|
"""
|
||||||
|
dataMessages = {}
|
||||||
|
for symbol in symbols:
|
||||||
|
IEXurl = f"https://cloud.iexapis.com/stable/stock/{symbol}/quote?token={self.IEX_TOKEN}"
|
||||||
|
|
||||||
|
response = r.get(IEXurl)
|
||||||
|
if response.status_code == 200:
|
||||||
|
IEXData = response.json()
|
||||||
|
keys = (
|
||||||
|
"isUSMarketOpen",
|
||||||
|
"extendedChangePercent",
|
||||||
|
"extendedPrice",
|
||||||
|
"companyName",
|
||||||
|
"latestPrice",
|
||||||
|
"changePercent",
|
||||||
|
)
|
||||||
|
|
||||||
|
if set(keys).issubset(IEXData):
|
||||||
|
|
||||||
|
try: # Some symbols dont return if the market is open
|
||||||
|
IEXData["isUSMarketOpen"]
|
||||||
|
except KeyError:
|
||||||
|
IEXData["isUSMarketOpen"] = True
|
||||||
|
|
||||||
|
if (
|
||||||
|
IEXData["isUSMarketOpen"]
|
||||||
|
or (IEXData["extendedChangePercent"] is None)
|
||||||
|
or (IEXData["extendedPrice"] is None)
|
||||||
|
): # Check if market is open.
|
||||||
|
message = f"The current stock price of {IEXData['companyName']} is $**{IEXData['latestPrice']}**"
|
||||||
|
change = round(IEXData["changePercent"] * 100, 2)
|
||||||
|
else:
|
||||||
|
message = (
|
||||||
|
f"{IEXData['companyName']} closed at $**{IEXData['latestPrice']}**,"
|
||||||
|
+ f" after hours _(15 minutes delayed)_ the stock price is $**{IEXData['extendedPrice']}**"
|
||||||
|
)
|
||||||
|
change = round(IEXData["extendedChangePercent"] * 100, 2)
|
||||||
|
|
||||||
|
# Determine wording of change text
|
||||||
|
if change > 0:
|
||||||
|
message += f", the stock is currently **up {change}%**"
|
||||||
|
elif change < 0:
|
||||||
|
message += f", the stock is currently **down {change}%**"
|
||||||
|
else:
|
||||||
|
message += ", the stock hasn't shown any movement today."
|
||||||
|
else:
|
||||||
|
message = f"The symbol: {symbol} encountered and error. This could be due to "
|
||||||
|
|
||||||
|
else:
|
||||||
|
message = f"The symbol: {symbol} was not found."
|
||||||
|
|
||||||
|
dataMessages[symbol] = message
|
||||||
|
|
||||||
|
return dataMessages
|
||||||
|
|
||||||
|
def dividend_reply(self, symbol: str) -> Dict[str, str]:
|
||||||
|
"""Returns the most recent, or next dividend date for a stock symbol.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
symbols : list
|
||||||
|
List of stock symbols.
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
Dict[str, str]
|
||||||
|
Each symbol passed in is a key with its value being a human readable formatted string of the symbols div dates.
|
||||||
|
"""
|
||||||
|
|
||||||
|
IEXurl = f"https://cloud.iexapis.com/stable/stock/{symbol}/dividends/next?token={self.IEX_TOKEN}"
|
||||||
|
response = r.get(IEXurl)
|
||||||
|
if response.status_code == 200:
|
||||||
|
IEXData = response.json()[0]
|
||||||
|
keys = (
|
||||||
|
"amount",
|
||||||
|
"currency",
|
||||||
|
"declaredDate",
|
||||||
|
"exDate",
|
||||||
|
"frequency",
|
||||||
|
"paymentDate",
|
||||||
|
"flag",
|
||||||
|
)
|
||||||
|
|
||||||
|
if set(keys).issubset(IEXData):
|
||||||
|
|
||||||
|
if IEXData["currency"] == "USD":
|
||||||
|
price = f"${IEXData['amount']}"
|
||||||
|
else:
|
||||||
|
price = f"{IEXData['amount']} {IEXData['currency']}"
|
||||||
|
|
||||||
|
# Pattern IEX uses for dividend date.
|
||||||
|
pattern = "%Y-%m-%d"
|
||||||
|
|
||||||
|
declared = datetime.strptime(IEXData["declaredDate"], pattern).strftime(
|
||||||
|
"%A, %B %w"
|
||||||
|
)
|
||||||
|
ex = datetime.strptime(IEXData["exDate"], pattern).strftime("%A, %B %w")
|
||||||
|
payment = datetime.strptime(IEXData["paymentDate"], pattern).strftime(
|
||||||
|
"%A, %B %w"
|
||||||
|
)
|
||||||
|
|
||||||
|
daysDelta = (
|
||||||
|
datetime.strptime(IEXData["paymentDate"], pattern) - datetime.now()
|
||||||
|
).days
|
||||||
|
|
||||||
|
return (
|
||||||
|
f"The next dividend for ${self.symbol_list[self.symbol_list['symbol']==symbol.upper()]['description'].item()}"
|
||||||
|
+ f" is on {payment} which is in {daysDelta} days."
|
||||||
|
+ f" The dividend is for {price} per share."
|
||||||
|
+ f"\nThe dividend was declared on {declared} and the ex-dividend date is {ex}"
|
||||||
|
)
|
||||||
|
|
||||||
|
return f"{symbol} either doesn't exist or pays no dividend."
|
||||||
|
|
||||||
|
def news_reply(self, symbols: list) -> Dict[str, str]:
|
||||||
|
"""Gets recent english news on stock symbols.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
symbols : list
|
||||||
|
List of stock symbols.
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
Dict[str, str]
|
||||||
|
Each symbol passed in is a key with its value being a human readable markdown formatted string of the symbols news.
|
||||||
|
"""
|
||||||
|
newsMessages = {}
|
||||||
|
|
||||||
|
for symbol in symbols:
|
||||||
|
IEXurl = f"https://cloud.iexapis.com/stable/stock/{symbol}/news/last/5?token={self.IEX_TOKEN}"
|
||||||
|
response = r.get(IEXurl)
|
||||||
|
if response.status_code == 200:
|
||||||
|
data = response.json()
|
||||||
|
if len(data):
|
||||||
|
newsMessages[symbol] = f"News for **{symbol.upper()}**:\n\n"
|
||||||
|
for news in data:
|
||||||
|
if news["lang"] == "en" and not news["hasPaywall"]:
|
||||||
|
message = f"*{news['source']}*: [{news['headline']}]({news['url']})\n"
|
||||||
|
newsMessages[symbol] = newsMessages[symbol] + message
|
||||||
|
else:
|
||||||
|
newsMessages[
|
||||||
|
symbol
|
||||||
|
] = f"No news found for: {symbol}\nEither today is boring or the symbol does not exist."
|
||||||
|
else:
|
||||||
|
newsMessages[
|
||||||
|
symbol
|
||||||
|
] = f"No news found for: {symbol}\nEither today is boring or the symbol does not exist."
|
||||||
|
|
||||||
|
return newsMessages
|
||||||
|
|
||||||
|
def info_reply(self, symbols: List[str]) -> Dict[str, str]:
|
||||||
|
"""Gets information on stock symbols.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
symbols : List[str]
|
||||||
|
List of stock symbols.
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
Dict[str, str]
|
||||||
|
Each symbol passed in is a key with its value being a human readable formatted string of the symbols information.
|
||||||
|
"""
|
||||||
|
infoMessages = {}
|
||||||
|
|
||||||
|
for symbol in symbols:
|
||||||
|
IEXurl = f"https://cloud.iexapis.com/stable/stock/{symbol}/company?token={self.IEX_TOKEN}"
|
||||||
|
response = r.get(IEXurl)
|
||||||
|
|
||||||
|
if response.status_code == 200:
|
||||||
|
data = response.json()
|
||||||
|
infoMessages[symbol] = (
|
||||||
|
f"Company Name: [{data['companyName']}]({data['website']})\nIndustry:"
|
||||||
|
+ f" {data['industry']}\nSector: {data['sector']}\nCEO: {data['CEO']}\nDescription: {data['description']}\n"
|
||||||
|
)
|
||||||
|
|
||||||
|
else:
|
||||||
|
infoMessages[
|
||||||
|
symbol
|
||||||
|
] = f"No information found for: {symbol}\nEither today is boring or the symbol does not exist."
|
||||||
|
|
||||||
|
return infoMessages
|
||||||
|
|
||||||
|
def intra_reply(self, symbol: str) -> pd.DataFrame:
|
||||||
|
"""Returns price data for a symbol since the last market open.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
symbol : str
|
||||||
|
Stock symbol.
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
pd.DataFrame
|
||||||
|
Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
|
||||||
|
"""
|
||||||
|
if symbol.upper() not in list(self.symbol_list["symbol"]):
|
||||||
|
return pd.DataFrame()
|
||||||
|
|
||||||
|
IEXurl = f"https://cloud.iexapis.com/stable/stock/{symbol}/intraday-prices?token={self.IEX_TOKEN}"
|
||||||
|
response = r.get(IEXurl)
|
||||||
|
if response.status_code == 200:
|
||||||
|
df = pd.DataFrame(response.json())
|
||||||
|
df.dropna(inplace=True, subset=["date", "minute", "high", "low", "volume"])
|
||||||
|
df["DT"] = pd.to_datetime(df["date"] + "T" + df["minute"])
|
||||||
|
df = df.set_index("DT")
|
||||||
|
return df
|
||||||
|
|
||||||
|
return pd.DataFrame()
|
||||||
|
|
||||||
|
def chart_reply(self, symbol: str) -> pd.DataFrame:
|
||||||
|
"""Returns price data for a symbol of the past month up until the previous trading days close.
|
||||||
|
Also caches multiple requests made in the same day.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
symbol : str
|
||||||
|
Stock symbol.
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
pd.DataFrame
|
||||||
|
Returns a timeseries dataframe with high, low, and volume data if its available. Otherwise returns empty pd.DataFrame.
|
||||||
|
"""
|
||||||
|
schedule.run_pending()
|
||||||
|
|
||||||
|
if symbol.upper() not in list(self.symbol_list["symbol"]):
|
||||||
|
return pd.DataFrame()
|
||||||
|
|
||||||
|
try: # https://stackoverflow.com/a/3845776/8774114
|
||||||
|
return self.charts[symbol.upper()]
|
||||||
|
except KeyError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
response = r.get(
|
||||||
|
f"https://cloud.iexapis.com/stable/stock/{symbol}/chart/1mm?token={self.IEX_TOKEN}&chartInterval=3&includeToday=false"
|
||||||
|
)
|
||||||
|
|
||||||
|
if response.status_code == 200:
|
||||||
|
df = pd.DataFrame(response.json())
|
||||||
|
df.dropna(inplace=True, subset=["date", "minute", "high", "low", "volume"])
|
||||||
|
df["DT"] = pd.to_datetime(df["date"] + "T" + df["minute"])
|
||||||
|
df = df.set_index("DT")
|
||||||
|
self.charts[symbol.upper()] = df
|
||||||
|
return df
|
||||||
|
|
||||||
|
return pd.DataFrame()
|
||||||
|
|
||||||
|
def stat_reply(self, symbols: List[str]) -> Dict[str, str]:
|
||||||
|
"""Gets key statistics for each symbol in the list
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
symbols : List[str]
|
||||||
|
List of stock symbols
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
Dict[str, str]
|
||||||
|
Each symbol passed in is a key with its value being a human readable formatted string of the symbols statistics.
|
||||||
|
"""
|
||||||
|
infoMessages = {}
|
||||||
|
|
||||||
|
for symbol in symbols:
|
||||||
|
IEXurl = f"https://cloud.iexapis.com/stable/stock/{symbol}/stats?token={self.IEX_TOKEN}"
|
||||||
|
response = r.get(IEXurl)
|
||||||
|
|
||||||
|
if response.status_code == 200:
|
||||||
|
data = response.json()
|
||||||
|
[data.pop(k) for k in list(data) if data[k] == ""]
|
||||||
|
|
||||||
|
m = ""
|
||||||
|
if "companyName" in data:
|
||||||
|
m += f"Company Name: {data['companyName']}\n"
|
||||||
|
if "marketcap" in data:
|
||||||
|
m += f"Market Cap: {data['marketcap']:,}\n"
|
||||||
|
if "week52high" in data:
|
||||||
|
m += f"52 Week (high-low): {data['week52high']:,} "
|
||||||
|
if "week52low" in data:
|
||||||
|
m += f"- {data['week52low']:,}\n"
|
||||||
|
if "employees" in data:
|
||||||
|
m += f"Number of Employees: {data['employees']:,}\n"
|
||||||
|
if "nextEarningsDate" in data:
|
||||||
|
m += f"Next Earnings Date: {data['nextEarningsDate']}\n"
|
||||||
|
if "peRatio" in data:
|
||||||
|
m += f"Price to Earnings: {data['peRatio']:.3f}\n"
|
||||||
|
if "beta" in data:
|
||||||
|
m += f"Beta: {data['beta']:.3f}\n"
|
||||||
|
infoMessages[symbol] = m
|
||||||
|
else:
|
||||||
|
infoMessages[
|
||||||
|
symbol
|
||||||
|
] = f"No information found for: {symbol}\nEither today is boring or the symbol does not exist."
|
||||||
|
|
||||||
|
return infoMessages
|
||||||
|
|
||||||
|
def crypto_reply(self, pair: str) -> str:
|
||||||
|
"""Returns the current price of a cryptocurrency
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
pair : str
|
||||||
|
symbol for the cryptocurrency, sometimes with a price pair like ETHUSD
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
str
|
||||||
|
Returns a human readable markdown description of the price, or an empty string if no price was found.
|
||||||
|
"""
|
||||||
|
|
||||||
|
pair = pair.split(" ")[-1].replace("/", "").upper()
|
||||||
|
pair += "USD" if len(pair) == 3 else pair
|
||||||
|
|
||||||
|
IEXurl = f"https://cloud.iexapis.com/stable/crypto/{pair}/quote?token={self.IEX_TOKEN}"
|
||||||
|
|
||||||
|
response = r.get(IEXurl)
|
||||||
|
|
||||||
|
if response.status_code == 200:
|
||||||
|
data = response.json()
|
||||||
|
|
||||||
|
quote = f"Symbol: {data['symbol']}\n"
|
||||||
|
quote += f"Price: ${data['latestPrice']}\n"
|
||||||
|
|
||||||
|
new, old = data["latestPrice"], data["previousClose"]
|
||||||
|
if old is not None:
|
||||||
|
change = (float(new) - float(old)) / float(old)
|
||||||
|
quote += f"Change: {change}\n"
|
||||||
|
|
||||||
|
return quote
|
||||||
|
|
||||||
|
else:
|
||||||
|
return ""
|
Loading…
x
Reference in New Issue
Block a user