kalshi-typescript 3.7.0 → 3.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +6 -2
- package/README.md +8 -3
- package/api/account-api.ts +1 -1
- package/api/api-keys-api.ts +1 -1
- package/api/communications-api.ts +13 -13
- package/api/events-api.ts +32 -24
- package/api/exchange-api.ts +1 -1
- package/api/fcm-api.ts +5 -5
- package/api/historical-api.ts +108 -5
- package/api/incentive-programs-api.ts +1 -1
- package/api/live-data-api.ts +1 -1
- package/api/market-api.ts +32 -24
- package/api/milestone-api.ts +16 -8
- package/api/multivariate-api.ts +5 -5
- package/api/order-groups-api.ts +21 -21
- package/api/orders-api.ts +21 -21
- package/api/portfolio-api.ts +193 -32
- package/api/search-api.ts +1 -1
- package/api/structured-targets-api.ts +1 -1
- package/api.ts +1 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api/account-api.d.ts +1 -1
- package/dist/api/account-api.js +1 -1
- package/dist/api/api-keys-api.d.ts +1 -1
- package/dist/api/api-keys-api.js +1 -1
- package/dist/api/communications-api.d.ts +13 -13
- package/dist/api/communications-api.js +13 -13
- package/dist/api/events-api.d.ts +25 -21
- package/dist/api/events-api.js +31 -24
- package/dist/api/exchange-api.d.ts +1 -1
- package/dist/api/exchange-api.js +1 -1
- package/dist/api/fcm-api.d.ts +5 -5
- package/dist/api/fcm-api.js +5 -5
- package/dist/api/historical-api.d.ts +54 -5
- package/dist/api/historical-api.js +98 -5
- package/dist/api/incentive-programs-api.d.ts +1 -1
- package/dist/api/incentive-programs-api.js +1 -1
- package/dist/api/live-data-api.d.ts +1 -1
- package/dist/api/live-data-api.js +1 -1
- package/dist/api/market-api.d.ts +25 -21
- package/dist/api/market-api.js +31 -24
- package/dist/api/milestone-api.d.ts +9 -5
- package/dist/api/milestone-api.js +15 -8
- package/dist/api/multivariate-api.d.ts +5 -5
- package/dist/api/multivariate-api.js +5 -5
- package/dist/api/order-groups-api.d.ts +21 -21
- package/dist/api/order-groups-api.js +21 -21
- package/dist/api/orders-api.d.ts +21 -21
- package/dist/api/orders-api.js +21 -21
- package/dist/api/portfolio-api.d.ts +95 -29
- package/dist/api/portfolio-api.js +175 -32
- package/dist/api/search-api.d.ts +1 -1
- package/dist/api/search-api.js +1 -1
- package/dist/api/structured-targets-api.d.ts +1 -1
- package/dist/api/structured-targets-api.js +1 -1
- package/dist/api.d.ts +1 -1
- package/dist/api.js +1 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api/account-api.d.ts +1 -1
- package/dist/esm/api/account-api.js +1 -1
- package/dist/esm/api/api-keys-api.d.ts +1 -1
- package/dist/esm/api/api-keys-api.js +1 -1
- package/dist/esm/api/communications-api.d.ts +13 -13
- package/dist/esm/api/communications-api.js +13 -13
- package/dist/esm/api/events-api.d.ts +25 -21
- package/dist/esm/api/events-api.js +31 -24
- package/dist/esm/api/exchange-api.d.ts +1 -1
- package/dist/esm/api/exchange-api.js +1 -1
- package/dist/esm/api/fcm-api.d.ts +5 -5
- package/dist/esm/api/fcm-api.js +5 -5
- package/dist/esm/api/historical-api.d.ts +54 -5
- package/dist/esm/api/historical-api.js +98 -5
- package/dist/esm/api/incentive-programs-api.d.ts +1 -1
- package/dist/esm/api/incentive-programs-api.js +1 -1
- package/dist/esm/api/live-data-api.d.ts +1 -1
- package/dist/esm/api/live-data-api.js +1 -1
- package/dist/esm/api/market-api.d.ts +25 -21
- package/dist/esm/api/market-api.js +31 -24
- package/dist/esm/api/milestone-api.d.ts +9 -5
- package/dist/esm/api/milestone-api.js +15 -8
- package/dist/esm/api/multivariate-api.d.ts +5 -5
- package/dist/esm/api/multivariate-api.js +5 -5
- package/dist/esm/api/order-groups-api.d.ts +21 -21
- package/dist/esm/api/order-groups-api.js +21 -21
- package/dist/esm/api/orders-api.d.ts +21 -21
- package/dist/esm/api/orders-api.js +21 -21
- package/dist/esm/api/portfolio-api.d.ts +95 -29
- package/dist/esm/api/portfolio-api.js +175 -32
- package/dist/esm/api/search-api.d.ts +1 -1
- package/dist/esm/api/search-api.js +1 -1
- package/dist/esm/api/structured-targets-api.d.ts +1 -1
- package/dist/esm/api/structured-targets-api.js +1 -1
- package/dist/esm/api.d.ts +1 -1
- package/dist/esm/api.js +1 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/models/accept-quote-request.d.ts +1 -1
- package/dist/esm/models/accept-quote-request.js +1 -1
- package/dist/esm/models/amend-order-request.d.ts +3 -3
- package/dist/esm/models/amend-order-request.js +1 -1
- package/dist/esm/models/amend-order-response.d.ts +1 -1
- package/dist/esm/models/amend-order-response.js +1 -1
- package/dist/esm/models/announcement.d.ts +1 -1
- package/dist/esm/models/announcement.js +1 -1
- package/dist/esm/models/api-key.d.ts +1 -1
- package/dist/esm/models/api-key.js +1 -1
- package/dist/esm/models/apply-subaccount-transfer-request.d.ts +1 -1
- package/dist/esm/models/apply-subaccount-transfer-request.js +1 -1
- package/dist/esm/models/associated-event.d.ts +1 -1
- package/dist/esm/models/associated-event.js +1 -1
- package/dist/esm/models/batch-cancel-orders-individual-response.d.ts +1 -5
- package/dist/esm/models/batch-cancel-orders-individual-response.js +1 -1
- package/dist/esm/models/batch-cancel-orders-request-order.d.ts +1 -1
- package/dist/esm/models/batch-cancel-orders-request-order.js +1 -1
- package/dist/esm/models/batch-cancel-orders-request.d.ts +1 -1
- package/dist/esm/models/batch-cancel-orders-request.js +1 -1
- package/dist/esm/models/batch-cancel-orders-response.d.ts +1 -1
- package/dist/esm/models/batch-cancel-orders-response.js +1 -1
- package/dist/esm/models/batch-create-orders-individual-response.d.ts +1 -1
- package/dist/esm/models/batch-create-orders-individual-response.js +1 -1
- package/dist/esm/models/batch-create-orders-request.d.ts +1 -1
- package/dist/esm/models/batch-create-orders-request.js +1 -1
- package/dist/esm/models/batch-create-orders-response.d.ts +1 -1
- package/dist/esm/models/batch-create-orders-response.js +1 -1
- package/dist/esm/models/batch-get-market-candlesticks-response.d.ts +1 -1
- package/dist/esm/models/batch-get-market-candlesticks-response.js +1 -1
- package/dist/esm/models/bid-ask-distribution-historical.d.ts +5 -5
- package/dist/esm/models/bid-ask-distribution-historical.js +1 -1
- package/dist/esm/models/bid-ask-distribution.d.ts +5 -21
- package/dist/esm/models/bid-ask-distribution.js +1 -1
- package/dist/esm/models/cancel-order-response.d.ts +1 -2
- package/dist/esm/models/cancel-order-response.js +1 -1
- package/dist/esm/models/create-api-key-request.d.ts +1 -1
- package/dist/esm/models/create-api-key-request.js +1 -1
- package/dist/esm/models/create-api-key-response.d.ts +1 -1
- package/dist/esm/models/create-api-key-response.js +1 -1
- package/dist/esm/models/create-market-in-multivariate-event-collection-request.d.ts +1 -1
- package/dist/esm/models/create-market-in-multivariate-event-collection-request.js +1 -1
- package/dist/esm/models/create-market-in-multivariate-event-collection-response.d.ts +1 -1
- package/dist/esm/models/create-market-in-multivariate-event-collection-response.js +1 -1
- package/dist/esm/models/create-order-group-request.d.ts +1 -1
- package/dist/esm/models/create-order-group-request.js +1 -1
- package/dist/esm/models/create-order-group-response.d.ts +1 -1
- package/dist/esm/models/create-order-group-response.js +1 -1
- package/dist/esm/models/create-order-request.d.ts +3 -3
- package/dist/esm/models/create-order-request.js +1 -1
- package/dist/esm/models/create-order-response.d.ts +1 -1
- package/dist/esm/models/create-order-response.js +1 -1
- package/dist/esm/models/create-quote-request.d.ts +3 -3
- package/dist/esm/models/create-quote-request.js +1 -1
- package/dist/esm/models/create-quote-response.d.ts +1 -1
- package/dist/esm/models/create-quote-response.js +1 -1
- package/dist/esm/models/create-rfqrequest.d.ts +2 -2
- package/dist/esm/models/create-rfqrequest.js +1 -1
- package/dist/esm/models/create-rfqresponse.d.ts +1 -1
- package/dist/esm/models/create-rfqresponse.js +1 -1
- package/dist/esm/models/create-subaccount-response.d.ts +1 -1
- package/dist/esm/models/create-subaccount-response.js +1 -1
- package/dist/esm/models/daily-schedule.d.ts +1 -1
- package/dist/esm/models/daily-schedule.js +1 -1
- package/dist/esm/models/decrease-order-request.d.ts +1 -1
- package/dist/esm/models/decrease-order-request.js +1 -1
- package/dist/esm/models/decrease-order-response.d.ts +1 -1
- package/dist/esm/models/decrease-order-response.js +1 -1
- package/dist/esm/models/error-response.d.ts +1 -1
- package/dist/esm/models/error-response.js +1 -1
- package/dist/esm/models/event-data.d.ts +5 -1
- package/dist/esm/models/event-data.js +1 -1
- package/dist/esm/models/event-position.d.ts +5 -25
- package/dist/esm/models/event-position.js +1 -1
- package/dist/esm/models/exchange-instance.d.ts +1 -1
- package/dist/esm/models/exchange-instance.js +1 -1
- package/dist/esm/models/exchange-status.d.ts +1 -1
- package/dist/esm/models/exchange-status.js +1 -1
- package/dist/esm/models/fill.d.ts +11 -17
- package/dist/esm/models/fill.js +1 -1
- package/dist/esm/models/forecast-percentiles-point.d.ts +1 -1
- package/dist/esm/models/forecast-percentiles-point.js +1 -1
- package/dist/esm/models/generate-api-key-request.d.ts +1 -1
- package/dist/esm/models/generate-api-key-request.js +1 -1
- package/dist/esm/models/generate-api-key-response.d.ts +1 -1
- package/dist/esm/models/generate-api-key-response.js +1 -1
- package/dist/esm/models/get-account-api-limits-response.d.ts +1 -1
- package/dist/esm/models/get-account-api-limits-response.js +1 -1
- package/dist/esm/models/get-api-keys-response.d.ts +1 -1
- package/dist/esm/models/get-api-keys-response.js +1 -1
- package/dist/esm/models/get-balance-response.d.ts +1 -1
- package/dist/esm/models/get-balance-response.js +1 -1
- package/dist/esm/models/get-communications-idresponse.d.ts +1 -1
- package/dist/esm/models/get-communications-idresponse.js +1 -1
- package/dist/esm/models/get-event-candlesticks-response.d.ts +1 -1
- package/dist/esm/models/get-event-candlesticks-response.js +1 -1
- package/dist/esm/models/get-event-forecast-percentiles-history-response.d.ts +1 -1
- package/dist/esm/models/get-event-forecast-percentiles-history-response.js +1 -1
- package/dist/esm/models/get-event-metadata-response.d.ts +1 -1
- package/dist/esm/models/get-event-metadata-response.js +1 -1
- package/dist/esm/models/get-event-response.d.ts +1 -1
- package/dist/esm/models/get-event-response.js +1 -1
- package/dist/esm/models/get-events-response.d.ts +1 -1
- package/dist/esm/models/get-events-response.js +1 -1
- package/dist/esm/models/get-exchange-announcements-response.d.ts +1 -1
- package/dist/esm/models/get-exchange-announcements-response.js +1 -1
- package/dist/esm/models/get-exchange-schedule-response.d.ts +1 -1
- package/dist/esm/models/get-exchange-schedule-response.js +1 -1
- package/dist/esm/models/get-fills-response.d.ts +1 -1
- package/dist/esm/models/get-fills-response.js +1 -1
- package/dist/esm/models/get-filters-by-sports-response.d.ts +1 -1
- package/dist/esm/models/get-filters-by-sports-response.js +1 -1
- package/dist/esm/models/get-historical-cutoff-response.d.ts +1 -1
- package/dist/esm/models/get-historical-cutoff-response.js +1 -1
- package/dist/esm/models/get-incentive-programs-response.d.ts +1 -1
- package/dist/esm/models/get-incentive-programs-response.js +1 -1
- package/dist/esm/models/get-live-data-response.d.ts +1 -1
- package/dist/esm/models/get-live-data-response.js +1 -1
- package/dist/esm/models/get-live-datas-response.d.ts +1 -1
- package/dist/esm/models/get-live-datas-response.js +1 -1
- package/dist/esm/models/get-market-candlesticks-historical-response.d.ts +1 -1
- package/dist/esm/models/get-market-candlesticks-historical-response.js +1 -1
- package/dist/esm/models/get-market-candlesticks-response.d.ts +1 -1
- package/dist/esm/models/get-market-candlesticks-response.js +1 -1
- package/dist/esm/models/get-market-orderbook-response.d.ts +1 -3
- package/dist/esm/models/get-market-orderbook-response.js +1 -1
- package/dist/esm/models/get-market-response.d.ts +1 -1
- package/dist/esm/models/get-market-response.js +1 -1
- package/dist/esm/models/get-markets-response.d.ts +1 -1
- package/dist/esm/models/get-markets-response.js +1 -1
- package/dist/esm/models/get-milestone-response.d.ts +1 -1
- package/dist/esm/models/get-milestone-response.js +1 -1
- package/dist/esm/models/get-milestones-response.d.ts +1 -1
- package/dist/esm/models/get-milestones-response.js +1 -1
- package/dist/esm/models/get-multivariate-event-collection-lookup-history-response.d.ts +1 -1
- package/dist/esm/models/get-multivariate-event-collection-lookup-history-response.js +1 -1
- package/dist/esm/models/get-multivariate-event-collection-response.d.ts +1 -1
- package/dist/esm/models/get-multivariate-event-collection-response.js +1 -1
- package/dist/esm/models/get-multivariate-event-collections-response.d.ts +1 -1
- package/dist/esm/models/get-multivariate-event-collections-response.js +1 -1
- package/dist/esm/models/get-multivariate-events-response.d.ts +1 -1
- package/dist/esm/models/get-multivariate-events-response.js +1 -1
- package/dist/esm/models/get-order-group-response.d.ts +1 -5
- package/dist/esm/models/get-order-group-response.js +1 -1
- package/dist/esm/models/get-order-groups-response.d.ts +1 -1
- package/dist/esm/models/get-order-groups-response.js +1 -1
- package/dist/esm/models/get-order-queue-position-response.d.ts +2 -6
- package/dist/esm/models/get-order-queue-position-response.js +1 -1
- package/dist/esm/models/get-order-queue-positions-response.d.ts +1 -1
- package/dist/esm/models/get-order-queue-positions-response.js +1 -1
- package/dist/esm/models/get-order-response.d.ts +1 -1
- package/dist/esm/models/get-order-response.js +1 -1
- package/dist/esm/models/get-orders-response.d.ts +1 -1
- package/dist/esm/models/get-orders-response.js +1 -1
- package/dist/esm/models/get-portfolio-resting-order-total-value-response.d.ts +1 -1
- package/dist/esm/models/get-portfolio-resting-order-total-value-response.js +1 -1
- package/dist/esm/models/get-positions-response.d.ts +1 -1
- package/dist/esm/models/get-positions-response.js +1 -1
- package/dist/esm/models/get-quote-response.d.ts +1 -1
- package/dist/esm/models/get-quote-response.js +1 -1
- package/dist/esm/models/get-quotes-response.d.ts +1 -1
- package/dist/esm/models/get-quotes-response.js +1 -1
- package/dist/esm/models/get-rfqresponse.d.ts +1 -1
- package/dist/esm/models/get-rfqresponse.js +1 -1
- package/dist/esm/models/get-rfqs-response.d.ts +1 -1
- package/dist/esm/models/get-rfqs-response.js +1 -1
- package/dist/esm/models/get-series-fee-changes-response.d.ts +1 -1
- package/dist/esm/models/get-series-fee-changes-response.js +1 -1
- package/dist/esm/models/get-series-list-response.d.ts +1 -1
- package/dist/esm/models/get-series-list-response.js +1 -1
- package/dist/esm/models/get-series-response.d.ts +1 -1
- package/dist/esm/models/get-series-response.js +1 -1
- package/dist/esm/models/get-settlements-response.d.ts +1 -1
- package/dist/esm/models/get-settlements-response.js +1 -1
- package/dist/esm/models/get-structured-target-response.d.ts +1 -1
- package/dist/esm/models/get-structured-target-response.js +1 -1
- package/dist/esm/models/get-structured-targets-response.d.ts +1 -1
- package/dist/esm/models/get-structured-targets-response.js +1 -1
- package/dist/esm/models/get-subaccount-balances-response.d.ts +1 -1
- package/dist/esm/models/get-subaccount-balances-response.js +1 -1
- package/dist/esm/models/get-subaccount-netting-response.d.ts +15 -0
- package/dist/esm/models/{orderbook.js → get-subaccount-netting-response.js} +1 -1
- package/dist/esm/models/get-subaccount-transfers-response.d.ts +1 -1
- package/dist/esm/models/get-subaccount-transfers-response.js +1 -1
- package/dist/esm/models/get-tags-for-series-categories-response.d.ts +1 -1
- package/dist/esm/models/get-tags-for-series-categories-response.js +1 -1
- package/dist/esm/models/get-trades-response.d.ts +1 -1
- package/dist/esm/models/get-trades-response.js +1 -1
- package/dist/esm/models/get-user-data-timestamp-response.d.ts +1 -1
- package/dist/esm/models/get-user-data-timestamp-response.js +1 -1
- package/dist/esm/models/incentive-program.d.ts +1 -5
- package/dist/esm/models/incentive-program.js +1 -1
- package/dist/esm/models/index.d.ts +3 -1
- package/dist/esm/models/index.js +3 -1
- package/dist/esm/models/intra-exchange-instance-transfer-request.d.ts +1 -1
- package/dist/esm/models/intra-exchange-instance-transfer-request.js +1 -1
- package/dist/esm/models/intra-exchange-instance-transfer-response.d.ts +1 -1
- package/dist/esm/models/intra-exchange-instance-transfer-response.js +1 -1
- package/dist/esm/models/live-data.d.ts +1 -1
- package/dist/esm/models/live-data.js +1 -1
- package/dist/esm/models/lookup-point.d.ts +1 -1
- package/dist/esm/models/lookup-point.js +1 -1
- package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-request.d.ts +1 -1
- package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-request.js +1 -1
- package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-response.d.ts +1 -1
- package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-response.js +1 -1
- package/dist/esm/models/maintenance-window.d.ts +1 -1
- package/dist/esm/models/maintenance-window.js +1 -1
- package/dist/esm/models/market-candlestick-historical.d.ts +1 -1
- package/dist/esm/models/market-candlestick-historical.js +1 -1
- package/dist/esm/models/market-candlestick.d.ts +1 -9
- package/dist/esm/models/market-candlestick.js +1 -1
- package/dist/esm/models/market-candlesticks-response.d.ts +1 -1
- package/dist/esm/models/market-candlesticks-response.js +1 -1
- package/dist/esm/models/market-metadata.d.ts +1 -1
- package/dist/esm/models/market-metadata.js +1 -1
- package/dist/esm/models/market-position.d.ts +5 -25
- package/dist/esm/models/market-position.js +1 -1
- package/dist/esm/models/market.d.ts +16 -68
- package/dist/esm/models/market.js +1 -1
- package/dist/esm/models/milestone.d.ts +7 -1
- package/dist/esm/models/milestone.js +1 -1
- package/dist/esm/models/multivariate-event-collection.d.ts +1 -1
- package/dist/esm/models/multivariate-event-collection.js +1 -1
- package/dist/esm/models/mve-selected-leg.d.ts +2 -2
- package/dist/esm/models/mve-selected-leg.js +1 -1
- package/dist/esm/models/order-group.d.ts +1 -5
- package/dist/esm/models/order-group.js +1 -1
- package/dist/esm/models/order-queue-position.d.ts +2 -6
- package/dist/esm/models/order-queue-position.js +1 -1
- package/dist/esm/models/order-status.d.ts +1 -1
- package/dist/esm/models/order-status.js +1 -1
- package/dist/esm/models/order.d.ts +10 -41
- package/dist/esm/models/order.js +1 -1
- package/dist/esm/models/orderbook-count-fp.d.ts +1 -1
- package/dist/esm/models/orderbook-count-fp.js +1 -1
- package/dist/esm/models/percentile-point.d.ts +1 -1
- package/dist/esm/models/percentile-point.js +1 -1
- package/dist/esm/models/price-distribution-historical.d.ts +1 -1
- package/dist/esm/models/price-distribution-historical.js +1 -1
- package/dist/esm/models/price-distribution.d.ts +9 -41
- package/dist/esm/models/price-distribution.js +1 -1
- package/dist/esm/models/price-range.d.ts +1 -1
- package/dist/esm/models/price-range.js +1 -1
- package/dist/esm/models/quote.d.ts +4 -21
- package/dist/esm/models/quote.js +1 -1
- package/dist/esm/models/rfq.d.ts +3 -12
- package/dist/esm/models/rfq.js +1 -1
- package/dist/esm/models/schedule.d.ts +1 -1
- package/dist/esm/models/schedule.js +1 -1
- package/dist/esm/models/scope-list.d.ts +1 -1
- package/dist/esm/models/scope-list.js +1 -1
- package/dist/esm/models/self-trade-prevention-type.d.ts +1 -1
- package/dist/esm/models/self-trade-prevention-type.js +1 -1
- package/dist/esm/models/series-fee-change.d.ts +1 -1
- package/dist/esm/models/series-fee-change.js +1 -1
- package/dist/esm/models/series.d.ts +5 -5
- package/dist/esm/models/series.js +1 -1
- package/dist/esm/models/settlement-source.d.ts +1 -1
- package/dist/esm/models/settlement-source.js +1 -1
- package/dist/esm/models/settlement.d.ts +12 -10
- package/dist/esm/models/settlement.js +1 -1
- package/dist/esm/models/sport-filter-details.d.ts +1 -1
- package/dist/esm/models/sport-filter-details.js +1 -1
- package/dist/esm/models/structured-target.d.ts +7 -1
- package/dist/esm/models/structured-target.js +1 -1
- package/dist/esm/models/subaccount-balance.d.ts +2 -2
- package/dist/esm/models/subaccount-balance.js +1 -1
- package/dist/esm/models/subaccount-netting-config.d.ts +21 -0
- package/dist/esm/models/subaccount-netting-config.js +14 -0
- package/dist/esm/models/subaccount-transfer.d.ts +1 -1
- package/dist/esm/models/subaccount-transfer.js +1 -1
- package/dist/esm/models/ticker-pair.d.ts +1 -1
- package/dist/esm/models/ticker-pair.js +1 -1
- package/dist/esm/models/trade.d.ts +3 -19
- package/dist/esm/models/trade.js +1 -1
- package/dist/esm/models/update-order-group-limit-request.d.ts +1 -1
- package/dist/esm/models/update-order-group-limit-request.js +1 -1
- package/dist/esm/models/update-subaccount-netting-request.d.ts +21 -0
- package/dist/esm/models/update-subaccount-netting-request.js +14 -0
- package/dist/esm/models/weekly-schedule.d.ts +1 -1
- package/dist/esm/models/weekly-schedule.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/accept-quote-request.d.ts +1 -1
- package/dist/models/accept-quote-request.js +1 -1
- package/dist/models/amend-order-request.d.ts +3 -3
- package/dist/models/amend-order-request.js +1 -1
- package/dist/models/amend-order-response.d.ts +1 -1
- package/dist/models/amend-order-response.js +1 -1
- package/dist/models/announcement.d.ts +1 -1
- package/dist/models/announcement.js +1 -1
- package/dist/models/api-key.d.ts +1 -1
- package/dist/models/api-key.js +1 -1
- package/dist/models/apply-subaccount-transfer-request.d.ts +1 -1
- package/dist/models/apply-subaccount-transfer-request.js +1 -1
- package/dist/models/associated-event.d.ts +1 -1
- package/dist/models/associated-event.js +1 -1
- package/dist/models/batch-cancel-orders-individual-response.d.ts +1 -5
- package/dist/models/batch-cancel-orders-individual-response.js +1 -1
- package/dist/models/batch-cancel-orders-request-order.d.ts +1 -1
- package/dist/models/batch-cancel-orders-request-order.js +1 -1
- package/dist/models/batch-cancel-orders-request.d.ts +1 -1
- package/dist/models/batch-cancel-orders-request.js +1 -1
- package/dist/models/batch-cancel-orders-response.d.ts +1 -1
- package/dist/models/batch-cancel-orders-response.js +1 -1
- package/dist/models/batch-create-orders-individual-response.d.ts +1 -1
- package/dist/models/batch-create-orders-individual-response.js +1 -1
- package/dist/models/batch-create-orders-request.d.ts +1 -1
- package/dist/models/batch-create-orders-request.js +1 -1
- package/dist/models/batch-create-orders-response.d.ts +1 -1
- package/dist/models/batch-create-orders-response.js +1 -1
- package/dist/models/batch-get-market-candlesticks-response.d.ts +1 -1
- package/dist/models/batch-get-market-candlesticks-response.js +1 -1
- package/dist/models/bid-ask-distribution-historical.d.ts +5 -5
- package/dist/models/bid-ask-distribution-historical.js +1 -1
- package/dist/models/bid-ask-distribution.d.ts +5 -21
- package/dist/models/bid-ask-distribution.js +1 -1
- package/dist/models/cancel-order-response.d.ts +1 -2
- package/dist/models/cancel-order-response.js +1 -1
- package/dist/models/create-api-key-request.d.ts +1 -1
- package/dist/models/create-api-key-request.js +1 -1
- package/dist/models/create-api-key-response.d.ts +1 -1
- package/dist/models/create-api-key-response.js +1 -1
- package/dist/models/create-market-in-multivariate-event-collection-request.d.ts +1 -1
- package/dist/models/create-market-in-multivariate-event-collection-request.js +1 -1
- package/dist/models/create-market-in-multivariate-event-collection-response.d.ts +1 -1
- package/dist/models/create-market-in-multivariate-event-collection-response.js +1 -1
- package/dist/models/create-order-group-request.d.ts +1 -1
- package/dist/models/create-order-group-request.js +1 -1
- package/dist/models/create-order-group-response.d.ts +1 -1
- package/dist/models/create-order-group-response.js +1 -1
- package/dist/models/create-order-request.d.ts +3 -3
- package/dist/models/create-order-request.js +1 -1
- package/dist/models/create-order-response.d.ts +1 -1
- package/dist/models/create-order-response.js +1 -1
- package/dist/models/create-quote-request.d.ts +3 -3
- package/dist/models/create-quote-request.js +1 -1
- package/dist/models/create-quote-response.d.ts +1 -1
- package/dist/models/create-quote-response.js +1 -1
- package/dist/models/create-rfqrequest.d.ts +2 -2
- package/dist/models/create-rfqrequest.js +1 -1
- package/dist/models/create-rfqresponse.d.ts +1 -1
- package/dist/models/create-rfqresponse.js +1 -1
- package/dist/models/create-subaccount-response.d.ts +1 -1
- package/dist/models/create-subaccount-response.js +1 -1
- package/dist/models/daily-schedule.d.ts +1 -1
- package/dist/models/daily-schedule.js +1 -1
- package/dist/models/decrease-order-request.d.ts +1 -1
- package/dist/models/decrease-order-request.js +1 -1
- package/dist/models/decrease-order-response.d.ts +1 -1
- package/dist/models/decrease-order-response.js +1 -1
- package/dist/models/error-response.d.ts +1 -1
- package/dist/models/error-response.js +1 -1
- package/dist/models/event-data.d.ts +5 -1
- package/dist/models/event-data.js +1 -1
- package/dist/models/event-position.d.ts +5 -25
- package/dist/models/event-position.js +1 -1
- package/dist/models/exchange-instance.d.ts +1 -1
- package/dist/models/exchange-instance.js +1 -1
- package/dist/models/exchange-status.d.ts +1 -1
- package/dist/models/exchange-status.js +1 -1
- package/dist/models/fill.d.ts +11 -17
- package/dist/models/fill.js +1 -1
- package/dist/models/forecast-percentiles-point.d.ts +1 -1
- package/dist/models/forecast-percentiles-point.js +1 -1
- package/dist/models/generate-api-key-request.d.ts +1 -1
- package/dist/models/generate-api-key-request.js +1 -1
- package/dist/models/generate-api-key-response.d.ts +1 -1
- package/dist/models/generate-api-key-response.js +1 -1
- package/dist/models/get-account-api-limits-response.d.ts +1 -1
- package/dist/models/get-account-api-limits-response.js +1 -1
- package/dist/models/get-api-keys-response.d.ts +1 -1
- package/dist/models/get-api-keys-response.js +1 -1
- package/dist/models/get-balance-response.d.ts +1 -1
- package/dist/models/get-balance-response.js +1 -1
- package/dist/models/get-communications-idresponse.d.ts +1 -1
- package/dist/models/get-communications-idresponse.js +1 -1
- package/dist/models/get-event-candlesticks-response.d.ts +1 -1
- package/dist/models/get-event-candlesticks-response.js +1 -1
- package/dist/models/get-event-forecast-percentiles-history-response.d.ts +1 -1
- package/dist/models/get-event-forecast-percentiles-history-response.js +1 -1
- package/dist/models/get-event-metadata-response.d.ts +1 -1
- package/dist/models/get-event-metadata-response.js +1 -1
- package/dist/models/get-event-response.d.ts +1 -1
- package/dist/models/get-event-response.js +1 -1
- package/dist/models/get-events-response.d.ts +1 -1
- package/dist/models/get-events-response.js +1 -1
- package/dist/models/get-exchange-announcements-response.d.ts +1 -1
- package/dist/models/get-exchange-announcements-response.js +1 -1
- package/dist/models/get-exchange-schedule-response.d.ts +1 -1
- package/dist/models/get-exchange-schedule-response.js +1 -1
- package/dist/models/get-fills-response.d.ts +1 -1
- package/dist/models/get-fills-response.js +1 -1
- package/dist/models/get-filters-by-sports-response.d.ts +1 -1
- package/dist/models/get-filters-by-sports-response.js +1 -1
- package/dist/models/get-historical-cutoff-response.d.ts +1 -1
- package/dist/models/get-historical-cutoff-response.js +1 -1
- package/dist/models/get-incentive-programs-response.d.ts +1 -1
- package/dist/models/get-incentive-programs-response.js +1 -1
- package/dist/models/get-live-data-response.d.ts +1 -1
- package/dist/models/get-live-data-response.js +1 -1
- package/dist/models/get-live-datas-response.d.ts +1 -1
- package/dist/models/get-live-datas-response.js +1 -1
- package/dist/models/get-market-candlesticks-historical-response.d.ts +1 -1
- package/dist/models/get-market-candlesticks-historical-response.js +1 -1
- package/dist/models/get-market-candlesticks-response.d.ts +1 -1
- package/dist/models/get-market-candlesticks-response.js +1 -1
- package/dist/models/get-market-orderbook-response.d.ts +1 -3
- package/dist/models/get-market-orderbook-response.js +1 -1
- package/dist/models/get-market-response.d.ts +1 -1
- package/dist/models/get-market-response.js +1 -1
- package/dist/models/get-markets-response.d.ts +1 -1
- package/dist/models/get-markets-response.js +1 -1
- package/dist/models/get-milestone-response.d.ts +1 -1
- package/dist/models/get-milestone-response.js +1 -1
- package/dist/models/get-milestones-response.d.ts +1 -1
- package/dist/models/get-milestones-response.js +1 -1
- package/dist/models/get-multivariate-event-collection-lookup-history-response.d.ts +1 -1
- package/dist/models/get-multivariate-event-collection-lookup-history-response.js +1 -1
- package/dist/models/get-multivariate-event-collection-response.d.ts +1 -1
- package/dist/models/get-multivariate-event-collection-response.js +1 -1
- package/dist/models/get-multivariate-event-collections-response.d.ts +1 -1
- package/dist/models/get-multivariate-event-collections-response.js +1 -1
- package/dist/models/get-multivariate-events-response.d.ts +1 -1
- package/dist/models/get-multivariate-events-response.js +1 -1
- package/dist/models/get-order-group-response.d.ts +1 -5
- package/dist/models/get-order-group-response.js +1 -1
- package/dist/models/get-order-groups-response.d.ts +1 -1
- package/dist/models/get-order-groups-response.js +1 -1
- package/dist/models/get-order-queue-position-response.d.ts +2 -6
- package/dist/models/get-order-queue-position-response.js +1 -1
- package/dist/models/get-order-queue-positions-response.d.ts +1 -1
- package/dist/models/get-order-queue-positions-response.js +1 -1
- package/dist/models/get-order-response.d.ts +1 -1
- package/dist/models/get-order-response.js +1 -1
- package/dist/models/get-orders-response.d.ts +1 -1
- package/dist/models/get-orders-response.js +1 -1
- package/dist/models/get-portfolio-resting-order-total-value-response.d.ts +1 -1
- package/dist/models/get-portfolio-resting-order-total-value-response.js +1 -1
- package/dist/models/get-positions-response.d.ts +1 -1
- package/dist/models/get-positions-response.js +1 -1
- package/dist/models/get-quote-response.d.ts +1 -1
- package/dist/models/get-quote-response.js +1 -1
- package/dist/models/get-quotes-response.d.ts +1 -1
- package/dist/models/get-quotes-response.js +1 -1
- package/dist/models/get-rfqresponse.d.ts +1 -1
- package/dist/models/get-rfqresponse.js +1 -1
- package/dist/models/get-rfqs-response.d.ts +1 -1
- package/dist/models/get-rfqs-response.js +1 -1
- package/dist/models/get-series-fee-changes-response.d.ts +1 -1
- package/dist/models/get-series-fee-changes-response.js +1 -1
- package/dist/models/get-series-list-response.d.ts +1 -1
- package/dist/models/get-series-list-response.js +1 -1
- package/dist/models/get-series-response.d.ts +1 -1
- package/dist/models/get-series-response.js +1 -1
- package/dist/models/get-settlements-response.d.ts +1 -1
- package/dist/models/get-settlements-response.js +1 -1
- package/dist/models/get-structured-target-response.d.ts +1 -1
- package/dist/models/get-structured-target-response.js +1 -1
- package/dist/models/get-structured-targets-response.d.ts +1 -1
- package/dist/models/get-structured-targets-response.js +1 -1
- package/dist/models/get-subaccount-balances-response.d.ts +1 -1
- package/dist/models/get-subaccount-balances-response.js +1 -1
- package/dist/models/get-subaccount-netting-response.d.ts +15 -0
- package/dist/models/{orderbook.js → get-subaccount-netting-response.js} +1 -1
- package/dist/models/get-subaccount-transfers-response.d.ts +1 -1
- package/dist/models/get-subaccount-transfers-response.js +1 -1
- package/dist/models/get-tags-for-series-categories-response.d.ts +1 -1
- package/dist/models/get-tags-for-series-categories-response.js +1 -1
- package/dist/models/get-trades-response.d.ts +1 -1
- package/dist/models/get-trades-response.js +1 -1
- package/dist/models/get-user-data-timestamp-response.d.ts +1 -1
- package/dist/models/get-user-data-timestamp-response.js +1 -1
- package/dist/models/incentive-program.d.ts +1 -5
- package/dist/models/incentive-program.js +1 -1
- package/dist/models/index.d.ts +3 -1
- package/dist/models/index.js +3 -1
- package/dist/models/intra-exchange-instance-transfer-request.d.ts +1 -1
- package/dist/models/intra-exchange-instance-transfer-request.js +1 -1
- package/dist/models/intra-exchange-instance-transfer-response.d.ts +1 -1
- package/dist/models/intra-exchange-instance-transfer-response.js +1 -1
- package/dist/models/live-data.d.ts +1 -1
- package/dist/models/live-data.js +1 -1
- package/dist/models/lookup-point.d.ts +1 -1
- package/dist/models/lookup-point.js +1 -1
- package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-request.d.ts +1 -1
- package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-request.js +1 -1
- package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-response.d.ts +1 -1
- package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-response.js +1 -1
- package/dist/models/maintenance-window.d.ts +1 -1
- package/dist/models/maintenance-window.js +1 -1
- package/dist/models/market-candlestick-historical.d.ts +1 -1
- package/dist/models/market-candlestick-historical.js +1 -1
- package/dist/models/market-candlestick.d.ts +1 -9
- package/dist/models/market-candlestick.js +1 -1
- package/dist/models/market-candlesticks-response.d.ts +1 -1
- package/dist/models/market-candlesticks-response.js +1 -1
- package/dist/models/market-metadata.d.ts +1 -1
- package/dist/models/market-metadata.js +1 -1
- package/dist/models/market-position.d.ts +5 -25
- package/dist/models/market-position.js +1 -1
- package/dist/models/market.d.ts +16 -68
- package/dist/models/market.js +1 -1
- package/dist/models/milestone.d.ts +7 -1
- package/dist/models/milestone.js +1 -1
- package/dist/models/multivariate-event-collection.d.ts +1 -1
- package/dist/models/multivariate-event-collection.js +1 -1
- package/dist/models/mve-selected-leg.d.ts +2 -2
- package/dist/models/mve-selected-leg.js +1 -1
- package/dist/models/order-group.d.ts +1 -5
- package/dist/models/order-group.js +1 -1
- package/dist/models/order-queue-position.d.ts +2 -6
- package/dist/models/order-queue-position.js +1 -1
- package/dist/models/order-status.d.ts +1 -1
- package/dist/models/order-status.js +1 -1
- package/dist/models/order.d.ts +10 -41
- package/dist/models/order.js +1 -1
- package/dist/models/orderbook-count-fp.d.ts +1 -1
- package/dist/models/orderbook-count-fp.js +1 -1
- package/dist/models/percentile-point.d.ts +1 -1
- package/dist/models/percentile-point.js +1 -1
- package/dist/models/price-distribution-historical.d.ts +1 -1
- package/dist/models/price-distribution-historical.js +1 -1
- package/dist/models/price-distribution.d.ts +9 -41
- package/dist/models/price-distribution.js +1 -1
- package/dist/models/price-range.d.ts +1 -1
- package/dist/models/price-range.js +1 -1
- package/dist/models/quote.d.ts +4 -21
- package/dist/models/quote.js +1 -1
- package/dist/models/rfq.d.ts +3 -12
- package/dist/models/rfq.js +1 -1
- package/dist/models/schedule.d.ts +1 -1
- package/dist/models/schedule.js +1 -1
- package/dist/models/scope-list.d.ts +1 -1
- package/dist/models/scope-list.js +1 -1
- package/dist/models/self-trade-prevention-type.d.ts +1 -1
- package/dist/models/self-trade-prevention-type.js +1 -1
- package/dist/models/series-fee-change.d.ts +1 -1
- package/dist/models/series-fee-change.js +1 -1
- package/dist/models/series.d.ts +5 -5
- package/dist/models/series.js +1 -1
- package/dist/models/settlement-source.d.ts +1 -1
- package/dist/models/settlement-source.js +1 -1
- package/dist/models/settlement.d.ts +12 -10
- package/dist/models/settlement.js +1 -1
- package/dist/models/sport-filter-details.d.ts +1 -1
- package/dist/models/sport-filter-details.js +1 -1
- package/dist/models/structured-target.d.ts +7 -1
- package/dist/models/structured-target.js +1 -1
- package/dist/models/subaccount-balance.d.ts +2 -2
- package/dist/models/subaccount-balance.js +1 -1
- package/dist/models/subaccount-netting-config.d.ts +21 -0
- package/dist/models/subaccount-netting-config.js +15 -0
- package/dist/models/subaccount-transfer.d.ts +1 -1
- package/dist/models/subaccount-transfer.js +1 -1
- package/dist/models/ticker-pair.d.ts +1 -1
- package/dist/models/ticker-pair.js +1 -1
- package/dist/models/trade.d.ts +3 -19
- package/dist/models/trade.js +1 -1
- package/dist/models/update-order-group-limit-request.d.ts +1 -1
- package/dist/models/update-order-group-limit-request.js +1 -1
- package/dist/models/update-subaccount-netting-request.d.ts +21 -0
- package/dist/models/update-subaccount-netting-request.js +15 -0
- package/dist/models/weekly-schedule.d.ts +1 -1
- package/dist/models/weekly-schedule.js +1 -1
- package/docs/AmendOrderRequest.md +2 -2
- package/docs/BatchCancelOrdersIndividualResponse.md +0 -2
- package/docs/BidAskDistribution.md +4 -12
- package/docs/BidAskDistributionHistorical.md +4 -4
- package/docs/CancelOrderResponse.md +0 -2
- package/docs/CommunicationsApi.md +3 -3
- package/docs/CreateOrderRequest.md +2 -2
- package/docs/CreateQuoteRequest.md +2 -2
- package/docs/CreateRFQRequest.md +1 -1
- package/docs/EventData.md +2 -0
- package/docs/EventPosition.md +4 -14
- package/docs/EventsApi.md +5 -4
- package/docs/FcmApi.md +1 -1
- package/docs/Fill.md +7 -11
- package/docs/GetMarketOrderbookResponse.md +0 -2
- package/docs/GetOrderGroupResponse.md +0 -2
- package/docs/GetOrderQueuePositionResponse.md +1 -3
- package/docs/GetSubaccountNettingResponse.md +20 -0
- package/docs/HistoricalApi.md +41 -1
- package/docs/IncentiveProgram.md +0 -2
- package/docs/Market.md +15 -39
- package/docs/MarketApi.md +5 -4
- package/docs/MarketCandlestick.md +0 -4
- package/docs/MarketPosition.md +4 -14
- package/docs/Milestone.md +2 -0
- package/docs/MilestoneApi.md +1 -0
- package/docs/MultivariateApi.md +2 -1
- package/docs/MveSelectedLeg.md +1 -1
- package/docs/Order.md +7 -27
- package/docs/OrderGroup.md +0 -2
- package/docs/OrderGroupsApi.md +5 -5
- package/docs/OrderQueuePosition.md +1 -3
- package/docs/OrdersApi.md +5 -5
- package/docs/PortfolioApi.md +76 -7
- package/docs/PriceDistribution.md +8 -24
- package/docs/Quote.md +3 -11
- package/docs/RFQ.md +2 -6
- package/docs/Series.md +2 -2
- package/docs/Settlement.md +7 -7
- package/docs/StructuredTarget.md +2 -0
- package/docs/SubaccountBalance.md +1 -1
- package/docs/SubaccountNettingConfig.md +22 -0
- package/docs/Trade.md +2 -10
- package/docs/UpdateSubaccountNettingRequest.md +22 -0
- package/index.ts +1 -1
- package/models/accept-quote-request.ts +1 -1
- package/models/amend-order-request.ts +3 -3
- package/models/amend-order-response.ts +1 -1
- package/models/announcement.ts +1 -1
- package/models/api-key.ts +1 -1
- package/models/apply-subaccount-transfer-request.ts +1 -1
- package/models/associated-event.ts +1 -1
- package/models/batch-cancel-orders-individual-response.ts +1 -5
- package/models/batch-cancel-orders-request-order.ts +1 -1
- package/models/batch-cancel-orders-request.ts +1 -1
- package/models/batch-cancel-orders-response.ts +1 -1
- package/models/batch-create-orders-individual-response.ts +1 -1
- package/models/batch-create-orders-request.ts +1 -1
- package/models/batch-create-orders-response.ts +1 -1
- package/models/batch-get-market-candlesticks-response.ts +1 -1
- package/models/bid-ask-distribution-historical.ts +5 -5
- package/models/bid-ask-distribution.ts +5 -21
- package/models/cancel-order-response.ts +1 -2
- package/models/create-api-key-request.ts +1 -1
- package/models/create-api-key-response.ts +1 -1
- package/models/create-market-in-multivariate-event-collection-request.ts +1 -1
- package/models/create-market-in-multivariate-event-collection-response.ts +1 -1
- package/models/create-order-group-request.ts +1 -1
- package/models/create-order-group-response.ts +1 -1
- package/models/create-order-request.ts +3 -3
- package/models/create-order-response.ts +1 -1
- package/models/create-quote-request.ts +3 -3
- package/models/create-quote-response.ts +1 -1
- package/models/create-rfqrequest.ts +2 -2
- package/models/create-rfqresponse.ts +1 -1
- package/models/create-subaccount-response.ts +1 -1
- package/models/daily-schedule.ts +1 -1
- package/models/decrease-order-request.ts +1 -1
- package/models/decrease-order-response.ts +1 -1
- package/models/error-response.ts +1 -1
- package/models/event-data.ts +5 -1
- package/models/event-position.ts +5 -25
- package/models/exchange-instance.ts +1 -1
- package/models/exchange-status.ts +1 -1
- package/models/fill.ts +11 -17
- package/models/forecast-percentiles-point.ts +1 -1
- package/models/generate-api-key-request.ts +1 -1
- package/models/generate-api-key-response.ts +1 -1
- package/models/get-account-api-limits-response.ts +1 -1
- package/models/get-api-keys-response.ts +1 -1
- package/models/get-balance-response.ts +1 -1
- package/models/get-communications-idresponse.ts +1 -1
- package/models/get-event-candlesticks-response.ts +1 -1
- package/models/get-event-forecast-percentiles-history-response.ts +1 -1
- package/models/get-event-metadata-response.ts +1 -1
- package/models/get-event-response.ts +1 -1
- package/models/get-events-response.ts +1 -1
- package/models/get-exchange-announcements-response.ts +1 -1
- package/models/get-exchange-schedule-response.ts +1 -1
- package/models/get-fills-response.ts +1 -1
- package/models/get-filters-by-sports-response.ts +1 -1
- package/models/get-historical-cutoff-response.ts +1 -1
- package/models/get-incentive-programs-response.ts +1 -1
- package/models/get-live-data-response.ts +1 -1
- package/models/get-live-datas-response.ts +1 -1
- package/models/get-market-candlesticks-historical-response.ts +1 -1
- package/models/get-market-candlesticks-response.ts +1 -1
- package/models/get-market-orderbook-response.ts +1 -5
- package/models/get-market-response.ts +1 -1
- package/models/get-markets-response.ts +1 -1
- package/models/get-milestone-response.ts +1 -1
- package/models/get-milestones-response.ts +1 -1
- package/models/get-multivariate-event-collection-lookup-history-response.ts +1 -1
- package/models/get-multivariate-event-collection-response.ts +1 -1
- package/models/get-multivariate-event-collections-response.ts +1 -1
- package/models/get-multivariate-events-response.ts +1 -1
- package/models/get-order-group-response.ts +1 -5
- package/models/get-order-groups-response.ts +1 -1
- package/models/get-order-queue-position-response.ts +2 -6
- package/models/get-order-queue-positions-response.ts +1 -1
- package/models/get-order-response.ts +1 -1
- package/models/get-orders-response.ts +1 -1
- package/models/get-portfolio-resting-order-total-value-response.ts +1 -1
- package/models/get-positions-response.ts +1 -1
- package/models/get-quote-response.ts +1 -1
- package/models/get-quotes-response.ts +1 -1
- package/models/get-rfqresponse.ts +1 -1
- package/models/get-rfqs-response.ts +1 -1
- package/models/get-series-fee-changes-response.ts +1 -1
- package/models/get-series-list-response.ts +1 -1
- package/models/get-series-response.ts +1 -1
- package/models/get-settlements-response.ts +1 -1
- package/models/get-structured-target-response.ts +1 -1
- package/models/get-structured-targets-response.ts +1 -1
- package/models/get-subaccount-balances-response.ts +1 -1
- package/models/get-subaccount-netting-response.ts +23 -0
- package/models/get-subaccount-transfers-response.ts +1 -1
- package/models/get-tags-for-series-categories-response.ts +1 -1
- package/models/get-trades-response.ts +1 -1
- package/models/get-user-data-timestamp-response.ts +1 -1
- package/models/incentive-program.ts +1 -5
- package/models/index.ts +3 -1
- package/models/intra-exchange-instance-transfer-request.ts +1 -1
- package/models/intra-exchange-instance-transfer-response.ts +1 -1
- package/models/live-data.ts +1 -1
- package/models/lookup-point.ts +1 -1
- package/models/lookup-tickers-for-market-in-multivariate-event-collection-request.ts +1 -1
- package/models/lookup-tickers-for-market-in-multivariate-event-collection-response.ts +1 -1
- package/models/maintenance-window.ts +1 -1
- package/models/market-candlestick-historical.ts +1 -1
- package/models/market-candlestick.ts +1 -9
- package/models/market-candlesticks-response.ts +1 -1
- package/models/market-metadata.ts +1 -1
- package/models/market-position.ts +5 -25
- package/models/market.ts +16 -68
- package/models/milestone.ts +5 -1
- package/models/multivariate-event-collection.ts +1 -1
- package/models/mve-selected-leg.ts +2 -2
- package/models/order-group.ts +1 -5
- package/models/order-queue-position.ts +2 -6
- package/models/order-status.ts +1 -1
- package/models/order.ts +10 -41
- package/models/orderbook-count-fp.ts +1 -1
- package/models/percentile-point.ts +1 -1
- package/models/price-distribution-historical.ts +1 -1
- package/models/price-distribution.ts +9 -41
- package/models/price-range.ts +1 -1
- package/models/quote.ts +4 -21
- package/models/rfq.ts +3 -12
- package/models/schedule.ts +1 -1
- package/models/scope-list.ts +1 -1
- package/models/self-trade-prevention-type.ts +1 -1
- package/models/series-fee-change.ts +1 -1
- package/models/series.ts +5 -5
- package/models/settlement-source.ts +1 -1
- package/models/settlement.ts +12 -10
- package/models/sport-filter-details.ts +1 -1
- package/models/structured-target.ts +5 -1
- package/models/subaccount-balance.ts +2 -2
- package/models/subaccount-netting-config.ts +27 -0
- package/models/subaccount-transfer.ts +1 -1
- package/models/ticker-pair.ts +1 -1
- package/models/trade.ts +3 -19
- package/models/update-order-group-limit-request.ts +1 -1
- package/models/update-subaccount-netting-request.ts +27 -0
- package/models/weekly-schedule.ts +1 -1
- package/package.json +1 -1
- package/dist/esm/models/orderbook.d.ts +0 -20
- package/dist/models/orderbook.d.ts +0 -20
- package/docs/Orderbook.md +0 -27
- package/models/orderbook.ts +0 -26
|
@@ -5,7 +5,6 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**orderbook** | [**Orderbook**](Orderbook.md) | | [default to undefined]
|
|
9
8
|
**orderbook_fp** | [**OrderbookCountFp**](OrderbookCountFp.md) | | [default to undefined]
|
|
10
9
|
|
|
11
10
|
## Example
|
|
@@ -14,7 +13,6 @@ Name | Type | Description | Notes
|
|
|
14
13
|
import { GetMarketOrderbookResponse } from 'kalshi-typescript';
|
|
15
14
|
|
|
16
15
|
const instance: GetMarketOrderbookResponse = {
|
|
17
|
-
orderbook,
|
|
18
16
|
orderbook_fp,
|
|
19
17
|
};
|
|
20
18
|
```
|
|
@@ -6,7 +6,6 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**is_auto_cancel_enabled** | **boolean** | Whether auto-cancel is enabled for this order group | [default to undefined]
|
|
9
|
-
**contracts_limit** | **number** | Current maximum contracts allowed over a rolling 15-second window (whole contracts only). | [optional] [default to undefined]
|
|
10
9
|
**contracts_limit_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [optional] [default to undefined]
|
|
11
10
|
**orders** | **Array<string>** | List of order IDs that belong to this order group | [default to undefined]
|
|
12
11
|
|
|
@@ -17,7 +16,6 @@ import { GetOrderGroupResponse } from 'kalshi-typescript';
|
|
|
17
16
|
|
|
18
17
|
const instance: GetOrderGroupResponse = {
|
|
19
18
|
is_auto_cancel_enabled,
|
|
20
|
-
contracts_limit,
|
|
21
19
|
contracts_limit_fp,
|
|
22
20
|
orders,
|
|
23
21
|
};
|
|
@@ -5,8 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**
|
|
9
|
-
**queue_position_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [optional] [default to undefined]
|
|
8
|
+
**queue_position_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
|
|
10
9
|
|
|
11
10
|
## Example
|
|
12
11
|
|
|
@@ -14,7 +13,6 @@ Name | Type | Description | Notes
|
|
|
14
13
|
import { GetOrderQueuePositionResponse } from 'kalshi-typescript';
|
|
15
14
|
|
|
16
15
|
const instance: GetOrderQueuePositionResponse = {
|
|
17
|
-
queue_position,
|
|
18
16
|
queue_position_fp,
|
|
19
17
|
};
|
|
20
18
|
```
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# GetSubaccountNettingResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**netting_configs** | [**Array<SubaccountNettingConfig>**](SubaccountNettingConfig.md) | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { GetSubaccountNettingResponse } from 'kalshi-typescript';
|
|
14
|
+
|
|
15
|
+
const instance: GetSubaccountNettingResponse = {
|
|
16
|
+
netting_configs,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/HistoricalApi.md
CHANGED
|
@@ -10,6 +10,7 @@ All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
|
|
|
10
10
|
|[**getHistoricalMarkets**](#gethistoricalmarkets) | **GET** /historical/markets | Get Historical Markets|
|
|
11
11
|
|[**getHistoricalOrders**](#gethistoricalorders) | **GET** /historical/orders | Get Historical Orders|
|
|
12
12
|
|[**getMarketCandlesticksHistorical**](#getmarketcandlestickshistorical) | **GET** /historical/markets/{ticker}/candlesticks | Get Historical Market Candlesticks|
|
|
13
|
+
|[**getTradesHistorical**](#gettradeshistorical) | **GET** /historical/trades | Get Historical Trades|
|
|
13
14
|
|
|
14
15
|
# **getFillsHistorical**
|
|
15
16
|
> GetFillsResponse getFillsHistorical()
|
|
@@ -46,6 +47,7 @@ All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
|
|
|
46
47
|
|**200** | Fills retrieved successfully | - |
|
|
47
48
|
|**400** | Bad request | - |
|
|
48
49
|
|**401** | Unauthorized | - |
|
|
50
|
+
|**404** | Resource not found | - |
|
|
49
51
|
|**500** | Internal server error | - |
|
|
50
52
|
|
|
51
53
|
# **getHistoricalCutoff**
|
|
@@ -122,7 +124,7 @@ Endpoint for getting markets that have been archived to the historical database.
|
|
|
122
124
|
| **limit** | [**number**] | Number of results per page. Defaults to 100. Maximum value is 1000. | (optional) defaults to 100|
|
|
123
125
|
| **cursor** | [**string**] | Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. | (optional) defaults to undefined|
|
|
124
126
|
| **tickers** | [**string**] | Filter by specific market tickers. Comma-separated list of market tickers to retrieve. | (optional) defaults to undefined|
|
|
125
|
-
| **eventTicker** | [**string**] | Event ticker
|
|
127
|
+
| **eventTicker** | [**string**] | Event ticker to filter by. Only a single event ticker is supported. | (optional) defaults to undefined|
|
|
126
128
|
| **mveFilter** | [**'exclude'**]**Array<'exclude'>** | Filter by multivariate events (combos). By default, MVE markets are included. | (optional) defaults to undefined|
|
|
127
129
|
|
|
128
130
|
|
|
@@ -221,3 +223,41 @@ No authorization required
|
|
|
221
223
|
|**404** | Not found | - |
|
|
222
224
|
|**500** | Internal server error | - |
|
|
223
225
|
|
|
226
|
+
# **getTradesHistorical**
|
|
227
|
+
> GetTradesResponse getTradesHistorical()
|
|
228
|
+
|
|
229
|
+
Endpoint for getting all historical trades for all markets. Trades that were filled before the historical cutoff are available via this endpoint. See [Historical Data](https://kalshi.com/docs/getting_started/historical_data) for details.
|
|
230
|
+
|
|
231
|
+
### Parameters
|
|
232
|
+
|
|
233
|
+
|Name | Type | Description | Notes|
|
|
234
|
+
|------------- | ------------- | ------------- | -------------|
|
|
235
|
+
| **ticker** | [**string**] | Filter by market ticker | (optional) defaults to undefined|
|
|
236
|
+
| **minTs** | [**number**] | Filter items after this Unix timestamp | (optional) defaults to undefined|
|
|
237
|
+
| **maxTs** | [**number**] | Filter items before this Unix timestamp | (optional) defaults to undefined|
|
|
238
|
+
| **limit** | [**number**] | Number of results per page. Defaults to 100. Maximum value is 1000. | (optional) defaults to 100|
|
|
239
|
+
| **cursor** | [**string**] | Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. | (optional) defaults to undefined|
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
### Return type
|
|
243
|
+
|
|
244
|
+
**GetTradesResponse**
|
|
245
|
+
|
|
246
|
+
### Authorization
|
|
247
|
+
|
|
248
|
+
No authorization required
|
|
249
|
+
|
|
250
|
+
### HTTP request headers
|
|
251
|
+
|
|
252
|
+
- **Content-Type**: Not defined
|
|
253
|
+
- **Accept**: application/json
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
### HTTP response details
|
|
257
|
+
| Status code | Description | Response headers |
|
|
258
|
+
|-------------|-------------|------------------|
|
|
259
|
+
|**200** | Historical trades retrieved successfully | - |
|
|
260
|
+
|**400** | Bad request - invalid input | - |
|
|
261
|
+
|**404** | Resource not found | - |
|
|
262
|
+
|**500** | Internal server error | - |
|
|
263
|
+
|
package/docs/IncentiveProgram.md
CHANGED
|
@@ -14,7 +14,6 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**period_reward** | **number** | Total reward for the period in centi-cents | [default to undefined]
|
|
15
15
|
**paid_out** | **boolean** | Whether the incentive has been paid out | [default to undefined]
|
|
16
16
|
**discount_factor_bps** | **number** | Discount factor in basis points (optional) | [optional] [default to undefined]
|
|
17
|
-
**target_size** | **number** | Target size for the incentive program (optional) | [optional] [default to undefined]
|
|
18
17
|
**target_size_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [optional] [default to undefined]
|
|
19
18
|
|
|
20
19
|
## Example
|
|
@@ -32,7 +31,6 @@ const instance: IncentiveProgram = {
|
|
|
32
31
|
period_reward,
|
|
33
32
|
paid_out,
|
|
34
33
|
discount_factor_bps,
|
|
35
|
-
target_size,
|
|
36
34
|
target_size_fp,
|
|
37
35
|
};
|
|
38
36
|
```
|
package/docs/Market.md
CHANGED
|
@@ -22,37 +22,25 @@ Name | Type | Description | Notes
|
|
|
22
22
|
**settlement_timer_seconds** | **number** | The amount of time after determination that the market settles | [default to undefined]
|
|
23
23
|
**status** | **string** | The current status of the market in its lifecycle. | [default to undefined]
|
|
24
24
|
**response_price_units** | **string** | DEPRECATED: Use price_level_structure and price_ranges instead. | [default to undefined]
|
|
25
|
-
**
|
|
26
|
-
**
|
|
27
|
-
**
|
|
28
|
-
**
|
|
29
|
-
**
|
|
30
|
-
**
|
|
31
|
-
**
|
|
32
|
-
**no_ask_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
33
|
-
**last_price** | **number** | DEPRECATED: Use last_price_dollars instead. | [default to undefined]
|
|
34
|
-
**last_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
35
|
-
**volume** | **number** | | [default to undefined]
|
|
25
|
+
**yes_bid_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
26
|
+
**yes_bid_size_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
|
|
27
|
+
**yes_ask_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
28
|
+
**yes_ask_size_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
|
|
29
|
+
**no_bid_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
30
|
+
**no_ask_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
31
|
+
**last_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
36
32
|
**volume_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
|
|
37
|
-
**volume_24h** | **number** | | [default to undefined]
|
|
38
33
|
**volume_24h_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
|
|
39
34
|
**result** | **string** | | [default to undefined]
|
|
40
35
|
**can_close_early** | **boolean** | | [default to undefined]
|
|
41
36
|
**fractional_trading_enabled** | **boolean** | | [default to undefined]
|
|
42
|
-
**open_interest** | **number** | Number of contracts bought on this market disconsidering netting | [default to undefined]
|
|
43
37
|
**open_interest_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
|
|
44
|
-
**
|
|
45
|
-
**
|
|
46
|
-
**
|
|
47
|
-
**
|
|
48
|
-
**
|
|
49
|
-
**
|
|
50
|
-
**previous_price** | **number** | DEPRECATED: Use previous_price_dollars instead. | [default to undefined]
|
|
51
|
-
**previous_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
52
|
-
**liquidity** | **number** | DEPRECATED: This field is deprecated and will always return 0. | [default to undefined]
|
|
53
|
-
**liquidity_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
54
|
-
**settlement_value** | **number** | The settlement value of the YES/LONG side of the contract in cents. Only filled after determination | [optional] [default to undefined]
|
|
55
|
-
**settlement_value_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [optional] [default to undefined]
|
|
38
|
+
**notional_value_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
39
|
+
**previous_yes_bid_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
40
|
+
**previous_yes_ask_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
41
|
+
**previous_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
42
|
+
**liquidity_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
43
|
+
**settlement_value_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [optional] [default to undefined]
|
|
56
44
|
**settlement_ts** | **string** | Timestamp when the market was settled. Only filled for settled markets | [optional] [default to undefined]
|
|
57
45
|
**expiration_value** | **string** | The value that was considered for the settlement | [default to undefined]
|
|
58
46
|
**fee_waiver_expiration_time** | **string** | Time when this market\'s fee waiver expires | [optional] [default to undefined]
|
|
@@ -95,36 +83,24 @@ const instance: Market = {
|
|
|
95
83
|
settlement_timer_seconds,
|
|
96
84
|
status,
|
|
97
85
|
response_price_units,
|
|
98
|
-
yes_bid,
|
|
99
86
|
yes_bid_dollars,
|
|
100
|
-
|
|
87
|
+
yes_bid_size_fp,
|
|
101
88
|
yes_ask_dollars,
|
|
102
|
-
|
|
89
|
+
yes_ask_size_fp,
|
|
103
90
|
no_bid_dollars,
|
|
104
|
-
no_ask,
|
|
105
91
|
no_ask_dollars,
|
|
106
|
-
last_price,
|
|
107
92
|
last_price_dollars,
|
|
108
|
-
volume,
|
|
109
93
|
volume_fp,
|
|
110
|
-
volume_24h,
|
|
111
94
|
volume_24h_fp,
|
|
112
95
|
result,
|
|
113
96
|
can_close_early,
|
|
114
97
|
fractional_trading_enabled,
|
|
115
|
-
open_interest,
|
|
116
98
|
open_interest_fp,
|
|
117
|
-
notional_value,
|
|
118
99
|
notional_value_dollars,
|
|
119
|
-
previous_yes_bid,
|
|
120
100
|
previous_yes_bid_dollars,
|
|
121
|
-
previous_yes_ask,
|
|
122
101
|
previous_yes_ask_dollars,
|
|
123
|
-
previous_price,
|
|
124
102
|
previous_price_dollars,
|
|
125
|
-
liquidity,
|
|
126
103
|
liquidity_dollars,
|
|
127
|
-
settlement_value,
|
|
128
104
|
settlement_value_dollars,
|
|
129
105
|
settlement_ts,
|
|
130
106
|
expiration_value,
|
package/docs/MarketApi.md
CHANGED
|
@@ -88,7 +88,7 @@ No authorization required
|
|
|
88
88
|
# **getMarketCandlesticks**
|
|
89
89
|
> GetMarketCandlesticksResponse getMarketCandlesticks()
|
|
90
90
|
|
|
91
|
-
Time period length of each candlestick in minutes. Valid values: 1 (1 minute), 60 (1 hour), 1440 (1 day).
|
|
91
|
+
Time period length of each candlestick in minutes. Valid values: 1 (1 minute), 60 (1 hour), 1440 (1 day). Candlesticks for markets that settled before the historical cutoff are only available via `GET /historical/markets/{ticker}/candlesticks`. See [Historical Data](https://kalshi.com/docs/getting_started/historical_data) for details.
|
|
92
92
|
|
|
93
93
|
### Parameters
|
|
94
94
|
|
|
@@ -162,7 +162,7 @@ No authorization required
|
|
|
162
162
|
# **getMarkets**
|
|
163
163
|
> GetMarketsResponse getMarkets()
|
|
164
164
|
|
|
165
|
-
Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled`. Leave empty to return markets with any status. - Only one `status` filter may be supplied at a time. - Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters. | Compatible Timestamp Filters | Additional Status Filters| Extra Notes | |------------------------------|--------------------------|-------------| | min_created_ts, max_created_ts | `unopened`, `open`, *empty* | | | min_close_ts, max_close_ts | `closed`, *empty* | | | min_settled_ts, max_settled_ts | `settled`, *empty* | | | min_updated_ts | *empty* | Incompatible with all filters besides `mve_filter=exclude` |
|
|
165
|
+
Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled`. Leave empty to return markets with any status. - Only one `status` filter may be supplied at a time. - Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters. | Compatible Timestamp Filters | Additional Status Filters| Extra Notes | |------------------------------|--------------------------|-------------| | min_created_ts, max_created_ts | `unopened`, `open`, *empty* | | | min_close_ts, max_close_ts | `closed`, *empty* | | | min_settled_ts, max_settled_ts | `settled`, *empty* | | | min_updated_ts | *empty* | Incompatible with all filters besides `mve_filter=exclude` | Markets that settled before the historical cutoff are only available via `GET /historical/markets`. See [Historical Data](https://kalshi.com/docs/getting_started/historical_data) for details.
|
|
166
166
|
|
|
167
167
|
### Parameters
|
|
168
168
|
|
|
@@ -170,7 +170,7 @@ Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled
|
|
|
170
170
|
|------------- | ------------- | ------------- | -------------|
|
|
171
171
|
| **limit** | [**number**] | Number of results per page. Defaults to 100. Maximum value is 1000. | (optional) defaults to 100|
|
|
172
172
|
| **cursor** | [**string**] | Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. | (optional) defaults to undefined|
|
|
173
|
-
| **eventTicker** | [**string**] | Event ticker
|
|
173
|
+
| **eventTicker** | [**string**] | Event ticker to filter by. Only a single event ticker is supported. | (optional) defaults to undefined|
|
|
174
174
|
| **seriesTicker** | [**string**] | Filter by series ticker | (optional) defaults to undefined|
|
|
175
175
|
| **minCreatedTs** | [**number**] | Filter items that created after this Unix timestamp | (optional) defaults to undefined|
|
|
176
176
|
| **maxCreatedTs** | [**number**] | Filter items that created before this Unix timestamp | (optional) defaults to undefined|
|
|
@@ -253,6 +253,7 @@ No authorization required
|
|
|
253
253
|
| **tags** | [**string**] | | (optional) defaults to undefined|
|
|
254
254
|
| **includeProductMetadata** | [**boolean**] | | (optional) defaults to false|
|
|
255
255
|
| **includeVolume** | [**boolean**] | If true, includes the total volume traded across all events in each series. | (optional) defaults to false|
|
|
256
|
+
| **minUpdatedTs** | [**number**] | Filter series with metadata updated after this Unix timestamp (in seconds). Use this to efficiently poll for changes. | (optional) defaults to undefined|
|
|
256
257
|
|
|
257
258
|
|
|
258
259
|
### Return type
|
|
@@ -279,7 +280,7 @@ No authorization required
|
|
|
279
280
|
# **getTrades**
|
|
280
281
|
> GetTradesResponse getTrades()
|
|
281
282
|
|
|
282
|
-
|
|
283
|
+
Endpoint for getting all trades for all markets. A trade represents a completed transaction between two users on a specific market. Each trade includes the market ticker, price, quantity, and timestamp information. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
|
|
283
284
|
|
|
284
285
|
### Parameters
|
|
285
286
|
|
|
@@ -9,9 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**yes_bid** | [**BidAskDistribution**](BidAskDistribution.md) | | [default to undefined]
|
|
10
10
|
**yes_ask** | [**BidAskDistribution**](BidAskDistribution.md) | | [default to undefined]
|
|
11
11
|
**price** | [**PriceDistribution**](PriceDistribution.md) | | [default to undefined]
|
|
12
|
-
**volume** | **number** | Number of contracts bought on the market during the candlestick period. | [default to undefined]
|
|
13
12
|
**volume_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
|
|
14
|
-
**open_interest** | **number** | Number of contracts bought on the market by end of the candlestick period (end_period_ts). | [default to undefined]
|
|
15
13
|
**open_interest_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
|
|
16
14
|
|
|
17
15
|
## Example
|
|
@@ -24,9 +22,7 @@ const instance: MarketCandlestick = {
|
|
|
24
22
|
yes_bid,
|
|
25
23
|
yes_ask,
|
|
26
24
|
price,
|
|
27
|
-
volume,
|
|
28
25
|
volume_fp,
|
|
29
|
-
open_interest,
|
|
30
26
|
open_interest_fp,
|
|
31
27
|
};
|
|
32
28
|
```
|
package/docs/MarketPosition.md
CHANGED
|
@@ -6,17 +6,12 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**ticker** | **string** | Unique identifier for the market | [default to undefined]
|
|
9
|
-
**
|
|
10
|
-
**total_traded_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
11
|
-
**position** | **number** | Number of contracts bought in this market. Negative means NO contracts and positive means YES contracts | [default to undefined]
|
|
9
|
+
**total_traded_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
12
10
|
**position_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
|
|
13
|
-
**
|
|
14
|
-
**
|
|
15
|
-
**realized_pnl** | **number** | Locked in profit and loss, in cents | [default to undefined]
|
|
16
|
-
**realized_pnl_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
11
|
+
**market_exposure_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
12
|
+
**realized_pnl_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
17
13
|
**resting_orders_count** | **number** | [DEPRECATED] Aggregate size of resting orders in contract units | [default to undefined]
|
|
18
|
-
**
|
|
19
|
-
**fees_paid_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
14
|
+
**fees_paid_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
20
15
|
**last_updated_ts** | **string** | Last time the position is updated | [optional] [default to undefined]
|
|
21
16
|
|
|
22
17
|
## Example
|
|
@@ -26,16 +21,11 @@ import { MarketPosition } from 'kalshi-typescript';
|
|
|
26
21
|
|
|
27
22
|
const instance: MarketPosition = {
|
|
28
23
|
ticker,
|
|
29
|
-
total_traded,
|
|
30
24
|
total_traded_dollars,
|
|
31
|
-
position,
|
|
32
25
|
position_fp,
|
|
33
|
-
market_exposure,
|
|
34
26
|
market_exposure_dollars,
|
|
35
|
-
realized_pnl,
|
|
36
27
|
realized_pnl_dollars,
|
|
37
28
|
resting_orders_count,
|
|
38
|
-
fees_paid,
|
|
39
29
|
fees_paid_dollars,
|
|
40
30
|
last_updated_ts,
|
|
41
31
|
};
|
package/docs/Milestone.md
CHANGED
|
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**title** | **string** | Title of the milestone. | [default to undefined]
|
|
15
15
|
**notification_message** | **string** | Notification message for the milestone. | [default to undefined]
|
|
16
16
|
**source_id** | **string** | Source id of milestone if available. | [optional] [default to undefined]
|
|
17
|
+
**source_ids** | **{ [key: string]: string; }** | Source ids of milestone if available. | [optional] [default to undefined]
|
|
17
18
|
**details** | **{ [key: string]: any; }** | Additional details about the milestone. | [default to undefined]
|
|
18
19
|
**primary_event_tickers** | **Array<string>** | List of event tickers directly related to the outcome of this milestone. | [default to undefined]
|
|
19
20
|
**last_updated_ts** | **string** | Last time this structured target was updated. | [default to undefined]
|
|
@@ -33,6 +34,7 @@ const instance: Milestone = {
|
|
|
33
34
|
title,
|
|
34
35
|
notification_message,
|
|
35
36
|
source_id,
|
|
37
|
+
source_ids,
|
|
36
38
|
details,
|
|
37
39
|
primary_event_tickers,
|
|
38
40
|
last_updated_ts,
|
package/docs/MilestoneApi.md
CHANGED
|
@@ -59,6 +59,7 @@ Minimum start date to filter milestones. Format: RFC3339 timestamp
|
|
|
59
59
|
| **type** | [**string**] | Filter by milestone type | (optional) defaults to undefined|
|
|
60
60
|
| **relatedEventTicker** | [**string**] | Filter by related event ticker | (optional) defaults to undefined|
|
|
61
61
|
| **cursor** | [**string**] | Pagination cursor. Use the cursor value returned from the previous response to get the next page of results | (optional) defaults to undefined|
|
|
62
|
+
| **minUpdatedTs** | [**number**] | Filter milestones with metadata updated after this Unix timestamp (in seconds). Use this to efficiently poll for changes. | (optional) defaults to undefined|
|
|
62
63
|
|
|
63
64
|
|
|
64
65
|
### Return type
|
package/docs/MultivariateApi.md
CHANGED
|
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
|
|
|
13
13
|
# **createMarketInMultivariateEventCollection**
|
|
14
14
|
> CreateMarketInMultivariateEventCollectionResponse createMarketInMultivariateEventCollection(createMarketInMultivariateEventCollectionRequest)
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Endpoint for creating an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market. Users are limited to 5000 creations per week.
|
|
17
17
|
|
|
18
18
|
### Parameters
|
|
19
19
|
|
|
@@ -43,6 +43,7 @@ All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
|
|
|
43
43
|
|**200** | Market created successfully | - |
|
|
44
44
|
|**400** | Bad request - invalid input | - |
|
|
45
45
|
|**401** | Unauthorized - authentication required | - |
|
|
46
|
+
|**429** | Rate limit exceeded | - |
|
|
46
47
|
|**500** | Internal server error | - |
|
|
47
48
|
|
|
48
49
|
# **getMultivariateEventCollection**
|
package/docs/MveSelectedLeg.md
CHANGED
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**event_ticker** | **string** | Unique identifier for the selected event | [optional] [default to undefined]
|
|
9
9
|
**market_ticker** | **string** | Unique identifier for the selected market | [optional] [default to undefined]
|
|
10
10
|
**side** | **string** | The side of the selected market | [optional] [default to undefined]
|
|
11
|
-
**yes_settlement_value_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to
|
|
11
|
+
**yes_settlement_value_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
package/docs/Order.md
CHANGED
|
@@ -13,32 +13,22 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**action** | **string** | | [default to undefined]
|
|
14
14
|
**type** | **string** | | [default to undefined]
|
|
15
15
|
**status** | [**OrderStatus**](OrderStatus.md) | | [default to undefined]
|
|
16
|
-
**
|
|
17
|
-
**
|
|
18
|
-
**yes_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
19
|
-
**no_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
20
|
-
**fill_count** | **number** | The number of contracts that have been filled | [default to undefined]
|
|
16
|
+
**yes_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
17
|
+
**no_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
21
18
|
**fill_count_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
|
|
22
|
-
**remaining_count** | **number** | | [default to undefined]
|
|
23
19
|
**remaining_count_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
|
|
24
|
-
**initial_count** | **number** | The initial size of the order (contract units) | [default to undefined]
|
|
25
20
|
**initial_count_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
|
|
26
|
-
**
|
|
27
|
-
**
|
|
28
|
-
**
|
|
29
|
-
**
|
|
30
|
-
**taker_fill_cost_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
31
|
-
**maker_fill_cost_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
32
|
-
**queue_position** | **number** | **DEPRECATED**: This field is deprecated and will always return 0. Please use the GET /portfolio/orders/{order_id}/queue_position endpoint instead | [default to undefined]
|
|
33
|
-
**taker_fees_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [optional] [default to undefined]
|
|
34
|
-
**maker_fees_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [optional] [default to undefined]
|
|
21
|
+
**taker_fill_cost_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
22
|
+
**maker_fill_cost_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
23
|
+
**taker_fees_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
24
|
+
**maker_fees_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
35
25
|
**expiration_time** | **string** | | [optional] [default to undefined]
|
|
36
26
|
**created_time** | **string** | | [optional] [default to undefined]
|
|
37
27
|
**last_update_time** | **string** | The last update to an order (modify, cancel, fill) | [optional] [default to undefined]
|
|
38
28
|
**self_trade_prevention_type** | [**SelfTradePreventionType**](SelfTradePreventionType.md) | | [optional] [default to undefined]
|
|
39
29
|
**order_group_id** | **string** | The order group this order is part of | [optional] [default to undefined]
|
|
40
30
|
**cancel_order_on_pause** | **boolean** | If this flag is set to true, the order will be canceled if the order is open and trading on the exchange is paused for any reason. | [optional] [default to undefined]
|
|
41
|
-
**subaccount_number** | **number** | Subaccount number (0 for primary, 1-32 for subaccounts).
|
|
31
|
+
**subaccount_number** | **number** | Subaccount number (0 for primary, 1-32 for subaccounts). | [optional] [default to undefined]
|
|
42
32
|
|
|
43
33
|
## Example
|
|
44
34
|
|
|
@@ -54,23 +44,13 @@ const instance: Order = {
|
|
|
54
44
|
action,
|
|
55
45
|
type,
|
|
56
46
|
status,
|
|
57
|
-
yes_price,
|
|
58
|
-
no_price,
|
|
59
47
|
yes_price_dollars,
|
|
60
48
|
no_price_dollars,
|
|
61
|
-
fill_count,
|
|
62
49
|
fill_count_fp,
|
|
63
|
-
remaining_count,
|
|
64
50
|
remaining_count_fp,
|
|
65
|
-
initial_count,
|
|
66
51
|
initial_count_fp,
|
|
67
|
-
taker_fees,
|
|
68
|
-
maker_fees,
|
|
69
|
-
taker_fill_cost,
|
|
70
|
-
maker_fill_cost,
|
|
71
52
|
taker_fill_cost_dollars,
|
|
72
53
|
maker_fill_cost_dollars,
|
|
73
|
-
queue_position,
|
|
74
54
|
taker_fees_dollars,
|
|
75
55
|
maker_fees_dollars,
|
|
76
56
|
expiration_time,
|
package/docs/OrderGroup.md
CHANGED
|
@@ -6,7 +6,6 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**id** | **string** | Unique identifier for the order group | [default to undefined]
|
|
9
|
-
**contracts_limit** | **number** | Current maximum contracts allowed over a rolling 15-second window (whole contracts only). | [optional] [default to undefined]
|
|
10
9
|
**contracts_limit_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [optional] [default to undefined]
|
|
11
10
|
**is_auto_cancel_enabled** | **boolean** | Whether auto-cancel is enabled for this order group | [default to undefined]
|
|
12
11
|
|
|
@@ -17,7 +16,6 @@ import { OrderGroup } from 'kalshi-typescript';
|
|
|
17
16
|
|
|
18
17
|
const instance: OrderGroup = {
|
|
19
18
|
id,
|
|
20
|
-
contracts_limit,
|
|
21
19
|
contracts_limit_fp,
|
|
22
20
|
is_auto_cancel_enabled,
|
|
23
21
|
};
|
package/docs/OrderGroupsApi.md
CHANGED
|
@@ -56,7 +56,7 @@ All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
|
|
|
56
56
|
|Name | Type | Description | Notes|
|
|
57
57
|
|------------- | ------------- | ------------- | -------------|
|
|
58
58
|
| **orderGroupId** | [**string**] | Order group ID | defaults to undefined|
|
|
59
|
-
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts).
|
|
59
|
+
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
|
|
60
60
|
|
|
61
61
|
|
|
62
62
|
### Return type
|
|
@@ -91,7 +91,7 @@ All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
|
|
|
91
91
|
|Name | Type | Description | Notes|
|
|
92
92
|
|------------- | ------------- | ------------- | -------------|
|
|
93
93
|
| **orderGroupId** | [**string**] | Order group ID | defaults to undefined|
|
|
94
|
-
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). If omitted,
|
|
94
|
+
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts. | (optional) defaults to undefined|
|
|
95
95
|
|
|
96
96
|
|
|
97
97
|
### Return type
|
|
@@ -125,7 +125,7 @@ All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
|
|
|
125
125
|
|
|
126
126
|
|Name | Type | Description | Notes|
|
|
127
127
|
|------------- | ------------- | ------------- | -------------|
|
|
128
|
-
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). If omitted,
|
|
128
|
+
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts. | (optional) defaults to undefined|
|
|
129
129
|
|
|
130
130
|
|
|
131
131
|
### Return type
|
|
@@ -161,7 +161,7 @@ All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
|
|
|
161
161
|
|------------- | ------------- | ------------- | -------------|
|
|
162
162
|
| **body** | **object**| | |
|
|
163
163
|
| **orderGroupId** | [**string**] | Order group ID | defaults to undefined|
|
|
164
|
-
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts).
|
|
164
|
+
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
|
|
165
165
|
|
|
166
166
|
|
|
167
167
|
### Return type
|
|
@@ -197,7 +197,7 @@ All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
|
|
|
197
197
|
|------------- | ------------- | ------------- | -------------|
|
|
198
198
|
| **body** | **object**| | |
|
|
199
199
|
| **orderGroupId** | [**string**] | Order group ID | defaults to undefined|
|
|
200
|
-
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts).
|
|
200
|
+
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
|
|
201
201
|
|
|
202
202
|
|
|
203
203
|
### Return type
|
|
@@ -7,8 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**order_id** | **string** | The order ID | [default to undefined]
|
|
9
9
|
**market_ticker** | **string** | The market ticker | [default to undefined]
|
|
10
|
-
**
|
|
11
|
-
**queue_position_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [optional] [default to undefined]
|
|
10
|
+
**queue_position_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
|
|
12
11
|
|
|
13
12
|
## Example
|
|
14
13
|
|
|
@@ -18,7 +17,6 @@ import { OrderQueuePosition } from 'kalshi-typescript';
|
|
|
18
17
|
const instance: OrderQueuePosition = {
|
|
19
18
|
order_id,
|
|
20
19
|
market_ticker,
|
|
21
|
-
queue_position,
|
|
22
20
|
queue_position_fp,
|
|
23
21
|
};
|
|
24
22
|
```
|