Skip to content

docs: 新增 TaiwanStockMarginMaintenance(個股融資維持率)中英雙語文件 - #174

Open
linsamtw wants to merge 2 commits into
masterfrom
feature/taiwan-stock-margin-maintenance
Open

docs: 新增 TaiwanStockMarginMaintenance(個股融資維持率)中英雙語文件#174
linsamtw wants to merge 2 commits into
masterfrom
feature/taiwan-stock-margin-maintenance

Conversation

@linsamtw

@linsamtw linsamtw commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

摘要

新增 sponsor 等級資料集 個股融資維持率 TaiwanStockMarginMaintenance 的中英雙語文件。

  • 資料區間:2001-01-05 ~ now(上櫃自 2007-01-04 起)
  • 付費等級:sponsor only(backer 不可用),heading 標註沿用
    TaiwanStockLoanCollateralBalance / TaiwanStockIndustryChainMoneyFlow
    「(只限 sponsor 會員使用)」寫法
  • 欄位:datestock_idmargin_balancemargin_costmargin_ratiomargin_maintenance

修改檔案

檔案 內容
docs/tutor/TaiwanMarket/Chip.md 總數 25 → 26;清單新增連結;檔尾新增資料集章節 + ??? note 四點說明 + 範例
docs/tutor/TaiwanMarket/Chip.en.md 總數 25 → 26;同上英文版
docs/tutor/TaiwanMarket/DataList.md 總數 90 → 91;Chip 清單新增連結
docs/tutor/TaiwanMarket/DataList.en.md 總數 90 → 91;Chip 清單新增連結
docs/WhatIsNew.md / .en.md 2026-08-03 新增一則(只寫資料區間,未寫更新頻率)
docs/llms-full.txt Chip 區塊 23 → 24;新增 dataset 區塊(Tier / Data range / Update / Params / Columns / Notes),純文字
docs/llms.txt Chip 分類清單加入 dataset 名

文件必要註記(以 ??? note 摺疊區塊呈現)

  1. 本資料集為估算指標:公開資訊只揭露個股融資餘額「張數」、未揭露個股層級的「融資金額」,無官方真值可對;各家服務同樣各自估算,數字不會一致。
  2. 融資成數採法定上限:上市六成;上櫃 2014-11-10 起六成、之前五成。警示股/處置股實際成數可能較低。
  3. 上櫃起始日與上市不同:上市 2001-01-05、上櫃 2007-01-04。
  4. 成本線為名目值:已調整股數事件(分割/面額變更/減資/配股)並於除息日扣除現金股利。

錨點驗證

