kalshi-typescript 2.1.2 → 3.0.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 +112 -42
- package/.openapi-generator/VERSION +1 -1
- package/README.md +110 -50
- package/api/api-keys-api.ts +57 -39
- package/api/collection-api.ts +506 -0
- package/api/communications-api.ts +296 -114
- package/api/events-api.ts +406 -57
- package/api/exchange-api.ts +104 -29
- package/api/fcm-api.ts +337 -0
- package/api/incentive-programs-api.ts +168 -0
- package/api/live-data-api.ts +207 -0
- package/api/market-api.ts +872 -0
- package/api/markets-api.ts +23 -24
- package/api/milestone-api.ts +258 -0
- package/api/milestones-api.ts +5 -6
- package/api/multivariate-api.ts +505 -0
- package/api/multivariate-collections-api.ts +11 -12
- package/api/order-groups-api.ts +454 -0
- package/api/orders-api.ts +941 -0
- package/api/portfolio-api.ts +204 -1355
- package/api/search-api.ts +183 -0
- package/api/series-api.ts +5 -6
- package/api/structured-targets-api.ts +47 -41
- package/api.ts +13 -8
- package/auth.ts +1 -1
- package/base.ts +8 -8
- package/common.ts +4 -4
- package/configuration.ts +4 -5
- package/dist/api/api-keys-api.d.ts +20 -20
- package/dist/api/api-keys-api.js +52 -40
- package/dist/api/collection-api.d.ts +242 -0
- package/dist/api/collection-api.js +467 -0
- package/dist/api/communications-api.d.ts +124 -60
- package/dist/api/communications-api.js +268 -124
- package/dist/api/events-api.d.ts +210 -36
- package/dist/api/events-api.js +376 -56
- package/dist/api/exchange-api.d.ts +57 -20
- package/dist/api/exchange-api.js +100 -31
- package/dist/api/fcm-api.d.ts +164 -0
- package/dist/api/fcm-api.js +313 -0
- package/dist/api/incentive-programs-api.d.ts +93 -0
- package/dist/api/incentive-programs-api.js +164 -0
- package/dist/api/live-data-api.d.ts +104 -0
- package/dist/api/live-data-api.js +205 -0
- package/dist/api/market-api.d.ts +417 -0
- package/dist/api/market-api.js +804 -0
- package/dist/api/markets-api.js +10 -10
- package/dist/api/milestone-api.d.ts +128 -0
- package/dist/api/milestone-api.js +249 -0
- package/dist/api/milestones-api.js +4 -4
- package/dist/api/multivariate-api.d.ts +242 -0
- package/dist/api/multivariate-api.js +467 -0
- package/dist/api/multivariate-collections-api.js +6 -6
- package/dist/api/order-groups-api.d.ts +198 -0
- package/dist/api/order-groups-api.js +421 -0
- package/dist/api/orders-api.d.ts +405 -0
- package/dist/api/orders-api.js +844 -0
- package/dist/api/portfolio-api.d.ts +83 -601
- package/dist/api/portfolio-api.js +164 -1213
- package/dist/api/search-api.d.ts +92 -0
- package/dist/api/search-api.js +182 -0
- package/dist/api/series-api.js +4 -4
- package/dist/api/structured-targets-api.d.ts +32 -24
- package/dist/api/structured-targets-api.js +47 -39
- package/dist/api.d.ts +13 -8
- package/dist/api.js +13 -8
- package/dist/base.d.ts +4 -4
- package/dist/base.js +4 -4
- package/dist/common.d.ts +4 -4
- package/dist/common.js +4 -4
- package/dist/configuration.d.ts +4 -4
- package/dist/configuration.js +4 -4
- package/dist/esm/api/api-keys-api.d.ts +20 -20
- package/dist/esm/api/api-keys-api.js +54 -42
- package/dist/esm/api/collection-api.d.ts +242 -0
- package/dist/esm/api/collection-api.js +460 -0
- package/dist/esm/api/communications-api.d.ts +124 -60
- package/dist/esm/api/communications-api.js +270 -126
- package/dist/esm/api/events-api.d.ts +210 -36
- package/dist/esm/api/events-api.js +377 -57
- package/dist/esm/api/exchange-api.d.ts +57 -20
- package/dist/esm/api/exchange-api.js +102 -33
- package/dist/esm/api/fcm-api.d.ts +164 -0
- package/dist/esm/api/fcm-api.js +306 -0
- package/dist/esm/api/incentive-programs-api.d.ts +93 -0
- package/dist/esm/api/incentive-programs-api.js +157 -0
- package/dist/esm/api/live-data-api.d.ts +104 -0
- package/dist/esm/api/live-data-api.js +198 -0
- package/dist/esm/api/market-api.d.ts +417 -0
- package/dist/esm/api/market-api.js +797 -0
- package/dist/esm/api/markets-api.js +11 -11
- package/dist/esm/api/milestone-api.d.ts +128 -0
- package/dist/esm/api/milestone-api.js +242 -0
- package/dist/esm/api/milestones-api.js +5 -5
- package/dist/esm/api/multivariate-api.d.ts +242 -0
- package/dist/esm/api/multivariate-api.js +460 -0
- package/dist/esm/api/multivariate-collections-api.js +7 -7
- package/dist/esm/api/order-groups-api.d.ts +198 -0
- package/dist/esm/api/order-groups-api.js +414 -0
- package/dist/esm/api/orders-api.d.ts +405 -0
- package/dist/esm/api/orders-api.js +837 -0
- package/dist/esm/api/portfolio-api.d.ts +83 -601
- package/dist/esm/api/portfolio-api.js +164 -1213
- package/dist/esm/api/search-api.d.ts +92 -0
- package/dist/esm/api/search-api.js +175 -0
- package/dist/esm/api/series-api.js +5 -5
- package/dist/esm/api/structured-targets-api.d.ts +32 -24
- package/dist/esm/api/structured-targets-api.js +49 -41
- package/dist/esm/api.d.ts +13 -8
- package/dist/esm/api.js +13 -8
- package/dist/esm/base.d.ts +4 -4
- package/dist/esm/base.js +4 -4
- package/dist/esm/common.d.ts +4 -4
- package/dist/esm/common.js +4 -4
- package/dist/esm/configuration.d.ts +4 -4
- package/dist/esm/configuration.js +4 -4
- package/dist/esm/index.d.ts +4 -4
- package/dist/esm/index.js +4 -4
- package/dist/esm/models/accept-quote-request.d.ts +13 -5
- package/dist/esm/models/accept-quote-request.js +8 -5
- package/dist/esm/models/amend-order-request.d.ts +27 -10
- package/dist/esm/models/amend-order-request.js +4 -4
- package/dist/esm/models/amend-order-response.d.ts +6 -5
- package/dist/esm/models/amend-order-response.js +4 -4
- package/dist/esm/models/announcement.d.ts +25 -13
- package/dist/esm/models/announcement.js +8 -8
- package/dist/esm/models/api-key.d.ts +4 -8
- package/dist/esm/models/api-key.js +4 -4
- package/dist/esm/models/associated-event.d.ts +33 -0
- package/dist/esm/models/associated-event.js +14 -0
- package/dist/esm/models/batch-cancel-orders-individual-response.d.ts +25 -0
- package/dist/esm/models/batch-cancel-orders-individual-response.js +14 -0
- package/dist/esm/models/batch-cancel-orders-request.d.ts +8 -5
- package/dist/esm/models/batch-cancel-orders-request.js +4 -4
- package/dist/esm/models/batch-cancel-orders-response.d.ts +6 -6
- package/dist/esm/models/batch-cancel-orders-response.js +4 -4
- package/dist/esm/models/batch-create-orders-individual-response.d.ts +18 -0
- package/dist/esm/models/batch-create-orders-individual-response.js +14 -0
- package/dist/esm/models/batch-create-orders-request.d.ts +4 -4
- package/dist/esm/models/batch-create-orders-request.js +4 -4
- package/dist/esm/models/batch-create-orders-response.d.ts +6 -6
- package/dist/esm/models/batch-create-orders-response.js +4 -4
- package/dist/esm/models/batch-get-market-candlesticks-response.d.ts +18 -0
- package/dist/esm/models/batch-get-market-candlesticks-response.js +14 -0
- package/dist/esm/models/bid-ask-distribution.d.ts +45 -0
- package/dist/esm/models/bid-ask-distribution.js +14 -0
- package/dist/esm/models/cancel-order-response.d.ts +6 -6
- package/dist/esm/models/cancel-order-response.js +4 -4
- package/dist/esm/models/create-api-key-request.d.ts +4 -4
- package/dist/esm/models/create-api-key-request.js +4 -4
- package/dist/esm/models/create-api-key-response.d.ts +4 -4
- package/dist/esm/models/create-api-key-response.js +4 -4
- package/dist/esm/models/create-market-in-multivariate-event-collection-request.d.ts +18 -0
- package/dist/esm/models/create-market-in-multivariate-event-collection-request.js +14 -0
- package/dist/esm/models/create-market-in-multivariate-event-collection-response.d.ts +21 -0
- package/dist/esm/models/create-market-in-multivariate-event-collection-response.js +14 -0
- package/dist/esm/models/create-order-group-request.d.ts +5 -5
- package/dist/esm/models/create-order-group-request.js +4 -4
- package/dist/esm/models/create-order-group-response.d.ts +5 -5
- package/dist/esm/models/create-order-group-response.js +4 -4
- package/dist/esm/models/create-order-request.d.ts +34 -9
- package/dist/esm/models/create-order-request.js +9 -4
- package/dist/esm/models/create-order-response.d.ts +5 -5
- package/dist/esm/models/create-order-response.js +4 -4
- package/dist/esm/models/create-quote-request.d.ts +19 -6
- package/dist/esm/models/create-quote-request.js +4 -4
- package/dist/esm/models/create-quote-response.d.ts +8 -6
- package/dist/esm/models/create-quote-response.js +4 -4
- package/dist/esm/models/create-rfqrequest.d.ts +28 -13
- package/dist/esm/models/create-rfqrequest.js +5 -8
- package/dist/esm/models/create-rfqresponse.d.ts +8 -6
- package/dist/esm/models/create-rfqresponse.js +4 -4
- package/dist/esm/models/daily-schedule.d.ts +12 -6
- package/dist/esm/models/daily-schedule.js +4 -4
- package/dist/esm/models/decrease-order-request.d.ts +6 -5
- package/dist/esm/models/decrease-order-request.js +4 -4
- package/dist/esm/models/decrease-order-response.d.ts +5 -5
- package/dist/esm/models/decrease-order-response.js +4 -4
- package/dist/esm/models/error-response.d.ts +20 -6
- package/dist/esm/models/error-response.js +4 -4
- package/dist/esm/models/event-data.d.ts +62 -0
- package/dist/esm/models/event-data.js +14 -0
- package/dist/esm/models/event-position.d.ts +24 -24
- package/dist/esm/models/event-position.js +4 -4
- package/dist/esm/models/exchange-status.d.ts +16 -6
- package/dist/esm/models/exchange-status.js +4 -4
- package/dist/esm/models/fill.d.ts +71 -12
- package/dist/esm/models/fill.js +4 -4
- package/dist/esm/models/forecast-percentiles-point.d.ts +30 -0
- package/dist/esm/models/forecast-percentiles-point.js +14 -0
- package/dist/esm/models/generate-api-key-request.d.ts +4 -4
- package/dist/esm/models/generate-api-key-request.js +4 -4
- package/dist/esm/models/generate-api-key-response.d.ts +4 -4
- package/dist/esm/models/generate-api-key-response.js +4 -4
- package/dist/esm/models/get-api-keys-response.d.ts +4 -4
- package/dist/esm/models/get-api-keys-response.js +4 -4
- package/dist/esm/models/get-balance-response.d.ts +14 -6
- package/dist/esm/models/get-balance-response.js +4 -4
- package/dist/esm/models/get-communications-idresponse.d.ts +6 -6
- package/dist/esm/models/get-communications-idresponse.js +4 -4
- package/dist/esm/models/get-event-candlesticks-response.d.ts +26 -0
- package/dist/esm/models/get-event-candlesticks-response.js +14 -0
- package/dist/esm/models/get-event-forecast-percentiles-history-response.d.ts +18 -0
- package/dist/esm/models/get-event-forecast-percentiles-history-response.js +14 -0
- package/dist/esm/models/get-event-metadata-response.d.ts +30 -5
- package/dist/esm/models/get-event-metadata-response.js +4 -4
- package/dist/esm/models/get-event-response.d.ts +10 -7
- package/dist/esm/models/get-event-response.js +4 -4
- package/dist/esm/models/get-events-candlesticks-response-events-inner.d.ts +30 -0
- package/dist/esm/models/get-events-candlesticks-response-events-inner.js +14 -0
- package/dist/esm/models/get-events-candlesticks-response.d.ts +18 -0
- package/dist/esm/models/get-events-candlesticks-response.js +14 -0
- package/dist/esm/models/get-events-response.d.ts +18 -7
- package/dist/esm/models/get-events-response.js +4 -4
- package/dist/esm/models/get-exchange-announcements-response.d.ts +8 -5
- package/dist/esm/models/get-exchange-announcements-response.js +4 -4
- package/dist/esm/models/get-exchange-schedule-response.d.ts +6 -6
- package/dist/esm/models/get-exchange-schedule-response.js +4 -4
- package/dist/esm/models/get-fills-response.d.ts +6 -6
- package/dist/esm/models/get-fills-response.js +4 -4
- package/dist/esm/models/get-filters-by-sports-response.d.ts +24 -0
- package/dist/esm/models/get-filters-by-sports-response.js +14 -0
- package/dist/esm/models/get-incentive-programs-response.d.ts +19 -0
- package/dist/esm/models/get-incentive-programs-response.js +14 -0
- package/dist/esm/models/get-live-data-response.d.ts +15 -0
- package/dist/esm/models/get-live-data-response.js +14 -0
- package/dist/esm/models/get-live-datas-response.d.ts +15 -0
- package/dist/esm/models/get-live-datas-response.js +14 -0
- package/dist/esm/models/get-market-candlesticks-response.d.ts +13 -6
- package/dist/esm/models/get-market-candlesticks-response.js +4 -4
- package/dist/esm/models/get-market-orderbook-response.d.ts +6 -6
- package/dist/esm/models/get-market-orderbook-response.js +4 -4
- package/dist/esm/models/get-market-response.d.ts +5 -5
- package/dist/esm/models/get-market-response.js +4 -4
- package/dist/esm/models/get-markets-response.d.ts +6 -6
- package/dist/esm/models/get-markets-response.js +4 -4
- package/dist/esm/models/get-milestone-response.d.ts +5 -5
- package/dist/esm/models/get-milestone-response.js +4 -4
- package/dist/esm/models/get-milestones-response.d.ts +12 -5
- package/dist/esm/models/get-milestones-response.js +4 -4
- package/dist/esm/models/get-multivariate-event-collection-lookup-history-response.d.ts +18 -0
- package/dist/esm/models/get-multivariate-event-collection-lookup-history-response.js +14 -0
- package/dist/esm/models/get-multivariate-event-collection-response.d.ts +5 -5
- package/dist/esm/models/get-multivariate-event-collection-response.js +4 -4
- package/dist/esm/models/get-multivariate-event-collections-response.d.ts +12 -5
- package/dist/esm/models/get-multivariate-event-collections-response.js +4 -4
- package/dist/esm/models/get-multivariate-events-response.d.ts +22 -0
- package/dist/esm/models/get-multivariate-events-response.js +14 -0
- package/dist/esm/models/get-order-group-response.d.ts +6 -6
- package/dist/esm/models/get-order-group-response.js +4 -4
- package/dist/esm/models/get-order-groups-response.d.ts +4 -5
- package/dist/esm/models/get-order-groups-response.js +4 -4
- package/dist/esm/models/get-order-queue-position-response.d.ts +8 -5
- package/dist/esm/models/get-order-queue-position-response.js +4 -4
- package/dist/esm/models/get-order-queue-positions-response.d.ts +18 -0
- package/dist/esm/models/get-order-queue-positions-response.js +14 -0
- package/dist/esm/models/get-order-response.d.ts +4 -4
- package/dist/esm/models/get-order-response.js +4 -4
- package/dist/esm/models/get-orders-response.d.ts +6 -6
- package/dist/esm/models/get-orders-response.js +4 -4
- package/dist/esm/models/get-portfolio-resting-order-total-value-response.d.ts +17 -0
- package/dist/esm/models/get-portfolio-resting-order-total-value-response.js +14 -0
- package/dist/esm/models/get-positions-response.d.ts +16 -7
- package/dist/esm/models/get-positions-response.js +4 -4
- package/dist/esm/models/get-quote-response.d.ts +5 -5
- package/dist/esm/models/get-quote-response.js +4 -4
- package/dist/esm/models/get-quotes-response.d.ts +12 -5
- package/dist/esm/models/get-quotes-response.js +4 -4
- package/dist/esm/models/get-rfqresponse.d.ts +5 -5
- package/dist/esm/models/get-rfqresponse.js +4 -4
- package/dist/esm/models/get-rfqs-response.d.ts +12 -5
- package/dist/esm/models/get-rfqs-response.js +4 -4
- package/dist/esm/models/get-series-fee-changes-response.d.ts +15 -0
- package/dist/esm/models/get-series-fee-changes-response.js +14 -0
- package/dist/esm/models/get-series-list-response.d.ts +15 -0
- package/dist/esm/models/get-series-list-response.js +14 -0
- package/dist/esm/models/get-series-response.d.ts +5 -5
- package/dist/esm/models/get-series-response.js +4 -4
- package/dist/esm/models/get-settlements-response.d.ts +5 -5
- package/dist/esm/models/get-settlements-response.js +4 -4
- package/dist/esm/models/get-structured-target-response.d.ts +4 -4
- package/dist/esm/models/get-structured-target-response.js +4 -4
- package/dist/esm/models/get-structured-targets-response.d.ts +8 -4
- package/dist/esm/models/get-structured-targets-response.js +4 -4
- package/dist/esm/models/get-tags-for-series-categories-response.d.ts +19 -0
- package/dist/esm/models/get-tags-for-series-categories-response.js +14 -0
- package/dist/esm/models/get-trades-response.d.ts +6 -6
- package/dist/esm/models/get-trades-response.js +4 -4
- package/dist/esm/models/get-user-data-timestamp-response.d.ts +8 -5
- package/dist/esm/models/get-user-data-timestamp-response.js +4 -4
- package/dist/esm/models/incentive-program.d.ts +54 -0
- package/dist/esm/models/incentive-program.js +17 -0
- package/dist/esm/models/index.d.ts +47 -17
- package/dist/esm/models/index.js +47 -17
- package/dist/esm/models/live-data.d.ts +27 -0
- package/dist/esm/models/live-data.js +14 -0
- package/dist/esm/models/lookup-point.d.ts +30 -0
- package/dist/esm/models/lookup-point.js +14 -0
- package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-request.d.ts +18 -0
- package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-request.js +14 -0
- package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-response.d.ts +21 -0
- package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-response.js +14 -0
- package/dist/esm/models/maintenance-window.d.ts +21 -0
- package/dist/esm/models/maintenance-window.js +14 -0
- package/dist/esm/models/market-candlestick.d.ts +30 -0
- package/dist/esm/models/market-candlestick.js +14 -0
- package/dist/esm/models/market-candlesticks-response.d.ts +22 -0
- package/dist/esm/models/market-candlesticks-response.js +14 -0
- package/dist/esm/models/market-metadata.d.ts +25 -0
- package/dist/esm/models/market-metadata.js +14 -0
- package/dist/esm/models/market-position.d.ts +61 -0
- package/dist/esm/models/market-position.js +14 -0
- package/dist/esm/models/market.d.ts +219 -26
- package/dist/esm/models/market.js +21 -4
- package/dist/esm/models/milestone.d.ts +54 -7
- package/dist/esm/models/milestone.js +4 -4
- package/dist/esm/models/multivariate-event-collection.d.ts +61 -9
- package/dist/esm/models/multivariate-event-collection.js +4 -4
- package/dist/esm/models/mve-selected-leg.d.ts +25 -0
- package/dist/esm/models/mve-selected-leg.js +14 -0
- package/dist/esm/models/order-group.d.ts +5 -5
- package/dist/esm/models/order-group.js +4 -4
- package/dist/esm/models/order-queue-position.d.ts +25 -0
- package/dist/esm/models/order-queue-position.js +14 -0
- package/dist/esm/models/order-status.d.ts +20 -0
- package/dist/esm/models/order-status.js +21 -0
- package/dist/esm/models/order.d.ts +75 -29
- package/dist/esm/models/order.js +4 -10
- package/dist/esm/models/orderbook.d.ts +17 -0
- package/dist/esm/models/orderbook.js +14 -0
- package/dist/esm/models/percentile-point.d.ts +29 -0
- package/dist/esm/models/percentile-point.js +14 -0
- package/dist/esm/models/price-distribution.d.ts +77 -0
- package/dist/esm/models/price-distribution.js +14 -0
- package/dist/esm/models/price-range.d.ts +25 -0
- package/dist/esm/models/price-range.js +14 -0
- package/dist/esm/models/quote.d.ts +116 -17
- package/dist/esm/models/quote.js +14 -7
- package/dist/esm/models/rfq.d.ts +65 -16
- package/dist/esm/models/rfq.js +7 -7
- package/dist/esm/models/schedule.d.ts +23 -0
- package/dist/esm/models/schedule.js +14 -0
- package/dist/esm/models/scope-list.d.ts +17 -0
- package/dist/esm/models/scope-list.js +14 -0
- package/dist/esm/models/self-trade-prevention-type.d.ts +19 -0
- package/dist/esm/models/self-trade-prevention-type.js +20 -0
- package/dist/esm/models/series-fee-change.d.ts +39 -0
- package/dist/esm/models/series-fee-change.js +18 -0
- package/dist/esm/models/series.d.ts +57 -9
- package/dist/esm/models/series.js +9 -5
- package/dist/esm/models/settlement-source.d.ts +21 -0
- package/dist/esm/models/settlement-source.js +14 -0
- package/dist/esm/models/settlement.d.ts +48 -12
- package/dist/esm/models/settlement.js +8 -6
- package/dist/esm/models/sport-filter-details.d.ts +24 -0
- package/dist/esm/models/sport-filter-details.js +14 -0
- package/dist/esm/models/structured-target.d.ts +28 -7
- package/dist/esm/models/structured-target.js +4 -4
- package/dist/esm/models/ticker-pair.d.ts +30 -0
- package/dist/esm/models/ticker-pair.js +17 -0
- package/dist/esm/models/trade.d.ts +45 -11
- package/dist/esm/models/trade.js +6 -6
- package/dist/esm/models/weekly-schedule.d.ts +50 -0
- package/dist/esm/models/weekly-schedule.js +14 -0
- package/dist/index.d.ts +4 -4
- package/dist/index.js +4 -4
- package/dist/models/accept-quote-request.d.ts +13 -5
- package/dist/models/accept-quote-request.js +9 -4
- package/dist/models/amend-order-request.d.ts +27 -10
- package/dist/models/amend-order-request.js +4 -4
- package/dist/models/amend-order-response.d.ts +6 -5
- package/dist/models/amend-order-response.js +4 -4
- package/dist/models/announcement.d.ts +25 -13
- package/dist/models/announcement.js +9 -9
- package/dist/models/api-key.d.ts +4 -8
- package/dist/models/api-key.js +4 -4
- package/dist/models/associated-event.d.ts +33 -0
- package/dist/models/associated-event.js +15 -0
- package/dist/models/batch-cancel-orders-individual-response.d.ts +25 -0
- package/dist/models/batch-cancel-orders-individual-response.js +15 -0
- package/dist/models/batch-cancel-orders-request.d.ts +8 -5
- package/dist/models/batch-cancel-orders-request.js +4 -4
- package/dist/models/batch-cancel-orders-response.d.ts +6 -6
- package/dist/models/batch-cancel-orders-response.js +4 -4
- package/dist/models/batch-create-orders-individual-response.d.ts +18 -0
- package/dist/models/batch-create-orders-individual-response.js +15 -0
- package/dist/models/batch-create-orders-request.d.ts +4 -4
- package/dist/models/batch-create-orders-request.js +4 -4
- package/dist/models/batch-create-orders-response.d.ts +6 -6
- package/dist/models/batch-create-orders-response.js +4 -4
- package/dist/models/batch-get-market-candlesticks-response.d.ts +18 -0
- package/dist/models/batch-get-market-candlesticks-response.js +15 -0
- package/dist/models/bid-ask-distribution.d.ts +45 -0
- package/dist/models/bid-ask-distribution.js +15 -0
- package/dist/models/cancel-order-response.d.ts +6 -6
- package/dist/models/cancel-order-response.js +4 -4
- package/dist/models/create-api-key-request.d.ts +4 -4
- package/dist/models/create-api-key-request.js +4 -4
- package/dist/models/create-api-key-response.d.ts +4 -4
- package/dist/models/create-api-key-response.js +4 -4
- package/dist/models/create-market-in-multivariate-event-collection-request.d.ts +18 -0
- package/dist/models/create-market-in-multivariate-event-collection-request.js +15 -0
- package/dist/models/create-market-in-multivariate-event-collection-response.d.ts +21 -0
- package/dist/models/create-market-in-multivariate-event-collection-response.js +15 -0
- package/dist/models/create-order-group-request.d.ts +5 -5
- package/dist/models/create-order-group-request.js +4 -4
- package/dist/models/create-order-group-response.d.ts +5 -5
- package/dist/models/create-order-group-response.js +4 -4
- package/dist/models/create-order-request.d.ts +34 -9
- package/dist/models/create-order-request.js +10 -5
- package/dist/models/create-order-response.d.ts +5 -5
- package/dist/models/create-order-response.js +4 -4
- package/dist/models/create-quote-request.d.ts +19 -6
- package/dist/models/create-quote-request.js +4 -4
- package/dist/models/create-quote-response.d.ts +8 -6
- package/dist/models/create-quote-response.js +4 -4
- package/dist/models/create-rfqrequest.d.ts +28 -13
- package/dist/models/create-rfqrequest.js +4 -9
- package/dist/models/create-rfqresponse.d.ts +8 -6
- package/dist/models/create-rfqresponse.js +4 -4
- package/dist/models/daily-schedule.d.ts +12 -6
- package/dist/models/daily-schedule.js +4 -4
- package/dist/models/decrease-order-request.d.ts +6 -5
- package/dist/models/decrease-order-request.js +4 -4
- package/dist/models/decrease-order-response.d.ts +5 -5
- package/dist/models/decrease-order-response.js +4 -4
- package/dist/models/error-response.d.ts +20 -6
- package/dist/models/error-response.js +4 -4
- package/dist/models/event-data.d.ts +62 -0
- package/dist/models/event-data.js +15 -0
- package/dist/models/event-position.d.ts +24 -24
- package/dist/models/event-position.js +4 -4
- package/dist/models/exchange-status.d.ts +16 -6
- package/dist/models/exchange-status.js +4 -4
- package/dist/models/fill.d.ts +71 -12
- package/dist/models/fill.js +4 -4
- package/dist/models/forecast-percentiles-point.d.ts +30 -0
- package/dist/models/forecast-percentiles-point.js +15 -0
- package/dist/models/generate-api-key-request.d.ts +4 -4
- package/dist/models/generate-api-key-request.js +4 -4
- package/dist/models/generate-api-key-response.d.ts +4 -4
- package/dist/models/generate-api-key-response.js +4 -4
- package/dist/models/get-api-keys-response.d.ts +4 -4
- package/dist/models/get-api-keys-response.js +4 -4
- package/dist/models/get-balance-response.d.ts +14 -6
- package/dist/models/get-balance-response.js +4 -4
- package/dist/models/get-communications-idresponse.d.ts +6 -6
- package/dist/models/get-communications-idresponse.js +4 -4
- package/dist/models/get-event-candlesticks-response.d.ts +26 -0
- package/dist/models/get-event-candlesticks-response.js +15 -0
- package/dist/models/get-event-forecast-percentiles-history-response.d.ts +18 -0
- package/dist/models/get-event-forecast-percentiles-history-response.js +15 -0
- package/dist/models/get-event-metadata-response.d.ts +30 -5
- package/dist/models/get-event-metadata-response.js +4 -4
- package/dist/models/get-event-response.d.ts +10 -7
- package/dist/models/get-event-response.js +4 -4
- package/dist/models/get-events-candlesticks-response-events-inner.d.ts +30 -0
- package/dist/models/get-events-candlesticks-response-events-inner.js +15 -0
- package/dist/models/get-events-candlesticks-response.d.ts +18 -0
- package/dist/models/get-events-candlesticks-response.js +15 -0
- package/dist/models/get-events-response.d.ts +18 -7
- package/dist/models/get-events-response.js +4 -4
- package/dist/models/get-exchange-announcements-response.d.ts +8 -5
- package/dist/models/get-exchange-announcements-response.js +4 -4
- package/dist/models/get-exchange-schedule-response.d.ts +6 -6
- package/dist/models/get-exchange-schedule-response.js +4 -4
- package/dist/models/get-fills-response.d.ts +6 -6
- package/dist/models/get-fills-response.js +4 -4
- package/dist/models/get-filters-by-sports-response.d.ts +24 -0
- package/dist/models/get-filters-by-sports-response.js +15 -0
- package/dist/models/get-incentive-programs-response.d.ts +19 -0
- package/dist/models/get-incentive-programs-response.js +15 -0
- package/dist/models/get-live-data-response.d.ts +15 -0
- package/dist/models/get-live-data-response.js +15 -0
- package/dist/models/get-live-datas-response.d.ts +15 -0
- package/dist/models/get-live-datas-response.js +15 -0
- package/dist/models/get-market-candlesticks-response.d.ts +13 -6
- package/dist/models/get-market-candlesticks-response.js +4 -4
- package/dist/models/get-market-orderbook-response.d.ts +6 -6
- package/dist/models/get-market-orderbook-response.js +4 -4
- package/dist/models/get-market-response.d.ts +5 -5
- package/dist/models/get-market-response.js +4 -4
- package/dist/models/get-markets-response.d.ts +6 -6
- package/dist/models/get-markets-response.js +4 -4
- package/dist/models/get-milestone-response.d.ts +5 -5
- package/dist/models/get-milestone-response.js +4 -4
- package/dist/models/get-milestones-response.d.ts +12 -5
- package/dist/models/get-milestones-response.js +4 -4
- package/dist/models/get-multivariate-event-collection-lookup-history-response.d.ts +18 -0
- package/dist/models/get-multivariate-event-collection-lookup-history-response.js +15 -0
- package/dist/models/get-multivariate-event-collection-response.d.ts +5 -5
- package/dist/models/get-multivariate-event-collection-response.js +4 -4
- package/dist/models/get-multivariate-event-collections-response.d.ts +12 -5
- package/dist/models/get-multivariate-event-collections-response.js +4 -4
- package/dist/models/get-multivariate-events-response.d.ts +22 -0
- package/dist/models/get-multivariate-events-response.js +15 -0
- package/dist/models/get-order-group-response.d.ts +6 -6
- package/dist/models/get-order-group-response.js +4 -4
- package/dist/models/get-order-groups-response.d.ts +4 -5
- package/dist/models/get-order-groups-response.js +4 -4
- package/dist/models/get-order-queue-position-response.d.ts +8 -5
- package/dist/models/get-order-queue-position-response.js +4 -4
- package/dist/models/get-order-queue-positions-response.d.ts +18 -0
- package/dist/models/get-order-queue-positions-response.js +15 -0
- package/dist/models/get-order-response.d.ts +4 -4
- package/dist/models/get-order-response.js +4 -4
- package/dist/models/get-orders-response.d.ts +6 -6
- package/dist/models/get-orders-response.js +4 -4
- package/dist/models/get-portfolio-resting-order-total-value-response.d.ts +17 -0
- package/dist/models/get-portfolio-resting-order-total-value-response.js +15 -0
- package/dist/models/get-positions-response.d.ts +16 -7
- package/dist/models/get-positions-response.js +4 -4
- package/dist/models/get-quote-response.d.ts +5 -5
- package/dist/models/get-quote-response.js +4 -4
- package/dist/models/get-quotes-response.d.ts +12 -5
- package/dist/models/get-quotes-response.js +4 -4
- package/dist/models/get-rfqresponse.d.ts +5 -5
- package/dist/models/get-rfqresponse.js +4 -4
- package/dist/models/get-rfqs-response.d.ts +12 -5
- package/dist/models/get-rfqs-response.js +4 -4
- package/dist/models/get-series-fee-changes-response.d.ts +15 -0
- package/dist/models/get-series-fee-changes-response.js +15 -0
- package/dist/models/get-series-list-response.d.ts +15 -0
- package/dist/models/get-series-list-response.js +15 -0
- package/dist/models/get-series-response.d.ts +5 -5
- package/dist/models/get-series-response.js +4 -4
- package/dist/models/get-settlements-response.d.ts +5 -5
- package/dist/models/get-settlements-response.js +4 -4
- package/dist/models/get-structured-target-response.d.ts +4 -4
- package/dist/models/get-structured-target-response.js +4 -4
- package/dist/models/get-structured-targets-response.d.ts +8 -4
- package/dist/models/get-structured-targets-response.js +4 -4
- package/dist/models/get-tags-for-series-categories-response.d.ts +19 -0
- package/dist/models/get-tags-for-series-categories-response.js +15 -0
- package/dist/models/get-trades-response.d.ts +6 -6
- package/dist/models/get-trades-response.js +4 -4
- package/dist/models/get-user-data-timestamp-response.d.ts +8 -5
- package/dist/models/get-user-data-timestamp-response.js +4 -4
- package/dist/models/incentive-program.d.ts +54 -0
- package/dist/models/incentive-program.js +20 -0
- package/dist/models/index.d.ts +47 -17
- package/dist/models/index.js +47 -17
- package/dist/models/live-data.d.ts +27 -0
- package/dist/models/live-data.js +15 -0
- package/dist/models/lookup-point.d.ts +30 -0
- package/dist/models/lookup-point.js +15 -0
- package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-request.d.ts +18 -0
- package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-request.js +15 -0
- package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-response.d.ts +21 -0
- package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-response.js +15 -0
- package/dist/models/maintenance-window.d.ts +21 -0
- package/dist/models/maintenance-window.js +15 -0
- package/dist/models/market-candlestick.d.ts +30 -0
- package/dist/models/market-candlestick.js +15 -0
- package/dist/models/market-candlesticks-response.d.ts +22 -0
- package/dist/models/market-candlesticks-response.js +15 -0
- package/dist/models/market-metadata.d.ts +25 -0
- package/dist/models/market-metadata.js +15 -0
- package/dist/models/market-position.d.ts +61 -0
- package/dist/models/market-position.js +15 -0
- package/dist/models/market.d.ts +219 -26
- package/dist/models/market.js +22 -5
- package/dist/models/milestone.d.ts +54 -7
- package/dist/models/milestone.js +4 -4
- package/dist/models/multivariate-event-collection.d.ts +61 -9
- package/dist/models/multivariate-event-collection.js +4 -4
- package/dist/models/mve-selected-leg.d.ts +25 -0
- package/dist/models/mve-selected-leg.js +15 -0
- package/dist/models/order-group.d.ts +5 -5
- package/dist/models/order-group.js +4 -4
- package/dist/models/order-queue-position.d.ts +25 -0
- package/dist/models/order-queue-position.js +15 -0
- package/dist/models/order-status.d.ts +20 -0
- package/dist/models/order-status.js +24 -0
- package/dist/models/order.d.ts +75 -29
- package/dist/models/order.js +5 -11
- package/dist/models/orderbook.d.ts +17 -0
- package/dist/models/orderbook.js +15 -0
- package/dist/models/percentile-point.d.ts +29 -0
- package/dist/models/percentile-point.js +15 -0
- package/dist/models/price-distribution.d.ts +77 -0
- package/dist/models/price-distribution.js +15 -0
- package/dist/models/price-range.d.ts +25 -0
- package/dist/models/price-range.js +15 -0
- package/dist/models/quote.d.ts +116 -17
- package/dist/models/quote.js +15 -8
- package/dist/models/rfq.d.ts +65 -16
- package/dist/models/rfq.js +8 -8
- package/dist/models/schedule.d.ts +23 -0
- package/dist/models/schedule.js +15 -0
- package/dist/models/scope-list.d.ts +17 -0
- package/dist/models/scope-list.js +15 -0
- package/dist/models/self-trade-prevention-type.d.ts +19 -0
- package/dist/models/self-trade-prevention-type.js +23 -0
- package/dist/models/series-fee-change.d.ts +39 -0
- package/dist/models/series-fee-change.js +21 -0
- package/dist/models/series.d.ts +57 -9
- package/dist/models/series.js +10 -4
- package/dist/models/settlement-source.d.ts +21 -0
- package/dist/models/settlement-source.js +15 -0
- package/dist/models/settlement.d.ts +48 -12
- package/dist/models/settlement.js +9 -7
- package/dist/models/sport-filter-details.d.ts +24 -0
- package/dist/models/sport-filter-details.js +15 -0
- package/dist/models/structured-target.d.ts +28 -7
- package/dist/models/structured-target.js +4 -4
- package/dist/models/ticker-pair.d.ts +30 -0
- package/dist/models/ticker-pair.js +20 -0
- package/dist/models/trade.d.ts +45 -11
- package/dist/models/trade.js +6 -6
- package/dist/models/weekly-schedule.d.ts +50 -0
- package/dist/models/weekly-schedule.js +15 -0
- package/docs/AcceptQuoteRequest.md +2 -2
- package/docs/AmendOrderRequest.md +12 -8
- package/docs/AmendOrderResponse.md +3 -1
- package/docs/Announcement.md +6 -6
- package/docs/ApiKey.md +0 -2
- package/docs/ApiKeysApi.md +16 -106
- package/docs/AssociatedEvent.md +28 -0
- package/docs/BatchCancelOrdersIndividualResponse.md +26 -0
- package/docs/BatchCancelOrdersRequest.md +2 -2
- package/docs/BatchCancelOrdersResponse.md +2 -2
- package/docs/BatchCreateOrdersIndividualResponse.md +24 -0
- package/docs/BatchCreateOrdersResponse.md +2 -2
- package/docs/BatchGetMarketCandlesticksResponse.md +20 -0
- package/docs/BidAskDistribution.md +34 -0
- package/docs/CancelOrderResponse.md +2 -2
- package/docs/CollectionApi.md +318 -0
- package/docs/CommunicationsApi.md +46 -271
- package/docs/CreateMarketInMultivariateEventCollectionRequest.md +20 -0
- package/docs/CreateMarketInMultivariateEventCollectionResponse.md +22 -0
- package/docs/CreateOrderGroupRequest.md +1 -1
- package/docs/CreateOrderGroupResponse.md +1 -1
- package/docs/CreateOrderRequest.md +18 -6
- package/docs/CreateOrderResponse.md +1 -1
- package/docs/CreateQuoteRequest.md +7 -5
- package/docs/CreateQuoteResponse.md +2 -2
- package/docs/CreateRFQRequest.md +12 -8
- package/docs/CreateRFQResponse.md +2 -2
- package/docs/DailySchedule.md +2 -2
- package/docs/DecreaseOrderRequest.md +3 -1
- package/docs/DecreaseOrderResponse.md +1 -1
- package/docs/ErrorResponse.md +8 -2
- package/docs/EventData.md +42 -0
- package/docs/EventPosition.md +11 -11
- package/docs/EventsApi.md +133 -93
- package/docs/ExchangeApi.md +42 -83
- package/docs/ExchangeStatus.md +4 -2
- package/docs/FcmApi.md +92 -0
- package/docs/Fill.md +25 -9
- package/docs/ForecastPercentilesPoint.md +26 -0
- package/docs/GetBalanceResponse.md +5 -1
- package/docs/GetCommunicationsIDResponse.md +1 -1
- package/docs/GetEventCandlesticksResponse.md +24 -0
- package/docs/GetEventForecastPercentilesHistoryResponse.md +20 -0
- package/docs/GetEventMetadataResponse.md +12 -2
- package/docs/GetEventResponse.md +2 -2
- package/docs/GetEventsCandlesticksResponse.md +20 -0
- package/docs/GetEventsCandlesticksResponseEventsInner.md +26 -0
- package/docs/GetEventsResponse.md +4 -2
- package/docs/GetExchangeAnnouncementsResponse.md +1 -1
- package/docs/GetExchangeScheduleResponse.md +1 -1
- package/docs/GetFillsResponse.md +2 -2
- package/docs/GetFiltersBySportsResponse.md +22 -0
- package/docs/GetIncentiveProgramsResponse.md +22 -0
- package/docs/GetLiveDataResponse.md +20 -0
- package/docs/GetLiveDatasResponse.md +20 -0
- package/docs/GetMarketCandlesticksResponse.md +3 -1
- package/docs/GetMarketOrderbookResponse.md +1 -1
- package/docs/GetMarketResponse.md +1 -1
- package/docs/GetMarketsResponse.md +2 -2
- package/docs/GetMilestoneResponse.md +1 -1
- package/docs/GetMilestonesResponse.md +3 -1
- package/docs/GetMultivariateEventCollectionLookupHistoryResponse.md +20 -0
- package/docs/GetMultivariateEventCollectionResponse.md +2 -2
- package/docs/GetMultivariateEventCollectionsResponse.md +4 -2
- package/docs/GetMultivariateEventsResponse.md +22 -0
- package/docs/GetOrderGroupResponse.md +2 -2
- package/docs/GetOrderGroupsResponse.md +0 -2
- package/docs/GetOrderQueuePositionResponse.md +1 -1
- package/docs/GetOrderQueuePositionsResponse.md +20 -0
- package/docs/GetOrdersResponse.md +2 -2
- package/docs/GetPortfolioRestingOrderTotalValueResponse.md +20 -0
- package/docs/GetPositionsResponse.md +4 -4
- package/docs/GetQuoteResponse.md +1 -1
- package/docs/GetQuotesResponse.md +3 -1
- package/docs/GetRFQResponse.md +1 -1
- package/docs/GetRFQsResponse.md +3 -1
- package/docs/GetSeriesFeeChangesResponse.md +20 -0
- package/docs/GetSeriesListResponse.md +20 -0
- package/docs/GetSeriesResponse.md +1 -1
- package/docs/GetSettlementsResponse.md +1 -1
- package/docs/GetStructuredTargetsResponse.md +2 -0
- package/docs/GetTagsForSeriesCategoriesResponse.md +20 -0
- package/docs/GetTradesResponse.md +2 -2
- package/docs/GetUserDataTimestampResponse.md +2 -2
- package/docs/IncentiveProgram.md +36 -0
- package/docs/IncentiveProgramsApi.md +44 -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 +105 -21
- package/docs/MarketApi.md +311 -0
- package/docs/MarketCandlestick.md +30 -0
- package/docs/MarketCandlesticksResponse.md +22 -0
- package/docs/MarketMetadata.md +24 -0
- package/docs/MarketPosition.md +42 -0
- package/docs/MarketsApi.md +3 -4
- package/docs/Milestone.md +23 -5
- package/docs/MilestoneApi.md +85 -0
- package/docs/MilestonesApi.md +0 -1
- package/docs/MultivariateApi.md +188 -0
- package/docs/MultivariateCollectionsApi.md +0 -1
- package/docs/MultivariateEventCollection.md +26 -6
- package/docs/MveSelectedLeg.md +24 -0
- package/docs/Order.md +42 -18
- package/docs/OrderGroup.md +1 -1
- package/docs/OrderGroupsApi.md +180 -0
- package/docs/OrderQueuePosition.md +24 -0
- package/docs/OrderStatus.md +13 -0
- package/docs/Orderbook.md +26 -0
- package/docs/OrdersApi.md +372 -0
- package/docs/PercentilePoint.md +26 -0
- package/docs/PortfolioApi.md +27 -1062
- package/docs/PriceDistribution.md +50 -0
- package/docs/PriceRange.md +24 -0
- package/docs/Quote.md +48 -16
- package/docs/RFQ.md +26 -14
- 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 +21 -5
- package/docs/SeriesApi.md +0 -1
- package/docs/SeriesFeeChange.md +28 -0
- package/docs/Settlement.md +15 -7
- package/docs/SettlementSource.md +22 -0
- package/docs/SportFilterDetails.md +22 -0
- package/docs/StructuredTarget.md +12 -6
- package/docs/StructuredTargetsApi.md +11 -57
- package/docs/TickerPair.md +24 -0
- package/docs/Trade.md +14 -6
- package/docs/WeeklySchedule.md +36 -0
- package/index.ts +4 -4
- package/models/accept-quote-request.ts +16 -5
- package/models/amend-order-request.ts +27 -10
- package/models/amend-order-response.ts +6 -5
- package/models/announcement.ts +26 -14
- package/models/api-key.ts +4 -8
- package/models/associated-event.ts +39 -0
- package/models/batch-cancel-orders-individual-response.ts +35 -0
- package/models/batch-cancel-orders-request.ts +8 -5
- package/models/batch-cancel-orders-response-responses-inner.ts +0 -1
- package/models/batch-cancel-orders-response.ts +6 -6
- package/models/batch-create-orders-individual-response.ts +28 -0
- package/models/batch-create-orders-request.ts +4 -4
- package/models/batch-create-orders-response-responses-inner.ts +0 -1
- package/models/batch-create-orders-response.ts +6 -6
- package/models/batch-get-market-candlesticks-response.ts +26 -0
- package/models/bid-ask-distribution.ts +51 -0
- package/models/cancel-order-response.ts +6 -6
- package/models/candlestick.ts +0 -1
- package/models/create-api-key-request.ts +4 -4
- package/models/create-api-key-response.ts +4 -4
- package/models/create-market-in-multivariate-event-collection-request.ts +26 -0
- package/models/create-market-in-multivariate-event-collection-response.ts +27 -0
- package/models/create-order-group-request.ts +5 -5
- package/models/create-order-group-response.ts +5 -5
- package/models/create-order-request.ts +37 -9
- package/models/create-order-response.ts +5 -5
- package/models/create-quote-request.ts +19 -6
- package/models/create-quote-response.ts +8 -8
- package/models/create-rfqrequest.ts +28 -16
- package/models/create-rfqresponse.ts +8 -8
- package/models/daily-schedule.ts +12 -6
- package/models/decrease-order-request.ts +6 -5
- package/models/decrease-order-response.ts +5 -5
- package/models/error-response-error.ts +0 -1
- package/models/error-response.ts +20 -8
- package/models/event-data.ts +70 -0
- package/models/event-position.ts +24 -24
- package/models/event.ts +0 -2
- package/models/exchange-status.ts +16 -6
- package/models/fill.ts +71 -12
- package/models/forecast-percentiles-point.ts +38 -0
- package/models/generate-api-key-request.ts +4 -4
- package/models/generate-api-key-response.ts +4 -4
- package/models/get-api-keys-response.ts +4 -4
- package/models/get-balance-response.ts +14 -6
- package/models/get-communications-idresponse.ts +6 -6
- package/models/get-event-candlesticks-response.ts +34 -0
- package/models/get-event-forecast-percentiles-history-response.ts +26 -0
- package/models/get-event-metadata-response.ts +34 -5
- package/models/get-event-response.ts +10 -7
- package/models/get-events-candlesticks-response-events-inner.ts +38 -0
- package/models/get-events-candlesticks-response.ts +26 -0
- package/models/get-events-response.ts +20 -7
- package/models/get-exchange-announcements-response.ts +8 -5
- package/models/get-exchange-schedule-response-schedule.ts +0 -1
- package/models/get-exchange-schedule-response.ts +6 -6
- package/models/get-fills-response.ts +6 -6
- package/models/get-filters-by-sports-response.ts +30 -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-response.ts +13 -6
- package/models/get-market-orderbook-response-orderbook.ts +0 -1
- package/models/get-market-orderbook-response.ts +6 -6
- package/models/get-market-response.ts +5 -5
- package/models/get-markets-response.ts +6 -6
- package/models/get-milestone-response.ts +5 -5
- package/models/get-milestones-response.ts +12 -5
- package/models/get-multivariate-event-collection-lookup-history-response.ts +26 -0
- package/models/get-multivariate-event-collection-response.ts +5 -5
- package/models/get-multivariate-event-collections-response.ts +12 -5
- package/models/get-multivariate-events-response.ts +30 -0
- package/models/get-order-group-response.ts +6 -6
- package/models/get-order-groups-response.ts +4 -5
- package/models/get-order-queue-position-response.ts +8 -5
- package/models/get-order-queue-positions-response.ts +26 -0
- package/models/get-order-response.ts +4 -4
- package/models/get-orders-response.ts +6 -6
- package/models/get-portfolio-resting-order-total-value-response.ts +23 -0
- package/models/get-positions-response.ts +16 -7
- package/models/get-queue-positions-request.ts +0 -1
- package/models/get-queue-positions-response.ts +0 -1
- package/models/get-quote-response.ts +5 -5
- package/models/get-quotes-response.ts +12 -5
- package/models/get-rfqresponse.ts +5 -5
- package/models/get-rfqs-response.ts +12 -5
- package/models/get-series-by-ticker-response.ts +0 -1
- 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 +5 -5
- package/models/get-settlements-response.ts +5 -5
- package/models/get-structured-target-response.ts +4 -4
- package/models/get-structured-targets-response.ts +8 -4
- package/models/get-tags-for-series-categories-response.ts +23 -0
- package/models/get-total-resting-order-value-response.ts +0 -1
- package/models/get-trades-response.ts +6 -6
- package/models/get-user-data-timestamp-response.ts +8 -5
- package/models/incentive-program.ts +63 -0
- package/models/index.ts +47 -17
- package/models/live-data.ts +31 -0
- package/models/lookup-bundle-request-bundle-inner.ts +0 -1
- package/models/lookup-bundle-request.ts +0 -1
- package/models/lookup-bundle-response.ts +0 -1
- 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.ts +40 -0
- package/models/market-candlesticks-response.ts +30 -0
- package/models/market-metadata.ts +31 -0
- package/models/market-position.ts +67 -0
- package/models/market.ts +226 -26
- package/models/milestone.ts +52 -7
- package/models/multivariate-event-collection-events-inner.ts +0 -1
- package/models/multivariate-event-collection.ts +61 -9
- package/models/mve-selected-leg.ts +31 -0
- package/models/order-group.ts +5 -5
- package/models/order-queue-position.ts +31 -0
- package/models/order-status.ts +30 -0
- package/models/order.ts +79 -30
- package/models/orderbook-level.ts +0 -1
- package/models/orderbook.ts +23 -0
- package/models/percentile-point.ts +35 -0
- package/models/position.ts +0 -2
- package/models/price-distribution.ts +83 -0
- package/models/price-range.ts +31 -0
- package/models/quote.ts +117 -17
- package/models/rfq.ts +67 -16
- 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 +62 -9
- package/models/settlement-source.ts +27 -0
- package/models/settlement.ts +49 -13
- package/models/sport-filter-details.ts +30 -0
- package/models/structured-target.ts +28 -7
- package/models/ticker-pair.ts +39 -0
- package/models/trade.ts +45 -11
- package/models/weekly-schedule.ts +58 -0
- package/package.json +1 -1
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# MarketCandlesticksResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**market_ticker** | **string** | Market ticker string (e.g., \'INXD-24JAN01\'). | [default to undefined]
|
|
9
|
+
**candlesticks** | [**Array<MarketCandlestick>**](MarketCandlestick.md) | Array of candlestick data points for the market. Includes an initial data point at the start timestamp when available. | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { MarketCandlesticksResponse } from 'kalshi-typescript';
|
|
15
|
+
|
|
16
|
+
const instance: MarketCandlesticksResponse = {
|
|
17
|
+
market_ticker,
|
|
18
|
+
candlesticks,
|
|
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,24 @@
|
|
|
1
|
+
# MarketMetadata
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**market_ticker** | **string** | The ticker of the market. | [default to undefined]
|
|
9
|
+
**image_url** | **string** | A path to an image that represents this market. | [default to undefined]
|
|
10
|
+
**color_code** | **string** | The color code for the market. | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { MarketMetadata } from 'kalshi-typescript';
|
|
16
|
+
|
|
17
|
+
const instance: MarketMetadata = {
|
|
18
|
+
market_ticker,
|
|
19
|
+
image_url,
|
|
20
|
+
color_code,
|
|
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,42 @@
|
|
|
1
|
+
# MarketPosition
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**ticker** | **string** | Unique identifier for the market | [default to undefined]
|
|
9
|
+
**total_traded** | **number** | Total spent on this market in cents | [default to undefined]
|
|
10
|
+
**total_traded_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [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]
|
|
12
|
+
**market_exposure** | **number** | Cost of the aggregate market position in cents | [default to undefined]
|
|
13
|
+
**market_exposure_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
|
|
14
|
+
**realized_pnl** | **number** | Locked in profit and loss, in cents | [default to undefined]
|
|
15
|
+
**realized_pnl_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
|
|
16
|
+
**resting_orders_count** | **number** | [DEPRECATED] Aggregate size of resting orders in contract units | [default to undefined]
|
|
17
|
+
**fees_paid** | **number** | Fees paid on fill orders, in cents | [default to undefined]
|
|
18
|
+
**fees_paid_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
|
|
19
|
+
**last_updated_ts** | **string** | Last time the position is updated | [optional] [default to undefined]
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import { MarketPosition } from 'kalshi-typescript';
|
|
25
|
+
|
|
26
|
+
const instance: MarketPosition = {
|
|
27
|
+
ticker,
|
|
28
|
+
total_traded,
|
|
29
|
+
total_traded_dollars,
|
|
30
|
+
position,
|
|
31
|
+
market_exposure,
|
|
32
|
+
market_exposure_dollars,
|
|
33
|
+
realized_pnl,
|
|
34
|
+
realized_pnl_dollars,
|
|
35
|
+
resting_orders_count,
|
|
36
|
+
fees_paid,
|
|
37
|
+
fees_paid_dollars,
|
|
38
|
+
last_updated_ts,
|
|
39
|
+
};
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
[[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/MarketsApi.md
CHANGED
|
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
|
|
|
13
13
|
# **getMarket**
|
|
14
14
|
> GetMarketResponse getMarket()
|
|
15
15
|
|
|
16
|
-
Get a single market by its ticker. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules.
|
|
16
|
+
Get a single market by its ticker. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules.
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
@@ -200,7 +200,7 @@ const { status, data } = await apiInstance.getMarketOrderbook(
|
|
|
200
200
|
# **getMarkets**
|
|
201
201
|
> GetMarketsResponse getMarkets()
|
|
202
202
|
|
|
203
|
-
List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. 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.
|
|
203
|
+
List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. 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.
|
|
204
204
|
|
|
205
205
|
### Example
|
|
206
206
|
|
|
@@ -278,7 +278,7 @@ const { status, data } = await apiInstance.getMarkets(
|
|
|
278
278
|
# **getTrades**
|
|
279
279
|
> GetTradesResponse getTrades()
|
|
280
280
|
|
|
281
|
-
Get 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.
|
|
281
|
+
Get 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.
|
|
282
282
|
|
|
283
283
|
### Example
|
|
284
284
|
|
|
@@ -342,4 +342,3 @@ No authorization required
|
|
|
342
342
|
|**500** | Internal server error | - |
|
|
343
343
|
|
|
344
344
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
345
|
-
|
package/docs/Milestone.md
CHANGED
|
@@ -5,9 +5,18 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**
|
|
9
|
-
**
|
|
10
|
-
**
|
|
8
|
+
**id** | **string** | Unique identifier for the milestone. | [default to undefined]
|
|
9
|
+
**category** | **string** | Category of the milestone. | [default to undefined]
|
|
10
|
+
**type** | **string** | Type of the milestone. | [default to undefined]
|
|
11
|
+
**start_date** | **string** | Start date of the milestone. | [default to undefined]
|
|
12
|
+
**end_date** | **string** | End date of the milestone, if any. | [optional] [default to undefined]
|
|
13
|
+
**related_event_tickers** | **Array<string>** | List of event tickers related to this milestone. | [default to undefined]
|
|
14
|
+
**title** | **string** | Title of the milestone. | [default to undefined]
|
|
15
|
+
**notification_message** | **string** | Notification message for the milestone. | [default to undefined]
|
|
16
|
+
**source_id** | **string** | Source id of milestone if available. | [optional] [default to undefined]
|
|
17
|
+
**details** | **{ [key: string]: any; }** | Additional details about the milestone. | [default to undefined]
|
|
18
|
+
**primary_event_tickers** | **Array<string>** | List of event tickers directly related to the outcome of this milestone. | [default to undefined]
|
|
19
|
+
**last_updated_ts** | **string** | Last time this structured target was updated. | [default to undefined]
|
|
11
20
|
|
|
12
21
|
## Example
|
|
13
22
|
|
|
@@ -15,9 +24,18 @@ Name | Type | Description | Notes
|
|
|
15
24
|
import { Milestone } from 'kalshi-typescript';
|
|
16
25
|
|
|
17
26
|
const instance: Milestone = {
|
|
18
|
-
|
|
27
|
+
id,
|
|
28
|
+
category,
|
|
29
|
+
type,
|
|
30
|
+
start_date,
|
|
31
|
+
end_date,
|
|
32
|
+
related_event_tickers,
|
|
19
33
|
title,
|
|
20
|
-
|
|
34
|
+
notification_message,
|
|
35
|
+
source_id,
|
|
36
|
+
details,
|
|
37
|
+
primary_event_tickers,
|
|
38
|
+
last_updated_ts,
|
|
21
39
|
};
|
|
22
40
|
```
|
|
23
41
|
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
# MilestoneApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getMilestone**](#getmilestone) | **GET** /milestones/{milestone_id} | Get Milestone|
|
|
8
|
+
|[**getMilestones**](#getmilestones) | **GET** /milestones | Get Milestones|
|
|
9
|
+
|
|
10
|
+
# **getMilestone**
|
|
11
|
+
> GetMilestoneResponse getMilestone()
|
|
12
|
+
|
|
13
|
+
Endpoint for getting data about a specific milestone by its ID.
|
|
14
|
+
|
|
15
|
+
### Parameters
|
|
16
|
+
|
|
17
|
+
|Name | Type | Description | Notes|
|
|
18
|
+
|------------- | ------------- | ------------- | -------------|
|
|
19
|
+
| **milestoneId** | [**string**] | Milestone ID | defaults to undefined|
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
### Return type
|
|
23
|
+
|
|
24
|
+
**GetMilestoneResponse**
|
|
25
|
+
|
|
26
|
+
### Authorization
|
|
27
|
+
|
|
28
|
+
No authorization required
|
|
29
|
+
|
|
30
|
+
### HTTP request headers
|
|
31
|
+
|
|
32
|
+
- **Content-Type**: Not defined
|
|
33
|
+
- **Accept**: application/json
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
### HTTP response details
|
|
37
|
+
| Status code | Description | Response headers |
|
|
38
|
+
|-------------|-------------|------------------|
|
|
39
|
+
|**200** | Milestone retrieved successfully | - |
|
|
40
|
+
|**400** | Bad Request | - |
|
|
41
|
+
|**401** | Unauthorized | - |
|
|
42
|
+
|**404** | Not Found | - |
|
|
43
|
+
|**500** | Internal Server Error | - |
|
|
44
|
+
|
|
45
|
+
# **getMilestones**
|
|
46
|
+
> GetMilestonesResponse getMilestones()
|
|
47
|
+
|
|
48
|
+
Minimum start date to filter milestones. Format: RFC3339 timestamp
|
|
49
|
+
|
|
50
|
+
### Parameters
|
|
51
|
+
|
|
52
|
+
|Name | Type | Description | Notes|
|
|
53
|
+
|------------- | ------------- | ------------- | -------------|
|
|
54
|
+
| **limit** | [**number**] | Number of milestones to return per page | defaults to undefined|
|
|
55
|
+
| **minimumStartDate** | [**string**] | Minimum start date to filter milestones. Format RFC3339 timestamp | (optional) defaults to undefined|
|
|
56
|
+
| **category** | [**string**] | Filter by milestone category | (optional) defaults to undefined|
|
|
57
|
+
| **competition** | [**string**] | Filter by competition | (optional) defaults to undefined|
|
|
58
|
+
| **sourceId** | [**string**] | Filter by source id | (optional) defaults to undefined|
|
|
59
|
+
| **type** | [**string**] | Filter by milestone type | (optional) defaults to undefined|
|
|
60
|
+
| **relatedEventTicker** | [**string**] | Filter by related event ticker | (optional) defaults to undefined|
|
|
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
|
+
|
|
63
|
+
|
|
64
|
+
### Return type
|
|
65
|
+
|
|
66
|
+
**GetMilestonesResponse**
|
|
67
|
+
|
|
68
|
+
### Authorization
|
|
69
|
+
|
|
70
|
+
No authorization required
|
|
71
|
+
|
|
72
|
+
### HTTP request headers
|
|
73
|
+
|
|
74
|
+
- **Content-Type**: Not defined
|
|
75
|
+
- **Accept**: application/json
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
### HTTP response details
|
|
79
|
+
| Status code | Description | Response headers |
|
|
80
|
+
|-------------|-------------|------------------|
|
|
81
|
+
|**200** | Milestones retrieved successfully | - |
|
|
82
|
+
|**400** | Bad Request | - |
|
|
83
|
+
|**401** | Unauthorized | - |
|
|
84
|
+
|**500** | Internal Server Error | - |
|
|
85
|
+
|
package/docs/MilestonesApi.md
CHANGED
|
@@ -122,4 +122,3 @@ const { status, data } = await apiInstance.getMilestones(
|
|
|
122
122
|
|**500** | Internal server error | - |
|
|
123
123
|
|
|
124
124
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
125
|
-
|
|
@@ -0,0 +1,188 @@
|
|
|
1
|
+
# MultivariateApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**createMarketInMultivariateEventCollection**](#createmarketinmultivariateeventcollection) | **POST** /multivariate_event_collections/{collection_ticker} | Create Market In Multivariate Event Collection|
|
|
8
|
+
|[**getMultivariateEventCollection**](#getmultivariateeventcollection) | **GET** /multivariate_event_collections/{collection_ticker} | Get Multivariate Event Collection|
|
|
9
|
+
|[**getMultivariateEventCollectionLookupHistory**](#getmultivariateeventcollectionlookuphistory) | **GET** /multivariate_event_collections/{collection_ticker}/lookup | Get Multivariate Event Collection Lookup History|
|
|
10
|
+
|[**getMultivariateEventCollections**](#getmultivariateeventcollections) | **GET** /multivariate_event_collections | Get Multivariate Event Collections|
|
|
11
|
+
|[**lookupTickersForMarketInMultivariateEventCollection**](#lookuptickersformarketinmultivariateeventcollection) | **PUT** /multivariate_event_collections/{collection_ticker}/lookup | Lookup Tickers For Market In Multivariate Event Collection|
|
|
12
|
+
|
|
13
|
+
# **createMarketInMultivariateEventCollection**
|
|
14
|
+
> CreateMarketInMultivariateEventCollectionResponse createMarketInMultivariateEventCollection(createMarketInMultivariateEventCollectionRequest)
|
|
15
|
+
|
|
16
|
+
Endpoint for looking up an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market.
|
|
17
|
+
|
|
18
|
+
### Parameters
|
|
19
|
+
|
|
20
|
+
|Name | Type | Description | Notes|
|
|
21
|
+
|------------- | ------------- | ------------- | -------------|
|
|
22
|
+
| **createMarketInMultivariateEventCollectionRequest** | **CreateMarketInMultivariateEventCollectionRequest**| | |
|
|
23
|
+
| **collectionTicker** | [**string**] | Collection ticker | defaults to undefined|
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
### Return type
|
|
27
|
+
|
|
28
|
+
**CreateMarketInMultivariateEventCollectionResponse**
|
|
29
|
+
|
|
30
|
+
### Authorization
|
|
31
|
+
|
|
32
|
+
[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
|
|
33
|
+
|
|
34
|
+
### HTTP request headers
|
|
35
|
+
|
|
36
|
+
- **Content-Type**: application/json
|
|
37
|
+
- **Accept**: application/json
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
### HTTP response details
|
|
41
|
+
| Status code | Description | Response headers |
|
|
42
|
+
|-------------|-------------|------------------|
|
|
43
|
+
|**200** | Market created successfully | - |
|
|
44
|
+
|**400** | Bad request - invalid input | - |
|
|
45
|
+
|**401** | Unauthorized - authentication required | - |
|
|
46
|
+
|**500** | Internal server error | - |
|
|
47
|
+
|
|
48
|
+
# **getMultivariateEventCollection**
|
|
49
|
+
> GetMultivariateEventCollectionResponse getMultivariateEventCollection()
|
|
50
|
+
|
|
51
|
+
Endpoint for getting data about a multivariate event collection by its ticker.
|
|
52
|
+
|
|
53
|
+
### Parameters
|
|
54
|
+
|
|
55
|
+
|Name | Type | Description | Notes|
|
|
56
|
+
|------------- | ------------- | ------------- | -------------|
|
|
57
|
+
| **collectionTicker** | [**string**] | Collection ticker | defaults to undefined|
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
### Return type
|
|
61
|
+
|
|
62
|
+
**GetMultivariateEventCollectionResponse**
|
|
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** | Collection retrieved successfully | - |
|
|
78
|
+
|**400** | Bad request - invalid input | - |
|
|
79
|
+
|**404** | Resource not found | - |
|
|
80
|
+
|**500** | Internal server error | - |
|
|
81
|
+
|
|
82
|
+
# **getMultivariateEventCollectionLookupHistory**
|
|
83
|
+
> GetMultivariateEventCollectionLookupHistoryResponse getMultivariateEventCollectionLookupHistory()
|
|
84
|
+
|
|
85
|
+
Endpoint for retrieving which markets in an event collection were recently looked up.
|
|
86
|
+
|
|
87
|
+
### Parameters
|
|
88
|
+
|
|
89
|
+
|Name | Type | Description | Notes|
|
|
90
|
+
|------------- | ------------- | ------------- | -------------|
|
|
91
|
+
| **collectionTicker** | [**string**] | Collection ticker | defaults to undefined|
|
|
92
|
+
| **lookbackSeconds** | [**10 | 60 | 300 | 3600**]**Array<10 | 60 | 300 | 3600>** | Number of seconds to look back for lookup history. Must be one of 10, 60, 300, or 3600. | defaults to undefined|
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
### Return type
|
|
96
|
+
|
|
97
|
+
**GetMultivariateEventCollectionLookupHistoryResponse**
|
|
98
|
+
|
|
99
|
+
### Authorization
|
|
100
|
+
|
|
101
|
+
No authorization required
|
|
102
|
+
|
|
103
|
+
### HTTP request headers
|
|
104
|
+
|
|
105
|
+
- **Content-Type**: Not defined
|
|
106
|
+
- **Accept**: application/json
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
### HTTP response details
|
|
110
|
+
| Status code | Description | Response headers |
|
|
111
|
+
|-------------|-------------|------------------|
|
|
112
|
+
|**200** | Lookup history retrieved successfully | - |
|
|
113
|
+
|**400** | Bad request - invalid input | - |
|
|
114
|
+
|**500** | Internal server error | - |
|
|
115
|
+
|
|
116
|
+
# **getMultivariateEventCollections**
|
|
117
|
+
> GetMultivariateEventCollectionsResponse getMultivariateEventCollections()
|
|
118
|
+
|
|
119
|
+
Endpoint for getting data about multivariate event collections.
|
|
120
|
+
|
|
121
|
+
### Parameters
|
|
122
|
+
|
|
123
|
+
|Name | Type | Description | Notes|
|
|
124
|
+
|------------- | ------------- | ------------- | -------------|
|
|
125
|
+
| **status** | [**'unopened' | 'open' | 'closed'**]**Array<'unopened' | 'open' | 'closed'>** | Only return collections of a certain status. Can be unopened, open, or closed. | (optional) defaults to undefined|
|
|
126
|
+
| **associatedEventTicker** | [**string**] | Only return collections associated with a particular event ticker. | (optional) defaults to undefined|
|
|
127
|
+
| **seriesTicker** | [**string**] | Only return collections with a particular series ticker. | (optional) defaults to undefined|
|
|
128
|
+
| **limit** | [**number**] | Specify the maximum number of results. | (optional) defaults to undefined|
|
|
129
|
+
| **cursor** | [**string**] | The Cursor represents a pointer to the next page of records in the pagination. This optional parameter, when filled, should be filled with the cursor string returned in a previous request to this end-point. | (optional) defaults to undefined|
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
### Return type
|
|
133
|
+
|
|
134
|
+
**GetMultivariateEventCollectionsResponse**
|
|
135
|
+
|
|
136
|
+
### Authorization
|
|
137
|
+
|
|
138
|
+
No authorization required
|
|
139
|
+
|
|
140
|
+
### HTTP request headers
|
|
141
|
+
|
|
142
|
+
- **Content-Type**: Not defined
|
|
143
|
+
- **Accept**: application/json
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
### HTTP response details
|
|
147
|
+
| Status code | Description | Response headers |
|
|
148
|
+
|-------------|-------------|------------------|
|
|
149
|
+
|**200** | Collections retrieved successfully | - |
|
|
150
|
+
|**400** | Bad request - invalid input | - |
|
|
151
|
+
|**500** | Internal server error | - |
|
|
152
|
+
|
|
153
|
+
# **lookupTickersForMarketInMultivariateEventCollection**
|
|
154
|
+
> LookupTickersForMarketInMultivariateEventCollectionResponse lookupTickersForMarketInMultivariateEventCollection(lookupTickersForMarketInMultivariateEventCollectionRequest)
|
|
155
|
+
|
|
156
|
+
Endpoint for looking up an individual market in a multivariate event collection. If CreateMarketInMultivariateEventCollection has never been hit with that variable combination before, this will return a 404.
|
|
157
|
+
|
|
158
|
+
### Parameters
|
|
159
|
+
|
|
160
|
+
|Name | Type | Description | Notes|
|
|
161
|
+
|------------- | ------------- | ------------- | -------------|
|
|
162
|
+
| **lookupTickersForMarketInMultivariateEventCollectionRequest** | **LookupTickersForMarketInMultivariateEventCollectionRequest**| | |
|
|
163
|
+
| **collectionTicker** | [**string**] | Collection ticker | defaults to undefined|
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
### Return type
|
|
167
|
+
|
|
168
|
+
**LookupTickersForMarketInMultivariateEventCollectionResponse**
|
|
169
|
+
|
|
170
|
+
### Authorization
|
|
171
|
+
|
|
172
|
+
[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
|
|
173
|
+
|
|
174
|
+
### HTTP request headers
|
|
175
|
+
|
|
176
|
+
- **Content-Type**: application/json
|
|
177
|
+
- **Accept**: application/json
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
### HTTP response details
|
|
181
|
+
| Status code | Description | Response headers |
|
|
182
|
+
|-------------|-------------|------------------|
|
|
183
|
+
|**200** | Market looked up successfully | - |
|
|
184
|
+
|**400** | Bad request - invalid input | - |
|
|
185
|
+
|**401** | Unauthorized - authentication required | - |
|
|
186
|
+
|**404** | Resource not found | - |
|
|
187
|
+
|**500** | Internal server error | - |
|
|
188
|
+
|
|
@@ -182,4 +182,3 @@ const { status, data } = await apiInstance.lookupMultivariateEventCollectionBund
|
|
|
182
182
|
|**500** | Internal server error | - |
|
|
183
183
|
|
|
184
184
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
185
|
-
|
|
@@ -5,10 +5,20 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**collection_ticker** | **string** |
|
|
9
|
-
**
|
|
10
|
-
**
|
|
11
|
-
**
|
|
8
|
+
**collection_ticker** | **string** | Unique identifier for the collection. | [default to undefined]
|
|
9
|
+
**series_ticker** | **string** | Series associated with the collection. Events produced in the collection will be associated with this series. | [default to undefined]
|
|
10
|
+
**title** | **string** | Title of the collection. | [default to undefined]
|
|
11
|
+
**description** | **string** | Short description of the collection. | [default to undefined]
|
|
12
|
+
**open_date** | **string** | The open date of the collection. Before this time, the collection cannot be interacted with. | [default to undefined]
|
|
13
|
+
**close_date** | **string** | The close date of the collection. After this time, the collection cannot be interacted with. | [default to undefined]
|
|
14
|
+
**associated_events** | [**Array<AssociatedEvent>**](AssociatedEvent.md) | List of events with their individual configuration. | [default to undefined]
|
|
15
|
+
**associated_event_tickers** | **Array<string>** | [DEPRECATED - Use associated_events instead] A list of events associated with the collection. Markets in these events can be passed as inputs to the Lookup and Create endpoints. | [default to undefined]
|
|
16
|
+
**is_ordered** | **boolean** | Whether the collection is ordered. If true, the order of markets passed into Lookup/Create affects the output. If false, the order does not matter. | [default to undefined]
|
|
17
|
+
**is_single_market_per_event** | **boolean** | [DEPRECATED - Use associated_events instead] Whether the collection accepts multiple markets from the same event passed into Lookup/Create. | [default to undefined]
|
|
18
|
+
**is_all_yes** | **boolean** | [DEPRECATED - Use associated_events instead] Whether the collection requires that only the market side of \'yes\' may be used. | [default to undefined]
|
|
19
|
+
**size_min** | **number** | The minimum number of markets that must be passed into Lookup/Create (inclusive). | [default to undefined]
|
|
20
|
+
**size_max** | **number** | The maximum number of markets that must be passed into Lookup/Create (inclusive). | [default to undefined]
|
|
21
|
+
**functional_description** | **string** | A functional description of the collection describing how inputs affect the output. | [default to undefined]
|
|
12
22
|
|
|
13
23
|
## Example
|
|
14
24
|
|
|
@@ -17,9 +27,19 @@ import { MultivariateEventCollection } from 'kalshi-typescript';
|
|
|
17
27
|
|
|
18
28
|
const instance: MultivariateEventCollection = {
|
|
19
29
|
collection_ticker,
|
|
30
|
+
series_ticker,
|
|
20
31
|
title,
|
|
21
|
-
|
|
22
|
-
|
|
32
|
+
description,
|
|
33
|
+
open_date,
|
|
34
|
+
close_date,
|
|
35
|
+
associated_events,
|
|
36
|
+
associated_event_tickers,
|
|
37
|
+
is_ordered,
|
|
38
|
+
is_single_market_per_event,
|
|
39
|
+
is_all_yes,
|
|
40
|
+
size_min,
|
|
41
|
+
size_max,
|
|
42
|
+
functional_description,
|
|
23
43
|
};
|
|
24
44
|
```
|
|
25
45
|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# MveSelectedLeg
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**event_ticker** | **string** | Unique identifier for the selected event | [optional] [default to undefined]
|
|
9
|
+
**market_ticker** | **string** | Unique identifier for the selected market | [optional] [default to undefined]
|
|
10
|
+
**side** | **string** | The side of the selected market | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { MveSelectedLeg } from 'kalshi-typescript';
|
|
16
|
+
|
|
17
|
+
const instance: MveSelectedLeg = {
|
|
18
|
+
event_ticker,
|
|
19
|
+
market_ticker,
|
|
20
|
+
side,
|
|
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)
|
package/docs/Order.md
CHANGED
|
@@ -5,24 +5,36 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**order_id** | **string** | | [
|
|
9
|
-
**
|
|
10
|
-
**
|
|
11
|
-
**
|
|
12
|
-
**
|
|
13
|
-
**
|
|
14
|
-
**
|
|
15
|
-
**
|
|
16
|
-
**
|
|
17
|
-
**
|
|
18
|
-
**
|
|
19
|
-
**
|
|
20
|
-
**
|
|
21
|
-
**
|
|
22
|
-
**
|
|
8
|
+
**order_id** | **string** | | [default to undefined]
|
|
9
|
+
**user_id** | **string** | Unique identifier for users | [default to undefined]
|
|
10
|
+
**client_order_id** | **string** | | [default to undefined]
|
|
11
|
+
**ticker** | **string** | | [default to undefined]
|
|
12
|
+
**side** | **string** | | [default to undefined]
|
|
13
|
+
**action** | **string** | | [default to undefined]
|
|
14
|
+
**type** | **string** | | [default to undefined]
|
|
15
|
+
**status** | [**OrderStatus**](OrderStatus.md) | | [default to undefined]
|
|
16
|
+
**yes_price** | **number** | | [default to undefined]
|
|
17
|
+
**no_price** | **number** | | [default to undefined]
|
|
18
|
+
**yes_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
|
|
19
|
+
**no_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
|
|
20
|
+
**fill_count** | **number** | The number of contracts that have been filled | [default to undefined]
|
|
21
|
+
**remaining_count** | **number** | | [default to undefined]
|
|
22
|
+
**initial_count** | **number** | The initial size of the order (contract units) | [default to undefined]
|
|
23
|
+
**taker_fees** | **number** | Fees paid on filled taker contracts, in cents | [default to undefined]
|
|
24
|
+
**maker_fees** | **number** | Fees paid on filled maker contracts, in cents | [default to undefined]
|
|
25
|
+
**taker_fill_cost** | **number** | The cost of filled taker orders in cents | [default to undefined]
|
|
26
|
+
**maker_fill_cost** | **number** | The cost of filled maker orders in cents | [default to undefined]
|
|
27
|
+
**taker_fill_cost_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
|
|
28
|
+
**maker_fill_cost_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
|
|
29
|
+
**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]
|
|
30
|
+
**taker_fees_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
|
|
31
|
+
**maker_fees_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
|
|
23
32
|
**expiration_time** | **string** | | [optional] [default to undefined]
|
|
24
33
|
**created_time** | **string** | | [optional] [default to undefined]
|
|
25
|
-
**
|
|
34
|
+
**last_update_time** | **string** | The last update to an order (modify, cancel, fill) | [optional] [default to undefined]
|
|
35
|
+
**self_trade_prevention_type** | [**SelfTradePreventionType**](SelfTradePreventionType.md) | | [optional] [default to undefined]
|
|
36
|
+
**order_group_id** | **string** | The order group this order is part of | [optional] [default to undefined]
|
|
37
|
+
**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]
|
|
26
38
|
|
|
27
39
|
## Example
|
|
28
40
|
|
|
@@ -31,6 +43,7 @@ import { Order } from 'kalshi-typescript';
|
|
|
31
43
|
|
|
32
44
|
const instance: Order = {
|
|
33
45
|
order_id,
|
|
46
|
+
user_id,
|
|
34
47
|
client_order_id,
|
|
35
48
|
ticker,
|
|
36
49
|
side,
|
|
@@ -39,15 +52,26 @@ const instance: Order = {
|
|
|
39
52
|
status,
|
|
40
53
|
yes_price,
|
|
41
54
|
no_price,
|
|
42
|
-
|
|
55
|
+
yes_price_dollars,
|
|
56
|
+
no_price_dollars,
|
|
43
57
|
fill_count,
|
|
44
58
|
remaining_count,
|
|
45
59
|
initial_count,
|
|
46
60
|
taker_fees,
|
|
47
61
|
maker_fees,
|
|
62
|
+
taker_fill_cost,
|
|
63
|
+
maker_fill_cost,
|
|
64
|
+
taker_fill_cost_dollars,
|
|
65
|
+
maker_fill_cost_dollars,
|
|
66
|
+
queue_position,
|
|
67
|
+
taker_fees_dollars,
|
|
68
|
+
maker_fees_dollars,
|
|
48
69
|
expiration_time,
|
|
49
70
|
created_time,
|
|
50
|
-
|
|
71
|
+
last_update_time,
|
|
72
|
+
self_trade_prevention_type,
|
|
73
|
+
order_group_id,
|
|
74
|
+
cancel_order_on_pause,
|
|
51
75
|
};
|
|
52
76
|
```
|
|
53
77
|
|
package/docs/OrderGroup.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**id** | **string** | Unique identifier for the order group | [default to undefined]
|
|
9
|
-
**is_auto_cancel_enabled** | **boolean** | Whether auto-cancel is enabled for this order group | [
|
|
9
|
+
**is_auto_cancel_enabled** | **boolean** | Whether auto-cancel is enabled for this order group | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|