Skip to main content

Cancel Order

caution

You could cancel those unfilled or partially filled orders.

HTTP Request

POST /unified/v3/private/order/cancel

Request Parameters

ParameterRequiredTypeComments
categorytruestringProduct type. linear, option
symboltruestringSymbol name
orderIdfalsestringOrder id. Either orderId or orderLinkId is required
orderLinkIdfalsestringUser customised order id. Either orderId or orderLinkId is required
orderFilterfalsestringOrder: active order, StopOrder: conditional order

Response Parameters

ParameterTypeComments
orderIdstringOrder ID
orderLinkIdstringUser customised order id

Request Example

curl --location --request POST 'https://api-testnet.bybit.com/unified/v3/private/order/cancel' \
--header 'X-BAPI-SIGN-TYPE: 2' \
--header 'X-BAPI-SIGN: XXXXX' \
--header 'X-BAPI-API-KEY: {api key}' \
--header 'X-BAPI-TIMESTAMP: 1657871228347' \
--header 'X-BAPI-RECV-WINDOW: 5000' \
--header 'Content-Type: application/json' \
--data-raw '{
"category": "linear",
"orderId": "4c51a45f-7795-4b38-9b66-3c306b73f112",
"symbol": "BTCUSDT"
}'

Response Example

{
"retCode": 0,
"retMsg": "OK",
"result": {
"orderId": "4c51a45f-7795-4b38-9b66-3c306b73f112",
"orderLinkId": "e80d558e-ed"
}
}