Skip to main content

GET SCRIP

This API returns the details of a specific scrip across different exchanges and market segments based on the instrument type, symbol, and expiry date.

🔗 Path Parameters

ParameterTypeRequiredDescriptionExample
tenantidstringYesUnique id provided for the tenant by SIPL"tenant001"
instrumentNamestringYesInstrument type"EQUITIES"
expiryDatestringYesExpiry date of the contract. For cash market instruments, pass null."null"
symbolstringYesTrading symbol"ONGC"

🔍 Query Parameters

ParameterTypeRequiredDescriptionExample
userIdstringYesUser ID (UCC)"{{user_id}}"

🔑 Header Parameters

HeaderTypeDescriptionExample
Content-TypestringRequest payload formatapplication/json
AuthorizationstringAccess token for authenticated requests{{access_token}}
x-api-keystringAPI key used to authorize request{{x-api-key}}

🟢 Success Response - 200 OK

Content-Type: application/json

The API returns matching scrip records across exchanges and market segments.

📦 Response Fields

FieldTypeDescription
expstringExpiry date of the contract
sSymbolstringSymbol code provided in the exchange scrip master
sOptionTypestringOption type (CE, PE)
nStrikePricestringStrike price in paise
nExpiryDateintegerExpiry date in numeric format
nExpiryDate1stringExpiry date in DDMMYYYY format
nExpiryDate2stringExpiry date in MMMDD format
nAssetTokenintegerAsset token of the scrip
nInstrumentTypeintegerInstrument type identifier
nMarketSegmentIdintegerMarket segment ID
nNormal_MarketAllowedintegerIndicates whether normal market trading is allowed
nPriceBdAttributeintegerPrice board attribute
nRegularLotintegerMarket lot size
nTokenintegerExchange token number
sDerivitiveDescstringDerivative contract description
sInstrumentNamestringInstrument name (EQUITIES, FUTSTK, OPTSTK, FUTIDX, OPTIDX, etc.)
sSecurityDescstringSecurity description/name
sSeriesstringSeries code (EQ, A, B, T, Z, etc.)
nSPOSintegerSPOS value
nPOSintegerPOS value
DecimalLocatorintegerDecimal place locator for price values
nNRILimitintegerNRI trading limit
nFIILimitintegerFII trading limit
nPriceTickintegerMinimum tick size
nSpreadintegerSpread value
sISINCodestringISIN code
sGlobalNormalFlagstringGlobal normal flag
nStrikePrice1stringStrike price in rupees
nFIIFlagintegerFII flag
nMarginTypeIndicatorintegerMargin type indicator
nAVMBuyMarginintegerAVM buy margin
nAVMSellMarginintegerAVM sell margin
nPriceNumintegerPrice numerator
nPriceDenintegerPrice denominator
nIsAssetintegerAsset flag
nIntrinsicValueintegerIntrinsic value
nIsIndexintegerIndex flag
nFOExistsintegerIndicates whether F&O contracts exist
nCoCodeintegerCompany code
nSectorCodeintegerSector code
nOtherExchTokenintegerOther exchange token
sSectorstringSector name
nExpiryMonthintegerExpiry month
nIssueMaturityDateintegerIssue maturity date
nIsSIPintegerSIP eligibility flag
idstringUnique identifier
sExchangestringExchange segment
sSearchTextstringSearch keywords associated with the scrip
sSymbolnewstringNew symbol code from exchange master