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

upstox-python-sdk-2.21.0/PKG-INFO

@@ -0,0 +1,552 @@
+Metadata-Version: 2.1
+Name: upstox-python-sdk
+Version: 2.21.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)
+
+## Introduction
+
+The official Python client for communicating with the <a href="https://upstox.com/developer/api-documentation/open-api">Upstox API</a>.
+
+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.21.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.
+
+## Documentation.
+
+<a href="https://upstox.com/developer/api-documentation">Upstox API Documentation</a>
+
+## Requirements.
+
+Python 2.7 and 3.4+
+
+## Installation & Usage
+### pip install
+
+If the python package is hosted on Github, you can install directly from Github
+
+```sh
+pip install upstox-python-sdk
+```
+(you may need to run `pip` with root permission: `sudo pip install upstox-python-sdk`)
+
+Then import the package:
+```python
+import upstox_client 
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+Then import the package:
+```python
+import upstox_client
+```
+
+## Sandbox Mode
+We recommend using the sandbox environment for testing purposes. To enable sandbox mode, set the `sandbox` flag to `True` in the configuration object.
+
+```python
+import upstox_client
+from upstox_client.rest import ApiException
+
+configuration = upstox_client.Configuration(sandbox=True)
+configuration.access_token = 'SANDBOX_ACCESS_TOKEN'
+
+api_instance = upstox_client.OrderApiV3(upstox_client.ApiClient(configuration))
+body = upstox_client.PlaceOrderV3Request(quantity=1, product="D",validity="DAY", price=9.12, tag="string", instrument_token="NSE_EQ|INE669E01016", order_type="LIMIT",
+                                         transaction_type="BUY", disclosed_quantity=0, trigger_price=0.0, is_amo=True, slice=True)
+
+try:
+    api_response = api_instance.place_order(body)
+    print(api_response)
+except ApiException as e:
+    print("Exception when calling OrderApi->place_order: %s\n" % 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 Name Support
+
+The SDK supports passing an algorithm name for order tracking and management. When provided, the SDK will pass the algo name as `X-Algo-Name` 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=20, 
+                                        instrument_token="NSE_EQ|INE528G01035", order_type="LIMIT", 
+                                        transaction_type="BUY", disclosed_quantity=0, trigger_price=0, 
+                                        is_amo=False, slice=True)
+
+try:
+    api_response = api_instance.place_order(body, algo_name="your-algo-name")
+    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_name` as a keyword parameter.
+
+
+## Documentation for API Endpoints
+
+- Place, Modify, and Cancel Order APIs are relative to `https://api-hft.upstox.com`
+- All other APIs are relative to `https://api.upstox.com`
+
+API Name | HTTP Request | Class | Documentation | Sample Codes
+------------ | ------------- | ------------- | ------------- | -------------
+**Expired Instruments** | | | |
+Get Expiries | **GET** /v2/expired-instruments/expiries| *ExpiredInstrumentApi* | [API Reference](https://upstox.com/developer/api-documentation/get-expiries) | [Sample Code](https://upstox.com/developer/api-documentation/get-expiries#sample-code-python_sdk)
+Get Expired Option Contracts | **GET**  /v2/expired-instruments/option/contract| *ExpiredInstrumentApi* | [API Reference](https://upstox.com/developer/api-documentation/get-expired-option-contracts) | [Sample Code](https://upstox.com/developer/api-documentation/get-expired-option-contracts#sample-code-python_sdk)
+Get Expired Future Contracts | **GET** /v2/expired-instruments/future/contract| *ExpiredInstrumentApi* | [API Reference](https://upstox.com/developer/api-documentation/get-expired-future-contracts) | [Sample Code](https://upstox.com/developer/api-documentation/get-expired-future-contracts#sample-code-python_sdk)
+Get Expired Historical Candle Data | **GET** /v2/expired-instruments/historical-candle/{expired_instrument_key}/{interval}/{to_date}/{from_date}| *ExpiredInstrumentApi* | [API Reference](https://upstox.com/developer/api-documentation/get-expired-historical-candle-data) | [Sample Code](https://upstox.com/developer/api-documentation/get-expired-historical-candle-data#sample-code-python_sdk)
+**Login** | | | |
+Get Token | **POST** /v2/login/authorization/token | *LoginApi* | [API Reference](https://upstox.com/developer/api-documentation/get-token) | [Sample Code](https://upstox.com/developer/api-documentation/get-token#sample-code-python_sdk)
+Access Token Request | **POST** /v3/login/auth/token/request/{client_id} | *LoginApi* | [API Reference](https://upstox.com/developer/api-documentation/access-token-request) | [Sample Code](https://upstox.com/developer/api-documentation/access-token-request#sample-code-python_sdk)
+Logout | **DELETE** /v2/logout | *LoginApi* | [API Reference](https://upstox.com/developer/api-documentation/logout) | [Sample Code](https://upstox.com/developer/api-documentation/logout#sample-code-python_sdk)
+**User** | | | |
+Get Profile | **GET** /v2/user/profile | *UserApi* | [API Reference](https://upstox.com/developer/api-documentation/get-profile) | [Sample Code](https://upstox.com/developer/api-documentation/get-profile#sample-code-python_sdk)
+Get User Fund Margin | **GET** /v2/user/get-funds-and-margin | *UserApi* | [API Reference](https://upstox.com/developer/api-documentation/get-user-fund-margin) | [Sample Code](https://upstox.com/developer/api-documentation/get-user-fund-margin#sample-code-python_sdk)
+**Charges** | | | |
+Get Brokerage | **GET** /v2/charges/brokerage | *ChargeApi* | [API Reference](https://upstox.com/developer/api-documentation/get-brokerage) | [Sample Code](https://upstox.com/developer/api-documentation/get-brokerage#sample-code-python_sdk)
+**Margins** | | | |
+Margin | **POST** /v2/charges/margin | *ChargeApi* | [API Reference](https://upstox.com/developer/api-documentation/margin) | [Sample Code](https://upstox.com/developer/api-documentation/margin#sample-code-python_sdk)
+**Orders** | | | |
+Place Order V3 | **POST** /v3/order/place | *OrderApiV3* | [API Reference](https://upstox.com/developer/api-documentation/v3/place-order) | [Sample Code](https://upstox.com/developer/api-documentation/v3/place-order#sample-code-python_sdk)
+Place Multi Order | **POST** /v2/order/multi/place | *OrderApi* | [API Reference](https://upstox.com/developer/api-documentation/place-multi-order) | [Sample Code](https://upstox.com/developer/api-documentation/place-multi-order#sample-code-python_sdk)
+Modify Order V3 | **PUT** /v3/order/modify | *OrderApiV3* | [API Reference](https://upstox.com/developer/api-documentation/v3/modify-order) | [Sample Code](https://upstox.com/developer/api-documentation/v3/modify-order#sample-code-python_sdk)
+Cancel Order V3 | **DELETE** /v3/order/cancel | *OrderApiV3* | [API Reference](https://upstox.com/developer/api-documentation/v3/cancel-order) | [Sample Code](https://upstox.com/developer/api-documentation/v3/cancel-order#sample-code-python_sdk)
+Cancel Multi Order | **DELETE** /v2/order/multi/cancel | *OrderApi* | [API Reference](https://upstox.com/developer/api-documentation/cancel-multi-order) | [Sample Code](https://upstox.com/developer/api-documentation/cancel-multi-order#sample-code-python_sdk)
+Exit All Position | **POST** /v2/order/positions/exit | *OrderApi* | [API Reference](https://upstox.com/developer/api-documentation/exit-all-positions) | [Sample Code](https://upstox.com/developer/api-documentation/exit-all-positions#sample-code-python_sdk)
+Get Order Details | **GET** /v2/order/details | *OrderApi* | [API Reference](https://upstox.com/developer/api-documentation/get-order-details) | [Sample Code](https://upstox.com/developer/api-documentation/get-order-details#sample-code-python_sdk)
+Get Order History | **GET** /v2/order/history | *OrderApi* | [API Reference](https://upstox.com/developer/api-documentation/get-order-history) | [Sample Code](https://upstox.com/developer/api-documentation/get-order-history#sample-code-python_sdk)
+Get Trades By Order | **GET** /v2/order/trades | *OrderApi* | [API Reference](https://upstox.com/developer/api-documentation/get-trades-by-order) | [Sample Code](https://upstox.com/developer/api-documentation/get-trades-by-order#sample-code-python_sdk)
+Get Trade History | **GET** /v2/order/trades/get-trades-for-day | *OrderApi* | [API Reference](https://upstox.com/developer/api-documentation/get-trade-history) | [Sample Code](https://upstox.com/developer/api-documentation/get-trade-history#sample-code-python_sdk)
+**GTT Order** | | | |
+Place GTT Order | **POST** /v3/order/gtt/place | *OrderApiV3* | [API Reference](https://upstox.com/developer/api-documentation/place-gtt-order) | [Sample Code](https://upstox.com/developer/api-documentation/place-gtt-order#sample-code-python_sdk)
+Modify GTT Order | **PUT** /v3/order/gtt/modify | *OrderApiV3* | [API Reference](https://upstox.com/developer/api-documentation/modify-gtt-order) | [Sample Code](https://upstox.com/developer/api-documentation/modify-gtt-order#sample-code-python_sdk)
+Cancel GTT Order | **DELETE** /v3/order/gtt/cancel | *OrderApiV3* | [API Reference](https://upstox.com/developer/api-documentation/cancel-gtt-order) | [Sample Code](https://upstox.com/developer/api-documentation/cancel-gtt-order#sample-code-python_sdk)
+Get GTT Order Details | **GET** /v3/order/gtt | *OrderApiV3* | [API Reference](https://upstox.com/developer/api-documentation/get-gtt-order-details) | [Sample Code](https://upstox.com/developer/api-documentation/get-gtt-order-details#sample-code-python_sdk)
+**Portfolio** | | | |
+Get Positions | **GET** /v2/portfolio/short-term-positions | *PortfolioApi* | [API Reference](https://upstox.com/developer/api-documentation/get-positions) | [Sample Code](https://upstox.com/developer/api-documentation/get-positions#sample-code-python_sdk)
+Get MTF Positions | **GET** /v3/portfolio/mtf | *PortfolioApi* | [API Reference](https://upstox.com/developer/api-documentation/get-mtf-positions) | [Sample Code](https://upstox.com/developer/api-documentation/get-mtf-positions#sample-code-python_sdk)
+Convert Positions | **PUT** /v2/portfolio/convert-position | *PortfolioApi* | [API Reference](https://upstox.com/developer/api-documentation/convert-positions) | [Sample Code](https://upstox.com/developer/api-documentation/convert-positions#sample-code-python_sdk)
+Get Holdings | **GET** /v2/portfolio/long-term-holdings | *PortfolioApi* | [API Reference](https://upstox.com/developer/api-documentation/get-holdings) | [Sample Code](https://upstox.com/developer/api-documentation/get-holdings#sample-code-python_sdk)
+**Trade Profit And Loss** | | | |
+Get Report Meta Data | **GET** /v2/trade/profit-loss/metadata | *TradeProfitAndLossApi* | [API Reference](https://upstox.com/developer/api-documentation/get-report-meta-data) | [Sample Code](https://upstox.com/developer/api-documentation/get-report-meta-data#sample-code-python_sdk)
+Get Profit And Loss Report | **GET** /v2/trade/profit-loss/data | *TradeProfitAndLossApi* | [API Reference](https://upstox.com/developer/api-documentation/get-profit-and-loss-report) | [Sample Code](https://upstox.com/developer/api-documentation/get-profit-and-loss-report#sample-code-python_sdk)
+Get Trade Charges | **GET** /v2/trade/profit-loss/charges | *TradeProfitAndLossApi* | [API Reference](https://upstox.com/developer/api-documentation/get-trade-charges) | [Sample Code](https://upstox.com/developer/api-documentation/get-trade-charges#sample-code-python_sdk)
+**Historical Data** | | | |
+Get Historical Candle Data V3 | **GET** /v3/historical-candle | *HistoryV3Api* | [API Reference](https://upstox.com/developer/api-documentation/v3/get-historical-candle-data) | [Sample Code](https://upstox.com/developer/api-documentation/v3/get-historical-candle-data#sample-code-python_sdk)
+Get Intra Day Candle Data V3 | **GET** /v3/intra-day-candle | *HistoryV3Api* | [API Reference](https://upstox.com/developer/api-documentation/v3/get-intra-day-candle-data) | [Sample Code](https://upstox.com/developer/api-documentation/v3/get-intra-day-candle-data#sample-code-python_sdk)
+**Market Quote** | | | |
+Get Full Market Quote | **GET** /v2/market-quote/quotes | *MarketQuoteApi* | [API Reference](https://upstox.com/developer/api-documentation/get-full-market-quote) | [Sample Code](https://upstox.com/developer/api-documentation/get-full-market-quote#sample-code-python_sdk)
+Get Market Quote OHLC | **GET** /v2/market-quote/ohlc | *MarketQuoteApi* | [API Reference](https://upstox.com/developer/api-documentation/get-market-quote-ohlc) | [Sample Code](https://upstox.com/developer/api-documentation/get-market-quote-ohlc#sample-code-python_sdk)
+LTP V3 | **GET** /v3/market-quote/ltp | *MarketQuoteV3Api* | [API Reference](https://upstox.com/developer/api-documentation/ltp-v3) | [Sample Code](https://upstox.com/developer/api-documentation/ltp-v3#sample-code-python_sdk)
+Option Greek | **GET** /v3/market-quote/greeks | *MarketQuoteV3Api* | [API Reference](https://upstox.com/developer/api-documentation/option-greek) | [Sample Code](https://upstox.com/developer/api-documentation/option-greek#sample-code-python_sdk)
+**Market Information** | | | |
+Get Market Holidays | **GET** /v2/market/holidays | *MarketHolidaysAndTimingsApi* | [API Reference](https://upstox.com/developer/api-documentation/get-market-holidays) | [Sample Code](https://upstox.com/developer/api-documentation/get-market-holidays#sample-code-python_sdk)
+Get Market Timings | **GET** /v2/market/timings | *MarketHolidaysAndTimingsApi* | [API Reference](https://upstox.com/developer/api-documentation/get-market-timings) | [Sample Code](https://upstox.com/developer/api-documentation/get-market-timings#sample-code-python_sdk)
+Get Market Status | **GET** /v2/market/status | *MarketHolidaysAndTimingsApi* | [API Reference](https://upstox.com/developer/api-documentation/get-market-status) | [Sample Code](https://upstox.com/developer/api-documentation/get-market-status#sample-code-python_sdk)
+**Option Chain** | | | |
+Get Option Contracts | **GET** /v2/option/contract | *OptionsApi* | [API Reference](https://upstox.com/developer/api-documentation/get-option-contracts) | [Sample Code](https://upstox.com/developer/api-documentation/get-option-contracts#sample-code-python_sdk)
+Get PC Option Chain | **GET** /v2/option/chain | *OptionsApi* | [API Reference](https://upstox.com/developer/api-documentation/get-pc-option-chain) | [Sample Code](https://upstox.com/developer/api-documentation/get-pc-option-chain#sample-code-python_sdk)
+
+## Documentation for Feeder Functions
+
+Connecting to the WebSocket for market and portfolio updates is streamlined through two primary Feeder functions:
+
+1. **MarketDataStreamer**: Offers real-time market updates, providing a seamless way to receive instantaneous information on various market instruments.
+2. **PortfolioDataStreamer**: Delivers updates related to the user's orders, enhancing the ability to track order status and portfolio changes effectively.
+
+Both functions are designed to simplify the process of subscribing to essential data streams, ensuring users have quick and easy access to the information they need.
+
+### Detailed Explanation of Feeder Interface
+
+### MarketDataStreamer
+
+
+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:
+
+```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.MarketDataStreamerV3(
+        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 MarketDataStreamerV3 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 MarketDataStreamerV3 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. 
+- **option_greeks**: Contains only option greeks.
+- **full_d30**: full_d30 includes Full mode data plus 30 market level quotes.      
+
+#### Functions
+1. **constructor MarketDataStreamerV3(apiClient, instrumentKeys, mode)**: Initializes the streamer with optional instrument keys and mode (`full`, `ltpc`, `option_greeks` or `full_d30`).
+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 MarketDataStreamerV3 effectively.
+
+<br/>
+
+1. Subscribing to Market Data on Connection Open with MarketDataStreamerV3
+
+```python
+import upstox_client
+
+def main():
+    configuration = upstox_client.Configuration()
+    access_token = <ACCESS_TOKEN>
+    configuration.access_token = access_token
+
+    streamer = upstox_client.MarketDataStreamerV3(
+        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.MarketDataStreamerV3(
+        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.MarketDataStreamerV3(
+        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.MarketDataStreamerV3(
+        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.MarketDataStreamerV3(
+        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.MarketDataStreamerV3(
+        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/>
+
+
+### 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:
+
+```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.PortfolioDataStreamer(
+        upstox_client.ApiClient(configuration))
+
+    streamer.on("message", on_message)
+
+    streamer.connect()
+
+
+if __name__ == "__main__":
+    main()
+```
+<br/>
+
+Position, holding, and GTT order updates can be enabled by setting the corresponding flag to `True` in the constructor of the `PortfolioDataStreamer` class.
+
+```python
+import upstox_client
+import data_token
+
+
+def on_message(message):
+    print(message)
+
+
+def on_open():
+    print("connection opened")
+
+
+def main():
+    configuration = upstox_client.Configuration()
+    configuration.access_token = <ACCESS_TOKEN>
+
+    streamer = upstox_client.PortfolioDataStreamer(upstox_client.ApiClient(configuration),
+                                                  order_update=True,
+                                                  position_update=True,
+                                                  holding_update=True,
+                                                  gtt_update=True)
+
+    streamer.on("message", on_message)
+    streamer.on("open", on_open)
+    streamer.connect()
+
+
+if __name__ == "__main__":
+    main()
+
+```
+
+<br/>
+
+### Exploring the PortfolioDataStreamer Functionality
+
+#### Constructor Parameters
+1. **api_client**: Your API client instance
+2. **order_update**: Set to `True` to receive real-time order updates (default: `True`)
+3. **position_update**: Set to `True` to receive position updates (default: `False`) 
+4. **holding_update**: Set to `True` to receive holding updates (default: `False`)
+5. **gtt_update**: Set to `True` to receive GTT order updates (default: `False`)
+
+#### Functions
+1. **constructor PortfolioDataStreamer()**: Initializes the streamer.
+2. **connect()**: Establishes the WebSocket connection.
+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.
+