1. Glossary
  • Fundamental Data API - Introduction
  • Authentication, Request & Response
  • Code Samples & API Trial
  • List of APIs
  • Type of Corporate Data Available
  • Corporate Data APIs
    • Corporate Announcements
      • GetCorporateAnnouncementsCategories
      • GetCorporateAnnouncements
    • Corporate Announcement Attachment Downloader
      • GetCorporateAnnouncementAttachment
    • Corporate Actions
      • GetCorporateActionsCategories
      • GetCorporateActions
    • Financial Results
      • GetResultsCalendar
      • GetFinancialResultsItems
      • GetFinancialResults
      • GetFinRatioEOD
      • GetFinRatioQuarterly
      • GetFinRatioSnapshot
    • Sectoral Classification
      • GetSectoralClassification
      • GetSectors
      • GetMei
      • GetIndustries
      • GetBasicIndustries
    • Share Holding Patterns
      • GetShpItems
      • GetSHP
      • GetSHPAdvanced
    • Market Capitalization
      • GetScripMCap
      • GetExchangeMCap
    • Voting Results
      • GetVotingItems
      • GetVoting
    • Corporate Governance
      • GetCorporateGovernanceItems
      • GetCorporateGovernance
    • Annual Results (PDF)
      • GetAnnualReports
    • Company Information
      • GetCompanyData
    • Bulk / Block Deals
      • GetBulkDeals
      • GetBlockDeals
    • Delivery Volumes
      • GetDeliveryVolumes
    • Promoter's Pledge
      • GetConsolidatedPledge
  • Other Data APIs
    • Index Constituents
    • GetEODStats
      GET
    • GetBhavCopyCM
      GET
    • GetBhavCopyFO
      GET
    • GetFuturesAndOptions
      GET
    • GetIndexDetail
      GET
    • GetCircuitFilterDetails
      GET
    • GetStatisticsGroupAbCompanies
      GET
    • GetTop5GainersLosers
      GET
    • GetIndexHighlights
      GET
    • GetTotalTradeHighlights
      GET
    • GetScripGroupTradeHighlights
      GET
    • GetTurnoverDetailsOfTop15ScripsofAgroup
      GET
  • EOD Statistics
    • GetSeriesChange
    • GetBannedSecurities
    • ​GetDeliverable
    • GetVolatality
    • GetNewHL
    • GetCircuitBreakers
  • Helper APIs
    • GetServerInfo
    • GetLimitation
    • GetInstruments
  • Glossary
    • Glossary
  • Diagnostic API Responses
    • Diagnostic API Responses
  • Release Notes
    • 📢Release Notes
  1. Glossary

Glossary

Request Parameters

Sr. No Parameter Description
1accessKeyAuthentication key for API access.
2dateSpecific date for data retrieval. Date in Epoch format eg: 1740493802, String eg:02-25-2025 21:00:02
3detailedDetailed Information: True/ False
4dTFormatDate and time format specification. Available values : Epoch eg: 1740493802, String eg:02-25-2025 21:00:02
5exchangeMarket exchange identifier. Example: BSE
6formatDesired output format. Available values : Json, Xml, Csv, CsvContent
7fromStarting timestamp for called data. Expressed as Unix Time.
8fromYearStarting year for data extraction. Example: 2024
9groupsCompany groups. Example: A+B, A,B
10instrumentIdentifierExample: RELIANCE
11instrumentIdentifiersExample: RELIANCE+ABB
12natureOfReportsType or classification of reports requested. Available values : Standalone, Consolidated
13periodsTime intervals for data. Available values : QM, M12, QJ, QS, M6, QD, M9
14RangeThe time span for financial data result retrieval
15toEnding timestamp for called data. Expressed as Unix Time.
16toYearEnding year for data extraction. Example: 2025
17typesClassification or type of data.
18yearSpecific year for data retrieval. Example: 2024

Response Parameters

