kalshi-typescript 3.5.0 → 3.7.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 +323 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +33 -0
- package/README.md +19 -2
- package/api/account-api.ts +129 -0
- package/api/api-keys-api.ts +372 -0
- package/api/communications-api.ts +1053 -0
- package/api/events-api.ts +679 -0
- package/api/exchange-api.ts +390 -0
- package/api/fcm-api.ts +337 -0
- package/api/historical-api.ts +613 -0
- package/api/incentive-programs-api.ts +168 -0
- package/api/live-data-api.ts +207 -0
- package/api/market-api.ts +912 -0
- package/api/milestone-api.ts +258 -0
- package/{dist/esm/api/collection-api.js → api/multivariate-api.ts} +185 -140
- package/api/order-groups-api.ts +666 -0
- package/api/orders-api.ts +965 -0
- package/api/portfolio-api.ts +892 -0
- package/api/search-api.ts +183 -0
- package/api/structured-targets-api.ts +222 -0
- package/api.ts +34 -0
- package/auth.ts +38 -0
- package/base.ts +96 -0
- package/common.ts +98 -0
- package/configuration.ts +93 -0
- package/dist/api/account-api.d.ts +63 -0
- package/dist/api/account-api.js +130 -0
- 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 +9 -5
- package/dist/api/communications-api.js +15 -8
- package/dist/api/events-api.d.ts +1 -1
- package/dist/api/events-api.js +1 -1
- package/dist/api/exchange-api.d.ts +1 -1
- package/dist/api/exchange-api.js +1 -1
- package/dist/api/fcm-api.d.ts +1 -1
- package/dist/api/fcm-api.js +1 -1
- package/dist/api/historical-api.d.ts +290 -0
- package/dist/api/historical-api.js +566 -0
- 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 +13 -9
- package/dist/api/market-api.js +19 -12
- package/dist/api/milestone-api.d.ts +1 -1
- package/dist/api/milestone-api.js +1 -1
- package/dist/api/multivariate-api.d.ts +1 -1
- package/dist/api/multivariate-api.js +1 -1
- package/dist/api/order-groups-api.d.ts +114 -21
- package/dist/api/order-groups-api.js +224 -33
- package/dist/api/orders-api.d.ts +21 -13
- package/dist/api/orders-api.js +33 -19
- package/dist/api/portfolio-api.d.ts +17 -13
- package/dist/api/portfolio-api.js +23 -16
- 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 +3 -1
- package/dist/api.js +3 -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 +63 -0
- package/dist/esm/api/account-api.js +123 -0
- 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 +9 -5
- package/dist/esm/api/communications-api.js +15 -8
- package/dist/esm/api/events-api.d.ts +1 -1
- package/dist/esm/api/events-api.js +1 -1
- 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 +1 -1
- package/dist/esm/api/fcm-api.js +1 -1
- package/dist/esm/api/historical-api.d.ts +290 -0
- package/dist/esm/api/historical-api.js +559 -0
- 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 +13 -9
- package/dist/esm/api/market-api.js +19 -12
- package/dist/esm/api/milestone-api.d.ts +1 -1
- package/dist/esm/api/milestone-api.js +1 -1
- package/dist/esm/api/multivariate-api.d.ts +1 -1
- package/dist/esm/api/multivariate-api.js +1 -1
- package/dist/esm/api/order-groups-api.d.ts +114 -21
- package/dist/esm/api/order-groups-api.js +224 -33
- package/dist/esm/api/orders-api.d.ts +21 -13
- package/dist/esm/api/orders-api.js +33 -19
- package/dist/esm/api/portfolio-api.d.ts +17 -13
- package/dist/esm/api/portfolio-api.js +23 -16
- 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 +3 -1
- package/dist/esm/api.js +3 -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 +9 -5
- 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 -1
- package/dist/esm/models/batch-cancel-orders-individual-response.js +1 -1
- package/dist/esm/models/{get-subaccount-balance-response.d.ts → batch-cancel-orders-request-order.d.ts} +6 -6
- package/dist/esm/models/{get-events-candlesticks-response-events-inner.js → batch-cancel-orders-request-order.js} +1 -1
- package/dist/esm/models/batch-cancel-orders-request.d.ts +8 -2
- 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 +29 -0
- package/dist/esm/models/{get-events-candlesticks-response.js → bid-ask-distribution-historical.js} +1 -1
- package/dist/esm/models/bid-ask-distribution.d.ts +5 -5
- package/dist/esm/models/bid-ask-distribution.js +1 -1
- package/dist/esm/models/cancel-order-response.d.ts +1 -1
- 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 +6 -2
- 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 -9
- package/dist/esm/models/create-order-request.js +1 -5
- 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 +7 -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 +11 -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 +5 -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 +1 -1
- package/dist/esm/models/event-data.js +1 -1
- package/dist/esm/models/event-position.d.ts +5 -5
- 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 +9 -1
- 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 +25 -0
- package/dist/esm/models/{get-subaccount-balance-response.js → 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 +25 -0
- package/dist/esm/models/{orderbook-level-count-fp-inner.js → 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 +22 -0
- package/dist/esm/models/get-market-candlesticks-historical-response.js +14 -0
- 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 -1
- 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 +9 -1
- 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 +5 -1
- 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-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 +5 -1
- package/dist/esm/models/incentive-program.js +1 -1
- package/dist/esm/models/index.d.ts +8 -0
- package/dist/esm/models/index.js +8 -0
- 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 +30 -0
- package/dist/esm/models/market-candlestick-historical.js +14 -0
- package/dist/esm/models/market-candlestick.d.ts +1 -1
- 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 -5
- package/dist/esm/models/market-position.js +1 -1
- package/dist/esm/models/market.d.ts +19 -13
- package/dist/esm/models/market.js +2 -1
- package/dist/esm/models/milestone.d.ts +1 -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 +9 -1
- package/dist/esm/models/order-group.js +1 -1
- package/dist/esm/models/order-queue-position.d.ts +5 -1
- 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 +11 -7
- 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/orderbook.d.ts +1 -1
- package/dist/esm/models/orderbook.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 +37 -0
- package/dist/esm/models/price-distribution-historical.js +14 -0
- package/dist/esm/models/price-distribution.d.ts +9 -9
- 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 +9 -4
- package/dist/esm/models/quote.js +1 -1
- package/dist/esm/models/rfq.d.ts +8 -3
- 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 +1 -1
- 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 +2 -2
- 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 +1 -1
- package/dist/esm/models/structured-target.js +1 -1
- package/dist/esm/models/subaccount-balance.d.ts +3 -3
- package/dist/esm/models/subaccount-balance.js +1 -1
- package/dist/esm/models/subaccount-transfer.d.ts +2 -2
- 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 -3
- package/dist/esm/models/trade.js +1 -1
- package/dist/esm/models/update-order-group-limit-request.d.ts +21 -0
- package/dist/esm/models/update-order-group-limit-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 +9 -5
- 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 -1
- package/dist/models/batch-cancel-orders-individual-response.js +1 -1
- package/dist/models/{get-subaccount-balance-response.d.ts → batch-cancel-orders-request-order.d.ts} +6 -6
- package/dist/models/{get-events-candlesticks-response-events-inner.js → batch-cancel-orders-request-order.js} +1 -1
- package/dist/models/batch-cancel-orders-request.d.ts +8 -2
- 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 +29 -0
- package/dist/models/{get-events-candlesticks-response.js → bid-ask-distribution-historical.js} +1 -1
- package/dist/models/bid-ask-distribution.d.ts +5 -5
- package/dist/models/bid-ask-distribution.js +1 -1
- package/dist/models/cancel-order-response.d.ts +1 -1
- 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 +6 -2
- 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 -9
- package/dist/models/create-order-request.js +2 -6
- 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 +7 -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 +11 -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 +5 -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 +1 -1
- package/dist/models/event-data.js +1 -1
- package/dist/models/event-position.d.ts +5 -5
- 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 +9 -1
- 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 +25 -0
- package/dist/models/{get-subaccount-balance-response.js → 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 +25 -0
- package/dist/models/{orderbook-level-count-fp-inner.js → 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 +22 -0
- package/dist/models/get-market-candlesticks-historical-response.js +15 -0
- 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 -1
- 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 +9 -1
- 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 +5 -1
- 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-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 +5 -1
- package/dist/models/incentive-program.js +1 -1
- package/dist/models/index.d.ts +8 -0
- package/dist/models/index.js +8 -0
- 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 +30 -0
- package/dist/models/market-candlestick-historical.js +15 -0
- package/dist/models/market-candlestick.d.ts +1 -1
- 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 -5
- package/dist/models/market-position.js +1 -1
- package/dist/models/market.d.ts +19 -13
- package/dist/models/market.js +2 -1
- package/dist/models/milestone.d.ts +1 -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 +9 -1
- package/dist/models/order-group.js +1 -1
- package/dist/models/order-queue-position.d.ts +5 -1
- 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 +11 -7
- 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/orderbook.d.ts +1 -1
- package/dist/models/orderbook.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 +37 -0
- package/dist/models/price-distribution-historical.js +15 -0
- package/dist/models/price-distribution.d.ts +9 -9
- 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 +9 -4
- package/dist/models/quote.js +1 -1
- package/dist/models/rfq.d.ts +8 -3
- 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 +1 -1
- 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 +2 -2
- 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 +1 -1
- package/dist/models/structured-target.js +1 -1
- package/dist/models/subaccount-balance.d.ts +3 -3
- package/dist/models/subaccount-balance.js +1 -1
- package/dist/models/subaccount-transfer.d.ts +2 -2
- 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 -3
- package/dist/models/trade.js +1 -1
- package/dist/models/update-order-group-limit-request.d.ts +21 -0
- package/dist/models/update-order-group-limit-request.js +15 -0
- package/dist/models/weekly-schedule.d.ts +1 -1
- package/dist/models/weekly-schedule.js +1 -1
- package/docs/AcceptQuoteRequest.md +20 -0
- package/docs/AccountApi.md +38 -0
- package/docs/AmendOrderRequest.md +42 -0
- package/docs/AmendOrderResponse.md +22 -0
- package/docs/Announcement.md +26 -0
- package/docs/ApiKey.md +24 -0
- package/docs/ApiKeysApi.md +145 -0
- package/docs/ApplySubaccountTransferRequest.md +26 -0
- package/docs/AssociatedEvent.md +28 -0
- package/docs/BatchCancelOrdersIndividualResponse.md +28 -0
- package/docs/BatchCancelOrdersRequest.md +22 -0
- package/docs/BatchCancelOrdersRequestOrder.md +22 -0
- package/docs/BatchCancelOrdersResponse.md +20 -0
- package/docs/BatchCreateOrdersIndividualResponse.md +24 -0
- package/docs/BatchCreateOrdersRequest.md +20 -0
- package/docs/BatchCreateOrdersResponse.md +20 -0
- package/docs/BatchGetMarketCandlesticksResponse.md +20 -0
- package/docs/BidAskDistribution.md +34 -0
- package/docs/BidAskDistributionHistorical.md +26 -0
- package/docs/CancelOrderResponse.md +24 -0
- package/docs/CommunicationsApi.md +404 -0
- package/docs/CreateApiKeyRequest.md +24 -0
- package/docs/CreateApiKeyResponse.md +20 -0
- package/docs/CreateMarketInMultivariateEventCollectionRequest.md +22 -0
- package/docs/CreateMarketInMultivariateEventCollectionResponse.md +24 -0
- package/docs/CreateOrderGroupRequest.md +24 -0
- package/docs/CreateOrderGroupResponse.md +20 -0
- package/docs/CreateOrderRequest.md +58 -0
- package/docs/CreateOrderResponse.md +20 -0
- package/docs/CreateQuoteRequest.md +28 -0
- package/docs/CreateQuoteResponse.md +20 -0
- package/docs/CreateRFQRequest.md +36 -0
- package/docs/CreateRFQResponse.md +20 -0
- package/docs/CreateSubaccountResponse.md +20 -0
- package/docs/DailySchedule.md +22 -0
- package/docs/DecreaseOrderRequest.md +28 -0
- package/docs/DecreaseOrderResponse.md +20 -0
- package/docs/ErrorResponse.md +26 -0
- package/docs/EventData.md +42 -0
- package/docs/EventPosition.md +40 -0
- package/docs/EventsApi.md +239 -0
- package/docs/ExchangeApi.md +163 -0
- package/docs/ExchangeInstance.md +11 -0
- package/docs/ExchangeStatus.md +24 -0
- package/docs/FcmApi.md +92 -0
- package/docs/Fill.md +58 -0
- package/docs/ForecastPercentilesPoint.md +26 -0
- package/docs/GenerateApiKeyRequest.md +22 -0
- package/docs/GenerateApiKeyResponse.md +22 -0
- package/docs/GetAccountApiLimitsResponse.md +24 -0
- package/docs/GetApiKeysResponse.md +20 -0
- package/docs/GetBalanceResponse.md +24 -0
- package/docs/GetCommunicationsIDResponse.md +20 -0
- package/docs/GetEventCandlesticksResponse.md +24 -0
- package/docs/GetEventForecastPercentilesHistoryResponse.md +20 -0
- package/docs/GetEventMetadataResponse.md +30 -0
- package/docs/GetEventResponse.md +22 -0
- package/docs/GetEventsResponse.md +24 -0
- package/docs/GetExchangeAnnouncementsResponse.md +20 -0
- package/docs/GetExchangeScheduleResponse.md +20 -0
- package/docs/GetFillsResponse.md +22 -0
- package/docs/GetFiltersBySportsResponse.md +22 -0
- package/docs/GetHistoricalCutoffResponse.md +24 -0
- package/docs/GetIncentiveProgramsResponse.md +22 -0
- package/docs/GetLiveDataResponse.md +20 -0
- package/docs/GetLiveDatasResponse.md +20 -0
- package/docs/GetMarketCandlesticksHistoricalResponse.md +22 -0
- package/docs/GetMarketCandlesticksResponse.md +22 -0
- package/docs/GetMarketOrderbookResponse.md +22 -0
- package/docs/GetMarketResponse.md +20 -0
- package/docs/GetMarketsResponse.md +22 -0
- package/docs/GetMilestoneResponse.md +20 -0
- package/docs/GetMilestonesResponse.md +22 -0
- package/docs/GetMultivariateEventCollectionLookupHistoryResponse.md +20 -0
- package/docs/GetMultivariateEventCollectionResponse.md +20 -0
- package/docs/GetMultivariateEventCollectionsResponse.md +22 -0
- package/docs/GetMultivariateEventsResponse.md +22 -0
- package/docs/GetOrderGroupResponse.md +26 -0
- package/docs/GetOrderGroupsResponse.md +20 -0
- package/docs/GetOrderQueuePositionResponse.md +22 -0
- package/docs/GetOrderQueuePositionsResponse.md +20 -0
- package/docs/GetOrderResponse.md +20 -0
- package/docs/GetOrdersResponse.md +22 -0
- package/docs/GetPortfolioRestingOrderTotalValueResponse.md +20 -0
- package/docs/GetPositionsResponse.md +24 -0
- package/docs/GetQuoteResponse.md +20 -0
- package/docs/GetQuotesResponse.md +22 -0
- package/docs/GetRFQResponse.md +20 -0
- package/docs/GetRFQsResponse.md +22 -0
- package/docs/GetSeriesFeeChangesResponse.md +20 -0
- package/docs/GetSeriesListResponse.md +20 -0
- package/docs/GetSeriesResponse.md +20 -0
- package/docs/GetSettlementsResponse.md +22 -0
- package/docs/GetStructuredTargetResponse.md +20 -0
- package/docs/GetStructuredTargetsResponse.md +22 -0
- package/docs/GetSubaccountBalancesResponse.md +20 -0
- package/docs/GetSubaccountTransfersResponse.md +22 -0
- package/docs/GetTagsForSeriesCategoriesResponse.md +20 -0
- package/docs/GetTradesResponse.md +22 -0
- package/docs/GetUserDataTimestampResponse.md +20 -0
- package/docs/HistoricalApi.md +223 -0
- package/docs/IncentiveProgram.md +40 -0
- package/docs/IncentiveProgramsApi.md +44 -0
- package/docs/IntraExchangeInstanceTransferRequest.md +24 -0
- package/docs/IntraExchangeInstanceTransferResponse.md +20 -0
- package/docs/LiveData.md +24 -0
- package/docs/LiveDataApi.md +75 -0
- package/docs/LookupPoint.md +26 -0
- package/docs/LookupTickersForMarketInMultivariateEventCollectionRequest.md +20 -0
- package/docs/LookupTickersForMarketInMultivariateEventCollectionResponse.md +22 -0
- package/docs/MaintenanceWindow.md +22 -0
- package/docs/Market.md +150 -0
- package/docs/MarketApi.md +315 -0
- package/docs/MarketCandlestick.md +34 -0
- package/docs/MarketCandlestickHistorical.md +30 -0
- package/docs/MarketCandlesticksResponse.md +22 -0
- package/docs/MarketMetadata.md +24 -0
- package/docs/MarketPosition.md +44 -0
- package/docs/Milestone.md +42 -0
- package/docs/MilestoneApi.md +85 -0
- package/docs/MultivariateApi.md +188 -0
- package/docs/MultivariateEventCollection.md +46 -0
- package/docs/MveSelectedLeg.md +26 -0
- package/docs/Order.md +86 -0
- package/docs/OrderGroup.md +26 -0
- package/docs/OrderGroupsApi.md +260 -0
- package/docs/OrderQueuePosition.md +26 -0
- package/docs/OrderStatus.md +13 -0
- package/docs/Orderbook.md +27 -0
- package/docs/OrderbookCountFp.md +23 -0
- package/docs/OrdersApi.md +375 -0
- package/docs/PercentilePoint.md +26 -0
- package/docs/PortfolioApi.md +324 -0
- package/docs/PriceDistribution.md +50 -0
- package/docs/PriceDistributionHistorical.md +30 -0
- package/docs/PriceRange.md +24 -0
- package/docs/Quote.md +72 -0
- package/docs/RFQ.md +50 -0
- package/docs/Schedule.md +22 -0
- package/docs/ScopeList.md +20 -0
- package/docs/SearchApi.md +69 -0
- package/docs/SelfTradePreventionType.md +11 -0
- package/docs/Series.md +46 -0
- package/docs/SeriesFeeChange.md +28 -0
- package/docs/Settlement.md +44 -0
- package/docs/SettlementSource.md +22 -0
- package/docs/SportFilterDetails.md +22 -0
- package/docs/StructuredTarget.md +30 -0
- package/docs/StructuredTargetsApi.md +79 -0
- package/docs/SubaccountBalance.md +24 -0
- package/docs/SubaccountTransfer.md +28 -0
- package/docs/TickerPair.md +24 -0
- package/docs/Trade.md +40 -0
- package/docs/UpdateOrderGroupLimitRequest.md +22 -0
- package/docs/WeeklySchedule.md +36 -0
- package/git_push.sh +57 -0
- package/index.ts +18 -0
- package/models/accept-quote-request.ts +31 -0
- package/models/amend-order-request.ts +81 -0
- package/models/amend-order-response.ts +24 -0
- package/models/announcement.ts +50 -0
- package/models/api-key.ts +31 -0
- package/{dist/models/transfer-between-subaccounts-request.d.ts → models/apply-subaccount-transfer-request.ts} +13 -3
- package/models/associated-event.ts +39 -0
- package/models/batch-cancel-orders-individual-response.ts +39 -0
- package/models/batch-cancel-orders-request-order.ts +27 -0
- package/models/batch-cancel-orders-request.ts +31 -0
- package/models/batch-cancel-orders-response.ts +23 -0
- package/models/batch-create-orders-individual-response.ts +28 -0
- package/models/batch-create-orders-request.ts +23 -0
- package/models/batch-create-orders-response.ts +23 -0
- package/models/batch-get-market-candlesticks-response.ts +26 -0
- package/models/bid-ask-distribution-historical.ts +35 -0
- package/models/bid-ask-distribution.ts +51 -0
- package/models/cancel-order-response.ts +28 -0
- package/models/create-api-key-request.ts +31 -0
- package/models/create-api-key-response.ts +23 -0
- package/models/create-market-in-multivariate-event-collection-request.ts +30 -0
- package/models/create-market-in-multivariate-event-collection-response.ts +31 -0
- package/models/create-order-group-request.ts +31 -0
- package/models/create-order-group-response.ts +23 -0
- package/models/create-order-request.ts +90 -0
- package/models/create-order-response.ts +23 -0
- package/models/create-quote-request.ts +39 -0
- package/models/create-quote-response.ts +23 -0
- package/models/create-rfqrequest.ts +56 -0
- package/models/create-rfqresponse.ts +23 -0
- package/models/create-subaccount-response.ts +23 -0
- package/models/daily-schedule.ts +27 -0
- package/models/decrease-order-request.ts +39 -0
- package/models/decrease-order-response.ts +23 -0
- package/models/error-response.ts +35 -0
- package/models/event-data.ts +70 -0
- package/models/event-position.ts +63 -0
- package/models/exchange-instance.ts +29 -0
- package/models/exchange-status.ts +31 -0
- package/models/fill.ts +113 -0
- package/models/forecast-percentiles-point.ts +38 -0
- package/models/generate-api-key-request.ts +27 -0
- package/models/generate-api-key-response.ts +27 -0
- package/models/get-account-api-limits-response.ts +31 -0
- package/models/get-api-keys-response.ts +26 -0
- package/models/get-balance-response.ts +31 -0
- package/models/get-communications-idresponse.ts +23 -0
- package/{dist/esm/models/get-events-candlesticks-response-events-inner.d.ts → models/get-event-candlesticks-response.ts} +11 -7
- package/models/get-event-forecast-percentiles-history-response.ts +26 -0
- package/models/get-event-metadata-response.ts +49 -0
- package/models/get-event-response.ts +30 -0
- package/models/get-events-response.ts +37 -0
- package/models/get-exchange-announcements-response.ts +26 -0
- package/models/get-exchange-schedule-response.ts +23 -0
- package/models/get-fills-response.ts +24 -0
- package/models/get-filters-by-sports-response.ts +30 -0
- package/models/get-historical-cutoff-response.ts +31 -0
- package/models/get-incentive-programs-response.ts +27 -0
- package/models/get-live-data-response.ts +23 -0
- package/models/get-live-datas-response.ts +23 -0
- package/models/get-market-candlesticks-historical-response.ts +30 -0
- package/models/get-market-candlesticks-response.ts +30 -0
- package/models/get-market-orderbook-response.ts +27 -0
- package/models/get-market-response.ts +23 -0
- package/models/get-markets-response.ts +24 -0
- package/models/get-milestone-response.ts +23 -0
- package/models/get-milestones-response.ts +30 -0
- package/models/get-multivariate-event-collection-lookup-history-response.ts +26 -0
- package/models/get-multivariate-event-collection-response.ts +23 -0
- package/models/get-multivariate-event-collections-response.ts +30 -0
- package/models/get-multivariate-events-response.ts +30 -0
- package/models/get-order-group-response.ts +35 -0
- package/models/get-order-groups-response.ts +23 -0
- package/models/get-order-queue-position-response.ts +27 -0
- package/models/get-order-queue-positions-response.ts +26 -0
- package/models/get-order-response.ts +23 -0
- package/models/get-orders-response.ts +24 -0
- package/models/get-portfolio-resting-order-total-value-response.ts +23 -0
- package/models/get-positions-response.ts +37 -0
- package/models/get-quote-response.ts +23 -0
- package/models/get-quotes-response.ts +30 -0
- package/models/get-rfqresponse.ts +23 -0
- package/models/get-rfqs-response.ts +30 -0
- package/models/get-series-fee-changes-response.ts +23 -0
- package/models/get-series-list-response.ts +23 -0
- package/models/get-series-response.ts +23 -0
- package/models/get-settlements-response.ts +24 -0
- package/models/get-structured-target-response.ts +23 -0
- package/models/get-structured-targets-response.ts +27 -0
- package/models/get-subaccount-balances-response.ts +23 -0
- package/models/get-subaccount-transfers-response.ts +27 -0
- package/models/get-tags-for-series-categories-response.ts +23 -0
- package/models/get-trades-response.ts +24 -0
- package/models/get-user-data-timestamp-response.ts +23 -0
- package/models/incentive-program.ts +71 -0
- package/models/index.ts +138 -0
- package/models/intra-exchange-instance-transfer-request.ts +30 -0
- package/models/intra-exchange-instance-transfer-response.ts +23 -0
- package/models/live-data.ts +31 -0
- package/models/lookup-point.ts +38 -0
- package/models/lookup-tickers-for-market-in-multivariate-event-collection-request.ts +26 -0
- package/models/lookup-tickers-for-market-in-multivariate-event-collection-response.ts +27 -0
- package/models/maintenance-window.ts +27 -0
- package/models/market-candlestick-historical.ts +40 -0
- package/models/market-candlestick.ts +48 -0
- package/models/market-candlesticks-response.ts +30 -0
- package/models/market-metadata.ts +31 -0
- package/models/market-position.ts +71 -0
- package/models/market.ts +310 -0
- package/models/milestone.ts +67 -0
- package/models/multivariate-event-collection.ts +78 -0
- package/models/mve-selected-leg.ts +35 -0
- package/models/order-group.ts +35 -0
- package/models/order-queue-position.ts +35 -0
- package/models/order-status.ts +30 -0
- package/models/order.ts +142 -0
- package/models/orderbook-count-fp.ts +24 -0
- package/models/orderbook.ts +26 -0
- package/models/percentile-point.ts +35 -0
- package/models/price-distribution-historical.ts +43 -0
- package/models/price-distribution.ts +83 -0
- package/models/price-range.ts +31 -0
- package/models/quote.ts +145 -0
- package/models/rfq.ts +95 -0
- package/models/schedule.ts +33 -0
- package/models/scope-list.ts +23 -0
- package/models/self-trade-prevention-type.ts +29 -0
- package/models/series-fee-change.ts +48 -0
- package/models/series.ts +87 -0
- package/models/settlement-source.ts +27 -0
- package/models/settlement.ts +81 -0
- package/models/sport-filter-details.ts +30 -0
- package/models/structured-target.ts +43 -0
- package/models/subaccount-balance.ts +31 -0
- package/models/subaccount-transfer.ts +39 -0
- package/models/ticker-pair.ts +39 -0
- package/models/trade.ts +71 -0
- package/models/update-order-group-limit-request.ts +27 -0
- package/models/weekly-schedule.ts +58 -0
- package/package.json +13 -13
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +18 -0
- package/dist/api/collection-api.d.ts +0 -242
- package/dist/api/collection-api.js +0 -467
- package/dist/api/markets-api.d.ts +0 -263
- package/dist/api/markets-api.js +0 -515
- package/dist/api/milestones-api.d.ts +0 -104
- package/dist/api/milestones-api.js +0 -209
- package/dist/api/multivariate-collections-api.d.ts +0 -138
- package/dist/api/multivariate-collections-api.js +0 -278
- package/dist/api/series-api.d.ts +0 -100
- package/dist/api/series-api.js +0 -202
- package/dist/esm/api/collection-api.d.ts +0 -242
- package/dist/esm/api/markets-api.d.ts +0 -263
- package/dist/esm/api/markets-api.js +0 -508
- package/dist/esm/api/milestones-api.d.ts +0 -104
- package/dist/esm/api/milestones-api.js +0 -202
- package/dist/esm/api/multivariate-collections-api.d.ts +0 -138
- package/dist/esm/api/multivariate-collections-api.js +0 -271
- package/dist/esm/api/series-api.d.ts +0 -100
- package/dist/esm/api/series-api.js +0 -195
- package/dist/esm/models/batch-cancel-orders-response-responses-inner.d.ts +0 -17
- package/dist/esm/models/batch-cancel-orders-response-responses-inner.js +0 -14
- package/dist/esm/models/batch-create-orders-response-responses-inner.d.ts +0 -17
- package/dist/esm/models/batch-create-orders-response-responses-inner.js +0 -14
- package/dist/esm/models/candlestick.d.ts +0 -20
- package/dist/esm/models/candlestick.js +0 -14
- package/dist/esm/models/error-response-error.d.ts +0 -25
- package/dist/esm/models/error-response-error.js +0 -14
- package/dist/esm/models/event.d.ts +0 -26
- package/dist/esm/models/event.js +0 -18
- package/dist/esm/models/get-events-candlesticks-response.d.ts +0 -18
- package/dist/esm/models/get-exchange-schedule-response-schedule.d.ts +0 -21
- package/dist/esm/models/get-exchange-schedule-response-schedule.js +0 -14
- package/dist/esm/models/get-market-orderbook-response-orderbook.d.ts +0 -16
- package/dist/esm/models/get-market-orderbook-response-orderbook.js +0 -14
- package/dist/esm/models/get-queue-positions-request.d.ts +0 -14
- package/dist/esm/models/get-queue-positions-request.js +0 -14
- package/dist/esm/models/get-queue-positions-response.d.ts +0 -16
- package/dist/esm/models/get-queue-positions-response.js +0 -14
- package/dist/esm/models/get-series-by-ticker-response.d.ts +0 -15
- package/dist/esm/models/get-series-by-ticker-response.js +0 -14
- package/dist/esm/models/get-total-resting-order-value-response.d.ts +0 -14
- package/dist/esm/models/get-total-resting-order-value-response.js +0 -14
- package/dist/esm/models/lookup-bundle-request-bundle-inner.d.ts +0 -15
- package/dist/esm/models/lookup-bundle-request-bundle-inner.js +0 -14
- package/dist/esm/models/lookup-bundle-request.d.ts +0 -15
- package/dist/esm/models/lookup-bundle-request.js +0 -14
- package/dist/esm/models/lookup-bundle-response.d.ts +0 -15
- package/dist/esm/models/lookup-bundle-response.js +0 -14
- package/dist/esm/models/multivariate-event-collection-events-inner.d.ts +0 -17
- package/dist/esm/models/multivariate-event-collection-events-inner.js +0 -14
- package/dist/esm/models/orderbook-level-count-fp-inner.d.ts +0 -15
- package/dist/esm/models/orderbook-level.d.ts +0 -15
- package/dist/esm/models/orderbook-level.js +0 -14
- package/dist/esm/models/position.d.ts +0 -26
- package/dist/esm/models/position.js +0 -17
- package/dist/esm/models/price-level-count-fp-inner.d.ts +0 -15
- package/dist/esm/models/price-level-count-fp-inner.js +0 -14
- package/dist/esm/models/price-level-dollars-inner.d.ts +0 -15
- package/dist/esm/models/price-level-dollars-inner.js +0 -14
- package/dist/esm/models/transfer-between-subaccounts-request.d.ts +0 -25
- package/dist/esm/models/transfer-between-subaccounts-request.js +0 -14
- package/dist/models/batch-cancel-orders-response-responses-inner.d.ts +0 -17
- package/dist/models/batch-cancel-orders-response-responses-inner.js +0 -15
- package/dist/models/batch-create-orders-response-responses-inner.d.ts +0 -17
- package/dist/models/batch-create-orders-response-responses-inner.js +0 -15
- package/dist/models/candlestick.d.ts +0 -20
- package/dist/models/candlestick.js +0 -15
- package/dist/models/error-response-error.d.ts +0 -25
- package/dist/models/error-response-error.js +0 -15
- package/dist/models/event.d.ts +0 -26
- package/dist/models/event.js +0 -21
- package/dist/models/get-events-candlesticks-response-events-inner.d.ts +0 -30
- package/dist/models/get-events-candlesticks-response.d.ts +0 -18
- package/dist/models/get-exchange-schedule-response-schedule.d.ts +0 -21
- package/dist/models/get-exchange-schedule-response-schedule.js +0 -15
- package/dist/models/get-market-orderbook-response-orderbook.d.ts +0 -16
- package/dist/models/get-market-orderbook-response-orderbook.js +0 -15
- package/dist/models/get-queue-positions-request.d.ts +0 -14
- package/dist/models/get-queue-positions-request.js +0 -15
- package/dist/models/get-queue-positions-response.d.ts +0 -16
- package/dist/models/get-queue-positions-response.js +0 -15
- package/dist/models/get-series-by-ticker-response.d.ts +0 -15
- package/dist/models/get-series-by-ticker-response.js +0 -15
- package/dist/models/get-total-resting-order-value-response.d.ts +0 -14
- package/dist/models/get-total-resting-order-value-response.js +0 -15
- package/dist/models/lookup-bundle-request-bundle-inner.d.ts +0 -15
- package/dist/models/lookup-bundle-request-bundle-inner.js +0 -15
- package/dist/models/lookup-bundle-request.d.ts +0 -15
- package/dist/models/lookup-bundle-request.js +0 -15
- package/dist/models/lookup-bundle-response.d.ts +0 -15
- package/dist/models/lookup-bundle-response.js +0 -15
- package/dist/models/multivariate-event-collection-events-inner.d.ts +0 -17
- package/dist/models/multivariate-event-collection-events-inner.js +0 -15
- package/dist/models/orderbook-level-count-fp-inner.d.ts +0 -15
- package/dist/models/orderbook-level.d.ts +0 -15
- package/dist/models/orderbook-level.js +0 -15
- package/dist/models/position.d.ts +0 -26
- package/dist/models/position.js +0 -20
- package/dist/models/price-level-count-fp-inner.d.ts +0 -15
- package/dist/models/price-level-count-fp-inner.js +0 -15
- package/dist/models/price-level-dollars-inner.d.ts +0 -15
- package/dist/models/price-level-dollars-inner.js +0 -15
- package/dist/models/transfer-between-subaccounts-request.js +0 -15
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# GetSubaccountBalancesResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**subaccount_balances** | [**Array<SubaccountBalance>**](SubaccountBalance.md) | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { GetSubaccountBalancesResponse } from 'kalshi-typescript';
|
|
14
|
+
|
|
15
|
+
const instance: GetSubaccountBalancesResponse = {
|
|
16
|
+
subaccount_balances,
|
|
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)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# GetSubaccountTransfersResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**transfers** | [**Array<SubaccountTransfer>**](SubaccountTransfer.md) | | [default to undefined]
|
|
9
|
+
**cursor** | **string** | Cursor for the next page of results. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { GetSubaccountTransfersResponse } from 'kalshi-typescript';
|
|
15
|
+
|
|
16
|
+
const instance: GetSubaccountTransfersResponse = {
|
|
17
|
+
transfers,
|
|
18
|
+
cursor,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# GetTagsForSeriesCategoriesResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**tags_by_categories** | **{ [key: string]: Array<string>; }** | Mapping of series categories to their associated tags | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { GetTagsForSeriesCategoriesResponse } from 'kalshi-typescript';
|
|
14
|
+
|
|
15
|
+
const instance: GetTagsForSeriesCategoriesResponse = {
|
|
16
|
+
tags_by_categories,
|
|
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)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# GetTradesResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**trades** | [**Array<Trade>**](Trade.md) | | [default to undefined]
|
|
9
|
+
**cursor** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { GetTradesResponse } from 'kalshi-typescript';
|
|
15
|
+
|
|
16
|
+
const instance: GetTradesResponse = {
|
|
17
|
+
trades,
|
|
18
|
+
cursor,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# GetUserDataTimestampResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**as_of_time** | **string** | Timestamp when user data was last updated. | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { GetUserDataTimestampResponse } from 'kalshi-typescript';
|
|
14
|
+
|
|
15
|
+
const instance: GetUserDataTimestampResponse = {
|
|
16
|
+
as_of_time,
|
|
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)
|
|
@@ -0,0 +1,223 @@
|
|
|
1
|
+
# HistoricalApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getFillsHistorical**](#getfillshistorical) | **GET** /historical/fills | Get Historical Fills|
|
|
8
|
+
|[**getHistoricalCutoff**](#gethistoricalcutoff) | **GET** /historical/cutoff | Get Historical Cutoff Timestamps|
|
|
9
|
+
|[**getHistoricalMarket**](#gethistoricalmarket) | **GET** /historical/markets/{ticker} | Get Historical Market|
|
|
10
|
+
|[**getHistoricalMarkets**](#gethistoricalmarkets) | **GET** /historical/markets | Get Historical Markets|
|
|
11
|
+
|[**getHistoricalOrders**](#gethistoricalorders) | **GET** /historical/orders | Get Historical Orders|
|
|
12
|
+
|[**getMarketCandlesticksHistorical**](#getmarketcandlestickshistorical) | **GET** /historical/markets/{ticker}/candlesticks | Get Historical Market Candlesticks|
|
|
13
|
+
|
|
14
|
+
# **getFillsHistorical**
|
|
15
|
+
> GetFillsResponse getFillsHistorical()
|
|
16
|
+
|
|
17
|
+
Endpoint for getting all historical fills for the member. A fill is when a trade you have is matched.
|
|
18
|
+
|
|
19
|
+
### Parameters
|
|
20
|
+
|
|
21
|
+
|Name | Type | Description | Notes|
|
|
22
|
+
|------------- | ------------- | ------------- | -------------|
|
|
23
|
+
| **ticker** | [**string**] | Filter by market ticker | (optional) defaults to undefined|
|
|
24
|
+
| **maxTs** | [**number**] | Filter items before this Unix timestamp | (optional) defaults to undefined|
|
|
25
|
+
| **limit** | [**number**] | Number of results per page. Defaults to 100. Maximum value is 200. | (optional) defaults to 100|
|
|
26
|
+
| **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|
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
### Return type
|
|
30
|
+
|
|
31
|
+
**GetFillsResponse**
|
|
32
|
+
|
|
33
|
+
### Authorization
|
|
34
|
+
|
|
35
|
+
[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
|
|
36
|
+
|
|
37
|
+
### HTTP request headers
|
|
38
|
+
|
|
39
|
+
- **Content-Type**: Not defined
|
|
40
|
+
- **Accept**: application/json
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
### HTTP response details
|
|
44
|
+
| Status code | Description | Response headers |
|
|
45
|
+
|-------------|-------------|------------------|
|
|
46
|
+
|**200** | Fills retrieved successfully | - |
|
|
47
|
+
|**400** | Bad request | - |
|
|
48
|
+
|**401** | Unauthorized | - |
|
|
49
|
+
|**500** | Internal server error | - |
|
|
50
|
+
|
|
51
|
+
# **getHistoricalCutoff**
|
|
52
|
+
> GetHistoricalCutoffResponse getHistoricalCutoff()
|
|
53
|
+
|
|
54
|
+
Returns the cutoff timestamps that define the boundary between **live** and **historical** data. ## Cutoff fields - `market_settled_ts` : Markets that **settled** before this timestamp, and their candlesticks, must be accessed via `GET /historical/markets` and `GET /historical/markets/{ticker}/candlesticks`. - `trades_created_ts` : Trades that were **filled** before this timestamp must be accessed via `GET /historical/fills`. - `orders_updated_ts` : Orders that were **canceled or fully executed** before this timestamp must be accessed via `GET /historical/orders`. Resting (active) orders are always available in `GET /portfolio/orders`.
|
|
55
|
+
|
|
56
|
+
### Parameters
|
|
57
|
+
This endpoint does not have any parameters.
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
### Return type
|
|
61
|
+
|
|
62
|
+
**GetHistoricalCutoffResponse**
|
|
63
|
+
|
|
64
|
+
### Authorization
|
|
65
|
+
|
|
66
|
+
No authorization required
|
|
67
|
+
|
|
68
|
+
### HTTP request headers
|
|
69
|
+
|
|
70
|
+
- **Content-Type**: Not defined
|
|
71
|
+
- **Accept**: application/json
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
### HTTP response details
|
|
75
|
+
| Status code | Description | Response headers |
|
|
76
|
+
|-------------|-------------|------------------|
|
|
77
|
+
|**200** | Historical cutoff timestamps retrieved successfully | - |
|
|
78
|
+
|**500** | Internal server error | - |
|
|
79
|
+
|
|
80
|
+
# **getHistoricalMarket**
|
|
81
|
+
> GetMarketResponse getHistoricalMarket()
|
|
82
|
+
|
|
83
|
+
Endpoint for getting data about a specific market by its ticker from the historical database.
|
|
84
|
+
|
|
85
|
+
### Parameters
|
|
86
|
+
|
|
87
|
+
|Name | Type | Description | Notes|
|
|
88
|
+
|------------- | ------------- | ------------- | -------------|
|
|
89
|
+
| **ticker** | [**string**] | Market ticker | defaults to undefined|
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
### Return type
|
|
93
|
+
|
|
94
|
+
**GetMarketResponse**
|
|
95
|
+
|
|
96
|
+
### Authorization
|
|
97
|
+
|
|
98
|
+
No authorization required
|
|
99
|
+
|
|
100
|
+
### HTTP request headers
|
|
101
|
+
|
|
102
|
+
- **Content-Type**: Not defined
|
|
103
|
+
- **Accept**: application/json
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
### HTTP response details
|
|
107
|
+
| Status code | Description | Response headers |
|
|
108
|
+
|-------------|-------------|------------------|
|
|
109
|
+
|**200** | Historical market retrieved successfully | - |
|
|
110
|
+
|**404** | Resource not found | - |
|
|
111
|
+
|**500** | Internal server error | - |
|
|
112
|
+
|
|
113
|
+
# **getHistoricalMarkets**
|
|
114
|
+
> GetMarketsResponse getHistoricalMarkets()
|
|
115
|
+
|
|
116
|
+
Endpoint for getting markets that have been archived to the historical database. Filters are mutually exclusive.
|
|
117
|
+
|
|
118
|
+
### Parameters
|
|
119
|
+
|
|
120
|
+
|Name | Type | Description | Notes|
|
|
121
|
+
|------------- | ------------- | ------------- | -------------|
|
|
122
|
+
| **limit** | [**number**] | Number of results per page. Defaults to 100. Maximum value is 1000. | (optional) defaults to 100|
|
|
123
|
+
| **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
|
+
| **tickers** | [**string**] | Filter by specific market tickers. Comma-separated list of market tickers to retrieve. | (optional) defaults to undefined|
|
|
125
|
+
| **eventTicker** | [**string**] | Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10). | (optional) defaults to undefined|
|
|
126
|
+
| **mveFilter** | [**'exclude'**]**Array<'exclude'>** | Filter by multivariate events (combos). By default, MVE markets are included. | (optional) defaults to undefined|
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
### Return type
|
|
130
|
+
|
|
131
|
+
**GetMarketsResponse**
|
|
132
|
+
|
|
133
|
+
### Authorization
|
|
134
|
+
|
|
135
|
+
No authorization required
|
|
136
|
+
|
|
137
|
+
### HTTP request headers
|
|
138
|
+
|
|
139
|
+
- **Content-Type**: Not defined
|
|
140
|
+
- **Accept**: application/json
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
### HTTP response details
|
|
144
|
+
| Status code | Description | Response headers |
|
|
145
|
+
|-------------|-------------|------------------|
|
|
146
|
+
|**200** | Historical markets retrieved successfully | - |
|
|
147
|
+
|**400** | Bad request - invalid input | - |
|
|
148
|
+
|**500** | Internal server error | - |
|
|
149
|
+
|
|
150
|
+
# **getHistoricalOrders**
|
|
151
|
+
> GetOrdersResponse getHistoricalOrders()
|
|
152
|
+
|
|
153
|
+
Endpoint for getting orders that have been archived to the historical database.
|
|
154
|
+
|
|
155
|
+
### Parameters
|
|
156
|
+
|
|
157
|
+
|Name | Type | Description | Notes|
|
|
158
|
+
|------------- | ------------- | ------------- | -------------|
|
|
159
|
+
| **ticker** | [**string**] | Filter by market ticker | (optional) defaults to undefined|
|
|
160
|
+
| **maxTs** | [**number**] | Filter items before this Unix timestamp | (optional) defaults to undefined|
|
|
161
|
+
| **limit** | [**number**] | Number of results per page. Defaults to 100. Maximum value is 200. | (optional) defaults to 100|
|
|
162
|
+
| **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|
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
### Return type
|
|
166
|
+
|
|
167
|
+
**GetOrdersResponse**
|
|
168
|
+
|
|
169
|
+
### Authorization
|
|
170
|
+
|
|
171
|
+
[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
|
|
172
|
+
|
|
173
|
+
### HTTP request headers
|
|
174
|
+
|
|
175
|
+
- **Content-Type**: Not defined
|
|
176
|
+
- **Accept**: application/json
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
### HTTP response details
|
|
180
|
+
| Status code | Description | Response headers |
|
|
181
|
+
|-------------|-------------|------------------|
|
|
182
|
+
|**200** | Historical orders retrieved successfully | - |
|
|
183
|
+
|**400** | Bad request - invalid input | - |
|
|
184
|
+
|**401** | Unauthorized - authentication required | - |
|
|
185
|
+
|**500** | Internal server error | - |
|
|
186
|
+
|
|
187
|
+
# **getMarketCandlesticksHistorical**
|
|
188
|
+
> GetMarketCandlesticksHistoricalResponse getMarketCandlesticksHistorical()
|
|
189
|
+
|
|
190
|
+
Endpoint for fetching historical candlestick data for markets that have been archived from the live data set. Time period length of each candlestick in minutes. Valid values: 1 (1 minute), 60 (1 hour), 1440 (1 day).
|
|
191
|
+
|
|
192
|
+
### Parameters
|
|
193
|
+
|
|
194
|
+
|Name | Type | Description | Notes|
|
|
195
|
+
|------------- | ------------- | ------------- | -------------|
|
|
196
|
+
| **ticker** | [**string**] | Market ticker - unique identifier for the specific market | defaults to undefined|
|
|
197
|
+
| **startTs** | [**number**] | Start timestamp (Unix timestamp). Candlesticks will include those ending on or after this time. | defaults to undefined|
|
|
198
|
+
| **endTs** | [**number**] | End timestamp (Unix timestamp). Candlesticks will include those ending on or before this time. | defaults to undefined|
|
|
199
|
+
| **periodInterval** | [**1 | 60 | 1440**]**Array<1 | 60 | 1440>** | Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day). | defaults to undefined|
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
### Return type
|
|
203
|
+
|
|
204
|
+
**GetMarketCandlesticksHistoricalResponse**
|
|
205
|
+
|
|
206
|
+
### Authorization
|
|
207
|
+
|
|
208
|
+
No authorization required
|
|
209
|
+
|
|
210
|
+
### HTTP request headers
|
|
211
|
+
|
|
212
|
+
- **Content-Type**: Not defined
|
|
213
|
+
- **Accept**: application/json
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
### HTTP response details
|
|
217
|
+
| Status code | Description | Response headers |
|
|
218
|
+
|-------------|-------------|------------------|
|
|
219
|
+
|**200** | Candlesticks retrieved successfully | - |
|
|
220
|
+
|**400** | Bad request | - |
|
|
221
|
+
|**404** | Not found | - |
|
|
222
|
+
|**500** | Internal server error | - |
|
|
223
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# IncentiveProgram
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | Unique identifier for the incentive program | [default to undefined]
|
|
9
|
+
**market_id** | **string** | The unique identifier of the market associated with this incentive program | [default to undefined]
|
|
10
|
+
**market_ticker** | **string** | The ticker symbol of the market associated with this incentive program | [default to undefined]
|
|
11
|
+
**incentive_type** | **string** | Type of incentive program | [default to undefined]
|
|
12
|
+
**start_date** | **string** | Start date of the incentive program | [default to undefined]
|
|
13
|
+
**end_date** | **string** | End date of the incentive program | [default to undefined]
|
|
14
|
+
**period_reward** | **number** | Total reward for the period in centi-cents | [default to undefined]
|
|
15
|
+
**paid_out** | **boolean** | Whether the incentive has been paid out | [default to undefined]
|
|
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
|
+
**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
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import { IncentiveProgram } from 'kalshi-typescript';
|
|
24
|
+
|
|
25
|
+
const instance: IncentiveProgram = {
|
|
26
|
+
id,
|
|
27
|
+
market_id,
|
|
28
|
+
market_ticker,
|
|
29
|
+
incentive_type,
|
|
30
|
+
start_date,
|
|
31
|
+
end_date,
|
|
32
|
+
period_reward,
|
|
33
|
+
paid_out,
|
|
34
|
+
discount_factor_bps,
|
|
35
|
+
target_size,
|
|
36
|
+
target_size_fp,
|
|
37
|
+
};
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# IncentiveProgramsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getIncentivePrograms**](#getincentiveprograms) | **GET** /incentive_programs | Get Incentives|
|
|
8
|
+
|
|
9
|
+
# **getIncentivePrograms**
|
|
10
|
+
> GetIncentiveProgramsResponse getIncentivePrograms()
|
|
11
|
+
|
|
12
|
+
List incentives with optional filters. Incentives are rewards programs for trading activity on specific markets.
|
|
13
|
+
|
|
14
|
+
### Parameters
|
|
15
|
+
|
|
16
|
+
|Name | Type | Description | Notes|
|
|
17
|
+
|------------- | ------------- | ------------- | -------------|
|
|
18
|
+
| **status** | [**'all' | 'active' | 'upcoming' | 'closed' | 'paid_out'**]**Array<'all' | 'active' | 'upcoming' | 'closed' | 'paid_out'>** | Status filter. Can be \"all\", \"active\", \"upcoming\", \"closed\", or \"paid_out\". Default is \"all\". | (optional) defaults to undefined|
|
|
19
|
+
| **type** | [**'all' | 'liquidity' | 'volume'**]**Array<'all' | 'liquidity' | 'volume'>** | Type filter. Can be \"all\", \"liquidity\", or \"volume\". Default is \"all\". | (optional) defaults to undefined|
|
|
20
|
+
| **limit** | [**number**] | Number of results per page. Defaults to 100. Maximum value is 10000. | (optional) defaults to undefined|
|
|
21
|
+
| **cursor** | [**string**] | Cursor for pagination | (optional) defaults to undefined|
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
### Return type
|
|
25
|
+
|
|
26
|
+
**GetIncentiveProgramsResponse**
|
|
27
|
+
|
|
28
|
+
### Authorization
|
|
29
|
+
|
|
30
|
+
No authorization required
|
|
31
|
+
|
|
32
|
+
### HTTP request headers
|
|
33
|
+
|
|
34
|
+
- **Content-Type**: Not defined
|
|
35
|
+
- **Accept**: application/json
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
### HTTP response details
|
|
39
|
+
| Status code | Description | Response headers |
|
|
40
|
+
|-------------|-------------|------------------|
|
|
41
|
+
|**200** | Incentive programs retrieved successfully | - |
|
|
42
|
+
|**400** | Invalid request parameters | - |
|
|
43
|
+
|**500** | Internal server error | - |
|
|
44
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# IntraExchangeInstanceTransferRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**source** | [**ExchangeInstance**](ExchangeInstance.md) | | [default to undefined]
|
|
9
|
+
**destination** | [**ExchangeInstance**](ExchangeInstance.md) | | [default to undefined]
|
|
10
|
+
**amount** | **number** | The amount to transfer in centicents | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { IntraExchangeInstanceTransferRequest } from 'kalshi-typescript';
|
|
16
|
+
|
|
17
|
+
const instance: IntraExchangeInstanceTransferRequest = {
|
|
18
|
+
source,
|
|
19
|
+
destination,
|
|
20
|
+
amount,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# IntraExchangeInstanceTransferResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**transfer_id** | **string** | The ID of the transfer that was created | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { IntraExchangeInstanceTransferResponse } from 'kalshi-typescript';
|
|
14
|
+
|
|
15
|
+
const instance: IntraExchangeInstanceTransferResponse = {
|
|
16
|
+
transfer_id,
|
|
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/LiveData.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# LiveData
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**type** | **string** | Type of live data | [default to undefined]
|
|
9
|
+
**details** | **{ [key: string]: any; }** | Live data details as a flexible object | [default to undefined]
|
|
10
|
+
**milestone_id** | **string** | Milestone ID | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { LiveData } from 'kalshi-typescript';
|
|
16
|
+
|
|
17
|
+
const instance: LiveData = {
|
|
18
|
+
type,
|
|
19
|
+
details,
|
|
20
|
+
milestone_id,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# LiveDataApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getLiveData**](#getlivedata) | **GET** /live_data/{type}/milestone/{milestone_id} | Get Live Data|
|
|
8
|
+
|[**getLiveDatas**](#getlivedatas) | **GET** /live_data/batch | Get Multiple Live Data|
|
|
9
|
+
|
|
10
|
+
# **getLiveData**
|
|
11
|
+
> GetLiveDataResponse getLiveData()
|
|
12
|
+
|
|
13
|
+
Get live data for a specific milestone
|
|
14
|
+
|
|
15
|
+
### Parameters
|
|
16
|
+
|
|
17
|
+
|Name | Type | Description | Notes|
|
|
18
|
+
|------------- | ------------- | ------------- | -------------|
|
|
19
|
+
| **type** | [**string**] | Type of live data | defaults to undefined|
|
|
20
|
+
| **milestoneId** | [**string**] | Milestone ID | defaults to undefined|
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
### Return type
|
|
24
|
+
|
|
25
|
+
**GetLiveDataResponse**
|
|
26
|
+
|
|
27
|
+
### Authorization
|
|
28
|
+
|
|
29
|
+
No authorization required
|
|
30
|
+
|
|
31
|
+
### HTTP request headers
|
|
32
|
+
|
|
33
|
+
- **Content-Type**: Not defined
|
|
34
|
+
- **Accept**: application/json
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
### HTTP response details
|
|
38
|
+
| Status code | Description | Response headers |
|
|
39
|
+
|-------------|-------------|------------------|
|
|
40
|
+
|**200** | Live data retrieved successfully | - |
|
|
41
|
+
|**404** | Live data not found | - |
|
|
42
|
+
|**500** | Internal server error | - |
|
|
43
|
+
|
|
44
|
+
# **getLiveDatas**
|
|
45
|
+
> GetLiveDatasResponse getLiveDatas()
|
|
46
|
+
|
|
47
|
+
Get live data for multiple milestones
|
|
48
|
+
|
|
49
|
+
### Parameters
|
|
50
|
+
|
|
51
|
+
|Name | Type | Description | Notes|
|
|
52
|
+
|------------- | ------------- | ------------- | -------------|
|
|
53
|
+
| **milestoneIds** | **Array<string>** | Array of milestone IDs | defaults to undefined|
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
### Return type
|
|
57
|
+
|
|
58
|
+
**GetLiveDatasResponse**
|
|
59
|
+
|
|
60
|
+
### Authorization
|
|
61
|
+
|
|
62
|
+
No authorization required
|
|
63
|
+
|
|
64
|
+
### HTTP request headers
|
|
65
|
+
|
|
66
|
+
- **Content-Type**: Not defined
|
|
67
|
+
- **Accept**: application/json
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
### HTTP response details
|
|
71
|
+
| Status code | Description | Response headers |
|
|
72
|
+
|-------------|-------------|------------------|
|
|
73
|
+
|**200** | Live data retrieved successfully | - |
|
|
74
|
+
|**500** | Internal server error | - |
|
|
75
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# LookupPoint
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**event_ticker** | **string** | Event ticker for the lookup point. | [default to undefined]
|
|
9
|
+
**market_ticker** | **string** | Market ticker for the lookup point. | [default to undefined]
|
|
10
|
+
**selected_markets** | [**Array<TickerPair>**](TickerPair.md) | Markets that were selected for this lookup. | [default to undefined]
|
|
11
|
+
**last_queried_ts** | **string** | Timestamp when this lookup was last queried. | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { LookupPoint } from 'kalshi-typescript';
|
|
17
|
+
|
|
18
|
+
const instance: LookupPoint = {
|
|
19
|
+
event_ticker,
|
|
20
|
+
market_ticker,
|
|
21
|
+
selected_markets,
|
|
22
|
+
last_queried_ts,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# LookupTickersForMarketInMultivariateEventCollectionRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**selected_markets** | [**Array<TickerPair>**](TickerPair.md) | List of selected markets that act as parameters to determine which market is produced. | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { LookupTickersForMarketInMultivariateEventCollectionRequest } from 'kalshi-typescript';
|
|
14
|
+
|
|
15
|
+
const instance: LookupTickersForMarketInMultivariateEventCollectionRequest = {
|
|
16
|
+
selected_markets,
|
|
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)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# LookupTickersForMarketInMultivariateEventCollectionResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**event_ticker** | **string** | Event ticker for the looked up market. | [default to undefined]
|
|
9
|
+
**market_ticker** | **string** | Market ticker for the looked up market. | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { LookupTickersForMarketInMultivariateEventCollectionResponse } from 'kalshi-typescript';
|
|
15
|
+
|
|
16
|
+
const instance: LookupTickersForMarketInMultivariateEventCollectionResponse = {
|
|
17
|
+
event_ticker,
|
|
18
|
+
market_ticker,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# MaintenanceWindow
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**start_datetime** | **string** | Start date and time of the maintenance window. | [default to undefined]
|
|
9
|
+
**end_datetime** | **string** | End date and time of the maintenance window. | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { MaintenanceWindow } from 'kalshi-typescript';
|
|
15
|
+
|
|
16
|
+
const instance: MaintenanceWindow = {
|
|
17
|
+
start_datetime,
|
|
18
|
+
end_datetime,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|