POST
/
v3
/
trade
/
order
cURL
curl --request POST \
  --url https://api.woox.io/v3/trade/order \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-signature: <x-api-signature>' \
  --header 'x-api-timestamp: <x-api-timestamp>' \
  --data '{
  "symbol": "SPOT_BTC_USDT",
  "clientOrderId": "1954766344355779056",
  "orderTag": "",
  "side": "",
  "positionSide": "",
  "type": "",
  "price": "",
  "quantity": "",
  "amount": "",
  "reduceOnly": "",
  "visibleQuantity": "",
  "marginMode": "",
  "bidAskLevel": "",
  "postOnlyAdjusted": ""
}'
{
  "success": true,
  "timestamp": 123,
  "data": {
    "orderId": 123,
    "type": "<string>",
    "price": "<string>",
    "quantity": "<string>",
    "amount": "<string>",
    "clientOrderId": 123,
    "bidAskLevel": 123
  }
}
Limit: 5 requests per 1 symbol per 1 second

Headers

​
x-api-key
string
required

api-key

Example:

"abcdef123456"

​
x-api-signature
string
required

api-signature

Example:

"signaturestring"

​
x-api-timestamp
string
required

api-timestamp

Example:

"1718943200000"

Body

application/json
​
symbol
string
required

Symbol name

Example:

"SPOT_BTC_USDT"

​
side
string
required

BUY/SELL

Example:

""

​
type
string
required

LIMIT/MARKET/IOC/FOK/POST_ONLY/ASK/BID/AC/RPI where AC/RPI are only available to market makers.

Example:

""

​
clientOrderId
integer

Valid input ranges from 0 to 9223372036854775807

Example:

"1954766344355779056"

​
orderTag
string

Optional tag for this order, max string length: 64

Example:

""

​
positionSide
string

Position side; The default is BOTH in the one way mode; Can only be LONG or SHORT in the hedge mode. Only applicable to perpetual instruments.

Example:

""

​
price
string

Only applicable to LIMIT/IOC/FOK/POST_ONLY orders; MARKET/ASK/BID orders will ignore this field

Example:

""

​
quantity
string

Either quantity or amount is required; If both are passed, the request will be rejected

Example:

""

​
amount
string

Only applicable to MARKET/ASK/BID orders on spot instruments; Either quantity or amount is required; If both are passed, the request will be rejected

Example:

""

​
reduceOnly
boolean

Only applicable to perpetual instruments; Whether the order can only reduce in position size; valid options are true/false

Example:

""

​
visibleQuantity
string

The order quantity visible on orderbook

Example:

""

​
marginMode
string

CROSS / ISOLATED

Example:

""

​
bidAskLevel
string

[1..5](only effective if type = ASK / BID)

Example:

""

​
postOnlyAdjusted
boolean

Only applicable to POST_ONLY orders; Whether the order should be adjusted to the best bid/ask if it would cross the book and execute immediately as a taker

Example:

""

Response

200 - application/json
​
success
boolean

true

​
timestamp
integer

timestamp

​
data
object