跳到主要内容

交易接口

下单 (TRADE)​

POST /api/v3/order

这个请求会把1个订单添加到 EXCHANGE_MAX_ORDERS 过滤器和 MAX_NUM_ORDERS 过滤器中。

权重: 1

未成交的订单计数: 1

参数:

名称类型是否必须描述
symbolSTRINGYES
sideENUMYES详见枚举定义:订单方向
typeENUMYES详见枚举定义:订单类型
timeInForceENUMNO详见枚举定义:生效时间
quantityDECIMALNO
quoteOrderQtyDECIMALNO
priceDECIMALNO
newClientOrderIdSTRINGNO用户自定义的orderid,如空缺系统会自动赋值。
strategyIdLONGNO
strategyTypeINTNO不能低于 1000000。
stopPriceDECIMALNO仅 STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT 需要此参数。
trailingDeltaLONGNO参见 追踪止盈止损(Trailing Stop)订单常见问题
icebergQtyDECIMALNO仅有限价单(包括条件限价单与限价做事单)可以使用该参数,含义为创建冰山订单并指定冰山订单的数量。
newOrderRespTypeENUMNOMARKET 与 LIMIT 订单默认为FULL, 其他默认为ACK。
selfTradePreventionModeENUMNO允许的 ENUM 取决于交易对的配置。
pegPriceTypeENUMNO参阅 关于挂钩订单参数的注意事项
pegOffsetValueINTNO用于挂钩的价格水平(最大值:100)。参阅 关于挂钩订单参数的注意事项
pegOffsetTypeENUMNO仅支持 PRICE_LEVEL。参阅 关于挂钩订单参数的注意事项
recvWindowDECIMALNO最大值为 60000 毫秒。
支持最多三位小数的精度(例如 6000.346),以便可以指定微秒。
timestampLONGYES用于请求签名的 Unix 时间戳,单位为毫秒或微秒。该值必须反映客户端当前时间,并会在签名接口中由服务器进行校验。

数据源: 撮合引擎

根据 order type的不同,某些参数 有强制要求,具体如下:

Type强制要求的参数其他信息
LIMITtimeInForce, quantity, price
MARKETquantity市价买卖单可用quantity参数来设置base asset数量.
例如:BTCUSDT 市价单,BTC 买卖数量取决于quantity参数.

市价买卖单可用quoteOrderQty参数来设置quote asset数量. 正确的quantity取决于市场的流动性与quoteOrderQty
例如: 市价 BUY BTCUSDT,单子会基于quoteOrderQty- USDT 的数量,购买 BTC.
市价 SELL BTCUSDT,单子会卖出 BTC 来满足quoteOrderQty- USDT 的数量.
STOP_LOSSquantity, stopPrice, trailingDelta条件满足后会下MARKET单子. (例如:达到stopPrice或trailingDelta被启动)
STOP_LOSS_LIMITtimeInForce, quantity, price, stopPrice, trailingDelta
TAKE_PROFITquantity, stopPrice, trailingDelta条件满足后会下MARKET单子. (例如:达到stopPrice或trailingDelta被启动)
TAKE_PROFIT_LIMITtimeInForce, quantity, price, stopPrice, trailingDelta
LIMIT_MAKERquantity, price订单大部分情况下与普通的限价单没有区别,但是如果在当前价格会立即吃对手单并成交则下单会被拒绝。因此使用这个订单类型可以保证订单一定是挂单方,不会成为吃单方。

关于挂钩订单参数的注意事项:

  • 这些参数仅适用于 LIMIT, LIMIT_MAKER, STOP_LOSS_LIMIT 和 TAKE_PROFIT_LIMIT 订单。
  • 如果使用了 pegPriceType, 那么 price 字段将是可选的。 否则,price 字段依旧是必须的。
  • pegPriceType=PRIMARY_PEG 就是主要挂钩(primary),这是订单簿上与您的订单同一方向的最佳价格。
  • pegPriceType=MARKET_PEG 就是市场挂钩(market),这是订单簿上与您的订单相反方向的最佳价格。
  • 可以通过使用 pegOffsetType 和 pegOffsetValue 来获取最佳价格以外的价格水平。 这两个参数必须一起使用。

其他:

  • 任何LIMIT或LIMIT_MAKER只要填icebergQty参数都可以下冰上订单。
  • 冰山订单的 timeInForce必须设置为GTC。
  • STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT_LIMIT 与 TAKE_PROFIT 单子都能同时填上trailingDelta与stopPrice。
  • 填上quoteOrderQty的市价单不会触犯过滤器的LOT_SIZE限制。订单的quantity会尽量满足quoteOrderQty的数量。

条件单的触发价格必须:

  • 比下单时当前市价高: STOP_LOSS BUY, TAKE_PROFIT SELL
  • 比下单时当前市价低: STOP_LOSS SELL, TAKE_PROFIT BUY

响应:

ACK 响应类型:返回速度最快,不包含成交信息,信息量最少

{
"symbol": "BTCUSDT",
"orderId": 28,
"orderListId": -1, // 除非此单是订单列表的一部分, 否则此值为 -1
"clientOrderId": "6gCrw2kRUAF9CvJDGP16IP",
"transactTime": 1507725176595
}

RESULT 响应类型:返回速度居中,返回吃单成交的少量信息

{
"symbol": "BTCUSDT",
"orderId": 28,
"orderListId": -1, // 除非此单是订单列表的一部分, 否则此值为 -1
"clientOrderId": "6gCrw2kRUAF9CvJDGP16IP",
"transactTime": 1507725176595,
"price": "0.00000000",
"origQty": "10.00000000",
"executedQty": "10.00000000",
"origQuoteOrderQty": "0.000000",
"cummulativeQuoteQty": "10.00000000",
"status": "FILLED",
"timeInForce": "GTC",
"type": "MARKET",
"side": "SELL",
"workingTime": 1507725176595,
"selfTradePreventionMode": "NONE"
}

FULL 响应类型:返回速度最慢,返回吃单成交的详细信息

{
"symbol": "BTCUSDT",
"orderId": 28,
"orderListId": -1, // 除非此单是订单列表的一部分, 否则此值为 -1
"clientOrderId": "6gCrw2kRUAF9CvJDGP16IP",
"transactTime": 1507725176595,
"price": "1.00000000",
"origQty": "10.00000000",
"executedQty": "10.00000000",
"origQuoteOrderQty": "0.000000",
"cummulativeQuoteQty": "10.00000000",
"status": "FILLED",
"timeInForce": "GTC",
"type": "MARKET",
"side": "SELL",
"workingTime": 1507725176595,
"selfTradePreventionMode": "NONE",
"fills": [
{
"price": "4000.00000000",
"qty": "1.00000000",
"commission": "4.00000000",
"commissionAsset": "USDT",
"tradeId": 56
},
{
"price": "3999.00000000",
"qty": "5.00000000",
"commission": "19.99500000",
"commissionAsset": "USDT",
"tradeId": 57
},
{
"price": "3998.00000000",
"qty": "2.00000000",
"commission": "7.99600000",
"commissionAsset": "USDT",
"tradeId": 58
},
{
"price": "3997.00000000",
"qty": "1.00000000",
"commission": "3.99700000",
"commissionAsset": "USDT",
"tradeId": 59
},
{
"price": "3995.00000000",
"qty": "1.00000000",
"commission": "3.99500000",
"commissionAsset": "USDT",
"tradeId": 60
}
]
}

测试下单接口 (TRADE)​

POST /api/v3/order/test

用于测试订单请求,但不会提交到撮合引擎

权重:

条件权重
没有 computeCommissionRates1
有 computeCommissionRates20

参数:

名称类型是否必须描述
computeCommissionRatesBOOLEANNO默认值: false
请参阅佣金常见问题解答 了解更多信息。
symbolSTRINGYES
sideENUMYES详见枚举定义:订单方向
typeENUMYES详见枚举定义:订单类型
timeInForceENUMNO详见枚举定义:生效时间
quantityDECIMALNO
quoteOrderQtyDECIMALNO
priceDECIMALNO
newClientOrderIdSTRINGNO用户自定义的orderid,如空缺系统会自动赋值。
strategyIdLONGNO
strategyTypeINTNO不能低于 1000000。
stopPriceDECIMALNO仅 STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT 需要此参数。
trailingDeltaLONGNO参见 追踪止盈止损(Trailing Stop)订单常见问题
icebergQtyDECIMALNO仅有限价单(包括条件限价单与限价做事单)可以使用该参数,含义为创建冰山订单并指定冰山订单的数量。
newOrderRespTypeENUMNO指定响应类型 ACK, RESULT, or FULL; MARKET 与 LIMIT 订单默认为FULL, 其他默认为ACK。
selfTradePreventionModeENUMNO允许的 ENUM 取决于交易对的配置。支持的值有:STP 模式。
pegPriceTypeENUMNOPRIMARY_PEG 或 MARKET_PEG。 参阅 关于挂钩订单参数的注意事项
pegOffsetValueINTNO用于挂钩的价格水平(最大值:100)。 参阅 关于挂钩订单参数的注意事项
pegOffsetTypeENUMNO仅支持 PRICE_LEVEL。 参阅 关于挂钩订单参数的注意事项
recvWindowDECIMALNO最大值为 60000 毫秒。 支持最多三位小数的精度(例如 6000.346),以便可以指定微秒。
timestampLONGYES用于请求签名的 Unix 时间戳,单位为毫秒或微秒。该值必须反映客户端当前时间,并会在签名接口中由服务器进行校验。

数据源: 缓存

响应:

没有 computeCommissionRates

{}

有 computeCommissionRates

{
// 订单交易的标准佣金率
"standardCommissionForOrder": {
"maker": "0.00000112",
"taker": "0.00000114"
},
// 订单交易的特殊佣金率
"specialCommissionForOrder": {
"maker": "0.05000000",
"taker": "0.06000000"
},
// 订单交易的税率
"taxCommissionForOrder": {
"maker": "0.00000112",
"taker": "0.00000114"
},
// 以BNB支付时的标准佣金折扣。
"discount": {
"enabledForAccount": true,
"enabledForSymbol": true,
"discountAsset": "BNB",
"discount": "0.25000000"
}
}

撤销订单 (TRADE)​

DELETE /api/v3/order

撤销订单.

权重: 1

参数:

名称类型是否必须描述
symbolSTRINGYES
orderIdLONGNO
origClientOrderIdSTRINGNO
newClientOrderIdSTRINGNO用户自定义的本次撤销操作的ID(注意不是被撤销的订单的自定义ID)。如无指定会自动赋值。
cancelRestrictionsENUMNO支持的值:
ONLY_NEW - 如果订单状态为 NEW,撤销将成功。
ONLY_PARTIALLY_FILLED - 如果订单状态为 PARTIALLY_FILLED,撤销将成功。 请参阅关于 cancelRestrictions 了解更多信息。
recvWindowDECIMALNO最大值: 60000。
支持最多三位小数的精度(例如 6000.346),以便可以指定微秒。
timestampLONGYES用于请求签名的 Unix 时间戳,单位为毫秒或微秒。该值必须反映客户端当前时间,并会在签名接口中由服务器进行校验。

