Skip to main content
GET
/
v3
/
trade
/
orders
cURL
curl --request GET \
  --url https://api.woox.io/v3/trade/orders \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-signature: <x-api-signature>' \
  --header 'x-api-timestamp: <x-api-timestamp>'
{
    "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
}

Documentation Index

Fetch the complete documentation index at: https://developer.woox.io/llms.txt

Use this file to discover all available pages before exploring further.

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
Example:

"abcdef123456"

​
x-api-signature
string
required
Example:

"signaturestring"

​
x-api-timestamp
string
required
Example:

"1718943200000"

Query Parameters

​
symbol
string

Symbol name

​
side
string

BUY/SELL

​
positionSide
string

BOTH for one way mode; LONG or SHORT for hedge mode; Only applicable to perpetual instruments

​
type
string

LIMIT/MARKET/IOC/FOK/POST_ONLY/LIQUIDATE/RPI/LIQUIDATE_BLP/ADL

​
orderTag
string

Order tag

​
withRealizedPnl
boolean

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

​
status
string

NEW/CANCELLED/PARTIAL_FILLED/FILLED/REJECTED/INCOMPLETE/COMPLETED

​
startTime
integer<int64>

Start timestamp in Unix timestamp format in milliseconds

​
endTime
integer<int64>

End timestamp in Unix timestamp format in milliseconds

​
page
integer
default:1

Page number

​
size
integer
default:50

Data size per page, max 500

Required range: x <= 500

Response

200 - application/json
​
success
boolean

true

​
timestamp
integer

timestamp

​
data
object