Skip to content
Longport WhaleLongport Whale
Symbol Information

Clearing - Instrument Information

Query the clearing security master, used during day-end settlement to maintain and reconcile the clearing attributes of each security.

Request parameters

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

Business notes

The data comes from the clearing security master; each record represents one security within the clearing scope.

Each record carries clearing attributes such as ledger date, security code, full instrument name, internal security code (counter_id), status, closing price, stamp-duty exemption flag, whether a holding exists, and whether a pending approval ticket exists.

The closing price is used for clearing valuation and is precision-sensitive; changes to an instrument's attributes typically go through an approval workflow, and has_pending_ticket indicates whether the instrument currently has an outstanding approval ticket.

Returns

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

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.close_price_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
ledger_datestringrequired

Filters results by Ledger Date.

codestring

Filters results by Counter ID.

namestring

Filters results by Fallback Name.

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.

statusstring

Filters results by Status.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

Allowed values: 0 Active, 1 Suspended, 2 Delisted, 3 Prelist, 8 Unknown, 9 Others, normal Active

Values
0
Active
1
Suspended
2
Delisted
3
Prelist
8
Unknown
9
Others
normal
Active
close_pricestring

Filters results by Close Price.

stamp_duty_markstring

Filters results by Stamp Duty Exemption.

Allowed values: 1 Subject to stamp duty, 0 Exempt from stamp duty

Values
1
Subject to stamp duty
0
Exempt from stamp duty
has_holdingstring

Filters results by Existing Position.

has_pending_ticketstring

Filters results by Pending Approvals.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Clearing - Instrument Information 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
idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

ledger_datestring

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

codestring

Returned value: Counter ID.

counter_idstring

Returned value: Counter ID.

marketstring

Returned value: Market.

currencystring

Returned value: Currency.

namestring

Returned value: Fallback Name.

name_enstring

Returned value: Name(EN).

name_cnstring

Returned value: Name(CN).

name_hkstring

Returned value: Name(TC).

isinstring

Returned value: ISIN.

ipo_datestring

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

ipo_pricestring

Returned value: IPO Price.

statusstring

Returned value: State.

status_valstring

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

suspend_datestring

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

lot_sizestring

Returned value: Lot size.

stamp_duty_exemptionstring

Returned value: Stamp Duty Exemption.

stamp_duty_exemption_valstring

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

close_pricestring

Returned value: Closing Price.

pre_close_pricestring

Returned value: Previous Closing Price.

settle_pricestring

Returned value: Stock Lending Settlement Price.

close_price_suspendstring

Returned value: Closing Price For Statement(For suspended stock).

turnoverstring

Returned value: Turnover.

has_holdingstring

Returned value: Indicates whether existing position.

updated_atstring

Returned value: Updated At. The date or time format follows the value returned by the API.

operatorstring

Returned value: Operator.

operator_valstring

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

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

Whale Docs