Interface RestRequestOrderTypeMarketLPP

Orders with isLiquidationAcquisitionOnly set to true are only allowed for whitelisted wallets at this time. Please contact the Kuma team if you would like more details.

interface RestRequestOrderTypeMarketLPP {
    nonce: string;
    wallet: string;
    market: string;
    side: OrderSide;
    quantity: string;
    type: "market";
    isLiquidationAcquisitionOnly: true;
    delegatedKey?: string;
    clientOrderId?: string;
}

Hierarchy (view full)

Properties

nonce wallet market side quantity type isLiquidationAcquisitionOnly delegatedKey? clientOrderId?

Properties

nonce

nonce: string

User data and trade endpoints requests must include a nonce.

  • MUST be a version 1 UUID
  • Nonces may be supplied with or without hyphens.

Remarks

Version 1 UUIDs encode a timestamp in addition to other unique information, and thus serve both to prevent replay attacks as well as to enforce request timing. As a result, nonces MUST be generated at the time of a request.

wallet

wallet: string

The wallet address to use for the request.

market

market: string

Base-quote pair e.g. 'ETH-USD'

Readonly side

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

See

enum OrderSide

Readonly quantity

quantity: string

Order quantity in base terms

Readonly type

type: "market"
  • 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
 })

See

Readonly isLiquidationAcquisitionOnly

isLiquidationAcquisitionOnly: true

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

Optional delegatedKey

delegatedKey?: string

The delegated key to use for the request, if any.

Optional Readonly clientOrderId

clientOrderId?: string

Client-specified order id, maximum of 40 bytes

Settings

Member Visibility

Theme

On This Page

noncewalletmarketsidequantitytypeisLiquidationAcquisitionOnlydelegatedKeyclientOrderId