1.0.19 • Published 1 year ago
terminal-stocks v1.0.19
terminal-stocks
terminal-stocks is a terminal first application that provides stock price information. Read more here: https://blog.shashi.dev/2021/01/track-stock-market-information-right-in.html
Documentation
https://shashi.dev/terminal-stocks
How to use
$ curl terminal-stocks.dev/<TICKER>
Example
$ curl terminal-stocks.dev/ITC.NS
TIP
- You can also pass comma separated list of tickers
$ curl terminal-stocks.dev/ITC.NS,INFY.NS,WIPRO.NS
Note
- This app uses https://finance.yahoo.com/ to fetch information. Please provide a ticker symbol from yahoo finance to fetch the ticker's market data
CLI Usage
You can use the terminal-stocks command line interface (cli)
- install cli globaly
npm i terminal-stocks -g
- run the commands to get informations
Available commands
terminal-stocks --help // to get help
terminal-stocks --version // to see the version
terminal-stocks -t [ticker] // to see current price information of the stock
terminal-stocks --ticker [ticker] // to see current price information of the stock
terminal-stocks --ticker -ms [ticker] // to see current price information of the stock, including market state (open/closed)
terminal-stocks -t [ticker] --historical [domain] // to see the historical price information of stock
terminal-stocks --tickers ITC.NS,INFY.NS // to get the current prices of the multiple stocks
terminal-stocks -m // to see the market summary
terminal-stocks --market // to see the market summary
terminal-stokcs --market --json // to export the data as json file
terminal-stokcs --market --csv // to expor the data as csv file
Example
terminal-stocks -t ITC.NS
View Historical data
Example
$ curl terminal-stocks.dev/historical/ITC.NS
- By default it shows 10 entries. This api is paginated so you can use ?page=2 to view next entries.
View Market Summary
Example
$ curl terminal-stocks.dev/market-summary
Tech
- node.js - evented I/O for the backend
- Express - fast node.js network app framework @tjholowaychuk
- node-yahoo-finance2 - community API for Yahoo-Finance
Installation
Requires Node.js v8+ to run. Install the dependencies and devDependencies and start the server.
$ git clone "https://github.com/shweshi/terminal-stocks"
$ npm install
$ npm run serve
Development
Want to contribute? Great! Feel free to open a PR.
Support
Happy Coding!!!
1.0.19
1 year ago
1.0.18
1 year ago
1.0.17
1 year ago
1.0.16
2 years ago
1.0.15
2 years ago
1.0.14
2 years ago
1.0.13
2 years ago
1.0.9
3 years ago
1.0.11
2 years ago
1.0.10
3 years ago
1.0.12
2 years ago
1.0.8
4 years ago
1.0.7
4 years ago
1.0.6
4 years ago
1.0.5
4 years ago
1.0.4
4 years ago
1.0.3
4 years ago
1.0.2
4 years ago
1.0.1
4 years ago
1.0.0
4 years ago