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

Reference / @getenginex/sdk-predictions / Order

Order ​

A user's order. Monetary values in cents; price in cents per contract.

Properties ​

actualCost ​

actualCost: number

Effective cost of the executions.


actualFee ​

actualFee: number

Fee actually charged.


canceledAt? ​

optional canceledAt?: string

Cancellation (ISO 8601).


cancelReason ​

cancelReason: string

Reason for the cancellation, when there was one ('' otherwise).


collateralAmount ​

collateralAmount: number

Amount reserved as collateral.


collateralReleased ​

collateralReleased: number

Collateral already returned.


createdAt? ​

optional createdAt?: string

Creation (ISO 8601).


direction ​

direction: OrderDirection

Buy or sell.


estimatedFee ​

estimatedFee: number

Estimated fee.


filledAt? ​

optional filledAt?: string

Full execution (ISO 8601).


filledQuantity ​

filledQuantity: number

Quantity already executed.


id ​

id: string

Order id.


marketId ​

marketId: string

Market id.


marketTitle ​

marketTitle: string

Market title.


orderType ​

orderType: OrderType

Limit or market.


postOnly ​

postOnly: boolean

Whether the order only adds liquidity.


price ​

price: number

Price in cents per contract.


quantity ​

quantity: number

Quantity requested, in contracts.


reduceOnly ​

reduceOnly: boolean

Whether the order only reduces a position.


remainingQuantity ​

remainingQuantity: number

Quantity left to execute.


side ​

side: OrderSide

Market side.


status ​

status: OrderStatus

Status.


timeInForce ​

timeInForce: TimeInForce

Validity.