Skip to main content

Definition

OrderType

  • Description: HongKong stock support order type
EnumDescription
LOLimit Order
ELOEnhanced Limit Order
MOMarket Order
AOAt-auction Order
ALOAt-auction Limit Order
ODDOdd Lots Order
LITLimit If Touched
MITMarket If Touched
TSLPAMTTrailing Limit If Touched (Trailing Amount)
TSLPPCTTrailing Limit If Touched (Trailing Percent)
SLOSpecial Limit Order. Not Support Replace Order.
  • Description: US stock support order type
EnumDescription
LOLimit Order
MOMarket Order
LITLimit If Touched
MITMarket If Touched
TSLPAMTTrailing Limit If Touched (Trailing Amount)
TSLPPCTTrailing Limit If Touched (Trailing Percent)

OrderStatus

  • Description: Order Status
EnumDescription
NotReportedNotReported
ReplacedNotReportedNotReported (Replaced Order)
ProtectedNotReportedNotReported (Protected Order)
VarietiesNotReportedNotReported (Conditional Order)
FilledStatusFilled
WaitToNewWait To New
NewStatusNew
WaitToReplaceWait To Replace
PendingReplaceStatusPending Replace
ReplacedStatusReplaced
PartialFilledStatusPartial Filled
WaitToCancelWait To Cancel
PendingCancelStatusPending Cancel
RejectedStatusRejected
CanceledStatusCanceled
ExpiredStatusExpired
PartialWithdrawalPartial Withdrawal

Market

  • Description: Market
EnumDescription
HKHong Kong Market
USUnited States of America Market

WebSocket Notification

  • Description: Push notification field description
fieldtypeDescription
sidestringorder side

Enum Value
Buy
Sell
stock_namestringstock name
submitted_quantitystringsubmitted quantity
symbolstringorder symbol
order_typestringOrder Type
submitted_pricestringsubmitted price
executed_quantitystringexecuted quantity
executed_pricestringexecuted price
order_idstringorder id
currencystringcurrency
statusstringorder status
submitted_atstringsubmitted time,formatted as a timestamp (second)
updated_atstringlast updated time ,formatted as a timestamp (second)
trigger_pricestring"LIT / MIT order trigger price"
msgstringrejected message or remark
tagstringorder tag

Enum Value
Normal - Normal Order
GTC - Long term Order
Grey - Grey Order
trigger_statusstringconditional order trigger status

Enum Value
NOT_USED
DEACTIVE
ACTIVE
RELEASED
trigger_atstringconditional order trigger time. formatted as a timestamp (second)
trailing_amountstring"TSLPAMT order trailing amount"
trailing_percentstring"TSLPPCT order trailing percent"
limit_offsetstring"TSLPAMT / TSLPPCT order limit offset amount"
account_nostringaccount no
remarkstringremark message
last_sharestringlast share
last_pricestringlast price

example

{
"event": "order_changed_lb",
"data": {
"side": "Buy",
"stock_name": "Tencent Holdings Ltd.",
"submitted_quantity": "1000",
"symbol": "700.HK",
"order_type": "LO",
"submitted_price": "213.2",
"executed_quantity": "1000",
"executed_price": "213.2",
"order_id": "27",
"currency": "HKD",
"status": "NewStatus",
"submitted_at": "1562761893",
"updated_at": "1562761893",
"trigger_price": "213.0",
"msg": "Insufficient Qty - 1000",
"tag": "GTC",
"trigger_status": "ACTIVE",
"trigger_at": "1562761893",
"trailing_amount": "5",
"trailing_percent": "1",
"limit_offset": "0.01",
"account_no": "HK123445",
"last_share": "100",
"last_price": "234",
"remark": "abc"
}
}