@@ -0,0 +1,17 @@
|
||||
# `openstock dart corp`
|
||||
|
||||
Purpose: resolve a KRX stock symbol to an OpenDART corp code.
|
||||
|
||||
Usage:
|
||||
|
||||
```bash
|
||||
openstock dart corp 005930
|
||||
```
|
||||
|
||||
Input: `symbol`.
|
||||
|
||||
Reads: OpenDART corp code cache; refreshes on miss when needed.
|
||||
|
||||
Output fields: `stock_code`, `corp_code`, `corp_name`, `modify_date`.
|
||||
|
||||
Agent rule: use when an OpenDART command needs an explicit corp code.
|
||||
@@ -0,0 +1,20 @@
|
||||
# `openstock dart disclosures`
|
||||
|
||||
Purpose: query disclosure lists from OpenDART.
|
||||
|
||||
Usage:
|
||||
|
||||
```bash
|
||||
openstock dart disclosures 005930 --from 20260601 --to 20260609
|
||||
openstock dart disclosures --corp-code 00126380 --page-count 50
|
||||
```
|
||||
|
||||
Inputs: optional `symbol`, `--corp-code`, `--from`, `--to`, `--corp-cls`, `--page-no`, `--page-count`.
|
||||
|
||||
Reads: `OPENDART_API_KEY`; corp-code cache when resolving a symbol.
|
||||
|
||||
External IO: OpenDART list API.
|
||||
|
||||
Output fields: `query`, `resolved`, `disclosures`.
|
||||
|
||||
Agent rule: use for disclosure evidence lists without fetching document text.
|
||||
@@ -0,0 +1,19 @@
|
||||
# `openstock dart document`
|
||||
|
||||
Purpose: fetch and extract text from a DART disclosure document by receipt number.
|
||||
|
||||
Usage:
|
||||
|
||||
```bash
|
||||
openstock dart document 20260609000000 --max-chars 20000
|
||||
```
|
||||
|
||||
Inputs: `rcept_no`, optional `--force`, `--max-chars`.
|
||||
|
||||
Reads: `OPENDART_API_KEY`.
|
||||
|
||||
Writes: document ZIP cache.
|
||||
|
||||
Output fields: document metadata and extracted text.
|
||||
|
||||
Agent rule: use `--max-chars` to cap large documents.
|
||||
@@ -0,0 +1,43 @@
|
||||
# `openstock dart`
|
||||
|
||||
## Purpose
|
||||
|
||||
Query OpenDART listed-company mappings, disclosure lists, and disclosure documents.
|
||||
|
||||
## Subcommands
|
||||
|
||||
| Command | Purpose |
|
||||
| --- | --- |
|
||||
| `openstock dart sync [--force]` | Refresh OpenDART corp code cache. |
|
||||
| `openstock dart status` | Show corp code cache status. |
|
||||
| `openstock dart corp <symbol>` | Resolve KRX symbol to DART corp code. |
|
||||
| `openstock dart disclosures [symbol] [--corp-code CODE] [--from YYYYMMDD] [--to YYYYMMDD] [--corp-cls Y|K|N|E] [--page-no N] [--page-count N]` | Query disclosure list. |
|
||||
| `openstock dart document <rcept_no> [--force] [--max-chars N]` | Fetch disclosure document text. |
|
||||
| `openstock dart show <symbol> [--from YYYYMMDD] [--to YYYYMMDD] [--index N] [--page-count N] [--force] [--max-chars N]` | Query disclosures for a symbol and fetch one selected document. |
|
||||
|
||||
## IO
|
||||
|
||||
| Direction | Data |
|
||||
| --- | --- |
|
||||
| Env read | `OPENDART_API_KEY` for OpenDART API calls. |
|
||||
| External IO | OpenDART corp code, list, and document endpoints. |
|
||||
| File read/write | `~/.config/openstock/cache/opendart`. |
|
||||
| Side effect | `sync`, `document`, and `show` can write cache. |
|
||||
|
||||
## Important Fields
|
||||
|
||||
| Field | Meaning |
|
||||
| --- | --- |
|
||||
| `stock_code` | KRX stock code. |
|
||||
| `corp_code` | OpenDART 8-digit company code. |
|
||||
| `corp_name` | OpenDART company name. |
|
||||
| `modify_date` | Corp code mapping modification date. |
|
||||
| `query` | Disclosure query sent to OpenDART. |
|
||||
| `resolved` | Symbol/corp code resolution details. |
|
||||
| `disclosures` | Disclosure list. |
|
||||
| `selected` | Disclosure selected by `--index`. |
|
||||
| `document` | Disclosure document metadata and extracted text. |
|
||||
|
||||
## Agent Notes
|
||||
|
||||
Use `dart show` for the common workflow: symbol to disclosures to selected document. Use `dart disclosures` when only the list is needed.
|
||||
@@ -0,0 +1,19 @@
|
||||
# `openstock dart show`
|
||||
|
||||
Purpose: query disclosures for a symbol and fetch the selected disclosure document.
|
||||
|
||||
Usage:
|
||||
|
||||
```bash
|
||||
openstock dart show 005930 --from 20260601 --to 20260609 --index 1
|
||||
```
|
||||
|
||||
Inputs: `symbol`, optional `--from`, `--to`, `--index`, `--page-count`, `--force`, `--max-chars`.
|
||||
|
||||
Reads: `OPENDART_API_KEY`; corp-code and document cache.
|
||||
|
||||
External IO: OpenDART list and document APIs.
|
||||
|
||||
Output fields: `query`, `resolved`, `disclosures`, `selected`, `document`.
|
||||
|
||||
Agent rule: preferred command when the task asks for a specific stock's latest disclosure and contents.
|
||||
@@ -0,0 +1,15 @@
|
||||
# `openstock dart status`
|
||||
|
||||
Purpose: inspect OpenDART corp code cache status.
|
||||
|
||||
Usage:
|
||||
|
||||
```bash
|
||||
openstock dart status
|
||||
```
|
||||
|
||||
Reads: OpenDART corp code cache.
|
||||
|
||||
Output fields: source/cache metadata and corp count.
|
||||
|
||||
Agent rule: if cache is missing, run `openstock dart sync`.
|
||||
@@ -0,0 +1,18 @@
|
||||
# `openstock dart sync`
|
||||
|
||||
Purpose: refresh OpenDART listed-company corp code mapping cache.
|
||||
|
||||
Usage:
|
||||
|
||||
```bash
|
||||
openstock dart sync
|
||||
openstock dart sync --force
|
||||
```
|
||||
|
||||
Reads: `OPENDART_API_KEY`.
|
||||
|
||||
Writes: `~/.config/openstock/cache/opendart/corp_codes.json`.
|
||||
|
||||
Output fields: source/cache metadata and corp count.
|
||||
|
||||
Agent rule: run when corp-code cache is missing, stale, or explicitly requested.
|
||||
Reference in New Issue
Block a user