upstox-java

Upstox Java SDK for API v2

Introduction

The official Java client for communicating with the Upstox API.

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.

Automatically generated by the Swagger Codegen

Documentation.

Upstox API Documentation

Requirements

Building the API client library requires:

  1. Java 1.7+
  2. Maven/Gradle

Installation

Maven users

Add this dependency to your project’s POM:

<dependency>
  <groupId>com.upstox.api</groupId>
  <artifactId>upstox-java-sdk</artifactId>
  <version>1.10.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project’s build file:

compile "com.upstox.api:upstox-java-sdk:1.10.0"

Examples

Sample Implementations can be found within /examples folder.

Documentation for API Endpoints

All URIs are relative to https://api.upstox.com/v2

Class Method HTTP request Description
ChargeApi getBrokerage GET /v2/charges/brokerage Brokerage details
ChargeApi postMargin POST /v2/charges/margin Calculate Margin
HistoryApi getHistoricalCandleData GET /v2/historical-candle/{instrumentKey}/{interval}/{to_date} Historical candle data
HistoryApi getHistoricalCandleData1 GET /v2/historical-candle/{instrumentKey}/{interval}/{to_date}/{from_date} Historical candle data
HistoryApi getIntraDayCandleData GET /v2/historical-candle/intraday/{instrumentKey}/{interval} Intra day candle data
LoginApi authorize GET /v2/login/authorization/dialog Authorize API
LoginApi autoLogin GET /v2/auth/auto-login Auto Login
LoginApi logout DELETE /v2/logout Logout
LoginApi token POST /v2/login/authorization/token Get token API
MarketHolidaysAndTimingsApi getExchangeTimings GET /v2/market/timings/{date} Get Exchange Timings on particular date
MarketHolidaysAndTimingsApi getHoliday GET /v2/market/holidays/{date} Get Holiday on particular date
MarketHolidaysAndTimingsApi getHolidays GET /v2/market/holidays Get Holiday list of current year
MarketHolidaysAndTimingsApi getMarketStatus GET /v2/market/status/{exchange} Get Market status for particular exchange
MarketQuoteApi getFullMarketQuote GET /v2/market-quote/quotes Market quotes and instruments - Full market quotes
MarketQuoteApi getMarketQuoteOHLC GET /v2/market-quote/ohlc Market quotes and instruments - OHLC quotes
MarketQuoteApi ltp GET /v2/market-quote/ltp Market quotes and instruments - LTP quotes.
OptionsApi getOptionContracts GET /v2/option/contract Get option contracts
OptionsApi getPutCallOptionChain GET /v2/option/chain Get option chain
OrderApi cancelMultiOrder DELETE /v2/order/multi/cancel Cancel multi order
OrderApi cancelOrder DELETE /v2/order/cancel Cancel order
OrderApi exitPositions POST /v2/order/positions/exit Exit all positions
OrderApi getOrderBook GET /v2/order/retrieve-all Get order book
OrderApi getOrderDetails GET /v2/order/history Get order history
OrderApi getOrderStatus GET /v2/order/details Get order details
OrderApi getTradeHistory GET /v2/order/trades/get-trades-for-day Get trades
OrderApi getTradesByOrder GET /v2/order/trades Get trades for order
OrderApi modifyOrder PUT /v2/order/modify Modify order
OrderApi placeMultiOrder POST /v2/order/multi/place Place multi order
OrderApi placeOrder POST /v2/order/place Place order
PortfolioApi convertPositions PUT /v2/portfolio/convert-position Convert Positions
PortfolioApi getHoldings GET /v2/portfolio/long-term-holdings Get Holdings
PortfolioApi getPositions GET /v2/portfolio/short-term-positions Get Positions
PostTradeApi getTradesByDateRange GET /v2/charges/historical-trades Get historical trades
TradeProfitAndLossApi getProfitAndLossCharges GET /v2/trade/profit-loss/charges Get profit and loss on trades
TradeProfitAndLossApi getTradeWiseProfitAndLossData GET /v2/trade/profit-loss/data Get Trade-wise Profit and Loss Report Data
TradeProfitAndLossApi getTradeWiseProfitAndLossMetaData GET /v2/trade/profit-loss/metadata Get profit and loss meta data on trades
UserApi getProfile GET /v2/user/profile Get profile
UserApi getUserFundMargin GET /v2/user/get-funds-and-margin Get User Fund And Margin
WebsocketApi getMarketDataFeed GET /v2/feed/market-data-feed Market Data Feed
WebsocketApi getMarketDataFeedAuthorize GET /v2/feed/market-data-feed/authorize Market Data Feed Authorize
WebsocketApi getPortfolioStreamFeed GET /v2/feed/portfolio-stream-feed Portfolio Stream Feed
WebsocketApi getPortfolioStreamFeedAuthorize GET /v2/feed/portfolio-stream-feed/authorize Portfolio Stream Feed Authorize


