Skip to content
Longport WhaleLongport Whale
Custodian Query

Move Position

Adjust a position among street/nominee/own within the same custodian.

Request parameters

  • Required: aaid (securities account), market (market), counter_id (instrument code), custodian_id (custodian ID), sub_position_no (custodian sub-position), street_quantity (street change quantity), nominee_quantity (nominee change quantity), own_quantity (own change quantity), ledger_date (ledger date)
  • See each field description for format, value range, and business meaning.

Business notes

Within the same custodian_id and sub_position_no, reallocates the position attribute split by the street/nominee/own change quantities. This changes real positions.

Risk warning

This operation changes real positions. Confirm the account, instrument, custodian, and each change quantity before calling.

Result

On success the position move is applied; refer to the 200 response for the resulting state and returned data.

POSThttps://b-api.lbkrs.com/clearing/move_position

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.clearing_move_holding_position

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

Request body application/json

aaidstringrequired

Specifies A/C No.. This field is required.

Pass the internal numeric ID of the customer's securities account (aaid), not the securities account number account_no (such as H00000000) or the customer ID member_id. One customer can have multiple aaid values.

marketstringrequired

This field is required.

counter_idstringrequired

Counter ID associated with this request. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

custodian_idstringrequired

Refers to the clear_custodian_no_all enum.

Call GET /v1/datasets/refs/clearing_custodians to retrieve the current data dictionary, and use the returned entry's key as this field's value.

sub_position_nostringrequired

See enum clear_sub_position_no_all.

Call GET /v1/datasets/refs/custodian_sub_positions to retrieve the current data dictionary, and use the returned entry's key as this field's value.

street_quantitynumberrequired

This field is required.

nominee_quantitynumberrequired

This field is required.

own_quantitynumberrequired

This field is required.

ledger_datestringrequired

This field is required.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

On success data is an empty object.

No nested fields

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