kalshi::ws::UpdateSubscriptionParams Struct Reference

Options for update_subscription; the client sets the subscription. More...

#include <kalshi/ws_models.hpp>

Public Attributes
std::optional< std::string >	market_ticker
	Add/remove a single market.
std::vector< std::string >	market_tickers
	Add/remove multiple markets.
std::optional< std::string >	market_id
	Add/remove a single market by UUID (ticker only)
std::vector< std::string >	market_ids
	Add/remove multiple markets by UUID (ticker only)
std::optional< bool >	send_initial_snapshot
	If true, receive an initial snapshot for newly added market tickers on the ticker channel.
UpdateAction	action {}
std::vector< std::string >	index_ids
	CF Benchmarks index IDs to add or remove.
std::vector< std::string >	underlying_tickers
	Pyth underlyings to add or remove.

Detailed Description

Options for update_subscription; the client sets the subscription.

Member Data Documentation

market_ticker

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

Add/remove a single market.

market_tickers

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

Add/remove multiple markets.

market_id

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

Add/remove a single market by UUID (ticker only)

market_ids

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

Add/remove multiple markets by UUID (ticker only)

send_initial_snapshot

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

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

action

UpdateAction kalshi::ws::UpdateSubscriptionParams::action {}

index_ids

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

CF Benchmarks index IDs to add or remove.

underlying_tickers

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

Pyth underlyings to add or remove.

---

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

• kalshi/ws_models.hpp