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

Reference / @getenginex/sdk-predictions / PredictionEvent

PredictionEvent ​

Predictions event: groups one or more markets about the same subject.

Properties ​

categoryId ​

categoryId: string

Category id.


categoryName ​

categoryName: string

Category name.


code? ​

optional code?: string

Base code defined by the operator, when present.


createdAt? ​

optional createdAt?: string

Creation (ISO 8601).


description ​

description: string

Description.


endTime? ​

optional endTime?: string

End (ISO 8601).


eventMakerFeeBps? ​

optional eventMakerFeeBps?: number

The event's maker fee, in basis points, when it overrides the market's.


eventTakerFeeBps? ​

optional eventTakerFeeBps?: number

The event's taker fee, in basis points, when it overrides the market's.


eventType ​

eventType: string

Event type (e.g. binary, me).


id ​

id: string

Event id.


imageUrl ​

imageUrl: string

Image URL ('' if none).


marketCount ​

marketCount: number

Number of markets.


mutuallyExclusive ​

mutuallyExclusive: boolean

Whether only one market of the event can resolve yes.


question ​

question: string

The event's question (e.g. Who wins?).


resolutionTime? ​

optional resolutionTime?: string

When the event is resolved (ISO 8601).


startTime? ​

optional startTime?: string

Start (ISO 8601).


status ​

status: EventStatus

Status.


tags ​

tags: string[]

Tags.


ticker? ​

optional ticker?: string

Readable ticker, when present.


title ​

title: string

Title.


topMarkets? ​

optional topMarkets?: Market[]

The highest-volume markets (for listing cards), when the gateway sends them.


totalVolume ​

totalVolume: number

Total volume, in cents.


updatedAt? ​

optional updatedAt?: string

Last update (ISO 8601).