# unibit-js

> Interface to Unibit API

Latest version **1.0.1** (published 2020-02-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install unibit-js
pnpm add unibit-js
yarn add unibit-js
bun add unibit-js
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2020-02-03 |
| First published | 2019-03-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 35.3 KB |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 13 |
| Author | Chenfeng Liu |
| Maintainers | chenfengliu |
| Keywords | unibit, stock news api, free stock api, stock market data api, stock api, historical stock prices, news api, forex api, stock market data, historical stock price data, currency conversion api, free news api, stock market data download excel, crypto api, exchange rate api, cryptocurrency historical data, yahoo finance api, cryptocurrency data, financial data api, google finance api, alternative data, stock market news, stock news, stock valuation, stock sentiment, deep learning for event-driven stock prediction dataset, machine learning datasets, business news, stock market indices historical data, dividend stock split api, stock data, stock list, data driven news, S&P 500 list, nasdaq stock list, nasdaq api, list of dow jones stocks, sentiment api, portfolio tracking, crypto news, asset management software, free asset management software, avearge p/e by industry, cusip lookup, comodity prices, isin lookup, mutual fund prices |

## Links

- npm: https://www.npmjs.com/package/unibit-js
- Repository: https://github.com/unibit-api/unibit-js
- Homepage: https://github.com/unibit-api/unibit-js#readme
- Issues: https://github.com/unibit-api/unibit-js/issues
- npm.io page: https://npm.io/package/unibit-js

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^0.19.0

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2020-02-03
- 1.0.0 — 2020-02-03
- 0.2.2 — 2019-06-27
- 0.2.1 — 2019-06-26
- 0.1.2 — 2019-03-21
- 0.1.1 — 2019-03-20
- 0.1.0 — 2019-03-20

## README

# unibit

*A Javascript module to get stock data and news from the UniBit API*

UniBit is a free API that provides real time and historical financial data, as well as financial news. This SDK is a quick starter for the UniBit API (https://www.unibit.ai) which has Javascript functions (return a Promise) for each available API call. For the UniBit API documentation, visit (https://unibit.ai/docs/V2.0/introduction)

To get started, sign up at (https://unibit.ai/signin) to request a free access key. With a free key, all non-news API features are available with generous rate limits.

The UniBit Stock News API requires a premium account, but in return gives a wealth of news articles on all 8000 US-listed companies. Along with this, UniBit provides analyses on each news article. With deep learning, each article is classified into a comprehensive genre list, and named entities and sentiment are also extracted. 

## Install
To install UniBit, type:
```shell
npm install --save unibit-js
```

## Examples

Get the real time price of Apple (AAPL)

```javascript
const unibit = require("unibit-js")({ AccessKey: "demo" }).v2;

params = {
  tickers: "AMZN",
}
unibit.stockPrice.getPricesRealTime(params)
  .then(data => {
    console.log(data);
  })
  .catch(error => {
    console.log(error);
  });
```

Get Apple's Company Profile

```javascript
const unibit = require("unibit-js")({ AccessKey: "demo" }).v2;

params = {
  tickers: "AMZN"
};
unibit.companyInfo.getCompanyProfile(params)
  .then(data => {
    console.log(data);
  })
  .catch(error => {
    console.log(error);
  });
```

Get the latest news on Apple

```javascript
const unibit = require("unibit-js")({ AccessKey: "demo" }).v2;

params = {
  tickers: "AMZN"
};
unibit.companyInfo.getStockNews(params)
  .then(data => {
    console.log(data);
  })
  .catch(error => {
    console.log(error);
  });
```
## Contribute

In the UniBit Javascript SDK, we not only want to wrap the UniBit API, but open source methods of stock analysis, be it with some fancy quantitative strategy, with graphing, or with machine learning. Propose something in an issue or contact me at chenfeng@unibit.ai if you want to help!

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