KIS Developers menu

API 문서 HOME API 문서 OAuth인증

OAuth인증

실시간 (웹소켓) 접속키 발급[실시간-000]

WEBSOCKET

실시간 (웹소켓) 접속키 발급[실시간-000]

기본정보

  • Method
    POST
  • 실전 Domain
    https://openapi.koreainvestment.com:9443
  • 모의 Domain
    https://openapivts.koreainvestment.com:29443
  • URL
    /oauth2/Approval
  • Format
    JSON
  • Content-Type
     

개요

실시간 (웹소켓) 접속키 발급받으실 수 있는 API 입니다.
웹소켓 이용 시 해당 키를 appkey와 appsecret 대신 헤더에 넣어 API를 호출합니다.

접속키의 유효기간은 24시간이지만, 접속키는 세션 연결 시 초기 1회만 사용하기 때문에 접속키 인증 후에는 세션종료되지 않는 이상 접속키 신규 발급받지 않으셔도 365일 내내 웹소켓 데이터 수신하실 수 있습니다.

LAYOUT

Request

Header

Element 한글명 Type Required Length Description
content-type 컨텐츠타입 String N 20 application/json; utf-8

Body

Element 한글명 Type Required Length Description
grant_type 권한부여타입 String Y 18 "client_credentials"
appkey 앱키 String Y 36 한국투자증권 홈페이지에서 발급받은 appkey (절대 노출되지 않도록 주의해주세요.)
secretkey 시크릿키 String Y 180 한국투자증권 홈페이지에서 발급받은 appkey (절대 노출되지 않도록 주의해주세요.)

Response

Body

Element 한글명 Type Required Length Description
approval_key 웹소켓 접속키 String Y 286 웹소켓 이용 시 발급받은 웹소켓 접속키를 appkey와 appsecret 대신 헤더에 넣어 API 호출합니다.

Example

Request

{
"grant_type": "client_credentials",
"appkey": "PSg5dctL9dKPo727J13Ur405OSXXXXXXXXXX",
"secretkey": "yo2t8zS68zpdjGuWvFyM9VikjXE0i0CbgPEamnqPA00G0bIfrdfQb2RUD1xP7SqatQXr1cD1fGUNsb78MMXoq6o4lAYt9YTtHAjbMoFy+c72kbq5owQY1Pvp39/x6ejpJlXCj7gE3yVOB/h25Hvl+URmYeBTfrQeOqIAOYc/OIXXXXXXXXXX"
}

Response

{
    "approval_key": "a2585daf-8c09-4587-9fce-8ab893XXXXX"
}

Hashkey

REST

Hashkey

기본정보

  • Method
    POST
  • 실전 Domain
    https://openapi.koreainvestment.com:9443
  • 모의 Domain
    https://openapivts.koreainvestment.com:29443
  • URL
    /uapi/hashkey
  • Format
    JSON
  • Content-Type
    application/json

개요

해쉬키(Hashkey)는 보안을 위한 요소로 사용자가 보낸 요청 값을 중간에 탈취하여 변조하지 못하도록 하는데 사용됩니다.
해쉬키를 사용하면 POST로 보내는 요청(주로 주문/정정/취소 API 해당)의 body 값을 사전에 암호화시킬 수 있습니다.
해쉬키는 비필수값으로 사용하지 않아도 POST API 호출은 가능합니다.

LAYOUT

Request

Header

Element 한글명 Type Required Length Description
content-type 컨텐츠타입 String N 40 application/json; charset=utf-8
appkey 앱키 String Y 36 한국투자증권 홈페이지에서 발급받은 appkey (절대 노출되지 않도록 주의해주세요.)
appsecret 앱시크릿키 String Y 180 한국투자증권 홈페이지에서 발급받은 appsecret (절대 노출되지 않도록 주의해주세요.)

Body

Element 한글명 Type Required Length Description
JsonBody 요청값 Object Y POST로 보낼 body값

ex)
datas = {
"CANO": '00000000',
"ACNT_PRDT_CD": "01",
"OVRS_EXCG_CD": "SHAA"
}

Response

Body

Element 한글명 Type Required Length Description
JsonBody 요청값 Object Y 요청한 JsonBody
HASH 해쉬키 String Y 256 [POST API 대상] Client가 요청하는 Request Body를 hashkey api로 생성한 Hash값
* API문서 > hashkey 참조

Example

Request

