Interface RestRequestOrderTypeLimit

interface RestRequestOrderTypeLimit {
    nonce: string;
    wallet: string;
    market: string;
    side: OrderSide;
    quantity: string;
    type: "limit";
    price: string;
    delegatedKey?: string;
    clientOrderId?: string;
    reduceOnly?: boolean;
    timeInForce?: TimeInForce;
    selfTradePrevention?: SelfTradePrevention;
}

Hierarchy (view full)

Properties

nonce wallet market side quantity type price delegatedKey? clientOrderId? reduceOnly? timeInForce? selfTradePrevention?

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: "limit"
  • 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 price

price: string

Order price in quote terms

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

See

enum OrderType

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

Optional Readonly reduceOnly

reduceOnly?: boolean

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

Optional Readonly timeInForce

timeInForce?: TimeInForce

See

enum TimeInForce

Default Value

TimeInForce.gtc

Optional Readonly selfTradePrevention

selfTradePrevention?: SelfTradePrevention

Self-trade prevention policy, see enum links

See

enum SelfTradePrevention

Default Value

SelfTradePrevention.dc

Settings

Member Visibility

Theme

On This Page

noncewalletmarketsidequantitytypepricedelegatedKeyclientOrderIdreduceOnlytimeInForceselfTradePrevention