kalshi::KalshiClient Class Reference

Client for the Kalshi Predictions REST API. More...

#include <kalshi/api.hpp>

Public Member Functions
	KalshiClient (HttpClient client)
	Uses a libcurl client. It signs requests when constructed with a Signer.
	KalshiClient (std::shared_ptr< const HttpTransport > transport)
	Uses any transport, such as RetryingTransport or a test double.
	~KalshiClient ()
	KalshiClient (KalshiClient &&) noexcept
KalshiClient &	operator= (KalshiClient &&) noexcept
	KalshiClient (const KalshiClient &)=delete
KalshiClient &	operator= (const KalshiClient &)=delete
const HttpTransport &	transport () const noexcept
Result< GetAccountApiLimitsResponse >	get_account_api_limits ()
	Get Account API Limits GET /account/limits
Result< void >	upgrade_account_api_usage_level ()
	Upgrade Account API Usage Level POST /account/api_usage_level/upgrade
Result< std::vector< AccountApiUsageLevelVolumeProgress > >	get_account_api_usage_level_volume_progress ()
	Get Account API Usage Level Volume Progress GET /account/api_usage_level/volume_progress
Result< GetAccountEndpointCostsResponse >	get_account_endpoint_costs ()
	List Non-Default Endpoint Costs GET /account/endpoint_costs
Result< GetApiKeysResponse >	get_api_keys (const GetApiKeysParams &params={})
	Get API Keys GET /api_keys
Result< CreateApiKeyResponse >	create_api_key (const CreateApiKeyRequest &body)
	Create API Key POST /api_keys
Result< GenerateApiKeyResponse >	generate_api_key (const GenerateApiKeyRequest &body)
	Generate API Key POST /api_keys/generate
Result< void >	delete_api_key (std::string_view api_key)
	Delete API Key DELETE /api_keys/{api_key}
Result< std::string >	get_communications_id ()
	Get Communications ID GET /communications/id
Result< GetBlockTradeProposalsResponse >	get_block_trade_proposals (const GetBlockTradeProposalsParams &params={})
	Get Block Trade Proposals GET /communications/block-trade-proposals
Result< std::string >	propose_block_trade (const ProposeBlockTradeRequest &body)
	Propose Block Trade POST /communications/block-trade-proposals
Result< void >	accept_block_trade_proposal (std::string_view block_trade_proposal_id, const AcceptBlockTradeProposalRequest &body)
	Accept Block Trade Proposal POST /communications/block-trade-proposals/{block_trade_proposal_id}/accept
Result< GetRFQsResponse >	get_rfqs (const GetRfqsParams &params={})
	Get RFQs GET /communications/rfqs
Result< std::string >	create_rfq (const CreateRFQRequest &body)
	Create RFQ POST /communications/rfqs
Result< RFQ >	get_rfq (std::string_view rfq_id)
	Get RFQ GET /communications/rfqs/{rfq_id}
Result< void >	delete_rfq (std::string_view rfq_id)
	Delete RFQ DELETE /communications/rfqs/{rfq_id}
Result< Quote >	get_rfq_quote (std::string_view rfq_id, std::string_view quote_id)
	Get RFQ Quote GET /communications/rfqs/{rfq_id}/quotes/{quote_id}
Result< void >	delete_rfq_quote (std::string_view rfq_id, std::string_view quote_id)
	Delete RFQ Quote DELETE /communications/rfqs/{rfq_id}/quotes/{quote_id}
Result< void >	accept_rfq_quote (std::string_view rfq_id, std::string_view quote_id, const AcceptQuoteRequest &body)
	Accept RFQ Quote PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/accept
Result< void >	confirm_rfq_quote (std::string_view rfq_id, std::string_view quote_id)
	Confirm RFQ Quote PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/confirm
Result< GetQuotesResponse >	get_quotes (const GetQuotesParams &params={})
	Get Quotes GET /communications/quotes
Result< std::string >	create_quote (const CreateQuoteRequest &body)
	Create Quote POST /communications/quotes
Result< Quote >	get_quote (std::string_view quote_id)
	Get Quote GET /communications/quotes/{quote_id}
Result< void >	delete_quote (std::string_view quote_id)
	Delete Quote DELETE /communications/quotes/{quote_id}
Result< void >	accept_quote (std::string_view quote_id, const AcceptQuoteRequest &body)
	Accept Quote PUT /communications/quotes/{quote_id}/accept
Result< void >	confirm_quote (std::string_view quote_id)
	Confirm Quote PUT /communications/quotes/{quote_id}/confirm
Result< GetEventCandlesticksResponse >	get_market_candlesticks_by_event (std::string_view series_ticker, std::string_view ticker, const GetMarketCandlesticksByEventParams &params)
	Get Event Candlesticks GET /series/{series_ticker}/events/{ticker}/candlesticks
Result< GetEventsResponse >	get_events (const GetEventsParams &params={})
	Get Events GET /events
Result< GetMultivariateEventsResponse >	get_multivariate_events (const GetMultivariateEventsParams &params={})
	Get Multivariate Events GET /events/multivariate
Result< GetEventFeeChangesResponse >	get_event_fee_changes (const GetEventFeeChangesParams &params={})
	Get Event Fee Changes GET /events/fee_changes
Result< GetEventResponse >	get_event (std::string_view event_ticker, const GetEventParams &params={})
	Get Event GET /events/{event_ticker}
Result< GetEventMetadataResponse >	get_event_metadata (std::string_view event_ticker)
	Get Event Metadata GET /events/{event_ticker}/metadata
Result< std::vector< ForecastPercentilesPoint > >	get_event_forecast_percentiles_history (std::string_view series_ticker, std::string_view ticker, const GetEventForecastPercentilesHistoryParams &params)
	Get Event Forecast Percentile History GET /series/{series_ticker}/events/{ticker}/forecast_percentile_history
Result< ExchangeStatus >	get_exchange_status ()
	Get Exchange Status GET /exchange/status
Result< std::vector< SeriesFeeChange > >	get_series_fee_changes (const GetSeriesFeeChangesParams &params={})
	Get Series Fee Changes GET /series/fee_changes
