Files
sam-kd/opendart/API_SERVICES.md

174 lines
5.0 KiB
Markdown
Raw Permalink Normal View History

# Open DART API 서비스 목록
Open DART(전자공시시스템)는 금융감독원에서 제공하는 다양한 기업 공시 정보를 API 형태로 제공합니다.
## 현재 구현된 서비스
### 1. 기업개황 조회 (`company.json`)
- **용도**: 기업의 기본 정보 조회
- **제공 정보**:
- 대표자명, 법인등록번호, 사업자등록번호
- 설립일, 업종코드, 주소, 홈페이지, 전화번호
- **구현 파일**: `api/detail.php`
- **사용 예시**: 기업 검색 후 상세 정보 확인
### 2. 기업코드 다운로드 (`corpCode.xml`)
- **용도**: 전체 기업 목록 및 코드 다운로드
- **제공 정보**:
- 기업코드(CorpCode), 기업명, 종목코드(StockCode)
- 수정일
- **구현 파일**: `api/sync_corpcode.php`
- **사용 예시**: 기업 검색을 위한 데이터베이스 구축
---
## 추가 활용 가능한 주요 서비스
### 3. 공시목록 조회 (`list.json`)
- **용도**: 특정 기업의 공시 목록 조회
- **제공 정보**:
- 공시번호, 공시제목, 공시일자
- 공시유형, 보고서명
- **활용 방안**:
- 최근 공시 내역 모니터링
- 특정 기업의 공시 이력 추적
- **API 엔드포인트**: `/api/list.json`
### 4. 사업보고서 조회 (`fnlttSinglAcnt.json`)
- **용도**: 사업보고서의 주요 재무 정보 조회
- **제공 정보**:
- 재무제표 항목별 금액
- 자산, 부채, 자본, 매출액, 영업이익 등
- **활용 방안**:
- 기업 재무 상태 분석
- 경쟁사 비교 분석
- **API 엔드포인트**: `/api/fnlttSinglAcnt.json`
### 5. 재무제표 전체 조회 (`fnlttSinglAcntAll.json`)
- **용도**: 연결/별도 재무제표 전체 조회
- **제공 정보**:
- 재무상태표, 손익계산서, 현금흐름표
- 분기별/연간 데이터
- **활용 방안**:
- 종합 재무 분석
- 트렌드 분석
- **API 엔드포인트**: `/api/fnlttSinglAcntAll.json`
### 6. 주요사항보고서 조회 (`rceptNo.json`)
- **용도**: 주요사항보고서 원본 조회
- **제공 정보**:
- 보고서 원문
- 주요 경영사항
- **활용 방안**:
- 경영진 변동 추적
- 주요 의사결정 모니터링
- **API 엔드포인트**: `/api/rceptNo.json`
### 7. 배당 정보 조회 (`alotMatter.json`)
- **용도**: 배당 관련 정보 조회
- **제공 정보**:
- 배당금액, 배당률
- 배당 기준일, 지급일
- **활용 방안**:
- 배당 수익률 분석
- 주주 가치 분석
- **API 엔드포인트**: `/api/alotMatter.json`
### 8. 임원/주주 정보 조회 (`hyslrSttus.json`)
- **용도**: 임원 및 주요주주 보유 현황
- **제공 정보**:
- 임원명, 보유 주식수
- 주요주주 보유 현황
- **활용 방안**:
- 지배구조 분석
- 경영권 안정성 평가
- **API 엔드포인트**: `/api/hyslrSttus.json`
### 9. 공시서류 원본 다운로드 (`document.xml`)
- **용도**: 공시된 서류의 원본 파일 다운로드
- **제공 정보**:
- PDF, HWP 등 원본 파일
- **활용 방안**:
- 상세 보고서 분석
- 문서 보관
- **API 엔드포인트**: `/api/document.xml`
### 10. 기업고유번호 조회 (`corpCode.xml`)
- **용도**: 기업고유번호로 기업 정보 조회
- **제공 정보**:
- 기업 기본 정보
- **활용 방안**:
- 기업코드로 빠른 정보 조회
- **API 엔드포인트**: `/api/corpCode.xml`
---
## API 호출 구조
모든 API 호출은 프록시 방식을 통해 이루어집니다:
```
클라이언트 → 회사 서버 (proxy_helper.php) → Open DART API → 회사 서버 → 클라이언트
```
### 공통 파라미터
- `crtfc_key`: Open DART API 인증키 (필수)
- 기타 API별 고유 파라미터
### 사용 예시
```php
// proxy_helper.php의 callOpenDartAPI 함수 사용
$result = callOpenDartAPI('list.json', [
'corp_code' => '00126380',
'bgn_de' => '20240101',
'end_de' => '20241231'
]);
if ($result['success']) {
$data = $result['data'];
// 데이터 처리
} else {
$error = $result['error'];
// 에러 처리
}
```
---
## 활용 시나리오
### 1. 기업 정보 대시보드
- 기업개황 + 재무제표 + 공시 내역을 통합 조회
- 실시간 모니터링
### 2. 경쟁사 분석 시스템
- 여러 기업의 재무제표 비교
- 트렌드 분석 및 벤치마킹
### 3. 투자 분석 도구
- 배당 정보 + 재무제표 분석
- 투자 의사결정 지원
### 4. 공시 모니터링 시스템
- 특정 기업의 공시 알림
- 자동 리포트 생성
---
## 참고 자료
- [Open DART 공식 홈페이지](https://opendart.fss.or.kr/)
- [Open DART API 가이드](https://opendart.fss.or.kr/guide/main.do)
- [API 인증키 발급](https://opendart.fss.or.kr/uss/umt/EidRetrievePublicKeyView.do)
---
## 주의사항
1. **IP 제한**: Open DART에 등록된 IP에서만 API 호출 가능
2. **API 호출 제한**: 일일/월간 호출 제한이 있을 수 있음
3. **데이터 지연**: 공시 후 일정 시간이 지나야 API에서 조회 가능
4. **멀티테넌시**: 프록시 방식을 통해 여러 클라이언트 지원 가능