Margin Financing System (MFS)

Retrieve margin financing data including open positions, current takeup volumes, and free float financing metrics.

GET/3.0/margin-financing

Description

This endpoint returns Margin Financing System (MFS) data, which includes open position volumes and values, current takeup volumes and values, markup-weighted averages, free float information, and the percentage of free float that has been financed through margin financing for eligible securities.

Request

Authentication

• Type: Bearer Token
• Required: Yes

Parameters

Name	Type	Required	Description	Example
from	string	Yes	Start date for filtering data (format: YYYY-MM-DD). Required parameter.	2022-07-20
to	string	Yes	End date for filtering data (format: YYYY-MM-DD). Required parameter.	2022-10-13
symbol	string	No	Stock symbol filter to get data for a specific security.	UBL

Response

Success Response (200)

{
  "status": "ok",
  "message": "",
  "data": [
    {
      "date": "2022-10-13T16:00:00+05:00",
      "symbol": "UBL",
      "name": "United Bank Limited",
      "oprvol": 1000000,
      "oprval": 275000000.00,
      "crvol": 150000,
      "crval": 41250000.00,
      "ctvol": 50000,
      "ctval": 13750000.00,
      "mwa": 275.50,
      "nopvol": 1000000,
      "nopval": 275000000.00,
      "noppct": 2.50,
      "ff": 15000000,
      "pctfff": 18.33
    },
    {
      "date": "2022-10-13T16:00:00+05:00",
      "symbol": "MCB",
      "name": "MCB Bank Limited",
      "oprvol": 500000,
      "oprval": 130000000.00,
      "crvol": 75000,
      "crval": 19500000.00,
      "ctvol": 25000,
      "ctval": 6500000.00,
      "mwa": 260.00,
      "nopvol": 500000,
      "nopval": 130000000.00,
      "noppct": 1.75,
      "ff": 8000000,
      "pctfff": 12.50
    },
    {
      "date": "2022-10-13T16:00:00+05:00",
      "symbol": "HUBC",
      "name": "Hub Power Company Limited",
      "oprvol": 2000000,
      "oprval": 130000000.00,
      "crvol": 300000,
      "crval": 19500000.00,
      "ctvol": 100000,
      "ctval": 6500000.00,
      "mwa": 65.00,
      "nopvol": 2000000,
      "nopval": 130000000.00,
      "noppct": 3.25,
      "ff": 25000000,
      "pctfff": 22.75
    }
  ]
}

Response Fields

Field	Type	Description
date	string (ISO 8601)	Date and time of the margin financing record
symbol	string	Stock symbol of the security
name	string	Full name of the company/security
oprvol	float	Open position release volume
oprval	float	Open position release value
crvol	float	Current release volume
crval	float	Current release value
ctvol	float	Current takeup volume
ctval	float	Current takeup value
mwa	float	Markup weighted average price
nopvol	float	Net open position volume
nopval	float	Net open position value
noppct	float	Net open position percentage
ff	float	Free float volume
pctfff	float	Percentage of free float financed

Error Responses

For detailed Common Error responses, see the Error Handling.

No Date Range Provided

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

Examples

Get MFS Data for Specific Symbol

curl -X GET "https://csapis.com/3.0/margin-financing?from=2022-07-20&to=2022-10-13&symbol=UBL" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Use Cases

• Margin Financing Tracking: Monitor margin financing volumes and values
• Free Float Analysis: Analyze free float and margin financing percentages
• Risk Assessment: Track net open positions and weighted averages
• Financing Trends: Analyze margin financing trends over time periods
• Regulatory Compliance: Generate margin financing reports for compliance