https://github.com/ihadeed/intrinio

NodeJS Client for Intrinio
https://github.com/ihadeed/intrinio

Last synced: 13 days ago
JSON representation

NodeJS Client for Intrinio

• Host: GitHub
• URL: https://github.com/ihadeed/intrinio
• Owner: ihadeed
• Created: 2017-04-23T17:38:15.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-04-24T12:56:38.000Z (over 7 years ago)
• Last Synced: 2024-10-26T09:08:25.421Z (2 months ago)
• Language: TypeScript
• Size: 5.86 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Intrinio

Unofficial NodeJS SDK for Intrinio

## Installation

```shell

npm i --save intrinio

```

## Usage

### Vanilla Javascript

```js

var Intrinio = require('intrinio');

var intrinio = new Intrinio(username, password);

```

### ES6 / Typescript

```ts

import Intrinio from 'intrinio';

const intrinio = new Intrinio(username, password);

```

## API Reference

### queryCompanies

```ts

// signature

queryCompanies(query, options?)

// example

intrinio.queryCompanies('GOO', { page_size: 10 })

  .then(data => console.log('Data is ', data))

  .catch(e => console.log('Error getting data ', e));

```

Query companies

- **query**: the query (string)

- **options**: optional options (object)

### getCompanyByTicker

```ts

// signature

getCompanyByTicker(ticker: string, options?)

// example

intrinio.getCompanyByTicker('GOOGL')

  .then(data => console.log(data))

  .catch(e => console.log(e));

```

Get company profile by ticker

- **ticker**: company's ticker (string)

- **options**: optional options (object)

### watchPrices

```ts

// signature

watchPrices(ticker, options?, interval?)

// example

let watch = intrinio.watchPrices('GOOGL').subscribe(data => console.log('Got new data for GOOGL', data));

// call .unsubscribe to stop watching price

watch.unsubscribe();

```

Watch price for a ticker.

- **ticker**: company's ticker (string)

- **options**: optional options (object)

- **interval**: number of milliseconds between each check (number), defaults to `10000`

### getSecurityById

```ts

getSecurityById(id, options?)

```

### querySecurities

```ts

querySecurities(query, options?)

```