Nonflavored Prescription Medicine

    terminal-stocks

    1.0.8 • Public • Published

    terminal-stocks

    terminal-stocks is a terminal based application that provide 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.shashi.dev/<TICKER>

    Example

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

    terminal-stocks

    TIP

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

    terminal-stocks

    Note

    • This app uses the yahoo finance to fetch information. Please provide ticker for yahoo finance.

    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.herokuapp.com/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.herokuapp.com/market-summary

    terminal-stocks

    Tech

    • [node.js] - evented I/O for the backend
    • [Express] - fast node.js network app framework [@tjholowaychuk]

    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.

    Upvote on Product Hunt

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

    Happy Coding!!!

    Keywords

    none

    Install

    npm i terminal-stocks

    DownloadsWeekly Downloads

    13

    Version

    1.0.8

    License

    ISC

    Unpacked Size

    288 kB

    Total Files

    24

    Last publish

    Collaborators

    • shweshi