openstock-kr

openstock-kr은 한국거래소(KRX) OPEN API를 파이썬 환경에서 쉽고 안정적으로 수집할 수 있도록 도와주는 라이브러리입니다.

주식 시장의 지수, 종목별 시세, 종목 기본 정보 데이터를 몇 줄의 코드로 간단하게 수집하고, 분석에 바로 사용할 수 있도록 데이터 전처리(수치형 변환, 한글 컬럼명 매핑 등)를 자동화하여 제공합니다.

✨ 주요 기능

• 간편한 API 호출: KOSPI, KOSDAQ 시장의 데이터를 한 번의 메서드 호출로 병합하여 가져옵니다.
• 자동 예외 처리: 네트워크 지연, 서버 오류, 빈 데이터 응답 등의 예외 상황을 내부적으로 안전하게 처리합니다.
• 스마트한 수치형 변환: 문자열로 섞여 들어오는 숫자 데이터(예: 콤마가 포함된 거래대금, '무액면' 문자가 포함된 액면가 등)를 판별하여 안전하게 int 또는 float으로 변환합니다.
• 컬럼명 언어 설정: 분석 편의를 위해 원본 영문 컬럼명(en)과 번역된 한글 컬럼명(kr)을 선택할 수 있습니다.

📦 설치 방법

pip install --upgrade openstock-kr

🔑 사전 준비

• 이 라이브러리를 사용하려면 한국거래소 OPEN API(openapi.krx.co.kr)에서 무료로 발급하는 OPEN API 인증키(AUTH_KEY) 가 필요합니다.
• API 인증키 발급 이후, 다음의 API 서비스에 대해서 개별적으로 API이용신청과 거래소 담당자 승인이 완료되어야 합니다. (인증키만 발급받는 경우, API 서비스가 지원되지 않음)
  • KRX 시리즈 일별시세정보
  • KOSPI 시리즈 일별시세정보
  • KOSDAQ 시리즈 일별시세정보
  • 유가증권 일별매매정보
  • 코스닥 일별매매정보
  • 유가증권 종목기본정보
  • 코스닥 종목기본정보

🚀 빠른 시작 (Quick Start)

1. 초기화

from OpenStock import OpenStock

# 발급받은 API 키 입력
api_key = "YOUR_API_KEY_HERE"
stock = OpenStock(api_key=api_key)

2. 시장 지수 데이터 수집 (get_index)

특정 일자의 지수(KRX, KOSPI, KOSDAQ) 데이터를 수집합니다.

# 기준일자 'YYYYMMDD' 형식 입력, col_lan='kr' 설정 시 한글 컬럼명 반환
df_index = stock.get_index('20260306', col_lan='kr')
print(df_index.head())

3. 종목 시세 데이터 수집 (get_price)

특정 일자의 전 종목 시세(KOSPI, KOSDAQ) 데이터를 수집합니다.

df_price = stock.get_price('20260306', col_lan='kr')
print(df_price.head())

4. 종목 기본 정보 수집 (get_stockinfo)

특정 일자의 종목 기본 정보(표준코드, 액면가, 상장주식수 등) 데이터를 수집합니다.

df_info = stock.get_stockinfo('20260306', col_lan='kr')
print(df_info.head())

📝 라이선스 (License)

This project is licensed under the MIT License.