Socket
Socket
Sign inDemoInstall

terminal-stocks

Package Overview
Dependencies
204
Maintainers
2
Versions
17
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

terminal-stocks

Fetch stock price information on terminal


Version published
Maintainers
2
Weekly downloads
5
decreased by-28.57%

Weekly downloads

Readme

Source

terminal-stocks

terminal-stocks is a terminal based application that provides stock price information. Read more here: https://blog.shashi.dev/2021/01/track-stock-market-information-right-in.html

terminal-stocks

Documentation

https://shashi.dev/terminal-stocks

How to use

$ curl terminal-stocks.dev/<TICKER>

Example

$ curl terminal-stocks.dev/ITC.NS
terminal-stocks

TIP

  • You can also pass comma separated list of tickers
$ curl terminal-stocks.dev/ITC.NS,INFY.NS,WIPRO.NS
terminal-stocks

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 -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
terminal-stocks
  • 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
terminal-stocks

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

Terminal Stocks - Track stock market right in your terminal | Product Hunt

Buy Me A Coffee

Happy Coding!!!

Keywords

FAQs

Last updated on 09 May 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc