SCRIP SEARCH
This API returns the list of securities (scrips) matching the provided search text across eligible market segments.
It can be used to search for equities, derivatives, commodities, indices, and other instruments.
🔗 Path Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| tenantid | string | Yes | Unique id provided for the tenant by SIPL | "tenant001" |
| searchText | string | Yes | Search text used to find matching scrips | "ACC", "NIFTY APR", "GOLD MCX" |
| mktAllowed | integer | Yes | Market segment filter identifier | 268453979 |
🔍 Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| userId | string | Yes | User ID (UCC) | "{{user_id}}" |
🔑 Header Parameters
| Header | Type | Description | Example |
|---|---|---|---|
| Content-Type | string | Request payload format | application/json |
| Authorization | string | Access token for authenticated requests | {{access_token}} |
| x-api-key | string | API key used to authorize request | {{x-api-key}} |
🟢 Success Response - 200 OK
Content-Type: application/json
The API returns one or more matching scrip records.
📦 Response Fields
| Field | Type | Description |
|---|---|---|
| exp | string | Expiry information |
| sSymbol | string | Symbol code provided in exchange scrip master |
| sOptionType | string | Option type (CE/PE) |
| nStrikePrice | string | Strike price of the contract |
| nExpiryDate | integer | Contract expiry date |
| nExpiryDate1 | string | Expiry date format 1 |
| nExpiryDate2 | string | Expiry date format 2 |
| nAssetToken | integer | Asset token |
| nInstrumentType | integer | Instrument type |
| nMarketSegmentId | integer | Market segment identifier |
| nNormal_MarketAllowed | integer | Normal market allowed flag |
| nPriceBdAttribute | integer | Price board attribute |
| nRegularLot | integer | Market lot size |
| nToken | integer | Exchange token number |
| sDerivitiveDesc | string | Derivative description |
| sInstrumentName | string | Instrument name |
| sSecurityDesc | string | Security description |
| sSeries | string | Series (EQ, A, B, T, Z, etc.) |
| nSPOS | integer | SPOS value |
| nPOS | integer | POS value |
| DecimalLocator | integer | Decimal locator value |
| nNRILimit | integer | NRI limit |
| nFIILimit | integer | FII limit |
| nPriceTick | integer | Tick size |
| nSpread | integer | Spread value |
| sISINCode | string | ISIN code |
| sGlobalNormalFlag | string | Global normal flag |
| nStrikePrice1 | string | Alternate strike price |
| nFIIFlag | integer | FII flag |
| nMarginTypeIndicator | integer | Margin type indicator |
| nAVMBuyMargin | integer | AVM buy margin |
| nAVMSellMargin | integer | AVM sell margin |
| nPriceNum | integer | Price numerator |
| nPriceDen | integer | Price denominator |
| nIsAsset | integer | Indicates whether instrument is an asset |
| nIntrinsicValue | integer | Intrinsic value |
| nIsIndex | integer | Indicates whether instrument is an index |
| nFOExists | integer | Indicates whether F&O contract exists |
| nCoCode | integer | Company code |
| nSectorCode | integer | Sector code |
| nOtherExchToken | integer | Token in another exchange |
| sSector | string | Sector name |
| nExpiryMonth | integer | Expiry month |
| nIssueMaturityDate | integer | Issue maturity date |
| nIsSIP | integer | SIP eligibility flag |
| id | string | Unique document identifier |
| sExchange | string | Exchange |
| sSearchText | string | Search text indexed for lookup |
| sSymbolnew | string | New symbol code |