krx-cli 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +35 -35
  2. package/SKILL.md +171 -48
  3. package/dist/cli.js +530 -193
  4. package/dist/cli.js.map +1 -1
  5. package/package.json +8 -1
package/README.md CHANGED
@@ -60,51 +60,51 @@ krx auth status
60
60
  ### 지수 조회
61
61
 
62
62
  ```bash
63
- krx index list --date 20250307 --market kospi
64
- krx index list --date 20250307 --market kosdaq
63
+ krx index list --date 20260310 --market kospi
64
+ krx index list --date 20260310 --market kosdaq
65
65
  ```
66
66
 
67
67
  ### 주식 조회
68
68
 
69
69
  ```bash
70
- krx stock list --date 20250307 --market kospi
71
- krx stock list --date 20250307 --market kosdaq
70
+ krx stock list --date 20260310 --market kospi
71
+ krx stock list --date 20260310 --market kosdaq
72
72
  krx stock info --market kospi
73
73
  ```
74
74
 
75
75
  ### ETF/ETN/ELW 조회
76
76
 
77
77
  ```bash
78
- krx etp list --date 20250307 --type etf
79
- krx etp list --date 20250307 --type etn
78
+ krx etp list --date 20260310 --type etf
79
+ krx etp list --date 20260310 --type etn
80
80
  ```
81
81
 
82
82
  ### 채권 조회
83
83
 
84
84
  ```bash
85
- krx bond list --date 20250307 --market kts
86
- krx bond list --date 20250307 --market general
85
+ krx bond list --date 20260310 --market kts
86
+ krx bond list --date 20260310 --market general
87
87
  ```
88
88
 
89
89
  ### 파생상품 조회
90
90
 
91
91
  ```bash
92
- krx derivative list --date 20250307 --type futures
93
- krx derivative list --date 20250307 --type options
92
+ krx derivative list --date 20260310 --type futures
93
+ krx derivative list --date 20260310 --type options
94
94
  ```
95
95
 
96
96
  ### 일반상품 조회
97
97
 
98
98
  ```bash
99
- krx commodity list --date 20250307 --type gold
100
- krx commodity list --date 20250307 --type oil
99
+ krx commodity list --date 20260310 --type gold
100
+ krx commodity list --date 20260310 --type oil
101
101
  ```
102
102
 
103
103
  ### ESG 조회
104
104
 
105
105
  ```bash
106
- krx esg list --date 20250307 --type index
107
- krx esg list --date 20250307 --type sri-bond
106
+ krx esg list --date 20260310 --type index
107
+ krx esg list --date 20260310 --type sri-bond
108
108
  ```
109
109
 
110
110
  ### 스키마 조회
@@ -116,24 +116,24 @@ krx schema stock.stk_bydd_trd
116
116
 
117
117
  ## 글로벌 옵션
118
118
 
119
- | 옵션 | 설명 | 기본값 |
120
- |------|------|--------|
119
+ | 옵션 | 설명 | 기본값 |
120
+ | ----------------------- | ------------------------------ | ------------------------------ |
121
121
  | `-o, --output <format>` | 출력 형식: json, table, ndjson | json (파이프) / table (터미널) |
122
- | `-f, --fields <fields>` | 출력 필드 필터 (쉼표 구분) | 전체 |
123
- | `--dry-run` | API 호출 없이 요청 내용 출력 | - |
124
- | `-v, --verbose` | 상세 로그 (stderr) | - |
122
+ | `-f, --fields <fields>` | 출력 필드 필터 (쉼표 구분) | 전체 |
123
+ | `--dry-run` | API 호출 없이 요청 내용 출력 | - |
124
+ | `-v, --verbose` | 상세 로그 (stderr) | - |
125
125
 
126
126
  ## Exit Codes
127
127
 
