Skip to main content

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

ParameterTypeRequiredDescriptionExample/ENUM
Exchange allowednumberYesSpecifies the Exchange Segment. Use -1 to fetch all holdings across segments.-1
ISINstringYesIf a valid ISIN is provided, fetches holding information for only that ISIN. Use %20 to retrieve all holdings.%20
ModestringYesDefines the type of information to retrieve: HOLDINGS for basic data, ALL for detailed data."HOLDING"

🔑Header Parameters

HeaderTypeRequiredDescriptionExample/ENUM
Content-typestringYesDefines the content type of the request.application/json
AuthorizationstringYesBearer token for Authorization{{access_token}}
x-api-keystringYesAPI key provided{{x-api-key}}
api-keystringYesThe API key for identifying the application.{{api_key}}

🟢Success Response - 200 Ok

FieldTypeDescriptionExample
statusstringIndicates the status of the API call"true"
resultarrayContains the resulting data.Array of holding data objects
dataarray of objectsAn array containing the data for each holding.See below for detailed structure

📘Data Object Info Fields

FieldTypeDescriptionExample
ISINstringInternational Securities Identification Number (ISIN) for the holding."IN23456788"
sSeriesstringThe series of the security (e.g., equity, bond, etc.)."EQ"
sSymbolstringThe symbol of the stock or security."TCS"
nMarketSegmentIDintegerThe ID representing the market segment where the stock is listed.1 (Normal Market), 2 (F&O)
nTokenintegerA unique identifier token for the stock."11536"
TOTALFREEQUANTITYstringThe total free quantity of the holding (i.e., available quantity)."200"
sCurvRecvFreestringThe received free quantity for the holding."0"
nBuyAvgPricenumberThe average price at which the stock was bought."1500"
OtherSegmentTokensstringTokens for other market segments the stock may belong to"6789"
nNormal_MarketAllowedintegerFlag indicating whether the stock is allowed in the normal market.1 (Allowed), 0 (Not Allowed)
nScripTypeintegerType of scrip (security), indicating whether it's equity, bond, etc.1 (Equity), 2 (Bond)
nTodayAvgBuyPriceintegerThe average buy price for the stock on the current day."1520"
nUploadedAvgBuyPriceintegerThe 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}