Skip to content
Stock Transfer

Internal Stock Transfer Query (support Approval)

Query securities position-transfer flows between accounts, used by operations and risk teams to track the movement of securities positions between accounts and their approval progress.

Request parameters

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

Business notes

  • The data comes from inter-account securities position-transfer records and is joined with the risk-approval ticket.

  • Each record carries the transfer number, the from and to parties with their account types, customer channel, security code, custodian and sub-position, transfer quantity, transfer type, source (manual or system), remark, operator, execution result and status, plus the approval ticket number, creator, approver, review status, and the created/updated times.

  • Use it to verify which security, quantity, and direction an inter-account position transfer involves, its origin, and whether it was approved and executed successfully.

Returns

On success, returns the matched record list with pagination. See the response definition for column meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

portfolio.omnibus_transfer_equity_holding_change_query

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
from_aaidstring

From Account. Filters results by From Account.

to_aaidstring

To Account. Filters results by To Account.

transfer_nostring

Transfer ID. Filters results by Transfer ID.

transfer_typestring

Transfer Type. Filters results by Transfer Type.

Allowed values: 1 TransferToSub, 0 TransferToMain

Values
1
TransferToSub
0
TransferToMain
counter_idstring

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

ticket_statusstring

Approval Status. Filters results by Approval Status.

Allowed values: WAIT Waiting for Approval, WAIT_APPROVE Under Approval, APPROVED, REJECTED, CLOSE

Values
WAIT
Waiting for Approval
WAIT_APPROVE
Under Approval
APPROVED
Approved
REJECTED
Rejected
CLOSE
Close
pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

Responses

HTTP 200On success, returns paginated Internal Stock Transfer Query (support Approval) 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: 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.

transfer_nostring

Transfer ID. Returned value: Transfer ID.

from_aaidstring

From Account. Returned value: From Account.

from_aaid_valstring

From Account (raw value). Raw value of from_aaid. The from_aaid field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

from_aaid_copystring

Account Name. Returned value: Account Name.

from_aaid_copy_valstring

Account Name (raw value). Raw value of from_aaid_copy. The from_aaid_copy field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

from_aaid_account_typestring

Account Type. Returned value: Account Type.

from_aaid_account_type_valstring

Account Type (raw value). Raw value of from_aaid_account_type. The from_aaid_account_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

to_aaidstring

To Account. Returned value: To Account.

to_aaid_valstring

To Account (raw value). Raw value of to_aaid. The to_aaid field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

to_aaid_copystring

Account Name. Returned value: Account Name.

to_aaid_copy_valstring

Account Name (raw value). Raw value of to_aaid_copy. The to_aaid_copy field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

to_aaid_account_typestring

Account Type. Returned value: Account Type.

to_aaid_account_type_valstring

Account Type (raw value). Raw value of to_aaid_account_type. The to_aaid_account_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

account_channelstring

Account Channel. Returned value: Account Channel.

counter_idstring

Stock Code. Returned value: Stock Code.

custodianstring

Custodian. Returned value: Custodian.

custodian_valstring

Custodian (raw value). Raw value of custodian. The custodian field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

sub_position_no_namestring

Sub Position No. Returned value: Sub Position No.

sub_position_no_name_valstring

Sub Position No (raw value). Raw value of sub_position_no_name. The sub_position_no_name field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

streetstring

Street. Returned value: Street.

nomineestring

Nominee. Returned value: Nominee.

ownstring

Own. Returned value: Own.

transfer_quantitystring

Qty. Returned value: Qty.

equity_typestring

Asset Type. Returned value: Asset Type.

transfer_typestring

Transfer Type. Returned value: Transfer Type.

transfer_type_valstring

Transfer Type (raw value). Raw value of transfer_type. The transfer_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

remarkstring

Remarks. Returned value: Remarks.

ticket_statusstring

Approval Status. Returned value: Approval Status.

ticket_status_valstring

Approval Status (raw value). Raw value of ticket_status. The ticket_status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

created_atstring

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

updated_atstring

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

commentstring

Update Status. Returned value: Update Status.

ticket_idstring

Ticket No. Returned value: Ticket No.

ticket_creatorstring

Submitted By. Returned value: Submitted By.

ticket_creator_valstring

Submitted By (raw value). Raw value of ticket_creator. The ticket_creator field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

ticket_approvedstring

Approved By. Returned value: Approved By.

ticket_approved_valstring

Approved By (raw value). Raw value of ticket_approved. The ticket_approved field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

source_typestring

Source. Returned value: Source.

source_type_valstring

Source (raw value). Raw value of source_type. The source_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

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