Interface RestRequestOrderBase

• When specifying, using the OrderType enum is recommended for inline docs and convenience.

Example

 import { OrderType } from '@kumabid/kuma-sdk'

 const response = await client.createOrder({
   // whichever order type you are creating
   type: OrderType.market,
   // ...other params
 })
Copy

See

• docs API Documentation: Order Types
• enum OrderType

• When specifying, using the OrderSide enum is recommended for inline docs and convenience.

See

enum OrderSide

Order quantity in base terms

Client-specified order id, maximum of 40 bytes

Reduce only orders are only accepted opposite open positions and only reduce an opposite position’s size

• When specifying, using the TimeInForce enum is recommended for inline docs and convenience.
• isLiquidationAcquisitionOnly limit orders must have timeInForce set to TimeInForce.gtx
• Defaults to TimeInForce.gtc

See

enum TimeInForce

Default Value

TimeInForce.gtc
Copy

Self-trade prevention policy, see enum links

• When specifying, using the SelfTradePrevention enum is recommended for inline docs and convenience.
• MUST be SelfTradePrevention.cn if TimeInForce.fok is specified for the timeInForce property.
• For isLiquidationAcquisitionOnly OrderType.limit orders, selfTradePrevention must be omitted or its default value of SelfTradePrevention.dc.

See

enum SelfTradePrevention

Default Value

SelfTradePrevention.dc
Copy

Only allowed for certain order types mentioned below, omitted otherwise.

• Stop loss or take profit price for order types:

  • stopLossMarket
  • stopLossLimit
  • takeProfitMarket
  • takeProfitLimit

• Activation price for order types:

  • trailingStopMarket

See

enum OrderType

Price type for the triggerPrice

• When specifying, using the TriggerType enum is recommended for inline docs and convenience.
• Required when triggerPrice is defined.

See

enum TriggerType

Order price in quote terms

• Required for all limit order types.
• Omitted for all market order types.

See

enum OrderType

When this parameter is true it indicates that the order is an LP side channel order not to be executed against the order book.

• Wallet placing the order MUST BE WHITELISTED. Contact the Kuma team for more details.
• This parameter is only allowed to be true on market and limit order types.
• In the case of limit orders, timeInForce must be TimeInForce.gtc indicating that side channel orders never take liquidity.
• reduceOnly and selfTradePrevention parameters may be omitted or set to their default values only.

See

• enum OrderType
• enum TimeInForce