API 규격 안내

데이터 표현규격

  • 한국증권금융의 API는 JSON 포맷으로 호출됩니다.
  • 메시지 전송을 위한 문자 인코딩으로 UTF-8을, 통화코드 표현으로 ISO-4217 표준규격을 사용합니다.

데이터 통신규격

네트워크

자본시장 공동망(K-NET) 및 이용기관과 증권금융간 별도 전용선 네트워크를 사용합니다.

네트워크 IP 및 PORT의 경우, 이용기관의 KSFC API 포털 참가 신청서 제출 후 포털 관리자가 이메일로 회신

참가 신청서 다운로드

메시지 교환방식

API 요청 및 응답 메시지 교환방식으로 REST 방식을 사용합니다.

REST(REpresentational State Transfer)
HTTP 기반으로 데이터를 전달하는 프레임워크로써, URI로 정보의 자원을 표현하고 자원에 대한 행위를 HTTP 메소드(GET, POST)로 표현

REST 더 알아보기

URI 계층 구조

당사에서 제공하는 자원(리소스)을 고유하게 식별하고, 위치를 지정할 수 있도록 URI 계층구조를 다음과 같이 구성하였습니다.

분류 URI 계층 구조
접근토큰 발급 API
(OAuth인증)
<base path > / oauth / 2.0 / token
일반 api
(투자자예탁금 등)
<base path > / <version > / <resource >
  • <base path > 전용 회선 네트워크 IP주소
  • <version > API 버전 정보 (ex. v1 등)
  • <resource > 당사가 보유하고 있는 특정 자원을 요청하기 위한 식별 정보

HTTP 헤더

헤더 값을 통해 데이터(Body)의 포맷을 지정합니다.

HTTP 유형 구분 헤더 값 지정
요청
(Request)
OAuth 2.0 접근토큰 발급 application/x-www-form-urlencoded
JSON 형식으로 데이터 전송 application/json
응답
(Response)
OAuth 2.0 접근토큰 발급 application/json
JSON 형식으로 데이터 전송 application/json

HTTP 응답

분류 응답 코드 및 메시지
접근토큰 발급 API
(OAuth인증)
RFC 6479 및 7009 국제표준 준용
일반 API
(투자자예탁금 등)
응답 메시지 내 ‘rsp_code’, ‘rsp_msg’ 필드로 반환

API별 오류코드와 오류 메시지는 개발가이드를 참고하세요.

페이지네이션

‘다음 페이지 존재여부’(next_page_yn)가 Y인 경우, 다음 페이지의 거래내역을 확인하기 위해 결과로 받은 ‘직전조회추적정보’ (before_inquiry_trace_info)를 설정합니다.

HTTP 유형 구분 헤더 값 지정 설명
요청 before_inquiry_trace_info AN(20) 직전조회추적정보
응답 before_inquiry_trace_info AN(20) 직전조회추적정보
next_page_yn A(1) 다음 페이지 존재여부

다음 페이지 조회 시 직전 조회 응답 메시지 내 ‘직전조회추적정보’ (before_inquiry_trace_info)필드를 그대로 세팅하여 요청합니다.

예시
요청 응답
최초 조회 파라미터 설정하지 않음 {
“rsp_code” : “00000”,
“rsp_msg” : “success”,
“next_page_yn” : “Y”
“before_inquiry_trace_info” : “1”
“data” : “ABC ... ”
}
다음 페이지 조회 before_inquiry_trace_info = 1 {
“rsp_code” : “00000”,
“rsp_msg” : “success”,
“next_page_yn” : “Y”
“before_inquiry_trace_info” : “2”
“data” : “PQR ... ”
}
다음 페이지 조회 before_inquiry_trace_info = 2 {
“rsp_code” : “00000”,
“rsp_msg” : “success”,
“next_page_yn” : “N”
“before_inquiry_trace_info” : “”
“data” : “XYZ ... ”
}
담당자 연락처
  • 02-3770-8953 (IT지원팀)
  • ksfc44@ksfc.co.kr