Upstox Python SDK for API v2

Introduction

The official Python 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.

• API version: v2
• Package version: 2.19.0
• Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

This Python package is automatically generated by the Swagger Codegen project.

Documentation.

Upstox API Documentation

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

pip install upstox-python-sdk

(you may need to run pip with root permission: sudo pip install upstox-python-sdk)

Then import the package:

import upstox_client 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

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.

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.

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.

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	Sample Code
Get Expired Option Contracts	GET /v2/expired-instruments/option/contract	ExpiredInstrumentApi	API Reference	Sample Code
Get Expired Future Contracts	GET /v2/expired-instruments/future/contract	ExpiredInstrumentApi	API Reference	Sample Code
Get Expired Historical Candle Data	GET /v2/expired-instruments/historical-candle/{expired_instrument_key}/{interval}/{to_date}/{from_date}	ExpiredInstrumentApi	API Reference	Sample Code
Login
Get Token	POST /v2/login/authorization/token	LoginApi	API Reference	Sample Code
Access Token Request	POST /v3/login/auth/token/request/{client_id}	LoginApi	API Reference	Sample Code
Logout	DELETE /v2/logout	LoginApi	API Reference	Sample Code
User
Get Profile	GET /v2/user/profile	UserApi	API Reference	Sample Code
Get User Fund Margin	GET /v2/user/get-funds-and-margin	UserApi	API Reference	Sample Code
Charges
Get Brokerage	GET /v2/charges/brokerage	ChargeApi	API Reference	Sample Code
Margins
Margin	POST /v2/charges/margin	ChargeApi	API Reference	Sample Code
Orders
Place Order V3	POST /v3/order/place	OrderApiV3	API Reference	Sample Code
Place Multi Order	POST /v2/order/multi/place	OrderApi	API Reference	Sample Code
Modify Order V3	PUT /v3/order/modify	OrderApiV3	API Reference	Sample Code
Cancel Order V3	DELETE /v3/order/cancel	OrderApiV3	API Reference	Sample Code
Cancel Multi Order	DELETE /v2/order/multi/cancel	OrderApi	API Reference	Sample Code
Exit All Position	POST /v2/order/positions/exit	OrderApi	API Reference	Sample Code
Get Order Details	GET /v2/order/details	OrderApi	API Reference	Sample Code
Get Order History	GET /v2/order/history	OrderApi	API Reference	Sample Code
Get Trades By Order	GET /v2/order/trades	OrderApi	API Reference	Sample Code
Get Trade History	GET /v2/order/trades/get-trades-for-day	OrderApi	API Reference	Sample Code
GTT Order
Place GTT Order	POST /v3/order/gtt/place	OrderApiV3	API Reference	Sample Code
Modify GTT Order	PUT /v3/order/gtt/modify	OrderApiV3	API Reference	Sample Code
Cancel GTT Order	DELETE /v3/order/gtt/cancel	OrderApiV3	API Reference	Sample Code
Get GTT Order Details	GET /v3/order/gtt	OrderApiV3	API Reference	Sample Code
Portfolio
Get Positions	GET /v2/portfolio/short-term-positions	PortfolioApi	API Reference	Sample Code
Get MTF Positions	GET /v3/portfolio/mtf	PortfolioApi	API Reference	Sample Code
Convert Positions	PUT /v2/portfolio/convert-position	PortfolioApi	API Reference	Sample Code
Get Holdings	GET /v2/portfolio/long-term-holdings	PortfolioApi	API Reference	Sample Code
Trade Profit And Loss
Get Report Meta Data	GET /v2/trade/profit-loss/metadata	TradeProfitAndLossApi	API Reference	Sample Code
Get Profit And Loss Report	GET /v2/trade/profit-loss/data	TradeProfitAndLossApi	API Reference	Sample Code
Get Trade Charges	GET /v2/trade/profit-loss/charges	TradeProfitAndLossApi	API Reference	Sample Code
Historical Data
Get Historical Candle Data V3	GET /v3/historical-candle	HistoryV3Api	API Reference	Sample Code
Get Intra Day Candle Data V3	GET /v3/intra-day-candle	HistoryV3Api	API Reference	Sample Code
Market Quote
Get Full Market Quote	GET /v2/market-quote/quotes	MarketQuoteApi	API Reference	Sample Code
Get Market Quote OHLC	GET /v2/market-quote/ohlc	MarketQuoteApi	API Reference	Sample Code
LTP V3	GET /v3/market-quote/ltp	MarketQuoteV3Api	API Reference	Sample Code
Option Greek	GET /v3/market-quote/greeks	MarketQuoteV3Api	API Reference	Sample Code
Market Information
Get Market Holidays	GET /v2/market/holidays	MarketHolidaysAndTimingsApi	API Reference	Sample Code
Get Market Timings	GET /v2/market/timings	MarketHolidaysAndTimingsApi	API Reference	Sample Code
Get Market Status	GET /v2/market/status	MarketHolidaysAndTimingsApi	API Reference	Sample Code
Option Chain
Get Option Contracts	GET /v2/option/contract	OptionsApi	API Reference	Sample Code
Get PC Option Chain	GET /v2/option/chain	OptionsApi	API Reference	Sample Code

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:

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.

1. Subscribing to Market Data on Connection Open with MarketDataStreamerV3

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()

2. Subscribing to Instruments with Delays

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()

3. Subscribing and Unsubscribing to Instruments

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()

4. Subscribe, Change Mode and Unsubscribe

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()

5. Disable Auto-Reconnect

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()

6. Modify Auto-Reconnect parameters

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()

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:

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()

Position, holding, and GTT order updates can be enabled by setting the corresponding flag to True in the constructor of the PortfolioDataStreamer class.

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()

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.
3. disconnect(): Ends the active WebSocket connection.
4. 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.