Skip to main content

INDEX DETAILS

This API returns the list of market indices available in the system, including default indices, exchange segment information, and index token details.

🔗 Path Parameters

ParameterTypeRequiredDescriptionExample
tenantidstringYesUnique id provided for the tenant by SIPL"tenant001"

🔍 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

FieldTypeDescription
statusbooleanStatus of API call
resultarrayList of market indices

📦 Index Fields

FieldTypeDescriptionExample
nMarketSegmentIdintegerMarket Segment ID1
nTokenintegerToken number received in the Exchange Scrip Master999920000
sIndexstringIndex symbol"NIFTY 50"
sIndexDescstringIndex description"NIFTY 50 Index"
nIsDefaultIndexintegerIndicates whether the index is marked as default1
cIsIndexstringIndicates whether the instrument is an index"Y"