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

Reference / @getenginex/sdk-predictions / Position

Position ​

A user's position on one side of a market. Monetary values in cents.

Properties ​

avgPrice ​

avgPrice: number

Average price, in cents.


createdAt? ​

optional createdAt?: string

Creation (ISO 8601).


currentPrice ​

currentPrice: number

Current price of the side, in cents.


currentValue ​

currentValue: number

Current value.


eventId ​

eventId: string

Event id of the market.


eventStatus ​

eventStatus: EventStatus

Event status.


id ​

id: string

Position id.


lastPrice ​

lastPrice: number

Last traded price, in cents.


marketId ​

marketId: string

Market id.


marketResolution? ​

optional marketResolution?: MarketResolution

Market outcome, when resolved.


marketResolvedAt? ​

optional marketResolvedAt?: string

When the market was resolved (ISO 8601).


marketStatus ​

marketStatus: MarketStatus

Market status.


marketTitle ​

marketTitle: string

Market title.


quantity ​

quantity: number

Contracts.


realizedPnl ​

realizedPnl: number

Realized profit or loss.


settledAt? ​

optional settledAt?: string

Settlement (ISO 8601).


settlementAmount ​

settlementAmount: number

Amount paid at settlement (0 before it).


side ​

side: OrderSide

Side.


status ​

status: PositionStatus

Status.


totalCost ​

totalCost: number

Total cost.


trades? ​

optional trades?: PositionTrade[]

Executions that make up the position (only when the gateway sends them).


unrealizedPnl ​

unrealizedPnl: number

Unrealized profit or loss.


updatedAt? ​

optional updatedAt?: string

Last update (ISO 8601).