合约交易接口

下单

限速规则：10次/s

HTTP请求 下单

• POST /api/swap/v3/order/placeOrder

请求参数

参数名	参数类型	是否必须	描述
symbol	String	是	合约名称
client_oid	String	是	自定义订单号(不超过40个字符，且不能是特殊字符，如火星字符等),不可以重复出现在挂单中。如空缺系统会自动赋值
size	String	是	下单数量（不能为0，不能为负数）
type	String	是	1:开多 2:开空 3:平多 4:平空
order_type	String	是	0:普通，1：只做maker;2:全部成交或立即取消;3:立即成交并取消剩余
match_price	String	是	0:限价还是1:市价
price	String	否	委托价格（有精度限制，精度（tick_size）和步长（priceEndStep）取“合约信息接口”，限价必填）
presetTakeProfitPrice	BigDecimal	否	预设的止盈价格
presetStopLossPrice	BigDecimal	否	预设的止损价格

返回数据:

{
    "client_oid":"ww#123456", //客户端请求标识
    "order_id":"513466539039522813" //订单号
}

返回值说明

返回字段	字段说明
client_oid	客户端请求标识
order_id	订单号

批量下单

限速规则：10次/s

HTTP请求 批量下单

• POST /api/swap/v3/order/batchOrders

请求参数

参数名	参数类型	是否必须	描述
symbol	String	是	合约名称
orderDataList	List	是	对象属性 例（price=5,size=2,type=1,match_price=1,order_type=1,client_oid="abc")，字段参考【合约下单】接口，且最多只能批量处理20笔订单

返回数据:

{
    "result":true,
    "order_info":[
        {
            "result":true, //成交结果
            "client_oid":"dxdanzi", //客户端请求标识
            "order_id":"513468410013679613" //成交订单Id
        },
        {
            "result":true,
            "client_oid":"dxdanzi",
            "order_id":"513468410001096713"
        }
    ]
}

返回值说明

返回字段	字段说明
result	成交结果
client_oid	客户端请求标识
order_id	成交订单Id

撤单

限速规则：10次/s

HTTP请求 取消订单

• POST /api/swap/v3/order/cancel_order

请求参数

参数名	参数类型	是否必须	描述
symbol	String	是	合约名称
orderId	String	是	订单号

返回数据:

{
   "symbol":"cmt_btcusdt", //合约名称
   "order_id":"513468410013679613", //订单号
   "client_oid":"dxdanzi", //客户端标识
   "result":true //取消结果
}

返回值说明

返回字段	字段说明
symbol	合约名称
order_id	订单号
client_oid	客户端标识
result	取消结果

批量撤单

限速规则：10次/s

HTTP请求 批量撤单

• POST /api/swap/v3/order/cancel_batch_orders

请求参数

参数名	参数类型	是否必须	描述
symbol	String	是	合约名称
ids	List	是	订单号的集合

返回数据:

{
   "symbol":"cmt_btcusdt", //合约名称
   "result":true, //处理结果
   "order_ids":[
          "258414711",//成功的id
          "478585558"
    ],
   "fail_infos":[
          {
        "order_id":"258414711", //失败的id
        "err_code":"401", //错误code
        "err_msg":""  //错误信息
     }
  ]
}

返回值说明

返回字段	字段说明
symbol	合约名称
result	处理结果
order_ids	订单ids
order_id	订单号
err_code	错误code
err_msg	错误信息

获取单订单信息

限速规则：10次/s

HTTP请求 获取单订单信息

• GET /api/swap/v3/order/detail

请求参数

参数名	参数类型	是否必须	描述
symbol	String	是	合约名称
orderId	String	是	订单号

返回数据:

{
     "symbol":"cmt_btcusdt",//合约名称
     "size":"12", //委托数量
     "timestamp":"15582271175271", //废弃字段
     "client_oid":"cmdtde", //客户端标识
     "createTime":"1698475585258", //创建时间戳
     "filled_qty":"0", //成交数量
     "fee":"0", //手续费
     "order_id":"513468410013679613", //订单id
     "price":"12", //委托价格
     "price_avg":"0", //成交均价
     "status":"-1", //订单状态
     "type":"1", //委托类型
     "order_type":"0",  //订单类型
     "totalProfits":"253" //总盈亏
}

返回值说明

返回字段	字段说明
symbol	合约名称
size	委托数量
timestamp	系统时间戳 //废弃字段
client_oid	客户端标识
createTime	创建时间戳
filled_qty	成交数量
fee	手续费
order_id	订单id
price	委托价格
price_avg	成交均价
status	订单状态( -1:撤销成功 0:等待成交 1:部分成交 2:完全成交)
type	委托类型 1:开多 2:开空 3:平多 4:平空 5:减仓平多 6:减仓平空 7:协议平多 8:协议平空 9:爆仓平多 10:爆仓平空
order_type	订单类型 0：普通委托 1：只做Maker（Post only） 2：全部成交或立即取消（FOK） 3：立即成交并取消剩余（IOC）
totalProfits	总盈亏

获取订单历史委托

限速规则：10次/s

HTTP请求 获取订单历史委托

• GET /api/swap/v3/order/history

请求参数

参数名	参数类型	是否必须	描述
symbol	String	是	合约名称
pageIndex	String	是	页码，为空默认第一页，从1开始
pageSize	String	是	每页数据的条数
createDate	Integer	是	天数 (天数必须小于或等于90,不能为负数)

返回数据:

[
   {
     "symbol":"cmt_btcusdt", //合约名称
     "size":"12", //委托数量
     "client_oid":"cmdtde", //客户端标识
     "createTime":"1698475585258", //创建时间戳
     "filled_qty":"0", //成交数量
     "fee":"0", //手续费
     "order_id":"513468410013679613", //订单id
     "price":"12", //委托价格
     "price_avg":"0", //成交均价
     "status":"-1", //订单状态
     "type":"1", //委托类型
     "order_type":"0", //订单类型
     "totalProfits":"253" //总盈亏
 }
]

返回值说明

返回字段	字段说明
symbol	合约名称
size	委托数量
client_oid	客户端标识
createTime	创建时间戳
filled_qty	成交数量
fee	手续费
order_id	订单id
price	委托价格
price_avg	成交均价
status	订单状态( -1:撤销成功 0:等待成交 1:部分成交 2:完全成交)
type	委托类型 1:开多 2:开空 3:平多 4:平空 5:减仓平多 6:减仓平空 7:协议平多 8:协议平空 9:爆仓平多 10:爆仓平空
order_type	订单类型 0：普通委托 1：只做Maker（Post only） 2：全部成交或立即取消（FOK） 3：立即成交并取消剩余（IOC）
totalProfits	总盈亏

获取订单当前委托

限速规则：10次/s

HTTP请求 获取订单当前委托

• GET /api/swap/v3/order/current 请求参数

参数名	参数类型	是否必须	描述
symbol	String	是	合约名称

返回数据:

[
   {
     "symbol":"cmt_btcusdt", //合约名称
     "size":"12", //委托数量
     "client_oid":"cmdtde", //客户端标识
     "createTime":"1698475585258", //创建时间戳
     "filled_qty":"0", //成交数量
     "fee":"0", //手续费
     "order_id":"513468410013679613", //订单id
     "price":"12", //委托价格
     "price_avg":"0", //成交均价
     "status":"-1", //订单状态
     "type":"1", //委托类型
     "order_type":"0", //订单类型
     "totalProfits":"253" //总盈亏
 }
]

返回值说明