128
- | 코드 | 의미 |
129
- |------|------|
130
- | 0 | 성공 |
131
- | 1 | 일반 오류 |
132
- | 2 | 사용법 오류 (잘못된 인자) |
133
- | 3 | 데이터 없음 |
134
- | 4 | 인증 실패 |
135
- | 5 | Rate limit 초과 (일 10,000건) |
136
- | 6 | 서비스 미승인 |
128
+ | 코드 | 의미 |
129
+ | ---- | ----------------------------- |
130
+ | 0 | 성공 |
131
+ | 1 | 일반 오류 |
132
+ | 2 | 사용법 오류 (잘못된 인자) |
133
+ | 3 | 데이터 없음 |
134
+ | 4 | 인증 실패 |
135
+ | 5 | Rate limit 초과 (일 10,000건) |
136
+ | 6 | 서비스 미승인 |
137
137
 
138
138
  ## AI 에이전트 연동
139
139
 
@@ -176,14 +176,14 @@ export KRX_API_KEY=<your-api-key>
176
176
 
177
177
  skills.sh는 40개 이상의 에이전트를 지원합니다:
178
178
 
179
- | 에이전트 | 스킬 설치 경로 |
180
- |---------|--------------|
181
- | Claude Code | `~/.claude/skills/` |
182
- | Cursor | `~/.cursor/skills/` |
179
+ | 에이전트 | 스킬 설치 경로 |
180
+ | -------------- | --------------------------- |
181
+ | Claude Code | `~/.claude/skills/` |
182
+ | Cursor | `~/.cursor/skills/` |
183
183
  | GitHub Copilot | `~/.github-copilot/skills/` |
184
- | Cline | `~/.cline/skills/` |
185
- | Windsurf | `~/.windsurf/skills/` |
186
- | 기타 | `~/.agents/skills/` |
184
+ | Cline | `~/.cline/skills/` |
185
+ | Windsurf | `~/.windsurf/skills/` |
186
+ | 기타 | `~/.agents/skills/` |
187
187
 
188
188
  ### 사용 예시
189
189
 
package/SKILL.md CHANGED
@@ -1,12 +1,15 @@
1
1
  ---
2
2
  name: krx-cli
3
- description: Query KRX (Korea Exchange) market data via CLI
3
+ description: Query KRX (Korea Exchange) market data via CLI. This skill should be used when the user asks about Korean stock market data including stock prices, indices, ETF/ETN/ELW, bonds, derivatives, commodities, or ESG data. Triggers on tasks involving 주가, 시세, 종가, 코스피, 코스닥, KOSPI, KOSDAQ, KRX, 지수, ETF, 채권, 선물, 옵션, 금시세, 배출권, ESG. Do NOT web search — use the `krx` CLI via Bash tool instead.
4
4
  required_env:
5
5
  - KRX_API_KEY
6
6
  install: npm install -g krx-cli
7
7
  binary: krx
8
+ metadata:
9
+ author: kyo504
10
+ version: "1.1.0"
8
11
  invariants:
9
- - Always use YYYYMMDD format for --date (e.g., 20250307)
12
+ - Always use YYYYMMDD format for --date (e.g., 20260310)
10
13
  - Data is T-1 (previous trading day), available from 2010 onwards
11
14
  - Default output is JSON to stdout, errors go to stderr
12
15
  - Rate limit is 10,000 API calls per day
@@ -16,7 +19,19 @@ invariants:
16
19
 
17
20
  # krx-cli
18
21
 
19
- Agent-native CLI for querying KRX (Korea Exchange) Open API data.
22
+ Agent-native CLI for querying KRX (Korea Exchange) Open API data. Use the `krx` CLI via Bash tool — do NOT web search for Korean market data.
23
+
24
+ ## When to Apply
25
+
26
+ Use this skill when the user asks about:
27
+
28
+ - 주식 시세/가격 (삼성전자 주가, 종목별 종가 등)
29
+ - 지수 조회 (코스피, 코스닥, KRX 지수 등)
30
+ - ETF, ETN, ELW 시세
31
+ - 채권 시세 (국채, 일반채권, 소액채권)
32
+ - 파생상품 (선물, 옵션)
33
+ - 일반상품 (금, 석유, 배출권)
34
+ - ESG 지수/채권 정보
20
35
 
21
36
  ## Setup
22
37
 
