Create New Order

post

https://trade-hk.oslsandbox.com/api/v4/order

Create a new order in the exchange.

🔐
To call this endpoint, the API Key need to have the Place and Manage Orders permission enabled (via OSL website).

Order Types Supported

Limit Order Day - OrdType = Limit , timeInForce = Day
Limit Order (GTC) - OrdType = Limit , timeInForce = GoodTillCancel
Market Order - OrdType = Market , timeInForce = GoodTillCancel
Immediate or Cancel (IOC) - OrdType = Limit , timeInForce = ImmediateOrCancel
Fill or Kill (FOK) - OrdType = Limit , timeInForce = FillOrKill
Post-Only Order - OrdType = Limit , timeInForce = Day or GoodTillCancel, execInst = PostOnly

`ordStatus` Code Table

Code	Description
New	The order is active and unexecuted on the exchange
PartiallyFilled	The order is active and partially filled on the exchange
Filled	The order is fully filled and no longer active on the exchange
Cancelled	The order is cancelled and no longer active on the exchange
Replaced	The order is amended
Rejected	The order is rejected and no longer active on the exchange
Suspended	The order is suspended
Expired	The order is expired and no longer active on the exchange
Withdrawn	The order is withdrawn to prevent self trade orders

Body Params

symbol

string

required

Currency-pair.

orderQty

string

required

Order quantity.

side

string

required

Side of order. Valid values: Buy/ Sell

ordType

string

required

Defaults to Market

Order type. Valid values: Limit / Market

price

string

Limit price.

timeInForce

string

Defaults to GoodTillCancel

Time in force specifies how long the order remains in effect. Default to GoodTillCancel. Valid values: GoodTillCancel: The order will remain in the order book until fully filled or cancelled by the user. ImmediateOrCancel: The order will execute in full or partially and then cancelled. It does not rest on the order book. FillOrKill: Execute all, or none and immediately cancel.

clOrdID

string

Client order ID. There is no clOrdID duplicate check. It is the client's responsibility to keep them unique. If not unique for a given user some reporting endpoints might have unexpected behavior.

execInst

string

The execution instruction flags for the order. Valid values: PostOnly.

acctGroupUuid

string

The account group to place order. Only house account group can use other account group to place order.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

To call this endpoint, the API Key need to have the Place and Manage Orders permission enabled (via OSL website).

Order Types Supported

ordStatus Code Table

200200

400400

401401

404404

500500

To call this endpoint, the API Key need to have the `Place and Manage Orders` permission enabled (via OSL website).

`ordStatus` Code Table