kquant API document (0.3.6)

kquant.api

kquant.api 모듈은 CHECK-API 연결에 필요한 정보를 설정 및 확인하기 위한 기능을 제공합니다.

kquant.api 모듈은 다음 두 가지 함수를 제공합니다.

set_api() 함수로 API ID 및 API KEY를 설정하는 방법은 다음과 같습니다.

import kquant as kq

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

get_api() 함수로 설정된 API ID 및 API KEY를 확인하는 방법은 다음과 같습니다.

import kquant as kq

kq.get_api()

('발급받은 API ID 문자열', '발급받은 API KEY 문자열')

set_api()함수로 API ID 및 API KEY를 설정하면 설정 데이터는 사용자의 홈 디렉토리 아래의 .kquant 디렉토리 상의 credential 파일에 다음과 같은 형식으로 저장됩니다.

API_ID = "발급받은 API ID 문자열"
API_KEY = "발급받은 API KEY 문자열"

따라서 한 번 set_api() 함수로 API 정보를 설정하면 이 파일이 삭제되거나 손상되지 않는 한 다시 set_api() 함수로 API 정보를 설정할 필요는 없습니다.

만약 Linux/Mac 서버에서 미리 사용자를 지정할 수 없는 경우에는 홈 디렉토리가 아닌 /.kquant/credential 경로에 API 정보 파일을 두면 이 정보를 사용합니다.

함수명	함수 설명
`get_api`	설정된 CHECK-API 서비스용 API ID 및 API KEY를 반환하는 함수
`set_api`	CHECK-API 서비스용 API ID 및 API KEY를 설정 및 저장하는 함수