Get Order Details by clientOid

Request via this interface to check the information of a single active order via clientOid. The system will prompt that the order does not exists if the order does not exist or has been settled.

HTTP REQUEST

GET /api/v1/order/client-order/{clientOid}

Example

GET /api/v1/order/client-order/6d539dc614db312

{
  "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": "",
  "stop": "",
  "stopTriggered": false,
  "stopPrice": "0",
  "timeInForce": "GTC",
  "postOnly": false,
  "hidden": false,
  "iceberg": false,
  "visibleSize": "0",
  "cancelAfter": 0,
  "channel": "API",
  "clientOid": "6d539dc614db312",
  "remark": "",
  "tags": "",
  "isActive": true,
  "cancelExist": false,
  "createdAt": 1597051810000,
  "tradeType": "TRADE"
}

API KEY PERMISSIONS

This endpoint requires the General permission.

REQUEST URL

This endpoint support Spot URL

REQUEST RATE LIMIT

Spot weight：3

PARAMETERS

Param	Type	Mandatory	Description
clientOid	String	Yes	Unique order id created by users to identify their orders

RESPONSES

Param	Description
id	Order ID, the ID of an order
symbol	symbol
opType	operation type,deal is pending order,cancel is cancel order
type	order type,e.g. limit,market,stop_limit.
side	transaction direction,include buy and sell
price	order price
size	order quantity
funds	order funds
dealFunds	deal funds
dealSize	deal quantity
fee	fee
feeCurrency	charge fee currency
stp	self trade prevention,include CN,CO,DC,CB
stop	stop type, include entry and loss
stopTriggered	stop order is triggered
stopPrice	stop price
timeInForce	time InForce,include GTC,GTT,IOC,FOK
postOnly	postOnly
hidden	hidden order
iceberg	iceberg order
visibleSize	display quantity for iceberg order
cancelAfter	cancel orders time，requires timeInForce to be GTT
channel	order source
clientOid	user-entered order unique mark
remark	remark
tags	tag order source
isActive	order status, true and false. If true, the order is active, if false, the order is fillled or cancelled
cancelExist	order cancellation transaction record
createdAt	create time
tradeType	The type of trading : TRADE（Spot Trading）, MARGIN_TRADE (Margin Trading).