kalshi-cpp 0.6.2
C++23 client for Kalshi's Predictions API
Loading...
Searching...
No Matches
kalshi::Market Struct Reference

#include <kalshi/models.hpp>

Public Attributes

std::string ticker
 
std::string event_ticker
 
MarketType market_type {}
 Identifies the type of market.
 
std::optional< std::string > title
 
std::optional< std::string > subtitle
 
std::string yes_sub_title
 Shortened title for the yes side of this market.
 
std::string no_sub_title
 Shortened title for the no side of this market.
 
std::string created_time
 
std::string updated_time
 Time of the last non-trading metadata update.
 
std::string open_time
 
std::string close_time
 
std::optional< std::string > expected_expiration_time
 Time when this market is expected to expire.
 
std::optional< std::string > expiration_time
 
std::string latest_expiration_time
 Latest possible time for this market to expire.
 
std::int64_t settlement_timer_seconds {}
 The amount of time after determination that the market settles.
 
MarketStatus status {}
 The current status of the market in its lifecycle.
 
FixedPointDollars yes_bid_dollars
 Price for the highest YES buy offer on this market in dollars.
 
FixedPointCount yes_bid_size_fp
 Total contract size of orders to buy YES at the best bid price (fixed-point count string).
 
FixedPointDollars yes_ask_dollars
 Price for the lowest YES sell offer on this market in dollars.
 
FixedPointCount yes_ask_size_fp
 Total contract size of orders to sell YES at the best ask price (fixed-point count string).
 
FixedPointDollars no_bid_dollars
 Price for the highest NO buy offer on this market in dollars.
 
FixedPointDollars no_ask_dollars
 Price for the lowest NO sell offer on this market in dollars.
 
FixedPointDollars last_price_dollars
 Price for the last traded YES contract on this market in dollars.
 
FixedPointCount volume_fp
 String representation of the market volume in contracts.
 
FixedPointCount volume_24h_fp
 String representation of the 24h market volume in contracts.
 
MarketResult result {}
 
bool can_close_early {}
 
FixedPointCount open_interest_fp
 String representation of the number of contracts bought on this market disconsidering netting.
 
FixedPointDollars notional_value_dollars
 The total value of a single contract at settlement in dollars.
 
FixedPointDollars previous_yes_bid_dollars
 Price for the highest YES buy offer on this market a day ago in dollars.
 
FixedPointDollars previous_yes_ask_dollars
 Price for the lowest YES sell offer on this market a day ago in dollars.
 
FixedPointDollars previous_price_dollars
 Price for the last traded YES contract on this market a day ago in dollars.
 
std::optional< FixedPointDollars > settlement_value_dollars
 The settlement value of the YES/LONG side of the contract in dollars.
 
std::optional< std::string > settlement_ts
 Timestamp when the market was settled.
 
std::string expiration_value
 The value that was considered for the settlement.
 
std::optional< std::string > occurrence_datetime
 The recorded datetime when the underlying event occurred, if available.
 
std::optional< std::string > fee_waiver_expiration_time
 Time when this market's fee waiver expires.
 
std::optional< std::string > early_close_condition
 The condition under which the market can close early.
 
std::optional< StrikeType > strike_type
 Strike type defines how the market strike is defined and evaluated.
 
std::optional< double > floor_strike
 Minimum expiration value that leads to a YES settlement.
 
std::optional< double > cap_strike
 Maximum expiration value that leads to a YES settlement.
 
std::optional< std::string > functional_strike
 Mapping from expiration values to settlement values.
 
std::optional< RawJson > custom_strike
 Expiration value for each target that leads to a YES settlement.
 
std::string rules_primary
 A plain language description of the most important market terms.
 
std::string rules_secondary
 A plain language description of secondary market terms.
 
std::optional< std::string > mve_collection_ticker
 The ticker of the multivariate event collection.
 
std::optional< std::vector< MveSelectedLeg > > mve_selected_legs
 
std::optional< std::string > primary_participant_key
 
std::string price_level_structure
 Price level structure for this market, defining price ranges and tick sizes.
 
std::vector< PriceRange > price_ranges
 Valid price ranges for orders on this market.
 
std::optional< bool > is_provisional
 If true, the market may be removed after determination if there is no activity on it.
 
std::optional< ExchangeIndex > exchange_index
 

Member Data Documentation

◆ ticker

std::string kalshi::Market::ticker

◆ event_ticker

std::string kalshi::Market::event_ticker

◆ market_type

MarketType kalshi::Market::market_type {}

Identifies the type of market.

◆ title

std::optional<std::string> kalshi::Market::title

◆ subtitle

std::optional<std::string> kalshi::Market::subtitle

◆ yes_sub_title

std::string kalshi::Market::yes_sub_title

Shortened title for the yes side of this market.

◆ no_sub_title

std::string kalshi::Market::no_sub_title

Shortened title for the no side of this market.

◆ created_time

std::string kalshi::Market::created_time

◆ updated_time

std::string kalshi::Market::updated_time

Time of the last non-trading metadata update.

◆ open_time

std::string kalshi::Market::open_time

◆ close_time

std::string kalshi::Market::close_time

◆ expected_expiration_time

std::optional<std::string> kalshi::Market::expected_expiration_time

