Place Order

post

https://api.osl.com/openapi/v1/order

Note: When newOrderRespType is set to RESULT: MARKET orders will directly return execution results; LIMIT orders using special timeInForce will directly return execution or expired/rejected results.

Optional in one-way margin mode, defaults to and can only be BOTH.

Body Params

category

string

required

Transaction type: FUTURE/SPOT; currently only FUTURE is supported

symbol

string

required

Trading pair

side

string

required

Side: SELL/BUY

positionSide

string

Position side: Optional in one-way margin mode, default BOTH; required in hedge mode, optional LONG/SHORT

newClientOrderId

string

Client Order ID: Only supports [a-zA-Z0-9-_], if not provided, a UUID will be automatically generated

isolated

boolean

Is isolated: default false

type

string

required

Order type: LIMIT/MARKET/STOP/TAKE_PROFIT/STOP_MARKET/TAKE_PROFIT_MARKET

timeInForce

string

Time in force: GTC/FOK/IOC/POST_ONLY; default GTC; cannot be filled for MARKET/STOP_MARKET/TAKE_PROFIT_MARKET

quantity

number

Quantity: One of quantity or amount; mutually exclusive with closePosition; required for LIMIT/MARKET/STOP/TAKE_PROFIT/STOP_MARKET/TAKE_PROFIT_MARKET types when closePosition is not provided

price

number

Price: Required for LIMIT/STOP/TAKE_PROFIT; cannot be filled for MARKET/STOP_MARKET/TAKE_PROFIT_MARKET

stopPrice

number

Stop price: Required for STOP/STOP_MARKET/TAKE_PROFIT/TAKE_PROFIT_MARKET; cannot be filled for other types

closePosition

boolean

Close all after triggering: Only supports STOP/STOP_MARKET/TAKE_PROFIT/TAKE_PROFIT_MARKET; mutually exclusive with quantity, amount, and reduceOnly

reduceOnly

boolean

Is reduce only: Default false in one-way mode; cannot be true in hedge mode; mutually exclusive with closePosition

workingType

string

Trigger type: LAST_PRICE/MARK_PRICE; default LAST_PRICE

newOrderRespType

string

Response type: ACK/RESULT; default ACK; MARKET orders directly return execution results when RESULT is used

selfTradePreventionMode

string

Self-trade prevention mode: EXPIRE_TAKER/EXPIRE_MAKER/EXPIRE_BOTH; default EXPIRE_TAKER

amount

number

Notional value: One of quantity or amount; if amount is provided, quantity can be omitted, and the system converts the quantity based on price and rounds up to the nearest integer multiple of the step size; mutually exclusive with closePosition

Response

200Order placed successfully