alphakit-sdk 0.1.0__py3-none-any.whl

alphakit/__init__.py

@@ -0,0 +1,6 @@
+"""AlphaKit — 简洁的金融数据 API 工具包。"""
+from alphakit.client import AlphaKit, set_token
+from alphakit.exceptions import AlphaKitError
+
+__version__ = "0.1.0"
+__all__ = ["AlphaKit", "set_token", "AlphaKitError"]

alphakit/client.py

@@ -0,0 +1,111 @@
+"""AlphaKit 客户端 — 简洁的金融数据 API。"""
+import requests
+import pandas as pd
+from typing import Optional
+
+from alphakit.exceptions import AlphaKitError
+
+_global_token: Optional[str] = None
+_default_base_url = "http://101.42.11.124:8002"
+
+
+def set_token(token: str):
+    """设置全局 token。"""
+    global _global_token
+    _global_token = token
+
+
+class AlphaKit:
+    """AlphaKit API 客户端。
+
+    用法：
+        import alphakit as ak
+        ak.set_token('your_token_here')
+        api = ak.AlphaKit()
+        df = api.daily_basic(trade_date='20260101')
+    """
+
+    def __init__(self, token: Optional[str] = None, base_url: Optional[str] = None):
+        self.token = token or _global_token
+        if not self.token:
+            raise ValueError("未设置 token。请先调用 set_token() 或传入 token 参数。")
+        self.base_url = (base_url or _default_base_url).rstrip('/')
+        self.endpoint = f"{self.base_url}/api/v1/query"
+
+    def _query(self, api_name: str, **params) -> pd.DataFrame:
+        """内部查询方法：调用 API 并返回 DataFrame。"""
+        # 过滤 None 值参数
+        filtered = {k: v for k, v in params.items() if v is not None}
+
+        payload = {
+            "api_name": api_name,
+            "params": filtered,
+            "fields": None
+        }
+
+        headers = {"Authorization": f"Bearer {self.token}"}
+
+        try:
+            resp = requests.post(self.endpoint, json=payload, headers=headers, timeout=30)
+            resp.raise_for_status()
+        except requests.RequestException as e:
+            raise AlphaKitError(9999, f"网络请求失败: {e}")
+
+        result = resp.json()
+
+        if result["code"] != 0:
+            raise AlphaKitError(result["code"], result["msg"])
+
+        data = result.get("data")
+        if not data or not data.get("items"):
+            return pd.DataFrame()
+
+        return pd.DataFrame(data["items"], columns=data["fields"])
+
+    # ---- 业务表方法（对标 tushare pro API）----
+
+    def daily_basic(self, ts_code: Optional[str] = None, trade_date: Optional[str] = None,
+                    start_date: Optional[str] = None, end_date: Optional[str] = None) -> pd.DataFrame:
+        """日线基础数据。"""
+        return self._query("daily_basic", ts_code=ts_code, trade_date=trade_date,
+                          start_date=start_date, end_date=end_date)
+
+    def opt_basic(self, ts_code: Optional[str] = None, exchange: Optional[str] = None) -> pd.DataFrame:
+        """期权基础信息。"""
+        return self._query("opt_basic", ts_code=ts_code, exchange=exchange)
+
+    def opt_daily(self, ts_code: Optional[str] = None, trade_date: Optional[str] = None,
+                  start_date: Optional[str] = None, end_date: Optional[str] = None) -> pd.DataFrame:
+        """期权日线数据。"""
+        return self._query("opt_daily", ts_code=ts_code, trade_date=trade_date,
+                          start_date=start_date, end_date=end_date)
+
+    def etf_basic(self, ts_code: Optional[str] = None, market: Optional[str] = None) -> pd.DataFrame:
+        """ETF 基础信息。"""
+        return self._query("etf_basic", ts_code=ts_code, market=market)
+
+    def etf_daily(self, ts_code: Optional[str] = None, trade_date: Optional[str] = None,
+                  start_date: Optional[str] = None, end_date: Optional[str] = None) -> pd.DataFrame:
+        """ETF 日线数据。"""
+        return self._query("etf_daily", ts_code=ts_code, trade_date=trade_date,
+                          start_date=start_date, end_date=end_date)
+
+    def etf_nav(self, ts_code: Optional[str] = None, nav_date: Optional[str] = None,
+                start_date: Optional[str] = None, end_date: Optional[str] = None) -> pd.DataFrame:
+        """ETF 净值数据。"""
+        return self._query("etf_nav", ts_code=ts_code, nav_date=nav_date,
+                          start_date=start_date, end_date=end_date)
+
+    def etf_share(self, ts_code: Optional[str] = None, trade_date: Optional[str] = None,
+                  start_date: Optional[str] = None, end_date: Optional[str] = None) -> pd.DataFrame:
+        """ETF 份额数据。"""
+        return self._query("etf_share", ts_code=ts_code, trade_date=trade_date,
+                          start_date=start_date, end_date=end_date)
+
+    def etf_theme_map(self, ts_code: Optional[str] = None, theme: Optional[str] = None) -> pd.DataFrame:
+        """ETF 主题映射。"""
+        return self._query("etf_theme_map", ts_code=ts_code, theme=theme)
+
+    def query(self, api_name: str, **params) -> pd.DataFrame:
+        """通用查询方法（兜底）。"""
+        return self._query(api_name, **params)

alphakit/exceptions.py

@@ -0,0 +1,9 @@
+"""AlphaKit 异常。"""
+
+
+class AlphaKitError(Exception):
+    """SDK 基础异常。"""
+    def __init__(self, code: int, message: str):
+        self.code = code
+        self.message = message
+        super().__init__(f"[{code}] {message}")

