Skip to main content

New UM Order (TRADE)

API Description#

Place new UM order

HTTP Request#

POST /papi/v1/um/order

Request Weight(Order)#

1

Request Parameters#

NameTypeMandatoryDescription
symbolSTRINGYES
sideENUMYES
positionSideENUMNODefault BOTH for One-way Mode ; LONG or SHORT for Hedge Mode. It must be sent in Hedge Mode.
typeENUMYESLIMIT, MARKET
timeInForceENUMNO
quantityDECIMALNO
reduceOnlySTRINGNO"true" or "false". default "false". Cannot be sent in Hedge Mode .
priceDECIMALNO
newClientOrderIdSTRINGNOA unique id among open orders. Automatically generated if not sent. Can only be string following the rule: ^[\.A-Z\:/a-z0-9_-]{1,32}$
newOrderRespTypeENUMNOACK, RESULT, default ACK
recvWindowLONGNO
timestampLONGYES

Additional mandatory parameters based on type:

TypeAdditional mandatory parameters
LIMITtimeInForce, quantity, price
MARKETquantity
  • If newOrderRespType is sent as RESULT :
    • MARKET order: the final FILLED result of the order will be return directly.
    • LIMIT order with special timeInForce: the final status result of the order(FILLED or EXPIRED) will be returned directly.

Response Example#

{    "clientOrderId": "testOrder",    "cumQty": "0",    "cumQuote": "0",    "executedQty": "0",    "orderId": 22542179,    "avgPrice": "0.00000",    "origQty": "10",    "price": "0",    "reduceOnly": false,    "side": "BUY",    "positionSide": "SHORT",    "status": "NEW",    "symbol": "BTCUSDT",    "timeInForce": "GTC",    "type": "MARKET",    "updateTime": 1566818724722}