Docs
English

命令行工具 (CLI)

Tiger OpenAPI Python SDK 提供了 tigeropen 命令行工具，可以直接在终端中查询行情、管理订单、查看账户信息等，无需编写代码。


安装

推荐使用一键安装脚本，自动检测并选择最佳安装方式（uv > pipx > pip）：

curl -fsSL https://raw.githubusercontent.com/tigerfintech/openapi-python-sdk/master/install.sh | sh

如果您希望手动安装，推荐使用 uv（高速 Python 包管理器）：

# 安装 uv（如尚未安装）
# macOS / Linux:
curl -LsSf https://astral.sh/uv/install.sh | sh
# 或通过 pip:
pip install uv

# 使用 uv 安装独立 CLI
uv tool install tigeropen

也可以通过 pipx 或 pip 安装：

# pipx（自动创建独立环境）
pipx install tigeropen

# pip（在已激活的虚拟环境中安装，适合同时在代码中使用 SDK）
pip install tigeropen

安装完成后，在终端运行 tigeropen 即可查看使用帮助。


升级

重新运行一键安装脚本即可升级到最新版本，脚本会自动覆盖安装：

curl -fsSL https://raw.githubusercontent.com/tigerfintech/openapi-python-sdk/master/install.sh | sh

如果是手动安装，请使用与安装时相同的工具进行升级：

# uv
uv tool upgrade tigeropen

# pipx
pipx upgrade tigeropen

# pip
pip install --upgrade tigeropen

升级完成后可运行 tigeropen version 确认版本号。


配置

在使用 CLI 前，需要完成 Tiger OpenAPI 的配置。CLI 支持签名认证（默认，用 Tiger ID 与私钥）；个人用户还可以使用 OAuth2 授权（不需要私钥）。两者的区别见认证方式。

OAuth2 仅支持个人用户，需要 tigeropen >= 3.8.0，且不需要私钥。机构用户请使用签名认证：

tigeropen --auth oauth2 config init

然后按下方认证管理完成授权。


全局选项

以下选项可以在任意子命令中使用：

选项说明
-f, --format输出格式：table、json、csv，默认 json
-c, --config-path配置文件目录或文件路径
-l, --language语言：en_US、zh_CN、zh_TW，默认 en_US
--auth认证方式：signature、oauth2
-v, --verbose启用详细日志输出
-h, --help显示帮助信息

认证管理

# 完成授权
tigeropen auth login

# 查看状态或取消授权
tigeropen auth status
tigeropen auth logout

调用权限以授权时选择的范围为准。


股票查询

行情权限说明：实时行情（quotes、逐笔、深度等）需要单独购买 API 行情权限，与 App 内行情权限相互独立；K 线等历史行情的可用范围由历史行情额度等级决定。详情请参阅行情权限说明。

# 查询股票实时行情
tigeropen quote briefs AAPL TSLA

# 查询日 K 线，默认返回最近251条
tigeropen quote bars AAPL --period day

# 查询 5 分钟 K 线，指定数量
tigeropen quote bars AAPL --period 5min --limit 50

# 指定时间范围
tigeropen quote bars AAPL --period day --begin-time 2025-01-01 --end-time 2025-03-01

# 查询当日分时数据
tigeropen quote timeline AAPL

# 查询指定日期的分时数据
tigeropen quote timeline AAPL --date 2025-03-20

# 逐笔成交
tigeropen quote ticks AAPL --limit 100

# 盘口数据
tigeropen quote depth AAPL --market US

# 市场状态
tigeropen quote market-status --market US

# 股票代码列表
tigeropen quote symbols --market US

选股筛选（Scanner）

# 今日涨幅最大的美股（预设）
tigeropen quote scanner --filter gainers --sort acc.ChangeRate --sort-dir DESC

# 市值超过 100 亿、市盈率低于 20 的美股
tigeropen quote scanner --filter MarketValue:1e10: --filter PeTTM::20 --sort MarketValue

# 年化 ROE 高于 15% 的股票
tigeropen quote scanner --filter acc.ROE:0.15::ANNUAL --sort acc.ROE:ANNUAL --sort-dir DESC

# 有期权的美股
tigeropen quote scanner --filter tag.OptionsAvailable:1

# 港股筛选
tigeropen quote scanner --market HK --filter MarketValue:1e9: --sort MarketValue

--filter 格式说明：

  • FIELD:min:max — 数值范围，如 PeTTM::20（P/E 低于 20）、MarketValue:1e9:（市值高于 10 亿）
  • acc.FIELD:min:max:PERIOD — 累计字段，PERIOD 可选 ANNUAL、QUARTERLY、SEMIANNUAL
  • fin.FIELD:min:max — 财务字段（LTM）
  • tag.FIELD:tag1,tag2 — 标签筛选，如 tag.OptionsAvailable:1
  • 预设：gainers（今日涨幅 > 5%）、losers（今日跌幅 < -5%）

期权查询

# 查询期权到期日
tigeropen quote option expirations AAPL

# 查询期权链
tigeropen quote option chain AAPL 2025-06-20

# 查询期权行情
tigeropen quote option briefs "AAPL  250620C00200000"

# 查询期权 K 线
tigeropen quote option bars "AAPL  250620C00200000" --period day

期权链 Greeks 已废弃：期权链中的 Greeks 请求开关、筛选字段/模型和返回字段 delta、gamma、theta、vega、rho 每日更新，时效性不足以支持盘中使用，请勿用于实时交易决策。请使用期权计算器，并传入当前市场输入进行计算。


