upstox-python-sdk 2.20.0__tar.gz → 2.22.0__tar.gz

{upstox-python-sdk-2.20.0 → upstox-python-sdk-2.22.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: upstox-python-sdk
-Version: 2.20.0
+Version: 2.22.0
 Summary: Upstox Developer API
 Home-page: https://github.com/upstox/upstox-python
 License: MIT
@@ -15,12 +15,12 @@ License-File: LICENSE.txt
 
 ## Introduction
 
-The official Python client for communicating with the <a href="https://upstox.com/uplink/">Upstox API</a>.
+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.20.0
+- Package version: 2.22.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.
@@ -111,69 +111,35 @@ except ApiException as 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)
+## Example Scripts
+
+The [`examples/`](examples/) folder contains ready-to-run scripts covering common API use cases:
+
+| Folder | Description |
+|--------|-------------|
+| [`examples/login/`](examples/login/) | OAuth2 authorization flow and access token generation |
+| [`examples/orders/`](examples/orders/) | Place, modify, cancel, and retrieve orders |
+| [`examples/market_quote/`](examples/market-quote/) | Fetch live quotes, OHLC, and market depth |
+| [`examples/portfolio/`](examples/portfolio/) | View holdings, positions, and P&L |
+| [`examples/strategies/`](examples/strategies/) | 33 options trading strategies across four categories |
+
+### Options Strategy Examples
+
+## Interactive Examples
+
+The [interactive_examples/](interactive_examples/) directory contains 47 ready-to-run CLI scripts across 8 categories: instrument search, futures basis, options strategies, options analytics, arbitrage, historical analysis, portfolio screening, and market data. See the [interactive_examples README](interactive_examples/README.md) for details.
+
+The [`examples/strategies/`](examples/strategies/) folder is organized by market outlook:
+
+| Category | Strategies |
+|----------|------------|
+| [Bullish](examples/strategies/bullish/) | Buy Call, Sell Put, Bull Call Spread, Bull Put Spread, Bull Butterfly, Bull Condor, Long Calendar with Calls, Long Synthetic Future, Call Ratio Back Spread, Range Forward |
+| [Bearish](examples/strategies/bearish/) | Buy Put, Sell Call, Bear Call Spread, Bear Put Spread, Bear Butterfly, Bear Condor, Long Calendar with Puts, Short Synthetic Future, Put Ratio Back Spread, Risk Reversal |
+| [Neutral](examples/strategies/neutral/) | Short Straddle, Short Strangle, Iron Butterfly, Batman, Short Iron Condor |
+| [Others](examples/strategies/others/) | Long Straddle, Long Strangle, Call Ratio Spread, Put Ratio Spread, Long Iron Butterfly, Long Iron Condor, Strip, Strap |
+
+Each strategy script automatically selects the correct Nifty 50 strikes using `InstrumentsApi.search_instrument()` and places orders via `OrderApiV3`. Just set your `ACCESS_TOKEN` and run.
+
 
 ## Documentation for Feeder Functions
 

{upstox-python-sdk-2.20.0 → upstox-python-sdk-2.22.0}/README.md

@@ -4,12 +4,12 @@
 
 ## Introduction
 
-The official Python client for communicating with the <a href="https://upstox.com/uplink/">Upstox API</a>.
+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.20.0
+- Package version: 2.22.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.
@@ -100,69 +100,35 @@ except ApiException as 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)
+## Example Scripts
+
+The [`examples/`](examples/) folder contains ready-to-run scripts covering common API use cases:
+
+| Folder | Description |
+|--------|-------------|
+| [`examples/login/`](examples/login/) | OAuth2 authorization flow and access token generation |
+| [`examples/orders/`](examples/orders/) | Place, modify, cancel, and retrieve orders |
+| [`examples/market_quote/`](examples/market-quote/) | Fetch live quotes, OHLC, and market depth |
+| [`examples/portfolio/`](examples/portfolio/) | View holdings, positions, and P&L |
+| [`examples/strategies/`](examples/strategies/) | 33 options trading strategies across four categories |
+
+### Options Strategy Examples
+
+## Interactive Examples
+
+The [interactive_examples/](interactive_examples/) directory contains 47 ready-to-run CLI scripts across 8 categories: instrument search, futures basis, options strategies, options analytics, arbitrage, historical analysis, portfolio screening, and market data. See the [interactive_examples README](interactive_examples/README.md) for details.
+
+The [`examples/strategies/`](examples/strategies/) folder is organized by market outlook:
+
+| Category | Strategies |
+|----------|------------|
+| [Bullish](examples/strategies/bullish/) | Buy Call, Sell Put, Bull Call Spread, Bull Put Spread, Bull Butterfly, Bull Condor, Long Calendar with Calls, Long Synthetic Future, Call Ratio Back Spread, Range Forward |
+| [Bearish](examples/strategies/bearish/) | Buy Put, Sell Call, Bear Call Spread, Bear Put Spread, Bear Butterfly, Bear Condor, Long Calendar with Puts, Short Synthetic Future, Put Ratio Back Spread, Risk Reversal |
+| [Neutral](examples/strategies/neutral/) | Short Straddle, Short Strangle, Iron Butterfly, Batman, Short Iron Condor |
+| [Others](examples/strategies/others/) | Long Straddle, Long Strangle, Call Ratio Spread, Put Ratio Spread, Long Iron Butterfly, Long Iron Condor, Strip, Strap |
+
+Each strategy script automatically selects the correct Nifty 50 strikes using `InstrumentsApi.search_instrument()` and places orders via `OrderApiV3`. Just set your `ACCESS_TOKEN` and run.
+
 
 ## Documentation for Feeder Functions
 

