GET
/
v3
/
trade
/
orders
curl --request GET \
  --url https://api.woox.io/v3/trade/orders \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-signature: <x-api-signature>' \
  --header 'x-api-timestamp: <x-api-timestamp>' \
  --data 'symbol=<string>' \
  --data 'side=<string>' \
  --data 'positionSide=<string>' \
  --data 'type=<string>' \
  --data 'orderTag=<string>' \
  --data withRealizedPnl=true \
  --data 'status=<string>' \
  --data startTime=123 \
  --data endTime=123 \
  --data page=123 \
  --data size=123
{
    "success": true,
    "data": {
        "meta": {
            "total": 31,
            "recordsPerPage": 25,
            "currentPage": 1
        },
        "rows": [
            {
                "symbol": "PERP_BTC_USDT",
                "status": "FILLED",
                "side": "SELL",
                "positionSide": "BOTH",
                "createdTime": 1578565539808,
                "orderId": 135,
                "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": "2",
                "averageExecutedPrice": "123",
            },
            ...
        ]
    },
    "timestamp": 1721351502594
}

Limit: 10 requests per 1 second

Get orders by customizable conditions. For filtering by status, one can reference special bundled statuses below for ease of access of open (i.e. INCOMPLETE) orders or COMPLETED orders.

  1. INCOMPLETE = NEW + PARTIAL_FILLED

  2. COMPLETED = CANCELLED + FILLED + REJECTED

{
    "success": true,
    "data": {
        "meta": {
            "total": 31,
            "recordsPerPage": 25,
            "currentPage": 1
        },
        "rows": [
            {
                "symbol": "PERP_BTC_USDT",
                "status": "FILLED",
                "side": "SELL",
                "positionSide": "BOTH",
                "createdTime": 1578565539808,
                "orderId": 135,
                "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": "2",
                "averageExecutedPrice": "123",
            },
            ...
        ]
    },
    "timestamp": 1721351502594
}

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/x-www-form-urlencoded

The body is of type object.

Response

200 - application/json

The response is of type object.