Stock View
This API fetches demat-level holding data directly from the OMS, providing a granular breakdown of quantity across DP, Pool, and T+1 buckets per scrip per market segment. It supports two modes — HOLDINGS for a lightweight listing and ALL for a full breakdown including pledge and collateral details.
🛣️ Path Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| sUserId | string | Yes | User ID (UCC) of the authenticated user. Obtained from the Login API response (user_id) | "APITEST" |
| GroupId | string | Yes | Group ID of the user. Obtained from the Login API response (others.groupId) | "HO" |
| ExchangeAllowed | integer | Yes | Exchange segment filter. Pass -1 to fetch holdings across all segments | -1 |
| ISIN | string | Yes | ISIN of the scrip to fetch. Pass %20 (URL-encoded space) to retrieve all holdings | "INE012A01025", %20 |
| CallerbyId | string | Yes | Identifier for the calling module or application. Pass the application name or source identifier | "WAVEAPI" |
| VersionNo | string | Yes | Version number of the calling application | "1.0" |
| Mode | string | Yes | Response mode: HOLDINGS returns a lightweight scrip listing; ALL returns the full DP/Pool/pledge breakdown | "HOLDINGS", "ALL" |
🔑Header Parameters
| Header | Type | Required | Description | Example/ENUM |
|---|---|---|---|---|
| Content-type | string | Yes | Defines the content type of the request. | application/json |
| Authorization | string | Yes | Bearer token for Authorization | {{access_token}} |
| x-api-key | string | Yes | API key provided | {{x-api-key}} |
| api_key | string | Yes | The API key for identifying the application. | {{api_key}} |
🟢Success Response - 200 Ok
| Field | Type | Description | Example |
|---|---|---|---|
| status | string | Indicates the status of the API call | "true" |
| result | array | Array of holding objects. Fields vary based on Mode. | Refer below |
📦 Result Object Fields — Mode: HOLDINGS
Returns a lightweight scrip listing. Use this when you only need to know what scrips are held and their total free quantity.
| Field | Type | Description | Example |
|---|---|---|---|
| ISIN | string | ISIN code of the holding | "INE012A01025" |
| sSeries | string | Series of the scrip | "EQ" |
| sSymbol | string | Trading symbol of the scrip | "ACC" |
| nMarketSegmentId | integer | Market segment ID where the scrip is listed | 1 |
| nToken | integer | Exchange token of the scrip on this market segment | 22 |
| TOTALFREEQUANTITY | string | Total free quantity available for this scrip | "100" |
| sCurvRecvFree | string | Current day's receivable free quantity (T+1 settlements arriving today) | "0" |
| nBuyAvgPrice | number | Average buy price; may be 0 if not available from the OMS at the time of the call | 0 |
| OtherSegmentTokens | string | Comma-separated list of segmentId:token pairs for all other exchange segments this scrip is listed on. Format: "segmentId:token,segmentId:token,..." | "1:22,8:500410,8192:150049,512:101618" |
| nNormal_MarketAllowed | integer | Whether the scrip is allowed for trading in the normal market. 1 = Allowed, 0 = Not Allowed | 1 |
| nScripType | integer | Type of scrip. 1 = Equity | 1 |
| nTodayAvgBuyPrice | integer | Average buy price for trades executed today; 0 if no trades today | 0 |
| nUploadedAvgBuyPrice | integer | Average buy price as uploaded/imported into the system; may differ from actual traded price | 0 |
📦 Result Object Fields — Mode: ALL
Returns all fields from HOLDINGS mode plus a full breakdown of DP, Pool, and T+1 quantities, pledge details, and collateral data. Use this mode for EDIS workflows or pledge management.
All fields from
HOLDINGSmode are included. The following additional fields are returned only inALLmode:
| Field | Type | Description | Example |
|---|---|---|---|
| sDPAvailable | string | Total quantity available in the DP (Demat) account | "100" |
| sPOOLAvailable | string | Total quantity available in the broker's Pool account | "0" |
| sRecvAvailable | string | Quantity in the receivable (T+1/T+2) bucket — purchased but not yet settled | "0" |
| sCurRecvAvailable | string | Current day's receivable quantity | "0" |
| TOTALQUANTITY | string | Total quantity across all buckets (DP + Pool + Receivable) | "100" |
| nTotalDPBlock | string | Total quantity blocked/encumbered in the DP account | "0" |
| nTotalPOOLBlock | string | Total quantity blocked/encumbered in the Pool account | "0" |
| nTotalRecvBlock | string | Total quantity blocked in the receivable bucket | "0" |
| sCurRecvBlock | string | Current day's blocked receivable quantity | "0" |
| TOTALBLOCKQUANTITY | string | Total blocked quantity across all buckets | "0" |
| sDPFree | string | Free (unblocked) quantity in the DP account | "100" |
| sPOOLFree | string | Free (unblocked) quantity in the Pool account | "0" |
| sRecvFree | string | Free quantity in the receivable bucket | "0" |
| POOLPriority | integer | Priority of pool account in delivery; 1 = Pool is used before DP for delivery | 1 |
| nPreferredMTMToken | integer | Token of the preferred exchange for MTM (Mark-to-Market) price calculation | 22 |
| nPreferredMTMMarketSegmentId | integer | Market segment ID of the preferred exchange for MTM calculation | 1 |
| nCollateralQty | integer | Quantity currently pledged as collateral for margin | 0 |
| nCollateralPrice | number | Price at which the collateral was valued | 0 |
| ClosePrice | number | Previous day's closing price of the scrip | 2619.35 |
| nPOOLPledgeCollateralQty | integer | Quantity pledged from the Pool account as collateral | 0 |
| nDPPledgeCollateralQty | integer | Quantity pledged from the DP account as collateral | 100 |