{upstox-python-sdk-2.20.0 → upstox-python-sdk-2.22.0}/setup.py

@@ -18,7 +18,7 @@ this_directory = Path(__file__).parent
 long_description = (this_directory / "README.md").read_text()
 
 NAME = "upstox-python-sdk"
-VERSION = "2.20.0"
+VERSION = "2.22.0"
 # To install the library, run the following
 #
 # python setup.py install

{upstox-python-sdk-2.20.0 → upstox-python-sdk-2.22.0}/upstox_client/__init__.py

@@ -19,6 +19,7 @@ from upstox_client.api.charge_api import ChargeApi
 from upstox_client.api.expired_instrument_api import ExpiredInstrumentApi
 from upstox_client.api.history_api import HistoryApi
 from upstox_client.api.history_v3_api import HistoryV3Api
+from upstox_client.api.instruments_api import InstrumentsApi
 from upstox_client.api.login_api import LoginApi
 from upstox_client.api.market_holidays_and_timings_api import MarketHolidaysAndTimingsApi
 from upstox_client.api.market_quote_api import MarketQuoteApi
@@ -40,6 +41,7 @@ from upstox_client.configuration import Configuration
 # import models into sdk package
 from upstox_client.models.analytics_data import AnalyticsData
 from upstox_client.models.api_gateway_error_response import ApiGatewayErrorResponse
+from upstox_client.models.available_to_trade import AvailableToTrade
 from upstox_client.models.batch_execution_summary import BatchExecutionSummary
 from upstox_client.models.brokerage_data import BrokerageData
 from upstox_client.models.brokerage_taxes import BrokerageTaxes
@@ -48,11 +50,16 @@ from upstox_client.models.cancel_or_exit_multi_order_data import CancelOrExitMul
 from upstox_client.models.cancel_or_exit_multi_order_response import CancelOrExitMultiOrderResponse
 from upstox_client.models.cancel_or_exit_order_error_data import CancelOrExitOrderErrorData
 from upstox_client.models.cancel_order_data import CancelOrderData
+from upstox_client.models.cash_available_to_trade import CashAvailableToTrade
+from upstox_client.models.cash_breakdown import CashBreakdown
+from upstox_client.models.cash_margin_used import CashMarginUsed
+from upstox_client.models.cash_unavailable_to_trade import CashUnavailableToTrade
 from upstox_client.models.cancel_order_response import CancelOrderResponse
 from upstox_client.models.cancel_order_v3_response import CancelOrderV3Response
 from upstox_client.models.convert_position_data import ConvertPositionData
 from upstox_client.models.convert_position_request import ConvertPositionRequest
 from upstox_client.models.convert_position_response import ConvertPositionResponse
+from upstox_client.models.delivery_margin import DeliveryMargin
 from upstox_client.models.depth import Depth
 from upstox_client.models.depth_map import DepthMap
 from upstox_client.models.dp_plan import DpPlan
@@ -86,6 +93,7 @@ from upstox_client.models.get_trade_response import GetTradeResponse
 from upstox_client.models.get_trade_wise_profit_and_loss_data_response import GetTradeWiseProfitAndLossDataResponse
 from upstox_client.models.get_trade_wise_profit_and_loss_meta_data_response import GetTradeWiseProfitAndLossMetaDataResponse
 from upstox_client.models.get_user_fund_margin_response import GetUserFundMarginResponse
