Skip to main content

Order

Subscribe to the order or order.event topic to receive real-time Event Contract order updates.

Topic: order / order.event

info
  • Authentication is required before subscribing to private topics.
  • Pushed when an Event Contract order status changes (e.g., filled, partially filled, cancelled).

Response Parameters

ParameterTypeComments
idstringMessage ID
topicstringTopic name
creationTimenumberData created timestamp (ms)
dataarrayObject
> categorystringProduct type. event
> orderIdstringOrder ID
> orderLinkIdstringUser-defined order ID
> symbolstringSymbol name
> symbolIdintegerSymbol ID
> sidestringSide: Buy or Sell
> baseCoinstringBase coin
> quoteCoinstringQuote coin
> settleCoinstringSettle coin
> orderStatusstringOrder status: New, PartiallyFilled, Filled, Cancelled, Rejected
> ecContractTypestringEvent contract type: UpDown, Target, Range
> ecDirectionstringDirection: UP/DOWN (UpDown type), ABOVE/BELOW (Target type), RANGE_IN/RANGE_OUT (Range type)
> ecDurationWindowintegerDuration window in seconds
> ecTargetPricestringTarget price. Target type only.
> ecLowerBoundstringLower bound. Range type only.
> ecUpperBoundstringUpper bound. Range type only.
> ecOrderValuestringEvent Contract order value
> ecIndexPricestringIndex price at order creation
> ecSettleTimestringExpected settlement time in milliseconds
> payoutRatiostringOrder payout ratio (price)
> orderAvgPayoutRatiostringAverage payout ratio of filled portion
> cumExecValuestringCumulative executed value
> cumExecFeestringCumulative executed fee
> leavesValuestringRemaining order value
> cumPayoutstringCumulative payout
> createTypeintegerOrder create type
> cancelTypestringCancel type
> rejectReasonstringReject reason
> extraFeesarrayExtra fees
> transTimestringTransaction time in milliseconds
> createdTimestringOrder creation time in milliseconds
> updatedTimestringOrder update time in milliseconds

Subscribe Example

{
"op": "subscribe",
"args": [
"order"
]
}

Stream Example

{
"topic": "order",
"id": "1509583_ETHUSDT-5MIN-UP_1311",
"creationTime": 1787635282379,
"data": [
{
"category": "event",
"orderId": "746a6c87-a6dd-4008-8889-37e694046681",
"orderLinkId": "cjm1119",
"symbol": "ETHUSDT-5MIN-UP",
"symbolId": 500000,
"side": "Sell",
"baseCoin": "ETH",
"quoteCoin": "USDT",
"settleCoin": "USDT",
"orderStatus": "PartiallyFilled",
"ecContractType": "UpDown",
"ecDirection": "UP",
"ecDurationWindow": 300,
"ecTargetPrice": "",
"ecLowerBound": "",
"ecUpperBound": "",
"ecOrderValue": "5000",
"ecIndexPrice": "2503.50730825",
"ecSettleTime": "1787635582374",
"payoutRatio": "3.5",
"orderAvgPayoutRatio": "3.5000035",
"cumExecValue": "200",
"cumExecFee": "8.57142858",
"leavesValue": "4800",
"cumPayout": "700",
"createType": 1,
"cancelType": "UNKNOWN",
"rejectReason": "EC_NoError",
"extraFees": [],
"transTime": "1787635282374",
"createdTime": "1787635103917",
"updatedTime": "1787635103917"
}
]
}