The Upstox Developer API is a free OAuth 2.0 REST and WebSocket suite for building trading and investment applications against a live SEBI-registered brokerage account. It covers order placement, modification and cancellation (V2 and the newer V3 endpoints with order slicing), multi-order and exit-all-positions batch operations, GTT and trailing-stop-loss conditional orders, portfolio holdings, positions and MTF positions, funds and margin, brokerage and charge calculation, trade-wise profit and loss reporting, market quotes with LTP/OHLC/full depth and option greeks, historical and intraday candle data, expired instrument history for backtesting, option chains and contracts, company fundamentals by ISIN, IPO listing and application, mutual fund orders, SIPs and holdings, fund pay-in and payout management, market information analytics (FII/DII activity, OI, change in OI, max pain, put-call ratio), a kill switch, static IP management for algo-trading compliance, and streaming market-data and portfolio feeds over WebSocket.
Upstox Developer API is one of 2 APIs that Upstox publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Orders, Portfolio, Market Data, Historical Data, and Options. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.
This API exposes
101 operations
across 95 paths,
organized into 22 resource areas,
and defines 211 schemas.
It is described by OpenAPI 3.1.0, at version v0.
Requests are made against a single base URL, https://api-v2.upstox.com.
101 operations95 paths211 schemas7 DELETE76 GET12 POST6 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.1.0
API Version
v0
Base URL
https://api.upstox.com
Authentication
OAuth 2.0
Resource Areas
22
Authentication & Security 1
Upstox Developer API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (OAUTH2) using the authorizationCode flow, exposing 2 scopes.
Paths & Operations 101
Across 95 paths, the API surfaces 101 operations — 7 DELETE, 76 GET, 12 POST, 6 PUT. They span 22 resource areas, including Order, PAYMENTS, User, Portfolio, Login, IPO, events-controller-v-2, Charge, and 14 more. Each is listed below with its method, path, parameters, and response codes.
The contract defines 211 schemas that model the data the API accepts and returns. The most detailed are InstrumentData (37 properties), OrderBookData (30 properties), PositionData (29 properties), IpoDetailsData (27 properties). Each schema is shown below with its type and property counts.
ApiGatewayErrorResponse
object
2 properties
Problem
object
7 properties
ModifyOrderRequest
object
7 properties5 required
ModifyOrderData
object
1 property
ModifyOrderV3Response
object
3 properties
OrderMetadata
object
1 property
GttModifyOrderRequest
object
4 properties4 required
GttRule
object
5 properties3 required
GttOrderData
object
1 property
GttTriggerOrderResponse
object
3 properties
ModifyPayoutRequest
object
1 property1 required
PayoutDetails
object
10 properties
PayoutDetailsResponse
object
2 properties
UpdateUserIpRequest
object
2 properties
FamilyMemberData
object
2 properties
UserIpResponse
object
2 properties
UserIpResponseData
object
7 properties
ConvertPositionRequest
object
5 properties5 required
ConvertPositionData
object
1 property
ConvertPositionResponse
object
3 properties
ModifyOrderResponse
object
2 properties
PlaceOrderV3Request
object
12 properties10 required
MultiOrderV3Data
object
1 property
PlaceOrderV3Response
object
3 properties
GttPlaceOrderRequest
object
6 properties6 required
IndieUserTokenRequest
object
3 properties
TokenResponse
object
17 properties
InitiatePayoutRequest
object
2 properties2 required
KillSwitchSegmentUpdateRequest
object
2 properties2 required
KillSwitchResponse
object
2 properties
KillSwitchSegmentData
object
3 properties
BatchExecutionSummary
object
3 properties
CancelOrExitMultiOrderData
object
1 property
CancelOrExitMultiOrderResponse
object
4 properties
CancelOrExitOrderErrorData
object
9 properties
PlaceOrderRequest
object
11 properties10 required
PlaceOrderData
object
1 property
PlaceOrderResponse
object
2 properties
MultiOrderRequest
object
14 properties12 required
MultiOrderData
object
2 properties
MultiOrderError
object
8 properties
MultiOrderResponse
object
4 properties
MultiOrderSummary
object
4 properties
TokenRequest
object
6 properties5 required
IpoApplyRequest
object
4 properties4 required
IpoBidRequest
object
2 properties2 required
IpoApplyData
object
1 property
IpoApplyResponse
object
2 properties
EventRequest
object
3 properties2 required
EventResponse
object
1 property
Instrument
object
5 properties4 required
MarginRequest
object
1 property1 required
Margin
object
7 properties
MarginData
object
3 properties
PostMarginResponse
object
2 properties
AvailableToTrade
object
3 properties
CashAvailableToTrade
object
3 properties
CashBreakdown
object
5 properties
CashMarginUsed
object
7 properties
CashUnavailableToTrade
object
1 property
DeliveryMargin
object
3 properties
GetUserFundMarginV3Response
object
2 properties
Loss
object
3 properties
MarginFromPledge
object
3 properties
PledgeAvailableToTrade
object
2 properties
PledgeMarginUsed
object
6 properties
PledgeUnavailableToTrade
object
2 properties
UnavailableToTrade
object
2 properties
UnsettledProfit
object
2 properties
UserFundMarginV3Data
object
2 properties
GetPositionResponse
object
3 properties
PositionData
object
29 properties
GetGttOrderResponse
object
3 properties
GttOrderDetails
object
10 properties
Rule
object
8 properties
GetMarketQuoteOptionGreekResponseV3
object
2 properties
MarketQuoteOptionGreekV3
object
11 properties
GetMarketQuoteOHLCResponseV3
object
2 properties
MarketQuoteOHLCV3
object
4 properties
OhlcV3
object
6 properties
GetMarketQuoteLastTradedPriceResponseV3
object
2 properties
MarketQuoteSymbolLtpV3
object
5 properties
GetHistoricalCandleResponse
object
2 properties
HistoricalCandleData
object
1 property
GetIntraDayCandleResponse
object
2 properties
IntraDayCandleData
object
1 property
GetProfileResponse
object
2 properties
ProfileData
object
11 properties
PaymentHistoryData
object
12 properties
PaymentHistoryResponse
object
2 properties
PayoutModesData
PayoutModesResponse
object
2 properties
GetUserFundMarginResponse
object
2 properties
UserFundMarginData
object
7 properties
GetTradeWiseProfitAndLossMetaDataResponse
object
2 properties
TradeWiseMetaData
object
2 properties
GetTradeWiseProfitAndLossDataResponse
object
3 properties
ProfitAndLossMetaData
object
2 properties
ProfitAndLossMetaDataWrapper
object
1 property
TradeWiseProfitAndLossData
object
10 properties
GetProfitAndLossChargesResponse
object
2 properties
ProfitAndLossChargesData
object
4 properties
ProfitAndLossChargesTaxes
object
3 properties
ProfitAndLossChargesWrapperData
object
1 property
ProfitAndLossOtherChargesTaxes
object
6 properties
GetHoldingsResponse
object
2 properties
HoldingsData
object
20 properties
GetTradeResponse
object
2 properties
TradeData
object
15 properties
GetOrderBookResponse
object
2 properties
OrderBookData
object
30 properties
GetOrderResponse
object
2 properties
OrderData
object
26 properties
GetOrderDetailsResponse
object
2 properties
GetOptionContractResponse
object
2 properties
InstrumentData
object
37 properties
AnalyticsData
object
6 properties
GetOptionChainResponse
object
2 properties
MarketData
object
9 properties
OptionStrikeData
object
7 properties
PutCallOptionChainData
object
3 properties
GetNewsResponse
object
3 properties
NewsItemData
object
5 properties
NewsResponseMetaData
object
1 property
NewsResponsePageData
object
4 properties
GetMutualFundSipsResponse
object
3 properties
MutualFundMetaData
object
1 property
MutualFundSipData
object
18 properties
Pagination
object
4 properties
GetMutualFundOrdersResponse
object
3 properties
MutualFundOrderData
object
19 properties
GetMutualFundOrderDetailsResponse
object
2 properties
GetMutualFundHoldingsResponse
object
2 properties
MutualFundHoldingData
object
9 properties
ExchangeTimingData
object
3 properties
GetExchangeTimingResponse
object
2 properties
CasEligibleStatusData
object
2 properties
GetMarketStatusResponse
object
2 properties
MarketStatusData
object
4 properties
AnalyticsResponse
object
2 properties
GetHolidayResponse
object
2 properties
HolidayData
object
5 properties
Depth
object
3 properties
DepthMap
object
2 properties
GetFullMarketQuoteResponse
object
2 properties
MarketQuoteSymbol
object
17 properties
Ohlc
object
4 properties
GetMarketQuoteOHLCResponse
object
2 properties
MarketQuoteOHLC
object
3 properties
GetMarketQuoteLastTradedPriceResponse
object
2 properties
MarketQuoteSymbolLtp
object
2 properties
IpoInvestorType
object
2 properties
IpoListingData
object
14 properties
IpoListingResponse
object
3 properties
IpoMetaData
object
1 property
IpoDetailsData
object
27 properties
IpoDetailsResponse
object
2 properties
IpoRegistrarInfo
object
6 properties
IpoTimeline
object
8 properties
IpoOrderBid
object
4 properties
IpoOrderData
object
24 properties
IpoOrderResponse
object
3 properties
IpoOrderDetailResponse
object
2 properties
SearchInstrumentResponse
object
3 properties
SearchMetaData
object
1 property
HistoryItem
object
3 properties
ShareHoldingData
object
2 properties
ShareHoldingsResponse
object
2 properties
CompanyProfileData
object
4 properties
CompanyProfileResponse
object
2 properties
SectorMarketCapAmount
object
3 properties
KeyRatioData
object
3 properties
KeyRatiosResponse
object
2 properties
FinancialStatementEntry
object
2 properties
IncomeStatementData
object
5 properties
IncomeStatementEntry
object
2 properties
IncomeStatementResponse
object
2 properties
CorporateActionData
object
5 properties
CorporateActionEventDetail
object
2 properties
CorporateActionsResponse
object
2 properties
CashFlowData
object
5 properties
CashFlowEntry
object
2 properties
CashFlowResponse
object
2 properties
BalanceSheetData
object
5 properties
BalanceSheetHistoryItem
object
3 properties
BalanceSheetResponse
object
2 properties
CompetitorData
object
5 properties
CompetitorsResponse
object
2 properties
WebsocketAuthRedirectResponse
object
2 properties
WebsocketAuthRedirectResponseData
object
2 properties
ExpiredFutureData
object
15 properties
GetExpiredFuturesContractResponse
object
2 properties
GetExpiriesResponse
object
2 properties
TradeHistoryResponse
object
3 properties
TradeHistoryResponseMetaData
object
1 property
TradeHistoryResponsePageData
object
4 properties
TradeHistoryResponseTradeData
object
15 properties
BrokerageData
object
7 properties
BrokerageTaxes
object
3 properties
BrokerageWrapperData
object
1 property
DpPlan
object
2 properties
GetBrokerageResponse
object
2 properties
OtherTaxes
object
4 properties
GttCancelOrderRequest
object
1 property1 required
CancelOrderData
object
1 property
CancelOrderV3Response
object
3 properties
CancelOrderResponse
object
2 properties
LogoutResponse
object
2 properties
OAuthClientException
object
5 properties
IpoCancelData
object
2 properties
IpoCancelResponse
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Upstox Developer API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