Documentation for Feeder Interfaces

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 Interfaces

MarketDataStreamer

V3

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: ```java public class MarketFeederTest { public static void main(String[] args) throws ApiException { ApiClient defaultClient = Configuration.getDefaultApiClient(); Set instrumentKeys = new HashSet<>(); instrumentKeys.add("NSE_INDEX|Nifty 50"); instrumentKeys.add("NSE_INDEX|Nifty Bank"); OAuth oAuth = (OAuth) defaultClient.getAuthentication("OAUTH2"); oAuth.setAccessToken(); final MarketDataStreamerV3 marketDataStreamer = new MarketDataStreamerV3(defaultClient, instrumentKeys, Mode.FULL); marketDataStreamer.setOnMarketUpdateListener(new OnMarketUpdateV3Listener() { @Override public void onUpdate(MarketUpdateV3 marketUpdate) { System.out.println(marketUpdate); } }); marketDataStreamer.connect(); } } ``` 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 - **Mode.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. - **Mode.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. - **Mode.OPTION_GREEKS**: Contains only option greeks. #### Functions 1. **constructor MarketDataStreamerV3(apiClient)**: Initializes the streamer. 1. **constructor MarketDataStreamerV3(apiClient, instrumentKeys, mode)**: Initializes the streamer with instrument keys and mode (`Mode.FULL`, `Mode.LTPC` or `Mode.OPTION_GREEKS`). 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. **autoReconnect(enable)**: Enable/Disable the auto reconnect capability. 7. **autoReconnect(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 Listeners - **onOpenListener**: Called on successful connection establishment. - **onCloseListener**: Called when WebSocket connection has been closed. - **OnMarketUpdateV3Listener**: Delivers market updates. - **onErrorListener**: Signals an error has occurred. - **onReconnectingListener**: Announced when a reconnect attempt is initiated. - **onAutoReconnectStoppedListener**: 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.
1. Subscribing to Market Data on Connection Open with MarketDataStreamerV3 ```java public class MarketFeederTest { public static void main(String[] args) throws ApiException { ApiClient defaultClient = Configuration.getDefaultApiClient(); OAuth oAuth = (OAuth) defaultClient.getAuthentication("OAUTH2"); oAuth.setAccessToken(); final MarketDataStreamerV3 marketDataStreamer = new MarketDataStreamerV3(defaultClient); marketDataStreamer.setOnOpenListener(new OnOpenListener() { @Override public void onOpen() { System.out.println("Connection Established"); Set instrumentKeys = new HashSet<>(); instrumentKeys.add("NSE_INDEX|Nifty 50"); instrumentKeys.add("NSE_INDEX|Nifty Bank"); marketDataStreamer.subscribe(instrumentKeys, Mode.FULL); } }); marketDataStreamer.setOnMarketUpdateListener(new OnMarketUpdateV3Listener() { @Override public void onUpdate(MarketUpdateV3 marketUpdate) { System.out.println(marketUpdate); } }); marketDataStreamer.connect(); } } ```
2. Subscribing to Instruments with Delays ```java public class MarketFeederTest { public static void main(String[] args) throws ApiException { ApiClient defaultClient = Configuration.getDefaultApiClient(); OAuth oAuth = (OAuth) defaultClient.getAuthentication("OAUTH2"); oAuth.setAccessToken(); final MarketDataStreamerV3 marketDataStreamer = new MarketDataStreamerV3(defaultClient); marketDataStreamer.setOnOpenListener(new OnOpenListener() { @Override public void onOpen() { System.out.println("Connection Established"); Set instrumentKeys1 = new HashSet<>(); instrumentKeys1.add("NSE_INDEX|Nifty 50"); marketDataStreamer.subscribe(instrumentKeys1, Mode.FULL); ScheduledExecutorService scheduler = Executors.newSingleThreadScheduledExecutor(); scheduler.schedule(() -> { Set instrumentKeys2 = new HashSet<>(); instrumentKeys2.add("NSE_INDEX|Nifty Bank"); marketDataStreamer.subscribe(instrumentKeys2, Mode.FULL); scheduler.shutdown(); }, 5, TimeUnit.SECONDS); } }); marketDataStreamer.setOnMarketUpdateListener(new OnMarketUpdateV3Listener() { @Override public void onUpdate(MarketUpdateV3 marketUpdate) { System.out.println(marketUpdate); } }); marketDataStreamer.connect(); } } ```
3. Subscribing and Unsubscribing to Instruments ```java public class MarketFeederTest { public static void main(String[] args) throws ApiException { ApiClient defaultClient = Configuration.getDefaultApiClient(); OAuth oAuth = (OAuth) defaultClient.getAuthentication("OAUTH2"); oAuth.setAccessToken(); final MarketDataStreamerV3 marketDataStreamer = new MarketDataStreamerV3(defaultClient); marketDataStreamer.setOnOpenListener(new OnOpenListener() { @Override public void onOpen() { System.out.println("Connection Established"); Set instrumentKeys = new HashSet<>(); instrumentKeys.add("NSE_INDEX|Nifty 50"); instrumentKeys.add("NSE_INDEX|Nifty Bank"); marketDataStreamer.subscribe(instrumentKeys, Mode.FULL); ScheduledExecutorService scheduler = Executors.newSingleThreadScheduledExecutor(); scheduler.schedule(() -> { marketDataStreamer.unsubscribe(instrumentKeys); scheduler.shutdown(); }, 5, TimeUnit.SECONDS); } }); marketDataStreamer.setOnMarketUpdateListener(new OnMarketUpdateV3Listener() { @Override public void onUpdate(MarketUpdateV3 marketUpdate) { System.out.println(marketUpdate); } }); marketDataStreamer.connect(); } } ```
4. Subscribe, Change Mode and Unsubscribe ```java public class MarketFeederTest { public static void main(String[] args) throws ApiException { ApiClient defaultClient = Configuration.getDefaultApiClient(); OAuth oAuth = (OAuth) defaultClient.getAuthentication("OAUTH2"); oAuth.setAccessToken(); final MarketDataStreamerV3 marketDataStreamer = new MarketDataStreamerV3(defaultClient); marketDataStreamer.setOnOpenListener(new OnOpenListener() { @Override public void onOpen() { System.out.println("Connection Established"); Set instrumentKeys = new HashSet<>(); instrumentKeys.add("NSE_INDEX|Nifty 50"); instrumentKeys.add("NSE_INDEX|Nifty Bank"); marketDataStreamer.subscribe(instrumentKeys, Mode.FULL); ScheduledExecutorService scheduler = Executors.newSingleThreadScheduledExecutor(); scheduler.schedule(() -> { marketDataStreamer.changeMode(instrumentKeys, Mode.LTPC); scheduler.shutdown(); }, 5, TimeUnit.SECONDS); scheduler.schedule(() -> { marketDataStreamer.unsubscribe(instrumentKeys); scheduler.shutdown(); }, 10, TimeUnit.SECONDS); } }); marketDataStreamer.setOnMarketUpdateListener(new OnMarketUpdateV3Listener() { @Override public void onUpdate(MarketUpdateV3 marketUpdate) { System.out.println(marketUpdate); } }); marketDataStreamer.connect(); } } ```
5. Disable Auto-Reconnect ```java public class MarketFeederTest { public static void main(String[] args) throws ApiException { ApiClient defaultClient = Configuration.getDefaultApiClient(); OAuth oAuth = (OAuth) defaultClient.getAuthentication("OAUTH2"); oAuth.setAccessToken(); final MarketDataStreamerV3 marketDataStreamer = new MarketDataStreamerV3(defaultClient); marketDataStreamer.setOnAutoReconnectStoppedListener(new OnAutoReconnectStoppedListener() { @Override public void onHault(String message) { System.out.println(message); } }); marketDataStreamer.autoReconnect(false); marketDataStreamer.connect(); } } ```
6. Modify Auto-Reconnect parameters ```java public class MarketFeederTest { public static void main(String[] args) throws ApiException { ApiClient defaultClient = Configuration.getDefaultApiClient(); OAuth oAuth = (OAuth) defaultClient.getAuthentication("OAUTH2"); oAuth.setAccessToken(); final MarketDataStreamerV3 marketDataStreamer = new MarketDataStreamerV3(defaultClient); marketDataStreamer.autoReconnect(true, 10, 3); marketDataStreamer.connect(); } } ```
</p> </details>

