fyers-apiv3 3.1.8__tar.gz → 3.1.9__tar.gz

{fyers_apiv3-3.1.8 → fyers_apiv3-3.1.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fyers_apiv3
-Version: 3.1.8
+Version: 3.1.9
 Summary: Fyers trading APIs.
 Home-page: https://github.com/FyersDev/fyers-api-sample-code/tree/sample_v3/v3/python
 Author: Fyers-Tech
@@ -182,7 +182,8 @@ data =  {
       "disclosedQty":0,
       "offlineOrder":False,
       "stopLoss":0,
-      "takeProfit":0
+      "takeProfit":0,
+      "isSliceOrder":False
     }                              ## This is a sample example to place a limit order you can make the further changes based on your requriements 
 
 print(fyers.place_order(data))
@@ -350,6 +351,230 @@ data = {"symbol":"NSE:SBIN-EQ","ohlcv_flag":"1"}
 print(fyers.depth(data))
 
 
+#################################################################################################################
+
+"""
+PRICE ALERTS : This includes following APIs (create_alert, get_alert, update_alert, delete_alert, toggle_alert)
+"""
+
+## Create Price Alert
+data = {
+    "agent": "fyers-api",
+    "alert-type": 1,
+    "name": "gold alert",
+    "symbol": "NSE:GOLDBEES-EQ",
+    "comparisonType": "LTP",
+    "condition": "GT",
+    "value": "9888",
+    "notes": " iji"
+}
+
+print(fyers.create_alert(data))
+
+## Get Price Alerts
+# Get all active alerts
+print(fyers.get_alert())
+
+# Get archived alerts
+data = {"archive": "1"}
+print(fyers.get_alert(data))
+
+## Update Price Alert
+data = {
+    "alertId": "6249977",
+    "agent": "fyers-api",
+    "alert-type": 1,
+    "name": "goldy bees",
+    "symbol": "NSE:GOLDBEES-EQ",
+    "comparisonType": "OPEN",
+    "condition": "GT",
+    "value": "10000.00676766767676676667"
+}
+
+print(fyers.update_alert(data))
+
+## Delete Price Alert
+data = {"alertId": "6131416", "agent": "fyers-api"}
+print(fyers.delete_alert(data))
+
+## Toggle Price Alert (Enable/Disable)
+data = {"alertId": "3870991"}
+print(fyers.toggle_alert(data))
+
+
+#################################################################################################################
+
+"""
+SMART ORDERS : This includes following APIs (create, modify, cancel, pause, resume, orderbook)
+Smart orders support different flow types: step, limit, trail, sip
+"""
+
+## Create Smart Order - Step
+data = {
+    "symbol": "NSE:SBIN-EQ",
+    "qty": 10,
+    "type": 1,
+    "side": 1,
+    "productType": "INTRADAY",
+    "limitPrice": 600.00,
+    "stopPrice": 0,
+    "validity": "DAY",
+    "disclosedQty": 0,
+    "offlineOrder": False
+}
+
+print(fyers.create_smart_order_step(data))
+
+## Create Smart Order - Limit
+data = {
+    "symbol": "NSE:SBIN-EQ",
+    "qty": 10,
+    "type": 1,
+    "side": 1,
+    "productType": "INTRADAY",
+    "limitPrice": 600.00,
+    "stopPrice": 0,
+    "validity": "DAY",
+    "disclosedQty": 0,
+    "offlineOrder": False
+}
+
+print(fyers.create_smart_order_limit(data))
+
+## Create Smart Order - Trail
+data = {
+    "symbol": "NSE:SBIN-EQ",
+    "qty": 10,
+    "type": 1,
+    "side": 1,
+    "productType": "INTRADAY",
+    "limitPrice": 600.00,
+    "stopPrice": 0,
+    "validity": "DAY",
+    "disclosedQty": 0,
+    "offlineOrder": False
+}
+
+print(fyers.create_smart_order_trail(data))
+
+## Create Smart Order - SIP
+data = {
+    "symbol": "NSE:SBIN-EQ",
+    "qty": 10,
+    "type": 1,
+    "side": 1,
+    "productType": "CNC",
+    "limitPrice": 600.00,
+    "stopPrice": 0,
+    "validity": "DAY",
+    "disclosedQty": 0,
+    "offlineOrder": False
+}
+
+print(fyers.create_smart_order_sip(data))
+
+## Modify Smart Order
+data = {
+    "flowId": "123456789",
+    "limitPrice": 610.00,
+    "qty": 15
+}
+
+print(fyers.modify_smart_order(data))
+
+## Cancel Smart Order
+data = {"flowId": "123456789"}
+print(fyers.cancel_order(data))
+
+## Pause Smart Order
+data = {"flowId": "123456789"}
+print(fyers.pause_order(data))
+
+## Resume Smart Order
+data = {"flowId": "123456789"}
+print(fyers.resume_order(data))
+
+## Get Smart Order Book with Filter
+# Get all smart orders
+print(fyers.smart_orderbook_with_filter())
+
+# Get filtered smart orders
+# Filter by side (1 for Buy, -1 for Sell)
+data = {"side": [1]}
+print(fyers.smart_orderbook_with_filter(data))
+
+# Filter by multiple parameters
+data = {
+    "exchange": ["NSE"],
+    "side": [1, -1],
+    "flowtype": [1, 2],
+    "product": ["CNC", "INTRADAY"],
+    "messageType": [1, 2],
+    "search": "SBIN",
+    "sort_by": "CreatedTime",
+    "ord_by": 1,
+    "page_no": 1,
+    "page_size": 15
+}
+print(fyers.smart_orderbook_with_filter(data))
+
+
+#################################################################################################################
+
+"""
+SMART EXIT TRIGGERS : This includes following APIs (create, get, update, activate)
+"""
+
+## Create Smart Exit Trigger
+
+# Type 1: Only Alert (notification only, no auto-exit)
+data = {
+    "name": "Alert Only Strategy",
+    "type": 1,
+    "profitRate": 5000,
+    "lossRate": -2000
+}
+print(fyers.create_smartexit_trigger(data))
+
+# Type 2: Exit with Alert (notification + immediate exit)
+data = {
+    "name": "Auto Exit Strategy",
+    "type": 2,
+    "profitRate": 5000,
+    "lossRate": -2000
+}
+print(fyers.create_smartexit_trigger(data))
+
+# Type 3: Exit with Alert + Wait for Recovery (notification + delayed exit)
+data = {
+    "name": "Recovery Exit Strategy",
+    "type": 3,
+    "profitRate": 10000,
+    "lossRate": -3000,
+    "waitTime": 5
+}
+print(fyers.create_smartexit_trigger(data))
+
+## Get Smart Exit Triggers
+# Get all smart exit triggers
+print(fyers.get_smartexit_triggers())
+
+
+## Update Smart Exit Trigger
+data = {
+    "flowId": "123456789",
+    "triggerPrice": 610.00,
+    "stopLoss": 600.00,
+    "takeProfit": 630.00
+}
+
+print(fyers.update_smartexit_trigger(data))
+
+## Activate Smart Exit Trigger
+data = {"flowId": "123456789"}
+print(fyers.activate_smartexit_trigger(data))
+
+
 ```
 
 ## Getting started with Data Socket
@@ -437,43 +662,61 @@ from fyers_apiv3.FyersWebsocket import order_ws
 
 def onTrade(message):
     """
-    Callback function to handle incoming messages from the FyersDataSocket WebSocket.
+    Callback function to handle incoming trade messages from the FyersOrderSocket WebSocket.
 
     Parameters:
         message (dict): The received message from the WebSocket.
-
+            - message["trades"]: Contains trade data including id_fyers field if present
+            - message["s"]: Status of the message
+    
+    Note: The message may contain an "id_fyers" field in the trades data, which is a unique identifier
+    for Fyers-specific trade tracking.
     """
     print("Trade Response:", message)
 
+
 def onOrder(message):
     """
-    Callback function to handle incoming messages from the FyersDataSocket WebSocket.
+    Callback function to handle incoming order messages from the FyersOrderSocket WebSocket.
 
     Parameters:
         message (dict): The received message from the WebSocket.
-
+            - message["orders"]: Contains order data including id_fyers field if present
+            - message["s"]: Status of the message
+    
+    Note: The message may contain an "id_fyers" field in the orders data, which is a unique identifier
+    for Fyers-specific order tracking.
     """
     print("Order Response:", message)
 
+
 def onPosition(message):
     """
-    Callback function to handle incoming messages from the FyersDataSocket WebSocket.
+    Callback function to handle incoming position messages from the FyersOrderSocket WebSocket.
 
     Parameters:
         message (dict): The received message from the WebSocket.
-
+            - message["positions"]: Contains position data including id_fyers field if present
+            - message["s"]: Status of the message
+    
     """
     print("Position Response:", message)
 
+
 def onGeneral(message):
     """
-    Callback function to handle incoming messages from the FyersDataSocket WebSocket.
+    Callback function to handle incoming general messages from the FyersOrderSocket WebSocket.
+    This includes eDIS updates, price alerts, and login events.
 
     Parameters:
         message (dict): The received message from the WebSocket.
+            - May contain price alerts with id_fyers field if present
+            - May contain eDIS updates
+            - May contain login events
 
     """
     print("General Response:", message)
+
 def onerror(message):
     """
     Callback function to handle WebSocket errors.

{fyers_apiv3-3.1.8 → fyers_apiv3-3.1.9}/README.md

@@ -154,7 +154,8 @@ data =  {
       "disclosedQty":0,
       "offlineOrder":False,
       "stopLoss":0,
-      "takeProfit":0
+      "takeProfit":0,
+      "isSliceOrder":False
     }                              ## This is a sample example to place a limit order you can make the further changes based on your requriements 
 
 print(fyers.place_order(data))
@@ -322,6 +323,230 @@ data = {"symbol":"NSE:SBIN-EQ","ohlcv_flag":"1"}
 print(fyers.depth(data))
 
 
+#################################################################################################################
+
+"""
+PRICE ALERTS : This includes following APIs (create_alert, get_alert, update_alert, delete_alert, toggle_alert)
+"""
+
+## Create Price Alert
+data = {
+    "agent": "fyers-api",
+    "alert-type": 1,
+    "name": "gold alert",
+    "symbol": "NSE:GOLDBEES-EQ",
+    "comparisonType": "LTP",
+    "condition": "GT",
+    "value": "9888",
+    "notes": " iji"
+}
+
+print(fyers.create_alert(data))
+
+## Get Price Alerts
+# Get all active alerts
+print(fyers.get_alert())
+
+# Get archived alerts
+data = {"archive": "1"}
+print(fyers.get_alert(data))
+
+## Update Price Alert
+data = {
+    "alertId": "6249977",
+    "agent": "fyers-api",
+    "alert-type": 1,
+    "name": "goldy bees",
+    "symbol": "NSE:GOLDBEES-EQ",
+    "comparisonType": "OPEN",
+    "condition": "GT",
+    "value": "10000.00676766767676676667"
+}
+
+print(fyers.update_alert(data))
+
+## Delete Price Alert
+data = {"alertId": "6131416", "agent": "fyers-api"}
+print(fyers.delete_alert(data))
+
+## Toggle Price Alert (Enable/Disable)
+data = {"alertId": "3870991"}
+print(fyers.toggle_alert(data))
+
+
+#################################################################################################################
+
+"""
+SMART ORDERS : This includes following APIs (create, modify, cancel, pause, resume, orderbook)
+Smart orders support different flow types: step, limit, trail, sip
+"""
+
+## Create Smart Order - Step
+data = {
+    "symbol": "NSE:SBIN-EQ",
+    "qty": 10,
+    "type": 1,
+    "side": 1,
+    "productType": "INTRADAY",
+    "limitPrice": 600.00,
+    "stopPrice": 0,
+    "validity": "DAY",
+    "disclosedQty": 0,
+    "offlineOrder": False
+}
+
+print(fyers.create_smart_order_step(data))
+
+## Create Smart Order - Limit
+data = {
+    "symbol": "NSE:SBIN-EQ",
+    "qty": 10,
+    "type": 1,
+    "side": 1,
+    "productType": "INTRADAY",
+    "limitPrice": 600.00,
+    "stopPrice": 0,
+    "validity": "DAY",
+    "disclosedQty": 0,
+    "offlineOrder": False
+}
+
+print(fyers.create_smart_order_limit(data))
+
+## Create Smart Order - Trail
+data = {
+    "symbol": "NSE:SBIN-EQ",
+    "qty": 10,
+    "type": 1,
+    "side": 1,
+    "productType": "INTRADAY",
+    "limitPrice": 600.00,
+    "stopPrice": 0,
+    "validity": "DAY",
+    "disclosedQty": 0,
+    "offlineOrder": False
+}
+
+print(fyers.create_smart_order_trail(data))
+
+## Create Smart Order - SIP
+data = {
+    "symbol": "NSE:SBIN-EQ",
+    "qty": 10,
+    "type": 1,
+    "side": 1,
+    "productType": "CNC",
+    "limitPrice": 600.00,
+    "stopPrice": 0,
+    "validity": "DAY",
+    "disclosedQty": 0,
+    "offlineOrder": False
+}
+
+print(fyers.create_smart_order_sip(data))
+
+## Modify Smart Order
+data = {
+    "flowId": "123456789",
+    "limitPrice": 610.00,
+    "qty": 15
+}
+
+print(fyers.modify_smart_order(data))
+
+## Cancel Smart Order
+data = {"flowId": "123456789"}
+print(fyers.cancel_order(data))
+
+## Pause Smart Order
+data = {"flowId": "123456789"}
+print(fyers.pause_order(data))
+
+## Resume Smart Order
+data = {"flowId": "123456789"}
+print(fyers.resume_order(data))
+
+## Get Smart Order Book with Filter
+# Get all smart orders
+print(fyers.smart_orderbook_with_filter())
+
+# Get filtered smart orders
+# Filter by side (1 for Buy, -1 for Sell)
+data = {"side": [1]}
+print(fyers.smart_orderbook_with_filter(data))
+
+# Filter by multiple parameters
+data = {
+    "exchange": ["NSE"],
+    "side": [1, -1],
+    "flowtype": [1, 2],
+    "product": ["CNC", "INTRADAY"],
+    "messageType": [1, 2],
+    "search": "SBIN",
+    "sort_by": "CreatedTime",
+    "ord_by": 1,
+    "page_no": 1,
+    "page_size": 15
+}
+print(fyers.smart_orderbook_with_filter(data))
+
+
+#################################################################################################################
+
+"""
+SMART EXIT TRIGGERS : This includes following APIs (create, get, update, activate)
+"""
+
+## Create Smart Exit Trigger
+
+# Type 1: Only Alert (notification only, no auto-exit)
+data = {
+    "name": "Alert Only Strategy",
+    "type": 1,
+    "profitRate": 5000,
+    "lossRate": -2000
+}
+print(fyers.create_smartexit_trigger(data))
+
+# Type 2: Exit with Alert (notification + immediate exit)
+data = {
+    "name": "Auto Exit Strategy",
+    "type": 2,
+    "profitRate": 5000,
+    "lossRate": -2000
+}
+print(fyers.create_smartexit_trigger(data))
+
+# Type 3: Exit with Alert + Wait for Recovery (notification + delayed exit)
+data = {
+    "name": "Recovery Exit Strategy",
+    "type": 3,
+    "profitRate": 10000,
+    "lossRate": -3000,
+    "waitTime": 5
+}
+print(fyers.create_smartexit_trigger(data))
+
+## Get Smart Exit Triggers
+# Get all smart exit triggers
+print(fyers.get_smartexit_triggers())
+
+
+## Update Smart Exit Trigger
+data = {
+    "flowId": "123456789",
+    "triggerPrice": 610.00,
+    "stopLoss": 600.00,
+    "takeProfit": 630.00
+}
+
+print(fyers.update_smartexit_trigger(data))
+
+## Activate Smart Exit Trigger
+data = {"flowId": "123456789"}
+print(fyers.activate_smartexit_trigger(data))
+
+
 ```
 
 ## Getting started with Data Socket
@@ -409,43 +634,61 @@ from fyers_apiv3.FyersWebsocket import order_ws
 
 def onTrade(message):
     """
-    Callback function to handle incoming messages from the FyersDataSocket WebSocket.
+    Callback function to handle incoming trade messages from the FyersOrderSocket WebSocket.
 
     Parameters:
         message (dict): The received message from the WebSocket.
-
+            - message["trades"]: Contains trade data including id_fyers field if present
+            - message["s"]: Status of the message
+    
+    Note: The message may contain an "id_fyers" field in the trades data, which is a unique identifier
+    for Fyers-specific trade tracking.
     """
     print("Trade Response:", message)
 
+
 def onOrder(message):
     """
-    Callback function to handle incoming messages from the FyersDataSocket WebSocket.
+    Callback function to handle incoming order messages from the FyersOrderSocket WebSocket.
 
     Parameters:
         message (dict): The received message from the WebSocket.
-
+            - message["orders"]: Contains order data including id_fyers field if present
+            - message["s"]: Status of the message
+    
+    Note: The message may contain an "id_fyers" field in the orders data, which is a unique identifier
+    for Fyers-specific order tracking.
     """
     print("Order Response:", message)
 
+
 def onPosition(message):
     """
-    Callback function to handle incoming messages from the FyersDataSocket WebSocket.
+    Callback function to handle incoming position messages from the FyersOrderSocket WebSocket.
 
     Parameters:
         message (dict): The received message from the WebSocket.
-
+            - message["positions"]: Contains position data including id_fyers field if present
+            - message["s"]: Status of the message
+    
     """
     print("Position Response:", message)
 
+
 def onGeneral(message):
     """
-    Callback function to handle incoming messages from the FyersDataSocket WebSocket.
+    Callback function to handle incoming general messages from the FyersOrderSocket WebSocket.
+    This includes eDIS updates, price alerts, and login events.
 
     Parameters:
         message (dict): The received message from the WebSocket.
+            - May contain price alerts with id_fyers field if present
+            - May contain eDIS updates
+            - May contain login events
 
     """
     print("General Response:", message)
+
 def onerror(message):
     """
     Callback function to handle WebSocket errors.