Time when this market is expected to expire.

◆ expiration_time

std::optional<std::string> kalshi::Market::expiration_time

◆ latest_expiration_time

std::string kalshi::Market::latest_expiration_time

Latest possible time for this market to expire.

◆ settlement_timer_seconds

std::int64_t kalshi::Market::settlement_timer_seconds {}

The amount of time after determination that the market settles.

◆ status

MarketStatus kalshi::Market::status {}

The current status of the market in its lifecycle.

◆ yes_bid_dollars

FixedPointDollars kalshi::Market::yes_bid_dollars

Price for the highest YES buy offer on this market in dollars.

◆ yes_bid_size_fp

FixedPointCount kalshi::Market::yes_bid_size_fp

Total contract size of orders to buy YES at the best bid price (fixed-point count string).

◆ yes_ask_dollars

FixedPointDollars kalshi::Market::yes_ask_dollars

Price for the lowest YES sell offer on this market in dollars.

◆ yes_ask_size_fp

FixedPointCount kalshi::Market::yes_ask_size_fp

Total contract size of orders to sell YES at the best ask price (fixed-point count string).

◆ no_bid_dollars

FixedPointDollars kalshi::Market::no_bid_dollars

Price for the highest NO buy offer on this market in dollars.

◆ no_ask_dollars

FixedPointDollars kalshi::Market::no_ask_dollars

Price for the lowest NO sell offer on this market in dollars.

◆ last_price_dollars

FixedPointDollars kalshi::Market::last_price_dollars

Price for the last traded YES contract on this market in dollars.

◆ volume_fp

FixedPointCount kalshi::Market::volume_fp

String representation of the market volume in contracts.

◆ volume_24h_fp

FixedPointCount kalshi::Market::volume_24h_fp

String representation of the 24h market volume in contracts.

◆ result

MarketResult kalshi::Market::result {}

◆ can_close_early

bool kalshi::Market::can_close_early {}

◆ open_interest_fp

FixedPointCount kalshi::Market::open_interest_fp

String representation of the number of contracts bought on this market disconsidering netting.

◆ notional_value_dollars

FixedPointDollars kalshi::Market::notional_value_dollars

The total value of a single contract at settlement in dollars.

◆ previous_yes_bid_dollars

FixedPointDollars kalshi::Market::previous_yes_bid_dollars

Price for the highest YES buy offer on this market a day ago in dollars.

◆ previous_yes_ask_dollars

FixedPointDollars kalshi::Market::previous_yes_ask_dollars

Price for the lowest YES sell offer on this market a day ago in dollars.

◆ previous_price_dollars

FixedPointDollars kalshi::Market::previous_price_dollars

Price for the last traded YES contract on this market a day ago in dollars.

◆ settlement_value_dollars

std::optional<FixedPointDollars> kalshi::Market::settlement_value_dollars

The settlement value of the YES/LONG side of the contract in dollars.

◆ settlement_ts

std::optional<std::string> kalshi::Market::settlement_ts

Timestamp when the market was settled.

◆ expiration_value

std::string kalshi::Market::expiration_value

The value that was considered for the settlement.

◆ occurrence_datetime

std::optional<std::string> kalshi::Market::occurrence_datetime

The recorded datetime when the underlying event occurred, if available.

◆ fee_waiver_expiration_time

std::optional<std::string> kalshi::Market::fee_waiver_expiration_time

Time when this market's fee waiver expires.

◆ early_close_condition

std::optional<std::string> kalshi::Market::early_close_condition

The condition under which the market can close early.

◆ strike_type

std::optional<StrikeType> kalshi::Market::strike_type

Strike type defines how the market strike is defined and evaluated.

◆ floor_strike

std::optional<double> kalshi::Market::floor_strike

Minimum expiration value that leads to a YES settlement.

◆ cap_strike

std::optional<double> kalshi::Market::cap_strike

Maximum expiration value that leads to a YES settlement.

◆ functional_strike

std::optional<std::string> kalshi::Market::functional_strike

Mapping from expiration values to settlement values.

◆ custom_strike

std::optional<RawJson> kalshi::Market::custom_strike

Expiration value for each target that leads to a YES settlement.

◆ rules_primary

std::string kalshi::Market::rules_primary

A plain language description of the most important market terms.

◆ rules_secondary

std::string kalshi::Market::rules_secondary

A plain language description of secondary market terms.

◆ mve_collection_ticker

std::optional<std::string> kalshi::Market::mve_collection_ticker

The ticker of the multivariate event collection.

◆ mve_selected_legs

std::optional<std::vector<MveSelectedLeg> > kalshi::Market::mve_selected_legs

◆ primary_participant_key

std::optional<std::string> kalshi::Market::primary_participant_key

◆ price_level_structure

std::string kalshi::Market::price_level_structure

Price level structure for this market, defining price ranges and tick sizes.

◆ price_ranges

std::vector<PriceRange> kalshi::Market::price_ranges

Valid price ranges for orders on this market.

◆ is_provisional

std::optional<bool> kalshi::Market::is_provisional

If true, the market may be removed after determination if there is no activity on it.

◆ exchange_index

std::optional<ExchangeIndex> kalshi::Market::exchange_index

The documentation for this struct was generated from the following file: