Expand description
Kalshi REST API models.
Structs§
- Account
Limits - Account token limits; enforcement belongs to the shared budget owner.
- Amend
Order Response - A V2 amend acknowledgement.
- Balance
- Subaccount collateral; integer amounts use venue cents.
- Batch
Cancel Order - One independent batch-cancel outcome.
- Batch
Cancel Response - Independent selected-ID batch-cancel results.
- Batch
Create Order - One independent batch-create outcome, including venue rejection evidence.
- Batch
Create Response - Independent batch-create results.
- BidAsk
Distribution - Bid or ask candle prices.
- Book
Side Iter - An iterator over the variants of BookSide
- Bucket
Limit - Token-bucket refill and capacity advertised by the venue.
- Cancel
Order Response - A V2 cancellation acknowledgement.
- Candlestick
- One candle; the period end is Unix time in seconds.
- Candlesticks
Response - A live market’s candles.
- Create
Order Response - A V2 create acknowledgement; absent average prices do not imply zero.
- Decimal
Number - An exact JSON number decoded from its source text without a binary float conversion.
- Decrease
Order Response - A V2 decrease acknowledgement.
- Endpoint
Cost - An endpoint’s advertised token cost.
- Endpoint
Costs - Default and endpoint-specific token costs.
- Event
- Event identity and collateral metadata, with optional nested markets.
- Event
Position - Event-level position economics.
- Event
Response - An event response, including the separately returned markets.
- Events
Response - A paginated events response.
- Exchange
Index Status - Availability of one exchange shard.
- Exchange
Status - Public exchange availability, including per-shard state when supplied.
- Fill
- A private fill with stable fill, trade, and order identities.
- Fills
Response - A paginated private fills response.
- Fixed
Point - A fixed-point wire string, retaining its exact decimal value and scale.
- Historical
BidAsk Distribution - Archived bid/ask prices use unsuffixed dollar fields.
- Historical
Candlestick - An archived candle with exact unsuffixed count strings.
- Historical
Candlesticks Response - An archived market’s candles.
- Historical
Cutoff - Archive partition cutoffs as exact timestamps.
- Historical
Price Distribution - Archived trade prices are required nullable dollar fields.
- Indexed
Balance - Dollar collateral for one exchange shard.
- Market
- Raw market metadata and exact quote, volume, and settlement values.
- Market
Position - Signed market position and exact economics, without an inferred entry price.
- Market
Response - A market response envelope.
- Markets
Response - A paginated markets response.
- Order
- A raw order report retaining exact costs, fees, and canonical sides.
- Order
Response - A single order report envelope.
- Order
Status Iter - An iterator over the variants of OrderStatus
- Orderbook
- Fixed-point YES and NO bid levels, each encoded as price and count.
- Orderbook
Response - A REST order-book envelope.
- Orders
Response - A paginated orders response.
- Outcome
Side Iter - An iterator over the variants of OutcomeSide
- Position
Pages - Collected market/event positions and explicit pagination completeness.
- Positions
Response - Market and event positions from one live or archived page.
- Price
Distribution - Trade candle prices; missing and null prices remain distinct.
- Price
Range - A fixed-point market price-grid interval.
- Self
Trade Prevention Iter - An iterator over the variants of SelfTradePrevention
- Series
- Series metadata used by discovery and fee qualification.
- Series
List Response - An unpaginated series response.
- Series
Response - A series response envelope.
- Settlement
- A settlement record still available in the live tier.
- Settlement
Source - Provider settlement-source reference.
- Settlements
Response - A paginated settlements response.
- Time
InForce Iter - An iterator over the variants of TimeInForce
- Trade
- Public trade with canonical taker-side fields.
- Trades
Response - A paginated trades response.
- Usage
Grant - A provider usage-level grant.
- Venue
Error - Provider error fields. Diagnostics must redact their potentially private values.
Enums§
- Book
Side - The YES-price order-book side.
- Field
- A wire field whose absence differs from explicit null and from a value.
- Order
Status - A venue order state; unknown states require explicit domain rejection.
- Outcome
Side - The contract outcome side.
- Self
Trade Prevention - Self-trade prevention policy accepted by V2 orders.
- Time
InForce - V2 time in force; expiration uses good-till-canceled with a timestamp.