@@ -44,63 +59,63 @@ krx auth check <category> # Check specific category: index, stock, etp, bond
44
59
  ### Index (지수)
45
60
 
46
61
  ```bash
47
- krx index list --date 20250307 --market kospi # KOSPI index
48
- krx index list --date 20250307 --market kosdaq # KOSDAQ index
49
- krx index list --date 20250307 --market krx # KRX index
50
- krx index list --date 20250307 --market bond # Bond index
51
- krx index list --date 20250307 --market derivative # Derivative index
62
+ krx index list --date 20260310 --market kospi # KOSPI index
63
+ krx index list --date 20260310 --market kosdaq # KOSDAQ index
64
+ krx index list --date 20260310 --market krx # KRX index
65
+ krx index list --date 20260310 --market bond # Bond index
66
+ krx index list --date 20260310 --market derivative # Derivative index
52
67
  ```
53
68
 
54
69
  ### Stock (주식)
55
70
 
56
71
  ```bash
57
- krx stock list --date 20250307 --market kospi # KOSPI stocks
58
- krx stock list --date 20250307 --market kosdaq # KOSDAQ stocks
59
- krx stock list --date 20250307 --market konex # KONEX stocks
72
+ krx stock list --date 20260310 --market kospi # KOSPI stocks
73
+ krx stock list --date 20260310 --market kosdaq # KOSDAQ stocks
74
+ krx stock list --date 20260310 --market konex # KONEX stocks
60
75
  krx stock info --market kospi # Stock base info
61
76
  ```
62
77
 
63
78
  ### ETP (ETF/ETN/ELW)
64
79
 
65
80
  ```bash
66
- krx etp list --date 20250307 --type etf # ETF
67
- krx etp list --date 20250307 --type etn # ETN
68
- krx etp list --date 20250307 --type elw # ELW
81
+ krx etp list --date 20260310 --type etf # ETF
82
+ krx etp list --date 20260310 --type etn # ETN
83
+ krx etp list --date 20260310 --type elw # ELW
69
84
  ```
70
85
 
71
86
  ### Bond (채권)
72
87
 
73
88
  ```bash
74
- krx bond list --date 20250307 --market kts # Government bonds
75
- krx bond list --date 20250307 --market general # General bonds
76
- krx bond list --date 20250307 --market small # Small bonds
89
+ krx bond list --date 20260310 --market kts # Government bonds
90
+ krx bond list --date 20260310 --market general # General bonds
91
+ krx bond list --date 20260310 --market small # Small bonds
77
92
  ```
78
93
 
79
94
  ### Derivative (파생상품)
80
95
 
81
96
  ```bash
82
- krx derivative list --date 20250307 --type futures # Futures
83
- krx derivative list --date 20250307 --type options # Options
84
- krx derivative list --date 20250307 --type futures-kospi # KOSPI stock futures
85
- krx derivative list --date 20250307 --type futures-kosdaq # KOSDAQ stock futures
86
- krx derivative list --date 20250307 --type options-kospi # KOSPI stock options
87
- krx derivative list --date 20250307 --type options-kosdaq # KOSDAQ stock options
97
+ krx derivative list --date 20260310 --type futures # Futures
98
+ krx derivative list --date 20260310 --type options # Options
99
+ krx derivative list --date 20260310 --type futures-kospi # KOSPI stock futures
100
+ krx derivative list --date 20260310 --type futures-kosdaq # KOSDAQ stock futures
101
+ krx derivative list --date 20260310 --type options-kospi # KOSPI stock options
102
+ krx derivative list --date 20260310 --type options-kosdaq # KOSDAQ stock options
88
103
  ```
89
104
 
90
105
  ### Commodity (일반상품)
91
106
 
92
107
  ```bash
93
- krx commodity list --date 20250307 --type gold # Gold
94
- krx commodity list --date 20250307 --type oil # Oil
95
- krx commodity list --date 20250307 --type emission # Emission trading
108
+ krx commodity list --date 20260310 --type gold # Gold
109
+ krx commodity list --date 20260310 --type oil # Oil
110
+ krx commodity list --date 20260310 --type emission # Emission trading
96
111
  ```
