Skip to content
Longport WhaleLongport Whale
SBL Overview

Modify Short Sell Stock Holding Status

Modifies the status of a short-sell position for a given security.

Request parameters

  • Required: counter_id (security code), status, remark
  • Parameters are passed as a query string (Content-Type: application/x-www-form-urlencoded).
  • See the field definitions for each field's format, allowed values, and business meaning.

Business notes

Updates the handling status of the short-sell position for the given security code and records a remark.

Risk warning

This operation changes a real short-sell position status. Verify the security code and target status before calling.

Result

On success the short-sell position status is updated; subsequent state and returned data follow the 200 response definition.

POSThttps://b-api.lbkrs.com/v1/risk_monitoring/modif_short_sell_stock_holding_status

Authorization

AuthorizationstringheaderRequired

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

Permission

margin_call.modify_short_sell_stock_holding_status

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

Request body application/json

counter_idstringrequired

Counter ID. A hidden field derived programmatically from the selected record; not editable by the user. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

statusstringrequired

Status. Short-selling holding status to set. Only one value is supported; see the option definitions below.

Allowed values: 0 Normal, 1 Close-out Warning, 2 Position Closed

Values
0
Normal
1
Close-out Warning
2
Position Closed
remarkstringrequired

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

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