Skip to main content

Python SDK for Gangtise OpenAPI

Project description

gangtise-openapi

Gangtise OpenAPI 的 Python SDK。与 npm CLI gangtise-openapi-cli v0.27.0 功能对齐,覆盖 90 个上游接口,并提供本地鉴权状态辅助工具。

更新日志

最近 5 个版本(完整记录见 CHANGELOG.md):

0.1.18 - 2026-07-12

  • 自动命名下载在不支持硬链接的文件系统上不再丢文件:v0.1.17 的 os.link 仅对硬编码 errno 白名单回退 O_EXCL 占位,漏了 macOS exFAT/SMB 的 ENOTSUP(与白名单里的 EOPNOTSUPP 是不同值)和 Windows FAT 的 EINVAL——完成的 .part 被删、下载报成写失败(no-replay 计费端点手动重试还再扣费)。现任何 os.link 失败都回退占位(ENOSPC/EROFS 等真故障会在占位的 os.open 处照常抛出)。
  • 302 跳转目标回 200+JSON 不再被当文件写盘:跳转目标返回 application/json 业务错误 envelope 时,此前把 JSON 字节存成 report.pdf 并报成功(计费 + 损坏文件);现跟随后的拉取与直连下载路径同样做 envelope 校验——失败 envelope 抛 ApiError{url} 元数据续接,对齐 TS client.ts
  • 跳转那一跳的 CDN 瞬态 429/5xx 改为重试:跟随 URL 此前只重试网络错误,一次性 503/429(签名仍有效)会立即失败;现可重试状态按默认策略重试(尊重 Retry-After),403/404 仍快速失败(签名过期重放无意义),计费上游永不重发。
  • 同源 302 保留 bearer:手工跳转此前对任何 Location 都不带 Authorization,同源跳到另一鉴权路径的 302 会 401/403;现仅当 Location 停在 API 同源(scheme+host+port 精确匹配)时转发 bearer,跨源 CDN 永不可见。恢复 v0.1.16 / TS 一致。
  • _require_fetchable_url 真正 fail-closed:此前用 stdlib urlsplit 校验(比 httpx 宽松),含控制符、畸形点分 IPv4 或 IDNA 主机、超长、前导空格的 URL 能过闸,随后 httpx.URLhttpx.InvalidURL(非 httpx.HTTPError)逃出 except 阶梯;现用 httpx.URL 本体 + 精确 strip 校验,畸形 URL 抛脱敏后的 DownloadError
  • .part 清理失败不再把成功下载报成失败(独立 Codex 审查发现):os.link 提交完整文件后,finally.part unlink 是承重步骤,一旦失败(杀软锁、只读挂载)裸 OSError 会绕过 except OSError 报假失败(并诱发 no-replay 重扣);现清理改为尽力而为。
  • 任何从跟随目标冒出的错误都不再重放计费上游,{url} 链加跳数上限(对上述修复的第二、三轮复核):把跟随目标的 JSON envelope 抛成 ApiError 后,从已成功的上游之后冒出的错误仍可能驱动 download_to_path 外层循环重发上游。现此类错误打标记、短路每一条外层重放:鉴权 envelope(0000001008/8000014/8000015)的刷 token 路径,以及可重试 999999 的默认策略重试路径(正是让默认重试端点 insight.report-image.download(0.1 积分/张)被重扣三次的那条)。直连(非跟随)路径的鉴权自愈与 999999 重试不变。自引用/环形 {url} 链现以有上限的 DownloadError(最多 5 跳)失败,不再递归到 RecursionError + 请求风暴;同源 bearer 转发每跳重新判断(第二个同源跳不再丢 bearer);_redact_url 改为复用 httpx.URL 的判定,非 ASCII/畸形 authority(坏 IDNA、非法点分 IPv4 如 1.2.3.999)折叠为 redacted-url 而非回显。
  • 跟随目标错误改用计费安全提示、占位回退扛住 close 故障、同源精确区分显式 :0(第四轮复核):(1) 打标记的跟随目标错误仍带通用 .hint——999999 的「请稍后重试」、鉴权码的「会自动重新登录重试」——都会诱导用户手动重发、重扣已执行的上游(且此处并不会真的自动重登),现改为专用提示,明确「计费上游已执行、勿盲目重试」。(2) 无硬链接占位提交里,对 O_EXCL 占位 fd 的 os.close() 未加保护:close 期 OSError(如本版重点覆盖的 SMB/exFAT 上的 EIO)会在改名前中断,完整 .part 被外层 finally 删除、只剩 0 字节文件;现 close 改为尽力而为(fd 仅用于占名,承重的改名照常落盘)。(3) _same_originport or default 把显式 :0 折成默认端口,令 https://api.test:0https://api.test 判为同源;现改用 port if not None else default,scheme+host+port 真正精确匹配。无端点/API 表面变更,仍对齐 CLI v0.27.0、90 接口。