97
112
 
98
113
  ### ESG
99
114
 
100
115
  ```bash
101
- krx esg list --date 20250307 --type index # ESG index
102
- krx esg list --date 20250307 --type etp # ESG ETP
103
- krx esg list --date 20250307 --type sri-bond # SRI bonds
116
+ krx esg list --date 20260310 --type index # ESG index
117
+ krx esg list --date 20260310 --type etp # ESG ETP
118
+ krx esg list --date 20260310 --type sri-bond # SRI bonds
104
119
  ```
105
120
 
106
121
  ### Schema (introspection)
@@ -136,13 +151,13 @@ krx schema index.kospi_dd_trd # Specific endpoint schema
136
151
  ### Get KOSPI closing price for a specific date
137
152
 
138
153
  ```bash
139
- krx index list --date 20250307 --market kospi --fields IDX_NM,CLSPRC_IDX,FLUC_RT
154
+ krx index list --date 20260310 --market kospi --fields IDX_NM,CLSPRC_IDX,FLUC_RT
140
155
  ```
141
156
 
142
157
  ### Get Samsung Electronics stock price
143
158
 
144
159
  ```bash
145
- krx stock list --date 20250307 --market kospi --fields ISU_NM,TDD_CLSPRC,FLUC_RT | jq '.[] | select(.ISU_NM == "삼성전자")'
160
+ krx stock list --date 20260310 --market kospi --fields ISU_NM,TDD_CLSPRC,FLUC_RT | jq '.[] | select(.ISU_NM == "삼성전자")'
146
161
  ```
147
162
 
148
163
  ### Check API availability before querying
@@ -154,20 +169,128 @@ krx auth status -o json
154
169
  ### Dry run to verify request
155
170
 