期货查询

# 查看可用期货交易所
tigeropen quote future exchanges

# 查看交易所下的期货合约
tigeropen quote future contracts CME

# 查询期货行情
tigeropen quote future briefs CL2509

# 查询期货 K 线
tigeropen quote future bars CL2509 --period day

资金流向

# 查询资金流入流出
tigeropen quote capital flow AAPL --market US --period day

# 查询资金分布
tigeropen quote capital distribution AAPL --market US


订单管理

# 查看订单列表
tigeropen trade order list

# 按状态筛选（Filled/Cancelled/Submitted）
tigeropen trade order list --status Filled --market US

# 查看订单详情
tigeropen trade order get 12345678

# 预览订单
tigeropen trade order preview --symbol AAPL --action BUY --quantity 100 --limit-price 150.00

# 下单
tigeropen trade order place --symbol AAPL --action BUY --order-type LMT --quantity 100 --limit-price 150.00

# 修改订单
tigeropen trade order modify 12345678 --limit-price 151.00

# 撤单
tigeropen trade order cancel 12345678

持仓查询

# 查看所有持仓
tigeropen trade position list

# 按证券类型和市场筛选
tigeropen trade position list --sec-type STK --market US

# 按标的筛选
tigeropen trade position list --symbol AAPL

成交记录

tigeropen trade transaction list --symbol AAPL --start-time 2025-01-01 --end-time 2025-03-01

账户信息

# 查看账户信息
tigeropen account info

# 查看资产概况
tigeropen account assets

# 指定币种查看资产
tigeropen account assets --currency USD

# 查看资产分析
tigeropen account analytics --start-date 2025-01-01 --end-date 2025-03-01

实时推送

CLI 支持订阅实时数据流，按 Ctrl+C 停止订阅：

# 订阅实时行情
tigeropen push quote AAPL TSLA

# 订阅订单状态变化
tigeropen push order

# 订阅持仓变化
tigeropen push position

# 订阅资产变化
tigeropen push asset

配置管理

# 交互式配置（签名认证，收集 Tiger ID 与私钥）
tigeropen config init

# OAuth2 配置（仅限个人用户，不收集私钥）
tigeropen --auth oauth2 config init

# 查看当前配置（私钥信息已脱敏）
tigeropen config show

# 修改单个配置项
tigeropen config set tiger_id your_new_tiger_id

# 查看配置文件路径
tigeropen config path

OAuth2 配置不包含私钥。配置项优先级为：命令行选项 > 环境变量 > 配置文件。


内置 Skill 知识

CLI 自带一组供 AI 编码助手阅读的说明文件，随 CLI 一起安装，版本始终与 CLI 一致，无需额外下载：

# 列出可用的 skill 模块
tigeropen skills list

# 读取某个模块的说明
tigeropen skills read tigeropen-shared

# 读取模块下的参考文件
tigeropen skills read tigeropen-cli references/oauth2.md

# 以 JSON 输出，便于程序处理
tigeropen skills list --json
模块内容
tigeropen-shared认证方式、配置与行情权限
tigeropen-cli命令总览、全局选项、配置管理、OAuth2 接入
tigeropen-quote行情查询与选股器
tigeropen-trade下单、订单与持仓管理
tigeropen-push实时推送订阅

这套内容面向"AI 要正确调用 tigeropen 命令"这个场景。如果你要的是"AI 帮你写 SDK 代码"，那是另一套东西，见 AI Skills。


其他命令

# 查看版本
tigeropen version

# 卸载
tigeropen uninstall

# 卸载并移除配置目录
tigeropen uninstall --remove-config

输出格式

CLI 支持三种输出格式，通过 -f 参数切换。默认为 json。

JSON 格式（默认）

适合程序处理和管道操作。输出带缩进的 JSON，中文字符直接显示不转义。

tigeropen quote briefs AAPL -f json

返回示例：

[
  {
    "symbol": "AAPL",
    "open": 217.565,
    "high": 220.48,
    "low": 216.23,
    "close": 220.37,
    "pre_close": 218.27,
    "latest_price": 220.37,
    "latest_time": "2025-03-21 16:00:00",
    "volume": 34552403,
    "amount": 7544389505,
    "status": "NORMAL"
  }
]

表格格式

适合终端直接阅读，以对齐的列表形式展示。

tigeropen quote briefs AAPL -f table

返回示例：

symbol    open     high      low    close  pre_close  latest_price         latest_time    volume       amount  status
  AAPL  217.565  220.48  216.23   220.37     218.27        220.37  2025-03-21 16:00:00  34552403  7544389505  NORMAL

CSV 格式

适合导入 Excel 等表格工具进行进一步分析。

tigeropen quote briefs AAPL -f csv

返回示例：

symbol,open,high,low,close,pre_close,latest_price,latest_time,volume,amount,status
AAPL,217.565,220.48,216.23,220.37,218.27,220.37,2025-03-21 16:00:00,34552403,7544389505,NORMAL

格式选项可放在任意位置

-f 是全局选项，可以放在命令行的任意位置：

# 以下写法等效
tigeropen quote briefs AAPL -f table
tigeropen -f table quote briefs AAPL
tigeropen quote briefs AAPL TSLA -f csv

频率限制

CLI 的请求频率限制与 Tiger OpenAPI 一致，详情请参阅请求频率与限制。

Updated 2 days ago

Did this page help you?