数据源: 撮合引擎

  • orderId 与 origClientOrderId 必须至少发送一个。
  • 当同时提供 orderId 和 origClientOrderId 两个参数时,系统首先将会使用 orderId 来搜索订单。然后, 查找结果中的 origClientOrderId 的值将会被用来验证订单。如果两个条件都不满足,则请求将被拒绝。

响应:

{
"symbol": "LTCBTC",
"orderId": 4,
"orderListId": -1, // 除非此单是订单列表的一部分, 否则此值为 -1
"origClientOrderId": "myOrder1",
"clientOrderId": "cancelMyOrder1",
"transactTime": 1684804350068,
"price": "2.00000000",
"origQty": "1.00000000",
"executedQty": "0.00000000",
"origQuoteOrderQty": "0.000000",
"cummulativeQuoteQty": "0.00000000",
"status": "CANCELED",
"timeInForce": "GTC",
"type": "LIMIT",
"side": "BUY",
"selfTradePreventionMode": "NONE",
"icebergQty": "0.00000000", // 冰山订单数量。仅当请求中发送了 `icebergQty` 参数时返回。
"preventedMatchId": 0, // 与 `symbol` 搭配时可用于查询 prevented match。仅当订单因 STP 过期时返回。
"preventedQuantity": "1.200000", // 因 STP 过期的订单数量。仅当订单因 STP 过期时返回。
"stopPrice": "23500.00000000", // 算法订单触发价格。适用于 `STOP_LOSS`、`TAKE_PROFIT`、`STOP_LOSS_LIMIT` 和 `TAKE_PROFIT_LIMIT` 订单。
"strategyId": 37463720, // 可用于标记订单策略中的订单。仅当请求中传入该参数时返回。
"strategyType": 1000000, // 可用于标记使用订单策略的订单。仅当请求中传入该参数时返回。
"trailingDelta": 10, // 订单激活前所需的价格变动幅度。适用于追踪止损订单。
"trailingTime": -1, // 追踪订单激活并开始跟踪价格变化的时间。仅适用于追踪止损订单。
"usedSor": true, // 表示订单是否使用了 SOR。仅在使用 SOR 下单时返回。
"workingFloor": "SOR", // 表示订单由 SOR 撮合还是由提交到的订单簿撮合。仅在使用 SOR 下单时返回。
"pegPriceType": "PRIMARY_PEG", // Peg 价格类型。仅适用于 pegged 订单。
"pegOffsetType": "PRICE_LEVEL", // Peg 价格偏移类型。仅适用于请求了该字段的 pegged 订单。
"pegOffsetValue": 5, // Peg 价格偏移值。仅适用于请求了该字段的 pegged 订单。
"peggedPrice": "87523.83710000", // 订单当前 peg 到的价格。仅适用于已确定 peg 价格的订单。
"expiryReason": "INSUFFICIENT_LIQUIDITY" // 订单过期原因。仅当订单已过期时返回。
}

注意:

  • 上面的 payload 没有显示所有可以出现的字段,更多请看 订单响应中的特定条件时才会出现的字段 部分。
  • 当仅发送 orderId 时,取消订单的执行(单个 Cancel 或作为 Cancel-Replace 的一部分)总是更快。发送 origClientOrderId 或同时发送 orderId + origClientOrderId 会稍慢。

关于 cancelRestrictions

  • 如果 cancelRestrictions 值不是任何受支持的值,则错误将是:
{
"code": -1145,
"msg": "Invalid cancelRestrictions"
}
  • 如果订单没有通过 cancelRestrictions 的条件,错误将是:
{
"code": -2011,
"msg": "Order was not canceled due to cancel restrictions."
}

撤销单一交易对的所有挂单 (TRADE)​

DELETE /api/v3/openOrders

撤销单一交易对下所有挂单。这也包括了来自订单列表的挂单。

权重: 1

参数:

名称类型是否必须描述
symbolSTRINGYES
recvWindowDECIMALNO最大值: 60000。
支持最多三位小数的精度(例如 6000.346),以便可以指定微秒。
timestampLONGYES用于请求签名的 Unix 时间戳,单位为毫秒或微秒。该值必须反映客户端当前时间,并会在签名接口中由服务器进行校验。

数据源: 撮合引擎

响应:

[
{
"symbol": "BTCUSDT",
"origClientOrderId": "E6APeyTJvkMvLMYMqu1KQ4",
"orderId": 11,
"orderListId": -1,
"clientOrderId": "pXLV6Hz6mprAcVYpVMTGgx",
"transactTime": 1684804350068,
"price": "0.089853",
"origQty": "0.178622",
"executedQty": "0.000000",
"origQuoteOrderQty": "0.000000",
"cummulativeQuoteQty": "0.000000",
"status": "CANCELED",
"timeInForce": "GTC",
"type": "LIMIT",
"side": "BUY",
"selfTradePreventionMode": "NONE"
},
{
"symbol": "BTCUSDT",
"origClientOrderId": "A3EF2HCwxgZPFMrfwbgrhv",
"orderId": 13,
"orderListId": -1,
"clientOrderId": "pXLV6Hz6mprAcVYpVMTGgx",
"transactTime": 1684804350069,
"price": "0.090430",
"origQty": "0.178622",
"executedQty": "0.000000",
"origQuoteOrderQty": "0.000000",
"cummulativeQuoteQty": "0.000000",
"status": "CANCELED",
"timeInForce": "GTC",
"type": "LIMIT",
"side": "BUY",
"selfTradePreventionMode": "NONE"
},
{
"orderListId": 1929,
"contingencyType": "OCO",
"listStatusType": "ALL_DONE",
"listOrderStatus": "ALL_DONE",
"listClientOrderId": "2inzWQdDvZLHbbAmAozX2N",
"transactionTime": 1585230948299,
"symbol": "BTCUSDT",
"orders": [
{
"symbol": "BTCUSDT",
"orderId": 20,
"clientOrderId": "CwOOIPHSmYywx6jZX77TdL"
},
{
"symbol": "BTCUSDT",
"orderId": 21,
"clientOrderId": "461cPg51vQjV3zIMOXNz39"
}
],
"orderReports": [
{
"symbol": "BTCUSDT",
"origClientOrderId": "CwOOIPHSmYywx6jZX77TdL",
"orderId": 20,
"orderListId": 1929,
"clientOrderId": "pXLV6Hz6mprAcVYpVMTGgx",
"transactTime": 1688005070874,
"price": "0.668611",
"origQty": "0.690354",
"executedQty": "0.000000",
"origQuoteOrderQty": "0.000000",
"cummulativeQuoteQty": "0.000000",
"status": "CANCELED",
"timeInForce": "GTC",
"type": "STOP_LOSS_LIMIT",
"side": "BUY",
"stopPrice": "0.378131",
"icebergQty": "0.017083",
"selfTradePreventionMode": "NONE"
},
{
"symbol": "BTCUSDT",
"origClientOrderId": "461cPg51vQjV3zIMOXNz39",
"orderId": 21,
"orderListId": 1929,
"clientOrderId": "pXLV6Hz6mprAcVYpVMTGgx",
"transactTime": 1688005070874,
"price": "0.008791",
"origQty": "0.690354",
"executedQty": "0.000000",
"origQuoteOrderQty": "0.000000",
"cummulativeQuoteQty": "0.000000",
"status": "CANCELED",
"timeInForce": "GTC",
"type": "LIMIT_MAKER",
"side": "BUY",
"icebergQty": "0.639962",
"selfTradePreventionMode": "NONE"
}
]
}
]

撤消挂单再下单 (TRADE)​

POST /api/v3/order/cancelReplace
  • 撤消挂单并在同个交易对上重新下单。
  • 在撤消订单和下单前会判断: 1) 过滤器参数, 以及 2) 目前下单数量。
  • 即使请求中没有尝试发送新订单,比如(newOrderResult: NOT_ATTEMPTED),未成交订单的数量仍然会加1。
  • 通过此接口只能撤消订单列表中的单个订单,但结果与撤消整个订单列表相同。

权重: 1

未成交的订单计数: 1

参数:

名称类型是否必须描述
symbolSTRINGYES
sideENUMYES
typeENUMYES
cancelReplaceModeENUMYES指定类型:STOP_ON_FAILURE - 如果撤消订单失败将不会继续重新下单。
ALLOW_FAILURE - 不管撤消订单是否成功都会继续重新下单。
timeInForceENUMNO
quantityDECIMALNO
quoteOrderQtyDECIMALNO
priceDECIMALNO
cancelNewClientOrderIdSTRINGNO用户自定义的id,如空缺系统会自动赋值
cancelOrigClientOrderIdSTRINGNO必须提供 cancelOrderId 或者 cancelOrigClientOrderId。

当同时提供 cancelOrderId 和 cancelOrigClientOrderId 两个参数时,系统首先将会使用 cancelOrderId 来搜索订单。

然后, 查找结果中的 cancelOrigClientOrderId 的值将会被用来验证订单。

如果两个条件都不满足,则请求将被拒绝。
cancelOrderIdLONGNO必须提供 cancelOrderId 或者 cancelOrigClientOrderId。

当同时提供 cancelOrderId 和 cancelOrigClientOrderId 两个参数时,系统首先将会使用 cancelOrderId 来搜索订单。

然后, 查找结果中的 cancelOrigClientOrderId 的值将会被用来验证订单。

如果两个条件都不满足,则请求将被拒绝。
newClientOrderIdSTRINGNO用于辨识新订单。
strategyIdLONGNO
strategyTypeINTNO不能低于 1000000。
stopPriceDECIMALNO
trailingDeltaLONGNO参考 追踪止盈止损(Trailing Stop)订单常见问题
icebergQtyDECIMALNO
newOrderRespTypeENUMNO指定响应类型:
指定响应类型 ACK, RESULT, or FULL; MARKET 与 LIMIT 订单默认为FULL, 其他默认为ACK。
selfTradePreventionModeENUMNO允许的 ENUM 取决于交易对的配置。支持的值有:STP 模式。
cancelRestrictionsENUMNO支持的值:
ONLY_NEW - 如果订单状态为 NEW,撤销将成功。
ONLY_PARTIALLY_FILLED - 如果订单状态为 PARTIALLY_FILLED,撤销将成功。 请参阅关于 cancelRestrictions 了解更多信息。
orderRateLimitExceededModeENUMNO支持的值:

DO_NOTHING(默认值)- 仅在账户未超过未成交订单频率限制时,会尝试取消订单。

