TWS API 类参考总览
这一部分对应 IBKR 官方的 TWS API Reference,官方入口是:TWS API Reference。
它和前面的实战教程不是同一种内容:
| 内容 | 用途 |
|---|---|
| TWS API 实战教程 | 按开发任务讲,例如连接 TWS、请求历史 K 线、构造合约、提交订单。 |
| TWS API 类参考 | 按类和字段讲,例如 Contract、Order、EClient、EWrapper 每个属性是什么意思。 |
简单说:实战教程告诉你“怎么跑通一个功能”,类参考告诉你“某个对象里每个字段代表什么”。
官方 Reference 目录
Section titled “官方 Reference 目录”官方 twsapi-ref 主要包含这些类和接口:
| 类 / 接口 | 中文理解 |
|---|---|
AccountSummaryTags | 账户摘要字段集合。 |
Bar | 历史 K 线数据条。 |
ComboLeg | 组合合约中的单条腿。 |
CommissionAndFeesReport | 成交产生的佣金和费用报告。 |
Contract | 合约对象,描述股票、期权、期货、外汇等金融工具。 |
ContractDetails | 合约详情,包含交易时间、最小变动价位、有效交易所等扩展信息。 |
CodeMsgPair | 错误码和错误消息的组合。 |
DeltaNeutralContract | Delta-neutral 组合中的底层合约信息。 |
EClient | 发起请求的客户端接口。 |
EClientSocket | Socket 客户端实现。 |
EReader | 从 Socket 读取消息的线程组件。 |
EReaderSignal | 消息读取线程使用的信号接口。 |
EWrapper | 接收回调的接口。 |
Execution | 成交对象。 |
ExecutionCondition | 成交条件。 |
ExecutionFilter | 成交查询过滤器。 |
HistoricalTick | 历史逐笔数据。 |
HistoricalTickBidAsk | 历史买卖价逐笔数据。 |
HistoricalTickLast | 历史成交逐笔数据。 |
Liquidity | 流动性标记。 |
MarginCondition | 保证金条件。 |
Order | 订单对象。 |
OrderAllocation | 订单分配信息。 |
OrderCancel | 取消订单请求对象。 |
OrderComboLeg | 组合订单每条腿的订单价格信息。 |
OrderState | 订单状态和保证金影响。 |
PercentChangeCondition | 百分比变化条件。 |
PriceCondition | 价格条件。 |
ScannerSubscription | 市场扫描器订阅对象。 |
SoftDollarTier | Soft Dollar 分层信息。 |
TagValue | 键值对扩展参数。 |
TickAttrib | Tick 附加属性。 |
TimeCondition | 时间条件。 |
VolumeCondition | 成交量条件。 |
WshEventData | Wall Street Horizon 事件数据对象。 |
这一部分怎么使用
Section titled “这一部分怎么使用”每个类参考页按“作用、字段、关联接口、易错点”组织。读者可以在实战章节遇到某个对象时,回到这里查字段含义,也可以让 Agent 通过 MCP 检索这些结构化说明。
| 模块 | 内容 |
|---|---|
| 类的作用 | 这个类在 TWS API 里解决什么问题。 |
| 常用字段 | 字段英文名、中文解释、类型、常见取值。 |
| 和实战接口的关系 | 哪些请求或回调会用到这个类。 |
| 易错点 | 新手最容易填错或误解的字段。 |
类参考适合查字段,实战章节适合照着写代码。比如 Contract 和 Order 的字段很多,实战章节会给出可运行的组合,类参考则解释这些字段为什么要这样填。
建议先读:
EClient与EWrapper:理解请求和回调。Contract:理解股票、期权、期货、外汇如何定义。ContractDetails:理解合约查询返回的扩展信息。Bar:理解历史 K 线返回字段。Order:理解下单字段。OrderState、Execution、CommissionAndFeesReport:理解订单状态、成交和费用。
实战章节中的合约、行情、历史 K 线和订单示例,会与这些类参考互相对应。