0.1.17 - 2026-07-12

  • 计费安全(重要):下载端点 302 跳转 CDN 后 CDN 失败,不再重放计费上游端点——此前上游让 httpx 内联跟随跳转,CDN 那一跳失败会被误判为上游的连接期错误,对 no-replay(按篇计费)端点触发重发;现上游停在 3xx、把 Location 交给签名 URL 拉取器(其重试循环只重放不计费的 CDN URL)。跟随后的 URL 也补上了此前绕过的 10× 传输硬截止。
  • 签名 URL 脱敏改为 fail-closed_redact_url 此前只留 scheme://host/path,但裸 alice:SECRET@host/p 会被解析成 scheme=alice,旧的 netloc 路径会泄露 alice://SECRET@…;非法端口还会以未包装的 httpx.InvalidURL 带出原值。现非绝对 http(s)+有 host+合法端口一律折叠为 redacted-url,签名 URL 拉取前先校验,畸形 URL 抛脱敏后的 DownloadError
  • 自动命名下载恢复原子可见 + 后缀正确:v0.1.16 的 O_CREAT|O_EXCL 占名会先创建 0 字节最终文件再 rename(崩溃可能留下看似成功的空文件),且 report-1.pdf 碰撞会落成 report-1-1.pdf 而非 report-2.pdf;现改用 os.link 把完成的 .part 硬链接到目标(完整文件一次性出现、后缀从原始名扫描),仅在不支持硬链接的文件系统回退 O_EXCL 占位(仍非 clobber)。
  • EDE 内层 999999 补正确提示:双层 envelope 的内层错误在 transport 之外解包,此前仍是「请稍后重试」;现与外层同用「检查查询条件」的 EDE 提示。
  • 零警告固化pyproject.tomlfilterwarnings 把本项目的 UserWarning 升级为错误,未来分片/漂移告警会让本地与 CI/release 套件失败(此前仅在个别测试临时断言)。无端点/API 表面变更,仍对齐 CLI v0.27.0、90 接口。

0.1.16 - 2026-07-11

  • 安全:签名 URL 不再泄露进异常信息——此前预签名下载失败的 DownloadError 会带完整 URL(含 X-Amz-Signature 查询串与 user:password@ 认证段),终端/CI/错误采集系统都会记录;现只保留 scheme://host[:port]/path(userinfo、query、fragment 全部剥离,IPv6 主机自动补回方括号)。
  • 数据完整性:自动命名下载不再互相覆盖——两个 output=None 的并发下载解析到同名文件时,此前后完成者会静默覆盖前者;现改用 O_CREAT|O_EXCL 原子占名提交,输家自动改用下一个 -1..-99 后缀,最终移动失败时清理占位文件。全文件系统可用(不依赖硬链接);显式 output= 保持文档化的覆盖语义。
  • 签名 URL 拉取遇瞬态网络错误现会重试(默认策略、每次尝试独立 10× 硬截止)——重放签名 URL 恒安全,计费上游端点绝不重发;签名 URL 的 HTTP ≥400 仍立即失败(签名会过期,重放 403 无意义)。
  • MIME→扩展名映射补齐图片类(png/jpeg/gif/webp/svg,与 TS 一致):report_image_download 自动命名现落地为 report-image-<id>.jpg 而非无扩展名。
  • no-replay 端点的 999999 提示不再写「请稍后重试」(SDK 未自动重试、请求可能已执行计费),改为提示先核实结果/扣费再决定是否手动重试。
  • 测试套件在 -W error::UserWarning 下零警告通过(分页 fixture 统一为真实 {total, list} 形状),真实协议漂移告警不再被噪音掩盖。无端点/API 表面变更,仍对齐 CLI v0.27.0、90 接口。

