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

#include <kalshi/models.hpp>

Public Attributes

std::string ticker
 Ticker that identifies this series.
 
std::string frequency
 Description of the frequency of the series.
 
std::string title
 Title describing the series.
 
std::string category
 Category is the primary category of this series.
 
std::vector< std::string > categories
 Categories is the list of discovery categories for this series.
 
std::optional< std::vector< std::string > > tags
 Tags specifies the subjects that this series relates to, multiple series from different categories can have the same tags.
 
std::optional< std::vector< SettlementSource > > settlement_sources
 SettlementSources specifies the official sources used for the determination of markets within the series.
 
std::string contract_url
 ContractUrl provides a direct link to the original filing of the contract which underlies the series.
 
std::string contract_terms_url
 ContractTermsUrl is the URL to the current terms of the contract underlying the series.
 
std::optional< RawJson > product_metadata
 Internal product metadata of the series.
 
FeeType fee_type {}
 FeeType is a string representing the series' fee structure.
 
double fee_multiplier {}
 FeeMultiplier is a floating point multiplier applied to the fee calculations.
 
std::optional< std::vector< std::string > > additional_prohibitions
 AdditionalProhibitions is a list of additional trading prohibitions for this series.
 
std::optional< FixedPointCount > volume_fp
 String representation of the total number of contracts traded across all events in this series.
 
std::optional< std::string > last_updated_ts
 Timestamp of when this series' metadata was last updated.
 
std::optional< ExchangeIndex > exchange_index
 

Member Data Documentation

◆ ticker

std::string kalshi::Series::ticker

Ticker that identifies this series.

◆ frequency

std::string kalshi::Series::frequency

Description of the frequency of the series.

◆ title

std::string kalshi::Series::title

Title describing the series.

◆ category

std::string kalshi::Series::category

Category is the primary category of this series.

◆ categories

std::vector<std::string> kalshi::Series::categories

Categories is the list of discovery categories for this series.

◆ tags

std::optional<std::vector<std::string> > kalshi::Series::tags

Tags specifies the subjects that this series relates to, multiple series from different categories can have the same tags.

◆ settlement_sources

std::optional<std::vector<SettlementSource> > kalshi::Series::settlement_sources

SettlementSources specifies the official sources used for the determination of markets within the series.

◆ contract_url

std::string kalshi::Series::contract_url

ContractUrl provides a direct link to the original filing of the contract which underlies the series.

◆ contract_terms_url

std::string kalshi::Series::contract_terms_url

ContractTermsUrl is the URL to the current terms of the contract underlying the series.

◆ product_metadata

std::optional<RawJson> kalshi::Series::product_metadata

Internal product metadata of the series.

◆ fee_type

FeeType kalshi::Series::fee_type {}

FeeType is a string representing the series' fee structure.

◆ fee_multiplier

double kalshi::Series::fee_multiplier {}

FeeMultiplier is a floating point multiplier applied to the fee calculations.

◆ additional_prohibitions

std::optional<std::vector<std::string> > kalshi::Series::additional_prohibitions

AdditionalProhibitions is a list of additional trading prohibitions for this series.

◆ volume_fp

std::optional<FixedPointCount> kalshi::Series::volume_fp

String representation of the total number of contracts traded across all events in this series.

◆ last_updated_ts

std::optional<std::string> kalshi::Series::last_updated_ts

Timestamp of when this series' metadata was last updated.

◆ exchange_index

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

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