Result< Schedule >	get_exchange_schedule ()
	Get Exchange Schedule GET /exchange/schedule
Result< std::string >	get_user_data_timestamp ()
	Get User Data Timestamp GET /exchange/user_data_timestamp
Result< GetFcmFillsResponse >	get_fcm_fills (const GetFcmFillsParams &params={})
	Get FCM Fills GET /fcm/fills
Result< GetOrdersResponse >	get_fcm_orders (const GetFcmOrdersParams &params={})
	Get FCM Orders GET /fcm/orders
Result< std::vector< FCMSubtrader > >	get_fcm_subtraders ()
	List FCM Subtraders GET /fcm/subtraders
Result< std::string >	create_fcm_subtrader (const CreateFCMSubtraderRequest &body)
	Create FCM Subtrader POST /fcm/subtraders
Result< GetFCMEventContractDailyCapResponse >	get_fcm_event_contract_daily_cap (const GetFcmEventContractDailyCapParams &params={})
	Get FCM Subtrader Event Contract Daily Cap GET /fcm/subtraders/event_contract_daily_cap
Result< void >	update_fcm_event_contract_daily_cap (const UpdateFCMEventContractDailyCapRequest &body)
	Update FCM Subtrader Event Contract Daily Cap PUT /fcm/subtraders/event_contract_daily_cap
Result< void >	delete_fcm_event_contract_daily_cap (const DeleteFcmEventContractDailyCapParams &params)
	Delete FCM Subtrader Event Contract Daily Cap DELETE /fcm/subtraders/event_contract_daily_cap
Result< std::vector< std::string > >	get_fcm_subtrader_blocked_categories (const GetFcmSubtraderBlockedCategoriesParams &params)
	Get FCM Subtrader Blocked Categories GET /fcm/subtraders/blocked_categories
Result< std::vector< std::string > >	update_fcm_subtrader_blocked_categories (const UpdateFCMSubtraderBlockedCategoriesRequest &body)
	Update FCM Subtrader Blocked Categories PUT /fcm/subtraders/blocked_categories
Result< GetPositionsResponse >	get_fcm_positions (const GetFcmPositionsParams &params={})
	Get FCM Positions GET /fcm/positions
Result< GetHistoricalCutoffResponse >	get_historical_cutoff ()
	Get Historical Cutoff Timestamps GET /historical/cutoff
Result< GetMarketCandlesticksHistoricalResponse >	get_market_candlesticks_historical (std::string_view ticker, const GetMarketCandlesticksHistoricalParams &params)
	Get Historical Market Candlesticks GET /historical/markets/{ticker}/candlesticks
Result< GetFillsResponse >	get_fills_historical (const GetFillsHistoricalParams &params={})
	Get Historical Fills GET /historical/fills
Result< GetOrdersResponse >	get_historical_orders (const GetHistoricalOrdersParams &params={})
	Get Historical Orders GET /historical/orders
Result< GetPositionsResponse >	get_historical_positions (const GetHistoricalPositionsParams &params={})
	Get Historical Positions GET /historical/positions
Result< GetTradesResponse >	get_trades_historical (const GetTradesHistoricalParams &params={})
	Get Historical Trades GET /historical/trades
Result< GetMarketsResponse >	get_historical_markets (const GetHistoricalMarketsParams &params={})
	Get Historical Markets GET /historical/markets
Result< Market >	get_historical_market (std::string_view ticker)
	Get Historical Market GET /historical/markets/{ticker}
Result< GetIncentiveProgramsResponse >	get_incentive_programs (const GetIncentiveProgramsParams &params={})
	Get Incentives GET /incentive_programs
Result< LiveData >	get_live_data_by_milestone (std::string_view milestone_id, const GetLiveDataByMilestoneParams &params={})
	Get Live Data GET /live_data/milestone/{milestone_id}
Result< LiveData >	get_live_data (std::string_view type, std::string_view milestone_id, const GetLiveDataParams &params={})
	Get Live Data (with type) GET /live_data/{type}/milestone/{milestone_id}
Result< std::vector< LiveData > >	get_live_datas (const GetLiveDatasParams &params)
	Get Multiple Live Data GET /live_data/batch
Result< std::optional< PlayByPlay > >	get_game_stats (std::string_view milestone_id)
	Get Game Stats GET /live_data/milestone/{milestone_id}/game_stats
Result< EventLiveData >	get_event_live_data (std::string_view event_ticker, const GetEventLiveDataParams &params={})
	Get Event Live Data GET /live_data/events/{event_ticker}
Result< GetWeatherIndexResponse >	get_weather_index (std::string_view city, const GetWeatherIndexParams &params={})
	Get Weather Index GET /live_data/weather/{city}
Result< GetWeatherIndexCalibrationsResponse >	get_weather_index_calibrations (std::string_view city)
	Get Weather Index Calibrations GET /live_data/weather/{city}/calibrations
Result< GetMarketCandlesticksResponse >	get_market_candlesticks (std::string_view series_ticker, std::string_view ticker, const GetMarketCandlesticksParams &params)
	Get Market Candlesticks GET /series/{series_ticker}/markets/{ticker}/candlesticks
Result< GetTradesResponse >	get_trades (const GetTradesParams &params={})
	Get Trades GET /markets/trades
Result< OrderbookCountFp >	get_market_orderbook (std::string_view ticker, const GetMarketOrderbookParams &params={})
	Get Market Orderbook GET /markets/{ticker}/orderbook
Result< std::vector< MarketOrderbookFp > >	get_market_orderbooks (const GetMarketOrderbooksParams &params)
	Get Multiple Market Orderbooks GET /markets/orderbooks
Result< Series >	get_series (std::string_view series_ticker, const GetSeriesParams &params={})
	Get Series GET /series/{series_ticker}
Result< std::vector< Series > >	get_series_list (const GetSeriesListParams &params={})
	Get Series List GET /series
Result< GetMarketsResponse >	get_markets (const GetMarketsParams &params={})
	Get Markets GET /markets
Result< Market >	get_market (std::string_view ticker)
	Get Market GET /markets/{ticker}
