Skip to content

Commit 1ec6c84

Browse files
committed
updated readme
1 parent d525c80 commit 1ec6c84

File tree

2 files changed

+14
-4
lines changed

2 files changed

+14
-4
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# PSE Edge
22

3-
Note: This is still a work in progress, not yet for production
4-
53
![GitHub](https://img.shields.io/github/license/bldulam1/pse-edge?style=plastic)
64
[![Node.js CI](https://github.com/bldulam1/pse-edge/actions/workflows/node.js.yml/badge.svg)](https://github.com/bldulam1/pse-edge/actions/workflows/node.js.yml)
75

@@ -12,7 +10,7 @@ This is a wrapper of the PSE Edge backend API, useful for scraping data from PSE
1210
- [x] Historical Prices
1311
- [x] Public Company disclosures
1412
- [x] Company Information
15-
- [ ] Financial Reports
13+
- [x] Financial Reports
1614

1715

1816
## Usage
@@ -33,15 +31,26 @@ getCompanyInfo('tel').then(console.log)
3331
// Get Historical prices (daily OHLC) of a stock
3432
getHistoricalPrices({ symbol: 'tel', startDate: '2021-02-02' }).then(console.log)
3533

34+
// Get Financial reports
35+
getFinancialReports("glo").then(console.log)
3636
```
3737

3838
### Javascript
3939
```javascript
4040
const { fetchStocksAll, getCompanyDisclosures, getCompanyInfo, getHistoricalPrices } = require('pse-edge/lib')
4141

42+
// Fetch all stocks listed in the PSE
4243
fetchStocksAll().then(console.log)
44+
45+
// Get all company disclosures of a stock symbol
4346
getCompanyDisclosures('glo').then(console.log)
47+
48+
// Get company info of a stock symbol
4449
getCompanyInfo('tel').then(console.log)
50+
51+
// Get Historical prices (daily OHLC) of a stock
4552
getHistoricalPrices({ symbol: 'tel', startDate: '2021-02-02' }).then(console.log)
4653

54+
// Get Financial reports
55+
getFinancialReports("glo").then(console.log)
4756
```

src/index.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import { fetchStocksAll } from './directory'
22
import { getCompanyDisclosures } from './disclosures'
3+
import { getFinancialReports } from './finance'
34
import { getHistoricalPrices } from './history'
45
import { getCompanyInfo } from './info'
56

6-
export { getCompanyInfo, getHistoricalPrices, getCompanyDisclosures, fetchStocksAll }
7+
export { getCompanyInfo, getHistoricalPrices, getCompanyDisclosures, fetchStocksAll, getFinancialReports }

0 commit comments

Comments
 (0)