Sr. No. Parameter Description
1ActionIdUnique identifier for the corporate action.
2AdvancesStocks had a price increase compared to their previous closing price on given date.
3AnnouncementDateDate of the corporate announcement.
4AnnouncementUrlURL for the official announcement.
5AnnounceTypeType of corporate announcement (e.g., dividend, bonus issue).
6AttachmentNameName of the file attached to the announcement.
7AttachmentUrlURL to download the attachment.
8BaseChangeThis represents the change in price compared to the base price.
9BasePriceReference price used for calculating price variations, margins, and other trading parameters for the contract.
10BcRdFlagIndicates whether the record date or book closure is applicable.
11BcRdFromStart date for book closure or record date.
12BcRdToEnd date for book closure or record date.
13BizDtBusiness date related to the corporate action.
14ChangeChange in price.
15ChangePctPercentage change in price.
16CktFlagThis means the stock has hit the Lower Circuit Limit on the given date.
17ClientNameName of the client associated with the data.
18CloseThe last traded price of the contract at market close on the given date.
19ClosePriceFinal traded price of the contract at the market close on the given date.
20ClosingLast traded price of a security or contract at the end of the official trading session for the day.
21CompanyNameName of the company issuing the corporate action.
22ContextNameContext or category of the corporate action.
23ContractsNoTotal number of derivative contracts traded for the specified instrument on the given date.
24CorporateActionTypeSpecific type of corporate action (e.g., merger, rights issue).
25CriticalNewsIndicates if the news is critical for stakeholders.
26CumTrdValTotal value of traded contracts (Volume × Price).
27CumTrdVolTotal contracts traded so far in the session.
28CurrentClosingLatest closing price of the stock on the given trading day.
29DateDate.
30DealTypeType of financial deal (e.g., M&A, stake sale).
31DecimalsNumber of decimal places used in price or quantity values.
32DeclinesNumber of stocks within Group A and B companies that have experienced a decrease in their stock price.
33DeliveryQtyQuantity of shares delivered in settlement.
34DeliveryQtyPctPercentage of total shares delivered.
35DeliveryValueTotal value of shares delivered.
36DescriptionDetailed description.
37DescriptorLabel or tag (e.g., Board Meeting Rescheduled).
38DescriptorIdUnique ID for the descriptor.
39YearCalendar year for the data. Example: 2024.
40ExpiryExpiry date of an Scrip/ Instrument.
41ExpiryDateLast trading date of a futures or options contract.
42FileStatusStatus of the received file (e.g., processed, pending).
43FillingDateDate when the corporate filing was submitted.
44FinInstrmActlXpryDtActual expiry date of the financial instrument.
45FinInstrmIdUnique identifier for the financial instrument.
46FinInstrmNmName of the financial instrument.
47FinInstrmTpType of financial instrument (e.g., FUTSTK).
48FromStart date of event.
49GrossDateDate related to gross settlements.
50HeadLineHeadline of the event.
51HighHigh Price
52HighPriceHighest price recorded for the Scrip/ Instrument.
53IndexCodeUnique identifier for a stock market index.
54IndexNameName of the stock market index.
55IndustryNameIndustry classification of the company.
56InstrumentIdentifierSymbol Name of the financial instrument.
57InstrumentNameName of the financial instrument.
58ISINInternational Securities Identification Number.
59IsLoserIndicates whether the stock is a top loser for the day.
60IssuesTradedNumber of securities traded in the session.
61KeyA unique identifier or reference key for data entries.
62LastDayThe previous trading session's date.
63LastPriceThe latest traded price of the security.
64ListedStatusIndicates whether the security is currently listed on the exchange.
65LowThe lowest price reached during the session.
66LowPriceAnother reference for the session's lowest price.
67LTPThe most recent traded price of the stock.
68LtqThe quantity traded in the last transaction.
69MarketCapTotal market value of a company's outstanding shares.
70MeetingDateThe scheduled date for a corporate meeting.
71MeetingTypeSpecifies the type of meeting (AGM, EGM, etc.).
72ModifyDateThe date when the record was last updated.
73MonthAgoReference date one month before the current date.
74NatureOfReportDescribes the type of corporate report (e.g., financial, governance).
75NdEndDateEnd date of a specific corporate event or period.
76NdStartDateStart date of a specific corporate event or period.
77NewBrdLotQtyThe revised board lot quantity for trading.
78NewsBodyDetailed content of a corporate news report.
79NewsSubjectHeadline or title summarizing the corporate news.
80NoofsharesheldwithNBF
Cascollateralagainst
lending_NonPromotershares
Number of non-promoter shares held as collateral with NBFCs for lending purposes.
81NoofsharesheldwithNBF
Cascollateralagainst
lending_Promotershares
Number of promoter
shares held as collateral with
NBFCs for lending purposes.
82Noofsharespledgedin
thedepositorysystem_
DNoofsharespledged
Total number of shares pledged
in the depository system.
83Noofsharespledgedinthedepository
system_ETotalnoofdematshares
Total number of dematerialized
(demat) shares in the
depository system.
84Noofsharespledgedinthe
depositorysystem_FPerDE
Percentage of pledged shares relative to total demat shares.
85Noofsharespledgedinthe
depositorysystem_ValuesPromoter
Value of pledged shares belonging
to promoters in monetary terms.
86OIOpen Interest, the total number of outstanding derivative contracts.
87OiChngChange in Open Interest compared to the previous value.
88OiQtyQuantity of open interest.
89OpeningThe opening price of a stock or security.
90OpenPriceThe initial price at which a security is traded when the market opens.
91OptionTypeSpecifies the type of option contract (Call/Put).
92PaymentDateThe date when a payment is made or due.
93PercentageFluctationPercentage change in price over a given period.
94PerChangePercentage change in value compared to the previous period.
95PrevCloseThe last recorded closing price of the security.
96PrevCloseChangePctPercentage change from the previous close.
97PrevCloseChangePtsPoints change from the previous close.
98PrevClosePriceClosing price of the previous trading session.
99PreviousClosingAnother term for the last closing price.
100PriceThe current price of the security.
101ProductIdentifies the financial product or instrument.
102ProductIdUnique identifier for a specific product.
103ProductTypeSpecifies the category of the product.
104PromoterSharesEncumberedas
oflastquarter_NoofShares
Number of encumbered promoter shares as of the last quarter.
105PromoterSharesEncumberedas
oflastquarter_Perofpromotershares
Percentage of promoter shares that are encumbered.
106PromoterSharesEncumberedas
oflastquarter_Peroftotalshares
Percentage of total shares that are encumbered by promoters.
107PromoterSharesEncumberedas
oflastquarter_Values
Value of encumbered promoter shares.
108ProvXdateProvisional expiry date for contracts.
109PurposeCodeCode representing the purpose of a transaction.
110QtyQuantity of traded or held shares.
111QtyPctPercentage representation of the traded or held quantity.
112QuantityTotal number of units involved in a trade.
113RatioAmountThe ratio value in a corporate action like bonus or rights issue.
114ReceivedAtTimestamp indicating when data was received.
115ReferenceSrnoSerial number for reference purposes.
116ResultPeriodThe financial period for which results are declared.
117ResultsDateDate on which financial results are announced.
118ResultsTypeType of financial result (e.g., quarterly, annual).
119SavedAtTimestamp when the record was saved.
120ScripCodeUnique code identifying a stock/security.
121ScripFaceValueThe nominal value of a share as per company records.
122ScripGroupCategory or group classification of the scrip.
123ScripIdUnique identifier for a scrip.
124ScripNameName of the stock/security.
125ScripsNoNumber of scrips in a transaction or record.
126SctySrsSecurity series code.
127SeriesCodeCode for identifying the series of a security.
128SeriesIdUnique identifier for a series.
129SettPriceSettlement price for the security.
130SgmtSegment of the market in which the security trades.
131SharesNoNumber of shares.
132SharesVolVolume of shares traded.
133SrcSource of data or transaction.
134SsnIdSession identifier.
135StrikePriceThe agreed-upon price in an options contract.
136SttlmPricSettlement price for derivatives.
137SymbolTrading symbol for the security.
138ToRepresents the upper value in a range or transaction.
139TotalIssuedSharesTotal number of shares issued by a company.
140TotalPromoterHoldingPerPercentage of shares held by promoters.
141TotalPromoterHoldingSharesTotal number of shares held by promoters.
142TotalPublicHoldingTotal number of shares held by the public.
143TotalTradesNoTotal number of trades executed.
144TotTurnoverPctPercentage change in total turnover.
145TradDtTrade date.
146TradeDateDate on which a trade was executed.
147TradedQtyQuantity of shares traded.
148TradesNoNumber of trades executed.
149TtlTrfValTotal transfer value of shares.
150TTQTotal traded quantity.
151TurnoverTotal transaction value in monetary terms.
152TurnoverRsTotal turnover in Indian Rupees.
153TurnoverRsCrTotal turnover in crores.
154UnchangedNumber of securities with no price change.
155UnderlyingPriceThe price of the underlying asset in a derivative.
156UnitIdUnique identifier for a trading unit.
157ValueTotal value of traded securities.
158ValueRsCrTotal value of securities in crores.
159VolSharesVolume of shares traded.
160WeekAgoData value recorded a week ago.
161YearAgoData value recorded a year ago.
162DateDate of the record or transaction.
163DealDateDate on which a deal or agreement was made.
164GrossDateDate representing the gross transaction value.
165IdentifierUnique reference code or ID.
166IndexNameName of the stock market index.
167InstrumentThe financial instrument involved in trading. Example: RELIANCE.
168InstrumentNameName of the financial instrument. Example: RELIANCE.
169LabelDescriptive label for a security or record.
170ScripGroupCodeCode representing the scrip’s group category.
171TradeHighlightsKey highlights or observations from trading activity.
172Disclosuresmadebypromoters
ontheirencumberedsharesunderR
egulation31ofSASTsincethe
lastquarter
Disclosures made by company promoters about their pledged shares under Regulation 31 of SEBI's SAST regulations since the previous quarter.
173AllotedFromSource or category from which the sectoral data is assigned.
174MeiCodeCode representing the Macro Economic Indicator linked to the company.
175MacroEconomicIndicatorA broader economic category under which the company falls.
176SectCodeUnique identifier for the sector.
177SectorThe primary business sector of the company.
178IndustryCodeUnique identifier for the industry.
179IndustryThe industry classification within the sector.
180BasicIndustryCodeUnique code for the basic industry group.
181BasicIndustryThe most granular industry classification for the company.
182AddressOfficial registered address of the company.
183ContactDetailsPhone or other contact numbers of the company.
184EmailOfficial email address of the company.
185CompanySecretaryNameName of the company secretary responsible for compliance.
186DesignationOfficial designation of the company secretary.
187RtaNameName of the Registrar and Transfer Agent handling share registry services.
188RtaEmailOfficial email address of the Registrar and Transfer Agent.
189RtaContactContact number of the Registrar and Transfer Agent.
190RnInternal or reference number associated with the data record.
Modified at 2025-05-09 08:39:50
Previous
GetInstruments
Next
Diagnostic API Responses
Built with