Result< std::vector< MarketCandlesticksResponse > >	batch_get_market_candlesticks (const BatchGetMarketCandlesticksParams &params)
	Batch Get Market Candlesticks GET /markets/candlesticks
Result< Milestone >	get_milestone (std::string_view milestone_id)
	Get Milestone GET /milestones/{milestone_id}
Result< GetMilestonesResponse >	get_milestones (const GetMilestonesParams &params)
	Get Milestones GET /milestones
Result< MultivariateEventCollection >	get_multivariate_event_collection (std::string_view collection_ticker)
	Get Multivariate Event Collection GET /multivariate_event_collections/{collection_ticker}
Result< CreateMarketInMultivariateEventCollectionResponse >	create_market_in_multivariate_event_collection (std::string_view collection_ticker, const CreateMarketInMultivariateEventCollectionRequest &body)
	Create Market In Multivariate Event Collection POST /multivariate_event_collections/{collection_ticker}
Result< GetMultivariateEventCollectionsResponse >	get_multivariate_event_collections (const GetMultivariateEventCollectionsParams &params={})
	Get Multivariate Event Collections GET /multivariate_event_collections
Result< std::optional< std::vector< OrderGroup > > >	get_order_groups (const GetOrderGroupsParams &params={})
	Get Order Groups GET /portfolio/order_groups
Result< CreateOrderGroupResponse >	create_order_group (const CreateOrderGroupRequest &body)
	Create Order Group POST /portfolio/order_groups/create
Result< GetOrderGroupResponse >	get_order_group (std::string_view order_group_id, const GetOrderGroupParams &params={})
	Get Order Group GET /portfolio/order_groups/{order_group_id}
Result< void >	delete_order_group (std::string_view order_group_id, const DeleteOrderGroupParams &params={})
	Delete Order Group DELETE /portfolio/order_groups/{order_group_id}
Result< void >	reset_order_group (std::string_view order_group_id, const ResetOrderGroupParams &params={})
	Reset Order Group PUT /portfolio/order_groups/{order_group_id}/reset
Result< void >	trigger_order_group (std::string_view order_group_id, const TriggerOrderGroupParams &params={})
	Trigger Order Group PUT /portfolio/order_groups/{order_group_id}/trigger
Result< void >	update_order_group_limit (std::string_view order_group_id, const UpdateOrderGroupLimitRequest &body, const UpdateOrderGroupLimitParams &params={})
	Update Order Group Limit PUT /portfolio/order_groups/{order_group_id}/limit
Result< GetOrdersResponse >	get_orders (const GetOrdersParams &params={})
	Get Orders GET /portfolio/orders
Result< Order >	get_order (std::string_view order_id)
	Get Order GET /portfolio/orders/{order_id}
Result< std::vector< OrderQueuePosition > >	get_order_queue_positions (const GetOrderQueuePositionsParams &params={})
	Get Queue Positions for Orders GET /portfolio/orders/queue_positions
Result< FixedPointCount >	get_order_queue_position (std::string_view order_id)
	Get Order Queue Position GET /portfolio/orders/{order_id}/queue_position
Result< CreateOrderV2Response >	create_order (const CreateOrderV2Request &body)
	Create Order POST /portfolio/events/orders
Result< void >	cancel_all_orders (const CancelAllOrdersParams &params={})
	Cancel All Orders DELETE /portfolio/events/orders
Result< std::vector< BatchCreateOrdersV2ResponseOrdersItem > >	batch_create_orders (const BatchCreateOrdersV2Request &body)
	Batch Create Orders POST /portfolio/events/orders/batched
Result< std::vector< BatchCancelOrdersV2ResponseOrdersItem > >	batch_cancel_orders (const BatchCancelOrdersV2Request &body)
	Batch Cancel Orders DELETE /portfolio/events/orders/batched
Result< CancelOrderV2Response >	cancel_order (std::string_view order_id, const CancelOrderParams &params={})
	Cancel Order DELETE /portfolio/events/orders/{order_id}
Result< AmendOrderV2Response >	amend_order (std::string_view order_id, const AmendOrderV2Request &body, const AmendOrderParams &params={})
	Amend Order POST /portfolio/events/orders/{order_id}/amend
Result< DecreaseOrderV2Response >	decrease_order (std::string_view order_id, const DecreaseOrderV2Request &body, const DecreaseOrderParams &params={})
	Decrease Order POST /portfolio/events/orders/{order_id}/decrease
Result< GetBalanceResponse >	get_balance (const GetBalanceParams &params={})
	Get Balance GET /portfolio/balance
Result< std::string >	intra_exchange_instance_transfer (const IntraExchangeInstanceTransferRequest &body)
	Intra Account Transfer POST /portfolio/intra_exchange_instance_transfer
Result< GetIntraExchangeInstanceTransfersResponse >	get_intra_exchange_instance_transfers (const GetIntraExchangeInstanceTransfersParams &params={})
	Get Intra Account Transfers GET /portfolio/intra_exchange_instance_transfers
Result< IntraExchangeInstanceTransfer >	get_intra_exchange_instance_transfer (std::string_view transfer_id)
	Get Intra Account Transfer GET /portfolio/intra_exchange_instance_transfers/{transfer_id}
Result< std::int64_t >	create_subaccount (const CreateSubaccountRequest &body)
	Create Subaccount POST /portfolio/subaccounts
Result< void >	apply_subaccount_transfer (const ApplySubaccountTransferRequest &body)
	Transfer Between Subaccounts POST /portfolio/subaccounts/transfer
Result< std::vector< SubaccountBalance > >	get_subaccount_balances ()
	Get All Subaccount Balances GET /portfolio/subaccounts/balances
Result< GetSubaccountTransfersResponse >	get_subaccount_transfers (const GetSubaccountTransfersParams &params={})
	Get Subaccount Transfers GET /portfolio/subaccounts/transfers
Result< std::vector< SubaccountNettingConfig > >	get_subaccount_netting ()
	Get Subaccount Netting GET /portfolio/subaccounts/netting
Result< void >	update_subaccount_netting (const UpdateSubaccountNettingRequest &body)
	Update Subaccount Netting PUT /portfolio/subaccounts/netting
