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_range | string | No | Date range filter in format YYYY-MM-DD:YYYY-MM-DD. When provided, filters transactions within the specified date range (inclusive). | 2025-05-01:2025-05-08 |
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",
"message": "",
"data": [
{
"date": "2025-05-08T10:30:00+05:00",
"settlement_date": "2025-05-10T16:00:00+05:00",
"type": 1,
"sector_code": "COMMERCIAL_BANKS",
"member_from": "ARIF",
"member_from_name": "Arif Habib Limited",
"member_to": "FIMM",
"member_to_name": "First Imperial Securities",
"symbol": "UBL",
"name": "United Bank Limited",
"volume": 50000,
"rate": 275.50,
"value": 13775000.00
},
{
"date": "2025-05-07T14:15:00+05:00",
"settlement_date": "2025-05-09T16:00:00+05:00",
"type": 2,
"sector_code": "POWER_GENERATION",
"member_from": "KPS",
"member_from_name": "Khanani & Parwani Securities",
"member_to": "BNIB",
"member_to_name": "Bnib Securities",
"symbol": "HUBC",
"name": "Hub Power Company Limited",
"volume": 100000,
"rate": 65.25,
"value": 6525000.00
},
{
"date": "2025-05-06T11:45:00+05:00",
"settlement_date": "2025-05-08T16:00:00+05:00",
"type": 1,
"sector_code": "TECHNOLOGY",
"member_from": "JSBRY",
"member_from_name": "JS Bank Brokerage",
"member_to": "PROL",
"member_to_name": "Proliance Securities",
"symbol": "TECH",
"name": "Technology Company Limited",
"volume": 25000,
"rate": 450.00,
"value": 11250000.00
}
],
"offset": 0,
"count": 3,
"total": 150
}
Response Fields
| Field | Type | Description |
|---|---|---|
date | string (ISO 8601) | Transaction date and time |
settlement_date | string (ISO 8601) | 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" \
-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