Need Package Maintenance

    stockfinder
    TypeScript icon, indicating that this package has built-in type declarations

    3.1.1 • Public • Published

    Contributors Forks Stargazers Issues MITLicense LinkedIn FOSSA Status


    Logo

    Stock Finder

    A fast way to query IEX Cloud to find recent stock data.
    Explore the docs »

    View Demo · Stock-Finder Bug · Request Feature

    Table of Contents

    About The Project

    I created this project to easily query the IEX Cloud database of stock information for my own use. I originally started by looking for packages that already offered this and there was none that was updated. I then created this package to allow for a much more streamlined approach to do this.

    Built With

    Getting Started

    To get started with using this package follow these steps.

    Prerequisites

    You need to have the latest version of NPM for this project to work.

    • npm
    npm install npm@latest -g

    Installation

    1. Clone the Stock-Finder
    git clone https://github.com/austinmccalley/Stock-Finder.git
    1. Install NPM packages
    npm install
    1. Build JS File
    tsc

    Usage

    Here is a code sample of how to do a simple request for $TSLA stock information using the package with the getStock() function.

    const stockFinder = require('stockfinder');
    
    /*
      Declare the Stock Finder with
      the parameters you want
    */
    const sf = new stockFinder('stable', 'TSLA', apiKey, false);
    
    /*
      Call the get stock function and then wait
      for the promise to return
    */
    sf.getStock().then(res => {
      console.log(res)
    });

    If you want to get multiple stocks you will use the getStocks() function.

    const stockFinder = require('stockfinder');
    
    /*
      Declare the Stock Finder with
      the parameters you want
    */
    const sf = new stockFinder('stable', ['TSLA','AAPL'], apiKey, false);
    
    /*
      Call the get stocks function and then wait
      for the promise to return
    */
    sf.getStocks().then(res => {
      console.log(res)
    });

    Note

    Sometimes IEX Cloud has issues with normal requests, you can switch to using a CURL request instead by following the example.

    const stockFinder = require('stockfinder');
    
    /*
      Declare the Stock Finder with
      the parameters you want
    */
    const sf = new stockFinder('stable', 'TSLA', apiKey, true);
    
    /*
      Call the get stock function and then wait
      for the promise to return
    */
    sf.getStock().then(res => {
      console.log(res)
    });

    Roadmap

    See the open issues for a list of proposed features (and known issues).

    Contributing

    Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

    1. Fork the Project
    2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
    3. Commit your Changes (git commit -m 'Add some AmazingFeature')
    4. Push to the Branch (git push origin feature/AmazingFeature)
    5. Open a Pull Request

    License

    Distributed under the MIT License. See LICENSE for more information.

    FOSSA Status

    Contact

    Austin McCalley - austin@austinmccalley.com

    Project Link: https://github.com/austinmccalley/Stock-Finder

    Install

    npm i stockfinder

    DownloadsWeekly Downloads

    11

    Version

    3.1.1

    License

    MIT

    Unpacked Size

    33.9 kB

    Total Files

    18

    Last publish

    Collaborators

    • mrmcaustin1