kalshi::GetEventsParams Struct Reference

Query parameters for get_events. More...

#include <kalshi/models.hpp>

Public Attributes
std::optional< std::int64_t >	limit
	Parameter to specify the number of results per page.
std::optional< std::string >	cursor
	Parameter to specify the pagination cursor.
std::optional< bool >	with_nested_markets
	Parameter to specify if nested markets should be included in the response.
std::optional< bool >	with_milestones
	If true, includes related milestones as a field alongside events.
std::optional< GetEventsStatus >	status
	Filter by event status.
std::optional< std::string >	series_ticker
	Filter by series ticker.
std::optional< std::string >	tickers
	Filter by specific event tickers.
std::optional< std::int64_t >	min_close_ts
	Filter events with at least one market with close timestamp greater than this Unix timestamp (in seconds).
std::optional< std::int64_t >	min_updated_ts
	Filter events with metadata updated after this Unix timestamp (in seconds).

Detailed Description

Query parameters for get_events.

Member Data Documentation

limit

std::optional<std::int64_t> kalshi::GetEventsParams::limit

Parameter to specify the number of results per page.

cursor

std::optional<std::string> kalshi::GetEventsParams::cursor

Parameter to specify the pagination cursor.

with_nested_markets

std::optional<bool> kalshi::GetEventsParams::with_nested_markets

Parameter to specify if nested markets should be included in the response.

with_milestones

std::optional<bool> kalshi::GetEventsParams::with_milestones

If true, includes related milestones as a field alongside events.

status

std::optional<GetEventsStatus> kalshi::GetEventsParams::status

Filter by event status.

series_ticker

std::optional<std::string> kalshi::GetEventsParams::series_ticker

Filter by series ticker.

tickers

std::optional<std::string> kalshi::GetEventsParams::tickers

Filter by specific event tickers.

min_close_ts

std::optional<std::int64_t> kalshi::GetEventsParams::min_close_ts

Filter events with at least one market with close timestamp greater than this Unix timestamp (in seconds).

min_updated_ts

std::optional<std::int64_t> kalshi::GetEventsParams::min_updated_ts

Filter events with metadata updated after this Unix timestamp (in seconds).

---

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

• kalshi/models.hpp