Result< GetPositionsResponse >	get_positions (const GetPositionsParams &params={})
	Get Positions GET /portfolio/positions
Result< GetSettlementsResponse >	get_settlements (const GetSettlementsParams &params={})
	Get Settlements GET /portfolio/settlements
Result< GetDepositsResponse >	get_deposits (const GetDepositsParams &params={})
	Get Deposits GET /portfolio/deposits
Result< GetWithdrawalsResponse >	get_withdrawals (const GetWithdrawalsParams &params={})
	Get Withdrawals GET /portfolio/withdrawals
Result< GetPortfolioRestingOrderTotalValueResponse >	get_portfolio_resting_order_total_value ()
	Get Total Resting Order Value GET /portfolio/summary/total_resting_order_value
Result< GetFillsResponse >	get_fills (const GetFillsParams &params={})
	Get Fills GET /portfolio/fills
Result< GetTargetBalanceAllocationResponse >	get_target_balance_allocation ()
	Get Target Balance Allocation GET /portfolio/target_balance_allocation
Result< void >	set_target_balance_allocation (const SetTargetBalanceAllocationRequest &body)
	Set Target Balance Allocation POST /portfolio/target_balance_allocation
Result< std::map< std::string, std::vector< std::string > > >	get_tags_for_series_categories ()
	Get Tags for Series Categories GET /search/tags_by_categories
Result< GetFiltersBySportsResponse >	get_filters_for_sports ()
	Get Filters for Sports GET /search/filters_by_sport
Result< GetStructuredTargetsResponse >	get_structured_targets (const GetStructuredTargetsParams &params={})
	Get Structured Targets GET /structured_targets
Result< std::optional< StructuredTarget > >	get_structured_target (std::string_view structured_target_id)
	Get Structured Target GET /structured_targets/{structured_target_id}

Detailed Description

Client for the Kalshi Predictions REST API.

Each method maps to one operation in Kalshi's OpenAPI document, named after its operationId.

Failures come back as Error: InvalidRequest for a request the SDK rejects before sending or another HTTP 4xx, AuthenticationError, NotFound, RateLimited, ServerError, NetworkError, ParseError, or SigningError. Error::api_code carries Kalshi's machine-readable code when it sends one.

Constructor & Destructor Documentation

KalshiClient() [1/4]

kalshi::KalshiClient::KalshiClient ( HttpClient  client )

explicit

Uses a libcurl client. It signs requests when constructed with a Signer.

KalshiClient() [2/4]

kalshi::KalshiClient::KalshiClient ( std::shared_ptr< const HttpTransport >  transport )

explicit

Uses any transport, such as RetryingTransport or a test double.

~KalshiClient()

kalshi::KalshiClient::~KalshiClient

(

)

KalshiClient() [3/4]

kalshi::KalshiClient::KalshiClient ( KalshiClient &&  )

noexcept

KalshiClient() [4/4]

kalshi::KalshiClient::KalshiClient ( const KalshiClient &  )

delete

Member Function Documentation

operator=() [1/2]

KalshiClient & kalshi::KalshiClient::operator= ( KalshiClient &&  )

noexcept

operator=() [2/2]

KalshiClient & kalshi::KalshiClient::operator= ( const KalshiClient &  )

delete

transport()

const HttpTransport & kalshi::KalshiClient::transport ( ) const

noexcept

get_account_api_limits()

Result< GetAccountApiLimitsResponse > kalshi::KalshiClient::get_account_api_limits

(

)

Get Account API Limits GET /account/limits

upgrade_account_api_usage_level()

Result< void > kalshi::KalshiClient::upgrade_account_api_usage_level

(

)

Upgrade Account API Usage Level POST /account/api_usage_level/upgrade

get_account_api_usage_level_volume_progress()

Result< std::vector< AccountApiUsageLevelVolumeProgress > > kalshi::KalshiClient::get_account_api_usage_level_volume_progress

(

)

Get Account API Usage Level Volume Progress GET /account/api_usage_level/volume_progress

get_account_endpoint_costs()

Result< GetAccountEndpointCostsResponse > kalshi::KalshiClient::get_account_endpoint_costs

(

)

List Non-Default Endpoint Costs GET /account/endpoint_costs

get_api_keys()

Result< GetApiKeysResponse > kalshi::KalshiClient::get_api_keys

(

const GetApiKeysParams &

params = {}

)

Get API Keys GET /api_keys

create_api_key()

Result< CreateApiKeyResponse > kalshi::KalshiClient::create_api_key

(

const CreateApiKeyRequest &

body

)

Create API Key POST /api_keys

generate_api_key()

Result< GenerateApiKeyResponse > kalshi::KalshiClient::generate_api_key

(

const GenerateApiKeyRequest &

body

)

Generate API Key POST /api_keys/generate

delete_api_key()

Result< void > kalshi::KalshiClient::delete_api_key

(

std::string_view

api_key

)

Delete API Key DELETE /api_keys/{api_key}

get_communications_id()

Result< std::string > kalshi::KalshiClient::get_communications_id

(

)

Get Communications ID GET /communications/id

get_block_trade_proposals()

Result< GetBlockTradeProposalsResponse > kalshi::KalshiClient::get_block_trade_proposals

(

const GetBlockTradeProposalsParams &

params = {}

)

Get Block Trade Proposals GET /communications/block-trade-proposals

propose_block_trade()

Result< std::string > kalshi::KalshiClient::propose_block_trade

(

const ProposeBlockTradeRequest &

body

)

Propose Block Trade POST /communications/block-trade-proposals

accept_block_trade_proposal()

Result< void > kalshi::KalshiClient::accept_block_trade_proposal	(	std::string_view	block_trade_proposal_id,
		const AcceptBlockTradeProposalRequest &	body
	)

Accept Block Trade Proposal POST /communications/block-trade-proposals/{block_trade_proposal_id}/accept

get_rfqs()

Result< GetRFQsResponse > kalshi::KalshiClient::get_rfqs

(

const GetRfqsParams &

params = {}

)

