Get HF order details by clientOid

This endpoint can be used to obtain information for a single margin HF order using the clientOid.

If the order is not an active order, you can only get data within the time range of 3 _ 24 hours (ie: from the current time to 3 _ 24 hours ago). If the time range is exceeded, the system will query the data within the time range of 3 * 24 hours by default.

HTTP REQUEST

GET /api/v3/hf/margin/orders/client-order/{clientOid}?symbol={symbol}

Example

GET /api/v3/hf/margin/orders/client-order/6d539dc614db312?symbol=6d539dc614db312

//Response
{
  "code": "200000",
  "data": {
    "id": "5f3113a1c9b6d539dc614dc6",
    "symbol": "KCS-BTC",
    "opType": "DEAL",
    "type": "limit",
    "side": "buy",
    "price": "0.00001",
    "size": "1",
    "funds": "0",
    "dealFunds": "0",
    "dealSize": "0",
    "fee": "0",
    "feeCurrency": "BTC",
    "stp": "",
    "timeInForce": "GTC",
    "postOnly": false,
    "hidden": false,
    "iceberg": false,
    "visibleSize": "0",
    "cancelAfter": 0,
    "channel": "API",
    "clientOid": "6d539dc614db312",
    "remark": "",
    "tags": "",
    "active": true,
    "inOrderBook": false,
    "cancelExist": false,
    "createdAt": 1547026471000,
    "lastUpdatedAt": 1547026471001,
    "tradeType": "MARGIN_TRADE"
  }
}
API KEY PERMISSIONS

This endpoint requires the General permission.

REQUEST URL

This endpoint support Spot URL

REQUEST RATE LIMIT

Spot weight:5

PARAMETERS
Param Type Mandatory Description
clientOid String Yes Path parameter,an identifier created by the client
symbol String Yes symbol, such as, ETH-BTC
RESPONSES
Param Description
id Order id,a unique identifier pertaining to the order
symbol Trading pair
opType Operation type: DEAL
type Order type
side Buy or sell
price Order price
size Order size
funds Order amount
dealFunds Number of filled funds
dealSize Number of filled transactions
fee Service fee
feeCurrency currency used to calculate fees
stp self trade prevention
timeInForce Time in force
postOnly Is it post only?
hidden Is it a hidden order?
iceberg Is it an iceberg order?
visibleSize Visible size of iceberg order in order book.
cancelAfter A GTT timeInForce that expires in n seconds
channel Source of orders
clientOid Identifier created by the client
remark Order description
tags Order identifier
active Order status: true-The status of the order isactive; false-The status of the order isdone
inOrderBook Whether to enter the orderbook: true: enter the orderbook; false: not enter the orderbook
cancelExist Are there any cancellation records pertaining to the order?
createdAt order creation time
lastUpdatedAt Last update time of order
tradeType Transaction type: MARGIN_TRADE - cross margin trading order, MARGIN_ISOLATED_TRADE - isolated margin trading order