CANCEL_ONLY - 将始终取消订单。
pegPriceTypeENUMNOPRIMARY_PEG 或 MARKET_PEG。
参阅 关于挂钩订单参数的注意事项
pegOffsetValueINTNO用于挂钩的价格水平(最大值:100)。
参阅 关于挂钩订单参数的注意事项
pegOffsetTypeENUMNO仅支持 PRICE_LEVEL。
参阅 关于挂钩订单参数的注意事项
recvWindowDECIMALNO最大值为 60000 毫秒。
支持最多三位小数的精度(例如 6000.346),以便可以指定微秒。
timestampLONGYES用于请求签名的 Unix 时间戳,单位为毫秒或微秒。该值必须反映客户端当前时间,并会在签名接口中由服务器进行校验。

数据源: 撮合引擎

如同 POST /api/v3/order,额外的强制参数取决于 type 。 响应格式根据消息的处理是成功、部分成功还是失败而有所不同。

请求 响应
cancelReplaceMode orderRateLimitExceededMode 未成交订单数 cancelResult newOrderResult status
STOP_ON_FAILURE DO_NOTHING 在限制范围内 ✅ SUCCESS ✅ SUCCESS 200
❌ FAILURE ➖ NOT_ATTEMPTED 400
✅ SUCCESS ❌ FAILURE 409
超出限制范围 ✅ SUCCESS ✅ SUCCESS N/A
❌ FAILURE ➖ NOT_ATTEMPTED N/A
✅ SUCCESS ❌ FAILURE N/A
CANCEL_ONLY 在限制范围内 ✅ SUCCESS ✅ SUCCESS 200
❌ FAILURE ➖ NOT_ATTEMPTED 400
✅ SUCCESS ❌ FAILURE 409
超出限制范围 ❌ FAILURE ➖ NOT_ATTEMPTED 429
✅ SUCCESS ❌ FAILURE 429
ALLOW_FAILURE DO_NOTHING 在限制范围内 ✅ SUCCESS ✅ SUCCESS 200
❌ FAILURE ❌ FAILURE 400
❌ FAILURE ✅ SUCCESS 409
✅ SUCCESS ❌ FAILURE 409
超出限制范围 ✅ SUCCESS ✅ SUCCESS N/A
❌ FAILURE ❌ FAILURE N/A
❌ FAILURE ✅ SUCCESS N/A
✅ SUCCESS ❌ FAILURE N/A
CANCEL_ONLY 在限制范围内 ✅ SUCCESS ✅ SUCCESS 200
❌ FAILURE ❌ FAILURE 400
❌ FAILURE ✅ SUCCESS 409
✅ SUCCESS ❌ FAILURE 409
超出限制范围 ✅ SUCCESS ✅ SUCCESS N/A
❌ FAILURE ❌ FAILURE 400
❌ FAILURE ✅ SUCCESS N/A
✅ SUCCESS ❌ FAILURE 409

响应:

撤单和下单都成功,而且账户没有超出未成交订单计数时:

{
"cancelResult": "SUCCESS",
"newOrderResult": "SUCCESS",
"cancelResponse": {
"symbol": "BTCUSDT",
"origClientOrderId": "DnLo3vTAQcjha43lAZhZ0y", // 请求的 cancelOrigClientOrderId
"orderId": 9,
"orderListId": -1, // 除非此单是订单列表的一部分, 否则此值为 -1
"clientOrderId": "osxN3JXAtJvKvCqGeMWMVR", // 请求的 cancelNewClientOrderId
"transactTime": 1684804350068,
"price": "0.01000000",
"origQty": "0.000100",
"executedQty": "0.00000000",
"origQuoteOrderQty": "0.000000",
"cummulativeQuoteQty": "0.00000000",
"status": "CANCELED",
"timeInForce": "GTC",
"type": "LIMIT",
"side": "SELL",
"selfTradePreventionMode": "NONE",
"icebergQty": "0.00000000", // 仅在请求中发送了 icebergQty 参数时出现。
"preventedMatchId": 0, // 仅在因 STP 导致订单失效时出现。
"preventedQuantity": "1.200000", // 因 STP 导致订单失效的数量。
"stopPrice": "0.00000000", // 出现在 STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT 和 TAKE_PROFIT_LIMIT 订单中。
"strategyId": 1, // 仅在下单时提供了 strategyId 参数时出现。
"strategyType": 1000000, // 仅在下单时提供了 strategyType 参数时出现。
"trailingDelta": 10, // 订单激活前所需的价格变动。
"trailingTime": -1, // 追踪单被激活和跟踪价格变化的时间。
"usedSor": true, // 用于确定订单是否使用SOR的字段。
"workingFloor": "SOR", // 用以定义订单是通过 SOR 还是由订单簿成交的。
"pegPriceType": "PRIMARY_PEG", // 挂钩价格类型。仅用于挂钩订单。
"pegOffsetType": "PRICE_LEVEL", // 挂钩价格偏移类型。如若需要,仅用于挂钩订单。
"pegOffsetValue": 5, // 挂钩价格偏移值。如若需要,仅用于挂钩订单。
"peggedPrice": "87523.83710000", // 订单对应的当前挂钩价格。一旦确定,仅用于挂钩订单。
"expiryReason": "INSUFFICIENT_LIQUIDITY" // 订单过期的原因。当订单过期时出现。
},
"newOrderResponse": {
"symbol": "BTCUSDT",
"orderId": 10,
"orderListId": -1, // 除非此单是订单列表的一部分, 否则此值为 -1
"clientOrderId": "wOceeeOzNORyLiQfw7jd8S",
"transactTime": 1652928801803,
"price": "0.02000000",
"origQty": "0.040000",
"executedQty": "0.00000000",
"origQuoteOrderQty": "0.000000",
"cummulativeQuoteQty": "0.00000000",
"status": "NEW",
"timeInForce": "GTC",
"type": "LIMIT",
"side": "BUY",
"workingTime": 1669277163808,
"fills": [],
"selfTradePreventionMode": "NONE",
"icebergQty": "0.00000000", // 仅在请求中发送了 icebergQty 参数时出现。
"preventedMatchId": 0, // 仅在因 STP 导致订单失效时出现。
"preventedQuantity": "1.200000", // 因 STP 导致订单失效的数量。
"stopPrice": "0.00000000", // 出现在 STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT 和 TAKE_PROFIT_LIMIT 订单中。
"strategyId": 1, // 仅在下单时提供了 strategyId 参数时出现。
"strategyType": 1000000, // 仅在下单时提供了 strategyType 参数时出现。
"trailingDelta": 10, // 订单激活前所需的价格变动。
"trailingTime": -1, // 追踪单被激活和跟踪价格变化的时间。
"usedSor": true, // 用于确定订单是否使用SOR的字段。
"workingFloor": "SOR", // 用以定义订单是通过 SOR 还是由订单簿成交的。
"pegPriceType": "PRIMARY_PEG", // 挂钩价格类型。仅用于挂钩订单。
"pegOffsetType": "PRICE_LEVEL", // 挂钩价格偏移类型。如若需要,仅用于挂钩订单。
"pegOffsetValue": 5, // 挂钩价格偏移值。如若需要,仅用于挂钩订单。
"peggedPrice": "87523.83710000", // 订单对应的当前挂钩价格。一旦确定,仅用于挂钩订单。
"expiryReason": "INSUFFICIENT_LIQUIDITY" // 订单过期的原因。当订单过期时出现。
}
}

选择了 STOP_ON_FAILURE 而且账户没有超出未成交订单计数时, 撤单出现错误:

{
"code": -2022,
"msg": "Order cancel-replace failed.",
"data": {
"cancelResult": "FAILURE",
"newOrderResult": "NOT_ATTEMPTED",
"cancelResponse": {
"code": -2011,
"msg": "Unknown order sent."
},
"newOrderResponse": null
}
}

选择 cancelReplaceMode=ALLOW_FAILURE 而且账户没有超出未成交订单计数时, 撤单和下单失败:

{
"code": -2022,
"msg": "Order cancel-replace failed.",
"data": {
"cancelResult": "FAILURE",
"newOrderResult": "FAILURE",
"cancelResponse": {
"code": -2011,
"msg": "Unknown order sent."
},
"newOrderResponse": {
"code": -2010,
"msg": "Order would immediately match and take."
}
}
}

撤单成功而且账户没有超出未成交订单计数时,下单失败:

{
"code": -2021,
"msg": "Order cancel-replace partially failed.",
"data": {
"cancelResult": "SUCCESS",
"newOrderResult": "FAILURE",
"cancelResponse": {
"symbol": "BTCUSDT",
"origClientOrderId": "86M8erehfExV8z2RC8Zo8k", // 请求的 cancelOrigClientOrderId
"orderId": 3,
"orderListId": -1,
"clientOrderId": "G1kLo6aDv2KGNTFcjfTSFq", // 请求的 cancelNewClientOrderId
"transactTime": 1684804350068,
"price": "0.006123",
"origQty": "10000.000000",
"executedQty": "0.000000",
"origQuoteOrderQty": "0.000000",
"cummulativeQuoteQty": "0.000000",
"status": "CANCELED",
"timeInForce": "GTC",
"type": "LIMIT_MAKER",
"side": "SELL",
"selfTradePreventionMode": "NONE"
},
"newOrderResponse": {
"code": -2010,
"msg": "Order would immediately match and take."
}
}
}

选择 ALLOW_FAILURE 而且账户没有超出未成交订单计数时, 撤单出现错误:

{
"code": -2021,
"msg": "Order cancel-replace partially failed.",
"data": {
"cancelResult": "FAILURE",
"newOrderResult": "SUCCESS",
"cancelResponse": {
"code": -2011,
"msg": "Unknown order sent."
},
"newOrderResponse": {
"symbol": "BTCUSDT",
"orderId": 11,
"orderListId": -1,
"clientOrderId": "pfojJMg6IMNDKuJqDxvoxN",
"transactTime": 1648540168818
}
}
}

选择 orderRateLimitExceededMode=CANCEL_ONLY 而且账户超出未成交订单计数时:

{
"code": -2021,
"msg": "Order cancel-replace partially failed.",
"data": {
"cancelResult": "SUCCESS",
"newOrderResult": "FAILURE",
"cancelResponse": {
"symbol": "LTCBNB",
"origClientOrderId": "GKt5zzfOxRDSQLveDYCTkc", // 请求的 cancelOrigClientOrderId
"orderId": 64,
"orderListId": -1,
"clientOrderId": "loehOJF3FjoreUBDmv739R", // 请求的 cancelNewClientOrderId
"transactTime": 1715779007228,
"price": "1.00",
"origQty": "10.00000000",
"executedQty": "0.00000000",
"origQuoteOrderQty": "0.000000",
"cummulativeQuoteQty": "0.00",
"status": "CANCELED",
"timeInForce": "GTC",
"type": "LIMIT",
"side": "SELL",
"selfTradePreventionMode": "NONE"
},
"newOrderResponse": {
"code": -1015,
"msg": "Too many new orders; current limit is 1 orders per 10 SECOND."
}
}
}

