Skip to content
Longport WhaleLongport Whale
Temporary Adjustment

Temporary Adjustment

Performs a temporary adjustment on a securities account, supporting cash and stock asset types.

Request parameters

  • Required: security_type (asset type), op_user (operator); provide cash_adjusts (cash adjustment detail) when security_type is CASH, or stock_adjusts (stock adjustment detail) when it is STOCK.
  • cash_adjusts and stock_adjusts are single objects; each request submits one adjustment. expire_time (expiry, Unix timestamp in seconds) is required inside the adjustment detail.
  • See the field descriptions for each field's format, value range, and business meaning.

Business notes

Temporarily increases or decreases the account's cash or stock assets according to security_type. Use expire_time to have the adjustment auto-expire, supporting temporary asset changes.

Risk warning

This operation temporarily changes real account funds or positions. Confirm the account, asset type, and adjustment details before calling.

Result

On success, the temporary adjustment completes. Refer to the 200 response definition for the resulting state.

POSThttps://b-api.lbkrs.com/v2/whaleapi/asset/temp_adjust

Authorization

AuthorizationstringheaderRequired

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

Permission

change_ticket.update

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

Request body application/json

security_typestringrequired

Asset type of the adjustment; determines which adjustment detail to provide.

  • CASH - Cash: provide cash_adjusts
  • STOCK - Stock: provide stock_adjusts
Values
CASH
STOCK
op_userstringrequired

Operator

cash_adjustsobject

Cash adjustment detail. Each request submits one adjustment, passed as a single object (not an array). Required when security_type is CASH.

Child attributes
currencystringrequired

Currency, for example USD or HKD

directionstringrequired

Adjustment type (direction). Must match biz_code.

  • CREDIT - Credit
  • DEBIT - Debit
Values
CREDIT
DEBIT
incurred_amountstringrequired

Adjustment amount, with 2 decimal places

biz_codestringrequired

Business code that determines a temporary increase or decrease, and must match direction: codes containing PDR are decreases (DEBIT); all others are increases (CREDIT). Cash temporary adjustment codes:

  • LCTPCR - Cash temporary increase (CREDIT)
  • LCTPDR - Cash temporary decrease (DEBIT)
remarkstringrequired

Remark

expire_timeintegerrequired

Expiry date, that is, the time when the temporary adjustment automatically expires. Unix timestamp in seconds (for example, 1767196800).

account_nostringrequired

Securities account number, for example L6VQEU00121996

account_no is the securities account number (such as L6VQEU00121996). It differs from the customer ID member_id and the internal securities account ID aaid.

stock_adjustsobject

Stock adjustment detail. Each request submits one adjustment, passed as a single object (not an array). Required when security_type is STOCK.

Child attributes
Symbolstringrequired

Security symbol, for example AAPL.US

directionstringrequired

Adjustment type (direction). Must match biz_code.

  • CREDIT - Credit
  • DEBIT - Debit
Values
CREDIT
DEBIT
incurred_quantitystringrequired

Adjustment quantity

biz_codestringrequired

Business code that determines a temporary increase or decrease, and must match direction: codes containing PDR are decreases (DEBIT); all others are increases (CREDIT). Stock temporary adjustment codes:

  • LSTPCR - Stock temporary increase (CREDIT)
  • LSTPDR - Stock temporary decrease (DEBIT)
remarkstringrequired

Remark

currencystringrequired

Currency (currency of the cost price)

cost_pricestringrequired

Total cost price

expire_timeintegerrequired

Expiry date, that is, the time when the temporary adjustment automatically expires. Unix timestamp in seconds (for example, 1767196800).

position_sidestringrequired

Position side.

  • LONG - Long
  • SHORT - Short
Values
LONG
SHORT
account_nostringrequired

Securities account number, for example L6VQEU00121996

account_no is the securities account number (such as L6VQEU00121996). It differs from the customer ID member_id and the internal securities account ID aaid.

Responses

HTTP 200Successful response
Standard response envelopecodemessagedata
dataobjectdata structure
adjust_nostringrequired

adjust_no

codestringrequired

code

messagestringrequired

message

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