Skip to main content

Python SDK for Gangtise OpenAPI

Project description

gangtise-openapi

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

更新日志

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

0.1.5 - 2026-06-12

  • 健壮性:并发遇到失效令牌只触发一次登录;失效的 GANGTISE_TOKEN 环境变量不再反复拖慢每次调用;异步分页/分片失败抛回 ApiError(不再是 ExceptionGroup);K 线分片部分失败不再丢弃已取数据(结果带 partial/failedShards 标记);缓存写盘失败不再影响请求本身。
  • 下载:令牌失效自动刷新重试、瞬时错误退避重试、支持预签名 URL 响应、4xx 保留业务错误码与中文提示、异步下载不再阻塞事件循环。
  • gangtise.configure(...) 现对 gangtise.async_ 同样生效;facade 域属性支持 IDE 补全与类型检查。
  • 性能:列式 K 线直接构建 DataFrame(提速 2-3 倍);全市场日 K 回填跳过纯周末分片(少发约 29% 请求)。
  • 对齐 TS CLI:earning_forecast 缺省自动取最近一年;时间参数换算与 toTimestamp13 一致;补齐 5 个错误码提示。
  • 全部公开方法新增中文 docstring(含枚举取值);测试从 222 个增至 402 个。

0.1.4 - 2026-05-30

  • 新增 alternative.concept_info / alternative.concept_securities:题材(概念)指数画像与成分股;concept_idai.theme_tracking 共用题材 ID 体系,可经 gangtise.lookup.theme_ids() 按名称查询。
  • quote.index_day_kline 透传上游新增的 securityName 列(如「上证指数」)。
  • title 缓存优化:单端点标题数封顶、无新增内容时不再重写——此前会无限增长至约 58 MB,现单次写入约 1.7 MB。

0.1.3 - 2026-05-29

  • 修复 quote.realtime / quote.minute_kline / quote.day_klinereference.securities_search 列名错配导致整列为 None:改为按响应 fieldList 动态取列,不再硬编码列名。

0.1.2 - 2026-05-29

  • 列式响应({fieldList, list:[[...]]})的 DataFrame 转换(新增 normalize_rows),修复财务报表 / 估值 / 主营构成等接口的空表问题。
  • GANGTISE_VERBOSE 调试日志真正生效;异步客户端不再因磁盘 I/O 阻塞事件循环。
  • fundamental.earning_forecast 改为返回 DataFrame;各 domain 的公共 helper 合并去重。

0.1.1 - 2026-05-28

  • 为所有公开方法补齐可独立运行的示例脚本(sample/sync/sample/async/)与完整参数文档 sample/API_PARAMETERS.md,并统一示例输出与下载文件命名。

安装

pip install gangtise-openapi

需要 Python 3.10+。

配置

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 覆盖 9 个领域下的 75 个上游接口:

  • gangtise.auth.* — 登录、状态
  • gangtise.lookup.* — 本地查表(研究领域、券商、行业等)
  • gangtise.reference.* — 证券搜索(GTS 代码)
  • gangtise.insight.* — 观点、研报、公告、日程
  • gangtise.quote.* — K 线、实时行情
  • gangtise.fundamental.* — 财务报表、估值、股东、盈利预测
  • gangtise.ai.* — AI 生成的洞察(一页通、同业对比、业绩点评等)
  • gangtise.vault.* — 个人云盘、会议记录、股票池、微信
  • gangtise.alternative.* — 经济指标(EDB)、题材(概念)指数画像与成分股

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.5.tar.gz (59.3 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.5-py3-none-any.whl (72.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for gangtise_openapi-0.1.5.tar.gz
Algorithm Hash digest
SHA256 ec1d8dca2bc8194dac02daf962b22e41e0135ff100f7b26b26b765d0fd5deb42
MD5 62b538f5ec95cf5e55e56c2781273d87
BLAKE2b-256 dd8dbabaec020928802821c9a1b0f7b6e54d947a793c887799fab41867a2d01d

See more details on using hashes here.

Provenance

The following attestation bundles were made for gangtise_openapi-0.1.5.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.5-py3-none-any.whl.

File metadata

File hashes

Hashes for gangtise_openapi-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 d670b4760d5c5657adb00633c0dd19fa3ac52f854b19ad4efdecd9436c55245b
MD5 d56f80fc2f05826216de6a3df3553b95
BLAKE2b-256 3e520a283409e5fdd1562d8246d50afb1ca94d09cb6f0378bff6b6ddec8e2883

See more details on using hashes here.

Provenance

The following attestation bundles were made for gangtise_openapi-0.1.5-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