api.hpp

Go to the documentation of this file.

// Generated by tools/codegen/generate.py from spec/openapi.yaml. Do not edit.
#pragma once
 
 
#include "kalshi/error.hpp"
#include "kalshi/http_client.hpp"
#include "kalshi/models.hpp"
#include "kalshi/rate_limit.hpp"
 
#include <memory>
#include <string_view>
 
namespace kalshi {
 
class KalshiClient {
public:
    explicit KalshiClient(HttpClient client);
    explicit KalshiClient(std::shared_ptr<const HttpTransport> transport);
    ~KalshiClient();
 
    KalshiClient(KalshiClient&&) noexcept;
    KalshiClient& operator=(KalshiClient&&) noexcept;
    KalshiClient(const KalshiClient&) = delete;
    KalshiClient& operator=(const KalshiClient&) = delete;
 
    [[nodiscard]] const HttpTransport& transport() const noexcept;
 
    // ----- account -----------------------------------------------------------
 
    [[nodiscard]] Result<GetAccountApiLimitsResponse> get_account_api_limits();
 
    [[nodiscard]] Result<void> upgrade_account_api_usage_level();
 
    [[nodiscard]] Result<std::vector<AccountApiUsageLevelVolumeProgress>>
    get_account_api_usage_level_volume_progress();
 
    [[nodiscard]] Result<GetAccountEndpointCostsResponse> get_account_endpoint_costs();
 
    // ----- api-keys ----------------------------------------------------------
 
    [[nodiscard]] Result<GetApiKeysResponse> get_api_keys(const GetApiKeysParams& params = {});
 
    [[nodiscard]] Result<CreateApiKeyResponse> create_api_key(const CreateApiKeyRequest& body);
 
    [[nodiscard]] Result<GenerateApiKeyResponse>
    generate_api_key(const GenerateApiKeyRequest& body);
 
    [[nodiscard]] Result<void> delete_api_key(std::string_view api_key);
 
    // ----- communications ----------------------------------------------------
 
    [[nodiscard]] Result<std::string> get_communications_id();
 
    [[nodiscard]] Result<GetBlockTradeProposalsResponse>
    get_block_trade_proposals(const GetBlockTradeProposalsParams& params = {});
 
    [[nodiscard]] Result<std::string> propose_block_trade(const ProposeBlockTradeRequest& body);
 
    [[nodiscard]] Result<void>
    accept_block_trade_proposal(std::string_view block_trade_proposal_id,
                                const AcceptBlockTradeProposalRequest& body);
 
    [[nodiscard]] Result<GetRFQsResponse> get_rfqs(const GetRfqsParams& params = {});
 
    [[nodiscard]] Result<std::string> create_rfq(const CreateRFQRequest& body);
 
    [[nodiscard]] Result<RFQ> get_rfq(std::string_view rfq_id);
 
    [[nodiscard]] Result<void> delete_rfq(std::string_view rfq_id);
 
    [[nodiscard]] Result<Quote> get_rfq_quote(std::string_view rfq_id, std::string_view quote_id);
 
    [[nodiscard]] Result<void> delete_rfq_quote(std::string_view rfq_id, std::string_view quote_id);
 
    [[nodiscard]] Result<void> accept_rfq_quote(std::string_view rfq_id, std::string_view quote_id,
                                                const AcceptQuoteRequest& body);
 
    [[nodiscard]] Result<void> confirm_rfq_quote(std::string_view rfq_id,
                                                 std::string_view quote_id);
 
    [[nodiscard]] Result<GetRFQBatchesResponse>
    get_rfq_batches(const GetRfqBatchesParams& params = {});
 
    [[nodiscard]] Result<RFQBatch> create_rfq_batch(const CreateRFQBatchRequest& body);
 
    [[nodiscard]] Result<RFQBatch> get_rfq_batch(std::string_view rfq_batch_id);
 
    [[nodiscard]] Result<void> delete_rfq_batch(std::string_view rfq_batch_id);
 
    [[nodiscard]] Result<RFQBatchBestQuotes>
    get_rfq_batch_best_quotes(std::string_view rfq_batch_id);
 
