Cancel GTT Order

This API allows you to cancel a pending GTT order.

USE CASE

Cancel a GTT order you no longer need, for example after exiting the position another way.

Details

You can cancel pending orders before they trigger.
Send only the id of the GTT order. It is returned when you place the order and is also listed in the GTT Order Book.
Response code 1103 means the cancellation was successful. Other codes are specific error conditions.
Confirm the result in the GTT Order Book, where a cancelled order shows ord_status 1 and report_type CANCELLED.
Rate limits differ between the Standard and Prime plans. See Plans & rate limits.

Request Attributes - For each order

Attribute	Data Type	Description
`id`*	string	Unique identifier for the order to be cancelled, e.g., "25010700000001".

Response Attributes

Attribute	Data Type	Description
`s`	string	ok / error
`code`	int	Status code indicating the outcome of the cancellation request: 1103: Order cancellation successful. Other codes represent specific error conditions.
`message`	string	Descriptive message about the cancellation request, e.g., "Successfully cancelled order".
`id`	string	Unique identifier for the cancelled order, returned if the cancellation is successful.

Request

from fyers_apiv3 import fyersModel

client_id = "XC4XXXXM-100"
access_token = "eyJ0eXXXXXXXX2c5-Y3RgS8wR14g"

# Initialize the FyersModel instance with your client_id, access_token, and enable async mode
fyers = fyersModel.FyersModel(client_id=client_id, is_async=False, token=access_token, log_path="")


data = {"id":'25012400002099'}

response = fyers.cancel_gtt_order(data=data)
print(response)

{
  "code": 1103,
  "message": "Successfully cancelled order",
  "s": "ok",
  "id": "25012400002099"
}