eddmpython commited on
Commit
9babaf9
·
verified ·
1 Parent(s): d004616

add dataset card

Browse files
Files changed (1) hide show
  1. README.md +166 -3
README.md CHANGED
@@ -1,3 +1,166 @@
1
- ---
2
- license: mit
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: mit
3
+ task_categories:
4
+ - table-question-answering
5
+ - text-classification
6
+ language:
7
+ - ko
8
+ - en
9
+ tags:
10
+ - finance
11
+ - disclosure
12
+ - dart
13
+ - edgar
14
+ - sec
15
+ - xbrl
16
+ - korea
17
+ - financial-statements
18
+ - corporate-filings
19
+ pretty_name: DartLab Company Data
20
+ size_categories:
21
+ - 1K<n<10K
22
+ ---
23
+
24
+ <div align="center">
25
+
26
+ # DartLab Data
27
+
28
+ **Structured company data from DART & EDGAR disclosure filings**
29
+
30
+ [![GitHub](https://img.shields.io/badge/GitHub-dartlab-ea4647?style=for-the-badge&labelColor=050811&logo=github&logoColor=white)](https://github.com/eddmpython/dartlab)
31
+ [![PyPI](https://img.shields.io/pypi/v/dartlab?style=for-the-badge&color=ea4647&labelColor=050811&logo=pypi&logoColor=white)](https://pypi.org/project/dartlab/)
32
+ [![Docs](https://img.shields.io/badge/Docs-GitHub_Pages-38bdf8?style=for-the-badge&labelColor=050811&logo=github-pages&logoColor=white)](https://eddmpython.github.io/dartlab/)
33
+ [![Sponsor](https://img.shields.io/badge/Sponsor-Buy_Me_A_Coffee-ffdd00?style=for-the-badge&labelColor=050811&logo=buy-me-a-coffee&logoColor=white)](https://buymeacoffee.com/eddmpython)
34
+
35
+ </div>
36
+
37
+ ## What is this?
38
+
39
+ 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.
40
+
41
+ This dataset is the **data layer** behind DartLab. When you run `dartlab.Company("005930")`, the library automatically downloads the relevant parquet from this repo.
42
+
43
+ ## Dataset Structure
44
+
45
+ ```
46
+ dart/
47
+ ├── docs/ 6 companies ~42 MB disclosure text (sections, tables, markdown)
48
+ ├── finance/ 2,735 companies ~586 MB financial statements (BS, IS, CF, XBRL)
49
+ └── report/ 2,711 companies ~319 MB structured disclosure APIs (28 types)
50
+ ```
51
+
52
+ Each file is one company: `{stockCode}.parquet`
53
+
54
+ ### docs — Disclosure Text
55
+
56
+ Full-text sections from annual/quarterly reports, parsed into structured blocks.
57
+
58
+ | Column | Description |
59
+ |--------|------------|
60
+ | `rcept_no` | DART filing ID |
61
+ | `rcept_date` | Filing date |
62
+ | `stock_code` | Stock code |
63
+ | `corp_name` | Company name |
64
+ | `report_type` | Annual/quarterly report type |
65
+ | `section_title` | Original section title |
66
+ | `section_order` | Section ordering |
67
+ | `content` | Section text (markdown) |
68
+ | `blockType` | `text` / `table` / `heading` |
69
+ | `year` | Filing year |
70
+
71
+ ### finance — Financial Statements
72
+
73
+ XBRL-based financial data from DART OpenAPI (`fnlttSinglAcntAll`).
74
+
75
+ | Column | Description |
76
+ |--------|------------|
77
+ | `bsns_year` | Business year |
78
+ | `reprt_code` | Report quarter code |
79
+ | `stock_code` | Stock code |
80
+ | `corp_name` | Company name |
81
+ | `fs_div` | `CFS` (consolidated) / `OFS` (separate) |
82
+ | `sj_div` | Statement type (BS/IS/CF/SCE) |
83
+ | `account_id` | XBRL account ID |
84
+ | `account_nm` | Account name (Korean) |
85
+ | `thstrm_amount` | Current period amount |
86
+ | `frmtrm_amount` | Prior period amount |
87
+ | `bfefrmtrm_amount` | Two periods prior amount |
88
+
89
+ ### report — Structured Disclosure APIs
90
+
91
+ 28 DART API categories covering governance, compensation, shareholding, and more.
92
+
93
+ | Column | Description |
94
+ |--------|------------|
95
+ | `apiType` | API category (e.g., `dividend`, `employee`, `executive`) |
96
+ | `year` | Year |
97
+ | `quarter` | Quarter |
98
+ | `stockCode` | Stock code |
99
+ | `corpCode` | DART corp code |
100
+ | *(varies)* | Category-specific columns |
101
+
102
+ **28 API types:** dividend, employee, executive, majorHolder, treasuryStock, capitalChange, auditOpinion, stockTotal, outsideDirector, corporateBond, and more.
103
+
104
+ ## Usage
105
+
106
+ ### With DartLab (recommended)
107
+
108
+ ```bash
109
+ pip install dartlab
110
+ ```
111
+
112
+ ```python
113
+ import dartlab
114
+
115
+ c = dartlab.Company("005930") # Samsung Electronics
116
+ c.sections # full company map (topic x period)
117
+ c.BS # balance sheet
118
+ c.ratios # financial ratios
119
+ c.show("businessOverview") # narrative text
120
+
121
+ # US companies work the same way
122
+ us = dartlab.Company("AAPL")
123
+ us.BS
124
+ us.ratios
125
+ ```
126
+
127
+ DartLab auto-downloads from this dataset. No manual download needed.
128
+
129
+ ### Direct download
130
+
131
+ ```python
132
+ import polars as pl
133
+
134
+ # Single file
135
+ url = "https://huggingface.co/datasets/eddmpython/dartlab-data/resolve/main/dart/finance/005930.parquet"
136
+ df = pl.read_parquet(url)
137
+ ```
138
+
139
+ ```bash
140
+ # wget
141
+ wget https://huggingface.co/datasets/eddmpython/dartlab-data/resolve/main/dart/finance/005930.parquet
142
+ ```
143
+
144
+ ## Data Source
145
+
146
+ - **DART** (Korea): [dart.fss.or.kr](https://dart.fss.or.kr) — Korea's electronic disclosure system operated by the Financial Supervisory Service
147
+ - **EDGAR** (US): [sec.gov/edgar](https://www.sec.gov/edgar) — SEC's Electronic Data Gathering, Analysis, and Retrieval system
148
+
149
+ 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.
150
+
151
+ ## Update Schedule
152
+
153
+ This dataset is updated automatically via GitHub Actions (twice weekly). New filings are collected incrementally.
154
+
155
+ ## License
156
+
157
+ MIT — same as [DartLab](https://github.com/eddmpython/dartlab).
158
+
159
+ ## Support
160
+
161
+ If DartLab is useful for your work, consider supporting the project:
162
+
163
+ [![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)
164
+
165
+ - [GitHub Issues](https://github.com/eddmpython/dartlab/issues) — bug reports, feature requests
166
+ - [Blog](https://eddmpython.github.io/dartlab/blog/) — 120+ articles on Korean disclosure analysis