    [[nodiscard]] Result<AcceptRFQBatchResponse>
    accept_rfq_batch(std::string_view rfq_batch_id, const AcceptRFQBatchRequest& body);
 
    [[nodiscard]] Result<std::vector<RFQBatchQuote>>
    get_rfq_batch_quotes(std::string_view rfq_batch_id);
 
    [[nodiscard]] Result<std::string>
    create_rfq_batch_quote(std::string_view rfq_batch_id, const CreateRFQBatchQuoteRequest& body);
 
    [[nodiscard]] Result<void> delete_rfq_batch_quote(std::string_view rfq_batch_id,
                                                      std::string_view batch_quote_id);
 
    [[nodiscard]] Result<void> confirm_rfq_batch_quote(std::string_view rfq_batch_id,
                                                       std::string_view batch_quote_id);
 
    [[nodiscard]] Result<GetQuotesResponse> get_quotes(const GetQuotesParams& params = {});
 
    [[nodiscard]] Result<std::string> create_quote(const CreateQuoteRequest& body);
 
    [[deprecated("deprecated by Kalshi")]] [[nodiscard]] Result<Quote>
    get_quote(std::string_view quote_id);
 
    [[deprecated("deprecated by Kalshi")]] [[nodiscard]] Result<void>
    delete_quote(std::string_view quote_id);
 
    [[deprecated("deprecated by Kalshi")]] [[nodiscard]] Result<void>
    accept_quote(std::string_view quote_id, const AcceptQuoteRequest& body);
 
    [[deprecated("deprecated by Kalshi")]] [[nodiscard]] Result<void>
    confirm_quote(std::string_view quote_id);
 
    // ----- events ------------------------------------------------------------
 
    [[nodiscard]] Result<GetEventCandlesticksResponse>
    get_market_candlesticks_by_event(std::string_view series_ticker, std::string_view ticker,
                                     const GetMarketCandlesticksByEventParams& params);
 
    [[nodiscard]] Result<GetEventsResponse> get_events(const GetEventsParams& params = {});
 
    [[nodiscard]] Result<GetMultivariateEventsResponse>
    get_multivariate_events(const GetMultivariateEventsParams& params = {});
 
    [[nodiscard]] Result<GetEventFeeChangesResponse>
    get_event_fee_changes(const GetEventFeeChangesParams& params = {});
 
    [[nodiscard]] Result<GetEventResponse> get_event(std::string_view event_ticker,
                                                     const GetEventParams& params = {});
 
    [[nodiscard]] Result<GetEventMetadataResponse>
    get_event_metadata(std::string_view event_ticker);
 
    [[nodiscard]] Result<std::vector<ForecastPercentilesPoint>>
    get_event_forecast_percentiles_history(std::string_view series_ticker, std::string_view ticker,
                                           const GetEventForecastPercentilesHistoryParams& params);
 
    // ----- exchange ----------------------------------------------------------
 
    [[nodiscard]] Result<ExchangeStatus> get_exchange_status();
 
    [[nodiscard]] Result<std::vector<SeriesFeeChange>>
    get_series_fee_changes(const GetSeriesFeeChangesParams& params = {});
 
    [[nodiscard]] Result<Schedule> get_exchange_schedule();
 
    [[nodiscard]] Result<std::string> get_user_data_timestamp();
 
    // ----- fcm ---------------------------------------------------------------
 
    [[nodiscard]] Result<GetFcmFillsResponse> get_fcm_fills(const GetFcmFillsParams& params = {});
 
    [[nodiscard]] Result<GetOrdersResponse> get_fcm_orders(const GetFcmOrdersParams& params = {});
 
    [[nodiscard]] Result<std::vector<FCMSubtrader>> get_fcm_subtraders();
 
    [[nodiscard]] Result<std::string> create_fcm_subtrader(const CreateFCMSubtraderRequest& body);
 
    [[nodiscard]] Result<GetFCMEventContractDailyCapResponse>
    get_fcm_event_contract_daily_cap(const GetFcmEventContractDailyCapParams& params = {});
 
    [[nodiscard]] Result<void>
    update_fcm_event_contract_daily_cap(const UpdateFCMEventContractDailyCapRequest& body);
 
