Get Stop Orders List

Request via this endpoint to get your current untriggered stop order list. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.

HTTP REQUEST

GET /api/v1/stop-order

Example

GET /api/v1/stop-order

{
  "currentPage": 1,
  "pageSize": 50,
  "totalNum": 1,
  "totalPage": 1,
  "items": [
    {
      "id": "vs8hoo8kqjnklv4m0038lrfq",
      "symbol": "KCS-USDT",
      "userId": "60fe4956c43cbc0006562c2c",
      "status": "NEW",
      "type": "limit",
      "side": "buy",
      "price": "0.01000000000000000000",
      "size": "0.01000000000000000000",
      "funds": null,
      "stp": null,
      "timeInForce": "GTC",
      "cancelAfter": -1,
      "postOnly": false,
      "hidden": false,
      "iceberg": false,
      "visibleSize": null,
      "channel": "API",
      "clientOid": "404814a0fb4311eb9098acde48001122",
      "remark": null,
      "tags": null,
      "orderTime": 1628755183702150167,
      "domainId": "kucoin",
      "tradeSource": "USER",
      "tradeType": "TRADE",
      "feeCurrency": "USDT",
      "takerFeeRate": "0.00200000000000000000",
      "makerFeeRate": "0.00200000000000000000",
      "createdAt": 1628755183704,
      "stop": "loss",
      "stopTriggerTime": null,
      "stopPrice": "10.00000000000000000000"
    }
  ]
}

API KEY PERMISSIONS

This endpoint requires the General permission.

REQUEST URL

This endpoint support Spot URL

REQUEST RATE LIMIT

Spot weight：8

PARAMETERS

Param	Type	Mandatory	Description
symbol	String	No	Only list orders for a specific symbol.
side	String	No	buy or sell
type	String	No	limit, market, limit_stop or market_stop
tradeType	String	No	The type of trading : TRADE（Spot）, MARGIN_TRADE (Cross Margin), MARGIN_ISOLATED_TRADE (Isolated Margin). Default is TRADE
startAt	long	No	Start time (milisecond)
endAt	long	No	End time (milisecond)
currentPage	Int	No	current page
orderIds	String	No	comma seperated order ID list
pageSize	Int	No	page size
stop	Int	No	Order type: stop: stop loss order, oco: oco order

RESPONSES

Param	Description
id	Order ID, the ID of an order.
symbol	Symbol
userId	User ID
status	Order status, include NEW, TRIGGERED
type	Order type
side	transaction direction,include buy and sell
price	order price
size	order quantity
funds	order funds
stp	self trade prevention
timeInForce	time InForce,include GTC,GTT,IOC,FOK
cancelAfter	cancel orders after n seconds，requires timeInForce to be GTT
postOnly	postOnly
hidden	hidden order
iceberg	Iceberg order
visibleSize	displayed quantity for iceberg order
channel	order source
clientOid	user-entered order unique mark
remark	Remarks
tags	tag order source
orderTime	Time of place a stop order, accurate to nanoseconds
domainId	domainId, e.g: kucoin
tradeSource	trade source: USER（Order by user）, MARGIN_SYSTEM（Order by margin system）
tradeType	The type of trading : TRADE（Spot）, MARGIN_TRADE (Cross Margin), MARGIN_ISOLATED_TRADE (Isolated Margin).
feeCurrency	The currency of the fee
takerFeeRate	Fee Rate of taker
makerFeeRate	Fee Rate of maker
createdAt	order creation time
stop	Stop order type, include loss and entry
stopTriggerTime	The trigger time of the stop order
stopPrice	stop price