@seedalpha/ticker/README.md

ticker parser of seedalpha

# seed-ticker

module providing ticker parsing, stock lookup and stock information (eg. keywords) for content searching / matching

## Changelog

`1.4.0`@`2016-07-12`

- support CapIQ style pattern `eg: KOSDAQ:A093190`

`1.3.2`@`2016-07-05`

- add try catch for handling huge documents

`1.3.0`@`2016-06-20`

- pre-implementation of findTickers function

`1.2.0`@`2016-06-17`

- release for new datasets:
  - china (shenzhen)
  - korea
- update roadmap for datasets to add in the future

`1.1.0`@`2016-06-16`

- release for new datasets, now includes:
  - hong kong (main, gem)
  - us (nasdaq, nyse, amex)
  - london
  - japan
  - australia
  - china (shanghai)

`1.0.0`@`2016-06-10`

- first release

## Roadmap

- [ ] new function to expose supported exchanges & ticker formatting
- [ ] new function to find tickers inside a content piece (such as research)
- [ ] dataset for *Taiwan*, *Singapore*, *Indonesia*, *Philippines*
- [ ] new function to get historical data from external source for a ticker
- [ ] add sector to dataset
- [ ] add keywords to dataset
- [ ] support keywords in _getTerms_ function, to provide better information (hints) for searching/matching
- [ ] add relationships between stocks (same company listed in multi-countries, subsidiary companies, supply chain etc)

## Installation

```bash
$ npm install seed-ticker -SE
```

## Usage

```javascript
var ticker = require('seed-ticker');
var detail = ticker.parse('0005 hk');
ticker.lookup(detail, function(err, result) {
  ticker.getTerms(result, function(err, terms) {
    // use the terms returned to search/match
  });
});
```

## Developing / Testing

```bash
$ git clone git@github.com:seedalpha/ticker.git
$ cd ticker
$ npm test
```

## Authors

Marvin Lam <lam@seedalpha.net>

## License

[Copyright © 2016 SeedAlpha, All rights reserved.](LICENSE.md)