跳到主要内容

设置倒计时取消所有订单配置 (TRADE)

接口描述

此接口用于设置倒计时取消所有订单(包括做市商保护订单与普通订单)配置,即在倒计时结束前心跳没有更新,特定标的资产的所有订单会被取消。若倒计时结束前心跳没有更新,所有的订单将会被取消,同时新订单会返回错误代码-2010。可以通过设置countdownTime为0取消此功能。

HTTP请求

POST /eapi/v1/countdownCancelAll

 

请求权重

1

请求参数

名称类型是否必须描述
underlyingSTRINGYES期权标的资产, 如 BTCUSDT
countdownTimeLONGYES以毫秒计量倒计时长 (1000代表1秒)。 设为0时关闭倒计时。最小设为5000(负值无效) 
recvWindowLONGNO
timestampLONGYES
  • 本接口用于配置网络中断情况下自动取消已有订单。
  • 使用样例:对特定的标的资产调用本接口(使用参数countdownTime = 10000,10秒)打开自动取消所有订单功能。如果功能开启后任意10秒内没有对该标的资产调用countdownCancelAllHeartBeat接口,则该标的资产上所有订单被去取消。如果调用接口时传参countdownTime = 0,倒计时自动取消订单功能关闭。
  • 请注意,系统每隔1000ms(1s)倒计时是否结束,使用此功能时应考虑足够的时间冗余。 我们不建议将倒计时时间设置得太精确或太小。  

响应示例

{
  "underlying": "ETHUSDT",
  "countdownTime": 100000
}