개발가이드
KB증권 Open API 서비스 이용을 위한 접속 정보, Access Token 발급 방법 및 API 호출 절차를 안내합니다.
appKey와 appSecret을 이용해 Access Token을 발급받고, 이를 통해 다양한 Open API 서비스를 연동할 수 있습니다.
-
계좌개설 및
사용신청 -
appKey/appSecret
발급 -
Access Token
발급 -
API 호출 및
서비스 이용
접속 정보 및 토큰발급
접속 정보
KB증권 Open API 서비스는 HTTPS 기반으로 제공되며, JSON 형식의 요청/응답을 사용합니다.
운영 환경 및 테스트 환경은 아래와 같이 구분되며, 접속 정보는 서비스 환경에 따라 달라질 수 있습니다.
- 구분
- 서비스 URL
- 설명
- 운영 환경
- https://developer.kbsec.com:32484
- 실 운영 환경
기본 호출 조건
- ProtocolHTTPS
- Content-Typeapplication/json
- CharacterUTF-8
- AuthenticaionBearer Token
Token 발급
KB증권 Open API 서비스는 Client Credentials 방식을 사용하여 Token을 발급합니다.
appKey와 appSecret을 이용해 Access Token을 발급받고 API 호출 시 Authorization Header에 포함하여 사용합니다.
요청 예시 (Token 발급)
POST /oauth2/token
Content-Type : application/json
{
"grant_type" : "client_credentials",
"appKey" : "{appKey}",
"appSecret" : "{appSecret}"
}
Content-Type : application/json
{
"grant_type" : "client_credentials",
"appKey" : "{appKey}",
"appSecret" : "{appSecret}"
}
응답 예시
{
"access_token" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"token_type" : "Bearer",
"expires_in" : 86400
}
"access_token" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"token_type" : "Bearer",
"expires_in" : 86400
}
유의사항
- * Access Token은 유효기간이 있으며 만료 시 재발급 후 사용해야 합니다.
- * Token 및 API 사용 권한 정보는 외부에 노출되지 않도록 안전하게 관리해야 합니다.
Token 발급 시 검증 항목
appKey 유효 여부appSecret 일치 여부API 사용 신청 여부앱 사용 가능 여부API 권한계좌 권한호출 제한 정책서비스 해지 여부
API 호출 가이드
API 호출 기본 구조
Access Token 발급 후 API 요청 시 Header에 Token을 포함하여 호출합니다.
API 호출 시 예시 Token, 고객 신청 상품, API 권한, 계좌 권한, 호출 제한 기준 등을 고려합니다.
API 호출 흐름
- API 요청
- 인증 및 권한 검증
- API 처리
- 응답 반환
HTTP Header 구성 예시
POST /api/v1/ssqm1802
Content-Type : application/json
Authorization : Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Content-Type : application/json
Authorization : Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
주문 API 호출 예시 (POST)
POST /api/v1/ssqm1802
dataHeader
{
"ipAddr": "127.0.0.1",
"macAddr": "1A-2B-3C-4D-5E-67",
}
dataBody
{
"bnd_mktio_ccd": "1",
"is_no": ""
}
dataHeader
{
"ipAddr": "127.0.0.1",
"macAddr": "1A-2B-3C-4D-5E-67",
}
dataBody
{
"bnd_mktio_ccd": "1",
"is_no": ""
}
- * 실제 Header 항목은 KB증권 Open API 표준에 맞춰 최종 확정입니다.
오류 처리 가이드
API 호출이 실패하는 경우 아래 기준에 따라 원인을 확인하고 조치합니다.
- Token 만료Token 재발급 후 재호출
- 권한 없음API신청 범위 및 앱 상태 확인
- 계좌 권한 없음사용 계좌 및 계좌 연결 상태 확인
- 호출 제한 초과일정 시간 후 재시도 또는 호출량 확인
- 필수값 누락요청 Header 및 Body 확인
- 주문 불가주문 가능 금액,수량,종목 상태 확인
- * 보다 자세한 API 목록, 요청/응답 전문, 오류코드, 제한 정책 등은 API 명세서 에서 확인할 수 있습니다.
문서 다운로드