Skip to content
Longport WhaleLongport Whale
Restricted Stock

Restricted Stock

Query securities transfer-in restriction settings, i.e. the list of stocks restricted from being transferred into the platform.

Request parameters

  • Combine business filters through filters (see the filter-field notes below for the available fields), and use page, page_size, and orderBy for pagination and sorting.

Business notes

  • Each record corresponds to one restricted stock, controlling which instruments are disallowed or limited from transferring in via rollover.
  • It records the restriction ID, the associated stock, and the last update time.
  • Filter by restriction ID, stock, or update time to help operations maintain the transfer-in eligibility scope.

Returns

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

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

Authorization

AuthorizationstringheaderRequired

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

Permission

finance.rollover_stocks_limit

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

Request body application/json

filtersobject

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

Child attributes
idstring

Restricted Stock ID. Filters results by Restricted Stock ID.

counter_idstring

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

updated_atobject

Updated At. Filters results by Updated At.

Child attributes
gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Restricted Stock records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List. Returned value: Records matching the query conditions.

Child attributes
idstring

Restricted Stock ID. Returned value: Unique identifier of the current record.

counter_idstring

Stock. Returned value: Stock.

admin_namestring

Processed By. Returned value: Processed By.

updated_atstring

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

totalintegerrequired

Total. 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