Skip to main content

Market_Connect

Index List

The Index List APIs provide you with the ability to discover all index names and retrieve the corresponding scrip code necessary for obtaining the index value.

Method: POST​

https://connect-go.thefirstock.tech/api/V5/indexList

Request details

API Parameters
Parameter Description Example
userId
string		 Identifier for the user upon login, unique to each user in the system. AA0013
exchange
string		 Exchange on which the order is placed (e.g., NSE, BSE, NFO, BFO) BSE
jKey
string		 Authentication token obtained from the login API d4180daa72ea70885ab0d

Libraries and SDKs

Tabbed Interface 
curl --location 'https://connect-go.thefirstock.tech/api/V5/indexList' \
--header 'Content-Type: application/json' \
--data '{
  "userId": "NP2997",
  "jKey": "211b250616fe25067a3b71b24451d1dfd389faabe338770ada62d81fd20b4bda"
}'

Success response details

API Parameters
Parameter Description Example
status
String		 Status of the API request, indicating
success or failure		 success
values
String		 Array of Basket, Criteria pair ["idxname":"HangSeng BeES-NAV",
"token": "26016", "token": "26000"]
data.requestTime
String		 Time of the successful API response 16:38:31 17-01-2023

Basket, Criteria pair Object

API Parameters
Parameter Description Example
value.idxname
String		 Index Name HangSeng BeES-NAV
value.token
String		 Index token used to subscribe 26016 
{
    "status": "success",
    "message": "All indexes",
    "data": [
        {
            "exch": "NSE",
            "token": "26000",
            "trading_symb": "NIFTY",
            "symbol": "NIFTY",
            "reps_name": "NIFTY 50"
        },
        {
            "exch": "NSE",
            "token": "26013",
            "trading_symb": "NIFTYNXT50",
            "symbol": "NIFTYNXT50",
            "reps_name": "NIFTY NEXT 50"
        },
        {
            "exch": "NSE",
            "token": "26009",
            "trading_symb": "BANKNIFTY",
            "symbol": "BANKNIFTY",
            "reps_name": "NIFTY BANK"
        },
        {
            "exch": "NSE",
            "token": "26037",
            "trading_symb": "FINNIFTY",
            "symbol": "FINNIFTY",
            "reps_name": "NIFTY FIN"
        },
        {
            "exch": "NSE",
            "token": "26074",
            "trading_symb": "MIDCPNIFTY",
            "symbol": "MIDCPNIFTY",
            "reps_name": "NIFTY MID CAP"
        },
        {
            "exch": "BSE",
            "token": "1",
            "trading_symb": "SENSEX",
            "symbol": "SENSEX",
            "reps_name": "SENSEX"
        },
        {
            "exch": "BSE",
            "token": "12",
            "trading_symb": "BANKEX",
            "symbol": "BANKEX",
            "reps_name": "BANKEX"
        },
        {
            "exch": "BSE",
            "token": "47",
            "trading_symb": "SENSEX50",
            "symbol": "SENSEX50",
            "reps_name": "SENSEX 50"
        }
    ]
}

Failure response details

API Error Parameters
Parameter Description Example
status
String		 The status of the response indicating a failure
in the API operation		 failed
code
String		 The HTTP status code associated
with the error condition		 401
name
String		 Describes the type or category of the error
encountered		 INVALID_USERID
error.field
String		 Specifies the field in the request that caused the
error		 userid
error.message
String		 Provides a detailed message describing the error userid parameter is invalid 
{
  "status": "failed",
  "code": "401",
  "name": "INVALID_USERID",
  "error": {
      "field": "userid",
      "message": "userid parameter is invalid"
  }
}