返回字段	字段说明
symbol	合约名称
size	委托数量
client_oid	客户端标识
createTime	创建时间戳
filled_qty	成交数量
fee	手续费
order_id	订单id
price	委托价格
price_avg	成交均价
status	订单状态( -1:撤销成功 0:等待成交 1:部分成交 2:完全成交)
type	委托类型 1:开多 2:开空 3:平多 4:平空 5:减仓平多 6:减仓平空 7:协议平多 8:协议平空 9:爆仓平多 10:爆仓平空
order_type	订单类型 0：普通委托 1：只做Maker（Post only） 2：全部成交或立即取消（FOK） 3：立即成交并取消剩余（IOC）
totalProfits	总盈亏

查询成交明细

限速规则：10次/s

HTTP请求 查询成交明细

• GET /api/swap/v3/order/fills

请求参数

参数名	参数类型	是否必须	描述
symbol	String	是	合约名称
orderId	String	是	订单号

返回数据:

[
  {
      "symbol":"cmt_btcusdt",  //合约名称
      "trade_id":"6667390", //成交Id
      "order_id":"525946425993854915", //订单id
      "price":"9839.00", //成交价格 
      "order_qty":"3466", //成交数量
      "fee":"-0.0000528407360000", //手续费
      "timestamp":"1561121514442", //创建时间戳
      "exec_type":"M", //流动性方向
      "side":"3", //委托类型    标注废弃
      "delegateType": "3" //委托类型
}
]

返回值说明

返回字段	字段说明
symbol	合约名称
trade_id	成交Id
order_id	订单id
price	成交价格
order_qty	成交数量
fee	手续费
timestamp	创建时间戳
exec_type	流动性方向，T：taker M：maker
side	委托类型（1：开多；2：开空；3：平多；4：平空；5：强制平多；6：强制平空；11：协议平多；12：协议平空；13：爆仓平多查询；14：爆仓平空查询
delegateType	委托类型（1：开多；2：开空；3：平多；4：平空；5：强制平多；6：强制平空；11：协议平多；12：协议平空；13：爆仓平多查询；14：爆仓平空查询

计划委托下单

限速规则：10次/s

HTTP请求 计划委托下单

• POST /api/swap/v3/order/plan_order

请求参数

参数名	参数类型	是否必须	描述
symbol	String	是	合约名称
client_oid	String	是	自定义订单号(不超过40个字符，且不能是特殊字符，如火星字符等),不可以重复出现在挂单中。如空缺系统会自动赋值
size	String	是	下单张数（不能为0，不能为负数）
type	String	是	类型 1开仓 2平仓
side	String	是	持仓方向 1多仓 2空仓 标注废弃
holdSide	String	是	持仓方向 1多仓 2空仓
match_type	String	是	0:限价还是1:市价
execute_price	String	是	执行价格
trigger_price	String	是	触发价格

返回数据:

{
      "client_oid":"bitget#123456", //客户端标识
      "order_id":"589579827556646928" //计划委托订单号
}

返回值说明

返回字段	字段说明
client_oid	客户端标识
order_id	计划委托订单号

计划委托撤单

限速规则：10次/s

HTTP请求 计划委托撤单

• POST /api/swap/v3/order/cancel_plan

请求参数

参数名	参数类型	是否必须	描述
symbol	String	是	合约名称
orderId	String	是	订单号

返回数据:

 {
     "order_id":"5895798275566469458", //订单号
     "client_oid":"weex#123456", //客户端标识
     "result":false, //是否撤销成功
     "err_code":"order_no_exist_error", //撤销失败时的原因code
     "err_msg":"订单不存在" //撤销失败时的原因
}

返回值说明

返回字段	字段说明
order_id	订单号
client_oid	客户端标识
result	是否撤销成功
err_code	撤销失败时的原因code
err_msg	撤销失败时的原因

查询当前计划委托

限速规则：10次/s

HTTP请求 查询当前计划委托

• GET /api/swap/v3/order/currentPlan

请求参数

