Skip to main content

Positions

Positions contain the user open position across exchange segments. The Equity positions which are passed overnight are transferred to the holdings portfolio the following day. The positions API provides two sets of positions i.e. Daily and Expiry where position tagged as ‘Expiry’ is the carryforwarded positions and position tagged as ‘Daily’ is today's created positions.

🛣️Path Parameter

ParameterTypeRequiredDescriptionExample/ENUM
typestringYesThe type of positions to fetch. Possible values are:
all: Fetch all positions,
daily: Fetch daily positions,
expiry: Fetch positions by expiry
all, daily, expiry

🟢Success Response - 200 Ok

FieldTypeDescriptionExample
statusstringIndicates the result of API Call"success"
codestringResponse code corresponding to the request"s-101"
messagestringDescriptive message for the response"Success Message"
dataarraryAn array of position objects containing the user's position details.See below table

📘Data Object Info Fields

FieldTypeDescriptionExample
exchangestringThe Exchange segments where the scrip is tradedNSE, BSE, MCX, etc.
scrip_tokenintegerExchange token number assigned to the scrip or instrument."123456"
product_typestringProduct type used for trading."INTRADAY"
symbolstringSymbol code provided in the exchange scripmaster file"KOLTEPATIL"
seriesstringSeries to which the scrip belongs (e.g., A, Eq, B, T, Z, etc.)."EQ"
instrumentstringInstrument name (e.g., underlying instrument for F&O)."EQUITIES"
expiry_datestringExpiry date of the contract in YYYY-MM-DD format.2025-06-30
strike_pricestringStrike price of the contract, usually in Paise."0.01"
option_typestringOption type (whether it is a Call or Put option).CE (Call Option), PE (Put Option)
buy_quantityintegerQuantity of the scrip bought by the user.50 , 100
avg_buy_pricestringAverage buy price of the scrip."271.70"
buy_valuestringTotal value of the buy order."815.10"
sell_quantityintegerQuantity of the scrip sold by the user100,200
avg_sell_pricestringAverage sell price of the scrip."360.50"
sell_valuestringTotal value of the sell order."36050"
net_quantityintegerNet quantity of the position (buy quantity - sell quantity)50,100
net_pricestringNet price of the position (average buy/sell price after carry forwards)."355.75"
net_valuestringTotal value of the net position (net quantity * net price)."1778.75"
multiplierstringOrder type (e.g., Limit, Market, Stop-Loss). Refer to Global Constants."1.00"

🔴 Error Response - 400 Bad Request

FieldTypeDescriptionExample
statusstringStatus of the API call Default Error"error"
codestringError code indicating the failure"e-101"
messagestringSpecific message explaining the reason for failed request."Error Message"
get/transactional/v1/portfolio/positions/{type}