• 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

    Authentication, Request & Response


    Request Format#

    RESTful APIs (HTTP GET) are used for sending the request where inputs are sent as part of URL in the form of query parameters.

    Response Format#

    Response is received in Json, Xml, Csv or CsvContent format. This is user-configurable; value of "format" parameter sent in request decides the format of the response.
    While data is sent in Csv as part of response, a file containing Csv values is sent when format=CsvContent.
    Sometimes, API can return diagnostic response in plain/text format instead of actual data. When this happens, user will need to send the request again - till they receive actual data. A list of available diagnostic responses can be found here

    Authentication#

    To receive the response, user will need to send valid "AccessKey" parameter with each request. User can get the accessKey for their use by contacting our Sales Team and making the payment for the data subscription.
    Modified at 2025-04-11 12:13:17
    Previous
    Fundamental Data API - Introduction
    Next
    Code Samples & API Trial
    Built with