Trade

Query Order (USER_DATA)

Check an order's status.

  • Either orderId or origClientOrderId must be sent.
  • For some historical orders cummulativeQuoteQty will be < 0, meaning the data is not available at this time.

Weight(IP): 4

get/api/v3/order

Query parameters

symbolstring required
Example:BNBUSDT

Trading symbol, e.g. BNBUSDT

orderIdinteger

Order id

origClientOrderIdstring

Order id from client

recvWindowinteger
Example:5000

The value cannot be greater than 60000

timestampinteger required

UTC timestamp in ms

signaturestring required

Signature

Response

Order details

symbolstring required
orderIdinteger required
orderListIdinteger required

Unless OCO, value will be -1

clientOrderIdstring required
pricestring required
origQtystring required
executedQtystring required
cummulativeQuoteQtystring required
statusstring required
timeInForcestring required
typestring required
sidestring required
stopPricestring required
icebergQtystring required
timeinteger required
updateTimeinteger required
isWorkingboolean required
workingTimeinteger required
origQuoteOrderQtystring required
selfTradePreventionModestring required
preventedMatchIdinteger
preventedQuantitystring

Example response

{
  "symbol": "LTCBTC",
  "orderId": 1,
  "orderListId": -1,
  "clientOrderId": "myOrder1",
  "price": "0.1",
  "origQty": "1.0",
  "executedQty": "0.0",
  "cummulativeQuoteQty": "0.0",
  "status": "NEW",
  "timeInForce": "GTC",
  "type": "LIMIT",
  "side": "BUY",
  "stopPrice": "0.0",
  "icebergQty": "0.0",
  "time": 1499827319559,
  "updateTime": 1499827319559,
  "workingTime": 1499827319559,
  "origQuoteOrderQty": "0.00000000",
  "selfTradePreventionMode": "NONE",
  "preventedQuantity": "1.200000"
}

Changes

Changed in 3 of the 26 revisions of this API.326

    • added the optional property preventedMatchId to the response with the 200 status

      response-optional-property-added

    • added the optional property preventedQuantity to the response with the 200 status

      response-optional-property-added

    • added the required property selfTradePreventionMode to the response with the 200 status

      response-required-property-added

    • added the required property workingTime to the response with the 200 status

      response-required-property-added

  • a484ce871a72322See the full diff
    • for the query request parameter orderId, the type/format was changed from integer/ to integer/int64

      request-parameter-type-changed

    • for the query request parameter recvWindow, the type/format was changed from integer/ to integer/int64

      request-parameter-type-changed

    • for the query request parameter timestamp, the type/format was changed from integer/ to integer/int64

      request-parameter-type-changed

    • the response property clientOrderId became required for the status 200

      response-property-became-required

    • the response property code became required for the status 400

      response-property-became-required

    • the response property code became required for the status 401

      response-property-became-required

    • the response property cummulativeQuoteQty became required for the status 200

      response-property-became-required

    • the response property executedQty became required for the status 200

      response-property-became-required

    • the response property icebergQty became required for the status 200

      response-property-became-required

    • the response property isWorking became required for the status 200

      response-property-became-required

    • the response property msg became required for the status 400

      response-property-became-required

    • the response property msg became required for the status 401

      response-property-became-required

    • the response property orderId became required for the status 200

      response-property-became-required

    • the response property orderListId became required for the status 200

      response-property-became-required

    • the response property origQty became required for the status 200

      response-property-became-required

    • the response property origQuoteOrderQty became required for the status 200

      response-property-became-required

    • the response property price became required for the status 200

      response-property-became-required

    • the response property side became required for the status 200

      response-property-became-required

    • the response property status became required for the status 200

      response-property-became-required

    • the response property stopPrice became required for the status 200

      response-property-became-required

    • the response property symbol became required for the status 200

      response-property-became-required

    • the response property time became required for the status 200

      response-property-became-required

    • the response property timeInForce became required for the status 200

      response-property-became-required

    • the response property type became required for the status 200

      response-property-became-required

    • the response property updateTime became required for the status 200

      response-property-became-required