{
"ORD_PRCS_DVSN_CD": "02",
"CANO": "계좌번호",
"ACNT_PRDT_CD": "03",
"SLL_BUY_DVSN_CD": "02",
"SHTN_PDNO": "101S06",
"ORD_QTY": "1",
"UNIT_PRICE": "370",
"NMPR_TYPE_CD": "",
"KRX_NMPR_CNDT_CD": "",
"CTAC_TLNO": "",
"FUOP_ITEM_DVSN_CD": "",
"ORD_DVSN_CD": "02"
}

Response

{
  "BODY": {
    "ORD_PRCS_DVSN_CD": "02",
    "CANO": "계좌번호",
    "ACNT_PRDT_CD": "03",
    "SLL_BUY_DVSN_CD": "02",
    "SHTN_PDNO": "101S06",
    "ORD_QTY": "1",
    "UNIT_PRICE": "370",
    "NMPR_TYPE_CD": "",
    "KRX_NMPR_CNDT_CD": "",
    "CTAC_TLNO": "",
    "FUOP_ITEM_DVSN_CD": "",
    "ORD_DVSN_CD": "02"
  },
  "HASH": "8b84068222a49302f7ef58226d90403f62e216828f8103465f900de0e7be2f0f"
}

접근토큰발급(P)[인증-001]

REST

접근토큰발급(P)[인증-001]

기본정보

  • Method
    POST
  • 실전 Domain
    https://openapi.koreainvestment.com:9443
  • 모의 Domain
    https://openapivts.koreainvestment.com:29443
  • URL
    /oauth2/tokenP
  • Format
    JSON
  • Content-Type
    application/json; charset=UTF-8

개요

본인 계좌에 필요한 인증 절차로, 인증을 통해 접근 토큰을 부여받아 오픈API 활용이 가능합니다.

1. 접근토큰(access_token)의 유효기간은 24시간 이며(1일 1회발급 원칙)
갱신발급주기는 6시간 입니다.(6시간 이내는 기존 발급키로 응답)

2. 접근토큰발급(/oauth2/tokenP) 시 접근토큰값(access_token)과 함께 수신되는
접근토큰 유효기간(acess_token_token_expired)을 이용해 접근토큰을 관리하실 수 있습니다.


[참고]

'23.4.28 이후 지나치게 잦은 토큰 발급 요청건을 제어 하기 위해 신규 접근토큰발급 이후 일정시간 이내에 재호출 시에는 직전 토큰값을 리턴하게 되었습니다. 일정시간 이후 접근토큰발급 API 호출 시에는 신규 토큰값을 리턴합니다.
접근토큰발급 API 호출 및 코드 작성하실 때 해당 사항을 참고하시길 바랍니다.

※ 참고 : 포럼 > 공지사항 > [수정] [중요] 접근 토큰 발급 변경 안내

LAYOUT

Request

Body

Element 한글명 Type Required Length Description
grant_type 권한부여 Type String Y 18 client_credentials
appkey 앱키 String Y 36 한국투자증권 홈페이지에서 발급받은 appkey (절대 노출되지 않도록 주의해주세요.)
appsecret 앱시크릿키 String Y 180 한국투자증권 홈페이지에서 발급받은 appsecret (절대 노출되지 않도록 주의해주세요.)

Response

Body

Element 한글명 Type Required Length Description
access_token 접근토큰 String Y 350 OAuth 토큰이 필요한 API 경우 발급한 Access token
ex) "eyJ0eXUxMiJ9.eyJz…..................................."

- 일반개인고객/일반법인고객
. Access token 유효기간 1일
.. 일정시간(6시간) 이내에 재호출 시에는 직전 토큰값을 리턴
. OAuth 2.0의 Client Credentials Grant 절차를 준용

- 제휴법인
. Access token 유효기간 3개월
. Refresh token 유효기간 1년
. OAuth 2.0의 Authorization Code Grant 절차를 준용
token_type 접근토큰유형 String Y 20 접근토큰유형 : "Bearer"
※ API 호출 시, 접근토큰유형 "Bearer" 입력. ex) "Bearer eyJ...."
expires_in 접근토큰 유효기간 Number Y 10 유효기간(초)
ex) 7776000
acess_token_token_expired 접근토큰 유효기간(일시표시) String Y 50 유효기간(년:월:일 시:분:초)
ex) "2022-08-30 08:10:10"

Example

Request