选择 orderRateLimitExceededMode=DO_NOTHING 而且账户超出未成交订单计数时:

{
"code": -1015,
"msg": "Too many new orders; current limit is 1 orders per 10 SECOND."
}

注意:

  • 上面的 payload 没有显示所有可以出现的字段,更多请看 订单响应中的特定条件时才会出现的字段 部分。
  • 当仅发送 orderId 时,取消订单的执行(单个 Cancel 或作为 Cancel-Replace 的一部分)总是更快。发送 origClientOrderId 或同时发送 orderId + origClientOrderId 会稍慢。

修改订单并保留优先级 (TRADE)​

PUT /api/v3/order/amend/keepPriority

由客户发送以减少其现有当前订单的原始数量。

这个请求将添加0个订单到 EXCHANGE_MAX_ORDERS 过滤器和 MAX_NUM_ORDERS 过滤器中。

请阅读 保留优先权的修改订单常见问题 了解更多信息。

权重: 4

未成交的订单计数: 0

参数:

名称类型是否必须描述
symbolSTRINGYES
orderIdLONGNO需提供 orderId 或 origClientOrderId。
origClientOrderIdSTRINGNO需提供 orderId 或 origClientOrderId。
newClientOrderIdSTRINGNO订单在被修改后被赋予的新 client order ID。
如果未发送则自动生成。
可以将当前 clientOrderId 作为 newClientOrderId 发送来重用当前 clientOrderId 的值。
newQtyDECIMALYES交易的新数量。 newQty 必须大于0, 但是必须比订单的原始数量小。
recvWindowDECIMALNO最大值为 60000 毫秒。
支持最多三位小数的精度(例如 6000.346),以便可以指定微秒。
timestampLONGYES用于请求签名的 Unix 时间戳,单位为毫秒或微秒。该值必须反映客户端当前时间,并会在签名接口中由服务器进行校验。

数据源: 撮合引擎

响应:

来自单个订单的响应:

{
"transactTime": 1741926410255,
"executionId": 75,
"amendedOrder": {
"symbol": "BTCUSDT",
"orderId": 33,
"orderListId": -1,
"origClientOrderId": "5xrgbMyg6z36NzBn2pbT8H",
"clientOrderId": "PFaq6hIHxqFENGfdtn4J6Q",
"price": "6.00000000",
"qty": "5.00000000",
"executedQty": "0.00000000",
"preventedQty": "0.00000000",
"quoteOrderQty": "0.00000000",
"cumulativeQuoteQty": "0.00000000",
"status": "NEW",
"timeInForce": "GTC",
"type": "LIMIT",
"side": "SELL",
"workingTime": 1741926410242,
"selfTradePreventionMode": "NONE"
}
}

来自订单列表中单个订单的响应:

{
"transactTime": 1741926410255,
"executionId": 75,
"amendedOrder": {
"symbol": "BTCUSDT",
"orderId": 33,
"orderListId": -1,
"origClientOrderId": "5xrgbMyg6z36NzBn2pbT8H",
"clientOrderId": "PFaq6hIHxqFENGfdtn4J6Q",
"price": "6.00000000",
"qty": "5.00000000",
"executedQty": "0.00000000",
"preventedQty": "0.00000000",
"quoteOrderQty": "0.00000000",
"cumulativeQuoteQty": "0.00000000",
"status": "NEW",
"timeInForce": "GTC",
"type": "LIMIT",
"side": "SELL",
"workingTime": 1741926410242,
"selfTradePreventionMode": "NONE",
"icebergQty": "0.00000000", // 仅在请求中发送了 icebergQty 参数时出现。
"preventedMatchId": 0, // 仅在因 STP 导致订单失效时出现。
"preventedQuantity": "1.200000", // 因 STP 导致订单失效的数量。
"stopPrice": "0.00000000", // 出现在 STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT 和 TAKE_PROFIT_LIMIT 订单中。
"strategyId": 1, // 仅在下单时提供了 strategyId 参数时出现。
"strategyType": 1000000, // 仅在下单时提供了 strategyType 参数时出现。
"trailingDelta": 10, // 订单激活前所需的价格变动。
"trailingTime": -1, // 追踪单被激活和跟踪价格变化的时间。
"usedSor": true, // 用于确定订单是否使用SOR的字段。
"workingFloor": "SOR", // 用以定义订单是通过 SOR 还是由订单簿成交的。
"pegPriceType": "PRIMARY_PEG", // 挂钩价格类型。仅用于挂钩订单。
"pegOffsetType": "PRICE_LEVEL", // 挂钩价格偏移类型。如若需要,仅用于挂钩订单。
"pegOffsetValue": 5, // 挂钩价格偏移值。如若需要,仅用于挂钩订单。
"peggedPrice": "87523.83710000", // 订单对应的当前挂钩价格。一旦确定,仅用于挂钩订单。
"expiryReason": "INSUFFICIENT_LIQUIDITY" // 订单过期的原因。当订单过期时出现。
},
"listStatus": {
"orderListId": 1,
"contingencyType": "OTO",
"listOrderStatus": "EXECUTING",
"listClientOrderId": "AT7FTxZXylVSwRoZs52mt3",
"symbol": "BTCUSDT",
"orders": [
{
"symbol": "BTCUSDT",
"orderId": 8,
"clientOrderId": "GkwwHZUUbFtZOoH1YsZk9Q"
},
{
"symbol": "BTCUSDT",
"orderId": 9,
"clientOrderId": "UQ1Np3bmQ71jJzsSDW9Vpi"
}
]
}
}

注意: 上面的 payload 没有显示所有可以出现的字段,更多请看 订单响应中的特定条件时才会出现的字段 部分。

发送新 OCO 订单 - 已弃用 (TRADE)​

POST /api/v3/order/oco

发送新的 OCO。

  • 价格限制:
    • SELL: Limit price > 最后交易价格 > stop Price
    • BUY: Limit price < 最后交易价格 < stop Price
  • 数量限制:
    • 两条腿的数量必须相同。
    • 不过, 冰山 交易的数量不一定相同
  • OCO 将2个订单添加到 EXCHANGE_MAX_ORDERS 过滤器和 MAX_NUM_ORDERS 过滤器中。

权重: 1

未成交的订单计数: 2

参数:

名称类型是否必须描述
symbolSTRINGYES
listClientOrderIdSTRINGNO整个orderList的唯一ID
sideENUMYES
quantityDECIMALYES
limitClientOrderIdSTRINGNO限价单的唯一ID
priceDECIMALYES
limitStrategyIdLONGNO
limitStrategyTypeINTNO不能低于 1000000
limitIcebergQtyDECIMALNO用于使 LIMIT_MAKER 腿单成为冰山订单。
trailingDeltaLONGNO
stopClientOrderIdSTRINGNO止损/止损限价单的唯一ID
stopPriceDECIMALYES
stopStrategyIdLONGNO
stopStrategyTypeINTNO不能低于 1000000
stopLimitPriceDECIMALNO如果提供,须配合提交stopLimitTimeInForce
stopIcebergQtyDECIMALNO与 STOP_LOSS_LIMIT 腿单一起使用,使其成为冰山订单。
stopLimitTimeInForceENUMNO有效值 GTC/FOK/IOC
newOrderRespTypeENUMNOJSON 响应格式。支持的数值:订单返回类型
selfTradePreventionModeENUMNO允许的值取决于交易对的配置。支持的数值:STP模式
recvWindowDECIMALNO最大值为 60000 毫秒。
支持最多三位小数的精度(例如 6000.346),以便可以指定微秒。
timestampLONGYES用于请求签名的 Unix 时间戳,单位为毫秒或微秒。该值必须反映客户端当前时间,并会在签名接口中由服务器进行校验。

数据源: 撮合引擎

响应:

{
"orderListId": 0,
"contingencyType": "OCO",
"listStatusType": "EXEC_STARTED",
"listOrderStatus": "EXECUTING",
"listClientOrderId": "JYVpp3F0f5CAG15DhtrqLp",
"transactionTime": 1563417480525,
"symbol": "LTCBTC",
"orders": [
{
"symbol": "LTCBTC",
"orderId": 2,
"clientOrderId": "Kk7sqHb9J6mJWTMDVW7Vos"
},
{
"symbol": "LTCBTC",
"orderId": 3,
"clientOrderId": "xTXKaGYd4bluPVp78IVRvl"
}
],
"orderReports": [
{
"symbol": "LTCBTC",
"orderId": 2,
"orderListId": 0,
"clientOrderId": "Kk7sqHb9J6mJWTMDVW7Vos",
"transactTime": 1563417480525,
"price": "0.000000",
"origQty": "0.624363",
"executedQty": "0.000000",
"origQuoteOrderQty": "0.000000",
"cummulativeQuoteQty": "0.000000",
"status": "NEW",
"timeInForce": "GTC",
"type": "STOP_LOSS",
"side": "BUY",
"stopPrice": "0.960664",
"workingTime": -1,
"selfTradePreventionMode": "NONE"
},
{
"symbol": "LTCBTC",
"orderId": 3,
"orderListId": 0,
"clientOrderId": "xTXKaGYd4bluPVp78IVRvl",
"transactTime": 1563417480525,
"price": "0.036435",
"origQty": "0.624363",
"executedQty": "0.000000",
"origQuoteOrderQty": "0.000000",
"cummulativeQuoteQty": "0.000000",
"status": "NEW",
"timeInForce": "GTC",
"type": "LIMIT_MAKER",
"side": "BUY",
"workingTime": 1563417480525,
"selfTradePreventionMode": "NONE"
}
]
}

新订单列表 - OCO (TRADE)​

POST /api/v3/orderList/oco

发送新 one-cancels-the-other (OCO) 订单,激活其中一个订单会立即取消另一个订单。

  • OCO 包含了两个订单,分别被称为 上方订单 和 下方订单。
  • 其中一个订单必须是 LIMIT_MAKER/TAKE_PROFIT/TAKE_PROFIT_LIMIT 订单,另一个订单必须是 STOP_LOSS 或 STOP_LOSS_LIMIT 订单。
  • 针对价格限制:
    • 如果 OCO 订单方向是 SELL:
      • LIMIT_MAKER/TAKE_PROFIT_LIMIT price > 最后交易价格 > STOP_LOSS/STOP_LOSS_LIMIT stopPrice
      • TAKE_PROFIT stopPrice > 最后交易价格 > STOP_LOSS/STOP_LOSS_LIMIT stopPrice
    • 如果 OCO 订单方向是 BUY:
      • LIMIT_MAKER/TAKE_PROFIT_LIMIT price < 最后交易价格 < stopPrice
      • TAKE_PROFIT stopPrice < 最后交易价格 < STOP_LOSS/STOP_LOSS_LIMIT stopPrice
  • OCO 会添加 2个订单 到 EXCHANGE_MAX_ORDERS 过滤器和 MAX_NUM_ORDERS 过滤器中。