Get RFQs GET /communications/rfqs

create_rfq()

Result< std::string > kalshi::KalshiClient::create_rfq

(

const CreateRFQRequest &

body

)

Create RFQ POST /communications/rfqs

get_rfq()

Result< RFQ > kalshi::KalshiClient::get_rfq

(

std::string_view

rfq_id

)

Get RFQ GET /communications/rfqs/{rfq_id}

delete_rfq()

Result< void > kalshi::KalshiClient::delete_rfq

(

std::string_view

rfq_id

)

Delete RFQ DELETE /communications/rfqs/{rfq_id}

get_rfq_quote()

Result< Quote > kalshi::KalshiClient::get_rfq_quote	(	std::string_view	rfq_id,
		std::string_view	quote_id
	)

Get RFQ Quote GET /communications/rfqs/{rfq_id}/quotes/{quote_id}

delete_rfq_quote()

Result< void > kalshi::KalshiClient::delete_rfq_quote	(	std::string_view	rfq_id,
		std::string_view	quote_id
	)

Delete RFQ Quote DELETE /communications/rfqs/{rfq_id}/quotes/{quote_id}

accept_rfq_quote()

Result< void > kalshi::KalshiClient::accept_rfq_quote	(	std::string_view	rfq_id,
		std::string_view	quote_id,
		const AcceptQuoteRequest &	body
	)

Accept RFQ Quote PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/accept

confirm_rfq_quote()

Result< void > kalshi::KalshiClient::confirm_rfq_quote	(	std::string_view	rfq_id,
		std::string_view	quote_id
	)

Confirm RFQ Quote PUT /communications/rfqs/{rfq_id}/quotes/{quote_id}/confirm

get_quotes()

Result< GetQuotesResponse > kalshi::KalshiClient::get_quotes

(

const GetQuotesParams &

params = {}

)

Get Quotes GET /communications/quotes

create_quote()

Result< std::string > kalshi::KalshiClient::create_quote

(

const CreateQuoteRequest &

body

)

Create Quote POST /communications/quotes

get_quote()

Result< Quote > kalshi::KalshiClient::get_quote

(

std::string_view

quote_id

)

Get Quote GET /communications/quotes/{quote_id}

delete_quote()

Result< void > kalshi::KalshiClient::delete_quote

(

std::string_view

quote_id

)

Delete Quote DELETE /communications/quotes/{quote_id}

accept_quote()

Result< void > kalshi::KalshiClient::accept_quote	(	std::string_view	quote_id,
		const AcceptQuoteRequest &	body
	)

Accept Quote PUT /communications/quotes/{quote_id}/accept

confirm_quote()

Result< void > kalshi::KalshiClient::confirm_quote

(

std::string_view

quote_id

)

Confirm Quote PUT /communications/quotes/{quote_id}/confirm

get_market_candlesticks_by_event()

Result< GetEventCandlesticksResponse > kalshi::KalshiClient::get_market_candlesticks_by_event	(	std::string_view	series_ticker,
		std::string_view	ticker,
		const GetMarketCandlesticksByEventParams &	params
	)

Get Event Candlesticks GET /series/{series_ticker}/events/{ticker}/candlesticks

get_events()

Result< GetEventsResponse > kalshi::KalshiClient::get_events

(

const GetEventsParams &

params = {}

)

Get Events GET /events

get_multivariate_events()

Result< GetMultivariateEventsResponse > kalshi::KalshiClient::get_multivariate_events

(

const GetMultivariateEventsParams &

params = {}

)

Get Multivariate Events GET /events/multivariate

get_event_fee_changes()

Result< GetEventFeeChangesResponse > kalshi::KalshiClient::get_event_fee_changes

(

const GetEventFeeChangesParams &

params = {}

)

Get Event Fee Changes GET /events/fee_changes

get_event()

Result< GetEventResponse > kalshi::KalshiClient::get_event	(	std::string_view	event_ticker,
		const GetEventParams &	params = {}
	)

Get Event GET /events/{event_ticker}

get_event_metadata()

Result< GetEventMetadataResponse > kalshi::KalshiClient::get_event_metadata

(

std::string_view

event_ticker

)

Get Event Metadata GET /events/{event_ticker}/metadata

get_event_forecast_percentiles_history()

Result< std::vector< ForecastPercentilesPoint > > kalshi::KalshiClient::get_event_forecast_percentiles_history	(	std::string_view	series_ticker,
		std::string_view	ticker,
		const GetEventForecastPercentilesHistoryParams &	params
	)

Get Event Forecast Percentile History GET /series/{series_ticker}/events/{ticker}/forecast_percentile_history

get_exchange_status()

Result< ExchangeStatus > kalshi::KalshiClient::get_exchange_status

(

)

Get Exchange Status GET /exchange/status

get_series_fee_changes()

Result< std::vector< SeriesFeeChange > > kalshi::KalshiClient::get_series_fee_changes

(

const GetSeriesFeeChangesParams &

params = {}

)

Get Series Fee Changes GET /series/fee_changes

get_exchange_schedule()

Result< Schedule > kalshi::KalshiClient::get_exchange_schedule

(

)

Get Exchange Schedule GET /exchange/schedule

get_user_data_timestamp()

Result< std::string > kalshi::KalshiClient::get_user_data_timestamp

(

)

Get User Data Timestamp GET /exchange/user_data_timestamp

get_fcm_fills()

Result< GetFcmFillsResponse > kalshi::KalshiClient::get_fcm_fills

(

const GetFcmFillsParams &

params = {}

)

Get FCM Fills GET /fcm/fills

get_fcm_orders()

Result< GetOrdersResponse > kalshi::KalshiClient::get_fcm_orders

(

const GetFcmOrdersParams &

params = {}

)

Get FCM Orders GET /fcm/orders

get_fcm_subtraders()

Result< std::vector< FCMSubtrader > > kalshi::KalshiClient::get_fcm_subtraders

(

)

List FCM Subtraders GET /fcm/subtraders

create_fcm_subtrader()

Result< std::string > kalshi::KalshiClient::create_fcm_subtrader

(

const CreateFCMSubtraderRequest &

body

)

