wmshare

English TL;DR — wmshare is a BSD-3-Clause Python SDK for China A-share / Hong Kong / US market data: k-line, intraday, money flow, statements, screener, whole-market batch, and 2,752 server-precomputed metrics (percentile ranks, multi-window averages, industry-relative ranks — no DIY computation). Ships an offline catalog, data guards and AI skill. Credentials required on open.winmale.com; try offline first with wmshare.demo_client() (frozen snapshot; not live). Install: pip install wmshare.

给 Python 量化开发者的中文财经数据 SDK：一行接口拿到清洗好的 A股/港股/美股数据—— 估值分位、TTM 股息率等指标服务端算好直出，全市场批量 12 次请求绕开限流。 凭证在开放平台（open.winmale.com）获取后即可取数；各市场逐能力明细见「市场覆盖」。

目录

基本功能 · 特色功能 · 快速上手 · 给 AI / Agent · 市场覆盖 · 我想做 X → 用哪一行 · 批量取数 · 单位与数据守护 · 许可与数据服务 · 更多

快速上手

安装

pip install wmshare                  # 基础安装
pip install "wmshare[dataframe]"     # 可选：pandas 支持（_df=True）
pip install "wmshare[mcp]"           # 可选：本地 MCP server
python3 -c "import wmshare; print(wmshare.__version__)"   # 验证安装

国内直连不稳时换清华源：pip install -i https://pypi.tuna.tsinghua.edu.cn/simple wmshare（镜像滞后时回官方源）；升级 pip install -U wmshare（Windows 用 py -m pip install -U wmshare）；开发者安装见 CONTRIBUTING.md。

配置凭证

凭证在 开放平台「我的 → 开放平台 → 我的应用」页获取 AppId（Client ID） 与 API Key（Client Secret） 两个值（缺一不可），配置方式任选其一：

export WMSHARE_CLIENT_ID=<AppId> WMSHARE_CLIENT_SECRET=<API Key>   # 方式一：环境变量
# 方式二：~/.wmshare/credentials.env（KEY=VALUE 每行一条）
# 方式三：构造参数 cli = wmshare.Client(client_id="...", client_secret="...")

选股实战：10 行筛出「高股息 + PE 十年低位」

逐票请求全市场会撞限流（5,691 家 = 5,691 次请求），所以先用一次批量拿到股息率（12 次请求），只对候选逐票查 PE 与十年分位：

import wmshare
cli = wmshare.Client.from_env()
pool = cli.stocks.list()                                     # 全市场 5,691 家
meta = {r["symbol"]: r for r in pool}
yld = cli.batch_all("bonus.snapshot_yield_ttm", list(meta))   # 12 次请求，不是 5,691 次
top = sorted(((s, v) for s, v in yld.results.items() if isinstance(v, (int, float))),
             key=lambda kv: -kv[1])
cand = [(s, v) for s, v in top if 0.03 <= v <= 0.10 and not meta[s].get("is_st")][:60]
rows = []
for s, v in cand:
    m = cli.indicator.metrics(s, ["$PE_TTM_LAST", "$PCT_PE_TTM_10Y_LAST"])
    pe, pct = m["$PE_TTM_LAST"], m["$PCT_PE_TTM_10Y_LAST"]
    if pe and 0 < pe < 40 and pct is not None and pct <= 0.5:
        rows.append((s, meta[s]["name"], v, pe, pct))
rows.sort(key=lambda r: r[4])
for s, n, v, pe, pct in rows[:8]:                            # 取前 8 行打印
    print(f"{s}  {n}  股息率 {v:.2%}  PE {pe:.1f}  十年分位 {pct:.1%}")

没配凭证也能先看调用面：cli = wmshare.demo_client()（同签名、不联网）。这是 2026-10-30 真实 API 固定快照：10 只演示宇宙 + 当日全市场 screener，非实时数据； 换成 Client.from_env() 即接真实数据。

基本功能

随包离线目录：18 个数据域 · 269 个底层函数 · 2752 个指标代码；友好层 131 个核心接口， 按使用视角组织为（11 个指标组、74 个精选常用指标代码，cat.search("中文") 可编程检索）：

特色功能

服务端预计算，先查目录再写代码——目录里有的码不要自己算（eval 按标的数逐票计费 EC）：

