Options for subscribe; the client sets the channel. More...

#include <kalshi/ws_models.hpp>

Public Attributes
std::optional< std::string >	market_ticker
	Subscribe to a single market.

std::vector< std::string >	market_tickers
	Subscribe to multiple markets.

std::optional< std::string >	market_id
	Subscribe to a single market by UUID (ticker only; mutually exclusive with market_ids and market_ticker(s))

std::vector< std::string >	market_ids
	Subscribe to multiple markets by UUID (ticker only; mutually exclusive with market_id and market_ticker(s))

std::optional< bool >	send_initial_snapshot
	If true, receive an initial snapshot for requested market tickers on the ticker channel.

std::optional< bool >	skip_ticker_ack
	If true, OK responses omit the market_tickers/market_ids lists for this subscription.

std::optional< bool >	use_yes_price
	Orderbook channel only.

std::optional< UserFilter >	user_filter
	Communications channel only.

std::optional< std::int64_t >	shard_factor
	Number of shards for communications channel fanout (optional)

std::optional< std::int64_t >	shard_key
	Shard key for communications channel fanout (requires shard_factor)

std::vector< std::string >	index_ids
	cfbenchmarks_value and cfbenchmarks_value_5hz channels only.

std::vector< std::string >	underlying_tickers
	pyth_value channel only.

Detailed Description

Options for subscribe; the client sets the channel.

Member Data Documentation

◆ market_ticker

std::optional<std::string> kalshi::ws::SubscribeParams::market_ticker

Subscribe to a single market.

◆ market_tickers

std::vector<std::string> kalshi::ws::SubscribeParams::market_tickers

Subscribe to multiple markets.

◆ market_id

std::optional<std::string> kalshi::ws::SubscribeParams::market_id

Subscribe to a single market by UUID (ticker only; mutually exclusive with market_ids and market_ticker(s))

◆ market_ids

std::vector<std::string> kalshi::ws::SubscribeParams::market_ids

Subscribe to multiple markets by UUID (ticker only; mutually exclusive with market_id and market_ticker(s))

◆ send_initial_snapshot

std::optional<bool> kalshi::ws::SubscribeParams::send_initial_snapshot

If true, receive an initial snapshot for requested market tickers on the ticker channel.

◆ skip_ticker_ack

std::optional<bool> kalshi::ws::SubscribeParams::skip_ticker_ack

If true, OK responses omit the market_tickers/market_ids lists for this subscription.

◆ use_yes_price

std::optional<bool> kalshi::ws::SubscribeParams::use_yes_price

Orderbook channel only.

◆ user_filter

std::optional<UserFilter> kalshi::ws::SubscribeParams::user_filter

Communications channel only.

◆ shard_factor

std::optional<std::int64_t> kalshi::ws::SubscribeParams::shard_factor

Number of shards for communications channel fanout (optional)

◆ shard_key

std::optional<std::int64_t> kalshi::ws::SubscribeParams::shard_key

Shard key for communications channel fanout (requires shard_factor)

◆ index_ids

std::vector<std::string> kalshi::ws::SubscribeParams::index_ids

cfbenchmarks_value and cfbenchmarks_value_5hz channels only.

◆ underlying_tickers

std::vector<std::string> kalshi::ws::SubscribeParams::underlying_tickers

pyth_value channel only.

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

kalshi/ws_models.hpp

Public Attributes