Get Holdings

API to retrieve the long term holdings of the user. A Holding within a holdings portfolio remains in place without a predetermined time limit. It can only be withdrawn when it is divested, delisted, or subject to modifications dictated by the stock exchanges. In essence, the instruments housed in the portfolio are securely located within the user's DEMAT account, in strict compliance with the regulations.

Header Parameters

Name	Required	Type	Description
Authorization	true	string	Requires the format Bearer access_token where access_token is obtained from the Token API.
Accept	true	string	Defines the content format the client expects, which should be set to application/json.

Responses

• 200

---

Response Body

{
  "status": "success",
  "data": [
    {
      "isin": "INE528G01035",
      "cnc_used_quantity": 0,
      "collateral_type": "WC",
      "company_name": "YES BANK LTD.",
      "haircut": 0.2,
      "product": "D",
      "quantity": 36,
      "trading_symbol": "YESBANK",
      "tradingsymbol": "YESBANK",
      "last_price": 17.05,
      "close_price": 17.05,
      "pnl": -61.2,
      "day_change": 0,
      "day_change_percentage": 0,
      "instrument_token": "NSE_EQ|INE528G01035",
      "average_price": 18.75,
      "collateral_quantity": 0,
      "collateral_update_quantity": 0,
      "t1_quantity": 0,
      "exchange": "NSE"
    },
    {
      "isin": "INE036A01016",
      "cnc_used_quantity": 0,
      "collateral_type": "WC",
      "company_name": "RELIANCE INFRASTRUCTURE LTD.",
      "haircut": 1,
      "product": "D",
      "quantity": 1,
      "trading_symbol": "RELINFRA",
      "tradingsymbol": "RELINFRA",
      "last_price": 174.85,
      "close_price": 169.2,
      "pnl": -17.7,
      "day_change": 0,
      "day_change_percentage": 0,
      "instrument_token": "NSE_EQ|INE036A01016",
      "average_price": 192.55,
      "collateral_quantity": 0,
      "collateral_update_quantity": 0,
      "t1_quantity": 0,
      "exchange": "NSE"
    }
  ]
}

Name	Type	Description
status	string	A string indicating the outcome of the request. Typically success for successful operations.
data	object[]	Response data for holdings
data[].isin	string	The standard ISIN representing stocks listed on multiple exchanges
data[].cnc_used_quantity	int32	Quantity either blocked towards open or completed order
data[].collateral_type	string	Category of collateral assigned by RMS
data[].company_name	string	Name of the company
data[].haircut	float	This is the haircut percentage applied from RMS (applicable incase of collateral)
data[].product	string	Signifies if the order was either Intraday, Delivery or CO. Possible values: I, D, CO, MTF.
data[].quantity	int32	The total holding qty
data[].trading_symbol	string	Shows the trading symbol of the instrument
data[].last_price	float	The last traded price of the instrument
data[].close_price	float	Closing price of the instrument from the last trading day
data[].pnl	float	Profit and Loss
data[].day_change	float	Day's change in absolute value for the stock
data[].day_change_percentage	float	Day's change in percentage for the stock
data[].instrument_token	string	Key of the instrument. For the regex pattern applicable to this field, see the Field Pattern Appendix.
data[].average_price	float	Average price at which the net holding quantity was acquired
data[].collateral_quantity	int32	Quantity marked as collateral by RMS on users request
data[].collateral_update_quantity	int32	Updated collateral quantity
data[].t1_quantity	int32	Quantity on T+1 day after order execution
data[].exchange	string	Exchange to which the order is associated. Valid exchanges can be found in the Exchange Appendix

Notice of Deprecation

The lowercase field (tradingsymbol) is deprecated and will be removed in future versions. Use the snake_case versions for consistency.

Examples

A comprehensive set of examples is provided to illustrate various use cases and implementation scenarios for this API. To view detailed examples and access sample code, please refer to: API Examples.

Loading...