权重: 1

未成交的订单计数: 2

参数:

名称类型是否必须描述
symbolSTRINGYES
listClientOrderIdSTRINGNO整个 OCO order list 的唯一ID。 如果未发送则自动生成。 仅当前一个订单已填满或完全过期时,才会接受具有相同的listClientOrderId。 listClientOrderId 与 aboveClientOrderId 和 belowClientOrderId 不同。
sideENUMYES
quantityDECIMALYES两个订单的数量。
aboveTypeENUMYES
aboveClientOrderIdSTRINGNO上方订单的唯一ID。 如果未发送则自动生成。
aboveIcebergQtyLONGNO请注意,只有当 aboveTimeInForce 为 GTC 时才能使用。
abovePriceDECIMALNO当 aboveType 是 STOP_LOSS_LIMIT, LIMIT_MAKER 或 TAKE_PROFIT_LIMIT 时,可用以指定限价。
aboveStopPriceDECIMALNO如果 aboveType 是 STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT 或 TAKE_PROFIT_LIMIT 才能使用。 必须指定 aboveStopPrice 或 aboveTrailingDelta 或两者。
aboveTrailingDeltaLONGNO请看 追踪止盈止损(Trailing Stop)订单常见问题
aboveTimeInForceENUMNO如果 aboveType 是 STOP_LOSS_LIMIT 或 TAKE_PROFIT_LIMIT,则为必填项。
aboveStrategyIdLONGNO订单策略中上方订单的 ID。
aboveStrategyTypeINTNO上方订单策略的任意数值。小于 1000000 的值被保留,无法使用。
abovePegPriceTypeENUMNOPRIMARY_PEG 或 MARKET_PEG。 参阅 关于挂钩订单参数的注意事项
abovePegOffsetTypeENUMNO
abovePegOffsetValueINTNO
belowTypeENUMYES支持值:STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT。
belowClientOrderIdSTRINGNO下方订单的唯一ID。 如果未发送则自动生成。
belowIcebergQtyLONGNO请注意,只有当 belowTimeInForce 为 GTC 时才能使用。
belowPriceDECIMALNO当 belowType 是 STOP_LOSS_LIMIT, LIMIT_MAKER 或 TAKE_PROFIT_LIMIT 时,可用以指定限价。
belowStopPriceDECIMALNO如果 belowType 是 STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT 或 TAKE_PROFIT_LIMIT 才能使用。 必须指定 belowStopPrice 或 belowTrailingDelta 或两者。
belowTrailingDeltaLONGNO请看 追踪止盈止损(Trailing Stop)订单常见问题
belowTimeInForceENUMNO如果 belowType 是 STOP_LOSS_LIMIT 或 TAKE_PROFIT_LIMIT,则为必须配合提交的值。
belowStrategyIdLONGNO订单策略中下方订单的 ID。
belowStrategyTypeINTNO下方订单策略的任意数值。小于 1000000 的值被保留,无法使用。
belowPegPriceTypeENUMNO参阅 关于挂钩订单参数的注意事项
belowPegOffsetTypeENUMNO
belowPegOffsetValueINTNO
newOrderRespTypeENUMNO响应格式可选值: ACK, RESULT, FULL。
selfTradePreventionModeENUMNO允许的 ENUM 取决于交易对上的配置。 支持值:STP 模式
recvWindowDECIMALNO最大值为 60000 毫秒。 支持最多三位小数的精度(例如 6000.346),以便可以指定微秒。
timestampLONGYES用于请求签名的 Unix 时间戳,单位为毫秒或微秒。该值必须反映客户端当前时间,并会在签名接口中由服务器进行校验。

数据源: 撮合引擎

响应:

{
"orderListId": 1,
"contingencyType": "OCO",
"listStatusType": "EXEC_STARTED",
"listOrderStatus": "EXECUTING",
"listClientOrderId": "lH1YDkuQKWiXVXHPSKYEIp",
"transactionTime": 1710485608839,
"symbol": "LTCBTC",
"orders": [
{
"symbol": "LTCBTC",
"orderId": 10,
"clientOrderId": "44nZvqpemY7sVYgPYbvPih"
},
{
"symbol": "LTCBTC",
"orderId": 11,
"clientOrderId": "NuMp0nVYnciDiFmVqfpBqK"
}
],
"orderReports": [
{
"symbol": "LTCBTC",
"orderId": 10,
"orderListId": 1,
"clientOrderId": "44nZvqpemY7sVYgPYbvPih",
"transactTime": 1710485608839,
"price": "1.00000000",
"origQty": "5.00000000",
"executedQty": "0.00000000",
"origQuoteOrderQty": "0.000000",
"cummulativeQuoteQty": "0.00000000",
"status": "NEW",
"timeInForce": "GTC",
"type": "STOP_LOSS_LIMIT",
"side": "SELL",
"stopPrice": "1.00000000",
"workingTime": -1,
"icebergQty": "1.00000000",
"selfTradePreventionMode": "NONE"
},
{
"symbol": "LTCBTC",
"orderId": 11,
"orderListId": 1,
"clientOrderId": "NuMp0nVYnciDiFmVqfpBqK",
"transactTime": 1710485608839,
"price": "3.00000000",
"origQty": "5.00000000",
"executedQty": "0.00000000",
"origQuoteOrderQty": "0.000000",
"cummulativeQuoteQty": "0.00000000",
"status": "NEW",
"timeInForce": "GTC",
"type": "LIMIT_MAKER",
"side": "SELL",
"workingTime": 1710485608839,
"selfTradePreventionMode": "NONE"
}
]
}

新订单列表 - OTO (TRADE)​

POST /api/v3/orderList/oto

发送一个新的 OTO 订单。

  • 一个 OTO 订单(One-Triggers-the-Other)是一个包含了两个订单的订单列表.
  • 第一个订单被称为生效订单,必须为 LIMIT 或 LIMIT_MAKER 类型的订单。最初,订单簿上只有生效订单。
  • 第二个订单被称为待处理订单。它可以是任何订单类型,但不包括使用参数 quoteOrderQty 的 MARKET 订单。只有当生效订单完全成交时,待处理订单才会被自动下单。
  • 如果生效订单或者待处理订单中的任意一个被单独取消,订单列表中剩余的那个订单也会被随之取消或过期。
  • 如果生效订单在下订单列表后立即完全成交,则可能会得到订单响应。其中,生效订单的状态为 FILLED ,但待处理订单的状态为 PENDING_NEW。针对这类情况,如果需要检查当前状态,您可以查询相关的待处理订单。
  • OTO 订单将2 个订单添加到 EXCHANGE_MAX_NUM_ORDERS 过滤器和 MAX_NUM_ORDERS 过滤器中。

权重: 1

未成交的订单计数: 2

参数:

名称类型是否必须描述
symbolSTRINGYES
listClientOrderIdSTRINGNO整个订单列表的唯一ID。 如果未发送则自动生成。 仅当前一个订单列表已填满或完全过期时,才会接受含有相同 listClientOrderId 值的新订单列表。 listClientOrderId 与 workingClientOrderId 和 pendingClientOrderId 不同。
newOrderRespTypeENUMNO用于设置JSON响应的格式。 支持的数值: 订单返回类型
selfTradePreventionModeENUMNO允许的数值取决于交易对上的配置。参考 STP 模式
workingTypeENUMYES支持的数值: LIMIT, LIMIT_MAKER
workingSideENUMYES支持的数值: 订单方向
workingClientOrderIdSTRINGNO用于标识生效订单的唯一ID。 如果未发送则自动生成。
workingPriceDECIMALYES
workingQuantityDECIMALYES用于设置生效订单的数量。
workingIcebergQtyDECIMALNO仅当 workingTimeInForce 为 GTC 或 workingType 为 LIMIT_MAKER 时,才能使用此功能。
workingTimeInForceENUMNO支持的数值: 生效时间
workingStrategyIdLONGNO订单策略中用于标识生效订单的 ID。
workingStrategyTypeINTNO用于标识生效订单策略的任意数值。 小于 1000000 的值被保留,无法使用。
pendingTypeENUMYES支持的数值: 订单类型 请注意,系统不支持使用 quoteOrderQty 的 MARKET 订单。
workingPegPriceTypeENUMNO参阅 关于挂钩订单参数的注意事项
workingPegOffsetTypeENUMNO
workingPegOffsetValueINTNO
pendingSideENUMYES支持的数值: 订单方向
pendingClientOrderIdSTRINGNO用于标识待处理订单的唯一ID。 如果未发送则自动生成。
pendingPriceDECIMALNO
pendingStopPriceDECIMALNO
pendingTrailingDeltaDECIMALNO
pendingQuantityDECIMALYES用于设置待处理订单的数量。
pendingIcebergQtyDECIMALNO只有当 pendingTimeInForce 为 GTC 或者当 pendingType 为 LIMIT_MAKER 时才能使用。
pendingTimeInForceENUMNO支持的数值: 生效时间
pendingStrategyIdLONGNO订单策略中用于标识待处理订单的 ID。
pendingStrategyTypeINTNO用于标识待处理订单策略的任意数值。 小于 1000000 的值被保留,无法使用。
pendingPegPriceTypeENUMNO参阅 关于挂钩订单参数的注意事项
pendingPegOffsetTypeENUMNO
pendingPegOffsetValueINTNO
recvWindowDECIMALNO最大值为 60000 毫秒。 支持最多三位小数的精度(例如 6000.346),以便可以指定微秒。
timestampLONGYES用于请求签名的 Unix 时间戳,单位为毫秒或微秒。该值必须反映客户端当前时间,并会在签名接口中由服务器进行校验。

数据源: 撮合引擎

根据 pendingType 或者 workingType 的不同值,对于某些参数的强制要求

根据 pendingType 或者workingType的不同值,对于某些可选参数有强制要求,具体如下:

类型强制要求的参数其他信息
workingType = LIMITworkingTimeInForce
pendingType = LIMITpendingPrice, pendingTimeInForce
pendingType = STOP_LOSS 或 TAKE_PROFITpendingStopPrice 与/或 pendingTrailingDelta
pendingType = STOP_LOSS_LIMIT 或 TAKE_PROFIT_LIMITpendingPrice, pendingStopPrice 与/或 pendingTrailingDelta, pendingTimeInForce

响应:

