User-friendly CLI for the Kiwoom Securities REST API (키움증권)
Project description
kiwoom-cli
키움증권 REST API를 터미널에서 사용하기 위한 CLI 도구.
- 207개 API 전체 지원 (188 REST + 19 WebSocket 실시간)
- 종목 조회, 호가, 차트, 계좌, 주문, 순위, 업종, 테마, ETF, ELW, 금현물
- 출력 형식: Rich 테이블 / JSON / CSV (
-f json,-f csv) - 실시간 WebSocket 스트리밍 (체결, 호가, VI, 잔고 등)
- AI 에이전트 친화적: 구조화된 JSON 출력, exit code (0/1/2/3)
설치
pip install kiwoom-cli
시작하기
# 1. 초기 설정 (appkey, secretkey 입력 + 암호화 비밀번호 설정)
kiwoom config setup
# 2. 토큰 발급 (비밀번호 확인 후 발급)
kiwoom auth login
# 3. 사용 (토큰 발급 후에는 비밀번호 불필요)
kiwoom stock info 005930
모의투자 vs 실거래
config setup 시 도메인을 선택합니다. 이후 변경:
kiwoom config domain mock # 모의투자 (기본값, 테스트용)
kiwoom config domain prod # 실거래
kiwoom config show # 현재 설정 확인
모의투자는 KRX만 지원됩니다. 실거래 전환 후에는 kiwoom auth login으로 토큰을 재발급하세요.
환경변수 설정
도메인과 계좌번호는 환경변수로도 설정 가능합니다.
export KIWOOM_DOMAIN="prod" # prod 또는 mock
export KIWOOM_ACCOUNT="1234567" # 선택
appkey/secretkey는 보안을 위해 환경변수를 지원하지 않습니다. 반드시 kiwoom config setup으로 암호화 저장하세요.
멀티 프로필
계좌별로 다른 appkey/secretkey를 사용할 수 있습니다.
# 프로필별 설정
kiwoom config setup --profile default # 메인계좌
kiwoom config setup --profile isa # ISA계좌
# 프로필 설정 변경
kiwoom config set domain prod # 도메인 변경
kiwoom config set account 1234567 # 계좌번호 설정
kiwoom -p isa config set domain mock # 특정 프로필
# 프로필 전환 / 목록
kiwoom config use isa
kiwoom config profiles
# 특정 프로필로 사용
kiwoom -p isa account balance
kiwoom -p isa auth login
명령어 구조
kiwoom [--format table|json|csv] [--no-color]
├── config 설정 (setup / show / domain)
├── auth 인증 (login / logout / status)
├── stock 종목 조회 (info / orderbook / chart / compare ...)
├── account 계좌 조회 (balance / deposit / returns / pnl ...)
├── order 주문 (buy / sell / modify / cancel / credit / gold)
├── market 시장 정보 (rank / sector / theme / etf / elw / gold)
├── stream 실시간 스트리밍 (quote / orderbook / order / vi ...)
├── dashboard 대시보드 (계좌 + 거래량 상위 한눈에)
└── api Raw API 호출
stock - 종목 조회
kiwoom stock info 005930 # 기본정보 (PER, PBR, 시가총액 등)
kiwoom stock price 005930 # 현재가 한 줄
kiwoom stock orderbook 005930 # 10단계 호가창
kiwoom stock daily 005930 # 일별 시세
kiwoom stock daily 005930 --type week # 주별 시세
kiwoom stock exec 005930 # 체결정보
kiwoom stock trader 005930 # 거래원
kiwoom stock foreign 005930 # 외국인 매매동향
kiwoom stock institution 005930 # 기관 매매동향
kiwoom stock short 005930 --from 20260101 --to 20260330 # 공매도 추이
kiwoom stock sync # 전 시장 종목 리스트 다운로드 (캐시)
kiwoom stock search 삼성 # 캐시에서 종목 검색
kiwoom stock search 삼성 --market kospi # 코스피만 필터
kiwoom stock watchlist "005930|000660" # 관심종목
차트
kiwoom stock chart tick 005930 --range 1 # 틱
kiwoom stock chart minute 005930 --interval 5 # 5분봉
kiwoom stock chart day 005930 --base-date 20260301 # 일봉
kiwoom stock chart week 005930 --base-date 20260301 # 주봉
kiwoom stock chart month 005930 --base-date 20260301 # 월봉
kiwoom stock chart year 005930 --base-date 20260301 # 년봉
투자자/분석
kiwoom stock investor daily-trade --from 20260301 --to 20260330
kiwoom stock investor by-stock 005930 --date 20260301
kiwoom stock investor program-top
kiwoom stock analysis vi-trigger
kiwoom stock analysis per-rank --type low-per
kiwoom stock lending trend
kiwoom stock credit trend 005930 --date 20260301 --type loan
전체 stock 하위 명령어
| 명령 | 설명 |
|---|---|
info |
종목 기본정보 |
price |
현재가 한 줄 |
detail |
종목정보 상세 |
orderbook |
10단계 호가창 |
daily |
일/주/월별 시세 |
timeprice |
시분 시세 |
daily-price |
일별주가 |
after-hours |
시간외단일가 |
quote-info |
시세표성정보 |
exec |
체결정보 |
trader |
거래원 |
today-exec |
당일/전일 체결 |
today-volume |
당일/전일 체결량 |
tick-strength |
체결강도 시간별 |
daily-strength |
체결강도 일별 |
foreign |
외국인 매매동향 |
institution |
기관 매매동향 |
short |
공매도 추이 |
sync |
전 시장 종목 리스트 다운로드 (캐시 저장) |
search |
종목 검색 (캐시 기반, 시장/유형 필터) |
watchlist |
관심종목 |
brokers |
회원사 리스트 |
chart * |
틱/분봉/일봉/주봉/월봉/년봉, 투자자별 차트 |
investor * |
기관매매, 투자자별매매, 프로그램매매 등 10개 |
analysis * |
거래상세, 거래량갱신, 매물대, PER, VI, 증권사 등 10개 |
lending * |
대차거래 추이/상위/종목별/내역 |
credit * |
신용매매동향, 신용융자 가능 |
account - 계좌 조회
kiwoom account list # 계좌번호
kiwoom account balance # 잔고 + 보유종목 + 손익
kiwoom account deposit # 예수금
kiwoom account asset # 추정자산
kiwoom account today # 당일현황
kiwoom account returns summary # 수익률
kiwoom account pnl today 005930 # 당일 실현손익
kiwoom account orders pending # 미체결 주문
kiwoom account orders executed # 체결 내역
kiwoom account holdings eval # 잔고내역
kiwoom account orderable amount 005930 --side buy --price 70000
전체 account 하위 명령어
| 그룹 | 명령 | 설명 |
|---|---|---|
| - | list |
계좌번호 조회 |
| - | balance |
계좌 평가현황 |
| - | deposit |
예수금 상세 |
| - | asset |
추정자산 |
| - | today |
당일현황 |
| - | margin-detail |
증거금 세부내역 |
returns |
summary |
계좌 수익률 |
returns |
daily-balance |
일별 잔고수익률 |
returns |
daily-detail |
일별 수익률 상세 |
returns |
daily-asset |
일별 예탁자산 |
pnl |
today |
당일 실현손익 |
pnl |
by-date |
일자별 실현손익 |
pnl |
by-period |
기간별 실현손익 |
pnl |
daily |
일자별 실현손익 |
orders |
pending |
미체결 주문 |
orders |
executed |
체결 내역 |
orders |
detail |
주문체결 상세 |
orders |
status |
주문체결 현황 |
orders |
split-detail |
분할주문 상세 |
holdings |
eval |
계좌평가 잔고 |
holdings |
settled |
체결잔고 |
holdings |
next-settle |
익일결제예정 |
orderable |
amount |
주문가능 금액 |
orderable |
margin-qty |
증거금율별 수량 |
orderable |
credit-qty |
신용보증금율별 수량 |
history |
transactions |
위탁종합 거래내역 |
history |
journal |
당일 매매일지 |
order - 주문
모든 주문에 --confirm 필수.
# 주식
kiwoom order buy 005930 10 --type market --confirm # 시장가 매수
kiwoom order buy 005930 10 --price 70000 --type limit --confirm # 지정가 매수
kiwoom order sell 005930 10 --type market --confirm # 매도
kiwoom order modify 0000139 005930 1 70000 --confirm # 정정
kiwoom order cancel 0000140 005930 --confirm # 취소
# 신용
kiwoom order credit buy 005930 10 --type market --confirm
kiwoom order credit sell 005930 10 --type market --confirm
# 금현물
kiwoom order gold buy M04020000 1 --type market --confirm
kiwoom order gold balance --confirm # 잔고
kiwoom order gold pending --confirm # 미체결
# 조건검색
kiwoom order condition list
kiwoom order condition search 001 --confirm
주문유형: limit market conditional after-hours pre-market single best first ioc market-ioc best-ioc fok market-fok best-fok stop mid mid-ioc mid-fok
market - 시장 정보
순위
kiwoom market rank volume # 거래량 상위
kiwoom market rank amount # 거래대금 상위
kiwoom market rank change # 등락률 상위
kiwoom market rank surge # 가격 급등락
kiwoom market rank hot # 실시간 조회 순위
kiwoom market rank limit # 상하한가
kiwoom market rank foreign-period # 외인 기간별 매매
kiwoom market rank foreign-inst # 외국인/기관 매매
전체 rank 명령어 (28개)
volume prev-volume amount change expected-change surge hot limit new-highlow near-highlow volume-surge orderbook-top orderbook-surge balance-rate-surge credit-ratio foreign-period foreign-consecutive foreign-exhaust foreign-broker foreign-inst investor-top broker-by-stock broker-top major-trader net-buyer top-exit same-net-trade afterhours-change
업종 / 테마 / ETF / ELW / 금현물 / 프로그램
kiwoom market sector current 001 # 업종 현재가
kiwoom market sector index # 전업종 지수
kiwoom market sector chart day 001 --date 20260301
kiwoom market theme groups # 테마 그룹
kiwoom market theme stocks THEMA001 # 테마 구성종목
kiwoom market etf all # ETF 전체 시세
kiwoom market etf info 069500 # ETF 종목정보
kiwoom market elw detail 580001 # ELW 상세정보
kiwoom market elw search # ELW 조건검색
kiwoom market gold price # 금현물 시세
kiwoom market gold orderbook # 금현물 호가
kiwoom market program time-trend --date 20260301
kiwoom market program stock-daily 005930
stream - 실시간 스트리밍
WebSocket 실시간 시세. Ctrl+C로 종료.
kiwoom stream quote 005930 # 체결 실시간
kiwoom stream orderbook 005930 # 호가 실시간
kiwoom stream order # 주문체결 (계좌)
kiwoom stream balance # 잔고 변동 (계좌)
kiwoom stream vi 005930 # VI 발동/해제
kiwoom stream multi 005930 # 체결+호가 동시
kiwoom stream quote 005930 000660 035420 # 복수 종목
kiwoom stream custom 0B,0D 005930 # 타입 직접 지정
kiwoom stream types # 타입 코드 목록
| 코드 | 명령 | 설명 |
|---|---|---|
| 00 | order |
주문체결 |
| 04 | balance |
잔고 |
| 0A | price |
주식기세 |
| 0B | quote |
주식체결 |
| 0C | best-bid |
우선호가 |
| 0D | orderbook |
호가잔량 |
| 0E | after-hours |
시간외호가 |
| 0F | trader |
당일거래원 |
| 0G | etf-nav |
ETF NAV |
| 0H | expected |
예상체결 |
| 0I | gold |
국제금환산 |
| 0J | sector-index |
업종지수 |
| 0U | sector-change |
업종등락 |
| 0g | stock-info |
종목정보 |
| 0m | elw-theory |
ELW 이론가 |
| 0s | market-time |
장시작시간 |
| 0u | elw-indicator |
ELW 지표 |
| 0w | program |
프로그램매매 |
| 1h | vi |
VI발동/해제 |
Raw API
kiwoom api ka10001 '{"stk_cd":"005930"}' # 테이블 출력
kiwoom api ka10001 '{"stk_cd":"005930"}' --raw # JSON 원본
dashboard - 대시보드
kiwoom dashboard # 계좌 요약 + 거래량 상위 한눈에
종목 비교
kiwoom stock compare 005930 000660 # 삼성전자 vs SK하이닉스
kiwoom stock compare 005930 000660 035420 # 3종목 비교
kiwoom -f json stock compare 005930 000660 # JSON 출력
출력 형식
모든 명령에 -f / --format 옵션 사용 가능:
kiwoom stock info 005930 # 기본: Rich 테이블
kiwoom -f json stock info 005930 # JSON (파이핑, AI 에이전트용)
kiwoom -f csv stock daily 005930 # CSV (엑셀, 데이터 분석용)
kiwoom --no-color stock info 005930 # 색상 없이 (파일 저장용)
# jq로 필터링
kiwoom -f json market rank volume | jq '.[].stk_nm'
# CSV를 파일로 저장
kiwoom -f csv stock daily 005930 > samsung_daily.csv
Shell 자동완성
# Bash
eval "$(_KIWOOM_COMPLETE=bash_source kiwoom)"
# Zsh
eval "$(_KIWOOM_COMPLETE=zsh_source kiwoom)"
# Fish
eval (env _KIWOOM_COMPLETE=fish_source kiwoom)
Exit Codes
| 코드 | 의미 |
|---|---|
| 0 | 성공 |
| 1 | 입력 오류 (잘못된 인자) |
| 2 | API/네트워크 오류 |
| 3 | 인증 필요 (토큰 만료) |
참고
| 항목 | 값 |
|---|---|
| 항목 | 값 |
| --------------- | ---------------------------- |
| 설정 파일 | ~/.kiwoom/config.toml (도메인, 계좌만) |
| appkey/secretkey | OS 키체인 (암호화 저장) |
| 토큰 | OS 키체인 |
| 캐시 디렉터리 | ~/.kiwoom/cache/ |
| 운영 도메인 | https://api.kiwoom.com |
| 모의투자 도메인 | https://mockapi.kiwoom.com |
| WebSocket | wss://api.kiwoom.com:10000 |
kiwoom <명령> --help로 상세 옵션 확인- 모의투자 먼저 테스트:
kiwoom config domain mock - 연속조회(페이지네이션) 자동 처리
- 종목코드 6자리:
005930(삼성전자) - 금현물:
M04020000(1kg),M04020100(미니 100g)
보안
인증정보(appkey, secretkey)는 OS 키체인에 암호화되어 저장됩니다. 파일로 존재하지 않으며, 비밀번호 없이는 복호화할 수 없습니다.
| 항목 | 저장 방식 | 비밀번호 필요 |
|---|---|---|
| appkey / secretkey | 암호화 + OS 키체인 | O (config setup, auth login 시) |
| 토큰 | OS 키체인 (평문) | X (만료되는 값) |
| config.toml | 도메인, 계좌번호만 | X |
config setup시 설정한 비밀번호로 appkey/secretkey를 암호화auth login/logout시 비밀번호 확인 후 키체인 접근- 토큰 발급 후 일반 명령어는 비밀번호 없이 사용
keyring.get_password()로 직접 접근해도 암호화된 값만 반환
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file kiwoom_cli-0.6.2.tar.gz.
File metadata
- Download URL: kiwoom_cli-0.6.2.tar.gz
- Upload date:
- Size: 66.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1b7f4477cb63a5183b074a784aead028d5a4f50cdccbad809b37515d1c4a89af
|
|
| MD5 |
9ded33c75c45bcc15c927306670ef33b
|
|
| BLAKE2b-256 |
43e8c05e6180b22588c5ca49b9044a46ac9798720990439157c4c77cd0b1cd98
|
File details
Details for the file kiwoom_cli-0.6.2-py3-none-any.whl.
File metadata
- Download URL: kiwoom_cli-0.6.2-py3-none-any.whl
- Upload date:
- Size: 65.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4107c096a1bdefa440ca1c52841fd166af8317609f76bc535e97d5966d639ed5
|
|
| MD5 |
4d6bb0cc2ccfcd1225039941fb0c55a8
|
|
| BLAKE2b-256 |
9ef6079ed2dd6a671a378b08d6e343f7e416669e1d24ffb4507320bf939404d6
|