Skip to main content

Futures Open Interest - CSF

Retrieve open interest data for futures contracts including contract volumes, shares, and free float information.

GET/3.0/futures/open-interest/csf

Description

This endpoint returns open interest data for futures contracts, including contract counts, underlying shares, total value, and free float metrics. Data is filtered by date range and provides insights into derivative market participation and activity levels.

Request

Authentication

  • Type: Bearer Token
  • Required: Yes

Parameters

NameTypeRequiredDescriptionExample
fromstringYesStart date for filtering data (format: YYYY-MM-DD). Required parameter.2023-01-05
tostringYesEnd date for filtering data (format: YYYY-MM-DD). Required parameter.2023-01-05
symbolstringNoStock symbol filter to get futures open interest for specific underlying.UBL

Response

Success Response (200)

{
"status": "ok",
"message": "",
"data": [
{
"date": "2023-01-05",
"symbol": "UBL",
"cat": "A",
"contracts": 500000,
"shares": 50000000,
"value": 13750000000,
"free_float": 7500000,
"free_float_pct": 15.00
},
{
"date": "2023-01-05",
"symbol": "MCB",
"cat": "A",
"contracts": 450000,
"shares": 45000000,
"value": 11700000000,
"free_float": 6750000,
"free_float_pct": 15.00
}
]
}

Response Fields

FieldTypeDescription
datestring (ISO 8601)Date of the open interest record
symbolstringStock symbol for the underlying security
catstringCategory of the contract (A, B, etc.)
contractsintegerNumber of open futures contracts
sharesintegerNumber of underlying shares represented
valueintegerTotal value of open positions in PKR
free_floatintegerFree float shares in the underlying security
free_float_pctfloatPercentage of free float in open futures

Error Responses

For detailed Common Error responses, see the Error Handling.

Missing Date Parameters (200)

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

Examples

Get Futures Open Interest for Date Range

curl -X GET "https://csapis.com/3.0/futures/open-interest/csf?from=2023-01-01&to=2023-01-31" \
-H "Authorization: Bearer YOUR_API_TOKEN"

Use Cases

  • Open Interest Tracking: Monitor open interest levels and trends
  • Derivative Market Analysis: Analyze futures market participation
  • Risk Assessment: Evaluate derivative exposure and concentration
  • Market Sentiment: Gauge investor activity through open interest
  • Free Float Analysis: Track free float participation in futures markets