Data Models Reference¶
This page documents all the data models used in the Kalshi Python client.
Core Models¶
GithubComKalshiExchangeInfraCommonExchangeMetadataDailySchedule¶
kalshi_py.models.github_com_kalshi_exchange_infra_common_exchange_metadata_daily_schedule.GithubComKalshiExchangeInfraCommonExchangeMetadataDailySchedule
¶
Attributes:
| Name | Type | Description |
|---|---|---|
close_time |
Union[Unset, str]
|
Closing time in ET (Eastern Time) format HH:MM. |
open_time |
Union[Unset, str]
|
Opening time in ET (Eastern Time) format HH:MM. |
GithubComKalshiExchangeInfraCommonExchangeMetadataSchedule¶
kalshi_py.models.github_com_kalshi_exchange_infra_common_exchange_metadata_schedule.GithubComKalshiExchangeInfraCommonExchangeMetadataSchedule
¶
GithubComKalshiExchangeInfraCommonExchangeMetadataScheduleMaintenanceWindowsItem¶
kalshi_py.models.github_com_kalshi_exchange_infra_common_exchange_metadata_schedule_maintenance_windows_item.GithubComKalshiExchangeInfraCommonExchangeMetadataScheduleMaintenanceWindowsItem
¶
Attributes:
| Name | Type | Description |
|---|---|---|
end_datetime |
Union[Unset, datetime]
|
End date and time of the maintenance window. |
start_datetime |
Union[Unset, datetime]
|
Start date and time of the maintenance window. |
GithubComKalshiExchangeInfraCommonExchangeMetadataScheduleStandardHoursItem¶
kalshi_py.models.github_com_kalshi_exchange_infra_common_exchange_metadata_schedule_standard_hours_item.GithubComKalshiExchangeInfraCommonExchangeMetadataScheduleStandardHoursItem
¶
Attributes:
| Name | Type | Description |
|---|---|---|
end_time |
Union[Unset, datetime]
|
End date and time for when this weekly schedule is no longer effective. |
friday |
Union[Unset, list[GithubComKalshiExchangeInfraCommonExchangeMetadataDailySchedule]]
|
Trading hours for Friday. May contain multiple sessions. |
saturday |
Union[Unset, list[GithubComKalshiExchangeInfraCommonExchangeMetadataDailySchedule]]
|
Trading hours for Saturday. May contain multiple sessions. |
start_time |
Union[Unset, datetime]
|
Start date and time for when this weekly schedule is effective. |
sunday |
Union[Unset, list[GithubComKalshiExchangeInfraCommonExchangeMetadataDailySchedule]]
|
Trading hours for Sunday. May contain multiple sessions. |
thursday |
Union[Unset, list[GithubComKalshiExchangeInfraCommonExchangeMetadataDailySchedule]]
|
Trading hours for Thursday. May contain multiple sessions. |
tuesday |
Union[Unset, list[GithubComKalshiExchangeInfraCommonExchangeMetadataDailySchedule]]
|
Trading hours for Tuesday. May contain multiple sessions. |
wednesday |
Union[Unset, list[GithubComKalshiExchangeInfraCommonExchangeMetadataDailySchedule]]
|
Trading hours for Wednesday. May contain multiple sessions. |
GithubComKalshiExchangeInfraCommonExchangeMetadataScheduleStandardHoursItemMondayItem¶
kalshi_py.models.github_com_kalshi_exchange_infra_common_exchange_metadata_schedule_standard_hours_item_monday_item.GithubComKalshiExchangeInfraCommonExchangeMetadataScheduleStandardHoursItemMondayItem
¶
Attributes:
| Name | Type | Description |
|---|---|---|
close_time |
Union[Unset, str]
|
Closing time in ET (Eastern Time) format HH:MM. |
open_time |
Union[Unset, str]
|
Opening time in ET (Eastern Time) format HH:MM. |
GithubComKalshiExchangeInfraCommonUnimodelProductMetadata¶
kalshi_py.models.github_com_kalshi_exchange_infra_common_unimodel_product_metadata.GithubComKalshiExchangeInfraCommonUnimodelProductMetadata
¶
ModelEmptyResponse¶
kalshi_py.models.model_empty_response.ModelEmptyResponse
¶
ModelGetExchangeAnnouncementsResponse¶
kalshi_py.models.model_get_exchange_announcements_response.ModelGetExchangeAnnouncementsResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
announcements |
Union[Unset, list[ModelGetExchangeAnnouncementsResponseAnnouncementsItem]]
|
A list of exchange-wide announcements. |
ModelGetExchangeAnnouncementsResponseAnnouncementsItem¶
kalshi_py.models.model_get_exchange_announcements_response_announcements_item.ModelGetExchangeAnnouncementsResponseAnnouncementsItem
¶
Attributes:
| Name | Type | Description |
|---|---|---|
delivery_time |
Union[Unset, datetime]
|
The time the announcement was delivered. |
message |
Union[Unset, str]
|
The message contained within the announcement. |
status |
Union[Unset, str]
|
|
type_ |
Union[Unset, str]
|
|
ModelGetExchangeScheduleResponse¶
kalshi_py.models.model_get_exchange_schedule_response.ModelGetExchangeScheduleResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
schedule |
Union[Unset, GithubComKalshiExchangeInfraCommonExchangeMetadataSchedule]
|
|
ModelGetMilestoneResponse¶
kalshi_py.models.model_get_milestone_response.ModelGetMilestoneResponse
¶
ModelGetMilestonesResponse¶
kalshi_py.models.model_get_milestones_response.ModelGetMilestonesResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
cursor |
Union[Unset, str]
|
Cursor for pagination. |
milestones |
Union[Unset, list[ModelMilestone]]
|
List of milestones. |
ModelGetRFQsResponse¶
kalshi_py.models.model_get_rf_qs_response.ModelGetRFQsResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
cursor |
Union[Unset, str]
|
Cursor for pagination to get the next page of results. |
rfqs |
Union[Unset, list[ModelGetRFQsResponseRfqsItem]]
|
List of RFQs matching the query criteria. |
ModelGetSettlementsResponse¶
kalshi_py.models.model_get_settlements_response.ModelGetSettlementsResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
cursor |
Union[Unset, str]
|
The Cursor represents a pointer to the next page of records in the pagination. Use the value returned here in the cursor query parameter for this end-point to get the next page containing limit records. An empty value of this field indicates there is no next page. |
settlements |
Union[Unset, list[ModelGetSettlementsResponseSettlementsItem]]
|
Settlement summaries for all markets the user participated in. |
ModelGetSettlementsResponseSettlementsItem¶
kalshi_py.models.model_get_settlements_response_settlements_item.ModelGetSettlementsResponseSettlementsItem
¶
Attributes:
| Name | Type | Description |
|---|---|---|
market_result |
Union[Unset, ModelGetSettlementsResponseSettlementsItemMarketResult]
|
The outcome of the market settlement ('yes' or 'no'). |
no_count |
Union[Unset, int]
|
Number of NO contracts owned at the time of settlement. |
no_total_cost |
Union[Unset, int]
|
|
revenue |
Union[Unset, int]
|
|
settled_time |
Union[Unset, Any]
|
|
ticker |
Union[Unset, str]
|
The ticker symbol of the market that was settled. |
yes_count |
Union[Unset, int]
|
Number of YES contracts owned at the time of settlement. |
yes_total_cost |
Union[Unset, int]
|
|
ModelGetStructuredTargetResponse¶
kalshi_py.models.model_get_structured_target_response.ModelGetStructuredTargetResponse
¶
ModelGetStructuredTargetsResponse¶
kalshi_py.models.model_get_structured_targets_response.ModelGetStructuredTargetsResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
cursor |
Union[Unset, str]
|
Pagination cursor for the next page. Empty if there are no more results. |
structured_targets |
Union[Unset, list[ModelStructuredTarget]]
|
Array of structured targets matching the query criteria. |
ModelPublicTradesGetResponse¶
kalshi_py.models.model_public_trades_get_response.ModelPublicTradesGetResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
cursor |
Union[Unset, str]
|
The Cursor represents a pointer to the next page of records in the pagination. Use the value returned here in the cursor query parameter for this end-point to get the next page containing limit records. An empty value of this field indicates there is no next page. |
trades |
Union[Unset, list[ModelPublicTrade]]
|
|
Market Models¶
EventPosition¶
kalshi_py.models.event_position.EventPosition
¶
Attributes:
| Name | Type | Description |
|---|---|---|
event_exposure |
Union[Unset, int]
|
|
event_exposure_dollars |
Union[Unset, list[int]]
|
|
event_ticker |
Union[Unset, str]
|
Unique identifier for events. |
fees_paid |
Union[Unset, int]
|
|
fees_paid_dollars |
Union[Unset, list[int]]
|
|
realized_pnl |
Union[Unset, int]
|
|
realized_pnl_dollars |
Union[Unset, list[int]]
|
|
resting_order_count |
Union[Unset, int]
|
Aggregate size of resting orders in contract units. |
total_cost |
Union[Unset, int]
|
|
total_cost_dollars |
Union[Unset, list[int]]
|
|
GithubComKalshiExchangeInfraSvcApi2ModelMarket¶
kalshi_py.models.github_com_kalshi_exchange_infra_svc_api_2_model_market.GithubComKalshiExchangeInfraSvcApi2ModelMarket
¶
Contains information about a market
Attributes:
| Name | Type | Description |
|---|---|---|
ticker |
str
|
Unique identifier for markets |
event_ticker |
str
|
Unique identifier for events |
market_type |
str
|
Type of market (binary, scalar) |
subtitle |
str
|
Shortened title for this market |
yes_sub_title |
str
|
Shortened title for the yes side |
no_sub_title |
str
|
Shortened title for the no side |
open_time |
datetime
|
Time when trading begins |
close_time |
datetime
|
Time when trading ends |
expiration_time |
datetime
|
Time when market expires |
latest_expiration_time |
datetime
|
Latest possible expiration time |
settlement_timer_seconds |
int
|
Settlement timer in seconds |
status |
str
|
Current market status |
response_price_units |
str
|
Price units for response |
notional_value |
int
|
Notional value of contract |
tick_size |
int
|
Minimum price movement |
yes_bid |
int
|
Highest YES buy offer price |
yes_ask |
int
|
Lowest YES sell offer price |
no_bid |
int
|
Highest NO buy offer price |
no_ask |
int
|
Lowest NO sell offer price |
last_price |
int
|
Last traded price |
previous_yes_bid |
int
|
Previous YES bid price |
previous_yes_ask |
int
|
Previous YES ask price |
previous_price |
int
|
Previous traded price |
volume |
int
|
Trading volume |
volume_24h |
int
|
24h trading volume |
liquidity |
int
|
Current liquidity |
open_interest |
int
|
Open interest |
result |
str
|
Settlement result |
can_close_early |
bool
|
Whether market can close early |
expiration_value |
str
|
Expiration value |
category |
str
|
Market category |
risk_limit_cents |
int
|
Risk limit in cents |
rules_primary |
str
|
Primary market rules |
rules_secondary |
str
|
Secondary market rules |
title |
Union[Unset, str]
|
Full title describing this market |
settlement_value |
Union[Unset, int]
|
The settlement value of the YES/LONG side of the contract. Only filled after determination. |
settlement_value_dollars |
Union[Unset, str]
|
The settlement value of the YES/LONG side of the contract. Only filled after determination. |
MarketCandlestick¶
kalshi_py.models.market_candlestick.MarketCandlestick
¶
Attributes:
| Name | Type | Description |
|---|---|---|
end_period_ts |
Union[Unset, int]
|
Unix timestamp for the inclusive end of the candlestick period. |
open_interest |
Union[Unset, int]
|
Number of contracts bought on the market by end of the candlestick period (end_period_ts). |
price |
Union[Unset, ModelPriceDistribution]
|
|
volume |
Union[Unset, int]
|
Number of contracts bought on the market during the candlestick period. |
yes_ask |
Union[Unset, ModelBidAskDistribution]
|
|
yes_bid |
Union[Unset, ModelBidAskDistribution]
|
|
MarketPosition¶
kalshi_py.models.market_position.MarketPosition
¶
Attributes:
| Name | Type | Description |
|---|---|---|
fees_paid |
Union[Unset, int]
|
|
fees_paid_dollars |
Union[Unset, list[int]]
|
|
last_updated_ts |
Union[Unset, datetime]
|
Last time the position is updated. |
market_exposure |
Union[Unset, int]
|
|
market_exposure_dollars |
Union[Unset, list[int]]
|
|
position |
Union[Unset, int]
|
Number of contracts bought in this market. Negative means NO contracts and positive means YES contracts. |
realized_pnl |
Union[Unset, int]
|
|
realized_pnl_dollars |
Union[Unset, list[int]]
|
|
resting_orders_count |
Union[Unset, int]
|
Aggregate size of resting orders in contract units. |
ticker |
Union[Unset, str]
|
Unique identifier for the market. |
total_traded |
Union[Unset, int]
|
|
total_traded_dollars |
Union[Unset, list[int]]
|
|
ModelCreateMarketInMultivariateEventCollectionRequest¶
kalshi_py.models.model_create_market_in_multivariate_event_collection_request.ModelCreateMarketInMultivariateEventCollectionRequest
¶
Attributes:
| Name | Type | Description |
|---|---|---|
selected_markets |
Union[Unset, list[ModelTickerPair]]
|
List of selected markets that act as parameters to determine which market is created. |
ModelCreateMarketInMultivariateEventCollectionResponse¶
kalshi_py.models.model_create_market_in_multivariate_event_collection_response.ModelCreateMarketInMultivariateEventCollectionResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
event_ticker |
Union[Unset, str]
|
Event ticker for the created market. |
market_ticker |
Union[Unset, str]
|
Market ticker for the created market. |
ModelEventData¶
kalshi_py.models.model_event_data.ModelEventData
¶
Attributes:
| Name | Type | Description |
|---|---|---|
category |
Union[Unset, str]
|
Event category (deprecated, use series-level category instead). |
collateral_return_type |
Union[Unset, str]
|
|
event_ticker |
Union[Unset, str]
|
Unique identifier for this event. |
markets |
Union[Unset, list[ModelMarket]]
|
Array of markets associated with this event. Only populated when 'with_nested_markets=true' is specified in the request. |
mutually_exclusive |
Union[Unset, bool]
|
If true, only one market in this event can resolve to 'yes'. If false, multiple markets can resolve to 'yes'. |
price_level_structure |
Union[Unset, str]
|
|
series_ticker |
Union[Unset, str]
|
Unique identifier for the series this event belongs to. |
strike_date |
Union[Unset, Any]
|
|
strike_period |
Union[Unset, str]
|
The time period this event covers (e.g., 'week', 'month'). Only filled when the event uses a period strike (mutually exclusive with strike_date). |
sub_title |
Union[Unset, str]
|
Shortened descriptive title for the event. |
title |
Union[Unset, str]
|
Full title of the event (deprecated, use sub_title instead). |
ModelGetEventMetadataResponse¶
kalshi_py.models.model_get_event_metadata_response.ModelGetEventMetadataResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
image_url |
Union[Unset, str]
|
|
settlement_sources |
Union[Unset, list[ModelGetEventMetadataResponseSettlementSourcesItem]]
|
|
ModelGetEventMetadataResponseSettlementSourcesItem¶
kalshi_py.models.model_get_event_metadata_response_settlement_sources_item.ModelGetEventMetadataResponseSettlementSourcesItem
¶
Attributes:
| Name | Type | Description |
|---|---|---|
name |
Union[Unset, str]
|
The official name of the settlement source. |
url |
Union[Unset, str]
|
The URL of the settlement source. |
ModelGetEventResponse¶
kalshi_py.models.model_get_event_response.ModelGetEventResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
event |
Union[Unset, ModelEventData]
|
|
markets |
Union[Unset, list[ModelMarket]]
|
|
ModelGetEventsResponse¶
kalshi_py.models.model_get_events_response.ModelGetEventsResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
cursor |
Union[Unset, str]
|
Pagination cursor for the next page. Empty if there are no more results. |
events |
Union[Unset, list[ModelEventData]]
|
Array of events matching the query criteria. |
ModelGetMarketCandlesticksResponse¶
kalshi_py.models.model_get_market_candlesticks_response.ModelGetMarketCandlesticksResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
candlesticks |
Union[Unset, list[ModelGetMarketCandlesticksResponseCandlesticksItem]]
|
Array of candlestick data points for the specified time range. |
ticker |
Union[Unset, str]
|
Unique identifier for the market. |
ModelGetMarketCandlesticksResponseCandlesticksItem¶
kalshi_py.models.model_get_market_candlesticks_response_candlesticks_item.ModelGetMarketCandlesticksResponseCandlesticksItem
¶
Attributes:
| Name | Type | Description |
|---|---|---|
end_period_ts |
Union[Unset, int]
|
Unix timestamp for the inclusive end of the candlestick period. |
open_interest |
Union[Unset, int]
|
Number of contracts bought on the market by end of the candlestick period (end_period_ts). |
price |
Union[Unset, ModelPriceDistribution]
|
|
volume |
Union[Unset, int]
|
Number of contracts bought on the market during the candlestick period. |
yes_ask |
Union[Unset, ModelBidAskDistribution]
|
|
yes_bid |
Union[Unset, ModelBidAskDistribution]
|
|
ModelGetMarketOrderbookResponse¶
kalshi_py.models.model_get_market_orderbook_response.ModelGetMarketOrderbookResponse
¶
ModelGetMarketResponse¶
kalshi_py.models.model_get_market_response.ModelGetMarketResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
market |
Union[Unset, ModelMarket]
|
Contains information about a market |
ModelGetMarketsResponse¶
kalshi_py.models.model_get_markets_response.ModelGetMarketsResponse
¶
ModelGetMultivariateEventCollectionLookupHistoryResponse¶
kalshi_py.models.model_get_multivariate_event_collection_lookup_history_response.ModelGetMultivariateEventCollectionLookupHistoryResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
lookup_points |
Union[Unset, list[ModelGetMultivariateEventCollectionLookupHistoryResponseLookupPointsItem]]
|
List of recent lookup points in the collection. |
ModelGetMultivariateEventCollectionLookupHistoryResponseLookupPointsItem¶
kalshi_py.models.model_get_multivariate_event_collection_lookup_history_response_lookup_points_item.ModelGetMultivariateEventCollectionLookupHistoryResponseLookupPointsItem
¶
Attributes:
| Name | Type | Description |
|---|---|---|
event_ticker |
Union[Unset, str]
|
Event ticker for the lookup point. |
last_queried_ts |
Union[Unset, datetime]
|
Timestamp when this lookup was last queried. |
market_ticker |
Union[Unset, str]
|
Market ticker for the lookup point. |
selected_markets |
Union[Unset, list[ModelTickerPair]]
|
Markets that were selected for this lookup. |
ModelGetMultivariateEventCollectionResponse¶
kalshi_py.models.model_get_multivariate_event_collection_response.ModelGetMultivariateEventCollectionResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
multivariate_contract |
Union[Unset, ModelMultivariateEventCollection]
|
|
ModelGetMultivariateEventCollectionsResponse¶
kalshi_py.models.model_get_multivariate_event_collections_response.ModelGetMultivariateEventCollectionsResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
cursor |
Union[Unset, str]
|
The Cursor represents a pointer to the next page of records in the pagination. Use the value returned here in the cursor query parameter for this end-point to get the next page containing limit records. An empty value of this field indicates there is no next page. |
multivariate_contracts |
Union[Unset, list[ModelMultivariateEventCollection]]
|
List of multivariate event collections. |
ModelGetPositionsResponseEventPositionsItem¶
kalshi_py.models.model_get_positions_response_event_positions_item.ModelGetPositionsResponseEventPositionsItem
¶
Attributes:
| Name | Type | Description |
|---|---|---|
event_exposure |
Union[Unset, int]
|
|
event_exposure_dollars |
Union[Unset, list[int]]
|
|
event_ticker |
Union[Unset, str]
|
Unique identifier for events. |
fees_paid |
Union[Unset, int]
|
|
fees_paid_dollars |
Union[Unset, list[int]]
|
|
realized_pnl |
Union[Unset, int]
|
|
realized_pnl_dollars |
Union[Unset, list[int]]
|
|
resting_order_count |
Union[Unset, int]
|
Aggregate size of resting orders in contract units. |
total_cost |
Union[Unset, int]
|
|
total_cost_dollars |
Union[Unset, list[int]]
|
|
ModelGetPositionsResponseMarketPositionsItem¶
kalshi_py.models.model_get_positions_response_market_positions_item.ModelGetPositionsResponseMarketPositionsItem
¶
Attributes:
| Name | Type | Description |
|---|---|---|
fees_paid |
Union[Unset, int]
|
|
fees_paid_dollars |
Union[Unset, list[int]]
|
|
last_updated_ts |
Union[Unset, datetime]
|
Last time the position is updated. |
market_exposure |
Union[Unset, int]
|
|
market_exposure_dollars |
Union[Unset, list[int]]
|
|
position |
Union[Unset, int]
|
Number of contracts bought in this market. Negative means NO contracts and positive means YES contracts. |
realized_pnl |
Union[Unset, int]
|
|
realized_pnl_dollars |
Union[Unset, list[int]]
|
|
resting_orders_count |
Union[Unset, int]
|
Aggregate size of resting orders in contract units. |
ticker |
Union[Unset, str]
|
Unique identifier for the market. |
total_traded |
Union[Unset, int]
|
|
total_traded_dollars |
Union[Unset, list[int]]
|
|
ModelGetSettlementsResponseSettlementsItemMarketResult¶
kalshi_py.models.model_get_settlements_response_settlements_item_market_result.ModelGetSettlementsResponseSettlementsItemMarketResult
¶
Bases: str, Enum
ModelLookupTickersForMarketInMultivariateEventCollectionRequest¶
kalshi_py.models.model_lookup_tickers_for_market_in_multivariate_event_collection_request.ModelLookupTickersForMarketInMultivariateEventCollectionRequest
¶
ModelLookupTickersForMarketInMultivariateEventCollectionRequestSelectedMarketsItem¶
kalshi_py.models.model_lookup_tickers_for_market_in_multivariate_event_collection_request_selected_markets_item.ModelLookupTickersForMarketInMultivariateEventCollectionRequestSelectedMarketsItem
¶
Attributes:
| Name | Type | Description |
|---|---|---|
event_ticker |
Union[Unset, str]
|
Event ticker identifier. |
market_ticker |
Union[Unset, str]
|
Market ticker identifier. |
side |
Union[Unset, ModelLookupTickersForMarketInMultivariateEventCollectionRequestSelectedMarketsItemSide]
|
Side of the market (yes or no). |
ModelLookupTickersForMarketInMultivariateEventCollectionRequestSelectedMarketsItemSide¶
kalshi_py.models.model_lookup_tickers_for_market_in_multivariate_event_collection_request_selected_markets_item_side.ModelLookupTickersForMarketInMultivariateEventCollectionRequestSelectedMarketsItemSide
¶
Bases: str, Enum
ModelLookupTickersForMarketInMultivariateEventCollectionResponse¶
kalshi_py.models.model_lookup_tickers_for_market_in_multivariate_event_collection_response.ModelLookupTickersForMarketInMultivariateEventCollectionResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
event_ticker |
Union[Unset, str]
|
Event ticker for the looked up market. |
market_ticker |
Union[Unset, str]
|
Market ticker for the looked up market. |
ModelMarket¶
kalshi_py.models.model_market.ModelMarket
¶
Contains information about a market
Attributes:
| Name | Type | Description |
|---|---|---|
ticker |
str
|
Unique identifier for markets |
event_ticker |
str
|
Unique identifier for events |
market_type |
str
|
Type of market (binary, scalar) |
subtitle |
str
|
Shortened title for this market |
yes_sub_title |
str
|
Shortened title for the yes side |
no_sub_title |
str
|
Shortened title for the no side |
open_time |
datetime
|
Time when trading begins |
close_time |
datetime
|
Time when trading ends |
expiration_time |
datetime
|
Time when market expires |
latest_expiration_time |
datetime
|
Latest possible expiration time |
settlement_timer_seconds |
int
|
Settlement timer in seconds |
status |
str
|
Current market status |
response_price_units |
str
|
Price units for response |
notional_value |
int
|
Notional value of contract |
tick_size |
int
|
Minimum price movement |
yes_bid |
int
|
Highest YES buy offer price |
yes_ask |
int
|
Lowest YES sell offer price |
no_bid |
int
|
Highest NO buy offer price |
no_ask |
int
|
Lowest NO sell offer price |
last_price |
int
|
Last traded price |
previous_yes_bid |
int
|
Previous YES bid price |
previous_yes_ask |
int
|
Previous YES ask price |
previous_price |
int
|
Previous traded price |
volume |
int
|
Trading volume |
volume_24h |
int
|
24h trading volume |
liquidity |
int
|
Current liquidity |
open_interest |
int
|
Open interest |
result |
str
|
Settlement result |
can_close_early |
bool
|
Whether market can close early |
expiration_value |
str
|
Expiration value |
category |
str
|
Market category |
risk_limit_cents |
int
|
Risk limit in cents |
rules_primary |
str
|
Primary market rules |
rules_secondary |
str
|
Secondary market rules |
title |
Union[Unset, str]
|
Full title describing this market |
settlement_value |
Union[Unset, int]
|
The settlement value of the YES/LONG side of the contract. Only filled after determination. |
settlement_value_dollars |
Union[Unset, str]
|
The settlement value of the YES/LONG side of the contract. Only filled after determination. |
ModelMultivariateEventCollection¶
kalshi_py.models.model_multivariate_event_collection.ModelMultivariateEventCollection
¶
Attributes:
| Name | Type | Description |
|---|---|---|
associated_event_tickers |
Union[Unset, list[str]]
|
A list of events associated with the collection. Markets in these events can be passed as inputs to the Lookup and Create endpoints. |
close_date |
Union[Unset, datetime]
|
The close date of the collection. After this time, the collection cannot be interacted with. |
collection_ticker |
Union[Unset, str]
|
Unique identifier for the collection. |
description |
Union[Unset, str]
|
Short description of the collection. |
functional_description |
Union[Unset, str]
|
A functional description of the collection describing how inputs affect the output. |
is_all_yes |
Union[Unset, bool]
|
Whether the collection requires that only the market side of 'yes' may be used. |
is_ordered |
Union[Unset, bool]
|
Whether the collection is ordered. If true, the order of markets passed into Lookup/Create affects the output. If false, the order does not matter. |
is_single_market_per_event |
Union[Unset, bool]
|
Whether the collection accepts multiple markets from the same event passed into Lookup/Create. |
open_date |
Union[Unset, datetime]
|
The open date of the collection. Before this time, the collection cannot be interacted with. |
series_ticker |
Union[Unset, str]
|
Series associated with the collection. Events produced in the collection will be associated with this series. |
size_max |
Union[Unset, int]
|
The maximum number of markets that must be passed into Lookup/Create (inclusive). |
size_min |
Union[Unset, int]
|
The minimum number of markets that must be passed into Lookup/Create (inclusive). |
title |
Union[Unset, str]
|
Title of the collection. |
ModelTickerPair¶
kalshi_py.models.model_ticker_pair.ModelTickerPair
¶
Attributes:
| Name | Type | Description |
|---|---|---|
event_ticker |
Union[Unset, str]
|
Event ticker identifier. |
market_ticker |
Union[Unset, str]
|
Market ticker identifier. |
side |
Union[Unset, ModelTickerPairSide]
|
Side of the market (yes or no). |
ModelTickerPairSide¶
kalshi_py.models.model_ticker_pair_side.ModelTickerPairSide
¶
Bases: str, Enum
SettlementMarketResult¶
kalshi_py.models.settlement_market_result.SettlementMarketResult
¶
Bases: str, Enum
TickerPair¶
kalshi_py.models.ticker_pair.TickerPair
¶
Attributes:
| Name | Type | Description |
|---|---|---|
event_ticker |
Union[Unset, str]
|
Event ticker identifier. |
market_ticker |
Union[Unset, str]
|
Market ticker identifier. |
side |
Union[Unset, TickerPairSide]
|
Side of the market (yes or no). |
TickerPairSide¶
kalshi_py.models.ticker_pair_side.TickerPairSide
¶
Bases: str, Enum
Order Models¶
BatchCancelOrdersIndividualResponse¶
kalshi_py.models.batch_cancel_orders_individual_response.BatchCancelOrdersIndividualResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
error |
Union[Unset, GithubComKalshiExchangeInfraCommonApiJSONError]
|
|
order |
Union[Unset, ModelOrder]
|
|
order_id |
Union[Unset, str]
|
|
reduced_by |
Union[Unset, int]
|
The number of contracts that were successfully canceled from this order. |
BatchCreateOrdersIndividualResponse¶
kalshi_py.models.batch_create_orders_individual_response.BatchCreateOrdersIndividualResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
client_order_id |
Union[Unset, str]
|
|
error |
Union[Unset, GithubComKalshiExchangeInfraCommonApiJSONError]
|
|
order |
Union[Unset, ModelOrderConfirmation]
|
|
GithubComKalshiExchangeInfraSvcApi2ModelOrderConfirmation¶
kalshi_py.models.github_com_kalshi_exchange_infra_svc_api_2_model_order_confirmation.GithubComKalshiExchangeInfraSvcApi2ModelOrderConfirmation
¶
Attributes:
| Name | Type | Description |
|---|---|---|
action |
Union[Unset, str]
|
|
client_order_id |
Union[Unset, str]
|
|
created_time |
Union[Unset, Any]
|
|
expiration_time |
Union[Unset, Any]
|
|
no_price |
Union[Unset, int]
|
|
no_price_dollars |
Union[Unset, list[int]]
|
|
order_group_id |
Union[Unset, str]
|
|
order_id |
Union[Unset, str]
|
Unique identifier for orders. |
self_trade_prevention_type |
Union[Unset, str]
|
|
side |
Union[Unset, str]
|
|
status |
Union[Unset, str]
|
|
ticker |
Union[Unset, str]
|
Unique identifier for markets. |
type_ |
Union[Unset, str]
|
|
user_id |
Union[Unset, str]
|
Unique identifier for users. |
yes_price |
Union[Unset, int]
|
|
yes_price_dollars |
Union[Unset, list[int]]
|
|
ModelAmendOrderRequest¶
kalshi_py.models.model_amend_order_request.ModelAmendOrderRequest
¶
Attributes:
| Name | Type | Description |
|---|---|---|
action |
Union[Unset, ModelAmendOrderRequestAction]
|
Specifies if this is a buy or sell order. Cannot be amended and is validated against original order. |
client_order_id |
Union[Unset, str]
|
|
count |
Union[Unset, int]
|
New total number of contracts for the order. This is the desired final count, not a delta. |
no_price |
Union[Unset, int]
|
|
no_price_dollars |
Union[Unset, list[int]]
|
|
side |
Union[Unset, ModelAmendOrderRequestSide]
|
Side of the order (yes or no). Cannot be amended and is validated against original order. |
ticker |
Union[Unset, str]
|
Market ticker. Cannot be amended and is validated against original order. |
updated_client_order_id |
Union[Unset, str]
|
|
yes_price |
Union[Unset, int]
|
|
yes_price_dollars |
Union[Unset, list[int]]
|
|
ModelAmendOrderRequestAction¶
kalshi_py.models.model_amend_order_request_action.ModelAmendOrderRequestAction
¶
Bases: str, Enum
ModelAmendOrderRequestSide¶
kalshi_py.models.model_amend_order_request_side.ModelAmendOrderRequestSide
¶
Bases: str, Enum
ModelAmendOrderResponse¶
kalshi_py.models.model_amend_order_response.ModelAmendOrderResponse
¶
ModelBatchCancelOrdersRequest¶
kalshi_py.models.model_batch_cancel_orders_request.ModelBatchCancelOrdersRequest
¶
Attributes:
| Name | Type | Description |
|---|---|---|
ids |
Union[Unset, list[str]]
|
An array of order IDs to cancel. |
ModelBatchCancelOrdersResponse¶
kalshi_py.models.model_batch_cancel_orders_response.ModelBatchCancelOrdersResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
orders |
Union[Unset, list[ModelBatchCancelOrdersResponseOrdersItem]]
|
An array of responses corresponding to each order cancellation request. Each response indicates success or failure for that specific cancellation. |
ModelBatchCancelOrdersResponseOrdersItem¶
kalshi_py.models.model_batch_cancel_orders_response_orders_item.ModelBatchCancelOrdersResponseOrdersItem
¶
Attributes:
| Name | Type | Description |
|---|---|---|
error |
Union[Unset, GithubComKalshiExchangeInfraCommonApiJSONError]
|
|
order |
Union[Unset, ModelOrder]
|
|
order_id |
Union[Unset, str]
|
|
reduced_by |
Union[Unset, int]
|
The number of contracts that were successfully canceled from this order. |
ModelBatchCreateOrdersRequest¶
kalshi_py.models.model_batch_create_orders_request.ModelBatchCreateOrdersRequest
¶
Attributes:
| Name | Type | Description |
|---|---|---|
orders |
Union[Unset, list[ModelCreateOrderRequest]]
|
An array of individual orders to place. |
ModelBatchCreateOrdersResponse¶
kalshi_py.models.model_batch_create_orders_response.ModelBatchCreateOrdersResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
orders |
Union[Unset, list[ModelBatchCreateOrdersResponseOrdersItem]]
|
An array of responses corresponding to each order in the request. Each response indicates success or failure for that specific order. |
ModelBatchCreateOrdersResponseOrdersItem¶
kalshi_py.models.model_batch_create_orders_response_orders_item.ModelBatchCreateOrdersResponseOrdersItem
¶
Attributes:
| Name | Type | Description |
|---|---|---|
client_order_id |
Union[Unset, str]
|
|
error |
Union[Unset, GithubComKalshiExchangeInfraCommonApiJSONError]
|
|
order |
Union[Unset, ModelOrderConfirmation]
|
|
ModelCancelOrderResponse¶
kalshi_py.models.model_cancel_order_response.ModelCancelOrderResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
order |
Union[Unset, ModelOrder]
|
|
reduced_by |
Union[Unset, int]
|
How much the count of the order was reduced by because of this operation. |
ModelCreateOrderGroupRequest¶
kalshi_py.models.model_create_order_group_request.ModelCreateOrderGroupRequest
¶
Attributes:
| Name | Type | Description |
|---|---|---|
contracts_limit |
Union[Unset, int]
|
Specifies the maximum number of contracts that can be matched within this group. |
ModelCreateOrderGroupResponse¶
kalshi_py.models.model_create_order_group_response.ModelCreateOrderGroupResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
order_group_id |
Union[Unset, str]
|
|
ModelCreateOrderRequest¶
kalshi_py.models.model_create_order_request.ModelCreateOrderRequest
¶
Attributes:
| Name | Type | Description |
|---|---|---|
action |
Union[Unset, ModelCreateOrderRequestAction]
|
Specifies if this is a buy or sell order. |
buy_max_cost |
Union[Unset, int]
|
|
client_order_id |
Union[Unset, str]
|
|
count |
Union[Unset, int]
|
Number of contracts to be bought or sold. |
expiration_ts |
Union[Unset, int]
|
Expiration time of the order, in unix seconds. If not supplied, the order won't expire until explicitly cancelled (GTC). If the time is in the past, the order will attempt to fill and cancel any remainder (IOC). If the time is in the future, the unfilled quantity will expire at the specified time. |
no_price |
Union[Unset, int]
|
|
no_price_dollars |
Union[Unset, list[int]]
|
|
order_group_id |
Union[Unset, str]
|
|
post_only |
Union[Unset, bool]
|
If this flag is set to true, an order will be rejected if it crosses the spread and executes. |
self_trade_prevention_type |
Union[Unset, str]
|
|
sell_position_capped |
Union[Unset, bool]
|
SellPositionCapped prevents sell orders from exceeding your current position. This option can only be used with Immediate-or-Cancel (IoC) orders. |
sell_position_floor |
Union[Unset, int]
|
SellPositionFloor will not let you flip position for a market order if set to 0. Deprecated: Use sell_position_capped instead. |
side |
Union[Unset, ModelCreateOrderRequestSide]
|
Specifies if this is a 'yes' or 'no' order. |
ticker |
Union[Unset, str]
|
The ticker of the market the order will be placed in. |
time_in_force |
Union[Unset, ModelCreateOrderRequestTimeInForce]
|
Currently only 'fill_or_kill' and 'immediate_or_cancel' are supported. Other time in forces are controlled through expiration_ts. |
type_ |
Union[Unset, ModelCreateOrderRequestType]
|
Specifies if this is a 'market' or a 'limit' order. Note that either the Yes Price or the No Price must be provided for limit orders. |
yes_price |
Union[Unset, int]
|
|
yes_price_dollars |
Union[Unset, list[int]]
|
|
ModelCreateOrderRequestAction¶
kalshi_py.models.model_create_order_request_action.ModelCreateOrderRequestAction
¶
Bases: str, Enum
ModelCreateOrderRequestSide¶
kalshi_py.models.model_create_order_request_side.ModelCreateOrderRequestSide
¶
Bases: str, Enum
ModelCreateOrderRequestTimeInForce¶
kalshi_py.models.model_create_order_request_time_in_force.ModelCreateOrderRequestTimeInForce
¶
Bases: str, Enum
ModelCreateOrderRequestType¶
kalshi_py.models.model_create_order_request_type.ModelCreateOrderRequestType
¶
Bases: str, Enum
ModelCreateOrderResponse¶
kalshi_py.models.model_create_order_response.ModelCreateOrderResponse
¶
ModelDecreaseOrderRequest¶
kalshi_py.models.model_decrease_order_request.ModelDecreaseOrderRequest
¶
Attributes:
| Name | Type | Description |
|---|---|---|
reduce_by |
Union[Unset, int]
|
Number of contracts to decrease the order's count by. One of reduce_by or reduce_to must be provided. |
reduce_to |
Union[Unset, int]
|
Number of contracts to decrease the order to. If the orders remaining count is lower, it does nothing. One of reduce_by or reduce_to must be provided. |
ModelDecreaseOrderResponse¶
kalshi_py.models.model_decrease_order_response.ModelDecreaseOrderResponse
¶
ModelFill¶
kalshi_py.models.model_fill.ModelFill
¶
Attributes:
| Name | Type | Description |
|---|---|---|
action |
Union[Unset, str]
|
|
count |
Union[Unset, int]
|
Number of contracts bought or sold in this fill. |
created_time |
Union[Unset, Any]
|
|
is_taker |
Union[Unset, bool]
|
If true, this fill was a taker (removed liquidity from the order book). |
no_price |
Union[Unset, int]
|
|
no_price_fixed |
Union[Unset, list[int]]
|
|
order_id |
Union[Unset, str]
|
|
side |
Union[Unset, str]
|
|
ticker |
Union[Unset, str]
|
Unique identifier for the market. |
trade_id |
Union[Unset, str]
|
|
yes_price |
Union[Unset, int]
|
|
yes_price_fixed |
Union[Unset, list[int]]
|
|
ModelGetFillsResponse¶
kalshi_py.models.model_get_fills_response.ModelGetFillsResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
cursor |
Union[Unset, str]
|
The Cursor represents a pointer to the next page of records in the pagination. Use the value returned here in the cursor query parameter for this end-point to get the next page containing limit records. An empty value of this field indicates there is no next page. |
fills |
Union[Unset, list[ModelFill]]
|
|
ModelGetOrderGroupResponse¶
kalshi_py.models.model_get_order_group_response.ModelGetOrderGroupResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
is_auto_cancel_enabled |
Union[Unset, bool]
|
Whether auto-cancel is enabled for this order group. |
orders |
Union[Unset, list[str]]
|
List of order IDs that belong to this order group. |
ModelGetOrderGroupsResponse¶
kalshi_py.models.model_get_order_groups_response.ModelGetOrderGroupsResponse
¶
ModelGetOrderQueuePositionResponse¶
kalshi_py.models.model_get_order_queue_position_response.ModelGetOrderQueuePositionResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
queue_position |
Union[Unset, int]
|
The position of the order in the queue. |
ModelGetOrderQueuePositionsResponse¶
kalshi_py.models.model_get_order_queue_positions_response.ModelGetOrderQueuePositionsResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
queue_positions |
Union[Unset, list[ModelGetOrderQueuePositionsResponseQueuePositionsItem]]
|
|
ModelGetOrderQueuePositionsResponseQueuePositionsItem¶
kalshi_py.models.model_get_order_queue_positions_response_queue_positions_item.ModelGetOrderQueuePositionsResponseQueuePositionsItem
¶
Attributes:
| Name | Type | Description |
|---|---|---|
market_ticker |
Union[Unset, str]
|
|
order_id |
Union[Unset, str]
|
|
queue_position |
Union[Unset, int]
|
|
ModelGetOrderResponse¶
kalshi_py.models.model_get_order_response.ModelGetOrderResponse
¶
ModelGetOrdersResponse¶
kalshi_py.models.model_get_orders_response.ModelGetOrdersResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
cursor |
Union[Unset, str]
|
The Cursor represents a pointer to the next page of records in the pagination. Use the value returned here in the cursor query parameter for this end-point to get the next page containing limit records. An empty value of this field indicates there is no next page. |
orders |
Union[Unset, list[ModelOrder]]
|
|
ModelGetPositionsResponse¶
kalshi_py.models.model_get_positions_response.ModelGetPositionsResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
cursor |
Union[Unset, str]
|
The Cursor represents a pointer to the next page of records in the pagination. Use the value returned here in the cursor query parameter for this end-point to get the next page containing limit records. An empty value of this field indicates there is no next page. |
event_positions |
Union[Unset, list[ModelGetPositionsResponseEventPositionsItem]]
|
List of event positions. |
market_positions |
Union[Unset, list[ModelGetPositionsResponseMarketPositionsItem]]
|
List of market positions. |
ModelGetUserRestingOrderTotalValueResponse¶
kalshi_py.models.model_get_user_resting_order_total_value_response.ModelGetUserRestingOrderTotalValueResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
total_value |
Union[Unset, int]
|
|
ModelOrder¶
kalshi_py.models.model_order.ModelOrder
¶
Attributes:
| Name | Type | Description |
|---|---|---|
action |
Union[Unset, str]
|
|
client_order_id |
Union[Unset, str]
|
|
created_time |
Union[Unset, Any]
|
|
expiration_time |
Union[Unset, Any]
|
|
fill_count |
Union[Unset, int]
|
The size of filled orders (maker + taker). |
initial_count |
Union[Unset, int]
|
The initial size of the order (contract units). |
last_update_time |
Union[Unset, Any]
|
|
maker_fees |
Union[Unset, int]
|
|
maker_fill_cost |
Union[Unset, int]
|
|
no_price |
Union[Unset, int]
|
|
no_price_dollars |
Union[Unset, list[int]]
|
|
order_group_id |
Union[Unset, str]
|
|
order_id |
Union[Unset, str]
|
Unique identifier for orders. |
queue_position |
Union[Unset, int]
|
Position in the priority queue at a given price level. |
remaining_count |
Union[Unset, int]
|
The size of the remaining resting orders (contract units). |
self_trade_prevention_type |
Union[Unset, str]
|
|
side |
Union[Unset, str]
|
|
status |
Union[Unset, str]
|
|
taker_fees |
Union[Unset, int]
|
|
taker_fill_cost |
Union[Unset, int]
|
|
ticker |
Union[Unset, str]
|
Unique identifier for markets. |
type_ |
Union[Unset, str]
|
|
user_id |
Union[Unset, str]
|
Unique identifier for users. |
yes_price |
Union[Unset, int]
|
|
yes_price_dollars |
Union[Unset, list[int]]
|
|
ModelOrderBook¶
kalshi_py.models.model_order_book.ModelOrderBook
¶
Attributes:
| Name | Type | Description |
|---|---|---|
no |
Union[Unset, list[list[int]]]
|
Array of price levels for no orders. Each level is [price, quantity] where price is in cents or centicents based on use_centi_cent parameter. |
no_dollars |
Union[Unset, list[ModelOrderBookNoDollarsItem]]
|
Array of price levels for no orders. Each level is {price, quantity} where price is in dollars. |
yes |
Union[Unset, list[list[int]]]
|
Array of price levels for yes orders. Each level is [price, quantity] where price is in cents or centicents based on use_centi_cent parameter. |
yes_dollars |
Union[Unset, list[ModelOrderBookYesDollarsItem]]
|
Array of price levels for yes orders. Each level is {price, quantity} where price is in dollars. |
ModelOrderBookNoDollarsItem¶
kalshi_py.models.model_order_book_no_dollars_item.ModelOrderBookNoDollarsItem
¶
Attributes:
| Name | Type | Description |
|---|---|---|
count |
Union[Unset, int]
|
|
dollars |
Union[Unset, list[int]]
|
|
ModelOrderBookYesDollarsItem¶
kalshi_py.models.model_order_book_yes_dollars_item.ModelOrderBookYesDollarsItem
¶
Attributes:
| Name | Type | Description |
|---|---|---|
count |
Union[Unset, int]
|
|
dollars |
Union[Unset, list[int]]
|
|
ModelOrderConfirmation¶
kalshi_py.models.model_order_confirmation.ModelOrderConfirmation
¶
Attributes:
| Name | Type | Description |
|---|---|---|
action |
Union[Unset, str]
|
|
client_order_id |
Union[Unset, str]
|
|
created_time |
Union[Unset, Any]
|
|
expiration_time |
Union[Unset, Any]
|
|
no_price |
Union[Unset, int]
|
|
no_price_dollars |
Union[Unset, list[int]]
|
|
order_group_id |
Union[Unset, str]
|
|
order_id |
Union[Unset, str]
|
Unique identifier for orders. |
self_trade_prevention_type |
Union[Unset, str]
|
|
side |
Union[Unset, str]
|
|
status |
Union[Unset, str]
|
|
ticker |
Union[Unset, str]
|
Unique identifier for markets. |
type_ |
Union[Unset, str]
|
|
user_id |
Union[Unset, str]
|
Unique identifier for users. |
yes_price |
Union[Unset, int]
|
|
yes_price_dollars |
Union[Unset, list[int]]
|
|
ModelOrderGroupSummary¶
kalshi_py.models.model_order_group_summary.ModelOrderGroupSummary
¶
Attributes:
| Name | Type | Description |
|---|---|---|
id |
Union[Unset, str]
|
|
is_auto_cancel_enabled |
Union[Unset, bool]
|
Whether auto-cancel is enabled for this order group. |
OrderQueuePosition¶
kalshi_py.models.order_queue_position.OrderQueuePosition
¶
Attributes:
| Name | Type | Description |
|---|---|---|
market_ticker |
Union[Unset, str]
|
|
order_id |
Union[Unset, str]
|
|
queue_position |
Union[Unset, int]
|
|
User Models¶
ApiKey¶
kalshi_py.models.api_key.ApiKey
¶
Attributes:
| Name | Type | Description |
|---|---|---|
api_key_id |
Union[Unset, str]
|
Unique identifier for the API key. |
created_ts |
Union[Unset, datetime]
|
Timestamp when the API key was created. |
name |
Union[Unset, str]
|
User-provided name for the API key. |
ModelGetBalanceResponse¶
kalshi_py.models.model_get_balance_response.ModelGetBalanceResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
balance |
Union[Unset, int]
|
|
ModelGetUserDataTimestampResponse¶
kalshi_py.models.model_get_user_data_timestamp_response.ModelGetUserDataTimestampResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
as_of_time |
Union[Unset, Any]
|
|
ModelUserCreateApiKeyRequest¶
kalshi_py.models.model_user_create_api_key_request.ModelUserCreateApiKeyRequest
¶
Attributes:
| Name | Type | Description |
|---|---|---|
name |
Union[Unset, str]
|
Name for the API key. This helps identify the key's purpose. |
public_key |
Union[Unset, str]
|
RSA public key in PEM format. This will be used to verify signatures on API requests. |
ModelUserCreateApiKeyResponse¶
kalshi_py.models.model_user_create_api_key_response.ModelUserCreateApiKeyResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
api_key_id |
Union[Unset, str]
|
Unique identifier for the newly created API key. |
ModelUserGenerateApiKeyRequest¶
kalshi_py.models.model_user_generate_api_key_request.ModelUserGenerateApiKeyRequest
¶
Attributes:
| Name | Type | Description |
|---|---|---|
name |
Union[Unset, str]
|
Name for the API key. This helps identify the key's purpose. |
ModelUserGenerateApiKeyResponse¶
kalshi_py.models.model_user_generate_api_key_response.ModelUserGenerateApiKeyResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
api_key_id |
Union[Unset, str]
|
Unique identifier for the newly generated API key. |
private_key |
Union[Unset, str]
|
RSA private key in PEM format. This must be stored securely and cannot be retrieved again after this response. |
ModelUserGetApiKeysResponse¶
kalshi_py.models.model_user_get_api_keys_response.ModelUserGetApiKeysResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
api_keys |
Union[Unset, list[ModelUserGetApiKeysResponseApiKeysItem]]
|
List of all API keys associated with the user. |
ModelUserGetApiKeysResponseApiKeysItem¶
kalshi_py.models.model_user_get_api_keys_response_api_keys_item.ModelUserGetApiKeysResponseApiKeysItem
¶
Attributes:
| Name | Type | Description |
|---|---|---|
api_key_id |
Union[Unset, str]
|
Unique identifier for the API key. |
created_ts |
Union[Unset, datetime]
|
Timestamp when the API key was created. |
name |
Union[Unset, str]
|
User-provided name for the API key. |
Communication Models¶
GithubComKalshiExchangeInfraCommonCommunicationsQuote¶
kalshi_py.models.github_com_kalshi_exchange_infra_common_communications_quote.GithubComKalshiExchangeInfraCommonCommunicationsQuote
¶
Attributes:
| Name | Type | Description |
|---|---|---|
accepted_side |
Union[Unset, str]
|
The side that was accepted (yes or no). |
accepted_ts |
Union[Unset, datetime]
|
Timestamp when the quote was accepted. |
cancellation_reason |
Union[Unset, str]
|
Reason for quote cancellation if cancelled. |
cancelled_ts |
Union[Unset, datetime]
|
Timestamp when the quote was cancelled. |
confirmed_ts |
Union[Unset, datetime]
|
Timestamp when the quote was confirmed. |
contracts |
Union[Unset, int]
|
Number of contracts in the quote. |
created_ts |
Union[Unset, datetime]
|
Timestamp when the quote was created. |
creator_id |
Union[Unset, str]
|
|
creator_order_id |
Union[Unset, str]
|
|
creator_user_id |
Union[Unset, str]
|
|
executed_ts |
Union[Unset, datetime]
|
Timestamp when the quote was executed. |
id |
Union[Unset, str]
|
|
market_ticker |
Union[Unset, str]
|
The ticker of the market this quote is for. |
no_bid |
Union[Unset, int]
|
|
rest_remainder |
Union[Unset, bool]
|
Whether to rest the remainder of the quote after execution. |
rfq_creator_id |
Union[Unset, str]
|
|
rfq_creator_order_id |
Union[Unset, str]
|
|
rfq_creator_user_id |
Union[Unset, str]
|
|
rfq_id |
Union[Unset, str]
|
|
status |
Union[Unset, str]
|
|
updated_ts |
Union[Unset, datetime]
|
Timestamp when the quote was last updated. |
yes_bid |
Union[Unset, int]
|
|
GithubComKalshiExchangeInfraCommonCommunicationsRFQ¶
kalshi_py.models.github_com_kalshi_exchange_infra_common_communications_rfq.GithubComKalshiExchangeInfraCommonCommunicationsRFQ
¶
Attributes:
| Name | Type | Description |
|---|---|---|
cancellation_reason |
Union[Unset, str]
|
Reason for RFQ cancellation if cancelled. |
cancelled_ts |
Union[Unset, datetime]
|
Timestamp when the RFQ was cancelled. |
contracts |
Union[Unset, int]
|
Number of contracts requested in the RFQ. |
created_ts |
Union[Unset, datetime]
|
Timestamp when the RFQ was created. |
creator_id |
Union[Unset, str]
|
|
creator_user_id |
Union[Unset, str]
|
|
id |
Union[Unset, str]
|
|
market_ticker |
Union[Unset, str]
|
The ticker of the market this RFQ is for. |
rest_remainder |
Union[Unset, bool]
|
Whether to rest the remainder of the RFQ after execution. |
status |
Union[Unset, str]
|
|
updated_ts |
Union[Unset, datetime]
|
Timestamp when the RFQ was last updated. |
ModelAcceptQuoteRequest¶
kalshi_py.models.model_accept_quote_request.ModelAcceptQuoteRequest
¶
Attributes:
| Name | Type | Description |
|---|---|---|
accepted_side |
Union[Unset, ModelAcceptQuoteRequestAcceptedSide]
|
The side of the quote to accept (yes or no). |
ModelAcceptQuoteRequestAcceptedSide¶
kalshi_py.models.model_accept_quote_request_accepted_side.ModelAcceptQuoteRequestAcceptedSide
¶
Bases: str, Enum
ModelCreateQuoteRequest¶
kalshi_py.models.model_create_quote_request.ModelCreateQuoteRequest
¶
Attributes:
| Name | Type | Description |
|---|---|---|
no_bid |
Union[Unset, list[int]]
|
|
rest_remainder |
Union[Unset, bool]
|
Whether to rest the remainder of the quote after execution. |
rfq_id |
Union[Unset, str]
|
|
yes_bid |
Union[Unset, list[int]]
|
|
ModelCreateQuoteResponse¶
kalshi_py.models.model_create_quote_response.ModelCreateQuoteResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
id |
Union[Unset, str]
|
The ID of the newly created quote. |
ModelCreateRFQRequest¶
kalshi_py.models.model_create_rfq_request.ModelCreateRFQRequest
¶
Attributes:
| Name | Type | Description |
|---|---|---|
contracts |
Union[Unset, int]
|
The number of contracts for the RFQ. |
market_ticker |
Union[Unset, str]
|
The ticker of the market for which to create an RFQ. |
rest_remainder |
Union[Unset, bool]
|
Whether to rest the remainder of the RFQ after execution. |
ModelCreateRFQResponse¶
kalshi_py.models.model_create_rfq_response.ModelCreateRFQResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
id |
Union[Unset, str]
|
The ID of the newly created RFQ. |
ModelGetCommunicationsIDResponse¶
kalshi_py.models.model_get_communications_id_response.ModelGetCommunicationsIDResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
communications_id |
Union[Unset, str]
|
|
ModelGetQuoteResponse¶
kalshi_py.models.model_get_quote_response.ModelGetQuoteResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
quote |
Union[Unset, GithubComKalshiExchangeInfraCommonCommunicationsQuote]
|
|
ModelGetQuotesResponse¶
kalshi_py.models.model_get_quotes_response.ModelGetQuotesResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
cursor |
Union[Unset, str]
|
Cursor for pagination to get the next page of results. |
quotes |
Union[Unset, list[ModelGetQuotesResponseQuotesItem]]
|
List of quotes matching the query criteria. |
ModelGetQuotesResponseQuotesItem¶
kalshi_py.models.model_get_quotes_response_quotes_item.ModelGetQuotesResponseQuotesItem
¶
Attributes:
| Name | Type | Description |
|---|---|---|
accepted_side |
Union[Unset, str]
|
The side that was accepted (yes or no). |
accepted_ts |
Union[Unset, datetime]
|
Timestamp when the quote was accepted. |
cancellation_reason |
Union[Unset, str]
|
Reason for quote cancellation if cancelled. |
cancelled_ts |
Union[Unset, datetime]
|
Timestamp when the quote was cancelled. |
confirmed_ts |
Union[Unset, datetime]
|
Timestamp when the quote was confirmed. |
contracts |
Union[Unset, int]
|
Number of contracts in the quote. |
created_ts |
Union[Unset, datetime]
|
Timestamp when the quote was created. |
creator_id |
Union[Unset, str]
|
|
creator_order_id |
Union[Unset, str]
|
|
creator_user_id |
Union[Unset, str]
|
|
executed_ts |
Union[Unset, datetime]
|
Timestamp when the quote was executed. |
id |
Union[Unset, str]
|
|
market_ticker |
Union[Unset, str]
|
The ticker of the market this quote is for. |
no_bid |
Union[Unset, int]
|
|
rest_remainder |
Union[Unset, bool]
|
Whether to rest the remainder of the quote after execution. |
rfq_creator_id |
Union[Unset, str]
|
|
rfq_creator_order_id |
Union[Unset, str]
|
|
rfq_creator_user_id |
Union[Unset, str]
|
|
rfq_id |
Union[Unset, str]
|
|
status |
Union[Unset, str]
|
|
updated_ts |
Union[Unset, datetime]
|
Timestamp when the quote was last updated. |
yes_bid |
Union[Unset, int]
|
|
ModelGetRFQsResponseRfqsItem¶
kalshi_py.models.model_get_rf_qs_response_rfqs_item.ModelGetRFQsResponseRfqsItem
¶
Attributes:
| Name | Type | Description |
|---|---|---|
cancellation_reason |
Union[Unset, str]
|
Reason for RFQ cancellation if cancelled. |
cancelled_ts |
Union[Unset, datetime]
|
Timestamp when the RFQ was cancelled. |
contracts |
Union[Unset, int]
|
Number of contracts requested in the RFQ. |
created_ts |
Union[Unset, datetime]
|
Timestamp when the RFQ was created. |
creator_id |
Union[Unset, str]
|
|
creator_user_id |
Union[Unset, str]
|
|
id |
Union[Unset, str]
|
|
market_ticker |
Union[Unset, str]
|
The ticker of the market this RFQ is for. |
rest_remainder |
Union[Unset, bool]
|
Whether to rest the remainder of the RFQ after execution. |
status |
Union[Unset, str]
|
|
updated_ts |
Union[Unset, datetime]
|
Timestamp when the RFQ was last updated. |
ModelGetRFQResponse¶
kalshi_py.models.model_get_rfq_response.ModelGetRFQResponse
¶
Attributes:
| Name | Type | Description |
|---|---|---|
rfq |
Union[Unset, GithubComKalshiExchangeInfraCommonCommunicationsRFQ]
|
|
Other Models¶
Announcement¶
kalshi_py.models.announcement.Announcement
¶
Attributes:
| Name | Type | Description |
|---|---|---|
delivery_time |
Union[Unset, datetime]
|
The time the announcement was delivered. |
message |
Union[Unset, str]
|
The message contained within the announcement. |
status |
Union[Unset, str]
|
|
type_ |
Union[Unset, str]
|
|
DailySchedule¶
kalshi_py.models.daily_schedule.DailySchedule
¶
Attributes:
| Name | Type | Description |
|---|---|---|
close_time |
Union[Unset, str]
|
Closing time in ET (Eastern Time) format HH:MM. |
open_time |
Union[Unset, str]
|
Opening time in ET (Eastern Time) format HH:MM. |
GenericObject¶
kalshi_py.models.generic_object.GenericObject
¶
Generic object type
GithubComKalshiExchangeInfraCommonApiJSONError¶
kalshi_py.models.github_com_kalshi_exchange_infra_common_api_json_error.GithubComKalshiExchangeInfraCommonApiJSONError
¶
Attributes:
| Name | Type | Description |
|---|---|---|
code |
Union[Unset, str]
|
A short identifier for the error type. |
details |
Union[Unset, str]
|
Additional details about the error, if available. |
message |
Union[Unset, str]
|
A human-readable description of the error. |
service |
Union[Unset, str]
|
The name of the service that generated the error. |
GithubComKalshiExchangeInfraCommonUnimodelDetails¶
kalshi_py.models.github_com_kalshi_exchange_infra_common_unimodel_details.GithubComKalshiExchangeInfraCommonUnimodelDetails
¶
LookupPoint¶
kalshi_py.models.lookup_point.LookupPoint
¶
Attributes:
| Name | Type | Description |
|---|---|---|
event_ticker |
Union[Unset, str]
|
Event ticker for the lookup point. |
last_queried_ts |
Union[Unset, datetime]
|
Timestamp when this lookup was last queried. |
market_ticker |
Union[Unset, str]
|
Market ticker for the lookup point. |
selected_markets |
Union[Unset, list[ModelTickerPair]]
|
Markets that were selected for this lookup. |
MaintenanceWindow¶
kalshi_py.models.maintenance_window.MaintenanceWindow
¶
Attributes:
| Name | Type | Description |
|---|---|---|
end_datetime |
Union[Unset, datetime]
|
End date and time of the maintenance window. |
start_datetime |
Union[Unset, datetime]
|
Start date and time of the maintenance window. |
ModelBidAskDistribution¶
kalshi_py.models.model_bid_ask_distribution.ModelBidAskDistribution
¶
Attributes:
| Name | Type | Description |
|---|---|---|
close |
Union[Unset, int]
|
|
close_dollars |
Union[Unset, list[int]]
|
|
high |
Union[Unset, int]
|
|
high_dollars |
Union[Unset, list[int]]
|
|
low |
Union[Unset, int]
|
|
low_dollars |
Union[Unset, list[int]]
|
|
open_ |
Union[Unset, int]
|
|
open_dollars |
Union[Unset, list[int]]
|
|
ModelExchangeStatus¶
kalshi_py.models.model_exchange_status.ModelExchangeStatus
¶
Attributes:
| Name | Type | Description |
|---|---|---|
exchange_active |
Union[Unset, bool]
|
False if the core Kalshi exchange is no longer taking any state changes at all. This includes but is not limited to trading, new users, and transfers. True unless we are under maintenance. |
exchange_estimated_resume_time |
Union[Unset, Any]
|
|
trading_active |
Union[Unset, bool]
|
True if we are currently permitting trading on the exchange. This is true during trading hours and false outside exchange hours. Kalshi reserves the right to pause at any time in case issues are detected. |
ModelMilestone¶
kalshi_py.models.model_milestone.ModelMilestone
¶
Attributes:
| Name | Type | Description |
|---|---|---|
category |
Union[Unset, str]
|
Category of the milestone. |
details |
Union[Unset, GithubComKalshiExchangeInfraCommonUnimodelDetails]
|
|
end_date |
Union[Unset, datetime]
|
End date of the milestone, if any. |
id |
Union[Unset, str]
|
Unique identifier for the milestone. |
last_updated_ts |
Union[Unset, datetime]
|
Last time this structured target was updated. |
notification_message |
Union[Unset, str]
|
Notification message for the milestone. |
primary_event_tickers |
Union[Unset, list[str]]
|
List of event tickers directly related to the outcome of this milestone. |
related_event_tickers |
Union[Unset, list[str]]
|
List of event tickers related to this milestone. |
source_id |
Union[Unset, str]
|
Source id of milestone if available. |
start_date |
Union[Unset, datetime]
|
Start date of the milestone. |
title |
Union[Unset, str]
|
Title of the milestone. |
type_ |
Union[Unset, str]
|
Type of the milestone. |
ModelPriceDistribution¶
kalshi_py.models.model_price_distribution.ModelPriceDistribution
¶
Attributes:
| Name | Type | Description |
|---|---|---|
close |
Union[Unset, int]
|
|
close_dollars |
Union[Unset, list[int]]
|
|
high |
Union[Unset, int]
|
|
high_dollars |
Union[Unset, list[int]]
|
|
low |
Union[Unset, int]
|
|
low_dollars |
Union[Unset, list[int]]
|
|
mean |
Union[Unset, int]
|
|
mean_dollars |
Union[Unset, list[int]]
|
|
open_ |
Union[Unset, int]
|
|
open_dollars |
Union[Unset, list[int]]
|
|
previous |
Union[Unset, int]
|
|
previous_dollars |
Union[Unset, list[int]]
|
|
ModelPublicTrade¶
kalshi_py.models.model_public_trade.ModelPublicTrade
¶
Attributes:
| Name | Type | Description |
|---|---|---|
count |
Union[Unset, int]
|
Number of contracts bought or sold in this trade. |
created_time |
Union[Unset, Any]
|
|
no_price |
Union[Unset, int]
|
|
taker_side |
Union[Unset, str]
|
|
ticker |
Union[Unset, str]
|
Unique identifier for the market. |
trade_id |
Union[Unset, str]
|
|
yes_price |
Union[Unset, int]
|
|
ModelStructuredTarget¶
kalshi_py.models.model_structured_target.ModelStructuredTarget
¶
Attributes:
| Name | Type | Description |
|---|---|---|
details |
Union[Unset, GithubComKalshiExchangeInfraCommonUnimodelDetails]
|
|
id |
Union[Unset, str]
|
Unique identifier for the structured target. |
last_updated_ts |
Union[Unset, datetime]
|
Timestamp when this structured target was last updated. |
name |
Union[Unset, str]
|
Name of the structured target. |
source_id |
Union[Unset, str]
|
External source identifier for the structured target, if available (e.g., third- party data provider ID). |
type_ |
Union[Unset, str]
|
Type of the structured target. |
PriceLevelDollars¶
kalshi_py.models.price_level_dollars.PriceLevelDollars
¶
Attributes:
| Name | Type | Description |
|---|---|---|
count |
Union[Unset, int]
|
|
dollars |
Union[Unset, list[int]]
|
|
Settlement¶
kalshi_py.models.settlement.Settlement
¶
Attributes:
| Name | Type | Description |
|---|---|---|
market_result |
Union[Unset, SettlementMarketResult]
|
The outcome of the market settlement ('yes' or 'no'). |
no_count |
Union[Unset, int]
|
Number of NO contracts owned at the time of settlement. |
no_total_cost |
Union[Unset, int]
|
|
revenue |
Union[Unset, int]
|
|
settled_time |
Union[Unset, Any]
|
|
ticker |
Union[Unset, str]
|
The ticker symbol of the market that was settled. |
yes_count |
Union[Unset, int]
|
Number of YES contracts owned at the time of settlement. |
yes_total_cost |
Union[Unset, int]
|
|
SettlementSource¶
kalshi_py.models.settlement_source.SettlementSource
¶
Attributes:
| Name | Type | Description |
|---|---|---|
name |
Union[Unset, str]
|
The official name of the settlement source. |
url |
Union[Unset, str]
|
The URL of the settlement source. |
WeeklySchedule¶
kalshi_py.models.weekly_schedule.WeeklySchedule
¶
Attributes:
| Name | Type | Description |
|---|---|---|
end_time |
Union[Unset, datetime]
|
End date and time for when this weekly schedule is no longer effective. |
friday |
Union[Unset, list[GithubComKalshiExchangeInfraCommonExchangeMetadataDailySchedule]]
|
Trading hours for Friday. May contain multiple sessions. |
monday |
Union[Unset, list[WeeklyScheduleMondayItem]]
|
Trading hours for Monday. May contain multiple sessions. |
saturday |
Union[Unset, list[GithubComKalshiExchangeInfraCommonExchangeMetadataDailySchedule]]
|
Trading hours for Saturday. May contain multiple sessions. |
start_time |
Union[Unset, datetime]
|
Start date and time for when this weekly schedule is effective. |
sunday |
Union[Unset, list[GithubComKalshiExchangeInfraCommonExchangeMetadataDailySchedule]]
|
Trading hours for Sunday. May contain multiple sessions. |
thursday |
Union[Unset, list[GithubComKalshiExchangeInfraCommonExchangeMetadataDailySchedule]]
|
Trading hours for Thursday. May contain multiple sessions. |
tuesday |
Union[Unset, list[GithubComKalshiExchangeInfraCommonExchangeMetadataDailySchedule]]
|
Trading hours for Tuesday. May contain multiple sessions. |
wednesday |
Union[Unset, list[GithubComKalshiExchangeInfraCommonExchangeMetadataDailySchedule]]
|
Trading hours for Wednesday. May contain multiple sessions. |
WeeklyScheduleMondayItem¶
kalshi_py.models.weekly_schedule_monday_item.WeeklyScheduleMondayItem
¶
Attributes:
| Name | Type | Description |
|---|---|---|
close_time |
Union[Unset, str]
|
Closing time in ET (Eastern Time) format HH:MM. |
open_time |
Union[Unset, str]
|
Opening time in ET (Eastern Time) format HH:MM. |