• 预置指标库（2,752 个指标码，11 组精选 74 码带量级守护）：历史分位（$PCT_PE_TTM_10Y_LAST = PE 十年分位）、多窗口均值/最低/趋势（$BONUS_RATE_3Y_AVG_LAST = 近3年股息率TTM均值）、 行业内分位（$CUR_IND_ROE_PCT_LAST，1=行业最高）、行业均值（$ID_ROE_TTM）、指数加权股息率 （$IDW_BONUS_RATE_HM）、期货主力连续（$FUT_CLOSE）、宏观时序（$CPI）。命名语法 $主题+[窗口 3Y/5Y/10Y]+[统计量 TTM/YOY/AVG/MIN/TREND]+[_LAST]；全量码表按数据类型分章 （概览/股票行情/股票指标/行业/指数及ETF/宏观/期货/可转债/港美）见 docs/INDICATORS.md。
• 全市场批量：cli.batch_all(name, codes) 把 A 股 5,691 家压成 12 次请求绕开限流。
• 全市场筛选服务端直出：cli.screener 涨跌全景/分桶/行业分布/涨跌榜走服务端预计算索引，毫秒级。
• 离线目录防编造：269 个底层函数、131 个核心接口、2,752 个指标码离线可查 （cat.search("中文")），目录之外的名字显式报错。
• 零凭证离线试跑：wmshare.demo_client()（同签名、不联网，2026-10-30 固定快照；非实时数据）。
• 数据守护：全库单位统一（比率=小数、金额=元、量=股），返回前量级/不变量校验，违例抛 DataError。

给 AI / Agent

• 先查目录再写代码（一行验证）： python3 -c "import wmshare; print(wmshare.load().search('股息'))"
• 本地 MCP server：20 个 task tools；全部 134 个 friendly API——131 登记 + 3 组合——均可用 wmshare_call(target=..., mode="api") 兜底，macro 域仅此路径。配置：pip install "wmshare[mcp]" → wmshare-mcp setup --client-id <AppId> --client-secret-stdin --market cn（提示后粘贴 API Key， wmshare-mcp doctor 体检）；客户端最小配置 {"mcpServers":{"wmshare":{"command":"wmshare-mcp","args":[]}}}；接入路径详见 AI 用法。
• skill 随包分发：wmshare.skill_dir() 可复制进 .agents/.zcode/.claude 的 skills/。
• 死码警示：$*_LIVE 等 20 个上游死码混入 cli.indicator.metrics() 会整批失败， 清单见 INDICATORS.md · 死码警示。
• AI 友好索引：llms.txt（索引）/ llms-full.txt（全文拼接，大上下文直读）。

市场覆盖

市场切换：Client(market="cn" / "hk" / "us")，缺省 cn；代码与市场不匹配会被服务端直接拒绝（如 cn 市场查 00700 报 market mismatch）。美股用裸代码（AAPL/BRK_B），AAPL.O/BRK.B 由 SDK 按代码表自动归一；cli.intl 港美股披露也要用对应市场客户端调用。

如实注记（2026-11-09 实测）：港/美列 ✅ 均经 live 探针逐族验证；美股代码用裸代码（AAPL / BRK_B）—— 带后缀 AAPL.O/BRK.N 会被上游当宏观序列，SDK 已按随包代码表归一（裸代码实测正常）；美股日 K 已日更， 周/月 K 由日线派生（freq="W"/"M"，2026-11 起追平），后复权无外部因子源不随日更，分时仅美股盘中（北京夜间）有值。 深研宽表暂仅 cn；hk 十大流通股东与回购数据管线已有、SDK 接口待路由。

我想做 X → 用哪一行

常用示例（输出为预期量级）：

import wmshare

cli = wmshare.Client.from_env()

# TTM 股息率：小数口径，0.0396 = 3.96%
print(cli.dividend.yield_ttm("600519"))                      # 0.0396

# 估值温度计：PE(TTM) 处于近 10 年 42% 分位（小数）
print(cli.indicator.get("600519", "$PCT_PE_TTM_10Y_LAST"))   # 0.42

# 行业定位：ROE 在同行业内的分位（1.0 = 行业最高；茅台 ROE 为行业之最）
print(cli.indicator.get("600519", "$CUR_IND_ROE_PCT_LAST"))  # 1.0

