ScannerSubscription 类参考

ScannerSubscription 是 TWS API Reference 中的一个数据结构。本页按 IBKR TWS API Python 包 10.47.1 的字段核对，用中文解释常见用途。

类的作用

市场扫描器订阅对象，用来定义扫描产品、市场范围、扫描代码和过滤条件。

常见使用位置

reqScannerSubscription() 使用它发起扫描器请求。

字段速查

字段	类型	中文解释
numberOfRows	int	扩展字段。实际含义取决于所在接口和产品类型，建议结合对应请求或回调一起阅读。
instrument	str	扩展字段。实际含义取决于所在接口和产品类型，建议结合对应请求或回调一起阅读。
locationCode	str	扩展字段。实际含义取决于所在接口和产品类型，建议结合对应请求或回调一起阅读。
scanCode	str	扫描器代码，例如 HOT_BY_VOLUME。
abovePrice	float	价格相关字段。填写前应确认最小价格增量和订单类型是否支持。
belowPrice	float	价格相关字段。填写前应确认最小价格增量和订单类型是否支持。
aboveVolume	int	扩展字段。实际含义取决于所在接口和产品类型，建议结合对应请求或回调一起阅读。
marketCapAbove	float	扩展字段。实际含义取决于所在接口和产品类型，建议结合对应请求或回调一起阅读。
marketCapBelow	float	扩展字段。实际含义取决于所在接口和产品类型，建议结合对应请求或回调一起阅读。
moodyRatingAbove	str	扩展字段。实际含义取决于所在接口和产品类型，建议结合对应请求或回调一起阅读。
moodyRatingBelow	str	扩展字段。实际含义取决于所在接口和产品类型，建议结合对应请求或回调一起阅读。
spRatingAbove	str	扩展字段。实际含义取决于所在接口和产品类型，建议结合对应请求或回调一起阅读。
spRatingBelow	str	扩展字段。实际含义取决于所在接口和产品类型，建议结合对应请求或回调一起阅读。
maturityDateAbove	str	时间或日期字段。TWS API 对日期格式、时区和空值比较敏感。
maturityDateBelow	str	时间或日期字段。TWS API 对日期格式、时区和空值比较敏感。
couponRateAbove	float	扩展字段。实际含义取决于所在接口和产品类型，建议结合对应请求或回调一起阅读。
couponRateBelow	float	扩展字段。实际含义取决于所在接口和产品类型，建议结合对应请求或回调一起阅读。
excludeConvertible	bool	扩展字段。实际含义取决于所在接口和产品类型，建议结合对应请求或回调一起阅读。
averageOptionVolumeAbove	int	扩展字段。实际含义取决于所在接口和产品类型，建议结合对应请求或回调一起阅读。
scannerSettingPairs	str	扩展字段。实际含义取决于所在接口和产品类型，建议结合对应请求或回调一起阅读。
stockTypeFilter	str	扩展字段。实际含义取决于所在接口和产品类型，建议结合对应请求或回调一起阅读。

易错点

• instrument、locationCode、scanCode 应来自 reqScannerParameters() 返回的 XML。
• 扫描器返回的是候选合约列表，不是实时行情订阅。

版本来源

Python API 中对应源码文件为 ibapi/scanner.py。不同语言的类名和字段名可能略有大小写差异，但核心含义一致；写策略时应以自己安装的 API 版本为准。