{
"orderListId": 0,
"contingencyType": "OTO",
"listStatusType": "EXEC_STARTED",
"listOrderStatus": "EXECUTING",
"listClientOrderId": "yl2ERtcar1o25zcWtqVBTC",
"transactionTime": 1712289389158,
"symbol": "LTCBTC",
"orders": [
{
"symbol": "LTCBTC",
"orderId": 4,
"clientOrderId": "Bq17mn9fP6vyCn75Jw1xya"
},
{
"symbol": "LTCBTC",
"orderId": 5,
"clientOrderId": "arLFo0zGJVDE69cvGBaU0d"
}
],
"orderReports": [
{
"symbol": "LTCBTC",
"orderId": 4,
"orderListId": 0,
"clientOrderId": "Bq17mn9fP6vyCn75Jw1xya",
"transactTime": 1712289389158,
"price": "1.00000000",
"origQty": "1.00000000",
"executedQty": "0.00000000",
"origQuoteOrderQty": "0.000000",
"cummulativeQuoteQty": "0.00000000",
"status": "NEW",
"timeInForce": "GTC",
"type": "LIMIT",
"side": "SELL",
"workingTime": 1712289389158,
"selfTradePreventionMode": "NONE"
},
{
"symbol": "LTCBTC",
"orderId": 5,
"orderListId": 0,
"clientOrderId": "arLFo0zGJVDE69cvGBaU0d",
"transactTime": 1712289389158,
"price": "0.00000000",
"origQty": "5.00000000",
"executedQty": "0.00000000",
"origQuoteOrderQty": "0.000000",
"cummulativeQuoteQty": "0.00000000",
"status": "PENDING_NEW",
"timeInForce": "GTC",
"type": "MARKET",
"side": "BUY",
"workingTime": -1,
"selfTradePreventionMode": "NONE"
}
]
}

注意: 上面的 payload 没有显示所有可以出现的字段,更多请看 订单响应中的特定条件时才会出现的字段 部分。

新订单列表 - OTOCO (TRADE)​

POST /api/v3/orderList/otoco

发送一个新的 OTOCO 订单。

  • 一个 OTOCO 订单(One-Triggers-One-Cancels-the-Other)是一个包含了三个订单的订单列表。
  • 第一个订单被称为生效订单,必须为 LIMIT 或 LIMIT_MAKER 类型的订单。最初,订单簿上只有生效订单。
    • 生效订单的行为与此一致 OTO
  • 一个OTOCO订单有两个待处理订单(pending above 和 pending below),它们构成了一个 OCO 订单列表。只有当生效订单完全成交时,待处理订单们才会被自动下单。
    • 待处理上方(pending above)订单和待处理下方(pending below)订单都遵循与 OCO 订单列表相同的规则 OrderList OCO。
  • OTOCO 在 EXCHANGE_MAX_NUM_ORDERS 过滤器和 MAX_NUM_ORDERS 过滤器的基础上添加3个订单。

权重: 1

未成交的订单计数: 3

参数:

名称类型是否必须描述
symbolSTRINGYES
listClientOrderIdSTRINGNO整个订单列表的唯一ID。 如果未发送则自动生成。 仅当前一个订单列表已填满或完全过期时,才会接受含有相同 listClientOrderId 值的新订单列表。 listClientOrderId 与 workingClientOrderId、pendingAboveClientOrderId 和 pendingBelowClientOrderId 不同。
newOrderRespTypeENUMNO用于设置JSON响应的格式。 支持的数值: 订单返回类型
selfTradePreventionModeENUMNO允许的数值取决于交易对上的配置。参考 STP 模式
workingTypeENUMYES支持的数值: LIMIT, LIMIT_MAKER
workingSideENUMYES支持的数值: 订单方向
workingClientOrderIdSTRINGNO用于标识生效订单的唯一ID。 如果未发送则自动生成。
workingPriceDECIMALYES
workingQuantityDECIMALYES用于设置生效订单的数量。
workingIcebergQtyDECIMALNO仅当 workingTimeInForce 为 GTC 或 workingType 为 LIMIT_MAKER 时,才能使用此功能。
workingTimeInForceENUMNO支持的数值: 生效时间
workingStrategyIdLONGNO订单策略中用于标识生效订单的 ID。
workingStrategyTypeINTNO用于标识生效订单策略的任意数值。 小于 1000000 的值被保留,无法使用。
workingPegPriceTypeENUMNO参阅 关于挂钩订单参数的注意事项
workingPegOffsetTypeENUMNO
workingPegOffsetValueINTNO
pendingSideENUMYES支持的数值: 订单方向
pendingQuantityDECIMALYES用于设置待处理订单的数量。
pendingAboveTypeENUMYES支持的数值: STOP_LOSS_LIMIT, STOP_LOSS, LIMIT_MAKER, TAKE_PROFIT, TAKE_PROFIT_LIMIT
pendingAboveClientOrderIdSTRINGNO用于标识待处理上方订单的唯一ID。 如果未发送则自动生成。
pendingAbovePriceDECIMALNO当 pendingAboveType 是 STOP_LOSS_LIMIT, LIMIT_MAKER 或 TAKE_PROFIT_LIMIT 时,可用以指定限价。
pendingAboveStopPriceDECIMALNO如果 pendingAboveType 是 STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT 才能使用。
pendingAboveTrailingDeltaDECIMALNO参见 追踪止盈止损(Trailing Stop)订单常见问题
pendingAboveIcebergQtyDECIMALNO只有当 pendingAboveTimeInForce 为 GTC 或 pendingAboveType 为 LIMIT_MAKER 时才能使用。
pendingAboveTimeInForceENUMNO如果 pendingAboveType 是 STOP_LOSS_LIMIT 或 TAKE_PROFIT_LIMIT,则为必填项。
pendingAboveStrategyIdLONGNO订单策略中用于标识待处理上方订单的 ID。
pendingAboveStrategyTypeINTNO用于标识待处理上方订单策略的任意数值。 小于 1000000 的值被保留,无法使用。
pendingAbovePegPriceTypeENUMNO参阅 关于挂钩订单参数的注意事项
pendingAbovePegOffsetTypeENUMNO
pendingAbovePegOffsetValueINTNO
pendingBelowTypeENUMNO支持的数值: STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT
pendingBelowClientOrderIdSTRINGNO用于标识待处理下方订单的唯一ID。 如果未发送则自动生成。
pendingBelowPriceDECIMALNO当 pendingBelowType 是 STOP_LOSS_LIMIT 或 TAKE_PROFIT_LIMIT 时,可用以指定限价。
pendingBelowStopPriceDECIMALNO如果 pendingBelowType 是 STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT 才能使用。 必须指定 pendingBelowStopPrice 或 pendingBelowTrailingDelta 或两者。
pendingBelowTrailingDeltaDECIMALNO参见 追踪止盈止损(Trailing Stop)订单常见问题
pendingBelowIcebergQtyDECIMALNO只有当 pendingBelowTimeInForce 为 GTC 或 pendingBelowType 为 LIMIT_MAKER 时才能使用。
pendingBelowTimeInForceENUMNO如果 pendingBelowType 是 STOP_LOSS_LIMIT 或 TAKE_PROFIT_LIMIT,则为必须配合提交的值。
pendingBelowStrategyIdLONGNO订单策略中用于标识待处理下方订单的 ID。
pendingBelowStrategyTypeINTNO用于标识待处理下方订单策略的任意数值。 小于 1000000 的值被保留,无法使用。
pendingBelowPegPriceTypeENUMNO参阅 关于挂钩订单参数的注意事项
pendingBelowPegOffsetTypeENUMNO
pendingBelowPegOffsetValueINTNO
recvWindowDECIMALNO最大值为 60000 毫秒。 支持最多三位小数的精度(例如 6000.346),以便可以指定微秒。
timestampLONGYES用于请求签名的 Unix 时间戳,单位为毫秒或微秒。该值必须反映客户端当前时间,并会在签名接口中由服务器进行校验。

数据源: 撮合引擎

根据 pendingAboveType, pendingBelowType 或者workingType的不同值,对于某些参数的强制要求

根据 pendingAboveType, pendingBelowType 或者workingType的不同值,对于某些可选参数有强制要求,具体如下:

类型强制要求的参数其他信息
workingType = LIMITworkingTimeInForce
pendingAboveType = LIMIT_MAKERpendingAbovePrice
pendingAboveType = STOP_LOSS/TAKE_PROFITpendingAboveStopPrice 与/或 pendingAboveTrailingDelta
pendingAboveType = STOP_LOSS_LIMIT/TAKE_PROFIT_LIMITpendingAbovePrice, pendingAboveStopPrice 与/或 pendingAboveTrailingDelta, pendingAboveTimeInForce
pendingBelowType = LIMIT_MAKERpendingBelowPrice
pendingBelowType = STOP_LOSS/TAKE_PROFITpendingBelowStopPrice 与/或 pendingBelowTrailingDelta
pendingBelowType = STOP_LOSS_LIMIT/TAKE_PROFIT_LIMITpendingBelowPrice, pendingBelowStopPrice 与/或 pendingBelowTrailingDelta, pendingBelowTimeInForce

响应:

{
"orderListId": 1,
"contingencyType": "OTO",
"listStatusType": "EXEC_STARTED",
"listOrderStatus": "EXECUTING",
"listClientOrderId": "RumwQpBaDctlUu5jyG5rs0",
"transactionTime": 1712291372842,
"symbol": "LTCBTC",
"orders": [
{
"symbol": "LTCBTC",
"orderId": 6,
"clientOrderId": "fM9Y4m23IFJVCQmIrlUmMK"
},
{
"symbol": "LTCBTC",
"orderId": 7,
"clientOrderId": "6pcQbFIzTXGZQ1e2MkGDq4"
},
{
"symbol": "LTCBTC",
"orderId": 8,
"clientOrderId": "r4JMv9cwAYYUwwBZfbussx"
}
],
"orderReports": [
{
"symbol": "LTCBTC",
"orderId": 6,
"orderListId": 1,
"clientOrderId": "fM9Y4m23IFJVCQmIrlUmMK",
"transactTime": 1712291372842,
"price": "1.00000000",
"origQty": "1.00000000",
"executedQty": "0.00000000",
"origQuoteOrderQty": "0.000000",
"cummulativeQuoteQty": "0.00000000",
"status": "NEW",
"timeInForce": "GTC",
"type": "LIMIT",
"side": "SELL",
"workingTime": 1712291372842,
"selfTradePreventionMode": "NONE"
},
{
"symbol": "LTCBTC",
"orderId": 7,
"orderListId": 1,
"clientOrderId": "6pcQbFIzTXGZQ1e2MkGDq4",
"transactTime": 1712291372842,
"price": "1.00000000",
"origQty": "5.00000000",
"executedQty": "0.00000000",
"origQuoteOrderQty": "0.000000",
"cummulativeQuoteQty": "0.00000000",
"status": "PENDING_NEW",
"timeInForce": "IOC",
"type": "STOP_LOSS_LIMIT",
"side": "BUY",
"stopPrice": "6.00000000",
"workingTime": -1,
"selfTradePreventionMode": "NONE"
},
{
"symbol": "LTCBTC",
"orderId": 8,
"orderListId": 1,
"clientOrderId": "r4JMv9cwAYYUwwBZfbussx",
"transactTime": 1712291372842,
"price": "3.00000000",
"origQty": "5.00000000",
"executedQty": "0.00000000",
"origQuoteOrderQty": "0.000000",
"cummulativeQuoteQty": "0.00000000",
"status": "PENDING_NEW",
"timeInForce": "GTC",
"type": "LIMIT_MAKER",
"side": "BUY",
"workingTime": -1,
"selfTradePreventionMode": "NONE"
}
]
}

