Institution Contract

Queries the broker contract list — the institution-side settlement contracts managed by broker/custodian in day-end clearing, acting as the counterparty to client contracts.

Request parameters

Combine business filters through filters (see the filter field notes below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Data comes from institution settlement contracts, recording the broker's trades and settlement through upstream broker/custodian channels.

Each record carries the custodian/broker, contract number, data source, ledger date, trade date, cash/stock settlement dates, settlement channel, business type, sub account, market, trade phase, security, currency, direction, trade quantity and amount, accrued interest, and fee.

Records can be filtered by security, date, data source, market, and business type for reconciling and managing institution-side settlement.

Returns

On success, returns the matching records with pagination. See the response definition for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/booking_company_tasks

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

lb_hk_clearing.contract_manage_query

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes

counter_idstring

Filters results by Counter ID. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

trade_ledger_datestring

Filters results by Ledger Date.

trade_datestring

Filters results by Trade Date.

expected_balance_settlement_datestring

Filters results by Expected Settlement Date (Cash).

expected_equity_settlement_datestring

Filters results by Expected Settlement Date (Qty).

company_datasourcestring

Filters results by Data Source.

Allowed values: 0 Normal Contract, 1 Broker Contract Overshooting, 2 Broker Contract Adjustment

Values

0: Normal Contract
1: Broker Contract Overshooting
2: Broker Contract Adjustment

marketstring

Filters results by Market.

Values are dynamic. Call GET /v1/datasets/refs/clearing_config_markets to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

biz_typestring

Filters results by Biz Type.

Values are dynamic. Call GET /v1/datasets/refs/billing_agent_business_type to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Institution Contract records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Returned value: List of list.

Child attributes

custodian_idstring

Returned value: Custodian.

custodian_id_valstring

Raw value of custodian_id. The custodian_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

nostring

Returned value: No.

company_datasourcestring

Returned value: Source.

company_datasource_valstring

Raw value of company_datasource. The company_datasource field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

trade_ledger_datestring

Returned value: Ledger Date. The date or time format follows the value returned by the API.

trade_datestring

Returned value: Trade Date. The date or time format follows the value returned by the API.

expected_balance_settlement_datestring

Returned value: Expected Settlement Date (Cash). The date or time format follows the value returned by the API.

expected_equity_settlement_datestring

Returned value: Expected Settlement Date (Qty). The date or time format follows the value returned by the API.

settlement_channelstring

Returned value: Settlement Channel.

settlement_channel_valstring

Raw value of settlement_channel. The settlement_channel field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

biz_typestring

Returned value: Biz Type.

biz_type_valstring

Raw value of biz_type. The biz_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

settlement_accountstring

Returned value: Sub Account.

marketstring

Returned value: Market.

market_valstring

Raw value of market. The market field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

stagestring

Returned value: Trade Phase.

stage_valstring

Raw value of stage. The stage field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

counter_idstring

Returned value: Counter ID.

currencystring

Returned value: Currency.

directionstring

Returned value: Trade Direction.

direction_valstring

Raw value of direction. The direction field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

trade_quantitystring

Returned value: Trade Quantity.

trade_amountstring

Returned value: Trade Amount.

ibond_amountstring

Returned value: Interest.

fee_amountstring

Returned value: Fee.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

HTTP 400Bad request. Check the business error code in code and the error details in message.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

Request

curl --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/booking_company_tasks' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "custodian_id": "CCASS",
        "custodian_id_val": "1",
        "no": "OSCC20260713161023",
        "company_datasource": "Normal Contract",
        "company_datasource_val": "0",
        "trade_ledger_date": "2026-07-13",
        "trade_date": "2026-07-13",
        "expected_balance_settlement_date": "2026-07-15",
        "expected_equity_settlement_date": "2026-07-15",
        "settlement_channel": "settlement_ex_hk & CCASS",
        "settlement_channel_val": "5",
        "biz_type": "Broker Fee- Stock Trade",
        "biz_type_val": "11",
        "settlement_account": "U90118610",
        "market": "HK",
        "market_val": "HK",
        "stage": "Normal",
        "stage_val": "1",
        "counter_id": "ST/HK/700",
        "currency": "HKD",
        "direction": "Sell",
        "direction_val": "2",
        "trade_quantity": "1,000.00",
        "trade_amount": "466,600.00",
        "ibond_amount": "0.00",
        "fee_amount": "173,473.12"
      }
    ],
    "total": 23385
  }
}