This is a proof of concept at the moment. It's a Slack bot that wraps around the Yahoo Finance API to display "real time" (Delayed 15 minutes) financial data. This project should not be considered production ready, it's a little rough around the edges. If you find any bugs, please file an issue.
Clone this repository
git clone https://github.com/TNowalk/stock-slack-bot.git && cd $_
Install node modules (Note: Node v6+ required)
npm install
Copy the default configuration file
cp config.default.js config.js
Update with your configuration, it should look similar to this
'use strict';
const config = {
slack: {
token: 'xoxb-your-token-goes-here',
autoReconnect: true,
},
port: 3000,
};
module.exports = config;
The autoReconnect configuration is a boolean that indicates whether the bot should automatically reconnect if the websocket drops.
Alternatively, you can use environmental variables. The bot will use environment variables first and will fall back to the config.js file if no variables were found. The following environmental variables can be set:
SLACK_TOKEN=xoxb-your-token-goes-here
SLACK_AUTO_RECONNECT=true
PORT=true
Finally, run the app
npm run
- Add more commands
- Annotate the codebase
- Add tests and coverage reports (badges)
- See issues list
Have an idea? Submit an issue.
As time goes on, the plan is to add more commands to try and make this tool as helpful as possible. Below is a list of commands that the bot currently supports.
All commands can be run in any channel that the bot has been invited to, or in a direct message with the bot. When running a command in a public channel, or in a multi-person direct messages it must be directed towards the bot.
@stockbot quote $AAPL
If in a direct message with the bot, the command does not need to be directed towards the bot.
quote $AAPL
Most commands support multiple symbols and will return a formatted message for each matched symbol found.
Note: Symbol names are case insensitive, so $aapl will also match for all commands
Provide helpful text for how to use the commands. Will automatically expand the list of commands as new commands are installed.
Example usage
help
Example usage for help with a specific command
help quote
The bot will passively listen to any Slack channel it has been invited to. It checks every message into the channel for a pattern of $ followed by a string of letters (e.g. $AAPL). If it detects this pattern, it attempts to query the Yahoo! Finance API to get the snapshot for the found symbol(s) and returns information about the matched symbol including current price (15 minute delayed), last trade time, daily range, and current volume. The bot can match multiple symbols and will respond with multiple snapshots.
Example usage
Hey, you should check out $AAPL!
Example usage for multiple symbols
I sure did, but did you see $YHOO and $GOOG?
The Quote command can be triggered by sending a message with the word quote or q and the symbol(s) in a channel the bot is in or in a direct message. The quote is nearly identical to a snapshot but also includes a graph of the current day's trading activity.
Triggers: quote, q
Multiple: Yes
Example usage
quote $AAPL
The Historical command is triggered by sending a message to the bot with historical or h along with the symbol and optionally a number of days, a single date, or a range of dates. The response will include a formatted table with a row for each date the symbol was traded that includes the date, open and close prices, high and low prices, volume, and the adjusted close price. A chart for the time period will also be included. By default, if no arguments are passed in the default length of time is the last 5 days. Note that the number of days provided won't necessarily return the same number of rows, for example if it is Monday and you run the command without any arguments it will return results for the last 5 days. Because Saturday and Sunday are not trading days, only 3 or 4 rows will be included. If it's after market close, today's row will be returned and you'll have 4 rows, if the market is still open then only 3 rows will be returned.
Triggers:historical, h
Multiple: No
Options:
30dor30 days- Last 30 days<date>- Results from date until today<date> <date>- Results from first date to second date
Example usage
historical $AAPL 30 days
Other examples
historical $AAPL 45d
historical $AAPL 2016-04-01
historical $AAPL 2016-04-01 2016-05-01
The Analysis can be called using analyze or a and the symbol(s) to look up. The goal is to keep this command as non opinionated as possible, but there are certain thresholds that had to be defined. At some point, these thresholds may be moved to a config file and you can define your own thresholds to customize this to your own trading preferences. The return payload for this function will provide a wide array of data from current price, eps, market capital, current volume vs average volume, support and resistance levels, trending, returns, simple averages, and other data points used to provide a quick heads up analysis of a stock.
Triggers: analyze, a
Multiple: Yes
Example usage
analyze $AAPL
The Variance command can be triggered using either variance or v and is used to get the price variation between two dates. Similar to the Historical command, you can pass the timeframe in a number of ways. The returned data includes the open price for the first date, close price for the second date, the price variance between the two as well as the highest and lowest values for the timeframe.
Triggers:variance, v
Multiple: No
Options:
30dor30 days- Last 30 days<date>- Results from date until today<date> <date>- Results from first date to second date
Example usage
variance $AAPL 30 days
Other examples
variance $AAPL 45d
variance $AAPL 2016-04-01
variance $AAPL 2016-04-01 2016-05-01
The Watchlist command is triggered using watchlist, wl, or w. This command is used to add or remove symbols from a user's watchlist. The eventual goal is to use the watchlist to perform other actions, such as bulk snapshots of all symbols on the watchlist, automated alerts (#4, #7, #8, & #15).
Triggers:watchlist, wl, w
Multiple: No
Example usage with no watched symbols
watchlist
Example usage for adding a symbol
watchlist add $AAPL $SPY $GOOG
Example usage for adding a symbol
watchlist remove $GOOG
Example usage for listing symbols
watchlist
Symbols that are in a user's watchlist/portfolio will generate automatic alerts when certain criteria are met. Users will be alerted once per day for each type of alert.
When a stock's current price is ±5% than the open price, the bot will direct message all users watching the stock. If the price gains/loses 5% from the open price and keeps going in the same direction, the user will receive a single alert. A user can be notified multi times if the price fluctuates. For example, if the price falls below -5% from the open price the user will receive a notification. If the price climbs and again falls below -5% the user will not receive a second notification. If the price then rises over 5% from the open price the user will receive a new notification for the price rise and the notification for the price fall will be reset, meaning if the price once again falls back below -5% from the open price the user will receive a third notification and the price rise notification is reset.
Prices are checked every 5 minutes.
I'd like to take a few moments to shout out to the various people and tools that provided inspiration for this bot.
- Shaun Burdick's Slack Game Bot for providing the boilerplate code for setting up a Slack RTM bot
- Quotr for providing the base inspiration for the bot
- Botkit for providing the base lib for working with the Slack RTM API
- Slack for providing an incredibly awesome and easy to use API