+from upstox_client.models.get_user_fund_margin_v3_response import GetUserFundMarginV3Response
 from upstox_client.models.gtt_cancel_order_request import GttCancelOrderRequest
 from upstox_client.models.gtt_modify_order_request import GttModifyOrderRequest
 from upstox_client.models.gtt_order_data import GttOrderData
@@ -101,10 +109,18 @@ from upstox_client.models.indie_user_init_token_response import IndieUserInitTok
 from upstox_client.models.indie_user_token_request import IndieUserTokenRequest
 from upstox_client.models.instrument import Instrument
 from upstox_client.models.instrument_data import InstrumentData
+from upstox_client.models.search_instrument_response import SearchInstrumentResponse
+from upstox_client.models.search_meta_data import SearchMetaData
+from upstox_client.models.search_page import SearchPage
 from upstox_client.models.intra_day_candle_data import IntraDayCandleData
+from upstox_client.models.kill_switch_response import KillSwitchResponse
+from upstox_client.models.kill_switch_segment_data import KillSwitchSegmentData
+from upstox_client.models.kill_switch_segment_update_request import KillSwitchSegmentUpdateRequest
 from upstox_client.models.logout_response import LogoutResponse
+from upstox_client.models.loss import Loss
 from upstox_client.models.margin import Margin
 from upstox_client.models.margin_data import MarginData
+from upstox_client.models.margin_from_pledge import MarginFromPledge
 from upstox_client.models.margin_request import MarginRequest
 from upstox_client.models.market_data import MarketData
 from upstox_client.models.market_quote_ohlc import MarketQuoteOHLC
@@ -140,6 +156,9 @@ from upstox_client.models.place_order_request import PlaceOrderRequest
 from upstox_client.models.place_order_response import PlaceOrderResponse
 from upstox_client.models.place_order_v3_request import PlaceOrderV3Request
 from upstox_client.models.place_order_v3_response import PlaceOrderV3Response
+from upstox_client.models.pledge_available_to_trade import PledgeAvailableToTrade
+from upstox_client.models.pledge_margin_used import PledgeMarginUsed
+from upstox_client.models.pledge_unavailable_to_trade import PledgeUnavailableToTrade
 from upstox_client.models.position_data import PositionData
 from upstox_client.models.post_margin_response import PostMarginResponse
 from upstox_client.models.problem import Problem
@@ -161,6 +180,12 @@ from upstox_client.models.trade_history_response_page_data import TradeHistoryRe
 from upstox_client.models.trade_history_response_trade_data import TradeHistoryResponseTradeData
 from upstox_client.models.trade_wise_meta_data import TradeWiseMetaData
 from upstox_client.models.trade_wise_profit_and_loss_data import TradeWiseProfitAndLossData
+from upstox_client.models.unavailable_to_trade import UnavailableToTrade
+from upstox_client.models.unsettled_profit import UnsettledProfit
+from upstox_client.models.update_user_ip_request import UpdateUserIpRequest
 from upstox_client.models.user_fund_margin_data import UserFundMarginData
+from upstox_client.models.user_fund_margin_v3_data import UserFundMarginV3Data
+from upstox_client.models.user_ip_response import UserIpResponse
+from upstox_client.models.user_ip_response_data import UserIpResponseData
 from upstox_client.models.websocket_auth_redirect_response import WebsocketAuthRedirectResponse
 from upstox_client.models.websocket_auth_redirect_response_data import WebsocketAuthRedirectResponseData

{upstox-python-sdk-2.20.0 → upstox-python-sdk-2.22.0}/upstox_client/api/__init__.py

@@ -7,6 +7,7 @@ from upstox_client.api.charge_api import ChargeApi
 from upstox_client.api.expired_instrument_api import ExpiredInstrumentApi
 from upstox_client.api.history_api import HistoryApi
 from upstox_client.api.history_v3_api import HistoryV3Api
+from upstox_client.api.instruments_api import InstrumentsApi
 from upstox_client.api.login_api import LoginApi
 from upstox_client.api.market_holidays_and_timings_api import MarketHolidaysAndTimingsApi
 from upstox_client.api.market_quote_api import MarketQuoteApi

upstox-python-sdk-2.22.0/upstox_client/api/instruments_api.py