Create FCM Subtrader POST /fcm/subtraders

get_fcm_event_contract_daily_cap()

Result< GetFCMEventContractDailyCapResponse > kalshi::KalshiClient::get_fcm_event_contract_daily_cap

(

const GetFcmEventContractDailyCapParams &

params = {}

)

Get FCM Subtrader Event Contract Daily Cap GET /fcm/subtraders/event_contract_daily_cap

update_fcm_event_contract_daily_cap()

Result< void > kalshi::KalshiClient::update_fcm_event_contract_daily_cap

(

const UpdateFCMEventContractDailyCapRequest &

body

)

Update FCM Subtrader Event Contract Daily Cap PUT /fcm/subtraders/event_contract_daily_cap

delete_fcm_event_contract_daily_cap()

Result< void > kalshi::KalshiClient::delete_fcm_event_contract_daily_cap

(

const DeleteFcmEventContractDailyCapParams &

params

)

Delete FCM Subtrader Event Contract Daily Cap DELETE /fcm/subtraders/event_contract_daily_cap

get_fcm_subtrader_blocked_categories()

Result< std::vector< std::string > > kalshi::KalshiClient::get_fcm_subtrader_blocked_categories

(

const GetFcmSubtraderBlockedCategoriesParams &

params

)

Get FCM Subtrader Blocked Categories GET /fcm/subtraders/blocked_categories

update_fcm_subtrader_blocked_categories()

Result< std::vector< std::string > > kalshi::KalshiClient::update_fcm_subtrader_blocked_categories

(

const UpdateFCMSubtraderBlockedCategoriesRequest &

body

)

Update FCM Subtrader Blocked Categories PUT /fcm/subtraders/blocked_categories

get_fcm_positions()

Result< GetPositionsResponse > kalshi::KalshiClient::get_fcm_positions

(

const GetFcmPositionsParams &

params = {}

)

Get FCM Positions GET /fcm/positions

get_historical_cutoff()

Result< GetHistoricalCutoffResponse > kalshi::KalshiClient::get_historical_cutoff

(

)

Get Historical Cutoff Timestamps GET /historical/cutoff

get_market_candlesticks_historical()

Result< GetMarketCandlesticksHistoricalResponse > kalshi::KalshiClient::get_market_candlesticks_historical	(	std::string_view	ticker,
		const GetMarketCandlesticksHistoricalParams &	params
	)

Get Historical Market Candlesticks GET /historical/markets/{ticker}/candlesticks

get_fills_historical()

Result< GetFillsResponse > kalshi::KalshiClient::get_fills_historical

(

const GetFillsHistoricalParams &

params = {}

)

Get Historical Fills GET /historical/fills

get_historical_orders()

Result< GetOrdersResponse > kalshi::KalshiClient::get_historical_orders

(

const GetHistoricalOrdersParams &

params = {}

)

Get Historical Orders GET /historical/orders

get_historical_positions()

Result< GetPositionsResponse > kalshi::KalshiClient::get_historical_positions

(

const GetHistoricalPositionsParams &

params = {}

)

Get Historical Positions GET /historical/positions

get_trades_historical()

Result< GetTradesResponse > kalshi::KalshiClient::get_trades_historical

(

const GetTradesHistoricalParams &

params = {}

)

Get Historical Trades GET /historical/trades

get_historical_markets()

Result< GetMarketsResponse > kalshi::KalshiClient::get_historical_markets

(

const GetHistoricalMarketsParams &

params = {}

)

Get Historical Markets GET /historical/markets

get_historical_market()

Result< Market > kalshi::KalshiClient::get_historical_market

(

std::string_view

ticker

)

Get Historical Market GET /historical/markets/{ticker}

get_incentive_programs()

Result< GetIncentiveProgramsResponse > kalshi::KalshiClient::get_incentive_programs

(

const GetIncentiveProgramsParams &

params = {}

)

Get Incentives GET /incentive_programs

get_live_data_by_milestone()

Result< LiveData > kalshi::KalshiClient::get_live_data_by_milestone	(	std::string_view	milestone_id,
		const GetLiveDataByMilestoneParams &	params = {}
	)

Get Live Data GET /live_data/milestone/{milestone_id}

get_live_data()

Result< LiveData > kalshi::KalshiClient::get_live_data	(	std::string_view	type,
		std::string_view	milestone_id,
		const GetLiveDataParams &	params = {}
	)

Get Live Data (with type) GET /live_data/{type}/milestone/{milestone_id}

get_live_datas()

Result< std::vector< LiveData > > kalshi::KalshiClient::get_live_datas

(

const GetLiveDatasParams &

params

)

Get Multiple Live Data GET /live_data/batch

get_game_stats()

Result< std::optional< PlayByPlay > > kalshi::KalshiClient::get_game_stats

(

std::string_view

milestone_id

)

Get Game Stats GET /live_data/milestone/{milestone_id}/game_stats

get_event_live_data()

Result< EventLiveData > kalshi::KalshiClient::get_event_live_data	(	std::string_view	event_ticker,
		const GetEventLiveDataParams &	params = {}
	)

Get Event Live Data GET /live_data/events/{event_ticker}

get_weather_index()

Result< GetWeatherIndexResponse > kalshi::KalshiClient::get_weather_index	(	std::string_view	city,
		const GetWeatherIndexParams &	params = {}
	)

Get Weather Index GET /live_data/weather/{city}

get_weather_index_calibrations()

Result< GetWeatherIndexCalibrationsResponse > kalshi::KalshiClient::get_weather_index_calibrations

(

std::string_view

city

)

Get Weather Index Calibrations GET /live_data/weather/{city}/calibrations

get_market_candlesticks()

Result< GetMarketCandlesticksResponse > kalshi::KalshiClient::get_market_candlesticks	(	std::string_view	series_ticker,
		std::string_view	ticker,
		const GetMarketCandlesticksParams &	params
	)

Get Market Candlesticks GET /series/{series_ticker}/markets/{ticker}/candlesticks

get_trades()

Result< GetTradesResponse > kalshi::KalshiClient::get_trades

(

const GetTradesParams &

params = {}

)

