Skip to main content

Module models

Module models 

Source
Expand description

Kalshi REST API models.

Structs§

AccountLimits
Account token limits; enforcement belongs to the shared budget owner.
AmendOrderResponse
A V2 amend acknowledgement.
Balance
Subaccount collateral; integer amounts use venue cents.
BatchCancelOrder
One independent batch-cancel outcome.
BatchCancelResponse
Independent selected-ID batch-cancel results.
BatchCreateOrder
One independent batch-create outcome, including venue rejection evidence.
BatchCreateResponse
Independent batch-create results.
BidAskDistribution
Bid or ask candle prices.
BookSideIter
An iterator over the variants of BookSide
BucketLimit
Token-bucket refill and capacity advertised by the venue.
CancelOrderResponse
A V2 cancellation acknowledgement.
Candlestick
One candle; the period end is Unix time in seconds.
CandlesticksResponse
A live market’s candles.
CreateOrderResponse
A V2 create acknowledgement; absent average prices do not imply zero.
DecimalNumber
An exact JSON number decoded from its source text without a binary float conversion.
DecreaseOrderResponse
A V2 decrease acknowledgement.
EndpointCost
An endpoint’s advertised token cost.
EndpointCosts
Default and endpoint-specific token costs.
Event
Event identity and collateral metadata, with optional nested markets.
EventPosition
Event-level position economics.
EventResponse
An event response, including the separately returned markets.
EventsResponse
A paginated events response.
ExchangeIndexStatus
Availability of one exchange shard.
ExchangeStatus
Public exchange availability, including per-shard state when supplied.
Fill
A private fill with stable fill, trade, and order identities.
FillsResponse
A paginated private fills response.
FixedPoint
A fixed-point wire string, retaining its exact decimal value and scale.
HistoricalBidAskDistribution
Archived bid/ask prices use unsuffixed dollar fields.
HistoricalCandlestick
An archived candle with exact unsuffixed count strings.
HistoricalCandlesticksResponse
An archived market’s candles.
HistoricalCutoff
Archive partition cutoffs as exact timestamps.
HistoricalPriceDistribution
Archived trade prices are required nullable dollar fields.
IndexedBalance
Dollar collateral for one exchange shard.
Market
Raw market metadata and exact quote, volume, and settlement values.
MarketPosition
Signed market position and exact economics, without an inferred entry price.
MarketResponse
A market response envelope.
MarketsResponse
A paginated markets response.
Order
A raw order report retaining exact costs, fees, and canonical sides.
OrderResponse
A single order report envelope.
OrderStatusIter
An iterator over the variants of OrderStatus
Orderbook
Fixed-point YES and NO bid levels, each encoded as price and count.
OrderbookResponse
A REST order-book envelope.
OrdersResponse
A paginated orders response.
OutcomeSideIter
An iterator over the variants of OutcomeSide
PositionPages
Collected market/event positions and explicit pagination completeness.
PositionsResponse
Market and event positions from one live or archived page.
PriceDistribution
Trade candle prices; missing and null prices remain distinct.
PriceRange
A fixed-point market price-grid interval.
SelfTradePreventionIter
An iterator over the variants of SelfTradePrevention
Series
Series metadata used by discovery and fee qualification.
SeriesListResponse
An unpaginated series response.
SeriesResponse
A series response envelope.
Settlement
A settlement record still available in the live tier.
SettlementSource
Provider settlement-source reference.
SettlementsResponse
A paginated settlements response.
TimeInForceIter
An iterator over the variants of TimeInForce
Trade
Public trade with canonical taker-side fields.
TradesResponse
A paginated trades response.
UsageGrant
A provider usage-level grant.
VenueError
Provider error fields. Diagnostics must redact their potentially private values.

Enums§

BookSide
The YES-price order-book side.
Field
A wire field whose absence differs from explicit null and from a value.
OrderStatus
A venue order state; unknown states require explicit domain rejection.
OutcomeSide
The contract outcome side.
SelfTradePrevention
Self-trade prevention policy accepted by V2 orders.
TimeInForce
V2 time in force; expiration uses good-till-canceled with a timestamp.