Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
koreainvestment authored Oct 31, 2022
1 parent e29a722 commit 16f5dc7
Showing 1 changed file with 52 additions and 14 deletions.
66 changes: 52 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
![header](https://capsule-render.vercel.app/api?type=waving&color=gradient&height=300&section=header&text=한국투자증권%20KIS%20Developers&fontSize=50&animation=fadeIn&fontAlignY=38&desc=Open%20Trading%20API%20Docs&descAlignY=51&descAlign=62)



## 1. KIS Developers 개발자 센터 소개
[KIS Developers](https://apiportal.koreainvestment.com/)는 한국투자증권의 트레이딩 서비스를 오픈API로 제공하여 개발자들이 다양한 금융서비스를 만들 수 있도록 지원하는 개발자 센터입니다. KIS Developers에서는 개발자의 금융 서비스 개발을 지원하기 위해 API 문서 메뉴 내 API에 대한 상세한 설명과 예제를 제공합니다. 전문 개발자가 아닌 일반인들도 쉽게 금융 서비스를 만들 수 있습니다.

* 제휴 문의는 [제휴안내 페이지](https://apiportal.koreainvestment.com/howto-register)에서 제휴 신청 부탁드립니다.
* API 사용 관련 문의는 [Q&A 페이지](https://apiportal.koreainvestment.com/community/10000000-0000-0011-0000-000000000003)에서 문의 부탁드립니다.


## 2. 이용 안내
### 2.1. 사전 준비
KIS Developers 서비스는 한국투자증권 홈페이지에서 신청하실 수 있습니다. 신청을 위해서는 2가지 사전 준비물이 필요합니다. 첫 번째로는 한국투자증권 계좌가 개설되어있어야 하며, 두 번째로는 한국투자증권 ID 등록이 필요합니다. 만약 계좌가 없으시다면 한국투자증권 앱을 통해 비대면 개설을 진행하거나, 가까운 영업점을 방문해주시길 바랍니다. (모의투자계좌의 경우, 한국투자 홈페이지 혹은 MTS에서 모의투자 서비스 신청 후 발급받은 모의계좌번호로 API 신청을 하셔야 합니다.)
Expand All @@ -15,30 +17,66 @@ KIS Developers 서비스는 한국투자증권 홈페이지에서 신청하실
- 가까운 영업점 찾기 : [https://securities.koreainvestment.com/main/customer/guide/branch/branch.jsp](https://securities.koreainvestment.com/main/customer/guide/branch/branch.jsp)
- 모의투자계좌 발급 : [https://securities.koreainvestment.com/main/research/virtual/_static/TF07da010000.jsp](https://securities.koreainvestment.com/main/research/virtual/_static/TF07da010000.jsp)


### 2.2. 서비스 신청
![enter image description here](https://wikidocs.net/images/page/159333/KIS_Developers_%EC%84%9C%EB%B9%84%EC%8A%A4_%EC%8B%A0%EC%B2%AD%ED%95%98%EA%B8%B0.png)

서비스 신청 페이지까지 2가지 경로로 접속 가능합니다.
* [KIS Developers](https://apiportal.koreainvestment.com/) 우상단 API신청 버튼 클릭
서비스 신청 페이지까지 2가지 경로로 접속 가능합니다.

* KIS Developers 우상단 API신청 버튼 클릭
* 한국투자증권 홈페이지 [서비스신청 > Open API > KIS Developers > KIS Developers 서비스 신청하기]

위 그림과 같은 서비스신청 페이지에서 등록하신 휴대폰 인증을 통해 본인 인증을 완료합니다.
서비스 신청 화면에 접속하면 홈페이지 인증서 로그인 화면이 뜨고, 인증을 완료하면 아래와 같이 KIS Developers 서비스 신청하기의 첫 화면인 휴대폰 인증 화면에 인입하실 수 있습니다.

![](https://wikidocs.net/images/page/159301/kis_restapi_1.png)

해당 화면에서 등록하신 휴대폰 인증을 통해 본인 인증을 완료합니다.



### 2.3. 유의사항 확인
![](https://wikidocs.net/images/page/159301/kis_restapi_2.png)

다음으로는 유의사항확인입니다. 서비스 사용에 관한 유의사항을 정독하여 충분하게 숙지하신 뒤, 동의를 진행합니다. 개인정보 처리, 서비스 이용약관 및 이용약관 개정 알림에 대해 미동의 시, 서비스 이용이 불가합니다.



### 2.4. KIS Developers 서비스 신청하기
![](https://wikidocs.net/images/page/159301/kis_restapi_3.png)

서비스 신청하기 팝업 화면에서 보유하고 계신 계좌에 대하여 API 신청하실 수 있습니다. 한 번에 2개의 계좌까지 API 신청 가능하며, 다계좌 API 신청을 원하실 경우, 신청하기 완료 후 신청정보 페이지에서 추가신청하기 기능을 이용하시기 바랍니다.

* 실전투자계좌의 경우 동일한 종합 계좌번호의 주식(국내, 해외), 선물/옵션 계좌로 API 이용 가능합니다.
* 모의투자계좌의 경우 한국투자 홈페이지 혹은 MTS에서 모의투자 서비스 신청 후 발급받은 모의계좌번호로 API 신청을 하셔야 합니다.

계좌번호 선택 하단에 위치한 테이블에 있는 KIS Developers 사용자 ID는 향후 KIS Developers 포탈에서 사용되는 ID로 기존 등록된 HTS ID와 동일합니다. 두번째로 API그룹은 현재 KIS Developers에서 이용 가능한 API 기능들로, 지속적으로 추가 개발될 예정입니다. 세번째로 문자메시지 설정을 통해 서비스 만료 1개월 전 메시지를 받을 수 있으니 참고하시길 바랍니다. 마지막으로 이용기간은 신청일로부터 1년입니다.

계좌번호를 선택 혹은 입력하시고 신청 버튼을 누르시면 처음 홈페이지 로그인하신 방식으로 인증 팝업이 뜨게 됩니다.

![](https://wikidocs.net/images/page/159301/kis_restapi_6.png)

정상적으로 인증을 완료하였다는 메시지가 창에 뜨고, 해당 계좌번호로 API 신청 및 APP Key, APP Secret 발급이 완료됩니다.

![](https://wikidocs.net/images/page/159301/kis_restapi_4.png)

이상으로 신청이 완료되었습니다.


### 2.5. 신청정보

![](https://wikidocs.net/images/page/159301/kis_restapi_7.png)

신청이 완료되면 신청정보 화면의 신청현황 테이블에서 해당 계좌의 App Key와 App Secret을 확인하실 수 있습니다. App Key와 App Secret은 노출되어 있지 않아, 클립보드에 복사 후 원하시는 곳에 붙여넣어 사용 부탁드립니다. App Key와 App Secret 두 암호키를 통해 계좌에 접근할 수 있는 토큰을 발급받을 수 있어, 타인에게 유출을 금하며 관리에 유의해야합니다. 유출시 즉시 홈페이지에서 재발급 하시기 바랍니다.

갱신 기능과 해지 기능에 대해 설명드리겠습니다. 갱신(기간 연장)은 만료 30일 전부터 신청 가능하며, 그 전까지는 갱신 버튼이 비활성화되어 클릭이 불가능합니다. 갱신 시, 신청일로부터 1년 기간이 연장되며, APP Key, APP Secret가 재발급됩니다. 해지는 언제든지 신청 가능하며, 해지 완료 시 발급되었던 APP Key, APP Secret는 사용이 불가능합니다.

### 2.3.유의사항 확인
![enter image description here](https://wikidocs.net/images/page/159301/%EC%9C%A0%EC%9D%98%EC%82%AC%ED%95%AD%ED%99%95%EC%9D%B8.JPG)

다음으로는 유의사항확인입니다. 서비스 사용에 관한 유의사항을 정독하여 충분하게 숙지하신 뒤, 동의를 진행합니다. 개인정보 처리와 서비스 이용약관에 대해 미동의 시, 서비스 이용이 불가합니다.
### 2.6. 추가신청하기

### 2.4. 신청정보 확인
![enter image description here](https://wikidocs.net/images/page/159301/%EC%8B%A0%EC%B2%AD%EC%A0%95%EB%B3%B4.JPG)
![](https://wikidocs.net/images/page/159301/kis_restapi_5.png)

해당 화면에서는 서비스 신청 정보를 확인하실 수 있습니다. 주요하게 확인할 사항 3가지를 소개해드리겠습니다. 첫 번째로 상단 테이블에 위치한 **이메일**은 사전에 등록한 이메일로 향후 KIS Developers ID/PW 찾기에 활용되니 꼭 기억하시길 바랍니다. 다음으로 하단 테이블에 위치한 **계좌정보**에서 종합계좌, 모의계좌 각각 한 계좌씩 총 두 개의 계좌를 신청할 수 있습니다. 만약 종합계좌, 모의계좌 중 하나만 선택하신 뒤 완료하셨다면 나중에 추가 혹은 변경이 가능한 점 참고하시길 바랍니다. 마지막으로 KIS Developers **사용자 ID**는 향후 KIS Developers 포탈에서 사용되는 ID로 기존 등록된 HTS ID와 동일합니다.
신청현황 화면 하단의 추가신청하기 기능을 이용하여 더 많은 계좌의 API 신청이 가능합니다. 실전투자계좌의 경우 최대 89개, 모의투자계좌의 경우 최대 10개까지 신청 가능합니다. 추가 신청 프로세스는 맨 처음 신청했을 때와 동일하게 계좌 선택 및 비밀번호 인증, 인증서 인증을 거쳐 이뤄집니다.

이 외에 최하단에 위치한 문자메시지 설정을 통해 서비스 만료 1개월 전 메시지를 받을 수 있으니 참고하시길 바랍니다.

### 2.5. 신청 완료
![enter image description here](https://wikidocs.net/images/page/159301/%EC%84%9C%EB%B9%84%EC%8A%A4%EC%8B%A0%EC%B2%AD%EC%99%84%EB%A3%8C.JPG)
신청한 계좌의 App Key와 App Secret을 확인합니다. 두 암호키를 통해 계좌에 접근할 수 있는 토큰을 발급받을 수 있어, 타인에게 유출을 금하며 관리에 유의해야합니다. 유출시 즉시 홈페이지에서 재발급 하시기 바랍니다.

## 3. API 제공 목록 <a id="apiList">

Expand Down

0 comments on commit 16f5dc7

Please sign in to comment.