Skip to main content

Get Orders (Paginated)

Query orders with pagination

HTTP Request

GET /cloud/contract/v3/private/copytrading/order/page-list

Request Parameters

ParameterRequiredTypeComments
symbolfalsestringSymbol
orderIdfalsestringOrder Id
orderLinkIdfalsestringUnique user-set order ID. Maximum length of 36 characters
copyTradeOrderTypefalsestringcopyTradeOrderType: All, Active, Closed, Cancelled, Tpsl
preIndexfalsestringIndex of the last order from the previous query. Omit for first query
pageSizefalseintegerNumber of records per page. Default: 10, Max: 50

Response Parameters

ParameterTypeComments
listarrayOrder list. See Get Orders for order structure
hasNextbooleanWhether there is more data
nextIndexstringIndex for next page query. Pass this value as preIndex in the next request

Order Fields (in list)

ParameterTypeComments
orderIdstringOrder Id
orderLinkIdstringUnique user-set order ID. Maximum length of 36 characters
symbolstringSymbol
sidestringSide
pricestringOrder price
qtystringOrder quantity in USD
timeInForcestringTime in force
isIsolatedbooleantrue means isolated margin mode; false means cross margin mode
leveragestringIn Isolated Margin mode, the value is set by the user. In Cross Margin mode, the value is the max leverage at current risk level
copyTradeOrderStatusstringCopy trade order type
leavesQtystringNumber of unfilled contracts from the order's size
leavesValuestringThe estimated value corresponding to the number of remaining orders
cumExecValuestringCumulative value of trading
cumExecFeestringCumulative trading fees
takeProfitstringTake profit price
stopLossstringStop loss price
tpTriggerBystringType of take-profit activation price, LastPrice by default.
slTriggerBystringType of stop-loss activation price, LastPrice by default.
createdTimestringCreation time (when the order_status was Created)
updatedTimestringUpdate time

Request Example

# First page
curl --location --request GET 'https://openapi-testnet.zoomex.com/cloud/contract/v3/private/copytrading/order/page-list?timestamp=1689845343595&api_key=XXXXX&recv_window=5000&sign=XXXXX&pageSize=20'

# Next page (use nextIndex from previous response as preIndex)
curl --location --request GET 'https://openapi-testnet.zoomex.com/cloud/contract/v3/private/copytrading/order/page-list?timestamp=1689845343595&api_key=XXXXX&recv_window=5000&sign=XXXXX&pageSize=20&preIndex=eyJvcmRlcklkIjoiMjQxNTg4ZmItMWU2OS00NmYyLTg0NDYtOTI3OGU0MDkwMmJmIn0='

Response Example

{
"retCode": 0,
"retMsg": "success",
"result": {
"list": [
{
"orderId": "241588fb-1e69-46f2-8446-9278e40902bf",
"symbol": "BTCUSDT",
"orderLinkId": "",
"side": "Sell",
"copyTradeOrderStatus": "OpenOrderFilled",
"price": "30285.00",
"qty": "1",
"timeInForce": "GoodTillCancel",
"leavesQty": "0",
"isIsolated": true,
"leavesValue": "0",
"leverage": "25",
"cumExecValue": "30287.6",
"cumExecFee": "18.17256",
"createdTime": "1689845238176",
"updatedTime": "1689845238192",
"takeProfit": "29000.00",
"stopLoss": "32000.00",
"tpTriggerBy": "MarkPrice",
"slTriggerBy": "IndexPrice"
}
],
"hasNext": true,
"nextIndex": "eyJvcmRlcklkIjoiMjQxNTg4ZmItMWU2OS00NmYyLTg0NDYtOTI3OGU0MDkwMmJmIn0="
}
}