Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hkjang/opendart
https://github.com/hkjang/opendart
javascript opendart-api
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/hkjang/opendart
- Owner: hkjang
- License: mit
- Created: 2021-03-18T10:01:24.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-19T14:52:51.000Z (over 1 year ago)
- Last Synced: 2024-03-25T20:36:10.886Z (10 months ago)
- Topics: javascript, opendart-api
- Language: JavaScript
- Homepage:
- Size: 5.86 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# opendart API for javascript
**Javascript** opendart API package, Support **Node.js**
## Installation
```bash
npm install --save opendart
```
## Getting Started
### with Node.js
```javascript
const opendart = require('opendart')
```
## Authentication
```
accessToken
```
## opendart API
* accessToken: opendart API key
### opendart.disclosure.company(access_token: string, options: object = {})
호출 예 )
```javascript
const opendart = require('opendart');
var options = {
'corp_code' : '00126380'
}
opendart.disclosure.company('ACCESS_TOKEN', options).then(function (res){
console.log(res.data);
});
```
## Details
- https://opendart.fss.or.kr/guide/main.do?apiGrpCd=DS001
- https://documenter.getpostman.com/view/12899159/TVKJxEeP
## 전체 API
```javascript
const opendart = {
disclosure: {
/** 공시검색 API */
list (accessToken, options = {}) {
return Request.get(accessToken, '/list.json', options)
},
/** 기업개황 API */
company (accessToken, options = {}) {
return Request.get(accessToken, '/company.json', options)
},
/** 고유번호 API */
corpCode (accessToken, options = {}) {
return Request.get(accessToken, '/corpCode.xml', options)
},
/** 고유번호 API */
document (accessToken, options = {}) {
return Request.get(accessToken, '/document.xml', options)
}
},
report: {
/** 증자(감자) 현황 API */
irdsSttus(accessToken, options = {}) {
return Request.get(accessToken, '/irdsSttus.json', options)
},
/** 배당에 관한 사항 API */
alotMatter(accessToken, options = {}) {
return Request.get(accessToken, '/alotMatter.json', options)
},
/** 자기주식 취득 및 처분 현황 API */
tesstkAcqsDspsSttus(accessToken, options = {}) {
return Request.get(accessToken, '/tesstkAcqsDspsSttus.json', options)
},
/** 최대주주 현황 API */
hyslrSttus(accessToken, options = {}) {
return Request.get(accessToken, '/hyslrSttus.json', options)
},
/** 최대주주 변동 현황 API */
hyslrChgSttus(accessToken, options = {}) {
return Request.get(accessToken, '/hyslrChgSttus.json', options)
},
/** 소액주주 현황 API */
mrhlSttus(accessToken, options = {}) {
return Request.get(accessToken, '/mrhlSttus.json', options)
},
/** 임원 현황 API */
exctvSttus(accessToken, options = {}) {
return Request.get(accessToken, '/exctvSttus.json', options)
},
/** 직원 현황 API */
empSttus(accessToken, options = {}) {
return Request.get(accessToken, '/empSttus.json', options)
},
/** 이사,감사의 개인별 보수 현황 API */
hmvAuditIndvdlBySttus(accessToken, options = {}) {
return Request.get(accessToken, '/hmvAuditIndvdlBySttus.json', options)
},
/** 이사, 감사 전체의 보수 현황 API */
hmvAuditAllSttus(accessToken, options = {}) {
return Request.get(accessToken, '/hmvAuditAllSttus.json', options)
},
/** 개인별 보수금액(5억이상 상위5인) API */
indvdlByPay(accessToken, options = {}) {
return Request.get(accessToken, '/indvdlByPay.json', options)
},
/** 타법인 출자현황 API */
otrCprInvstmntSttus(accessToken, options = {}) {
return Request.get(accessToken, '/otrCprInvstmntSttus.json', options)
}
},
statement: {
/** 단일회사 주요계정 API */
fnlttSinglAcnt(accessToken, options = {}) {
return Request.get(accessToken, '/fnlttSinglAcnt.json', options)
},
/** 다중회사 주요계정 API */
fnlttMultiAcnt(accessToken, options = {}) {
return Request.get(accessToken, '/fnlttMultiAcnt.json', options)
},
/** 단일회사 전체 재무제표 API */
fnlttSinglAcntAll(accessToken, options = {}) {
return Request.get(accessToken, '/fnlttSinglAcntAll.json', options)
},
/** XBRL택사노미재무제표양식 API */
xbrlTaxonomy(accessToken, options = {}) {
return Request.get(accessToken, '/xbrlTaxonomy.json', options)
},
/** 재무제표 원본파일(XBRL) API */
fnlttXbrl(accessToken, options = {}) {
return Request.get(accessToken, '/fnlttXbrl.xml', options)
}
},
equity: {
/** 대량보유 상황보고 API */
majorstock(accessToken, options = {}) {
return Request.get(accessToken, '/majorstock.json', options)
},
/** 임원ㆍ주요주주 소유보고 API */
elestock(accessToken, options = {}) {
return Request.get(accessToken, '/elestock.json', options)
}
}
}
```
## License
[MIT](https://github.com/hkjang/opendart/blob/master/LICENSE)
Copyright 2018-2020. [hkjang](https://github.com/hkjang). All rights reserved.