注意: 上面的 payload 没有显示所有可以出现的字段,更多请看 订单响应中的特定条件时才会出现的字段 部分。

新订单列表 - OPOCO (TRADE)​

POST /api/v3/orderList/opoco

发送一个 OPOCO 订单。

权重: 1

未成交的订单计数: 3

参数:

名称类型是否必须描述
symbolSTRINGYES
listClientOrderIdSTRINGNO订单列表中的唯一 ID。如果未发送,则自动生成。只有当之前的同一 listClientOrderId 的订单列表已成交或完全过期后,才接受新的同一 listClientOrderId 的订单列表。listClientOrderId 与 workingClientOrderId、pendingAboveClientOrderId 和 pendingBelowClientOrderId 不同。
newOrderRespTypeENUMNOJSON 响应格式。支持的数值:订单返回类型
selfTradePreventionModeENUMNO允许的数值取决于交易对的配置。支持的数值:STP模式
workingTypeENUMYES
workingSideENUMYES支持的数值:订单方向
workingClientOrderIdSTRINGNO生效订单中挂单的任意唯一 ID。如果未发送,则自动生成。
workingPriceDECIMALYES生效订单价格
workingQuantityDECIMALYES设置生效订单的数量
workingIcebergQtyDECIMALNO仅当 workingTimeInForce 为 GTC 或 workingType 为 LIMIT_MAKER 时可用
workingTimeInForceENUMNO支持的数值:生效时间
workingStrategyIdLONGNO用于标识订单策略中生效订单的任意数字值
workingStrategyTypeINTNO用于标识生效订单策略的任意数字值。小于 1000000 的值为保留值,不能使用。
workingPegPriceTypeENUMNO参阅 关于挂钩订单参数的注意事项
workingPegOffsetTypeENUMNO参阅 关于挂钩订单参数的注意事项
workingPegOffsetValueINTNO用于挂钩的价格水平(最大值:100)。 参阅 关于挂钩订单参数的注意事项
pendingSideENUMYES支持的数值:订单方向
pendingAboveTypeENUMYES支持的数值:STOP_LOSS_LIMIT,STOP_LOSS,LIMIT_MAKER,TAKE_PROFIT,TAKE_PROFIT_LIMIT
pendingAboveClientOrderIdSTRINGNO待处理"上方"订单中开放订单的任意唯一 ID。如果未发送,则自动生成。
pendingAbovePriceDECIMALNO当 pendingAboveType 为 STOP_LOSS_LIMIT、LIMIT_MAKER 或 TAKE_PROFIT_LIMIT 时,可用于指定限价。
pendingAboveStopPriceDECIMALNO当 pendingAboveType 为 STOP_LOSS、STOP_LOSS_LIMIT、TAKE_PROFIT、TAKE_PROFIT_LIMIT 时可用。
pendingAboveTrailingDeltaDECIMALNO详见 追踪止盈止损常见问题
pendingAboveIcebergQtyDECIMALNO仅当 pendingAboveTimeInForce 为 GTC 或 pendingAboveType 为 LIMIT_MAKER 时可用。
pendingAboveTimeInForceENUMNO如果 pendingAboveType 是 STOP_LOSS_LIMIT 或 TAKE_PROFIT_LIMIT,则为必填项。
pendingAboveStrategyIdLONGNO用于标识订单策略中待处理上方订单的任意数字值。
pendingAboveStrategyTypeINTNO用于标识待处理上方订单策略的任意数字值。小于 1000000 的值为保留值,不能使用。
pendingAbovePegPriceTypeENUMNO参阅 关于挂钩订单参数的注意事项
pendingAbovePegOffsetTypeENUMNO参阅 关于挂钩订单参数的注意事项
pendingAbovePegOffsetValueINTNO用于挂钩的价格水平(最大值:100)。 参阅 关于挂钩订单参数的注意事项
pendingBelowTypeENUMNO支持的数值:STOP_LOSS,STOP_LOSS_LIMIT,TAKE_PROFIT,TAKE_PROFIT_LIMIT
pendingBelowClientOrderIdSTRINGNO待处理"下方"订单中开放订单的任意唯一 ID。如果未发送,则自动生成。
pendingBelowPriceDECIMALNO当 pendingBelowType 为 STOP_LOSS_LIMIT 或 TAKE_PROFIT_LIMIT 时,可用于指定限价。
pendingBelowStopPriceDECIMALNO当 pendingBelowType 为 STOP_LOSS、STOP_LOSS_LIMIT、TAKE_PROFIT 或 TAKE_PROFIT_LIMIT 时可用。pendingBelowStopPrice、pendingBelowTrailingDelta 或两者之一必须被指定。
pendingBelowTrailingDeltaDECIMALNO详见 追踪止盈止损常见问题
pendingBelowIcebergQtyDECIMALNO仅当 pendingBelowTimeInForce 为 GTC 或 pendingBelowType 为 LIMIT_MAKER 时可用。
pendingBelowTimeInForceENUMNO支持的数值:生效时间
pendingBelowStrategyIdLONGNO用于标识订单策略中待处理下方订单的任意数字值。
pendingBelowStrategyTypeINTNO用于标识待处理下方订单策略的任意数字值。小于 1000000 为保留值,不能使用。
pendingBelowPegPriceTypeENUMNO参阅 关于挂钩订单参数的注意事项
pendingBelowPegOffsetTypeENUMNO
pendingBelowPegOffsetValueINTNO
recvWindowDECIMALNO该值不能大于 60000。支持最多三位小数精度(例如 6000.346),以便指定微秒。
timestampLONGYES用于请求签名的 Unix 时间戳,单位为毫秒或微秒。该值必须反映客户端当前时间,并会在签名接口中由服务器进行校验。

数据源: 撮合引擎

响应:

{
"orderListId": 2,
"contingencyType": "OTO",
"listStatusType": "EXEC_STARTED",
"listOrderStatus": "EXECUTING",
"listClientOrderId": "bcedxMpQG6nFrZUPQyshoL",
"transactionTime": 1763000506354,
"symbol": "BTCUSDT",
"orders": [
{
"symbol": "BTCUSDT",
"orderId": 9,
"clientOrderId": "OLSBhMWaIlLSzZ9Zm7fnKB"
},
{
"symbol": "BTCUSDT",
"orderId": 10,
"clientOrderId": "mfif39yPTHsB3C0FIXznR2"
},
{
"symbol": "BTCUSDT",
"orderId": 11,
"clientOrderId": "yINkaXSJeoi3bU5vWMY8Z8"
}
],
"orderReports": [
{
"symbol": "BTCUSDT",
"orderId": 9,
"orderListId": 2,
"clientOrderId": "OLSBhMWaIlLSzZ9Zm7fnKB",
"transactTime": 1763000506354,
"price": "102496.00000000",
"origQty": "0.00170000",
"executedQty": "0.00000000",
"origQuoteOrderQty": "0.00000000",
"cummulativeQuoteQty": "0.00000000",
"status": "NEW",
"timeInForce": "GTC",
"type": "LIMIT",
"side": "BUY",
"workingTime": 1763000506354,
"selfTradePreventionMode": "NONE"
},
{
"symbol": "BTCUSDT",
"orderId": 10,
"orderListId": 2,
"clientOrderId": "mfif39yPTHsB3C0FIXznR2",
"transactTime": 1763000506354,
"price": "101613.00000000",
"executedQty": "0.00000000",
"origQuoteOrderQty": "0.00000000",
"cummulativeQuoteQty": "0.00000000",
"status": "PENDING_NEW",
"timeInForce": "GTC",
"type": "STOP_LOSS_LIMIT",
"side": "SELL",
"stopPrice": "10100.00000000",
"workingTime": -1,
"selfTradePreventionMode": "NONE"
},
{
"symbol": "BTCUSDT",
"orderId": 11,
"orderListId": 2,
"clientOrderId": "yINkaXSJeoi3bU5vWMY8Z8",
"transactTime": 1763000506354,
"price": "104261.00000000",
"executedQty": "0.00000000",
"origQuoteOrderQty": "0.00000000",
"cummulativeQuoteQty": "0.00000000",
"status": "PENDING_NEW",
"timeInForce": "GTC",
"type": "LIMIT_MAKER",
"side": "SELL",
"workingTime": -1,
"selfTradePreventionMode": "NONE"
}
]
}

注意: 上面的 payload 没有显示所有可以出现的字段,更多请看 订单响应中的特定条件时才会出现的字段 部分。

取消订单列表 (TRADE)​

DELETE /api/v3/orderList

取消整个订单列表。

权重: 1

参数:

名称类型是否必须描述
symbolSTRINGYES
orderListIdLONGNOorderListId 或 listClientOrderId 必须被提供
listClientOrderIdSTRINGNOorderListId 或 listClientOrderId 必须被提供
newClientOrderIdSTRINGNO用户自定义的本次撤销操作的ID(注意不是被撤销的订单的自定义ID)。如无指定会自动赋值。
recvWindowDECIMALNO最大值: 60000。
支持最多三位小数的精度(例如 6000.346),以便可以指定微秒。
timestampLONGYES用于请求签名的 Unix 时间戳,单位为毫秒或微秒。该值必须反映客户端当前时间,并会在签名接口中由服务器进行校验。

数据源: 撮合引擎

其他注意点:

  • 取消订单列表中的单个订单将取消整个订单列表.
  • 当同时提供 orderListId 和 listClientOrderId 两个参数时,系统首先将会使用 orderListId 来搜索订单。然后, 查找结果中的 listClientOrderId 的值将会被用来验证订单。如果两个条件都不满足,则请求将被拒绝。

响应:

{
"orderListId": 0,
"contingencyType": "OCO",
"listStatusType": "ALL_DONE",
"listOrderStatus": "ALL_DONE",
"listClientOrderId": "C3wyj4WVEktd7u9aVBRXcN",
"transactionTime": 1574040868128,
"symbol": "LTCBTC",
"orders": [
{
"symbol": "LTCBTC",
"orderId": 2,
"clientOrderId": "pO9ufTiFGg3nw2fOdgeOXa"
},
{
"symbol": "LTCBTC",
"orderId": 3,
"clientOrderId": "TXOvglzXuaubXAaENpaRCB"
}
],
"orderReports": [
{
"symbol": "LTCBTC",
"origClientOrderId": "pO9ufTiFGg3nw2fOdgeOXa",
"orderId": 2,
"orderListId": 0,
"clientOrderId": "unfWT8ig8i0uj6lPuYLez6",
"transactTime": 1688005070874,
"price": "1.00000000",
"origQty": "10.00000000",
"executedQty": "0.00000000",
"origQuoteOrderQty": "0.000000",
"cummulativeQuoteQty": "0.00000000",
"status": "CANCELED",
"timeInForce": "GTC",
"type": "STOP_LOSS_LIMIT",
"side": "SELL",
"stopPrice": "1.00000000", // 出现在 STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT 和 TAKE_PROFIT_LIMIT 订单中。
"selfTradePreventionMode": "NONE"
},
{
"symbol": "LTCBTC",
"origClientOrderId": "TXOvglzXuaubXAaENpaRCB",
"orderId": 3,
"orderListId": 0,
"clientOrderId": "unfWT8ig8i0uj6lPuYLez6",
"transactTime": 1688005070874,
"price": "3.00000000",
"origQty": "10.00000000",
"executedQty": "0.00000000",
"origQuoteOrderQty": "0.000000",
"cummulativeQuoteQty": "0.00000000",
"status": "CANCELED",
"timeInForce": "GTC",
"type": "LIMIT_MAKER",
"side": "SELL",
"selfTradePreventionMode": "NONE"
}
]
}