    [[nodiscard]] Result<void>
    delete_fcm_event_contract_daily_cap(const DeleteFcmEventContractDailyCapParams& params);
 
    [[nodiscard]] Result<std::vector<std::string>>
    get_fcm_subtrader_blocked_categories(const GetFcmSubtraderBlockedCategoriesParams& params);
 
    [[nodiscard]] Result<std::vector<std::string>>
    update_fcm_subtrader_blocked_categories(const UpdateFCMSubtraderBlockedCategoriesRequest& body);
 
    [[nodiscard]] Result<GetPositionsResponse>
    get_fcm_positions(const GetFcmPositionsParams& params = {});
 
    [[nodiscard]] Result<std::string>
    create_fcm_position_transfer(const CreateFCMPositionTransferRequest& body);
 
    // ----- historical --------------------------------------------------------
 
    [[nodiscard]] Result<GetHistoricalCutoffResponse> get_historical_cutoff();
 
    [[nodiscard]] Result<GetMarketCandlesticksHistoricalResponse>
    get_market_candlesticks_historical(std::string_view ticker,
                                       const GetMarketCandlesticksHistoricalParams& params);
 
    [[nodiscard]] Result<GetFillsResponse>
    get_fills_historical(const GetFillsHistoricalParams& params = {});
 
    [[nodiscard]] Result<GetOrdersResponse>
    get_historical_orders(const GetHistoricalOrdersParams& params = {});
 
    [[nodiscard]] Result<GetPositionsResponse>
    get_historical_positions(const GetHistoricalPositionsParams& params = {});
 
    [[nodiscard]] Result<GetTradesResponse>
    get_trades_historical(const GetTradesHistoricalParams& params = {});
 
    [[nodiscard]] Result<GetMarketsResponse>
    get_historical_markets(const GetHistoricalMarketsParams& params = {});
 
    [[nodiscard]] Result<Market> get_historical_market(std::string_view ticker);
 
    // ----- incentive-programs ------------------------------------------------
 
    [[nodiscard]] Result<GetIncentiveProgramsResponse>
    get_incentive_programs(const GetIncentiveProgramsParams& params = {});
 
    // ----- live-data ---------------------------------------------------------
 
    [[nodiscard]] Result<LiveData>
    get_live_data_by_milestone(std::string_view milestone_id,
                               const GetLiveDataByMilestoneParams& params = {});
 
    [[nodiscard]] Result<LiveData> get_live_data(std::string_view type,
                                                 std::string_view milestone_id,
                                                 const GetLiveDataParams& params = {});
 
    [[nodiscard]] Result<std::vector<LiveData>> get_live_datas(const GetLiveDatasParams& params);
 
    [[nodiscard]] Result<std::optional<PlayByPlay>> get_game_stats(std::string_view milestone_id);
 
    [[nodiscard]] Result<EventLiveData>
    get_event_live_data(std::string_view event_ticker, const GetEventLiveDataParams& params = {});
 
    [[nodiscard]] Result<GetWeatherIndexResponse>
    get_weather_index(std::string_view city, const GetWeatherIndexParams& params = {});
 
    [[nodiscard]] Result<GetWeatherIndexCalibrationsResponse>
    get_weather_index_calibrations(std::string_view city);
 
    // ----- market ------------------------------------------------------------
 
    [[nodiscard]] Result<GetMarketCandlesticksResponse>
    get_market_candlesticks(std::string_view series_ticker, std::string_view ticker,
                            const GetMarketCandlesticksParams& params);
 
    [[nodiscard]] Result<GetTradesResponse> get_trades(const GetTradesParams& params = {});
 
    [[nodiscard]] Result<OrderbookCountFp>
    get_market_orderbook(std::string_view ticker, const GetMarketOrderbookParams& params = {});
 
    [[nodiscard]] Result<std::vector<MarketOrderbookFp>>
    get_market_orderbooks(const GetMarketOrderbooksParams& params);
 
    [[nodiscard]] Result<Series> get_series(std::string_view series_ticker,
                                            const GetSeriesParams& params = {});
 
    [[nodiscard]] Result<std::vector<Series>>
    get_series_list(const GetSeriesListParams& params = {});
 
