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

#include <kalshi/models.hpp>

Public Attributes

std::string collection_ticker
 Unique identifier for the collection.
 
std::string series_ticker
 Series associated with the collection.
 
std::optional< ExchangeIndex > exchange_index
 Exchange index inherited from the collection's series.
 
std::string title
 Title of the collection.
 
std::string description
 Short description of the collection.
 
std::string open_date
 The open date of the collection.
 
std::string close_date
 The close date of the collection.
 
std::vector< AssociatedEvent > associated_events
 List of events with their individual configuration.
 
std::vector< std::string > associated_event_tickers
 [DEPRECATED - Use associated_events instead] A list of events associated with the collection.
 
bool is_ordered {}
 Whether the collection is ordered.
 
bool is_single_market_per_event {}
 [DEPRECATED - Use associated_events instead] Whether the collection accepts multiple markets from the same event passed into Lookup/Create.
 
bool is_all_yes {}
 [DEPRECATED - Use associated_events instead] Whether the collection requires that only the market side of 'yes' may be used.
 
std::int64_t size_min {}
 The minimum number of markets that must be passed into Lookup/Create (inclusive).
 
std::int64_t size_max {}
 The maximum number of markets that must be passed into Lookup/Create (inclusive).
 
std::string functional_description
 A functional description of the collection describing how inputs affect the output.
 

Member Data Documentation

◆ collection_ticker

std::string kalshi::MultivariateEventCollection::collection_ticker

Unique identifier for the collection.

◆ series_ticker

std::string kalshi::MultivariateEventCollection::series_ticker

Series associated with the collection.

◆ exchange_index

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

Exchange index inherited from the collection's series.

◆ title

std::string kalshi::MultivariateEventCollection::title

Title of the collection.

◆ description

std::string kalshi::MultivariateEventCollection::description

Short description of the collection.

◆ open_date

std::string kalshi::MultivariateEventCollection::open_date

The open date of the collection.

◆ close_date

std::string kalshi::MultivariateEventCollection::close_date

The close date of the collection.

◆ associated_events

std::vector<AssociatedEvent> kalshi::MultivariateEventCollection::associated_events

List of events with their individual configuration.

◆ associated_event_tickers

std::vector<std::string> kalshi::MultivariateEventCollection::associated_event_tickers

[DEPRECATED - Use associated_events instead] A list of events associated with the collection.

◆ is_ordered

bool kalshi::MultivariateEventCollection::is_ordered {}

Whether the collection is ordered.

◆ is_single_market_per_event

bool kalshi::MultivariateEventCollection::is_single_market_per_event {}

[DEPRECATED - Use associated_events instead] Whether the collection accepts multiple markets from the same event passed into Lookup/Create.

◆ is_all_yes

bool kalshi::MultivariateEventCollection::is_all_yes {}

[DEPRECATED - Use associated_events instead] Whether the collection requires that only the market side of 'yes' may be used.

◆ size_min

std::int64_t kalshi::MultivariateEventCollection::size_min {}

The minimum number of markets that must be passed into Lookup/Create (inclusive).

◆ size_max

std::int64_t kalshi::MultivariateEventCollection::size_max {}

The maximum number of markets that must be passed into Lookup/Create (inclusive).

◆ functional_description

std::string kalshi::MultivariateEventCollection::functional_description

A functional description of the collection describing how inputs affect the output.


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