POSITIONS

This API allows an ADMIN user to fetch the net position details of an end user, including buy/sell quantities, MTM-related data, and instrument-level breakdown.

🔗 Path Parameters

Parameter	Type	Required	Description	Example / Enum
type	string	Yes	Position type filter	"all", "daily", "expiry"

🔍 Query Parameters

Parameter	Type	Required	Description	Example / Enum
userId	string	Yes	User ID (UCC)	"{{user_id}}"
intropStatus	integer	No	Interoperability flag	0 = OFF, 1 = ON

🔑 Header Parameters

Header	Type	Description	Example
Content-Type	string	Request payload format	application/json
Authorization	string	Access token for authenticated requests	{{access_token}}
x-api-key	string	API key used to authorize request	{{x-api-key}}

🟢 Success Response - 200 OK

Content-Type: application/json

Field	Type	Description	Example
status	string	Status of API call	"success"
code	string	Response code	"s-101"
message	string	Success message	"Positions fetched successfully"
data	array	List of position details	Refer Data Object Fields

📦 Data Object Fields

Field	Type	Description	Example / Enum
exchange	string	Exchange segment	"NSE_EQ"
preferred_exchange	string	Preferred exchange	"NSE_EQ"
scrip_token	integer	Scrip token	12345
preferred_scrip_token	integer	Preferred scrip token	12345
product_type	string	Product type	"MIS", "CNC"
symbol	string	Trading symbol	"RELIANCE"
series	string	Series	"EQ"
market_lot	integer	Lot size	1
gen_num	integer	Generator numerator	1
gen_den	integer	Generator denominator	1
price_num	integer	Price numerator	1
price_den	integer	Price denominator	1
reference_rate	integer	Reference rate	2500
instrument	string	Instrument name	"EQ", "FUTIDX"
expiry_date	string	Expiry date	"2026-06-25"
strike_price	string	Strike price	"250000"
option_type	string	Option type	"CE", "PE"
buy_quantity	integer	Total buy quantity	100
avg_buy_price	string	Average buy price	"2500.50"
buy_value	string	Total buy value	"250050"
sell_quantity	integer	Total sell quantity	50
avg_sell_price	string	Average sell price	"2510.00"
sell_value	string	Total sell value	"125500"
net_quantity	integer	Net quantity (Buy - Sell)	50
net_price	string	Net price	"2505.25"
net_value	string	Net value	"125250"
cf_buy_value	string	Carry-forward buy value	"50000"
cf_sell_value	string	Carry-forward sell value	"20000"
cf_net_price	string	Carry-forward net price	"2400.00"
unsetteled_quantity	string	Unsettled quantity	"10"
multiplier	string	Contract multiplier	"1"
daily_or_expiry	string	Position type	"daily", "expiry"