# 全市场涨跌全景：服务端索引直出，免本地扫描（*_pct 百分数、median_pct 小数）
print(cli.screener.index_breadth_summary())
# {'total': 5685, 'up': 4567, 'down': 934, 'flat': 184, 'up_pct': 80.3, ...}

# 全市场列表 / 行业成分（中文名直达，也可传 "S48"）/ 批量：单标的接口传 list 即批量（≤500/批）
rows = cli.stocks.list()                 # A 股 ≈5.7k 行：代码/名称/交易所/行业/上市日；港/美换 market
df = cli.call_batch("kline.snapshot", ["600519", "000001"]).to_df()   # 带 symbol 列的长表；to_df 需 pandas

以上能力全部在离线目录可查（cat = wmshare.load() 后）：cat.search("分位")、cat.metrics_in_group("dividend")； 全量指标码导航见 INDICATORS.md。

批量取数

服务端按请求次数限流（免费档 500 次/小时、5,000 次/日）：逐票取 A 股 5,691 家 = 5,691 次请求 必然撞 429，批量只需 12 次。三入口——一站式、逐批、单批：

import wmshare
cli = wmshare.Client.from_env()
codes = [r["symbol"] for r in cli.stocks.list()]      # 全市场代码池（港/美换 market）
res = cli.batch_all("kline.snapshot", codes)           # ① 一站式：自动分批聚合
print(len(res.results), res.requests)                  # 5,691 12
for i, part in enumerate(cli.batch_iter("dividend.history", codes), 1):
    print(f"第 {i} 批 {len(part.results)} 家")          # ② 逐批：可进度、可中断、可落盘
cli.call_batch("kline.snapshot", ["600519", "000001"]) # ③ 单批（≤500），to_df() 出长表

要点：name 必须是目录函数名（指标码不能批量，一票多码用 cli.indicator.metrics(sym, codes)）； 容错用批级 batch_all(on_batch_error="skip")，勿用 call_batch(on_error="skip")（逐票放大、 正好制造 429）；一个批次只能同一市场；批量省请求次数不省 EC——全市场最新快照优先服务端直出 cli.moneyflow.board()。参数/续跑/分批策略明细见 GUIDE · 批量取数。

单位与数据守护

全库统一基础单位：比率 / 涨跌幅 = 小数（0.01 = 1%，ROE 0.332 = 33.2%）、 金额 / 价格 / 市值 = 元（报表原币）、成交量 = 股；各接口单位口径见「基本功能」表。 返回前做量级与关系不变量校验，违例抛 DataError——错误的量级到不了你的代码。 需要脚本原始口径时：_raw=True（上游原始行）、_units="native"（保留上游原单位，如手/百分数）、Client(validate=False)（关校验留换算）。

数据深度：个股/ETF 日 K 覆盖自上市首日以来的全部交易日（最早 1991 年）；单次区间上限 5 年、 默认单次 500 根（Client(max_limit=...) 可调）；深回溯老数据可能触发守护，整段历史时 validate=False。

许可与数据服务

• 代码采用 BSD-3-Clause：可自由使用、修改、再分发（含商业用途），保留版权声明即可。
• 云端数据服务需 开放平台 账号：免费档 500 次/小时、5,000 次/日，更高额度以平台为准。
• 数据仅供研究参考，不构成任何投资建议。

更多

• AI 原生：随包 SKILL.md、AI 用法、本地 MCP server（skill 可复制进 .agents/.zcode/.claude 的 skills/）
• 生态工具 big-winner：基于本 SDK 的开源工具。
• 文档中心 docs/：使用指南 GUIDE（单票菜谱/批量/多市场/故障排查）· 指标库 INDICATORS.md（全量指标码按数据类型分章）· AI 用法 · llms.txt 索引 · API 参考（按资产类别分章的 131 个核心接口 + 指标组）
• 可转债日更管线：cli.cbond.daily() → article() → figures() 一条命令出图文（三层口径 + 三道闸 + 状态机 + 事件日历，每个数字带 sources 与 as_of，缺条目抛错而非补猜测值）；实战 notebook 见 docs/notebooks/cb_double_low.ipynb（2026-11-07 真实数据）
• 示例课程 examples/：14 个编号示例（入门→进阶→生产→AI），全部支持演示客户端离线试跑，CI 端到端覆盖
• 贡献指南：提交门禁、内容规范、许可政策