eddmpython commited on
Commit
e4ba18e
·
verified ·
1 Parent(s): b9e8aac

docs(README): 7개 public 카테고리별 설명 + KRX/prices 신규 추가

Browse files
Files changed (1) hide show
  1. README.md +159 -51
README.md CHANGED
@@ -3,6 +3,7 @@ license: mit
3
  task_categories:
4
  - table-question-answering
5
  - text-classification
 
6
  language:
7
  - ko
8
  - en
@@ -16,11 +17,14 @@ tags:
16
  - korea
17
  - financial-statements
18
  - corporate-filings
 
 
 
19
  - 전자공시
20
  - 재무제표
21
  - 사업보고서
22
  - 한국
23
- pretty_name: DartLab 전자공시 데이터
24
  size_categories:
25
  - 1K<n<10K
26
  ---
@@ -33,8 +37,8 @@ size_categories:
33
 
34
  <h3>DartLab Data</h3>
35
 
36
- <p><b>Structured company data from DART & EDGAR disclosure filings</b></p>
37
- <p>DART 전자공시 + EDGAR 공시 데이터 — 한 2,700사 / 미국 970사</p>
38
 
39
  <p>
40
  <a href="https://github.com/eddmpython/dartlab"><img src="https://img.shields.io/badge/GitHub-dartlab-ea4647?style=for-the-badge&labelColor=050811&logo=github&logoColor=white" alt="GitHub"></a>
@@ -49,72 +53,196 @@ size_categories:
49
 
50
  <img align="right" src="https://huggingface.co/datasets/eddmpython/dartlab-data/resolve/main/assets/avatar-study.png" width="120">
51
 
