initial commit

한국투자증권(API)/examples_llm/domestic_stock/ccnl_total/ccnl_total.py

@@ -0,0 +1,111 @@
+"""
+Created on 2025-07-09
+"""
+
+import logging
+import sys
+
+sys.path.extend(['../..', '.'])
+import kis_auth as ka
+
+# 로깅 설정
+logging.basicConfig(level=logging.INFO, format='%(levelname)s - %(message)s')
+logger = logging.getLogger(__name__)
+
+##############################################################################################
+# [국내주식] 실시간시세 > 국내주식 실시간체결가 (통합)
+##############################################################################################
+
+
+def ccnl_total(
+        tr_type: str,
+        tr_key: str,
+) -> tuple[dict, list[str]]:
+    """
+    국내주식 실시간체결가 (통합)[H0UNCNT0]
+    국내주식 실시간체결가 (통합) API를 통해 실시간 데이터를 구독합니다.
+
+    Args:
+        tr_type (str): [필수] 구독 등록("1") 또는 해제("0") 여부를 나타내는 값
+        tr_key (str): [필수] 종목코드, 실시간 데이터를 구독할 주식의 종목코드
+
+    Returns:
+        message (dict): 실시간 체결가 데이터 메시지
+        columns (list[str]): 데이터의 컬럼 정보 리스트
+
+    Raises:
+        ValueError: tr_key가 빈 문자열인 경우 발생
+
+    Example:
+        >>> msg, columns = ccnl_total("1", "005930")
+        >>> print(msg, columns)
+
+    Note:
+        이 함수는 웹소켓을 통해 실시간 데이터를 구독합니다. 구독을 시작하려면 tr_type을 "1"로 설정하고,
+        구독을 해제하려면 "0"으로 설정하십시오.
+    """
+
+    # 필수 파라미터 검증
+    if not tr_key:
+        raise ValueError("tr_key is required and cannot be an empty string")
+
+    tr_id = "H0UNCNT0"
+
+    params = {
+        "tr_key": tr_key,
+    }
+
+    # 웹소켓을 통해 실시간 데이터를 가져옵니다.
+    msg = ka.data_fetch(tr_id, tr_type, params)
+
+    # API 메타데이터에 기반한 정확한 컬럼 리스트
+    columns = [
+        "MKSC_SHRN_ISCD",
+        "STCK_CNTG_HOUR",
+        "STCK_PRPR",
+        "PRDY_VRSS_SIGN",
+        "PRDY_VRSS",
+        "PRDY_CTRT",
+        "WGHN_AVRG_STCK_PRC",
+        "STCK_OPRC",
+        "STCK_HGPR",
+        "STCK_LWPR",
+        "ASKP1",
+        "BIDP1",
+        "CNTG_VOL",
+        "ACML_VOL",
+        "ACML_TR_PBMN",
+        "SELN_CNTG_CSNU",
+        "SHNU_CNTG_CSNU",
+        "NTBY_CNTG_CSNU",
+        "CTTR",
+        "SELN_CNTG_SMTN",
+        "SHNU_CNTG_SMTN",
+        "CNTG_CLS_CODE",
+        "SHNU_RATE",
+        "PRDY_VOL_VRSS_ACML_VOL_RATE",
+        "OPRC_HOUR",
+        "OPRC_VRSS_PRPR_SIGN",
+        "OPRC_VRSS_PRPR",
+        "HGPR_HOUR",
+        "HGPR_VRSS_PRPR_SIGN",
+        "HGPR_VRSS_PRPR",
+        "LWPR_HOUR",
+        "LWPR_VRSS_PRPR_SIGN",
+        "LWPR_VRSS_PRPR",
+        "BSOP_DATE",
+        "NEW_MKOP_CLS_CODE",
+        "TRHT_YN",
+        "ASKP_RSQN1",
+        "BIDP_RSQN1",
+        "TOTAL_ASKP_RSQN",
+        "TOTAL_BIDP_RSQN",
+        "VOL_TNRT",
+        "PRDY_SMNS_HOUR_ACML_VOL",
+        "PRDY_SMNS_HOUR_ACML_VOL_RATE",
+        "HOUR_CLS_CODE",
+        "MRKT_TRTM_CLS_CODE",
+        "VI_STND_PRC",
+    ]
+
+    return msg, columns