Interface MarketSettlement

A market's settlement, from read.settlement. Pass settlementPriceRaw and tickSizeRaw to cost.settledPayout to show what a position paid.

interface MarketSettlement {
    expiryMs: bigint;
    marketId: string;
    settled: boolean;
    settlementPrice: number | null;
    settlementPriceRaw: bigint | null;
    tickSizeRaw: bigint;
}

Properties

expiryMs: bigint

marketId: string

settled: boolean

Whether Predict has recorded the settlement price.

settlementPrice: number | null

The settlement price in USD, or null until the market settles.

settlementPriceRaw: bigint | null

The settlement price at the 1e9 price scale, or null until the market settles.

tickSizeRaw: bigint

The market's raw tick size, which cost.settledPayout rounds the price against.