Skip to content
Order Page Setup

Get Order Configuration

Retrieves the order rules and configuration for a security under the current account when the user opens the order page, switches securities, or switches accounts: lot size, tick-size table, order price limits, order tag, the trading sessions and time-in-force values supported by each order type, support for good-till-date and attached orders, US fractional shares, available settlement currencies, online buy and sell restrictions, the market order buying-power factor, and the status of authorizations and statements required before ordering. A Broker-built order page uses this response to determine the available order types, sessions, time in force, quantity step, and price step, and to block submission when an authorization is missing. When amending an order, pass the original order ID to get the configuration for that order. After the user completes an authorization or certification, call this endpoint again to refresh the status. This endpoint is also used by the recurring investment plan creation page (to read the trading configuration of the security) and by the options income and protection strategy pages (to read the authorization status of the strategy risk agreement).

WhaleCore's orderService() wraps this endpoint as the typed method getOrderInfo. If you use WhaleCore, prefer that method.

GEThttps://api.lbkrs.com/v5/orders/info

Parameters

counter_idstringqueryRequired

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

order_idstringquery

Original order ID when amending an order. Omit it for a new order.

order_id_strstringquery

String form of the original order ID. When amending an order, pass the same value as order_id.

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Order Configuration” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
counter_idstring

Security ID

namestring

Security name

last_donestring

Latest price in the quote currency

lot_sizestring

Lot size. Use it as the quantity step when buy_lot_size or sell_lot_size is empty.

buy_lot_sizestring

Lot size for buy orders

sell_lot_sizestring

Lot size for sell orders

upper_limitstring

Upper price limit. The order price cannot exceed this value.

lower_limitstring

Lower price limit. The order price cannot be below this value.

taginteger

Order tag. Pass it as order_tag when estimating trading fees:

  • 1 - Regular order
  • 2 - Long-term order
  • 3 - Grey market order
Values
1
2
3
timestampstring

Current server time as a Unix timestamp in seconds

bid_sizesarray<object>

Tick-size table used to determine the minimum price increment for a price and to validate or adjust the order price. When no band matches, use the first item.

Child attributes
bid_sizestring

Minimum price increment in this band, for example "0.01"

str_proceedstring

Lower bound of the band (exclusive)

end_proceedstring

Upper bound of the band (inclusive)

is_connectboolean

Whether the security is traded through China Connect

is_spacboolean

Whether the security is a SPAC

is_rightsboolean

Whether the security is a rights issue

channel_infosobject

Trading configuration of the current account for this security. In addition to the fields below, the response contains several *_granted booleans (whether the corresponding authorization, certification, or risk statement is complete) with matching certification URL fields (*_url, *_granted_url). Some apply only to specific markets or businesses, and the server determines which fields are present. When a value is false, guide the user to the matching URL before submitting the order, and call this endpoint again afterward to refresh the status.

Child attributes
account_channelstring

Account channel. Together with org_id and aaid, it identifies the account this configuration belongs to.

org_idstring

Tenant ID

aaidstring

Asset account ID

currencystring

Quote currency of the security, for example USD, HKD, or GBX

settlement_currencyarray<string>

Available settlement currencies. The first item is the default trading currency; pass it as currency when you query positions and cash, buying power, and estimated fees.

order_type_configobject

Order type configuration available for this security and account. Keys are order type codes, for example LO (limit order), ELO (enhanced limit order), MO (market order), LIT (limit-if-touched), and MIT (market-if-touched). An order type that does not appear is unavailable. When this object is returned, use the per-order-type configuration for sessions and time in force.

support_tradeboolean

Whether the current account channel supports trading. When false, do not offer order entry.

restrictedinteger

Online trading restriction:

  • 1 - Online buying is not allowed
  • 2 - Online selling is not allowed
  • 3 - Neither online buying nor online selling is allowed

If the field is absent or has another value, no such restriction applies. For a restricted direction, direct the user to contact the Broker offline.

Values
1
2
3
support_rthboolean

Whether pre-market and after-hours trading is supported. When order_type_config is returned, support_sessions in it takes precedence.

support_overnightboolean

Whether overnight trading is supported. When order_type_config is returned, support_sessions in it takes precedence.

gtd_support_order_typesarray<string>

Order type codes that support good-till-date (GTD) orders

support_attached_order_typesarray<string>

Order type codes that accept attached orders

support_fractional_sharesboolean

Whether US fractional-share trading is supported

fractional_min_amountstring

Minimum amount, in USD, for a fractional-share order placed by amount. Orders below this amount are rejected.

mo_avail_ratiostring

Buying-power factor for market orders. Available buying power for a market order (including an untriggered market conditional order) equals buy_limit from Get Buying Power for Order Entry multiplied by this factor. Treat an empty value as 1.

finance_account_statusinteger

Margin credit status:

  • 0 - Normal
  • 1 - Credit limit is 0 and an adjustment request is under review
  • 2 - Credit limit is 0 and no request is under review

When the value is 1 or 2, trades that require margin credit, such as opening a short stock position or selling to open options, cannot proceed. Tell the user to wait for review or request a limit adjustment.

Values
0
1
2
account_risk_levelinteger

Account risk level:

  • 0 - No additional statement is required
  • 1 - The user must confirm the trade-anyway statement before ordering
  • 2 - The user must confirm the important notice before ordering
Values
0
1
2
confirm_purchase_statementboolean

Whether the user has confirmed the trade-anyway statement

confirm_important_noticeboolean

Whether the user has confirmed the important notice

granted_infoobject

Authorization status of each trading qualification and risk statement. Keys are qualification type codes, for example us_overnight_risk_agreement (US overnight trading risk statement) and fractional_shares_risk_agreement (fractional-share trading risk statement). The server determines the other keys.

stock_contractobject

Option contract information, returned only for options

Child attributes
contract_directionstring

Option type: C for a call, P for a put

underlying_counter_idstring

Security ID of the underlying stock

nearing_expireboolean

Whether the option is close to expiry

contract_modelinteger

Option margin mode:

  • 1 - Non-margin mode
  • 2 - Margin mode
Values
1
2
open_purchase_limitobject

Minimum buying power required to open an option position. No threshold applies when threshold is empty or 0.

Child attributes
thresholdstring

Threshold amount

currencystring

Currency of the threshold amount

Whale Docs