156
171
  ```bash
157
- krx stock list --date 20250307 --market kospi --dry-run
158
- ```
159
-
160
- ## Key Response Fields
161
-
162
- ### Stock / Index common fields
163
- - `BAS_DD` - Date (YYYYMMDD)
164
- - `ISU_NM` / `IDX_NM` - Name
165
- - `TDD_CLSPRC` / `CLSPRC_IDX` - Closing price
166
- - `CMPPREVDD_PRC` / `CMPPREVDD_IDX` - Change from previous day
167
- - `FLUC_RT` - Change rate (%)
168
- - `TDD_OPNPRC` / `OPNPRC_IDX` - Opening price
169
- - `TDD_HGPRC` / `HGPRC_IDX` - High price
170
- - `TDD_LWPRC` / `LWPRC_IDX` - Low price
171
- - `ACC_TRDVOL` - Trading volume
172
- - `ACC_TRDVAL` - Trading value
173
- - `MKTCAP` - Market capitalization
172
+ krx stock list --date 20260310 --market kospi --dry-run
173
+ ```
174
+
175
+ ## Response Fields
176
+
177
+ Use `krx schema <command>` to get full field definitions for any endpoint. All values are strings.
178
+
179
+ ### Index (kospi/kosdaq/krx)
180
+
181
+ | Field | Description |
182
+ | ------------- | ------------------- |
183
+ | BAS_DD | 기준일자 (YYYYMMDD) |
184
+ | IDX_CLSS | 계열구분 |
185
+ | IDX_NM | 지수명 |
186
+ | CLSPRC_IDX | 종가 |
187
+ | CMPPREVDD_IDX | 전일대비 |
188
+ | FLUC_RT | 등락률(%) |
189
+ | OPNPRC_IDX | 시가 |
190
+ | HGPRC_IDX | 고가 |
191
+ | LWPRC_IDX | 저가 |
192
+ | ACC_TRDVOL | 거래량 |
193
+ | ACC_TRDVAL | 거래대금 |
194
+ | MKTCAP | 상장시가총액 |
195
+
196
+ ### Stock (kospi/kosdaq/konex)
197
+
198
+ | Field | Description |
199
+ | ------------- | ------------------- |
200
+ | BAS_DD | 기준일자 (YYYYMMDD) |
201
+ | ISU_CD | 종목코드 |
202
+ | ISU_NM | 종목명 |
203
+ | MKT_NM | 시장구분 |
204
+ | SECT_TP_NM | 소속부 |
205
+ | TDD_CLSPRC | 종가 |
206
+ | CMPPREVDD_PRC | 전일대비 |
207
+ | FLUC_RT | 등락률(%) |
208
+ | TDD_OPNPRC | 시가 |
209
+ | TDD_HGPRC | 고가 |
210
+ | TDD_LWPRC | 저가 |
211
+ | ACC_TRDVOL | 거래량 |
212
+ | ACC_TRDVAL | 거래대금 |
213
+ | MKTCAP | 시가총액 |
214
+ | LIST_SHRS | 상장주식수 |
215
+
216
+ ### ETF
217
+
218
+ | Field | Description |
219
+ | -------------- | --------------- |
220
+ | ISU_CD | 종목코드 |
221
+ | ISU_NM | 종목명 |
222
+ | TDD_CLSPRC | 종가 |
223
+ | FLUC_RT | 등락률(%) |
224
+ | NAV | 순자산가치(NAV) |
225
+ | ACC_TRDVOL | 거래량 |
226
+ | MKTCAP | 시가총액 |
227
+ | IDX_IND_NM | 기초지수명 |
228
+ | OBJ_STKPRC_IDX | 기초지수종가 |
229
+
230
+ ### Futures
231
+
232
+ | Field | Description |
233
+ | -------------- | -------------- |
234
+ | PROD_NM | 상품명 |
235
+ | ISU_NM | 종목명 |
236
+ | TDD_CLSPRC | 종가 |
237
+ | SPOT_PRC | 현물가 |
238
+ | SETL_PRC | 정산가 |
239
+ | ACC_OPNINT_QTY | 미결제약정수량 |
240
+
241
+ ### Options
242
+
243
+ | Field | Description |
244
+ | -------------- | ---------------- |
245
+ | PROD_NM | 상품명 |
246
+ | RGHT_TP_NM | 권리유형 (콜/풋) |
247
+ | ISU_NM | 종목명 |
248
+ | TDD_CLSPRC | 종가 |
249
+ | IMP_VOLT | 내재변동성 |
250
+ | ACC_OPNINT_QTY | 미결제약정수량 |
251
+
252
+ ### Bond
253
+
254
+ | Field | Description |
255
+ | ---------- | ----------- |
256
+ | ISU_NM | 종목명 |
257
+ | CLSPRC | 종가 |
258
+ | CLSPRC_YD | 종가수익률 |
259
+ | ACC_TRDVOL | 거래량 |
260
+ | ACC_TRDVAL | 거래대금 |
261
+
262
+ ### Commodity (gold/emission)
263
+
264
+ | Field | Description |
265
+ | ---------- | ----------- |
266
+ | ISU_NM | 종목명 |
267
+ | TDD_CLSPRC | 종가 |
268
+ | FLUC_RT | 등락률(%) |
269
+ | ACC_TRDVOL | 거래량 |
270
+
271
+ ### Commodity (oil)
272
+
273
+ | Field | Description |
274
+ | ---------- | ------------ |
275
+ | OIL_NM | 유종명 |
276
+ | WT_AVG_PRC | 가중평균가격 |
277
+ | ACC_TRDVOL | 거래량 |
278
+
279
+ ### ESG Index
280
+
281
+ | Field | Description |
282
+ | ----------- | ----------- |
283
+ | IDX_NM | 지수명 |
284
+ | CLSPRC_IDX | 종가 |
285
+ | PRV_DD_CMPR | 전일대비 |
286
+ | UPDN_RATE | 등락률(%) |
287
+
288
+ ### Schema Introspection
289
+
290
+ For full response field definitions including all fields per endpoint:
291
+
292
+ ```bash
293
+ krx schema index.kospi_dd_trd # Shows params + responseFields
294
+ krx schema stock.stk_bydd_trd # Stock endpoint fields
295
+ krx schema --all # All 31 endpoints
296
+ ```