Skip to content
Order Checks

Get Pre-Order Confirmations (Hong Kong and Singapore)

Before submitting the order of an order card (for Hong Kong and Singapore stock accounts), pass the normalized order parameters returned by POST /v1/trade/widget/validate to get the reminders, assessments, and declarations that the Client must confirm. If the list is empty, submit the order directly. Otherwise, show each item and obtain the Client's confirmation before submitting. This operation does not create an order.

For a declaration item (type=3) without click_url, sign the declaration after the Client selects the confirmation: if flag in param is options_general_risk_disclaimer, call POST /v1/member/account/options/agree; otherwise pass the value as type to POST /v1/record/questionnaire. After signing succeeds, call this operation again and submit the order only when no items remain.

POSThttps://api.lbkrs.com/v1/trade/widget/submit/check

Request body application/json

counter_idstringrequired

Security ID (counter_id), for example ST/US/AAPL or ST/HK/700

actionintegerrequired

Order side:

  • 1 - Buy
  • 2 - Sell
Values
1
2
order_typestringrequired

Order type, for example LO (limit), MO (market), ELO (enhanced limit), ALO (at-auction limit), AO (at-auction market), ODD (odd lot), LIT (limit if touched), MIT (market if touched), TSLPAMT / TSLPPCT (trailing stop limit by amount / percentage), TSMAMT / TSMPCT (trailing stop market by amount / percentage), or MOC (market on close)

pricestringrequired

Order price; the limit price for stop-limit orders. Omit it for market orders

trigger_pricestring

Trigger price for conditional orders

quantitystringrequired

Order quantity

settlement_currencystringrequired

Settlement currency, for example USD, HKD, or SGD

force_only_rthintegerrequired

Trading session (force_only_rth). US stocks:

  • 0 - Any session
  • 1 - Regular trading hours only
  • 4 - Overnight

Hong Kong and Singapore stocks:

  • 1 - Regular trading hours only
  • 2 - Regular trading hours plus pre-market and after-hours
  • 3 - Overnight only
  • 4 - Options pre-market
time_in_forceinteger

Time in force:

  • 0 - Day
  • 1 - Good till canceled (GTC)
  • 3 - Immediate or cancel (IOC)
  • 5 - Fill or kill (FOK)
  • 6 - Good till date (GTD); an expiry time is also required
Values
0
1
3
5
6
tailing_amountstring

Trailing amount, used when a trailing order tracks by amount

tailing_percentstring

Trailing percentage, used when a trailing order tracks by percentage

limit_offsetstring

Limit offset for trailing stop limit orders

monitor_pricestring

Monitoring price for trailing orders

trigger_countinteger

Number of triggers within one minute for conditional orders

statistics_entrystringrequired

Order entry identifier used to attribute the order source. Order cards use ai_widget

stock_contractobject

Single option contract

Child attributes
underlying_counter_idstring

Security ID of the underlying

expire_datestring

Expiry date

strike_pricestring

Strike price

contract_directionstring

Option direction:

  • C - Call
  • P - Put
Values
C
P
contract_multiplierstring

Contract multiplier: the number of underlying shares per contract

multiLegobject

Multi-leg option combination

Child attributes
strategyinteger

Combination strategy type

strategy_namestring

Combination strategy name

multi_leg_idstring

Multi-leg combination ID

codestring

Combination code for display

namestring

Combination name

legsarray<object>

Legs of the combination

Child attributes
counter_idstring

Security ID of the option contract in this leg

actioninteger

Order side:

  • 1 - Buy
  • 2 - Sell
Values
1
2
ratio_quantitystring

Ratio quantity of this leg in the combination

quantitystring

Order quantity of this leg, in contracts

security_typestring

Security type of this leg

expire_datestring

Option expiry date

contract_directionstring

Option direction:

  • C - Call
  • P - Put
Values
C
P
strike_pricestring

Strike price

trendinteger

Trigger direction of a LIT, MIT, or TSL order

market_pricestring

Market price when the order card was validated, for LIT, MIT, and TSL orders. The service fetches it from quotes

limit_depth_levelinteger

Order book level that prices a TSL order after it triggers: 0 uses the market price adjusted by limit_offset, -1 to -5 use bid 1 to bid 5, and 1 to 5 use ask 1 to ask 5

expire_timeinteger

Expiry time as a Unix timestamp in seconds, derived from expire_date. Present only when time_in_force is 6

namestring

Localized security name for display

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Pre-Order Confirmations (Hong Kong and Singapore)” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
itemsarray<object>

Items that the Client must confirm; empty when no confirmation is needed

Child attributes
typeinteger

Check item type:

  • 1 - Reminder; the Client can continue after confirming it (for example queued orders, margin calls, PDT, or day-trading buying power)
  • 2 - Assessment; open click_url to complete an assessment or risk confirmation (for example OTC, warrants and CBBCs, or virtual asset ETFs)
  • 3 - Declaration; show the agreement in check_url and have the Client select the confirmation (for example options, US short selling, overnight trading, odd lots, or penny stocks)
Values
1
2
3
titlestring

Title; may contain template variables

bodystring

Body text; may contain {{key}} template variables that you replace with the values of the same keys in param

paramstring

Template parameters as a JSON string. For declaration items, flag is the type value to submit when the Client signs the declaration

click_urlstring

Destination URL for an assessment item

check_urlstring

Rich-text content of a declaration item; may contain agreement links

checkboxstring

Confirmation phrase next to the checkbox of a declaration item; may contain template variables. If empty, use a default confirmation phrase

Whale Docs