0.1.15 - 2026-07-11

  • 对齐 CLI v0.24.0–v0.27.0。计费安全(重要):16 个按次计费端点(7 个 AI 同步生成、earnings_review/viewpoint_debate 的 get-id、hot_topicknowledge_batchconcept_info/concept_securitiessummary/foreign_report/my_conference 三个下载)改为 no-replay 重试策略——5xx/响应超时/999999 不再自动重放(实测平台按次计费且缓存命中不豁免,同参数重放每次都扣分);仅连接期错误(请求未发出)、429 限流和 token 自愈仍重试。
  • EDE 指标三端点对 999999 不再重试——服务端用 HTTP 500 + 999999 表示「查询无数据」(节假日/未来日期/未覆盖标的),此前每次空查询白烧 3 个请求 + ~4 秒;错误提示改为指向检查查询条件而非「稍后重试」。
  • 7 个 AI 同步生成端点内置 120s 超时下限one_pager/investment_logic/peer_comparison/theme_tracking/research_outline/management_discuss_*×2)——生成耗时长不再撞 30s 默认超时;显式设更大 timeout 仍生效(取 max)。
  • 新增接口 ×4(86→90):insight.qa_list 投资者问答(按证券提取互动平台/电话会议/调研纪要的提问与回答,11 类问题类型过滤,自动翻页单页上限 500,0.1 积分/条);insight.report_image_list / report_image_download 研报图表(按关键词搜研报图片返回 chunkId+元数据,list 免费、下载原图 JPEG 0.1 积分/张);reference.official_account_search 公众号 ID 搜索(返回 accountId 喂 official_account_list;免费)。
  • 429 尊重 Retry-After(秒或 HTTP-date,优先于指数退避,60s 封顶;JSON 与下载路径都生效)。
  • 本地校验(实测服务端对超限值静默截断、对拼错分类静默忽略/返回空):top/limit 上限——reference 六个搜索 ≤10、report_image_list/knowledge_batch ≤20、edb_search ≤200、indicator.search ≤100;category 白名单——securities_search/institution_search/official_account_search;错误码 100003 补中文提示。
  • 可靠性:AI 异步轮询容忍瞬态错误(5xx/网络抖动只消耗一次尝试并继续等待,不再作废整段等待);全市场分片硬错后熔断(剩余分片不再派发、计入 failedShards,省配额)、shape 破损分片计入 failedShards、撞行数上限的分片输出 truncatedShards 具体日期窗口(可定向缩窗补拉);分页端点首页形状漂移发 UserWarning(不再完全静默退化单页);自动命名 100 个重名耗尽时抛 DownloadError(不再静默覆盖第一个文件);签名 URL 下载加整体硬截止(10× 单请求超时,慢滴速传输不再无限续命);GANGTISE_PAGE_CONCURRENCY 防御性解析(非法/非正数回退默认 5、上限 32);EDE 矩阵中与 date/security/name 同名的指标列自动加后缀(不再覆盖元数据列)。

0.1.14 - 2026-07-07

  • 域层过滤参数类型化security/industry/rating 等过滤参数由 Any 收窄为 str | int | Sequence[str | int]FilterValue 别名),单值或列表均可——IDE 补全 + mypy 拦误用;int(如 industry=1fiscal_year=2025)与 str 都保持有效(与接口一致)。无端点/API 表面变更,仍对齐 CLI v0.23.0、86 接口。
  • 矩阵端点 DataFrame 构建 2-5x 提速:列式 {fieldList, list} 响应(财报、EDE 指标等)直接按列矩阵构建,不再转成逐行 dict 再转回;输出逐值 + dtype 完全一致。
  • 分页 from/size 拒绝 boolint 子类)抛 ValidationError,与行情 limit 校验一致。
  • 每个请求带 User-Agent: gangtise-openapi-python/<version>(同步 + 异步),便于服务端区分 Python SDK 与 npm CLI。
  • 包成熟度 classifier 升至 Development Status :: 4 - Beta;新增 pytest-cov 覆盖率、CI 补测 Python 3.11/3.12。

安装

pip3 install gangtise-openapi        # 或 pip

需要 Python 3.10+。

更新到最新版

pip3 install --upgrade gangtise-openapi

(刚发版时若提示找不到新版本,是 PyPI/pip 缓存滞后,加 --no-cache-dir 强制刷新。)

配置

