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
|
@@ -19,31 +19,7 @@ All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
|
|
|
19
19
|
# **acceptQuote**
|
|
20
20
|
> acceptQuote(acceptQuoteRequest)
|
|
21
21
|
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
### Example
|
|
25
|
-
|
|
26
|
-
```typescript
|
|
27
|
-
import {
|
|
28
|
-
CommunicationsApi,
|
|
29
|
-
Configuration,
|
|
30
|
-
AcceptQuoteRequest
|
|
31
|
-
} from 'kalshi-typescript';
|
|
32
|
-
|
|
33
|
-
const configuration = new Configuration({
|
|
34
|
-
apiKey: 'your-api-key-id',
|
|
35
|
-
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
36
|
-
});
|
|
37
|
-
const apiInstance = new CommunicationsApi(configuration);
|
|
38
|
-
|
|
39
|
-
let quoteId: string; //Quote ID (default to undefined)
|
|
40
|
-
let acceptQuoteRequest: AcceptQuoteRequest; //
|
|
41
|
-
|
|
42
|
-
const { status, data } = await apiInstance.acceptQuote(
|
|
43
|
-
quoteId,
|
|
44
|
-
acceptQuoteRequest
|
|
45
|
-
);
|
|
46
|
-
```
|
|
22
|
+
Endpoint for accepting a quote. This will require the quoter to confirm
|
|
47
23
|
|
|
48
24
|
### Parameters
|
|
49
25
|
|
|
@@ -59,7 +35,7 @@ void (empty response body)
|
|
|
59
35
|
|
|
60
36
|
### Authorization
|
|
61
37
|
|
|
62
|
-
[
|
|
38
|
+
[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
|
|
63
39
|
|
|
64
40
|
### HTTP request headers
|
|
65
41
|
|
|
@@ -76,38 +52,16 @@ void (empty response body)
|
|
|
76
52
|
|**404** | Resource not found | - |
|
|
77
53
|
|**500** | Internal server error | - |
|
|
78
54
|
|
|
79
|
-
[[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)
|
|
80
|
-
|
|
81
55
|
# **confirmQuote**
|
|
82
56
|
> confirmQuote()
|
|
83
57
|
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
### Example
|
|
87
|
-
|
|
88
|
-
```typescript
|
|
89
|
-
import {
|
|
90
|
-
CommunicationsApi,
|
|
91
|
-
Configuration
|
|
92
|
-
} from 'kalshi-typescript';
|
|
93
|
-
|
|
94
|
-
const configuration = new Configuration({
|
|
95
|
-
apiKey: 'your-api-key-id',
|
|
96
|
-
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
97
|
-
});
|
|
98
|
-
const apiInstance = new CommunicationsApi(configuration);
|
|
99
|
-
|
|
100
|
-
let quoteId: string; //Quote ID (default to undefined)
|
|
101
|
-
|
|
102
|
-
const { status, data } = await apiInstance.confirmQuote(
|
|
103
|
-
quoteId
|
|
104
|
-
);
|
|
105
|
-
```
|
|
58
|
+
Endpoint for confirming a quote. This will start a timer for order execution
|
|
106
59
|
|
|
107
60
|
### Parameters
|
|
108
61
|
|
|
109
62
|
|Name | Type | Description | Notes|
|
|
110
63
|
|------------- | ------------- | ------------- | -------------|
|
|
64
|
+
| **body** | **object**| | |
|
|
111
65
|
| **quoteId** | [**string**] | Quote ID | defaults to undefined|
|
|
112
66
|
|
|
113
67
|
|
|
@@ -117,11 +71,11 @@ void (empty response body)
|
|
|
117
71
|
|
|
118
72
|
### Authorization
|
|
119
73
|
|
|
120
|
-
[
|
|
74
|
+
[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
|
|
121
75
|
|
|
122
76
|
### HTTP request headers
|
|
123
77
|
|
|
124
|
-
- **Content-Type**:
|
|
78
|
+
- **Content-Type**: application/json
|
|
125
79
|
- **Accept**: application/json
|
|
126
80
|
|
|
127
81
|
|
|
@@ -133,34 +87,10 @@ void (empty response body)
|
|
|
133
87
|
|**404** | Resource not found | - |
|
|
134
88
|
|**500** | Internal server error | - |
|
|
135
89
|
|
|
136
|
-
[[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)
|
|
137
|
-
|
|
138
90
|
# **createQuote**
|
|
139
91
|
> CreateQuoteResponse createQuote(createQuoteRequest)
|
|
140
92
|
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
### Example
|
|
144
|
-
|
|
145
|
-
```typescript
|
|
146
|
-
import {
|
|
147
|
-
CommunicationsApi,
|
|
148
|
-
Configuration,
|
|
149
|
-
CreateQuoteRequest
|
|
150
|
-
} from 'kalshi-typescript';
|
|
151
|
-
|
|
152
|
-
const configuration = new Configuration({
|
|
153
|
-
apiKey: 'your-api-key-id',
|
|
154
|
-
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
155
|
-
});
|
|
156
|
-
const apiInstance = new CommunicationsApi(configuration);
|
|
157
|
-
|
|
158
|
-
let createQuoteRequest: CreateQuoteRequest; //
|
|
159
|
-
|
|
160
|
-
const { status, data } = await apiInstance.createQuote(
|
|
161
|
-
createQuoteRequest
|
|
162
|
-
);
|
|
163
|
-
```
|
|
93
|
+
Endpoint for creating a quote in response to an RFQ
|
|
164
94
|
|
|
165
95
|
### Parameters
|
|
166
96
|
|
|
@@ -175,7 +105,7 @@ const { status, data } = await apiInstance.createQuote(
|
|
|
175
105
|
|
|
176
106
|
### Authorization
|
|
177
107
|
|
|
178
|
-
[
|
|
108
|
+
[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
|
|
179
109
|
|
|
180
110
|
### HTTP request headers
|
|
181
111
|
|
|
@@ -191,34 +121,10 @@ const { status, data } = await apiInstance.createQuote(
|
|
|
191
121
|
|**401** | Unauthorized - authentication required | - |
|
|
192
122
|
|**500** | Internal server error | - |
|
|
193
123
|
|
|
194
|
-
[[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)
|
|
195
|
-
|
|
196
124
|
# **createRFQ**
|
|
197
125
|
> CreateRFQResponse createRFQ(createRFQRequest)
|
|
198
126
|
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
### Example
|
|
202
|
-
|
|
203
|
-
```typescript
|
|
204
|
-
import {
|
|
205
|
-
CommunicationsApi,
|
|
206
|
-
Configuration,
|
|
207
|
-
CreateRFQRequest
|
|
208
|
-
} from 'kalshi-typescript';
|
|
209
|
-
|
|
210
|
-
const configuration = new Configuration({
|
|
211
|
-
apiKey: 'your-api-key-id',
|
|
212
|
-
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
213
|
-
});
|
|
214
|
-
const apiInstance = new CommunicationsApi(configuration);
|
|
215
|
-
|
|
216
|
-
let createRFQRequest: CreateRFQRequest; //
|
|
217
|
-
|
|
218
|
-
const { status, data } = await apiInstance.createRFQ(
|
|
219
|
-
createRFQRequest
|
|
220
|
-
);
|
|
221
|
-
```
|
|
127
|
+
Endpoint for creating a new RFQ. You can have a maximum of 100 open RFQs at a time.
|
|
222
128
|
|
|
223
129
|
### Parameters
|
|
224
130
|
|
|
@@ -233,7 +139,7 @@ const { status, data } = await apiInstance.createRFQ(
|
|
|
233
139
|
|
|
234
140
|
### Authorization
|
|
235
141
|
|
|
236
|
-
[
|
|
142
|
+
[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
|
|
237
143
|
|
|
238
144
|
### HTTP request headers
|
|
239
145
|
|
|
@@ -247,35 +153,13 @@ const { status, data } = await apiInstance.createRFQ(
|
|
|
247
153
|
|**201** | RFQ created successfully | - |
|
|
248
154
|
|**400** | Bad request - invalid input | - |
|
|
249
155
|
|**401** | Unauthorized - authentication required | - |
|
|
156
|
+
|**409** | Conflict - resource already exists or cannot be modified | - |
|
|
250
157
|
|**500** | Internal server error | - |
|
|
251
158
|
|
|
252
|
-
[[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)
|
|
253
|
-
|
|
254
159
|
# **deleteQuote**
|
|
255
160
|
> deleteQuote()
|
|
256
161
|
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
### Example
|
|
260
|
-
|
|
261
|
-
```typescript
|
|
262
|
-
import {
|
|
263
|
-
CommunicationsApi,
|
|
264
|
-
Configuration
|
|
265
|
-
} from 'kalshi-typescript';
|
|
266
|
-
|
|
267
|
-
const configuration = new Configuration({
|
|
268
|
-
apiKey: 'your-api-key-id',
|
|
269
|
-
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
270
|
-
});
|
|
271
|
-
const apiInstance = new CommunicationsApi(configuration);
|
|
272
|
-
|
|
273
|
-
let quoteId: string; //Quote ID (default to undefined)
|
|
274
|
-
|
|
275
|
-
const { status, data } = await apiInstance.deleteQuote(
|
|
276
|
-
quoteId
|
|
277
|
-
);
|
|
278
|
-
```
|
|
162
|
+
Endpoint for deleting a quote, which means it can no longer be accepted.
|
|
279
163
|
|
|
280
164
|
### Parameters
|
|
281
165
|
|
|
@@ -290,7 +174,7 @@ void (empty response body)
|
|
|
290
174
|
|
|
291
175
|
### Authorization
|
|
292
176
|
|
|
293
|
-
[
|
|
177
|
+
[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
|
|
294
178
|
|
|
295
179
|
### HTTP request headers
|
|
296
180
|
|
|
@@ -306,33 +190,10 @@ void (empty response body)
|
|
|
306
190
|
|**404** | Resource not found | - |
|
|
307
191
|
|**500** | Internal server error | - |
|
|
308
192
|
|
|
309
|
-
[[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)
|
|
310
|
-
|
|
311
193
|
# **deleteRFQ**
|
|
312
194
|
> deleteRFQ()
|
|
313
195
|
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
### Example
|
|
317
|
-
|
|
318
|
-
```typescript
|
|
319
|
-
import {
|
|
320
|
-
CommunicationsApi,
|
|
321
|
-
Configuration
|
|
322
|
-
} from 'kalshi-typescript';
|
|
323
|
-
|
|
324
|
-
const configuration = new Configuration({
|
|
325
|
-
apiKey: 'your-api-key-id',
|
|
326
|
-
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
327
|
-
});
|
|
328
|
-
const apiInstance = new CommunicationsApi(configuration);
|
|
329
|
-
|
|
330
|
-
let rfqId: string; //RFQ ID (default to undefined)
|
|
331
|
-
|
|
332
|
-
const { status, data } = await apiInstance.deleteRFQ(
|
|
333
|
-
rfqId
|
|
334
|
-
);
|
|
335
|
-
```
|
|
196
|
+
Endpoint for deleting an RFQ by ID
|
|
336
197
|
|
|
337
198
|
### Parameters
|
|
338
199
|
|
|
@@ -347,7 +208,7 @@ void (empty response body)
|
|
|
347
208
|
|
|
348
209
|
### Authorization
|
|
349
210
|
|
|
350
|
-
[
|
|
211
|
+
[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
|
|
351
212
|
|
|
352
213
|
### HTTP request headers
|
|
353
214
|
|
|
@@ -363,29 +224,10 @@ void (empty response body)
|
|
|
363
224
|
|**404** | Resource not found | - |
|
|
364
225
|
|**500** | Internal server error | - |
|
|
365
226
|
|
|
366
|
-
[[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)
|
|
367
|
-
|
|
368
227
|
# **getCommunicationsID**
|
|
369
228
|
> GetCommunicationsIDResponse getCommunicationsID()
|
|
370
229
|
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
### Example
|
|
374
|
-
|
|
375
|
-
```typescript
|
|
376
|
-
import {
|
|
377
|
-
CommunicationsApi,
|
|
378
|
-
Configuration
|
|
379
|
-
} from 'kalshi-typescript';
|
|
380
|
-
|
|
381
|
-
const configuration = new Configuration({
|
|
382
|
-
apiKey: 'your-api-key-id',
|
|
383
|
-
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
384
|
-
});
|
|
385
|
-
const apiInstance = new CommunicationsApi(configuration);
|
|
386
|
-
|
|
387
|
-
const { status, data } = await apiInstance.getCommunicationsID();
|
|
388
|
-
```
|
|
230
|
+
Endpoint for getting the communications ID of the logged-in user.
|
|
389
231
|
|
|
390
232
|
### Parameters
|
|
391
233
|
This endpoint does not have any parameters.
|
|
@@ -397,7 +239,7 @@ This endpoint does not have any parameters.
|
|
|
397
239
|
|
|
398
240
|
### Authorization
|
|
399
241
|
|
|
400
|
-
[
|
|
242
|
+
[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
|
|
401
243
|
|
|
402
244
|
### HTTP request headers
|
|
403
245
|
|
|
@@ -412,33 +254,10 @@ This endpoint does not have any parameters.
|
|
|
412
254
|
|**401** | Unauthorized - authentication required | - |
|
|
413
255
|
|**500** | Internal server error | - |
|
|
414
256
|
|
|
415
|
-
[[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)
|
|
416
|
-
|
|
417
257
|
# **getQuote**
|
|
418
258
|
> GetQuoteResponse getQuote()
|
|
419
259
|
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
### Example
|
|
423
|
-
|
|
424
|
-
```typescript
|
|
425
|
-
import {
|
|
426
|
-
CommunicationsApi,
|
|
427
|
-
Configuration
|
|
428
|
-
} from 'kalshi-typescript';
|
|
429
|
-
|
|
430
|
-
const configuration = new Configuration({
|
|
431
|
-
apiKey: 'your-api-key-id',
|
|
432
|
-
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
433
|
-
});
|
|
434
|
-
const apiInstance = new CommunicationsApi(configuration);
|
|
435
|
-
|
|
436
|
-
let quoteId: string; //Quote ID (default to undefined)
|
|
437
|
-
|
|
438
|
-
const { status, data } = await apiInstance.getQuote(
|
|
439
|
-
quoteId
|
|
440
|
-
);
|
|
441
|
-
```
|
|
260
|
+
Endpoint for getting a particular quote
|
|
442
261
|
|
|
443
262
|
### Parameters
|
|
444
263
|
|
|
@@ -453,7 +272,7 @@ const { status, data } = await apiInstance.getQuote(
|
|
|
453
272
|
|
|
454
273
|
### Authorization
|
|
455
274
|
|
|
456
|
-
[
|
|
275
|
+
[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
|
|
457
276
|
|
|
458
277
|
### HTTP request headers
|
|
459
278
|
|
|
@@ -469,32 +288,24 @@ const { status, data } = await apiInstance.getQuote(
|
|
|
469
288
|
|**404** | Resource not found | - |
|
|
470
289
|
|**500** | Internal server error | - |
|
|
471
290
|
|
|
472
|
-
[[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)
|
|
473
|
-
|
|
474
291
|
# **getQuotes**
|
|
475
292
|
> GetQuotesResponse getQuotes()
|
|
476
293
|
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
### Example
|
|
480
|
-
|
|
481
|
-
```typescript
|
|
482
|
-
import {
|
|
483
|
-
CommunicationsApi,
|
|
484
|
-
Configuration
|
|
485
|
-
} from 'kalshi-typescript';
|
|
486
|
-
|
|
487
|
-
const configuration = new Configuration({
|
|
488
|
-
apiKey: 'your-api-key-id',
|
|
489
|
-
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
490
|
-
});
|
|
491
|
-
const apiInstance = new CommunicationsApi(configuration);
|
|
492
|
-
|
|
493
|
-
const { status, data } = await apiInstance.getQuotes();
|
|
494
|
-
```
|
|
294
|
+
Endpoint for getting quotes
|
|
495
295
|
|
|
496
296
|
### Parameters
|
|
497
|
-
|
|
297
|
+
|
|
298
|
+
|Name | Type | Description | Notes|
|
|
299
|
+
|------------- | ------------- | ------------- | -------------|
|
|
300
|
+
| **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|
|
|
301
|
+
| **eventTicker** | [**string**] | Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10). | (optional) defaults to undefined|
|
|
302
|
+
| **marketTicker** | [**string**] | Filter by market ticker | (optional) defaults to undefined|
|
|
303
|
+
| **limit** | [**number**] | Parameter to specify the number of results per page. Defaults to 500. | (optional) defaults to 500|
|
|
304
|
+
| **status** | [**string**] | Filter quotes by status | (optional) defaults to undefined|
|
|
305
|
+
| **quoteCreatorUserId** | [**string**] | Filter quotes by quote creator user ID | (optional) defaults to undefined|
|
|
306
|
+
| **rfqCreatorUserId** | [**string**] | Filter quotes by RFQ creator user ID | (optional) defaults to undefined|
|
|
307
|
+
| **rfqCreatorSubtraderId** | [**string**] | Filter quotes by RFQ creator subtrader ID (FCM members only) | (optional) defaults to undefined|
|
|
308
|
+
| **rfqId** | [**string**] | Filter quotes by RFQ ID | (optional) defaults to undefined|
|
|
498
309
|
|
|
499
310
|
|
|
500
311
|
### Return type
|
|
@@ -503,7 +314,7 @@ This endpoint does not have any parameters.
|
|
|
503
314
|
|
|
504
315
|
### Authorization
|
|
505
316
|
|
|
506
|
-
[
|
|
317
|
+
[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
|
|
507
318
|
|
|
508
319
|
### HTTP request headers
|
|
509
320
|
|
|
@@ -518,33 +329,10 @@ This endpoint does not have any parameters.
|
|
|
518
329
|
|**401** | Unauthorized - authentication required | - |
|
|
519
330
|
|**500** | Internal server error | - |
|
|
520
331
|
|
|
521
|
-
[[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)
|
|
522
|
-
|
|
523
332
|
# **getRFQ**
|
|
524
333
|
> GetRFQResponse getRFQ()
|
|
525
334
|
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
### Example
|
|
529
|
-
|
|
530
|
-
```typescript
|
|
531
|
-
import {
|
|
532
|
-
CommunicationsApi,
|
|
533
|
-
Configuration
|
|
534
|
-
} from 'kalshi-typescript';
|
|
535
|
-
|
|
536
|
-
const configuration = new Configuration({
|
|
537
|
-
apiKey: 'your-api-key-id',
|
|
538
|
-
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
539
|
-
});
|
|
540
|
-
const apiInstance = new CommunicationsApi(configuration);
|
|
541
|
-
|
|
542
|
-
let rfqId: string; //RFQ ID (default to undefined)
|
|
543
|
-
|
|
544
|
-
const { status, data } = await apiInstance.getRFQ(
|
|
545
|
-
rfqId
|
|
546
|
-
);
|
|
547
|
-
```
|
|
335
|
+
Endpoint for getting a single RFQ by id
|
|
548
336
|
|
|
549
337
|
### Parameters
|
|
550
338
|
|
|
@@ -559,7 +347,7 @@ const { status, data } = await apiInstance.getRFQ(
|
|
|
559
347
|
|
|
560
348
|
### Authorization
|
|
561
349
|
|
|
562
|
-
[
|
|
350
|
+
[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
|
|
563
351
|
|
|
564
352
|
### HTTP request headers
|
|
565
353
|
|
|
@@ -575,32 +363,21 @@ const { status, data } = await apiInstance.getRFQ(
|
|
|
575
363
|
|**404** | Resource not found | - |
|
|
576
364
|
|**500** | Internal server error | - |
|
|
577
365
|
|
|
578
|
-
[[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)
|
|
579
|
-
|
|
580
366
|
# **getRFQs**
|
|
581
367
|
> GetRFQsResponse getRFQs()
|
|
582
368
|
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
### Example
|
|
586
|
-
|
|
587
|
-
```typescript
|
|
588
|
-
import {
|
|
589
|
-
CommunicationsApi,
|
|
590
|
-
Configuration
|
|
591
|
-
} from 'kalshi-typescript';
|
|
592
|
-
|
|
593
|
-
const configuration = new Configuration({
|
|
594
|
-
apiKey: 'your-api-key-id',
|
|
595
|
-
privateKeyPath: '/path/to/private-key.pem' // or privateKeyPem: 'PEM string'
|
|
596
|
-
});
|
|
597
|
-
const apiInstance = new CommunicationsApi(configuration);
|
|
598
|
-
|
|
599
|
-
const { status, data } = await apiInstance.getRFQs();
|
|
600
|
-
```
|
|
369
|
+
Endpoint for getting RFQs
|
|
601
370
|
|
|
602
371
|
### Parameters
|
|
603
|
-
|
|
372
|
+
|
|
373
|
+
|Name | Type | Description | Notes|
|
|
374
|
+
|------------- | ------------- | ------------- | -------------|
|
|
375
|
+
| **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|
|
|
376
|
+
| **eventTicker** | [**string**] | Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10). | (optional) defaults to undefined|
|
|
377
|
+
| **marketTicker** | [**string**] | Filter by market ticker | (optional) defaults to undefined|
|
|
378
|
+
| **limit** | [**number**] | Parameter to specify the number of results per page. Defaults to 100. | (optional) defaults to 100|
|
|
379
|
+
| **status** | [**string**] | Filter RFQs by status | (optional) defaults to undefined|
|
|
380
|
+
| **creatorUserId** | [**string**] | Filter RFQs by creator user ID | (optional) defaults to undefined|
|
|
604
381
|
|
|
605
382
|
|
|
606
383
|
### Return type
|
|
@@ -609,7 +386,7 @@ This endpoint does not have any parameters.
|
|
|
609
386
|
|
|
610
387
|
### Authorization
|
|
611
388
|
|
|
612
|
-
[
|
|
389
|
+
[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
|
|
613
390
|
|
|
614
391
|
### HTTP request headers
|
|
615
392
|
|
|
@@ -624,5 +401,3 @@ This endpoint does not have any parameters.
|
|
|
624
401
|
|**401** | Unauthorized - authentication required | - |
|
|
625
402
|
|**500** | Internal server error | - |
|
|
626
403
|
|
|
627
|
-
[[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)
|
|
628
|
-
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# CreateMarketInMultivariateEventCollectionRequest
|
|
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 created. | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { CreateMarketInMultivariateEventCollectionRequest } from 'kalshi-typescript';
|
|
14
|
+
|
|
15
|
+
const instance: CreateMarketInMultivariateEventCollectionRequest = {
|
|
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
|
+
# CreateMarketInMultivariateEventCollectionResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**event_ticker** | **string** | Event ticker for the created market. | [default to undefined]
|
|
9
|
+
**market_ticker** | **string** | Market ticker for the created market. | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { CreateMarketInMultivariateEventCollectionResponse } from 'kalshi-typescript';
|
|
15
|
+
|
|
16
|
+
const instance: CreateMarketInMultivariateEventCollectionResponse = {
|
|
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)
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**contracts_limit** | **number** | Specifies the maximum number of contracts that can be matched within this group. | [
|
|
8
|
+
**contracts_limit** | **number** | Specifies the maximum number of contracts that can be matched within this group. | [default to undefined]
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**order_group_id** | **string** | The unique identifier for the created order group | [
|
|
8
|
+
**order_group_id** | **string** | The unique identifier for the created order group | [default to undefined]
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -10,14 +10,20 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**side** | **string** | | [default to undefined]
|
|
11
11
|
**action** | **string** | | [default to undefined]
|
|
12
12
|
**count** | **number** | | [default to undefined]
|
|
13
|
-
**type** | **string** | | [default to undefined]
|
|
13
|
+
**type** | **string** | | [optional] [default to undefined]
|
|
14
14
|
**yes_price** | **number** | | [optional] [default to undefined]
|
|
15
15
|
**no_price** | **number** | | [optional] [default to undefined]
|
|
16
|
+
**yes_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
|
|
17
|
+
**no_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [optional] [default to undefined]
|
|
16
18
|
**expiration_ts** | **number** | | [optional] [default to undefined]
|
|
17
|
-
**
|
|
18
|
-
**buy_max_cost** | **number** |
|
|
19
|
-
**post_only** | **boolean** |
|
|
20
|
-
**
|
|
19
|
+
**time_in_force** | **string** | | [optional] [default to undefined]
|
|
20
|
+
**buy_max_cost** | **number** | Maximum cost in cents. When specified, the order will automatically have Fill-or-Kill (FoK) behavior. | [optional] [default to undefined]
|
|
21
|
+
**post_only** | **boolean** | | [optional] [default to undefined]
|
|
22
|
+
**reduce_only** | **boolean** | | [optional] [default to undefined]
|
|
23
|
+
**sell_position_floor** | **number** | Deprecated: Use reduce_only instead. Only accepts value of 0. | [optional] [default to undefined]
|
|
24
|
+
**self_trade_prevention_type** | [**SelfTradePreventionType**](SelfTradePreventionType.md) | | [optional] [default to undefined]
|
|
25
|
+
**order_group_id** | **string** | The order group this order is part of | [optional] [default to undefined]
|
|
26
|
+
**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]
|
|
21
27
|
|
|
22
28
|
## Example
|
|
23
29
|
|
|
@@ -33,11 +39,17 @@ const instance: CreateOrderRequest = {
|
|
|
33
39
|
type,
|
|
34
40
|
yes_price,
|
|
35
41
|
no_price,
|
|
42
|
+
yes_price_dollars,
|
|
43
|
+
no_price_dollars,
|
|
36
44
|
expiration_ts,
|
|
37
|
-
|
|
45
|
+
time_in_force,
|
|
38
46
|
buy_max_cost,
|
|
39
47
|
post_only,
|
|
48
|
+
reduce_only,
|
|
49
|
+
sell_position_floor,
|
|
50
|
+
self_trade_prevention_type,
|
|
40
51
|
order_group_id,
|
|
52
|
+
cancel_order_on_pause,
|
|
41
53
|
};
|
|
42
54
|
```
|
|
43
55
|
|
|
@@ -5,9 +5,10 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**rfq_id** | **string** |
|
|
9
|
-
**
|
|
10
|
-
**
|
|
8
|
+
**rfq_id** | **string** | The ID of the RFQ to quote on | [default to undefined]
|
|
9
|
+
**yes_bid** | **string** | The bid price for YES contracts, in dollars | [default to undefined]
|
|
10
|
+
**no_bid** | **string** | The bid price for NO contracts, in dollars | [default to undefined]
|
|
11
|
+
**rest_remainder** | **boolean** | Whether to rest the remainder of the quote after execution | [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -16,8 +17,9 @@ import { CreateQuoteRequest } from 'kalshi-typescript';
|
|
|
16
17
|
|
|
17
18
|
const instance: CreateQuoteRequest = {
|
|
18
19
|
rfq_id,
|
|
19
|
-
|
|
20
|
-
|
|
20
|
+
yes_bid,
|
|
21
|
+
no_bid,
|
|
22
|
+
rest_remainder,
|
|
21
23
|
};
|
|
22
24
|
```
|
|
23
25
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**
|
|
8
|
+
**id** | **string** | The ID of the newly created quote | [default to undefined]
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
import { CreateQuoteResponse } from 'kalshi-typescript';
|
|
14
14
|
|
|
15
15
|
const instance: CreateQuoteResponse = {
|
|
16
|
-
|
|
16
|
+
id,
|
|
17
17
|
};
|
|
18
18
|
```
|
|
19
19
|
|