@@ -0,0 +1,156 @@
+# coding: utf-8
+
+"""
+    OpenAPI definition
+
+    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
+
+    OpenAPI spec version: v0
+    
+    Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+from __future__ import absolute_import
+
+import re  # noqa: F401
+
+# python 2 and python 3 compatibility library
+import six
+
+from upstox_client.api_client import ApiClient
+
+
+class InstrumentsApi(object):
+    """NOTE: This class is auto generated by the swagger code generator program.
+
+    Do not edit the class manually.
+    Ref: https://github.com/swagger-api/swagger-codegen
+    """
+
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+
+    def search_instrument(self, query, **kwargs):  # noqa: E501
+        """Search instruments  # noqa: E501
+
+        This API provides the functionality to retrieve the instrument details for searched query  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.search_instrument(query, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param object query: natural language query (required)
+        :param object exchanges: Comma separated exchanges
+        :param object segments: Comma separated segments
+        :param object instrument_types: Comma separated instrument types
+        :param object expiry: expiry in format: yyyy-MM-dd
+        :param object atm_offset: page number greater than or equal to 1
+        :param object page_number: ATM offset number for queries like ATM, ATM+1, ATM-1, etc.
+        :param object records: no of records in a single page
+        :return: SearchInstrumentResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.search_instrument_with_http_info(query, **kwargs)  # noqa: E501
+        else:
+            (data) = self.search_instrument_with_http_info(query, **kwargs)  # noqa: E501
+            return data
+
+    def search_instrument_with_http_info(self, query, **kwargs):  # noqa: E501
+        """Search instruments  # noqa: E501
+
+        This API provides the functionality to retrieve the instrument details for searched query  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.search_instrument_with_http_info(query, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param object query: natural language query (required)
+        :param object exchanges: Comma separated exchanges
+        :param object segments: Comma separated segments
+        :param object instrument_types: Comma separated instrument types
+        :param object expiry: expiry in format: yyyy-MM-dd
+        :param object atm_offset: page number greater than or equal to 1
+        :param object page_number: ATM offset number for queries like ATM, ATM+1, ATM-1, etc.
+        :param object records: no of records in a single page
+        :return: SearchInstrumentResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['query', 'exchanges', 'segments', 'instrument_types', 'expiry', 'atm_offset', 'page_number', 'records']  # noqa: E501
+        all_params.append('async_req')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method search_instrument" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'query' is set
+        if ('query' not in params or
+                params['query'] is None):
+            raise ValueError("Missing the required parameter `query` when calling `search_instrument`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+        if 'query' in params:
+            query_params.append(('query', params['query']))  # noqa: E501
+        if 'exchanges' in params:
+            query_params.append(('exchanges', params['exchanges']))  # noqa: E501
+        if 'segments' in params:
+            query_params.append(('segments', params['segments']))  # noqa: E501
+        if 'instrument_types' in params:
+            query_params.append(('instrument_types', params['instrument_types']))  # noqa: E501
+        if 'expiry' in params:
+            query_params.append(('expiry', params['expiry']))  # noqa: E501
+        if 'atm_offset' in params:
+            query_params.append(('atm_offset', params['atm_offset']))  # noqa: E501
+        if 'page_number' in params:
+            query_params.append(('page_number', params['page_number']))  # noqa: E501
+        if 'records' in params:
+            query_params.append(('records', params['records']))  # noqa: E501
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['*/*', 'application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['OAUTH2']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/v2/instruments/search', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='SearchInstrumentResponse',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=params.get('async_req'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            collection_formats=collection_formats)

{upstox-python-sdk-2.20.0 → upstox-python-sdk-2.22.0}/upstox_client/api/login_api.py

@@ -369,7 +369,6 @@ class LoginApi(object):
         :param str client_secret:
         :param str redirect_uri:
         :param str grant_type:
-        :param bool refresh_extended_token:
         :return: TokenResponse
                  If the method is called asynchronously,
                  returns the request thread.
@@ -397,13 +396,12 @@ class LoginApi(object):
         :param str client_secret:
         :param str redirect_uri:
         :param str grant_type:
-        :param bool refresh_extended_token:
         :return: TokenResponse
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['api_version', 'code', 'client_id', 'client_secret', 'redirect_uri', 'grant_type', 'refresh_extended_token']  # noqa: E501
+        all_params = ['api_version', 'code', 'client_id', 'client_secret', 'redirect_uri', 'grant_type']  # noqa: E501
         all_params.append('async_req')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -445,8 +443,6 @@ class LoginApi(object):
             form_params.append(('redirect_uri', params['redirect_uri']))  # noqa: E501
         if 'grant_type' in params:
             form_params.append(('grant_type', params['grant_type']))  # noqa: E501
-        if 'refresh_extended_token' in params and params['refresh_extended_token'] is not None:
-            form_params.append(('refresh_extended_token', 'true' if params['refresh_extended_token'] else 'false'))  # noqa: E501
 
         body_params = None
         # HTTP header `Accept`