kalshi-typescript 2.1.3 → 3.3.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/README.md +110 -50
- package/dist/api/api-keys-api.d.ts +20 -20
- package/dist/api/api-keys-api.js +44 -32
- 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 +246 -102
- package/dist/api/events-api.d.ts +210 -36
- package/dist/api/events-api.js +370 -50
- package/dist/api/exchange-api.d.ts +57 -20
- package/dist/api/exchange-api.js +92 -23
- 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 +425 -0
- package/dist/api/market-api.js +811 -0
- package/dist/api/milestone-api.d.ts +128 -0
- package/dist/api/milestone-api.js +249 -0
- package/dist/api/multivariate-api.d.ts +242 -0
- package/dist/api/multivariate-api.js +467 -0
- 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 +73 -601
- package/dist/api/portfolio-api.js +141 -1202
- package/dist/api/search-api.d.ts +92 -0
- package/dist/api/search-api.js +182 -0
- package/dist/api/structured-targets-api.d.ts +32 -24
- package/dist/api/structured-targets-api.js +43 -35
- 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 +45 -33
- 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 +247 -103
- package/dist/esm/api/events-api.d.ts +210 -36
- package/dist/esm/api/events-api.js +370 -50
- package/dist/esm/api/exchange-api.d.ts +57 -20
- package/dist/esm/api/exchange-api.js +93 -24
- 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 +425 -0
- package/dist/esm/api/market-api.js +804 -0
- package/dist/esm/api/milestone-api.d.ts +128 -0
- package/dist/esm/api/milestone-api.js +242 -0
- package/dist/esm/api/multivariate-api.d.ts +242 -0
- package/dist/esm/api/multivariate-api.js +460 -0
- 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 +73 -601
- package/dist/esm/api/portfolio-api.js +141 -1202
- package/dist/esm/api/search-api.d.ts +92 -0
- package/dist/esm/api/search-api.js +175 -0
- package/dist/esm/api/structured-targets-api.d.ts +32 -24
- package/dist/esm/api/structured-targets-api.js +44 -36
- 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 +6 -6
- 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 +8 -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 +8 -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/{models/accept-quote-request.ts → dist/esm/models/get-events-candlesticks-response-events-inner.js} +4 -10
- package/dist/esm/models/get-events-candlesticks-response.d.ts +18 -0
- package/{models/decrease-order-request.ts → dist/esm/models/get-events-candlesticks-response.js} +4 -10
- 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 +226 -27
- package/dist/esm/models/market.js +26 -6
- 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 +52 -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 +6 -6
- 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 +8 -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 +8 -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/{models/get-event-metadata-response.ts → dist/models/get-events-candlesticks-response-events-inner.js} +5 -10
- package/dist/models/get-events-candlesticks-response.d.ts +18 -0
- package/{models/get-user-data-timestamp-response.ts → dist/models/get-events-candlesticks-response.js} +5 -10
- 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 +226 -27
- package/dist/models/market.js +27 -7
- 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 +52 -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/package.json +13 -13
- package/.openapi-generator/FILES +0 -213
- package/.openapi-generator/VERSION +0 -1
- package/.openapi-generator-ignore +0 -33
- package/api/api-keys-api.ts +0 -354
- package/api/communications-api.ts +0 -863
- package/api/events-api.ts +0 -330
- package/api/exchange-api.ts +0 -315
- package/api/markets-api.ts +0 -554
- package/api/milestones-api.ts +0 -216
- package/api/multivariate-collections-api.ts +0 -293
- package/api/portfolio-api.ts +0 -1720
- package/api/series-api.ts +0 -208
- package/api/structured-targets-api.ts +0 -216
- package/api.ts +0 -27
- package/auth.ts +0 -38
- package/base.ts +0 -96
- package/common.ts +0 -98
- package/configuration.ts +0 -94
- package/docs/AcceptQuoteRequest.md +0 -20
- package/docs/AmendOrderRequest.md +0 -34
- package/docs/AmendOrderResponse.md +0 -20
- package/docs/Announcement.md +0 -26
- package/docs/ApiKey.md +0 -24
- package/docs/ApiKeysApi.md +0 -235
- package/docs/BatchCancelOrdersRequest.md +0 -20
- package/docs/BatchCancelOrdersResponse.md +0 -20
- package/docs/BatchCancelOrdersResponseResponsesInner.md +0 -24
- package/docs/BatchCreateOrdersRequest.md +0 -20
- package/docs/BatchCreateOrdersResponse.md +0 -20
- package/docs/BatchCreateOrdersResponseResponsesInner.md +0 -22
- package/docs/CancelOrderResponse.md +0 -22
- package/docs/Candlestick.md +0 -32
- package/docs/CommunicationsApi.md +0 -628
- package/docs/CreateApiKeyRequest.md +0 -22
- package/docs/CreateApiKeyResponse.md +0 -20
- package/docs/CreateOrderGroupRequest.md +0 -20
- package/docs/CreateOrderGroupResponse.md +0 -20
- package/docs/CreateOrderRequest.md +0 -44
- package/docs/CreateOrderResponse.md +0 -20
- package/docs/CreateQuoteRequest.md +0 -24
- package/docs/CreateQuoteResponse.md +0 -20
- package/docs/CreateRFQRequest.md +0 -26
- package/docs/CreateRFQResponse.md +0 -20
- package/docs/DailySchedule.md +0 -22
- package/docs/DecreaseOrderRequest.md +0 -20
- package/docs/DecreaseOrderResponse.md +0 -20
- package/docs/ErrorResponse.md +0 -20
- package/docs/ErrorResponseError.md +0 -24
- package/docs/Event.md +0 -30
- package/docs/EventPosition.md +0 -38
- package/docs/EventsApi.md +0 -199
- package/docs/ExchangeApi.md +0 -204
- package/docs/ExchangeStatus.md +0 -22
- package/docs/Fill.md +0 -36
- package/docs/GenerateApiKeyRequest.md +0 -20
- package/docs/GenerateApiKeyResponse.md +0 -22
- package/docs/GetApiKeysResponse.md +0 -20
- package/docs/GetBalanceResponse.md +0 -20
- package/docs/GetCommunicationsIDResponse.md +0 -20
- package/docs/GetEventMetadataResponse.md +0 -20
- package/docs/GetEventResponse.md +0 -22
- package/docs/GetEventsResponse.md +0 -22
- package/docs/GetExchangeAnnouncementsResponse.md +0 -20
- package/docs/GetExchangeScheduleResponse.md +0 -20
- package/docs/GetExchangeScheduleResponseSchedule.md +0 -32
- package/docs/GetFillsResponse.md +0 -22
- package/docs/GetMarketCandlesticksResponse.md +0 -20
- package/docs/GetMarketOrderbookResponse.md +0 -20
- package/docs/GetMarketOrderbookResponseOrderbook.md +0 -22
- package/docs/GetMarketResponse.md +0 -20
- package/docs/GetMarketsResponse.md +0 -22
- package/docs/GetMilestoneResponse.md +0 -20
- package/docs/GetMilestonesResponse.md +0 -20
- package/docs/GetMultivariateEventCollectionResponse.md +0 -20
- package/docs/GetMultivariateEventCollectionsResponse.md +0 -20
- package/docs/GetOrderGroupResponse.md +0 -22
- package/docs/GetOrderGroupsResponse.md +0 -22
- package/docs/GetOrderQueuePositionResponse.md +0 -20
- package/docs/GetOrderResponse.md +0 -20
- package/docs/GetOrdersResponse.md +0 -22
- package/docs/GetPositionsResponse.md +0 -24
- package/docs/GetQueuePositionsRequest.md +0 -20
- package/docs/GetQueuePositionsResponse.md +0 -20
- package/docs/GetQuoteResponse.md +0 -20
- package/docs/GetQuotesResponse.md +0 -20
- package/docs/GetRFQResponse.md +0 -20
- package/docs/GetRFQsResponse.md +0 -20
- package/docs/GetSeriesByTickerResponse.md +0 -20
- package/docs/GetSeriesResponse.md +0 -20
- package/docs/GetSettlementsResponse.md +0 -22
- package/docs/GetStructuredTargetResponse.md +0 -20
- package/docs/GetStructuredTargetsResponse.md +0 -20
- package/docs/GetTotalRestingOrderValueResponse.md +0 -20
- package/docs/GetTradesResponse.md +0 -22
- package/docs/GetUserDataTimestampResponse.md +0 -20
- package/docs/LookupBundleRequest.md +0 -20
- package/docs/LookupBundleRequestBundleInner.md +0 -22
- package/docs/LookupBundleResponse.md +0 -22
- package/docs/Market.md +0 -56
- package/docs/MarketsApi.md +0 -345
- package/docs/Milestone.md +0 -24
- package/docs/MilestonesApi.md +0 -125
- package/docs/MultivariateCollectionsApi.md +0 -185
- package/docs/MultivariateEventCollection.md +0 -26
- package/docs/MultivariateEventCollectionEventsInner.md +0 -26
- package/docs/Order.md +0 -54
- package/docs/OrderGroup.md +0 -22
- package/docs/OrderbookLevel.md +0 -22
- package/docs/PortfolioApi.md +0 -1224
- package/docs/Position.md +0 -34
- package/docs/Quote.md +0 -36
- package/docs/RFQ.md +0 -34
- package/docs/Series.md +0 -26
- package/docs/SeriesApi.md +0 -122
- package/docs/Settlement.md +0 -30
- package/docs/StructuredTarget.md +0 -24
- package/docs/StructuredTargetsApi.md +0 -125
- package/docs/Trade.md +0 -30
- package/git_push.sh +0 -57
- package/index.ts +0 -18
- package/models/amend-order-request.ts +0 -56
- package/models/amend-order-response.ts +0 -23
- package/models/announcement.ts +0 -38
- package/models/api-key.ts +0 -31
- package/models/batch-cancel-orders-request.ts +0 -20
- package/models/batch-cancel-orders-response-responses-inner.ts +0 -25
- package/models/batch-cancel-orders-response.ts +0 -23
- package/models/batch-create-orders-request.ts +0 -23
- package/models/batch-create-orders-response-responses-inner.ts +0 -27
- package/models/batch-create-orders-response.ts +0 -23
- package/models/cancel-order-response.ts +0 -24
- package/models/candlestick.ts +0 -26
- package/models/create-api-key-request.ts +0 -27
- package/models/create-api-key-response.ts +0 -23
- package/models/create-order-group-request.ts +0 -23
- package/models/create-order-group-response.ts +0 -23
- package/models/create-order-request.ts +0 -58
- package/models/create-order-response.ts +0 -23
- package/models/create-quote-request.ts +0 -22
- package/models/create-quote-response.ts +0 -23
- package/models/create-rfqrequest.ts +0 -31
- package/models/create-rfqresponse.ts +0 -23
- package/models/daily-schedule.ts +0 -21
- package/models/decrease-order-response.ts +0 -23
- package/models/error-response-error.ts +0 -31
- package/models/error-response.ts +0 -23
- package/models/event-position.ts +0 -59
- package/models/event.ts +0 -37
- package/models/exchange-status.ts +0 -21
- package/models/fill.ts +0 -42
- package/models/generate-api-key-request.ts +0 -23
- package/models/generate-api-key-response.ts +0 -27
- package/models/get-api-keys-response.ts +0 -26
- package/models/get-balance-response.ts +0 -23
- package/models/get-communications-idresponse.ts +0 -23
- package/models/get-event-response.ts +0 -27
- package/models/get-events-response.ts +0 -24
- package/models/get-exchange-announcements-response.ts +0 -23
- package/models/get-exchange-schedule-response-schedule.ts +0 -29
- package/models/get-exchange-schedule-response.ts +0 -23
- package/models/get-fills-response.ts +0 -24
- package/models/get-market-candlesticks-response.ts +0 -23
- package/models/get-market-orderbook-response-orderbook.ts +0 -24
- package/models/get-market-orderbook-response.ts +0 -23
- package/models/get-market-response.ts +0 -23
- package/models/get-markets-response.ts +0 -24
- package/models/get-milestone-response.ts +0 -23
- package/models/get-milestones-response.ts +0 -23
- package/models/get-multivariate-event-collection-response.ts +0 -23
- package/models/get-multivariate-event-collections-response.ts +0 -23
- package/models/get-order-group-response.ts +0 -27
- package/models/get-order-groups-response.ts +0 -24
- package/models/get-order-queue-position-response.ts +0 -20
- package/models/get-order-response.ts +0 -23
- package/models/get-orders-response.ts +0 -24
- package/models/get-positions-response.ts +0 -28
- package/models/get-queue-positions-request.ts +0 -20
- package/models/get-queue-positions-response.ts +0 -20
- package/models/get-quote-response.ts +0 -23
- package/models/get-quotes-response.ts +0 -23
- package/models/get-rfqresponse.ts +0 -23
- package/models/get-rfqs-response.ts +0 -23
- package/models/get-series-by-ticker-response.ts +0 -23
- package/models/get-series-response.ts +0 -23
- package/models/get-settlements-response.ts +0 -24
- package/models/get-structured-target-response.ts +0 -23
- package/models/get-structured-targets-response.ts +0 -23
- package/models/get-total-resting-order-value-response.ts +0 -20
- package/models/get-trades-response.ts +0 -24
- package/models/index.ts +0 -90
- package/models/lookup-bundle-request-bundle-inner.ts +0 -21
- package/models/lookup-bundle-request.ts +0 -23
- package/models/lookup-bundle-response.ts +0 -21
- package/models/market.ts +0 -59
- package/models/milestone.ts +0 -22
- package/models/multivariate-event-collection-events-inner.ts +0 -23
- package/models/multivariate-event-collection.ts +0 -26
- package/models/order-group.ts +0 -27
- package/models/order.ts +0 -77
- package/models/orderbook-level.ts +0 -21
- package/models/position.ts +0 -35
- package/models/quote.ts +0 -36
- package/models/rfq.ts +0 -35
- package/models/series.ts +0 -26
- package/models/settlement.ts +0 -33
- package/models/structured-target.ts +0 -22
- package/models/trade.ts +0 -33
- package/tsconfig.esm.json +0 -7
- package/tsconfig.json +0 -18
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## kalshi-typescript@
|
|
1
|
+
## kalshi-typescript@3.3.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install kalshi-typescript@
|
|
39
|
+
npm install kalshi-typescript@3.3.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -67,44 +67,58 @@ Class | Method | HTTP request | Description
|
|
|
67
67
|
*CommunicationsApi* | [**getRFQ**](docs/CommunicationsApi.md#getrfq) | **GET** /communications/rfqs/{rfq_id} | Get RFQ
|
|
68
68
|
*CommunicationsApi* | [**getRFQs**](docs/CommunicationsApi.md#getrfqs) | **GET** /communications/rfqs | Get RFQs
|
|
69
69
|
*EventsApi* | [**getEvent**](docs/EventsApi.md#getevent) | **GET** /events/{event_ticker} | Get Event
|
|
70
|
+
*EventsApi* | [**getEventForecastPercentilesHistory**](docs/EventsApi.md#geteventforecastpercentileshistory) | **GET** /series/{series_ticker}/events/{ticker}/forecast_percentile_history | Get Event Forecast Percentile History
|
|
70
71
|
*EventsApi* | [**getEventMetadata**](docs/EventsApi.md#geteventmetadata) | **GET** /events/{event_ticker}/metadata | Get Event Metadata
|
|
71
72
|
*EventsApi* | [**getEvents**](docs/EventsApi.md#getevents) | **GET** /events | Get Events
|
|
73
|
+
*EventsApi* | [**getMarketCandlesticksByEvent**](docs/EventsApi.md#getmarketcandlesticksbyevent) | **GET** /series/{series_ticker}/events/{ticker}/candlesticks | Get Event Candlesticks
|
|
74
|
+
*EventsApi* | [**getMultivariateEvents**](docs/EventsApi.md#getmultivariateevents) | **GET** /events/multivariate | Get Multivariate Events
|
|
72
75
|
*ExchangeApi* | [**getExchangeAnnouncements**](docs/ExchangeApi.md#getexchangeannouncements) | **GET** /exchange/announcements | Get Exchange Announcements
|
|
73
76
|
*ExchangeApi* | [**getExchangeSchedule**](docs/ExchangeApi.md#getexchangeschedule) | **GET** /exchange/schedule | Get Exchange Schedule
|
|
74
77
|
*ExchangeApi* | [**getExchangeStatus**](docs/ExchangeApi.md#getexchangestatus) | **GET** /exchange/status | Get Exchange Status
|
|
78
|
+
*ExchangeApi* | [**getSeriesFeeChanges**](docs/ExchangeApi.md#getseriesfeechanges) | **GET** /series/fee_changes | Get Series Fee Changes
|
|
75
79
|
*ExchangeApi* | [**getUserDataTimestamp**](docs/ExchangeApi.md#getuserdatatimestamp) | **GET** /exchange/user_data_timestamp | Get User Data Timestamp
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
*
|
|
81
|
-
*
|
|
82
|
-
*
|
|
83
|
-
*
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
*
|
|
93
|
-
*
|
|
80
|
+
*FcmApi* | [**getFCMOrders**](docs/FcmApi.md#getfcmorders) | **GET** /fcm/orders | Get FCM Orders
|
|
81
|
+
*FcmApi* | [**getFCMPositions**](docs/FcmApi.md#getfcmpositions) | **GET** /fcm/positions | Get FCM Positions
|
|
82
|
+
*IncentiveProgramsApi* | [**getIncentivePrograms**](docs/IncentiveProgramsApi.md#getincentiveprograms) | **GET** /incentive_programs | Get Incentives
|
|
83
|
+
*LiveDataApi* | [**getLiveData**](docs/LiveDataApi.md#getlivedata) | **GET** /live_data/{type}/milestone/{milestone_id} | Get Live Data
|
|
84
|
+
*LiveDataApi* | [**getLiveDatas**](docs/LiveDataApi.md#getlivedatas) | **GET** /live_data/batch | Get Multiple Live Data
|
|
85
|
+
*MarketApi* | [**batchGetMarketCandlesticks**](docs/MarketApi.md#batchgetmarketcandlesticks) | **GET** /markets/candlesticks | Batch Get Market Candlesticks
|
|
86
|
+
*MarketApi* | [**getMarket**](docs/MarketApi.md#getmarket) | **GET** /markets/{ticker} | Get Market
|
|
87
|
+
*MarketApi* | [**getMarketCandlesticks**](docs/MarketApi.md#getmarketcandlesticks) | **GET** /series/{series_ticker}/markets/{ticker}/candlesticks | Get Market Candlesticks
|
|
88
|
+
*MarketApi* | [**getMarketOrderbook**](docs/MarketApi.md#getmarketorderbook) | **GET** /markets/{ticker}/orderbook | Get Market Orderbook
|
|
89
|
+
*MarketApi* | [**getMarkets**](docs/MarketApi.md#getmarkets) | **GET** /markets | Get Markets
|
|
90
|
+
*MarketApi* | [**getSeries**](docs/MarketApi.md#getseries) | **GET** /series/{series_ticker} | Get Series
|
|
91
|
+
*MarketApi* | [**getSeriesList**](docs/MarketApi.md#getserieslist) | **GET** /series | Get Series List
|
|
92
|
+
*MarketApi* | [**getTrades**](docs/MarketApi.md#gettrades) | **GET** /markets/trades | Get Trades
|
|
93
|
+
*MilestoneApi* | [**getMilestone**](docs/MilestoneApi.md#getmilestone) | **GET** /milestones/{milestone_id} | Get Milestone
|
|
94
|
+
*MilestoneApi* | [**getMilestones**](docs/MilestoneApi.md#getmilestones) | **GET** /milestones | Get Milestones
|
|
95
|
+
*MultivariateApi* | [**createMarketInMultivariateEventCollection**](docs/MultivariateApi.md#createmarketinmultivariateeventcollection) | **POST** /multivariate_event_collections/{collection_ticker} | Create Market In Multivariate Event Collection
|
|
96
|
+
*MultivariateApi* | [**getMultivariateEventCollection**](docs/MultivariateApi.md#getmultivariateeventcollection) | **GET** /multivariate_event_collections/{collection_ticker} | Get Multivariate Event Collection
|
|
97
|
+
*MultivariateApi* | [**getMultivariateEventCollectionLookupHistory**](docs/MultivariateApi.md#getmultivariateeventcollectionlookuphistory) | **GET** /multivariate_event_collections/{collection_ticker}/lookup | Get Multivariate Event Collection Lookup History
|
|
98
|
+
*MultivariateApi* | [**getMultivariateEventCollections**](docs/MultivariateApi.md#getmultivariateeventcollections) | **GET** /multivariate_event_collections | Get Multivariate Event Collections
|
|
99
|
+
*MultivariateApi* | [**lookupTickersForMarketInMultivariateEventCollection**](docs/MultivariateApi.md#lookuptickersformarketinmultivariateeventcollection) | **PUT** /multivariate_event_collections/{collection_ticker}/lookup | Lookup Tickers For Market In Multivariate Event Collection
|
|
100
|
+
*OrderGroupsApi* | [**createOrderGroup**](docs/OrderGroupsApi.md#createordergroup) | **POST** /portfolio/order_groups/create | Create Order Group
|
|
101
|
+
*OrderGroupsApi* | [**deleteOrderGroup**](docs/OrderGroupsApi.md#deleteordergroup) | **DELETE** /portfolio/order_groups/{order_group_id} | Delete Order Group
|
|
102
|
+
*OrderGroupsApi* | [**getOrderGroup**](docs/OrderGroupsApi.md#getordergroup) | **GET** /portfolio/order_groups/{order_group_id} | Get Order Group
|
|
103
|
+
*OrderGroupsApi* | [**getOrderGroups**](docs/OrderGroupsApi.md#getordergroups) | **GET** /portfolio/order_groups | Get Order Groups
|
|
104
|
+
*OrderGroupsApi* | [**resetOrderGroup**](docs/OrderGroupsApi.md#resetordergroup) | **PUT** /portfolio/order_groups/{order_group_id}/reset | Reset Order Group
|
|
105
|
+
*OrdersApi* | [**amendOrder**](docs/OrdersApi.md#amendorder) | **POST** /portfolio/orders/{order_id}/amend | Amend Order
|
|
106
|
+
*OrdersApi* | [**batchCancelOrders**](docs/OrdersApi.md#batchcancelorders) | **DELETE** /portfolio/orders/batched | Batch Cancel Orders
|
|
107
|
+
*OrdersApi* | [**batchCreateOrders**](docs/OrdersApi.md#batchcreateorders) | **POST** /portfolio/orders/batched | Batch Create Orders
|
|
108
|
+
*OrdersApi* | [**cancelOrder**](docs/OrdersApi.md#cancelorder) | **DELETE** /portfolio/orders/{order_id} | Cancel Order
|
|
109
|
+
*OrdersApi* | [**createOrder**](docs/OrdersApi.md#createorder) | **POST** /portfolio/orders | Create Order
|
|
110
|
+
*OrdersApi* | [**decreaseOrder**](docs/OrdersApi.md#decreaseorder) | **POST** /portfolio/orders/{order_id}/decrease | Decrease Order
|
|
111
|
+
*OrdersApi* | [**getOrder**](docs/OrdersApi.md#getorder) | **GET** /portfolio/orders/{order_id} | Get Order
|
|
112
|
+
*OrdersApi* | [**getOrderQueuePosition**](docs/OrdersApi.md#getorderqueueposition) | **GET** /portfolio/orders/{order_id}/queue_position | Get Order Queue Position
|
|
113
|
+
*OrdersApi* | [**getOrderQueuePositions**](docs/OrdersApi.md#getorderqueuepositions) | **GET** /portfolio/orders/queue_positions | Get Queue Positions for Orders
|
|
114
|
+
*OrdersApi* | [**getOrders**](docs/OrdersApi.md#getorders) | **GET** /portfolio/orders | Get Orders
|
|
94
115
|
*PortfolioApi* | [**getBalance**](docs/PortfolioApi.md#getbalance) | **GET** /portfolio/balance | Get Balance
|
|
95
116
|
*PortfolioApi* | [**getFills**](docs/PortfolioApi.md#getfills) | **GET** /portfolio/fills | Get Fills
|
|
96
|
-
*PortfolioApi* | [**
|
|
97
|
-
*PortfolioApi* | [**getOrderGroup**](docs/PortfolioApi.md#getordergroup) | **GET** /portfolio/order_groups/{order_group_id} | Get Order Group
|
|
98
|
-
*PortfolioApi* | [**getOrderGroups**](docs/PortfolioApi.md#getordergroups) | **GET** /portfolio/order_groups | Get Order Groups
|
|
99
|
-
*PortfolioApi* | [**getOrderQueuePosition**](docs/PortfolioApi.md#getorderqueueposition) | **GET** /portfolio/orders/{order_id}/queue_position | Get Order Queue Position
|
|
100
|
-
*PortfolioApi* | [**getOrders**](docs/PortfolioApi.md#getorders) | **GET** /portfolio/orders | Get Orders
|
|
117
|
+
*PortfolioApi* | [**getPortfolioRestingOrderTotalValue**](docs/PortfolioApi.md#getportfoliorestingordertotalvalue) | **GET** /portfolio/summary/total_resting_order_value | Get Total Resting Order Value
|
|
101
118
|
*PortfolioApi* | [**getPositions**](docs/PortfolioApi.md#getpositions) | **GET** /portfolio/positions | Get Positions
|
|
102
|
-
*PortfolioApi* | [**getQueuePositions**](docs/PortfolioApi.md#getqueuepositions) | **POST** /portfolio/orders/queue_positions | Get Queue Positions
|
|
103
119
|
*PortfolioApi* | [**getSettlements**](docs/PortfolioApi.md#getsettlements) | **GET** /portfolio/settlements | Get Settlements
|
|
104
|
-
*
|
|
105
|
-
*
|
|
106
|
-
*SeriesApi* | [**getSeries**](docs/SeriesApi.md#getseries) | **GET** /series | Get Series
|
|
107
|
-
*SeriesApi* | [**getSeriesByTicker**](docs/SeriesApi.md#getseriesbyticker) | **GET** /series/{ticker} | Get Series by Ticker
|
|
120
|
+
*SearchApi* | [**getFiltersForSports**](docs/SearchApi.md#getfiltersforsports) | **GET** /search/filters_by_sport | Get Filters for Sports
|
|
121
|
+
*SearchApi* | [**getTagsForSeriesCategories**](docs/SearchApi.md#gettagsforseriescategories) | **GET** /search/tags_by_categories | Get Tags for Series Categories
|
|
108
122
|
*StructuredTargetsApi* | [**getStructuredTarget**](docs/StructuredTargetsApi.md#getstructuredtarget) | **GET** /structured_targets/{structured_target_id} | Get Structured Target
|
|
109
123
|
*StructuredTargetsApi* | [**getStructuredTargets**](docs/StructuredTargetsApi.md#getstructuredtargets) | **GET** /structured_targets | Get Structured Targets
|
|
110
124
|
|
|
@@ -116,16 +130,20 @@ Class | Method | HTTP request | Description
|
|
|
116
130
|
- [AmendOrderResponse](docs/AmendOrderResponse.md)
|
|
117
131
|
- [Announcement](docs/Announcement.md)
|
|
118
132
|
- [ApiKey](docs/ApiKey.md)
|
|
133
|
+
- [AssociatedEvent](docs/AssociatedEvent.md)
|
|
134
|
+
- [BatchCancelOrdersIndividualResponse](docs/BatchCancelOrdersIndividualResponse.md)
|
|
119
135
|
- [BatchCancelOrdersRequest](docs/BatchCancelOrdersRequest.md)
|
|
120
136
|
- [BatchCancelOrdersResponse](docs/BatchCancelOrdersResponse.md)
|
|
121
|
-
- [
|
|
137
|
+
- [BatchCreateOrdersIndividualResponse](docs/BatchCreateOrdersIndividualResponse.md)
|
|
122
138
|
- [BatchCreateOrdersRequest](docs/BatchCreateOrdersRequest.md)
|
|
123
139
|
- [BatchCreateOrdersResponse](docs/BatchCreateOrdersResponse.md)
|
|
124
|
-
- [
|
|
140
|
+
- [BatchGetMarketCandlesticksResponse](docs/BatchGetMarketCandlesticksResponse.md)
|
|
141
|
+
- [BidAskDistribution](docs/BidAskDistribution.md)
|
|
125
142
|
- [CancelOrderResponse](docs/CancelOrderResponse.md)
|
|
126
|
-
- [Candlestick](docs/Candlestick.md)
|
|
127
143
|
- [CreateApiKeyRequest](docs/CreateApiKeyRequest.md)
|
|
128
144
|
- [CreateApiKeyResponse](docs/CreateApiKeyResponse.md)
|
|
145
|
+
- [CreateMarketInMultivariateEventCollectionRequest](docs/CreateMarketInMultivariateEventCollectionRequest.md)
|
|
146
|
+
- [CreateMarketInMultivariateEventCollectionResponse](docs/CreateMarketInMultivariateEventCollectionResponse.md)
|
|
129
147
|
- [CreateOrderGroupRequest](docs/CreateOrderGroupRequest.md)
|
|
130
148
|
- [CreateOrderGroupResponse](docs/CreateOrderGroupResponse.md)
|
|
131
149
|
- [CreateOrderRequest](docs/CreateOrderRequest.md)
|
|
@@ -138,69 +156,95 @@ Class | Method | HTTP request | Description
|
|
|
138
156
|
- [DecreaseOrderRequest](docs/DecreaseOrderRequest.md)
|
|
139
157
|
- [DecreaseOrderResponse](docs/DecreaseOrderResponse.md)
|
|
140
158
|
- [ErrorResponse](docs/ErrorResponse.md)
|
|
141
|
-
- [
|
|
142
|
-
- [Event](docs/Event.md)
|
|
159
|
+
- [EventData](docs/EventData.md)
|
|
143
160
|
- [EventPosition](docs/EventPosition.md)
|
|
144
161
|
- [ExchangeStatus](docs/ExchangeStatus.md)
|
|
145
162
|
- [Fill](docs/Fill.md)
|
|
163
|
+
- [ForecastPercentilesPoint](docs/ForecastPercentilesPoint.md)
|
|
146
164
|
- [GenerateApiKeyRequest](docs/GenerateApiKeyRequest.md)
|
|
147
165
|
- [GenerateApiKeyResponse](docs/GenerateApiKeyResponse.md)
|
|
148
166
|
- [GetApiKeysResponse](docs/GetApiKeysResponse.md)
|
|
149
167
|
- [GetBalanceResponse](docs/GetBalanceResponse.md)
|
|
150
168
|
- [GetCommunicationsIDResponse](docs/GetCommunicationsIDResponse.md)
|
|
169
|
+
- [GetEventCandlesticksResponse](docs/GetEventCandlesticksResponse.md)
|
|
170
|
+
- [GetEventForecastPercentilesHistoryResponse](docs/GetEventForecastPercentilesHistoryResponse.md)
|
|
151
171
|
- [GetEventMetadataResponse](docs/GetEventMetadataResponse.md)
|
|
152
172
|
- [GetEventResponse](docs/GetEventResponse.md)
|
|
153
173
|
- [GetEventsResponse](docs/GetEventsResponse.md)
|
|
154
174
|
- [GetExchangeAnnouncementsResponse](docs/GetExchangeAnnouncementsResponse.md)
|
|
155
175
|
- [GetExchangeScheduleResponse](docs/GetExchangeScheduleResponse.md)
|
|
156
|
-
- [GetExchangeScheduleResponseSchedule](docs/GetExchangeScheduleResponseSchedule.md)
|
|
157
176
|
- [GetFillsResponse](docs/GetFillsResponse.md)
|
|
177
|
+
- [GetFiltersBySportsResponse](docs/GetFiltersBySportsResponse.md)
|
|
178
|
+
- [GetIncentiveProgramsResponse](docs/GetIncentiveProgramsResponse.md)
|
|
179
|
+
- [GetLiveDataResponse](docs/GetLiveDataResponse.md)
|
|
180
|
+
- [GetLiveDatasResponse](docs/GetLiveDatasResponse.md)
|
|
158
181
|
- [GetMarketCandlesticksResponse](docs/GetMarketCandlesticksResponse.md)
|
|
159
182
|
- [GetMarketOrderbookResponse](docs/GetMarketOrderbookResponse.md)
|
|
160
|
-
- [GetMarketOrderbookResponseOrderbook](docs/GetMarketOrderbookResponseOrderbook.md)
|
|
161
183
|
- [GetMarketResponse](docs/GetMarketResponse.md)
|
|
162
184
|
- [GetMarketsResponse](docs/GetMarketsResponse.md)
|
|
163
185
|
- [GetMilestoneResponse](docs/GetMilestoneResponse.md)
|
|
164
186
|
- [GetMilestonesResponse](docs/GetMilestonesResponse.md)
|
|
187
|
+
- [GetMultivariateEventCollectionLookupHistoryResponse](docs/GetMultivariateEventCollectionLookupHistoryResponse.md)
|
|
165
188
|
- [GetMultivariateEventCollectionResponse](docs/GetMultivariateEventCollectionResponse.md)
|
|
166
189
|
- [GetMultivariateEventCollectionsResponse](docs/GetMultivariateEventCollectionsResponse.md)
|
|
190
|
+
- [GetMultivariateEventsResponse](docs/GetMultivariateEventsResponse.md)
|
|
167
191
|
- [GetOrderGroupResponse](docs/GetOrderGroupResponse.md)
|
|
168
192
|
- [GetOrderGroupsResponse](docs/GetOrderGroupsResponse.md)
|
|
169
193
|
- [GetOrderQueuePositionResponse](docs/GetOrderQueuePositionResponse.md)
|
|
194
|
+
- [GetOrderQueuePositionsResponse](docs/GetOrderQueuePositionsResponse.md)
|
|
170
195
|
- [GetOrderResponse](docs/GetOrderResponse.md)
|
|
171
196
|
- [GetOrdersResponse](docs/GetOrdersResponse.md)
|
|
197
|
+
- [GetPortfolioRestingOrderTotalValueResponse](docs/GetPortfolioRestingOrderTotalValueResponse.md)
|
|
172
198
|
- [GetPositionsResponse](docs/GetPositionsResponse.md)
|
|
173
|
-
- [GetQueuePositionsRequest](docs/GetQueuePositionsRequest.md)
|
|
174
|
-
- [GetQueuePositionsResponse](docs/GetQueuePositionsResponse.md)
|
|
175
199
|
- [GetQuoteResponse](docs/GetQuoteResponse.md)
|
|
176
200
|
- [GetQuotesResponse](docs/GetQuotesResponse.md)
|
|
177
201
|
- [GetRFQResponse](docs/GetRFQResponse.md)
|
|
178
202
|
- [GetRFQsResponse](docs/GetRFQsResponse.md)
|
|
179
|
-
- [
|
|
203
|
+
- [GetSeriesFeeChangesResponse](docs/GetSeriesFeeChangesResponse.md)
|
|
204
|
+
- [GetSeriesListResponse](docs/GetSeriesListResponse.md)
|
|
180
205
|
- [GetSeriesResponse](docs/GetSeriesResponse.md)
|
|
181
206
|
- [GetSettlementsResponse](docs/GetSettlementsResponse.md)
|
|
182
207
|
- [GetStructuredTargetResponse](docs/GetStructuredTargetResponse.md)
|
|
183
208
|
- [GetStructuredTargetsResponse](docs/GetStructuredTargetsResponse.md)
|
|
184
|
-
- [
|
|
209
|
+
- [GetTagsForSeriesCategoriesResponse](docs/GetTagsForSeriesCategoriesResponse.md)
|
|
185
210
|
- [GetTradesResponse](docs/GetTradesResponse.md)
|
|
186
211
|
- [GetUserDataTimestampResponse](docs/GetUserDataTimestampResponse.md)
|
|
187
|
-
- [
|
|
188
|
-
- [
|
|
189
|
-
- [
|
|
212
|
+
- [IncentiveProgram](docs/IncentiveProgram.md)
|
|
213
|
+
- [LiveData](docs/LiveData.md)
|
|
214
|
+
- [LookupPoint](docs/LookupPoint.md)
|
|
215
|
+
- [LookupTickersForMarketInMultivariateEventCollectionRequest](docs/LookupTickersForMarketInMultivariateEventCollectionRequest.md)
|
|
216
|
+
- [LookupTickersForMarketInMultivariateEventCollectionResponse](docs/LookupTickersForMarketInMultivariateEventCollectionResponse.md)
|
|
217
|
+
- [MaintenanceWindow](docs/MaintenanceWindow.md)
|
|
190
218
|
- [Market](docs/Market.md)
|
|
219
|
+
- [MarketCandlestick](docs/MarketCandlestick.md)
|
|
220
|
+
- [MarketCandlesticksResponse](docs/MarketCandlesticksResponse.md)
|
|
221
|
+
- [MarketMetadata](docs/MarketMetadata.md)
|
|
222
|
+
- [MarketPosition](docs/MarketPosition.md)
|
|
191
223
|
- [Milestone](docs/Milestone.md)
|
|
192
224
|
- [MultivariateEventCollection](docs/MultivariateEventCollection.md)
|
|
193
|
-
- [
|
|
225
|
+
- [MveSelectedLeg](docs/MveSelectedLeg.md)
|
|
194
226
|
- [Order](docs/Order.md)
|
|
195
227
|
- [OrderGroup](docs/OrderGroup.md)
|
|
196
|
-
- [
|
|
197
|
-
- [
|
|
228
|
+
- [OrderQueuePosition](docs/OrderQueuePosition.md)
|
|
229
|
+
- [OrderStatus](docs/OrderStatus.md)
|
|
230
|
+
- [Orderbook](docs/Orderbook.md)
|
|
231
|
+
- [PercentilePoint](docs/PercentilePoint.md)
|
|
232
|
+
- [PriceDistribution](docs/PriceDistribution.md)
|
|
233
|
+
- [PriceRange](docs/PriceRange.md)
|
|
198
234
|
- [Quote](docs/Quote.md)
|
|
199
235
|
- [RFQ](docs/RFQ.md)
|
|
236
|
+
- [Schedule](docs/Schedule.md)
|
|
237
|
+
- [ScopeList](docs/ScopeList.md)
|
|
238
|
+
- [SelfTradePreventionType](docs/SelfTradePreventionType.md)
|
|
200
239
|
- [Series](docs/Series.md)
|
|
240
|
+
- [SeriesFeeChange](docs/SeriesFeeChange.md)
|
|
201
241
|
- [Settlement](docs/Settlement.md)
|
|
242
|
+
- [SettlementSource](docs/SettlementSource.md)
|
|
243
|
+
- [SportFilterDetails](docs/SportFilterDetails.md)
|
|
202
244
|
- [StructuredTarget](docs/StructuredTarget.md)
|
|
245
|
+
- [TickerPair](docs/TickerPair.md)
|
|
203
246
|
- [Trade](docs/Trade.md)
|
|
247
|
+
- [WeeklySchedule](docs/WeeklySchedule.md)
|
|
204
248
|
|
|
205
249
|
|
|
206
250
|
<a id="documentation-for-authorization"></a>
|
|
@@ -208,8 +252,24 @@ Class | Method | HTTP request | Description
|
|
|
208
252
|
|
|
209
253
|
|
|
210
254
|
Authentication schemes defined for the API:
|
|
211
|
-
<a id="
|
|
212
|
-
###
|
|
255
|
+
<a id="kalshiAccessKey"></a>
|
|
256
|
+
### kalshiAccessKey
|
|
213
257
|
|
|
214
|
-
- **Type**:
|
|
258
|
+
- **Type**: API key
|
|
259
|
+
- **API key parameter name**: KALSHI-ACCESS-KEY
|
|
260
|
+
- **Location**: HTTP header
|
|
261
|
+
|
|
262
|
+
<a id="kalshiAccessSignature"></a>
|
|
263
|
+
### kalshiAccessSignature
|
|
264
|
+
|
|
265
|
+
- **Type**: API key
|
|
266
|
+
- **API key parameter name**: KALSHI-ACCESS-SIGNATURE
|
|
267
|
+
- **Location**: HTTP header
|
|
268
|
+
|
|
269
|
+
<a id="kalshiAccessTimestamp"></a>
|
|
270
|
+
### kalshiAccessTimestamp
|
|
271
|
+
|
|
272
|
+
- **Type**: API key
|
|
273
|
+
- **API key parameter name**: KALSHI-ACCESS-TIMESTAMP
|
|
274
|
+
- **Location**: HTTP header
|
|
215
275
|
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Kalshi
|
|
3
|
-
*
|
|
2
|
+
* Kalshi Trade API Manual Endpoints
|
|
3
|
+
* Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 3.3.0
|
|
4
6
|
*
|
|
5
|
-
* The version of the OpenAPI document: 2.0.0
|
|
6
|
-
* Contact: support@kalshi.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
9
|
* https://openapi-generator.tech
|
|
@@ -22,7 +22,7 @@ import type { GetApiKeysResponse } from '../models';
|
|
|
22
22
|
*/
|
|
23
23
|
export declare const ApiKeysApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* Endpoint for creating a new API key with a user-provided public key. This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests.
|
|
26
26
|
* @summary Create API Key
|
|
27
27
|
* @param {CreateApiKeyRequest} createApiKeyRequest
|
|
28
28
|
* @param {*} [options] Override http request option.
|
|
@@ -30,7 +30,7 @@ export declare const ApiKeysApiAxiosParamCreator: (configuration?: Configuration
|
|
|
30
30
|
*/
|
|
31
31
|
createApiKey: (createApiKeyRequest: CreateApiKeyRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
32
32
|
/**
|
|
33
|
-
*
|
|
33
|
+
* Endpoint for deleting an existing API key. This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone.
|
|
34
34
|
* @summary Delete API Key
|
|
35
35
|
* @param {string} apiKey API key ID to delete
|
|
36
36
|
* @param {*} [options] Override http request option.
|
|
@@ -38,7 +38,7 @@ export declare const ApiKeysApiAxiosParamCreator: (configuration?: Configuration
|
|
|
38
38
|
*/
|
|
39
39
|
deleteApiKey: (apiKey: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
40
40
|
/**
|
|
41
|
-
*
|
|
41
|
+
* Endpoint for generating a new API key with an automatically created key pair. This endpoint generates both a public and private RSA key pair. The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.
|
|
42
42
|
* @summary Generate API Key
|
|
43
43
|
* @param {GenerateApiKeyRequest} generateApiKeyRequest
|
|
44
44
|
* @param {*} [options] Override http request option.
|
|
@@ -46,7 +46,7 @@ export declare const ApiKeysApiAxiosParamCreator: (configuration?: Configuration
|
|
|
46
46
|
*/
|
|
47
47
|
generateApiKey: (generateApiKeyRequest: GenerateApiKeyRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48
48
|
/**
|
|
49
|
-
*
|
|
49
|
+
* Endpoint for retrieving all API keys associated with the authenticated user. API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name.
|
|
50
50
|
* @summary Get API Keys
|
|
51
51
|
* @param {*} [options] Override http request option.
|
|
52
52
|
* @throws {RequiredError}
|
|
@@ -58,7 +58,7 @@ export declare const ApiKeysApiAxiosParamCreator: (configuration?: Configuration
|
|
|
58
58
|
*/
|
|
59
59
|
export declare const ApiKeysApiFp: (configuration?: Configuration) => {
|
|
60
60
|
/**
|
|
61
|
-
*
|
|
61
|
+
* Endpoint for creating a new API key with a user-provided public key. This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests.
|
|
62
62
|
* @summary Create API Key
|
|
63
63
|
* @param {CreateApiKeyRequest} createApiKeyRequest
|
|
64
64
|
* @param {*} [options] Override http request option.
|
|
@@ -66,7 +66,7 @@ export declare const ApiKeysApiFp: (configuration?: Configuration) => {
|
|
|
66
66
|
*/
|
|
67
67
|
createApiKey(createApiKeyRequest: CreateApiKeyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateApiKeyResponse>>;
|
|
68
68
|
/**
|
|
69
|
-
*
|
|
69
|
+
* Endpoint for deleting an existing API key. This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone.
|
|
70
70
|
* @summary Delete API Key
|
|
71
71
|
* @param {string} apiKey API key ID to delete
|
|
72
72
|
* @param {*} [options] Override http request option.
|
|
@@ -74,7 +74,7 @@ export declare const ApiKeysApiFp: (configuration?: Configuration) => {
|
|
|
74
74
|
*/
|
|
75
75
|
deleteApiKey(apiKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
76
76
|
/**
|
|
77
|
-
*
|
|
77
|
+
* Endpoint for generating a new API key with an automatically created key pair. This endpoint generates both a public and private RSA key pair. The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.
|
|
78
78
|
* @summary Generate API Key
|
|
79
79
|
* @param {GenerateApiKeyRequest} generateApiKeyRequest
|
|
80
80
|
* @param {*} [options] Override http request option.
|
|
@@ -82,7 +82,7 @@ export declare const ApiKeysApiFp: (configuration?: Configuration) => {
|
|
|
82
82
|
*/
|
|
83
83
|
generateApiKey(generateApiKeyRequest: GenerateApiKeyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateApiKeyResponse>>;
|
|
84
84
|
/**
|
|
85
|
-
*
|
|
85
|
+
* Endpoint for retrieving all API keys associated with the authenticated user. API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name.
|
|
86
86
|
* @summary Get API Keys
|
|
87
87
|
* @param {*} [options] Override http request option.
|
|
88
88
|
* @throws {RequiredError}
|
|
@@ -94,7 +94,7 @@ export declare const ApiKeysApiFp: (configuration?: Configuration) => {
|
|
|
94
94
|
*/
|
|
95
95
|
export declare const ApiKeysApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
96
96
|
/**
|
|
97
|
-
*
|
|
97
|
+
* Endpoint for creating a new API key with a user-provided public key. This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests.
|
|
98
98
|
* @summary Create API Key
|
|
99
99
|
* @param {CreateApiKeyRequest} createApiKeyRequest
|
|
100
100
|
* @param {*} [options] Override http request option.
|
|
@@ -102,7 +102,7 @@ export declare const ApiKeysApiFactory: (configuration?: Configuration, basePath
|
|
|
102
102
|
*/
|
|
103
103
|
createApiKey(createApiKeyRequest: CreateApiKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateApiKeyResponse>;
|
|
104
104
|
/**
|
|
105
|
-
*
|
|
105
|
+
* Endpoint for deleting an existing API key. This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone.
|
|
106
106
|
* @summary Delete API Key
|
|
107
107
|
* @param {string} apiKey API key ID to delete
|
|
108
108
|
* @param {*} [options] Override http request option.
|
|
@@ -110,7 +110,7 @@ export declare const ApiKeysApiFactory: (configuration?: Configuration, basePath
|
|
|
110
110
|
*/
|
|
111
111
|
deleteApiKey(apiKey: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
112
112
|
/**
|
|
113
|
-
*
|
|
113
|
+
* Endpoint for generating a new API key with an automatically created key pair. This endpoint generates both a public and private RSA key pair. The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.
|
|
114
114
|
* @summary Generate API Key
|
|
115
115
|
* @param {GenerateApiKeyRequest} generateApiKeyRequest
|
|
116
116
|
* @param {*} [options] Override http request option.
|
|
@@ -118,7 +118,7 @@ export declare const ApiKeysApiFactory: (configuration?: Configuration, basePath
|
|
|
118
118
|
*/
|
|
119
119
|
generateApiKey(generateApiKeyRequest: GenerateApiKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateApiKeyResponse>;
|
|
120
120
|
/**
|
|
121
|
-
*
|
|
121
|
+
* Endpoint for retrieving all API keys associated with the authenticated user. API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name.
|
|
122
122
|
* @summary Get API Keys
|
|
123
123
|
* @param {*} [options] Override http request option.
|
|
124
124
|
* @throws {RequiredError}
|
|
@@ -130,7 +130,7 @@ export declare const ApiKeysApiFactory: (configuration?: Configuration, basePath
|
|
|
130
130
|
*/
|
|
131
131
|
export declare class ApiKeysApi extends BaseAPI {
|
|
132
132
|
/**
|
|
133
|
-
*
|
|
133
|
+
* Endpoint for creating a new API key with a user-provided public key. This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests.
|
|
134
134
|
* @summary Create API Key
|
|
135
135
|
* @param {CreateApiKeyRequest} createApiKeyRequest
|
|
136
136
|
* @param {*} [options] Override http request option.
|
|
@@ -138,7 +138,7 @@ export declare class ApiKeysApi extends BaseAPI {
|
|
|
138
138
|
*/
|
|
139
139
|
createApiKey(createApiKeyRequest: CreateApiKeyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateApiKeyResponse, any, {}>>;
|
|
140
140
|
/**
|
|
141
|
-
*
|
|
141
|
+
* Endpoint for deleting an existing API key. This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone.
|
|
142
142
|
* @summary Delete API Key
|
|
143
143
|
* @param {string} apiKey API key ID to delete
|
|
144
144
|
* @param {*} [options] Override http request option.
|
|
@@ -146,7 +146,7 @@ export declare class ApiKeysApi extends BaseAPI {
|
|
|
146
146
|
*/
|
|
147
147
|
deleteApiKey(apiKey: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
148
148
|
/**
|
|
149
|
-
*
|
|
149
|
+
* Endpoint for generating a new API key with an automatically created key pair. This endpoint generates both a public and private RSA key pair. The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again.
|
|
150
150
|
* @summary Generate API Key
|
|
151
151
|
* @param {GenerateApiKeyRequest} generateApiKeyRequest
|
|
152
152
|
* @param {*} [options] Override http request option.
|
|
@@ -154,7 +154,7 @@ export declare class ApiKeysApi extends BaseAPI {
|
|
|
154
154
|
*/
|
|
155
155
|
generateApiKey(generateApiKeyRequest: GenerateApiKeyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateApiKeyResponse, any, {}>>;
|
|
156
156
|
/**
|
|
157
|
-
*
|
|
157
|
+
* Endpoint for retrieving all API keys associated with the authenticated user. API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name.
|
|
158
158
|
* @summary Get API Keys
|
|
159
159
|
* @param {*} [options] Override http request option.
|
|
160
160
|
* @throws {RequiredError}
|