alphakit_sdk-0.1.0.dist-info/METADATA

@@ -0,0 +1,174 @@
+Metadata-Version: 2.4
+Name: alphakit-sdk
+Version: 0.1.0
+Summary: AlphaKit — 简洁的金融数据 API 工具包
+Author: AlphaKit Team
+License: MIT
+Project-URL: Homepage, https://github.com/yourusername/alphakit
+Keywords: finance,data,api,quant,alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Topic :: Office/Business :: Financial
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.28.0
+Requires-Dist: pandas>=1.3.0
+
+# AlphaKit
+
+简洁的金融数据 API 工具包，提供类似 tushare 的使用体验。
+
+## 安装
+
+```bash
+pip install alphakit
+```
+
+本地开发安装：
+```bash
+cd TokenAuth
+pip install -e .
+```
+
+## 快速开始
+
+### 方式一：全局 token（推荐）
+
+```python
+import alphakit as ak
+
+# 设置全局 token
+ak.set_token('your_token_here')
+
+# 创建 API 实例
+api = ak.AlphaKit()
+
+# 查询数据
+df = api.daily_basic(trade_date='20260101')
+print(df.head())
+```
+
+### 方式二：实例化时传入 token
+
+```python
+from alphakit import AlphaKit
+
+api = AlphaKit(token='your_token_here')
+df = api.opt_daily(ts_code='10004355.SH', start_date='20260101', end_date='20260131')
+```
+
+### 方式三：自定义服务器地址
+
+```python
+import alphakit as ak
+
+ak.set_token('your_token')
+api = ak.AlphaKit(base_url='http://your-server.com:8002')
+df = api.etf_daily(ts_code='510050.SH', trade_date='20260101')
+```
+
+## API 方法
+
+所有方法返回 pandas DataFrame。
+
+### 日线基础数据
+```python
+df = api.daily_basic(
+    ts_code='000001.SZ',      # 可选
+    trade_date='20260101',    # 可选
+    start_date='20260101',    # 可选
+    end_date='20260131'       # 可选
+)
+```
+
+### 期权数据
+```python
+# 期权基础信息
+df = api.opt_basic(ts_code='10004355.SH')
+
+# 期权日线
+df = api.opt_daily(
+    ts_code='10004355.SH',
+    start_date='20260101',
+    end_date='20260131'
+)
+```
+
+### ETF 数据
+```python
+# ETF 基础信息
+df = api.etf_basic(market='SSE')
+
+# ETF 日线
+df = api.etf_daily(ts_code='510050.SH', trade_date='20260101')
+
+# ETF 净值
+df = api.etf_nav(ts_code='510050.SH', nav_date='20260101')
+
+# ETF 份额
+df = api.etf_share(ts_code='510050.SH', trade_date='20260101')
+
+# ETF 主题
+df = api.etf_theme_map(theme='科技')
+```
+
+### 通用查询（支持所有表）
+```python
+df = api.query('daily_basic', ts_code='000001.SZ', trade_date='20260101')
+```
+
+## 错误处理
+
+```python
+from alphakit import AlphaKit, AlphaKitError
+
+api = AlphaKit(token='your_token')
+
+try:
+    df = api.daily_basic(trade_date='20260101')
+except AlphaKitError as e:
+    print(f"错误码: {e.code}")
+    print(f"错误信息: {e.message}")
+```
+
+常见错误码：
+- `1001`: Token 无效 / 过期 / 吊销
+- `1002`: 无权限访问该表
+- `1003`: IP 超限 / 封禁
+- `1004`: 每分钟限频
+- `1005`: 每日配额用尽
+- `1006`: 查询参数错误
+
+## 注意事项
+
+1. **大表必须带过滤条件**：`daily_basic`、`opt_daily`、`etf_daily` 等大表必须带 `ts_code` 或日期过滤，否则报错 1006
+2. **日期格式**：`YYYYMMDD`（如 `20260101`）
+3. **IP 限制**：每个 token 默认最多绑定 3 个 IP，超限拒绝
+4. **限流配额**：默认每分钟 60 次、每日 500 次
+
+## 示例脚本
+
+```python
+import alphakit as ak
+
+ak.set_token('your_64_char_token_here')
+api = ak.AlphaKit()
+
+# 查某股票某天的数据
+df = api.daily_basic(ts_code='000001.SZ', trade_date='20260101')
+print(df)
+
+# 查某期权某月的行情
+df = api.opt_daily(ts_code='10004355.SH', start_date='20260101', end_date='20260131')
+print(df.tail())
+
+# 查所有 ETF 基础信息（小表可不带过滤）
+df = api.etf_basic()
+print(f"共 {len(df)} 只 ETF")
+```

alphakit_sdk-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+alphakit/__init__.py,sha256=Sc66hTFUSwzVSAQAldusGQ6WHeKQIg0CiVNVAgNiGO4,228
+alphakit/client.py,sha256=J_YMX10SQD_PHy79WD9vJ1GoaD63PLtJPkjK8m78bS0,4676
+alphakit/exceptions.py,sha256=LLglI0ACFmlq-7IJdvhrOLtsdWgBx3QEOT4kk8YO1j4,242
+alphakit_sdk-0.1.0.dist-info/METADATA,sha256=lFw_H5V9Gi5W8ouG-DMHJgvqr9Y2r52iagTjTQ1UIVk,4193
+alphakit_sdk-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+alphakit_sdk-0.1.0.dist-info/top_level.txt,sha256=6PdBm22Q3cELg6eF6YseqpH2eirIMqQDImj8cWmUGW0,9
+alphakit_sdk-0.1.0.dist-info/RECORD,,

alphakit_sdk-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

alphakit_sdk-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+alphakit