下 SOR 订单 (TRADE)​

POST /api/v3/sor/order

发送使用智能订单路由 (SOR) 的新订单。

这个请求会把1个订单添加到 EXCHANGE_MAX_ORDERS 过滤器和 MAX_NUM_ORDERS 过滤器中。

参阅 智能订单路由 (SOR) 了解更多详情。

权重: 1

未成交的订单计数: 1

参数:

名称类型是否必须描述
symbolSTRINGYES
sideENUMYES
typeENUMYES
timeInForceENUMNO
quantityDECIMALYES
priceDECIMALNO
newClientOrderIdSTRINGNO用户自定义的orderid,如空缺系统会自动赋值。如果几个订单具有相同的 newClientOrderID 赋值,
那么只有在前一个订单成交后才可以接受下一个订单,否则该订单将被拒绝。
strategyIdLONGNO
strategyTypeINTNO赋值不能小于 1000000.
icebergQtyDECIMALNO仅有限价单可以使用该参数,含义为创建冰山订单并指定冰山订单的数量。
newOrderRespTypeENUMNO指定响应类型:
selfTradePreventionModeENUMNO允许的 ENUM 取决于交易对的配置。支持的值有:STP 模式。
recvWindowDECIMALNO最大值为 60000 毫秒。
支持最多三位小数的精度(例如 6000.346),以便可以指定微秒。
timestampLONGYES用于请求签名的 Unix 时间戳,单位为毫秒或微秒。该值必须反映客户端当前时间,并会在签名接口中由服务器进行校验。

数据源: 撮合引擎

请注意: POST /api/v3/sor/order 只支持 限价 和 市场 单, 并不支持 quoteOrderQty。

响应:

{
"symbol": "BTCUSDT",
"orderId": 2,
"orderListId": -1,
"clientOrderId": "sBI1KM6nNtOfj5tccZSKly",
"transactTime": 1689149087774,
"price": "31000.00000000",
"origQty": "0.50000000",
"executedQty": "0.50000000",
"origQuoteOrderQty": "0.000000",
"cummulativeQuoteQty": "14000.00000000",
"status": "FILLED",
"timeInForce": "GTC",
"type": "LIMIT",
"side": "BUY",
"workingTime": 1689149087774,
"fills": [
{
"matchType": "ONE_PARTY_TRADE_REPORT",
"price": "28000.00000000",
"qty": "0.50000000",
"commission": "0.00000000",
"commissionAsset": "BTC",
"tradeId": -1,
"allocId": 0
}
],
"workingFloor": "SOR",
"selfTradePreventionMode": "NONE",
"usedSor": true
}

测试 SOR 下单接口 (TRADE)​

POST /api/v3/sor/order/test

用于测试使用智能订单路由 (SOR) 的订单请求,但不会提交到撮合引擎

权重:

条件权重
没有 computeCommissionRates1
有 computeCommissionRates20

参数:

名称类型是否必须描述
computeCommissionRatesBOOLEANNO默认值: false。
symbolSTRINGYES
sideENUMYES详见枚举定义:订单方向
typeENUMYES详见枚举定义:订单类型
timeInForceENUMNO详见枚举定义:生效时间
quantityDECIMALYES
priceDECIMALNO
newClientOrderIdSTRINGNO用户自定义的orderid,如空缺系统会自动赋值。如果几个订单具有相同的 newClientOrderID 赋值,那么只有在前一个订单成交后才可以接受下一个订单,否则该订单将被拒绝。
strategyIdLONGNO
strategyTypeINTNO赋值不能小于 1000000。
icebergQtyDECIMALNO仅有限价单可以使用该参数,含义为创建冰山订单并指定冰山订单的数量。
newOrderRespTypeENUMNO指定响应类型: ACK, RESULT 或 FULL; 默认为 FULL。
selfTradePreventionModeENUMNO允许的 ENUM 取决于交易对的配置。支持的值有:STP 模式。
recvWindowDECIMALNO最大值为 60000 毫秒。 支持最多三位小数的精度(例如 6000.346),以便可以指定微秒。
timestampLONGYES用于请求签名的 Unix 时间戳,单位为毫秒或微秒。该值必须反映客户端当前时间,并会在签名接口中由服务器进行校验。

数据源: 缓存

响应:

没有 computeCommissionRates

{}

有 computeCommissionRates

{
// 订单交易的标准佣金率。
"standardCommissionForOrder": {
"maker": "0.00000112",
"taker": "0.00000114"
},
// 订单交易的税率。
"taxCommissionForOrder": {
"maker": "0.00000112",
"taker": "0.00000114"
},
// 以BNB支付时的标准佣金折扣。
"discount": {
"enabledForAccount": true,
"enabledForSymbol": true,
"discountAsset": "BNB",
"discount": "0.25000000"
}
}

新订单列表 - OPO (TRADE)​

POST /api/v3/orderList/opo

发送一个新的 OPO 订单。

  • OPO 会向 EXCHANGE_MAX_NUM_ORDERS 过滤器和 MAX_NUM_ORDERS 过滤器中添加 2 个订单。

权重: 1

未成交的订单计数: 2

参数:

名称类型是否必须描述
symbolSTRINGYES
listClientOrderIdSTRINGNO订单列表中的唯一 ID。如果未发送,则自动生成。只有当之前的同一 listClientOrderId 的订单列表已成交或完全过期后,才接受新的同一 listClientOrderId 的订单列表。listClientOrderId 与 workingClientOrderId 和 pendingClientOrderId 不同。
newOrderRespTypeENUMNOJSON 响应格式。支持的数值:订单返回类型
selfTradePreventionModeENUMNO允许的数值取决于交易对的配置。支持的数值:STP模式
workingTypeENUMYES支持的数值:LIMIT,LIMIT_MAKER
workingSideENUMYES支持的数值:订单方向
workingClientOrderIdSTRINGNO生效订单中挂单的任意唯一 ID。如果未发送,则自动生成。
workingPriceDECIMALYES生效订单价格
workingQuantityDECIMALYES设置生效订单的数量
workingIcebergQtyDECIMALNO仅当 workingTimeInForce 为 GTC 或 workingType 为 LIMIT_MAKER 时可用
workingTimeInForceENUMNO支持的数值:生效时间
workingStrategyIdLONGNO用于标识订单策略中生效订单的任意数字值
workingStrategyTypeINTNO用于标识生效订单策略的任意数字值。小于 1000000 的值为保留值,不能使用。
workingPegPriceTypeENUMNO参阅 关于挂钩订单参数的注意事项
workingPegOffsetTypeENUMNO
workingPegOffsetValueINTNO
pendingTypeENUMYES支持的数值:订单类型。注意,不支持使用 quoteOrderQty 的 MARKET 订单。
pendingSideENUMYES支持的数值:订单方向
pendingClientOrderIdSTRINGNO待处理订单中挂单的任意唯一 ID。如果未发送,则自动生成。
pendingPriceDECIMALNO待处理订单价格
pendingStopPriceDECIMALNO待处理订单止损价格
pendingTrailingDeltaDECIMALNO待处理订单跟踪止损差值
pendingIcebergQtyDECIMALNO仅当 pendingTimeInForce 为 GTC 或 pendingType 为 LIMIT_MAKER 时可用
pendingTimeInForceENUMNO支持的数值:生效时间
pendingStrategyIdLONGNO用于标识订单策略中待处理订单的任意数字值
pendingStrategyTypeINTNO用于标识待处理订单策略的任意数字值。小于 1000000 的值为保留值,不能使用。
pendingPegPriceTypeENUMNO参阅 关于挂钩订单参数的注意事项
pendingPegOffsetTypeENUMNO
pendingPegOffsetValueINTNO
recvWindowDECIMALNO最大值: 60000。
该值不能大于 60000。支持最多三位小数精度(例如 6000.346),以便指定微秒。
timestampLONGYES用于请求签名的 Unix 时间戳,单位为毫秒或微秒。该值必须反映客户端当前时间,并会在签名接口中由服务器进行校验。

数据源: 撮合引擎

响应:

{
"orderListId": 0,
"contingencyType": "OTO",
"listStatusType": "EXEC_STARTED",
"listOrderStatus": "EXECUTING",
"listClientOrderId": "H94qCqO27P74OEiO4X8HOG",
"transactionTime": 1762998011671,
"symbol": "BTCUSDT",
"orders": [
{
"symbol": "BTCUSDT",
"orderId": 2,
"clientOrderId": "JX6xfdjo0wysiGumfHNmPu"
},
{
"symbol": "BTCUSDT",
"orderId": 3,
"clientOrderId": "2ZJCY0IjOhuYIMLGN8kU8S"
}
],
"orderReports": [
{
"symbol": "BTCUSDT",
"orderId": 2,
"orderListId": 0,
"clientOrderId": "JX6xfdjo0wysiGumfHNmPu",
"transactTime": 1762998011671,
"price": "102264.00000000",
"origQty": "0.00060000",
"executedQty": "0.00000000",
"origQuoteOrderQty": "0.00000000",
"cummulativeQuoteQty": "0.00000000",
"status": "NEW",
"timeInForce": "GTC",
"type": "LIMIT",
"side": "BUY",
"workingTime": 1762998011671,
"selfTradePreventionMode": "NONE"
},
{
"symbol": "BTCUSDT",
"orderId": 3,
"orderListId": 0,
"clientOrderId": "2ZJCY0IjOhuYIMLGN8kU8S",
"transactTime": 1762998011671,
"price": "0.00000000",
"executedQty": "0.00000000",
"origQuoteOrderQty": "0.00000000",
"cummulativeQuoteQty": "0.00000000",
"status": "PENDING_NEW",
"timeInForce": "GTC",
"type": "MARKET",
"side": "SELL",
"workingTime": -1,
"selfTradePreventionMode": "NONE"
}
]
}

注意: 上面的 payload 没有显示所有可以出现的字段,更多请看 订单响应中的特定条件时才会出现的字段 部分。