This version (v0.7) has not been published to npm yet.
Skip to content

Reference / @getenginex/sdk-predictions / MarketOrderInput

MarketOrderInput ​

Market order: executes against the book immediately. price is optional and, when omitted, the SDK sends 0 (which is what the production player app sends). A non-zero price is interpreted by the predictions service, not by the gateway: use it only if you know what it does. When given, an integer from 0 to 99.

Extends ​

Properties ​

direction ​

direction: "buy" | "sell"

buy or sell.

Inherited from ​

OrderInputBase.direction


marketId ​

marketId: string

Market id.

Inherited from ​

OrderInputBase.marketId


orderType ​

orderType: "market"

Market order.


postOnly? ​

optional postOnly?: boolean

Rejects the order if it would cross the spread (only adds liquidity). Boolean.

Inherited from ​

OrderInputBase.postOnly


price? ​

optional price?: number

Optional; when omitted it goes as 0. When given, an integer from 0 to 99.


quantity ​

quantity: number

Quantity in contracts, an integer greater than zero.

Inherited from ​

OrderInputBase.quantity


reduceOnly? ​

optional reduceOnly?: boolean

The order can only reduce an existing position. Boolean.

Inherited from ​

OrderInputBase.reduceOnly


side ​

side: OutcomeSide

Market side: yes or no.

Inherited from ​

OrderInputBase.side


timeInForce? ​

optional timeInForce?: "gtc" | "ioc" | "fok"

gtc (default), ioc or fok.

Inherited from ​

OrderInputBase.timeInForce