XTP

DolphinDB Server 2.00.10 及更高版本，支持 Linux x64。

1. 在 DolphinDB 客户端中使用 listRemotePlugins 命令查看插件仓库中的插件信息。

   注意：仅展示当前操作系统和 server 版本支持的插件。若无预期插件，可自行编译（请选择对应分支下的插件）或在 DolphinDB 用户社区进行反馈。

   login("admin", "123456")
   listRemotePlugins()

2. 使用 installPlugin 命令完成插件安装。

   installPlugin("XTP")

3. 使用 loadPlugin 命令加载插件。

   loadPlugin("XTP")

语法

XTP::setGlobalConfig(clientId, saveFilePath, logLevel)

详情

设置一些全局配置项。在创建句柄前必须调用至少一次。无返回值。

参数

clientId INT 类型标量，1-99 之间取值，表示账户 ID。如果需要在多个 DolphinDB 进程中使用同一个账户去连接，则需要使用不同的 clientId。

saveFilePath STRING 类型标量，表示存储日志文件的目录，要求必须存在且有可写权限。

logLevel INT 类型标量，表示 xtp 记录日志的级别，0-5 之间取值，分别对应 FATAL ERROR WARNING INFO DEBUG TRACE 级别，默认是 3。

语法

XTP::createXTPConnection(name, config)

详情

返回一个连接句柄，可用于登录，订阅数据。

参数

name STRING 类型标量，连接句柄的唯一标识符，不能为空，也不能重复。

config 一个 key 类型为 STRING 的字典，包含如下所示的配置项：

语法

XTP::login(conn, config)

详情

连接 XTP 服务器并登录。无返回值。

注意事项（摘自 XTP 官方文档）：

• 测试环境使用 TCP 的方式推送行情。由于带宽的限制，建议客户只订阅少量股票，否则会出现推送延时、断线等问题。
• XPT 提供的 API 的默认日志级别是 DEBUG，需要调整到 INFO（或 ERROR），否则可能会导致丢包。本插件已将默认级别调整到 INFO，在调试时可以设置为 DEBUG。

参数

conn 由 createXTPConnection 接口返回的句柄。

config 一个 key 类型为 STRING 的字典，包含一些配置项：

注意：如果在 createXTPConnection 中开启了配置项 ciphertext，则在登陆时传递的密码和 IV 值的类型也要求是 INT 类型数组。

语法

XTP::subscribe(conn, quotationType, marketType, codeList, tableDic)

详情

订阅行情数据，收到数据后存储到目标表中。无返回值。

注意事项：

• 订阅同一个行情类型时，在多次订阅上证、深证市场时，要求传入的 tableDic 相同，如果不同，则以第一次订阅传入的 tableDic 为准。
• 订阅同一个行情类型时，在多次订阅新三板市场时，要求传入的 tableDic 相同，如果不同，则以第一次订阅传入的 tableDic 为准。
• 订阅同一个行情类型时，市场类型如果已订阅了 4（上证+深证）则不能再次订阅 1（上证）或 2（深证）。
• 订阅同一个行情类型时，市场类型如果已订阅了 1（上证）或 2（深证）则不能再次订阅 4（上证+深证）。
• 如果 marketType 填为 4，则不能填 codeList。
• 各目标表的 schema 可以通过 getSchema 接口获取。
• 目标表要求是共享表。
• 公网测试环境仅供客户调试 API 接口，没有订单薄 OB 行情。

参数

conn 由 createXTPConnection 接口返回的句柄。

quotationType INT 类型标量，表示行情类型。1：快照，2：逐笔，3：订单簿。

marketType INT 类型标量，表示市场类型。1：上证， 2：深证，3：新三板，4：上证+深证。

codeList STRING 类型向量，表示合约 ID 数组。如果不填或者填空，则订阅全市场数据。

tableDic 一个字典，key 类型是 STRING，value 必须是共享表，用来指定输出表。根据行情类型的不同，输出表的数量也不同。如果空缺其中若干表，则相对应的行情会被丢弃，详情如下表所示：

注意：自 3.00.0.2/2.00.12.5 版本起，支持 TickByTickTable 即逐笔合并表，其包含收到的三种逐笔数据（委托、成交、状态），该表可以做为 orderbookSnapshotEngine 的输入表。在订阅逐笔数据时，tableDic 如果指定了 “TickByTickTable”，就会忽略其它的表。当 key 为 ”TickByTickTable” 时，value 分成两种情况：

• value 为一个表，即包含收到的所有数据。
• value 为一个字典，该字典的键为整形，表示channelNo，值是共享表，会将收到数据按照 channelNo 进行分类，放到不同的表中。

语法

XTP::unsubscribe(conn, quotationType)

详情

取消订阅某个类型的行情数据。无返回值。

参数

conn 由 createXTPConnection 接口返回的句柄。

quotationType INT 类型标量，表示行情类型。1：快照；2：逐笔；3：订单簿。

语法

XTP::getStatus([conn])

详情

获取订阅的状态信息。返回一个表，表结构如下所示：

参数

conn 由 createXTPConnection 接口返回的句柄，可选参数。如果不填，则返回当前所有连接的状态信息。

语法

XTP::getHandle(name)

详情

返回由 name 指定的连接句柄。

参数

name STRING 类型标量，表示连接句柄的唯一标识符 。

语法

XTP::closeXTPConnection(conn)

详情

断开连接，销毁句柄。

参数

conn 由 createXTPConnection 接口返回的句柄。

语法

XTP::getSchema(type, [needReceiveTime], [needElapsedTime])

详情

返回可存储相应行情类型数据的表的结构。

参数

type STRING 类型标量，表示类型。可选的 type 如下表所示：

needReceiveTime BOOL 类型标量，可选参数，默认为 false,，表示是否需要包含 receiveTime 列。如果在 createXTPConnection 时指定了 receiveTime 配置，那么该参数须设置为 true。

needElapsedTime BOOL 类型标量，可选参数，表示返回的 shcmea 是否包含 elapsedTime 列。默认为 false，表示不包含。

返回值 一个表结构。表结构因 type 参数设置值不同而有所变化，具体说明如下。

指数快照表

期权快照表

现货快照表

债券快照表

北交所数据表

逐笔委托表

逐笔成交表

逐笔状态表

订单簿表

逐笔合并表

语法

XTP::generateCiphertextAndIV(password)

详情

对传入的明文密码进行加密，并返回加密后的密码和 IV 值，可用于登录。加密算法为 AES-256-CFB。返回一个元组，第一个元素是密文密码，第二个元素是 IV 值，这两个元素的类型都是 INT 类型数组。

参数

password STRING类型标量，表示明文密码。