Add Stop Order

POST

https://api.kucoin.com/api/v1/stop-order

domain:Spot

api-channel:Private

api-permission:Spot

api-rate-limit-pool:Spot

sdk-service:Spot

sdk-sub-service:Order

sdk-method-name:addStopOrder

api-rate-limit-weight:1

Description

Place stop order to the Spot trading system. The maximum untriggered stop orders for a single trading pair in one account is 20.

Request

Body Params application/json

type

enum<string>

required

specify if the order is an 'limit' order or 'market' order.

The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine.

When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels.

Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged.

Allowed values:

limitmarket

Example:

limit

symbol

string

required

symbol

Examples:

BTC-USDTETH-USDTKCS-USDT

side

enum<string>

required

specify if the order is to 'buy' or 'sell'

Allowed values:

buysell

Example:

buy

clientOid

string

optional

Client Order Id，The ClientOid field is a unique ID created by the user（we recommend using a UUID）, and can only contain numbers, letters, underscores （_）, and hyphens （-）. This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.

Please remember the orderId created by the service provider, it used to check for updates in order status.

Example:

5c52e11203aa677f33e493fb

price

string

optional

Specify price for order, not need for market order.

When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error.

stp

enum<string>

optional

Self Trade Prevention is divided into four strategies: CN, CO, CB , and DC

Allowed values:

DCCOCNCB

stopPrice

string

required

The trigger price.

remark

string

optional

Order placement remarks, length cannot exceed 20 characters (ASCII)

timeInForce

enum<string>

optional

Time in force is a special strategy used during trading. Required for limit orders.

Allowed values:

GTCGTTIOCFOK

Default:

GTC

cancelAfter

integer <int64>

optional

Cancel after n seconds, the order timing strategy is GTT, -1 means it will not be cancelled automatically, the default value is -1

> 0< 2592000

Default:

-1

postOnly

boolean

optional

passive order labels, this is disabled when the order timing strategy is IOC or FOK if type is limit.

Default:

false

hidden

boolean

optional

Hidden order or not (not shown in order book)

Default:

false

iceberg

boolean

optional

Whether or not only visible portions of orders are shown in Iceberg orders

Default:

false

visibleSize

string

optional

When type is limit, this is Maximum visible quantity in iceberg orders.

size

string

optional

Specify quantity for order

When type is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize.

When type is market, select one out of two: size or funds

funds

string

optional

When type is market, select one out of two: size or funds

tradeType

string

optional

The type of trading : TRADE（Spot）, MARGIN_TRADE (Cross Margin), MARGIN_ISOLATED_TRADE (Isolated Margin). Default is TRADE

Example

//limit order
{
    "type": "limit",
    "symbol": "BTC-USDT",
    "side": "buy",
    "price": "50000",
    "stopPrice": "50000",
    "size": "0.00001",
    "clientOid": "5c52e11203aa677f33e493fb",
    "remark": "order remarks"
}

//market order 1
// {
//     "type": "market",
//     "symbol": "BTC-USDT",
//     "side": "buy",
//     "size": "0.00001",
//     "clientOid": "5c52e11203aa677f33e493fc",
//     "remark": "order remarks"
// }

//market order 2
// {
//     "type": "market",
//     "symbol": "BTC-USDT",
//     "side": "buy",
//     "funds": "1",
//     "clientOid": "5c52e11203aa677f33e493fc",
//     "remark": "order remarks"
// }

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.kucoin.com/api/v1/stop-order' \
--header 'Content-Type: application/json' \
--data-raw '//limit order
{
    "type": "limit",
    "symbol": "BTC-USDT",
    "side": "buy",
    "price": "50000",
    "stopPrice": "50000",
    "size": "0.00001",
    "clientOid": "5c52e11203aa677f33e493fb",
    "remark": "order remarks"
}

//market order 1
// {
//     "type": "market",
//     "symbol": "BTC-USDT",
//     "side": "buy",
//     "size": "0.00001",
//     "clientOid": "5c52e11203aa677f33e493fc",
//     "remark": "order remarks"
// }

//market order 2
// {
//     "type": "market",
//     "symbol": "BTC-USDT",
//     "side": "buy",
//     "funds": "1",
//     "clientOid": "5c52e11203aa677f33e493fc",
//     "remark": "order remarks"
// }'

Responses

🟢200OK

application/json

Body

code

string

required

data

object

required

orderId

string

required

The unique order id generated by the trading system,which can be used later for further actions such as canceling the order.

Example

{
  "code": "200000",
  "data": {
    "orderId": "670fd33bf9406e0007ab3945"
  }
}

Modified at 2025-03-20 08:01:47

Set DCP

Cancel Stop Order By ClientOid