Welcome to the new WEEX API documentation. Looking for the previous version?Switch to the legacy docs
WEEX

Get Order Info (USER_DATA)

  • GET /capi/v3/order

Weight(IP): 2

Request parameters

ParameterTypeRequired?Description
orderIdLongYesOrder ID to query.
Request example
PowerShellCode
curl "https://api-contract.weex.com/capi/v3/order?orderId=702345678901234567" \ -H "ACCESS-KEY:*******" \ -H "ACCESS-SIGN:*******" \ -H "ACCESS-PASSPHRASE:*****" \ -H "ACCESS-TIMESTAMP:<CURRENT_TIMESTAMP_MS>"
Response parameters
FieldTypeDescription
avgPriceStringAverage fill price.
clientOrderIdStringClient-defined order ID.
cumQuoteStringCumulative filled amount in the quote asset.
executedQtyStringFilled quantity in the base asset.
orderIdLongSystem order ID.
origQtyStringOriginal order quantity.
priceStringOrder price.
priceMatchStringOrder book price matching mode: NONE (regular order), OPPONENT (opponent level 1), OPPONENT_5 (opponent level 5), QUEUE (same-side level 1), QUEUE_5 (same-side level 5).
reduceOnlyBooleanWhether the order can only reduce positions.
sideStringOrder side. See Order Side for possible values.
positionSideStringPosition side. See Position Mode.
statusStringOrder status. See Order Status.
stopPriceStringStop price / trigger price (if applicable).
symbolStringTrading pair.
timeLongOrder creation time (ms).
timeInForceStringTime-in-force policy. See Time in Force.
typeStringOrder type. See Order Type.
updateTimeLongLast update time (ms).
workingTypeStringTrigger price type. See Trigger Price Type.
Response example
JSONCode
{ "avgPrice": "68990.5", "clientOrderId": "my-order-0001", "cumQuote": "689.905", "executedQty": "0.01", "orderId": 702345678901234567, "origQty": "0.01", "price": "69000", "priceMatch": "NONE", "reduceOnly": false, "side": "BUY", "positionSide": "LONG", "status": "FILLED", "stopPrice": "0", "symbol": "BTCUSDT", "time": 1764505700123, "timeInForce": "GTC", "type": "LIMIT", "updateTime": 1764505701456, "workingType": "CONTRACT_PRICE" }