kalshi-cpp 0.8.0
C++23 client for Kalshi's Predictions API
Loading...
Searching...
No Matches
models.hpp
Go to the documentation of this file.
1// Generated by tools/codegen/generate.py from spec/openapi.yaml. Do not edit.
2#pragma once
3
4#include "kalshi/raw_json.hpp"
5
6#include <array>
7#include <cstdint>
8#include <map>
9#include <optional>
10#include <string>
11#include <string_view>
12#include <vector>
13
14namespace kalshi {
15
16// ----- Scalars ----------------------------------------------------------
17
19using ExchangeIndex = std::int64_t;
20
23using FixedPointCount = std::string;
24
26using FixedPointDollars = std::string;
27
30using PriceLevelDollarsCountFp = std::array<std::string, 2>;
31
32// ----- Enums ------------------------------------------------------------
33
35enum class Action : std::uint8_t {
36 Unknown,
37 Buy,
38 Sell,
39};
40
41[[nodiscard]] constexpr std::string_view to_string(Action value) noexcept {
42 switch (value) {
43 case Action::Buy:
44 return "buy";
45 case Action::Sell:
46 return "sell";
47 case Action::Unknown:
48 break;
49 }
50 return "";
51}
52
65
66[[nodiscard]] constexpr std::string_view to_string(ApiKeyScope value) noexcept {
67 switch (value) {
69 return "read";
71 return "write";
73 return "read::block_trade_accept";
75 return "read::portfolio_balance";
77 return "write::trade";
79 return "write::transfer";
81 return "write::fcm_risk";
83 return "write::block_trade_accept";
85 break;
86 }
87 return "";
88}
89
91enum class ApiKeyType : std::uint8_t {
92 Unknown,
93 Rsa,
94 Ed25519,
95};
96
97[[nodiscard]] constexpr std::string_view to_string(ApiKeyType value) noexcept {
98 switch (value) {
99 case ApiKeyType::Rsa:
100 return "rsa";
102 return "ed25519";
104 break;
105 }
106 return "";
107}
108
110enum class BookSide : std::uint8_t {
111 Unknown,
112 Bid,
113 Ask,
114};
115
116[[nodiscard]] constexpr std::string_view to_string(BookSide value) noexcept {
117 switch (value) {
118 case BookSide::Bid:
119 return "bid";
120 case BookSide::Ask:
121 return "ask";
123 break;
124 }
125 return "";
126}
127
129enum class CreditHistoryStatus : std::uint8_t {
130 Unknown,
131 Pending,
132 Failed,
133 Applied,
134};
135
136[[nodiscard]] constexpr std::string_view to_string(CreditHistoryStatus value) noexcept {
137 switch (value) {
139 return "pending";
141 return "failed";
143 return "applied";
145 return "unknown";
146 }
147 return "";
148}
149
151enum class DepositStatus : std::uint8_t {
152 Unknown,
153 Pending,
154 Applied,
155 Failed,
156 Returned,
157};
158
159[[nodiscard]] constexpr std::string_view to_string(DepositStatus value) noexcept {
160 switch (value) {
162 return "pending";
164 return "applied";
166 return "failed";
168 return "returned";
170 break;
171 }
172 return "";
173}
174
176enum class DepositType : std::uint8_t {
177 Unknown,
178 Ach,
179 Wire,
180 Crypto,
181 Debit,
182 Apm,
183};
184
185[[nodiscard]] constexpr std::string_view to_string(DepositType value) noexcept {
186 switch (value) {
187 case DepositType::Ach:
188 return "ach";
190 return "wire";
192 return "crypto";
194 return "debit";
195 case DepositType::Apm:
196 return "apm";
198 break;
199 }
200 return "";
201}
202
203enum class EventContractExitTriggerStatus : std::uint8_t {
204 Unknown,
206 Active,
207 Filled,
208 Canceled,
209 Failed,
210};
211
212[[nodiscard]] constexpr std::string_view to_string(EventContractExitTriggerStatus value) noexcept {
213 switch (value) {
215 return "pending_on_entry";
217 return "active";
219 return "filled";
221 return "canceled";
223 return "failed";
225 return "unknown";
226 }
227 return "";
228}
229
231enum class ExchangeInstance : std::uint8_t {
232 Unknown,
234 Margined,
235};
236
237[[nodiscard]] constexpr std::string_view to_string(ExchangeInstance value) noexcept {
238 switch (value) {
240 return "event_contract";
242 return "margined";
244 break;
245 }
246 return "";
247}
248
250enum class FeeType : std::uint8_t {
251 Unknown,
252 Quadratic,
255 Flat,
256};
257
258[[nodiscard]] constexpr std::string_view to_string(FeeType value) noexcept {
259 switch (value) {
261 return "quadratic";
263 return "quadratic_with_maker_fees";
265 return "quadratic_with_combo_maker_fees";
266 case FeeType::Flat:
267 return "flat";
268 case FeeType::Unknown:
269 break;
270 }
271 return "";
272}
273
275enum class GetEventsStatus : std::uint8_t {
276 Unknown,
277 Unopened,
278 Open,
279 Closed,
280 Settled,
281};
282
283[[nodiscard]] constexpr std::string_view to_string(GetEventsStatus value) noexcept {
284 switch (value) {
286 return "unopened";
288 return "open";
290 return "closed";
292 return "settled";
294 break;
295 }
296 return "";
297}
298
300enum class GetHistoricalMarketsMveFilter : std::uint8_t {
301 Unknown,
302 Exclude,
303};
304
305[[nodiscard]] constexpr std::string_view to_string(GetHistoricalMarketsMveFilter value) noexcept {
306 switch (value) {
308 return "exclude";
310 break;
311 }
312 return "";
313}
314
316enum class GetIncentiveProgramsStatus : std::uint8_t {
317 Unknown,
318 All,
319 Active,
320 Upcoming,
321 Closed,
322 PaidOut,
323};
324
325[[nodiscard]] constexpr std::string_view to_string(GetIncentiveProgramsStatus value) noexcept {
326 switch (value) {
328 return "all";
330 return "active";
332 return "upcoming";
334 return "closed";
336 return "paid_out";
338 break;
339 }
340 return "";
341}
342
344enum class GetIncentiveProgramsType : std::uint8_t {
345 Unknown,
346 All,
347 Liquidity,
348 Volume,
351};
352
353[[nodiscard]] constexpr std::string_view to_string(GetIncentiveProgramsType value) noexcept {
354 switch (value) {
356 return "all";
358 return "liquidity";
360 return "volume";
362 return "margin_maker_volume";
364 return "margin_taker_volume";
366 break;
367 }
368 return "";
369}
370
372enum class GetMarketsMveFilter : std::uint8_t {
373 Unknown,
374 Only,
375 Exclude,
376};
377
378[[nodiscard]] constexpr std::string_view to_string(GetMarketsMveFilter value) noexcept {
379 switch (value) {
381 return "only";
383 return "exclude";
385 break;
386 }
387 return "";
388}
389
391enum class GetMarketsStatus : std::uint8_t {
392 Unknown,
393 Unopened,
394 Open,
395 Paused,
396 Closed,
397 Settled,
398};
399
400[[nodiscard]] constexpr std::string_view to_string(GetMarketsStatus value) noexcept {
401 switch (value) {
403 return "unopened";
405 return "open";
407 return "paused";
409 return "closed";
411 return "settled";
413 break;
414 }
415 return "";
416}
417
419enum class GetMultivariateEventCollectionsStatus : std::uint8_t {
420 Unknown,
421 Unopened,
422 Open,
423 Closed,
424};
425
426[[nodiscard]] constexpr std::string_view
428 switch (value) {
430 return "unopened";
432 return "open";
434 return "closed";
436 break;
437 }
438 return "";
439}
440
442enum class IncentiveProgramIncentiveType : std::uint8_t {
443 Unknown,
444 Liquidity,
445 Volume,
448};
449
450[[nodiscard]] constexpr std::string_view to_string(IncentiveProgramIncentiveType value) noexcept {
451 switch (value) {
453 return "liquidity";
455 return "volume";
457 return "margin_maker_volume";
459 return "margin_taker_volume";
461 break;
462 }
463 return "";
464}
465
467enum class IntraExchangeInstanceTransferStatus : std::uint8_t {
468 Unknown,
469 Pending,
470 Complete,
471};
472
473[[nodiscard]] constexpr std::string_view
475 switch (value) {
477 return "pending";
479 return "complete";
481 break;
482 }
483 return "";
484}
485
486enum class Kind : std::uint8_t {
487 Unknown,
488 Bracket,
489};
490
491[[nodiscard]] constexpr std::string_view to_string(Kind value) noexcept {
492 switch (value) {
493 case Kind::Bracket:
494 return "bracket";
495 case Kind::Unknown:
496 break;
497 }
498 return "";
499}
500
502enum class MarketIndexStatus : std::uint8_t {
503 Unknown,
504 Open,
505 Closed,
506 Stale,
507};
508
509[[nodiscard]] constexpr std::string_view to_string(MarketIndexStatus value) noexcept {
510 switch (value) {
512 return "open";
514 return "closed";
516 return "stale";
518 break;
519 }
520 return "";
521}
522
523enum class MarketResult : std::uint8_t {
524 Unknown,
525 Yes,
526 No,
527 Scalar,
528 Unset,
529};
530
531[[nodiscard]] constexpr std::string_view to_string(MarketResult value) noexcept {
532 switch (value) {
534 return "yes";
535 case MarketResult::No:
536 return "no";
538 return "scalar";
540 return "";
542 break;
543 }
544 return "";
545}
546
548enum class MarketStatus : std::uint8_t {
549 Unknown,
551 Inactive,
552 Active,
553 Closed,
554 Determined,
555 Disputed,
556 Amended,
557 Finalized,
558};
559
560[[nodiscard]] constexpr std::string_view to_string(MarketStatus value) noexcept {
561 switch (value) {
563 return "initialized";
565 return "inactive";
567 return "active";
569 return "closed";
571 return "determined";
573 return "disputed";
575 return "amended";
577 return "finalized";
579 break;
580 }
581 return "";
582}
583
585enum class MarketType : std::uint8_t {
586 Unknown,
587 Binary,
588 Scalar,
589};
590
591[[nodiscard]] constexpr std::string_view to_string(MarketType value) noexcept {
592 switch (value) {
594 return "binary";
596 return "scalar";
598 break;
599 }
600 return "";
601}
602
604enum class OrderStatus : std::uint8_t {
605 Unknown,
606 Resting,
607 Canceled,
608 Executed,
609};
610
611[[nodiscard]] constexpr std::string_view to_string(OrderStatus value) noexcept {
612 switch (value) {
614 return "resting";
616 return "canceled";
618 return "executed";
620 break;
621 }
622 return "";
623}
624
625enum class OrderType : std::uint8_t {
626 Unknown,
627 Limit,
628 Market,
629};
630
631[[nodiscard]] constexpr std::string_view to_string(OrderType value) noexcept {
632 switch (value) {
633 case OrderType::Limit:
634 return "limit";
636 return "market";
638 break;
639 }
640 return "";
641}
642
644enum class OutcomeSide : std::uint8_t {
645 Unknown,
646 Yes,
647 No,
648};
649
650[[nodiscard]] constexpr std::string_view to_string(OutcomeSide value) noexcept {
651 switch (value) {
652 case OutcomeSide::Yes:
653 return "yes";
654 case OutcomeSide::No:
655 return "no";
657 break;
658 }
659 return "";
660}
661
663enum class QuoteStatus : std::uint8_t {
664 Unknown,
665 Open,
666 Accepted,
667 Confirmed,
668 Executed,
669 Cancelled,
670};
671
672[[nodiscard]] constexpr std::string_view to_string(QuoteStatus value) noexcept {
673 switch (value) {
675 return "open";
677 return "accepted";
679 return "confirmed";
681 return "executed";
683 return "cancelled";
685 break;
686 }
687 return "";
688}
689
691enum class RFQBatchQuoteStatus : std::uint8_t {
692 Unknown,
693 Open,
694 Accepted,
695 Confirmed,
696 Executed,
698 Cancelled,
699};
700
701[[nodiscard]] constexpr std::string_view to_string(RFQBatchQuoteStatus value) noexcept {
702 switch (value) {
704 return "open";
706 return "accepted";
708 return "confirmed";
710 return "executed";
712 return "partially_executed";
714 return "cancelled";
716 break;
717 }
718 return "";
719}
720
722enum class RFQBatchStatus : std::uint8_t {
723 Unknown,
724 Open,
725 Accepted,
726 Closed,
727};
728
729[[nodiscard]] constexpr std::string_view to_string(RFQBatchStatus value) noexcept {
730 switch (value) {
732 return "open";
734 return "accepted";
736 return "closed";
738 break;
739 }
740 return "";
741}
742
744enum class RFQStatus : std::uint8_t {
745 Unknown,
746 Open,
747 Closed,
748};
749
750[[nodiscard]] constexpr std::string_view to_string(RFQStatus value) noexcept {
751 switch (value) {
752 case RFQStatus::Open:
753 return "open";
755 return "closed";
757 break;
758 }
759 return "";
760}
761
763enum class RestingMarginReservation : std::uint8_t {
764 Unknown,
765 None,
766 Max,
767 Sum,
768};
769
770[[nodiscard]] constexpr std::string_view to_string(RestingMarginReservation value) noexcept {
771 switch (value) {
773 return "none";
775 return "max";
777 return "sum";
779 break;
780 }
781 return "";
782}
783
785enum class SelfTradePreventionType : std::uint8_t {
786 Unknown,
788 Maker,
789};
790
791[[nodiscard]] constexpr std::string_view to_string(SelfTradePreventionType value) noexcept {
792 switch (value) {
794 return "taker_at_cross";
796 return "maker";
798 break;
799 }
800 return "";
801}
802
804enum class SettlementBoundsType : std::uint8_t {
805 Unknown,
806 Default,
807 Floor,
808};
809
810[[nodiscard]] constexpr std::string_view to_string(SettlementBoundsType value) noexcept {
811 switch (value) {
813 return "default";
815 return "floor";
817 break;
818 }
819 return "";
820}
821
823enum class SettlementMarketResult : std::uint8_t {
824 Unknown,
825 Yes,
826 No,
827 Scalar,
828};
829
830[[nodiscard]] constexpr std::string_view to_string(SettlementMarketResult value) noexcept {
831 switch (value) {
833 return "yes";
835 return "no";
837 return "scalar";
839 break;
840 }
841 return "";
842}
843
846enum class SettlementStatus : std::uint8_t {
847 Unknown,
848 Unsettled,
849 Settled,
850 All,
851};
852
853[[nodiscard]] constexpr std::string_view to_string(SettlementStatus value) noexcept {
854 switch (value) {
856 return "unsettled";
858 return "settled";
860 return "all";
862 break;
863 }
864 return "";
865}
866
867enum class Side : std::uint8_t {
868 Unknown,
869 Yes,
870 No,
871};
872
873[[nodiscard]] constexpr std::string_view to_string(Side value) noexcept {
874 switch (value) {
875 case Side::Yes:
876 return "yes";
877 case Side::No:
878 return "no";
879 case Side::Unknown:
880 break;
881 }
882 return "";
883}
884
886enum class StrikeType : std::uint8_t {
887 Unknown,
888 Greater,
890 Less,
892 Between,
893 Functional,
894 Custom,
895 Structured,
896};
897
898[[nodiscard]] constexpr std::string_view to_string(StrikeType value) noexcept {
899 switch (value) {
901 return "greater";
903 return "greater_or_equal";
904 case StrikeType::Less:
905 return "less";
907 return "less_or_equal";
909 return "between";
911 return "functional";
913 return "custom";
915 return "structured";
917 break;
918 }
919 return "";
920}
921
923enum class TimeInForce : std::uint8_t {
924 Unknown,
925 FillOrKill,
928};
929
930[[nodiscard]] constexpr std::string_view to_string(TimeInForce value) noexcept {
931 switch (value) {
933 return "fill_or_kill";
935 return "good_till_canceled";
937 return "immediate_or_cancel";
939 break;
940 }
941 return "";
942}
943
944enum class TriggeredLeg : std::uint8_t {
945 Unknown,
946 StopLoss,
947 TakeProfit,
948};
949
950[[nodiscard]] constexpr std::string_view to_string(TriggeredLeg value) noexcept {
951 switch (value) {
953 return "stop_loss";
955 return "take_profit";
957 break;
958 }
959 return "";
960}
961
962enum class Unit : std::uint8_t {
963 Unknown,
964 Bps,
965 Cents,
966};
967
968[[nodiscard]] constexpr std::string_view to_string(Unit value) noexcept {
969 switch (value) {
970 case Unit::Bps:
971 return "bps";
972 case Unit::Cents:
973 return "cents";
974 case Unit::Unknown:
975 break;
976 }
977 return "";
978}
979
981enum class UserFilter : std::uint8_t {
982 Unknown,
983 Self,
984};
985
986[[nodiscard]] constexpr std::string_view to_string(UserFilter value) noexcept {
987 switch (value) {
988 case UserFilter::Self:
989 return "self";
991 break;
992 }
993 return "";
994}
995
996// ----- Models -----------------------------------------------------------
997
1000 std::optional<std::string> subtrader_id;
1002 std::optional<std::int64_t> subaccount;
1003};
1004
1009
1017
1022 std::vector<RFQBatchAcceptLimit> min_bids;
1024 std::optional<std::string> client_order_id;
1025};
1026
1027struct Quote {
1029 std::string id;
1031 std::string rfq_id;
1033 std::string creator_id;
1035 std::string rfq_creator_id;
1037 std::string market_ticker;
1045 std::string created_ts;
1047 std::string updated_ts;
1051 std::optional<Side> accepted_side;
1053 std::optional<std::string> accepted_ts;
1055 std::optional<std::string> confirmed_ts;
1057 std::optional<std::string> executed_ts;
1059 std::optional<std::string> cancelled_ts;
1061 std::optional<bool> rest_remainder;
1064 std::optional<bool> post_only;
1066 std::optional<std::string> cancellation_reason;
1068 std::optional<std::string> creator_user_id;
1070 std::optional<std::string> rfq_creator_user_id;
1072 std::optional<FixedPointDollars> rfq_target_cost_dollars;
1075 std::optional<bool> target_cost_excludes_fees;
1077 std::optional<std::string> rfq_creator_order_id;
1079 std::optional<std::string> creator_order_id;
1081 std::optional<std::int64_t> creator_subaccount;
1083 std::optional<std::int64_t> rfq_creator_subaccount;
1085 std::optional<FixedPointCount> yes_contracts_fp;
1087 std::optional<FixedPointCount> no_contracts_fp;
1088};
1089
1094 std::vector<Quote> quotes;
1095};
1096
1103
1107 std::int64_t computed_ts{};
1109 std::vector<AccountApiUsageLevelVolumeGoal> goals;
1110};
1111
1115 std::optional<std::int64_t> subaccount;
1116};
1117
1120 std::optional<std::int64_t> subaccount;
1122 std::string ticker;
1128 std::optional<std::string> client_order_id;
1130 std::optional<std::string> updated_client_order_id;
1132 std::optional<std::int64_t> yes_price;
1134 std::optional<std::int64_t> no_price;
1136 std::optional<FixedPointDollars> yes_price_dollars;
1138 std::optional<FixedPointDollars> no_price_dollars;
1140 std::optional<std::int64_t> count;
1142 std::optional<FixedPointCount> count_fp;
1144 std::optional<ExchangeIndex> exchange_index;
1145};
1146
1195
1202
1205 std::string ticker;
1213 std::optional<std::string> client_order_id;
1215 std::optional<std::string> updated_client_order_id;
1217 std::optional<std::int64_t> expiration_time;
1219 std::optional<ExchangeIndex> exchange_index;
1220};
1221
1223 std::string order_id;
1224 std::optional<std::string> client_order_id;
1226 std::optional<FixedPointCount> remaining_count;
1228 std::optional<FixedPointCount> fill_count;
1230 std::optional<FixedPointDollars> average_fill_price;
1232 std::optional<FixedPointDollars> average_fee_paid;
1234 std::int64_t ts_ms{};
1235};
1236
1237struct ApiKey {
1239 std::string api_key_id;
1241 std::string name;
1243 std::vector<ApiKeyScope> scopes;
1246 std::optional<std::int64_t> subaccount;
1250 std::optional<std::string> fcm_subtrader_id;
1251};
1252
1257 std::string level;
1259 std::optional<std::int64_t> expires_ts;
1262 std::string source;
1263};
1264
1269 std::int64_t from_subaccount{};
1271 std::int64_t to_subaccount{};
1273 std::int64_t amount_cents{};
1275 std::optional<ExchangeIndex> exchange_index;
1276};
1277
1280 std::string ticker;
1284 std::optional<std::int64_t> size_max;
1286 std::optional<std::int64_t> size_min;
1288 std::vector<std::string> active_quoters;
1289};
1290
1294 std::int64_t value{};
1295};
1296
1300 std::optional<EventContractExitSlippage> slippage;
1301 std::optional<FixedPointDollars> stop_loss_price;
1302 std::optional<FixedPointDollars> take_profit_price;
1303};
1304
1307 std::optional<std::string> code;
1309 std::optional<std::string> message;
1311 std::optional<std::string> details;
1312};
1313
1316 std::string order_id;
1317 std::optional<Order> order;
1321 std::optional<ErrorResponse> error;
1322};
1323
1326 std::string order_id;
1329 std::optional<std::int64_t> subaccount;
1331 std::optional<ExchangeIndex> exchange_index;
1333 std::optional<std::string> market_ticker;
1334};
1335
1338 std::optional<std::vector<std::string>> ids;
1340 std::optional<std::vector<BatchCancelOrdersRequestOrder>> orders;
1341};
1342
1344 std::vector<BatchCancelOrdersIndividualResponse> orders;
1345};
1346
1349 std::string order_id;
1352 std::optional<std::int64_t> subaccount;
1354 std::optional<ExchangeIndex> exchange_index;
1356 std::optional<std::string> market_ticker;
1357};
1358
1361 std::vector<BatchCancelOrdersV2RequestOrdersItem> orders;
1362};
1363
1366 std::string order_id;
1367 std::optional<std::string> client_order_id;
1372 std::optional<std::int64_t> ts_ms;
1373 std::optional<ErrorResponse> error;
1374};
1375
1377 std::vector<BatchCancelOrdersV2ResponseOrdersItem> orders;
1378};
1379
1381 std::optional<std::string> client_order_id;
1382 std::optional<Order> order;
1383 std::optional<ErrorResponse> error;
1384};
1385
1387 std::string ticker;
1388 std::optional<std::string> client_order_id;
1392 std::optional<std::int64_t> count;
1394 std::optional<FixedPointCount> count_fp;
1395 std::optional<std::int64_t> yes_price;
1396 std::optional<std::int64_t> no_price;
1398 std::optional<FixedPointDollars> yes_price_dollars;
1400 std::optional<FixedPointDollars> no_price_dollars;
1402 std::optional<std::int64_t> expiration_ts;
1404 std::optional<TimeInForce> time_in_force;
1406 std::optional<std::int64_t> buy_max_cost;
1407 std::optional<bool> post_only;
1408 std::optional<bool> reduce_only;
1410 std::optional<std::int64_t> sell_position_floor;
1411 std::optional<SelfTradePreventionType> self_trade_prevention_type;
1413 std::optional<std::string> order_group_id;
1416 std::optional<bool> cancel_order_on_pause;
1418 std::optional<std::int64_t> subaccount;
1420 std::optional<ExchangeIndex> exchange_index;
1421};
1422
1424 std::vector<CreateOrderRequest> orders;
1425};
1426
1428 std::vector<BatchCreateOrdersIndividualResponse> orders;
1429};
1430
1432 std::string ticker;
1433 std::optional<std::string> client_order_id;
1440 std::optional<std::int64_t> expiration_time;
1443 std::optional<bool> post_only;
1447 std::optional<bool> cancel_order_on_pause;
1449 std::optional<bool> reduce_only;
1451 std::optional<std::int64_t> subaccount;
1453 std::optional<std::string> order_group_id;
1455 std::optional<ExchangeIndex> exchange_index;
1456};
1457
1459 std::vector<CreateOrderV2Request> orders;
1460};
1461
1463 std::optional<std::string> order_id;
1464 std::optional<std::string> client_order_id;
1466 std::optional<FixedPointCount> fill_count;
1468 std::optional<FixedPointCount> remaining_count;
1470 std::optional<FixedPointDollars> average_fill_price;
1472 std::optional<FixedPointDollars> average_fee_paid;
1474 std::optional<std::int64_t> ts_ms;
1475 std::optional<ErrorResponse> error;
1476};
1477
1479 std::vector<BatchCreateOrdersV2ResponseOrdersItem> orders;
1480};
1481
1485 std::string market_tickers;
1487 std::int64_t start_ts{};
1489 std::int64_t end_ts{};
1491 std::int64_t period_interval{};
1493 std::optional<bool> include_latest_before_start;
1494};
1495
1506
1509 std::optional<FixedPointDollars> open_dollars;
1511 std::optional<FixedPointDollars> low_dollars;
1513 std::optional<FixedPointDollars> high_dollars;
1515 std::optional<FixedPointDollars> close_dollars;
1517 std::optional<FixedPointDollars> mean_dollars;
1519 std::optional<FixedPointDollars> previous_dollars;
1521 std::optional<FixedPointDollars> min_dollars;
1523 std::optional<FixedPointDollars> max_dollars;
1524};
1525
1545
1548 std::string market_ticker;
1550 std::vector<MarketCandlestick> candlesticks;
1551};
1552
1555 std::vector<MarketCandlesticksResponse> markets;
1556};
1557
1568
1571 std::string id;
1573 std::string proposer_user_id;
1575 std::string buyer_user_id;
1577 std::optional<std::string> buyer_subtrader_id;
1579 std::string seller_user_id;
1581 std::optional<std::string> seller_subtrader_id;
1583 std::string market_ticker;
1585 std::int64_t price_centi_cents{};
1587 std::int64_t centicount{};
1591 std::string expiration_ts;
1593 std::string status;
1595 std::string created_ts;
1597 std::string updated_ts;
1603 std::optional<std::string> buyer_accepted_ts;
1605 std::optional<std::string> seller_accepted_ts;
1607 std::optional<std::string> executed_ts;
1609 std::optional<std::string> buyer_order_id;
1611 std::optional<std::string> seller_order_id;
1612};
1613
1617 std::int64_t refill_rate{};
1619 std::int64_t bucket_capacity{};
1620};
1621
1625 std::optional<std::int64_t> subaccount;
1626};
1627
1631 std::optional<std::int64_t> subaccount;
1633 std::optional<ExchangeIndex> exchange_index;
1635 std::optional<std::string> market_ticker;
1636};
1637
1639 std::string order_id;
1640 std::optional<std::string> client_order_id;
1645 std::int64_t ts_ms{};
1646};
1647
1650 std::string name;
1652 std::string public_key;
1654 std::optional<std::vector<ApiKeyScope>> scopes;
1656 std::optional<std::int64_t> subaccount;
1658 std::optional<std::string> fcm_subtrader_id;
1659};
1660
1663 std::string api_key_id;
1667 std::optional<std::string> warning;
1668};
1669
1683
1688
1694
1699
1702 std::string market_ticker;
1704 std::string event_ticker;
1707};
1708
1715
1718 std::optional<std::string> event_ticker;
1720 std::optional<std::string> market_ticker;
1722 std::optional<std::string> side;
1724 std::optional<FixedPointDollars> yes_settlement_value_dollars;
1725};
1726
1729 std::string start;
1731 std::string end;
1733 std::string step;
1734};
1735
1736struct Market {
1737 std::string ticker;
1738 std::string event_ticker;
1741 std::optional<std::string> title;
1742 std::optional<std::string> subtitle;
1744 std::string yes_sub_title;
1746 std::string no_sub_title;
1747 std::string created_time;
1749 std::string updated_time;
1750 std::string open_time;
1751 std::string close_time;
1753 std::optional<std::string> expected_expiration_time;
1754 std::optional<std::string> expiration_time;
1793 std::optional<FixedPointDollars> settlement_value_dollars;
1795 std::optional<std::string> settlement_ts;
1799 std::optional<FixedPointDollars> settlement_floor_dollars;
1801 std::string expiration_value;
1803 std::optional<std::string> occurrence_datetime;
1805 std::optional<std::string> fee_waiver_expiration_time;
1807 std::optional<std::string> early_close_condition;
1809 std::optional<StrikeType> strike_type;
1811 std::optional<double> floor_strike;
1813 std::optional<double> cap_strike;
1815 std::optional<std::string> functional_strike;
1817 std::optional<RawJson> custom_strike;
1819 std::string rules_primary;
1821 std::string rules_secondary;
1823 std::optional<std::string> mve_collection_ticker;
1824 std::optional<std::vector<MveSelectedLeg>> mve_selected_legs;
1825 std::optional<std::string> primary_participant_key;
1829 std::vector<PriceRange> price_ranges;
1831 std::optional<bool> is_provisional;
1832 std::optional<ExchangeIndex> exchange_index;
1833};
1834
1837 std::string event_ticker;
1839 std::string market_ticker;
1841 std::optional<Market> market;
1842};
1843
1847 std::optional<std::int64_t> subaccount;
1850 std::optional<std::int64_t> contracts_limit;
1853 std::optional<FixedPointCount> contracts_limit_fp;
1855 std::optional<ExchangeIndex> exchange_index;
1856};
1857
1860 std::string order_group_id;
1862 std::int64_t subaccount{};
1863 std::optional<ExchangeIndex> exchange_index;
1864};
1865
1869
1871 std::string order_id;
1872 std::optional<std::string> client_order_id;
1878 std::optional<FixedPointDollars> average_fill_price;
1880 std::optional<FixedPointDollars> average_fee_paid;
1882 std::int64_t ts_ms{};
1883};
1884
1886 std::string ticker;
1887 std::optional<std::string> client_order_id;
1894 std::optional<std::int64_t> expiration_time;
1897 std::optional<bool> post_only;
1901 std::optional<bool> cancel_order_on_pause;
1903 std::optional<bool> reduce_only;
1905 std::optional<std::int64_t> subaccount;
1907 std::optional<std::string> order_group_id;
1909 std::optional<ExchangeIndex> exchange_index;
1911};
1912
1915 std::string rfq_id;
1924 std::optional<bool> post_only;
1926 std::optional<std::int64_t> subaccount;
1927};
1928
1931 std::string id;
1932};
1933
1937 std::optional<std::string> market_ticker;
1940 std::optional<std::vector<TickerPair>> selected_markets;
1942 std::optional<FixedPointCount> contracts_fp;
1944 std::optional<FixedPointDollars> target_cost_dollars;
1945};
1946
1955
1958 std::vector<RFQBatchQuoteEntry> quotes;
1963 std::optional<bool> post_only;
1966 std::optional<std::int64_t> subaccount;
1967};
1968
1971 std::string id;
1972};
1973
1976 std::vector<CreateRFQBatchChild> children;
1978 std::optional<std::string> mve_collection_ticker;
1980 std::optional<FixedPointCount> contracts_fp;
1982 std::optional<FixedPointDollars> target_cost_dollars;
1984 std::optional<bool> target_cost_excludes_fees;
1986 std::optional<bool> rest_remainder;
1988 std::optional<bool> replace_existing;
1990 std::optional<bool> obscure_creator_id;
1993 std::optional<std::string> client_batch_id;
1996 std::optional<std::string> subtrader_id;
1999 std::optional<std::int64_t> subaccount;
2000};
2001
2002struct RFQ {
2004 std::string id;
2006 std::string creator_id;
2008 std::string market_ticker;
2012 std::optional<FixedPointDollars> target_cost_dollars;
2015 std::optional<bool> target_cost_excludes_fees;
2019 std::string created_ts;
2021 std::optional<std::string> mve_collection_ticker;
2023 std::optional<std::vector<MveSelectedLeg>> mve_selected_legs;
2025 std::optional<bool> rest_remainder;
2027 std::optional<std::string> cancellation_reason;
2029 std::optional<std::string> creator_user_id;
2031 std::optional<std::int64_t> creator_subaccount;
2033 std::optional<std::string> cancelled_ts;
2035 std::optional<std::string> updated_ts;
2037 std::optional<std::string> rfq_batch_id;
2038};
2039
2040struct RFQBatch {
2042 std::string id;
2045 std::string creator_id;
2048 std::string created_ts;
2050 std::optional<std::string> accepted_ts;
2052 std::optional<std::string> closed_ts;
2054 std::vector<RFQ> rfqs;
2056 std::optional<std::string> updated_ts;
2058 std::optional<std::string> close_reason;
2060 std::optional<std::string> client_batch_id;
2062 std::optional<std::string> creator_user_id;
2064 std::optional<std::int64_t> creator_subaccount;
2065};
2066
2070
2073 std::string market_ticker;
2075 std::optional<std::int64_t> contracts;
2077 std::optional<FixedPointCount> contracts_fp;
2079 std::optional<std::int64_t> target_cost_centi_cents;
2081 std::optional<FixedPointDollars> target_cost_dollars;
2084 std::optional<bool> target_cost_excludes_fees;
2087 std::optional<bool> obscure_creator_id;
2091 std::optional<bool> replace_existing;
2093 std::optional<std::string> subtrader_id;
2096 std::optional<std::int64_t> subaccount;
2097};
2098
2101 std::string id;
2102};
2103
2106 std::optional<ExchangeIndex> exchange_index;
2107};
2108
2111 std::int64_t subaccount_number{};
2112};
2113
2128
2131 std::string open_time;
2133 std::string close_time;
2134};
2135
2139 std::optional<std::int64_t> subaccount;
2140};
2141
2144 std::optional<FixedPointCount> reduce_by;
2146 std::optional<FixedPointCount> reduce_to;
2148 std::optional<ExchangeIndex> exchange_index;
2150 std::optional<std::string> market_ticker;
2151};
2152
2154 std::string order_id;
2155 std::optional<std::string> client_order_id;
2159 std::int64_t ts_ms{};
2160};
2161
2165 std::optional<std::int64_t> subaccount;
2166 std::optional<Kind> kind;
2167};
2168
2174
2178 std::optional<std::int64_t> subaccount;
2180 std::optional<ExchangeIndex> exchange_index;
2181};
2182
2183struct Deposit {
2185 std::string id;
2191 std::int64_t amount_cents{};
2193 std::int64_t fee_cents{};
2195 std::int64_t created_ts{};
2197 std::optional<std::int64_t> finalized_ts;
2198};
2199
2202 std::string method;
2204 std::string path;
2206 std::int64_t cost{};
2207};
2208
2211 std::optional<EventContractExitSlippage> slippage;
2212 std::string id;
2213 std::string ticker;
2215 std::int64_t subaccount_number{};
2217 std::optional<FixedPointDollars> stop_loss_price;
2218 std::optional<FixedPointDollars> take_profit_price;
2220 std::optional<std::string> status_reason;
2221 std::optional<std::string> triggered_order_id;
2222 std::optional<TriggeredLeg> triggered_leg;
2223 std::string created_time;
2224 std::string updated_time;
2225};
2226
2229 std::optional<std::string> name;
2231 std::optional<std::string> url;
2232};
2233
2236 std::string event_ticker;
2238 std::string series_ticker;
2240 std::string sub_title;
2242 std::string title;
2250 std::optional<std::string> category;
2252 std::optional<std::string> strike_date;
2254 std::optional<std::string> strike_period;
2256 std::optional<std::vector<Market>> markets;
2258 std::optional<RawJson> product_metadata;
2260 std::optional<std::vector<SettlementSource>> settlement_sources;
2262 std::optional<std::string> last_updated_ts;
2264 std::optional<std::string> fee_type_override;
2266 std::optional<double> fee_multiplier_override;
2267 std::optional<ExchangeIndex> exchange_index;
2268};
2269
2272 std::string id;
2274 std::string event_ticker;
2276 std::string series_ticker;
2278 std::optional<FeeType> fee_type_override;
2280 std::optional<double> fee_multiplier_override;
2282 std::string scheduled_ts;
2283};
2284
2287 std::string type;
2291 std::optional<bool> is_historical;
2293 std::optional<std::string> default_range;
2295 std::optional<std::vector<std::string>> range_options;
2296};
2297
2313
2325
2334 std::optional<std::string> exchange_estimated_resume_time;
2336 std::optional<std::vector<ExchangeIndexStatus>> exchange_index_statuses;
2337};
2338
2341 std::string subtrader_id;
2343 std::vector<std::int64_t> exchange_indices;
2350};
2351
2352struct FcmFill {
2354 std::string fill_id;
2357 std::string ticker;
2365 std::optional<std::string> created_time;
2367 std::optional<std::string> maker_order_id;
2369 std::optional<std::string> maker_subtrader_id;
2371 std::optional<FixedPointDollars> maker_fee_cost;
2373 std::optional<std::string> taker_order_id;
2375 std::optional<std::string> taker_subtrader_id;
2377 std::optional<FixedPointDollars> taker_fee_cost;
2378};
2379
2380struct Fill {
2382 std::string fill_id;
2385 std::string trade_id;
2387 std::string order_id;
2389 std::string ticker;
2391 std::string market_ticker;
2393 std::optional<Side> side;
2395 std::optional<Action> action;
2407 bool is_taker{};
2409 std::optional<std::string> created_time;
2413 std::optional<std::int64_t> subaccount_number;
2415 std::optional<std::int64_t> ts;
2416};
2417
2428
2431 std::string event_ticker;
2433 std::int64_t end_period_ts{};
2435 std::int64_t period_interval{};
2437 std::vector<PercentilePoint> percentile_points;
2438};
2439
2442 std::string name;
2443 std::optional<ApiKeyType> key_type;
2445 std::optional<std::vector<ApiKeyScope>> scopes;
2447 std::optional<std::int64_t> subaccount;
2449 std::optional<std::string> fcm_subtrader_id;
2450};
2451
2454 std::string api_key_id;
2455 std::optional<ApiKeyType> key_type;
2458 std::string private_key;
2462 std::optional<std::string> warning;
2463};
2464
2468 std::string usage_tier;
2474 std::vector<ApiUsageLevelGrant> grants;
2475};
2476
2480 std::vector<AccountApiUsageLevelVolumeProgress> volume_progress;
2481};
2482
2485 std::int64_t default_cost{};
2487 std::vector<EndpointTokenCost> endpoint_costs;
2488};
2489
2493 std::optional<std::string> fcm_subtrader_id;
2494};
2495
2498 std::vector<ApiKey> api_keys;
2501 std::optional<std::int64_t> api_key_region_expiration_ts;
2502};
2503
2507 std::optional<std::int64_t> subaccount;
2509 std::optional<ExchangeIndex> exchange_index;
2510};
2511
2516
2519 std::int64_t balance{};
2524 std::int64_t portfolio_value{};
2526 std::int64_t updated_ts{};
2529 std::optional<std::vector<IndexedBalance>> balance_breakdown;
2530};
2531
2535 std::optional<std::string> cursor;
2537 std::optional<std::string> market_ticker;
2539 std::optional<std::int64_t> limit;
2541 std::optional<std::string> status;
2542};
2543
2546 std::vector<BlockTradeProposal> block_trade_proposals;
2548 std::optional<std::string> cursor;
2549};
2550
2555
2559 std::optional<std::int64_t> limit;
2561 std::optional<std::string> cursor;
2563 std::optional<std::int64_t> min_ts;
2565 std::optional<std::int64_t> max_ts;
2566};
2567
2569 std::vector<CreditHistory> credits;
2571 std::string cursor;
2572};
2573
2577 std::optional<std::int64_t> limit;
2579 std::optional<std::string> cursor;
2580};
2581
2583 std::vector<Deposit> deposits;
2584 std::optional<std::string> cursor;
2585};
2586
2589 std::vector<std::string> market_tickers;
2591 std::vector<std::vector<MarketCandlestick>> market_candlesticks;
2594 std::int64_t adjusted_end_ts{};
2595};
2596
2600 std::optional<std::int64_t> subaccount;
2601 std::optional<Kind> kind;
2602};
2603
2605 std::optional<EventContractExitTrigger> exit_trigger;
2606 std::vector<EventContractExitTrigger> exit_triggers;
2607};
2608
2611 std::optional<std::string> event_ticker;
2613 std::optional<std::int64_t> limit;
2615 std::optional<std::string> cursor;
2616};
2617
2619 std::vector<EventFeeChange> event_fee_changes;
2621 std::string cursor;
2622};
2623
2627 std::vector<std::int64_t> percentiles;
2629 std::int64_t start_ts{};
2631 std::int64_t end_ts{};
2633 std::int64_t period_interval{};
2634};
2635
2638 std::vector<ForecastPercentilesPoint> forecast_history;
2639};
2640
2644 std::optional<std::string> range;
2645};
2646
2650
2653 std::string market_ticker;
2655 std::string image_url;
2657 std::string color_code;
2658};
2659
2662 std::string image_url;
2664 std::optional<std::string> featured_image_url;
2666 std::vector<MarketMetadata> market_details;
2668 std::vector<SettlementSource> settlement_sources;
2670 std::optional<std::string> competition;
2672 std::optional<std::string> competition_scope;
2673};
2674
2678 std::optional<bool> exclude_markets;
2680 std::optional<bool> with_nested_markets;
2681};
2682
2687 std::vector<Market> markets;
2688};
2689
2693 std::optional<std::int64_t> limit;
2695 std::optional<std::string> cursor;
2697 std::optional<bool> with_nested_markets;
2699 std::optional<bool> with_milestones;
2701 std::optional<GetEventsStatus> status;
2703 std::optional<std::string> series_ticker;
2705 std::optional<std::string> tickers;
2708 std::optional<std::int64_t> min_close_ts;
2710 std::optional<std::int64_t> min_updated_ts;
2711};
2712
2715 std::string id;
2717 std::string category;
2719 std::string type;
2721 std::string start_date;
2723 std::optional<std::string> end_date;
2725 std::vector<std::string> related_event_tickers;
2727 std::string title;
2731 std::optional<std::string> source_id;
2733 std::optional<std::map<std::string, std::string>> source_ids;
2737 std::vector<std::string> primary_event_tickers;
2739 std::string last_updated_ts;
2740};
2741
2744 std::vector<EventData> events;
2746 std::optional<std::vector<Milestone>> milestones;
2748 std::string cursor;
2749};
2750
2753 std::string start_time;
2755 std::string end_time;
2757 std::vector<DailySchedule> monday;
2759 std::vector<DailySchedule> tuesday;
2761 std::vector<DailySchedule> wednesday;
2763 std::vector<DailySchedule> thursday;
2765 std::vector<DailySchedule> friday;
2767 std::vector<DailySchedule> saturday;
2769 std::vector<DailySchedule> sunday;
2770};
2771
2774 std::string start_datetime;
2776 std::string end_datetime;
2777};
2778
2779struct Schedule {
2781 std::vector<WeeklySchedule> standard_hours;
2783 std::vector<MaintenanceWindow> maintenance_windows;
2784};
2785
2789
2799
2802 std::vector<std::string> categories;
2803};
2804
2808 std::optional<std::string> subtrader_id;
2809};
2810
2814 std::optional<std::int64_t> min_ts;
2816 std::optional<std::int64_t> max_ts;
2818 std::optional<std::string> cursor;
2819};
2820
2822 std::vector<FcmFill> fills;
2823 std::string cursor;
2824};
2825
2829 std::optional<std::string> subtrader_id;
2831 std::optional<std::string> client_order_ids;
2833 std::optional<std::string> cursor;
2835 std::optional<std::string> event_ticker;
2837 std::optional<std::string> ticker;
2839 std::optional<std::int64_t> min_ts;
2841 std::optional<std::int64_t> max_ts;
2843 std::optional<OrderStatus> status;
2845 std::optional<std::int64_t> limit;
2846};
2847
2851 std::optional<std::string> subtrader_id;
2853 std::optional<std::string> ticker;
2855 std::optional<std::string> event_ticker;
2858 std::optional<std::string> count_filter;
2860 std::optional<SettlementStatus> settlement_status;
2862 std::optional<std::int64_t> limit;
2864 std::optional<std::string> cursor;
2865};
2866
2872
2876 std::optional<std::string> ticker;
2878 std::optional<std::int64_t> min_ts;
2880 std::optional<std::int64_t> max_ts;
2882 std::optional<std::int64_t> limit;
2884 std::optional<std::string> cursor;
2886 std::optional<std::int64_t> subaccount;
2887};
2888
2892 std::optional<std::string> ticker;
2894 std::optional<std::string> order_id;
2896 std::optional<std::int64_t> min_ts;
2898 std::optional<std::int64_t> max_ts;
2900 std::optional<std::int64_t> limit;
2902 std::optional<std::string> cursor;
2904 std::optional<std::int64_t> subaccount;
2906 std::optional<std::int64_t> exchange_index;
2907};
2908
2910 std::vector<Fill> fills;
2911 std::string cursor;
2912};
2913
2916 std::vector<std::string> scopes;
2917};
2918
2921 std::vector<std::string> scopes;
2923 std::map<std::string, ScopeList> competitions;
2924};
2925
2928 std::map<std::string, SportFilterDetails> filters_by_sports;
2930 std::vector<std::string> sport_ordering;
2931};
2932
2934 std::optional<std::vector<RawJson>> events;
2935};
2936
2939 std::optional<std::vector<PlayByPlayPeriodsItem>> periods;
2940};
2941
2943 std::optional<PlayByPlay> pbp;
2944};
2945
2956
2960 std::optional<std::int64_t> limit;
2962 std::optional<std::string> cursor;
2964 std::optional<std::string> tickers;
2966 std::optional<std::string> event_ticker;
2968 std::optional<std::string> series_ticker;
2970 std::optional<GetHistoricalMarketsMveFilter> mve_filter;
2971};
2972
2976 std::optional<std::string> ticker;
2978 std::optional<std::int64_t> min_ts;
2980 std::optional<std::int64_t> max_ts;
2982 std::optional<std::int64_t> limit;
2984 std::optional<std::string> cursor;
2986 std::optional<std::int64_t> subaccount;
2987};
2988
2992 std::optional<std::string> ticker;
2994 std::optional<std::string> event_ticker;
2996 std::optional<std::int64_t> subaccount;
2998 std::optional<std::int64_t> limit;
3000 std::optional<std::string> cursor;
3001};
3002
3006 std::optional<GetIncentiveProgramsStatus> status;
3008 std::optional<GetIncentiveProgramsType> type;
3010 std::optional<std::string> incentive_description;
3012 std::optional<std::int64_t> limit;
3014 std::optional<std::string> cursor;
3015};
3016
3019 std::string id;
3021 std::string market_id;
3023 std::string market_ticker;
3029 std::string start_date;
3031 std::string end_date;
3033 std::int64_t period_reward{};
3035 bool paid_out{};
3037 std::optional<std::int64_t> discount_factor_bps;
3039 std::optional<FixedPointCount> target_size_fp;
3041 std::optional<std::int64_t> max_reward_per_account;
3042};
3043
3045 std::vector<IncentiveProgram> incentive_programs;
3047 std::optional<std::string> next_cursor;
3048};
3049
3069
3073
3077 std::optional<std::int64_t> limit;
3079 std::optional<std::string> cursor;
3080};
3081
3083 std::vector<IntraExchangeInstanceTransfer> transfers;
3085 std::optional<std::string> cursor;
3086};
3087
3091 std::optional<bool> include_player_stats;
3092};
3093
3097 std::optional<bool> include_player_stats;
3098};
3099
3100struct LiveData {
3102 std::string type;
3106 std::string milestone_id;
3107};
3108
3112
3116 std::vector<std::string> milestone_ids;
3118 std::optional<bool> include_player_stats;
3119};
3120
3122 std::vector<LiveData> live_datas;
3123};
3124
3128 std::int64_t start_ts{};
3130 std::int64_t end_ts{};
3132 std::int64_t period_interval{};
3133};
3134
3138 std::int64_t start_ts{};
3140 std::int64_t end_ts{};
3142 std::int64_t period_interval{};
3143};
3144
3147 std::optional<FixedPointDollars> open;
3149 std::optional<FixedPointDollars> low;
3151 std::optional<FixedPointDollars> high;
3153 std::optional<FixedPointDollars> close;
3155 std::optional<FixedPointDollars> mean;
3157 std::optional<FixedPointDollars> previous;
3158};
3159
3179
3182 std::string ticker;
3184 std::vector<MarketCandlestickHistorical> candlesticks;
3185};
3186
3190 std::int64_t start_ts{};
3192 std::int64_t end_ts{};
3194 std::int64_t period_interval{};
3196 std::optional<bool> include_latest_before_start;
3197};
3198
3201 std::string ticker;
3203 std::vector<MarketCandlestick> candlesticks;
3204};
3205
3208 std::int64_t t{};
3210 double v{};
3211};
3212
3215 std::string id;
3217 std::string source;
3220 std::optional<std::int64_t> last_tick_ms;
3222 std::string interval;
3224 std::int64_t start_ms{};
3226 std::int64_t end_ms{};
3227 std::vector<MarketIndexTimeseriesPoint> timeseries;
3228};
3229
3233 std::string timezone;
3235 std::string open;
3237 std::string close;
3239 std::vector<std::string> days;
3242 std::optional<std::string> calendar;
3243};
3244
3247 std::string source;
3250 std::optional<double> value;
3252 std::optional<std::int64_t> last_tick_ms;
3253};
3254
3257 std::string id;
3259 std::string name;
3261 std::string family;
3263 std::optional<std::string> gics_code;
3265 std::optional<std::string> sector;
3267 std::string currency;
3269 std::string units;
3273 std::optional<MarketIndexLatest> latest;
3274};
3275
3279 std::string source;
3282 std::optional<double> value;
3284 std::optional<std::int64_t> last_tick_ms;
3286 std::string interval;
3288 std::int64_t start_ms{};
3290 std::int64_t end_ms{};
3291 std::vector<MarketIndexTimeseriesPoint> timeseries;
3292};
3293
3295 std::vector<MarketIndex> indexes;
3296};
3297
3302 std::optional<std::int64_t> depth;
3303};
3304
3307 std::vector<PriceLevelDollarsCountFp> yes_dollars;
3308 std::vector<PriceLevelDollarsCountFp> no_dollars;
3309};
3310
3315
3319 std::vector<std::string> tickers;
3320};
3321
3326
3328 std::vector<MarketOrderbookFp> orderbooks;
3329};
3330
3334
3338 std::optional<std::int64_t> limit;
3340 std::optional<std::string> cursor;
3342 std::optional<std::string> event_ticker;
3344 std::optional<std::string> series_ticker;
3346 std::optional<std::int64_t> min_created_ts;
3348 std::optional<std::int64_t> max_created_ts;
3350 std::optional<std::int64_t> min_updated_ts;
3352 std::optional<std::int64_t> max_updated_ts;
3354 std::optional<std::int64_t> max_close_ts;
3356 std::optional<std::int64_t> min_close_ts;
3358 std::optional<std::int64_t> min_settled_ts;
3360 std::optional<std::int64_t> max_settled_ts;
3362 std::optional<GetMarketsStatus> status;
3364 std::optional<std::string> tickers;
3366 std::optional<GetMarketsMveFilter> mve_filter;
3367};
3368
3370 std::vector<Market> markets;
3371 std::string cursor;
3372};
3373
3378
3382 std::int64_t limit{};
3384 std::optional<std::string> minimum_start_date;
3386 std::optional<std::string> category;
3388 std::optional<std::string> competition;
3390 std::optional<std::string> source_id;
3392 std::optional<std::string> type;
3394 std::optional<std::string> related_event_ticker;
3396 std::optional<std::string> cursor;
3398 std::optional<std::int64_t> min_updated_ts;
3399};
3400
3403 std::vector<Milestone> milestones;
3405 std::optional<std::string> cursor;
3406};
3407
3412 std::string series_ticker;
3414 std::optional<ExchangeIndex> exchange_index;
3416 std::string title;
3418 std::string description;
3420 std::string open_date;
3422 std::string close_date;
3424 std::vector<AssociatedEvent> associated_events;
3427 std::vector<std::string> associated_event_tickers;
3437 std::int64_t size_min{};
3439 std::int64_t size_max{};
3446 std::vector<PriceRange> price_ranges;
3447};
3448
3453
3457 std::optional<GetMultivariateEventCollectionsStatus> status;
3459 std::optional<std::string> associated_event_ticker;
3461 std::optional<std::string> series_ticker;
3463 std::optional<std::int64_t> limit;
3465 std::optional<std::string> cursor;
3466};
3467
3470 std::vector<MultivariateEventCollection> multivariate_contracts;
3472 std::optional<std::string> cursor;
3473};
3474
3478 std::optional<std::int64_t> limit;
3480 std::optional<std::string> cursor;
3482 std::optional<std::string> series_ticker;
3484 std::optional<std::string> collection_ticker;
3486 std::optional<std::string> tickers;
3488 std::optional<bool> with_nested_markets;
3489};
3490
3493 std::vector<EventData> events;
3495 std::string cursor;
3496};
3497
3501 std::optional<std::int64_t> subaccount;
3502};
3503
3509 std::optional<FixedPointCount> contracts_limit_fp;
3511 std::vector<std::string> orders;
3512 std::optional<ExchangeIndex> exchange_index;
3513};
3514
3518 std::optional<std::int64_t> subaccount;
3519};
3520
3523 std::string id;
3526 std::optional<FixedPointCount> contracts_limit_fp;
3529 std::optional<ExchangeIndex> exchange_index;
3530};
3531
3533 std::optional<std::vector<OrderGroup>> order_groups;
3534};
3535
3540
3544 std::optional<std::string> market_tickers;
3546 std::optional<std::string> event_ticker;
3548 std::optional<std::int64_t> subaccount;
3549};
3550
3559
3562 std::vector<OrderQueuePosition> queue_positions;
3563};
3564
3568
3572 std::optional<std::string> ticker;
3574 std::optional<std::string> event_ticker;
3576 std::optional<std::int64_t> min_ts;
3578 std::optional<std::int64_t> max_ts;
3580 std::optional<std::string> status;
3582 std::optional<std::int64_t> limit;
3584 std::optional<std::string> cursor;
3586 std::optional<std::int64_t> subaccount;
3588 std::optional<std::int64_t> exchange_index;
3589};
3590
3592 std::vector<Order> orders;
3593 std::string cursor;
3594};
3595
3603
3607 std::optional<std::string> cursor;
3609 std::optional<std::int64_t> limit;
3612 std::optional<std::string> count_filter;
3615 std::optional<SettlementStatus> settlement_status;
3617 std::optional<std::string> ticker;
3619 std::optional<std::string> event_ticker;
3621 std::optional<std::int64_t> subaccount;
3623 std::optional<std::int64_t> exchange_index;
3624};
3625
3645
3648 std::optional<std::string> cursor;
3650 std::vector<MarketPosition> market_positions;
3652 std::vector<EventPosition> event_positions;
3653};
3654
3659
3663 std::optional<std::string> cursor;
3666 std::optional<std::int64_t> min_ts;
3669 std::optional<std::int64_t> max_ts;
3671 std::optional<std::int64_t> limit;
3673 std::optional<std::string> status;
3675 std::optional<std::string> quote_creator_user_id;
3677 std::optional<UserFilter> user_filter;
3679 std::optional<UserFilter> rfq_user_filter;
3681 std::optional<std::string> rfq_creator_user_id;
3683 std::optional<std::string> rfq_creator_subtrader_id;
3685 std::optional<std::string> rfq_id;
3686};
3687
3690 std::vector<Quote> quotes;
3692 std::optional<std::string> cursor;
3693};
3694
3697 std::string rfq_id;
3699 std::string market_ticker;
3701 std::optional<FixedPointDollars> yes_bid_dollars;
3703 std::optional<FixedPointDollars> no_bid_dollars;
3705 std::optional<FixedPointCount> yes_contracts_offered_fp;
3707 std::optional<FixedPointCount> no_contracts_offered_fp;
3708};
3709
3712 std::string rfq_batch_id;
3715 std::int64_t version{};
3717 std::optional<std::string> updated_ts;
3723 std::vector<RFQBatchBestQuote> rfqs;
3724};
3725
3729
3733 std::string id;
3735 std::string rfq_batch_id;
3737 std::string creator_id;
3739 std::string rfq_creator_id;
3742 std::string created_ts;
3744 std::string updated_ts;
3746 std::optional<Side> accepted_side;
3748 std::optional<std::string> accepted_ts;
3750 std::optional<std::string> confirmed_ts;
3753 std::vector<Quote> quotes;
3756 std::optional<bool> rest_remainder;
3758 std::optional<bool> post_only;
3760 std::optional<std::string> creator_user_id;
3762 std::optional<std::int64_t> creator_subaccount;
3764 std::optional<std::string> rfq_creator_user_id;
3766 std::optional<std::int64_t> rfq_creator_subaccount;
3767};
3768
3771 std::vector<RFQBatchQuote> batch_quotes;
3772};
3773
3777
3780 std::vector<RFQBatch> rfq_batches;
3782 std::optional<std::string> cursor;
3783};
3784
3788};
3789
3792 std::vector<RFQ> rfqs;
3794 std::optional<std::string> cursor;
3795};
3796
3800 std::optional<std::string> cursor;
3802 std::optional<std::int64_t> subaccount;
3804 std::optional<std::int64_t> limit;
3806 std::optional<RFQBatchStatus> status;
3807 std::optional<UserFilter> user_filter;
3808};
3809
3813 std::optional<std::string> cursor;
3815 std::optional<std::string> event_ticker;
3817 std::optional<std::string> market_ticker;
3819 std::optional<std::int64_t> subaccount;
3821 std::optional<std::int64_t> limit;
3823 std::optional<std::string> status;
3825 std::optional<std::string> creator_user_id;
3826 std::optional<UserFilter> user_filter;
3827};
3828
3831 std::optional<std::string> series_ticker;
3832 std::optional<bool> show_historical;
3833};
3834
3837 std::string id;
3839 std::string series_ticker;
3845 std::string scheduled_ts;
3846};
3847
3849 std::vector<SeriesFeeChange> series_fee_change_arr;
3850};
3851
3855 std::optional<std::string> category;
3856 std::optional<std::string> tags;
3857 std::optional<bool> include_product_metadata;
3859 std::optional<bool> include_volume;
3861 std::optional<std::int64_t> min_updated_ts;
3862};
3863
3864struct Series {
3866 std::string ticker;
3868 std::string frequency;
3870 std::string title;
3872 std::string category;
3874 std::vector<std::string> categories;
3877 std::optional<std::vector<std::string>> tags;
3880 std::optional<std::vector<SettlementSource>> settlement_sources;
3883 std::string contract_url;
3887 std::optional<RawJson> product_metadata;
3893 std::optional<std::vector<std::string>> additional_prohibitions;
3896 std::optional<FixedPointCount> volume_fp;
3898 std::optional<std::string> last_updated_ts;
3899 std::optional<ExchangeIndex> exchange_index;
3900};
3901
3903 std::vector<Series> series;
3904};
3905
3909 std::optional<bool> include_volume;
3910};
3911
3915
3919 std::optional<std::int64_t> limit;
3921 std::optional<std::string> cursor;
3923 std::optional<std::string> ticker;
3925 std::optional<std::string> event_ticker;
3927 std::optional<std::int64_t> min_ts;
3929 std::optional<std::int64_t> max_ts;
3931 std::optional<std::int64_t> subaccount;
3932};
3933
3960
3962 std::vector<Settlement> settlements;
3963 std::optional<std::string> cursor;
3964};
3965
3968 std::optional<std::string> id;
3970 std::optional<std::string> name;
3972 std::optional<std::string> type;
3974 std::optional<RawJson> details;
3977 std::optional<std::string> source_id;
3979 std::optional<std::map<std::string, std::string>> source_ids;
3981 std::optional<std::string> last_updated_ts;
3982};
3983
3985 std::optional<StructuredTarget> structured_target;
3986};
3987
3991 std::vector<std::string> ids;
3993 std::optional<std::string> type;
3995 std::optional<std::string> competition;
3997 std::optional<std::int64_t> page_size;
3999 std::optional<std::string> cursor;
4000};
4001
4003 std::optional<std::vector<StructuredTarget>> structured_targets;
4005 std::optional<std::string> cursor;
4006};
4007
4018
4020 std::vector<SubaccountBalance> subaccount_balances;
4021};
4022
4025 std::int64_t subaccount_number{};
4027 bool enabled{};
4029 std::int64_t exchange_index{};
4030};
4031
4033 std::vector<SubaccountNettingConfig> netting_configs;
4034};
4035
4039 std::optional<std::int64_t> limit;
4041 std::optional<std::string> cursor;
4042};
4043
4046 std::string transfer_id;
4048 std::int64_t from_subaccount{};
4050 std::int64_t to_subaccount{};
4052 std::int64_t amount_cents{};
4054 std::int64_t created_ts{};
4056 std::int64_t exchange_index{};
4057};
4058
4060 std::vector<SubaccountTransfer> transfers;
4062 std::optional<std::string> cursor;
4063};
4064
4067 std::map<std::string, std::vector<std::string>> tags_by_categories;
4068};
4069
4072 std::int64_t exchange_index{};
4074 std::int64_t percent{};
4075};
4076
4081
4085 std::optional<std::string> ticker;
4087 std::optional<std::int64_t> min_ts;
4089 std::optional<std::int64_t> max_ts;
4091 std::optional<std::int64_t> limit;
4093 std::optional<std::string> cursor;
4095 std::optional<bool> is_block_trade;
4096};
4097
4101 std::optional<std::int64_t> limit;
4103 std::optional<std::string> cursor;
4105 std::optional<std::string> ticker;
4107 std::optional<std::int64_t> min_ts;
4109 std::optional<std::int64_t> max_ts;
4111 std::optional<bool> is_block_trade;
4112};
4113
4136
4138 std::vector<Trade> trades;
4139 std::string cursor;
4140};
4141
4146
4149 std::string station_id;
4151 double weight{};
4153 double offset_c{};
4157 std::optional<std::string> update_note;
4158};
4159
4162 std::string config_version;
4164 std::optional<std::int64_t> published_at_ms;
4167 std::int64_t effective_at_ms{};
4169 std::optional<std::string> change_reason;
4171 std::optional<std::int64_t> calibration_window_start_ms;
4173 std::optional<std::int64_t> calibration_window_end_ms;
4178 std::vector<WeatherIndexCalibrationStation> stations;
4179};
4180
4183 std::string city;
4186 std::string units;
4188 std::vector<WeatherIndexCalibration> calibrations;
4189};
4190
4194 std::optional<std::int64_t> from;
4196 std::optional<std::int64_t> to;
4198 std::optional<std::int64_t> last_sec;
4200 std::optional<bool> detailed;
4201};
4202
4205 std::string station_id;
4209 std::string code;
4211 std::optional<std::string> source;
4214 std::optional<double> temp_f;
4216 std::optional<std::int64_t> obs_time_ms;
4218 std::optional<std::int64_t> received_at_ms;
4220 std::optional<std::string> primary_code;
4221};
4222
4225 std::int64_t t{};
4227 std::optional<double> v;
4231 std::string status;
4233 std::optional<std::int64_t> contributors;
4236 std::optional<std::string> receipt_basis;
4239 std::optional<std::vector<WeatherIndexStationReading>> stations;
4240};
4241
4244 std::string city;
4246 std::optional<std::string> config_version;
4248 std::string units;
4249 std::vector<WeatherIndexPoint> timeseries;
4250};
4251
4255 std::optional<std::int64_t> limit;
4257 std::optional<std::string> cursor;
4258};
4259
4262 std::string id;
4268 std::int64_t amount_cents{};
4270 std::int64_t fee_cents{};
4272 std::int64_t created_ts{};
4274 std::optional<std::int64_t> finalized_ts;
4275};
4276
4278 std::vector<Withdrawal> withdrawals;
4279 std::optional<std::string> cursor;
4280};
4281
4284 std::optional<std::string> client_transfer_id;
4290 std::int64_t amount{};
4292 std::optional<std::int64_t> source_exchange_shard;
4294 std::optional<std::int64_t> destination_exchange_shard;
4296 std::optional<std::int64_t> source_subaccount;
4298 std::optional<std::int64_t> destination_subaccount;
4299};
4300
4305
4307 std::vector<FCMSubtrader> subtraders;
4308};
4309
4312 std::string buyer_user_id;
4314 std::optional<std::string> buyer_subtrader_id;
4316 std::optional<std::int64_t> buyer_subaccount;
4318 std::string seller_user_id;
4320 std::optional<std::string> seller_subtrader_id;
4323 std::optional<std::int64_t> seller_subaccount;
4325 std::string market_ticker;
4327 std::int64_t price_centi_cents{};
4329 std::int64_t centicount{};
4333 std::string expiration_ts;
4334};
4335
4340
4344 std::optional<std::int64_t> subaccount;
4346 std::optional<ExchangeIndex> exchange_index;
4347};
4348
4352 std::optional<std::int64_t> subaccount;
4353};
4354
4357 std::optional<EventContractExitSlippage> slippage;
4358 std::optional<Kind> kind;
4359 std::optional<FixedPointDollars> stop_loss_price;
4360 std::optional<FixedPointDollars> take_profit_price;
4361};
4362
4365 std::int64_t exchange_index{};
4367 std::int64_t percent{};
4368};
4369
4371 std::vector<TargetBalanceAllocationInput> allocations;
4373 std::optional<RestingMarginReservation> resting_margin_reservation;
4374};
4375
4379 std::optional<std::int64_t> subaccount;
4381 std::optional<ExchangeIndex> exchange_index;
4382};
4383
4389
4398
4401 std::vector<std::string> categories;
4402};
4403
4407 std::optional<std::int64_t> subaccount;
4409 std::optional<ExchangeIndex> exchange_index;
4410};
4411
4415 std::optional<std::int64_t> contracts_limit;
4418 std::optional<FixedPointCount> contracts_limit_fp;
4419};
4420
4427
4428} // namespace kalshi
Definition api.hpp:15
OrderType
Definition models.hpp:625
@ Unknown
A value this SDK version does not know.
GetEventsStatus
Filter by event status.
Definition models.hpp:275
@ Unknown
A value this SDK version does not know.
MarketType
Identifies the type of market.
Definition models.hpp:585
@ Unknown
A value this SDK version does not know.
RestingMarginReservation
Collateral an automatic rebalance leaves behind for resting orders.
Definition models.hpp:763
@ Unknown
A value this SDK version does not know.
MarketResult
Definition models.hpp:523
@ Unknown
A value this SDK version does not know.
@ Unset
empty string
GetMarketsMveFilter
Filter by multivariate events (combos).
Definition models.hpp:372
@ Unknown
A value this SDK version does not know.
ExchangeInstance
The exchange instance type.
Definition models.hpp:231
@ EventContract
event_contract
@ Unknown
A value this SDK version does not know.
Side
Definition models.hpp:867
@ Unknown
A value this SDK version does not know.
constexpr std::string_view to_string(HttpMethod method) noexcept
Definition http_client.hpp:23
std::array< std::string, 2 > PriceLevelDollarsCountFp
Price level in dollars represented as [dollars_string, fp] where dollars_string is like "0....
Definition models.hpp:30
Action
Deprecated.
Definition models.hpp:35
@ Unknown
A value this SDK version does not know.
GetIncentiveProgramsStatus
Status filter.
Definition models.hpp:316
@ Unknown
A value this SDK version does not know.
SelfTradePreventionType
The self-trade prevention type for orders.
Definition models.hpp:785
@ Unknown
A value this SDK version does not know.
MarketStatus
The current status of the market in its lifecycle.
Definition models.hpp:548
@ Initialized
initialized
@ Unknown
A value this SDK version does not know.
@ Determined
determined
GetMultivariateEventCollectionsStatus
Only return collections of a certain status.
Definition models.hpp:419
@ Unknown
A value this SDK version does not know.
SettlementStatus
Return unsettled positions by default, settled positions that have not yet been archived,...
Definition models.hpp:846
@ Unknown
A value this SDK version does not know.
GetIncentiveProgramsType
Type filter.
Definition models.hpp:344
@ MarginMakerVolume
margin_maker_volume
@ Unknown
A value this SDK version does not know.
@ MarginTakerVolume
margin_taker_volume
UserFilter
Omit or leave empty to return all results.
Definition models.hpp:981
@ Unknown
A value this SDK version does not know.
RFQBatchQuoteStatus
Status of a batch quote.
Definition models.hpp:691
@ PartiallyExecuted
partially_executed
@ Unknown
A value this SDK version does not know.
DepositType
Payment method used for the deposit.
Definition models.hpp:176
@ Unknown
A value this SDK version does not know.
FeeType
Fee type for a series or scheduled fee override.
Definition models.hpp:250
@ QuadraticWithComboMakerFees
quadratic_with_combo_maker_fees
@ QuadraticWithMakerFees
quadratic_with_maker_fees
@ Unknown
A value this SDK version does not know.
@ Quadratic
quadratic
RFQStatus
Current status of the RFQ (open, closed)
Definition models.hpp:744
@ Unknown
A value this SDK version does not know.
SettlementMarketResult
The outcome of the market settlement.
Definition models.hpp:823
@ Unknown
A value this SDK version does not know.
ApiKeyType
Signature algorithm of an API key pair.
Definition models.hpp:91
@ Unknown
A value this SDK version does not know.
GetMarketsStatus
Filter by market status.
Definition models.hpp:391
@ Unknown
A value this SDK version does not know.
DepositStatus
Current status of the deposit.
Definition models.hpp:151
@ Unknown
A value this SDK version does not know.
StrikeType
Strike type defines how the market strike is defined and evaluated.
Definition models.hpp:886
@ GreaterOrEqual
greater_or_equal
@ Structured
structured
@ Unknown
A value this SDK version does not know.
@ LessOrEqual
less_or_equal
@ Functional
functional
GetHistoricalMarketsMveFilter
Filter by multivariate events (combos).
Definition models.hpp:300
@ Unknown
A value this SDK version does not know.
SettlementBoundsType
Which settlement bounds apply to this market.
Definition models.hpp:804
@ Unknown
A value this SDK version does not know.
ApiKeyScope
Scope granted to an API key.
Definition models.hpp:54
@ WriteFcmRisk
write::fcm_risk
@ WriteTransfer
write::transfer
@ WriteTrade
write::trade
@ ReadBlockTradeAccept
read::block_trade_accept
@ Unknown
A value this SDK version does not know.
@ WriteBlockTradeAccept
write::block_trade_accept
@ ReadPortfolioBalance
read::portfolio_balance
MarketIndexStatus
open: in session with a current value.
Definition models.hpp:502
@ Unknown
A value this SDK version does not know.
BookSide
Side of the book for an order or trade.
Definition models.hpp:110
@ Unknown
A value this SDK version does not know.
QuoteStatus
Current status of the quote.
Definition models.hpp:663
@ Confirmed
confirmed
@ Unknown
A value this SDK version does not know.
@ Cancelled
cancelled
IncentiveProgramIncentiveType
Type of incentive program.
Definition models.hpp:442
@ MarginMakerVolume
margin_maker_volume
@ Unknown
A value this SDK version does not know.
@ MarginTakerVolume
margin_taker_volume
OrderStatus
The status of an order.
Definition models.hpp:604
@ Unknown
A value this SDK version does not know.
RFQBatchStatus
Status of an RFQ batch.
Definition models.hpp:722
@ Unknown
A value this SDK version does not know.
std::string FixedPointCount
Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names).
Definition models.hpp:23
CreditHistoryStatus
Credit processing status.
Definition models.hpp:129
@ Unknown
unknown, or a value this SDK version does not know.
std::string FixedPointDollars
Fixed-point US dollar string.
Definition models.hpp:26
IntraExchangeInstanceTransferStatus
Transfer status.
Definition models.hpp:467
@ Unknown
A value this SDK version does not know.
TriggeredLeg
Definition models.hpp:944
@ TakeProfit
take_profit
@ Unknown
A value this SDK version does not know.
std::int64_t ExchangeIndex
Identifier for an exchange shard.
Definition models.hpp:19
Kind
Definition models.hpp:486
@ Unknown
A value this SDK version does not know.
@ Bracket
bracket
OutcomeSide
Outcome side.
Definition models.hpp:644
@ Unknown
A value this SDK version does not know.
Unit
Definition models.hpp:962
@ Unknown
A value this SDK version does not know.
TimeInForce
Specifies how long the order remains active.
Definition models.hpp:923
@ GoodTillCanceled
good_till_canceled
@ Unknown
A value this SDK version does not know.
@ FillOrKill
fill_or_kill
@ ImmediateOrCancel
immediate_or_cancel
EventContractExitTriggerStatus
Definition models.hpp:203
@ Unknown
unknown, or a value this SDK version does not know.
std::optional< std::int64_t > subaccount
User-managed subaccount number to accept as (0 for primary, 1-63 for numbered subaccounts).
Definition models.hpp:1002
std::optional< std::string > subtrader_id
Subtrader ID to accept as.
Definition models.hpp:1000
Definition models.hpp:1005
Side accepted_side
The side of the quote to accept (yes or no)
Definition models.hpp:1007
Definition models.hpp:1018
std::vector< RFQBatchAcceptLimit > min_bids
Price protection, exactly one entry per child.
Definition models.hpp:1022
std::optional< std::string > client_order_id
Optional idempotency key.
Definition models.hpp:1024
Side accepted_side
The side to accept on every child (yes or no)
Definition models.hpp:1020
Definition models.hpp:1090
Side accepted_side
The side accepted on every child (yes or no)
Definition models.hpp:1092
std::vector< Quote > quotes
The quote each child was accepted from, in batch order.
Definition models.hpp:1094
Definition models.hpp:1097
FixedPointCount keep_volume_goal_fp
Definition models.hpp:1101
std::string level
API usage level for this Predictions volume goal.
Definition models.hpp:1099
FixedPointCount earn_volume_goal_fp
Definition models.hpp:1100
std::int64_t computed_ts
Unix timestamp (seconds) when this progress was computed; trailing_30d_volume_fp covers the trailing ...
Definition models.hpp:1107
std::vector< AccountApiUsageLevelVolumeGoal > goals
Definition models.hpp:1109
FixedPointCount trailing_30d_volume_fp
Definition models.hpp:1108
Query parameters for amend_order.
Definition models.hpp:1113
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:1115
Definition models.hpp:1118
std::optional< FixedPointDollars > yes_price_dollars
Updated yes price for the order in fixed-point dollars.
Definition models.hpp:1136
std::optional< std::int64_t > subaccount
Optional subaccount number to use for this amendment (0 for primary, 1-63 for subaccounts)
Definition models.hpp:1120
std::optional< std::int64_t > count
Updated quantity for the order (whole contracts only).
Definition models.hpp:1140
Side side
Side of the order.
Definition models.hpp:1124
std::optional< std::string > client_order_id
The original client-specified order ID to be amended.
Definition models.hpp:1128
std::optional< ExchangeIndex > exchange_index
Exchange shard index.
Definition models.hpp:1144
std::optional< std::string > updated_client_order_id
The new client-specified order ID after amendment.
Definition models.hpp:1130
std::optional< std::int64_t > yes_price
Updated yes price for the order in cents.
Definition models.hpp:1132
std::string ticker
Market ticker.
Definition models.hpp:1122
std::optional< std::int64_t > no_price
Updated no price for the order in cents.
Definition models.hpp:1134
std::optional< FixedPointDollars > no_price_dollars
Updated no price for the order in fixed-point dollars.
Definition models.hpp:1138
Action action
Action of the order.
Definition models.hpp:1126
std::optional< FixedPointCount > count_fp
String representation of the updated quantity for the order.
Definition models.hpp:1142
Definition models.hpp:1196
Order old_order
The order before amendment.
Definition models.hpp:1198
Order order
The order after amendment.
Definition models.hpp:1200
Definition models.hpp:1203
std::string ticker
Market ticker.
Definition models.hpp:1205
FixedPointCount count
Updated total/max fillable count for the order.
Definition models.hpp:1211
std::optional< std::string > client_order_id
The original client-specified order ID to be amended.
Definition models.hpp:1213
FixedPointDollars price
Updated price for the order in fixed-point dollars.
Definition models.hpp:1209
std::optional< std::int64_t > expiration_time
New Unix expiration timestamp in seconds.
Definition models.hpp:1217
std::optional< ExchangeIndex > exchange_index
Exchange shard index.
Definition models.hpp:1219
BookSide side
Side of the order.
Definition models.hpp:1207
std::optional< std::string > updated_client_order_id
The new client-specified order ID after amendment.
Definition models.hpp:1215
Definition models.hpp:1222
std::string order_id
Definition models.hpp:1223
std::optional< std::string > client_order_id
Definition models.hpp:1224
std::optional< FixedPointDollars > average_fee_paid
Volume-weighted average fee paid per contract for fills resulting from the amend.
Definition models.hpp:1232
std::optional< FixedPointCount > fill_count
Number of contracts filled as a result of the amend crossing the book.
Definition models.hpp:1228
std::optional< FixedPointDollars > average_fill_price
Volume-weighted average fill price for fills resulting from the amend.
Definition models.hpp:1230
std::int64_t ts_ms
Matching engine timestamp at which the amend was processed, as Unix epoch milliseconds.
Definition models.hpp:1234
std::optional< FixedPointCount > remaining_count
Number of resting contracts remaining after the amend.
Definition models.hpp:1226
Definition models.hpp:1237
std::optional< std::int64_t > subaccount
If set, the API key is restricted to this single sub-account and may only read and trade on it.
Definition models.hpp:1246
std::vector< ApiKeyScope > scopes
List of scopes granted to this API key.
Definition models.hpp:1243
std::optional< std::string > fcm_subtrader_id
If set, the API key is bound to this single FCM subtrader ({fcm_user_id}_{suffix}) and is usable only...
Definition models.hpp:1250
std::string api_key_id
Unique identifier for the API key.
Definition models.hpp:1239
std::string name
User-provided name for the API key.
Definition models.hpp:1241
Definition models.hpp:1253
std::optional< std::int64_t > expires_ts
Unix timestamp (seconds) when the grant expires.
Definition models.hpp:1259
std::string level
API usage level this grant confers (for example, expert, premier, paragon, prime, or prestige).
Definition models.hpp:1257
ExchangeInstance exchange_instance
Definition models.hpp:1254
std::string source
How the grant was created: "volume" (earned from trading volume) or "manual" (assigned by Kalshi).
Definition models.hpp:1262
Definition models.hpp:1265
std::string client_transfer_id
Unique client-provided transfer ID for idempotency.
Definition models.hpp:1267
std::int64_t from_subaccount
Source subaccount number (0 for primary, 1-63 for numbered subaccounts).
Definition models.hpp:1269
std::optional< ExchangeIndex > exchange_index
Identifier for an exchange shard.
Definition models.hpp:1275
std::int64_t to_subaccount
Destination subaccount number (0 for primary, 1-63 for numbered subaccounts).
Definition models.hpp:1271
std::int64_t amount_cents
Amount to transfer in cents.
Definition models.hpp:1273
Definition models.hpp:1278
std::optional< std::int64_t > size_max
Maximum number of markets from this event (inclusive).
Definition models.hpp:1284
std::string ticker
The event ticker.
Definition models.hpp:1280
std::optional< std::int64_t > size_min
Minimum number of markets from this event (inclusive).
Definition models.hpp:1286
std::vector< std::string > active_quoters
List of active quoters for this event.
Definition models.hpp:1288
bool is_yes_only
Whether only the 'yes' side can be used for this event.
Definition models.hpp:1282
Prices are YES prices, like the order's price, so for an ask the stop loss is above the entry price a...
Definition models.hpp:1299
std::optional< FixedPointDollars > stop_loss_price
Definition models.hpp:1301
std::optional< EventContractExitSlippage > slippage
Definition models.hpp:1300
std::optional< FixedPointDollars > take_profit_price
Definition models.hpp:1302
std::string order_id
The order ID to identify which order had an error during batch cancellation.
Definition models.hpp:1316
FixedPointCount reduced_by_fp
String representation of the number of contracts that were successfully canceled from this order.
Definition models.hpp:1320
std::optional< Order > order
Definition models.hpp:1317
std::optional< ErrorResponse > error
Definition models.hpp:1321
Definition models.hpp:1324
std::optional< std::int64_t > subaccount
Optional subaccount number to use for this cancellation (0 for primary, 1-63 for subaccounts)
Definition models.hpp:1329
std::string order_id
Order ID to cancel.
Definition models.hpp:1326
std::optional< std::string > market_ticker
Market ticker.
Definition models.hpp:1333
std::optional< ExchangeIndex > exchange_index
Exchange shard index.
Definition models.hpp:1331
Definition models.hpp:1336
std::optional< std::vector< BatchCancelOrdersRequestOrder > > orders
An array of orders to cancel, each optionally specifying a subaccount.
Definition models.hpp:1340
std::optional< std::vector< std::string > > ids
An array of order IDs to cancel.
Definition models.hpp:1338
Definition models.hpp:1343
std::vector< BatchCancelOrdersIndividualResponse > orders
Definition models.hpp:1344
std::optional< std::int64_t > subaccount
Optional subaccount number to use for this cancellation (0 for primary, 1-63 for subaccounts).
Definition models.hpp:1352
std::string order_id
Order ID to cancel.
Definition models.hpp:1349
std::optional< std::string > market_ticker
Market ticker.
Definition models.hpp:1356
std::optional< ExchangeIndex > exchange_index
Exchange shard index.
Definition models.hpp:1354
Definition models.hpp:1359
std::vector< BatchCancelOrdersV2RequestOrdersItem > orders
An array of orders to cancel, each optionally specifying a subaccount.
Definition models.hpp:1361
std::string order_id
The order ID identifying which order this entry corresponds to.
Definition models.hpp:1366
FixedPointCount reduced_by
Number of contracts that were canceled (i.e.
Definition models.hpp:1369
std::optional< std::int64_t > ts_ms
Matching engine timestamp at which the cancellation was processed, as Unix epoch milliseconds.
Definition models.hpp:1372
std::optional< std::string > client_order_id
Definition models.hpp:1367
std::optional< ErrorResponse > error
Definition models.hpp:1373
Definition models.hpp:1376
std::vector< BatchCancelOrdersV2ResponseOrdersItem > orders
Definition models.hpp:1377
std::optional< ErrorResponse > error
Definition models.hpp:1383
std::optional< std::string > client_order_id
Definition models.hpp:1381
std::optional< Order > order
Definition models.hpp:1382
Definition models.hpp:1423
std::vector< CreateOrderRequest > orders
Definition models.hpp:1424
Definition models.hpp:1427
std::vector< BatchCreateOrdersIndividualResponse > orders
Definition models.hpp:1428
Definition models.hpp:1458
std::vector< CreateOrderV2Request > orders
Definition models.hpp:1459
std::optional< FixedPointCount > fill_count
Number of contracts filled immediately upon placement.
Definition models.hpp:1466
std::optional< std::string > client_order_id
Definition models.hpp:1464
std::optional< FixedPointDollars > average_fee_paid
Volume-weighted average fee paid per contract.
Definition models.hpp:1472
std::optional< std::string > order_id
Definition models.hpp:1463
std::optional< FixedPointCount > remaining_count
Number of contracts remaining after placement.
Definition models.hpp:1468
std::optional< FixedPointDollars > average_fill_price
Volume-weighted average fill price.
Definition models.hpp:1470
std::optional< std::int64_t > ts_ms
Matching engine timestamp at which the order was processed, as Unix epoch milliseconds.
Definition models.hpp:1474
std::optional< ErrorResponse > error
Definition models.hpp:1475
Definition models.hpp:1478
std::vector< BatchCreateOrdersV2ResponseOrdersItem > orders
Definition models.hpp:1479
Query parameters for batch_get_market_candlesticks.
Definition models.hpp:1483
std::int64_t start_ts
Start timestamp in Unix seconds.
Definition models.hpp:1487
std::int64_t period_interval
Candlestick period interval in minutes.
Definition models.hpp:1491
std::string market_tickers
Comma-separated list of market tickers (maximum 100)
Definition models.hpp:1485
std::optional< bool > include_latest_before_start
If true, prepends the latest candlestick available before the start_ts.
Definition models.hpp:1493
std::int64_t end_ts
End timestamp in Unix seconds.
Definition models.hpp:1489
std::vector< MarketCandlesticksResponse > markets
Array of market candlestick data, one entry per requested market.
Definition models.hpp:1555
Definition models.hpp:1558
FixedPointDollars high
Highest offer price on the market during the candlestick period (in dollars).
Definition models.hpp:1564
FixedPointDollars open
Offer price on the market at the start of the candlestick period (in dollars).
Definition models.hpp:1560
FixedPointDollars close
Offer price on the market at the end of the candlestick period (in dollars).
Definition models.hpp:1566
FixedPointDollars low
Lowest offer price on the market during the candlestick period (in dollars).
Definition models.hpp:1562
Definition models.hpp:1496
FixedPointDollars open_dollars
Offer price on the market at the start of the candlestick period (in dollars).
Definition models.hpp:1498
FixedPointDollars high_dollars
Highest offer price on the market during the candlestick period (in dollars).
Definition models.hpp:1502
FixedPointDollars close_dollars
Offer price on the market at the end of the candlestick period (in dollars).
Definition models.hpp:1504
FixedPointDollars low_dollars
Lowest offer price on the market during the candlestick period (in dollars).
Definition models.hpp:1500
Definition models.hpp:1569
std::string id
Unique identifier for the block trade proposal.
Definition models.hpp:1571
std::optional< std::string > buyer_subtrader_id
Subtrader ID of the buyer.
Definition models.hpp:1577
std::optional< std::string > seller_order_id
Order ID for the seller after the proposal is executed.
Definition models.hpp:1611
std::string market_ticker
The ticker of the market for this block trade.
Definition models.hpp:1583
std::optional< std::string > seller_subtrader_id
Subtrader ID of the seller.
Definition models.hpp:1581
bool buyer_accepted
Whether the buyer has accepted the proposal.
Definition models.hpp:1599
std::string status
Current status of the proposal.
Definition models.hpp:1593
std::int64_t centicount
Number of contracts in centicounts.
Definition models.hpp:1587
std::string proposer_user_id
User ID of the proposal creator.
Definition models.hpp:1573
std::optional< std::string > executed_ts
Timestamp when the proposal was executed.
Definition models.hpp:1607
std::optional< std::string > buyer_accepted_ts
Timestamp when the buyer accepted.
Definition models.hpp:1603
std::int64_t price_centi_cents
Price in centi-cents.
Definition models.hpp:1585
std::string seller_user_id
User ID of the seller.
Definition models.hpp:1579
std::optional< std::string > seller_accepted_ts
Timestamp when the seller accepted.
Definition models.hpp:1605
std::optional< std::string > buyer_order_id
Order ID for the buyer after the proposal is executed.
Definition models.hpp:1609
bool seller_accepted
Whether the seller has accepted the proposal.
Definition models.hpp:1601
std::string expiration_ts
Expiration time of the proposal.
Definition models.hpp:1591
std::string created_ts
Timestamp when the proposal was created.
Definition models.hpp:1595
std::string buyer_user_id
User ID of the buyer.
Definition models.hpp:1575
Side maker_side
The maker side of the trade.
Definition models.hpp:1589
std::string updated_ts
Timestamp when the proposal was last updated.
Definition models.hpp:1597
Token-bucket budget for one rate-limit bucket.
Definition models.hpp:1615
std::int64_t bucket_capacity
Maximum tokens the bucket can hold.
Definition models.hpp:1619
std::int64_t refill_rate
Tokens added to the bucket per second.
Definition models.hpp:1617
Query parameters for cancel_all_orders.
Definition models.hpp:1623
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:1625
Query parameters for cancel_order.
Definition models.hpp:1629
std::optional< std::string > market_ticker
Market ticker.
Definition models.hpp:1635
std::optional< ExchangeIndex > exchange_index
Exchange shard index.
Definition models.hpp:1633
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:1631
Definition models.hpp:1638
std::int64_t ts_ms
Matching engine timestamp at which the cancellation was processed, as Unix epoch milliseconds.
Definition models.hpp:1645
std::optional< std::string > client_order_id
Definition models.hpp:1640
std::string order_id
Definition models.hpp:1639
FixedPointCount reduced_by
Number of contracts that were canceled (i.e.
Definition models.hpp:1642
Definition models.hpp:1648
std::optional< std::string > fcm_subtrader_id
FCM members only.
Definition models.hpp:1658
std::optional< std::int64_t > subaccount
If set, restricts the API key to a single sub-account (0-63) that you own.
Definition models.hpp:1656
std::optional< std::vector< ApiKeyScope > > scopes
List of scopes to grant to the API key.
Definition models.hpp:1654
std::string public_key
RSA or Ed25519 public key in PEM format (-----BEGIN PUBLIC KEY-----).
Definition models.hpp:1652
std::string name
Name for the API key.
Definition models.hpp:1650
Definition models.hpp:1661
std::string api_key_id
Unique identifier for the newly created API key.
Definition models.hpp:1663
std::optional< std::string > warning
Present only when the minted key is bound to an FCM subtrader that is missing a per- subtrader risk c...
Definition models.hpp:1667
std::int64_t position_centicount
Contracts to move, in centicounts (contracts x 100).
Definition models.hpp:1679
std::string source_subtrader_id
Full id of the FCM subtrader giving up the position, as returned by GET /fcm/subtraders.
Definition models.hpp:1672
std::string market_ticker
Ticker of the market whose position is moved.
Definition models.hpp:1677
std::int64_t price_centicents
YES price per contract in centicents (cents x 100), in whole cents, even when moving NO.
Definition models.hpp:1681
std::string target_subtrader_id
Subtrader under your error account that receives the position, {error_account_id}_{suffix} with a 1-1...
Definition models.hpp:1675
std::string position_transfer_id
Id of the executed transfer.
Definition models.hpp:1686
Definition models.hpp:1689
std::string subtrader_suffix
Suffix for the new subtrader, 1-16 case-sensitive ASCII alphanumeric characters ([A-Za-z0-9]).
Definition models.hpp:1692
Definition models.hpp:1695
std::string subtrader_id
The full id of the created subtrader.
Definition models.hpp:1697
std::vector< TickerPair > selected_markets
List of selected markets that act as parameters to determine which market is created.
Definition models.hpp:1711
std::optional< bool > with_market_payload
Whether to include the market payload in the response.
Definition models.hpp:1713
std::string market_ticker
Market ticker for the created market.
Definition models.hpp:1839
std::string event_ticker
Event ticker for the created market.
Definition models.hpp:1837
std::optional< Market > market
Market payload of the created market.
Definition models.hpp:1841
Definition models.hpp:1844
std::optional< std::int64_t > subaccount
Optional subaccount number to use for this order group (0 for primary, 1-63 for subaccounts).
Definition models.hpp:1847
std::optional< ExchangeIndex > exchange_index
Identifier for an exchange shard.
Definition models.hpp:1855
std::optional< FixedPointCount > contracts_limit_fp
String representation of the maximum number of contracts that can be matched within this group over a...
Definition models.hpp:1853
std::optional< std::int64_t > contracts_limit
Specifies the maximum number of contracts that can be matched within this group over a rolling 15-sec...
Definition models.hpp:1850
Definition models.hpp:1858
std::int64_t subaccount
Subaccount number that owns the created order group (0 for primary, 1-63 for subaccounts).
Definition models.hpp:1862
std::string order_group_id
The unique identifier for the created order group.
Definition models.hpp:1860
std::optional< ExchangeIndex > exchange_index
Definition models.hpp:1863
Definition models.hpp:1386
std::optional< bool > reduce_only
Definition models.hpp:1408
std::optional< std::int64_t > subaccount
The subaccount number to use for this order.
Definition models.hpp:1418
std::optional< FixedPointDollars > yes_price_dollars
Submitting price of the Yes side in fixed-point dollars.
Definition models.hpp:1398
std::optional< std::string > client_order_id
Definition models.hpp:1388
std::optional< SelfTradePreventionType > self_trade_prevention_type
Definition models.hpp:1411
Action action
Definition models.hpp:1390
std::string ticker
Definition models.hpp:1387
std::optional< std::int64_t > buy_max_cost
Maximum cost in cents.
Definition models.hpp:1406
std::optional< TimeInForce > time_in_force
Specifies how long the order remains active.
Definition models.hpp:1404
std::optional< bool > post_only
Definition models.hpp:1407
std::optional< std::int64_t > sell_position_floor
Deprecated: Use reduce_only instead.
Definition models.hpp:1410
std::optional< bool > cancel_order_on_pause
If this flag is set to true, the order will be canceled if the order is open and trading on the excha...
Definition models.hpp:1416
std::optional< std::int64_t > yes_price
Definition models.hpp:1395
std::optional< std::string > order_group_id
The order group this order is part of.
Definition models.hpp:1413
std::optional< FixedPointCount > count_fp
String representation of the order quantity in contracts.
Definition models.hpp:1394
std::optional< ExchangeIndex > exchange_index
Exchange shard index.
Definition models.hpp:1420
std::optional< std::int64_t > count
Order quantity in contracts (whole contracts only).
Definition models.hpp:1392
std::optional< FixedPointDollars > no_price_dollars
Submitting price of the No side in fixed-point dollars.
Definition models.hpp:1400
Side side
Definition models.hpp:1389
std::optional< std::int64_t > expiration_ts
Optional Unix timestamp in seconds for when the order expires.
Definition models.hpp:1402
std::optional< std::int64_t > no_price
Definition models.hpp:1396
Definition models.hpp:1866
Order order
Definition models.hpp:1867
Definition models.hpp:1431
FixedPointCount count
String representation of the order quantity in contracts.
Definition models.hpp:1436
SelfTradePreventionType self_trade_prevention_type
Definition models.hpp:1444
std::optional< ExchangeIndex > exchange_index
Exchange shard index.
Definition models.hpp:1455
FixedPointDollars price
Price for the order in fixed-point dollars.
Definition models.hpp:1438
std::string ticker
Definition models.hpp:1432
std::optional< std::string > client_order_id
Definition models.hpp:1433
std::optional< bool > cancel_order_on_pause
If this flag is set to true, the order will be canceled if the order is open and trading on the excha...
Definition models.hpp:1447
std::optional< bool > reduce_only
Specifies whether the order place count should be capped by the member's current position.
Definition models.hpp:1449
TimeInForce time_in_force
Specifies how long the order remains active.
Definition models.hpp:1442
BookSide side
Definition models.hpp:1434
std::optional< std::int64_t > expiration_time
Optional Unix timestamp in seconds for when the order expires.
Definition models.hpp:1440
std::optional< std::string > order_group_id
The order group this order is part of.
Definition models.hpp:1453
std::optional< bool > post_only
Definition models.hpp:1443
std::optional< std::int64_t > subaccount
The subaccount number to use for this order.
Definition models.hpp:1451
Definition models.hpp:1870
FixedPointCount fill_count
Number of contracts filled immediately upon placement.
Definition models.hpp:1874
std::optional< FixedPointDollars > average_fee_paid
Volume-weighted average fee paid per contract for fills resulting from this request.
Definition models.hpp:1880
std::optional< FixedPointDollars > average_fill_price
Volume-weighted average fill price.
Definition models.hpp:1878
std::optional< std::string > client_order_id
Definition models.hpp:1872
std::string order_id
Definition models.hpp:1871
std::int64_t ts_ms
Matching engine timestamp at which the order was processed, as Unix epoch milliseconds.
Definition models.hpp:1882
FixedPointCount remaining_count
Number of contracts remaining after placement.
Definition models.hpp:1876
std::optional< std::int64_t > expiration_time
Optional Unix timestamp in seconds for when the order expires.
Definition models.hpp:1894
std::optional< std::int64_t > subaccount
The subaccount number to use for this order.
Definition models.hpp:1905
std::optional< bool > post_only
Definition models.hpp:1897
SelfTradePreventionType self_trade_prevention_type
Definition models.hpp:1898
std::optional< bool > cancel_order_on_pause
If this flag is set to true, the order will be canceled if the order is open and trading on the excha...
Definition models.hpp:1901
BookSide side
Definition models.hpp:1888
std::optional< bool > reduce_only
Specifies whether the order place count should be capped by the member's current position.
Definition models.hpp:1903
TimeInForce time_in_force
Specifies how long the order remains active.
Definition models.hpp:1896
FixedPointCount count
String representation of the order quantity in contracts.
Definition models.hpp:1890
FixedPointDollars price
Price for the order in fixed-point dollars.
Definition models.hpp:1892
std::optional< std::string > client_order_id
Definition models.hpp:1887
std::optional< std::string > order_group_id
The order group this order is part of.
Definition models.hpp:1907
AttachedEventContractExitTrigger exit_trigger
Definition models.hpp:1910
std::string ticker
Definition models.hpp:1886
std::optional< ExchangeIndex > exchange_index
Exchange shard index.
Definition models.hpp:1909
Definition models.hpp:1913
std::string rfq_id
The UUID of the RFQ to quote on.
Definition models.hpp:1915
bool rest_remainder
Whether to rest the remainder of the quote after execution.
Definition models.hpp:1921
std::optional< bool > post_only
If true, the quote creator's resting order will be cancelled rather than crossed if it would take liq...
Definition models.hpp:1924
FixedPointDollars no_bid
The bid price for NO contracts, in dollars.
Definition models.hpp:1919
FixedPointDollars yes_bid
The bid price for YES contracts, in dollars.
Definition models.hpp:1917
std::optional< std::int64_t > subaccount
Optional subaccount number to place the quote under (0 for primary, 1-63 for subaccounts)
Definition models.hpp:1926
Definition models.hpp:1929
std::string id
UUID of the newly created quote.
Definition models.hpp:1931
One combo to request quotes on.
Definition models.hpp:1935
std::optional< FixedPointDollars > target_cost_dollars
Target cost of this child, in dollars, in place of the batch's size.
Definition models.hpp:1944
std::optional< std::vector< TickerPair > > selected_markets
Legs of the combo, at most 6, looked up or created in the request's mve_collection_ticker as POST /mu...
Definition models.hpp:1940
std::optional< FixedPointCount > contracts_fp
Number of contracts requested on this child, in place of the batch's size.
Definition models.hpp:1942
std::optional< std::string > market_ticker
Ticker of an existing combo market.
Definition models.hpp:1937
Definition models.hpp:1956
std::optional< std::int64_t > subaccount
Optional subaccount number to place the batch quote under (0 for primary, 1-63 for subaccounts)
Definition models.hpp:1966
std::optional< bool > post_only
If true, your resting orders are cancelled rather than crossed if they would take liquidity.
Definition models.hpp:1963
std::vector< RFQBatchQuoteEntry > quotes
Prices for every child RFQ of the batch, one entry per child.
Definition models.hpp:1958
bool rest_remainder
Whether to rest the remainder of each child quote after execution.
Definition models.hpp:1960
Definition models.hpp:1969
std::string id
UUID of the newly created batch quote.
Definition models.hpp:1971
Definition models.hpp:1974
std::vector< CreateRFQBatchChild > children
The combos to request quotes on, one child RFQ each.
Definition models.hpp:1976
std::optional< bool > target_cost_excludes_fees
Same as on Create RFQ, applied to every child.
Definition models.hpp:1984
std::optional< std::string > mve_collection_ticker
Collection in which children given by selected_markets are looked up or created.
Definition models.hpp:1978
std::optional< std::int64_t > subaccount
The subaccount number to create the RFQ batch for (direct members only; 0 for primary,...
Definition models.hpp:1999
std::optional< std::string > client_batch_id
Optional key for this batch, unique among your RFQ batches, including those closed within the last se...
Definition models.hpp:1993
std::optional< FixedPointDollars > target_cost_dollars
Target cost, in dollars, of every child that sets no size of its own.
Definition models.hpp:1982
std::optional< FixedPointCount > contracts_fp
Number of contracts requested on every child that sets no size of its own.
Definition models.hpp:1980
std::optional< bool > replace_existing
Close your oldest open RFQ batches as needed so this one can be created.
Definition models.hpp:1988
std::optional< bool > rest_remainder
Must be false.
Definition models.hpp:1986
std::optional< bool > obscure_creator_id
Same as on Create RFQ, applied to the batch and every child.
Definition models.hpp:1990
std::optional< std::string > subtrader_id
The subtrader to create the RFQ batch for (FCM members only; FCM members cannot create RFQ batches ye...
Definition models.hpp:1996
Definition models.hpp:2067
RFQBatch rfq_batch
Definition models.hpp:2068
Definition models.hpp:2071
bool rest_remainder
Whether to rest the remainder of the RFQ after execution.
Definition models.hpp:2089
std::optional< std::int64_t > target_cost_centi_cents
DEPRECATED: The target cost for the RFQ in centi-cents.
Definition models.hpp:2079
std::optional< std::string > subtrader_id
The subtrader to create the RFQ for (FCM members only)
Definition models.hpp:2093
std::optional< std::int64_t > contracts
Whole-contract count for the RFQ.
Definition models.hpp:2075
std::optional< std::int64_t > subaccount
The subaccount number to create the RFQ for (direct members only; 0 for primary, 1-63 for subaccounts...
Definition models.hpp:2096
std::optional< FixedPointDollars > target_cost_dollars
The target cost for the RFQ in dollars.
Definition models.hpp:2081
std::string market_ticker
The ticker of the market for which to create an RFQ.
Definition models.hpp:2073
std::optional< bool > obscure_creator_id
Replace the RFQ creator's public communications ID with a shared empty-input SHA-256 hash for other u...
Definition models.hpp:2087
std::optional< bool > target_cost_excludes_fees
Sizes quotes against the target cost as principal only (contracts = target cost / price),...
Definition models.hpp:2084
std::optional< bool > replace_existing
Whether to delete existing RFQs as part of this RFQ's creation.
Definition models.hpp:2091
std::optional< FixedPointCount > contracts_fp
Fixed-point number of contracts for the RFQ.
Definition models.hpp:2077
Definition models.hpp:2099
std::string id
UUID of the newly created RFQ.
Definition models.hpp:2101
Definition models.hpp:2104
std::optional< ExchangeIndex > exchange_index
Identifier for an exchange shard.
Definition models.hpp:2106
Definition models.hpp:2109
std::int64_t subaccount_number
The sequential number assigned to this subaccount (1-63).
Definition models.hpp:2111
Definition models.hpp:2114
std::string type
Credit category.
Definition models.hpp:2118
FixedPointDollars amount_dollars
Credit amount in dollars.
Definition models.hpp:2122
std::string reason
Credit description, which may include a market or event ticker.
Definition models.hpp:2124
std::string credit_id
Unique credit identifier.
Definition models.hpp:2116
std::string created_time
Time the credit was created.
Definition models.hpp:2126
CreditHistoryStatus status
Credit processing status.
Definition models.hpp:2120
Definition models.hpp:2129
std::string open_time
Opening time in ET (Eastern Time) format HH:MM.
Definition models.hpp:2131
std::string close_time
Closing time in ET (Eastern Time) format HH:MM.
Definition models.hpp:2133
Query parameters for decrease_order.
Definition models.hpp:2137
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:2139
Definition models.hpp:2142
std::optional< ExchangeIndex > exchange_index
Exchange shard index.
Definition models.hpp:2148
std::optional< FixedPointCount > reduce_to
String representation of the number of contracts to reduce to.
Definition models.hpp:2146
std::optional< std::string > market_ticker
Market ticker used for auto-routing when exchange_index is omitted or -1.
Definition models.hpp:2150
std::optional< FixedPointCount > reduce_by
String representation of the number of contracts to reduce by.
Definition models.hpp:2144
Definition models.hpp:2153
FixedPointCount remaining_count
Number of contracts remaining after the decrease.
Definition models.hpp:2157
std::int64_t ts_ms
Matching engine timestamp at which the decrease was processed, as Unix epoch milliseconds.
Definition models.hpp:2159
std::optional< std::string > client_order_id
Definition models.hpp:2155
std::string order_id
Definition models.hpp:2154
Query parameters for delete_event_contract_exit_trigger.
Definition models.hpp:2163
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:2165
std::optional< Kind > kind
Definition models.hpp:2166
Query parameters for delete_fcm_event_contract_daily_cap.
Definition models.hpp:2170
std::string subtrader_id
The subtrader whose daily cap should be removed.
Definition models.hpp:2172
Query parameters for delete_order_group.
Definition models.hpp:2176
std::optional< ExchangeIndex > exchange_index
Identifier for an exchange shard.
Definition models.hpp:2180
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:2178
Definition models.hpp:2183
DepositStatus status
Current status of the deposit.
Definition models.hpp:2187
std::int64_t fee_cents
Fee charged for the deposit in cents.
Definition models.hpp:2193
std::optional< std::int64_t > finalized_ts
Unix timestamp of when the deposit was finalized (applied, failed, or returned).
Definition models.hpp:2197
std::int64_t amount_cents
Deposit amount in cents.
Definition models.hpp:2191
DepositType type
Payment method used for the deposit.
Definition models.hpp:2189
std::string id
Unique identifier for the deposit.
Definition models.hpp:2185
std::int64_t created_ts
Unix timestamp of when the deposit was created.
Definition models.hpp:2195
Definition models.hpp:2200
std::int64_t cost
Configured token cost for an endpoint whose cost differs from the default cost.
Definition models.hpp:2206
std::string method
HTTP method for the endpoint.
Definition models.hpp:2202
std::string path
API route path for the endpoint.
Definition models.hpp:2204
Definition models.hpp:1305
std::optional< std::string > details
Additional details about the error, if available.
Definition models.hpp:1311
std::optional< std::string > code
Error code.
Definition models.hpp:1307
std::optional< std::string > message
Human-readable error message.
Definition models.hpp:1309
Execution allowance below the trigger price, shared by TP and SL.
Definition models.hpp:1292
Unit unit
Definition models.hpp:1293
std::int64_t value
Definition models.hpp:1294
side is the outcome the position holds.
Definition models.hpp:2210
std::optional< std::string > triggered_order_id
Definition models.hpp:2221
std::optional< TriggeredLeg > triggered_leg
Definition models.hpp:2222
std::string created_time
Definition models.hpp:2223
std::optional< FixedPointDollars > stop_loss_price
Definition models.hpp:2217
Side side
Definition models.hpp:2214
std::int64_t subaccount_number
Definition models.hpp:2215
std::optional< std::string > status_reason
Definition models.hpp:2220
std::string ticker
Definition models.hpp:2213
std::optional< EventContractExitSlippage > slippage
Definition models.hpp:2211
std::optional< FixedPointDollars > take_profit_price
Definition models.hpp:2218
EventContractExitTriggerStatus status
Definition models.hpp:2219
std::string updated_time
Definition models.hpp:2224
Kind kind
Definition models.hpp:2216
std::string id
Definition models.hpp:2212
Definition models.hpp:2234
std::optional< std::string > fee_type_override
Fee type override for this event.
Definition models.hpp:2264
std::optional< std::string > strike_period
The time period this event covers (e.g., 'week', 'month').
Definition models.hpp:2254
std::string collateral_return_type
Collateral-return netting type for this event: MECNET for mutually exclusive markets,...
Definition models.hpp:2245
std::string series_ticker
Unique identifier for the series this event belongs to.
Definition models.hpp:2238
std::string sub_title
Shortened descriptive title for the event.
Definition models.hpp:2240
std::optional< std::vector< Market > > markets
Array of markets associated with this event.
Definition models.hpp:2256
bool mutually_exclusive
True when collateral_return_type is MECNET: at most one market in this event can resolve to 'yes'.
Definition models.hpp:2248
std::optional< ExchangeIndex > exchange_index
Definition models.hpp:2267
std::optional< std::string > category
Event category (deprecated, use series-level category instead).
Definition models.hpp:2250
std::optional< std::string > strike_date
The specific date this event is based on.
Definition models.hpp:2252
std::string event_ticker
Unique identifier for this event.
Definition models.hpp:2236
std::optional< std::string > last_updated_ts
Timestamp of when this event's metadata was last updated.
Definition models.hpp:2262
std::optional< RawJson > product_metadata
Additional metadata for the event.
Definition models.hpp:2258
std::string title
Full title of the event.
Definition models.hpp:2242
std::optional< double > fee_multiplier_override
Fee multiplier override for this event.
Definition models.hpp:2266
std::optional< std::vector< SettlementSource > > settlement_sources
The official sources used for the determination of markets within this event.
Definition models.hpp:2260
Definition models.hpp:2270
std::optional< FeeType > fee_type_override
New fee type override for the event.
Definition models.hpp:2278
std::string scheduled_ts
Timestamp when this fee change is scheduled to take effect.
Definition models.hpp:2282
std::optional< double > fee_multiplier_override
New fee multiplier override for the event.
Definition models.hpp:2280
std::string event_ticker
Event ticker this fee change applies to.
Definition models.hpp:2274
std::string id
Unique identifier for this fee change.
Definition models.hpp:2272
std::string series_ticker
Series ticker for the event.
Definition models.hpp:2276
Definition models.hpp:2285
RawJson details
Live data details as a flexible object whose shape depends on the type.
Definition models.hpp:2289
std::string type
Type of live data.
Definition models.hpp:2287
std::optional< std::string > default_range
Chart range the client should default to (e.g.
Definition models.hpp:2293
std::optional< std::vector< std::string > > range_options
Chart range menu options.
Definition models.hpp:2295
std::optional< bool > is_historical
Present for crypto live data.
Definition models.hpp:2291
Definition models.hpp:2298
std::string event_ticker
Unique identifier for events.
Definition models.hpp:2300
FixedPointDollars total_cost_dollars
Total spent on this event in dollars.
Definition models.hpp:2302
FixedPointCount total_cost_shares_fp
String representation of the total number of shares traded on this event (including both YES and NO c...
Definition models.hpp:2305
FixedPointDollars fees_paid_dollars
Fees paid on fill orders, in dollars.
Definition models.hpp:2311
FixedPointDollars realized_pnl_dollars
Locked in profit and loss, in dollars.
Definition models.hpp:2309
FixedPointDollars event_exposure_dollars
Cost of the aggregate event position in dollars.
Definition models.hpp:2307
Definition models.hpp:2314
ExchangeIndex exchange_index
Definition models.hpp:2315
std::string description
Description of this exchange shard.
Definition models.hpp:2317
bool trading_active
True if trading is currently permitted on this exchange index.
Definition models.hpp:2321
bool exchange_active
False if this exchange index is no longer taking any state changes at all.
Definition models.hpp:2319
bool intra_exchange_transfers_active
True if intra-exchange transfers are currently permitted on this exchange index.
Definition models.hpp:2323
Definition models.hpp:2326
bool exchange_active
False if the core Kalshi exchange is no longer taking any state changes at all.
Definition models.hpp:2328
std::optional< std::vector< ExchangeIndexStatus > > exchange_index_statuses
Status of each exchange index.
Definition models.hpp:2336
std::optional< bool > intra_exchange_transfers_active
True if intra-exchange transfers are currently permitted.
Definition models.hpp:2332
bool trading_active
True if we are currently permitting trading on the exchange.
Definition models.hpp:2330
std::optional< std::string > exchange_estimated_resume_time
Estimated downtime for the current exchange maintenance window.
Definition models.hpp:2334
Definition models.hpp:2339
bool fcm_trading_blocked
Whether an FCM-owned per-subtrader trading block is configured.
Definition models.hpp:2347
std::string subtrader_id
Full subtrader identifier owned by the authenticated FCM.
Definition models.hpp:2341
bool propagation_pending
Whether a configured per-subtrader block is awaiting engine application.
Definition models.hpp:2349
bool trading_blocked
Effective trading block, including firm-wide and Kalshi restrictions.
Definition models.hpp:2345
std::vector< std::int64_t > exchange_indices
Exchange indices where this subtrader has been observed.
Definition models.hpp:2343
Definition models.hpp:2352
std::optional< FixedPointDollars > taker_fee_cost
Taker fee in dollars when owned by the FCM.
Definition models.hpp:2377
std::optional< std::string > maker_subtrader_id
Maker subtrader ID when owned by the FCM.
Definition models.hpp:2369
std::optional< std::string > created_time
Fill execution time.
Definition models.hpp:2365
std::optional< std::string > maker_order_id
Maker order ID when owned by the FCM.
Definition models.hpp:2367
FixedPointDollars yes_price_dollars
YES price in dollars.
Definition models.hpp:2363
std::optional< std::string > taker_order_id
Taker order ID when owned by the FCM.
Definition models.hpp:2373
FixedPointCount count_fp
Filled contract count.
Definition models.hpp:2361
OutcomeSide taker_outcome_side
Taker outcome side.
Definition models.hpp:2359
std::string fill_id
Fill ID.
Definition models.hpp:2354
std::optional< std::string > taker_subtrader_id
Taker subtrader ID when owned by the FCM.
Definition models.hpp:2375
std::optional< FixedPointDollars > maker_fee_cost
Maker fee in dollars when owned by the FCM.
Definition models.hpp:2371
std::string ticker
Market ticker.
Definition models.hpp:2357
ExchangeIndex exchange_index
Definition models.hpp:2355
Definition models.hpp:2380
BookSide book_side
Same directional bit as outcome_side in book vocabulary.
Definition models.hpp:2399
std::optional< std::int64_t > ts
Unix timestamp when this fill was executed (legacy field name)
Definition models.hpp:2415
ExchangeIndex exchange_index
Definition models.hpp:2383
std::optional< Side > side
Deprecated.
Definition models.hpp:2393
std::optional< Action > action
Deprecated.
Definition models.hpp:2395
FixedPointDollars yes_price_dollars
Fill price for the yes side in fixed-point dollars.
Definition models.hpp:2403
OutcomeSide outcome_side
The outcome side this fill positioned the user for.
Definition models.hpp:2397
std::string order_id
Unique identifier for the order that resulted in this fill.
Definition models.hpp:2387
FixedPointCount count_fp
String representation of the number of contracts bought or sold in this fill.
Definition models.hpp:2401
std::string ticker
Unique identifier for the market.
Definition models.hpp:2389
std::optional< std::string > created_time
Timestamp when this fill was executed.
Definition models.hpp:2409
std::string trade_id
Unique identifier for this fill (legacy field name, same as fill_id)
Definition models.hpp:2385
FixedPointDollars no_price_dollars
Fill price for the no side in fixed-point dollars.
Definition models.hpp:2405
FixedPointDollars fee_cost
Fee cost in fixed-point dollars.
Definition models.hpp:2411
std::optional< std::int64_t > subaccount_number
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:2413
bool is_taker
If true, this fill was a taker (removed liquidity from the order book)
Definition models.hpp:2407
std::string fill_id
Unique identifier for this fill.
Definition models.hpp:2382
std::string market_ticker
Unique identifier for the market (legacy field name, same as ticker)
Definition models.hpp:2391
Definition models.hpp:2429
std::int64_t end_period_ts
Unix timestamp for the inclusive end of the forecast period.
Definition models.hpp:2433
std::vector< PercentilePoint > percentile_points
Array of forecast values at different percentiles.
Definition models.hpp:2437
std::int64_t period_interval
Length of the forecast period in minutes.
Definition models.hpp:2435
std::string event_ticker
The event ticker this forecast is for.
Definition models.hpp:2431
Definition models.hpp:2440
std::optional< std::string > fcm_subtrader_id
FCM members only.
Definition models.hpp:2449
std::optional< std::vector< ApiKeyScope > > scopes
List of scopes to grant to the API key.
Definition models.hpp:2445
std::optional< ApiKeyType > key_type
Definition models.hpp:2443
std::string name
Name for the API key.
Definition models.hpp:2442
std::optional< std::int64_t > subaccount
If set, restricts the API key to a single sub-account (0-63) that you own.
Definition models.hpp:2447
Definition models.hpp:2452
std::optional< std::string > warning
Present only when the minted key is bound to an FCM subtrader that is missing a per- subtrader risk c...
Definition models.hpp:2462
std::string private_key
Private key in PEM format - PKCS#1 (-----BEGIN RSA PRIVATE KEY-----) for rsa, PKCS#8 (-----BEGIN PRIV...
Definition models.hpp:2458
std::string api_key_id
Unique identifier for the newly generated API key.
Definition models.hpp:2454
std::optional< ApiKeyType > key_type
Definition models.hpp:2455
Definition models.hpp:2465
std::string usage_tier
User's effective Predictions API usage tier for these limits (for example, basic, advanced,...
Definition models.hpp:2468
BucketLimit read
Definition models.hpp:2469
BucketLimit write
Definition models.hpp:2470
std::vector< ApiUsageLevelGrant > grants
The caller's active API usage level grants across exchange lanes, where each grant applies to its exc...
Definition models.hpp:2474
std::vector< AccountApiUsageLevelVolumeProgress > volume_progress
Latest cron-computed trading volume progress toward volume-based API usage tiers for the predictions ...
Definition models.hpp:2480
Definition models.hpp:2483
std::vector< EndpointTokenCost > endpoint_costs
API v2 endpoints whose configured token cost differs from default_cost.
Definition models.hpp:2487
std::int64_t default_cost
Default token cost applied to endpoints that are not listed in endpoint_costs.
Definition models.hpp:2485
Query parameters for get_api_keys.
Definition models.hpp:2491
std::optional< std::string > fcm_subtrader_id
Return only API keys bound to this FCM subtrader.
Definition models.hpp:2493
Definition models.hpp:2496
std::optional< std::int64_t > api_key_region_expiration_ts
Unix timestamp (seconds) when the account's location attestation for API key requests expires; a past...
Definition models.hpp:2501
std::vector< ApiKey > api_keys
List of all API keys associated with the user.
Definition models.hpp:2498
Query parameters for get_balance.
Definition models.hpp:2505
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:2507
std::optional< ExchangeIndex > exchange_index
Exchange index used to scope the balance and portfolio value.
Definition models.hpp:2509
Definition models.hpp:2517
std::int64_t portfolio_value
Member's portfolio value in cents for the requested account and exchange index.
Definition models.hpp:2524
std::int64_t balance
Member's available balance in cents for the requested account and exchange index.
Definition models.hpp:2519
std::optional< std::vector< IndexedBalance > > balance_breakdown
User balance breakdown per exchange instance, omitted only when using a subaccount- restricted API ke...
Definition models.hpp:2529
FixedPointDollars balance_dollars
Member's available balance as a fixed-point dollar string for the requested account and exchange inde...
Definition models.hpp:2522
std::int64_t updated_ts
Unix timestamp of the last update to the balance.
Definition models.hpp:2526
Query parameters for get_block_trade_proposals.
Definition models.hpp:2533
std::optional< std::int64_t > limit
Parameter to specify the number of results per page.
Definition models.hpp:2539
std::optional< std::string > status
Filter block trade proposals by status.
Definition models.hpp:2541
std::optional< std::string > market_ticker
Filter by market ticker.
Definition models.hpp:2537
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2535
Definition models.hpp:2544
std::optional< std::string > cursor
Cursor for pagination to get the next page of results.
Definition models.hpp:2548
std::vector< BlockTradeProposal > block_trade_proposals
List of block trade proposals.
Definition models.hpp:2546
Definition models.hpp:2551
std::string communications_id
A public communications ID which is used to identify the user.
Definition models.hpp:2553
Query parameters for get_credit_history.
Definition models.hpp:2557
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2561
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:2559
std::optional< std::int64_t > max_ts
Filter items before this Unix timestamp.
Definition models.hpp:2565
std::optional< std::int64_t > min_ts
Filter items after this Unix timestamp.
Definition models.hpp:2563
Definition models.hpp:2568
std::string cursor
Pagination cursor; empty when there are no more results.
Definition models.hpp:2571
std::vector< CreditHistory > credits
Definition models.hpp:2569
Query parameters for get_deposits.
Definition models.hpp:2575
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:2577
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2579
Definition models.hpp:2582
std::vector< Deposit > deposits
Definition models.hpp:2583
std::optional< std::string > cursor
Definition models.hpp:2584
Definition models.hpp:2587
std::vector< std::vector< MarketCandlestick > > market_candlesticks
Array of market candlestick arrays, one for each market in the event.
Definition models.hpp:2591
std::vector< std::string > market_tickers
Array of market tickers in the event.
Definition models.hpp:2589
std::int64_t adjusted_end_ts
Adjusted end timestamp if the requested candlesticks would be larger than maxAggregateCandidates.
Definition models.hpp:2594
Query parameters for get_event_contract_exit_triggers.
Definition models.hpp:2598
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:2600
std::optional< Kind > kind
Definition models.hpp:2601
std::vector< EventContractExitTrigger > exit_triggers
Definition models.hpp:2606
std::optional< EventContractExitTrigger > exit_trigger
Definition models.hpp:2605
Query parameters for get_event_fee_changes.
Definition models.hpp:2610
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2615
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:2613
std::optional< std::string > event_ticker
Definition models.hpp:2611
Definition models.hpp:2618
std::string cursor
Pagination cursor for the next page.
Definition models.hpp:2621
std::vector< EventFeeChange > event_fee_changes
Definition models.hpp:2619
Query parameters for get_event_forecast_percentiles_history.
Definition models.hpp:2625
std::int64_t end_ts
End timestamp for the range.
Definition models.hpp:2631
std::vector< std::int64_t > percentiles
Array of percentile values to retrieve (0-9999, max 10 values)
Definition models.hpp:2627
std::int64_t period_interval
Specifies the length of each forecast period, in minutes.
Definition models.hpp:2633
std::int64_t start_ts
Start timestamp for the range.
Definition models.hpp:2629
std::vector< ForecastPercentilesPoint > forecast_history
Array of forecast percentile data points over time.
Definition models.hpp:2638
Query parameters for get_event_live_data.
Definition models.hpp:2642
std::optional< std::string > range
Optional chart range hint (e.g.
Definition models.hpp:2644
Definition models.hpp:2647
EventLiveData live_data
Definition models.hpp:2648
Definition models.hpp:2660
std::optional< std::string > competition
Event competition.
Definition models.hpp:2670
std::optional< std::string > competition_scope
Event scope, based on the competition.
Definition models.hpp:2672
std::string image_url
A path to an image that represents this event.
Definition models.hpp:2662
std::optional< std::string > featured_image_url
A path to an image that represents the image of the featured market.
Definition models.hpp:2664
std::vector< MarketMetadata > market_details
Metadata for the markets in this event.
Definition models.hpp:2666
std::vector< SettlementSource > settlement_sources
A list of settlement sources for this event.
Definition models.hpp:2668
Query parameters for get_event.
Definition models.hpp:2676
std::optional< bool > with_nested_markets
If true, markets are included within the event object.
Definition models.hpp:2680
std::optional< bool > exclude_markets
Return event metadata without loading child markets.
Definition models.hpp:2678
Definition models.hpp:2683
EventData event
Data for the event.
Definition models.hpp:2685
std::vector< Market > markets
Data for the markets in this event.
Definition models.hpp:2687
Query parameters for get_events.
Definition models.hpp:2691
std::optional< bool > with_milestones
If true, includes related milestones as a field alongside events.
Definition models.hpp:2699
std::optional< std::string > cursor
Parameter to specify the pagination cursor.
Definition models.hpp:2695
std::optional< std::int64_t > min_updated_ts
Filter events with metadata updated after this Unix timestamp (in seconds).
Definition models.hpp:2710
std::optional< GetEventsStatus > status
Filter by event status.
Definition models.hpp:2701
std::optional< bool > with_nested_markets
Parameter to specify if nested markets should be included in the response.
Definition models.hpp:2697
std::optional< std::string > tickers
Filter by specific event tickers.
Definition models.hpp:2705
std::optional< std::int64_t > limit
Parameter to specify the number of results per page.
Definition models.hpp:2693
std::optional< std::int64_t > min_close_ts
Filter events with at least one market with close timestamp greater than this Unix timestamp (in seco...
Definition models.hpp:2708
std::optional< std::string > series_ticker
Filter by series ticker.
Definition models.hpp:2703
Definition models.hpp:2742
std::string cursor
Pagination cursor for the next page.
Definition models.hpp:2748
std::vector< EventData > events
Array of events matching the query criteria.
Definition models.hpp:2744
std::optional< std::vector< Milestone > > milestones
Array of milestones related to the events.
Definition models.hpp:2746
Definition models.hpp:2786
Schedule schedule
Definition models.hpp:2787
std::string cap_date
The New York calendar date the executed utilization applies to.
Definition models.hpp:2797
FixedPointDollars limit
Definition models.hpp:2792
FixedPointDollars executed_utilization
Definition models.hpp:2793
FixedPointDollars resting_order_utilization
Definition models.hpp:2794
std::string subtrader_id
Definition models.hpp:2791
FixedPointDollars pending_order_utilization
Definition models.hpp:2795
std::vector< std::string > categories
The event categories blocked for the subtrader, sorted ascending.
Definition models.hpp:2802
Query parameters for get_fcm_event_contract_daily_cap.
Definition models.hpp:2806
std::optional< std::string > subtrader_id
The subtrader whose daily cap should be returned.
Definition models.hpp:2808
Query parameters for get_fcm_fills.
Definition models.hpp:2812
std::optional< std::int64_t > min_ts
Filter items after this Unix timestamp.
Definition models.hpp:2814
std::optional< std::int64_t > max_ts
Filter items before this Unix timestamp.
Definition models.hpp:2816
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2818
Definition models.hpp:2821
std::vector< FcmFill > fills
Definition models.hpp:2822
std::string cursor
Definition models.hpp:2823
Query parameters for get_fcm_orders.
Definition models.hpp:2827
std::optional< std::string > ticker
Filter by market ticker.
Definition models.hpp:2837
std::optional< std::string > subtrader_id
Restricts the response to orders for a specific subtrader (FCM members only).
Definition models.hpp:2829
std::optional< std::string > client_order_ids
Client order IDs to filter by, as a comma-separated list (maximum 100).
Definition models.hpp:2831
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2833
std::optional< std::int64_t > limit
Parameter to specify the number of results per page.
Definition models.hpp:2845
std::optional< OrderStatus > status
Restricts the response to orders that have a certain status.
Definition models.hpp:2843
std::optional< std::int64_t > min_ts
Restricts the response to orders after a timestamp, formatted as a Unix Timestamp.
Definition models.hpp:2839
std::optional< std::string > event_ticker
Event ticker to filter by.
Definition models.hpp:2835
std::optional< std::int64_t > max_ts
Restricts the response to orders before a timestamp, formatted as a Unix Timestamp.
Definition models.hpp:2841
Query parameters for get_fcm_positions.
Definition models.hpp:2849
std::optional< std::string > cursor
The Cursor represents a pointer to the next page of records in the pagination.
Definition models.hpp:2864
std::optional< std::string > event_ticker
Event ticker of desired positions.
Definition models.hpp:2855
std::optional< std::string > count_filter
Restricts the positions to those with any of following fields with non-zero values,...
Definition models.hpp:2858
std::optional< std::int64_t > limit
Parameter to specify the number of results per page.
Definition models.hpp:2862
std::optional< std::string > ticker
Ticker of desired positions.
Definition models.hpp:2853
std::optional< SettlementStatus > settlement_status
Settlement status of the markets to return.
Definition models.hpp:2860
std::optional< std::string > subtrader_id
Restricts the response to positions for a specific subtrader (FCM members only).
Definition models.hpp:2851
Query parameters for get_fcm_subtrader_blocked_categories.
Definition models.hpp:2868
std::string subtrader_id
The subtrader whose blocked categories should be returned.
Definition models.hpp:2870
Query parameters for get_fills_historical.
Definition models.hpp:2874
std::optional< std::int64_t > max_ts
Filter items before this Unix timestamp.
Definition models.hpp:2880
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:2882
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:2886
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2884
std::optional< std::string > ticker
Filter by market ticker.
Definition models.hpp:2876
std::optional< std::int64_t > min_ts
Filter items after this Unix timestamp.
Definition models.hpp:2878
Query parameters for get_fills.
Definition models.hpp:2890
std::optional< std::int64_t > min_ts
Filter items after this Unix timestamp.
Definition models.hpp:2896
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:2904
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:2900
std::optional< std::string > ticker
Filter by market ticker.
Definition models.hpp:2892
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2902
std::optional< std::int64_t > exchange_index
Filter results by exchange shard.
Definition models.hpp:2906
std::optional< std::int64_t > max_ts
Filter items before this Unix timestamp.
Definition models.hpp:2898
std::optional< std::string > order_id
Filter by order ID.
Definition models.hpp:2894
Definition models.hpp:2909
std::string cursor
Definition models.hpp:2911
std::vector< Fill > fills
Definition models.hpp:2910
Definition models.hpp:2926
std::map< std::string, SportFilterDetails > filters_by_sports
Mapping of sports to their filter details.
Definition models.hpp:2928
std::vector< std::string > sport_ordering
Ordered list of sports for display.
Definition models.hpp:2930
Definition models.hpp:2942
std::optional< PlayByPlay > pbp
Definition models.hpp:2943
Definition models.hpp:2946
std::optional< std::string > market_positions_last_updated_ts
Cutoff based on position last-update time.
Definition models.hpp:2954
std::string market_settled_ts
Cutoff based on market settlement time.
Definition models.hpp:2948
std::string orders_updated_ts
Cutoff based on order cancellation or execution time.
Definition models.hpp:2952
std::string trades_created_ts
Cutoff based on trade fill time.
Definition models.hpp:2950
Query parameters for get_historical_markets.
Definition models.hpp:2958
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2962
std::optional< std::string > event_ticker
Event ticker to filter by.
Definition models.hpp:2966
std::optional< std::string > tickers
Filter by specific market tickers.
Definition models.hpp:2964
std::optional< std::string > series_ticker
Filter by series ticker.
Definition models.hpp:2968
std::optional< GetHistoricalMarketsMveFilter > mve_filter
Filter by multivariate events (combos).
Definition models.hpp:2970
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:2960
Query parameters for get_historical_orders.
Definition models.hpp:2974
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:2986
std::optional< std::int64_t > min_ts
Filter items after this Unix timestamp.
Definition models.hpp:2978
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2984
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:2982
std::optional< std::string > ticker
Filter by market ticker.
Definition models.hpp:2976
std::optional< std::int64_t > max_ts
Filter items before this Unix timestamp.
Definition models.hpp:2980
Query parameters for get_historical_positions.
Definition models.hpp:2990
std::optional< std::string > event_ticker
Event ticker to filter by.
Definition models.hpp:2994
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:3000
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:2996
std::optional< std::string > ticker
Filter by market ticker.
Definition models.hpp:2992
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:2998
Query parameters for get_incentive_programs.
Definition models.hpp:3004
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:3012
std::optional< GetIncentiveProgramsStatus > status
Status filter.
Definition models.hpp:3006
std::optional< GetIncentiveProgramsType > type
Type filter.
Definition models.hpp:3008
std::optional< std::string > incentive_description
Filter by exact incentive description.
Definition models.hpp:3010
std::optional< std::string > cursor
Cursor for pagination.
Definition models.hpp:3014
Definition models.hpp:3044
std::optional< std::string > next_cursor
Cursor for pagination to get the next page of results.
Definition models.hpp:3047
std::vector< IncentiveProgram > incentive_programs
Definition models.hpp:3045
IntraExchangeInstanceTransfer transfer
Definition models.hpp:3071
Query parameters for get_intra_exchange_instance_transfers.
Definition models.hpp:3075
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:3077
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:3079
std::optional< std::string > cursor
Cursor for the next page of results.
Definition models.hpp:3085
std::vector< IntraExchangeInstanceTransfer > transfers
Definition models.hpp:3083
Query parameters for get_live_data_by_milestone.
Definition models.hpp:3089
std::optional< bool > include_player_stats
When true, includes player-level statistics in the live data response.
Definition models.hpp:3091
Query parameters for get_live_data.
Definition models.hpp:3095
std::optional< bool > include_player_stats
When true, includes player-level statistics in the live data response.
Definition models.hpp:3097
Definition models.hpp:3109
LiveData live_data
Definition models.hpp:3110
Query parameters for get_live_datas.
Definition models.hpp:3114
std::optional< bool > include_player_stats
When true, includes player-level statistics in the live data response.
Definition models.hpp:3118
std::vector< std::string > milestone_ids
Array of milestone IDs.
Definition models.hpp:3116
Definition models.hpp:3121
std::vector< LiveData > live_datas
Definition models.hpp:3122
Query parameters for get_market_candlesticks_by_event.
Definition models.hpp:3126
std::int64_t start_ts
Start timestamp for the range.
Definition models.hpp:3128
std::int64_t end_ts
End timestamp for the range.
Definition models.hpp:3130
std::int64_t period_interval
Specifies the length of each candlestick period, in minutes.
Definition models.hpp:3132
Query parameters for get_market_candlesticks_historical.
Definition models.hpp:3136
std::int64_t period_interval
Time period length of each candlestick in minutes.
Definition models.hpp:3142
std::int64_t start_ts
Start timestamp (Unix timestamp).
Definition models.hpp:3138
std::int64_t end_ts
End timestamp (Unix timestamp).
Definition models.hpp:3140
std::string ticker
Unique identifier for the market.
Definition models.hpp:3182
std::vector< MarketCandlestickHistorical > candlesticks
Array of candlestick data points for the specified time range.
Definition models.hpp:3184
Query parameters for get_market_candlesticks.
Definition models.hpp:3188
std::optional< bool > include_latest_before_start
If true, prepends the latest candlestick available before the start_ts.
Definition models.hpp:3196
std::int64_t start_ts
Start timestamp (Unix timestamp).
Definition models.hpp:3190
std::int64_t period_interval
Time period length of each candlestick in minutes.
Definition models.hpp:3194
std::int64_t end_ts
End timestamp (Unix timestamp).
Definition models.hpp:3192
Definition models.hpp:3199
std::string ticker
Unique identifier for the market.
Definition models.hpp:3201
std::vector< MarketCandlestick > candlesticks
Array of candlestick data points for the specified time range.
Definition models.hpp:3203
Definition models.hpp:3213
std::string id
Market index ID.
Definition models.hpp:3215
MarketIndexStatus status
Definition models.hpp:3218
std::vector< MarketIndexTimeseriesPoint > timeseries
Definition models.hpp:3227
std::int64_t end_ms
Window end, unix milliseconds.
Definition models.hpp:3226
std::optional< std::int64_t > last_tick_ms
Time of the index's latest value, unix milliseconds.
Definition models.hpp:3220
std::string source
Data source of timeseries.
Definition models.hpp:3217
std::int64_t start_ms
Window start, unix milliseconds.
Definition models.hpp:3224
std::string interval
Point spacing of timeseries (1s or 1m).
Definition models.hpp:3222
Definition models.hpp:3276
std::int64_t start_ms
Window start, unix milliseconds.
Definition models.hpp:3288
std::int64_t end_ms
Window end, unix milliseconds.
Definition models.hpp:3290
std::optional< double > value
Latest index value.
Definition models.hpp:3282
std::string interval
Point spacing of timeseries (1m).
Definition models.hpp:3286
std::optional< std::int64_t > last_tick_ms
Time of value, unix milliseconds.
Definition models.hpp:3284
MarketIndex index
Definition models.hpp:3277
std::string source
Data source of timeseries.
Definition models.hpp:3279
std::vector< MarketIndexTimeseriesPoint > timeseries
Definition models.hpp:3291
MarketIndexStatus status
Definition models.hpp:3280
Definition models.hpp:3294
std::vector< MarketIndex > indexes
Definition models.hpp:3295
Query parameters for get_market_orderbook.
Definition models.hpp:3299
std::optional< std::int64_t > depth
Depth of the orderbook to retrieve (0 or negative means all levels, 1-100 for specific depth)
Definition models.hpp:3302
Definition models.hpp:3311
OrderbookCountFp orderbook_fp
Orderbook with fixed-point contract counts (fp) in all price levels.
Definition models.hpp:3313
Query parameters for get_market_orderbooks.
Definition models.hpp:3317
std::vector< std::string > tickers
List of market tickers to fetch orderbooks for.
Definition models.hpp:3319
Definition models.hpp:3327
std::vector< MarketOrderbookFp > orderbooks
Definition models.hpp:3328
Definition models.hpp:3331
Market market
Definition models.hpp:3332
Query parameters for get_markets.
Definition models.hpp:3336
std::optional< std::string > series_ticker
Filter by series ticker.
Definition models.hpp:3344
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:3340
std::optional< GetMarketsStatus > status
Filter by market status.
Definition models.hpp:3362
std::optional< std::string > event_ticker
Event ticker to filter by.
Definition models.hpp:3342
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:3338
std::optional< GetMarketsMveFilter > mve_filter
Filter by multivariate events (combos).
Definition models.hpp:3366
std::optional< std::int64_t > min_updated_ts
Return markets with metadata updated later than this Unix timestamp (in seconds).
Definition models.hpp:3350
std::optional< std::int64_t > max_updated_ts
Return markets with metadata updated at or before this Unix timestamp (in seconds).
Definition models.hpp:3352
std::optional< std::int64_t > max_settled_ts
Filter items that settled before this Unix timestamp.
Definition models.hpp:3360
std::optional< std::int64_t > max_close_ts
Filter items that close before this Unix timestamp.
Definition models.hpp:3354
std::optional< std::string > tickers
Filter by specific market tickers.
Definition models.hpp:3364
std::optional< std::int64_t > min_created_ts
Filter items that created after this Unix timestamp.
Definition models.hpp:3346
std::optional< std::int64_t > min_close_ts
Filter items that close after this Unix timestamp.
Definition models.hpp:3356
std::optional< std::int64_t > max_created_ts
Filter items that created before this Unix timestamp.
Definition models.hpp:3348
std::optional< std::int64_t > min_settled_ts
Filter items that settled after this Unix timestamp.
Definition models.hpp:3358
Definition models.hpp:3369
std::vector< Market > markets
Definition models.hpp:3370
std::string cursor
Definition models.hpp:3371
Definition models.hpp:3374
Milestone milestone
The milestone data.
Definition models.hpp:3376
Query parameters for get_milestones.
Definition models.hpp:3380
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:3396
std::optional< std::int64_t > min_updated_ts
Filter milestones with metadata updated after this Unix timestamp (in seconds).
Definition models.hpp:3398
std::optional< std::string > minimum_start_date
Minimum start date to filter milestones.
Definition models.hpp:3384
std::optional< std::string > category
Filter by milestone category.
Definition models.hpp:3386
std::optional< std::string > type
Filter by milestone type.
Definition models.hpp:3392
std::int64_t limit
Number of milestones to return per page.
Definition models.hpp:3382
std::optional< std::string > related_event_ticker
Filter by related event ticker.
Definition models.hpp:3394
std::optional< std::string > competition
Filter by competition.
Definition models.hpp:3388
std::optional< std::string > source_id
Filter by source id.
Definition models.hpp:3390
Definition models.hpp:3401
std::optional< std::string > cursor
Cursor for pagination.
Definition models.hpp:3405
std::vector< Milestone > milestones
List of milestones.
Definition models.hpp:3403
MultivariateEventCollection multivariate_contract
The multivariate event collection.
Definition models.hpp:3451
Query parameters for get_multivariate_event_collections.
Definition models.hpp:3455
std::optional< GetMultivariateEventCollectionsStatus > status
Only return collections of a certain status.
Definition models.hpp:3457
std::optional< std::string > series_ticker
Only return collections with a particular series ticker.
Definition models.hpp:3461
std::optional< std::string > cursor
The Cursor represents a pointer to the next page of records in the pagination.
Definition models.hpp:3465
std::optional< std::string > associated_event_ticker
Only return collections associated with a particular event ticker.
Definition models.hpp:3459
std::optional< std::int64_t > limit
Specify the maximum number of results.
Definition models.hpp:3463
std::optional< std::string > cursor
The Cursor represents a pointer to the next page of records in the pagination.
Definition models.hpp:3472
std::vector< MultivariateEventCollection > multivariate_contracts
List of multivariate event collections.
Definition models.hpp:3470
Query parameters for get_multivariate_events.
Definition models.hpp:3476
std::optional< std::string > collection_ticker
Filter events by collection ticker.
Definition models.hpp:3484
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:3478
std::optional< std::string > tickers
Filter by specific event tickers.
Definition models.hpp:3486
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:3480
std::optional< bool > with_nested_markets
Parameter to specify if nested markets should be included in the response.
Definition models.hpp:3488
std::optional< std::string > series_ticker
Filter by series ticker.
Definition models.hpp:3482
Definition models.hpp:3491
std::vector< EventData > events
Array of multivariate events matching the query criteria.
Definition models.hpp:3493
std::string cursor
Pagination cursor for the next page.
Definition models.hpp:3495
Query parameters for get_order_group.
Definition models.hpp:3499
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:3501
Definition models.hpp:3504
std::optional< ExchangeIndex > exchange_index
Definition models.hpp:3512
std::optional< FixedPointCount > contracts_limit_fp
String representation of the current maximum contracts allowed over a rolling 15-second window.
Definition models.hpp:3509
std::vector< std::string > orders
List of order IDs that belong to this order group.
Definition models.hpp:3511
bool is_auto_cancel_enabled
Whether auto-cancel is enabled for this order group.
Definition models.hpp:3506
Query parameters for get_order_groups.
Definition models.hpp:3516
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:3518
Definition models.hpp:3532
std::optional< std::vector< OrderGroup > > order_groups
Definition models.hpp:3533
Definition models.hpp:3536
FixedPointCount queue_position_fp
The number of preceding shares before the order in the queue.
Definition models.hpp:3538
Query parameters for get_order_queue_positions.
Definition models.hpp:3542
std::optional< std::string > market_tickers
Comma-separated list of market tickers to filter by.
Definition models.hpp:3544
std::optional< std::string > event_ticker
Event ticker to filter by.
Definition models.hpp:3546
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:3548
Definition models.hpp:3560
std::vector< OrderQueuePosition > queue_positions
Queue positions for all matching orders.
Definition models.hpp:3562
Definition models.hpp:3565
Order order
Definition models.hpp:3566
Query parameters for get_orders.
Definition models.hpp:3570
std::optional< std::string > status
Filter by status.
Definition models.hpp:3580
std::optional< std::string > ticker
Filter by market ticker.
Definition models.hpp:3572
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:3584
std::optional< std::int64_t > max_ts
Filter items before this Unix timestamp.
Definition models.hpp:3578
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:3586
std::optional< std::int64_t > min_ts
Filter items after this Unix timestamp.
Definition models.hpp:3576
std::optional< std::int64_t > exchange_index
Filter results by exchange shard.
Definition models.hpp:3588
std::optional< std::string > event_ticker
Event tickers to filter by, as a comma-separated list (maximum 100).
Definition models.hpp:3574
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:3582
Definition models.hpp:3591
std::vector< Order > orders
Definition models.hpp:3592
std::string cursor
Definition models.hpp:3593
std::vector< IndexedBalance > resting_order_value_breakdown
Total value of resting orders broken down by exchange index, with each balance expressed as a fixed-p...
Definition models.hpp:3601
std::int64_t total_resting_order_value
Total value of resting orders in cents.
Definition models.hpp:3598
Query parameters for get_positions.
Definition models.hpp:3605
std::optional< std::int64_t > exchange_index
Filter results by exchange shard.
Definition models.hpp:3623
std::optional< std::string > cursor
The Cursor represents a pointer to the next page of records in the pagination.
Definition models.hpp:3607
std::optional< std::int64_t > limit
Parameter to specify the number of results per page.
Definition models.hpp:3609
std::optional< std::string > event_ticker
Event ticker to filter by.
Definition models.hpp:3619
std::optional< SettlementStatus > settlement_status
Return unsettled positions by default, settled positions that have not yet been archived,...
Definition models.hpp:3615
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:3621
std::optional< std::string > ticker
Filter by market ticker.
Definition models.hpp:3617
std::optional< std::string > count_filter
Restricts the positions to those with any of following fields with non-zero values,...
Definition models.hpp:3612
Definition models.hpp:3646
std::vector< EventPosition > event_positions
List of event positions.
Definition models.hpp:3652
std::vector< MarketPosition > market_positions
List of market positions.
Definition models.hpp:3650
std::optional< std::string > cursor
The Cursor represents a pointer to the next page of records in the pagination.
Definition models.hpp:3648
Definition models.hpp:3655
Quote quote
The details of the requested quote.
Definition models.hpp:3657
Query parameters for get_quotes.
Definition models.hpp:3661
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:3663
std::optional< UserFilter > user_filter
Filter for quotes created by the authenticated user.
Definition models.hpp:3677
std::optional< std::int64_t > limit
Parameter to specify the number of results per page.
Definition models.hpp:3671
std::optional< std::int64_t > max_ts
Restricts the response to quotes last updated before a timestamp, formatted as a Unix Timestamp.
Definition models.hpp:3669
std::optional< std::string > rfq_creator_subtrader_id
Filter quotes by RFQ creator subtrader ID (FCM members only)
Definition models.hpp:3683
std::optional< std::string > quote_creator_user_id
Filter quotes by quote creator user ID.
Definition models.hpp:3675
std::optional< std::string > status
Filter quotes by status.
Definition models.hpp:3673
std::optional< UserFilter > rfq_user_filter
Filter for quotes responding to RFQs created by the authenticated user.
Definition models.hpp:3679
std::optional< std::string > rfq_creator_user_id
Filter quotes by RFQ creator user ID.
Definition models.hpp:3681
std::optional< std::string > rfq_id
Filter quotes by RFQ UUID.
Definition models.hpp:3685
std::optional< std::int64_t > min_ts
Restricts the response to quotes last updated after a timestamp, formatted as a Unix Timestamp.
Definition models.hpp:3666
Definition models.hpp:3688
std::vector< Quote > quotes
List of quotes matching the query criteria.
Definition models.hpp:3690
std::optional< std::string > cursor
Cursor for pagination to get the next page of results.
Definition models.hpp:3692
Definition models.hpp:3726
RFQBatchBestQuotes best_quotes
Definition models.hpp:3727
Definition models.hpp:3769
std::vector< RFQBatchQuote > batch_quotes
Batch quotes on the RFQ batch visible to you.
Definition models.hpp:3771
Definition models.hpp:3774
RFQBatch rfq_batch
Definition models.hpp:3775
Definition models.hpp:3778
std::optional< std::string > cursor
Cursor for pagination to get the next page of results.
Definition models.hpp:3782
std::vector< RFQBatch > rfq_batches
RFQ batches matching the query criteria.
Definition models.hpp:3780
Definition models.hpp:3785
RFQ rfq
The details of the requested RFQ.
Definition models.hpp:3787
Definition models.hpp:3790
std::optional< std::string > cursor
Cursor for pagination to get the next page of results.
Definition models.hpp:3794
std::vector< RFQ > rfqs
List of RFQs matching the query criteria.
Definition models.hpp:3792
Query parameters for get_rfq_batches.
Definition models.hpp:3798
std::optional< std::int64_t > limit
Maximum number of batches per page.
Definition models.hpp:3804
std::optional< RFQBatchStatus > status
Filter RFQ batches by status.
Definition models.hpp:3806
std::optional< UserFilter > user_filter
Definition models.hpp:3807
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:3800
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:3802
Query parameters for get_rfqs.
Definition models.hpp:3811
std::optional< std::string > market_ticker
Filter by market ticker.
Definition models.hpp:3817
std::optional< std::int64_t > limit
Parameter to specify the number of results per page.
Definition models.hpp:3821
std::optional< std::string > creator_user_id
Filter RFQs by creator user UUID.
Definition models.hpp:3825
std::optional< UserFilter > user_filter
Definition models.hpp:3826
std::optional< std::string > event_ticker
Event ticker to filter by.
Definition models.hpp:3815
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:3819
std::optional< std::string > status
Filter RFQs by status.
Definition models.hpp:3823
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:3813
Query parameters for get_series_fee_changes.
Definition models.hpp:3830
std::optional< bool > show_historical
Definition models.hpp:3832
std::optional< std::string > series_ticker
Definition models.hpp:3831
Definition models.hpp:3848
std::vector< SeriesFeeChange > series_fee_change_arr
Definition models.hpp:3849
Query parameters for get_series_list.
Definition models.hpp:3853
std::optional< std::int64_t > min_updated_ts
Filter series with metadata updated after this Unix timestamp (in seconds).
Definition models.hpp:3861
std::optional< bool > include_product_metadata
Definition models.hpp:3857
std::optional< std::string > tags
Definition models.hpp:3856
std::optional< bool > include_volume
If true, includes the total volume traded across all events in each series.
Definition models.hpp:3859
std::optional< std::string > category
Return series whose categories list contains this value.
Definition models.hpp:3855
Definition models.hpp:3902
std::vector< Series > series
Definition models.hpp:3903
Query parameters for get_series.
Definition models.hpp:3907
std::optional< bool > include_volume
If true, includes the total volume traded across all events in this series.
Definition models.hpp:3909
Definition models.hpp:3912
Series series
Definition models.hpp:3913
Query parameters for get_settlements.
Definition models.hpp:3917
std::optional< std::string > ticker
Filter by market ticker.
Definition models.hpp:3923
std::optional< std::int64_t > max_ts
Filter items before this Unix timestamp.
Definition models.hpp:3929
std::optional< std::string > event_ticker
Event ticker to filter by.
Definition models.hpp:3925
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:3921
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:3919
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:3931
std::optional< std::int64_t > min_ts
Filter items after this Unix timestamp.
Definition models.hpp:3927
Definition models.hpp:3961
std::vector< Settlement > settlements
Definition models.hpp:3962
std::optional< std::string > cursor
Definition models.hpp:3963
Definition models.hpp:3984
std::optional< StructuredTarget > structured_target
Definition models.hpp:3985
Query parameters for get_structured_targets.
Definition models.hpp:3989
std::optional< std::string > competition
Filter by competition.
Definition models.hpp:3995
std::vector< std::string > ids
Filter by specific structured target IDs.
Definition models.hpp:3991
std::optional< std::int64_t > page_size
Number of items per page (min 1, max 2000, default 100)
Definition models.hpp:3997
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:3999
std::optional< std::string > type
Filter by structured target type.
Definition models.hpp:3993
Definition models.hpp:4002
std::optional< std::vector< StructuredTarget > > structured_targets
Definition models.hpp:4003
std::optional< std::string > cursor
Pagination cursor for the next page.
Definition models.hpp:4005
Definition models.hpp:4019
std::vector< SubaccountBalance > subaccount_balances
Definition models.hpp:4020
Definition models.hpp:4032
std::vector< SubaccountNettingConfig > netting_configs
Definition models.hpp:4033
Query parameters for get_subaccount_transfers.
Definition models.hpp:4037
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:4041
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:4039
Definition models.hpp:4059
std::vector< SubaccountTransfer > transfers
Definition models.hpp:4060
std::optional< std::string > cursor
Cursor for the next page of results.
Definition models.hpp:4062
std::map< std::string, std::vector< std::string > > tags_by_categories
Mapping of series categories to their associated tags.
Definition models.hpp:4067
std::vector< TargetBalanceAllocation > allocations
Definition models.hpp:4078
RestingMarginReservation resting_margin_reservation
Definition models.hpp:4079
Query parameters for get_trades_historical.
Definition models.hpp:4083
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:4091
std::optional< std::int64_t > min_ts
Filter items after this Unix timestamp.
Definition models.hpp:4087
std::optional< std::string > ticker
Filter by market ticker.
Definition models.hpp:4085
std::optional< bool > is_block_trade
Filter trades by whether they are block trades.
Definition models.hpp:4095
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:4093
std::optional< std::int64_t > max_ts
Filter items before this Unix timestamp.
Definition models.hpp:4089
Query parameters for get_trades.
Definition models.hpp:4099
std::optional< std::string > ticker
Filter by market ticker.
Definition models.hpp:4105
std::optional< bool > is_block_trade
Filter trades by whether they are block trades.
Definition models.hpp:4111
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:4103
std::optional< std::int64_t > max_ts
Filter items before this Unix timestamp.
Definition models.hpp:4109
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:4101
std::optional< std::int64_t > min_ts
Filter items after this Unix timestamp.
Definition models.hpp:4107
Definition models.hpp:4137
std::vector< Trade > trades
Definition models.hpp:4138
std::string cursor
Definition models.hpp:4139
Definition models.hpp:4142
std::string as_of_time
Timestamp when user data was last updated.
Definition models.hpp:4144
std::vector< WeatherIndexCalibration > calibrations
Configuration records, ascending by effective time.
Definition models.hpp:4188
std::string units
Always celsius — offsets and the city reference are Celsius quantities from the index methodology (th...
Definition models.hpp:4186
std::string city
Index city ID.
Definition models.hpp:4183
Query parameters for get_weather_index.
Definition models.hpp:4192
std::optional< std::int64_t > last_sec
Trailing window in seconds; equivalent to from=now-last_sec, to=now.
Definition models.hpp:4198
std::optional< std::int64_t > from
Window start, unix milliseconds (inclusive).
Definition models.hpp:4194
std::optional< bool > detailed
Include per-station audit readings on every point.
Definition models.hpp:4200
std::optional< std::int64_t > to
Window end, unix milliseconds (inclusive).
Definition models.hpp:4196
Definition models.hpp:4242
std::string units
Always fahrenheit.
Definition models.hpp:4248
std::optional< std::string > config_version
Index configuration version of the newest returned point (e.g.
Definition models.hpp:4246
std::string city
Index city ID.
Definition models.hpp:4244
std::vector< WeatherIndexPoint > timeseries
Definition models.hpp:4249
Query parameters for get_withdrawals.
Definition models.hpp:4253
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:4257
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:4255
Definition models.hpp:4277
std::optional< std::string > cursor
Definition models.hpp:4279
std::vector< Withdrawal > withdrawals
Definition models.hpp:4278
Definition models.hpp:3017
std::string market_ticker
The ticker symbol of the market associated with this incentive program.
Definition models.hpp:3023
std::int64_t period_reward
Total reward for the period in centi-cents.
Definition models.hpp:3033
std::string start_date
Start date of the incentive program.
Definition models.hpp:3029
std::optional< std::int64_t > max_reward_per_account
Maximum reward per account in centi-cents (optional)
Definition models.hpp:3041
std::string market_id
The unique identifier of the market associated with this incentive program.
Definition models.hpp:3021
std::string id
Unique identifier for the incentive program.
Definition models.hpp:3019
std::string end_date
End date of the incentive program.
Definition models.hpp:3031
IncentiveProgramIncentiveType incentive_type
Type of incentive program.
Definition models.hpp:3025
std::optional< std::int64_t > discount_factor_bps
Discount factor in basis points (optional)
Definition models.hpp:3037
std::string incentive_description
Plain text description of the incentive program.
Definition models.hpp:3027
bool paid_out
Whether the incentive has been paid out.
Definition models.hpp:3035
std::optional< FixedPointCount > target_size_fp
String representation of the target size for the incentive program (optional)
Definition models.hpp:3039
Definition models.hpp:2512
ExchangeIndex exchange_index
Definition models.hpp:2513
FixedPointDollars balance
Definition models.hpp:2514
std::optional< std::int64_t > destination_exchange_shard
Destination exchange shard index (default 0)
Definition models.hpp:4294
std::optional< std::int64_t > source_subaccount
Source subaccount number (default 0 for the primary account).
Definition models.hpp:4296
ExchangeInstance source
The source exchange instance.
Definition models.hpp:4286
std::optional< std::int64_t > source_exchange_shard
Source exchange shard index (default 0)
Definition models.hpp:4292
std::optional< std::string > client_transfer_id
Client ID for duplicate prevention.
Definition models.hpp:4284
std::optional< std::int64_t > destination_subaccount
Destination subaccount number (default 0 for the primary account).
Definition models.hpp:4298
ExchangeInstance destination
The destination exchange instance.
Definition models.hpp:4288
std::int64_t amount
The amount to transfer in centicents.
Definition models.hpp:4290
std::string transfer_id
The ID of the transfer that was created.
Definition models.hpp:4303
Definition models.hpp:3050
std::optional< std::string > client_transfer_id
The client_transfer_id provided when the transfer was created.
Definition models.hpp:3054
std::int64_t source_exchange_shard
Source exchange shard index.
Definition models.hpp:3060
ExchangeInstance source
Source exchange instance.
Definition models.hpp:3056
IntraExchangeInstanceTransferStatus status
Definition models.hpp:3065
std::int64_t created_ts
Unix timestamp when the transfer was created.
Definition models.hpp:3067
std::string transfer_id
Unique transfer id.
Definition models.hpp:3052
std::int64_t destination_exchange_shard
Destination exchange shard index.
Definition models.hpp:3062
ExchangeInstance destination
Destination exchange instance.
Definition models.hpp:3058
FixedPointDollars amount
Transfer amount in dollars.
Definition models.hpp:3064
Definition models.hpp:4306
std::vector< FCMSubtrader > subtraders
Definition models.hpp:4307
Definition models.hpp:3100
std::string milestone_id
Milestone ID.
Definition models.hpp:3106
std::string type
Type of live data.
Definition models.hpp:3102
RawJson details
Live data details as a flexible object.
Definition models.hpp:3104
Definition models.hpp:2772
std::string start_datetime
Start date and time of the maintenance window.
Definition models.hpp:2774
std::string end_datetime
End date and time of the maintenance window.
Definition models.hpp:2776
Definition models.hpp:3160
std::int64_t end_period_ts
Unix timestamp for the inclusive end of the candlestick period.
Definition models.hpp:3162
BidAskDistributionHistorical yes_bid
Open, high, low, close (OHLC) data for YES buy offers on the market during the candlestick period.
Definition models.hpp:3165
BidAskDistributionHistorical yes_ask
Open, high, low, close (OHLC) data for YES sell offers on the market during the candlestick period.
Definition models.hpp:3168
PriceDistributionHistorical price
Open, high, low, close (OHLC) and more data for trade YES contract prices on the market during the ca...
Definition models.hpp:3171
FixedPointCount open_interest
String representation of the number of contracts bought on the market by end of the candlestick perio...
Definition models.hpp:3177
FixedPointCount volume
String representation of the number of contracts bought on the market during the candlestick period.
Definition models.hpp:3174
Definition models.hpp:1526
PriceDistribution price
Open, high, low, close (OHLC) and more data for trade YES contract prices on the market during the ca...
Definition models.hpp:1537
BidAskDistribution yes_bid
Open, high, low, close (OHLC) data for YES buy offers on the market during the candlestick period.
Definition models.hpp:1531
std::int64_t end_period_ts
Unix timestamp for the inclusive end of the candlestick period.
Definition models.hpp:1528
FixedPointCount open_interest_fp
String representation of the number of contracts bought on the market by end of the candlestick perio...
Definition models.hpp:1543
BidAskDistribution yes_ask
Open, high, low, close (OHLC) data for YES sell offers on the market during the candlestick period.
Definition models.hpp:1534
FixedPointCount volume_fp
String representation of the number of contracts bought on the market during the candlestick period.
Definition models.hpp:1540
Definition models.hpp:1546
std::string market_ticker
Market ticker string (e.g., 'INXD-24JAN01').
Definition models.hpp:1548
std::vector< MarketCandlestick > candlesticks
Array of candlestick data points for the market.
Definition models.hpp:1550
Definition models.hpp:3245
std::optional< double > value
Latest index value.
Definition models.hpp:3250
std::optional< std::int64_t > last_tick_ms
Time of value, unix milliseconds.
Definition models.hpp:3252
MarketIndexStatus status
Definition models.hpp:3248
std::string source
Data source of the value, e.g.
Definition models.hpp:3247
The index's regular publication session.
Definition models.hpp:3231
std::string open
Session open, HH:MM local time.
Definition models.hpp:3235
std::string timezone
IANA time zone of open and close, e.g.
Definition models.hpp:3233
std::vector< std::string > days
Weekdays the session runs, e.g.
Definition models.hpp:3239
std::string close
Session close, HH:MM local time.
Definition models.hpp:3237
std::optional< std::string > calendar
Holiday calendar applied on top of days: us_equity (US stock market holidays and 1:00 PM early closes...
Definition models.hpp:3242
Definition models.hpp:3206
std::int64_t t
Unix milliseconds.
Definition models.hpp:3208
double v
Index value.
Definition models.hpp:3210
Definition models.hpp:3255
bool available
False while the index has no data source; such an index serves no values.
Definition models.hpp:3272
std::string units
Unit of index values; always index_points.
Definition models.hpp:3269
std::optional< std::string > gics_code
GICS sector code, for sector indexes only.
Definition models.hpp:3263
std::optional< MarketIndexLatest > latest
Definition models.hpp:3273
std::string currency
ISO 4217 currency of the index, e.g.
Definition models.hpp:3267
MarketIndexSession session
Definition models.hpp:3270
std::string id
Stable index ID, e.g.
Definition models.hpp:3257
std::string name
Index name, e.g.
Definition models.hpp:3259
std::string family
Index family, e.g.
Definition models.hpp:3261
std::optional< std::string > sector
GICS sector name, for sector indexes only.
Definition models.hpp:3265
Definition models.hpp:2651
std::string color_code
The color code for the market.
Definition models.hpp:2657
std::string market_ticker
The ticker of the market.
Definition models.hpp:2653
std::string image_url
A path to an image that represents this market.
Definition models.hpp:2655
Definition models.hpp:3322
OrderbookCountFp orderbook_fp
Definition models.hpp:3324
std::string ticker
Definition models.hpp:3323
Definition models.hpp:3626
std::string last_updated_ts
Last time the position is updated.
Definition models.hpp:3641
FixedPointDollars market_exposure_dollars
Cost of the aggregate market position in dollars.
Definition models.hpp:3635
FixedPointCount position_fp
String representation of the number of contracts bought in this market.
Definition models.hpp:3633
FixedPointDollars fees_paid_dollars
Fees paid on fill orders, in dollars.
Definition models.hpp:3639
FixedPointDollars realized_pnl_dollars
Locked in profit and loss, in dollars.
Definition models.hpp:3637
ExchangeIndex exchange_index
Definition models.hpp:3629
FixedPointDollars total_traded_dollars
Total spent on this market in dollars.
Definition models.hpp:3631
std::string ticker
Unique identifier for the market.
Definition models.hpp:3628
bool netting_enabled
Whether netting applies to this position's event.
Definition models.hpp:3643
Definition models.hpp:1736
std::optional< std::string > settlement_ts
Timestamp when the market was settled.
Definition models.hpp:1795
std::optional< bool > is_provisional
If true, the market may be removed after determination if there is no activity on it.
Definition models.hpp:1831
std::optional< std::string > functional_strike
Mapping from expiration values to settlement values.
Definition models.hpp:1815
std::vector< PriceRange > price_ranges
Valid price ranges for orders on this market.
Definition models.hpp:1829
FixedPointDollars yes_ask_dollars
Price for the lowest YES sell offer on this market in dollars.
Definition models.hpp:1766
FixedPointDollars previous_yes_ask_dollars
Price for the lowest YES sell offer on this market a day ago in dollars.
Definition models.hpp:1789
FixedPointCount yes_ask_size_fp
Total contract size of orders to sell YES at the best ask price (fixed-point count string).
Definition models.hpp:1768
std::string event_ticker
Definition models.hpp:1738
FixedPointDollars previous_price_dollars
Price for the last traded YES contract on this market a day ago in dollars.
Definition models.hpp:1791
FixedPointDollars no_ask_dollars
Price for the lowest NO sell offer on this market in dollars.
Definition models.hpp:1772
FixedPointCount volume_24h_fp
String representation of the 24h market volume in contracts.
Definition models.hpp:1778
std::optional< std::string > fee_waiver_expiration_time
Time when this market's fee waiver expires.
Definition models.hpp:1805
MarketStatus status
The current status of the market in its lifecycle.
Definition models.hpp:1760
MarketType market_type
Identifies the type of market.
Definition models.hpp:1740
std::optional< ExchangeIndex > exchange_index
Definition models.hpp:1832
FixedPointDollars last_price_dollars
Price for the last traded YES contract on this market in dollars.
Definition models.hpp:1774
std::optional< std::string > primary_participant_key
Definition models.hpp:1825
FixedPointCount open_interest_fp
String representation of the number of contracts bought on this market disconsidering netting.
Definition models.hpp:1783
std::optional< double > floor_strike
Minimum expiration value that leads to a YES settlement.
Definition models.hpp:1811
std::optional< std::string > title
Definition models.hpp:1741
std::optional< RawJson > custom_strike
Expiration value for each target that leads to a YES settlement.
Definition models.hpp:1817
FixedPointDollars notional_value_dollars
The total value of a single contract at settlement in dollars.
Definition models.hpp:1785
std::string rules_primary
A plain language description of the most important market terms.
Definition models.hpp:1819
FixedPointDollars previous_yes_bid_dollars
Price for the highest YES buy offer on this market a day ago in dollars.
Definition models.hpp:1787
std::optional< FixedPointDollars > settlement_value_dollars
The settlement value of the YES/LONG side of the contract in dollars.
Definition models.hpp:1793
SettlementBoundsType settlement_bounds_type
Which settlement bounds apply to this market.
Definition models.hpp:1797
std::optional< std::string > occurrence_datetime
The recorded datetime when the underlying event occurred, if available.
Definition models.hpp:1803
std::optional< std::string > expected_expiration_time
Time when this market is expected to expire.
Definition models.hpp:1753
MarketResult result
Definition models.hpp:1779
std::string rules_secondary
A plain language description of secondary market terms.
Definition models.hpp:1821
FixedPointDollars no_bid_dollars
Price for the highest NO buy offer on this market in dollars.
Definition models.hpp:1770
std::string ticker
Definition models.hpp:1737
FixedPointCount yes_bid_size_fp
Total contract size of orders to buy YES at the best bid price (fixed-point count string).
Definition models.hpp:1764
std::string price_level_structure
Price level structure for this market, defining price ranges and tick sizes.
Definition models.hpp:1827
std::optional< double > cap_strike
Maximum expiration value that leads to a YES settlement.
Definition models.hpp:1813
FixedPointCount volume_fp
String representation of the market volume in contracts.
Definition models.hpp:1776
std::optional< std::string > early_close_condition
The condition under which the market can close early.
Definition models.hpp:1807
std::optional< std::vector< MveSelectedLeg > > mve_selected_legs
Definition models.hpp:1824
std::string close_time
Definition models.hpp:1751
std::optional< StrikeType > strike_type
Strike type defines how the market strike is defined and evaluated.
Definition models.hpp:1809
std::string latest_expiration_time
Latest possible time for this market to expire.
Definition models.hpp:1756
std::string expiration_value
The value that was considered for the settlement.
Definition models.hpp:1801
std::optional< FixedPointDollars > settlement_floor_dollars
The lowest value the YES/LONG side of the contract can settle at in dollars.
Definition models.hpp:1799
FixedPointDollars yes_bid_dollars
Price for the highest YES buy offer on this market in dollars.
Definition models.hpp:1762
std::string no_sub_title
Deprecated.
Definition models.hpp:1746
bool can_close_early
Definition models.hpp:1780
std::string created_time
Definition models.hpp:1747
std::optional< std::string > subtitle
Definition models.hpp:1742
std::optional< std::string > expiration_time
Definition models.hpp:1754
std::optional< std::string > mve_collection_ticker
The ticker of the multivariate event collection.
Definition models.hpp:1823
std::string updated_time
Time of the last non-trading metadata update.
Definition models.hpp:1749
std::string open_time
Definition models.hpp:1750
std::string yes_sub_title
Shortened title for the yes side of this market.
Definition models.hpp:1744
std::int64_t settlement_timer_seconds
The amount of time after determination that the market settles.
Definition models.hpp:1758
Definition models.hpp:2713
std::string title
Title of the milestone.
Definition models.hpp:2727
std::vector< std::string > primary_event_tickers
List of event tickers directly related to the outcome of this milestone.
Definition models.hpp:2737
std::optional< std::string > end_date
End date of the milestone, if any.
Definition models.hpp:2723
std::string start_date
Start date of the milestone.
Definition models.hpp:2721
std::string notification_message
Notification message for the milestone.
Definition models.hpp:2729
std::string last_updated_ts
Last time this structured target was updated.
Definition models.hpp:2739
std::vector< std::string > related_event_tickers
List of event tickers related to this milestone.
Definition models.hpp:2725
std::string id
Unique identifier for the milestone.
Definition models.hpp:2715
std::string category
Category of the milestone.
Definition models.hpp:2717
RawJson details
Additional details about the milestone.
Definition models.hpp:2735
std::optional< std::map< std::string, std::string > > source_ids
Source ids of milestone if available.
Definition models.hpp:2733
std::string type
Type of the milestone.
Definition models.hpp:2719
std::optional< std::string > source_id
Source id of milestone if available.
Definition models.hpp:2731
Definition models.hpp:3408
std::vector< std::string > associated_event_tickers
[DEPRECATED - Use associated_events instead] A list of events associated with the collection.
Definition models.hpp:3427
bool is_all_yes
[DEPRECATED - Use associated_events instead] Whether the collection requires that only the market sid...
Definition models.hpp:3435
std::string collection_ticker
Unique identifier for the collection.
Definition models.hpp:3410
std::optional< ExchangeIndex > exchange_index
Exchange index inherited from the collection's series.
Definition models.hpp:3414
std::int64_t size_min
The minimum number of markets that must be passed into Lookup/Create (inclusive).
Definition models.hpp:3437
std::string close_date
The close date of the collection.
Definition models.hpp:3422
std::string series_ticker
Series associated with the collection.
Definition models.hpp:3412
std::string open_date
The open date of the collection.
Definition models.hpp:3420
std::string price_level_structure
Price level structure used for new markets created in this collection.
Definition models.hpp:3443
std::string functional_description
A functional description of the collection describing how inputs affect the output.
Definition models.hpp:3441
std::vector< AssociatedEvent > associated_events
List of events with their individual configuration.
Definition models.hpp:3424
std::string title
Title of the collection.
Definition models.hpp:3416
std::int64_t size_max
The maximum number of markets that must be passed into Lookup/Create (inclusive).
Definition models.hpp:3439
std::vector< PriceRange > price_ranges
Price bands and tick sizes in fixed-point dollars for new markets created in this collection.
Definition models.hpp:3446
bool is_ordered
Whether the collection is ordered.
Definition models.hpp:3429
bool is_single_market_per_event
[DEPRECATED - Use associated_events instead] Whether the collection accepts multiple markets from the...
Definition models.hpp:3432
std::string description
Short description of the collection.
Definition models.hpp:3418
Definition models.hpp:1716
std::optional< std::string > market_ticker
Unique identifier for the selected market.
Definition models.hpp:1720
std::optional< FixedPointDollars > yes_settlement_value_dollars
The settlement value of the YES/LONG side of the contract in dollars.
Definition models.hpp:1724
std::optional< std::string > side
The side of the selected market.
Definition models.hpp:1722
std::optional< std::string > event_ticker
Unique identifier for the selected event.
Definition models.hpp:1718
Definition models.hpp:3521
std::optional< ExchangeIndex > exchange_index
Definition models.hpp:3529
std::string id
Unique identifier for the order group.
Definition models.hpp:3523
std::optional< FixedPointCount > contracts_limit_fp
String representation of the current maximum contracts allowed over a rolling 15-second window.
Definition models.hpp:3526
bool is_auto_cancel_enabled
Whether auto-cancel is enabled for this order group.
Definition models.hpp:3528
Definition models.hpp:3551
std::string market_ticker
The market ticker.
Definition models.hpp:3555
std::string order_id
The order ID.
Definition models.hpp:3553
FixedPointCount queue_position_fp
The number of preceding shares before the order in the queue.
Definition models.hpp:3557
Definition models.hpp:1147
FixedPointCount remaining_count_fp
String representation of the remaining contracts for this order.
Definition models.hpp:1170
FixedPointDollars maker_fees_dollars
Fees paid on filled maker contracts, in dollars.
Definition models.hpp:1180
std::optional< SelfTradePreventionType > self_trade_prevention_type
Definition models.hpp:1185
std::string ticker
Definition models.hpp:1152
FixedPointDollars taker_fees_dollars
Fees paid on filled taker contracts, in dollars.
Definition models.hpp:1178
std::optional< std::string > order_group_id
The order group this order is part of.
Definition models.hpp:1187
OutcomeSide outcome_side
The outcome side this order is positioned for.
Definition models.hpp:1158
FixedPointCount fill_count_fp
String representation of the number of contracts that have been filled.
Definition models.hpp:1168
FixedPointDollars no_price_dollars
The no price for this order in fixed-point dollars.
Definition models.hpp:1166
std::optional< std::string > created_time
Definition models.hpp:1182
std::string order_id
Definition models.hpp:1148
OrderStatus status
Definition models.hpp:1162
std::optional< Side > side
Deprecated.
Definition models.hpp:1154
std::string user_id
Unique identifier for users.
Definition models.hpp:1150
std::optional< Action > action
Deprecated.
Definition models.hpp:1156
std::optional< std::string > last_update_time
The last update to an order (modify, cancel, fill)
Definition models.hpp:1184
OrderType type
Definition models.hpp:1161
FixedPointDollars yes_price_dollars
The yes price for this order in fixed-point dollars.
Definition models.hpp:1164
std::optional< ExchangeIndex > exchange_index
Definition models.hpp:1193
std::string client_order_id
Definition models.hpp:1151
FixedPointDollars maker_fill_cost_dollars
The cost of filled maker orders in dollars.
Definition models.hpp:1176
std::optional< std::string > expiration_time
Definition models.hpp:1181
std::optional< bool > cancel_order_on_pause
If this flag is set to true, the order will be canceled if the order is open and trading on the excha...
Definition models.hpp:1190
BookSide book_side
Same directional bit as outcome_side in book vocabulary.
Definition models.hpp:1160
std::optional< std::int64_t > subaccount_number
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:1192
FixedPointDollars taker_fill_cost_dollars
The cost of filled taker orders in dollars.
Definition models.hpp:1174
FixedPointCount initial_count_fp
String representation of the initial size of the order (contract units)
Definition models.hpp:1172
Orderbook with fixed-point contract counts (fp) in all dollar price levels.
Definition models.hpp:3306
std::vector< PriceLevelDollarsCountFp > no_dollars
Definition models.hpp:3308
std::vector< PriceLevelDollarsCountFp > yes_dollars
Definition models.hpp:3307
Definition models.hpp:2418
std::string formatted_forecast
The human-readable formatted forecast value.
Definition models.hpp:2426
double numerical_forecast
The processed numerical forecast value.
Definition models.hpp:2424
std::int64_t percentile
The percentile value (0-9999).
Definition models.hpp:2420
double raw_numerical_forecast
The raw numerical forecast value.
Definition models.hpp:2422
Definition models.hpp:2933
std::optional< std::vector< RawJson > > events
Definition models.hpp:2934
Play-by-play data organized by period.
Definition models.hpp:2938
std::optional< std::vector< PlayByPlayPeriodsItem > > periods
Definition models.hpp:2939
Definition models.hpp:3145
std::optional< FixedPointDollars > mean
Volume-weighted average price during the candlestick period (in dollars).
Definition models.hpp:3155
std::optional< FixedPointDollars > previous
Close price from the previous candlestick period (in dollars).
Definition models.hpp:3157
std::optional< FixedPointDollars > low
Lowest trade price during the candlestick period (in dollars).
Definition models.hpp:3149
std::optional< FixedPointDollars > open
Price of the first trade during the candlestick period (in dollars).
Definition models.hpp:3147
std::optional< FixedPointDollars > high
Highest trade price during the candlestick period (in dollars).
Definition models.hpp:3151
std::optional< FixedPointDollars > close
Price of the last trade during the candlestick period (in dollars).
Definition models.hpp:3153
Definition models.hpp:1507
std::optional< FixedPointDollars > close_dollars
Last traded YES contract price on the market during the candlestick period (in dollars).
Definition models.hpp:1515
std::optional< FixedPointDollars > previous_dollars
Last traded YES contract price on the market before the candlestick period (in dollars).
Definition models.hpp:1519
std::optional< FixedPointDollars > high_dollars
Highest traded YES contract price on the market during the candlestick period (in dollars).
Definition models.hpp:1513
std::optional< FixedPointDollars > mean_dollars
Mean traded YES contract price on the market during the candlestick period (in dollars).
Definition models.hpp:1517
std::optional< FixedPointDollars > open_dollars
First traded YES contract price on the market during the candlestick period (in dollars).
Definition models.hpp:1509
std::optional< FixedPointDollars > low_dollars
Lowest traded YES contract price on the market during the candlestick period (in dollars).
Definition models.hpp:1511
std::optional< FixedPointDollars > min_dollars
Minimum close price of any market during the candlestick period (in dollars).
Definition models.hpp:1521
std::optional< FixedPointDollars > max_dollars
Maximum close price of any market during the candlestick period (in dollars).
Definition models.hpp:1523
Definition models.hpp:1727
std::string step
Price step/tick size for this range in dollars.
Definition models.hpp:1733
std::string end
Ending price for this range in dollars.
Definition models.hpp:1731
std::string start
Starting price for this range in dollars.
Definition models.hpp:1729
Definition models.hpp:4310
std::string market_ticker
The ticker of the market for this block trade.
Definition models.hpp:4325
Side maker_side
The maker side of the trade.
Definition models.hpp:4331
std::int64_t centicount
Number of contracts in centicounts.
Definition models.hpp:4329
std::string expiration_ts
Expiration time of the proposal.
Definition models.hpp:4333
std::optional< std::string > seller_subtrader_id
Subtrader ID of the seller.
Definition models.hpp:4320
std::optional< std::int64_t > buyer_subaccount
User-managed subaccount number of the buyer (0 for primary, 1-63 for numbered subaccounts).
Definition models.hpp:4316
std::string buyer_user_id
User ID of the buyer.
Definition models.hpp:4312
std::optional< std::int64_t > seller_subaccount
User-managed subaccount number of the seller (0 for primary, 1-63 for numbered subaccounts).
Definition models.hpp:4323
std::int64_t price_centi_cents
Price in centi-cents.
Definition models.hpp:4327
std::string seller_user_id
User ID of the seller.
Definition models.hpp:4318
std::optional< std::string > buyer_subtrader_id
Subtrader ID of the buyer.
Definition models.hpp:4314
Definition models.hpp:4336
std::string block_trade_proposal_id
The ID of the newly created block trade proposal.
Definition models.hpp:4338
Definition models.hpp:1027
FixedPointDollars yes_bid_dollars
Bid price for YES contracts, in dollars.
Definition models.hpp:1041
std::optional< std::string > creator_order_id
Order ID for the quote creator (private field)
Definition models.hpp:1079
std::optional< std::int64_t > creator_subaccount
Subaccount number of the quote creator (visible when the caller is the quote creator)
Definition models.hpp:1081
std::optional< std::string > accepted_ts
Timestamp when the quote was accepted.
Definition models.hpp:1053
std::optional< std::string > executed_ts
Timestamp when the quote was executed.
Definition models.hpp:1057
std::string rfq_id
UUID of the RFQ this quote is responding to.
Definition models.hpp:1031
std::string id
UUID of the quote.
Definition models.hpp:1029
std::optional< std::int64_t > rfq_creator_subaccount
Subaccount number of the RFQ creator (visible when the caller is the RFQ creator)
Definition models.hpp:1083
std::optional< std::string > creator_user_id
User ID of the quote creator (private field)
Definition models.hpp:1068
std::string market_ticker
The ticker of the market this quote is for.
Definition models.hpp:1037
std::optional< bool > rest_remainder
Whether to rest the remainder of the quote after execution.
Definition models.hpp:1061
FixedPointCount contracts_fp
String representation of the number of contracts in the quote.
Definition models.hpp:1039
std::optional< std::string > rfq_creator_user_id
User ID of the RFQ creator (private field)
Definition models.hpp:1070
std::optional< FixedPointCount > no_contracts_fp
Number of NO contracts offered in the quote (fixed-point)
Definition models.hpp:1087
std::string created_ts
Timestamp when the quote was created.
Definition models.hpp:1045
std::string rfq_creator_id
Public communications ID of the RFQ creator (pseudonymous).
Definition models.hpp:1035
std::optional< bool > target_cost_excludes_fees
True when the RFQ's target cost is principal-only and the contracts-offered sizes were computed witho...
Definition models.hpp:1075
std::optional< std::string > cancelled_ts
Timestamp when the quote was cancelled.
Definition models.hpp:1059
std::optional< FixedPointDollars > rfq_target_cost_dollars
Total value requested in the RFQ in dollars.
Definition models.hpp:1072
FixedPointDollars no_bid_dollars
Bid price for NO contracts, in dollars.
Definition models.hpp:1043
std::optional< std::string > confirmed_ts
Timestamp when the quote was confirmed.
Definition models.hpp:1055
std::optional< FixedPointCount > yes_contracts_fp
Number of YES contracts offered in the quote (fixed-point)
Definition models.hpp:1085
std::string updated_ts
Timestamp when the quote was last updated.
Definition models.hpp:1047
std::optional< std::string > rfq_creator_order_id
Order ID for the RFQ creator (private field)
Definition models.hpp:1077
QuoteStatus status
Current status of the quote.
Definition models.hpp:1049
std::string creator_id
Public communications ID of the quote creator.
Definition models.hpp:1033
std::optional< bool > post_only
Whether the quote creator's order is post-only (visible when the caller is the quote creator)
Definition models.hpp:1064
std::optional< Side > accepted_side
The side that was accepted (yes or no)
Definition models.hpp:1051
std::optional< std::string > cancellation_reason
Reason for quote cancellation if cancelled.
Definition models.hpp:1066
Definition models.hpp:1010
FixedPointDollars bid_dollars
The lowest bid you take on this child on the accepted side, normally the best bid you were shown.
Definition models.hpp:1015
std::string rfq_id
UUID of the child RFQ.
Definition models.hpp:1012
Definition models.hpp:3695
std::optional< FixedPointDollars > yes_bid_dollars
Best YES bid across makers, in dollars; absent when no maker bids YES.
Definition models.hpp:3701
std::string rfq_id
UUID of the child RFQ.
Definition models.hpp:3697
std::string market_ticker
The child's combo market.
Definition models.hpp:3699
std::optional< FixedPointCount > yes_contracts_offered_fp
Contracts the best YES bid offers.
Definition models.hpp:3705
std::optional< FixedPointCount > no_contracts_offered_fp
Contracts the best NO bid offers.
Definition models.hpp:3707
std::optional< FixedPointDollars > no_bid_dollars
Best NO bid across makers, in dollars; absent when no maker bids NO.
Definition models.hpp:3703
Definition models.hpp:3710
RFQBatchStatus status
Definition models.hpp:3713
std::int64_t version
Increases whenever a best bid changes.
Definition models.hpp:3715
std::string rfq_batch_id
UUID of the RFQ batch.
Definition models.hpp:3712
bool yes_complete
Whether every child has a YES bid, so the batch can be accepted on the yes side.
Definition models.hpp:3719
std::vector< RFQBatchBestQuote > rfqs
One entry per child RFQ, in batch order.
Definition models.hpp:3723
bool no_complete
Whether every child has a NO bid, so the batch can be accepted on the no side.
Definition models.hpp:3721
std::optional< std::string > updated_ts
When a best bid last changed.
Definition models.hpp:3717
Definition models.hpp:1947
FixedPointDollars no_bid
The bid price for NO contracts on this child, in dollars.
Definition models.hpp:1953
std::string rfq_id
UUID of the child RFQ to price.
Definition models.hpp:1949
FixedPointDollars yes_bid
The bid price for YES contracts on this child, in dollars.
Definition models.hpp:1951
One maker's quote on an RFQ batch.
Definition models.hpp:3731
std::optional< std::int64_t > rfq_creator_subaccount
Subaccount number of the RFQ batch creator (visible to the RFQ batch creator)
Definition models.hpp:3766
std::optional< std::string > rfq_creator_user_id
User ID of the RFQ batch creator (private field)
Definition models.hpp:3764
std::string creator_id
Public communications ID of the batch quote creator.
Definition models.hpp:3737
std::optional< std::string > accepted_ts
Timestamp when the batch quote was accepted.
Definition models.hpp:3748
std::string created_ts
Timestamp when the batch quote was created.
Definition models.hpp:3742
std::optional< bool > rest_remainder
Whether to rest the remainder of each child quote after execution (visible to the batch quote creator...
Definition models.hpp:3756
std::string updated_ts
Timestamp when the batch quote was last updated.
Definition models.hpp:3744
std::optional< Side > accepted_side
The side that was accepted on this maker's children (yes or no)
Definition models.hpp:3746
std::vector< Quote > quotes
One quote per child RFQ, or once accepted one per child this maker won; match them to children by rfq...
Definition models.hpp:3753
std::string rfq_batch_id
UUID of the RFQ batch this batch quote prices.
Definition models.hpp:3735
std::string rfq_creator_id
Public communications ID of the RFQ batch creator, obscured like Quote.rfq_creator_id.
Definition models.hpp:3739
RFQBatchQuoteStatus status
Definition models.hpp:3740
std::string id
UUID of the batch quote.
Definition models.hpp:3733
std::optional< std::int64_t > creator_subaccount
Subaccount number of the batch quote creator (visible to the batch quote creator)
Definition models.hpp:3762
std::optional< std::string > confirmed_ts
Timestamp when the batch quote was confirmed.
Definition models.hpp:3750
std::optional< bool > post_only
Whether the batch quote creator's orders are post-only (visible to the batch quote creator)
Definition models.hpp:3758
std::optional< std::string > creator_user_id
User ID of the batch quote creator (private field)
Definition models.hpp:3760
Definition models.hpp:2040
std::optional< std::string > updated_ts
Timestamp when the RFQ batch was last updated (visible to the batch creator)
Definition models.hpp:2056
std::optional< std::string > creator_user_id
User ID of the batch creator (private field)
Definition models.hpp:2062
std::optional< std::string > client_batch_id
The client_batch_id given at creation (visible to the batch creator)
Definition models.hpp:2060
std::optional< std::string > close_reason
Why the RFQ batch closed, for example executed, execution failed, or cancelled.
Definition models.hpp:2058
std::optional< std::string > accepted_ts
Timestamp when a batch quote on the batch was accepted.
Definition models.hpp:2050
RFQBatchStatus status
Definition models.hpp:2046
std::string creator_id
Public communications ID of the batch creator, obscured for other users like RFQ.creator_id when obsc...
Definition models.hpp:2045
std::optional< std::int64_t > creator_subaccount
Subaccount number of the batch creator (visible to the batch creator)
Definition models.hpp:2064
std::optional< std::string > closed_ts
Timestamp when the RFQ batch closed.
Definition models.hpp:2052
std::vector< RFQ > rfqs
The child RFQs, in the order they were requested.
Definition models.hpp:2054
std::string id
UUID of the RFQ batch.
Definition models.hpp:2042
std::string created_ts
Timestamp when the RFQ batch was created.
Definition models.hpp:2048
Definition models.hpp:2002
std::optional< std::string > creator_user_id
User ID of the RFQ creator (private field)
Definition models.hpp:2029
std::string created_ts
Timestamp when the RFQ was created.
Definition models.hpp:2019
std::string creator_id
Public communications ID of the RFQ creator (pseudonymous).
Definition models.hpp:2006
std::optional< std::string > cancellation_reason
Reason for RFQ cancellation if cancelled.
Definition models.hpp:2027
std::string id
UUID of the RFQ.
Definition models.hpp:2004
std::optional< bool > target_cost_excludes_fees
True when the target cost is principal-only and quote sizes are computed without reserving taker fees...
Definition models.hpp:2015
std::optional< std::int64_t > creator_subaccount
Subaccount number of the RFQ creator (visible when the caller is the RFQ creator)
Definition models.hpp:2031
std::optional< std::string > mve_collection_ticker
Ticker of the MVE collection this market belongs to.
Definition models.hpp:2021
FixedPointCount contracts_fp
String representation of the number of contracts requested in the RFQ.
Definition models.hpp:2010
std::optional< std::string > updated_ts
Timestamp when the RFQ was last updated.
Definition models.hpp:2035
std::optional< std::vector< MveSelectedLeg > > mve_selected_legs
Selected legs for the MVE collection.
Definition models.hpp:2023
RFQStatus status
Current status of the RFQ (open, closed)
Definition models.hpp:2017
std::optional< FixedPointDollars > target_cost_dollars
Total value of the RFQ in dollars.
Definition models.hpp:2012
std::optional< bool > rest_remainder
Whether to rest the remainder of the RFQ after execution.
Definition models.hpp:2025
std::optional< std::string > cancelled_ts
Timestamp when the RFQ was cancelled.
Definition models.hpp:2033
std::string market_ticker
The ticker of the market this RFQ is for.
Definition models.hpp:2008
std::optional< std::string > rfq_batch_id
Identifier of the RFQ batch this RFQ is a child of.
Definition models.hpp:2037
A JSON value kept as text, for free-form fields such as product metadata.
Definition raw_json.hpp:9
Query parameters for reset_order_group.
Definition models.hpp:4342
std::optional< ExchangeIndex > exchange_index
Identifier for an exchange shard.
Definition models.hpp:4346
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:4344
Definition models.hpp:2779
std::vector< WeeklySchedule > standard_hours
The standard operating hours of the exchange.
Definition models.hpp:2781
std::vector< MaintenanceWindow > maintenance_windows
Scheduled maintenance windows, during which the exchange may be unavailable.
Definition models.hpp:2783
Definition models.hpp:2914
std::vector< std::string > scopes
List of scopes.
Definition models.hpp:2916
Definition models.hpp:3835
FeeType fee_type
New fee type for the series.
Definition models.hpp:3841
std::string scheduled_ts
Timestamp when this fee change is scheduled to take effect.
Definition models.hpp:3845
std::string series_ticker
Series ticker this fee change applies to.
Definition models.hpp:3839
std::string id
Unique identifier for this fee change.
Definition models.hpp:3837
double fee_multiplier
New fee multiplier for the series.
Definition models.hpp:3843
Definition models.hpp:3864
std::string title
Title describing the series.
Definition models.hpp:3870
std::optional< std::string > last_updated_ts
Timestamp of when this series' metadata was last updated.
Definition models.hpp:3898
std::vector< std::string > categories
Categories is the list of discovery categories for this series.
Definition models.hpp:3874
std::string contract_terms_url
ContractTermsUrl is the URL to the current terms of the contract underlying the series.
Definition models.hpp:3885
std::optional< ExchangeIndex > exchange_index
Definition models.hpp:3899
std::string contract_url
ContractUrl provides a direct link to the original filing of the contract which underlies the series.
Definition models.hpp:3883
std::optional< std::vector< std::string > > tags
Tags specifies the subjects that this series relates to, multiple series from different categories ca...
Definition models.hpp:3877
std::string category
Category is the primary category of this series.
Definition models.hpp:3872
std::optional< FixedPointCount > volume_fp
String representation of the total number of contracts traded across all events in this series.
Definition models.hpp:3896
FeeType fee_type
FeeType is a string representing the series' fee structure.
Definition models.hpp:3889
std::string ticker
Ticker that identifies this series.
Definition models.hpp:3866
std::string frequency
Description of the frequency of the series.
Definition models.hpp:3868
std::optional< RawJson > product_metadata
Internal product metadata of the series.
Definition models.hpp:3887
std::optional< std::vector< std::string > > additional_prohibitions
AdditionalProhibitions is a list of additional trading prohibitions for this series.
Definition models.hpp:3893
std::optional< std::vector< SettlementSource > > settlement_sources
SettlementSources specifies the official sources used for the determination of markets within the ser...
Definition models.hpp:3880
double fee_multiplier
FeeMultiplier is a floating point multiplier applied to the fee calculations.
Definition models.hpp:3891
Query parameters for set_event_contract_exit_trigger.
Definition models.hpp:4350
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:4352
Replaces both legs, so a leg you omit is cleared.
Definition models.hpp:4356
std::optional< EventContractExitSlippage > slippage
Definition models.hpp:4357
std::optional< FixedPointDollars > stop_loss_price
Definition models.hpp:4359
std::optional< Kind > kind
Definition models.hpp:4358
std::optional< FixedPointDollars > take_profit_price
Definition models.hpp:4360
std::vector< TargetBalanceAllocationInput > allocations
Definition models.hpp:4371
std::optional< RestingMarginReservation > resting_margin_reservation
Defaults to sum when omitted.
Definition models.hpp:4373
Definition models.hpp:2227
std::optional< std::string > name
Name of the settlement source.
Definition models.hpp:2229
std::optional< std::string > url
URL to the settlement source.
Definition models.hpp:2231
Definition models.hpp:3934
FixedPointCount yes_count_fp
String representation of the number of YES contracts owned at the time of settlement.
Definition models.hpp:3943
ExchangeIndex exchange_index
Definition models.hpp:3937
FixedPointDollars no_total_cost_dollars
Total cost basis of all NO contracts in fixed-point dollars.
Definition models.hpp:3949
FixedPointDollars yes_total_cost_dollars
Total cost basis of all YES contracts in fixed-point dollars.
Definition models.hpp:3945
SettlementMarketResult market_result
The outcome of the market settlement.
Definition models.hpp:3941
std::optional< std::int64_t > value
Payout of a single yes contract in cents.
Definition models.hpp:3958
std::string ticker
The ticker symbol of the market that was settled.
Definition models.hpp:3936
FixedPointCount no_count_fp
String representation of the number of NO contracts owned at the time of settlement.
Definition models.hpp:3947
FixedPointDollars fee_cost
Total fees paid in fixed point dollars.
Definition models.hpp:3956
std::string settled_time
Timestamp when the market was settled and payouts were processed.
Definition models.hpp:3954
std::string event_ticker
The event ticker symbol of the market that was settled.
Definition models.hpp:3939
std::int64_t revenue
Total revenue earned from this settlement in cents (winning contracts pay out 100 cents each).
Definition models.hpp:3952
Definition models.hpp:2919
std::map< std::string, ScopeList > competitions
Mapping of competitions to their scope lists.
Definition models.hpp:2923
std::vector< std::string > scopes
List of scopes available for this sport.
Definition models.hpp:2921
Definition models.hpp:3966
std::optional< std::string > source_id
External source identifier for the structured target, if available (e.g., third-party data provider I...
Definition models.hpp:3977
std::optional< RawJson > details
Additional details about the structured target.
Definition models.hpp:3974
std::optional< std::string > type
Type of the structured target.
Definition models.hpp:3972
std::optional< std::map< std::string, std::string > > source_ids
Source ids of structured target if available.
Definition models.hpp:3979
std::optional< std::string > name
Name of the structured target.
Definition models.hpp:3970
std::optional< std::string > id
Unique identifier for the structured target.
Definition models.hpp:3968
std::optional< std::string > last_updated_ts
Timestamp when this structured target was last updated.
Definition models.hpp:3981
Definition models.hpp:4008
std::int64_t updated_ts
Unix timestamp of last balance update.
Definition models.hpp:4016
std::int64_t subaccount_number
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:4010
std::int64_t exchange_index
Exchange index the balance is held on.
Definition models.hpp:4012
FixedPointDollars balance
Balance in dollars.
Definition models.hpp:4014
Definition models.hpp:4023
bool enabled
Whether netting is enabled for this subaccount.
Definition models.hpp:4027
std::int64_t subaccount_number
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:4025
std::int64_t exchange_index
Exchange index of the subaccount.
Definition models.hpp:4029
Definition models.hpp:4044
std::int64_t amount_cents
Cash transfer amount in cents.
Definition models.hpp:4052
std::string transfer_id
Unique identifier for this transfer.
Definition models.hpp:4046
std::int64_t to_subaccount
Destination subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:4050
std::int64_t from_subaccount
Source subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:4048
std::int64_t exchange_index
Exchange index the transfer was applied on.
Definition models.hpp:4056
std::int64_t created_ts
Unix timestamp when the transfer was created.
Definition models.hpp:4054
Definition models.hpp:4363
std::int64_t exchange_index
Exchange index that receives this percentage of sweepable balance.
Definition models.hpp:4365
std::int64_t percent
Target percentage of sweepable balance for the exchange index.
Definition models.hpp:4367
Definition models.hpp:4070
std::int64_t percent
Target percentage of sweepable balance for the exchange index.
Definition models.hpp:4074
std::int64_t exchange_index
Exchange index that receives this percentage of sweepable balance.
Definition models.hpp:4072
Definition models.hpp:1700
std::string event_ticker
Event ticker identifier.
Definition models.hpp:1704
Side side
Side of the market (yes or no).
Definition models.hpp:1706
std::string market_ticker
Market ticker identifier.
Definition models.hpp:1702
Definition models.hpp:4114
bool is_block_trade
True if this trade was matched off-book as a block trade (e.g.
Definition models.hpp:4134
std::string ticker
Unique identifier for the market.
Definition models.hpp:4118
OutcomeSide taker_outcome_side
The outcome side the taker is positioned for.
Definition models.hpp:4128
FixedPointCount count_fp
String representation of the number of contracts bought or sold in this trade.
Definition models.hpp:4120
std::optional< Side > taker_side
Deprecated.
Definition models.hpp:4126
FixedPointDollars yes_price_dollars
Yes price for this trade in dollars.
Definition models.hpp:4122
std::string trade_id
Unique identifier for this trade.
Definition models.hpp:4116
FixedPointDollars no_price_dollars
No price for this trade in dollars.
Definition models.hpp:4124
BookSide taker_book_side
Same directional bit as taker_outcome_side in book vocabulary.
Definition models.hpp:4130
std::string created_time
Timestamp when this trade was executed.
Definition models.hpp:4132
Query parameters for trigger_order_group.
Definition models.hpp:4377
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:4379
std::optional< ExchangeIndex > exchange_index
Identifier for an exchange shard.
Definition models.hpp:4381
FixedPointDollars limit
Definition models.hpp:4387
std::string subtrader_id
The subtrader whose daily cap should be set.
Definition models.hpp:4386
std::string category
A single event category to add to or remove from the blocked set, 1-100 characters (e....
Definition models.hpp:4394
std::string subtrader_id
The subtrader whose blocked categories should be updated.
Definition models.hpp:4392
bool blocked
True adds the category to the blocked set; false removes it.
Definition models.hpp:4396
std::vector< std::string > categories
The subtrader's full resulting blocked set, sorted ascending.
Definition models.hpp:4401
Query parameters for update_order_group_limit.
Definition models.hpp:4405
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:4407
std::optional< ExchangeIndex > exchange_index
Identifier for an exchange shard.
Definition models.hpp:4409
Definition models.hpp:4412
std::optional< FixedPointCount > contracts_limit_fp
String representation of the new maximum number of contracts that can be matched within this group ov...
Definition models.hpp:4418
std::optional< std::int64_t > contracts_limit
New maximum number of contracts that can be matched within this group over a rolling 15-second window...
Definition models.hpp:4415
Definition models.hpp:4421
std::int64_t subaccount_number
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:4423
bool enabled
Whether netting is enabled for this subaccount.
Definition models.hpp:4425
Definition models.hpp:4147
std::optional< std::string > update_note
Weekly-calibration disposition, present only on weekly calibration records: updated ....
Definition models.hpp:4157
double offset_c
Station offset in Celsius (positive = station normally runs warmer than its peers).
Definition models.hpp:4153
std::string station_id
Member station ID (e.g.
Definition models.hpp:4149
double weight
Base weight (weights sum to 1.0 across members).
Definition models.hpp:4151
Definition models.hpp:4160
std::optional< std::int64_t > calibration_window_end_ms
End of the calibration window (exclusive).
Definition models.hpp:4173
std::string config_version
Configuration version (e.g.
Definition models.hpp:4162
std::vector< WeatherIndexCalibrationStation > stations
Configured member stations, in configuration order.
Definition models.hpp:4178
std::optional< std::int64_t > published_at_ms
When the record was published, unix milliseconds UTC.
Definition models.hpp:4164
std::optional< std::string > change_reason
Why the configuration changed.
Definition models.hpp:4169
std::optional< std::int64_t > calibration_window_start_ms
Start of the trailing observation window the offsets were estimated from.
Definition models.hpp:4171
double city_reference_c
City reference B_c in Celsius: the weight-dot-offset sum over all configured member stations.
Definition models.hpp:4176
std::int64_t effective_at_ms
The record governs event minutes at or after this time (unix milliseconds UTC), until superseded by t...
Definition models.hpp:4167
Definition models.hpp:4223
std::string status
normal (every member contributed its exact-minute primary observation) or degraded (a member was abse...
Definition models.hpp:4231
std::int64_t t
Event minute, unix milliseconds UTC.
Definition models.hpp:4225
std::optional< std::int64_t > contributors
Number of accepted member stations backing the point.
Definition models.hpp:4233
std::optional< std::string > receipt_basis
Present only on points produced by the labelled historical backfill that seeds a city's series for th...
Definition models.hpp:4236
std::optional< double > v
Published index value, Fahrenheit rounded to 0.01.
Definition models.hpp:4227
std::optional< std::vector< WeatherIndexStationReading > > stations
Per-station audit readings (only with detailed=true), sorted by station ID — every configured member'...
Definition models.hpp:4239
Definition models.hpp:4203
std::string code
Disposition: ok (accepted), missing (no eligible observation), late (received after the deadline; dia...
Definition models.hpp:4209
std::optional< std::string > primary_code
Why the primary observation was passed over when a fallback was selected instead.
Definition models.hpp:4220
std::optional< std::string > source
hf_asos (exact-minute primary) or metar (carried-forward official observation).
Definition models.hpp:4211
std::string station_id
Member station (e.g.
Definition models.hpp:4205
std::optional< double > temp_f
Raw reported temperature in Fahrenheit (unrounded — only the published index value carries output rou...
Definition models.hpp:4214
std::optional< std::int64_t > received_at_ms
Local wire-receipt time backing the eligibility deadline.
Definition models.hpp:4218
std::optional< std::int64_t > obs_time_ms
Observation time for carried-forward fallbacks (differs from the event minute).
Definition models.hpp:4216
Definition models.hpp:2751
std::vector< DailySchedule > sunday
Trading hours for Sunday.
Definition models.hpp:2769
std::vector< DailySchedule > tuesday
Trading hours for Tuesday.
Definition models.hpp:2759
std::vector< DailySchedule > thursday
Trading hours for Thursday.
Definition models.hpp:2763
std::string start_time
Start date and time for when this weekly schedule is effective.
Definition models.hpp:2753
std::vector< DailySchedule > saturday
Trading hours for Saturday.
Definition models.hpp:2767
std::vector< DailySchedule > friday
Trading hours for Friday.
Definition models.hpp:2765
std::vector< DailySchedule > monday
Trading hours for Monday.
Definition models.hpp:2757
std::vector< DailySchedule > wednesday
Trading hours for Wednesday.
Definition models.hpp:2761
std::string end_time
End date and time for when this weekly schedule is no longer effective.
Definition models.hpp:2755
Definition models.hpp:4260
std::string id
Unique identifier for the withdrawal.
Definition models.hpp:4262
std::optional< std::int64_t > finalized_ts
Unix timestamp of when the withdrawal was finalized (applied, failed, or returned).
Definition models.hpp:4274
std::int64_t fee_cents
Fee charged for the withdrawal in cents.
Definition models.hpp:4270
DepositType type
Payment type used for the withdrawal.
Definition models.hpp:4266
std::int64_t created_ts
Unix timestamp of when the withdrawal was created.
Definition models.hpp:4272
DepositStatus status
Current status of the withdrawal.
Definition models.hpp:4264
std::int64_t amount_cents
Withdrawal amount in cents.
Definition models.hpp:4268