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
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Kalshi Trade API Manual Endpoints
|
|
5
5
|
* Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 3.
|
|
7
|
+
* The version of the OpenAPI document: 3.6.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -124,10 +124,11 @@ export const MarketApiAxiosParamCreator = function (configuration) {
|
|
|
124
124
|
* @param {number} startTs Start timestamp (Unix timestamp). Candlesticks will include those ending on or after this time.
|
|
125
125
|
* @param {number} endTs End timestamp (Unix timestamp). Candlesticks will include those ending on or before this time.
|
|
126
126
|
* @param {GetMarketCandlesticksPeriodIntervalEnum} periodInterval Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day).
|
|
127
|
+
* @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
|
|
127
128
|
* @param {*} [options] Override http request option.
|
|
128
129
|
* @throws {RequiredError}
|
|
129
130
|
*/
|
|
130
|
-
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 = {}) {
|
|
131
|
+
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 = {}) {
|
|
131
132
|
// verify required parameter 'seriesTicker' is not null or undefined
|
|
132
133
|
assertParamExists('getMarketCandlesticks', 'seriesTicker', seriesTicker);
|
|
133
134
|
// verify required parameter 'ticker' is not null or undefined
|
|
@@ -159,6 +160,9 @@ export const MarketApiAxiosParamCreator = function (configuration) {
|
|
|
159
160
|
if (periodInterval !== undefined) {
|
|
160
161
|
localVarQueryParameter['period_interval'] = periodInterval;
|
|
161
162
|
}
|
|
163
|
+
if (includeLatestBeforeStart !== undefined) {
|
|
164
|
+
localVarQueryParameter['include_latest_before_start'] = includeLatestBeforeStart;
|
|
165
|
+
}
|
|
162
166
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
163
167
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
164
168
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -207,7 +211,7 @@ export const MarketApiAxiosParamCreator = function (configuration) {
|
|
|
207
211
|
};
|
|
208
212
|
}),
|
|
209
213
|
/**
|
|
210
|
-
* 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|
|
|
214
|
+
* 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` |
|
|
211
215
|
* @summary Get Markets
|
|
212
216
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
|
|
213
217
|
* @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.
|
|
@@ -215,6 +219,7 @@ export const MarketApiAxiosParamCreator = function (configuration) {
|
|
|
215
219
|
* @param {string} [seriesTicker] Filter by series ticker
|
|
216
220
|
* @param {number} [minCreatedTs] Filter items that created after this Unix timestamp
|
|
217
221
|
* @param {number} [maxCreatedTs] Filter items that created before this Unix timestamp
|
|
222
|
+
* @param {number} [minUpdatedTs] Return markets updated later than this Unix timestamp. Incompatible with any other filters.
|
|
218
223
|
* @param {number} [maxCloseTs] Filter items that close before this Unix timestamp
|
|
219
224
|
* @param {number} [minCloseTs] Filter items that close after this Unix timestamp
|
|
220
225
|
* @param {number} [minSettledTs] Filter items that settled after this Unix timestamp
|
|
@@ -225,7 +230,7 @@ export const MarketApiAxiosParamCreator = function (configuration) {
|
|
|
225
230
|
* @param {*} [options] Override http request option.
|
|
226
231
|
* @throws {RequiredError}
|
|
227
232
|
*/
|
|
228
|
-
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 = {}) {
|
|
233
|
+
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 = {}) {
|
|
229
234
|
const localVarPath = `/markets`;
|
|
230
235
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
231
236
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -254,6 +259,9 @@ export const MarketApiAxiosParamCreator = function (configuration) {
|
|
|
254
259
|
if (maxCreatedTs !== undefined) {
|
|
255
260
|
localVarQueryParameter['max_created_ts'] = maxCreatedTs;
|
|
256
261
|
}
|
|
262
|
+
if (minUpdatedTs !== undefined) {
|
|
263
|
+
localVarQueryParameter['min_updated_ts'] = minUpdatedTs;
|
|
264
|
+
}
|
|
257
265
|
if (maxCloseTs !== undefined) {
|
|
258
266
|
localVarQueryParameter['max_close_ts'] = maxCloseTs;
|
|
259
267
|
}
|
|
@@ -287,10 +295,11 @@ export const MarketApiAxiosParamCreator = function (configuration) {
|
|
|
287
295
|
* 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.
|
|
288
296
|
* @summary Get Series
|
|
289
297
|
* @param {string} seriesTicker The ticker of the series to retrieve
|
|
298
|
+
* @param {boolean} [includeVolume] If true, includes the total volume traded across all events in this series.
|
|
290
299
|
* @param {*} [options] Override http request option.
|
|
291
300
|
* @throws {RequiredError}
|
|
292
301
|
*/
|
|
293
|
-
getSeries: (seriesTicker_1, ...args_1) => __awaiter(this, [seriesTicker_1, ...args_1], void 0, function* (seriesTicker, options = {}) {
|
|
302
|
+
getSeries: (seriesTicker_1, includeVolume_1, ...args_1) => __awaiter(this, [seriesTicker_1, includeVolume_1, ...args_1], void 0, function* (seriesTicker, includeVolume, options = {}) {
|
|
294
303
|
// verify required parameter 'seriesTicker' is not null or undefined
|
|
295
304
|
assertParamExists('getSeries', 'seriesTicker', seriesTicker);
|
|
296
305
|
const localVarPath = `/series/{series_ticker}`
|
|
@@ -304,6 +313,9 @@ export const MarketApiAxiosParamCreator = function (configuration) {
|
|
|
304
313
|
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
305
314
|
const localVarHeaderParameter = {};
|
|
306
315
|
const localVarQueryParameter = {};
|
|
316
|
+
if (includeVolume !== undefined) {
|
|
317
|
+
localVarQueryParameter['include_volume'] = includeVolume;
|
|
318
|
+
}
|
|
307
319
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
308
320
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
309
321
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -318,10 +330,11 @@ export const MarketApiAxiosParamCreator = function (configuration) {
|
|
|
318
330
|
* @param {string} [category]
|
|
319
331
|
* @param {string} [tags]
|
|
320
332
|
* @param {boolean} [includeProductMetadata]
|
|
333
|
+
* @param {boolean} [includeVolume] If true, includes the total volume traded across all events in each series.
|
|
321
334
|
* @param {*} [options] Override http request option.
|
|
322
335
|
* @throws {RequiredError}
|
|
323
336
|
*/
|
|
324
|
-
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 = {}) {
|
|
337
|
+
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 = {}) {
|
|
325
338
|
const localVarPath = `/series`;
|
|
326
339
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
327
340
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -341,6 +354,9 @@ export const MarketApiAxiosParamCreator = function (configuration) {
|
|
|
341
354
|
if (includeProductMetadata !== undefined) {
|
|
342
355
|
localVarQueryParameter['include_product_metadata'] = includeProductMetadata;
|
|
343
356
|
}
|
|
357
|
+
if (includeVolume !== undefined) {
|
|
358
|
+
localVarQueryParameter['include_volume'] = includeVolume;
|
|
359
|
+
}
|
|
344
360
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
345
361
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
346
362
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -446,13 +462,14 @@ export const MarketApiFp = function (configuration) {
|
|
|
446
462
|
* @param {number} startTs Start timestamp (Unix timestamp). Candlesticks will include those ending on or after this time.
|
|
447
463
|
* @param {number} endTs End timestamp (Unix timestamp). Candlesticks will include those ending on or before this time.
|
|
448
464
|
* @param {GetMarketCandlesticksPeriodIntervalEnum} periodInterval Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day).
|
|
465
|
+
* @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
|
|
449
466
|
* @param {*} [options] Override http request option.
|
|
450
467
|
* @throws {RequiredError}
|
|
451
468
|
*/
|
|
452
|
-
getMarketCandlesticks(seriesTicker, ticker, startTs, endTs, periodInterval, options) {
|
|
469
|
+
getMarketCandlesticks(seriesTicker, ticker, startTs, endTs, periodInterval, includeLatestBeforeStart, options) {
|
|
453
470
|
return __awaiter(this, void 0, void 0, function* () {
|
|
454
471
|
var _a;
|
|
455
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getMarketCandlesticks(seriesTicker, ticker, startTs, endTs, periodInterval, options);
|
|
472
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getMarketCandlesticks(seriesTicker, ticker, startTs, endTs, periodInterval, includeLatestBeforeStart, options);
|
|
456
473
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
457
474
|
const localVarOperationServerBasePath = undefined;
|
|
458
475
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -476,7 +493,7 @@ export const MarketApiFp = function (configuration) {
|
|
|
476
493
|
});
|
|
477
494
|
},
|
|
478
495
|
/**
|
|
479
|
-
* 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|
|
|
496
|
+
* 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` |
|
|
480
497
|
* @summary Get Markets
|
|
481
498
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
|
|
482
499
|
* @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.
|
|
@@ -484,6 +501,7 @@ export const MarketApiFp = function (configuration) {
|
|
|
484
501
|
* @param {string} [seriesTicker] Filter by series ticker
|
|
485
502
|
* @param {number} [minCreatedTs] Filter items that created after this Unix timestamp
|
|
486
503
|
* @param {number} [maxCreatedTs] Filter items that created before this Unix timestamp
|
|
504
|
+
* @param {number} [minUpdatedTs] Return markets updated later than this Unix timestamp. Incompatible with any other filters.
|
|
487
505
|
* @param {number} [maxCloseTs] Filter items that close before this Unix timestamp
|
|
488
506
|
* @param {number} [minCloseTs] Filter items that close after this Unix timestamp
|
|
489
507
|
* @param {number} [minSettledTs] Filter items that settled after this Unix timestamp
|
|
@@ -494,10 +512,10 @@ export const MarketApiFp = function (configuration) {
|
|
|
494
512
|
* @param {*} [options] Override http request option.
|
|
495
513
|
* @throws {RequiredError}
|
|
496
514
|
*/
|
|
497
|
-
getMarkets(limit, cursor, eventTicker, seriesTicker, minCreatedTs, maxCreatedTs, maxCloseTs, minCloseTs, minSettledTs, maxSettledTs, status, tickers, mveFilter, options) {
|
|
515
|
+
getMarkets(limit, cursor, eventTicker, seriesTicker, minCreatedTs, maxCreatedTs, minUpdatedTs, maxCloseTs, minCloseTs, minSettledTs, maxSettledTs, status, tickers, mveFilter, options) {
|
|
498
516
|
return __awaiter(this, void 0, void 0, function* () {
|
|
499
517
|
var _a;
|
|
500
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getMarkets(limit, cursor, eventTicker, seriesTicker, minCreatedTs, maxCreatedTs, maxCloseTs, minCloseTs, minSettledTs, maxSettledTs, status, tickers, mveFilter, options);
|
|
518
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getMarkets(limit, cursor, eventTicker, seriesTicker, minCreatedTs, maxCreatedTs, minUpdatedTs, maxCloseTs, minCloseTs, minSettledTs, maxSettledTs, status, tickers, mveFilter, options);
|
|
501
519
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
502
520
|
const localVarOperationServerBasePath = undefined;
|
|
503
521
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -507,13 +525,14 @@ export const MarketApiFp = function (configuration) {
|
|
|
507
525
|
* 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.
|
|
508
526
|
* @summary Get Series
|
|
509
527
|
* @param {string} seriesTicker The ticker of the series to retrieve
|
|
528
|
+
* @param {boolean} [includeVolume] If true, includes the total volume traded across all events in this series.
|
|
510
529
|
* @param {*} [options] Override http request option.
|
|
511
530
|
* @throws {RequiredError}
|
|
512
531
|
*/
|
|
513
|
-
getSeries(seriesTicker, options) {
|
|
532
|
+
getSeries(seriesTicker, includeVolume, options) {
|
|
514
533
|
return __awaiter(this, void 0, void 0, function* () {
|
|
515
534
|
var _a;
|
|
516
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getSeries(seriesTicker, options);
|
|
535
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getSeries(seriesTicker, includeVolume, options);
|
|
517
536
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
518
537
|
const localVarOperationServerBasePath = undefined;
|
|
519
538
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -525,13 +544,14 @@ export const MarketApiFp = function (configuration) {
|
|
|
525
544
|
* @param {string} [category]
|
|
526
545
|
* @param {string} [tags]
|
|
527
546
|
* @param {boolean} [includeProductMetadata]
|
|
547
|
+
* @param {boolean} [includeVolume] If true, includes the total volume traded across all events in each series.
|
|
528
548
|
* @param {*} [options] Override http request option.
|
|
529
549
|
* @throws {RequiredError}
|
|
530
550
|
*/
|
|
531
|
-
getSeriesList(category, tags, includeProductMetadata, options) {
|
|
551
|
+
getSeriesList(category, tags, includeProductMetadata, includeVolume, options) {
|
|
532
552
|
return __awaiter(this, void 0, void 0, function* () {
|
|
533
553
|
var _a;
|
|
534
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getSeriesList(category, tags, includeProductMetadata, options);
|
|
554
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getSeriesList(category, tags, includeProductMetadata, includeVolume, options);
|
|
535
555
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
536
556
|
const localVarOperationServerBasePath = undefined;
|
|
537
557
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -597,11 +617,12 @@ export const MarketApiFactory = function (configuration, basePath, axios) {
|
|
|
597
617
|
* @param {number} startTs Start timestamp (Unix timestamp). Candlesticks will include those ending on or after this time.
|
|
598
618
|
* @param {number} endTs End timestamp (Unix timestamp). Candlesticks will include those ending on or before this time.
|
|
599
619
|
* @param {GetMarketCandlesticksPeriodIntervalEnum} periodInterval Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day).
|
|
620
|
+
* @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
|
|
600
621
|
* @param {*} [options] Override http request option.
|
|
601
622
|
* @throws {RequiredError}
|
|
602
623
|
*/
|
|
603
|
-
getMarketCandlesticks(seriesTicker, ticker, startTs, endTs, periodInterval, options) {
|
|
604
|
-
return localVarFp.getMarketCandlesticks(seriesTicker, ticker, startTs, endTs, periodInterval, options).then((request) => request(axios, basePath));
|
|
624
|
+
getMarketCandlesticks(seriesTicker, ticker, startTs, endTs, periodInterval, includeLatestBeforeStart, options) {
|
|
625
|
+
return localVarFp.getMarketCandlesticks(seriesTicker, ticker, startTs, endTs, periodInterval, includeLatestBeforeStart, options).then((request) => request(axios, basePath));
|
|
605
626
|
},
|
|
606
627
|
/**
|
|
607
628
|
* 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.
|
|
@@ -615,7 +636,7 @@ export const MarketApiFactory = function (configuration, basePath, axios) {
|
|
|
615
636
|
return localVarFp.getMarketOrderbook(ticker, depth, options).then((request) => request(axios, basePath));
|
|
616
637
|
},
|
|
617
638
|
/**
|
|
618
|
-
* 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|
|
|
639
|
+
* 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` |
|
|
619
640
|
* @summary Get Markets
|
|
620
641
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
|
|
621
642
|
* @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.
|
|
@@ -623,6 +644,7 @@ export const MarketApiFactory = function (configuration, basePath, axios) {
|
|
|
623
644
|
* @param {string} [seriesTicker] Filter by series ticker
|
|
624
645
|
* @param {number} [minCreatedTs] Filter items that created after this Unix timestamp
|
|
625
646
|
* @param {number} [maxCreatedTs] Filter items that created before this Unix timestamp
|
|
647
|
+
* @param {number} [minUpdatedTs] Return markets updated later than this Unix timestamp. Incompatible with any other filters.
|
|
626
648
|
* @param {number} [maxCloseTs] Filter items that close before this Unix timestamp
|
|
627
649
|
* @param {number} [minCloseTs] Filter items that close after this Unix timestamp
|
|
628
650
|
* @param {number} [minSettledTs] Filter items that settled after this Unix timestamp
|
|
@@ -633,18 +655,19 @@ export const MarketApiFactory = function (configuration, basePath, axios) {
|
|
|
633
655
|
* @param {*} [options] Override http request option.
|
|
634
656
|
* @throws {RequiredError}
|
|
635
657
|
*/
|
|
636
|
-
getMarkets(limit, cursor, eventTicker, seriesTicker, minCreatedTs, maxCreatedTs, maxCloseTs, minCloseTs, minSettledTs, maxSettledTs, status, tickers, mveFilter, options) {
|
|
637
|
-
return localVarFp.getMarkets(limit, cursor, eventTicker, seriesTicker, minCreatedTs, maxCreatedTs, maxCloseTs, minCloseTs, minSettledTs, maxSettledTs, status, tickers, mveFilter, options).then((request) => request(axios, basePath));
|
|
658
|
+
getMarkets(limit, cursor, eventTicker, seriesTicker, minCreatedTs, maxCreatedTs, minUpdatedTs, maxCloseTs, minCloseTs, minSettledTs, maxSettledTs, status, tickers, mveFilter, options) {
|
|
659
|
+
return localVarFp.getMarkets(limit, cursor, eventTicker, seriesTicker, minCreatedTs, maxCreatedTs, minUpdatedTs, maxCloseTs, minCloseTs, minSettledTs, maxSettledTs, status, tickers, mveFilter, options).then((request) => request(axios, basePath));
|
|
638
660
|
},
|
|
639
661
|
/**
|
|
640
662
|
* 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.
|
|
641
663
|
* @summary Get Series
|
|
642
664
|
* @param {string} seriesTicker The ticker of the series to retrieve
|
|
665
|
+
* @param {boolean} [includeVolume] If true, includes the total volume traded across all events in this series.
|
|
643
666
|
* @param {*} [options] Override http request option.
|
|
644
667
|
* @throws {RequiredError}
|
|
645
668
|
*/
|
|
646
|
-
getSeries(seriesTicker, options) {
|
|
647
|
-
return localVarFp.getSeries(seriesTicker, options).then((request) => request(axios, basePath));
|
|
669
|
+
getSeries(seriesTicker, includeVolume, options) {
|
|
670
|
+
return localVarFp.getSeries(seriesTicker, includeVolume, options).then((request) => request(axios, basePath));
|
|
648
671
|
},
|
|
649
672
|
/**
|
|
650
673
|
* 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.
|
|
@@ -652,11 +675,12 @@ export const MarketApiFactory = function (configuration, basePath, axios) {
|
|
|
652
675
|
* @param {string} [category]
|
|
653
676
|
* @param {string} [tags]
|
|
654
677
|
* @param {boolean} [includeProductMetadata]
|
|
678
|
+
* @param {boolean} [includeVolume] If true, includes the total volume traded across all events in each series.
|
|
655
679
|
* @param {*} [options] Override http request option.
|
|
656
680
|
* @throws {RequiredError}
|
|
657
681
|
*/
|
|
658
|
-
getSeriesList(category, tags, includeProductMetadata, options) {
|
|
659
|
-
return localVarFp.getSeriesList(category, tags, includeProductMetadata, options).then((request) => request(axios, basePath));
|
|
682
|
+
getSeriesList(category, tags, includeProductMetadata, includeVolume, options) {
|
|
683
|
+
return localVarFp.getSeriesList(category, tags, includeProductMetadata, includeVolume, options).then((request) => request(axios, basePath));
|
|
660
684
|
},
|
|
661
685
|
/**
|
|
662
686
|
* 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.
|
|
@@ -710,11 +734,12 @@ export class MarketApi extends BaseAPI {
|
|
|
710
734
|
* @param {number} startTs Start timestamp (Unix timestamp). Candlesticks will include those ending on or after this time.
|
|
711
735
|
* @param {number} endTs End timestamp (Unix timestamp). Candlesticks will include those ending on or before this time.
|
|
712
736
|
* @param {GetMarketCandlesticksPeriodIntervalEnum} periodInterval Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day).
|
|
737
|
+
* @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
|
|
713
738
|
* @param {*} [options] Override http request option.
|
|
714
739
|
* @throws {RequiredError}
|
|
715
740
|
*/
|
|
716
|
-
getMarketCandlesticks(seriesTicker, ticker, startTs, endTs, periodInterval, options) {
|
|
717
|
-
return MarketApiFp(this.configuration).getMarketCandlesticks(seriesTicker, ticker, startTs, endTs, periodInterval, options).then((request) => request(this.axios, this.basePath));
|
|
741
|
+
getMarketCandlesticks(seriesTicker, ticker, startTs, endTs, periodInterval, includeLatestBeforeStart, options) {
|
|
742
|
+
return MarketApiFp(this.configuration).getMarketCandlesticks(seriesTicker, ticker, startTs, endTs, periodInterval, includeLatestBeforeStart, options).then((request) => request(this.axios, this.basePath));
|
|
718
743
|
}
|
|
719
744
|
/**
|
|
720
745
|
* 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.
|
|
@@ -728,7 +753,7 @@ export class MarketApi extends BaseAPI {
|
|
|
728
753
|
return MarketApiFp(this.configuration).getMarketOrderbook(ticker, depth, options).then((request) => request(this.axios, this.basePath));
|
|
729
754
|
}
|
|
730
755
|
/**
|
|
731
|
-
* 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|
|
|
756
|
+
* 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` |
|
|
732
757
|
* @summary Get Markets
|
|
733
758
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
|
|
734
759
|
* @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.
|
|
@@ -736,6 +761,7 @@ export class MarketApi extends BaseAPI {
|
|
|
736
761
|
* @param {string} [seriesTicker] Filter by series ticker
|
|
737
762
|
* @param {number} [minCreatedTs] Filter items that created after this Unix timestamp
|
|
738
763
|
* @param {number} [maxCreatedTs] Filter items that created before this Unix timestamp
|
|
764
|
+
* @param {number} [minUpdatedTs] Return markets updated later than this Unix timestamp. Incompatible with any other filters.
|
|
739
765
|
* @param {number} [maxCloseTs] Filter items that close before this Unix timestamp
|
|
740
766
|
* @param {number} [minCloseTs] Filter items that close after this Unix timestamp
|
|
741
767
|
* @param {number} [minSettledTs] Filter items that settled after this Unix timestamp
|
|
@@ -746,18 +772,19 @@ export class MarketApi extends BaseAPI {
|
|
|
746
772
|
* @param {*} [options] Override http request option.
|
|
747
773
|
* @throws {RequiredError}
|
|
748
774
|
*/
|
|
749
|
-
getMarkets(limit, cursor, eventTicker, seriesTicker, minCreatedTs, maxCreatedTs, maxCloseTs, minCloseTs, minSettledTs, maxSettledTs, status, tickers, mveFilter, options) {
|
|
750
|
-
return 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));
|
|
775
|
+
getMarkets(limit, cursor, eventTicker, seriesTicker, minCreatedTs, maxCreatedTs, minUpdatedTs, maxCloseTs, minCloseTs, minSettledTs, maxSettledTs, status, tickers, mveFilter, options) {
|
|
776
|
+
return 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));
|
|
751
777
|
}
|
|
752
778
|
/**
|
|
753
779
|
* 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.
|
|
754
780
|
* @summary Get Series
|
|
755
781
|
* @param {string} seriesTicker The ticker of the series to retrieve
|
|
782
|
+
* @param {boolean} [includeVolume] If true, includes the total volume traded across all events in this series.
|
|
756
783
|
* @param {*} [options] Override http request option.
|
|
757
784
|
* @throws {RequiredError}
|
|
758
785
|
*/
|
|
759
|
-
getSeries(seriesTicker, options) {
|
|
760
|
-
return MarketApiFp(this.configuration).getSeries(seriesTicker, options).then((request) => request(this.axios, this.basePath));
|
|
786
|
+
getSeries(seriesTicker, includeVolume, options) {
|
|
787
|
+
return MarketApiFp(this.configuration).getSeries(seriesTicker, includeVolume, options).then((request) => request(this.axios, this.basePath));
|
|
761
788
|
}
|
|
762
789
|
/**
|
|
763
790
|
* 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.
|
|
@@ -765,11 +792,12 @@ export class MarketApi extends BaseAPI {
|
|
|
765
792
|
* @param {string} [category]
|
|
766
793
|
* @param {string} [tags]
|
|
767
794
|
* @param {boolean} [includeProductMetadata]
|
|
795
|
+
* @param {boolean} [includeVolume] If true, includes the total volume traded across all events in each series.
|
|
768
796
|
* @param {*} [options] Override http request option.
|
|
769
797
|
* @throws {RequiredError}
|
|
770
798
|
*/
|
|
771
|
-
getSeriesList(category, tags, includeProductMetadata, options) {
|
|
772
|
-
return MarketApiFp(this.configuration).getSeriesList(category, tags, includeProductMetadata, options).then((request) => request(this.axios, this.basePath));
|
|
799
|
+
getSeriesList(category, tags, includeProductMetadata, includeVolume, options) {
|
|
800
|
+
return MarketApiFp(this.configuration).getSeriesList(category, tags, includeProductMetadata, includeVolume, options).then((request) => request(this.axios, this.basePath));
|
|
773
801
|
}
|
|
774
802
|
/**
|
|
775
803
|
* 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).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Kalshi Trade API Manual Endpoints
|
|
5
5
|
* Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 3.
|
|
7
|
+
* The version of the OpenAPI document: 3.6.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* 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).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Kalshi Trade API Manual Endpoints
|
|
5
5
|
* Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 3.
|
|
7
|
+
* The version of the OpenAPI document: 3.6.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* 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
|
}
|