kquant API document (0.3.6)

kquant

kquant 패키지는 코스콤에서 개발한 금융데이터 분석용 파이썬 패키지로 코스콤 CHECK-API 서비스를 통해 금융데이터를 불러오고 분석하는 기능을 제공합니다.

패키지 설치

kquant 패키지는 pip install 명령으로 설치할 수 있습니다.

pip install kquant

준비 사항

kquant 패키지를 사용하기 위해서는 실시간 금융 데이터를 REST-API 및 WebSocket 기반으로 제공하는 서비스인 코스콤 CHECK-API 서비스를 신청하여 API ID 및 API KEY를 발급받으셔야 합니다.

코스콤 CHECK-API 서비스에 대해서는 다음 홈페이지를 참조해 주세요.

패키지 사용법

패키지를 임포트 한 후 set_api() 함수로 API ID 및 API KEY를 설정한 후 사용하시면 됩니다.

import kquant as kq

kq.set_api("발급받은 API ID 문자열", "발급받은 API KEY 문자열")

kq.daily_stock("005930")

패키지 구조

전체 패키지는 다음과 같은 서브모듈과 그 자식모듈로 구성됩니다.

  • kquant.api : CHECK API 정보를 읽거나 저장하기 위한 함수를 제공하는 모듈
  • kquant.data : CHECK API를 통해 데이터를 불러오기 위한 함수를 제공하는 모듈
  • kquant.chart : 캔들차트 등 시각화 기능을 제공하는 모듈
  • kquant.analysis : 주가 분석, 포트폴리오 분석 등 금융분석 기능을 제공하는 모듈
  • kquant.utils : 여러가지 추가 기능을 제공하는 모듈
  • kquant.types : kquant 패키지에서 사용하는 타입 정보

서브모듈의 구조는 버전 업그레이드에 따라 변경될 수 있으니 서브모듈에서 직접 함수를 임포트하는 것은 추천하지 않습니다.

모든 함수는 최상위 레벨에서 바로 임포트할 수 있으므로 “패키지 사용법”에서 설명하는 바와 같이 항상 최상위 레벨에서 임포트하여 사용하는 것을 추천드립니다.