Set Stop Loss & Target

This API allows you to add a Stop Loss and Take Profit to an open position.

USE CASE

Set your exit levels on a position after its entry order has traded.

Details

This allows the user to add Stop Loss and Take Profit to an existing open position.
positionId is mandatory, for example NSE:KWIL-EQ-INTRADAY. Send stopLoss, takeProfit or both.
legType is optional: 1 = offset, 2 = percentage.
qty is optional and its maximum is the position quantity.
The same PATCH /api/v3/positions endpoint is used to modify and to cancel these levels later.
Rate limits differ between the Standard and Prime plans. See Plans & rate limits.

Request Attributes

Attribute	Data Type	Description
`positionId`*	string	Mandatory. Position id Eg: NSE:KWIL-EQ-INTRADAY
`takeProfit`	float	Take profit value
`stopLoss`	float	Stop loss value
`qty`	int	Optional. Max qty should be position qty
`legType`	int	Optional. `1` = offset, `2` = percentage

Response Attributes

Attribute	Data Type	Description
`s`	string	Request status, `ok` on success or `error` on failure
`code`	int	Response code (e.g. `1102` on success)
`message`	string	Status message, e.g. "Successfully modified order"
`id_fyers`	string	Fyers-generated identifier for the position/order operation the stop-loss/target was attached to

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, token=access_token,is_async=False, log_path="")

data = {
    "positionId": "NSE:TMPV-EQ-CNC",
    "takeProfit": 11,
    "stopLoss": 6
}

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

{
  "code": 1102,
  "message": "Successfully modified order",
  "s": "ok",
  "id_fyers": "0ac7e98f-b915-4385-a7d5-fe5cdf555105"
}