Cancel Order (TRADE)
Cancel an active order.
Cancel Order (TRADE) › Authorization
Cancel Order (TRADE) › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Cancel Order (TRADE) › Request Parameters
idmethodWebSocket API method name.
symboltimestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
apiKeyAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
orderIdorigClientOrderIdrecvWindowCancel Order (TRADE) › Responses
Cancel Order
idpositionId
statusEnum:completed,processing
Indicates that combined is set to true.
orderIdSub-order ID
symbolTrading symbol
pairPair
statusEnum:completed,processing
clientOrderIdClient order ID.
priceLatest token price.
origQtyOriginal order quantity
executedQtyExecuted quantity
cumQtyCumulative filled quantity.
timeInForceTime in force
typeOrder type.
reduceOnlyWhether the order is reduce-only.
closePositionif Close-All
sideTrading side
positionSidePosition side
stopPriceplease ignore when order type is TRAILING_STOP_MARKET
workingTypeStop trigger price type.
priceProtectif conditional order trigger is protected
origTypeOriginal order type.
updateTimeupdate time
Rate limit definitions.
rateLimitTypeRate limit type.
intervalRate limit interval.
intervalNumRate limit interval multiplier.
limitMaximum allowed orders for this rule.
countTotal number of trades in the 24h window.
Modify Order (TRADE)
Order modify function, currently only LIMIT order modification is supported, modified orders will be reordered in the match queue
Modify Order (TRADE) › Authorization
Modify Order (TRADE) › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
1 on 10s order rate limit(X-MBX-ORDER-COUNT-10S); 1 on 1min order rate limit(X-MBX-ORDER-COUNT-1M); 1 on IP rate limit(x-mbx-used-weight-1m)
Modify Order (TRADE) › Request Parameters
idmethodWebSocket API method name.
symbolsidequantityOrder quantity, cannot be sent with closePosition=true
pricetimestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
apiKeyAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
orderIdorigClientOrderIdpriceMatchonly avaliable for LIMIT/STOP/TAKE_PROFIT order; Can't be passed together with price
modifyIdUser-defined modification identifier, returned as-is in the response. Optional; not validated for uniqueness.
recvWindowModify Order (TRADE) › Responses
Modify Order
idpositionId
statusEnum:completed,processing
Indicates that combined is set to true.
orderIdSub-order ID
symbolTrading symbol
pairPair
statusEnum:completed,processing
clientOrderIdClient order ID.
modifyIduser-defined modification identifier, only returned if provided in the request
priceLatest token price.
origQtyOriginal order quantity
executedQtyExecuted quantity
cumQtyCumulative filled quantity.
timeInForceTime in force
typeOrder type.
reduceOnlyWhether the order is reduce-only.
closePositionif Close-All
sideTrading side
positionSidePosition side
stopPriceplease ignore when order type is TRAILING_STOP_MARKET
workingTypeStop trigger price type.
priceProtectif conditional order trigger is protected
origTypeOriginal order type.
updateTimeupdate time
Rate limit definitions.
rateLimitTypeRate limit type.
intervalRate limit interval.
intervalNumRate limit interval multiplier.
limitMaximum allowed orders for this rule.
countTotal number of trades in the 24h window.
New Order (TRADE)
Send in a new order.
New Order (TRADE) › Authorization
New Order (TRADE) › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
New Order (TRADE) › Request Parameters
idmethodWebSocket API method name.
symbolsidetypeAfter CM migration, stop-type values (STOP, STOP_MARKET, TAKE_PROFIT, TAKE_PROFIT_MARKET, TRAILING_STOP_MARKET) are no longer accepted and will return -4120. Use the REST /dapi/v1/algoOrder endpoint instead.
timestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
apiKeyAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
positionSideDefault BOTH for One-way Mode; LONG or SHORT for Hedge Mode. It must be sent in Hedge Mode.
timeInForcequantityQuantity measured by contract number, Cannot be sent with closePosition=true
reduceOnlyCannot be sent in Hedge Mode; cannot be sent with closePosition=true (Close-All)"
pricenewClientOrderIdA unique id among open orders. Automatically generated if not sent. Can only be string following the rule: ^[\.A-Z\:/a-z0-9_-]{1,36}$
stopPriceUsed with STOP/STOP_MARKET or TAKE_PROFIT/TAKE_PROFIT_MARKET orders.
closePositiontrue, false;Close-All,used with STOP_MARKET or TAKE_PROFIT_MARKET.
activationPriceUsed with TRAILING_STOP_MARKET orders, default as the latest price(supporting different workingType)
callbackRateUsed with TRAILING_STOP_MARKET orders, min 0.1, max 10 where 1 for 1%
workingTypestopPrice triggered by: "MARK_PRICE", "CONTRACT_PRICE". Default "CONTRACT_PRICE"
priceProtectUsed with STOP/STOP_MARKET or TAKE_PROFIT/TAKE_PROFIT_MARKET orders.'
newOrderRespTypepriceMatchonly available for LIMIT/STOP/TAKE_PROFIT order; Can't be passed together with price
selfTradePreventionModeNONE: No STP / EXPIRE_TAKEREXPIRE_MAKEREXPIRE_BOTH
recvWindowNew Order (TRADE) › Responses
New Order
idpositionId
statusEnum:completed,processing
Indicates that combined is set to true.
orderIdSub-order ID
symbolTrading symbol
pairPair
statusEnum:completed,processing
clientOrderIdClient order ID.
priceLatest token price.
origQtyOriginal order quantity
executedQtyExecuted quantity
cumQtyCumulative filled quantity.
timeInForceTime in force
typeOrder type.
reduceOnlyWhether the order is reduce-only.
closePositionif Close-All
sideTrading side
positionSidePosition side
stopPriceplease ignore when order type is TRAILING_STOP_MARKET
workingTypeStop trigger price type.
priceProtectif conditional order trigger is protected
origTypeOriginal order type.
updateTimeupdate time
Rate limit definitions.
rateLimitTypeRate limit type.
intervalRate limit interval.
intervalNumRate limit interval multiplier.
limitMaximum allowed orders for this rule.
countTotal number of trades in the 24h window.
Position Information (USER_DATA)
Get current position information.
Position Information (USER_DATA) › Authorization
Position Information (USER_DATA) › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Position Information (USER_DATA) › Request Parameters
idmethodWebSocket API method name.
timestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
apiKeyAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
marginAssetpairrecvWindowPosition Information (USER_DATA) › Responses
Position Information
idpositionId
statusEnum:completed,processing
Indicates that combined is set to true.
symbolTrading symbol
positionAmtposition amount
entryPricePosition entry price.
markPricemark price
unRealizedProfitUnrealized profit.
liquidationPriceLiquidation price.
leverageLeverage value.
maxQtymaximum quantity of base asset
marginTypeMargin type.
isolatedMarginIsolated margin amount.
isAutoAddMarginWhether auto-add margin is enabled.
positionSidePosition side
notionalValueNotional value.
isolatedWalletIsolated wallet balance.
updateTimeupdate time
breakEvenPricebreak-even price
Rate limit definitions.
rateLimitTypeRate limit type.
intervalRate limit interval.
intervalNumRate limit interval multiplier.
limitMaximum allowed orders for this rule.
countTotal number of trades in the 24h window.
Query Order (USER_DATA)
Check an order's status.
- These orders will not be found:
- order status is
CANCELEDorEXPIREDAND order has NO filled trade AND created time + 3 days < current time - order create time + 90 days < current time
- order status is
Query Order (USER_DATA) › Authorization
Query Order (USER_DATA) › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Query Order (USER_DATA) › Request Parameters
idmethodWebSocket API method name.
symboltimestampUnix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.
apiKeyAn API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.
orderIdorigClientOrderIdrecvWindowQuery Order (USER_DATA) › Responses
Order
idpositionId
statusEnum:completed,processing
Indicates that combined is set to true.
orderIdSub-order ID
symbolTrading symbol
pairPair
statusEnum:completed,processing
clientOrderIdClient order ID.
priceLatest token price.
avgPriceAverage execution price
origQtyOriginal order quantity
executedQtyExecuted quantity
cumQtyCumulative filled quantity.
cumBaseCumulative base asset amount.
timeInForceTime in force
typeOrder type.
reduceOnlyWhether the order is reduce-only.
closePositionif Close-All
sideTrading side
positionSidePosition side
stopPriceplease ignore when order type is TRAILING_STOP_MARKET
workingTypeStop trigger price type.
priceProtectif conditional order trigger is protected
origTypeOriginal order type.
selfTradePreventionModeself trading preventation mode
timeTime
updateTimeupdate time
priceMatchprice match mode
Rate limit definitions.
rateLimitTypeRate limit type.
intervalRate limit interval.
intervalNumRate limit interval multiplier.
limitMaximum allowed orders for this rule.
countTotal number of trades in the 24h window.