Stock View
This API call fetches all holdings data from the portfolio page, along with additional details like pledged quantity, free quantity, etc.
🛣️Path Parameters
| Parameter | Type | Required | Description | Example/ENUM |
|---|---|---|---|---|
| Exchange allowed | number | Yes | Specifies the Exchange Segment. Use -1 to fetch all holdings across segments. | -1 |
| ISIN | string | Yes | If a valid ISIN is provided, fetches holding information for only that ISIN. Use %20 to retrieve all holdings. | %20 |
| Mode | string | Yes | Defines the type of information to retrieve: HOLDINGS for basic data, ALL for detailed data. | "HOLDING" |
🔑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 | Contains the resulting data. | Array of holding data objects |
| data | array of objects | An array containing the data for each holding. | See below for detailed structure |
📘Data Object Info Fields
| Field | Type | Description | Example |
|---|---|---|---|
| ISIN | string | International Securities Identification Number (ISIN) for the holding. | "IN23456788" |
| sSeries | string | The series of the security (e.g., equity, bond, etc.). | "EQ" |
| sSymbol | string | The symbol of the stock or security. | "TCS" |
| nMarketSegmentID | integer | The ID representing the market segment where the stock is listed. | 1 (Normal Market), 2 (F&O) |
| nToken | integer | A unique identifier token for the stock. | "11536" |
| TOTALFREEQUANTITY | string | The total free quantity of the holding (i.e., available quantity). | "200" |
| sCurvRecvFree | string | The received free quantity for the holding. | "0" |
| nBuyAvgPrice | number | The average price at which the stock was bought. | "1500" |
| OtherSegmentTokens | string | Tokens for other market segments the stock may belong to | "6789" |
| nNormal_MarketAllowed | integer | Flag indicating whether the stock is allowed in the normal market. | 1 (Allowed), 0 (Not Allowed) |
| nScripType | integer | Type of scrip (security), indicating whether it's equity, bond, etc. | 1 (Equity), 2 (Bond) |
| nTodayAvgBuyPrice | integer | The average buy price for the stock on the current day. | "1520" |
| nUploadedAvgBuyPrice | integer | The average buy price as uploaded to the system (can differ from actual buy price). | 1480 |
get
/transactional/v1/getStockView/{sUserId}/{GroupId}/{ExchangeAllowed}/{ISIN}/{CallerbyId}/{VersionNo}/{Mode}