{
  "grant_type": "client_credentials",
  "appkey": "PSg5dctL9dKPo727J13Ur405OSXXXXXXXXXX",
  "appsecret":  "yo2t8zS68zpdjGuWvFyM9VikjXE0i0CbgPEamnqPA00G0bIfrdfQb2RUD1xP7SqatQXr1cD1fGUNsb78MMXoq6o4lAYt9YTtHAjbMoFy+c72kbq5owQY1Pvp39/x6ejpJlXCj7gE3yVOB/h25Hvl+URmYeBTfrQeOqIAOYc/OIXXXXXXXXXX"
}

Response

{
"access_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0b2tlbiIsImF1ZCI6ImMwNzM1NTYzLTA1MjctNDNhZS05ODRiLTJiNWI1ZWZmOWYyMyIsImlzcyI6InVub2d3IiwiZXhwIjoxNjQ5NzUxMTAwLCJpYXQiOjE2NDE5NzUxMDAsImp0aSI6IkJTZlM0QUtSSnpRVGpmdHRtdXZlenVQUTlKajc3cHZGdjBZVyJ9.Oyt_C639yUjWmRhymlszgt6jDo8fvIKkkxH1mMngunV1T15SCC4I3Xe6MXxcY23DXunzBfR1uI0KXXXXXXXXXX",
"access_token_token_expired":"2023-12-22 08:16:59",
"token_type":"Bearer",
"expires_in":86400
}

접근토큰폐기(P)[인증-002]

REST

접근토큰폐기(P)[인증-002]

기본정보

  • Method
    POST
  • 실전 Domain
    https://openapi.koreainvestment.com:9443
  • 모의 Domain
    https://openapivts.koreainvestment.com:29443
  • URL
    /oauth2/revokeP
  • Format
    JSON
  • Content-Type
    application/json; charset=UTF-8

개요

부여받은 접큰토큰을 더 이상 활용하지 않을 때 사용합니다.

LAYOUT

Request

Body

Element 한글명 Type Required Length Description
appkey 고객 앱Key String Y 36 한국투자증권 홈페이지에서 발급받은 appkey (절대 노출되지 않도록 주의해주세요.)
appsecret 고객 앱Secret String Y 180 한국투자증권 홈페이지에서 발급받은 appsecret (절대 노출되지 않도록 주의해주세요.)
token 접근토큰 String Y 286 OAuth 토큰이 필요한 API 경우 발급한 Access token
일반고객(Access token 유효기간 1일, OAuth 2.0의 Client Credentials Grant 절차를 준용)
법인(Access token 유효기간 3개월, Refresh token 유효기간 1년, OAuth 2.0의 Authorization Code Grant 절차를 준용)

Response

Body

Element 한글명 Type Required Length Description
code 응답코드 String N 8 HTTP 응답코드
message 응답메세지 String N 450 응답메세지

Example

Request

{
  "appkey" : "PSw2UvBQCpoZFc7nZpIfIrOttmXXXXXXXXXX",
  "appsecret" : "/g84gaZp7W3DJEZhamiTH8ZdJkUJ8603rjo3HcOm5PvIc1YC3YmyJOQoW1H0kNjo4IbHwGUdi3+9oEbH4RKKl8GnEu3n/khxm0OrwHkQur+wbA74fcFXxaUnEbftu0X72Eaw9dEBMuK3rODeeOanrsJ1kZ9oKWykIG04F0nmgdXXXXXXXXXX",
  "token" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0b2tlbiIsImF1ZCI6IjZmNDgxMjBiLTlmMDItNGI5ZS05MGExLTRiNDk2MGM5ZWY2MyIsImlzcyI6InVub2d3IiwiZXhwIjoxNjQzMjg2MDUzLCJpYXQiOjE2NDMxOTk2NTMsImp0aSI6IlBTdzJVdkJRQ3dvWkZhOG5acElmSXJPdHRtZUtLUGZCclNKcyJ9.6Z-UvArobBfXbnpSFbFhd9WPVEM3ZQa5NEpqfmQ6rrZBISCi-P9CEamfVReIduTVYbafF02Pl6EPXXXXXXXXXX"
}

Response

{
  "code" : 200,
  "message" : "접근토큰 폐기에 성공하였습니다"
}

CONFIRM

x

CONFIRM

x

CONFIRM

x

시크릿조회

x

시크릿조회

x

제목

KIS Developers 이용약관

x
잠시만 기다려 주세요

마지막 로그인

x

로그인 날짜

2021-12-29 11:22:33

로그인 IP

0.0.0.0