An open API service indexing awesome lists of open source software.

https://github.com/rasbeetech/stock-checker

API service for checking NASDAQ stock prices.
https://github.com/rasbeetech/stock-checker

expressjs helmetjs javascript mocha-chai mongodb nodejs

Last synced: 3 months ago
JSON representation

API service for checking NASDAQ stock prices.

Awesome Lists containing this project

README

          

Welcome to Stock-Checker 👋



Version

Documentation


Maintenance


License: MIT

> API service for checking NASDAQ stock prices.

## Install

```sh
npm install
```

## Usage

```sh
npm start
```
#### Usage examples:
Retrieve stock price:
```
GET /api/stock-prices?stock=GOOG
```
Retrieve up to 2 stock prices:
```
GET /api/stock-prices?stock=GOOG&stock=MFST
```
Like a stock:
```
GET /api/stock-prices?stock=GOOG&like=true
```
#### Return example:
Query one stock price:
```
{"stockData": {"stock": "GOOG", "price": 2448.89, "likes": 9}}
```
Query two stock prices:
```
{"stockData": [{"stock": "GOOG", "price": 2448.89, "likes": 9}, {"stock": "MFST", "price": 271.89, "likes": 5}]}
```
## Run tests

```sh
npm run test
```

## Author

👤 **RasbeeTech**

* Website: linkedin.com/in/mykalbailey/
* Github: [@RasbeeTech](https://github.com/RasbeeTech)

## Show your support

Give a ⭐️ if this project helped you!

## 📝 License

Copyright © 2021 [RasbeeTech](https://github.com/RasbeeTech).

This project is [MIT](https://github.com/RasbeeTech/Stock-Checker/blob/master/LICENSE) licensed.

***
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_