dart-fss-cli 0.4.1
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.
- package/LICENSE +21 -0
- package/README.md +93 -0
- package/dist/bin.js +11 -0
- package/dist/chunk-4JOKJUHX.js +1715 -0
- package/dist/cli.d.ts +5 -0
- package/dist/cli.js +6 -0
- package/package.json +47 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Kiyeon Jeon
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
# dart-fss-cli
|
|
2
|
+
|
|
3
|
+
CLI for the Korea FSS [DART Open API](https://opendart.fss.or.kr) (Electronic Disclosure System).
|
|
4
|
+
|
|
5
|
+
Access all DART API endpoints from the command line.
|
|
6
|
+
|
|
7
|
+
**[한국어 가이드 (Korean Guide)](docs/ko.md)**
|
|
8
|
+
|
|
9
|
+
## Install
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
curl -fsSL https://raw.githubusercontent.com/kiyeonjeon21/dart-fss-cli/main/install.sh | bash
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Or via npm:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm install -g dart-fss-cli
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Or run directly with npx:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
npx dart-fss-cli --help
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Setup
|
|
28
|
+
|
|
29
|
+
Get an API key from [DART Open API](https://opendart.fss.or.kr).
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
export DART_API_KEY=your_api_key_here
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Usage
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
# Company overview
|
|
39
|
+
dart-fss disclosure company --corp "삼성전자" --pretty
|
|
40
|
+
|
|
41
|
+
# Search disclosures
|
|
42
|
+
dart-fss disclosure list --corp "카카오" --from 20240101 --to 20241231
|
|
43
|
+
|
|
44
|
+
# Employee status
|
|
45
|
+
dart-fss report employee --corp "삼성전자" --year 2024 --quarter annual
|
|
46
|
+
|
|
47
|
+
# Financial statements
|
|
48
|
+
dart-fss financial single-account --corp "카카오" --year 2024 --quarter annual --pretty
|
|
49
|
+
|
|
50
|
+
# Major holdings
|
|
51
|
+
dart-fss equity major-stock --corp "삼성전자" --pretty
|
|
52
|
+
|
|
53
|
+
# Look up corp_code by name
|
|
54
|
+
dart-fss lookup "네이버"
|
|
55
|
+
|
|
56
|
+
# List all endpoints
|
|
57
|
+
dart-fss endpoints
|
|
58
|
+
|
|
59
|
+
# Save output to file
|
|
60
|
+
dart-fss disclosure company --corp "삼성전자" --output result.json
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Command Groups
|
|
64
|
+
|
|
65
|
+
| Command | Description | APIs |
|
|
66
|
+
|---------|-------------|------|
|
|
67
|
+
| `disclosure` | Disclosures (search, company overview, documents) | 4 |
|
|
68
|
+
| `report` | Periodic reports (employees, executives, dividends, etc.) | 28 |
|
|
69
|
+
| `financial` | Financial data (statements, indices, XBRL) | 7 |
|
|
70
|
+
| `equity` | Equity disclosure (major holdings, executive ownership) | 2 |
|
|
71
|
+
| `major` | Major event reports (capital changes, bonds, M&A, etc.) | 36 |
|
|
72
|
+
| `securities` | Securities registration (equity, debt, mergers, etc.) | 6 |
|
|
73
|
+
|
|
74
|
+
## Global Options
|
|
75
|
+
|
|
76
|
+
| Option | Description |
|
|
77
|
+
|--------|-------------|
|
|
78
|
+
| `--api-key <key>` | DART API key (default: `DART_API_KEY` env) |
|
|
79
|
+
| `--pretty` | Pretty-print JSON output |
|
|
80
|
+
| `--output <file>` | Save result to file |
|
|
81
|
+
|
|
82
|
+
## Programmatic Usage
|
|
83
|
+
|
|
84
|
+
```typescript
|
|
85
|
+
import { createDartProgram } from 'dart-fss-cli';
|
|
86
|
+
|
|
87
|
+
const program = createDartProgram();
|
|
88
|
+
await program.parseAsync(['node', 'dart-fss', 'disclosure', 'company', '--corp', '삼성전자', '--pretty']);
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
## License
|
|
92
|
+
|
|
93
|
+
MIT
|
package/dist/bin.js
ADDED