参数名	参数类型	是否必须	描述
symbol	String	是	合约名称
side	String	是	委托类型 1开多 2开空 3平多 4平空 标注废弃
delegateType	String	是	委托类型 1开多 2开空 3平多 4平空
pageIndex	String	是	当前页(1-200整数)
pageSize	String	是	每页数量(1-100整数)
startTime	String	否	查询开始时间(时间戳)
endTime	String	否	查询结束时间(时间戳)

返回数据:

{
      "list":[
              {
                 "symbol":"cmt_btcusdt", //合约名称
                 "execute_count":"0", //执行数量
                 "delegate_count":"1222222", //委托数量
                 "create_time":1576294708136, //创建时间戳
                 "update_time":1576294708136, //更新时间戳
                 "direction":1, //方向
                 "direction_desc":"开多", //方向描述
                 "trigger_price":"22222210.0", //触发价格
                 "execute_price":"7490.0", //执行价格
                 "order_id":"589588227514433528", //订单号
                 "order_type":0, //订单类型
                 "status":1, //状态
                 "status_desc":"未执行状态", //状态描述
                 "create_trade_price":"7490" //计划委托时的成交价
           }
         ],
    "nextPage":false //是否有下一页
}

返回值说明

返回字段	字段说明
symbol	合约名称
nextPage	是否有下一页
execute_count	执行数量
delegate_count	委托数量
create_time	创建时间戳
update_time	更新时间戳
direction	方向 1开多 2开空 3平多 4平空"
direction_desc	方向 1开多 2开空 3平多 4平空"的描述
trigger_price	触发价格
execute_price	执行价格
order_id	订单号
order_type	订单类型 0限价 1市价
status	状态 1未执行状态 2已委托 3执行失败状态 4用户取消状态
status_desc	状态描述 （1未执行状态 2已委托 3执行失败状态 4用户取消状态）
create_trade_price	计划委托时的成交价

查询计划历史委托

限速规则：10次/s

HTTP请求 查询计划历史委托

• GET /api/swap/v3/order/historyPlan

请求参数

参数名	参数类型	是否必须	描述
symbol	String	是	合约名称
side	String	是	委托类型 1开多 2开空 3平多 4平空 标注废弃
delegateType	String	是	委托类型 1开多 2开空 3平多 4平空
pageIndex	String	是	当前页(1-200整数)
pageSize	String	是	每页数量(1-100整数)
startTime	String	否	查询开始时间(时间戳)
endTime	String	否	查询结束时间(时间戳)

返回数据:

{
      "list":[
              {
                 "symbol":"cmt_btcusdt", //合约名称
                 "execute_count":"0", //执行数量
                 "delegate_count":"1222222",//委托数量
                 "create_time":1576294708136,//创建时间戳
                 "update_time":1576294708136, //更新时间戳
                 "direction":1, //方向
                 "direction_desc":"开多", //方向描述
                 "trigger_price":"22222210.0", //触发价格
                 "execute_price":"7490.0", //执行价格
                 "order_id":"589588227514433528", //订单号
                 "order_type":0, //订单类型
                 "status":1, // 订单状态
                 "status_desc":"未执行状态", //订单状态描述
                 "create_trade_price":"7490" //计划委托时的成交价
           }
         ],
    "nextPage":false //是否有下一页
}

返回值说明

返回字段	字段说明
symbol	合约名称
nextPage	是否有下一页
execute_count	执行数量
delegate_count	委托数量
create_time	创建时间戳
update_time	更新时间戳
direction	方向 1开多 2开空 3平多 4平空"
direction_desc	方向 1开多 2开空 3平多 4平空"的描述
trigger_price	触发价格
execute_price	执行价格
order_id	订单号
order_type	订单类型0限价 1市价
status	订单状态 1未执行状态 2已委托 3执行失败状态 4用户取消状态
status_desc	状态描述（1未执行状态 2已委托 3执行失败状态 4用户取消状态）
create_trade_price	计划委托时的成交价