CTP

DolphinDB Server: 2.00.10 及更高版本，目前支持 x86-64 的 Linux 版本。

基于 CTP SDK 支持情况，分为两个版本的插件：CTP、CTPMini。

• CTP 对应 看穿式监管生产版本 (版本号: v6.6.9_20220914)。
• CTPMini 对应 看穿式监管生产版本（版本号: CTPIIMini API V1.6.4），该版本仅支持函数 ctp::queryInstrument。

警告：CTP 与 CTPMini 的 API 与 后台系统并不相互兼容，可能会导致 crash。请避免使用 CTP 版本插件连接 CTPMini 后台，或者使用 CTPMini 版本插件连接 CTP 后台。

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

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

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

   安装 CTP

   installPlugin("ctp");

   安装 CTPMini

   installPlugin("ctpMini");

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

   加载 CTP

   loadPlugin("ctp");

   加载 CTPMini

   loadPlugin("ctpMini");

语法

ctp::connect(ip, port, options, [username], [password])

详情

创建一个和 CTP 行情服务器之间的连接，返回一个句柄。如果该 ip，port 对应的账户已经建立了连接，则会直接返回已经建立了连接的 handle。注意，通过这种方式获得的 handle，它的 option 可能会与期望 option 不同，可以在 log 中查看返回 handle 的具体 option。

参数

ip 为 STRING 类型标量或向量，表示 CTP 行情服务器的 IP 地址。

port 为 INT 类型标量或向量，表示 CTP 行情服务器的端口。如果为向量，其长度应与向量 ip 的长度相等。

options 为一个字典，其 key 是一个字符串标量，可以为 "ConcatTime", "ReceivedTime", "OutputElapsed"；其 value 为 BOOL 标量。

• 如果 ConcatTime 为 true，则会将 UpdateTime 和 UpdateMillisec 字段合并为一个 tradeTime 字段置于表末尾，类型为 TIME。
• 如果 ReceivedTime 为 true，则会将接收到数据的时间作为一个字段置于表末尾，类型为 NANOTIMESTAMP。默认为 true。
• 如果 OutputElapsed 为 true，则会将数据进入插件，到插入流表前的时间间隔作为一个字段置于表末尾，类型为 LONG。

username 为 STRING 类型标量，代表 CTP 账号名。

password 为 STRING 类型标量，代表 CTP 密码。

语法

ctp::subscribe(ctpHandle, dataType, outputTable, ids)

详情

订阅指定合约 ID 的数据到由 connect 指定的流表中。

参数

ctpHandle connect 接口返回的句柄。

dataType STRING 类型标量，表示需要订阅的数据类型，目前只支持 "marketData"。

outputTable 输出表，为共享流表。

ids STRING 类型向量，表示由合约 ID 组成的数组。

语法

ctp::unsubscribe(ctpHandle, dataType, ids)

详情

取消订阅指定合约 ID 的数据。

参数

ctpHandle connect 接口返回的句柄。

dataType STRING 类型标量，表示需要取消订阅的数据类型，目前只支持 "marketData"。

ids STRING 类型向量，表示由合约 ID 组成的数组。

语法

ctp::close(ctpHandle)

详情

关闭当前连接。

参数

ctpHandle connect 接口返回的句柄。

语法

ctp::getSchema(handle, type)

详情

返回一个表，包含两列：name 和 type，分别表示该类型表结构的名字和类型。通过该表来创建具有相同结构的共享流表。

参数

ctpHandle connect 接口返回的句柄。

type STRING 类型标量，表示行情（marketData）或者询价等，当前只支持行情。

语法

ctp::getStatus(handle)

详情

获取订阅状态信息。

参数

handle connect 接口返回的句柄。

返回值

返回一个 dict，包含两个键值对。

• subStatus 键对应的是一个 8 列的表格：

  列名	含义	类型
  topicName	订阅的名称	STRING
  startTime	订阅开始的时间	NANOTIMESTAMP
  endTime	订阅结束的时间	NANOTIMESTAMP
  firstMsgTime	第一条消息收到的时间	NANOTIMESTAMP
  lastMsgTime	最后一条消息收到的时间	NANOTIMESTAMP
  processedMsgCount	已经处理的消息数	LONG
  lastErrMsg	最后一条错误信息	STRING
  failedMsgCount	处理失败的消息数	LONG
  lastFailedTimestamp	最后一条错误消息发生的时间	NANOTIMESTAMP

• ids 键对应的是一个 STRING VECTOR，里面为目前订阅的所有合约。

语法

在 ctp 中调用

ctp::queryInstrument(ip, port, userID, password, brokerID, appID, authCode, [exchangeID], [waitTimes]);

在 ctpMini 中调用

ctpMini::queryInstrument(ip, port, userID, password, brokerID, appID, authCode, [exchangeID], [waitTimes]);

详情

通过登录 CTP 交易端账号，查询并返回包含所有合约信息的表。具体字段含义请参考 CTP 官方文档。

注意：本函数需要有效的 CTP 交易端账号，如果只使用行情端的账号将无法获取结果。目前 CTPMini 中只有此函数。

参数

ip 为 STRING 类型标量或向量，表示 CTP 交易服务器的 IP 地址。

port 为 INT 类型标量或向量，表示 CTP 交易服务器的端口。如果为向量，其长度应与向量 ip 的长度相等。

userID STRING 类型标量，指用户代码。

password STRING 类型标量，指密码。

brokerID STRING 类型标量，指经纪公司代码。

appID STRING 类型标量，指客户端认证的 App 代码。

authCode STRING 类型标量，指客户端认证请求的认证码。

exchangeID 可选参数，STRING 类型标量，指交易所代码，如果指定了则只会查询对应交易所的合约。

waitTimes 可选参数，为整型标量，必需为正整数。指查询最大等待时间，单位为秒，默认为 10。