PyPI - datasinking - Versions diffs - 0.2.13__tar.gz → 0.2.15__tar.gz - Mend

datasinking 0.2.13tar.gz → 0.2.15tar.gz

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 (15) hide show

{datasinking-0.2.13 → datasinking-0.2.15}/PKG-INFO RENAMED Viewed

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: datasinking
-Version: 0.2.13
-Summary: Python client for DataSinking — full-text Asian financial reports (China, Korea, Japan, Taiwan) as Markdown.
+Version: 0.2.15
+Summary: Python client for DataSinking — full-text financial reports (US, UK, China, Japan, Korea, Taiwan) as Markdown. Earn $7 per yearly referral: https://datasink.ing/affiliate
 Author: DataSinking
 License: MIT
 Project-URL: Homepage, https://datasink.ing
 Project-URL: Documentation, https://datasink.ing/docs
 Project-URL: Repository, https://github.com/heubme2020/datasinking
-Keywords: a-share,china,korea,japan,financial reports,markdown,api,mcp,model-context-protocol,rag,llm
+Keywords: a-share,china,korea,japan,us,sec,financial reports,markdown,api,mcp,model-context-protocol,rag,llm
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
@@ -28,20 +28,21 @@ Dynamic: license-file
 [![PyPI version](https://img.shields.io/pypi/v/datasinking.svg)](https://pypi.org/project/datasinking/)
 [![MCP server](https://img.shields.io/badge/MCP-server-blue)](https://github.com/heubme2020/datasinking#mcp-server)
-**Full-text financial reports across Asia, as clean Markdown.**
+**Full-text financial reports across the US and Asia, as clean Markdown.**
 [DataSinking](https://datasink.ing) serves **full-text financial reports** — annual, semi-annual
-and quarterly — from **China, Korea, Japan and Taiwan** as clean **Markdown**, ready for LLM reading
-and RAG. Query by FMP-style symbol (`600519.SS`, `005930.KS`, `7203.T`, `2330.TW`) or filter by
+and quarterly — from **the US, the UK, China, Japan, Korea and Taiwan** as clean **Markdown**, ready for LLM reading
+and RAG. Query by FMP-style symbol (`AAPL`, `600519.SS`, `7203.T`, `005930.KS`, `2330.TW`) or filter by
 exchange, report period, or **section** — pull just the MD&A / risk section instead of the whole
-report. Reports are sourced from official disclosure platforms and parsed into structured Markdown
+filing, saving tokens. Every figure is traceable to its source disclosure and
+block. Reports are sourced from official disclosure platforms and parsed into structured Markdown
 with YAML frontmatter, preserved headings, paragraphs and tables.
 ---
 ## MCP server
-Ship DataSinking to any AI agent (Claude / Cursor / Codex / Devin Desktop) as an
+Ship DataSinking to any AI agent (Claude / Cursor / Codex / Devin Desktop / n8n) as an
 [MCP](https://modelcontextprotocol.io) server — 6 tools: list exchanges, list stocks,
 list reports, fetch a report, list sections, fetch one section (token-friendly for RAG).
@@ -144,6 +145,9 @@ errors that client actually produces:
 | Cursor | [`docs/mcp/cursor.md`](docs/mcp/cursor.md) |
 | DeepSeek Harness (`dsh`) | [`docs/mcp/deepseek.md`](docs/mcp/deepseek.md) |
 | Devin Desktop | [`docs/mcp/windsurf.md`](docs/mcp/windsurf.md) |
+| OpenCode | [`docs/mcp/opencode.md`](docs/mcp/opencode.md) |
+| Qoder | [`docs/mcp/qoder.md`](docs/mcp/qoder.md) |
+| Reasonix | [`docs/mcp/reasonix.md`](docs/mcp/reasonix.md) |
 ## Quick start
@@ -184,6 +188,7 @@ coverage, list a company's reports, and extract a figure with correct units.
 | `01_quickstart.py` | The 5 core functions: list exchanges / stocks / reports / fetch a report / fetch a stock's reports |
 | `02_download_company.py` | Download a company's full reports to local Markdown files |
 | `03_download_exchange.py` | Download an entire exchange's reports (all stocks) to local Markdown files |
+| `rag_ingest.py` | Slice reports into RAG chunks (on the `<!-- ds:block:N -->` anchors, with `source` traceability) and ingest into a vector store |
 Every example pulls from the live API and runs as-is.
@@ -203,12 +208,12 @@ Start from [`research/TEMPLATE.md`](research/TEMPLATE.md).
 | | |
 |---|---|
-| Coverage | China (SSE / SZSE / BSE) · Korea (KOSPI / KOSDAQ / KONEX) · Japan (TSE) · Taiwan (TWSE / TPEx) |
+| Coverage | US (NYSE / NASDAQ / CBOE) · China (SSE / SZSE / BSE) · Japan (TSE) · Korea (KOSPI / KOSDAQ / KONEX) · Taiwan (TWSE / TPEx) |
 | Document types | annual / semiannual / q1 / q3 / amendment |
-| Update frequency | Daily — Korea/Japan via official DART/EDINET APIs (new filings within ~24h of publication) |
+| Update frequency | Daily — US/Korea/Japan via official SEC EDGAR / DART / EDINET APIs (new filings within ~24h of publication) |
 | Format | Full-text Markdown (with YAML frontmatter) |
 | API | REST — `GET /documents`, batch download, `with_content=1` for full text, `?section=` + `/sections` for chapter-level access |
-| Symbols | FMP style: `600519.SS` / `005930.KS` / `7203.T` |
+| Symbols | FMP style: `AAPL` / `600519.SS` / `7203.T` / `005930.KS` |
 | Auth | `?apikey=` query parameter (FMP style) |
 ## Data source
@@ -217,6 +222,7 @@ Reports are sourced from the official regulatory disclosure platform of each mar
 | Market | Source | Platform |
 |---|---|---|
+| US (bare ticker, e.g. `AAPL`) | SEC EDGAR | US Securities and Exchange Commission — sec.gov/edgar |
 | China A-shares (`.SS` `.SZ` `.BJ`) | 巨潮资讯网 cninfo | CSRC-designated disclosure platform |
 | Korea (`.KS` `.KQ` `.KN`) | DART | Financial Supervisory Service — opendart.fss.or.kr |
 | Japan (`.T`) | EDINET | Financial Services Agency — disclosure2.edinet-fsa.go.jp |
@@ -224,6 +230,10 @@ Reports are sourced from the official regulatory disclosure platform of each mar
 Every document also carries a `source` field in the API response, so the attribution travels with the data. **Please keep it when you redistribute.**
+## Affiliate
+Earn **$7** for every customer who buys the yearly plan — one-time, PayPal, $31 minimum withdrawal: [datasink.ing/affiliate](https://datasink.ing/affiliate)
 ## License
 [MIT](LICENSE)

{datasinking-0.2.13 → datasinking-0.2.15}/README.md RENAMED Viewed

@@ -1,206 +1,216 @@
-# DataSinking
-<!-- mcp-name: io.github.heubme2020/datasinking -->
-[![PyPI version](https://img.shields.io/pypi/v/datasinking.svg)](https://pypi.org/project/datasinking/)
-[![MCP server](https://img.shields.io/badge/MCP-server-blue)](https://github.com/heubme2020/datasinking#mcp-server)
-**Full-text financial reports across Asia, as clean Markdown.**
-[DataSinking](https://datasink.ing) serves **full-text financial reports** — annual, semi-annual
-and quarterly — from **China, Korea, Japan and Taiwan** as clean **Markdown**, ready for LLM reading
-and RAG. Query by FMP-style symbol (`600519.SS`, `005930.KS`, `7203.T`, `2330.TW`) or filter by
-exchange, report period, or **section** — pull just the MD&A / risk section instead of the whole
-report. Reports are sourced from official disclosure platforms and parsed into structured Markdown
-with YAML frontmatter, preserved headings, paragraphs and tables.
----
-## MCP server
-Ship DataSinking to any AI agent (Claude / Cursor / Codex / Devin Desktop) as an
-[MCP](https://modelcontextprotocol.io) server — 6 tools: list exchanges, list stocks,
-list reports, fetch a report, list sections, fetch one section (token-friendly for RAG).
-### Hosted — nothing to install
-One URL, no package, no Python, no local server. Most clients take this shape:
-```json
-{
-  "mcpServers": {
-    "datasinking": {
-      "type": "http",
-      "url": "https://api.datasink.ing/mcp",
-      "headers": { "Authorization": "Bearer YOUR_KEY" }
-    }
-  }
-}
-```
-Claude Code, in one line:
-```bash
-claude mcp add --transport http datasinking https://api.datasink.ing/mcp \
-  --header "Authorization: Bearer YOUR_KEY"
-```
-A client that can't set a header can put the key in the URL instead —
-`https://api.datasink.ing/mcp?apikey=YOUR_KEY` — but only do that when you must: a key in a URL
-ends up in logs and screen shares, and no client can redact it.
-Two clients don't fit the shape above: Codex's config is TOML, and Devin Desktop's remote field is
-`serverUrl`, not `url`. Per-client files: [`docs/mcp/`](docs/mcp/).
-### Local — run it yourself
-If you'd rather keep everything on your own machine, there are two identical builds — pick
-whichever runtime you already have:
-**Node 18+ (no Python needed):**
-```json
-{
-  "mcpServers": {
-    "datasinking": {
-      "command": "npx",
-      "args": ["-y", "datasinking-mcp"],
-      "env": { "DATASINK_API_KEY": "YOUR_KEY" }
-    }
-  }
-}
-```
-**Python 3.8+:**
-```bash
-pip install "datasinking[mcp]"
-datasinking-mcp          # requires DATASINK_API_KEY (free at https://datasink.ing)
-```
-Then use `command: datasinking-mcp` in your client.
-Both run the same six tools with the same schemas — `npm/` and `datasinking/mcp_server.py` are
-kept in lockstep by [`check_mcp_parity.py`](check_mcp_parity.py).
-Full per-client setup: [`mcp-server.md`](mcp-server.md) (overview) ·
-[`docs/mcp/`](docs/mcp/) (one guide per client).
-The hosted endpoint is **POST-only and stateless** — `GET /mcp` returns 405, and no session id is
-issued. Most clients read MCP config at launch, so restart one after changing its config.
-![DataSinking MCP in Claude](docs/images/mcp-demo.png)
-## What this repo is
-Examples, research and tutorials showing how to work with financial report data, including reproducing the presentation styles found in financial-report research papers.
-```
-datasinking/
-├── examples/     # Example scripts: pull data from the API and analyze it
-├── research/     # Research notes / blog posts (reproducing paper-style presentation)
-├── datasinking/  # Python client + MCP server — pip install "datasinking[mcp]"
-├── npm/          # The same MCP server on npm — npx -y datasinking-mcp (Node 18+)
-├── docs/mcp/     # Per-client MCP setup — Claude Code, Desktop, Cursor, Codex, WorkBuddy, Devin…
-├── mcp-server.md # MCP server overview — endpoint, per-client table, tools, troubleshooting
-├── llm-examples.md  # Ask an LLM — no code needed (8 end-to-end examples)
-├── api-examples.md  # 7 examples × 3 interfaces (curl / Python / LLM)
-└── README.md
-```
-Per-client MCP guides — one file each, with the exact config path, both scopes, verification and the
-errors that client actually produces:
-| Client | Guide |
-|---|---|
-| Claude Code | [`docs/mcp/claude-code.md`](docs/mcp/claude-code.md) |
-| Claude Desktop | [`docs/mcp/claude-desktop.md`](docs/mcp/claude-desktop.md) |
-| OpenAI Codex CLI | [`docs/mcp/codex.md`](docs/mcp/codex.md) |
-| WorkBuddy / CodeBuddy | [`docs/mcp/workbuddy.md`](docs/mcp/workbuddy.md) |
-| Doubao Work / 豆包工作 | [`docs/mcp/doubao.md`](docs/mcp/doubao.md) |
-| Cursor | [`docs/mcp/cursor.md`](docs/mcp/cursor.md) |
-| DeepSeek Harness (`dsh`) | [`docs/mcp/deepseek.md`](docs/mcp/deepseek.md) |
-| Devin Desktop | [`docs/mcp/windsurf.md`](docs/mcp/windsurf.md) |
-## Quick start
-1. Get an API key at [datasink.ing](https://datasink.ing)
-2. One line (FMP-style `?apikey=`):
-```bash
-curl "https://api.datasink.ing/documents?symbol=600519.SS&with_content=1&apikey=YOUR_KEY"
-```
-Or in Python:
-```bash
-pip install datasinking
-```
-```python
-from datasinking import DataSinking
-ds = DataSinking("YOUR_KEY")
-for r in ds.get_stock_reports("600519.SS", limit=3):
-    print(r["report_period"], r["title"], len(r["content"]), "chars")
-```
-All five functions (curl / Python / LLM): [`api-examples.md`](api-examples.md).
-## Ask an LLM (no code)
-Don't want to write code? Point any LLM at [datasink.ing](https://datasink.ing),
-give it your API key, and ask in plain language. See
-[`llm-examples.md`](llm-examples.md) for eight end-to-end examples — explore
-coverage, list a company's reports, and extract a figure with correct units.
-## Examples (`examples/`)
-| File | What it does |
-|---|---|
-| `01_quickstart.py` | The 5 core functions: list exchanges / stocks / reports / fetch a report / fetch a stock's reports |
-| `02_download_company.py` | Download a company's full reports to local Markdown files |
-| `03_download_exchange.py` | Download an entire exchange's reports (all stocks) to local Markdown files |
-Every example pulls from the live API and runs as-is.
-> `03_download_exchange.py` fetches every report on an exchange (e.g. all of Shenzhen — 150k+ documents). Quotas count **documents, not requests**, over a rolling 7-day window: a free key gets 3 req/s and 8,191 documents per 7 days, inside a pool of 524,287 per 7 days shared by all free users and website visitors. A whole exchange will therefore take well over a week on a free key — a **paid (yearly)** key (31 req/s, 524,287 documents per 7 days) is strongly recommended.
-## Research (`research/`)
-`research/` hosts research notes and blog posts, each based on DataSinking data with the source cited. You can reproduce charts and presentations found in financial-report research papers, e.g.:
-- Long-term revenue / profit trends
-- Industry comparison and distribution
-- Time series of financial metrics
-Start from [`research/TEMPLATE.md`](research/TEMPLATE.md).
-## Data overview
-| | |
-|---|---|
-| Coverage | China (SSE / SZSE / BSE) · Korea (KOSPI / KOSDAQ / KONEX) · Japan (TSE) · Taiwan (TWSE / TPEx) |
-| Document types | annual / semiannual / q1 / q3 / amendment |
-| Update frequency | Daily — Korea/Japan via official DART/EDINET APIs (new filings within ~24h of publication) |
-| Format | Full-text Markdown (with YAML frontmatter) |
-| API | REST — `GET /documents`, batch download, `with_content=1` for full text, `?section=` + `/sections` for chapter-level access |
-| Symbols | FMP style: `600519.SS` / `005930.KS` / `7203.T` |
-| Auth | `?apikey=` query parameter (FMP style) |
-## Data source
-Reports are sourced from the official regulatory disclosure platform of each market and converted in-house to clean Markdown:
-| Market | Source | Platform |
-|---|---|---|
-| China A-shares (`.SS` `.SZ` `.BJ`) | 巨潮资讯网 cninfo | CSRC-designated disclosure platform |
-| Korea (`.KS` `.KQ` `.KN`) | DART | Financial Supervisory Service — opendart.fss.or.kr |
-| Japan (`.T`) | EDINET | Financial Services Agency — disclosure2.edinet-fsa.go.jp |
-| Taiwan (`.TW` `.TWO`) | 公開資訊觀測站 MOPS | Taiwan Stock Exchange — mops.twse.com.tw |
-Every document also carries a `source` field in the API response, so the attribution travels with the data. **Please keep it when you redistribute.**
-## License
-[MIT](LICENSE)
+# DataSinking
+<!-- mcp-name: io.github.heubme2020/datasinking -->
+[![PyPI version](https://img.shields.io/pypi/v/datasinking.svg)](https://pypi.org/project/datasinking/)
+[![MCP server](https://img.shields.io/badge/MCP-server-blue)](https://github.com/heubme2020/datasinking#mcp-server)
+**Full-text financial reports across the US and Asia, as clean Markdown.**
+[DataSinking](https://datasink.ing) serves **full-text financial reports** — annual, semi-annual
+and quarterly — from **the US, the UK, China, Japan, Korea and Taiwan** as clean **Markdown**, ready for LLM reading
+and RAG. Query by FMP-style symbol (`AAPL`, `600519.SS`, `7203.T`, `005930.KS`, `2330.TW`) or filter by
+exchange, report period, or **section** — pull just the MD&A / risk section instead of the whole
+filing, saving tokens. Every figure is traceable to its source disclosure and
+block. Reports are sourced from official disclosure platforms and parsed into structured Markdown
+with YAML frontmatter, preserved headings, paragraphs and tables.
+---
+## MCP server
+Ship DataSinking to any AI agent (Claude / Cursor / Codex / Devin Desktop / n8n) as an
+[MCP](https://modelcontextprotocol.io) server — 6 tools: list exchanges, list stocks,
+list reports, fetch a report, list sections, fetch one section (token-friendly for RAG).
+### Hosted — nothing to install
+One URL, no package, no Python, no local server. Most clients take this shape:
+```json
+{
+  "mcpServers": {
+    "datasinking": {
+      "type": "http",
+      "url": "https://api.datasink.ing/mcp",
+      "headers": { "Authorization": "Bearer YOUR_KEY" }
+    }
+  }
+}
+```
+Claude Code, in one line:
+```bash
+claude mcp add --transport http datasinking https://api.datasink.ing/mcp \
+  --header "Authorization: Bearer YOUR_KEY"
+```
+A client that can't set a header can put the key in the URL instead —
+`https://api.datasink.ing/mcp?apikey=YOUR_KEY` — but only do that when you must: a key in a URL
+ends up in logs and screen shares, and no client can redact it.
+Two clients don't fit the shape above: Codex's config is TOML, and Devin Desktop's remote field is
+`serverUrl`, not `url`. Per-client files: [`docs/mcp/`](docs/mcp/).
+### Local — run it yourself
+If you'd rather keep everything on your own machine, there are two identical builds — pick
+whichever runtime you already have:
+**Node 18+ (no Python needed):**
+```json
+{
+  "mcpServers": {
+    "datasinking": {
+      "command": "npx",
+      "args": ["-y", "datasinking-mcp"],
+      "env": { "DATASINK_API_KEY": "YOUR_KEY" }
+    }
+  }
+}
+```
+**Python 3.8+:**
+```bash
+pip install "datasinking[mcp]"
+datasinking-mcp          # requires DATASINK_API_KEY (free at https://datasink.ing)
+```
+Then use `command: datasinking-mcp` in your client.
+Both run the same six tools with the same schemas — `npm/` and `datasinking/mcp_server.py` are
+kept in lockstep by [`check_mcp_parity.py`](check_mcp_parity.py).
+Full per-client setup: [`mcp-server.md`](mcp-server.md) (overview) ·
+[`docs/mcp/`](docs/mcp/) (one guide per client).
+The hosted endpoint is **POST-only and stateless** — `GET /mcp` returns 405, and no session id is
+issued. Most clients read MCP config at launch, so restart one after changing its config.
+![DataSinking MCP in Claude](docs/images/mcp-demo.png)
+## What this repo is
+Examples, research and tutorials showing how to work with financial report data, including reproducing the presentation styles found in financial-report research papers.
+```
+datasinking/
+├── examples/     # Example scripts: pull data from the API and analyze it
+├── research/     # Research notes / blog posts (reproducing paper-style presentation)
+├── datasinking/  # Python client + MCP server — pip install "datasinking[mcp]"
+├── npm/          # The same MCP server on npm — npx -y datasinking-mcp (Node 18+)
+├── docs/mcp/     # Per-client MCP setup — Claude Code, Desktop, Cursor, Codex, WorkBuddy, Devin…
+├── mcp-server.md # MCP server overview — endpoint, per-client table, tools, troubleshooting
+├── llm-examples.md  # Ask an LLM — no code needed (8 end-to-end examples)
+├── api-examples.md  # 7 examples × 3 interfaces (curl / Python / LLM)
+└── README.md
+```
+Per-client MCP guides — one file each, with the exact config path, both scopes, verification and the
+errors that client actually produces:
+| Client | Guide |
+|---|---|
+| Claude Code | [`docs/mcp/claude-code.md`](docs/mcp/claude-code.md) |
+| Claude Desktop | [`docs/mcp/claude-desktop.md`](docs/mcp/claude-desktop.md) |
+| OpenAI Codex CLI | [`docs/mcp/codex.md`](docs/mcp/codex.md) |
+| WorkBuddy / CodeBuddy | [`docs/mcp/workbuddy.md`](docs/mcp/workbuddy.md) |
+| Doubao Work / 豆包工作 | [`docs/mcp/doubao.md`](docs/mcp/doubao.md) |
+| Cursor | [`docs/mcp/cursor.md`](docs/mcp/cursor.md) |
+| DeepSeek Harness (`dsh`) | [`docs/mcp/deepseek.md`](docs/mcp/deepseek.md) |
+| Devin Desktop | [`docs/mcp/windsurf.md`](docs/mcp/windsurf.md) |
+| OpenCode | [`docs/mcp/opencode.md`](docs/mcp/opencode.md) |
+| Qoder | [`docs/mcp/qoder.md`](docs/mcp/qoder.md) |
+| Reasonix | [`docs/mcp/reasonix.md`](docs/mcp/reasonix.md) |
+## Quick start
+1. Get an API key at [datasink.ing](https://datasink.ing)
+2. One line (FMP-style `?apikey=`):
+```bash
+curl "https://api.datasink.ing/documents?symbol=600519.SS&with_content=1&apikey=YOUR_KEY"
+```
+Or in Python:
+```bash
+pip install datasinking
+```
+```python
+from datasinking import DataSinking
+ds = DataSinking("YOUR_KEY")
+for r in ds.get_stock_reports("600519.SS", limit=3):
+    print(r["report_period"], r["title"], len(r["content"]), "chars")
+```
+All five functions (curl / Python / LLM): [`api-examples.md`](api-examples.md).
+## Ask an LLM (no code)
+Don't want to write code? Point any LLM at [datasink.ing](https://datasink.ing),
+give it your API key, and ask in plain language. See
+[`llm-examples.md`](llm-examples.md) for eight end-to-end examples — explore
+coverage, list a company's reports, and extract a figure with correct units.
+## Examples (`examples/`)
+| File | What it does |
+|---|---|
+| `01_quickstart.py` | The 5 core functions: list exchanges / stocks / reports / fetch a report / fetch a stock's reports |
+| `02_download_company.py` | Download a company's full reports to local Markdown files |
+| `03_download_exchange.py` | Download an entire exchange's reports (all stocks) to local Markdown files |
+| `rag_ingest.py` | Slice reports into RAG chunks (on the `<!-- ds:block:N -->` anchors, with `source` traceability) and ingest into a vector store |
+Every example pulls from the live API and runs as-is.
+> `03_download_exchange.py` fetches every report on an exchange (e.g. all of Shenzhen — 150k+ documents). Quotas count **documents, not requests**, over a rolling 7-day window: a free key gets 3 req/s and 8,191 documents per 7 days, inside a pool of 524,287 per 7 days shared by all free users and website visitors. A whole exchange will therefore take well over a week on a free key — a **paid (yearly)** key (31 req/s, 524,287 documents per 7 days) is strongly recommended.
+## Research (`research/`)
+`research/` hosts research notes and blog posts, each based on DataSinking data with the source cited. You can reproduce charts and presentations found in financial-report research papers, e.g.:
+- Long-term revenue / profit trends
+- Industry comparison and distribution
+- Time series of financial metrics
+Start from [`research/TEMPLATE.md`](research/TEMPLATE.md).
+## Data overview
+| | |
+|---|---|
+| Coverage | US (NYSE / NASDAQ / CBOE) · China (SSE / SZSE / BSE) · Japan (TSE) · Korea (KOSPI / KOSDAQ / KONEX) · Taiwan (TWSE / TPEx) |
+| Document types | annual / semiannual / q1 / q3 / amendment |
+| Update frequency | Daily — US/Korea/Japan via official SEC EDGAR / DART / EDINET APIs (new filings within ~24h of publication) |
+| Format | Full-text Markdown (with YAML frontmatter) |
+| API | REST — `GET /documents`, batch download, `with_content=1` for full text, `?section=` + `/sections` for chapter-level access |
+| Symbols | FMP style: `AAPL` / `600519.SS` / `7203.T` / `005930.KS` |
+| Auth | `?apikey=` query parameter (FMP style) |
+## Data source
+Reports are sourced from the official regulatory disclosure platform of each market and converted in-house to clean Markdown:
+| Market | Source | Platform |
+|---|---|---|
+| US (bare ticker, e.g. `AAPL`) | SEC EDGAR | US Securities and Exchange Commission — sec.gov/edgar |
+| China A-shares (`.SS` `.SZ` `.BJ`) | 巨潮资讯网 cninfo | CSRC-designated disclosure platform |
+| Korea (`.KS` `.KQ` `.KN`) | DART | Financial Supervisory Service — opendart.fss.or.kr |
+| Japan (`.T`) | EDINET | Financial Services Agency — disclosure2.edinet-fsa.go.jp |
+| Taiwan (`.TW` `.TWO`) | 公開資訊觀測站 MOPS | Taiwan Stock Exchange — mops.twse.com.tw |
+Every document also carries a `source` field in the API response, so the attribution travels with the data. **Please keep it when you redistribute.**
+## Affiliate
+Earn **$7** for every customer who buys the yearly plan — one-time, PayPal, $31 minimum withdrawal: [datasink.ing/affiliate](https://datasink.ing/affiliate)
+## License
+[MIT](LICENSE)

{datasinking-0.2.13 → datasinking-0.2.15}/datasinking/_version.py RENAMED Viewed

@@ -1,11 +1,11 @@
-# -*- coding: utf-8 -*-
-"""版本号的**唯一来源**。
-pyproject.toml 用 `dynamic = ["version"]` 从这里读，`client.py` 的 User-Agent 也读它。
-为什么单独抽一个文件：之前 pyproject.toml 和 `__init__.py` 各写各的版本号，
-结果 `__version__` 长期停在 0.1.0 没跟上（发 0.2.4 时才发现，User-Agent 里也一直
-写着旧版本）。现在只有这一处需要改。
-"""
-__version__ = "0.2.13"
+# -*- coding: utf-8 -*-
+"""版本号的**唯一来源**。
+pyproject.toml 用 `dynamic = ["version"]` 从这里读，`client.py` 的 User-Agent 也读它。
+为什么单独抽一个文件：之前 pyproject.toml 和 `__init__.py` 各写各的版本号，
+结果 `__version__` 长期停在 0.1.0 没跟上（发 0.2.4 时才发现，User-Agent 里也一直
+写着旧版本）。现在只有这一处需要改。
+"""
+__version__ = "0.2.15"

{datasinking-0.2.13 → datasinking-0.2.15}/datasinking/mcp_server.py RENAMED Viewed

@@ -1,213 +1,220 @@
-# -*- coding: utf-8 -*-
-"""DataSinking MCP server (Model Context Protocol).
-Expose the DataSinking API — full-text financial reports across Asia
-(China, Korea, Japan, Taiwan) as clean Markdown — to AI agents (Claude, Cursor,
-Codex, DeepSeek, Devin Desktop, …).
-Install the MCP extra::
-    pip install "datasinking[mcp]"
-Then run::
-    datasinking-mcp
-or add to any MCP client with ``command: datasinking-mcp`` (stdio). Requires
-the environment variable ``DATASINK_API_KEY`` (get a free key at
-https://datasink.ing).
-"""
-import json
-import os
-from typing import Annotated, Optional
-import requests
-from pydantic import Field
-from ._version import __version__  # 版本号唯一来源（原来是硬编码，漂到了 0.2.3）
-# mcp v1 uses FastMCP; v2 renamed it to MCPServer. Support both.
-try:
-    from mcp.server.fastmcp import FastMCP  # mcp v1
-except ImportError:  # pragma: no cover
-    from mcp.server.mcpserver import MCPServer as FastMCP  # mcp v2
-# ⚠️ **工具里必须抛 ToolError，不能抛 RuntimeError。**
-#
-# mcp v2（实测 2.2.0）对两者的处理完全不同：
-#     抛 RuntimeError  → 客户端收到 isError:true，但文本是**通用句**
-#                         「Error executing tool <名字>」，**消息内容被剥掉**，只进 stderr
-#     抛 ToolError     → 客户端收到 isError:true，文本带上你的原话
-#                         「Error executing tool <名字>: <你的消息>」
-#
-# 这不是细节：get_section 的描述让模型「用真实标题重试」，标题列表就在消息里；
-# 缺 API key 的提示也只在这里。用 RuntimeError 的话，模型看到的是一个**没有任何线索**的
-# 失败 —— 2026-09-22 用真 key 走 uvx 发布版实测确认（`Error executing tool get_section`，32 字符）。
-try:
-    from mcp.server.fastmcp.exceptions import ToolError  # mcp v1
-except ImportError:  # pragma: no cover
-    try:
-        from mcp.server.mcpserver.exceptions import ToolError  # mcp v2
-    except ImportError:  # 极老的 mcp 没有这个类：退回普通异常（消息会丢，但不至于起不来）
-        ToolError = RuntimeError  # type: ignore[assignment,misc]
-# ⚠️ 参数描述必须写成 `Annotated[T, Field(description=...)]`，**不能只靠 docstring 的 Args 段**。
-#    mcp v2（MCPServer）不再解析 docstring 的 Args —— 实测把整段 Args 当散文塞进工具描述，
-#    参数级 description 全是空的（2026-09-22 用真实 stdio 握手验证）。v1 两种都认，所以这样写两边通用。
-BASE_URL = "https://api.datasink.ing"
-API_KEY = os.environ.get("DATASINK_API_KEY", "")
-mcp = FastMCP(
-    "DataSinking",
-    title="DataSinking — Full-text Asian Financial Reports",
-    description="Full-text Asian financial reports (China, Korea, Japan, Taiwan) as clean Markdown via API, with chapter-level access for RAG and AI agents.",
-    version=__version__,
-    instructions=(
-        "DataSinking serves full-text financial reports (annual / semi-annual / quarterly) "
-        "from China, Korea, Japan and Taiwan as clean Markdown, ready for LLM reading and RAG. "
-        "Use FMP-style symbols: 600519.SS (Kweichow Moutai), 005930.KS (Samsung Electronics), "
-        "7203.T (Toyota), 2330.TW (TSMC). To save tokens, prefer get_section to pull one chapter "
-        "(e.g. MD&A) instead of get_report for the whole document."
-    ),
-)
-def _get(path: str, params: Optional[dict] = None) -> dict:
-    """Call the DataSinking API, carrying the API key automatically.
-    出错时**把服务端 body 原文带出去**。它写的不是「失败了」，而是「该怎么办」：
-      ``detail``     一句人话（「未找到章节「X」」）
-      ``available``  那份报告的**全部真实标题**
-    ``get_section`` 的工具描述明确让模型「retry with one of those」，所以这个列表
-    必须跟着异常走。原来这里是一句 ``r.raise_for_status()``，body 整个丢掉 ——
-    模型只看到裸的 ``404 Client Error: Not Found for url: ...``，既不知道错在哪，
-    也没有可重试的标题（2026-09-22 用真 key 实测，三份实现里这份丢得最干净）。
-    """
-    if not API_KEY:
-        raise ToolError(
-            "Missing DATASINK_API_KEY environment variable (get a free key at https://datasink.ing)"
-        )
-    p = dict(params or {})
-    p["apikey"] = API_KEY
-    r = requests.get(f"{BASE_URL}{path}", params=p, timeout=90)
-    if not r.ok:
-        try:
-            body = r.json()
-        except ValueError:
-            body = None
-        if not isinstance(body, dict):
-            body = {}
-        msg = f"HTTP {r.status_code}: {body.get('detail') or r.text[:2000]}"
-        available = body.get("available")
-        if isinstance(available, list):
-            msg += "\nAvailable sections: " + json.dumps(available, ensure_ascii=False)
-        # ToolError 而非 RuntimeError —— 否则 mcp v2 把 msg 剥成通用句，见文件顶部注释
-        raise ToolError(msg)
-    return r.json()
-@mcp.tool()
-def list_exchanges() -> list:
-    """List the exchanges DataSinking covers.
-    Returns exchange codes (sse / szse / bj / ksc / koe / knx / jpx / twse / tpex) with
-    the number of reports available per exchange. Call this first to discover coverage.
-    Sources: A-shares = cninfo.com.cn, Korea = DART, Japan = EDINET, Taiwan = MOPS.
-    """
-    return _get("/exchanges").get("exchanges", [])
-@mcp.tool()
-def list_stocks(
-    exchange: Annotated[
-        str, Field(description="Exchange code, e.g. sse / szse / bj / ksc / koe / knx / jpx / twse / tpex")
-    ],
-    limit: Annotated[
-        int, Field(description="Return only the first N companies (default 20) to keep the response short.")
-    ] = 20,
-) -> dict:
-    """List the stocks on one exchange, including the report count per company."""
-    data = _get("/stocks", {"exchange": exchange})
-    return {"exchange": exchange, "total": data.get("total", 0), "items": data.get("items", [])[:limit]}
-@mcp.tool()
-def list_reports(
-    symbol: Annotated[
-        str, Field(description="FMP-style symbol, e.g. 600519.SS / 005930.KS / 7203.T / 2330.TW")
-    ],
-    doc_type: Annotated[
-        str, Field(description="Report type to filter on. Defaults to annual.")
-    ] = "annual",
-    size: Annotated[int, Field(description="Number of reports to return (default 10).")] = 10,
-) -> dict:
-    """List a company's reports — metadata only (id, title, period), no body text.
-    Each item carries a `source` field naming the official disclosure platform;
-    keep that attribution when you cite it.
-    """
-    return _get("/documents", {"symbol": symbol, "doc_type": doc_type, "size": size})
-@mcp.tool()
-def get_report(
-    document_id: Annotated[int, Field(description="Report id, from list_reports items[].id")],
-) -> dict:
-    """Fetch one report's full text (metadata + Markdown body).
-    The `source` field names the official disclosure platform; keep that attribution
-    when you cite it. Expensive in tokens — prefer get_section when you only need one chapter.
-    """
-    return _get(f"/documents/{document_id}")
-@mcp.tool()
-def list_sections(
-    document_id: Annotated[int, Field(description="Report id, from list_reports items[].id")],
-) -> dict:
-    """List every section of a report with its size, before you decide what to pull.
-    Returns `sections` (titles, in order) plus `section_details` — same order, one entry
-    per section with `title`, `has_tables`, `chars` and `estimated_tokens`.
-    Use `estimated_tokens` to avoid pulling a chapter that would blow your context,
-    and `has_tables` to know whether the chapter needs special handling (tables are the
-    part RAG pipelines usually get wrong). Then call get_section with a heading keyword —
-    the headings are in the report's own language.
-    """
-    return _get(f"/documents/{document_id}/sections")
-@mcp.tool()
-def get_section(
-    document_id: Annotated[int, Field(description="Report id, from list_reports items[].id")],
-    section: Annotated[
-        str,
-        Field(
-            description=(
-                "Heading keyword, matched as a substring against the report's OWN headings, "
-                "so pass it in the report's language. A-share reports have Chinese headings "
-                "(e.g. 第三节管理层讨论与分析) — use 管理层讨论与分析 / 财务报告 there. "
-                "For English-language filings, \"MD&A\" / \"financial statements\" / \"notes\" work. "
-                "If nothing matches, the API returns 404 with the real headings — retry with one "
-                "of those, or call list_sections first."
-            )
-        ),
-    ],
-) -> dict:
-    """Fetch only one section of a report by keyword — much cheaper than get_report, best for RAG."""
-    return _get(f"/documents/{document_id}", {"section": section})
-def main() -> None:
-    """Entry point for the ``datasinking-mcp`` console script."""
-    mcp.run()
-if __name__ == "__main__":
-    main()
+# -*- coding: utf-8 -*-
+"""DataSinking MCP server (Model Context Protocol).
+Expose the DataSinking API — full-text financial reports across the US and Asia
+(the US, the UK, China, Japan, Korea, Taiwan) as clean Markdown — to AI agents (Claude, Cursor,
+Codex, DeepSeek, Devin Desktop, …).
+Install the MCP extra::
+    pip install "datasinking[mcp]"
+Then run::
+    datasinking-mcp
+or add to any MCP client with ``command: datasinking-mcp`` (stdio). Requires
+the environment variable ``DATASINK_API_KEY`` (get a free key at
+https://datasink.ing).
+"""
+import json
+import os
+from typing import Annotated, Optional
+import requests
+from pydantic import Field
+from ._version import __version__  # 版本号唯一来源（原来是硬编码，漂到了 0.2.3）
+# mcp v1 uses FastMCP; v2 renamed it to MCPServer. Support both.
+try:
+    from mcp.server.fastmcp import FastMCP  # mcp v1
+except ImportError:  # pragma: no cover
+    from mcp.server.mcpserver import MCPServer as FastMCP  # mcp v2
+# ⚠️ **工具里必须抛 ToolError，不能抛 RuntimeError。**
+#
+# mcp v2（实测 2.2.0）对两者的处理完全不同：
+#     抛 RuntimeError  → 客户端收到 isError:true，但文本是**通用句**
+#                         「Error executing tool <名字>」，**消息内容被剥掉**，只进 stderr
+#     抛 ToolError     → 客户端收到 isError:true，文本带上你的原话
+#                         「Error executing tool <名字>: <你的消息>」
+#
+# 这不是细节：get_section 的描述让模型「用真实标题重试」，标题列表就在消息里；
+# 缺 API key 的提示也只在这里。用 RuntimeError 的话，模型看到的是一个**没有任何线索**的
+# 失败 —— 2026-09-22 用真 key 走 uvx 发布版实测确认（`Error executing tool get_section`，32 字符）。
+try:
+    from mcp.server.fastmcp.exceptions import ToolError  # mcp v1
+except ImportError:  # pragma: no cover
+    try:
+        from mcp.server.mcpserver.exceptions import ToolError  # mcp v2
+    except ImportError:  # 极老的 mcp 没有这个类：退回普通异常（消息会丢，但不至于起不来）
+        ToolError = RuntimeError  # type: ignore[assignment,misc]
+# ⚠️ 参数描述必须写成 `Annotated[T, Field(description=...)]`，**不能只靠 docstring 的 Args 段**。
+#    mcp v2（MCPServer）不再解析 docstring 的 Args —— 实测把整段 Args 当散文塞进工具描述，
+#    参数级 description 全是空的（2026-09-22 用真实 stdio 握手验证）。v1 两种都认，所以这样写两边通用。
+BASE_URL = "https://api.datasink.ing"
+API_KEY = os.environ.get("DATASINK_API_KEY", "")
+mcp = FastMCP(
+    "DataSinking",
+    title="DataSinking — Full-text Financial Reports",
+    description="Full-text financial reports (US, UK, China, Japan, Korea, Taiwan) as clean Markdown via API, with chapter-level access for RAG and AI agents.",
+    version=__version__,
+    instructions=(
+        "DataSinking serves full-text financial reports (annual / semi-annual / quarterly) "
+        "from the US, the UK, China, Japan, Korea and Taiwan as clean Markdown, ready for LLM reading and RAG. "
+        "Use FMP-style symbols: AAPL (Apple), 600519.SS (Kweichow Moutai), 7203.T (Toyota), "
+        "005930.KS (Samsung Electronics), 2330.TW (TSMC). To save tokens, prefer get_section to pull one chapter "
+        "(e.g. MD&A) instead of get_report for the whole document."
+    ),
+)
+def _get(path: str, params: Optional[dict] = None) -> dict:
+    """Call the DataSinking API, carrying the API key automatically.
+    出错时**把服务端 body 原文带出去**。它写的不是「失败了」，而是「该怎么办」：
+      ``detail``     一句人话（「未找到章节「X」」）
+      ``available``  那份报告的**全部真实标题**
+    ``get_section`` 的工具描述明确让模型「retry with one of those」，所以这个列表
+    必须跟着异常走。原来这里是一句 ``r.raise_for_status()``，body 整个丢掉 ——
+    模型只看到裸的 ``404 Client Error: Not Found for url: ...``，既不知道错在哪，
+    也没有可重试的标题（2026-09-22 用真 key 实测，三份实现里这份丢得最干净）。
+    """
+    if not API_KEY:
+        raise ToolError(
+            "Missing DATASINK_API_KEY environment variable (get a free key at https://datasink.ing)"
+        )
+    p = dict(params or {})
+    p["apikey"] = API_KEY
+    r = requests.get(f"{BASE_URL}{path}", params=p, timeout=90)
+    if not r.ok:
+        try:
+            body = r.json()
+        except ValueError:
+            body = None
+        if not isinstance(body, dict):
+            body = {}
+        msg = f"HTTP {r.status_code}: {body.get('detail') or r.text[:2000]}"
+        available = body.get("available")
+        if isinstance(available, list):
+            msg += "\nAvailable sections: " + json.dumps(available, ensure_ascii=False)
+        # ToolError 而非 RuntimeError —— 否则 mcp v2 把 msg 剥成通用句，见文件顶部注释
+        raise ToolError(msg)
+    return r.json()
+@mcp.tool()
+def list_exchanges() -> list:
+    """List the exchanges DataSinking covers.
+    Returns exchange codes (nyse / nasdaq / cboe / sse / szse / bj / jpx / ksc / koe / knx / twse / tpex / lse) with
+    the number of reports available per exchange. Call this first to discover coverage.
+    Sources: US = SEC EDGAR, A-shares = cninfo.com.cn, Japan = EDINET, Korea = DART, Taiwan = MOPS, UK = FCA NSM.
+    """
+    return _get("/exchanges").get("exchanges", [])
+@mcp.tool()
+def list_stocks(
+    exchange: Annotated[
+        str, Field(description="Exchange code, e.g. nyse / nasdaq / cboe / sse / szse / bj / jpx / ksc / koe / knx / twse / tpex / lse")
+    ],
+    limit: Annotated[
+        int, Field(description="Return only the first N companies (default 20) to keep the response short.")
+    ] = 20,
+) -> dict:
+    """List the stocks on one exchange, including the report count per company."""
+    data = _get("/stocks", {"exchange": exchange})
+    return {"exchange": exchange, "total": data.get("total", 0), "items": data.get("items", [])[:limit]}
+@mcp.tool()
+def list_reports(
+    symbol: Annotated[
+        str, Field(description="FMP-style symbol, e.g. AAPL / 600519.SS / 7203.T / 005930.KS / 2330.TW")
+    ],
+    doc_type: Annotated[
+        str, Field(description="Report type to filter on. Defaults to annual.")
+    ] = "annual",
+    size: Annotated[int, Field(description="Number of reports to return (default 10).")] = 10,
+) -> dict:
+    """List a company's reports — metadata only (id, title, period), no body text.
+    Each item carries a `source` field naming the official disclosure platform;
+    keep that attribution when you cite it.
+    """
+    return _get("/documents", {"symbol": symbol, "doc_type": doc_type, "size": size})
+@mcp.tool()
+def get_report(
+    document_id: Annotated[int, Field(description="Report id, from list_reports items[].id")],
+) -> dict:
+    """Fetch one report's full text (metadata + Markdown body).
+    The `source` field names the official disclosure platform; keep that attribution
+    when you cite it. Expensive in tokens — prefer get_section when you only need one chapter.
+    Content is annotated with block markers (`<!-- ds:block:N -->`) so you can cite a
+    specific paragraph or table.
+    """
+    return _get(f"/documents/{document_id}")
+@mcp.tool()
+def list_sections(
+    document_id: Annotated[int, Field(description="Report id, from list_reports items[].id")],
+) -> dict:
+    """List every section of a report with its size, before you decide what to pull.
+    Returns `sections` (titles, in order) plus `section_details` — same order, one entry
+    per section with `title`, `has_tables`, `chars` and `estimated_tokens`.
+    Use `estimated_tokens` to avoid pulling a chapter that would blow your context,
+    and `has_tables` to know whether the chapter needs special handling (tables are the
+    part RAG pipelines usually get wrong). Then call get_section with a heading keyword —
+    the headings are in the report's own language.
+    """
+    return _get(f"/documents/{document_id}/sections")
+@mcp.tool()
+def get_section(
+    document_id: Annotated[int, Field(description="Report id, from list_reports items[].id")],
+    section: Annotated[
+        str,
+        Field(
+            description=(
+                "Heading keyword. Matches the report's own headings, and also understands "
+                "cross-market concepts — MD&A / financial statements / notes / audit report / "
+                "risk / governance (or their Chinese/Japanese/Korean equivalents) resolve to the "
+                "right section in any market. Otherwise pass a heading in the report's language "
+                "(A-share: 管理层讨论与分析 / 财务报告; English filings: \"MD&A\" / "
+                "\"financial statements\" / \"notes\"). If nothing matches, the API returns 404 "
+                "with the real headings — retry with one of those, or call list_sections first."
+            )
+        ),
+    ],
+) -> dict:
+    """Fetch only one section of a report by keyword — much cheaper than get_report, best for RAG.
+    Content is annotated with block markers (`<!-- ds:block:N -->`) so you can cite a
+    specific paragraph or table.
+    """
+    return _get(f"/documents/{document_id}", {"section": section})
+def main() -> None:
+    """Entry point for the ``datasinking-mcp`` console script."""
+    mcp.run()
+if __name__ == "__main__":
+    main()

{datasinking-0.2.13 → datasinking-0.2.15}/datasinking.egg-info/PKG-INFO RENAMED Viewed

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: datasinking
-Version: 0.2.13
-Summary: Python client for DataSinking — full-text Asian financial reports (China, Korea, Japan, Taiwan) as Markdown.
+Version: 0.2.15
+Summary: Python client for DataSinking — full-text financial reports (US, UK, China, Japan, Korea, Taiwan) as Markdown. Earn $7 per yearly referral: https://datasink.ing/affiliate
 Author: DataSinking
 License: MIT
 Project-URL: Homepage, https://datasink.ing
 Project-URL: Documentation, https://datasink.ing/docs
 Project-URL: Repository, https://github.com/heubme2020/datasinking
-Keywords: a-share,china,korea,japan,financial reports,markdown,api,mcp,model-context-protocol,rag,llm
+Keywords: a-share,china,korea,japan,us,sec,financial reports,markdown,api,mcp,model-context-protocol,rag,llm
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
@@ -28,20 +28,21 @@ Dynamic: license-file
 [![PyPI version](https://img.shields.io/pypi/v/datasinking.svg)](https://pypi.org/project/datasinking/)
 [![MCP server](https://img.shields.io/badge/MCP-server-blue)](https://github.com/heubme2020/datasinking#mcp-server)
-**Full-text financial reports across Asia, as clean Markdown.**
+**Full-text financial reports across the US and Asia, as clean Markdown.**
 [DataSinking](https://datasink.ing) serves **full-text financial reports** — annual, semi-annual
-and quarterly — from **China, Korea, Japan and Taiwan** as clean **Markdown**, ready for LLM reading
-and RAG. Query by FMP-style symbol (`600519.SS`, `005930.KS`, `7203.T`, `2330.TW`) or filter by
+and quarterly — from **the US, the UK, China, Japan, Korea and Taiwan** as clean **Markdown**, ready for LLM reading
+and RAG. Query by FMP-style symbol (`AAPL`, `600519.SS`, `7203.T`, `005930.KS`, `2330.TW`) or filter by
 exchange, report period, or **section** — pull just the MD&A / risk section instead of the whole
-report. Reports are sourced from official disclosure platforms and parsed into structured Markdown
+filing, saving tokens. Every figure is traceable to its source disclosure and
+block. Reports are sourced from official disclosure platforms and parsed into structured Markdown
 with YAML frontmatter, preserved headings, paragraphs and tables.
 ---
 ## MCP server
-Ship DataSinking to any AI agent (Claude / Cursor / Codex / Devin Desktop) as an
+Ship DataSinking to any AI agent (Claude / Cursor / Codex / Devin Desktop / n8n) as an
 [MCP](https://modelcontextprotocol.io) server — 6 tools: list exchanges, list stocks,
 list reports, fetch a report, list sections, fetch one section (token-friendly for RAG).
@@ -144,6 +145,9 @@ errors that client actually produces:
 | Cursor | [`docs/mcp/cursor.md`](docs/mcp/cursor.md) |
 | DeepSeek Harness (`dsh`) | [`docs/mcp/deepseek.md`](docs/mcp/deepseek.md) |
 | Devin Desktop | [`docs/mcp/windsurf.md`](docs/mcp/windsurf.md) |
+| OpenCode | [`docs/mcp/opencode.md`](docs/mcp/opencode.md) |
+| Qoder | [`docs/mcp/qoder.md`](docs/mcp/qoder.md) |
+| Reasonix | [`docs/mcp/reasonix.md`](docs/mcp/reasonix.md) |
 ## Quick start
@@ -184,6 +188,7 @@ coverage, list a company's reports, and extract a figure with correct units.
 | `01_quickstart.py` | The 5 core functions: list exchanges / stocks / reports / fetch a report / fetch a stock's reports |
 | `02_download_company.py` | Download a company's full reports to local Markdown files |
 | `03_download_exchange.py` | Download an entire exchange's reports (all stocks) to local Markdown files |
+| `rag_ingest.py` | Slice reports into RAG chunks (on the `<!-- ds:block:N -->` anchors, with `source` traceability) and ingest into a vector store |
 Every example pulls from the live API and runs as-is.
@@ -203,12 +208,12 @@ Start from [`research/TEMPLATE.md`](research/TEMPLATE.md).
 | | |
 |---|---|
-| Coverage | China (SSE / SZSE / BSE) · Korea (KOSPI / KOSDAQ / KONEX) · Japan (TSE) · Taiwan (TWSE / TPEx) |
+| Coverage | US (NYSE / NASDAQ / CBOE) · China (SSE / SZSE / BSE) · Japan (TSE) · Korea (KOSPI / KOSDAQ / KONEX) · Taiwan (TWSE / TPEx) |
 | Document types | annual / semiannual / q1 / q3 / amendment |
-| Update frequency | Daily — Korea/Japan via official DART/EDINET APIs (new filings within ~24h of publication) |
+| Update frequency | Daily — US/Korea/Japan via official SEC EDGAR / DART / EDINET APIs (new filings within ~24h of publication) |
 | Format | Full-text Markdown (with YAML frontmatter) |
 | API | REST — `GET /documents`, batch download, `with_content=1` for full text, `?section=` + `/sections` for chapter-level access |
-| Symbols | FMP style: `600519.SS` / `005930.KS` / `7203.T` |
+| Symbols | FMP style: `AAPL` / `600519.SS` / `7203.T` / `005930.KS` |
 | Auth | `?apikey=` query parameter (FMP style) |
 ## Data source
@@ -217,6 +222,7 @@ Reports are sourced from the official regulatory disclosure platform of each mar
 | Market | Source | Platform |
 |---|---|---|
+| US (bare ticker, e.g. `AAPL`) | SEC EDGAR | US Securities and Exchange Commission — sec.gov/edgar |
 | China A-shares (`.SS` `.SZ` `.BJ`) | 巨潮资讯网 cninfo | CSRC-designated disclosure platform |
 | Korea (`.KS` `.KQ` `.KN`) | DART | Financial Supervisory Service — opendart.fss.or.kr |
 | Japan (`.T`) | EDINET | Financial Services Agency — disclosure2.edinet-fsa.go.jp |
@@ -224,6 +230,10 @@ Reports are sourced from the official regulatory disclosure platform of each mar
 Every document also carries a `source` field in the API response, so the attribution travels with the data. **Please keep it when you redistribute.**
+## Affiliate
+Earn **$7** for every customer who buys the yearly plan — one-time, PayPal, $31 minimum withdrawal: [datasink.ing/affiliate](https://datasink.ing/affiliate)
 ## License
 [MIT](LICENSE)

{datasinking-0.2.13 → datasinking-0.2.15}/pyproject.toml RENAMED Viewed

@@ -1,39 +1,39 @@
-[build-system]
-requires = ["setuptools>=61.0"]
-build-backend = "setuptools.build_meta"
-[project]
-name = "datasinking"
-# 版本号唯一来源 = datasinking/_version.py（client.py 的 User-Agent 也读它）。
-# 以前这里和包内 __version__ 各写各的，结果漂了半年（发 0.2.4 时才发现 __init__ 还停在 0.1.0）。
-dynamic = ["version"]
-description = "Python client for DataSinking — full-text Asian financial reports (China, Korea, Japan, Taiwan) as Markdown."
-readme = "README.md"
-requires-python = ">=3.8"
-license = { text = "MIT" }
-authors = [{ name = "DataSinking" }]
-keywords = ["a-share", "china", "korea", "japan", "financial reports", "markdown", "api", "mcp", "model-context-protocol", "rag", "llm"]
-classifiers = [
-    "Programming Language :: Python :: 3",
-    "License :: OSI Approved :: MIT License",
-    "Operating System :: OS Independent",
-    "Topic :: Office/Business :: Financial",
-]
-dependencies = []
-[project.optional-dependencies]
-mcp = ["mcp>=1.0.0", "requests>=2.28", "pydantic>=2.0"]
-[project.scripts]
-datasinking-mcp = "datasinking.mcp_server:main"
-[project.urls]
-Homepage = "https://datasink.ing"
-Documentation = "https://datasink.ing/docs"
-Repository = "https://github.com/heubme2020/datasinking"
-[tool.setuptools]
-packages = ["datasinking"]
-[tool.setuptools.dynamic]
-version = { attr = "datasinking._version.__version__" }
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+[project]
+name = "datasinking"
+# 版本号唯一来源 = datasinking/_version.py（client.py 的 User-Agent 也读它）。
+# 以前这里和包内 __version__ 各写各的，结果漂了半年（发 0.2.4 时才发现 __init__ 还停在 0.1.0）。
+dynamic = ["version"]
+description = "Python client for DataSinking — full-text financial reports (US, UK, China, Japan, Korea, Taiwan) as Markdown. Earn $7 per yearly referral: https://datasink.ing/affiliate"
+readme = "README.md"
+requires-python = ">=3.8"
+license = { text = "MIT" }
+authors = [{ name = "DataSinking" }]
+keywords = ["a-share", "china", "korea", "japan", "us", "sec", "financial reports", "markdown", "api", "mcp", "model-context-protocol", "rag", "llm"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Topic :: Office/Business :: Financial",
+]
+dependencies = []
+[project.optional-dependencies]
+mcp = ["mcp>=1.0.0", "requests>=2.28", "pydantic>=2.0"]
+[project.scripts]
+datasinking-mcp = "datasinking.mcp_server:main"
+[project.urls]
+Homepage = "https://datasink.ing"
+Documentation = "https://datasink.ing/docs"
+Repository = "https://github.com/heubme2020/datasinking"
+[tool.setuptools]
+packages = ["datasinking"]
+[tool.setuptools.dynamic]
+version = { attr = "datasinking._version.__version__" }