kalshi-typescript 3.4.0 → 3.6.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 +19 -2
- package/dist/api/account-api.d.ts +63 -0
- package/dist/api/account-api.js +130 -0
- package/dist/api/api-keys-api.d.ts +1 -1
- package/dist/api/api-keys-api.js +1 -1
- package/dist/api/communications-api.d.ts +1 -1
- package/dist/api/communications-api.js +1 -1
- package/dist/api/events-api.d.ts +1 -1
- package/dist/api/events-api.js +1 -1
- package/dist/api/exchange-api.d.ts +1 -1
- package/dist/api/exchange-api.js +1 -1
- package/dist/api/fcm-api.d.ts +1 -1
- package/dist/api/fcm-api.js +1 -1
- package/dist/api/incentive-programs-api.d.ts +1 -1
- package/dist/api/incentive-programs-api.js +1 -1
- package/dist/api/live-data-api.d.ts +1 -1
- package/dist/api/live-data-api.js +1 -1
- package/dist/api/market-api.d.ts +37 -21
- package/dist/api/market-api.js +61 -33
- package/dist/api/milestone-api.d.ts +1 -1
- package/dist/api/milestone-api.js +1 -1
- package/dist/api/multivariate-api.d.ts +1 -1
- package/dist/api/multivariate-api.js +1 -1
- package/dist/api/order-groups-api.d.ts +98 -13
- package/dist/api/order-groups-api.js +196 -19
- package/dist/api/orders-api.d.ts +25 -13
- package/dist/api/orders-api.js +43 -22
- package/dist/api/portfolio-api.d.ts +145 -9
- package/dist/api/portfolio-api.js +307 -15
- package/dist/api/search-api.d.ts +1 -1
- package/dist/api/search-api.js +1 -1
- package/dist/api/structured-targets-api.d.ts +1 -1
- package/dist/api/structured-targets-api.js +1 -1
- package/dist/api.d.ts +2 -1
- package/dist/api.js +2 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api/account-api.d.ts +63 -0
- package/dist/esm/api/account-api.js +123 -0
- package/dist/esm/api/api-keys-api.d.ts +1 -1
- package/dist/esm/api/api-keys-api.js +1 -1
- package/dist/esm/api/communications-api.d.ts +1 -1
- package/dist/esm/api/communications-api.js +1 -1
- package/dist/esm/api/events-api.d.ts +1 -1
- package/dist/esm/api/events-api.js +1 -1
- package/dist/esm/api/exchange-api.d.ts +1 -1
- package/dist/esm/api/exchange-api.js +1 -1
- package/dist/esm/api/fcm-api.d.ts +1 -1
- package/dist/esm/api/fcm-api.js +1 -1
- package/dist/esm/api/incentive-programs-api.d.ts +1 -1
- package/dist/esm/api/incentive-programs-api.js +1 -1
- package/dist/esm/api/live-data-api.d.ts +1 -1
- package/dist/esm/api/live-data-api.js +1 -1
- package/dist/esm/api/market-api.d.ts +37 -21
- package/dist/esm/api/market-api.js +61 -33
- package/dist/esm/api/milestone-api.d.ts +1 -1
- package/dist/esm/api/milestone-api.js +1 -1
- package/dist/esm/api/multivariate-api.d.ts +1 -1
- package/dist/esm/api/multivariate-api.js +1 -1
- package/dist/esm/api/order-groups-api.d.ts +98 -13
- package/dist/esm/api/order-groups-api.js +196 -19
- package/dist/esm/api/orders-api.d.ts +25 -13
- package/dist/esm/api/orders-api.js +43 -22
- package/dist/esm/api/portfolio-api.d.ts +145 -9
- package/dist/esm/api/portfolio-api.js +308 -16
- package/dist/esm/api/search-api.d.ts +1 -1
- package/dist/esm/api/search-api.js +1 -1
- package/dist/esm/api/structured-targets-api.d.ts +1 -1
- package/dist/esm/api/structured-targets-api.js +1 -1
- package/dist/esm/api.d.ts +2 -1
- package/dist/esm/api.js +2 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/models/accept-quote-request.d.ts +1 -1
- package/dist/esm/models/accept-quote-request.js +1 -1
- package/dist/esm/models/account-limit.d.ts +25 -0
- package/dist/esm/models/account-limit.js +14 -0
- package/dist/esm/models/amend-order-request.d.ts +12 -4
- package/dist/esm/models/amend-order-request.js +1 -1
- package/dist/esm/models/amend-order-response.d.ts +1 -1
- package/dist/esm/models/amend-order-response.js +1 -1
- package/dist/esm/models/announcement.d.ts +1 -1
- package/dist/esm/models/announcement.js +1 -1
- package/dist/esm/models/api-key.d.ts +1 -1
- package/dist/esm/models/api-key.js +1 -1
- package/dist/esm/models/apply-subaccount-transfer-request.d.ts +29 -0
- package/dist/esm/models/apply-subaccount-transfer-request.js +14 -0
- package/dist/esm/models/associated-event.d.ts +1 -1
- package/dist/esm/models/associated-event.js +1 -1
- package/dist/esm/models/batch-cancel-orders-individual-response.d.ts +5 -1
- package/dist/esm/models/batch-cancel-orders-individual-response.js +1 -1
- package/dist/esm/models/batch-cancel-orders-request-order.d.ts +21 -0
- package/dist/esm/models/batch-cancel-orders-request-order.js +14 -0
- package/dist/esm/models/batch-cancel-orders-request.d.ts +8 -2
- package/dist/esm/models/batch-cancel-orders-request.js +1 -1
- package/dist/esm/models/batch-cancel-orders-response.d.ts +1 -1
- package/dist/esm/models/batch-cancel-orders-response.js +1 -1
- package/dist/esm/models/batch-create-orders-individual-response.d.ts +1 -1
- package/dist/esm/models/batch-create-orders-individual-response.js +1 -1
- package/dist/esm/models/batch-create-orders-request.d.ts +1 -1
- package/dist/esm/models/batch-create-orders-request.js +1 -1
- package/dist/esm/models/batch-create-orders-response.d.ts +1 -1
- package/dist/esm/models/batch-create-orders-response.js +1 -1
- package/dist/esm/models/batch-get-market-candlesticks-response.d.ts +1 -1
- package/dist/esm/models/batch-get-market-candlesticks-response.js +1 -1
- package/dist/esm/models/bid-ask-distribution.d.ts +1 -1
- package/dist/esm/models/bid-ask-distribution.js +1 -1
- package/dist/esm/models/cancel-order-response.d.ts +5 -1
- package/dist/esm/models/cancel-order-response.js +1 -1
- package/dist/esm/models/create-api-key-request.d.ts +1 -1
- package/dist/esm/models/create-api-key-request.js +1 -1
- package/dist/esm/models/create-api-key-response.d.ts +1 -1
- package/dist/esm/models/create-api-key-response.js +1 -1
- package/dist/esm/models/create-market-in-multivariate-event-collection-request.d.ts +1 -1
- package/dist/esm/models/create-market-in-multivariate-event-collection-request.js +1 -1
- package/dist/esm/models/create-market-in-multivariate-event-collection-response.d.ts +1 -1
- package/dist/esm/models/create-market-in-multivariate-event-collection-response.js +1 -1
- package/dist/esm/models/create-order-group-request.d.ts +11 -3
- package/dist/esm/models/create-order-group-request.js +1 -1
- package/dist/esm/models/create-order-group-response.d.ts +1 -1
- package/dist/esm/models/create-order-group-response.js +1 -1
- package/dist/esm/models/create-order-request.d.ts +13 -2
- package/dist/esm/models/create-order-request.js +1 -1
- package/dist/esm/models/create-order-response.d.ts +1 -1
- package/dist/esm/models/create-order-response.js +1 -1
- package/dist/esm/models/create-quote-request.d.ts +5 -1
- package/dist/esm/models/create-quote-request.js +1 -1
- package/dist/esm/models/create-quote-response.d.ts +1 -1
- package/dist/esm/models/create-quote-response.js +1 -1
- package/dist/esm/models/create-rfqrequest.d.ts +6 -2
- package/dist/esm/models/create-rfqrequest.js +1 -1
- package/dist/esm/models/create-rfqresponse.d.ts +1 -1
- package/dist/esm/models/create-rfqresponse.js +1 -1
- package/dist/esm/models/create-subaccount-response.d.ts +17 -0
- package/dist/esm/models/create-subaccount-response.js +14 -0
- package/dist/esm/models/daily-schedule.d.ts +1 -1
- package/dist/esm/models/daily-schedule.js +1 -1
- package/dist/esm/models/decrease-order-request.d.ts +19 -1
- package/dist/esm/models/decrease-order-request.js +1 -1
- package/dist/esm/models/decrease-order-response.d.ts +1 -1
- package/dist/esm/models/decrease-order-response.js +1 -1
- package/dist/esm/models/error-response.d.ts +1 -1
- package/dist/esm/models/error-response.js +1 -1
- package/dist/esm/models/event-data.d.ts +1 -1
- package/dist/esm/models/event-data.js +1 -1
- package/dist/esm/models/event-position.d.ts +5 -1
- package/dist/esm/models/event-position.js +1 -1
- package/dist/esm/models/exchange-instance.d.ts +1 -1
- package/dist/esm/models/exchange-instance.js +1 -1
- package/dist/esm/models/exchange-status.d.ts +1 -1
- package/dist/esm/models/exchange-status.js +1 -1
- package/dist/esm/models/fill.d.ts +9 -1
- package/dist/esm/models/fill.js +1 -1
- package/dist/esm/models/forecast-percentiles-point.d.ts +1 -1
- package/dist/esm/models/forecast-percentiles-point.js +1 -1
- package/dist/esm/models/generate-api-key-request.d.ts +1 -1
- package/dist/esm/models/generate-api-key-request.js +1 -1
- package/dist/esm/models/generate-api-key-response.d.ts +1 -1
- package/dist/esm/models/generate-api-key-response.js +1 -1
- package/dist/esm/models/get-account-api-limits-response.d.ts +25 -0
- package/dist/esm/models/get-account-api-limits-response.js +14 -0
- package/dist/esm/models/get-api-keys-response.d.ts +1 -1
- package/dist/esm/models/get-api-keys-response.js +1 -1
- package/dist/esm/models/get-balance-response.d.ts +1 -1
- package/dist/esm/models/get-balance-response.js +1 -1
- package/dist/esm/models/get-communications-idresponse.d.ts +1 -1
- package/dist/esm/models/get-communications-idresponse.js +1 -1
- package/dist/esm/models/get-event-candlesticks-response.d.ts +1 -1
- package/dist/esm/models/get-event-candlesticks-response.js +1 -1
- package/dist/esm/models/get-event-forecast-percentiles-history-response.d.ts +1 -1
- package/dist/esm/models/get-event-forecast-percentiles-history-response.js +1 -1
- package/dist/esm/models/get-event-metadata-response.d.ts +1 -1
- package/dist/esm/models/get-event-metadata-response.js +1 -1
- package/dist/esm/models/get-event-response.d.ts +1 -1
- package/dist/esm/models/get-event-response.js +1 -1
- package/dist/esm/models/get-events-response.d.ts +1 -1
- package/dist/esm/models/get-events-response.js +1 -1
- package/dist/esm/models/get-exchange-announcements-response.d.ts +1 -1
- package/dist/esm/models/get-exchange-announcements-response.js +1 -1
- package/dist/esm/models/get-exchange-schedule-response.d.ts +1 -1
- package/dist/esm/models/get-exchange-schedule-response.js +1 -1
- package/dist/esm/models/get-fills-response.d.ts +1 -1
- package/dist/esm/models/get-fills-response.js +1 -1
- package/dist/esm/models/get-filters-by-sports-response.d.ts +1 -1
- package/dist/esm/models/get-filters-by-sports-response.js +1 -1
- package/dist/esm/models/get-incentive-programs-response.d.ts +1 -1
- package/dist/esm/models/get-incentive-programs-response.js +1 -1
- package/dist/esm/models/get-live-data-response.d.ts +1 -1
- package/dist/esm/models/get-live-data-response.js +1 -1
- package/dist/esm/models/get-live-datas-response.d.ts +1 -1
- package/dist/esm/models/get-live-datas-response.js +1 -1
- package/dist/esm/models/get-market-candlesticks-response.d.ts +1 -1
- package/dist/esm/models/get-market-candlesticks-response.js +1 -1
- package/dist/esm/models/get-market-orderbook-response.d.ts +3 -1
- package/dist/esm/models/get-market-orderbook-response.js +1 -1
- package/dist/esm/models/get-market-response.d.ts +1 -1
- package/dist/esm/models/get-market-response.js +1 -1
- package/dist/esm/models/get-markets-response.d.ts +1 -1
- package/dist/esm/models/get-markets-response.js +1 -1
- package/dist/esm/models/get-milestone-response.d.ts +1 -1
- package/dist/esm/models/get-milestone-response.js +1 -1
- package/dist/esm/models/get-milestones-response.d.ts +1 -1
- package/dist/esm/models/get-milestones-response.js +1 -1
- package/dist/esm/models/get-multivariate-event-collection-lookup-history-response.d.ts +1 -1
- package/dist/esm/models/get-multivariate-event-collection-lookup-history-response.js +1 -1
- package/dist/esm/models/get-multivariate-event-collection-response.d.ts +1 -1
- package/dist/esm/models/get-multivariate-event-collection-response.js +1 -1
- package/dist/esm/models/get-multivariate-event-collections-response.d.ts +1 -1
- package/dist/esm/models/get-multivariate-event-collections-response.js +1 -1
- package/dist/esm/models/get-multivariate-events-response.d.ts +1 -1
- package/dist/esm/models/get-multivariate-events-response.js +1 -1
- package/dist/esm/models/get-order-group-response.d.ts +9 -1
- package/dist/esm/models/get-order-group-response.js +1 -1
- package/dist/esm/models/get-order-groups-response.d.ts +1 -1
- package/dist/esm/models/get-order-groups-response.js +1 -1
- package/dist/esm/models/get-order-queue-position-response.d.ts +1 -1
- package/dist/esm/models/get-order-queue-position-response.js +1 -1
- package/dist/esm/models/get-order-queue-positions-response.d.ts +1 -1
- package/dist/esm/models/get-order-queue-positions-response.js +1 -1
- package/dist/esm/models/get-order-response.d.ts +1 -1
- package/dist/esm/models/get-order-response.js +1 -1
- package/dist/esm/models/get-orders-response.d.ts +1 -1
- package/dist/esm/models/get-orders-response.js +1 -1
- package/dist/esm/models/get-portfolio-resting-order-total-value-response.d.ts +1 -1
- package/dist/esm/models/get-portfolio-resting-order-total-value-response.js +1 -1
- package/dist/esm/models/get-positions-response.d.ts +1 -1
- package/dist/esm/models/get-positions-response.js +1 -1
- package/dist/esm/models/get-quote-response.d.ts +1 -1
- package/dist/esm/models/get-quote-response.js +1 -1
- package/dist/esm/models/get-quotes-response.d.ts +1 -1
- package/dist/esm/models/get-quotes-response.js +1 -1
- package/dist/esm/models/get-rfqresponse.d.ts +1 -1
- package/dist/esm/models/get-rfqresponse.js +1 -1
- package/dist/esm/models/get-rfqs-response.d.ts +1 -1
- package/dist/esm/models/get-rfqs-response.js +1 -1
- package/dist/esm/models/get-series-fee-changes-response.d.ts +1 -1
- package/dist/esm/models/get-series-fee-changes-response.js +1 -1
- package/dist/esm/models/get-series-list-response.d.ts +1 -1
- package/dist/esm/models/get-series-list-response.js +1 -1
- package/dist/esm/models/get-series-response.d.ts +1 -1
- package/dist/esm/models/get-series-response.js +1 -1
- package/dist/esm/models/get-settlements-response.d.ts +1 -1
- package/dist/esm/models/get-settlements-response.js +1 -1
- package/dist/esm/models/get-structured-target-response.d.ts +1 -1
- package/dist/esm/models/get-structured-target-response.js +1 -1
- package/dist/esm/models/get-structured-targets-response.d.ts +1 -1
- package/dist/esm/models/get-structured-targets-response.js +1 -1
- package/dist/esm/models/get-subaccount-balance-response.d.ts +21 -0
- package/dist/esm/models/get-subaccount-balance-response.js +14 -0
- package/dist/esm/models/get-subaccount-balances-response.d.ts +15 -0
- package/dist/esm/models/get-subaccount-balances-response.js +14 -0
- package/dist/esm/models/get-subaccount-transfers-response.d.ts +19 -0
- package/dist/esm/models/get-subaccount-transfers-response.js +14 -0
- package/dist/esm/models/get-tags-for-series-categories-response.d.ts +1 -1
- package/dist/esm/models/get-tags-for-series-categories-response.js +1 -1
- package/dist/esm/models/get-trades-response.d.ts +1 -1
- package/dist/esm/models/get-trades-response.js +1 -1
- package/dist/esm/models/get-user-data-timestamp-response.d.ts +1 -1
- package/dist/esm/models/get-user-data-timestamp-response.js +1 -1
- package/dist/esm/models/incentive-program.d.ts +5 -1
- package/dist/esm/models/incentive-program.js +1 -1
- package/dist/esm/models/index.d.ts +10 -0
- package/dist/esm/models/index.js +10 -0
- package/dist/esm/models/intra-exchange-instance-transfer-request.d.ts +9 -1
- package/dist/esm/models/intra-exchange-instance-transfer-request.js +1 -1
- package/dist/esm/models/intra-exchange-instance-transfer-response.d.ts +1 -1
- package/dist/esm/models/intra-exchange-instance-transfer-response.js +1 -1
- package/dist/esm/models/live-data.d.ts +1 -1
- package/dist/esm/models/live-data.js +1 -1
- package/dist/esm/models/lookup-point.d.ts +1 -1
- package/dist/esm/models/lookup-point.js +1 -1
- package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-request.d.ts +1 -1
- package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-request.js +1 -1
- package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-response.d.ts +1 -1
- package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-response.js +1 -1
- package/dist/esm/models/maintenance-window.d.ts +1 -1
- package/dist/esm/models/maintenance-window.js +1 -1
- package/dist/esm/models/market-candlestick.d.ts +9 -1
- package/dist/esm/models/market-candlestick.js +1 -1
- package/dist/esm/models/market-candlesticks-response.d.ts +1 -1
- package/dist/esm/models/market-candlesticks-response.js +1 -1
- package/dist/esm/models/market-metadata.d.ts +1 -1
- package/dist/esm/models/market-metadata.js +1 -1
- package/dist/esm/models/market-position.d.ts +5 -1
- package/dist/esm/models/market-position.js +1 -1
- package/dist/esm/models/market.d.ts +22 -1
- package/dist/esm/models/market.js +2 -1
- package/dist/esm/models/milestone.d.ts +1 -1
- package/dist/esm/models/milestone.js +1 -1
- package/dist/esm/models/multivariate-event-collection.d.ts +1 -1
- package/dist/esm/models/multivariate-event-collection.js +1 -1
- package/dist/esm/models/mve-selected-leg.d.ts +5 -1
- package/dist/esm/models/mve-selected-leg.js +1 -1
- package/dist/esm/models/order-group.d.ts +9 -1
- package/dist/esm/models/order-group.js +1 -1
- package/dist/esm/models/order-queue-position.d.ts +1 -1
- package/dist/esm/models/order-queue-position.js +1 -1
- package/dist/esm/models/order-status.d.ts +1 -1
- package/dist/esm/models/order-status.js +1 -1
- package/dist/esm/models/order.d.ts +13 -1
- package/dist/esm/models/order.js +1 -1
- package/dist/esm/models/orderbook-count-fp.d.ts +18 -0
- package/dist/esm/models/orderbook-count-fp.js +14 -0
- package/dist/esm/models/orderbook-level-count-fp-inner.d.ts +15 -0
- package/dist/esm/models/orderbook-level-count-fp-inner.js +14 -0
- package/dist/esm/models/orderbook.d.ts +4 -1
- package/dist/esm/models/orderbook.js +1 -1
- package/dist/esm/models/percentile-point.d.ts +1 -1
- package/dist/esm/models/percentile-point.js +1 -1
- package/dist/esm/models/price-distribution.d.ts +1 -1
- package/dist/esm/models/price-distribution.js +1 -1
- package/dist/esm/models/price-level-count-fp-inner.d.ts +15 -0
- package/dist/esm/models/price-level-count-fp-inner.js +14 -0
- package/dist/esm/models/price-level-dollars-inner.d.ts +15 -0
- package/dist/esm/models/price-level-dollars-inner.js +14 -0
- package/dist/esm/models/price-range.d.ts +1 -1
- package/dist/esm/models/price-range.js +1 -1
- package/dist/esm/models/quote.d.ts +5 -1
- package/dist/esm/models/quote.js +1 -1
- package/dist/esm/models/rfq.d.ts +6 -2
- package/dist/esm/models/rfq.js +1 -1
- package/dist/esm/models/schedule.d.ts +1 -1
- package/dist/esm/models/schedule.js +1 -1
- package/dist/esm/models/scope-list.d.ts +1 -1
- package/dist/esm/models/scope-list.js +1 -1
- package/dist/esm/models/self-trade-prevention-type.d.ts +1 -1
- package/dist/esm/models/self-trade-prevention-type.js +1 -1
- package/dist/esm/models/series-fee-change.d.ts +1 -1
- package/dist/esm/models/series-fee-change.js +1 -1
- package/dist/esm/models/series.d.ts +9 -1
- package/dist/esm/models/series.js +1 -1
- package/dist/esm/models/settlement-source.d.ts +1 -1
- package/dist/esm/models/settlement-source.js +1 -1
- package/dist/esm/models/settlement.d.ts +10 -2
- package/dist/esm/models/settlement.js +1 -1
- package/dist/esm/models/sport-filter-details.d.ts +1 -1
- package/dist/esm/models/sport-filter-details.js +1 -1
- package/dist/esm/models/structured-target.d.ts +1 -1
- package/dist/esm/models/structured-target.js +1 -1
- package/dist/esm/models/subaccount-balance.d.ts +25 -0
- package/dist/esm/models/subaccount-balance.js +14 -0
- package/dist/esm/models/subaccount-transfer.d.ts +33 -0
- package/dist/esm/models/subaccount-transfer.js +14 -0
- package/dist/esm/models/ticker-pair.d.ts +1 -1
- package/dist/esm/models/ticker-pair.js +1 -1
- package/dist/esm/models/trade.d.ts +5 -1
- package/dist/esm/models/trade.js +1 -1
- package/dist/esm/models/transfer-between-subaccounts-request.d.ts +25 -0
- package/dist/esm/models/transfer-between-subaccounts-request.js +14 -0
- package/dist/esm/models/update-order-group-limit-request.d.ts +21 -0
- package/dist/esm/models/update-order-group-limit-request.js +14 -0
- package/dist/esm/models/weekly-schedule.d.ts +1 -1
- package/dist/esm/models/weekly-schedule.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/accept-quote-request.d.ts +1 -1
- package/dist/models/accept-quote-request.js +1 -1
- package/dist/models/account-limit.d.ts +25 -0
- package/dist/models/account-limit.js +15 -0
- package/dist/models/amend-order-request.d.ts +12 -4
- package/dist/models/amend-order-request.js +1 -1
- package/dist/models/amend-order-response.d.ts +1 -1
- package/dist/models/amend-order-response.js +1 -1
- package/dist/models/announcement.d.ts +1 -1
- package/dist/models/announcement.js +1 -1
- package/dist/models/api-key.d.ts +1 -1
- package/dist/models/api-key.js +1 -1
- package/dist/models/apply-subaccount-transfer-request.d.ts +29 -0
- package/dist/models/apply-subaccount-transfer-request.js +15 -0
- package/dist/models/associated-event.d.ts +1 -1
- package/dist/models/associated-event.js +1 -1
- package/dist/models/batch-cancel-orders-individual-response.d.ts +5 -1
- package/dist/models/batch-cancel-orders-individual-response.js +1 -1
- package/dist/models/batch-cancel-orders-request-order.d.ts +21 -0
- package/dist/models/batch-cancel-orders-request-order.js +15 -0
- package/dist/models/batch-cancel-orders-request.d.ts +8 -2
- package/dist/models/batch-cancel-orders-request.js +1 -1
- package/dist/models/batch-cancel-orders-response.d.ts +1 -1
- package/dist/models/batch-cancel-orders-response.js +1 -1
- package/dist/models/batch-create-orders-individual-response.d.ts +1 -1
- package/dist/models/batch-create-orders-individual-response.js +1 -1
- package/dist/models/batch-create-orders-request.d.ts +1 -1
- package/dist/models/batch-create-orders-request.js +1 -1
- package/dist/models/batch-create-orders-response.d.ts +1 -1
- package/dist/models/batch-create-orders-response.js +1 -1
- package/dist/models/batch-get-market-candlesticks-response.d.ts +1 -1
- package/dist/models/batch-get-market-candlesticks-response.js +1 -1
- package/dist/models/bid-ask-distribution.d.ts +1 -1
- package/dist/models/bid-ask-distribution.js +1 -1
- package/dist/models/cancel-order-response.d.ts +5 -1
- package/dist/models/cancel-order-response.js +1 -1
- package/dist/models/create-api-key-request.d.ts +1 -1
- package/dist/models/create-api-key-request.js +1 -1
- package/dist/models/create-api-key-response.d.ts +1 -1
- package/dist/models/create-api-key-response.js +1 -1
- package/dist/models/create-market-in-multivariate-event-collection-request.d.ts +1 -1
- package/dist/models/create-market-in-multivariate-event-collection-request.js +1 -1
- package/dist/models/create-market-in-multivariate-event-collection-response.d.ts +1 -1
- package/dist/models/create-market-in-multivariate-event-collection-response.js +1 -1
- package/dist/models/create-order-group-request.d.ts +11 -3
- package/dist/models/create-order-group-request.js +1 -1
- package/dist/models/create-order-group-response.d.ts +1 -1
- package/dist/models/create-order-group-response.js +1 -1
- package/dist/models/create-order-request.d.ts +13 -2
- package/dist/models/create-order-request.js +1 -1
- package/dist/models/create-order-response.d.ts +1 -1
- package/dist/models/create-order-response.js +1 -1
- package/dist/models/create-quote-request.d.ts +5 -1
- package/dist/models/create-quote-request.js +1 -1
- package/dist/models/create-quote-response.d.ts +1 -1
- package/dist/models/create-quote-response.js +1 -1
- package/dist/models/create-rfqrequest.d.ts +6 -2
- package/dist/models/create-rfqrequest.js +1 -1
- package/dist/models/create-rfqresponse.d.ts +1 -1
- package/dist/models/create-rfqresponse.js +1 -1
- package/dist/models/create-subaccount-response.d.ts +17 -0
- package/dist/models/create-subaccount-response.js +15 -0
- package/dist/models/daily-schedule.d.ts +1 -1
- package/dist/models/daily-schedule.js +1 -1
- package/dist/models/decrease-order-request.d.ts +19 -1
- package/dist/models/decrease-order-request.js +1 -1
- package/dist/models/decrease-order-response.d.ts +1 -1
- package/dist/models/decrease-order-response.js +1 -1
- package/dist/models/error-response.d.ts +1 -1
- package/dist/models/error-response.js +1 -1
- package/dist/models/event-data.d.ts +1 -1
- package/dist/models/event-data.js +1 -1
- package/dist/models/event-position.d.ts +5 -1
- package/dist/models/event-position.js +1 -1
- package/dist/models/exchange-instance.d.ts +1 -1
- package/dist/models/exchange-instance.js +1 -1
- package/dist/models/exchange-status.d.ts +1 -1
- package/dist/models/exchange-status.js +1 -1
- package/dist/models/fill.d.ts +9 -1
- package/dist/models/fill.js +1 -1
- package/dist/models/forecast-percentiles-point.d.ts +1 -1
- package/dist/models/forecast-percentiles-point.js +1 -1
- package/dist/models/generate-api-key-request.d.ts +1 -1
- package/dist/models/generate-api-key-request.js +1 -1
- package/dist/models/generate-api-key-response.d.ts +1 -1
- package/dist/models/generate-api-key-response.js +1 -1
- package/dist/models/get-account-api-limits-response.d.ts +25 -0
- package/dist/models/get-account-api-limits-response.js +15 -0
- package/dist/models/get-api-keys-response.d.ts +1 -1
- package/dist/models/get-api-keys-response.js +1 -1
- package/dist/models/get-balance-response.d.ts +1 -1
- package/dist/models/get-balance-response.js +1 -1
- package/dist/models/get-communications-idresponse.d.ts +1 -1
- package/dist/models/get-communications-idresponse.js +1 -1
- package/dist/models/get-event-candlesticks-response.d.ts +1 -1
- package/dist/models/get-event-candlesticks-response.js +1 -1
- package/dist/models/get-event-forecast-percentiles-history-response.d.ts +1 -1
- package/dist/models/get-event-forecast-percentiles-history-response.js +1 -1
- package/dist/models/get-event-metadata-response.d.ts +1 -1
- package/dist/models/get-event-metadata-response.js +1 -1
- package/dist/models/get-event-response.d.ts +1 -1
- package/dist/models/get-event-response.js +1 -1
- package/dist/models/get-events-response.d.ts +1 -1
- package/dist/models/get-events-response.js +1 -1
- package/dist/models/get-exchange-announcements-response.d.ts +1 -1
- package/dist/models/get-exchange-announcements-response.js +1 -1
- package/dist/models/get-exchange-schedule-response.d.ts +1 -1
- package/dist/models/get-exchange-schedule-response.js +1 -1
- package/dist/models/get-fills-response.d.ts +1 -1
- package/dist/models/get-fills-response.js +1 -1
- package/dist/models/get-filters-by-sports-response.d.ts +1 -1
- package/dist/models/get-filters-by-sports-response.js +1 -1
- package/dist/models/get-incentive-programs-response.d.ts +1 -1
- package/dist/models/get-incentive-programs-response.js +1 -1
- package/dist/models/get-live-data-response.d.ts +1 -1
- package/dist/models/get-live-data-response.js +1 -1
- package/dist/models/get-live-datas-response.d.ts +1 -1
- package/dist/models/get-live-datas-response.js +1 -1
- package/dist/models/get-market-candlesticks-response.d.ts +1 -1
- package/dist/models/get-market-candlesticks-response.js +1 -1
- package/dist/models/get-market-orderbook-response.d.ts +3 -1
- package/dist/models/get-market-orderbook-response.js +1 -1
- package/dist/models/get-market-response.d.ts +1 -1
- package/dist/models/get-market-response.js +1 -1
- package/dist/models/get-markets-response.d.ts +1 -1
- package/dist/models/get-markets-response.js +1 -1
- package/dist/models/get-milestone-response.d.ts +1 -1
- package/dist/models/get-milestone-response.js +1 -1
- package/dist/models/get-milestones-response.d.ts +1 -1
- package/dist/models/get-milestones-response.js +1 -1
- package/dist/models/get-multivariate-event-collection-lookup-history-response.d.ts +1 -1
- package/dist/models/get-multivariate-event-collection-lookup-history-response.js +1 -1
- package/dist/models/get-multivariate-event-collection-response.d.ts +1 -1
- package/dist/models/get-multivariate-event-collection-response.js +1 -1
- package/dist/models/get-multivariate-event-collections-response.d.ts +1 -1
- package/dist/models/get-multivariate-event-collections-response.js +1 -1
- package/dist/models/get-multivariate-events-response.d.ts +1 -1
- package/dist/models/get-multivariate-events-response.js +1 -1
- package/dist/models/get-order-group-response.d.ts +9 -1
- package/dist/models/get-order-group-response.js +1 -1
- package/dist/models/get-order-groups-response.d.ts +1 -1
- package/dist/models/get-order-groups-response.js +1 -1
- package/dist/models/get-order-queue-position-response.d.ts +1 -1
- package/dist/models/get-order-queue-position-response.js +1 -1
- package/dist/models/get-order-queue-positions-response.d.ts +1 -1
- package/dist/models/get-order-queue-positions-response.js +1 -1
- package/dist/models/get-order-response.d.ts +1 -1
- package/dist/models/get-order-response.js +1 -1
- package/dist/models/get-orders-response.d.ts +1 -1
- package/dist/models/get-orders-response.js +1 -1
- package/dist/models/get-portfolio-resting-order-total-value-response.d.ts +1 -1
- package/dist/models/get-portfolio-resting-order-total-value-response.js +1 -1
- package/dist/models/get-positions-response.d.ts +1 -1
- package/dist/models/get-positions-response.js +1 -1
- package/dist/models/get-quote-response.d.ts +1 -1
- package/dist/models/get-quote-response.js +1 -1
- package/dist/models/get-quotes-response.d.ts +1 -1
- package/dist/models/get-quotes-response.js +1 -1
- package/dist/models/get-rfqresponse.d.ts +1 -1
- package/dist/models/get-rfqresponse.js +1 -1
- package/dist/models/get-rfqs-response.d.ts +1 -1
- package/dist/models/get-rfqs-response.js +1 -1
- package/dist/models/get-series-fee-changes-response.d.ts +1 -1
- package/dist/models/get-series-fee-changes-response.js +1 -1
- package/dist/models/get-series-list-response.d.ts +1 -1
- package/dist/models/get-series-list-response.js +1 -1
- package/dist/models/get-series-response.d.ts +1 -1
- package/dist/models/get-series-response.js +1 -1
- package/dist/models/get-settlements-response.d.ts +1 -1
- package/dist/models/get-settlements-response.js +1 -1
- package/dist/models/get-structured-target-response.d.ts +1 -1
- package/dist/models/get-structured-target-response.js +1 -1
- package/dist/models/get-structured-targets-response.d.ts +1 -1
- package/dist/models/get-structured-targets-response.js +1 -1
- package/dist/models/get-subaccount-balance-response.d.ts +21 -0
- package/dist/models/get-subaccount-balance-response.js +15 -0
- package/dist/models/get-subaccount-balances-response.d.ts +15 -0
- package/dist/models/get-subaccount-balances-response.js +15 -0
- package/dist/models/get-subaccount-transfers-response.d.ts +19 -0
- package/dist/models/get-subaccount-transfers-response.js +15 -0
- package/dist/models/get-tags-for-series-categories-response.d.ts +1 -1
- package/dist/models/get-tags-for-series-categories-response.js +1 -1
- package/dist/models/get-trades-response.d.ts +1 -1
- package/dist/models/get-trades-response.js +1 -1
- package/dist/models/get-user-data-timestamp-response.d.ts +1 -1
- package/dist/models/get-user-data-timestamp-response.js +1 -1
- package/dist/models/incentive-program.d.ts +5 -1
- package/dist/models/incentive-program.js +1 -1
- package/dist/models/index.d.ts +10 -0
- package/dist/models/index.js +10 -0
- package/dist/models/intra-exchange-instance-transfer-request.d.ts +9 -1
- package/dist/models/intra-exchange-instance-transfer-request.js +1 -1
- package/dist/models/intra-exchange-instance-transfer-response.d.ts +1 -1
- package/dist/models/intra-exchange-instance-transfer-response.js +1 -1
- package/dist/models/live-data.d.ts +1 -1
- package/dist/models/live-data.js +1 -1
- package/dist/models/lookup-point.d.ts +1 -1
- package/dist/models/lookup-point.js +1 -1
- package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-request.d.ts +1 -1
- package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-request.js +1 -1
- package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-response.d.ts +1 -1
- package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-response.js +1 -1
- package/dist/models/maintenance-window.d.ts +1 -1
- package/dist/models/maintenance-window.js +1 -1
- package/dist/models/market-candlestick.d.ts +9 -1
- package/dist/models/market-candlestick.js +1 -1
- package/dist/models/market-candlesticks-response.d.ts +1 -1
- package/dist/models/market-candlesticks-response.js +1 -1
- package/dist/models/market-metadata.d.ts +1 -1
- package/dist/models/market-metadata.js +1 -1
- package/dist/models/market-position.d.ts +5 -1
- package/dist/models/market-position.js +1 -1
- package/dist/models/market.d.ts +22 -1
- package/dist/models/market.js +2 -1
- package/dist/models/milestone.d.ts +1 -1
- package/dist/models/milestone.js +1 -1
- package/dist/models/multivariate-event-collection.d.ts +1 -1
- package/dist/models/multivariate-event-collection.js +1 -1
- package/dist/models/mve-selected-leg.d.ts +5 -1
- package/dist/models/mve-selected-leg.js +1 -1
- package/dist/models/order-group.d.ts +9 -1
- package/dist/models/order-group.js +1 -1
- package/dist/models/order-queue-position.d.ts +1 -1
- package/dist/models/order-queue-position.js +1 -1
- package/dist/models/order-status.d.ts +1 -1
- package/dist/models/order-status.js +1 -1
- package/dist/models/order.d.ts +13 -1
- package/dist/models/order.js +1 -1
- package/dist/models/orderbook-count-fp.d.ts +18 -0
- package/dist/models/orderbook-count-fp.js +15 -0
- package/dist/models/orderbook-level-count-fp-inner.d.ts +15 -0
- package/dist/models/orderbook-level-count-fp-inner.js +15 -0
- package/dist/models/orderbook.d.ts +4 -1
- package/dist/models/orderbook.js +1 -1
- package/dist/models/percentile-point.d.ts +1 -1
- package/dist/models/percentile-point.js +1 -1
- package/dist/models/price-distribution.d.ts +1 -1
- package/dist/models/price-distribution.js +1 -1
- package/dist/models/price-level-count-fp-inner.d.ts +15 -0
- package/dist/models/price-level-count-fp-inner.js +15 -0
- package/dist/models/price-level-dollars-inner.d.ts +15 -0
- package/dist/models/price-level-dollars-inner.js +15 -0
- package/dist/models/price-range.d.ts +1 -1
- package/dist/models/price-range.js +1 -1
- package/dist/models/quote.d.ts +5 -1
- package/dist/models/quote.js +1 -1
- package/dist/models/rfq.d.ts +6 -2
- package/dist/models/rfq.js +1 -1
- package/dist/models/schedule.d.ts +1 -1
- package/dist/models/schedule.js +1 -1
- package/dist/models/scope-list.d.ts +1 -1
- package/dist/models/scope-list.js +1 -1
- package/dist/models/self-trade-prevention-type.d.ts +1 -1
- package/dist/models/self-trade-prevention-type.js +1 -1
- package/dist/models/series-fee-change.d.ts +1 -1
- package/dist/models/series-fee-change.js +1 -1
- package/dist/models/series.d.ts +9 -1
- package/dist/models/series.js +1 -1
- package/dist/models/settlement-source.d.ts +1 -1
- package/dist/models/settlement-source.js +1 -1
- package/dist/models/settlement.d.ts +10 -2
- package/dist/models/settlement.js +1 -1
- package/dist/models/sport-filter-details.d.ts +1 -1
- package/dist/models/sport-filter-details.js +1 -1
- package/dist/models/structured-target.d.ts +1 -1
- package/dist/models/structured-target.js +1 -1
- package/dist/models/subaccount-balance.d.ts +25 -0
- package/dist/models/subaccount-balance.js +15 -0
- package/dist/models/subaccount-transfer.d.ts +33 -0
- package/dist/models/subaccount-transfer.js +15 -0
- package/dist/models/ticker-pair.d.ts +1 -1
- package/dist/models/ticker-pair.js +1 -1
- package/dist/models/trade.d.ts +5 -1
- package/dist/models/trade.js +1 -1
- package/dist/models/transfer-between-subaccounts-request.d.ts +25 -0
- package/dist/models/transfer-between-subaccounts-request.js +15 -0
- package/dist/models/update-order-group-limit-request.d.ts +21 -0
- package/dist/models/update-order-group-limit-request.js +15 -0
- package/dist/models/weekly-schedule.d.ts +1 -1
- package/dist/models/weekly-schedule.js +1 -1
- package/package.json +1 -1
package/dist/api/market-api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Kalshi Trade API Manual Endpoints
|
|
6
6
|
* Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 3.
|
|
8
|
+
* The version of the OpenAPI document: 3.6.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -127,10 +127,11 @@ const MarketApiAxiosParamCreator = function (configuration) {
|
|
|
127
127
|
* @param {number} startTs Start timestamp (Unix timestamp). Candlesticks will include those ending on or after this time.
|
|
128
128
|
* @param {number} endTs End timestamp (Unix timestamp). Candlesticks will include those ending on or before this time.
|
|
129
129
|
* @param {GetMarketCandlesticksPeriodIntervalEnum} periodInterval Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day).
|
|
130
|
+
* @param {boolean} [includeLatestBeforeStart] If true, prepends the latest candlestick available before the start_ts. This synthetic candlestick is created by: 1. Finding the most recent real candlestick before start_ts 2. Projecting it forward to the first period boundary (calculated as the next period interval after start_ts) 3. Setting all OHLC prices to null, and `previous_price` to the close price from the real candlestick
|
|
130
131
|
* @param {*} [options] Override http request option.
|
|
131
132
|
* @throws {RequiredError}
|
|
132
133
|
*/
|
|
133
|
-
getMarketCandlesticks: (seriesTicker_1, ticker_1, startTs_1, endTs_1, periodInterval_1, ...args_1) => __awaiter(this, [seriesTicker_1, ticker_1, startTs_1, endTs_1, periodInterval_1, ...args_1], void 0, function* (seriesTicker, ticker, startTs, endTs, periodInterval, options = {}) {
|
|
134
|
+
getMarketCandlesticks: (seriesTicker_1, ticker_1, startTs_1, endTs_1, periodInterval_1, includeLatestBeforeStart_1, ...args_1) => __awaiter(this, [seriesTicker_1, ticker_1, startTs_1, endTs_1, periodInterval_1, includeLatestBeforeStart_1, ...args_1], void 0, function* (seriesTicker, ticker, startTs, endTs, periodInterval, includeLatestBeforeStart, options = {}) {
|
|
134
135
|
// verify required parameter 'seriesTicker' is not null or undefined
|
|
135
136
|
(0, common_1.assertParamExists)('getMarketCandlesticks', 'seriesTicker', seriesTicker);
|
|
136
137
|
// verify required parameter 'ticker' is not null or undefined
|
|
@@ -162,6 +163,9 @@ const MarketApiAxiosParamCreator = function (configuration) {
|
|
|
162
163
|
if (periodInterval !== undefined) {
|
|
163
164
|
localVarQueryParameter['period_interval'] = periodInterval;
|
|
164
165
|
}
|
|
166
|
+
if (includeLatestBeforeStart !== undefined) {
|
|
167
|
+
localVarQueryParameter['include_latest_before_start'] = includeLatestBeforeStart;
|
|
168
|
+
}
|
|
165
169
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
166
170
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
167
171
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -210,7 +214,7 @@ const MarketApiAxiosParamCreator = function (configuration) {
|
|
|
210
214
|
};
|
|
211
215
|
}),
|
|
212
216
|
/**
|
|
213
|
-
* Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled`. Leave empty to return markets with any status. - Only one `status` filter may be supplied at a time. - Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters. | Compatible Timestamp Filters | Additional Status Filters|
|
|
217
|
+
* Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled`. Leave empty to return markets with any status. - Only one `status` filter may be supplied at a time. - Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters. | Compatible Timestamp Filters | Additional Status Filters| Extra Notes | |------------------------------|--------------------------|-------------| | min_created_ts, max_created_ts | `unopened`, `open`, *empty* | | | min_close_ts, max_close_ts | `closed`, *empty* | | | min_settled_ts, max_settled_ts | `settled`, *empty* | | | min_updated_ts | *empty* | Incompatible with all filters besides `mve_filter=exclude` |
|
|
214
218
|
* @summary Get Markets
|
|
215
219
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
|
|
216
220
|
* @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
|
|
@@ -218,6 +222,7 @@ const MarketApiAxiosParamCreator = function (configuration) {
|
|
|
218
222
|
* @param {string} [seriesTicker] Filter by series ticker
|
|
219
223
|
* @param {number} [minCreatedTs] Filter items that created after this Unix timestamp
|
|
220
224
|
* @param {number} [maxCreatedTs] Filter items that created before this Unix timestamp
|
|
225
|
+
* @param {number} [minUpdatedTs] Return markets updated later than this Unix timestamp. Incompatible with any other filters.
|
|
221
226
|
* @param {number} [maxCloseTs] Filter items that close before this Unix timestamp
|
|
222
227
|
* @param {number} [minCloseTs] Filter items that close after this Unix timestamp
|
|
223
228
|
* @param {number} [minSettledTs] Filter items that settled after this Unix timestamp
|
|
@@ -228,7 +233,7 @@ const MarketApiAxiosParamCreator = function (configuration) {
|
|
|
228
233
|
* @param {*} [options] Override http request option.
|
|
229
234
|
* @throws {RequiredError}
|
|
230
235
|
*/
|
|
231
|
-
getMarkets: (limit_1, cursor_1, eventTicker_1, seriesTicker_1, minCreatedTs_1, maxCreatedTs_1, maxCloseTs_1, minCloseTs_1, minSettledTs_1, maxSettledTs_1, status_1, tickers_1, mveFilter_1, ...args_1) => __awaiter(this, [limit_1, cursor_1, eventTicker_1, seriesTicker_1, minCreatedTs_1, maxCreatedTs_1, maxCloseTs_1, minCloseTs_1, minSettledTs_1, maxSettledTs_1, status_1, tickers_1, mveFilter_1, ...args_1], void 0, function* (limit, cursor, eventTicker, seriesTicker, minCreatedTs, maxCreatedTs, maxCloseTs, minCloseTs, minSettledTs, maxSettledTs, status, tickers, mveFilter, options = {}) {
|
|
236
|
+
getMarkets: (limit_1, cursor_1, eventTicker_1, seriesTicker_1, minCreatedTs_1, maxCreatedTs_1, minUpdatedTs_1, maxCloseTs_1, minCloseTs_1, minSettledTs_1, maxSettledTs_1, status_1, tickers_1, mveFilter_1, ...args_1) => __awaiter(this, [limit_1, cursor_1, eventTicker_1, seriesTicker_1, minCreatedTs_1, maxCreatedTs_1, minUpdatedTs_1, maxCloseTs_1, minCloseTs_1, minSettledTs_1, maxSettledTs_1, status_1, tickers_1, mveFilter_1, ...args_1], void 0, function* (limit, cursor, eventTicker, seriesTicker, minCreatedTs, maxCreatedTs, minUpdatedTs, maxCloseTs, minCloseTs, minSettledTs, maxSettledTs, status, tickers, mveFilter, options = {}) {
|
|
232
237
|
const localVarPath = `/markets`;
|
|
233
238
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
234
239
|
const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -257,6 +262,9 @@ const MarketApiAxiosParamCreator = function (configuration) {
|
|
|
257
262
|
if (maxCreatedTs !== undefined) {
|
|
258
263
|
localVarQueryParameter['max_created_ts'] = maxCreatedTs;
|
|
259
264
|
}
|
|
265
|
+
if (minUpdatedTs !== undefined) {
|
|
266
|
+
localVarQueryParameter['min_updated_ts'] = minUpdatedTs;
|
|
267
|
+
}
|
|
260
268
|
if (maxCloseTs !== undefined) {
|
|
261
269
|
localVarQueryParameter['max_close_ts'] = maxCloseTs;
|
|
262
270
|
}
|
|
@@ -290,10 +298,11 @@ const MarketApiAxiosParamCreator = function (configuration) {
|
|
|
290
298
|
* Endpoint for getting data about a specific series by its ticker. A series represents a template for recurring events that follow the same format and rules (e.g., \"Monthly Jobs Report\", \"Weekly Initial Jobless Claims\", \"Daily Weather in NYC\"). Series define the structure, settlement sources, and metadata that will be applied to each recurring event instance within that series.
|
|
291
299
|
* @summary Get Series
|
|
292
300
|
* @param {string} seriesTicker The ticker of the series to retrieve
|
|
301
|
+
* @param {boolean} [includeVolume] If true, includes the total volume traded across all events in this series.
|
|
293
302
|
* @param {*} [options] Override http request option.
|
|
294
303
|
* @throws {RequiredError}
|
|
295
304
|
*/
|
|
296
|
-
getSeries: (seriesTicker_1, ...args_1) => __awaiter(this, [seriesTicker_1, ...args_1], void 0, function* (seriesTicker, options = {}) {
|
|
305
|
+
getSeries: (seriesTicker_1, includeVolume_1, ...args_1) => __awaiter(this, [seriesTicker_1, includeVolume_1, ...args_1], void 0, function* (seriesTicker, includeVolume, options = {}) {
|
|
297
306
|
// verify required parameter 'seriesTicker' is not null or undefined
|
|
298
307
|
(0, common_1.assertParamExists)('getSeries', 'seriesTicker', seriesTicker);
|
|
299
308
|
const localVarPath = `/series/{series_ticker}`
|
|
@@ -307,6 +316,9 @@ const MarketApiAxiosParamCreator = function (configuration) {
|
|
|
307
316
|
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
308
317
|
const localVarHeaderParameter = {};
|
|
309
318
|
const localVarQueryParameter = {};
|
|
319
|
+
if (includeVolume !== undefined) {
|
|
320
|
+
localVarQueryParameter['include_volume'] = includeVolume;
|
|
321
|
+
}
|
|
310
322
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
311
323
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
312
324
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -321,10 +333,11 @@ const MarketApiAxiosParamCreator = function (configuration) {
|
|
|
321
333
|
* @param {string} [category]
|
|
322
334
|
* @param {string} [tags]
|
|
323
335
|
* @param {boolean} [includeProductMetadata]
|
|
336
|
+
* @param {boolean} [includeVolume] If true, includes the total volume traded across all events in each series.
|
|
324
337
|
* @param {*} [options] Override http request option.
|
|
325
338
|
* @throws {RequiredError}
|
|
326
339
|
*/
|
|
327
|
-
getSeriesList: (category_1, tags_1, includeProductMetadata_1, ...args_1) => __awaiter(this, [category_1, tags_1, includeProductMetadata_1, ...args_1], void 0, function* (category, tags, includeProductMetadata, options = {}) {
|
|
340
|
+
getSeriesList: (category_1, tags_1, includeProductMetadata_1, includeVolume_1, ...args_1) => __awaiter(this, [category_1, tags_1, includeProductMetadata_1, includeVolume_1, ...args_1], void 0, function* (category, tags, includeProductMetadata, includeVolume, options = {}) {
|
|
328
341
|
const localVarPath = `/series`;
|
|
329
342
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
330
343
|
const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -344,6 +357,9 @@ const MarketApiAxiosParamCreator = function (configuration) {
|
|
|
344
357
|
if (includeProductMetadata !== undefined) {
|
|
345
358
|
localVarQueryParameter['include_product_metadata'] = includeProductMetadata;
|
|
346
359
|
}
|
|
360
|
+
if (includeVolume !== undefined) {
|
|
361
|
+
localVarQueryParameter['include_volume'] = includeVolume;
|
|
362
|
+
}
|
|
347
363
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
348
364
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
349
365
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -450,13 +466,14 @@ const MarketApiFp = function (configuration) {
|
|
|
450
466
|
* @param {number} startTs Start timestamp (Unix timestamp). Candlesticks will include those ending on or after this time.
|
|
451
467
|
* @param {number} endTs End timestamp (Unix timestamp). Candlesticks will include those ending on or before this time.
|
|
452
468
|
* @param {GetMarketCandlesticksPeriodIntervalEnum} periodInterval Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day).
|
|
469
|
+
* @param {boolean} [includeLatestBeforeStart] If true, prepends the latest candlestick available before the start_ts. This synthetic candlestick is created by: 1. Finding the most recent real candlestick before start_ts 2. Projecting it forward to the first period boundary (calculated as the next period interval after start_ts) 3. Setting all OHLC prices to null, and `previous_price` to the close price from the real candlestick
|
|
453
470
|
* @param {*} [options] Override http request option.
|
|
454
471
|
* @throws {RequiredError}
|
|
455
472
|
*/
|
|
456
|
-
getMarketCandlesticks(seriesTicker, ticker, startTs, endTs, periodInterval, options) {
|
|
473
|
+
getMarketCandlesticks(seriesTicker, ticker, startTs, endTs, periodInterval, includeLatestBeforeStart, options) {
|
|
457
474
|
return __awaiter(this, void 0, void 0, function* () {
|
|
458
475
|
var _a;
|
|
459
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getMarketCandlesticks(seriesTicker, ticker, startTs, endTs, periodInterval, options);
|
|
476
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getMarketCandlesticks(seriesTicker, ticker, startTs, endTs, periodInterval, includeLatestBeforeStart, options);
|
|
460
477
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
461
478
|
const localVarOperationServerBasePath = undefined;
|
|
462
479
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -480,7 +497,7 @@ const MarketApiFp = function (configuration) {
|
|
|
480
497
|
});
|
|
481
498
|
},
|
|
482
499
|
/**
|
|
483
|
-
* Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled`. Leave empty to return markets with any status. - Only one `status` filter may be supplied at a time. - Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters. | Compatible Timestamp Filters | Additional Status Filters|
|
|
500
|
+
* Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled`. Leave empty to return markets with any status. - Only one `status` filter may be supplied at a time. - Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters. | Compatible Timestamp Filters | Additional Status Filters| Extra Notes | |------------------------------|--------------------------|-------------| | min_created_ts, max_created_ts | `unopened`, `open`, *empty* | | | min_close_ts, max_close_ts | `closed`, *empty* | | | min_settled_ts, max_settled_ts | `settled`, *empty* | | | min_updated_ts | *empty* | Incompatible with all filters besides `mve_filter=exclude` |
|
|
484
501
|
* @summary Get Markets
|
|
485
502
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
|
|
486
503
|
* @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
|
|
@@ -488,6 +505,7 @@ const MarketApiFp = function (configuration) {
|
|
|
488
505
|
* @param {string} [seriesTicker] Filter by series ticker
|
|
489
506
|
* @param {number} [minCreatedTs] Filter items that created after this Unix timestamp
|
|
490
507
|
* @param {number} [maxCreatedTs] Filter items that created before this Unix timestamp
|
|
508
|
+
* @param {number} [minUpdatedTs] Return markets updated later than this Unix timestamp. Incompatible with any other filters.
|
|
491
509
|
* @param {number} [maxCloseTs] Filter items that close before this Unix timestamp
|
|
492
510
|
* @param {number} [minCloseTs] Filter items that close after this Unix timestamp
|
|
493
511
|
* @param {number} [minSettledTs] Filter items that settled after this Unix timestamp
|
|
@@ -498,10 +516,10 @@ const MarketApiFp = function (configuration) {
|
|
|
498
516
|
* @param {*} [options] Override http request option.
|
|
499
517
|
* @throws {RequiredError}
|
|
500
518
|
*/
|
|
501
|
-
getMarkets(limit, cursor, eventTicker, seriesTicker, minCreatedTs, maxCreatedTs, maxCloseTs, minCloseTs, minSettledTs, maxSettledTs, status, tickers, mveFilter, options) {
|
|
519
|
+
getMarkets(limit, cursor, eventTicker, seriesTicker, minCreatedTs, maxCreatedTs, minUpdatedTs, maxCloseTs, minCloseTs, minSettledTs, maxSettledTs, status, tickers, mveFilter, options) {
|
|
502
520
|
return __awaiter(this, void 0, void 0, function* () {
|
|
503
521
|
var _a;
|
|
504
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getMarkets(limit, cursor, eventTicker, seriesTicker, minCreatedTs, maxCreatedTs, maxCloseTs, minCloseTs, minSettledTs, maxSettledTs, status, tickers, mveFilter, options);
|
|
522
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getMarkets(limit, cursor, eventTicker, seriesTicker, minCreatedTs, maxCreatedTs, minUpdatedTs, maxCloseTs, minCloseTs, minSettledTs, maxSettledTs, status, tickers, mveFilter, options);
|
|
505
523
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
506
524
|
const localVarOperationServerBasePath = undefined;
|
|
507
525
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -511,13 +529,14 @@ const MarketApiFp = function (configuration) {
|
|
|
511
529
|
* Endpoint for getting data about a specific series by its ticker. A series represents a template for recurring events that follow the same format and rules (e.g., \"Monthly Jobs Report\", \"Weekly Initial Jobless Claims\", \"Daily Weather in NYC\"). Series define the structure, settlement sources, and metadata that will be applied to each recurring event instance within that series.
|
|
512
530
|
* @summary Get Series
|
|
513
531
|
* @param {string} seriesTicker The ticker of the series to retrieve
|
|
532
|
+
* @param {boolean} [includeVolume] If true, includes the total volume traded across all events in this series.
|
|
514
533
|
* @param {*} [options] Override http request option.
|
|
515
534
|
* @throws {RequiredError}
|
|
516
535
|
*/
|
|
517
|
-
getSeries(seriesTicker, options) {
|
|
536
|
+
getSeries(seriesTicker, includeVolume, options) {
|
|
518
537
|
return __awaiter(this, void 0, void 0, function* () {
|
|
519
538
|
var _a;
|
|
520
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getSeries(seriesTicker, options);
|
|
539
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getSeries(seriesTicker, includeVolume, options);
|
|
521
540
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
522
541
|
const localVarOperationServerBasePath = undefined;
|
|
523
542
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -529,13 +548,14 @@ const MarketApiFp = function (configuration) {
|
|
|
529
548
|
* @param {string} [category]
|
|
530
549
|
* @param {string} [tags]
|
|
531
550
|
* @param {boolean} [includeProductMetadata]
|
|
551
|
+
* @param {boolean} [includeVolume] If true, includes the total volume traded across all events in each series.
|
|
532
552
|
* @param {*} [options] Override http request option.
|
|
533
553
|
* @throws {RequiredError}
|
|
534
554
|
*/
|
|
535
|
-
getSeriesList(category, tags, includeProductMetadata, options) {
|
|
555
|
+
getSeriesList(category, tags, includeProductMetadata, includeVolume, options) {
|
|
536
556
|
return __awaiter(this, void 0, void 0, function* () {
|
|
537
557
|
var _a;
|
|
538
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getSeriesList(category, tags, includeProductMetadata, options);
|
|
558
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getSeriesList(category, tags, includeProductMetadata, includeVolume, options);
|
|
539
559
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
540
560
|
const localVarOperationServerBasePath = undefined;
|
|
541
561
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -602,11 +622,12 @@ const MarketApiFactory = function (configuration, basePath, axios) {
|
|
|
602
622
|
* @param {number} startTs Start timestamp (Unix timestamp). Candlesticks will include those ending on or after this time.
|
|
603
623
|
* @param {number} endTs End timestamp (Unix timestamp). Candlesticks will include those ending on or before this time.
|
|
604
624
|
* @param {GetMarketCandlesticksPeriodIntervalEnum} periodInterval Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day).
|
|
625
|
+
* @param {boolean} [includeLatestBeforeStart] If true, prepends the latest candlestick available before the start_ts. This synthetic candlestick is created by: 1. Finding the most recent real candlestick before start_ts 2. Projecting it forward to the first period boundary (calculated as the next period interval after start_ts) 3. Setting all OHLC prices to null, and `previous_price` to the close price from the real candlestick
|
|
605
626
|
* @param {*} [options] Override http request option.
|
|
606
627
|
* @throws {RequiredError}
|
|
607
628
|
*/
|
|
608
|
-
getMarketCandlesticks(seriesTicker, ticker, startTs, endTs, periodInterval, options) {
|
|
609
|
-
return localVarFp.getMarketCandlesticks(seriesTicker, ticker, startTs, endTs, periodInterval, options).then((request) => request(axios, basePath));
|
|
629
|
+
getMarketCandlesticks(seriesTicker, ticker, startTs, endTs, periodInterval, includeLatestBeforeStart, options) {
|
|
630
|
+
return localVarFp.getMarketCandlesticks(seriesTicker, ticker, startTs, endTs, periodInterval, includeLatestBeforeStart, options).then((request) => request(axios, basePath));
|
|
610
631
|
},
|
|
611
632
|
/**
|
|
612
633
|
* Endpoint for getting the current order book for a specific market. The order book shows all active bid orders for both yes and no sides of a binary market. It returns yes bids and no bids only (no asks are returned). This is because in binary markets, a bid for yes at price X is equivalent to an ask for no at price (100-X). For example, a yes bid at 7¢ is the same as a no ask at 93¢, with identical contract sizes. Each side shows price levels with their corresponding quantities and order counts, organized from best to worst prices.
|
|
@@ -620,7 +641,7 @@ const MarketApiFactory = function (configuration, basePath, axios) {
|
|
|
620
641
|
return localVarFp.getMarketOrderbook(ticker, depth, options).then((request) => request(axios, basePath));
|
|
621
642
|
},
|
|
622
643
|
/**
|
|
623
|
-
* Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled`. Leave empty to return markets with any status. - Only one `status` filter may be supplied at a time. - Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters. | Compatible Timestamp Filters | Additional Status Filters|
|
|
644
|
+
* Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled`. Leave empty to return markets with any status. - Only one `status` filter may be supplied at a time. - Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters. | Compatible Timestamp Filters | Additional Status Filters| Extra Notes | |------------------------------|--------------------------|-------------| | min_created_ts, max_created_ts | `unopened`, `open`, *empty* | | | min_close_ts, max_close_ts | `closed`, *empty* | | | min_settled_ts, max_settled_ts | `settled`, *empty* | | | min_updated_ts | *empty* | Incompatible with all filters besides `mve_filter=exclude` |
|
|
624
645
|
* @summary Get Markets
|
|
625
646
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
|
|
626
647
|
* @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
|
|
@@ -628,6 +649,7 @@ const MarketApiFactory = function (configuration, basePath, axios) {
|
|
|
628
649
|
* @param {string} [seriesTicker] Filter by series ticker
|
|
629
650
|
* @param {number} [minCreatedTs] Filter items that created after this Unix timestamp
|
|
630
651
|
* @param {number} [maxCreatedTs] Filter items that created before this Unix timestamp
|
|
652
|
+
* @param {number} [minUpdatedTs] Return markets updated later than this Unix timestamp. Incompatible with any other filters.
|
|
631
653
|
* @param {number} [maxCloseTs] Filter items that close before this Unix timestamp
|
|
632
654
|
* @param {number} [minCloseTs] Filter items that close after this Unix timestamp
|
|
633
655
|
* @param {number} [minSettledTs] Filter items that settled after this Unix timestamp
|
|
@@ -638,18 +660,19 @@ const MarketApiFactory = function (configuration, basePath, axios) {
|
|
|
638
660
|
* @param {*} [options] Override http request option.
|
|
639
661
|
* @throws {RequiredError}
|
|
640
662
|
*/
|
|
641
|
-
getMarkets(limit, cursor, eventTicker, seriesTicker, minCreatedTs, maxCreatedTs, maxCloseTs, minCloseTs, minSettledTs, maxSettledTs, status, tickers, mveFilter, options) {
|
|
642
|
-
return localVarFp.getMarkets(limit, cursor, eventTicker, seriesTicker, minCreatedTs, maxCreatedTs, maxCloseTs, minCloseTs, minSettledTs, maxSettledTs, status, tickers, mveFilter, options).then((request) => request(axios, basePath));
|
|
663
|
+
getMarkets(limit, cursor, eventTicker, seriesTicker, minCreatedTs, maxCreatedTs, minUpdatedTs, maxCloseTs, minCloseTs, minSettledTs, maxSettledTs, status, tickers, mveFilter, options) {
|
|
664
|
+
return localVarFp.getMarkets(limit, cursor, eventTicker, seriesTicker, minCreatedTs, maxCreatedTs, minUpdatedTs, maxCloseTs, minCloseTs, minSettledTs, maxSettledTs, status, tickers, mveFilter, options).then((request) => request(axios, basePath));
|
|
643
665
|
},
|
|
644
666
|
/**
|
|
645
667
|
* Endpoint for getting data about a specific series by its ticker. A series represents a template for recurring events that follow the same format and rules (e.g., \"Monthly Jobs Report\", \"Weekly Initial Jobless Claims\", \"Daily Weather in NYC\"). Series define the structure, settlement sources, and metadata that will be applied to each recurring event instance within that series.
|
|
646
668
|
* @summary Get Series
|
|
647
669
|
* @param {string} seriesTicker The ticker of the series to retrieve
|
|
670
|
+
* @param {boolean} [includeVolume] If true, includes the total volume traded across all events in this series.
|
|
648
671
|
* @param {*} [options] Override http request option.
|
|
649
672
|
* @throws {RequiredError}
|
|
650
673
|
*/
|
|
651
|
-
getSeries(seriesTicker, options) {
|
|
652
|
-
return localVarFp.getSeries(seriesTicker, options).then((request) => request(axios, basePath));
|
|
674
|
+
getSeries(seriesTicker, includeVolume, options) {
|
|
675
|
+
return localVarFp.getSeries(seriesTicker, includeVolume, options).then((request) => request(axios, basePath));
|
|
653
676
|
},
|
|
654
677
|
/**
|
|
655
678
|
* Endpoint for getting data about multiple series with specified filters. A series represents a template for recurring events that follow the same format and rules (e.g., \"Monthly Jobs Report\", \"Weekly Initial Jobless Claims\", \"Daily Weather in NYC\"). This endpoint allows you to browse and discover available series templates by category.
|
|
@@ -657,11 +680,12 @@ const MarketApiFactory = function (configuration, basePath, axios) {
|
|
|
657
680
|
* @param {string} [category]
|
|
658
681
|
* @param {string} [tags]
|
|
659
682
|
* @param {boolean} [includeProductMetadata]
|
|
683
|
+
* @param {boolean} [includeVolume] If true, includes the total volume traded across all events in each series.
|
|
660
684
|
* @param {*} [options] Override http request option.
|
|
661
685
|
* @throws {RequiredError}
|
|
662
686
|
*/
|
|
663
|
-
getSeriesList(category, tags, includeProductMetadata, options) {
|
|
664
|
-
return localVarFp.getSeriesList(category, tags, includeProductMetadata, options).then((request) => request(axios, basePath));
|
|
687
|
+
getSeriesList(category, tags, includeProductMetadata, includeVolume, options) {
|
|
688
|
+
return localVarFp.getSeriesList(category, tags, includeProductMetadata, includeVolume, options).then((request) => request(axios, basePath));
|
|
665
689
|
},
|
|
666
690
|
/**
|
|
667
691
|
* Endpoint for getting all trades for all markets. A trade represents a completed transaction between two users on a specific market. Each trade includes the market ticker, price, quantity, and timestamp information. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
|
|
@@ -716,11 +740,12 @@ class MarketApi extends base_1.BaseAPI {
|
|
|
716
740
|
* @param {number} startTs Start timestamp (Unix timestamp). Candlesticks will include those ending on or after this time.
|
|
717
741
|
* @param {number} endTs End timestamp (Unix timestamp). Candlesticks will include those ending on or before this time.
|
|
718
742
|
* @param {GetMarketCandlesticksPeriodIntervalEnum} periodInterval Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day).
|
|
743
|
+
* @param {boolean} [includeLatestBeforeStart] If true, prepends the latest candlestick available before the start_ts. This synthetic candlestick is created by: 1. Finding the most recent real candlestick before start_ts 2. Projecting it forward to the first period boundary (calculated as the next period interval after start_ts) 3. Setting all OHLC prices to null, and `previous_price` to the close price from the real candlestick
|
|
719
744
|
* @param {*} [options] Override http request option.
|
|
720
745
|
* @throws {RequiredError}
|
|
721
746
|
*/
|
|
722
|
-
getMarketCandlesticks(seriesTicker, ticker, startTs, endTs, periodInterval, options) {
|
|
723
|
-
return (0, exports.MarketApiFp)(this.configuration).getMarketCandlesticks(seriesTicker, ticker, startTs, endTs, periodInterval, options).then((request) => request(this.axios, this.basePath));
|
|
747
|
+
getMarketCandlesticks(seriesTicker, ticker, startTs, endTs, periodInterval, includeLatestBeforeStart, options) {
|
|
748
|
+
return (0, exports.MarketApiFp)(this.configuration).getMarketCandlesticks(seriesTicker, ticker, startTs, endTs, periodInterval, includeLatestBeforeStart, options).then((request) => request(this.axios, this.basePath));
|
|
724
749
|
}
|
|
725
750
|
/**
|
|
726
751
|
* Endpoint for getting the current order book for a specific market. The order book shows all active bid orders for both yes and no sides of a binary market. It returns yes bids and no bids only (no asks are returned). This is because in binary markets, a bid for yes at price X is equivalent to an ask for no at price (100-X). For example, a yes bid at 7¢ is the same as a no ask at 93¢, with identical contract sizes. Each side shows price levels with their corresponding quantities and order counts, organized from best to worst prices.
|
|
@@ -734,7 +759,7 @@ class MarketApi extends base_1.BaseAPI {
|
|
|
734
759
|
return (0, exports.MarketApiFp)(this.configuration).getMarketOrderbook(ticker, depth, options).then((request) => request(this.axios, this.basePath));
|
|
735
760
|
}
|
|
736
761
|
/**
|
|
737
|
-
* Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled`. Leave empty to return markets with any status. - Only one `status` filter may be supplied at a time. - Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters. | Compatible Timestamp Filters | Additional Status Filters|
|
|
762
|
+
* Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled`. Leave empty to return markets with any status. - Only one `status` filter may be supplied at a time. - Timestamp filters will be mutually exclusive from other timestamp filters and certain status filters. | Compatible Timestamp Filters | Additional Status Filters| Extra Notes | |------------------------------|--------------------------|-------------| | min_created_ts, max_created_ts | `unopened`, `open`, *empty* | | | min_close_ts, max_close_ts | `closed`, *empty* | | | min_settled_ts, max_settled_ts | `settled`, *empty* | | | min_updated_ts | *empty* | Incompatible with all filters besides `mve_filter=exclude` |
|
|
738
763
|
* @summary Get Markets
|
|
739
764
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
|
|
740
765
|
* @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
|
|
@@ -742,6 +767,7 @@ class MarketApi extends base_1.BaseAPI {
|
|
|
742
767
|
* @param {string} [seriesTicker] Filter by series ticker
|
|
743
768
|
* @param {number} [minCreatedTs] Filter items that created after this Unix timestamp
|
|
744
769
|
* @param {number} [maxCreatedTs] Filter items that created before this Unix timestamp
|
|
770
|
+
* @param {number} [minUpdatedTs] Return markets updated later than this Unix timestamp. Incompatible with any other filters.
|
|
745
771
|
* @param {number} [maxCloseTs] Filter items that close before this Unix timestamp
|
|
746
772
|
* @param {number} [minCloseTs] Filter items that close after this Unix timestamp
|
|
747
773
|
* @param {number} [minSettledTs] Filter items that settled after this Unix timestamp
|
|
@@ -752,18 +778,19 @@ class MarketApi extends base_1.BaseAPI {
|
|
|
752
778
|
* @param {*} [options] Override http request option.
|
|
753
779
|
* @throws {RequiredError}
|
|
754
780
|
*/
|
|
755
|
-
getMarkets(limit, cursor, eventTicker, seriesTicker, minCreatedTs, maxCreatedTs, maxCloseTs, minCloseTs, minSettledTs, maxSettledTs, status, tickers, mveFilter, options) {
|
|
756
|
-
return (0, exports.MarketApiFp)(this.configuration).getMarkets(limit, cursor, eventTicker, seriesTicker, minCreatedTs, maxCreatedTs, maxCloseTs, minCloseTs, minSettledTs, maxSettledTs, status, tickers, mveFilter, options).then((request) => request(this.axios, this.basePath));
|
|
781
|
+
getMarkets(limit, cursor, eventTicker, seriesTicker, minCreatedTs, maxCreatedTs, minUpdatedTs, maxCloseTs, minCloseTs, minSettledTs, maxSettledTs, status, tickers, mveFilter, options) {
|
|
782
|
+
return (0, exports.MarketApiFp)(this.configuration).getMarkets(limit, cursor, eventTicker, seriesTicker, minCreatedTs, maxCreatedTs, minUpdatedTs, maxCloseTs, minCloseTs, minSettledTs, maxSettledTs, status, tickers, mveFilter, options).then((request) => request(this.axios, this.basePath));
|
|
757
783
|
}
|
|
758
784
|
/**
|
|
759
785
|
* Endpoint for getting data about a specific series by its ticker. A series represents a template for recurring events that follow the same format and rules (e.g., \"Monthly Jobs Report\", \"Weekly Initial Jobless Claims\", \"Daily Weather in NYC\"). Series define the structure, settlement sources, and metadata that will be applied to each recurring event instance within that series.
|
|
760
786
|
* @summary Get Series
|
|
761
787
|
* @param {string} seriesTicker The ticker of the series to retrieve
|
|
788
|
+
* @param {boolean} [includeVolume] If true, includes the total volume traded across all events in this series.
|
|
762
789
|
* @param {*} [options] Override http request option.
|
|
763
790
|
* @throws {RequiredError}
|
|
764
791
|
*/
|
|
765
|
-
getSeries(seriesTicker, options) {
|
|
766
|
-
return (0, exports.MarketApiFp)(this.configuration).getSeries(seriesTicker, options).then((request) => request(this.axios, this.basePath));
|
|
792
|
+
getSeries(seriesTicker, includeVolume, options) {
|
|
793
|
+
return (0, exports.MarketApiFp)(this.configuration).getSeries(seriesTicker, includeVolume, options).then((request) => request(this.axios, this.basePath));
|
|
767
794
|
}
|
|
768
795
|
/**
|
|
769
796
|
* Endpoint for getting data about multiple series with specified filters. A series represents a template for recurring events that follow the same format and rules (e.g., \"Monthly Jobs Report\", \"Weekly Initial Jobless Claims\", \"Daily Weather in NYC\"). This endpoint allows you to browse and discover available series templates by category.
|
|
@@ -771,11 +798,12 @@ class MarketApi extends base_1.BaseAPI {
|
|
|
771
798
|
* @param {string} [category]
|
|
772
799
|
* @param {string} [tags]
|
|
773
800
|
* @param {boolean} [includeProductMetadata]
|
|
801
|
+
* @param {boolean} [includeVolume] If true, includes the total volume traded across all events in each series.
|
|
774
802
|
* @param {*} [options] Override http request option.
|
|
775
803
|
* @throws {RequiredError}
|
|
776
804
|
*/
|
|
777
|
-
getSeriesList(category, tags, includeProductMetadata, options) {
|
|
778
|
-
return (0, exports.MarketApiFp)(this.configuration).getSeriesList(category, tags, includeProductMetadata, options).then((request) => request(this.axios, this.basePath));
|
|
805
|
+
getSeriesList(category, tags, includeProductMetadata, includeVolume, options) {
|
|
806
|
+
return (0, exports.MarketApiFp)(this.configuration).getSeriesList(category, tags, includeProductMetadata, includeVolume, options).then((request) => request(this.axios, this.basePath));
|
|
779
807
|
}
|
|
780
808
|
/**
|
|
781
809
|
* Endpoint for getting all trades for all markets. A trade represents a completed transaction between two users on a specific market. Each trade includes the market ticker, price, quantity, and timestamp information. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Kalshi Trade API Manual Endpoints
|
|
3
3
|
* Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.
|
|
5
|
+
* The version of the OpenAPI document: 3.6.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Kalshi Trade API Manual Endpoints
|
|
6
6
|
* Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 3.
|
|
8
|
+
* The version of the OpenAPI document: 3.6.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Kalshi Trade API Manual Endpoints
|
|
3
3
|
* Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.
|
|
5
|
+
* The version of the OpenAPI document: 3.6.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Kalshi Trade API Manual Endpoints
|
|
6
6
|
* Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 3.
|
|
8
|
+
* The version of the OpenAPI document: 3.6.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Kalshi Trade API Manual Endpoints
|
|
3
3
|
* Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.
|
|
5
|
+
* The version of the OpenAPI document: 3.6.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -16,12 +16,13 @@ import type { CreateOrderGroupRequest } from '../models';
|
|
|
16
16
|
import type { CreateOrderGroupResponse } from '../models';
|
|
17
17
|
import type { GetOrderGroupResponse } from '../models';
|
|
18
18
|
import type { GetOrderGroupsResponse } from '../models';
|
|
19
|
+
import type { UpdateOrderGroupLimitRequest } from '../models';
|
|
19
20
|
/**
|
|
20
21
|
* OrderGroupsApi - axios parameter creator
|
|
21
22
|
*/
|
|
22
23
|
export declare const OrderGroupsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
23
24
|
/**
|
|
24
|
-
* Creates a new order group with a contracts limit. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.
|
|
25
|
+
* Creates a new order group with a contracts limit measured over a rolling 15-second window. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.
|
|
25
26
|
* @summary Create Order Group
|
|
26
27
|
* @param {CreateOrderGroupRequest} createOrderGroupRequest
|
|
27
28
|
* @param {*} [options] Override http request option.
|
|
@@ -32,10 +33,11 @@ export declare const OrderGroupsApiAxiosParamCreator: (configuration?: Configura
|
|
|
32
33
|
* Deletes an order group and cancels all orders within it. This permanently removes the group.
|
|
33
34
|
* @summary Delete Order Group
|
|
34
35
|
* @param {string} orderGroupId Order group ID
|
|
36
|
+
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts)
|
|
35
37
|
* @param {*} [options] Override http request option.
|
|
36
38
|
* @throws {RequiredError}
|
|
37
39
|
*/
|
|
38
|
-
deleteOrderGroup: (orderGroupId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
40
|
+
deleteOrderGroup: (orderGroupId: string, subaccount?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39
41
|
/**
|
|
40
42
|
* Retrieves details for a single order group including all order IDs and auto-cancel status.
|
|
41
43
|
* @summary Get Order Group
|
|
@@ -55,18 +57,38 @@ export declare const OrderGroupsApiAxiosParamCreator: (configuration?: Configura
|
|
|
55
57
|
* Resets the order group\'s matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.
|
|
56
58
|
* @summary Reset Order Group
|
|
57
59
|
* @param {string} orderGroupId Order group ID
|
|
60
|
+
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts)
|
|
58
61
|
* @param {object} [body]
|
|
59
62
|
* @param {*} [options] Override http request option.
|
|
60
63
|
* @throws {RequiredError}
|
|
61
64
|
*/
|
|
62
|
-
resetOrderGroup: (orderGroupId: string, body?: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
65
|
+
resetOrderGroup: (orderGroupId: string, subaccount?: number, body?: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
66
|
+
/**
|
|
67
|
+
* Triggers the order group, canceling all orders in the group and preventing new orders until the group is reset.
|
|
68
|
+
* @summary Trigger Order Group
|
|
69
|
+
* @param {string} orderGroupId Order group ID
|
|
70
|
+
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts)
|
|
71
|
+
* @param {object} [body]
|
|
72
|
+
* @param {*} [options] Override http request option.
|
|
73
|
+
* @throws {RequiredError}
|
|
74
|
+
*/
|
|
75
|
+
triggerOrderGroup: (orderGroupId: string, subaccount?: number, body?: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
76
|
+
/**
|
|
77
|
+
* Updates the order group contracts limit (rolling 15-second window). If the updated limit would immediately trigger the group, all orders in the group are canceled and the group is triggered.
|
|
78
|
+
* @summary Update Order Group Limit
|
|
79
|
+
* @param {string} orderGroupId Order group ID
|
|
80
|
+
* @param {UpdateOrderGroupLimitRequest} updateOrderGroupLimitRequest
|
|
81
|
+
* @param {*} [options] Override http request option.
|
|
82
|
+
* @throws {RequiredError}
|
|
83
|
+
*/
|
|
84
|
+
updateOrderGroupLimit: (orderGroupId: string, updateOrderGroupLimitRequest: UpdateOrderGroupLimitRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63
85
|
};
|
|
64
86
|
/**
|
|
65
87
|
* OrderGroupsApi - functional programming interface
|
|
66
88
|
*/
|
|
67
89
|
export declare const OrderGroupsApiFp: (configuration?: Configuration) => {
|
|
68
90
|
/**
|
|
69
|
-
* Creates a new order group with a contracts limit. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.
|
|
91
|
+
* Creates a new order group with a contracts limit measured over a rolling 15-second window. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.
|
|
70
92
|
* @summary Create Order Group
|
|
71
93
|
* @param {CreateOrderGroupRequest} createOrderGroupRequest
|
|
72
94
|
* @param {*} [options] Override http request option.
|
|
@@ -77,10 +99,11 @@ export declare const OrderGroupsApiFp: (configuration?: Configuration) => {
|
|
|
77
99
|
* Deletes an order group and cancels all orders within it. This permanently removes the group.
|
|
78
100
|
* @summary Delete Order Group
|
|
79
101
|
* @param {string} orderGroupId Order group ID
|
|
102
|
+
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts)
|
|
80
103
|
* @param {*} [options] Override http request option.
|
|
81
104
|
* @throws {RequiredError}
|
|
82
105
|
*/
|
|
83
|
-
deleteOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
106
|
+
deleteOrderGroup(orderGroupId: string, subaccount?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
84
107
|
/**
|
|
85
108
|
* Retrieves details for a single order group including all order IDs and auto-cancel status.
|
|
86
109
|
* @summary Get Order Group
|
|
@@ -100,18 +123,38 @@ export declare const OrderGroupsApiFp: (configuration?: Configuration) => {
|
|
|
100
123
|
* Resets the order group\'s matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.
|
|
101
124
|
* @summary Reset Order Group
|
|
102
125
|
* @param {string} orderGroupId Order group ID
|
|
126
|
+
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts)
|
|
103
127
|
* @param {object} [body]
|
|
104
128
|
* @param {*} [options] Override http request option.
|
|
105
129
|
* @throws {RequiredError}
|
|
106
130
|
*/
|
|
107
|
-
resetOrderGroup(orderGroupId: string, body?: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
131
|
+
resetOrderGroup(orderGroupId: string, subaccount?: number, body?: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
132
|
+
/**
|
|
133
|
+
* Triggers the order group, canceling all orders in the group and preventing new orders until the group is reset.
|
|
134
|
+
* @summary Trigger Order Group
|
|
135
|
+
* @param {string} orderGroupId Order group ID
|
|
136
|
+
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts)
|
|
137
|
+
* @param {object} [body]
|
|
138
|
+
* @param {*} [options] Override http request option.
|
|
139
|
+
* @throws {RequiredError}
|
|
140
|
+
*/
|
|
141
|
+
triggerOrderGroup(orderGroupId: string, subaccount?: number, body?: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
142
|
+
/**
|
|
143
|
+
* Updates the order group contracts limit (rolling 15-second window). If the updated limit would immediately trigger the group, all orders in the group are canceled and the group is triggered.
|
|
144
|
+
* @summary Update Order Group Limit
|
|
145
|
+
* @param {string} orderGroupId Order group ID
|
|
146
|
+
* @param {UpdateOrderGroupLimitRequest} updateOrderGroupLimitRequest
|
|
147
|
+
* @param {*} [options] Override http request option.
|
|
148
|
+
* @throws {RequiredError}
|
|
149
|
+
*/
|
|
150
|
+
updateOrderGroupLimit(orderGroupId: string, updateOrderGroupLimitRequest: UpdateOrderGroupLimitRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
108
151
|
};
|
|
109
152
|
/**
|
|
110
153
|
* OrderGroupsApi - factory interface
|
|
111
154
|
*/
|
|
112
155
|
export declare const OrderGroupsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
113
156
|
/**
|
|
114
|
-
* Creates a new order group with a contracts limit. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.
|
|
157
|
+
* Creates a new order group with a contracts limit measured over a rolling 15-second window. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.
|
|
115
158
|
* @summary Create Order Group
|
|
116
159
|
* @param {CreateOrderGroupRequest} createOrderGroupRequest
|
|
117
160
|
* @param {*} [options] Override http request option.
|
|
@@ -122,10 +165,11 @@ export declare const OrderGroupsApiFactory: (configuration?: Configuration, base
|
|
|
122
165
|
* Deletes an order group and cancels all orders within it. This permanently removes the group.
|
|
123
166
|
* @summary Delete Order Group
|
|
124
167
|
* @param {string} orderGroupId Order group ID
|
|
168
|
+
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts)
|
|
125
169
|
* @param {*} [options] Override http request option.
|
|
126
170
|
* @throws {RequiredError}
|
|
127
171
|
*/
|
|
128
|
-
deleteOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
172
|
+
deleteOrderGroup(orderGroupId: string, subaccount?: number, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
129
173
|
/**
|
|
130
174
|
* Retrieves details for a single order group including all order IDs and auto-cancel status.
|
|
131
175
|
* @summary Get Order Group
|
|
@@ -145,18 +189,38 @@ export declare const OrderGroupsApiFactory: (configuration?: Configuration, base
|
|
|
145
189
|
* Resets the order group\'s matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.
|
|
146
190
|
* @summary Reset Order Group
|
|
147
191
|
* @param {string} orderGroupId Order group ID
|
|
192
|
+
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts)
|
|
148
193
|
* @param {object} [body]
|
|
149
194
|
* @param {*} [options] Override http request option.
|
|
150
195
|
* @throws {RequiredError}
|
|
151
196
|
*/
|
|
152
|
-
resetOrderGroup(orderGroupId: string, body?: object, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
197
|
+
resetOrderGroup(orderGroupId: string, subaccount?: number, body?: object, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
198
|
+
/**
|
|
199
|
+
* Triggers the order group, canceling all orders in the group and preventing new orders until the group is reset.
|
|
200
|
+
* @summary Trigger Order Group
|
|
201
|
+
* @param {string} orderGroupId Order group ID
|
|
202
|
+
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts)
|
|
203
|
+
* @param {object} [body]
|
|
204
|
+
* @param {*} [options] Override http request option.
|
|
205
|
+
* @throws {RequiredError}
|
|
206
|
+
*/
|
|
207
|
+
triggerOrderGroup(orderGroupId: string, subaccount?: number, body?: object, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
208
|
+
/**
|
|
209
|
+
* Updates the order group contracts limit (rolling 15-second window). If the updated limit would immediately trigger the group, all orders in the group are canceled and the group is triggered.
|
|
210
|
+
* @summary Update Order Group Limit
|
|
211
|
+
* @param {string} orderGroupId Order group ID
|
|
212
|
+
* @param {UpdateOrderGroupLimitRequest} updateOrderGroupLimitRequest
|
|
213
|
+
* @param {*} [options] Override http request option.
|
|
214
|
+
* @throws {RequiredError}
|
|
215
|
+
*/
|
|
216
|
+
updateOrderGroupLimit(orderGroupId: string, updateOrderGroupLimitRequest: UpdateOrderGroupLimitRequest, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
153
217
|
};
|
|
154
218
|
/**
|
|
155
219
|
* OrderGroupsApi - object-oriented interface
|
|
156
220
|
*/
|
|
157
221
|
export declare class OrderGroupsApi extends BaseAPI {
|
|
158
222
|
/**
|
|
159
|
-
* Creates a new order group with a contracts limit. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.
|
|
223
|
+
* Creates a new order group with a contracts limit measured over a rolling 15-second window. When the limit is hit, all orders in the group are cancelled and no new orders can be placed until reset.
|
|
160
224
|
* @summary Create Order Group
|
|
161
225
|
* @param {CreateOrderGroupRequest} createOrderGroupRequest
|
|
162
226
|
* @param {*} [options] Override http request option.
|
|
@@ -167,10 +231,11 @@ export declare class OrderGroupsApi extends BaseAPI {
|
|
|
167
231
|
* Deletes an order group and cancels all orders within it. This permanently removes the group.
|
|
168
232
|
* @summary Delete Order Group
|
|
169
233
|
* @param {string} orderGroupId Order group ID
|
|
234
|
+
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts)
|
|
170
235
|
* @param {*} [options] Override http request option.
|
|
171
236
|
* @throws {RequiredError}
|
|
172
237
|
*/
|
|
173
|
-
deleteOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
238
|
+
deleteOrderGroup(orderGroupId: string, subaccount?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
174
239
|
/**
|
|
175
240
|
* Retrieves details for a single order group including all order IDs and auto-cancel status.
|
|
176
241
|
* @summary Get Order Group
|
|
@@ -190,9 +255,29 @@ export declare class OrderGroupsApi extends BaseAPI {
|
|
|
190
255
|
* Resets the order group\'s matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.
|
|
191
256
|
* @summary Reset Order Group
|
|
192
257
|
* @param {string} orderGroupId Order group ID
|
|
258
|
+
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts)
|
|
193
259
|
* @param {object} [body]
|
|
194
260
|
* @param {*} [options] Override http request option.
|
|
195
261
|
* @throws {RequiredError}
|
|
196
262
|
*/
|
|
197
|
-
resetOrderGroup(orderGroupId: string, body?: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
263
|
+
resetOrderGroup(orderGroupId: string, subaccount?: number, body?: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
264
|
+
/**
|
|
265
|
+
* Triggers the order group, canceling all orders in the group and preventing new orders until the group is reset.
|
|
266
|
+
* @summary Trigger Order Group
|
|
267
|
+
* @param {string} orderGroupId Order group ID
|
|
268
|
+
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts)
|
|
269
|
+
* @param {object} [body]
|
|
270
|
+
* @param {*} [options] Override http request option.
|
|
271
|
+
* @throws {RequiredError}
|
|
272
|
+
*/
|
|
273
|
+
triggerOrderGroup(orderGroupId: string, subaccount?: number, body?: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
274
|
+
/**
|
|
275
|
+
* Updates the order group contracts limit (rolling 15-second window). If the updated limit would immediately trigger the group, all orders in the group are canceled and the group is triggered.
|
|
276
|
+
* @summary Update Order Group Limit
|
|
277
|
+
* @param {string} orderGroupId Order group ID
|
|
278
|
+
* @param {UpdateOrderGroupLimitRequest} updateOrderGroupLimitRequest
|
|
279
|
+
* @param {*} [options] Override http request option.
|
|
280
|
+
* @throws {RequiredError}
|
|
281
|
+
*/
|
|
282
|
+
updateOrderGroupLimit(orderGroupId: string, updateOrderGroupLimitRequest: UpdateOrderGroupLimitRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
198
283
|
}
|