API文档

XLight SDK提供完整的Doxygen生成的API文档,包含所有类、函数、数据结构的详细说明。

API概览

XLight交易SDK采用双API架构设计,分别为行情数据API(Quote API)和交易执行API(Trade API)。 所有API都提供C++原生接口和Python绑定(通过SWIG生成)。

设计模式

  • SPI回调模式:异步事件通过Service Provider Interface回调处理
  • 请求ID关联:所有异步操作使用请求ID进行关联
  • 配置驱动:通过结构化配置对象初始化API

文件结构

  • cpp/include/ - C++头文件
  • python/ - Python包文件
  • doc/ - Doxygen生成的API文档

XLight API

提供高性能的 C++ 和 Python 接口,支持极速行情订阅与交易执行。核心包含行情(Quote)与交易(Trade)两大模块,采用异步 SPI 回调机制确保系统极低时延。

行情模块 (Quote)

负责全市场行情订阅、快照查询及深度获取。

  • 订阅指定证券或全市场行情
  • Level1/Level2行情数据推送
  • 逐笔委托和成交数据
  • 静态行情信息查询

交易模块 (Trade)

负责订单申报、撤单、资金股份查询及成交回报推送。

  • 订单管理(报单/撤单)
  • 资金与持仓实时查询
  • 成交回报推送
  • 交易消息断点续传

查看完整XLight API文档

包含所有函数签名、参数说明和示例代码

打开Doxygen文档

数据类型

基本数据类型

类型定义 底层类型 说明
amount_t int64_t 金额类型(单位:元)
price_t int64_t 价格类型(单位:元)
quantity_t int64_t 数量类型(单位:股/手)
security_code_t char[9] 证券代码(包含终止符)

主要数据结构

行情数据结构

  • xlt_market_data_t - 市场快照数据
  • xlt_tick_by_tick_data_t - 逐笔行情数据
  • xlt_static_quote_full_info_t - 静态行情信息

交易数据结构

  • xlt_order_insert_info_t - 报单信息
  • xlt_order_info_t - 订单信息
  • xlt_asset_info_t - 资金信息
  • xlt_position_info_t - 持仓信息

枚举类型

交易相关枚举

ExchangeIndex

交易所编号

  • • INIT = 0 - 初始化值或未知
  • • SH = 1 - 上海证券交易所
  • • SZ = 2 - 深圳证券交易所

OrderType

报单价格类型

  • • LIMIT_PRICE - 限价
  • • BEST_FIVE_PRICE_OR_CANCEL - 市转撤
  • • MARKET_PRICE_OR_CANCEL - 市价立即成交剩余撤销

Side

买卖方向

  • • BUY = 1 - 买入(ETF申购)
  • • SELL = 2 - 卖出(ETF赎回)

系统相关枚举

ApiLogLevel

日志级别

  • • LOG_TRACE = 1 - 跟踪级别
  • • LOG_DEBUG = 2 - 调试级别
  • • LOG_INFO = 3 - 信息级别
  • • LOG_ERROR = 5 - 错误级别

BusinessType

业务类型

  • • CASH = 1 - 现货集中竞价交易
  • • BOND_MATCH = 2 - 债券现券竞价交易
  • • ETF = 3 - ETF申赎业务
  • • PLEDGE_STYLE_REPO = 7 - 债券质押式回购

OrderStatus

订单状态

  • • REPORTED - 已报
  • • PARTIAL_FILLED - 部分成交
  • • FILLED - 全部成交
  • • CANCELLED - 已撤销

完整API文档

XLight SDK提供完整的Doxygen生成的API文档,包含所有类、函数、数据结构的详细说明。