Off Market Transactions

Retrieve off-market transaction data including member-to-member and client-to-client transactions.

GET/3.0/off-market-transactions

Description

This endpoint returns off-market transaction data, which includes transactions conducted outside the main exchange between members and their clients. The data includes transaction types (member-to-member or client-to-client), settlement dates, and transaction details.

Request

Authentication

• Type: Bearer Token
• Required: Yes

Parameters

Name	Type	Required	Description	Example
date	string	Yes	Date filter in format YYYY-MM-DD.	2025-05-01
type	integer	No	Transaction type filter	1
offset	integer	No	Pagination offset for results. Defaults to 0.	0
count	integer	No	Number of records to return per page. Defaults to 50.	25

Response

Success Response (200)

{
    "status": "ok",
    "offset": 0,
    "count": 50,
    "total": 59,
    "data": [
        {
            "date": "2024-07-01",
            "settlement_date": "2024-07-03",
            "type": 1,
            "sector_code": "0803",
            "member_from": "022",
            "member_from_name": "BMA Capital Management Limited",
            "member_to": "016",
            "member_to_name": "DJM Securities Limited",
            "symbol": "FCL",
            "name": "Fast Cables Ltd.",
            "volume": 27516,
            "rate": 24.14,
            "value": 664236
        },
        {
            "date": "2024-07-01",
            "settlement_date": "2024-07-02",
            "type": 1,
            "sector_code": "0824",
            "member_from": "037",
            "member_from_name": "HH Misbah Securities (Private) Limited",
            "member_to": "036",
            "member_to_name": "Time Securities (Pvt.) Limited",
            "symbol": "KEL",
            "name": "K-Electric Ltd.",
            "volume": 5000,
            "rate": 4.7,
            "value": 23500
        }
    ]
}

Response Fields

Field	Type	Description
date	string (YYYY-MM-DD)	Transaction date and time
settlement_date	string (YYYY-MM-DD)	Settlement date and time for the transaction
type	integer	Transaction type: 1 for member-to-member, 2 for client-to-client
sector_code	string	Sector classification code of the security
member_from	string	Code of the member initiating the transaction
member_from_name	string	Name of the member initiating the transaction
member_to	string	Code of the member receiving the transaction
member_to_name	string	Name of the member receiving the transaction
symbol	string	Stock symbol of the security
name	string	Full name of the company/security
volume	integer	Number of shares in the transaction
rate	float	Price per share (may be null for certain transaction types)
value	float	Total transaction value (volume × rate)

Error Responses

For detailed Common Error responses, see the Error Handling.

Examples

Get All Off-Market Transactions

curl -X GET "https://csapis.com/3.0/off-market-transactions?date=2025-05-01" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Use Cases

• Off-Market Trade Monitoring: Track off-market transactions between members and clients
• Settlement Analysis: Analyze settlement dates and transaction values
• Member Activity: Monitor transaction volumes between specific members
• Transaction Reporting: Generate comprehensive off-market transaction reports
• Data Analytics: Analyze off-market trading patterns and trends