V2

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: ```java public class MarketFeederTest { public static void main(String[] args) throws ApiException { ApiClient defaultClient = Configuration.getDefaultApiClient(); Set instrumentKeys = new HashSet<>(); instrumentKeys.add("NSE_INDEX|Nifty 50"); instrumentKeys.add("NSE_INDEX|Nifty Bank"); OAuth oAuth = (OAuth) defaultClient.getAuthentication("OAUTH2"); oAuth.setAccessToken(); final MarketDataStreamer marketDataStreamer = new MarketDataStreamer(defaultClient, instrumentKeys, Mode.FULL); marketDataStreamer.setOnMarketUpdateListener(new OnMarketUpdateListener() { @Override public void onUpdate(MarketUpdate marketUpdate) { System.out.println(marketUpdate); } }); marketDataStreamer.connect(); } } ``` 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 - **Mode.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. - **Mode.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)**: Initializes the streamer. 1. **constructor MarketDataStreamer(apiClient, instrumentKeys, mode)**: Initializes the streamer with instrument keys and mode (`Mode.FULL` or `Mode.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. **autoReconnect(enable)**: Enable/Disable the auto reconnect capability. 7. **autoReconnect(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 Listeners - **onOpenListener**: Called on successful connection establishment. - **onCloseListener**: Called when WebSocket connection has been closed. - **onMarketUpdateListener**: Delivers market updates. - **onErrorListener**: Signals an error has occurred. - **onReconnectingListener**: Announced when a reconnect attempt is initiated. - **onAutoReconnectStoppedListener**: 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.
1. Subscribing to Market Data on Connection Open with MarketDataStreamer ```java public class MarketFeederTest { public static void main(String[] args) throws ApiException { ApiClient defaultClient = Configuration.getDefaultApiClient(); OAuth oAuth = (OAuth) defaultClient.getAuthentication("OAUTH2"); oAuth.setAccessToken(); final MarketDataStreamer marketDataStreamer = new MarketDataStreamer(defaultClient); marketDataStreamer.setOnOpenListener(new OnOpenListener() { @Override public void onOpen() { System.out.println("Connection Established"); Set instrumentKeys = new HashSet<>(); instrumentKeys.add("NSE_INDEX|Nifty 50"); instrumentKeys.add("NSE_INDEX|Nifty Bank"); marketDataStreamer.subscribe(instrumentKeys, Mode.FULL); } }); marketDataStreamer.setOnMarketUpdateListener(new OnMarketUpdateListener() { @Override public void onUpdate(MarketUpdate marketUpdate) { System.out.println(marketUpdate); } }); marketDataStreamer.connect(); } } ```
2. Subscribing to Instruments with Delays ```java public class MarketFeederTest { public static void main(String[] args) throws ApiException { ApiClient defaultClient = Configuration.getDefaultApiClient(); OAuth oAuth = (OAuth) defaultClient.getAuthentication("OAUTH2"); oAuth.setAccessToken(); final MarketDataStreamer marketDataStreamer = new MarketDataStreamer(defaultClient); marketDataStreamer.setOnOpenListener(new OnOpenListener() { @Override public void onOpen() { System.out.println("Connection Established"); Set instrumentKeys1 = new HashSet<>(); instrumentKeys1.add("NSE_INDEX|Nifty 50"); marketDataStreamer.subscribe(instrumentKeys1, Mode.FULL); ScheduledExecutorService scheduler = Executors.newSingleThreadScheduledExecutor(); scheduler.schedule(() -> { Set instrumentKeys2 = new HashSet<>(); instrumentKeys2.add("NSE_INDEX|Nifty Bank"); marketDataStreamer.subscribe(instrumentKeys2, Mode.FULL); scheduler.shutdown(); }, 5, TimeUnit.SECONDS); } }); marketDataStreamer.setOnMarketUpdateListener(new OnMarketUpdateListener() { @Override public void onUpdate(MarketUpdate marketUpdate) { System.out.println(marketUpdate); } }); marketDataStreamer.connect(); } } ```
3. Subscribing and Unsubscribing to Instruments ```java public class MarketFeederTest { public static void main(String[] args) throws ApiException { ApiClient defaultClient = Configuration.getDefaultApiClient(); OAuth oAuth = (OAuth) defaultClient.getAuthentication("OAUTH2"); oAuth.setAccessToken(); final MarketDataStreamer marketDataStreamer = new MarketDataStreamer(defaultClient); marketDataStreamer.setOnOpenListener(new OnOpenListener() { @Override public void onOpen() { System.out.println("Connection Established"); Set instrumentKeys = new HashSet<>(); instrumentKeys.add("NSE_INDEX|Nifty 50"); instrumentKeys.add("NSE_INDEX|Nifty Bank"); marketDataStreamer.subscribe(instrumentKeys, Mode.FULL); ScheduledExecutorService scheduler = Executors.newSingleThreadScheduledExecutor(); scheduler.schedule(() -> { marketDataStreamer.unsubscribe(instrumentKeys); scheduler.shutdown(); }, 5, TimeUnit.SECONDS); } }); marketDataStreamer.setOnMarketUpdateListener(new OnMarketUpdateListener() { @Override public void onUpdate(MarketUpdate marketUpdate) { System.out.println(marketUpdate); } }); marketDataStreamer.connect(); } } ```
4. Subscribe, Change Mode and Unsubscribe ```java public class MarketFeederTest { public static void main(String[] args) throws ApiException { ApiClient defaultClient = Configuration.getDefaultApiClient(); OAuth oAuth = (OAuth) defaultClient.getAuthentication("OAUTH2"); oAuth.setAccessToken(); final MarketDataStreamer marketDataStreamer = new MarketDataStreamer(defaultClient); marketDataStreamer.setOnOpenListener(new OnOpenListener() { @Override public void onOpen() { System.out.println("Connection Established"); Set instrumentKeys = new HashSet<>(); instrumentKeys.add("NSE_INDEX|Nifty 50"); instrumentKeys.add("NSE_INDEX|Nifty Bank"); marketDataStreamer.subscribe(instrumentKeys, Mode.FULL); ScheduledExecutorService scheduler = Executors.newSingleThreadScheduledExecutor(); scheduler.schedule(() -> { marketDataStreamer.changeMode(instrumentKeys, Mode.LTPC); scheduler.shutdown(); }, 5, TimeUnit.SECONDS); scheduler.schedule(() -> { marketDataStreamer.unsubscribe(instrumentKeys); scheduler.shutdown(); }, 10, TimeUnit.SECONDS); } }); marketDataStreamer.setOnMarketUpdateListener(new OnMarketUpdateListener() { @Override public void onUpdate(MarketUpdate marketUpdate) { System.out.println(marketUpdate); } }); marketDataStreamer.connect(); } } ```
5. Disable Auto-Reconnect ```java public class MarketFeederTest { public static void main(String[] args) throws ApiException { ApiClient defaultClient = Configuration.getDefaultApiClient(); OAuth oAuth = (OAuth) defaultClient.getAuthentication("OAUTH2"); oAuth.setAccessToken(); final MarketDataStreamer marketDataStreamer = new MarketDataStreamer(defaultClient); marketDataStreamer.setOnAutoReconnectStoppedListener(new OnAutoReconnectStoppedListener() { @Override public void onHault(String message) { System.out.println(message); } }); marketDataStreamer.autoReconnect(false); marketDataStreamer.connect(); } } ```
6. Modify Auto-Reconnect parameters ```java public class MarketFeederTest { public static void main(String[] args) throws ApiException { ApiClient defaultClient = Configuration.getDefaultApiClient(); OAuth oAuth = (OAuth) defaultClient.getAuthentication("OAUTH2"); oAuth.setAccessToken(); final MarketDataStreamer marketDataStreamer = new MarketDataStreamer(defaultClient); marketDataStreamer.autoReconnect(true, 10, 3); marketDataStreamer.connect(); } } ```
</p> </details> ### PortfolioDataStreamer Connecting to the Portfolio WebSocket for real-time order updates is straightforward with the PortfolioDataStreamer class. Below is a concise guide to get you started on receiving updates: ```java public class PortfolioFeederTest { public static void main(String[] args) throws ApiException { ApiClient defaultClient = Configuration.getDefaultApiClient(); OAuth oAuth = (OAuth) defaultClient.getAuthentication("OAUTH2"); oAuth.setAccessToken(); final PortfolioDataStreamer portfolioDataStreamer = new PortfolioDataStreamer(defaultClient); portfolioDataStreamer.setOnOrderUpdateListener(new OnOrderUpdateListener() { @Override public void onUpdate(OrderUpdate orderUpdate) { System.out.println(orderUpdate); } }); portfolioDataStreamer.connect(); } } ```
Position and holding updates can be enabled by setting the corresponding flag to `true` in the constructor of the `PortfolioDataStreamer` class. ```java import com.upstox.feeder.HoldingUpdate; import com.upstox.feeder.PositionUpdate; public class PortfolioFeederTest { public static void main(String[] args) throws ApiException { ApiClient defaultClient = Configuration.getDefaultApiClient(); OAuth oAuth = (OAuth) defaultClient.getAuthentication("OAUTH2"); oAuth.setAccessToken( < ACCESS_TOKEN >); final PortfolioDataStreamer portfolioDataStreamer = new PortfolioDataStreamer(defaultClient, true, true, true); portfolioDataStreamer.setOnOrderUpdateListener(new OnOrderUpdateListener() { @Override public void onUpdate(OrderUpdate orderUpdate) { System.out.println(orderUpdate); } }); portfolioDataStreamer.setOnHoldingUpdateListener(new OnHoldingUpdateListener() { @Override public void onUpdate(HoldingUpdate holdingUpdate) { System.out.println(holdingUpdate); } }); portfolioDataStreamer.setOnPositionUpdateListener(new OnPositionUpdateListener() { @Override public void onUpdate(PositionUpdate positionUpdate) { System.out.println(positionUpdate); } }); portfolioDataStreamer.connect(); } } ```
This example demonstrates initializing the PortfolioDataStreamer, connecting it to the WebSocket, and setting up an event listener to receive and print order updates. Replace with your valid access token to authenticate the session. ### Exploring the PortfolioDataStreamer Functionality #### Functions 1. **constructor PortfolioDataStreamer(apiClient)**: Initializes the streamer. 2. **connect()**: Establishes the WebSocket connection. 6. **disconnect()**: Ends the active WebSocket connection. 7. **autoReconnect(enable)**: Enable/Disable the auto reconnect capability. 7. **autoReconnect(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 Listeners - **onOpenListener**: Called on successful connection establishment. - **onCloseListener**: Called when WebSocket connection has been closed. - **onOrderUpdateListener**: Delivers order updates. - **onErrorListener**: Signals an error has occurred. - **onReconnectingListener**: Announced when a reconnect attempt is initiated. - **onAutoReconnectStoppedListener**: Informs when auto-reconnect efforts have ceased after exhausting the retry count.
## Documentation for Models - [AnalyticsData](/upstox-java/docs/AnalyticsData.html) - [ApiGatewayErrorResponse](/upstox-java/docs/ApiGatewayErrorResponse.html) - [BatchExecutionSummary](/upstox-java/docs/BatchExecutionSummary.html) - [BrokerageData](/upstox-java/docs/BrokerageData.html) - [BrokerageTaxes](/upstox-java/docs/BrokerageTaxes.html) - [BrokerageWrapperData](/upstox-java/docs/BrokerageWrapperData.html) - [CancelOrExitMultiOrderData](/upstox-java/docs/CancelOrExitMultiOrderData.html) - [CancelOrExitMultiOrderResponse](/upstox-java/docs/CancelOrExitMultiOrderResponse.html) - [CancelOrExitOrderErrorData](/upstox-java/docs/CancelOrExitOrderErrorData.html) - [CancelOrderData](/upstox-java/docs/CancelOrderData.html) - [CancelOrderResponse](/upstox-java/docs/CancelOrderResponse.html) - [ConvertPositionData](/upstox-java/docs/ConvertPositionData.html) - [ConvertPositionRequest](/upstox-java/docs/ConvertPositionRequest.html) - [ConvertPositionResponse](/upstox-java/docs/ConvertPositionResponse.html) - [Depth](/upstox-java/docs/Depth.html) - [DepthMap](/upstox-java/docs/DepthMap.html) - [DpPlan](/upstox-java/docs/DpPlan.html) - [ExchangeTimingData](/upstox-java/docs/ExchangeTimingData.html) - [GetBrokerageResponse](/upstox-java/docs/GetBrokerageResponse.html) - [GetExchangeTimingResponse](/upstox-java/docs/GetExchangeTimingResponse.html) - [GetFullMarketQuoteResponse](/upstox-java/docs/GetFullMarketQuoteResponse.html) - [GetHistoricalCandleResponse](/upstox-java/docs/GetHistoricalCandleResponse.html) - [GetHoldingsResponse](/upstox-java/docs/GetHoldingsResponse.html) - [GetHolidayResponse](/upstox-java/docs/GetHolidayResponse.html) - [GetIntraDayCandleResponse](/upstox-java/docs/GetIntraDayCandleResponse.html) - [GetMarketQuoteLastTradedPriceResponse](/upstox-java/docs/GetMarketQuoteLastTradedPriceResponse.html) - [GetMarketQuoteOHLCResponse](/upstox-java/docs/GetMarketQuoteOHLCResponse.html) - [GetMarketStatusResponse](/upstox-java/docs/GetMarketStatusResponse.html) - [GetOptionChainResponse](/upstox-java/docs/GetOptionChainResponse.html) - [GetOptionContractResponse](/upstox-java/docs/GetOptionContractResponse.html) - [GetOrderBookResponse](/upstox-java/docs/GetOrderBookResponse.html) - [GetOrderDetailsResponse](/upstox-java/docs/GetOrderDetailsResponse.html) - [GetOrderResponse](/upstox-java/docs/GetOrderResponse.html) - [GetPositionResponse](/upstox-java/docs/GetPositionResponse.html) - [GetProfileResponse](/upstox-java/docs/GetProfileResponse.html) - [GetProfitAndLossChargesResponse](/upstox-java/docs/GetProfitAndLossChargesResponse.html) - [GetTradeResponse](/upstox-java/docs/GetTradeResponse.html) - [GetTradeWiseProfitAndLossDataResponse](/upstox-java/docs/GetTradeWiseProfitAndLossDataResponse.html) - [GetTradeWiseProfitAndLossMetaDataResponse](/upstox-java/docs/GetTradeWiseProfitAndLossMetaDataResponse.html) - [GetUserFundMarginResponse](/upstox-java/docs/GetUserFundMarginResponse.html) - [HistoricalCandleData](/upstox-java/docs/HistoricalCandleData.html) - [HoldingsData](/upstox-java/docs/HoldingsData.html) - [HolidayData](/upstox-java/docs/HolidayData.html) - [Instrument](/upstox-java/docs/Instrument.html) - [InstrumentData](/upstox-java/docs/InstrumentData.html) - [IntraDayCandleData](/upstox-java/docs/IntraDayCandleData.html) - [LogoutResponse](/upstox-java/docs/LogoutResponse.html) - [Margin](/upstox-java/docs/Margin.html) - [MarginData](/upstox-java/docs/MarginData.html) - [MarginRequest](/upstox-java/docs/MarginRequest.html) - [MarketData](/upstox-java/docs/MarketData.html) - [MarketQuoteOHLC](/upstox-java/docs/MarketQuoteOHLC.html) - [MarketQuoteSymbol](/upstox-java/docs/MarketQuoteSymbol.html) - [MarketQuoteSymbolLtp](/upstox-java/docs/MarketQuoteSymbolLtp.html) - [MarketStatusData](/upstox-java/docs/MarketStatusData.html) - [ModifyOrderData](/upstox-java/docs/ModifyOrderData.html) - [ModifyOrderRequest](/upstox-java/docs/ModifyOrderRequest.html) - [ModifyOrderResponse](/upstox-java/docs/ModifyOrderResponse.html) - [MultiOrderData](/upstox-java/docs/MultiOrderData.html) - [MultiOrderError](/upstox-java/docs/MultiOrderError.html) - [MultiOrderRequest](/upstox-java/docs/MultiOrderRequest.html) - [MultiOrderResponse](/upstox-java/docs/MultiOrderResponse.html) - [MultiOrderSummary](/upstox-java/docs/MultiOrderSummary.html) - [OAuthClientException](/upstox-java/docs/OAuthClientException.html) - [OAuthClientExceptionCause](/upstox-java/docs/OAuthClientExceptionCause.html) - [OAuthClientExceptionCauseStackTrace](/upstox-java/docs/OAuthClientExceptionCauseStackTrace.html) - [OAuthClientExceptionCauseSuppressed](/upstox-java/docs/OAuthClientExceptionCauseSuppressed.html) - [Ohlc](/upstox-java/docs/Ohlc.html) - [OptionStrikeData](/upstox-java/docs/OptionStrikeData.html) - [OrderBookData](/upstox-java/docs/OrderBookData.html) - [OrderData](/upstox-java/docs/OrderData.html) - [OtherTaxes](/upstox-java/docs/OtherTaxes.html) - [PlaceOrderData](/upstox-java/docs/PlaceOrderData.html) - [PlaceOrderRequest](/upstox-java/docs/PlaceOrderRequest.html) - [PlaceOrderResponse](/upstox-java/docs/PlaceOrderResponse.html) - [PositionData](/upstox-java/docs/PositionData.html) - [PostMarginResponse](/upstox-java/docs/PostMarginResponse.html) - [Problem](/upstox-java/docs/Problem.html) - [ProfileData](/upstox-java/docs/ProfileData.html) - [ProfitAndLossChargesData](/upstox-java/docs/ProfitAndLossChargesData.html) - [ProfitAndLossChargesTaxes](/upstox-java/docs/ProfitAndLossChargesTaxes.html) - [ProfitAndLossChargesWrapperData](/upstox-java/docs/ProfitAndLossChargesWrapperData.html) - [ProfitAndLossMetaData](/upstox-java/docs/ProfitAndLossMetaData.html) - [ProfitAndLossMetaDataWrapper](/upstox-java/docs/ProfitAndLossMetaDataWrapper.html) - [ProfitAndLossOtherChargesTaxes](/upstox-java/docs/ProfitAndLossOtherChargesTaxes.html) - [PutCallOptionChainData](/upstox-java/docs/PutCallOptionChainData.html) - [TokenRequest](/upstox-java/docs/TokenRequest.html) - [TokenResponse](/upstox-java/docs/TokenResponse.html) - [TradeData](/upstox-java/docs/TradeData.html) - [TradeHistoryResponse](/upstox-java/docs/TradeHistoryResponse.html) - [TradeHistoryResponseMetaData](/upstox-java/docs/TradeHistoryResponseMetaData.html) - [TradeHistoryResponsePageData](/upstox-java/docs/TradeHistoryResponsePageData.html) - [TradeHistoryResponseTradeData](/upstox-java/docs/TradeHistoryResponseTradeData.html) - [TradeWiseMetaData](/upstox-java/docs/TradeWiseMetaData.html) - [TradeWiseProfitAndLossData](/upstox-java/docs/TradeWiseProfitAndLossData.html) - [UserFundMarginData](/upstox-java/docs/UserFundMarginData.html) - [WebsocketAuthRedirectResponse](/upstox-java/docs/WebsocketAuthRedirectResponse.html) - [WebsocketAuthRedirectResponseData](/upstox-java/docs/WebsocketAuthRedirectResponseData.html) ## Recommendation It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.

This site is open source. Improve this page.