markdown.extensions.toc.slugify 實測,並與 repo 內既有同型標題交叉比對:

  • 中文(標題含 ASCII 資料集名):#taiwanstockmarginmaintenance-sponsor
    (對照 台股產業鏈資金流向 TaiwanStockIndustryChainMoneyFlow (…)
    #taiwanstockindustrychainmoneyflow-sponsor,與現行連結一致)
  • 英文(完整標題 slug):
    #individual-stock-margin-maintenance-taiwanstockmarginmaintenance-only-available-for-sponsor-members
    (對照 Industry Chain Money Flow …#industry-chain-money-flow-…-only-available-for-sponsor-members

Chip / DataList 中英四份清單的連結皆使用上述同一錨點。

備註

  • docs/llms-full.txt 的 Chip 區塊標題原本寫 23 datasets,但區塊內實際有 24 個
    ### 條目(既有落差)。本 PR 僅將其 +1 為 24,未一併修正該落差。

待其他 repo

本 PR 只動文件;資料集本身的實作、API 註冊與 SDK 方法(taiwan_stock_margin_maintenance)由其他 repo 的 MR 提供。

🤖 Generated with Claude Code

新增 sponsor 等級資料集「個股融資維持率 TaiwanStockMarginMaintenance」的
對外文件,涵蓋中文與英文兩個語系,並同步更新資料集清單、更新日誌與
LLM 索引檔。

修改檔案與內容:

docs/tutor/TaiwanMarket/Chip.md
- 第 1 行資料集總數 25 -> 26
- 頁首 bullet list 於 TaiwanStockIndustryChainMoneyFlow 之後新增
  「個股融資維持率 TaiwanStockMarginMaintenance」連結,錨點
  #taiwanstockmarginmaintenance-sponsor
- 檔尾新增資料集章節,heading 標註 sponsor only(比照
  TaiwanStockLoanCollateralBalance / TaiwanStockIndustryChainMoneyFlow
  的「(只限 [sponsor](...) 會員使用)」寫法,非 backer、sponsor)
- 章節內容:資料區間 2001-01-05 ~ now(上櫃自 2007-01-04 起)、
  更新時間、維持率與成本線的計算式、涵蓋範圍、無資料列的情形、
  不帶 data_id 取整日全市場的用法
- 以 ??? note 摺疊區塊補充四點必要說明(估算指標無官方真值、
  融資成數採法定上限、上櫃起始日不同、成本線為調整後名目值),
  置於 bullet list 之後、example 之前
- Package / Python / R 三種呼叫範例與 DataFrame、Schema 輸出範例

docs/tutor/TaiwanMarket/Chip.en.md
- 第 1 行資料集總數 25 -> 26
- 頁首 bullet list 新增對應英文連結,錨點為完整標題 slug
  #individual-stock-margin-maintenance-taiwanstockmarginmaintenance-only-available-for-sponsor-members
- 檔尾新增與中文版對應的英文章節(含相同的 ??? note 四點說明與範例)

docs/tutor/TaiwanMarket/DataList.md
- 第 1 行台灣金融市場資料集總數 90 -> 91
- 籌碼面 Chip 清單新增個股融資維持率連結(錨點與 Chip.md 一致)

docs/tutor/TaiwanMarket/DataList.en.md
- 第 1 行總數 90 -> 91
- Chip 清單新增對應英文連結(錨點與 Chip.en.md 一致)

docs/WhatIsNew.md / docs/WhatIsNew.en.md
- 2026-08-03 區塊新增一則:資料區間 2001-01-05 ~ now(上櫃自
  2007-01-04 起)、欄位概述,並註明本資料集為估算指標

docs/llms-full.txt
- Chip / Institutional 區塊標題資料集數 23 -> 24
- 於 TaiwanStockIndustryChainMoneyFlow 之後、
  TaiwanStockDispositionSecuritiesPeriod 之前新增
  TaiwanStockMarginMaintenance 區塊,含 Tier / Data range / Update /
  Params(含整日全市場查法)/ Columns / Formula / Coverage 與三則
  Note,維持純文字格式不使用 markdown 摺疊語法

docs/llms.txt
- Chip (Institutional) 分類清單加入 TaiwanStockMarginMaintenance
@linsamtw

linsamtw commented Aug 3, 2026

Copy link
Copy Markdown
Contributor Author

⚠️ Merge 前請注意:!!! output 的 DataFrame 範例是「構造值」,不是真實 API 輸出。

寫這段時 FinMind API / MCP 持續回 5xx,本機 .env 的 token 又已於 2026-08-02 輪替失效,無法取得真實資料。目前表格中:

  • 2026-07-28 / 2330 這列的 close 2280 → margin_cost 2346.9 → margin_maintenance 161.92 來自 Spec §3.4 的 prototype 實測值
  • 其餘 4 列(含所有 margin_balance 數值、以及 07-28 那列的 margin_balance)是為了讓 close / (margin_cost × margin_ratio) × 100 內部自洽而構造出來的,沒有對過真實資料

建議處置(擇一):

  1. 等 ddb11 建表 + backfill 完成、API 上線後,用真實輸出重新產生這張表再 merge
  2. 或先 merge 其餘內容,另開一個 follow-up PR 只換這張表

另外附帶說明:docs/llms-full.txt 的 Chip 區塊計數在本 PR 之前就已經對不上(header 寫 23、實際 24 個 ### 項目)。本 PR 只做 +1(23 → 24),維持 repo 既有的「照著加一」慣例,沒有順手修既存偏差。同樣的偏差在 Chip.md / Chip.en.md 也存在(宣稱 26、清單實際 28 條連結)。要不要統一校正這幾個計數,建議另開單處理,不混進本 PR。

原本只在 bullet 裡放一行摘要,沒有交代融資成本線到底怎麼遞推、邊界情況怎麼
處理。本資料集是估算指標、沒有官方真值可對照,數字必然與其他服務不同,
使用者一定會問「為什麼跟看盤軟體不一樣」,計算方式必須完整攤開。

修改檔案
- docs/tutor/TaiwanMarket/Chip.md
  新增「計算方式」??? note 摺疊區塊(放在 bullet list 之後、估算指標警語
  之前),內容:
  * 主公式 margin_maintenance = 當日收盤價 / (margin_cost * margin_ratio) * 100
  * margin_cost 的逐日遞推式(code block):
      舊部位     = max(今日融資餘額 - 今日融資買進, 0)
      margin_cost = (前一日 margin_cost * 舊部位 + 當日收盤價 * 今日融資買進)
                    / (舊部位 + 今日融資買進)
  * 說明單位為「張」、當日買進採公告值而非用餘額差推算,因此股數事件造成的
    餘額跳變不會被誤計為買進
  * 三個邊界情況:舊部位為 0 時成本線即當日收盤價;餘額歸零時重置並從當日
    收盤價重新起算;當日無成交時沿用前值且不輸出當日資料
  * 股數事件與除權息的調整順序(先調前一日成本線、再套當日買進)
  原本 bullet 裡重複的兩行公式摘要已移除,避免同一件事寫兩次且深度不一致。
- docs/tutor/TaiwanMarket/Chip.en.md
  同上,英文版對應改寫。
- docs/llms-full.txt
  原本單行的 Formula 拆成四行:主公式、margin_cost 遞推式、邊界情況、
  事件調整,讓 AI agent 讀得到完整規則。

驗證
- 以 mkdocs.yml 實際啟用的 extension 集合(admonition + pymdownx.details +
  pymdownx.superfences 等)渲染中英兩份,確認 ??? note 摺疊區塊為 2 個、
  縮排的 code fence 正確渲染成 2 個 code 區塊、summary 標題正確。

未揭露內部細節:沒有寫排程頻率或時間窗(更新時間仍只有名義時鐘)、沒有列
來源機關或法規條號、沒有內部路徑與常數。
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant