Cancel Order
caution
You could cancel those unfilled or partially filled orders.
HTTP Request
POST /unified/v3/private/order/cancel
Request Parameters
Parameter | Required | Type | Comments |
---|---|---|---|
category | true | string | Product type. linear , option |
symbol | true | string | Symbol name |
orderId | false | string | Order id. Either orderId or orderLinkId is required |
orderLinkId | false | string | User customised order id. Either orderId or orderLinkId is required |
orderFilter | false | string | Order : active order, StopOrder : conditional order |
Response Parameters
Parameter | Type | Comments |
---|---|---|
orderId | string | Order ID |
orderLinkId | string | User 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"
}
}