Skip to main content
GET
/
v3
/
trade
/
order
cURL
curl --request GET \
  --url https://api.woox.io/v3/trade/order \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-signature: <x-api-signature>' \
  --header 'x-api-timestamp: <x-api-timestamp>'
# if withRealizedPnl is True
{
    "success": true,
    "data": {
        "symbol": "PERP_BTC_USDT",
        "status": "FILLED",
        "side": "SELL",
        "positionSide": "BOTH",
        "createdTime": 1578565539808,
        "orderId": 13,
        "orderTag": "default",
        "price": "123",
        "type": "LIMIT",
        "quantity": "0.1",
        "amount": "null",
        "visible": "0.1",
        "executed": "0.1",
        "totalFee": "0.00123",
        "feeAsset": "USDT",
        "totalRebate": 0,
        "rebateCurrency": "USDT",
        "clientOrderId": 0,
        "reduceOnly": false,
        "realizedPnl": "100",
        "averageExecutedPrice": "123",
    },
    "timestamp": 1721351502594
}
# if withRealizedPnl is False
{
    "success": true,
    "data": {
        "symbol": "PERP_BTC_USDT",
        "status": "FILLED",
        "side": "SELL",
        "positionSide": "BOTH",
        "createdTime": 1578565539808,
        "orderId": 13,
        "orderTag": "default",
        "price": "123",
        "type": "LIMIT",
        "quantity": "0.1",
        "amount": "null",
        "visible": "0.1",
        "executed": "0.1",
        "totalFee": "0.00123",
        "feeAsset": "USDT",
        "totalRebate": 0,
        "rebateCurrency": "USDT",
        "clientOrderId": 0,
        "reduceOnly": false,
        "averageExecutedPrice": "123",
    },
    "timestamp": 1721351502594
}
Limit: 5 requests per 1 symbol per 1 second 
# if withRealizedPnl is True
{
    "success": true,
    "data": {
        "symbol": "PERP_BTC_USDT",
        "status": "FILLED",
        "side": "SELL",
        "positionSide": "BOTH",
        "createdTime": 1578565539808,
        "orderId": 13,
        "orderTag": "default",
        "price": "123",
        "type": "LIMIT",
        "quantity": "0.1",
        "amount": "null",
        "visible": "0.1",
        "executed": "0.1",
        "totalFee": "0.00123",
        "feeAsset": "USDT",
        "totalRebate": 0,
        "rebateCurrency": "USDT",
        "clientOrderId": 0,
        "reduceOnly": false,
        "realizedPnl": "100",
        "averageExecutedPrice": "123",
    },
    "timestamp": 1721351502594
}
# if withRealizedPnl is False
{
    "success": true,
    "data": {
        "symbol": "PERP_BTC_USDT",
        "status": "FILLED",
        "side": "SELL",
        "positionSide": "BOTH",
        "createdTime": 1578565539808,
        "orderId": 13,
        "orderTag": "default",
        "price": "123",
        "type": "LIMIT",
        "quantity": "0.1",
        "amount": "null",
        "visible": "0.1",
        "executed": "0.1",
        "totalFee": "0.00123",
        "feeAsset": "USDT",
        "totalRebate": 0,
        "rebateCurrency": "USDT",
        "clientOrderId": 0,
        "reduceOnly": false,
        "averageExecutedPrice": "123",
    },
    "timestamp": 1721351502594
}

Headers

​
x-api-key
string
required
Example:

"abcdef123456"

​
x-api-signature
string
required
Example:

"signaturestring"

​
x-api-timestamp
string
required
Example:

"1718943200000"

Query Parameters

​
orderId
integer
default:1

Id of the order; Either orderId or clientOrderId is required. If both are passed, orderId will be used.

​
clientOrderId
integer
default:1

Client order Id as assigned by the user; Either orderId or clientOrderId is required. If both are passed, orderId will be used.

​
withRealizedPnl
integer
default:1

Whether to return order’s realized pnl; Note that realized PnL is only calculated for Perpetual close orders.

Response

200 - application/json
​
success
boolean

true

​
timestamp
integer

timestamp

​
data
object