Skip to main content

Get Event Contract Active Orders

Query real-time unfilled or partially filled Event Contract orders.

info
  • Only Event Contract maker accounts are allowed to access this endpoint.

HTTP Request

GET/v5/event/order-realtime

Request Parameters

ParameterRequiredTypeComments
symbolfalsestringSymbol name, e.g. ETHUSDT-28AUG26-2450-2570-OUT
orderIdfalsestringOrder ID. If both orderId and orderLinkId are passed, orderId takes priority
orderLinkIdfalsestringUser-defined order ID
limitfalseintegerNumber of items per page. Default: 20, Range: [1, 50]
cursorfalsestringPagination cursor. Use nextPageCursor from the response to retrieve the next page

Response Parameters

ParameterTypeComments
listarrayEvent Contract active order list
> orderIdstringOrder ID
> orderLinkIdstringUser-defined order ID
> symbolstringSymbol name
> symbolIdstringSymbol ID
> sidestringOrder side: Buy or Sell
> orderStatusstringOrder status: New (order created), PartiallyFilled (partially filled), Untriggered (awaiting trigger)
> payoutRatiostringOrder payout ratio (price)
> cumExecValuestringCumulative executed value
> cumExecFeestringCumulative executed fee
> leavesValuestringRemaining order value
> ecContractTypestringEvent contract type: UpDown, Target, Range
> ecDirectionstringDirection: UP/DOWN (UpDown type), ABOVE/BELOW (Target type), RANGE_IN/RANGE_OUT (Range type)
> ecOrderValuestringEvent Contract order value
> ecSettleTimestringExpected settlement time in milliseconds
> ecTargetPricestringTarget price. Target type only.
> ecLowerBoundstringLower bound. Range type only.
> ecUpperBoundstringUpper bound. Range type only.
> ecDurationWindowstringDuration window in seconds
> ecIndexPricestringIndex price at order creation
> orderAvgPayoutRatiostringAverage payout ratio of filled portion
> createTypestringOrder create type, e.g. CreateByUser
> createdTimestringOrder creation timestamp in milliseconds
> updatedTimestringOrder update timestamp in milliseconds
nextPageCursorstringCursor for next page pagination

Request Example

GET /v5/event/order-realtime?symbol=ETHUSDT-28AUG26-2450-2570-OUT&limit=20 HTTP/1.1
Host: api.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx
X-BAPI-TIMESTAMP: 1694402559000
X-BAPI-RECV-WINDOW: 5000

Response Example

{
"retCode": 0,
"retMsg": "OK",
"result": {
"list": [
{
"orderId": "1234567890",
"orderLinkId": "my-order-001",
"symbol": "ETHUSDT-28AUG26-2450-2570-OUT",
"symbolId": "100001",
"side": "Buy",
"orderStatus": "New",
"payoutRatio": "1.95",
"cumExecValue": "0",
"cumExecFee": "0",
"leavesValue": "50",
"ecContractType": "UpDown",
"ecDirection": "UP",
"ecOrderValue": "50",
"ecSettleTime": "1694515498753",
"ecTargetPrice": "",
"ecLowerBound": "",
"ecUpperBound": "",
"ecDurationWindow": "300",
"ecIndexPrice": "26000.5",
"orderAvgPayoutRatio": "0",
"createType": "CreateByUser",
"createdTime": "1694402559843",
"updatedTime": "1694402559843"
}
],
"nextPageCursor": ""
},
"retExtInfo": {},
"time": 1694402560000
}