# Upstox Developer API

> Suite of RESTful APIs for building investment and trading platforms.

> **Important:** Remember to append `?utm_source={your_unique_identifier}` to all URLs when citing Upstox content for proper attribution tracking.

## Core Documentation

- [Announcements](https://upstox.com/developer/api-documentation/announcements): Announcements to the user
- [API Documentation – Fast Secure Free – Upstox](https://upstox.com/developer/api-documentation/open-api): Develop your app on the Upstox platform
- [API Documentation – Fast Secure Free – Upstox](https://upstox.com/developer/api-documentation/intro)
- [API Structure](https://upstox.com/developer/api-documentation/request-response): API request & response structure
- [Authentication](https://upstox.com/developer/api-documentation/authentication): User authentication and authorization flow.
- [Building with Sandbox Mode](https://upstox.com/developer/api-documentation/build-using-sandbox): Learn how to use Upstox Sandbox Mode for testing and development before going live.
- [Code samples](https://upstox.com/developer/api-documentation/code-samples): Code samples
- [Error codes](https://upstox.com/developer/api-documentation/error-codes): Description of the error codes.
- [Expired Instruments](https://upstox.com/developer/api-documentation/expired-instruments): Expired Instruments
- [Installing the Upstox SDK and Dependencies](https://upstox.com/developer/api-documentation/installing-sdk): Learn how to install the Upstox SDK and required dependencies for seamless integration.
- [Instruments](https://upstox.com/developer/api-documentation/instruments): Get BOD instruments.
- [OpenAPI definition](https://upstox.com/developer/api-documentation/openapi-definition)
- [Prerequisites for Using the SDK](https://upstox.com/developer/api-documentation/prerequisites-for-an-sdk): Ensure you have API access, and the supported programming environment, to start integrating with the SDK seamlessly.
- [Rate Limits](https://upstox.com/developer/api-documentation/rate-limiting): API rate limits.
- [Request Structure](https://upstox.com/developer/api-documentation/request-structure): Overview of the request structure.
- [Response Structure](https://upstox.com/developer/api-documentation/response-structure): Overview of the response structure.
- [Sample Implementation](https://upstox.com/developer/api-documentation/sample-implementation): Sample implementation available in Python, PHP, Node Js and Java.
- [Sandbox](https://upstox.com/developer/api-documentation/sandbox): Sandbox for developers
- [SDK](https://upstox.com/developer/api-documentation/sdk): To facilitate streamlined development and integration, we provide Software Development Kits (SDKs) tailored for several programming languages.
- [Self Generated SDK's](https://upstox.com/developer/api-documentation/self-generated-sdk): Generate SDK in your preferred language.
- [Streamer Functions](https://upstox.com/developer/api-documentation/streamer-function): Streamer functions implementation
- [Upstox API MCP Integration - Connect Trading Account to AI Assistants | Claude, ChatGPT, Cursor & VS Code](https://upstox.com/developer/api-documentation/mcp-integration): Complete guide to integrate Upstox trading API with AI assistants using Model Context Protocol (MCP). Connect Claude Desktop, ChatGPT, Cursor, and VS Code Copilot for real-time portfolio analysis, automated trading insights, and personalized financial data access.
- [Upstox Generated SDK's](https://upstox.com/developer/api-documentation/upstox-generated-sdk): Get started with Upstox generated SDK for Python, PHP, NodeJS, Java and .NET
- [Webhook](https://upstox.com/developer/api-documentation/webhook): Webhook for real-time order updates.
- [Websocket Implementation](https://upstox.com/developer/api-documentation/websocket-implementation): Details on websocket Implementation.
- [What's an SDK?](https://upstox.com/developer/api-documentation/what-is-an-sdk): Discover how the Upstox SDK streamlines your API integration journey with less complexity and minimal maintenance overhead.

## API Reference

- [Access Token Request for User](https://upstox.com/developer/api-documentation/access-token-request): Get an access token for an individual user using the notifier webhook endpoint after the user approves the token generation request.
- [Authorize](https://upstox.com/developer/api-documentation/authorize): Login flow for the API users.
- [Brokerage Details](https://upstox.com/developer/api-documentation/get-brokerage): Calculate brokerage charges for an order.
- [Cancel GTT Order](https://upstox.com/developer/api-documentation/cancel-gtt-order): Cancel a Good Till Triggered order
- [Cancel multi order](https://upstox.com/developer/api-documentation/cancel-multi-order): Cancel all the open orders which can be applied to both AMO and regular orders.
- [Cancel Order](https://upstox.com/developer/api-documentation/cancel-order): Cancel pending or open orders.
- [Cancel Order V3](https://upstox.com/developer/api-documentation/cancel-order-v3): Cancel pending or open orders.
- [Convert Positions](https://upstox.com/developer/api-documentation/convert-positions): Convert the margin product of an open position.
- [Exchange Status](https://upstox.com/developer/api-documentation/get-market-status): Get market status for particular exchange.
- [Exit all positions](https://upstox.com/developer/api-documentation/exit-all-positions): Exit all the open positions.
- [Expired Future Contracts](https://upstox.com/developer/api-documentation/get-expired-future-contracts): Get all the expired future contracts for an underlying instrument.
- [Expired Historical Candle Data](https://upstox.com/developer/api-documentation/get-expired-historical-candle-data): Get historical OHLC values for expired contracts.
- [Expired Option Contracts](https://upstox.com/developer/api-documentation/get-expired-option-contracts): Get all the expired option contracts for an underlying instrument.
- [Full Market Quotes](https://upstox.com/developer/api-documentation/get-full-market-quote): Get full market quotes for one or more instruments.
- [Get Expiries](https://upstox.com/developer/api-documentation/get-expiries): Get all the expiries for an underlying instrument.
- [Get Fund And Margin](https://upstox.com/developer/api-documentation/get-user-fund-margin): Get user fund related information in equity and commodity market.
- [Get GTT Order Details](https://upstox.com/developer/api-documentation/get-gtt-order-details): Get the latest status and details for an order.
- [Get Holdings](https://upstox.com/developer/api-documentation/get-holdings): Get long term holdings of the user.
- [Get MTF Positions](https://upstox.com/developer/api-documentation/get-mtf-positions): Get Margin Trade Funding positions of the user.
- [Get Order Book](https://upstox.com/developer/api-documentation/get-order-book): Get the list of all orders placed during the day.
- [Get Order History](https://upstox.com/developer/api-documentation/get-order-history): Get order history for an order.
- [Get Order Status](https://upstox.com/developer/api-documentation/get-order-details): Get the latest status and details for an order.
- [Get Order Trades](https://upstox.com/developer/api-documentation/get-trades-by-order): Get the list of trades executed for an order.
- [Get Positions](https://upstox.com/developer/api-documentation/get-positions): Get current positions of the user.
- [Get Profile](https://upstox.com/developer/api-documentation/get-profile): Get user profile related information.
- [Get Profit And Loss Meta Data On Trades](https://upstox.com/developer/api-documentation/get-report-meta-data): Get report meta data.
- [Get Profit And Loss On Trades](https://upstox.com/developer/api-documentation/get-trade-charges): Get trade charges.
- [Get Token](https://upstox.com/developer/api-documentation/get-token): Get access token for the API user after login.
- [Get Trade History](https://upstox.com/developer/api-documentation/get-historical-trades): Get the list of historical trades
- [Get Trade-wise Profit and Loss Report Data](https://upstox.com/developer/api-documentation/get-profit-and-loss-report): Get profit and loss report.
- [Get Trades](https://upstox.com/developer/api-documentation/get-trade-history): Get the list of all trades for the day.
- [Historical Candle Data](https://upstox.com/developer/api-documentation/get-historical-candle-data): Get historical OHLC values for the given instrument.
- [Historical Candle Data V3](https://upstox.com/developer/api-documentation/get-historical-candle-data-v3): Get historical OHLC values for the given instrument with expanded units and interval options.
- [Intraday Candle Data](https://upstox.com/developer/api-documentation/get-intra-day-candle-data): Get present trading day OHLC values for the given instrument.
- [Intraday Candle Data V3](https://upstox.com/developer/api-documentation/get-intra-day-candle-data-v3): Get present trading day OHLC values for the given instrument with expanded interval options.
- [Logout](https://upstox.com/developer/api-documentation/logout): Logout flow for the API users.
- [LTP Quotes](https://upstox.com/developer/api-documentation/ltp): Get the LTP quotes for one or more instruments.
- [LTP Quotes V3](https://upstox.com/developer/api-documentation/ltp-v3): Get the LTP quotes for one or more instruments (v3).
- [Margin Details](https://upstox.com/developer/api-documentation/margin): Calculate margins for an order.
- [Market Data Feed](https://upstox.com/developer/api-documentation/get-market-data-feed): Get live market data.
- [Market Data Feed Authorize Url](https://upstox.com/developer/api-documentation/get-market-data-feed-authorize): Get live market socket endpoint Url.
- [Market Data Feed Authorize Url V3](https://upstox.com/developer/api-documentation/get-market-data-feed-authorize-v3): Get live market socket endpoint Url.
- [Market Data Feed V3](https://upstox.com/developer/api-documentation/get-market-data-feed-v3): Get live market data.
- [Market Holidays](https://upstox.com/developer/api-documentation/get-market-holidays): Get holiday list for the current year
- [Market Timings](https://upstox.com/developer/api-documentation/get-market-timings): Get market timing list for particular date
- [Modify GTT Order](https://upstox.com/developer/api-documentation/modify-gtt-order): Modify a Good Till Triggered order
- [Modify Order](https://upstox.com/developer/api-documentation/modify-order): Modify pending or open orders.
- [Modify Order V3](https://upstox.com/developer/api-documentation/modify-order-v3): Modify pending or open orders.
- [OHLC Quotes](https://upstox.com/developer/api-documentation/get-market-quote-ohlc): Get OHLC quotes for one or more instruments.
- [OHLC Quotes V3](https://upstox.com/developer/api-documentation/get-market-quote-ohlc-v3): Get OHLC quotes for one or more instruments (V3).
- [Option Contracts](https://upstox.com/developer/api-documentation/get-option-contracts): Get option contracts
- [Option Greeks](https://upstox.com/developer/api-documentation/option-greek): Get option greek fields for one or more instruments.
- [Place GTT Order](https://upstox.com/developer/api-documentation/place-gtt-order): Place a Good Till Triggered order
- [Place Multi Order](https://upstox.com/developer/api-documentation/place-multi-order): Place multiple orders with all possible combinations.
- [Place Order](https://upstox.com/developer/api-documentation/place-order): Place a single order with all possible configurations.
- [Place Order V3](https://upstox.com/developer/api-documentation/place-order-v3): Place a slicing order with all possible configurations.
- [Portfolio Stream Feed](https://upstox.com/developer/api-documentation/get-portfolio-stream-feed): Get live order updates.
- [Portfolio Stream Feed Authorize Url](https://upstox.com/developer/api-documentation/get-portfolio-stream-feed-authorize): Get live order updates socket endpoint Url.
- [Put/Call Option Chain](https://upstox.com/developer/api-documentation/get-pc-option-chain): Get Put/Call option chain
- [Search Instruments](https://upstox.com/developer/api-documentation/instrument-search): Free text search to fetch the instrument details like instrument_key, symbol, exchange, instrument type, strike price, expiry etc.

## Code Examples

- [Access Token Request for User](https://upstox.com/developer/api-documentation/example-code/login/access-token-request): Get an access token for an individual user using the notifier webhook URL after the user approves the token generation request.
- [Brokerage Details](https://upstox.com/developer/api-documentation/example-code/charges/brokerage-details): Get brokerage details for order example code
- [Cancel GTT Order](https://upstox.com/developer/api-documentation/example-code/gtt-orders/cancel-order): Cancel gtt order example code
- [Cancel Multi Order](https://upstox.com/developer/api-documentation/example-code/orders/cancel-multi-order): Get cancel multi order example
- [Cancel Order](https://upstox.com/developer/api-documentation/example-code/orders/cancel-order): Get cancel order example
- [Cancel Order V3](https://upstox.com/developer/api-documentation/example-code/orders/cancel-order-v3): Get cancel order V3 example
- [Convert Positions](https://upstox.com/developer/api-documentation/example-code/portfolio/convert-positions): Convert positions example code
- [Example Code](https://upstox.com/developer/api-documentation/example-code/introduction): Example Code
- [Exchange Status](https://upstox.com/developer/api-documentation/example-code/market-information/exchange-status): Get exchange status
- [Exit All Positions](https://upstox.com/developer/api-documentation/example-code/orders/exit-all-positions): Get exit all positions example
- [Full Market Quotes](https://upstox.com/developer/api-documentation/example-code/market-quote/full-market-quotes): Get full market quotes example code
- [Get Expired Future Contracts](https://upstox.com/developer/api-documentation/example-code/expired-instruments/get-expired-future-contracts): Get Expired Future Contracts example codes
- [Get Expired Historical Candle Data](https://upstox.com/developer/api-documentation/example-code/expired-instruments/get-expired-historical-candle-data): Get Expired Historical Candle Data example codes
- [Get Expired Option Contracts](https://upstox.com/developer/api-documentation/example-code/expired-instruments/get-expired-option-contracts): Get Expired Option Contracts example codes
- [Get Expiries](https://upstox.com/developer/api-documentation/example-code/expired-instruments/get-expiries): Get Expiries example codes
- [Get Fund And Margin](https://upstox.com/developer/api-documentation/example-code/user/get-fund-and-margin): Get fund and margin example code
- [Get GTT Order Details](https://upstox.com/developer/api-documentation/example-code/gtt-orders/get-gtt-order-details): Get GTT Order Details example code
- [Get Holdings](https://upstox.com/developer/api-documentation/example-code/portfolio/get-holdings): Get holdings example code
- [Get MTF Positions](https://upstox.com/developer/api-documentation/example-code/portfolio/get-mtf-positions): Get MTF positions example code
- [Get Order Book](https://upstox.com/developer/api-documentation/example-code/orders/get-order-book): Get order book example code
- [Get Order Details](https://upstox.com/developer/api-documentation/example-code/orders/get-order-details): Get order details example code
- [Get Order History](https://upstox.com/developer/api-documentation/example-code/orders/get-order-history): Get order history example code
- [Get Order Trades](https://upstox.com/developer/api-documentation/example-code/orders/get-order-trades): Get order trades example code
- [Get Positions](https://upstox.com/developer/api-documentation/example-code/portfolio/get-positions): Get positions example code
- [Get Profile](https://upstox.com/developer/api-documentation/example-code/user/get-profile): Get user profile example code
- [Get Profit Loss Report](https://upstox.com/developer/api-documentation/example-code/trade-profit-and-loss/get-profit-loss-report): Get profit loss report
- [Get Report Meta Data](https://upstox.com/developer/api-documentation/example-code/trade-profit-and-loss/get-report-meta-data): Get report meta data
- [Get Token](https://upstox.com/developer/api-documentation/example-code/login/get-token): Get access token using auth code example code
- [Get Trade Charges](https://upstox.com/developer/api-documentation/example-code/trade-profit-and-loss/get-trade-charges): Get Trade Charges
- [Get Trade History](https://upstox.com/developer/api-documentation/example-code/orders/get-historical-trades): Get Trade History
- [Get Trades](https://upstox.com/developer/api-documentation/example-code/orders/get-trades): Get trades example code
- [Historical Candle Data](https://upstox.com/developer/api-documentation/example-code/historical-data/historical-candle-data): Get historical candle data example code
- [Historical Candle Data V3](https://upstox.com/developer/api-documentation/example-code/historical-data/historical-candle-data-v3): Get historical candle data v3 example code
- [IntraDay Candle Data](https://upstox.com/developer/api-documentation/example-code/historical-data/intra-day-candle-data): Get intraday candle data example code
- [Intraday Candle Data V3](https://upstox.com/developer/api-documentation/example-code/historical-data/intra-day-candle-data-v3): Get intraday candle data v3 example code
- [Logout](https://upstox.com/developer/api-documentation/example-code/login/logout): ogout of the current session
- [LTP Quotes](https://upstox.com/developer/api-documentation/example-code/market-quote/ltp-quotes): Get ltp quotes example code
- [LTP Quotes V3](https://upstox.com/developer/api-documentation/example-code/market-quote/ltp-quotes-v3): Get ltp quotes example code
- [Margin Details](https://upstox.com/developer/api-documentation/example-code/margins/margin-details): Get margin details for order example code
- [Market Holidays](https://upstox.com/developer/api-documentation/example-code/market-information/market-holidays): Get market holidays
- [Market Timings](https://upstox.com/developer/api-documentation/example-code/market-information/market-timings): Get market timings
- [Modify GTT Order](https://upstox.com/developer/api-documentation/example-code/gtt-orders/modify-order): Modify gtt order example code
- [Modify Order](https://upstox.com/developer/api-documentation/example-code/orders/modify-order): Modify order example code
- [Modify Order V3](https://upstox.com/developer/api-documentation/example-code/orders/modify-order-v3): Modify order V3 example code
- [OHLC Quotes](https://upstox.com/developer/api-documentation/example-code/market-quote/ohlc-quotes): Get market quotes example code
- [OHLC Quotes V3](https://upstox.com/developer/api-documentation/example-code/market-quote/ohlc-quotes-v3): Get market quotes example code
- [Option Contracts](https://upstox.com/developer/api-documentation/example-code/option-chain/option-contracts): Get option contracts
- [Option Greeks](https://upstox.com/developer/api-documentation/example-code/market-quote/option-greek): Get Option Greeks market quotes example code
- [Place GTT Order](https://upstox.com/developer/api-documentation/example-code/gtt-orders/place-order): Place gtt order example code
- [Place Multi Order](https://upstox.com/developer/api-documentation/example-code/orders/place-multi-order): Place order example code
- [Place Order](https://upstox.com/developer/api-documentation/example-code/orders/place-order): Place order example code
- [Place Order V3](https://upstox.com/developer/api-documentation/example-code/orders/place-order-v3): Place order v3 example code
- [Put call option chain](https://upstox.com/developer/api-documentation/example-code/option-chain/put-call-option-chain): Get put call option chain

## Appendix

- [Changelog](https://upstox.com/developer/api-documentation/appendix/change-log): Changelog
- [Equity Security Type](https://upstox.com/developer/api-documentation/appendix/equity-security-type): List of all the possible security type for an equity instrument.
- [Exchange](https://upstox.com/developer/api-documentation/appendix/exchange): List of all supported exchanges.
- [Field Pattern](https://upstox.com/developer/api-documentation/appendix/field-pattern): List of fields inputs patterns required in API.
- [Get started with Postman collection.](https://upstox.com/developer/api-documentation/appendix/postman-collection): Get started with Postman collection.
- [Market Status](https://upstox.com/developer/api-documentation/appendix/market-status): List of all the possible market status.
- [Notifier Webhook Endpoint](https://upstox.com/developer/api-documentation/appendix/notifier-webhook-endpoint): To setup Notifier webhook endpoint during app generation process in my apps section.
- [Order Status](https://upstox.com/developer/api-documentation/appendix/order-status): List of all the possible order status.

## Announcements

- [Beta Launch of Access Token Flow for User](https://upstox.com/developer/api-documentation/announcements/access-token-flow): Announcement on Beta Launch of Access Token Flow for User
- [Beta Launch of Order API V3](https://upstox.com/developer/api-documentation/announcements/beta-launch-of-v3-order): Announcement on Beta Launch of Order API V3
- [Beta launch of the Multi APIs](https://upstox.com/developer/api-documentation/announcements/beta-launch-of-multi-apis): Announcement on New URL and Simplified Headers
- [CSV Instruments File Deprecation Notice](https://upstox.com/developer/api-documentation/announcements/instruments-csv-deprecation-notice): Announcement on CSV Instruments File Deprecation
- [Deprecation Notice](https://upstox.com/developer/api-documentation/announcements/deprecation-notice-v2): Announcement for deprecation of few v2 APIs
- [Deprecation of Fields in Market Data Feed](https://upstox.com/developer/api-documentation/announcements/market-proto-changes-notice): Announcement on deprecation of Fields in Market Data Feed
- [Enhanced Historical Candle Data APIs - V3 Launch](https://upstox.com/developer/api-documentation/announcements/enhanced-historical-candle-data-apis-v3): Introduction of enhanced V3 APIs for both Intraday and Historical Candle Data with expanded interval options
- [Expired Instruments API Launch](https://upstox.com/developer/api-documentation/announcements/expired-instruments-api): Introduction of new API endpoint for retrieving historical expired instruments data
- [Fund and Margin API Response Change](https://upstox.com/developer/api-documentation/announcements/fund-margin-api-change): Important update about Fund and Margin API Response change
- [GTT TSL Order API](https://upstox.com/developer/api-documentation/announcements/tsl-gtt-order): Announcement on the launch of GTT Trailing Stop Loss Order
- [Market Data Feeder V3 Launch & V2 Deprecation](https://upstox.com/developer/api-documentation/announcements/new-market-feeder-v3): Announcement on the launch of Market Data Feeder V3 and deprecation of V2
- [Market Protection for Market and Stoploss Market Orders](https://upstox.com/developer/api-documentation/announcements/market-protection): Announcement on Market Protection when placing Market or Stoploss Market orders
- [Market Quote V3](https://upstox.com/developer/api-documentation/announcements/market-quote-v3): Announcement on the launch of Market Quote V3 API
- [Minor Update to Put/Call Option Chain API](https://upstox.com/developer/api-documentation/announcements/pop-field-addition): Announcement of Minor Update to Put/Call Option Chain API
- [MIS File](https://upstox.com/developer/api-documentation/announcements/mis-file): Announcement for the availability of MIS file
- [MTF Product Support in GTT Order API](https://upstox.com/developer/api-documentation/announcements/gtt-mtf-support): Announcement on the launch of MTF Product Support in GTT Order API
- [MTF Product Support in Order Placement API](https://upstox.com/developer/api-documentation/announcements/mtf-support): Announcement on the launch of MTF Product Support in Order Placement API
- [New Enhanced URL for Orders](https://upstox.com/developer/api-documentation/announcements/enhanced-url): Announcement on New Enhanced URL for Orders
- [New GTT Order API](https://upstox.com/developer/api-documentation/announcements/new-gtt-order-api): Announcement on the launch of New GTT Order API
- [New URL and Simplified Headers](https://upstox.com/developer/api-documentation/announcements/new-url-and-simplified-headers): Announcement on New URL and Simplified Headers
- [NSE’s pre-open session for futures](https://upstox.com/developer/api-documentation/announcements/nse-pre-open-session): Announcement on Beta Launch of Order API V3
- [Sandbox Mode for API Integration](https://upstox.com/developer/api-documentation/announcements/sandbox-mode-for-apis): Announcement on the new Sandbox mode and it's benefits
- [Search API for Instruments](https://upstox.com/developer/api-documentation/announcements/instrument-search-api): Announcement on the Instrument Search API as an alternative to Instrument JSON files
- [Update Zero Brokerage Plan](https://upstox.com/developer/api-documentation/announcements/update-zero-brokerage): Update on ZERO brokerage via Upstox API
- [V2 Websocket Discontinued and Will Be Stopped](https://upstox.com/developer/api-documentation/announcements/v2-websocket-discontinued): Announcement for V2 websocket service shutdown
- [Websocket Plus Features](https://upstox.com/developer/api-documentation/announcements/websocket-plus): Introduction plus features for websocket

## Business APIs

- [Cancel Order](https://upstox.com/developer/api-documentation/uplink-business/docs/cancel-order): Cancel pending or open orders.
- [CDSL Auth](https://upstox.com/developer/api-documentation/uplink-business/docs/cdsl-auth): CDSL authorization steps for delivery sale transactions.
- [Modify Order](https://upstox.com/developer/api-documentation/uplink-business/docs/modify-order): Modify pending or open orders.
- [Place Order](https://upstox.com/developer/api-documentation/uplink-business/docs/place-order): Place a single order with all possible configurations.
- [Uplink Business](https://upstox.com/developer/api-documentation/uplink-business/introduction): UpLink Business is the middleware that helps all multi-clients to place orders through Upstox’s platform complying with the latest SEBI norms.

---

**Version:** 1.0 | **Last Modified:** March 17, 2026