POSITIONS API

This API fetches the complete list of positions for a dealer or a specific client. It supports retrieving all, daily, or expiry-based positions.

📌 Path Parameters

Parameter	Type	Required	Description	Example / Enum
type	string	Yes	Type of positions to fetch	"all" / "daily" / "expiry"

🔍 Query Parameters

Parameter	Type	Required	Description	Example
client_id	string	No	Client ID to fetch positions for an end user	client_id=VISHAL1
only_pro	integer	No	Flag to fetch only dealer (pro) positions	1
intropStatus	integer	No	Interoperability flag (0 - OFF, 1 - ON)	1

🔑 Header Parameters

Header	Type	Description	Example
Content-Type	string	Specifies the media type	application/json
Authorization	string	Dealer authentication token	Bearer {{access_token}}
x-api-key	string	API key used to authorize the 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 to user request	"s-106"
message	string	Success message	"Positions retrieved successfully"
data	object[]	Array of position objects	Refer below

📦 Position Object Fields

Field	Type	Description	Example
exchange	string	Exchange segment	"NSE"
preferred_exchange	string	Preferred exchange segment	"NSE"
scrip_token	integer	Token number of the instrument	12345
preferred_scrip_token	integer	Preferred exchange token	12345
product_type	string	Product type	"CNC"
symbol	string	Trading symbol	"RELIANCE"
series	string	Series of the instrument	"EQ"
instrument	number	Instrument type identifier	1
expiry_date	string	Expiry date (for derivatives)	"2025-01-30"
strike_price	string	Strike price (for options)	"2500"
option_type	string	Option type	"CE" / "PE"
market_lot	integer	Lot size	1
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	"2550.00"
sell_value	string	Total sell value	"127500"
net_quantity	integer	Net quantity	50
net_price	string	Net price	"2525.25"
net_value	string	Total net value	"126262.5"
cf_buy_value	string	Carry-forward buy value	"100000"
cf_sell_value	string	Carry-forward sell value	"50000"
cf_net_price	string	Carry-forward net price	"2450"
unsetteled_quantity	integer	Unsettled quantity	10
multiplier	string	Multiplier value	"1"
daily_or_expiry	string	Indicates daily or expiry position	"daily"

📌 Notes

• The type path parameter determines the scope of positions returned:
  • all → All positions
  • daily → Intraday positions
  • expiry → Expiry-based positions
• Use client_id to fetch positions specific to an end user.
• Set only_pro=1 to fetch only dealer (pro) level positions.
• The Authorization header must include a valid access_token.