https://github.com/finstack-dev/morningstar-equity-classification-system
Morningstar Global Equity Classification Structure
https://github.com/finstack-dev/morningstar-equity-classification-system
2019v3 classification equity finstack javascript morningstar npm-package
Last synced: 6 months ago
JSON representation
Morningstar Global Equity Classification Structure
- Host: GitHub
- URL: https://github.com/finstack-dev/morningstar-equity-classification-system
- Owner: finstack-dev
- License: mit
- Created: 2020-06-18T06:36:58.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T09:20:32.000Z (almost 3 years ago)
- Last Synced: 2025-04-19T04:44:42.911Z (6 months ago)
- Topics: 2019v3, classification, equity, finstack, javascript, morningstar, npm-package
- Language: TypeScript
- Homepage: https://github.com/finstack-dev/morningstar-equity-classification-system
- Size: 1.06 MB
- Stars: 4
- Watchers: 0
- Forks: 1
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Morningstar Equity Classification System
This NPM package aims to enable lookups in the reference table of Morningstar as published on their
website.
## Installation
### Yarn
```shell
yarn add morningstar-equity-classification-system
```
### NPM
```shell
npm install morningstar-equity-classification-system
```
## Usage
```javascript
import * as mecs from 'morningstar-equity-classification-system';
mecs.all()
/** Output:
[
{
"superSector": "Cyclical",
"superSectorId": 1,
"description": "..."
},
{
...
}
]
**/
mecs.search('finance');
/** Output:
[
{
"superSector": "...",
"superSectorId": ...,
"sector": "...",
"sectorId": ...,
"industryGroup": "...",
"industryGroupId": ...,
"industry": "...",
"industryId": ...,
"description": "..."
},
{
...
}
]
**/
mecs.find('31169148');
/** Output:
{
"superSector": "...",
"superSectorId": ...,
"sector": "...",
"sectorId": ...,
"industryGroup": "...",
"industryGroupId": ...,
"industry": "...",
"industryId": ...,
"description": "..."
}
**/
mecs.above('31169148');
/** Output:
[
{
"superSector": "...",
"superSectorId": ...,
"sector": "...",
"sectorId": ...,
"industryGroup": "...",
"industryGroupId": ...,
"industry": "...",
"industryId": 31169148,
"description": "..."
},
{
"superSector": "...",
"superSectorId": ...,
"sector": "...",
"sectorId": ...,
"industryGroup": "...",
"industryGroupId": 31169,
"description": "..."
},
{
"superSector": "...",
"superSectorId": ...,
"sector": "...",
"sectorId": 311,
"description": "..."
},
{
"superSector": "...",
"superSectorId": 3,
"description": "..."
}
]
**/
mecs.below('311');
/** Output:
[
{
"superSector": "...",
"superSectorId": ...,
"sector": "...",
"sectorId": ...,
"industryGroup": "...",
"industryGroupId": 31169,
"description": "..."
},
{
"superSector": "...",
"superSectorId": ...,
"sector": "...",
"sectorId": ...,
"industryGroup": "...",
"industryGroupId": ...,
"industry": "...",
"industryId": 31169148,
"description": "..."
}
]
**/
```
