Skip to main content

Python SDK for Gangtise OpenAPI

Project description

gangtise-openapi

Python SDK for Gangtise OpenAPI. Feature-parity with the npm CLI gangtise-openapi-cli v0.15.0 across 75 upstream endpoints, plus local auth status helpers.

Changelog

0.1.1 - 2026-05-28

  • Added runnable sample coverage for all public SDK methods: 74 sync examples in sample/sync/ and 74 async examples in sample/async/.
  • Added complete API parameter documentation in sample/API_PARAMETERS.md.
  • Standardized sample output: DataFrame responses print directly, text and structured responses are saved as Markdown under sample_outputs/, and download samples save files under sample_downloads/.
  • Improved download handling so sample downloads keep the API-provided or original document name and extension where available.

0.1.0 - 2026-05-28

  • Initial SDK release with sync and async APIs, DataFrame-by-default responses, retries, token self-healing, pagination helpers, async-content polling, and npm CLI-compatible token cache.

Install

pip install gangtise-openapi

Requires Python 3.10+.

Configure

export GANGTISE_ACCESS_KEY=ak_xxx
export GANGTISE_SECRET_KEY=sk_xxx

(Or pass access_key= and secret_key= explicitly to GangtiseClient.) The token cache file at ~/.config/gangtise/token.json is shared with the npm CLI.

Quickstart

from gangtise_openapi import gangtise

# Tabular endpoints return a pandas DataFrame
df = gangtise.quote.day_kline(
    security="000001.SH",
    start_date="2026-01-01",
    end_date="2026-01-31",
)

# Use raw=True to get the underlying dict/list
result = gangtise.insight.opinion_list(industry=1, size=20, raw=True)

# Async
import asyncio

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

asyncio.run(main())

Samples

Every public SDK method has a standalone customer-testable script.

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

DataFrame-returning samples print the DataFrame directly. Text or dict/list responses are written as standard Markdown files under sample_outputs/. Download samples write real files under sample_downloads/ and preserve the server-provided or original filename when possible.

See sample/README.md for run notes and sample/API_PARAMETERS.md for complete method parameter documentation.

Endpoints

The SDK exposes 75 upstream endpoints across 9 domains:

  • gangtise.auth.* — login, status
  • gangtise.lookup.* — local lookup tables (research areas, brokers, industries, ...)
  • gangtise.reference.* — securities search (GTS codes)
  • gangtise.insight.* — opinions, research reports, announcements, schedules
  • gangtise.quote.* — K-line, real-time quotes
  • gangtise.fundamental.* — financial statements, valuation, holders, forecasts
  • gangtise.ai.* — AI-generated insights (one-pager, peer comparison, earnings reviews, ...)
  • gangtise.vault.* — personal drive, meeting records, stock pools, WeChat
  • gangtise.alternative.* — economic indicators (EDB), concept (theme) index profile + constituents

The Python wrappers accept the same parameters as the CLI flags, using snake_case instead of --kebab-case. For example, CLI --start-date maps to Python start_date.

License

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.4.tar.gz (48.6 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.4-py3-none-any.whl (60.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gangtise_openapi-0.1.4.tar.gz
  • Upload date:
  • Size: 48.6 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.4.tar.gz
Algorithm Hash digest
SHA256 a277b2075fbc9699d23d7497808655971af09d45ca4e4c7d5d7d71ebc79b1403
MD5 38f6690ed44cabc9ac3a6a8ddc2e3321
BLAKE2b-256 1af41b5fb590ef499aa6a945f6db38b2b322138a2e617304e351bc66f3a64ef2

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for gangtise_openapi-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7856ae47483620a98f0882bd0d3145fc79714786deadca8dc6e25901f1092af1
MD5 168f7221e3a62b34ece43309b61f39c3
BLAKE2b-256 7fd377c33620ad2516382ceed12aae0e92c7874d4cf3ae8f1c3f2e7123820fe7

See more details on using hashes here.

Provenance

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