Skip to main content
POST
Place Order

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request to place an order.

margin_mode
enum<string>
required
Available options:
Cross,
Isolated
order_type
enum<string>
required

Order type: Limit, Market.

Available options:
Limit,
Market
price
string
required
qty
string
required
side
enum<string>
required

Order side: buy or sell.

Available options:
Sell,
Buy
sub_account_address
string
required
symbol
string
required
Example:

"BTC-USDCx"

time_in_force
required

Time in Force instructions.

Available options:
GTC
close_on_trigger
boolean
expire_time
string<date-time> | null
Example:

"1672531200000"

post_only
boolean
reduce_only
boolean
slippage_tolerance
object
smp_group
integer<int64> | null

Self-match prevention group id. Orders with the same (user_id, smp_group) are eligible for SMP checks.

Required range: x >= 0
smp_type
null | enum<string>

Self-match prevention (SMP/STP) strategy. If unset, SMP is disabled.

Available options:
CancelMaker,
CancelTaker,
CancelBoth
tpsl
null | object
trigger
null | object

Response

200 - application/json

Order placed

Response for placing an order.

order_id
string<uuid>
required