    [[nodiscard]] Result<GetMarketsResponse> get_markets(const GetMarketsParams& params = {});
 
    [[nodiscard]] Result<Market> get_market(std::string_view ticker);
 
    [[nodiscard]] Result<std::vector<MarketCandlesticksResponse>>
    batch_get_market_candlesticks(const BatchGetMarketCandlesticksParams& params);
 
    // ----- milestone ---------------------------------------------------------
 
    [[nodiscard]] Result<Milestone> get_milestone(std::string_view milestone_id);
 
    [[nodiscard]] Result<GetMilestonesResponse> get_milestones(const GetMilestonesParams& params);
 
    // ----- multivariate ------------------------------------------------------
 
    [[nodiscard]] Result<MultivariateEventCollection>
    get_multivariate_event_collection(std::string_view collection_ticker);
 
    [[nodiscard]] Result<CreateMarketInMultivariateEventCollectionResponse>
    create_market_in_multivariate_event_collection(
        std::string_view collection_ticker,
        const CreateMarketInMultivariateEventCollectionRequest& body);
 
    [[nodiscard]] Result<GetMultivariateEventCollectionsResponse>
    get_multivariate_event_collections(const GetMultivariateEventCollectionsParams& params = {});
 
    // ----- order-groups ------------------------------------------------------
 
    [[nodiscard]] Result<std::optional<std::vector<OrderGroup>>>
    get_order_groups(const GetOrderGroupsParams& params = {});
 
    [[nodiscard]] Result<CreateOrderGroupResponse>
    create_order_group(const CreateOrderGroupRequest& body);
 
    [[nodiscard]] Result<GetOrderGroupResponse>
    get_order_group(std::string_view order_group_id, const GetOrderGroupParams& params = {});
 
    [[nodiscard]] Result<void> delete_order_group(std::string_view order_group_id,
                                                  const DeleteOrderGroupParams& params = {});
 
    [[nodiscard]] Result<void> reset_order_group(std::string_view order_group_id,
                                                 const ResetOrderGroupParams& params = {});
 
    [[nodiscard]] Result<void> trigger_order_group(std::string_view order_group_id,
                                                   const TriggerOrderGroupParams& params = {});
 
    [[nodiscard]] Result<void>
    update_order_group_limit(std::string_view order_group_id,
                             const UpdateOrderGroupLimitRequest& body,
                             const UpdateOrderGroupLimitParams& params = {});
 
    // ----- orders ------------------------------------------------------------
 
    [[nodiscard]] Result<GetOrdersResponse> get_orders(const GetOrdersParams& params = {});
 
    [[nodiscard]] Result<Order> get_order(std::string_view order_id);
 
    [[nodiscard]] Result<std::vector<OrderQueuePosition>>
    get_order_queue_positions(const GetOrderQueuePositionsParams& params = {});
 
    [[nodiscard]] Result<FixedPointCount> get_order_queue_position(std::string_view order_id);
 
    [[nodiscard]] Result<CreateOrderV2Response> create_order(const CreateOrderV2Request& body);
 
    [[nodiscard]] Result<void> cancel_all_orders(const CancelAllOrdersParams& params = {});
 
    [[nodiscard]] Result<std::vector<BatchCreateOrdersV2ResponseOrdersItem>>
    batch_create_orders(const BatchCreateOrdersV2Request& body);
 
    [[nodiscard]] Result<std::vector<BatchCancelOrdersV2ResponseOrdersItem>>
    batch_cancel_orders(const BatchCancelOrdersV2Request& body);
 
    [[nodiscard]] Result<CreateOrderV2Response>
    create_order_with_exit_trigger(const CreateOrderWithExitTriggerRequest& body);
 
    [[nodiscard]] Result<CancelOrderV2Response> cancel_order(std::string_view order_id,
                                                             const CancelOrderParams& params = {});
 
    [[nodiscard]] Result<AmendOrderV2Response> amend_order(std::string_view order_id,
                                                           const AmendOrderV2Request& body,
                                                           const AmendOrderParams& params = {});
 
    [[nodiscard]] Result<DecreaseOrderV2Response>
    decrease_order(std::string_view order_id, const DecreaseOrderV2Request& body,
                   const DecreaseOrderParams& params = {});
 