export GANGTISE_ACCESS_KEY=ak_xxx
export GANGTISE_SECRET_KEY=sk_xxx

(也可在创建 GangtiseClient 时直接传入 access_key=secret_key=;直接构造的 client 需配合域封装类调用接口:from gangtise_openapi.domains import Quote; Quote(client).day_kline(...)。)令牌缓存文件位于 ~/.config/gangtise/token.json,与 npm CLI 共用同一份。

快速开始

from gangtise_openapi import gangtise

# 表格类接口返回 pandas DataFrame
df = gangtise.quote.day_kline(
    security="000001.SH",
    start_date="2026-01-01",
    end_date="2026-01-31",
)

# 传 raw=True 获取底层 dict/list
result = gangtise.insight.opinion_list(industry=1, size=20, raw=True)

# 异步
import asyncio

async def main():
    df = await gangtise.async_.quote.day_kline(security="000001.SH")

asyncio.run(main())

示例

每个公开的 SDK 方法都配有可独立运行、便于客户自测的脚本。

uv run python sample/sync/quote_day_kline.py
uv run python sample/async/quote_day_kline.py

返回 DataFrame 的示例会直接打印 DataFrame;文本或 dict/list 响应会以标准 Markdown 文件写入 sample_outputs/;下载类示例会把真实文件写入 sample_downloads/,并尽量保留服务端提供或原始的文件名与扩展名。

运行说明见 sample/README.md,完整的方法参数文档见 sample/API_PARAMETERS.md

接口

SDK 覆盖 10 个领域下的 90 个上游接口:

  • gangtise.auth.* — 登录、状态
  • gangtise.lookup.* — 本地查表(券商机构、会议机构)
  • gangtise.reference.* — 证券搜索(GTS 代码)、机构 ID 搜索、公众号 ID 搜索、常量分类与常量值(行业/城市/公告分类/区域)、题材 ID 搜索、板块 ID 搜索与成分股
  • gangtise.insight.* — 观点、研报、研报图表、公告、日程、投资者问答
  • gangtise.quote.* — K 线、实时行情、A 股资金流向
  • gangtise.fundamental.* — 财务报表、估值、股东、盈利预测
  • gangtise.ai.* — AI 生成的洞察(一页通、同业对比、业绩点评等)
  • gangtise.vault.* — 个人云盘、会议记录、股票池、微信
  • gangtise.alternative.* — 经济指标(EDB)、题材(概念)指数画像与成分股
  • gangtise.indicator.* — 证券级数据指标(EDE):搜索指标码、截面、时序

Python 封装接受与 CLI 参数相同的入参,只是用 snake_case 代替 --kebab-case。例如 CLI 的 --start-date 对应 Python 的 start_date

许可证

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gangtise_openapi-0.1.18.tar.gz (101.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gangtise_openapi-0.1.18-py3-none-any.whl (101.5 kB view details)

Uploaded Python 3

File details

Details for the file gangtise_openapi-0.1.18.tar.gz.

File metadata

  • Download URL: gangtise_openapi-0.1.18.tar.gz
  • Upload date:
  • Size: 101.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for gangtise_openapi-0.1.18.tar.gz
Algorithm Hash digest
SHA256 a2b4c0488d61e6c66dc80b8a961e5169b6262a11f52ac33b38fe213f2c531ef1
MD5 9002a7c9ba702938678516236927ab43
BLAKE2b-256 d9d2a70f8b97c81d0801f58c9a67cf0ffc6f973ead5ec5610017345f8f6e91b7

See more details on using hashes here.

Provenance

The following attestation bundles were made for gangtise_openapi-0.1.18.tar.gz:

Publisher: release.yml on gangtiser/gangtise-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gangtise_openapi-0.1.18-py3-none-any.whl.

File metadata

File hashes

Hashes for gangtise_openapi-0.1.18-py3-none-any.whl
Algorithm Hash digest
SHA256 d29373a8b2a2f351915c90ad336840666e82f83a3f0efd9d08d9c45d443717ad
MD5 9b2b4ef6ed7828466ee281ed441da76f
BLAKE2b-256 cfa0ce5247639114118e2f8d5e21e13b6dbd745d7c77730a5a9c67d7e087b62b

See more details on using hashes here.

Provenance

The following attestation bundles were made for gangtise_openapi-0.1.18-py3-none-any.whl:

Publisher: release.yml on gangtiser/gangtise-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page