New Order
POST{BASE_URL}/orders/new
Places a Hong Kong equity order.
Coming soon (not available yet): option orders and OCO orders.
The option and OCO fields describe their planned behavior as a
preview: an option will be identified either by its OCC symbol, or
by underlying, expiration_date, option_type and strike_price;
an OCO equity order will set order_class=oco and provide both
take_profit_leg and stop_loss_leg.
- Orders must use
execution_instruction=heldand a whole-numberquantity. Fractional quantities andnotionalorders are not supported: a fractionalquantityfails withBasicInput_Error, andnot_heldfails withDisallowedOrderAction_Error. symbolis the HKEX stock code without leading zeros or suffix (700, not00700or0700.HK). Other forms fail withInstrument_Error: security not found.- Sell to open must use
sell_shortorsell_short_exempt(only for easy-to-borrow stocks); sell to close must usesell.
A 201 means the order was accepted and saved. Fills, rejection by the
venue and cancellation are reported on the WebSocket and by
GET /orders/status. Orders received outside a trading session stay
new until the next session they are eligible for.
Request
Responses
- 201
- 400
- 401
- 403
- 500
- 503
Order accepted. Track it on the WebSocket or with GET /orders/status.
The request could not be accepted, for example because the account or
symbol is unavailable, a required paired account is missing, buying power
or position is insufficient, required market pricing is unavailable, an
identifier is duplicated, or an order field or requested lifecycle action
is invalid. A missing account_number, or one not linked to the API key,
also returns 400 BasicInput_Error.
Missing or invalid X-API-KEY.
The API key is read-only and the request is not a GET.
Unexpected server-side failure, for example the order service did not
answer in time (AVInternal_Error, system too busy) or was
unreachable (Misc_Error). For order requests, check the order's
status before retrying: a retried order_id that was already
accepted is rejected as a duplicate.
A required service is temporarily unavailable (for example the database, or for Hong Kong requests that read from GigaMoney Whale, the Whale connection). Retry later.