52
- Pre-collected [Parquet](https://parquet.apache.org/) files from [DartLab](https://github.com/eddmpython/dartlab) — a Python library that turns DART (Korea) and EDGAR (US) disclosure filings into one structured company map.
53
 
54
- 한국 DART 전자공시 시스템과 미국 SEC EDGAR에서 수집한 기업 시 데이터입니다.
55
 
56
- This dataset is the **data layer** behind DartLab. When you run `dartlab.Company("005930")`, the library automatically downloads the relevant parquet from this repo.
57
 
58
- ## Dataset Structure
59
 
60
- ```
61
- dart/
62
- ├── docs/ 2,547 companies ~8 GB disclosure text (sections, tables, markdown)
63
- ├── finance/ 2,744 companies ~586 MB financial statements (BS, IS, CF, XBRL)
64
- └── report/ 2,711 companies ~319 MB structured disclosure APIs (28 types)
65
- ```
66
 
67
- Each file is one company: `{stockCode}.parquet`
 
 
 
 
 
 
 
 
68
 
69
- ### docs — Disclosure Text
70
 
71
- Full-text sections from annual/quarterly reports, parsed into structured blocks.
 
 
72
 
73
  | Column | Description |
74
- |--------|------------|
75
  | `rcept_no` | DART filing ID |
76
  | `rcept_date` | Filing date |
77
- | `stock_code` | Stock code |
78
  | `corp_name` | Company name |
79
  | `report_type` | Annual/quarterly report type |
80
- | `section_title` | Original section title |
81
  | `section_order` | Section ordering |
82
  | `content` | Section text (markdown) |
83
  | `blockType` | `text` / `table` / `heading` |
84
  | `year` | Filing year |
85
 
86
- ### financeFinancial Statements
87
 
88
- XBRL-based financial data from DART OpenAPI (`fnlttSinglAcntAll`).
 
 
 
 
89
 
90
  | Column | Description |
91
- |--------|------------|
92
  | `bsns_year` | Business year |
93
  | `reprt_code` | Report quarter code |
94
  | `stock_code` | Stock code |
95
  | `corp_name` | Company name |
96
  | `fs_div` | `CFS` (consolidated) / `OFS` (separate) |
97
  | `sj_div` | Statement type (BS/IS/CF/SCE) |
98
- | `account_id` | XBRL account ID |
99
- | `account_nm` | Account name (Korean) |
100
  | `thstrm_amount` | Current period amount |
101
  | `frmtrm_amount` | Prior period amount |
102
  | `bfefrmtrm_amount` | Two periods prior amount |
103
 
104
- ### reportStructured Disclosure APIs
105
 
106
- 28 DART API categories covering governance, compensation, shareholding, and more.
 
 
 
 
107
 
108
  | Column | Description |
109
- |--------|------------|
110
  | `apiType` | API category (e.g., `dividend`, `employee`, `executive`) |
111
- | `year` | Year |
112
- | `quarter` | Quarter |
113
  | `stockCode` | Stock code |
114
  | `corpCode` | DART corp code |
115
  | *(varies)* | Category-specific columns |
116
 
117
- **28 API types:** dividend, employee, executive, majorHolder, treasuryStock, capitalChange, auditOpinion, stockTotal, outsideDirector, corporateBond, and more.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
118
 
119
  ## Learn More
120
 
@@ -137,26 +265,6 @@ DartLab auto-downloads from this dataset — one stock code gives you the full c
137
 
138
  <img align="right" src="https://huggingface.co/datasets/eddmpython/dartlab-data/resolve/main/assets/avatar-discover.png" width="120">
139
 
140
- ## Data Source
141
-
142
- - **DART** (Korea): [dart.fss.or.kr](https://dart.fss.or.kr) — Korea's electronic disclosure system operated by the Financial Supervisory Service
143
- - **EDGAR** (US): [sec.gov/edgar](https://www.sec.gov/edgar) — SEC's Electronic Data Gathering, Analysis, and Retrieval system
144
-
145
- All data is sourced from public government disclosure systems. Financial figures are preserved as-is from the original filings — no rounding, no estimation, no interpolation.
146
-
147
- ## Update Schedule
148
-
149
- This dataset is updated automatically via GitHub Actions (daily). Recent filings (last 7 days) are checked and collected incrementally.
150
-
151
  ## License
152
 
153
- MIT same as [DartLab](https://github.com/eddmpython/dartlab).
154
-
155
- ## Support
156
-
157
- If DartLab is useful for your work, consider supporting the project:
158
-
159
- [![Buy Me A Coffee](https://img.shields.io/badge/Buy_Me_A_Coffee-Support-ffdd00?style=for-the-badge&labelColor=050811&logo=buy-me-a-coffee&logoColor=white)](https://buymeacoffee.com/eddmpython)
160
-
161
- - [GitHub Issues](https://github.com/eddmpython/dartlab/issues) — bug reports, feature requests
162
- - [Blog](https://eddmpython.github.io/dartlab/blog/) — 120+ articles on Korean disclosure analysis
 
3
  task_categories:
4
  - table-question-answering
5
  - text-classification
6
+ - time-series-forecasting
7
  language:
8
  - ko
9
  - en
 
17
  - korea
18
  - financial-statements
19
  - corporate-filings
20
+ - krx
21
+ - ohlcv
22
+ - market-data
23
  - 전자공시
24
  - 재무제표
25
  - 사업보고서
26
  - 한국
27
+ pretty_name: DartLab 전자공시 + 시장 데이터
28
  size_categories:
29
  - 1K<n<10K
30
  ---
 
37
 
38
  <h3>DartLab Data</h3>
39
 
40
+ <p><b>Structured company data + market data from DART, EDGAR, KRX</b></p>
41
+ <p>한국 DART 공시 + 미국 SEC EDGAR 공시 + KRX 시장 데이터 — 한 dataset, 여러 카테고리</p>
42
 
43
  <p>
44
  <a href="https://github.com/eddmpython/dartlab"><img src="https://img.shields.io/badge/GitHub-dartlab-ea4647?style=for-the-badge&labelColor=050811&logo=github&logoColor=white" alt="GitHub"></a>
 
53
 
54
  <img align="right" src="https://huggingface.co/datasets/eddmpython/dartlab-data/resolve/main/assets/avatar-study.png" width="120">
55
 
56
+ Pre-built [Parquet](https://parquet.apache.org/) files from [DartLab](https://github.com/eddmpython/dartlab) — a Python library that turns DART (Korea), EDGAR (US), and KRX disclosure & market data into one structured company map.
57
 
58
+ 한국 DART 전자공시 + 미국 SEC EDGAR 공시 + KRX 거래소 일별 데이터를 동일한 SSOT 로 묶은 데이터셋.
59
 
60
+ This dataset is the **data layer** behind DartLab. When you run `dartlab.Company("005930")` or `dartlab.gather("krx", "close")`, the library auto-downloads the relevant parquet from this repo — no API key, no manual collection.
61
 
62
+ ## Datasets
63
 
64
+ 7 public categories — each lives at its own subdirectory and is consumed by a specific dartlab engine.
 
 
 
 
 
65
 
66
+ | Category | Path | Coverage | Engine |
67
+ |---|---|---|---|
68
+ | [dart/docs](#dartdocs--dart-disclosure-text) | `dart/docs/` | 2,547 KR companies, ~8 GB | `Company.show("section")` |
69
+ | [dart/finance](#dartfinance--dart-financial-statements) | `dart/finance/` | 2,744 KR companies, ~586 MB | `Company.show("BS"/"IS"/"CF")` |
70
+ | [dart/report](#dartreport--dart-structured-disclosure-apis) | `dart/report/` | 2,711 KR companies, ~319 MB | `Company.report()` (28 APIs) |
71
+ | [dart/scan](#dartscan--cross-sectional-pre-built) | `dart/scan/` | KR cross-sectional | `dartlab.scan("...")` |
72
+ | [edgar/docs](#edgardocs--edgar-disclosure-text) | `edgar/docs/` | 970 US companies | `Company.show("section")` (US) |
73
+ | [krx/prices](#krxprices--krx-daily-ohlcv-new) ★ | `krx/prices/` | 1995~today, 17 yearly parquets | `gather("krx", target)` |
74
+ | [landing/map](#landingmap--industry-map-json) | `landing/map/` | KR industry graph | `dartlab.industry()` |
75
 
76
+ ---
77
 
78
+ ### dart/docs DART Disclosure Text
79
+
80
+ Full-text sections from Korean annual/quarterly reports, parsed into structured blocks.
81
 
82
  | Column | Description |
83
+ |---|---|
84
  | `rcept_no` | DART filing ID |
85
  | `rcept_date` | Filing date |
86
+ | `stock_code` | Stock code (6-digit) |
87
  | `corp_name` | Company name |
88
  | `report_type` | Annual/quarterly report type |
89
+ | `section_title` | Original section title (한글) |
90
  | `section_order` | Section ordering |
91
  | `content` | Section text (markdown) |
92
  | `blockType` | `text` / `table` / `heading` |
93
  | `year` | Filing year |
94
 
95
+ **File**: `dart/docs/{stockCode}.parquet`one file per company.
96
 
97
+ ---
98
+
99
+ ### dart/finance — DART Financial Statements
100
+
101
+ XBRL-based financial data from DART OpenAPI (`fnlttSinglAcntAll`). BS/IS/CF/SCE × 분기/연간.
102
 
103
  | Column | Description |
104
+ |---|---|
105
  | `bsns_year` | Business year |
106
  | `reprt_code` | Report quarter code |
107
  | `stock_code` | Stock code |
108
  | `corp_name` | Company name |
109
  | `fs_div` | `CFS` (consolidated) / `OFS` (separate) |
110
  | `sj_div` | Statement type (BS/IS/CF/SCE) |
111
+ | `account_id` | XBRL account ID (~97% mapped to standard names) |
112
+ | `account_nm` | Account name (한글) |
113
  | `thstrm_amount` | Current period amount |
114
  | `frmtrm_amount` | Prior period amount |
115
  | `bfefrmtrm_amount` | Two periods prior amount |
116
 
117
+ **File**: `dart/finance/{stockCode}.parquet`one file per company.
118
 
119
+ ---
120
+
121
+ ### dart/report — DART Structured Disclosure APIs
122
+
123
+ 28 DART API categories covering governance, compensation, shareholding, capital changes, audit opinions, and more.
124
 
125
  | Column | Description |
126
+ |---|---|
127
  | `apiType` | API category (e.g., `dividend`, `employee`, `executive`) |
128
+ | `year` / `quarter` | Reporting period |
 
129
  | `stockCode` | Stock code |
130
  | `corpCode` | DART corp code |
131
  | *(varies)* | Category-specific columns |
132
 
133
+ **28 API types**: dividend, employee, executive, majorHolder, treasuryStock, capitalChange, auditOpinion, stockTotal, outsideDirector, corporateBond, and 18 more.
134
+
135
+ **File**: `dart/report/{stockCode}.parquet` — one file per company.
136
+
137
+ ---
138
+
139
+ ### dart/scan — Cross-Sectional Pre-Built
140
+
141
+ Pre-computed cross-sectional aggregates across all KR listed companies (governance ratios, cash-flow patterns, financial ratios, etc.) — for ranking/screening without per-company iteration.
142
+
143
+ | Subcategory | Content |
144
+ |---|---|
145
+ | `dart/scan/governance/` | Board structure, related-party, ownership concentration |
146
+ | `dart/scan/financial/` | Pre-computed ratios (ROE, debt-to-equity, ...) |
147
+ | `dart/scan/cashflow/` | Operating/investing/financing patterns |
148
+
149
+ **Engine**: `dartlab.scan("governance/...")` — one call returns all-company DataFrame.
150
+
151
+ ---
152
+
153
+ ### edgar/docs — EDGAR Disclosure Text
154
+
155
+ Full-text sections from US annual/quarterly reports (10-K, 10-Q, 8-K, ...), parsed into the same structure as `dart/docs`. Same library API works for both markets.
156
+
157
+ **File**: `edgar/docs/{ticker}.parquet`.
158
+
159
+ ---
160
+
161
+ ### krx/prices — KRX Daily OHLCV ★ NEW
162
+
163
+ Daily OHLCV + market cap + listed shares for **all KRX-listed companies (KOSPI + KOSDAQ)**, raw long parquet from KRX OpenAPI.
164
+
165
+ | Column | Description | Unit |
166
+ |---|---|---|
167
+ | `BAS_DD` | Trade date (YYYYMMDD) | string |
168
+ | `ISU_CD` | Stock code (6-digit) | string |
169
+ | `ISU_NM` | Stock name | string |
170
+ | `MKT_NM` / `SECT_TP_NM` | Market / sector | string |
171
+ | `TDD_OPNPRC` / `TDD_HGPRC` / `TDD_LWPRC` / `TDD_CLSPRC` | Open / High / Low / Close | KRW |
172
+ | `ACC_TRDVOL` / `ACC_TRDVAL` | Volume / Amount | shares / KRW |
173
+ | `MKTCAP` | Market cap | KRW |
174
+ | `LIST_SHRS` | Listed shares | shares |
175
+ | `FLUC_RT` / `CMPPREVDD_PRC` | Daily change rate / price | % / KRW |
176
+
177
+ **Coverage**: 1995-01-04 ~ today (17 yearly partitions: `raw-1995.parquet` ~ `raw-2026.parquet`).
178
+ **Update**: every weekday at KST 17:00 (after market close + settlement). Auto gap-fill if any cron run is missed.
179
+ **Engine**: `gather("krx", target, ...)` — pivot to wide (rows = stockCode, cols = date) on demand. Adjusted prices (split/bonus/rights) auto-applied via price-series detection (CRSP backward chaining).
180
+
181
+ ```python
182
+ import dartlab
183
+ dartlab.gather("krx", "close", start="2025-01-01", end="2025-06-30") # close-price wide
184
+ dartlab.gather("krx", "rsi14", start="2025-01-01") # 30+ technical indicators
185
+ dartlab.gather("krx", "marketCap", start="2025-06-30") # market cap snapshot
186
+ ```
187
+
188
+ **No API key needed** — engine reads HF directly. (KRX OpenAPI key is only for operator cron building this dataset.)
189
+
190
+ ---
191
+
192
+ ### landing/map — Industry Map JSON
193
+
194
+ Pre-built industry graph (nodes + edges) for the Korean market — companies × processes × supply-chain edges. Powers the `/map` interactive industry visualization.
195
+
196
+ **Engine**: `dartlab.industry()` / `c.industry()`.
197
+
198
+ ---
199
+
200
+ ## Usage
201
+
202
+ ```python
203
+ import dartlab
204
+
205
+ # 1. Korean company — auto-downloads dart/docs + dart/finance + dart/report
206
+ c = dartlab.Company("005930")
207
+ c.show("BS") # balance sheet (dart/finance)
208
+ c.show("businessOverview") # business section text (dart/docs)
209
+ c.report("dividend") # dividend history (dart/report)
210
+
211
+ # 2. US company — same API, edgar/docs auto
212
+ us = dartlab.Company("AAPL")
213
+ us.show("IS")
214
+
215
+ # 3. KRX market data — no API key, HF auto
216
+ df = dartlab.gather("krx", "close", start="2024-01-01", end="2024-12-31") # 1-year wide DataFrame
217
+
218
+ # 4. Cross-sectional scan
219
+ ranked = dartlab.scan("governance/dividend") # all KR companies, sorted
220
+
221
+ # 5. Natural language
222
+ dartlab.ask("삼성전자 재무건전성 분석해줘")
223
+ ```
224
+
225
+ **No API key, no setup** — `pip install dartlab` and the library auto-downloads from this dataset, with local caching.
226
+
227
+ ## Data Source
228
+
229
+ - **DART** (Korea): [dart.fss.or.kr](https://dart.fss.or.kr) — Financial Supervisory Service's electronic disclosure system
230
+ - **EDGAR** (US): [sec.gov/edgar](https://www.sec.gov/edgar) — SEC's Electronic Data Gathering, Analysis, and Retrieval system
231
+ - **KRX** (Korea): [openapi.krx.co.kr](https://openapi.krx.co.kr) — Korea Exchange OpenAPI (daily OHLCV + market cap + shares)
232
+
233
+ All data sourced from public/government systems. Numeric figures preserved as-is from the original source — no rounding, no estimation, no interpolation. Adjusted prices computed at use time (raw + events SSOT).
234
+
235
+ ## Update Schedule
236
+
237
+ | Category | Cadence | Trigger |
238
+ |---|---|---|
239
+ | `dart/docs`, `dart/finance`, `dart/report` | Daily incremental + weekly full sync | GitHub Actions (DART) |
240
+ | `dart/scan` | Daily after dart/finance update | GitHub Actions |
241
+ | `edgar/docs` | Daily incremental | GitHub Actions (EDGAR) |
242
+ | `krx/prices` | Every weekday at KST 17:00 (T-0 same-day, auto gap-fill) | GitHub Actions (KRX) |
243
+ | `landing/map` | On industry-map source change | GitHub Actions (map build) |
244
+
245
+ Recent 7-day filings checked incrementally; full re-sync on schema changes.
246
 
247
  ## Learn More
248
 
 
265
 
266
  <img align="right" src="https://huggingface.co/datasets/eddmpython/dartlab-data/resolve/main/assets/avatar-discover.png" width="120">
267
 
 
 
 
 
 
 
 
 
 
 
 
268
  ## License
269
 
270
+ Dataset content licensed MIT. Underlying source data is governed by each source's terms (DART, SEC EDGAR, KRX OpenAPI). See [data source attribution](#data-source).