upstox-python-sdk 2.17.0__tar.gz → 2.19.0__tar.gz

upstox_python_sdk-2.17.0/README.md → upstox-python-sdk-2.19.0/PKG-INFO

@@ -1,3 +1,14 @@
+Metadata-Version: 2.1
+Name: upstox-python-sdk
+Version: 2.19.0
+Summary: Upstox Developer API
+Home-page: https://github.com/upstox/upstox-python
+License: MIT
+Keywords: Upstox Developer API
+Platform: UNKNOWN
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+
 # Upstox Python SDK for API v2
 
 [![PyPI](https://img.shields.io/pypi/v/upstox-python-sdk?label=upstox-python-sdk)](https://pypi.python.org/pypi/upstox-python-sdk)
@@ -9,7 +20,7 @@ The official Python client for communicating with the <a href="https://upstox.co
 Upstox API is a set of rest APIs that provide data required to build a complete investment and trading platform. Execute orders in real time, manage user portfolio, stream live market data (using Websocket), and more, with the easy to understand API collection. 
 
 - API version: v2
-- Package version: 2.17.0
+- Package version: 2.19.0
 - Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
 
 This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project.
@@ -73,7 +84,31 @@ except ApiException as e:
 ```
 To learn more about the sandbox environment and the available sandbox APIs, please visit the [Upstox API documentation - Sandbox](https://upstox.com/developer/api-documentation/sandbox).
 
+## Algo ID Support
+
+The SDK supports passing an algorithm ID for order tracking and management. When provided, the SDK will pass the algo ID as `X-Algo-Id` header.
 
+```python
+import upstox_client
+from upstox_client.rest import ApiException
+
+configuration = upstox_client.Configuration()
+configuration.access_token = 'ACCESS_TOKEN'
+
+api_instance = upstox_client.OrderApiV3(upstox_client.ApiClient(configuration))
+body = upstox_client.PlaceOrderV3Request(quantity=1, product="D", validity="DAY", price=0, 
+                                        instrument_token="NSE_EQ|INE528G01035", order_type="MARKET", 
+                                        transaction_type="BUY", disclosed_quantity=0, trigger_price=0, 
+                                        is_amo=False, slice=True)
+
+try:
+    api_response = api_instance.place_order(body, algo_id="your-algo-id")
+    print(api_response)
+except ApiException as e:
+    print("Exception when calling OrderApiV3->place_order: %s\n" % e)
+```
+
+Other order methods (modify, cancel, etc.) follow the same pattern by accepting an optional `algo_id` as a keyword parameter.
 
 ## Examples
 
@@ -158,9 +193,6 @@ Both functions are designed to simplify the process of subscribing to essential
 
 ### MarketDataStreamer
 
-<details>
-<summary style="cursor: pointer; font-size: 1.2em;">V3</summary>
-<p>
 
 The `MarketDataStreamerV3` interface is designed for effortless connection to the market WebSocket, enabling users to receive instantaneous updates on various instruments. The following example demonstrates how to quickly set up and start receiving market updates for selected instrument keys:
 
@@ -432,285 +464,8 @@ if __name__ == "__main__":
 ```
 
 <br/>
-</p>
-</details>
-
-<details>
-<summary style="cursor: pointer; font-size: 1.2em;">V2</summary>
-<p>
-
-The `MarketDataStreamer` interface is designed for effortless connection to the market WebSocket, enabling users to receive instantaneous updates on various instruments. The following example demonstrates how to quickly set up and start receiving market updates for selected instrument keys:
-
-```python
-import upstox_client
-
-def on_message(message):
-    print(message)
-
-
-def main():
-    configuration = upstox_client.Configuration()
-    access_token = <ACCESS_TOKEN>
-    configuration.access_token = access_token
-
-    streamer = upstox_client.MarketDataStreamer(
-        upstox_client.ApiClient(configuration), ["NSE_INDEX|Nifty 50", "NSE_INDEX|Nifty Bank"], "full")
-
-    streamer.on("message", on_message)
-
-    streamer.connect()
-
-
-if __name__ == "__main__":
-    main()
-```
-
-In this example, you first authenticate using an access token, then instantiate MarketDataStreamer with specific instrument keys and a subscription mode. Upon connecting, the streamer listens for market updates, which are logged to the console as they arrive.
-
-Feel free to adjust the access token placeholder and any other specifics to better fit your actual implementation or usage scenario.
-
-### Exploring the MarketDataStreamer Functionality
-
-#### Modes
-- **ltpc**: ltpc provides information solely about the most recent trade, encompassing details such as the last trade price, time of the last trade, quantity traded, and the closing price from the previous day.
-- **full**: The full option offers comprehensive information, including the latest trade prices, D5 depth, 1-minute, 30-minute, and daily candlestick data, along with some additional details.
-
-#### Functions
-1. **constructor MarketDataStreamer(apiClient, instrumentKeys, mode)**: Initializes the streamer with optional instrument keys and mode (`full` or `ltpc`).
-2. **connect()**: Establishes the WebSocket connection.
-3. **subscribe(instrumentKeys, mode)**: Subscribes to updates for given instrument keys in the specified mode. Both parameters are mandatory.
-4. **unsubscribe(instrumentKeys)**: Stops updates for the specified instrument keys.
-5. **changeMode(instrumentKeys, mode)**: Switches the mode for already subscribed instrument keys.
-6. **disconnect()**: Ends the active WebSocket connection.
-7. **auto_reconnect(enable, interval, retryCount)**: Customizes auto-reconnect functionality. Parameters include a flag to enable/disable it, the interval(in seconds) between attempts, and the maximum number of retries.
-
-#### Events
-- **open**: Emitted upon successful connection establishment.
-- **close**: Indicates the WebSocket connection has been closed.
-- **message**: Delivers market updates.
-- **error**: Signals an error has occurred.
-- **reconnecting**: Announced when a reconnect attempt is initiated.
-- **autoReconnectStopped**: Informs when auto-reconnect efforts have ceased after exhausting the retry count.
-
-The following documentation includes examples to illustrate the usage of these functions and events, providing a practical understanding of how to interact with the MarketDataStreamer effectively.
-
-<br/>
-
-1. Subscribing to Market Data on Connection Open with MarketDataStreamer
-
-```python
-import upstox_client
-
-def main():
-    configuration = upstox_client.Configuration()
-    access_token = <ACCESS_TOKEN>
-    configuration.access_token = access_token
-
-    streamer = upstox_client.MarketDataStreamer(
-        upstox_client.ApiClient(configuration))
-
-    def on_open():
-        streamer.subscribe(
-            ["NSE_EQ|INE020B01018", "NSE_EQ|INE467B01029"], "full")
-
-    def on_message(message):
-        print(message)
-
-    streamer.on("open", on_open)
-    streamer.on("message", on_message)
-
-    streamer.connect()
-
-if __name__ == "__main__":
-    main()
-```
-
-<br/>
-
-2. Subscribing to Instruments with Delays
-
-```python
-import upstox_client
-import time
-
-
-def main():
-    configuration = upstox_client.Configuration()
-    access_token = <ACCESS_TOKEN>
-    configuration.access_token = access_token
-
-    streamer = upstox_client.MarketDataStreamer(
-        upstox_client.ApiClient(configuration))
-
-    def on_open():
-        streamer.subscribe(
-            ["NSE_EQ|INE020B01018"], "full")
-
-    # Handle incoming market data messages\
-    def on_message(message):
-        print(message)
-
-    streamer.on("open", on_open)
-    streamer.on("message", on_message)
-
-    streamer.connect()
-
-    time.sleep(5)
-    streamer.subscribe(
-        ["NSE_EQ|INE467B01029"], "full")
-
-
-if __name__ == "__main__":
-    main()
-
-```
-
-<br/>
-
-3. Subscribing and Unsubscribing to Instruments
-
-```python
-import upstox_client
-import time
-
-
-def main():
-    configuration = upstox_client.Configuration()
-    access_token = <ACCESS_TOKEN>
-    configuration.access_token = access_token
-
-    streamer = upstox_client.MarketDataStreamer(
-        upstox_client.ApiClient(configuration))
-
-    def on_open():
-        print("Connected. Subscribing to instrument keys.")
-        streamer.subscribe(
-            ["NSE_EQ|INE020B01018", "NSE_EQ|INE467B01029"], "full")
-
-    # Handle incoming market data messages\
-    def on_message(message):
-        print(message)
-
-    streamer.on("open", on_open)
-    streamer.on("message", on_message)
-
-    streamer.connect()
-
-    time.sleep(5)
-    print("Unsubscribing from instrument keys.")
-    streamer.unsubscribe(["NSE_EQ|INE020B01018", "NSE_EQ|INE467B01029"])
-
-
-if __name__ == "__main__":
-    main()
-```
-
-<br/>
-
-4. Subscribe, Change Mode and Unsubscribe
-
-```python
-import upstox_client
-import time
-
-def main():
-    configuration = upstox_client.Configuration()
-    access_token = <ACCESS_TOKEN>
-    configuration.access_token = access_token
-
-    streamer = upstox_client.MarketDataStreamer(
-        upstox_client.ApiClient(configuration))
-
-    def on_open():
-        print("Connected. Subscribing to instrument keys.")
-        streamer.subscribe(
-            ["NSE_EQ|INE020B01018", "NSE_EQ|INE467B01029"], "full")
-
-    # Handle incoming market data messages\
-    def on_message(message):
-        print(message)
-
-    streamer.on("open", on_open)
-    streamer.on("message", on_message)
-
-    streamer.connect()
-
-    time.sleep(5)
-    print("Changing subscription mode to ltpc...")
-    streamer.change_mode(
-        ["NSE_EQ|INE020B01018", "NSE_EQ|INE467B01029"], "ltpc")
-
-    time.sleep(5)
-    print("Unsubscribing from instrument keys.")
-    streamer.unsubscribe(["NSE_EQ|INE020B01018", "NSE_EQ|INE467B01029"])
-
-
-if __name__ == "__main__":
-    main()
-```
-
-<br/>
-
-5. Disable Auto-Reconnect
-
-```python
-import upstox_client
-import time
-
-
-def main():
-    configuration = upstox_client.Configuration()
-    access_token = <ACCESS_TOKEN>
-    configuration.access_token = access_token
-
-    streamer = upstox_client.MarketDataStreamer(
-        upstox_client.ApiClient(configuration))
-
-    def on_reconnection_halt(message):
-        print(message)
-
-    streamer.on("autoReconnectStopped", on_reconnection_halt)
-
-    # Disable auto-reconnect feature
-    streamer.auto_reconnect(False)
-
-    streamer.connect()
-
-
-if __name__ == "__main__":
-    main()
-```
-
-<br/>
-
-6. Modify Auto-Reconnect parameters
-
-```python
-import upstox_client
-
-
-def main():
-    configuration = upstox_client.Configuration()
-    access_token = <ACCESS_TOKEN>
-    configuration.access_token = access_token
-
-    streamer = upstox_client.MarketDataStreamer(
-        upstox_client.ApiClient(configuration))
-
-    # Modify auto-reconnect parameters: enable it, set interval to 10 seconds, and retry count to 3
-    streamer.auto_reconnect(True, 10, 3)
-
-    streamer.connect()
 
 
-if __name__ == "__main__":
-    main()
-```
-
-<br/>
-</p>
-</details>
-
 ### PortfolioDataStreamer
 
 Connecting to the Portfolio WebSocket for real-time order updates is straightforward with the PortfolioDataStreamer function. Below is a concise guide to get you started on receiving updates:
@@ -929,3 +684,5 @@ if __name__ == "__main__":
  - [WebsocketAuthRedirectResponse](docs/WebsocketAuthRedirectResponse.md)
  - [WebsocketAuthRedirectResponseData](docs/WebsocketAuthRedirectResponseData.md)
 
+
+

upstox_python_sdk-2.17.0/PKG-INFO → upstox-python-sdk-2.19.0/README.md

@@ -1,28 +1,3 @@
-Metadata-Version: 2.4
-Name: upstox-python-sdk
-Version: 2.17.0
-Summary: Upstox Developer API
-Home-page: https://github.com/upstox/upstox-python
-License: MIT
-Keywords: Upstox Developer API
-Description-Content-Type: text/markdown
-License-File: LICENSE.txt
-Requires-Dist: urllib3>=1.15
-Requires-Dist: six>=1.10
-Requires-Dist: certifi
-Requires-Dist: python-dateutil
-Requires-Dist: websocket-client
-Requires-Dist: uuid
-Requires-Dist: protobuf
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: license-file
-Dynamic: requires-dist
-Dynamic: summary
-
 # Upstox Python SDK for API v2
 
 [![PyPI](https://img.shields.io/pypi/v/upstox-python-sdk?label=upstox-python-sdk)](https://pypi.python.org/pypi/upstox-python-sdk)
@@ -34,7 +9,7 @@ The official Python client for communicating with the <a href="https://upstox.co
 Upstox API is a set of rest APIs that provide data required to build a complete investment and trading platform. Execute orders in real time, manage user portfolio, stream live market data (using Websocket), and more, with the easy to understand API collection. 
 
 - API version: v2
-- Package version: 2.17.0
+- Package version: 2.19.0
 - Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
 
 This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project.
@@ -98,7 +73,31 @@ except ApiException as e:
 ```
 To learn more about the sandbox environment and the available sandbox APIs, please visit the [Upstox API documentation - Sandbox](https://upstox.com/developer/api-documentation/sandbox).
 
+## Algo ID Support
+
+The SDK supports passing an algorithm ID for order tracking and management. When provided, the SDK will pass the algo ID as `X-Algo-Id` header.
 
+```python
+import upstox_client
+from upstox_client.rest import ApiException
+
+configuration = upstox_client.Configuration()
+configuration.access_token = 'ACCESS_TOKEN'
+
+api_instance = upstox_client.OrderApiV3(upstox_client.ApiClient(configuration))
+body = upstox_client.PlaceOrderV3Request(quantity=1, product="D", validity="DAY", price=0, 
+                                        instrument_token="NSE_EQ|INE528G01035", order_type="MARKET", 
+                                        transaction_type="BUY", disclosed_quantity=0, trigger_price=0, 
+                                        is_amo=False, slice=True)
+
+try:
+    api_response = api_instance.place_order(body, algo_id="your-algo-id")
+    print(api_response)
+except ApiException as e:
+    print("Exception when calling OrderApiV3->place_order: %s\n" % e)
+```
+
+Other order methods (modify, cancel, etc.) follow the same pattern by accepting an optional `algo_id` as a keyword parameter.
 
 ## Examples
 
@@ -183,9 +182,6 @@ Both functions are designed to simplify the process of subscribing to essential
 
 ### MarketDataStreamer
 
-<details>
-<summary style="cursor: pointer; font-size: 1.2em;">V3</summary>
-<p>
 
 The `MarketDataStreamerV3` interface is designed for effortless connection to the market WebSocket, enabling users to receive instantaneous updates on various instruments. The following example demonstrates how to quickly set up and start receiving market updates for selected instrument keys:
 
@@ -457,284 +453,7 @@ if __name__ == "__main__":
 ```
 
 <br/>
-</p>
-</details>
-
-<details>
-<summary style="cursor: pointer; font-size: 1.2em;">V2</summary>
-<p>
-
-The `MarketDataStreamer` interface is designed for effortless connection to the market WebSocket, enabling users to receive instantaneous updates on various instruments. The following example demonstrates how to quickly set up and start receiving market updates for selected instrument keys:
-
-```python
-import upstox_client
-
-def on_message(message):
-    print(message)
-
-
-def main():
-    configuration = upstox_client.Configuration()
-    access_token = <ACCESS_TOKEN>
-    configuration.access_token = access_token
-
-    streamer = upstox_client.MarketDataStreamer(
-        upstox_client.ApiClient(configuration), ["NSE_INDEX|Nifty 50", "NSE_INDEX|Nifty Bank"], "full")
-
-    streamer.on("message", on_message)
-
-    streamer.connect()
-
-
-if __name__ == "__main__":
-    main()
-```
-
-In this example, you first authenticate using an access token, then instantiate MarketDataStreamer with specific instrument keys and a subscription mode. Upon connecting, the streamer listens for market updates, which are logged to the console as they arrive.
-
-Feel free to adjust the access token placeholder and any other specifics to better fit your actual implementation or usage scenario.
-
-### Exploring the MarketDataStreamer Functionality
-
-#### Modes
-- **ltpc**: ltpc provides information solely about the most recent trade, encompassing details such as the last trade price, time of the last trade, quantity traded, and the closing price from the previous day.
-- **full**: The full option offers comprehensive information, including the latest trade prices, D5 depth, 1-minute, 30-minute, and daily candlestick data, along with some additional details.
-
-#### Functions
-1. **constructor MarketDataStreamer(apiClient, instrumentKeys, mode)**: Initializes the streamer with optional instrument keys and mode (`full` or `ltpc`).
-2. **connect()**: Establishes the WebSocket connection.
-3. **subscribe(instrumentKeys, mode)**: Subscribes to updates for given instrument keys in the specified mode. Both parameters are mandatory.
-4. **unsubscribe(instrumentKeys)**: Stops updates for the specified instrument keys.
-5. **changeMode(instrumentKeys, mode)**: Switches the mode for already subscribed instrument keys.
-6. **disconnect()**: Ends the active WebSocket connection.
-7. **auto_reconnect(enable, interval, retryCount)**: Customizes auto-reconnect functionality. Parameters include a flag to enable/disable it, the interval(in seconds) between attempts, and the maximum number of retries.
-
-#### Events
-- **open**: Emitted upon successful connection establishment.
-- **close**: Indicates the WebSocket connection has been closed.
-- **message**: Delivers market updates.
-- **error**: Signals an error has occurred.
-- **reconnecting**: Announced when a reconnect attempt is initiated.
-- **autoReconnectStopped**: Informs when auto-reconnect efforts have ceased after exhausting the retry count.
-
-The following documentation includes examples to illustrate the usage of these functions and events, providing a practical understanding of how to interact with the MarketDataStreamer effectively.
-
-<br/>
-
-1. Subscribing to Market Data on Connection Open with MarketDataStreamer
-
-```python
-import upstox_client
-
-def main():
-    configuration = upstox_client.Configuration()
-    access_token = <ACCESS_TOKEN>
-    configuration.access_token = access_token
-
-    streamer = upstox_client.MarketDataStreamer(
-        upstox_client.ApiClient(configuration))
-
-    def on_open():
-        streamer.subscribe(
-            ["NSE_EQ|INE020B01018", "NSE_EQ|INE467B01029"], "full")
-
-    def on_message(message):
-        print(message)
-
-    streamer.on("open", on_open)
-    streamer.on("message", on_message)
-
-    streamer.connect()
-
-if __name__ == "__main__":
-    main()
-```
-
-<br/>
-
-2. Subscribing to Instruments with Delays
-
-```python
-import upstox_client
-import time
-
-
-def main():
-    configuration = upstox_client.Configuration()
-    access_token = <ACCESS_TOKEN>
-    configuration.access_token = access_token
-
-    streamer = upstox_client.MarketDataStreamer(
-        upstox_client.ApiClient(configuration))
-
-    def on_open():
-        streamer.subscribe(
-            ["NSE_EQ|INE020B01018"], "full")
-
-    # Handle incoming market data messages\
-    def on_message(message):
-        print(message)
-
-    streamer.on("open", on_open)
-    streamer.on("message", on_message)
-
-    streamer.connect()
-
-    time.sleep(5)
-    streamer.subscribe(
-        ["NSE_EQ|INE467B01029"], "full")
-
-
-if __name__ == "__main__":
-    main()
-
-```
-
-<br/>
-
-3. Subscribing and Unsubscribing to Instruments
-
-```python
-import upstox_client
-import time
-
-
-def main():
-    configuration = upstox_client.Configuration()
-    access_token = <ACCESS_TOKEN>
-    configuration.access_token = access_token
-
-    streamer = upstox_client.MarketDataStreamer(
-        upstox_client.ApiClient(configuration))
-
-    def on_open():
-        print("Connected. Subscribing to instrument keys.")
-        streamer.subscribe(
-            ["NSE_EQ|INE020B01018", "NSE_EQ|INE467B01029"], "full")
-
-    # Handle incoming market data messages\
-    def on_message(message):
-        print(message)
-
-    streamer.on("open", on_open)
-    streamer.on("message", on_message)
-
-    streamer.connect()
-
-    time.sleep(5)
-    print("Unsubscribing from instrument keys.")
-    streamer.unsubscribe(["NSE_EQ|INE020B01018", "NSE_EQ|INE467B01029"])
-
-
-if __name__ == "__main__":
-    main()
-```
-
-<br/>
-
-4. Subscribe, Change Mode and Unsubscribe
-
-```python
-import upstox_client
-import time
-
-def main():
-    configuration = upstox_client.Configuration()
-    access_token = <ACCESS_TOKEN>
-    configuration.access_token = access_token
-
-    streamer = upstox_client.MarketDataStreamer(
-        upstox_client.ApiClient(configuration))
-
-    def on_open():
-        print("Connected. Subscribing to instrument keys.")
-        streamer.subscribe(
-            ["NSE_EQ|INE020B01018", "NSE_EQ|INE467B01029"], "full")
 
-    # Handle incoming market data messages\
-    def on_message(message):
-        print(message)
-
-    streamer.on("open", on_open)
-    streamer.on("message", on_message)
-
-    streamer.connect()
-
-    time.sleep(5)
-    print("Changing subscription mode to ltpc...")
-    streamer.change_mode(
-        ["NSE_EQ|INE020B01018", "NSE_EQ|INE467B01029"], "ltpc")
-
-    time.sleep(5)
-    print("Unsubscribing from instrument keys.")
-    streamer.unsubscribe(["NSE_EQ|INE020B01018", "NSE_EQ|INE467B01029"])
-
-
-if __name__ == "__main__":
-    main()
-```
-
-<br/>
-
-5. Disable Auto-Reconnect
-
-```python
-import upstox_client
-import time
-
-
-def main():
-    configuration = upstox_client.Configuration()
-    access_token = <ACCESS_TOKEN>
-    configuration.access_token = access_token
-
-    streamer = upstox_client.MarketDataStreamer(
-        upstox_client.ApiClient(configuration))
-
-    def on_reconnection_halt(message):
-        print(message)
-
-    streamer.on("autoReconnectStopped", on_reconnection_halt)
-
-    # Disable auto-reconnect feature
-    streamer.auto_reconnect(False)
-
-    streamer.connect()
-
-
-if __name__ == "__main__":
-    main()
-```
-
-<br/>
-
-6. Modify Auto-Reconnect parameters
-
-```python
-import upstox_client
-
-
-def main():
-    configuration = upstox_client.Configuration()
-    access_token = <ACCESS_TOKEN>
-    configuration.access_token = access_token
-
-    streamer = upstox_client.MarketDataStreamer(
-        upstox_client.ApiClient(configuration))
-
-    # Modify auto-reconnect parameters: enable it, set interval to 10 seconds, and retry count to 3
-    streamer.auto_reconnect(True, 10, 3)
-
-    streamer.connect()
-
-
-if __name__ == "__main__":
-    main()
-```
-
-<br/>
-</p>
-</details>
 
 ### PortfolioDataStreamer