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

Name	Type	Required	Description	Example
date_from	string	Yes	Start date for filtering data (format: YYYY-MM-DD). Required parameter.	2023-01-05
date_to	string	Yes	End date for filtering data (format: YYYY-MM-DD). Required parameter.	2023-01-05
symbol	string	No	Stock 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

Field	Type	Description
date	string (ISO 8601)	Date of the open interest record
symbol	string	Stock symbol for the underlying security
cat	string	Category of the contract (A, B, etc.)
contracts	integer	Number of open futures contracts
shares	integer	Number of underlying shares represented
value	integer	Total value of open positions in PKR
free_float	integer	Free float shares in the underlying security
free_float_pct	float	Percentage 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_from` or `date_to` provided"
}

Examples

Get Futures Open Interest for Date Range

curl -X GET "https://csapis.com/3.0/futures/open-interest/csf?date_from=2023-01-01&date_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