Skip to main content

Single Index Overview

Retrieve detailed information for a single market index including current value, constituent stocks, valuation metrics, and performance data.

GET/3.0/market/index

Description

This endpoint provides comprehensive data for a specific market index including current price, trading volume, market capitalization, P/E ratio, dividend yield, and constituent stock information. It's ideal for focused analysis of a particular index.

Request

Authentication

  • Type: Bearer Token
  • Required: Yes

Parameters

NameTypeRequiredDescriptionExample
codestringYesIndex code/symbolKSE100

Response

Success Response (200)

{
"status": "ok",
"message": "",
"data": {
"type": 1,
"date": "2025-10-07 10:42:31",
"name": "BKTi",
"code": "BKTI",
"open": 47318.8643,
"high": 47549.8072,
"low": 46822.6112,
"close": 46983.8899,
"volume": 58410223,
"value": 3129090491.06,
"ldci": 47083.9094,
"ldcv": 163582679,
"change": -100.02,
"change_percent": -0.0021,
"high52": 47975.5523,
"low52": 21003.0733,
"total_scrips": 8,
"pe_ratio": 6.34,
"dividend_yield": 0.0793,
"market_cap": 1279702926640.9
}
}

Response Fields

FieldTypeDescription
typeintegerIndex type (1 - Exchange, 2 - Non-Tradeable)
datestringData timestamp (YYYY-MM-DD HH:MM:SS)
namestringIndex name
codestringIndex code/symbol
opennumberOpening value
highnumberHighest value of the day
lownumberLowest value of the day
closenumberClosing value
volumenumberTotal volume traded
valuenumberTotal value traded (in PKR)
ldcinumberLast day closing index
ldcvnumberLast day closing volume
changenumberPoints change
change_percentnumberPercentage change
high52number52-week high
low52number52-week low
total_scripsintegerNumber of constituent scrips
pe_rationumberPrice-to-Earnings ratio of the index
dividend_yieldnumberDividend yield of the index (%)
market_capnumberTotal market capitalization (in PKR)

Constituent Fields

FieldTypeDescription
symbolstringStock symbol
weightnumberWeight percentage in the index
pricenumberCurrent stock price
changenumberAbsolute price change
change_percentnumberPercentage price change

Error Responses

For detailed Common Error responses, see the Error Handling.

Missing Parameters (200)

{
"status": "error",
"message": "index_code_required"
}

Not Found (200)

{
"status": "error",
"message": "not_found"
}

Examples

Get Single Index Overview

curl -X GET "https://csapis.com/3.0/market/index?code=KSE100" \
-H "Authorization: Bearer YOUR_API_TOKEN"

Use Cases

  • Index Analysis: Get detailed information about a specific index
  • Constituent Analysis: Review which stocks make up an index and their weights
  • Performance Tracking: Monitor index performance and movements
  • Portfolio Benchmarking: Compare portfolio against a specific index benchmark
  • Sector Exposure: Understand exposure to specific sectors through indices
  • Risk Analysis: Analyze index composition and diversification