Skip to main content

Module enums

Module enums 

Source
Expand description

Kalshi venue enums mirrored from REST and WebSocket payloads.

Enums with an Other variant retain unrecognized wire labels for admission checks and persistence. Closed enums, including request filters, reject undocumented wire values.

Structs§

ApiKeyScopeIter
An iterator over the variants of ApiKeyScope
ApiKeyTypeIter
An iterator over the variants of ApiKeyType
ApiUsageTierIter
An iterator over the variants of ApiUsageTier
CandlestickIntervalIter
An iterator over the variants of CandlestickInterval
CfBenchmarksUpdateActionIter
An iterator over the variants of CfBenchmarksUpdateAction
CollateralReturnTypeIter
An iterator over the variants of CollateralReturnType
CreditStatusIter
An iterator over the variants of CreditStatus
EventStatusFilterIter
An iterator over the variants of EventStatusFilter
ExchangeInstanceIter
An iterator over the variants of ExchangeInstance
ExitSlippageUnitIter
An iterator over the variants of ExitSlippageUnit
ExitTriggerKindIter
An iterator over the variants of ExitTriggerKind
ExitTriggerLegIter
An iterator over the variants of ExitTriggerLeg
ExitTriggerStatusIter
An iterator over the variants of ExitTriggerStatus
FeeTypeIter
An iterator over the variants of FeeType
ForecastIntervalIter
An iterator over the variants of ForecastInterval
IncentiveStatusFilterIter
An iterator over the variants of IncentiveStatusFilter
IncentiveTypeFilterIter
An iterator over the variants of IncentiveTypeFilter
IncentiveTypeIter
An iterator over the variants of IncentiveType
KalshiCommandKindIter
An iterator over the variants of KalshiCommandKind
KalshiEnvironmentIter
An iterator over the variants of KalshiEnvironment
KalshiWsErrorCodeIter
An iterator over the variants of KalshiWsErrorCode
MarketIndexStatusIter
An iterator over the variants of MarketIndexStatus
MarketLifecycleEventIter
An iterator over the variants of MarketLifecycleEvent
MarketResultIter
An iterator over the variants of MarketResult
MarketStatusFilterIter
An iterator over the variants of MarketStatusFilter
MarketStatusIter
An iterator over the variants of MarketStatus
MarketTypeIter
An iterator over the variants of MarketType
MultivariateCollectionStatusIter
An iterator over the variants of MultivariateCollectionStatus
MultivariateMarketLifecycleEventIter
An iterator over the variants of MultivariateMarketLifecycleEvent
MveFilterIter
An iterator over the variants of MveFilter
MveHistoricalFilterIter
An iterator over the variants of MveHistoricalFilter
OrderActionIter
An iterator over the variants of OrderAction
OrderGroupEventIter
An iterator over the variants of OrderGroupEvent
OrderStatusFilterIter
An iterator over the variants of OrderStatusFilter
OrderTypeIter
An iterator over the variants of OrderType
OrderUpdateReasonIter
An iterator over the variants of OrderUpdateReason
OrderbookUpdateIntervalIter
An iterator over the variants of OrderbookUpdateInterval
PaymentStatusIter
An iterator over the variants of PaymentStatus
PaymentTypeIter
An iterator over the variants of PaymentType
PositionCountFilterIter
An iterator over the variants of PositionCountFilter
PositionSettlementStatusIter
An iterator over the variants of PositionSettlementStatus
PriceLevelStructureIter
An iterator over the variants of PriceLevelStructure
PythUpdateActionIter
An iterator over the variants of PythUpdateAction
QuoteStatusIter
An iterator over the variants of QuoteStatus
RestingMarginReservationIter
An iterator over the variants of RestingMarginReservation
RfqBatchQuoteStatusIter
An iterator over the variants of RfqBatchQuoteStatus
RfqBatchStatusIter
An iterator over the variants of RfqBatchStatus
RfqStatusIter
An iterator over the variants of RfqStatus
SettlementBoundsTypeIter
An iterator over the variants of SettlementBoundsType
StrikeTypeIter
An iterator over the variants of StrikeType
TransferStatusIter
An iterator over the variants of TransferStatus
UsageGrantSourceIter
An iterator over the variants of UsageGrantSource
UserFilterIter
An iterator over the variants of UserFilter

Enums§

ApiKeyScope
Scope granted to an API key.
ApiKeyType
API request signature algorithm.
ApiUsageTier
Published API usage tier; unrecognized tiers retain conservative quota handling.
CandlestickInterval
Candlestick duration in minutes.
CfBenchmarksUpdateAction
CF Benchmarks subscription update action.
CollateralReturnType
Event collateral netting scheme; an empty value disables netting.
CreditStatus
Credit processing state.
EventStatusFilter
Event discovery status filter.
ExchangeInstance
Exchange lane attached to an API usage grant.
ExitSlippageUnit
Unit of an event-contract exit slippage limit.
ExitTriggerKind
Event-contract exit trigger kind.
ExitTriggerLeg
Exit bracket leg that triggers execution.
ExitTriggerStatus
Event-contract exit trigger state.
FeeType
Series fee model or event override; unrecognized labels remain available for qualification.
ForecastInterval
Forecast history interval; zero selects five-second samples.
IncentiveStatusFilter
Incentive program status filter.
IncentiveType
Incentive program reward type.
IncentiveTypeFilter
Incentive program type filter.
KalshiCommandKind
WebSocket client command name.
KalshiEnvironment
Kalshi API environment.
KalshiWsErrorCode
Documented WebSocket error code; retired codes remain reserved.
MarketIndexStatus
Market index session and freshness state.
MarketLifecycleEvent
Market lifecycle notification kind.
MarketResult
Market settlement outcome; an empty value means no result.
MarketStatus
Market lifecycle state returned in metadata.
MarketStatusFilter
Market discovery status filter, distinct from response lifecycle states.
MarketType
Venue market type; unsupported families remain available for admission checks.
MultivariateCollectionStatus
Multivariate event collection status filter.
MultivariateMarketLifecycleEvent
Multivariate market lifecycle notification kind.
MveFilter
Multivariate market inclusion in live discovery.
MveHistoricalFilter
Multivariate market exclusion in archived discovery.
OrderAction
Legacy REST and WebSocket order action; an empty value means unknown.
OrderGroupEvent
Order-group lifecycle notification kind.
OrderStatusFilter
Order report status filter.
OrderType
Venue order type retained in order reports.
OrderUpdateReason
Reason for the most recent private order update.
OrderbookUpdateInterval
Order-book conflation interval in milliseconds; zero disables conflation.
PaymentStatus
Deposit or withdrawal processing state.
PaymentType
Deposit or withdrawal payment method.
PositionCountFilter
Position field required to have a nonzero value.
PositionSettlementStatus
Settlement state selected by position queries.
PriceLevelStructure
Venue price-grid label; price ranges define the actual valid ticks.
PythUpdateAction
Pyth subscription update action.
QuoteStatus
Request-for-quote quote state; cancellation uses the venue spelling.
RestingMarginReservation
Collateral reservation for resting orders during automatic rebalancing.
RfqBatchQuoteStatus
Request-for-quote batch quote state.
RfqBatchStatus
Request-for-quote batch state.
RfqStatus
Request-for-quote state.
SettlementBoundsType
Settlement bounds applied to a market.
StrikeType
Market strike evaluation rule.
TransferStatus
Intra-exchange-instance transfer state.
UsageGrantSource
Origin of an API usage-level grant.
UserFilter
Communications creator filter; an empty value selects all users.