Skip to content

Interface: PredictionCreateData ​

Optional native participation and audience settings.

Extends ​

Properties ​

auto_cancel_after? ​

ts
optional auto_cancel_after?: number;

Seconds after lock before automatic cancellation/refund.

Default Value ​

ts
86400

betting_enabled? ​

ts
optional betting_enabled?: boolean;

Viewers bet channel currency (proportional payout).

Default Value ​

true


chat_betting_enabled? ​

ts
optional chat_betting_enabled?: boolean;

Allow viewers to participate via chat messages.

Default Value ​

true


chat_command? ​

ts
optional chat_command?: string;

Chat command (e.g. "!predict"), used as !predict <outcome> <amount>.

Default Value ​

"!predict"


fixed_reward? ​

ts
optional fixed_reward?: number;

Fixed reward paid to each winner when betting_enabled is false.


max_bet? ​

ts
optional max_bet?: number;

Maximum bet amount.


min_bet? ​

ts
optional min_bet?: number;

Minimum bet amount.


outcomes ​

ts
outcomes: string[];

Outcome labels (2 to 10).


participation_mode? ​

ts
optional participation_mode?: "native" | "app_only";

native: chat/viewer UI; app_only: only the owner installation's API.

Default Value ​

ts
'native'

Inherited from ​

NativeVoteCreateOptions.participation_mode


prediction_window? ​

ts
optional prediction_window?: number;

Seconds before participations are automatically locked; omit for manual lock only.


results_visibility? ​

ts
optional results_visibility?: "live" | "after_end";

Hide intermediate results from viewers and native display until final status. Streamer and owner retain access.

Default Value ​

ts
'live'

Inherited from ​

NativeVoteCreateOptions.results_visibility


show_display? ​

ts
optional show_display?: boolean;

Show the native overlay display; false = the app renders its own UI.

Default Value ​

true


title ​

ts
title: string;

Prediction question.