Get Trades GET /markets/trades

get_market_orderbook()

Result< OrderbookCountFp > kalshi::KalshiClient::get_market_orderbook	(	std::string_view	ticker,
		const GetMarketOrderbookParams &	params = {}
	)

Get Market Orderbook GET /markets/{ticker}/orderbook

get_market_orderbooks()

Result< std::vector< MarketOrderbookFp > > kalshi::KalshiClient::get_market_orderbooks

(

const GetMarketOrderbooksParams &

params

)

Get Multiple Market Orderbooks GET /markets/orderbooks

get_series()

Result< Series > kalshi::KalshiClient::get_series	(	std::string_view	series_ticker,
		const GetSeriesParams &	params = {}
	)

Get Series GET /series/{series_ticker}

get_series_list()

Result< std::vector< Series > > kalshi::KalshiClient::get_series_list

(

const GetSeriesListParams &

params = {}

)

Get Series List GET /series

get_markets()

Result< GetMarketsResponse > kalshi::KalshiClient::get_markets

(

const GetMarketsParams &

params = {}

)

Get Markets GET /markets

get_market()

Result< Market > kalshi::KalshiClient::get_market

(

std::string_view

ticker

)

Get Market GET /markets/{ticker}

batch_get_market_candlesticks()

Result< std::vector< MarketCandlesticksResponse > > kalshi::KalshiClient::batch_get_market_candlesticks

(

const BatchGetMarketCandlesticksParams &

params

)

Batch Get Market Candlesticks GET /markets/candlesticks

get_milestone()

Result< Milestone > kalshi::KalshiClient::get_milestone

(

std::string_view

milestone_id

)

Get Milestone GET /milestones/{milestone_id}

get_milestones()

Result< GetMilestonesResponse > kalshi::KalshiClient::get_milestones

(

const GetMilestonesParams &

params

)

Get Milestones GET /milestones

get_multivariate_event_collection()

Result< MultivariateEventCollection > kalshi::KalshiClient::get_multivariate_event_collection

(

std::string_view

collection_ticker

)

Get Multivariate Event Collection GET /multivariate_event_collections/{collection_ticker}

create_market_in_multivariate_event_collection()

Result< CreateMarketInMultivariateEventCollectionResponse > kalshi::KalshiClient::create_market_in_multivariate_event_collection	(	std::string_view	collection_ticker,
		const CreateMarketInMultivariateEventCollectionRequest &	body
	)

Create Market In Multivariate Event Collection POST /multivariate_event_collections/{collection_ticker}

get_multivariate_event_collections()

Result< GetMultivariateEventCollectionsResponse > kalshi::KalshiClient::get_multivariate_event_collections

(

const GetMultivariateEventCollectionsParams &

params = {}

)

Get Multivariate Event Collections GET /multivariate_event_collections

get_order_groups()

Result< std::optional< std::vector< OrderGroup > > > kalshi::KalshiClient::get_order_groups

(

const GetOrderGroupsParams &

params = {}

)

Get Order Groups GET /portfolio/order_groups

create_order_group()

Result< CreateOrderGroupResponse > kalshi::KalshiClient::create_order_group

(

const CreateOrderGroupRequest &

body

)

Create Order Group POST /portfolio/order_groups/create

get_order_group()

Result< GetOrderGroupResponse > kalshi::KalshiClient::get_order_group	(	std::string_view	order_group_id,
		const GetOrderGroupParams &	params = {}
	)

Get Order Group GET /portfolio/order_groups/{order_group_id}

delete_order_group()

Result< void > kalshi::KalshiClient::delete_order_group	(	std::string_view	order_group_id,
		const DeleteOrderGroupParams &	params = {}
	)

Delete Order Group DELETE /portfolio/order_groups/{order_group_id}

reset_order_group()

Result< void > kalshi::KalshiClient::reset_order_group	(	std::string_view	order_group_id,
		const ResetOrderGroupParams &	params = {}
	)

Reset Order Group PUT /portfolio/order_groups/{order_group_id}/reset

trigger_order_group()

Result< void > kalshi::KalshiClient::trigger_order_group	(	std::string_view	order_group_id,
		const TriggerOrderGroupParams &	params = {}
	)

Trigger Order Group PUT /portfolio/order_groups/{order_group_id}/trigger

update_order_group_limit()

Result< void > kalshi::KalshiClient::update_order_group_limit	(	std::string_view	order_group_id,
		const UpdateOrderGroupLimitRequest &	body,
		const UpdateOrderGroupLimitParams &	params = {}
	)

Update Order Group Limit PUT /portfolio/order_groups/{order_group_id}/limit

get_orders()

Result< GetOrdersResponse > kalshi::KalshiClient::get_orders

(

const GetOrdersParams &

params = {}

)

Get Orders GET /portfolio/orders

get_order()

Result< Order > kalshi::KalshiClient::get_order

(

std::string_view

order_id

)

Get Order GET /portfolio/orders/{order_id}

get_order_queue_positions()

Result< std::vector< OrderQueuePosition > > kalshi::KalshiClient::get_order_queue_positions

(

const GetOrderQueuePositionsParams &

params = {}

)

Get Queue Positions for Orders GET /portfolio/orders/queue_positions

get_order_queue_position()

Result< FixedPointCount > kalshi::KalshiClient::get_order_queue_position

(

std::string_view

order_id

)

Get Order Queue Position GET /portfolio/orders/{order_id}/queue_position

create_order()

Result< CreateOrderV2Response > kalshi::KalshiClient::create_order

(

const CreateOrderV2Request &

body

)

Create Order POST /portfolio/events/orders

cancel_all_orders()

Result< void > kalshi::KalshiClient::cancel_all_orders

(

const CancelAllOrdersParams &

params = {}

)

Cancel All Orders DELETE /portfolio/events/orders

batch_create_orders()

Result< std::vector< BatchCreateOrdersV2ResponseOrdersItem > > kalshi::KalshiClient::batch_create_orders

(

const BatchCreateOrdersV2Request &

body

)

Batch Create Orders POST /portfolio/events/orders/batched

batch_cancel_orders()