    // ----- portfolio ---------------------------------------------------------
 
    [[nodiscard]] Result<GetEventContractExitTriggersResponse>
    get_event_contract_exit_triggers(std::string_view ticker,
                                     const GetEventContractExitTriggersParams& params = {});
 
    [[nodiscard]] Result<EventContractExitTrigger>
    set_event_contract_exit_trigger(std::string_view ticker,
                                    const SetEventContractExitTriggerRequest& body,
                                    const SetEventContractExitTriggerParams& params = {});
 
    [[nodiscard]] Result<void>
    delete_event_contract_exit_trigger(std::string_view ticker,
                                       const DeleteEventContractExitTriggerParams& params = {});
 
    [[nodiscard]] Result<GetBalanceResponse> get_balance(const GetBalanceParams& params = {});
 
    [[nodiscard]] Result<std::string>
    intra_exchange_instance_transfer(const IntraExchangeInstanceTransferRequest& body);
 
    [[nodiscard]] Result<GetIntraExchangeInstanceTransfersResponse>
    get_intra_exchange_instance_transfers(
        const GetIntraExchangeInstanceTransfersParams& params = {});
 
    [[nodiscard]] Result<IntraExchangeInstanceTransfer>
    get_intra_exchange_instance_transfer(std::string_view transfer_id);
 
    [[nodiscard]] Result<std::int64_t> create_subaccount(const CreateSubaccountRequest& body);
 
    [[nodiscard]] Result<void>
    apply_subaccount_transfer(const ApplySubaccountTransferRequest& body);
 
    [[nodiscard]] Result<std::vector<SubaccountBalance>> get_subaccount_balances();
 
    [[nodiscard]] Result<GetSubaccountTransfersResponse>
    get_subaccount_transfers(const GetSubaccountTransfersParams& params = {});
 
    [[nodiscard]] Result<std::vector<SubaccountNettingConfig>> get_subaccount_netting();
 
    [[nodiscard]] Result<void>
    update_subaccount_netting(const UpdateSubaccountNettingRequest& body);
 
    [[nodiscard]] Result<GetPositionsResponse> get_positions(const GetPositionsParams& params = {});
 
    [[nodiscard]] Result<GetSettlementsResponse>
    get_settlements(const GetSettlementsParams& params = {});
 
    [[nodiscard]] Result<GetCreditHistoryResponse>
    get_credit_history(const GetCreditHistoryParams& params = {});
 
    [[nodiscard]] Result<GetDepositsResponse> get_deposits(const GetDepositsParams& params = {});
 
    [[nodiscard]] Result<GetWithdrawalsResponse>
    get_withdrawals(const GetWithdrawalsParams& params = {});
 
    [[nodiscard]] Result<GetPortfolioRestingOrderTotalValueResponse>
    get_portfolio_resting_order_total_value();
 
    [[nodiscard]] Result<GetFillsResponse> get_fills(const GetFillsParams& params = {});
 
    [[nodiscard]] Result<GetTargetBalanceAllocationResponse> get_target_balance_allocation();
 
    [[nodiscard]] Result<void>
    set_target_balance_allocation(const SetTargetBalanceAllocationRequest& body);
 
    // ----- search ------------------------------------------------------------
 
    [[nodiscard]] Result<std::map<std::string, std::vector<std::string>>>
    get_tags_for_series_categories();
 
    [[nodiscard]] Result<GetFiltersBySportsResponse> get_filters_for_sports();
 
    // ----- structured-targets ------------------------------------------------
 
    [[nodiscard]] Result<GetStructuredTargetsResponse>
    get_structured_targets(const GetStructuredTargetsParams& params = {});
 
    [[nodiscard]] Result<std::optional<StructuredTarget>>
    get_structured_target(std::string_view structured_target_id);
 
private:
    struct Impl;
    std::unique_ptr<Impl> impl_;
};
 
[[nodiscard]] RateLimitConfig rate_limit_config(const GetAccountApiLimitsResponse& limits,
                                                const GetAccountEndpointCostsResponse& costs);
 
} // namespace kalshi