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";
191 return "event_contract";
214 return "quadratic_with_maker_fees";
216 return "quadratic_with_combo_maker_fees";
313 return "margin_maker_volume";
315 return "margin_taker_volume";
377[[nodiscard]]
constexpr std::string_view
408 return "margin_maker_volume";
410 return "margin_taker_volume";
424[[nodiscard]]
constexpr std::string_view
477 return "initialized";
655 return "taker_at_cross";
709enum class Side : std::uint8_t {
745 return "greater_or_equal";
749 return "less_or_equal";
775 return "fill_or_kill";
777 return "good_till_canceled";
779 return "immediate_or_cancel";
828 std::vector<AccountApiUsageLevelVolumeGoal>
goals;
1041 std::optional<std::vector<std::string>>
ids;
1043 std::optional<std::vector<BatchCancelOrdersRequestOrder>>
orders;
1047 std::vector<BatchCancelOrdersIndividualResponse>
orders;
1064 std::vector<BatchCancelOrdersV2RequestOrdersItem>
orders;
1080 std::vector<BatchCancelOrdersV2ResponseOrdersItem>
orders;
1131 std::vector<BatchCreateOrdersIndividualResponse>
orders;
1182 std::vector<BatchCreateOrdersV2ResponseOrdersItem>
orders;
1357 std::optional<std::vector<ApiKeyScope>>
scopes;
1703 std::optional<std::string>
url;
1887 std::optional<std::int64_t>
ts;
1917 std::optional<std::vector<ApiKeyScope>>
scopes;
2379 std::optional<std::vector<PlayByPlayPeriodsItem>>
periods;
2383 std::optional<PlayByPlay>
pbp;
2446 std::optional<GetIncentiveProgramsStatus>
status;
2448 std::optional<GetIncentiveProgramsType>
type;
2585 std::optional<FixedPointDollars>
open;
2587 std::optional<FixedPointDollars>
low;
2589 std::optional<FixedPointDollars>
high;
2593 std::optional<FixedPointDollars>
mean;
2798 std::optional<GetMultivariateEventCollectionsStatus>
status;
3207 std::optional<std::vector<std::string>>
tags;
3298 std::optional<std::string>
id;
3526 std::optional<std::int64_t>
to;
3557 std::optional<double>
v;
3569 std::optional<std::vector<WeatherIndexStationReading>>
stations;
OrderType
Definition models.hpp:539
@ Unknown
A value this SDK version does not know.
GetEventsStatus
Filter by event status.
Definition models.hpp:226
@ Unknown
A value this SDK version does not know.
MarketType
Identifies the type of market.
Definition models.hpp:499
@ Unknown
A value this SDK version does not know.
RestingMarginReservation
Collateral an automatic rebalance leaves behind for resting orders.
Definition models.hpp:624
@ Unknown
A value this SDK version does not know.
MarketResult
Definition models.hpp:437
@ Unknown
A value this SDK version does not know.
GetMarketsMveFilter
Filter by multivariate events (combos).
Definition models.hpp:323
@ Unknown
A value this SDK version does not know.
ExchangeInstance
The exchange instance type.
Definition models.hpp:182
@ EventContract
event_contract
@ Unknown
A value this SDK version does not know.
Side
Deprecated.
Definition models.hpp:709
@ Unknown
A value this SDK version does not know.
constexpr std::string_view to_string(HttpMethod method) noexcept
Definition http_client.hpp:22
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:267
@ Unknown
A value this SDK version does not know.
SelfTradePreventionType
The self-trade prevention type for orders.
Definition models.hpp:646
@ TakerAtCross
taker_at_cross
@ Unknown
A value this SDK version does not know.
MarketStatus
The current status of the market in its lifecycle.
Definition models.hpp:462
@ Unknown
A value this SDK version does not know.
GetMultivariateEventCollectionsStatus
Only return collections of a certain status.
Definition models.hpp:370
@ Unknown
A value this SDK version does not know.
SettlementStatus
Settlement status of the markets to return.
Definition models.hpp:687
@ Unknown
A value this SDK version does not know.
GetIncentiveProgramsType
Type filter.
Definition models.hpp:295
@ 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:787
@ Unknown
A value this SDK version does not know.
DepositType
Payment method used for the deposit.
Definition models.hpp:154
@ Unknown
A value this SDK version does not know.
FeeType
Fee type for a series or scheduled fee override.
Definition models.hpp:201
@ QuadraticWithComboMakerFees
quadratic_with_combo_maker_fees
@ QuadraticWithMakerFees
quadratic_with_maker_fees
@ Unknown
A value this SDK version does not know.
RFQStatus
Current status of the RFQ (open, closed)
Definition models.hpp:605
@ Unknown
A value this SDK version does not know.
SettlementMarketResult
The outcome of the market settlement.
Definition models.hpp:665
@ 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:342
@ Unknown
A value this SDK version does not know.
DepositStatus
Current status of the deposit.
Definition models.hpp:129
@ Unknown
A value this SDK version does not know.
StrikeType
Strike type defines how the market strike is defined and evaluated.
Definition models.hpp:728
@ GreaterOrEqual
greater_or_equal
@ Unknown
A value this SDK version does not know.
@ LessOrEqual
less_or_equal
GetHistoricalMarketsMveFilter
Filter by multivariate events (combos).
Definition models.hpp:251
@ 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
@ ReadBlockTradeAccept
read::block_trade_accept
@ Unknown
A value this SDK version does not know.
@ WriteBlockTradeAccept
write::block_trade_accept
@ ReadPortfolioBalance
read::portfolio_balance
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:577
@ Unknown
A value this SDK version does not know.
IncentiveProgramIncentiveType
Type of incentive program.
Definition models.hpp:393
@ 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:518
@ 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
std::string FixedPointDollars
Fixed-point US dollar string.
Definition models.hpp:26
IntraExchangeInstanceTransferStatus
Transfer status.
Definition models.hpp:418
@ Unknown
A value this SDK version does not know.
std::int64_t ExchangeIndex
Identifier for an exchange shard.
Definition models.hpp:19
OutcomeSide
Outcome side.
Definition models.hpp:558
@ Unknown
A value this SDK version does not know.
TimeInForce
Specifies how long the order remains active.
Definition models.hpp:765
@ GoodTillCanceled
good_till_canceled
@ Unknown
A value this SDK version does not know.
@ ImmediateOrCancel
immediate_or_cancel
Definition models.hpp:804
std::optional< std::int64_t > subaccount
User-managed subaccount number to accept as (0 for primary, 1-63 for numbered subaccounts).
Definition models.hpp:808
std::optional< std::string > subtrader_id
Subtrader ID to accept as.
Definition models.hpp:806
Definition models.hpp:811
Side accepted_side
The side of the quote to accept (yes or no)
Definition models.hpp:813
Definition models.hpp:816
FixedPointCount keep_volume_goal_fp
Definition models.hpp:820
std::string level
API usage level for this Predictions volume goal.
Definition models.hpp:818
FixedPointCount earn_volume_goal_fp
Definition models.hpp:819
Definition models.hpp:823
std::int64_t computed_ts
Unix timestamp (seconds) when this progress was computed; trailing_30d_volume_fp covers the trailing ...
Definition models.hpp:826
std::vector< AccountApiUsageLevelVolumeGoal > goals
Definition models.hpp:828
FixedPointCount trailing_30d_volume_fp
Definition models.hpp:827
Query parameters for amend_order.
Definition models.hpp:832
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:834
Definition models.hpp:837
std::optional< FixedPointDollars > yes_price_dollars
Updated yes price for the order in fixed-point dollars.
Definition models.hpp:855
std::optional< std::int64_t > subaccount
Optional subaccount number to use for this amendment (0 for primary, 1-63 for subaccounts)
Definition models.hpp:839
std::optional< std::int64_t > count
Updated quantity for the order (whole contracts only).
Definition models.hpp:859
Side side
Side of the order.
Definition models.hpp:843
std::optional< std::string > client_order_id
The original client-specified order ID to be amended.
Definition models.hpp:847
std::optional< ExchangeIndex > exchange_index
Exchange shard index.
Definition models.hpp:863
std::optional< std::string > updated_client_order_id
The new client-specified order ID after amendment.
Definition models.hpp:849
std::optional< std::int64_t > yes_price
Updated yes price for the order in cents.
Definition models.hpp:851
std::string ticker
Market ticker.
Definition models.hpp:841
std::optional< std::int64_t > no_price
Updated no price for the order in cents.
Definition models.hpp:853
std::optional< FixedPointDollars > no_price_dollars
Updated no price for the order in fixed-point dollars.
Definition models.hpp:857
Action action
Action of the order.
Definition models.hpp:845
std::optional< FixedPointCount > count_fp
String representation of the updated quantity for the order.
Definition models.hpp:861
Definition models.hpp:915
Order old_order
The order before amendment.
Definition models.hpp:917
Order order
The order after amendment.
Definition models.hpp:919
Definition models.hpp:922
std::string ticker
Market ticker.
Definition models.hpp:924
FixedPointCount count
Updated total/max fillable count for the order.
Definition models.hpp:930
std::optional< std::string > client_order_id
The original client-specified order ID to be amended.
Definition models.hpp:932
FixedPointDollars price
Updated price for the order in fixed-point dollars.
Definition models.hpp:928
std::optional< ExchangeIndex > exchange_index
Exchange shard index.
Definition models.hpp:936
BookSide side
Side of the order.
Definition models.hpp:926
std::optional< std::string > updated_client_order_id
The new client-specified order ID after amendment.
Definition models.hpp:934
Definition models.hpp:939
std::string order_id
Definition models.hpp:940
std::optional< std::string > client_order_id
Definition models.hpp:941
std::optional< FixedPointDollars > average_fee_paid
Volume-weighted average fee paid per contract for fills resulting from the amend.
Definition models.hpp:949
std::optional< FixedPointCount > fill_count
Number of contracts filled as a result of the amend crossing the book.
Definition models.hpp:945
std::optional< FixedPointDollars > average_fill_price
Volume-weighted average fill price for fills resulting from the amend.
Definition models.hpp:947
std::int64_t ts_ms
Matching engine timestamp at which the amend was processed, as Unix epoch milliseconds.
Definition models.hpp:951
std::optional< FixedPointCount > remaining_count
Number of resting contracts remaining after the amend.
Definition models.hpp:943
Definition models.hpp:954
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:963
std::vector< ApiKeyScope > scopes
List of scopes granted to this API key.
Definition models.hpp:960
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:967
std::string api_key_id
Unique identifier for the API key.
Definition models.hpp:956
std::string name
User-provided name for the API key.
Definition models.hpp:958
Definition models.hpp:970
std::optional< std::int64_t > expires_ts
Unix timestamp (seconds) when the grant expires.
Definition models.hpp:976
std::string level
API usage level this grant confers (for example, expert, premier, paragon, prime, or prestige).
Definition models.hpp:974
ExchangeInstance exchange_instance
Definition models.hpp:971
std::string source
How the grant was created: "volume" (earned from trading volume) or "manual" (assigned by Kalshi).
Definition models.hpp:979
Definition models.hpp:982
std::string client_transfer_id
Unique client-provided transfer ID for idempotency.
Definition models.hpp:984
std::int64_t from_subaccount
Source subaccount number (0 for primary, 1-63 for numbered subaccounts).
Definition models.hpp:986
std::optional< ExchangeIndex > exchange_index
Identifier for an exchange shard.
Definition models.hpp:992
std::int64_t to_subaccount
Destination subaccount number (0 for primary, 1-63 for numbered subaccounts).
Definition models.hpp:988
std::int64_t amount_cents
Amount to transfer in cents.
Definition models.hpp:990
Definition models.hpp:995
std::optional< std::int64_t > size_max
Maximum number of markets from this event (inclusive).
Definition models.hpp:1001
std::string ticker
The event ticker.
Definition models.hpp:997
std::optional< std::int64_t > size_min
Minimum number of markets from this event (inclusive).
Definition models.hpp:1003
std::vector< std::string > active_quoters
List of active quoters for this event.
Definition models.hpp:1005
bool is_yes_only
Whether only the 'yes' side can be used for this event.
Definition models.hpp:999
Definition models.hpp:1017
std::string order_id
The order ID to identify which order had an error during batch cancellation.
Definition models.hpp:1019
FixedPointCount reduced_by_fp
String representation of the number of contracts that were successfully canceled from this order.
Definition models.hpp:1023
std::optional< Order > order
Definition models.hpp:1020
std::optional< ErrorResponse > error
Definition models.hpp:1024
Definition models.hpp:1027
std::optional< std::int64_t > subaccount
Optional subaccount number to use for this cancellation (0 for primary, 1-63 for subaccounts)
Definition models.hpp:1032
std::string order_id
Order ID to cancel.
Definition models.hpp:1029
std::optional< std::string > market_ticker
Market ticker.
Definition models.hpp:1036
std::optional< ExchangeIndex > exchange_index
Exchange shard index.
Definition models.hpp:1034
Definition models.hpp:1039
std::optional< std::vector< BatchCancelOrdersRequestOrder > > orders
An array of orders to cancel, each optionally specifying a subaccount.
Definition models.hpp:1043
std::optional< std::vector< std::string > > ids
An array of order IDs to cancel.
Definition models.hpp:1041
Definition models.hpp:1046
std::vector< BatchCancelOrdersIndividualResponse > orders
Definition models.hpp:1047
Definition models.hpp:1050
std::optional< std::int64_t > subaccount
Optional subaccount number to use for this cancellation (0 for primary, 1-63 for subaccounts).
Definition models.hpp:1055
std::string order_id
Order ID to cancel.
Definition models.hpp:1052
std::optional< std::string > market_ticker
Market ticker.
Definition models.hpp:1059
std::optional< ExchangeIndex > exchange_index
Exchange shard index.
Definition models.hpp:1057
Definition models.hpp:1062
std::vector< BatchCancelOrdersV2RequestOrdersItem > orders
An array of orders to cancel, each optionally specifying a subaccount.
Definition models.hpp:1064
Definition models.hpp:1067
std::string order_id
The order ID identifying which order this entry corresponds to.
Definition models.hpp:1069
FixedPointCount reduced_by
Number of contracts that were canceled (i.e.
Definition models.hpp:1072
std::optional< std::int64_t > ts_ms
Matching engine timestamp at which the cancellation was processed, as Unix epoch milliseconds.
Definition models.hpp:1075
std::optional< std::string > client_order_id
Definition models.hpp:1070
std::optional< ErrorResponse > error
Definition models.hpp:1076
Definition models.hpp:1079
std::vector< BatchCancelOrdersV2ResponseOrdersItem > orders
Definition models.hpp:1080
Definition models.hpp:1083
std::optional< ErrorResponse > error
Definition models.hpp:1086
std::optional< std::string > client_order_id
Definition models.hpp:1084
std::optional< Order > order
Definition models.hpp:1085
Definition models.hpp:1126
std::vector< CreateOrderRequest > orders
Definition models.hpp:1127
Definition models.hpp:1130
std::vector< BatchCreateOrdersIndividualResponse > orders
Definition models.hpp:1131
Definition models.hpp:1161
std::vector< CreateOrderV2Request > orders
Definition models.hpp:1162
Definition models.hpp:1165
std::optional< FixedPointCount > fill_count
Number of contracts filled immediately upon placement.
Definition models.hpp:1169
std::optional< std::string > client_order_id
Definition models.hpp:1167
std::optional< FixedPointDollars > average_fee_paid
Volume-weighted average fee paid per contract.
Definition models.hpp:1175
std::optional< std::string > order_id
Definition models.hpp:1166
std::optional< FixedPointCount > remaining_count
Number of contracts remaining after placement.
Definition models.hpp:1171
std::optional< FixedPointDollars > average_fill_price
Volume-weighted average fill price.
Definition models.hpp:1173
std::optional< std::int64_t > ts_ms
Matching engine timestamp at which the order was processed, as Unix epoch milliseconds.
Definition models.hpp:1177
std::optional< ErrorResponse > error
Definition models.hpp:1178
Definition models.hpp:1181
std::vector< BatchCreateOrdersV2ResponseOrdersItem > orders
Definition models.hpp:1182
Query parameters for batch_get_market_candlesticks.
Definition models.hpp:1186
std::int64_t start_ts
Start timestamp in Unix seconds.
Definition models.hpp:1190
std::int64_t period_interval
Candlestick period interval in minutes.
Definition models.hpp:1194
std::string market_tickers
Comma-separated list of market tickers (maximum 100)
Definition models.hpp:1188
std::optional< bool > include_latest_before_start
If true, prepends the latest candlestick available before the start_ts.
Definition models.hpp:1196
std::int64_t end_ts
End timestamp in Unix seconds.
Definition models.hpp:1192
Definition models.hpp:1256
std::vector< MarketCandlesticksResponse > markets
Array of market candlestick data, one entry per requested market.
Definition models.hpp:1258
Definition models.hpp:1261
FixedPointDollars high
Highest offer price on the market during the candlestick period (in dollars).
Definition models.hpp:1267
FixedPointDollars open
Offer price on the market at the start of the candlestick period (in dollars).
Definition models.hpp:1263
FixedPointDollars close
Offer price on the market at the end of the candlestick period (in dollars).
Definition models.hpp:1269
FixedPointDollars low
Lowest offer price on the market during the candlestick period (in dollars).
Definition models.hpp:1265
Definition models.hpp:1199
FixedPointDollars open_dollars
Offer price on the market at the start of the candlestick period (in dollars).
Definition models.hpp:1201
FixedPointDollars high_dollars
Highest offer price on the market during the candlestick period (in dollars).
Definition models.hpp:1205
FixedPointDollars close_dollars
Offer price on the market at the end of the candlestick period (in dollars).
Definition models.hpp:1207
FixedPointDollars low_dollars
Lowest offer price on the market during the candlestick period (in dollars).
Definition models.hpp:1203
Definition models.hpp:1272
std::string id
Unique identifier for the block trade proposal.
Definition models.hpp:1274
std::optional< std::string > buyer_subtrader_id
Subtrader ID of the buyer.
Definition models.hpp:1280
std::optional< std::string > seller_order_id
Order ID for the seller after the proposal is executed.
Definition models.hpp:1314
std::string market_ticker
The ticker of the market for this block trade.
Definition models.hpp:1286
std::optional< std::string > seller_subtrader_id
Subtrader ID of the seller.
Definition models.hpp:1284
bool buyer_accepted
Whether the buyer has accepted the proposal.
Definition models.hpp:1302
std::string status
Current status of the proposal.
Definition models.hpp:1296
std::int64_t centicount
Number of contracts in centicounts.
Definition models.hpp:1290
std::string proposer_user_id
User ID of the proposal creator.
Definition models.hpp:1276
std::optional< std::string > executed_ts
Timestamp when the proposal was executed.
Definition models.hpp:1310
std::optional< std::string > buyer_accepted_ts
Timestamp when the buyer accepted.
Definition models.hpp:1306
std::int64_t price_centi_cents
Price in centi-cents.
Definition models.hpp:1288
std::string seller_user_id
User ID of the seller.
Definition models.hpp:1282
std::optional< std::string > seller_accepted_ts
Timestamp when the seller accepted.
Definition models.hpp:1308
std::optional< std::string > buyer_order_id
Order ID for the buyer after the proposal is executed.
Definition models.hpp:1312
bool seller_accepted
Whether the seller has accepted the proposal.
Definition models.hpp:1304
std::string expiration_ts
Expiration time of the proposal.
Definition models.hpp:1294
std::string created_ts
Timestamp when the proposal was created.
Definition models.hpp:1298
std::string buyer_user_id
User ID of the buyer.
Definition models.hpp:1278
Side maker_side
The maker side of the trade.
Definition models.hpp:1292
std::string updated_ts
Timestamp when the proposal was last updated.
Definition models.hpp:1300
Token-bucket budget for one rate-limit bucket.
Definition models.hpp:1318
std::int64_t bucket_capacity
Maximum tokens the bucket can hold.
Definition models.hpp:1322
std::int64_t refill_rate
Tokens added to the bucket per second.
Definition models.hpp:1320
Query parameters for cancel_all_orders.
Definition models.hpp:1326
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:1328
Query parameters for cancel_order.
Definition models.hpp:1332
std::optional< std::string > market_ticker
Market ticker.
Definition models.hpp:1338
std::optional< ExchangeIndex > exchange_index
Exchange shard index.
Definition models.hpp:1336
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:1334
Definition models.hpp:1341
std::int64_t ts_ms
Matching engine timestamp at which the cancellation was processed, as Unix epoch milliseconds.
Definition models.hpp:1348
std::optional< std::string > client_order_id
Definition models.hpp:1343
std::string order_id
Definition models.hpp:1342
FixedPointCount reduced_by
Number of contracts that were canceled (i.e.
Definition models.hpp:1345
Definition models.hpp:1351
std::optional< std::string > fcm_subtrader_id
FCM members only.
Definition models.hpp:1361
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:1359
std::optional< std::vector< ApiKeyScope > > scopes
List of scopes to grant to the API key.
Definition models.hpp:1357
std::string public_key
RSA or Ed25519 public key in PEM format (-----BEGIN PUBLIC KEY-----).
Definition models.hpp:1355
std::string name
Name for the API key.
Definition models.hpp:1353
Definition models.hpp:1364
std::string api_key_id
Unique identifier for the newly created API key.
Definition models.hpp:1366
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:1370
Definition models.hpp:1373
std::string subtrader_suffix
Suffix for the new subtrader, 1-16 case-sensitive ASCII alphanumeric characters ([A-Za-z0-9]).
Definition models.hpp:1376
Definition models.hpp:1379
std::string subtrader_id
The full id of the created subtrader.
Definition models.hpp:1381
Definition models.hpp:1393
std::vector< TickerPair > selected_markets
List of selected markets that act as parameters to determine which market is created.
Definition models.hpp:1395
std::optional< bool > with_market_payload
Whether to include the market payload in the response.
Definition models.hpp:1397
Definition models.hpp:1515
std::string market_ticker
Market ticker for the created market.
Definition models.hpp:1519
std::string event_ticker
Event ticker for the created market.
Definition models.hpp:1517
std::optional< Market > market
Market payload of the created market.
Definition models.hpp:1521
Definition models.hpp:1524
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:1527
std::optional< ExchangeIndex > exchange_index
Identifier for an exchange shard.
Definition models.hpp:1535
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:1533
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:1530
Definition models.hpp:1538
std::int64_t subaccount
Subaccount number that owns the created order group (0 for primary, 1-63 for subaccounts).
Definition models.hpp:1542
std::string order_group_id
The unique identifier for the created order group.
Definition models.hpp:1540
std::optional< ExchangeIndex > exchange_index
Definition models.hpp:1543
Definition models.hpp:1089
std::optional< bool > reduce_only
Definition models.hpp:1111
std::optional< std::int64_t > subaccount
The subaccount number to use for this order.
Definition models.hpp:1121
std::optional< FixedPointDollars > yes_price_dollars
Submitting price of the Yes side in fixed-point dollars.
Definition models.hpp:1101
std::optional< std::string > client_order_id
Definition models.hpp:1091
std::optional< SelfTradePreventionType > self_trade_prevention_type
Definition models.hpp:1114
Action action
Definition models.hpp:1093
std::string ticker
Definition models.hpp:1090
std::optional< std::int64_t > buy_max_cost
Maximum cost in cents.
Definition models.hpp:1109
std::optional< TimeInForce > time_in_force
Specifies how long the order remains active.
Definition models.hpp:1107
std::optional< bool > post_only
Definition models.hpp:1110
std::optional< std::int64_t > sell_position_floor
Deprecated: Use reduce_only instead.
Definition models.hpp:1113
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:1119
std::optional< std::int64_t > yes_price
Definition models.hpp:1098
std::optional< std::string > order_group_id
The order group this order is part of.
Definition models.hpp:1116
std::optional< FixedPointCount > count_fp
String representation of the order quantity in contracts.
Definition models.hpp:1097
std::optional< ExchangeIndex > exchange_index
Exchange shard index.
Definition models.hpp:1123
std::optional< std::int64_t > count
Order quantity in contracts (whole contracts only).
Definition models.hpp:1095
std::optional< FixedPointDollars > no_price_dollars
Submitting price of the No side in fixed-point dollars.
Definition models.hpp:1103
Side side
Definition models.hpp:1092
std::optional< std::int64_t > expiration_ts
Optional Unix timestamp in seconds for when the order expires.
Definition models.hpp:1105
std::optional< std::int64_t > no_price
Definition models.hpp:1099
Definition models.hpp:1546
Order order
Definition models.hpp:1547
Definition models.hpp:1134
FixedPointCount count
String representation of the order quantity in contracts.
Definition models.hpp:1139
SelfTradePreventionType self_trade_prevention_type
Definition models.hpp:1147
std::optional< ExchangeIndex > exchange_index
Exchange shard index.
Definition models.hpp:1158
FixedPointDollars price
Price for the order in fixed-point dollars.
Definition models.hpp:1141
std::string ticker
Definition models.hpp:1135
std::optional< std::string > client_order_id
Definition models.hpp:1136
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:1150
std::optional< bool > reduce_only
Specifies whether the order place count should be capped by the member's current position.
Definition models.hpp:1152
TimeInForce time_in_force
Specifies how long the order remains active.
Definition models.hpp:1145
BookSide side
Definition models.hpp:1137
std::optional< std::int64_t > expiration_time
Optional Unix timestamp in seconds for when the order expires.
Definition models.hpp:1143
std::optional< std::string > order_group_id
The order group this order is part of.
Definition models.hpp:1156
std::optional< bool > post_only
Definition models.hpp:1146
std::optional< std::int64_t > subaccount
The subaccount number to use for this order.
Definition models.hpp:1154
Definition models.hpp:1550
FixedPointCount fill_count
Number of contracts filled immediately upon placement.
Definition models.hpp:1554
std::optional< FixedPointDollars > average_fee_paid
Volume-weighted average fee paid per contract for fills resulting from this request.
Definition models.hpp:1560
std::optional< FixedPointDollars > average_fill_price
Volume-weighted average fill price.
Definition models.hpp:1558
std::optional< std::string > client_order_id
Definition models.hpp:1552
std::string order_id
Definition models.hpp:1551
std::int64_t ts_ms
Matching engine timestamp at which the order was processed, as Unix epoch milliseconds.
Definition models.hpp:1562
FixedPointCount remaining_count
Number of contracts remaining after placement.
Definition models.hpp:1556
Definition models.hpp:1565
std::string rfq_id
The UUID of the RFQ to quote on.
Definition models.hpp:1567
bool rest_remainder
Whether to rest the remainder of the quote after execution.
Definition models.hpp:1573
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:1576
FixedPointDollars no_bid
The bid price for NO contracts, in dollars.
Definition models.hpp:1571
FixedPointDollars yes_bid
The bid price for YES contracts, in dollars.
Definition models.hpp:1569
std::optional< std::int64_t > subaccount
Optional subaccount number to place the quote under (0 for primary, 1-63 for subaccounts)
Definition models.hpp:1578
Definition models.hpp:1581
std::string id
UUID of the newly created quote.
Definition models.hpp:1583
Definition models.hpp:1586
bool rest_remainder
Whether to rest the remainder of the RFQ after execution.
Definition models.hpp:1601
std::optional< std::int64_t > target_cost_centi_cents
DEPRECATED: The target cost for the RFQ in centi-cents.
Definition models.hpp:1594
std::optional< std::string > subtrader_id
The subtrader to create the RFQ for (FCM members only)
Definition models.hpp:1605
std::optional< std::int64_t > contracts
Whole-contract count for the RFQ.
Definition models.hpp:1590
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:1608
std::optional< FixedPointDollars > target_cost_dollars
The target cost for the RFQ in dollars.
Definition models.hpp:1596
std::string market_ticker
The ticker of the market for which to create an RFQ.
Definition models.hpp:1588
std::optional< bool > target_cost_excludes_fees
Sizes quotes against the target cost as principal only (contracts = target cost / price),...
Definition models.hpp:1599
std::optional< bool > replace_existing
Whether to delete existing RFQs as part of this RFQ's creation.
Definition models.hpp:1603
std::optional< FixedPointCount > contracts_fp
Fixed-point number of contracts for the RFQ.
Definition models.hpp:1592
Definition models.hpp:1611
std::string id
UUID of the newly created RFQ.
Definition models.hpp:1613
Definition models.hpp:1616
std::optional< ExchangeIndex > exchange_index
Identifier for an exchange shard.
Definition models.hpp:1618
Definition models.hpp:1621
std::int64_t subaccount_number
The sequential number assigned to this subaccount (1-63).
Definition models.hpp:1623
Definition models.hpp:1626
std::string open_time
Opening time in ET (Eastern Time) format HH:MM.
Definition models.hpp:1628
std::string close_time
Closing time in ET (Eastern Time) format HH:MM.
Definition models.hpp:1630
Query parameters for decrease_order.
Definition models.hpp:1634
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:1636
Definition models.hpp:1639
std::optional< ExchangeIndex > exchange_index
Exchange shard index.
Definition models.hpp:1645
std::optional< FixedPointCount > reduce_to
String representation of the number of contracts to reduce to.
Definition models.hpp:1643
std::optional< std::string > market_ticker
Market ticker used for auto-routing when exchange_index is omitted or -1.
Definition models.hpp:1647
std::optional< FixedPointCount > reduce_by
String representation of the number of contracts to reduce by.
Definition models.hpp:1641
Definition models.hpp:1650
FixedPointCount remaining_count
Number of contracts remaining after the decrease.
Definition models.hpp:1654
std::int64_t ts_ms
Matching engine timestamp at which the decrease was processed, as Unix epoch milliseconds.
Definition models.hpp:1656
std::optional< std::string > client_order_id
Definition models.hpp:1652
std::string order_id
Definition models.hpp:1651
Query parameters for delete_fcm_event_contract_daily_cap.
Definition models.hpp:1660
std::string subtrader_id
The subtrader whose daily cap should be removed.
Definition models.hpp:1662
Query parameters for delete_order_group.
Definition models.hpp:1666
std::optional< ExchangeIndex > exchange_index
Identifier for an exchange shard.
Definition models.hpp:1670
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:1668
Definition models.hpp:1673
DepositStatus status
Current status of the deposit.
Definition models.hpp:1677
std::int64_t fee_cents
Fee charged for the deposit in cents.
Definition models.hpp:1683
std::optional< std::int64_t > finalized_ts
Unix timestamp of when the deposit was finalized (applied, failed, or returned).
Definition models.hpp:1687
std::int64_t amount_cents
Deposit amount in cents.
Definition models.hpp:1681
DepositType type
Payment method used for the deposit.
Definition models.hpp:1679
std::string id
Unique identifier for the deposit.
Definition models.hpp:1675
std::int64_t created_ts
Unix timestamp of when the deposit was created.
Definition models.hpp:1685
Definition models.hpp:1690
std::int64_t cost
Configured token cost for an endpoint whose cost differs from the default cost.
Definition models.hpp:1696
std::string method
HTTP method for the endpoint.
Definition models.hpp:1692
std::string path
API route path for the endpoint.
Definition models.hpp:1694
Definition models.hpp:1008
std::optional< std::string > details
Additional details about the error, if available.
Definition models.hpp:1014
std::optional< std::string > code
Error code.
Definition models.hpp:1010
std::optional< std::string > message
Human-readable error message.
Definition models.hpp:1012
Definition models.hpp:1706
std::optional< std::string > fee_type_override
Fee type override for this event.
Definition models.hpp:1736
std::optional< std::string > strike_period
The time period this event covers (e.g., 'week', 'month').
Definition models.hpp:1726
std::string collateral_return_type
Collateral-return netting type for this event: MECNET for mutually exclusive markets,...
Definition models.hpp:1717
std::string series_ticker
Unique identifier for the series this event belongs to.
Definition models.hpp:1710
std::string sub_title
Shortened descriptive title for the event.
Definition models.hpp:1712
std::optional< std::vector< Market > > markets
Array of markets associated with this event.
Definition models.hpp:1728
bool mutually_exclusive
True when collateral_return_type is MECNET: at most one market in this event can resolve to 'yes'.
Definition models.hpp:1720
std::optional< ExchangeIndex > exchange_index
Definition models.hpp:1739
std::optional< std::string > category
Event category (deprecated, use series-level category instead).
Definition models.hpp:1722
std::optional< std::string > strike_date
The specific date this event is based on.
Definition models.hpp:1724
std::string event_ticker
Unique identifier for this event.
Definition models.hpp:1708
std::optional< std::string > last_updated_ts
Timestamp of when this event's metadata was last updated.
Definition models.hpp:1734
std::optional< RawJson > product_metadata
Additional metadata for the event.
Definition models.hpp:1730
std::string title
Full title of the event.
Definition models.hpp:1714
std::optional< double > fee_multiplier_override
Fee multiplier override for this event.
Definition models.hpp:1738
std::optional< std::vector< SettlementSource > > settlement_sources
The official sources used for the determination of markets within this event.
Definition models.hpp:1732
Definition models.hpp:1742
std::optional< FeeType > fee_type_override
New fee type override for the event.
Definition models.hpp:1750
std::string scheduled_ts
Timestamp when this fee change is scheduled to take effect.
Definition models.hpp:1754
std::optional< double > fee_multiplier_override
New fee multiplier override for the event.
Definition models.hpp:1752
std::string event_ticker
Event ticker this fee change applies to.
Definition models.hpp:1746
std::string id
Unique identifier for this fee change.
Definition models.hpp:1744
std::string series_ticker
Series ticker for the event.
Definition models.hpp:1748
Definition models.hpp:1757
RawJson details
Live data details as a flexible object whose shape depends on the type.
Definition models.hpp:1761
std::string type
Type of live data.
Definition models.hpp:1759
std::optional< std::string > default_range
Chart range the client should default to (e.g.
Definition models.hpp:1765
std::optional< std::vector< std::string > > range_options
Chart range menu options.
Definition models.hpp:1767
std::optional< bool > is_historical
Present for crypto live data.
Definition models.hpp:1763
Definition models.hpp:1770
std::string event_ticker
Unique identifier for events.
Definition models.hpp:1772
FixedPointDollars total_cost_dollars
Total spent on this event in dollars.
Definition models.hpp:1774
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:1777
FixedPointDollars fees_paid_dollars
Fees paid on fill orders, in dollars.
Definition models.hpp:1783
FixedPointDollars realized_pnl_dollars
Locked in profit and loss, in dollars.
Definition models.hpp:1781
FixedPointDollars event_exposure_dollars
Cost of the aggregate event position in dollars.
Definition models.hpp:1779
Definition models.hpp:1786
ExchangeIndex exchange_index
Definition models.hpp:1787
std::string description
Description of this exchange shard.
Definition models.hpp:1789
bool trading_active
True if trading is currently permitted on this exchange index.
Definition models.hpp:1793
bool exchange_active
False if this exchange index is no longer taking any state changes at all.
Definition models.hpp:1791
bool intra_exchange_transfers_active
True if intra-exchange transfers are currently permitted on this exchange index.
Definition models.hpp:1795
Definition models.hpp:1798
bool exchange_active
False if the core Kalshi exchange is no longer taking any state changes at all.
Definition models.hpp:1800
std::optional< std::vector< ExchangeIndexStatus > > exchange_index_statuses
Status of each exchange index.
Definition models.hpp:1808
std::optional< bool > intra_exchange_transfers_active
True if intra-exchange transfers are currently permitted.
Definition models.hpp:1804
bool trading_active
True if we are currently permitting trading on the exchange.
Definition models.hpp:1802
std::optional< std::string > exchange_estimated_resume_time
Estimated downtime for the current exchange maintenance window.
Definition models.hpp:1806
Definition models.hpp:1811
bool fcm_trading_blocked
Whether an FCM-owned per-subtrader trading block is configured.
Definition models.hpp:1819
std::string subtrader_id
Full subtrader identifier owned by the authenticated FCM.
Definition models.hpp:1813
bool propagation_pending
Whether a configured per-subtrader block is awaiting engine application.
Definition models.hpp:1821
bool trading_blocked
Effective trading block, including firm-wide and Kalshi restrictions.
Definition models.hpp:1817
std::vector< std::int64_t > exchange_indices
Exchange indices where this subtrader has been observed.
Definition models.hpp:1815
Definition models.hpp:1824
std::optional< FixedPointDollars > taker_fee_cost
Taker fee in dollars when owned by the FCM.
Definition models.hpp:1849
std::optional< std::string > maker_subtrader_id
Maker subtrader ID when owned by the FCM.
Definition models.hpp:1841
std::optional< std::string > created_time
Fill execution time.
Definition models.hpp:1837
std::optional< std::string > maker_order_id
Maker order ID when owned by the FCM.
Definition models.hpp:1839
FixedPointDollars yes_price_dollars
YES price in dollars.
Definition models.hpp:1835
std::optional< std::string > taker_order_id
Taker order ID when owned by the FCM.
Definition models.hpp:1845
FixedPointCount count_fp
Filled contract count.
Definition models.hpp:1833
OutcomeSide taker_outcome_side
Taker outcome side.
Definition models.hpp:1831
std::string fill_id
Fill ID.
Definition models.hpp:1826
std::optional< std::string > taker_subtrader_id
Taker subtrader ID when owned by the FCM.
Definition models.hpp:1847
std::optional< FixedPointDollars > maker_fee_cost
Maker fee in dollars when owned by the FCM.
Definition models.hpp:1843
std::string ticker
Market ticker.
Definition models.hpp:1829
ExchangeIndex exchange_index
Definition models.hpp:1827
Definition models.hpp:1852
BookSide book_side
Same directional bit as outcome_side in book vocabulary.
Definition models.hpp:1871
std::optional< std::int64_t > ts
Unix timestamp when this fill was executed (legacy field name)
Definition models.hpp:1887
ExchangeIndex exchange_index
Definition models.hpp:1855
std::optional< Side > side
Deprecated.
Definition models.hpp:1865
std::optional< Action > action
Deprecated.
Definition models.hpp:1867
FixedPointDollars yes_price_dollars
Fill price for the yes side in fixed-point dollars.
Definition models.hpp:1875
OutcomeSide outcome_side
The outcome side this fill positioned the user for.
Definition models.hpp:1869
std::string order_id
Unique identifier for the order that resulted in this fill.
Definition models.hpp:1859
FixedPointCount count_fp
String representation of the number of contracts bought or sold in this fill.
Definition models.hpp:1873
std::string ticker
Unique identifier for the market.
Definition models.hpp:1861
std::optional< std::string > created_time
Timestamp when this fill was executed.
Definition models.hpp:1881
std::string trade_id
Unique identifier for this fill (legacy field name, same as fill_id)
Definition models.hpp:1857
FixedPointDollars no_price_dollars
Fill price for the no side in fixed-point dollars.
Definition models.hpp:1877
FixedPointDollars fee_cost
Fee cost in fixed-point dollars.
Definition models.hpp:1883
std::optional< std::int64_t > subaccount_number
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:1885
bool is_taker
If true, this fill was a taker (removed liquidity from the order book)
Definition models.hpp:1879
std::string fill_id
Unique identifier for this fill.
Definition models.hpp:1854
std::string market_ticker
Unique identifier for the market (legacy field name, same as ticker)
Definition models.hpp:1863
Definition models.hpp:1901
std::int64_t end_period_ts
Unix timestamp for the inclusive end of the forecast period.
Definition models.hpp:1905
std::vector< PercentilePoint > percentile_points
Array of forecast values at different percentiles.
Definition models.hpp:1909
std::int64_t period_interval
Length of the forecast period in minutes.
Definition models.hpp:1907
std::string event_ticker
The event ticker this forecast is for.
Definition models.hpp:1903
Definition models.hpp:1912
std::optional< std::string > fcm_subtrader_id
FCM members only.
Definition models.hpp:1921
std::optional< std::vector< ApiKeyScope > > scopes
List of scopes to grant to the API key.
Definition models.hpp:1917
std::optional< ApiKeyType > key_type
Definition models.hpp:1915
std::string name
Name for the API key.
Definition models.hpp:1914
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:1919
Definition models.hpp:1924
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:1934
std::string private_key
Private key in PEM format - PKCS#1 (-----BEGIN RSA PRIVATE KEY-----) for rsa, PKCS#8 (-----BEGIN PRIV...
Definition models.hpp:1930
std::string api_key_id
Unique identifier for the newly generated API key.
Definition models.hpp:1926
std::optional< ApiKeyType > key_type
Definition models.hpp:1927
Definition models.hpp:1937
std::string usage_tier
User's effective Predictions API usage tier for these limits (for example, basic, advanced,...
Definition models.hpp:1940
BucketLimit read
Definition models.hpp:1941
BucketLimit write
Definition models.hpp:1942
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:1946
Definition models.hpp:1949
std::vector< AccountApiUsageLevelVolumeProgress > volume_progress
Latest cron-computed trading volume progress toward volume-based API usage tiers for the predictions ...
Definition models.hpp:1952
Definition models.hpp:1955
std::vector< EndpointTokenCost > endpoint_costs
API v2 endpoints whose configured token cost differs from default_cost.
Definition models.hpp:1959
std::int64_t default_cost
Default token cost applied to endpoints that are not listed in endpoint_costs.
Definition models.hpp:1957
Query parameters for get_api_keys.
Definition models.hpp:1963
std::optional< std::string > fcm_subtrader_id
Return only API keys bound to this FCM subtrader.
Definition models.hpp:1965
Definition models.hpp:1968
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:1973
std::vector< ApiKey > api_keys
List of all API keys associated with the user.
Definition models.hpp:1970
Query parameters for get_balance.
Definition models.hpp:1977
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:1979
std::optional< ExchangeIndex > exchange_index
Exchange index used to scope the balance and portfolio value.
Definition models.hpp:1981
Definition models.hpp:1989
std::int64_t portfolio_value
Member's portfolio value in cents for the requested account and exchange index.
Definition models.hpp:1996
std::int64_t balance
Member's available balance in cents for the requested account and exchange index.
Definition models.hpp:1991
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:2001
FixedPointDollars balance_dollars
Member's available balance as a fixed-point dollar string for the requested account and exchange inde...
Definition models.hpp:1994
std::int64_t updated_ts
Unix timestamp of the last update to the balance.
Definition models.hpp:1998
Query parameters for get_block_trade_proposals.
Definition models.hpp:2005
std::optional< std::int64_t > limit
Parameter to specify the number of results per page.
Definition models.hpp:2011
std::optional< std::string > status
Filter block trade proposals by status.
Definition models.hpp:2013
std::optional< std::string > market_ticker
Filter by market ticker.
Definition models.hpp:2009
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2007
Definition models.hpp:2016
std::optional< std::string > cursor
Cursor for pagination to get the next page of results.
Definition models.hpp:2020
std::vector< BlockTradeProposal > block_trade_proposals
List of block trade proposals.
Definition models.hpp:2018
Definition models.hpp:2023
std::string communications_id
A public communications ID which is used to identify the user.
Definition models.hpp:2025
Query parameters for get_deposits.
Definition models.hpp:2029
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:2031
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2033
Definition models.hpp:2036
std::vector< Deposit > deposits
Definition models.hpp:2037
std::optional< std::string > cursor
Definition models.hpp:2038
Definition models.hpp:2041
std::vector< std::vector< MarketCandlestick > > market_candlesticks
Array of market candlestick arrays, one for each market in the event.
Definition models.hpp:2045
std::vector< std::string > market_tickers
Array of market tickers in the event.
Definition models.hpp:2043
std::int64_t adjusted_end_ts
Adjusted end timestamp if the requested candlesticks would be larger than maxAggregateCandidates.
Definition models.hpp:2048
Query parameters for get_event_fee_changes.
Definition models.hpp:2052
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2057
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:2055
std::optional< std::string > event_ticker
Definition models.hpp:2053
Definition models.hpp:2060
std::string cursor
Pagination cursor for the next page.
Definition models.hpp:2063
std::vector< EventFeeChange > event_fee_changes
Definition models.hpp:2061
Query parameters for get_event_forecast_percentiles_history.
Definition models.hpp:2067
std::int64_t end_ts
End timestamp for the range.
Definition models.hpp:2073
std::vector< std::int64_t > percentiles
Array of percentile values to retrieve (0-9999, max 10 values)
Definition models.hpp:2069
std::int64_t period_interval
Specifies the length of each forecast period, in minutes.
Definition models.hpp:2075
std::int64_t start_ts
Start timestamp for the range.
Definition models.hpp:2071
Definition models.hpp:2078
std::vector< ForecastPercentilesPoint > forecast_history
Array of forecast percentile data points over time.
Definition models.hpp:2080
Query parameters for get_event_live_data.
Definition models.hpp:2084
std::optional< std::string > range
Optional chart range hint (e.g.
Definition models.hpp:2086
Definition models.hpp:2089
EventLiveData live_data
Definition models.hpp:2090
Query parameters for get_event.
Definition models.hpp:2118
std::optional< bool > with_nested_markets
If true, markets are included within the event object.
Definition models.hpp:2120
Definition models.hpp:2123
EventData event
Data for the event.
Definition models.hpp:2125
std::vector< Market > markets
Data for the markets in this event.
Definition models.hpp:2127
Query parameters for get_events.
Definition models.hpp:2131
std::optional< bool > with_milestones
If true, includes related milestones as a field alongside events.
Definition models.hpp:2139
std::optional< std::string > cursor
Parameter to specify the pagination cursor.
Definition models.hpp:2135
std::optional< std::int64_t > min_updated_ts
Filter events with metadata updated after this Unix timestamp (in seconds).
Definition models.hpp:2150
std::optional< GetEventsStatus > status
Filter by event status.
Definition models.hpp:2141
std::optional< bool > with_nested_markets
Parameter to specify if nested markets should be included in the response.
Definition models.hpp:2137
std::optional< std::string > tickers
Filter by specific event tickers.
Definition models.hpp:2145
std::optional< std::int64_t > limit
Parameter to specify the number of results per page.
Definition models.hpp:2133
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:2148
std::optional< std::string > series_ticker
Filter by series ticker.
Definition models.hpp:2143
Definition models.hpp:2182
std::string cursor
Pagination cursor for the next page.
Definition models.hpp:2188
std::vector< EventData > events
Array of events matching the query criteria.
Definition models.hpp:2184
std::optional< std::vector< Milestone > > milestones
Array of milestones related to the events.
Definition models.hpp:2186
Definition models.hpp:2226
Schedule schedule
Definition models.hpp:2227
Definition models.hpp:2230
std::string cap_date
The New York calendar date the executed utilization applies to.
Definition models.hpp:2237
FixedPointDollars limit
Definition models.hpp:2232
FixedPointDollars executed_utilization
Definition models.hpp:2233
FixedPointDollars resting_order_utilization
Definition models.hpp:2234
std::string subtrader_id
Definition models.hpp:2231
FixedPointDollars pending_order_utilization
Definition models.hpp:2235
Definition models.hpp:2240
std::vector< std::string > categories
The event categories blocked for the subtrader, sorted ascending.
Definition models.hpp:2242
Query parameters for get_fcm_event_contract_daily_cap.
Definition models.hpp:2246
std::optional< std::string > subtrader_id
The subtrader whose daily cap should be returned.
Definition models.hpp:2248
Query parameters for get_fcm_fills.
Definition models.hpp:2252
std::optional< std::int64_t > min_ts
Filter items after this Unix timestamp.
Definition models.hpp:2254
std::optional< std::int64_t > max_ts
Filter items before this Unix timestamp.
Definition models.hpp:2256
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2258
Definition models.hpp:2261
std::vector< FcmFill > fills
Definition models.hpp:2262
std::string cursor
Definition models.hpp:2263
Query parameters for get_fcm_orders.
Definition models.hpp:2267
std::optional< std::string > ticker
Filter by market ticker.
Definition models.hpp:2277
std::optional< std::string > subtrader_id
Restricts the response to orders for a specific subtrader (FCM members only).
Definition models.hpp:2269
std::optional< std::string > client_order_ids
Client order IDs to filter by, as a comma-separated list (maximum 100).
Definition models.hpp:2271
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2273
std::optional< std::int64_t > limit
Parameter to specify the number of results per page.
Definition models.hpp:2285
std::optional< OrderStatus > status
Restricts the response to orders that have a certain status.
Definition models.hpp:2283
std::optional< std::int64_t > min_ts
Restricts the response to orders after a timestamp, formatted as a Unix Timestamp.
Definition models.hpp:2279
std::optional< std::string > event_ticker
Event ticker to filter by.
Definition models.hpp:2275
std::optional< std::int64_t > max_ts
Restricts the response to orders before a timestamp, formatted as a Unix Timestamp.
Definition models.hpp:2281
Query parameters for get_fcm_positions.
Definition models.hpp:2289
std::optional< std::string > cursor
The Cursor represents a pointer to the next page of records in the pagination.
Definition models.hpp:2304
std::optional< std::string > event_ticker
Event ticker of desired positions.
Definition models.hpp:2295
std::optional< std::string > count_filter
Restricts the positions to those with any of following fields with non-zero values,...
Definition models.hpp:2298
std::optional< std::int64_t > limit
Parameter to specify the number of results per page.
Definition models.hpp:2302
std::optional< std::string > ticker
Ticker of desired positions.
Definition models.hpp:2293
std::optional< SettlementStatus > settlement_status
Settlement status of the markets to return.
Definition models.hpp:2300
std::optional< std::string > subtrader_id
Restricts the response to positions for a specific subtrader (FCM members only).
Definition models.hpp:2291
Query parameters for get_fcm_subtrader_blocked_categories.
Definition models.hpp:2308
std::string subtrader_id
The subtrader whose blocked categories should be returned.
Definition models.hpp:2310
Query parameters for get_fills_historical.
Definition models.hpp:2314
std::optional< std::int64_t > max_ts
Filter items before this Unix timestamp.
Definition models.hpp:2320
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:2322
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:2326
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2324
std::optional< std::string > ticker
Filter by market ticker.
Definition models.hpp:2316
std::optional< std::int64_t > min_ts
Filter items after this Unix timestamp.
Definition models.hpp:2318
Query parameters for get_fills.
Definition models.hpp:2330
std::optional< std::int64_t > min_ts
Filter items after this Unix timestamp.
Definition models.hpp:2336
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:2344
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:2340
std::optional< std::string > ticker
Filter by market ticker.
Definition models.hpp:2332
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2342
std::optional< std::int64_t > exchange_index
Filter results by exchange shard.
Definition models.hpp:2346
std::optional< std::int64_t > max_ts
Filter items before this Unix timestamp.
Definition models.hpp:2338
std::optional< std::string > order_id
Filter by order ID.
Definition models.hpp:2334
Definition models.hpp:2349
std::string cursor
Definition models.hpp:2351
std::vector< Fill > fills
Definition models.hpp:2350
Definition models.hpp:2366
std::map< std::string, SportFilterDetails > filters_by_sports
Mapping of sports to their filter details.
Definition models.hpp:2368
std::vector< std::string > sport_ordering
Ordered list of sports for display.
Definition models.hpp:2370
Definition models.hpp:2382
std::optional< PlayByPlay > pbp
Definition models.hpp:2383
Definition models.hpp:2386
std::optional< std::string > market_positions_last_updated_ts
Cutoff based on position last-update time.
Definition models.hpp:2394
std::string market_settled_ts
Cutoff based on market settlement time.
Definition models.hpp:2388
std::string orders_updated_ts
Cutoff based on order cancellation or execution time.
Definition models.hpp:2392
std::string trades_created_ts
Cutoff based on trade fill time.
Definition models.hpp:2390
Query parameters for get_historical_markets.
Definition models.hpp:2398
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2402
std::optional< std::string > event_ticker
Event ticker to filter by.
Definition models.hpp:2406
std::optional< std::string > tickers
Filter by specific market tickers.
Definition models.hpp:2404
std::optional< std::string > series_ticker
Filter by series ticker.
Definition models.hpp:2408
std::optional< GetHistoricalMarketsMveFilter > mve_filter
Filter by multivariate events (combos).
Definition models.hpp:2410
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:2400
Query parameters for get_historical_orders.
Definition models.hpp:2414
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:2426
std::optional< std::int64_t > min_ts
Filter items after this Unix timestamp.
Definition models.hpp:2418
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2424
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:2422
std::optional< std::string > ticker
Filter by market ticker.
Definition models.hpp:2416
std::optional< std::int64_t > max_ts
Filter items before this Unix timestamp.
Definition models.hpp:2420
Query parameters for get_historical_positions.
Definition models.hpp:2430
std::optional< std::string > event_ticker
Event ticker to filter by.
Definition models.hpp:2434
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2440
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:2436
std::optional< std::string > ticker
Filter by market ticker.
Definition models.hpp:2432
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:2438
Query parameters for get_incentive_programs.
Definition models.hpp:2444
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:2452
std::optional< GetIncentiveProgramsStatus > status
Status filter.
Definition models.hpp:2446
std::optional< GetIncentiveProgramsType > type
Type filter.
Definition models.hpp:2448
std::optional< std::string > incentive_description
Filter by exact incentive description.
Definition models.hpp:2450
std::optional< std::string > cursor
Cursor for pagination.
Definition models.hpp:2454
Definition models.hpp:2484
std::optional< std::string > next_cursor
Cursor for pagination to get the next page of results.
Definition models.hpp:2487
std::vector< IncentiveProgram > incentive_programs
Definition models.hpp:2485
Definition models.hpp:2508
IntraExchangeInstanceTransfer transfer
Definition models.hpp:2509
Query parameters for get_intra_exchange_instance_transfers.
Definition models.hpp:2513
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:2515
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2517
Definition models.hpp:2520
std::optional< std::string > cursor
Cursor for the next page of results.
Definition models.hpp:2523
std::vector< IntraExchangeInstanceTransfer > transfers
Definition models.hpp:2521
Query parameters for get_live_data_by_milestone.
Definition models.hpp:2527
std::optional< bool > include_player_stats
When true, includes player-level statistics in the live data response.
Definition models.hpp:2529
Query parameters for get_live_data.
Definition models.hpp:2533
std::optional< bool > include_player_stats
When true, includes player-level statistics in the live data response.
Definition models.hpp:2535
Definition models.hpp:2547
LiveData live_data
Definition models.hpp:2548
Query parameters for get_live_datas.
Definition models.hpp:2552
std::optional< bool > include_player_stats
When true, includes player-level statistics in the live data response.
Definition models.hpp:2556
std::vector< std::string > milestone_ids
Array of milestone IDs.
Definition models.hpp:2554
Definition models.hpp:2559
std::vector< LiveData > live_datas
Definition models.hpp:2560
Query parameters for get_market_candlesticks_by_event.
Definition models.hpp:2564
std::int64_t start_ts
Start timestamp for the range.
Definition models.hpp:2566
std::int64_t end_ts
End timestamp for the range.
Definition models.hpp:2568
std::int64_t period_interval
Specifies the length of each candlestick period, in minutes.
Definition models.hpp:2570
Query parameters for get_market_candlesticks_historical.
Definition models.hpp:2574
std::int64_t period_interval
Time period length of each candlestick in minutes.
Definition models.hpp:2580
std::int64_t start_ts
Start timestamp (Unix timestamp).
Definition models.hpp:2576
std::int64_t end_ts
End timestamp (Unix timestamp).
Definition models.hpp:2578
Definition models.hpp:2618
std::string ticker
Unique identifier for the market.
Definition models.hpp:2620
std::vector< MarketCandlestickHistorical > candlesticks
Array of candlestick data points for the specified time range.
Definition models.hpp:2622
Query parameters for get_market_candlesticks.
Definition models.hpp:2626
std::optional< bool > include_latest_before_start
If true, prepends the latest candlestick available before the start_ts.
Definition models.hpp:2634
std::int64_t start_ts
Start timestamp (Unix timestamp).
Definition models.hpp:2628
std::int64_t period_interval
Time period length of each candlestick in minutes.
Definition models.hpp:2632
std::int64_t end_ts
End timestamp (Unix timestamp).
Definition models.hpp:2630
Definition models.hpp:2637
std::string ticker
Unique identifier for the market.
Definition models.hpp:2639
std::vector< MarketCandlestick > candlesticks
Array of candlestick data points for the specified time range.
Definition models.hpp:2641
Query parameters for get_market_orderbook.
Definition models.hpp:2645
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:2648
Definition models.hpp:2657
OrderbookCountFp orderbook_fp
Orderbook with fixed-point contract counts (fp) in all price levels.
Definition models.hpp:2659
Query parameters for get_market_orderbooks.
Definition models.hpp:2663
std::vector< std::string > tickers
List of market tickers to fetch orderbooks for.
Definition models.hpp:2665
Definition models.hpp:2673
std::vector< MarketOrderbookFp > orderbooks
Definition models.hpp:2674
Definition models.hpp:2677
Market market
Definition models.hpp:2678
Query parameters for get_markets.
Definition models.hpp:2682
std::optional< std::string > series_ticker
Filter by series ticker.
Definition models.hpp:2690
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2686
std::optional< GetMarketsStatus > status
Filter by market status.
Definition models.hpp:2708
std::optional< std::string > event_ticker
Event ticker to filter by.
Definition models.hpp:2688
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:2684
std::optional< GetMarketsMveFilter > mve_filter
Filter by multivariate events (combos).
Definition models.hpp:2712
std::optional< std::int64_t > min_updated_ts
Return markets with metadata updated later than this Unix timestamp (in seconds).
Definition models.hpp:2696
std::optional< std::int64_t > max_updated_ts
Return markets with metadata updated at or before this Unix timestamp (in seconds).
Definition models.hpp:2698
std::optional< std::int64_t > max_settled_ts
Filter items that settled before this Unix timestamp.
Definition models.hpp:2706
std::optional< std::int64_t > max_close_ts
Filter items that close before this Unix timestamp.
Definition models.hpp:2700
std::optional< std::string > tickers
Filter by specific market tickers.
Definition models.hpp:2710
std::optional< std::int64_t > min_created_ts
Filter items that created after this Unix timestamp.
Definition models.hpp:2692
std::optional< std::int64_t > min_close_ts
Filter items that close after this Unix timestamp.
Definition models.hpp:2702
std::optional< std::int64_t > max_created_ts
Filter items that created before this Unix timestamp.
Definition models.hpp:2694
std::optional< std::int64_t > min_settled_ts
Filter items that settled after this Unix timestamp.
Definition models.hpp:2704
Definition models.hpp:2715
std::vector< Market > markets
Definition models.hpp:2716
std::string cursor
Definition models.hpp:2717
Definition models.hpp:2720
Milestone milestone
The milestone data.
Definition models.hpp:2722
Query parameters for get_milestones.
Definition models.hpp:2726
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2742
std::optional< std::int64_t > min_updated_ts
Filter milestones with metadata updated after this Unix timestamp (in seconds).
Definition models.hpp:2744
std::optional< std::string > minimum_start_date
Minimum start date to filter milestones.
Definition models.hpp:2730
std::optional< std::string > category
Filter by milestone category.
Definition models.hpp:2732
std::optional< std::string > type
Filter by milestone type.
Definition models.hpp:2738
std::int64_t limit
Number of milestones to return per page.
Definition models.hpp:2728
std::optional< std::string > related_event_ticker
Filter by related event ticker.
Definition models.hpp:2740
std::optional< std::string > competition
Filter by competition.
Definition models.hpp:2734
std::optional< std::string > source_id
Filter by source id.
Definition models.hpp:2736
Definition models.hpp:2747
std::optional< std::string > cursor
Cursor for pagination.
Definition models.hpp:2751
std::vector< Milestone > milestones
List of milestones.
Definition models.hpp:2749
Definition models.hpp:2790
MultivariateEventCollection multivariate_contract
The multivariate event collection.
Definition models.hpp:2792
Query parameters for get_multivariate_event_collections.
Definition models.hpp:2796
std::optional< GetMultivariateEventCollectionsStatus > status
Only return collections of a certain status.
Definition models.hpp:2798
std::optional< std::string > series_ticker
Only return collections with a particular series ticker.
Definition models.hpp:2802
std::optional< std::string > cursor
The Cursor represents a pointer to the next page of records in the pagination.
Definition models.hpp:2806
std::optional< std::string > associated_event_ticker
Only return collections associated with a particular event ticker.
Definition models.hpp:2800
std::optional< std::int64_t > limit
Specify the maximum number of results.
Definition models.hpp:2804
Definition models.hpp:2809
std::optional< std::string > cursor
The Cursor represents a pointer to the next page of records in the pagination.
Definition models.hpp:2813
std::vector< MultivariateEventCollection > multivariate_contracts
List of multivariate event collections.
Definition models.hpp:2811
Query parameters for get_multivariate_events.
Definition models.hpp:2817
std::optional< std::string > collection_ticker
Filter events by collection ticker.
Definition models.hpp:2825
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:2819
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2821
std::optional< bool > with_nested_markets
Parameter to specify if nested markets should be included in the response.
Definition models.hpp:2827
std::optional< std::string > series_ticker
Filter by series ticker.
Definition models.hpp:2823
Definition models.hpp:2830
std::vector< EventData > events
Array of multivariate events matching the query criteria.
Definition models.hpp:2832
std::string cursor
Pagination cursor for the next page.
Definition models.hpp:2834
Query parameters for get_order_group.
Definition models.hpp:2838
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:2840
Definition models.hpp:2843
std::optional< ExchangeIndex > exchange_index
Definition models.hpp:2851
std::optional< FixedPointCount > contracts_limit_fp
String representation of the current maximum contracts allowed over a rolling 15-second window.
Definition models.hpp:2848
std::vector< std::string > orders
List of order IDs that belong to this order group.
Definition models.hpp:2850
bool is_auto_cancel_enabled
Whether auto-cancel is enabled for this order group.
Definition models.hpp:2845
Query parameters for get_order_groups.
Definition models.hpp:2855
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:2857
Definition models.hpp:2871
std::optional< std::vector< OrderGroup > > order_groups
Definition models.hpp:2872
Definition models.hpp:2875
FixedPointCount queue_position_fp
The number of preceding shares before the order in the queue.
Definition models.hpp:2877
Query parameters for get_order_queue_positions.
Definition models.hpp:2881
std::optional< std::string > market_tickers
Comma-separated list of market tickers to filter by.
Definition models.hpp:2883
std::optional< std::string > event_ticker
Event ticker to filter by.
Definition models.hpp:2885
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:2887
Definition models.hpp:2899
std::vector< OrderQueuePosition > queue_positions
Queue positions for all matching orders.
Definition models.hpp:2901
Definition models.hpp:2904
Order order
Definition models.hpp:2905
Query parameters for get_orders.
Definition models.hpp:2909
std::optional< std::string > status
Filter by status.
Definition models.hpp:2919
std::optional< std::string > ticker
Filter by market ticker.
Definition models.hpp:2911
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:2923
std::optional< std::int64_t > max_ts
Filter items before this Unix timestamp.
Definition models.hpp:2917
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:2925
std::optional< std::int64_t > min_ts
Filter items after this Unix timestamp.
Definition models.hpp:2915
std::optional< std::int64_t > exchange_index
Filter results by exchange shard.
Definition models.hpp:2927
std::optional< std::string > event_ticker
Event tickers to filter by, as a comma-separated list (maximum 10).
Definition models.hpp:2913
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:2921
Definition models.hpp:2930
std::vector< Order > orders
Definition models.hpp:2931
std::string cursor
Definition models.hpp:2932
Definition models.hpp:2935
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:2940
std::int64_t total_resting_order_value
Total value of resting orders in cents.
Definition models.hpp:2937
Query parameters for get_positions.
Definition models.hpp:2944
std::optional< std::int64_t > exchange_index
Filter results by exchange shard.
Definition models.hpp:2959
std::optional< std::string > cursor
The Cursor represents a pointer to the next page of records in the pagination.
Definition models.hpp:2946
std::optional< std::int64_t > limit
Parameter to specify the number of results per page.
Definition models.hpp:2948
std::optional< std::string > event_ticker
Event ticker to filter by.
Definition models.hpp:2955
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:2957
std::optional< std::string > ticker
Filter by market ticker.
Definition models.hpp:2953
std::optional< std::string > count_filter
Restricts the positions to those with any of following fields with non-zero values,...
Definition models.hpp:2951
Definition models.hpp:2980
std::vector< EventPosition > event_positions
List of event positions.
Definition models.hpp:2986
std::vector< MarketPosition > market_positions
List of market positions.
Definition models.hpp:2984
std::optional< std::string > cursor
The Cursor represents a pointer to the next page of records in the pagination.
Definition models.hpp:2982
Definition models.hpp:3052
Quote quote
The details of the requested quote.
Definition models.hpp:3054
Query parameters for get_quotes.
Definition models.hpp:3058
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:3060
std::optional< UserFilter > user_filter
Filter for quotes created by the authenticated user.
Definition models.hpp:3074
std::optional< std::int64_t > limit
Parameter to specify the number of results per page.
Definition models.hpp:3068
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:3066
std::optional< std::string > rfq_creator_subtrader_id
Filter quotes by RFQ creator subtrader ID (FCM members only)
Definition models.hpp:3080
std::optional< std::string > quote_creator_user_id
Filter quotes by quote creator user ID.
Definition models.hpp:3072
std::optional< std::string > status
Filter quotes by status.
Definition models.hpp:3070
std::optional< UserFilter > rfq_user_filter
Filter for quotes responding to RFQs created by the authenticated user.
Definition models.hpp:3076
std::optional< std::string > rfq_creator_user_id
Filter quotes by RFQ creator user ID.
Definition models.hpp:3078
std::optional< std::string > rfq_id
Filter quotes by RFQ UUID.
Definition models.hpp:3082
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:3063
Definition models.hpp:3085
std::vector< Quote > quotes
List of quotes matching the query criteria.
Definition models.hpp:3087
std::optional< std::string > cursor
Cursor for pagination to get the next page of results.
Definition models.hpp:3089
Definition models.hpp:3128
RFQ rfq
The details of the requested RFQ.
Definition models.hpp:3130
Definition models.hpp:3133
std::optional< std::string > cursor
Cursor for pagination to get the next page of results.
Definition models.hpp:3137
std::vector< RFQ > rfqs
List of RFQs matching the query criteria.
Definition models.hpp:3135
Query parameters for get_rfqs.
Definition models.hpp:3141
std::optional< std::string > market_ticker
Filter by market ticker.
Definition models.hpp:3147
std::optional< std::int64_t > limit
Parameter to specify the number of results per page.
Definition models.hpp:3151
std::optional< std::string > creator_user_id
Filter RFQs by creator user UUID.
Definition models.hpp:3155
std::optional< UserFilter > user_filter
Definition models.hpp:3156
std::optional< std::string > event_ticker
Event ticker to filter by.
Definition models.hpp:3145
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:3149
std::optional< std::string > status
Filter RFQs by status.
Definition models.hpp:3153
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:3143
Query parameters for get_series_fee_changes.
Definition models.hpp:3160
std::optional< bool > show_historical
Definition models.hpp:3162
std::optional< std::string > series_ticker
Definition models.hpp:3161
Definition models.hpp:3178
std::vector< SeriesFeeChange > series_fee_change_arr
Definition models.hpp:3179
Query parameters for get_series_list.
Definition models.hpp:3183
std::optional< std::int64_t > min_updated_ts
Filter series with metadata updated after this Unix timestamp (in seconds).
Definition models.hpp:3191
std::optional< bool > include_product_metadata
Definition models.hpp:3187
std::optional< std::string > tags
Definition models.hpp:3186
std::optional< bool > include_volume
If true, includes the total volume traded across all events in each series.
Definition models.hpp:3189
std::optional< std::string > category
Return series whose categories list contains this value.
Definition models.hpp:3185
Definition models.hpp:3232
std::vector< Series > series
Definition models.hpp:3233
Query parameters for get_series.
Definition models.hpp:3237
std::optional< bool > include_volume
If true, includes the total volume traded across all events in this series.
Definition models.hpp:3239
Definition models.hpp:3242
Series series
Definition models.hpp:3243
Query parameters for get_settlements.
Definition models.hpp:3247
std::optional< std::string > ticker
Filter by market ticker.
Definition models.hpp:3253
std::optional< std::int64_t > max_ts
Filter items before this Unix timestamp.
Definition models.hpp:3259
std::optional< std::string > event_ticker
Event ticker to filter by.
Definition models.hpp:3255
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:3251
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:3249
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:3261
std::optional< std::int64_t > min_ts
Filter items after this Unix timestamp.
Definition models.hpp:3257
Definition models.hpp:3291
std::vector< Settlement > settlements
Definition models.hpp:3292
std::optional< std::string > cursor
Definition models.hpp:3293
Definition models.hpp:3314
std::optional< StructuredTarget > structured_target
Definition models.hpp:3315
Query parameters for get_structured_targets.
Definition models.hpp:3319
std::optional< std::string > competition
Filter by competition.
Definition models.hpp:3325
std::vector< std::string > ids
Filter by specific structured target IDs.
Definition models.hpp:3321
std::optional< std::int64_t > page_size
Number of items per page (min 1, max 2000, default 100)
Definition models.hpp:3327
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:3329
std::optional< std::string > type
Filter by structured target type.
Definition models.hpp:3323
Definition models.hpp:3332
std::optional< std::vector< StructuredTarget > > structured_targets
Definition models.hpp:3333
std::optional< std::string > cursor
Pagination cursor for the next page.
Definition models.hpp:3335
Definition models.hpp:3349
std::vector< SubaccountBalance > subaccount_balances
Definition models.hpp:3350
Definition models.hpp:3362
std::vector< SubaccountNettingConfig > netting_configs
Definition models.hpp:3363
Query parameters for get_subaccount_transfers.
Definition models.hpp:3367
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:3371
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:3369
Definition models.hpp:3389
std::vector< SubaccountTransfer > transfers
Definition models.hpp:3390
std::optional< std::string > cursor
Cursor for the next page of results.
Definition models.hpp:3392
Definition models.hpp:3407
std::vector< TargetBalanceAllocation > allocations
Definition models.hpp:3408
RestingMarginReservation resting_margin_reservation
Definition models.hpp:3409
Query parameters for get_trades_historical.
Definition models.hpp:3413
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:3421
std::optional< std::int64_t > min_ts
Filter items after this Unix timestamp.
Definition models.hpp:3417
std::optional< std::string > ticker
Filter by market ticker.
Definition models.hpp:3415
std::optional< bool > is_block_trade
Filter trades by whether they are block trades.
Definition models.hpp:3425
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:3423
std::optional< std::int64_t > max_ts
Filter items before this Unix timestamp.
Definition models.hpp:3419
Query parameters for get_trades.
Definition models.hpp:3429
std::optional< std::string > ticker
Filter by market ticker.
Definition models.hpp:3435
std::optional< bool > is_block_trade
Filter trades by whether they are block trades.
Definition models.hpp:3441
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:3433
std::optional< std::int64_t > max_ts
Filter items before this Unix timestamp.
Definition models.hpp:3439
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:3431
std::optional< std::int64_t > min_ts
Filter items after this Unix timestamp.
Definition models.hpp:3437
Definition models.hpp:3467
std::vector< Trade > trades
Definition models.hpp:3468
std::string cursor
Definition models.hpp:3469
Definition models.hpp:3472
std::string as_of_time
Timestamp when user data was last updated.
Definition models.hpp:3474
Definition models.hpp:3511
std::vector< WeatherIndexCalibration > calibrations
Configuration records, ascending by effective time.
Definition models.hpp:3518
std::string units
Always celsius — offsets and the city reference are Celsius quantities from the index methodology (th...
Definition models.hpp:3516
std::string city
Index city ID.
Definition models.hpp:3513
Query parameters for get_weather_index.
Definition models.hpp:3522
std::optional< std::int64_t > last_sec
Trailing window in seconds; equivalent to from=now-last_sec, to=now.
Definition models.hpp:3528
std::optional< std::int64_t > from
Window start, unix milliseconds (inclusive).
Definition models.hpp:3524
std::optional< bool > detailed
Include per-station audit readings on every point.
Definition models.hpp:3530
std::optional< std::int64_t > to
Window end, unix milliseconds (inclusive).
Definition models.hpp:3526
Definition models.hpp:3572
std::string units
Always fahrenheit.
Definition models.hpp:3578
std::optional< std::string > config_version
Index configuration version of the newest returned point (e.g.
Definition models.hpp:3576
std::string city
Index city ID.
Definition models.hpp:3574
std::vector< WeatherIndexPoint > timeseries
Definition models.hpp:3579
Query parameters for get_withdrawals.
Definition models.hpp:3583
std::optional< std::string > cursor
Pagination cursor.
Definition models.hpp:3587
std::optional< std::int64_t > limit
Number of results per page.
Definition models.hpp:3585
Definition models.hpp:3607
std::optional< std::string > cursor
Definition models.hpp:3609
std::vector< Withdrawal > withdrawals
Definition models.hpp:3608
Definition models.hpp:2457
std::string market_ticker
The ticker symbol of the market associated with this incentive program.
Definition models.hpp:2463
std::int64_t period_reward
Total reward for the period in centi-cents.
Definition models.hpp:2473
std::string start_date
Start date of the incentive program.
Definition models.hpp:2469
std::optional< std::int64_t > max_reward_per_account
Maximum reward per account in centi-cents (optional)
Definition models.hpp:2481
std::string market_id
The unique identifier of the market associated with this incentive program.
Definition models.hpp:2461
std::string id
Unique identifier for the incentive program.
Definition models.hpp:2459
std::string end_date
End date of the incentive program.
Definition models.hpp:2471
IncentiveProgramIncentiveType incentive_type
Type of incentive program.
Definition models.hpp:2465
std::optional< std::int64_t > discount_factor_bps
Discount factor in basis points (optional)
Definition models.hpp:2477
std::string incentive_description
Plain text description of the incentive program.
Definition models.hpp:2467
bool paid_out
Whether the incentive has been paid out.
Definition models.hpp:2475
std::optional< FixedPointCount > target_size_fp
String representation of the target size for the incentive program (optional)
Definition models.hpp:2479
Definition models.hpp:1984
ExchangeIndex exchange_index
Definition models.hpp:1985
FixedPointDollars balance
Definition models.hpp:1986
Definition models.hpp:3612
std::optional< std::int64_t > destination_exchange_shard
Destination exchange shard index (default 0)
Definition models.hpp:3622
std::optional< std::int64_t > source_subaccount
Source subaccount number (default 0 for the primary account).
Definition models.hpp:3624
ExchangeInstance source
The source exchange instance.
Definition models.hpp:3614
std::optional< std::int64_t > source_exchange_shard
Source exchange shard index (default 0)
Definition models.hpp:3620
std::optional< std::int64_t > destination_subaccount
Destination subaccount number (default 0 for the primary account).
Definition models.hpp:3626
ExchangeInstance destination
The destination exchange instance.
Definition models.hpp:3616
std::int64_t amount
The amount to transfer in centicents.
Definition models.hpp:3618
Definition models.hpp:3629
std::string transfer_id
The ID of the transfer that was created.
Definition models.hpp:3631
Definition models.hpp:2490
std::int64_t source_exchange_shard
Source exchange shard index.
Definition models.hpp:2498
ExchangeInstance source
Source exchange instance.
Definition models.hpp:2494
IntraExchangeInstanceTransferStatus status
Definition models.hpp:2503
std::int64_t created_ts
Unix timestamp when the transfer was created.
Definition models.hpp:2505
std::string transfer_id
Unique transfer id.
Definition models.hpp:2492
std::int64_t destination_exchange_shard
Destination exchange shard index.
Definition models.hpp:2500
ExchangeInstance destination
Destination exchange instance.
Definition models.hpp:2496
FixedPointDollars amount
Transfer amount in dollars.
Definition models.hpp:2502
Definition models.hpp:3634
std::vector< FCMSubtrader > subtraders
Definition models.hpp:3635
Definition models.hpp:2538
std::string milestone_id
Milestone ID.
Definition models.hpp:2544
std::string type
Type of live data.
Definition models.hpp:2540
RawJson details
Live data details as a flexible object.
Definition models.hpp:2542
Definition models.hpp:2212
std::string start_datetime
Start date and time of the maintenance window.
Definition models.hpp:2214
std::string end_datetime
End date and time of the maintenance window.
Definition models.hpp:2216
Definition models.hpp:2598
std::int64_t end_period_ts
Unix timestamp for the inclusive end of the candlestick period.
Definition models.hpp:2600
BidAskDistributionHistorical yes_bid
Open, high, low, close (OHLC) data for YES buy offers on the market during the candlestick period.
Definition models.hpp:2603
BidAskDistributionHistorical yes_ask
Open, high, low, close (OHLC) data for YES sell offers on the market during the candlestick period.
Definition models.hpp:2606
PriceDistributionHistorical price
Open, high, low, close (OHLC) and more data for trade YES contract prices on the market during the ca...
Definition models.hpp:2609
FixedPointCount open_interest
String representation of the number of contracts bought on the market by end of the candlestick perio...
Definition models.hpp:2615
FixedPointCount volume
String representation of the number of contracts bought on the market during the candlestick period.
Definition models.hpp:2612
Definition models.hpp:1229
PriceDistribution price
Open, high, low, close (OHLC) and more data for trade YES contract prices on the market during the ca...
Definition models.hpp:1240
BidAskDistribution yes_bid
Open, high, low, close (OHLC) data for YES buy offers on the market during the candlestick period.
Definition models.hpp:1234
std::int64_t end_period_ts
Unix timestamp for the inclusive end of the candlestick period.
Definition models.hpp:1231
FixedPointCount open_interest_fp
String representation of the number of contracts bought on the market by end of the candlestick perio...
Definition models.hpp:1246
BidAskDistribution yes_ask
Open, high, low, close (OHLC) data for YES sell offers on the market during the candlestick period.
Definition models.hpp:1237
FixedPointCount volume_fp
String representation of the number of contracts bought on the market during the candlestick period.
Definition models.hpp:1243
Definition models.hpp:1249
std::string market_ticker
Market ticker string (e.g., 'INXD-24JAN01').
Definition models.hpp:1251
std::vector< MarketCandlestick > candlesticks
Array of candlestick data points for the market.
Definition models.hpp:1253
Definition models.hpp:2668
OrderbookCountFp orderbook_fp
Definition models.hpp:2670
std::string ticker
Definition models.hpp:2669
Definition models.hpp:2962
std::string last_updated_ts
Last time the position is updated.
Definition models.hpp:2977
FixedPointDollars market_exposure_dollars
Cost of the aggregate market position in dollars.
Definition models.hpp:2971
FixedPointCount position_fp
String representation of the number of contracts bought in this market.
Definition models.hpp:2969
FixedPointDollars fees_paid_dollars
Fees paid on fill orders, in dollars.
Definition models.hpp:2975
FixedPointDollars realized_pnl_dollars
Locked in profit and loss, in dollars.
Definition models.hpp:2973
ExchangeIndex exchange_index
Definition models.hpp:2965
FixedPointDollars total_traded_dollars
Total spent on this market in dollars.
Definition models.hpp:2967
std::string ticker
Unique identifier for the market.
Definition models.hpp:2964
Definition models.hpp:1420
std::optional< std::string > settlement_ts
Timestamp when the market was settled.
Definition models.hpp:1479
std::optional< bool > is_provisional
If true, the market may be removed after determination if there is no activity on it.
Definition models.hpp:1511
std::optional< std::string > functional_strike
Mapping from expiration values to settlement values.
Definition models.hpp:1495
std::vector< PriceRange > price_ranges
Valid price ranges for orders on this market.
Definition models.hpp:1509
FixedPointDollars yes_ask_dollars
Price for the lowest YES sell offer on this market in dollars.
Definition models.hpp:1450
FixedPointDollars previous_yes_ask_dollars
Price for the lowest YES sell offer on this market a day ago in dollars.
Definition models.hpp:1473
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:1452
std::string event_ticker
Definition models.hpp:1422
FixedPointDollars previous_price_dollars
Price for the last traded YES contract on this market a day ago in dollars.
Definition models.hpp:1475
FixedPointDollars no_ask_dollars
Price for the lowest NO sell offer on this market in dollars.
Definition models.hpp:1456
FixedPointCount volume_24h_fp
String representation of the 24h market volume in contracts.
Definition models.hpp:1462
std::optional< std::string > fee_waiver_expiration_time
Time when this market's fee waiver expires.
Definition models.hpp:1485
MarketStatus status
The current status of the market in its lifecycle.
Definition models.hpp:1444
MarketType market_type
Identifies the type of market.
Definition models.hpp:1424
std::optional< ExchangeIndex > exchange_index
Definition models.hpp:1512
FixedPointDollars last_price_dollars
Price for the last traded YES contract on this market in dollars.
Definition models.hpp:1458
std::optional< std::string > primary_participant_key
Definition models.hpp:1505
FixedPointCount open_interest_fp
String representation of the number of contracts bought on this market disconsidering netting.
Definition models.hpp:1467
std::optional< double > floor_strike
Minimum expiration value that leads to a YES settlement.
Definition models.hpp:1491
std::optional< std::string > title
Definition models.hpp:1425
std::optional< RawJson > custom_strike
Expiration value for each target that leads to a YES settlement.
Definition models.hpp:1497
FixedPointDollars notional_value_dollars
The total value of a single contract at settlement in dollars.
Definition models.hpp:1469
std::string rules_primary
A plain language description of the most important market terms.
Definition models.hpp:1499
FixedPointDollars previous_yes_bid_dollars
Price for the highest YES buy offer on this market a day ago in dollars.
Definition models.hpp:1471
std::optional< FixedPointDollars > settlement_value_dollars
The settlement value of the YES/LONG side of the contract in dollars.
Definition models.hpp:1477
std::optional< std::string > occurrence_datetime
The recorded datetime when the underlying event occurred, if available.
Definition models.hpp:1483
std::optional< std::string > expected_expiration_time
Time when this market is expected to expire.
Definition models.hpp:1437
MarketResult result
Definition models.hpp:1463
std::string rules_secondary
A plain language description of secondary market terms.
Definition models.hpp:1501
FixedPointDollars no_bid_dollars
Price for the highest NO buy offer on this market in dollars.
Definition models.hpp:1454
std::string ticker
Definition models.hpp:1421
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:1448
std::string price_level_structure
Price level structure for this market, defining price ranges and tick sizes.
Definition models.hpp:1507
std::optional< double > cap_strike
Maximum expiration value that leads to a YES settlement.
Definition models.hpp:1493
FixedPointCount volume_fp
String representation of the market volume in contracts.
Definition models.hpp:1460
std::optional< std::string > early_close_condition
The condition under which the market can close early.
Definition models.hpp:1487
std::optional< std::vector< MveSelectedLeg > > mve_selected_legs
Definition models.hpp:1504
std::string close_time
Definition models.hpp:1435
std::optional< StrikeType > strike_type
Strike type defines how the market strike is defined and evaluated.
Definition models.hpp:1489
std::string latest_expiration_time
Latest possible time for this market to expire.
Definition models.hpp:1440
std::string expiration_value
The value that was considered for the settlement.
Definition models.hpp:1481
FixedPointDollars yes_bid_dollars
Price for the highest YES buy offer on this market in dollars.
Definition models.hpp:1446
std::string no_sub_title
Shortened title for the no side of this market.
Definition models.hpp:1430
bool can_close_early
Definition models.hpp:1464
std::string created_time
Definition models.hpp:1431
std::optional< std::string > subtitle
Definition models.hpp:1426
std::optional< std::string > expiration_time
Definition models.hpp:1438
std::optional< std::string > mve_collection_ticker
The ticker of the multivariate event collection.
Definition models.hpp:1503
std::string updated_time
Time of the last non-trading metadata update.
Definition models.hpp:1433
std::string open_time
Definition models.hpp:1434
std::string yes_sub_title
Shortened title for the yes side of this market.
Definition models.hpp:1428
std::int64_t settlement_timer_seconds
The amount of time after determination that the market settles.
Definition models.hpp:1442
Definition models.hpp:2153
std::string title
Title of the milestone.
Definition models.hpp:2167
std::vector< std::string > primary_event_tickers
List of event tickers directly related to the outcome of this milestone.
Definition models.hpp:2177
std::optional< std::string > end_date
End date of the milestone, if any.
Definition models.hpp:2163
std::string start_date
Start date of the milestone.
Definition models.hpp:2161
std::string notification_message
Notification message for the milestone.
Definition models.hpp:2169
std::string last_updated_ts
Last time this structured target was updated.
Definition models.hpp:2179
std::vector< std::string > related_event_tickers
List of event tickers related to this milestone.
Definition models.hpp:2165
std::string id
Unique identifier for the milestone.
Definition models.hpp:2155
std::string category
Category of the milestone.
Definition models.hpp:2157
RawJson details
Additional details about the milestone.
Definition models.hpp:2175
std::optional< std::map< std::string, std::string > > source_ids
Source ids of milestone if available.
Definition models.hpp:2173
std::string type
Type of the milestone.
Definition models.hpp:2159
std::optional< std::string > source_id
Source id of milestone if available.
Definition models.hpp:2171
Definition models.hpp:2754
std::vector< std::string > associated_event_tickers
[DEPRECATED - Use associated_events instead] A list of events associated with the collection.
Definition models.hpp:2773
bool is_all_yes
[DEPRECATED - Use associated_events instead] Whether the collection requires that only the market sid...
Definition models.hpp:2781
std::string collection_ticker
Unique identifier for the collection.
Definition models.hpp:2756
std::optional< ExchangeIndex > exchange_index
Exchange index inherited from the collection's series.
Definition models.hpp:2760
std::int64_t size_min
The minimum number of markets that must be passed into Lookup/Create (inclusive).
Definition models.hpp:2783
std::string close_date
The close date of the collection.
Definition models.hpp:2768
std::string series_ticker
Series associated with the collection.
Definition models.hpp:2758
std::string open_date
The open date of the collection.
Definition models.hpp:2766
std::string functional_description
A functional description of the collection describing how inputs affect the output.
Definition models.hpp:2787
std::vector< AssociatedEvent > associated_events
List of events with their individual configuration.
Definition models.hpp:2770
std::string title
Title of the collection.
Definition models.hpp:2762
std::int64_t size_max
The maximum number of markets that must be passed into Lookup/Create (inclusive).
Definition models.hpp:2785
bool is_ordered
Whether the collection is ordered.
Definition models.hpp:2775
bool is_single_market_per_event
[DEPRECATED - Use associated_events instead] Whether the collection accepts multiple markets from the...
Definition models.hpp:2778
std::string description
Short description of the collection.
Definition models.hpp:2764
Definition models.hpp:1400
std::optional< std::string > market_ticker
Unique identifier for the selected market.
Definition models.hpp:1404
std::optional< FixedPointDollars > yes_settlement_value_dollars
The settlement value of the YES/LONG side of the contract in dollars.
Definition models.hpp:1408
std::optional< std::string > side
The side of the selected market.
Definition models.hpp:1406
std::optional< std::string > event_ticker
Unique identifier for the selected event.
Definition models.hpp:1402
Definition models.hpp:2860
std::optional< ExchangeIndex > exchange_index
Definition models.hpp:2868
std::string id
Unique identifier for the order group.
Definition models.hpp:2862
std::optional< FixedPointCount > contracts_limit_fp
String representation of the current maximum contracts allowed over a rolling 15-second window.
Definition models.hpp:2865
bool is_auto_cancel_enabled
Whether auto-cancel is enabled for this order group.
Definition models.hpp:2867
Definition models.hpp:2890
std::string market_ticker
The market ticker.
Definition models.hpp:2894
std::string order_id
The order ID.
Definition models.hpp:2892
FixedPointCount queue_position_fp
The number of preceding shares before the order in the queue.
Definition models.hpp:2896
Definition models.hpp:866
FixedPointCount remaining_count_fp
String representation of the remaining contracts for this order.
Definition models.hpp:889
FixedPointDollars maker_fees_dollars
Fees paid on filled maker contracts, in dollars.
Definition models.hpp:899
std::optional< SelfTradePreventionType > self_trade_prevention_type
Definition models.hpp:904
std::string ticker
Definition models.hpp:871
FixedPointDollars taker_fees_dollars
Fees paid on filled taker contracts, in dollars.
Definition models.hpp:897
std::optional< std::string > order_group_id
The order group this order is part of.
Definition models.hpp:906
OutcomeSide outcome_side
The outcome side this order is positioned for.
Definition models.hpp:877
FixedPointCount fill_count_fp
String representation of the number of contracts that have been filled.
Definition models.hpp:887
FixedPointDollars no_price_dollars
The no price for this order in fixed-point dollars.
Definition models.hpp:885
std::optional< std::string > created_time
Definition models.hpp:901
std::string order_id
Definition models.hpp:867
OrderStatus status
Definition models.hpp:881
std::optional< Side > side
Deprecated.
Definition models.hpp:873
std::string user_id
Unique identifier for users.
Definition models.hpp:869
std::optional< Action > action
Deprecated.
Definition models.hpp:875
std::optional< std::string > last_update_time
The last update to an order (modify, cancel, fill)
Definition models.hpp:903
OrderType type
Definition models.hpp:880
FixedPointDollars yes_price_dollars
The yes price for this order in fixed-point dollars.
Definition models.hpp:883
std::optional< ExchangeIndex > exchange_index
Definition models.hpp:912
std::string client_order_id
Definition models.hpp:870
FixedPointDollars maker_fill_cost_dollars
The cost of filled maker orders in dollars.
Definition models.hpp:895
std::optional< std::string > expiration_time
Definition models.hpp:900
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:909
BookSide book_side
Same directional bit as outcome_side in book vocabulary.
Definition models.hpp:879
std::optional< std::int64_t > subaccount_number
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:911
FixedPointDollars taker_fill_cost_dollars
The cost of filled taker orders in dollars.
Definition models.hpp:893
FixedPointCount initial_count_fp
String representation of the initial size of the order (contract units)
Definition models.hpp:891
Orderbook with fixed-point contract counts (fp) in all dollar price levels.
Definition models.hpp:2652
std::vector< PriceLevelDollarsCountFp > no_dollars
Definition models.hpp:2654
std::vector< PriceLevelDollarsCountFp > yes_dollars
Definition models.hpp:2653
Definition models.hpp:1890
std::string formatted_forecast
The human-readable formatted forecast value.
Definition models.hpp:1898
double numerical_forecast
The processed numerical forecast value.
Definition models.hpp:1896
std::int64_t percentile
The percentile value (0-9999).
Definition models.hpp:1892
double raw_numerical_forecast
The raw numerical forecast value.
Definition models.hpp:1894
Definition models.hpp:2373
std::optional< std::vector< RawJson > > events
Definition models.hpp:2374
Play-by-play data organized by period.
Definition models.hpp:2378
std::optional< std::vector< PlayByPlayPeriodsItem > > periods
Definition models.hpp:2379
Definition models.hpp:2583
std::optional< FixedPointDollars > mean
Volume-weighted average price during the candlestick period (in dollars).
Definition models.hpp:2593
std::optional< FixedPointDollars > previous
Close price from the previous candlestick period (in dollars).
Definition models.hpp:2595
std::optional< FixedPointDollars > low
Lowest trade price during the candlestick period (in dollars).
Definition models.hpp:2587
std::optional< FixedPointDollars > open
Price of the first trade during the candlestick period (in dollars).
Definition models.hpp:2585
std::optional< FixedPointDollars > high
Highest trade price during the candlestick period (in dollars).
Definition models.hpp:2589
std::optional< FixedPointDollars > close
Price of the last trade during the candlestick period (in dollars).
Definition models.hpp:2591
Definition models.hpp:1210
std::optional< FixedPointDollars > close_dollars
Last traded YES contract price on the market during the candlestick period (in dollars).
Definition models.hpp:1218
std::optional< FixedPointDollars > previous_dollars
Last traded YES contract price on the market before the candlestick period (in dollars).
Definition models.hpp:1222
std::optional< FixedPointDollars > high_dollars
Highest traded YES contract price on the market during the candlestick period (in dollars).
Definition models.hpp:1216
std::optional< FixedPointDollars > mean_dollars
Mean traded YES contract price on the market during the candlestick period (in dollars).
Definition models.hpp:1220
std::optional< FixedPointDollars > open_dollars
First traded YES contract price on the market during the candlestick period (in dollars).
Definition models.hpp:1212
std::optional< FixedPointDollars > low_dollars
Lowest traded YES contract price on the market during the candlestick period (in dollars).
Definition models.hpp:1214
std::optional< FixedPointDollars > min_dollars
Minimum close price of any market during the candlestick period (in dollars).
Definition models.hpp:1224
std::optional< FixedPointDollars > max_dollars
Maximum close price of any market during the candlestick period (in dollars).
Definition models.hpp:1226
Definition models.hpp:1411
std::string step
Price step/tick size for this range in dollars.
Definition models.hpp:1417
std::string end
Ending price for this range in dollars.
Definition models.hpp:1415
std::string start
Starting price for this range in dollars.
Definition models.hpp:1413
Definition models.hpp:3638
std::string market_ticker
The ticker of the market for this block trade.
Definition models.hpp:3653
Side maker_side
The maker side of the trade.
Definition models.hpp:3659
std::int64_t centicount
Number of contracts in centicounts.
Definition models.hpp:3657
std::string expiration_ts
Expiration time of the proposal.
Definition models.hpp:3661
std::optional< std::string > seller_subtrader_id
Subtrader ID of the seller.
Definition models.hpp:3648
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:3644
std::string buyer_user_id
User ID of the buyer.
Definition models.hpp:3640
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:3651
std::int64_t price_centi_cents
Price in centi-cents.
Definition models.hpp:3655
std::string seller_user_id
User ID of the seller.
Definition models.hpp:3646
std::optional< std::string > buyer_subtrader_id
Subtrader ID of the buyer.
Definition models.hpp:3642
Definition models.hpp:3664
std::string block_trade_proposal_id
The ID of the newly created block trade proposal.
Definition models.hpp:3666
Definition models.hpp:2989
FixedPointDollars yes_bid_dollars
Bid price for YES contracts, in dollars.
Definition models.hpp:3003
std::optional< std::string > creator_order_id
Order ID for the quote creator (private field)
Definition models.hpp:3041
std::optional< std::int64_t > creator_subaccount
Subaccount number of the quote creator (visible when the caller is the quote creator)
Definition models.hpp:3043
std::optional< std::string > accepted_ts
Timestamp when the quote was accepted.
Definition models.hpp:3015
std::optional< std::string > executed_ts
Timestamp when the quote was executed.
Definition models.hpp:3019
std::string rfq_id
UUID of the RFQ this quote is responding to.
Definition models.hpp:2993
std::string id
UUID of the quote.
Definition models.hpp:2991
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:3045
std::optional< std::string > creator_user_id
User ID of the quote creator (private field)
Definition models.hpp:3030
std::string market_ticker
The ticker of the market this quote is for.
Definition models.hpp:2999
std::optional< bool > rest_remainder
Whether to rest the remainder of the quote after execution.
Definition models.hpp:3023
FixedPointCount contracts_fp
String representation of the number of contracts in the quote.
Definition models.hpp:3001
std::optional< std::string > rfq_creator_user_id
User ID of the RFQ creator (private field)
Definition models.hpp:3032
std::optional< FixedPointCount > no_contracts_fp
Number of NO contracts offered in the quote (fixed-point)
Definition models.hpp:3049
std::string created_ts
Timestamp when the quote was created.
Definition models.hpp:3007
std::string rfq_creator_id
Public communications ID of the RFQ creator.
Definition models.hpp:2997
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:3037
std::optional< std::string > cancelled_ts
Timestamp when the quote was cancelled.
Definition models.hpp:3021
std::optional< FixedPointDollars > rfq_target_cost_dollars
Total value requested in the RFQ in dollars.
Definition models.hpp:3034
FixedPointDollars no_bid_dollars
Bid price for NO contracts, in dollars.
Definition models.hpp:3005
std::optional< std::string > confirmed_ts
Timestamp when the quote was confirmed.
Definition models.hpp:3017
std::optional< FixedPointCount > yes_contracts_fp
Number of YES contracts offered in the quote (fixed-point)
Definition models.hpp:3047
std::string updated_ts
Timestamp when the quote was last updated.
Definition models.hpp:3009
std::optional< std::string > rfq_creator_order_id
Order ID for the RFQ creator (private field)
Definition models.hpp:3039
QuoteStatus status
Current status of the quote.
Definition models.hpp:3011
std::string creator_id
Public communications ID of the quote creator.
Definition models.hpp:2995
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:3026
std::optional< Side > accepted_side
The side that was accepted (yes or no)
Definition models.hpp:3013
std::optional< std::string > cancellation_reason
Reason for quote cancellation if cancelled.
Definition models.hpp:3028
Definition models.hpp:3092
std::optional< std::string > creator_user_id
User ID of the RFQ creator (private field)
Definition models.hpp:3119
std::string created_ts
Timestamp when the RFQ was created.
Definition models.hpp:3109
std::string creator_id
Public communications ID of the RFQ creator.
Definition models.hpp:3096
std::optional< std::string > cancellation_reason
Reason for RFQ cancellation if cancelled.
Definition models.hpp:3117
std::string id
UUID of the RFQ.
Definition models.hpp:3094
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:3105
std::optional< std::int64_t > creator_subaccount
Subaccount number of the RFQ creator (visible when the caller is the RFQ creator)
Definition models.hpp:3121
std::optional< std::string > mve_collection_ticker
Ticker of the MVE collection this market belongs to.
Definition models.hpp:3111
FixedPointCount contracts_fp
String representation of the number of contracts requested in the RFQ.
Definition models.hpp:3100
std::optional< std::string > updated_ts
Timestamp when the RFQ was last updated.
Definition models.hpp:3125
std::optional< std::vector< MveSelectedLeg > > mve_selected_legs
Selected legs for the MVE collection.
Definition models.hpp:3113
RFQStatus status
Current status of the RFQ (open, closed)
Definition models.hpp:3107
std::optional< FixedPointDollars > target_cost_dollars
Total value of the RFQ in dollars.
Definition models.hpp:3102
std::optional< bool > rest_remainder
Whether to rest the remainder of the RFQ after execution.
Definition models.hpp:3115
std::optional< std::string > cancelled_ts
Timestamp when the RFQ was cancelled.
Definition models.hpp:3123
std::string market_ticker
The ticker of the market this RFQ is for.
Definition models.hpp:3098
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:3670
std::optional< ExchangeIndex > exchange_index
Identifier for an exchange shard.
Definition models.hpp:3674
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:3672
Definition models.hpp:2219
std::vector< WeeklySchedule > standard_hours
The standard operating hours of the exchange.
Definition models.hpp:2221
std::vector< MaintenanceWindow > maintenance_windows
Scheduled maintenance windows, during which the exchange may be unavailable.
Definition models.hpp:2223
Definition models.hpp:2354
std::vector< std::string > scopes
List of scopes.
Definition models.hpp:2356
Definition models.hpp:3165
FeeType fee_type
New fee type for the series.
Definition models.hpp:3171
std::string scheduled_ts
Timestamp when this fee change is scheduled to take effect.
Definition models.hpp:3175
std::string series_ticker
Series ticker this fee change applies to.
Definition models.hpp:3169
std::string id
Unique identifier for this fee change.
Definition models.hpp:3167
double fee_multiplier
New fee multiplier for the series.
Definition models.hpp:3173
Definition models.hpp:3194
std::string title
Title describing the series.
Definition models.hpp:3200
std::optional< std::string > last_updated_ts
Timestamp of when this series' metadata was last updated.
Definition models.hpp:3228
std::vector< std::string > categories
Categories is the list of discovery categories for this series.
Definition models.hpp:3204
std::string contract_terms_url
ContractTermsUrl is the URL to the current terms of the contract underlying the series.
Definition models.hpp:3215
std::optional< ExchangeIndex > exchange_index
Definition models.hpp:3229
std::string contract_url
ContractUrl provides a direct link to the original filing of the contract which underlies the series.
Definition models.hpp:3213
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:3207
std::string category
Category is the primary category of this series.
Definition models.hpp:3202
std::optional< FixedPointCount > volume_fp
String representation of the total number of contracts traded across all events in this series.
Definition models.hpp:3226
FeeType fee_type
FeeType is a string representing the series' fee structure.
Definition models.hpp:3219
std::string ticker
Ticker that identifies this series.
Definition models.hpp:3196
std::string frequency
Description of the frequency of the series.
Definition models.hpp:3198
std::optional< RawJson > product_metadata
Internal product metadata of the series.
Definition models.hpp:3217
std::optional< std::vector< std::string > > additional_prohibitions
AdditionalProhibitions is a list of additional trading prohibitions for this series.
Definition models.hpp:3223
std::optional< std::vector< SettlementSource > > settlement_sources
SettlementSources specifies the official sources used for the determination of markets within the ser...
Definition models.hpp:3210
double fee_multiplier
FeeMultiplier is a floating point multiplier applied to the fee calculations.
Definition models.hpp:3221
Definition models.hpp:3684
std::vector< TargetBalanceAllocationInput > allocations
Definition models.hpp:3685
std::optional< RestingMarginReservation > resting_margin_reservation
Defaults to sum when omitted.
Definition models.hpp:3687
Definition models.hpp:1699
std::optional< std::string > name
Name of the settlement source.
Definition models.hpp:1701
std::optional< std::string > url
URL to the settlement source.
Definition models.hpp:1703
Definition models.hpp:3264
FixedPointCount yes_count_fp
String representation of the number of YES contracts owned at the time of settlement.
Definition models.hpp:3273
ExchangeIndex exchange_index
Definition models.hpp:3267
FixedPointDollars no_total_cost_dollars
Total cost basis of all NO contracts in fixed-point dollars.
Definition models.hpp:3279
FixedPointDollars yes_total_cost_dollars
Total cost basis of all YES contracts in fixed-point dollars.
Definition models.hpp:3275
SettlementMarketResult market_result
The outcome of the market settlement.
Definition models.hpp:3271
std::optional< std::int64_t > value
Payout of a single yes contract in cents.
Definition models.hpp:3288
std::string ticker
The ticker symbol of the market that was settled.
Definition models.hpp:3266
FixedPointCount no_count_fp
String representation of the number of NO contracts owned at the time of settlement.
Definition models.hpp:3277
FixedPointDollars fee_cost
Total fees paid in fixed point dollars.
Definition models.hpp:3286
std::string settled_time
Timestamp when the market was settled and payouts were processed.
Definition models.hpp:3284
std::string event_ticker
The event ticker symbol of the market that was settled.
Definition models.hpp:3269
std::int64_t revenue
Total revenue earned from this settlement in cents (winning contracts pay out 100 cents each).
Definition models.hpp:3282
Definition models.hpp:2359
std::map< std::string, ScopeList > competitions
Mapping of competitions to their scope lists.
Definition models.hpp:2363
std::vector< std::string > scopes
List of scopes available for this sport.
Definition models.hpp:2361
Definition models.hpp:3296
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:3307
std::optional< RawJson > details
Additional details about the structured target.
Definition models.hpp:3304
std::optional< std::string > type
Type of the structured target.
Definition models.hpp:3302
std::optional< std::map< std::string, std::string > > source_ids
Source ids of structured target if available.
Definition models.hpp:3309
std::optional< std::string > name
Name of the structured target.
Definition models.hpp:3300
std::optional< std::string > id
Unique identifier for the structured target.
Definition models.hpp:3298
std::optional< std::string > last_updated_ts
Timestamp when this structured target was last updated.
Definition models.hpp:3311
Definition models.hpp:3338
std::int64_t updated_ts
Unix timestamp of last balance update.
Definition models.hpp:3346
std::int64_t subaccount_number
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:3340
std::int64_t exchange_index
Exchange index the balance is held on.
Definition models.hpp:3342
FixedPointDollars balance
Balance in dollars.
Definition models.hpp:3344
Definition models.hpp:3353
bool enabled
Whether netting is enabled for this subaccount.
Definition models.hpp:3357
std::int64_t subaccount_number
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:3355
std::int64_t exchange_index
Exchange index of the subaccount.
Definition models.hpp:3359
Definition models.hpp:3374
std::int64_t amount_cents
Cash transfer amount in cents.
Definition models.hpp:3382
std::string transfer_id
Unique identifier for this transfer.
Definition models.hpp:3376
std::int64_t to_subaccount
Destination subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:3380
std::int64_t from_subaccount
Source subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:3378
std::int64_t exchange_index
Exchange index the transfer was applied on.
Definition models.hpp:3386
std::int64_t created_ts
Unix timestamp when the transfer was created.
Definition models.hpp:3384
Definition models.hpp:3400
std::int64_t percent
Target percentage of sweepable balance for the exchange index.
Definition models.hpp:3404
std::int64_t exchange_index
Exchange index that receives this percentage of sweepable balance.
Definition models.hpp:3402
Definition models.hpp:1384
std::string event_ticker
Event ticker identifier.
Definition models.hpp:1388
Side side
Side of the market (yes or no).
Definition models.hpp:1390
std::string market_ticker
Market ticker identifier.
Definition models.hpp:1386
Definition models.hpp:3444
bool is_block_trade
True if this trade was matched off-book as a block trade (e.g.
Definition models.hpp:3464
std::string ticker
Unique identifier for the market.
Definition models.hpp:3448
OutcomeSide taker_outcome_side
The outcome side the taker is positioned for.
Definition models.hpp:3458
FixedPointCount count_fp
String representation of the number of contracts bought or sold in this trade.
Definition models.hpp:3450
std::optional< Side > taker_side
Deprecated.
Definition models.hpp:3456
FixedPointDollars yes_price_dollars
Yes price for this trade in dollars.
Definition models.hpp:3452
std::string trade_id
Unique identifier for this trade.
Definition models.hpp:3446
FixedPointDollars no_price_dollars
No price for this trade in dollars.
Definition models.hpp:3454
BookSide taker_book_side
Same directional bit as taker_outcome_side in book vocabulary.
Definition models.hpp:3460
std::string created_time
Timestamp when this trade was executed.
Definition models.hpp:3462
Query parameters for trigger_order_group.
Definition models.hpp:3691
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:3693
std::optional< ExchangeIndex > exchange_index
Identifier for an exchange shard.
Definition models.hpp:3695
Definition models.hpp:3698
FixedPointDollars limit
Definition models.hpp:3701
std::string subtrader_id
The subtrader whose daily cap should be set.
Definition models.hpp:3700
Definition models.hpp:3704
std::string category
A single event category to add to or remove from the blocked set, 1-100 characters (e....
Definition models.hpp:3708
std::string subtrader_id
The subtrader whose blocked categories should be updated.
Definition models.hpp:3706
bool blocked
True adds the category to the blocked set; false removes it.
Definition models.hpp:3710
Definition models.hpp:3713
std::vector< std::string > categories
The subtrader's full resulting blocked set, sorted ascending.
Definition models.hpp:3715
Query parameters for update_order_group_limit.
Definition models.hpp:3719
std::optional< std::int64_t > subaccount
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:3721
std::optional< ExchangeIndex > exchange_index
Identifier for an exchange shard.
Definition models.hpp:3723
Definition models.hpp:3726
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:3732
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:3729
Definition models.hpp:3735
std::int64_t subaccount_number
Subaccount number (0 for primary, 1-63 for subaccounts).
Definition models.hpp:3737
bool enabled
Whether netting is enabled for this subaccount.
Definition models.hpp:3739
Definition models.hpp:3477
std::optional< std::string > update_note
Weekly-calibration disposition, present only on weekly calibration records: updated ....
Definition models.hpp:3487
double offset_c
Station offset in Celsius (positive = station normally runs warmer than its peers).
Definition models.hpp:3483
std::string station_id
Member station ID (e.g.
Definition models.hpp:3479
double weight
Base weight (weights sum to 1.0 across members).
Definition models.hpp:3481
Definition models.hpp:3490
std::optional< std::int64_t > calibration_window_end_ms
End of the calibration window (exclusive).
Definition models.hpp:3503
std::string config_version
Configuration version (e.g.
Definition models.hpp:3492
std::vector< WeatherIndexCalibrationStation > stations
Configured member stations, in configuration order.
Definition models.hpp:3508
std::optional< std::int64_t > published_at_ms
When the record was published, unix milliseconds UTC.
Definition models.hpp:3494
std::optional< std::string > change_reason
Why the configuration changed.
Definition models.hpp:3499
std::optional< std::int64_t > calibration_window_start_ms
Start of the trailing observation window the offsets were estimated from.
Definition models.hpp:3501
double city_reference_c
City reference B_c in Celsius: the weight-dot-offset sum over all configured member stations.
Definition models.hpp:3506
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:3497
Definition models.hpp:3553
std::string status
normal (every member contributed its exact-minute primary observation) or degraded (a member was abse...
Definition models.hpp:3561
std::int64_t t
Event minute, unix milliseconds UTC.
Definition models.hpp:3555
std::optional< std::int64_t > contributors
Number of accepted member stations backing the point.
Definition models.hpp:3563
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:3566
std::optional< double > v
Published index value, Fahrenheit rounded to 0.01.
Definition models.hpp:3557
std::optional< std::vector< WeatherIndexStationReading > > stations
Per-station audit readings (only with detailed=true), sorted by station ID — every configured member'...
Definition models.hpp:3569
Definition models.hpp:3533
std::string code
Disposition: ok (accepted), missing (no eligible observation), late (received after the deadline; dia...
Definition models.hpp:3539
std::optional< std::string > primary_code
Why the primary observation was passed over when a fallback was selected instead.
Definition models.hpp:3550
std::optional< std::string > source
hf_asos (exact-minute primary) or metar (carried-forward official observation).
Definition models.hpp:3541
std::string station_id
Member station (e.g.
Definition models.hpp:3535
std::optional< double > temp_f
Raw reported temperature in Fahrenheit (unrounded — only the published index value carries output rou...
Definition models.hpp:3544
std::optional< std::int64_t > received_at_ms
Local wire-receipt time backing the eligibility deadline.
Definition models.hpp:3548
std::optional< std::int64_t > obs_time_ms
Observation time for carried-forward fallbacks (differs from the event minute).
Definition models.hpp:3546
Definition models.hpp:2191
std::vector< DailySchedule > sunday
Trading hours for Sunday.
Definition models.hpp:2209
std::vector< DailySchedule > tuesday
Trading hours for Tuesday.
Definition models.hpp:2199
std::vector< DailySchedule > thursday
Trading hours for Thursday.
Definition models.hpp:2203
std::string start_time
Start date and time for when this weekly schedule is effective.
Definition models.hpp:2193
std::vector< DailySchedule > saturday
Trading hours for Saturday.
Definition models.hpp:2207
std::vector< DailySchedule > friday
Trading hours for Friday.
Definition models.hpp:2205
std::vector< DailySchedule > monday
Trading hours for Monday.
Definition models.hpp:2197
std::vector< DailySchedule > wednesday
Trading hours for Wednesday.
Definition models.hpp:2201
std::string end_time
End date and time for when this weekly schedule is no longer effective.
Definition models.hpp:2195
Definition models.hpp:3590
std::string id
Unique identifier for the withdrawal.
Definition models.hpp:3592
std::optional< std::int64_t > finalized_ts
Unix timestamp of when the withdrawal was finalized (applied, failed, or returned).
Definition models.hpp:3604
std::int64_t fee_cents
Fee charged for the withdrawal in cents.
Definition models.hpp:3600
DepositType type
Payment type used for the withdrawal.
Definition models.hpp:3596
std::int64_t created_ts
Unix timestamp of when the withdrawal was created.
Definition models.hpp:3602
DepositStatus status
Current status of the withdrawal.
Definition models.hpp:3594
std::int64_t amount_cents
Withdrawal amount in cents.
Definition models.hpp:3598