https://github.com/makevoid/stonks-alert
Stock and crypto alerts SMS app
https://github.com/makevoid/stonks-alert
alert alphavantage background-process bot crypto ruby sms sms-alert stock stocks stonks ticker ticker-symbols tickers twilio twilio-sms
Last synced: 5 months ago
JSON representation
Stock and crypto alerts SMS app
- Host: GitHub
- URL: https://github.com/makevoid/stonks-alert
- Owner: makevoid
- Created: 2021-02-20T20:41:49.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-12-21T21:58:09.000Z (almost 4 years ago)
- Last Synced: 2025-03-25T06:02:48.075Z (7 months ago)
- Topics: alert, alphavantage, background-process, bot, crypto, ruby, sms, sms-alert, stock, stocks, stonks, ticker, ticker-symbols, tickers, twilio, twilio-sms
- Language: Ruby
- Homepage:
- Size: 307 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# stonks-alert
Stock alerts SMS app
### Features
- simple, ~ 200 LoC program
- stock prices feed from alphavantage
- twilio SMS alerts
- redis dev cache
### Price feed details
You don't need a Pro account if you're ok with some delay (prices being checked once every ~10m)
### Redis DB
this application requires a redis instance running locally
### Twilio accounts alerts setup
- Twilio account
- A number registered with SMS capabilities
- API keys configured
### Config
Edit `config/stonks.rb` and replace the configuration with the ticker symbols you want to watch.
The keys of the config hash are the ticker symbols.
The values contain the alerts thresholds, low and high. Whenever the price crosses these values (on one direction or on the other) an SMS alert will be triggered.
### Env vars / secret files
This app can be configured with environment variables and secret files, note env vars take precedence.
#### `SMS_RECIPIENTS` / `~/.stonks_sms_recipients`
pipe separated list of numbers receiving the sms, if you want just one number just use the number, no spaces with international prefix e.g. `+4412345678`
#### `ALPHA_VANTAGE_KEY` / `~/.alphavantage-stonks-key`
alphavantage api key
#### `TWILIO_NUMBER` / `~/.twilio_number`
twilio number you registered (see prereqs.)
#### `TWILIO_KEYS` / `~/.twilio_keys`
twilio credentials, pipe separated - `TWILIO_SID|TWILIO_TOKEN` - e.g. `AC12762bf81fca007e3a6399bce2886932|fb5456bfc88774839f2d4d74bdf48817`
---
hope this helps :)
have fun!
@makevoid