Result< std::vector< BatchCancelOrdersV2ResponseOrdersItem > > kalshi::KalshiClient::batch_cancel_orders

(

const BatchCancelOrdersV2Request &

body

)

Batch Cancel Orders DELETE /portfolio/events/orders/batched

cancel_order()

Result< CancelOrderV2Response > kalshi::KalshiClient::cancel_order	(	std::string_view	order_id,
		const CancelOrderParams &	params = {}
	)

Cancel Order DELETE /portfolio/events/orders/{order_id}

amend_order()

Result< AmendOrderV2Response > kalshi::KalshiClient::amend_order	(	std::string_view	order_id,
		const AmendOrderV2Request &	body,
		const AmendOrderParams &	params = {}
	)

Amend Order POST /portfolio/events/orders/{order_id}/amend

decrease_order()

Result< DecreaseOrderV2Response > kalshi::KalshiClient::decrease_order	(	std::string_view	order_id,
		const DecreaseOrderV2Request &	body,
		const DecreaseOrderParams &	params = {}
	)

Decrease Order POST /portfolio/events/orders/{order_id}/decrease

get_balance()

Result< GetBalanceResponse > kalshi::KalshiClient::get_balance

(

const GetBalanceParams &

params = {}

)

Get Balance GET /portfolio/balance

intra_exchange_instance_transfer()

Result< std::string > kalshi::KalshiClient::intra_exchange_instance_transfer

(

const IntraExchangeInstanceTransferRequest &

body

)

Intra Account Transfer POST /portfolio/intra_exchange_instance_transfer

get_intra_exchange_instance_transfers()

Result< GetIntraExchangeInstanceTransfersResponse > kalshi::KalshiClient::get_intra_exchange_instance_transfers

(

const GetIntraExchangeInstanceTransfersParams &

params = {}

)

Get Intra Account Transfers GET /portfolio/intra_exchange_instance_transfers

get_intra_exchange_instance_transfer()

Result< IntraExchangeInstanceTransfer > kalshi::KalshiClient::get_intra_exchange_instance_transfer

(

std::string_view

transfer_id

)

Get Intra Account Transfer GET /portfolio/intra_exchange_instance_transfers/{transfer_id}

create_subaccount()

Result< std::int64_t > kalshi::KalshiClient::create_subaccount

(

const CreateSubaccountRequest &

body

)

Create Subaccount POST /portfolio/subaccounts

apply_subaccount_transfer()

Result< void > kalshi::KalshiClient::apply_subaccount_transfer

(

const ApplySubaccountTransferRequest &

body

)

Transfer Between Subaccounts POST /portfolio/subaccounts/transfer

get_subaccount_balances()

Result< std::vector< SubaccountBalance > > kalshi::KalshiClient::get_subaccount_balances

(

)

Get All Subaccount Balances GET /portfolio/subaccounts/balances

get_subaccount_transfers()

Result< GetSubaccountTransfersResponse > kalshi::KalshiClient::get_subaccount_transfers

(

const GetSubaccountTransfersParams &

params = {}

)

Get Subaccount Transfers GET /portfolio/subaccounts/transfers

get_subaccount_netting()

Result< std::vector< SubaccountNettingConfig > > kalshi::KalshiClient::get_subaccount_netting

(

)

Get Subaccount Netting GET /portfolio/subaccounts/netting

update_subaccount_netting()

Result< void > kalshi::KalshiClient::update_subaccount_netting

(

const UpdateSubaccountNettingRequest &

body

)

Update Subaccount Netting PUT /portfolio/subaccounts/netting

get_positions()

Result< GetPositionsResponse > kalshi::KalshiClient::get_positions

(

const GetPositionsParams &

params = {}

)

Get Positions GET /portfolio/positions

get_settlements()

Result< GetSettlementsResponse > kalshi::KalshiClient::get_settlements

(

const GetSettlementsParams &

params = {}

)

Get Settlements GET /portfolio/settlements

get_deposits()

Result< GetDepositsResponse > kalshi::KalshiClient::get_deposits

(

const GetDepositsParams &

params = {}

)

Get Deposits GET /portfolio/deposits

get_withdrawals()

Result< GetWithdrawalsResponse > kalshi::KalshiClient::get_withdrawals

(

const GetWithdrawalsParams &

params = {}

)

Get Withdrawals GET /portfolio/withdrawals

get_portfolio_resting_order_total_value()

Result< GetPortfolioRestingOrderTotalValueResponse > kalshi::KalshiClient::get_portfolio_resting_order_total_value

(

)

Get Total Resting Order Value GET /portfolio/summary/total_resting_order_value

get_fills()

Result< GetFillsResponse > kalshi::KalshiClient::get_fills

(

const GetFillsParams &

params = {}

)

Get Fills GET /portfolio/fills

get_target_balance_allocation()

Result< GetTargetBalanceAllocationResponse > kalshi::KalshiClient::get_target_balance_allocation

(

)

Get Target Balance Allocation GET /portfolio/target_balance_allocation

set_target_balance_allocation()

Result< void > kalshi::KalshiClient::set_target_balance_allocation

(

const SetTargetBalanceAllocationRequest &

body

)

Set Target Balance Allocation POST /portfolio/target_balance_allocation

get_tags_for_series_categories()

Result< std::map< std::string, std::vector< std::string > > > kalshi::KalshiClient::get_tags_for_series_categories

(

)

Get Tags for Series Categories GET /search/tags_by_categories

get_filters_for_sports()

Result< GetFiltersBySportsResponse > kalshi::KalshiClient::get_filters_for_sports

(

)

Get Filters for Sports GET /search/filters_by_sport

get_structured_targets()

Result< GetStructuredTargetsResponse > kalshi::KalshiClient::get_structured_targets

(

const GetStructuredTargetsParams &

params = {}

)

Get Structured Targets GET /structured_targets

get_structured_target()

Result< std::optional< StructuredTarget > > kalshi::KalshiClient::get_structured_target

(

std::string_view

structured_target_id

)

Get Structured Target GET /structured_targets/{structured_target_id}

---

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

• kalshi/api.hpp