2020. 12. 27. 23:26ㆍAI트레이딩/키움API
국내주식상품과 코스피200 지수선물/옵션, 주식선물을 거래할 수 있는 거래/분석프로그램을 개발 할 수 있다. COM형태로 제공
시세데이터 조회와 실시간 데이터제공, 주문기능, 조건검색기능(주식만 가능)을 제공
통신처리
[통신동작]
OpenAPI함수호출과 이벤트는 모두 비동식 방식으로 서버에 시세조회나 주문등을 함수호출로 요청하면 처리 결과를 전용 이벤트를 호출해서 전달합니다. 여기서 수신데이터를 가져오려면 반드시 이벤트 리턴전에 적절한 데이터 획득함수를 사용해서 얻어와야 합니다. 이벤트가 호출하기 전에 데이터 획득함수를 사용하거나 이벤트 리턴후에 호출하게 되면 혹은 임의로 이벤트를 호출하면 정상적인 데이터를 얻을수 없습니다.
지금까지 설명을 조회요청을 예를들어 정리하면 다음과 같습니다. 이외 OpenAPI기능도 관련 함수와 이벤트 차이가 있을뿐 전체 동작은 동일합니다.
기능요청(조회함수 CommRqData, CommKwRqData 호출) ---> 이벤트 호출(OnReceiveTRData ) ---> 데이터 획득 (GetCommData함수)
[화면번호]
화면번호는 서버에 조회나 주문등 필요한 기능을 요청할때 이를 구별하기 위한 키값으로 이해하시면 됩니다.
0000(혹은 0)을 제외한 임의의 숫자를 사용하면 되는데 갯수가 200개로 한정되어 있기 때문에 이 갯수를 넘지 않도록 관리하셔야 합니다.
만약 사용하는 화면번호가 200개를 넘는 경우 조회결과나 주문결과에 다른 데이터가 섞이거나 원하지 않는 결과를 나타날 수 있습니다.
[이벤트]
시세조회나 조건검색요청등 관련함수 호출로 요청하면 서버에서 이를 처리해서 결과를 OpenAPI의 특정함수를 호출해서 알려주는데 이 함수를 이벤트라고 합니다. 조회를 예로 들면 SetInputValue(), CommRqData()함수로 조회를 하면 조회결과를 만들어서 OpenAPI로 전달하고 조회한 사용자의 OnReceiveTRData를 호출하게 됩니다.
이벤트는 일반함수와 구별하기 위해 이름앞에 On~에 있으며 OnEventConnect, OnReceiveTRData, OnReceiveRealData등이 있습니다.
로그인, 조회, 주문, 조건검색등 기능별로 함수와 이벤트가 분류되어 있으니 용도에 맞는 함수와 이벤트를 사용해야 합니다.
로그인 버전처리
[로그인 개요]
로그인은 CommConnect()함수를 호출하며 OnEventConnect 이벤트 인자값으로 로그인 성공여부를 알수 있습니다.
이 값이 0이면 성공이고 나머지는 실패로 오류코드값을 참고해서 실패원인을 파악할수 있습니다.
실서버와 동일한 시세데이터로 주문테스트를 할수 있는 모의투자서버를 제공하는데 로그인창에서 "모의투자 서버"을 선택해서 간단히 접속하실수 있습니다.
[LONG CommConnect()]
수동 로그인설정인 경우 로그인창을 출력해서 로그인을 시도하거나 자동로그인 설정인 경우 로그인창 출력없이 로그인을 시도합니다.
[OnEventConnect()이벤트]
OnEventConnect(long nErrCode // 로그인 상태를 전달하는데 자세한 내용은 아래 상세내용 참고)
로그인 처리 이벤트입니다. 성공이면 인자값 nErrCode가 0이며 에러는 다음과 같은 값이 전달됩니다.
nErrCode별 상세내용
-100 사용자 정보교환 실패
-101 서버접속 실패
-102 버전처리 실패
[LONG GetConnectState()]
현재 로그인 상태를 알려줍니다. 리턴값 1:연결, 0:연결안됨
[LONG GetLoginInfo()]
로그인 후 사용할 수 있으며 인자값에 대응하는 정보를 얻을 수 있습니다.
인자는 다음값을 사용할 수 있습니다.
"ACCOUNT_CNT" : 보유계좌 수를 반환합니다.
"ACCLIST" 또는 "ACCNO" : 구분자 ';'로 연결된 보유계좌 목록을 반환합니다.
"USER_ID" : 사용자 ID를 반환합니다.
"USER_NAME" : 사용자 이름을 반환합니다.
"KEY_BSECGB" : 키보드 보안 해지여부를 반환합니다.(0 : 정상, 1 : 해지)
"FIREW_SECGB" : 방화벽 설정여부를 반환합니다.(0 : 미설정, 1 : 설정, 2 : 해지)
"GetServerGubun" : 접속서버 구분을 반환합니다.(1 : 모의투자, 나머지 : 실서버)
리턴값
인자값에 대응하는 정보를 얻을 수 있습니다.
---------------------------------------------------------------------------------------------------------------------
[보유계좌 목록 예시]
CString strAcctList = GetLoginInfo("ACCLIST");
여기서 strAcctList는 ';'로 분리한 보유계좌 목록임
예) "3040525910;567890;3040526010"
----------------------------------------------------------------------------------------------------------------------
[OnReceiveMsg()이벤트]
OnReceiveMsg(
BSTR sScrNo, // 화면번호
BSTR sRQName, // 사용자 구분명
BSTR sTrCode, // TR이름
BSTR sMsg // 서버에서 전달하는 메시지
)
서버통신 후 수신한 메시지를 알려줍니다.
메시지에는 6자리 코드번호가 포함되는데 이 코드번호는 통보없이 수시로 변경될 수 있습니다. 따라서 주문이나 오류관련처리를
이 코드번호로 분류하시면 안됩니다.
[수동 로그인]
로그인창에 로그인ID와 비밀번호를 직접입력해서 로그인을 하는것을 말하며 기본적으로 이 로그인방법을 사용하게 됩니다.
수동 로그인중에 버전처리내용이 있는 경우 버전처리도 함께 진행됩니다.
[자동 로그인]
로그인한 다음 계좌비밀번호 입력창을 통해 자동로그인을 설정할 수 있습니다.
트레이 메뉴(모니터 오른쪽 하단)에서 "계좌비밀번호 저장" 메뉴를 선택하면 화면이 표시되는데 여기서 로그인 이후 사용할 계좌와
계좌비밀번호를 입력하고 등록버튼을 눌러서 저장한 다음 계좌번호 아래에 있는 AUTO체크 박스를 선택하시면 자동 로그인을 위한
설정이 모두 끝납니다.
로그인 설정을 자동으로 하면 종목정보를 제외한 버전처리를 모두 무시하게 되며 버전처리를 다시 받으려면 AUTO버튼을 체크
해지하고 프로그램을 재 실행 하시면 됩니다.
[계좌비밀번호 설정]
잔고나 주문가능금액,수량등 계좌관련 조회나 주문전에 미리 계좌비밀번호를 설정해야 오류 알림창과 -301 오류코드없이 사용하실수 있습니다.
계좌비밀번호 설정은 계좌비밀번호 입력창에서만 가능하며 이 입력창은 메뉴나 함수로 출력하실수 있습니다.
메뉴이용 - 로그인후 트레이 메뉴(모니터 오른쪽 하단)에서 "계좌비밀번호 저장"선택
함수이용 - 로그인후 OpenAPI.KOA_Functions(_T("ShowAccountWindow"), _T(""))호출
[버전 처리]
로그인할때 버전처리가 필요한 경우 버전처리 알림창이 출력될수 있습니다. 이 알림창이 표시되면 OpenAPI프로그램을 먼저 모두 종료한다음 알림창에 있는 닫기버튼을 누르셔야 합니다.
그렇지 않으면 버전처리가 정상적으로 끝나지 않아서 로그인할때 또 버전처리 알림창이 표시됩니다.
그리고 알림창이 표시되었을때 KOA Studio도 실행중이면 역시 함께 종료시켜주셔야 합니다.
이렇게 OpenAPI프로그램을 모두 종료하신 다음 알림창을 닫아주시면 버전처리가 자동으로 진행되고 프로그램을 재실행 해주시면 됩니다.
[모의투자]
로그인 창에서 모의투자접속을 선택을 체크하면 모의투자로 접속하며 이 체크를 풀면 실서버(운영서버)로 접속합니다.
단 KOA Studio 프로그램은 항상 모의투자로만 접속가능해서 모의투자접속 체크 해지가 않됩니다.
모의투자로 로그인하시려면 당사 홈페이지에서 미리 모의투자 사용신청을 하셔야 하며 상세한 내용은 당사 홈페이지를 참고하시기 바랍니다.
모의투자 계좌번호, 주문 가능종목, 수수료등 정책은 실서버와 차이가 있으므로 상세한 내용은 홈페이지 내용을 꼭 참고해 주세요.
[중복로그인]
OpenAPI는 중복로그인을 허용하지 않기 때문에 동일PC나 다른PC나 관계없이 마지막에 로그인한 경우만 유지되고 이전에 로그인한 프로그램은 자동으로 로그오프됩니다.
모의투자서버 로그인 역시 중복로그인을 허용하지 않습니다.
조회와 실시간데이터처리
[조회처리(조회요청)]
OpenAPI가 제공하는 데이터중에서 원하는 데이터를 서버에 요청해서 가져오는 것을 말하는데 TR(Transaction)단위로 처리됩니다.
TR이란 서버와 데이터를 주고받을때 정의한 약속된 규약이며 입력부분(Input)과 데이터를 수신하는 출력부분(Output)을 가지고 있습니다.
입력부분은 요청하는 데이터에 따라 입력갯수(입력항목)가 달라지며 출력부분은 보통 데이터갯수(출력항목)가 여러개로 구성됩니다.
출력부분은 출력항목이 한번씩만 전달되는 싱글데이터와 복수로 전달되는 멀티데이터가 있고 TR에 따라 싱글데이터(또는 멀티데이터)만 있거나 둘다 있는 경우도 있습니다.
OpenAPI가 제공하는 TR은 KOA Studio의 TR목록 탭에서 찾아볼 수 있고 각 TR별로 조회도 가능합니다.
OPT10070 : 당일주요거래원요청 - 싱글데이터
OPT10081 : 주식일봉차트조회요청 - 싱글 + 멀티데이터
[계좌비밀번호 설정]
잔고나 주문가능금액,수량등 계좌관련 조회나 주문전에 미리 계좌비밀번호를 설정해야 오류 알림창과 -301 오류코드없이 사용하실수 있습니다.
계좌비밀번호 설정은 계좌비밀번호 입력창에서만 가능하며 이 입력창은 메뉴나 함수로 출력하실수 있습니다.
메뉴이용 - 로그인후 트레이 메뉴(모니터 오른쪽 하단)에서 "계좌비밀번호 저장"선택
함수이용 - 로그인후 OpenAPI.KOA_Functions(_T("ShowAccountWindow"), _T(""))호출
[조회제한]
OpenAPI 조회는 1초당 5회로 제한되며 복수종목 조회와 조건검색 조회 횟수가 합산됩니다.
가령 1초 동안 시세조회2회 관심종목 1회 조건검색 2회 순서로 조회를 했다면 모두 합쳐서 5회이므로 모두 조회성공하겠지만 조건검색을 3회 조회하면 맨 마지막 조건검색 조회는 실패하게 됩니다.
[조회제한 강화]
기존 1초당 5회 조회제한외에 분당, 시간당 유동적 조회제한이 2017년 4월 6일 17:00이후 반영되었습니다.
(OpenAPI 게시판 조회제한 관련 공지내용을 참고하세요.)
조회제한 강화 발생시 에러코드(-200)리턴과 알림 메시지가 표시되며 조회제한 강화가 발생한 프로그램은 다시 로그인해야 조회기능을 다시 이용할 수 있으며 구체적인 조회제한 기준은 비공개로 운영하고 있습니다.
이 조회제한 강화는 거래시간, 거래일에 관계없이 OpenAPI프로그램 실행시 항상 점검합니다.
점검방법은 CommRqData()함수와 CommKwRqData()함수를 이용한 조회횟수를 합산하는 것으로 연속조회 역시 CommRqData()를 이용므로 합산됩니다.
이외 SetRealReg()함수호출이나 나머지 OpenAPI함수호출은 조회제한 강화와 관련없으며 실시간 시세데이터 사용도 관련없습니다.
조회횟수 합산은 프로그램별로 합산하며 로그인ID 별로는 합산하지 않습니다.
예를들어 같은ID로 로그인한 2개 프로그램에서 각각 10회씩 조회했다면 프로그램별 10회 조회이며 20조회로 합산하지 않습니다.
[CommRqData() 함수]
CommRqData(
BSTR sRQName, // 사용자 구분명
BSTR sTrCode, // 조회하려는 TR이름
long nPrevNext, // 연속조회여부
BSTR sScreenNo // 화면번호
)
조회요청함수이며 빈번하게 조회요청하면 시세과부하 에러값으로 -200이 전달됩니다.
리턴값
0이면 조회요청 정상 나머지는 에러
-200 시세과부하
-201 조회전문작성 에러
[SetInputValue() 함수]
SetInputValue(
BSTR sID, // TR에 명시된 Input이름
BSTR sValue // Input이름으로 지정한 값
)
조회요청시 TR의 Input값을 지정하는 함수이며 조회 TR 입력값이 많은 경우 이 함수를 반복적으로 호출합니다.
----------------------------------------------------------------------------------------------------------------------
[OPT10081 : 주식일봉차트조회요청예시]
SetInputValue("종목코드" , "039490"); // 첫번째 입력값 설정
SetInputValue("기준일자" , "20160101");// 두번째 입력값 설정
SetInputValue("수정주가구분" , "1"); // 세번째 입력값 설정
LONG lRet = CommRqData( "RQName","OPT10081", "0","0600");// 조회요청
----------------------------------------------------------------------------------------------------------------------
[연속조회]
TR별로 한번에 전달할 수 있는 데이터 갯수가 정해져 있습니다. 그런데 이 갯수보다 조회데이터가 많을때 연속조회로 모든 데이터를 조회하게 됩니다.
연속조회는 모든 조회처리에 적용되는 공통사항이며 CommRqData()에서 인자값만 바꿔서 처리합니다.
아래처럼 설정해서 맨 처음 조회했을때 추가로 조회할 데이터가 있다면
OpenAPI.CommRqData("일별데이터조회", "OPT10086" , 0, "0001");
OnReceiveTRData()이벤트에서 5번째 인자값(sPrevNext)에 "2"가 전달됩니다.
그렇다면 연속조회하실때는 CommRqData("일별데이터조회", "OPT10086" , 2, "0001"); 3번째 인자값을 2로 설정해서 조회하시면 됩니다.
정리하면 다음과 같습니다.
OpenAPI.CommRqData("일별데이터조회", "OPT10086" , 0, "0001"); // 처음조회시 혹은 연속데이터가 없을때
OpenAPI.CommRqData("일별데이터조회", "OPT10086" , 2, "0001"); // 연속조회시
[OnReceiveTrData() 이벤트]
void OnReceiveTrData(
BSTR sScrNo, // 화면번호
BSTR sRQName, // 사용자 구분명
BSTR sTrCode, // TR이름
BSTR sRecordName, // 레코드 이름
BSTR sPrevNext, // 연속조회 유무를 판단하는 값 0: 연속(추가조회)데이터 없음, 2:연속(추가조회) 데이터 있음
LONG nDataLength, // 사용안함.
BSTR sErrorCode, // 사용안함.
BSTR sMessage, // 사용안함.
BSTR sSplmMsg // 사용안함.
)
조회요청 응답을 받거나 조회데이터를 수신했을때 호출됩니다.
조회데이터는 이 이벤트내부에서 GetCommData()함수를 이용해서 얻어올 수 있습니다.
[GetCommData() 함수]
GetCommData(
BSTR strTrCode, // TR 이름
BSTR strRecordName, // 레코드이름
long nIndex, // TR반복부
BSTR strItemName // TR에서 얻어오려는 출력항목이름
)
OnReceiveTRData()이벤트가 호출될때 조회데이터를 얻어오는 함수입니다.
이 함수는 반드시 OnReceiveTRData()이벤트가 호출될때 그 안에서 사용해야 합니다.
[GetRepeatCnt() 함수]
GetRepeatCnt(
BSTR sTrCode, // TR 이름
BSTR sRecordName // 레코드 이름
)
조회수신한 멀티데이터의 갯수(반복)수를 얻을수 있습니다. 예를들어 차트조회는 한번에 최대 900개 데이터를 수신할 수 있는데
이렇게 수신한 데이터갯수를 얻을때 사용합니다.
이 함수는 반드시 OnReceiveTRData()이벤트가 호출될때 그 안에서 사용해야 합니다.
--------------------------------------------------------------------------------------------------------------------------
[OPT10081 : 주식일봉차트조회요청예시]
OnReceiveTrDataKhopenapictrl(...)
{
if(strRQName == _T("주식일봉차트"))
{
int nCnt = OpenAPI.GetRepeatCnt(sTrcode, strRQName);
for (int nIdx = 0; nIdx < nCnt; nIdx++)
{
strData = OpenAPI.GetCommData(sTrcode, strRQName, nIdx, _T("종목코드")); strData.Trim();
strData = OpenAPI.GetCommData(sTrcode, strRQName, nIdx, _T("거래량")); strData.Trim();
strData = OpenAPI.GetCommData(sTrcode, strRQName, nIdx, _T("시가")); strData.Trim();
strData = OpenAPI.GetCommData(sTrcode, strRQName, nIdx, _T("고가")); strData.Trim();
strData = OpenAPI.GetCommData(sTrcode, strRQName, nIdx, _T("저가")); strData.Trim();
strData = OpenAPI.GetCommData(sTrcode, strRQName, nIdx, _T("현재가")) strData.Trim();
}
}
}
----------------------------------------------------------------------------------------------------------------------
[실시간 데이터]
시세조회요청이 성공하면 관련 실시간 시세데이터가 발생했을때 서버에서 자동으로 OnReceiveRealData()이벤트로 실시간 타입단위로 전달해줍니다.
KOA Studio의 실시간 탭을 여시면 Real Type과 "주식시세"에서 "종목프로그램매매"까지 나열된 이름을 확인할 수 있습니다.
이들 하나하나를 실시간 타입이라고 하며 관련있는 FID(숫자)와 이름(실시간 항목)를 임의로 모아놓은 것입니다.
예를들어 실시간 타입 "주식시세"는 FID 10 현재가 ~ FID 568 하한가발생시간까지 19개 FID로 구성되며 한꺼번에 전달되는것입니다.
또 실시간 타입 "주식체결"는 FID 20 체결시간 ~ FID 1313 Extra Item까지 35개 FID가 한번에 전달됩니다.
[OnReceiveRealData()이벤트]
OnReceiveRealData(
BSTR sCode, // 종목코드
BSTR sRealType, // 리얼타입
BSTR sRealData // 실시간 데이터 전문
)
실시간 데이터 수신할때마다 호출되며 SetRealReg()함수로 등록한 실시간 데이터도 이 이벤트로 전달됩니다.
GetCommRealData()함수를 이용해서 실시간 데이터를 얻을수 있습니다.
[GetCommRealData() 함수]
GetCommRealData(
BSTR strCode, // 종목코드
long nFid // 실시간 타입에 포함된FID
)
OnReceiveRealData()이벤트가 호출될때 실시간데이터를 얻어오는 함수입니다.
이 함수는 반드시 OnReceiveRealData()이벤트가 호출될때 그 안에서 사용해야 합니다.
----------------------------------------------------------------------------------------------------------------------
[주식체결 실시간 데이터 예시]
if(strRealType == _T("주식체결"))
{
strRealData = m_KOA.GetCommRealData(strCode, 10); // 현재가
strRealData = m_KOA.GetCommRealData(strCode, 13); // 누적거래량
strRealData = m_KOA.GetCommRealData(strCode, 228); // 체결강도
strRealData = m_KOA.GetCommRealData(strCode, 20); // 체결시간
}
----------------------------------------------------------------------------------------------------------------------
[GetCommDataEx() 함수]
GetCommDataEx(
BSTR strTrCode, // TR 이름
BSTR strRecordName // 레코드이름
)
조회 수신데이터 크기가 큰 차트데이터를 한번에 가져올 목적으로 만든 전용함수입니다.
----------------------------------------------------------------------------------------------------------------------
[차트일봉데이터 예시]
OnReceiveTrDataKhopenapictrl(...)
{
if(strRQName == _T("주식일봉차트"))
{
VARIANT vTemp = OpenAPI.GetCommDataEx(strTrCode, strRQName);
long lURows, lUCols;
long nIndex[2]
COleSafeArray saMatrix(vTemp);
VARIANT vDummy;
VariantInit(&vDummy);
saMatrix.GetUBound(1, &lURows); // 데이터 전체갯수(데이터 반복횟수)
saMatrix.GetUBound(2, &lUCols); // 출력항목갯수
for(int nRow = 0; nRow <= lURows; nRow ++)
{
for(int nCol = 0; nCol <= lUCols; nCol ++)
{
nIndex[0] = lURows;
nIndex[1] = lUCols;
saMatrix.GetElement(nIndex, &vDummy);
::SysFreeString(vDummy.bstrVal);
}
}
saMatrix.clear();
VariantClear(&vTemp);
}
}
----------------------------------------------------------------------------------------------------------------------
[실시간 데이터 - 주의사항]
실시간 타입 "주문체결", "잔고", "파생잔고"는 주문관련 실시간 데이터를 전달하기 때문에 시세조회한 뒤나 SetRealReg()함수로 등록해서 사용할 수 없습니다.
이 실시간 타입은 주문을 해야 발생하며 주문전용 OnReceiveChejanData()이벤트로 전달됩니다.
아래 실시간 타입은 시스템 내부용으로 사용할수없는 실시간 타입입니다.
1. 임의연장정보
2. 시간외종목정보
3. 주식거래원
4. 순간체결량
5. 선물옵션합계
6. 투자자별매매
[참고 SetRealReg() 함수]
SetRealReg()함수로도 실시간 시세데이터 수신이 가능하며 시세조회요청과 방법만 다를뿐 수신하는 실시간 시세데이터 그리고 데이터 처리 방법은 동일합니다
이 함수는 조건검색 항목에서 사용법을 설명하고 있습니다.
'AI트레이딩 > 키움API' 카테고리의 다른 글
| 5.[키움증권 오픈 API] 계좌 정보 가져오기 (0) | 2021.07.11 |
|---|---|
| 키움증권 openAPI 개발가이드 오류코드 (0) | 2020.12.31 |
| [키움증권 openAPI] QAxWidget 상속 정보 (0) | 2020.12.24 |
| 4. [키움 openAPI] 종목코드, 기업명 받아오기 (0) | 2020.12.09 |
| 3. [키움증권 openAPI] OnEventConnect 로그인 성공 실패 (0) | 2020.12.09 |