# react-stock-crawler

> A lightweight react component that gets stock data periodically and displays a list of stocks that crawls from right to left. It uses the Finnhub API [(https://finnhub.io/docs/api)](https://finnhub.io/docs/api) to fetch the stock data, hence, an api key

Latest version **0.1.4** (published 2020-08-03) · 0 weekly downloads

## Install

```sh
npm install react-stock-crawler
pnpm add react-stock-crawler
yarn add react-stock-crawler
bun add react-stock-crawler
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2020-08-03 |
| First published | 2020-08-02 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | steffy-lo, victoria-lo |

## Links

- npm: https://www.npmjs.com/package/react-stock-crawler
- npm.io page: https://npm.io/package/react-stock-crawler

## Recent versions

- 0.1.4 (latest) — 2020-08-03
- 0.1.3 — 2020-08-03
- 0.1.2 — 2020-08-03
- 0.1.1 — 2020-08-03
- 0.1.0 — 2020-08-02

## README

A lightweight react component that gets stock data periodically and displays a list of stocks that crawls from right to left.
It uses the Finnhub API [(https://finnhub.io/docs/api)](https://finnhub.io/docs/api) to fetch the stock data, hence, an api key is needed to use this component which will be passed in through props.

<img src = "https://github.com/steffy-lo/react-stock-crawler/blob/master/stock.gif?raw=true" alt="Gif not loading"/>

## Getting Started

1. Install the package
   `npm install react-stock-crawler`

2. Install peer dependencies
   `npm install react-ticker`

## Props

- `stocks` A list of stocks represented by their ticker symbol (Maximum Length = 7)
- `apiKey` Your api key to use the [Finnhub API](https://finnhub.io/docs/api)

## Example Usage

```
import StockCrawler from 'react-stock-crawler/dist'

function App() {
  return (
    <StockCrawler stocks={['AAPL', 'MSFT']} apiKey={"API_KEY"} />
  );
}

export default App;

```

---
_Source: https://npm.io/package/react-stock-crawler · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._