kalshi-typescript 3.4.0 → 3.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -2
- package/dist/api/account-api.d.ts +63 -0
- package/dist/api/account-api.js +130 -0
- package/dist/api/api-keys-api.d.ts +1 -1
- package/dist/api/api-keys-api.js +1 -1
- package/dist/api/communications-api.d.ts +1 -1
- package/dist/api/communications-api.js +1 -1
- package/dist/api/events-api.d.ts +1 -1
- package/dist/api/events-api.js +1 -1
- package/dist/api/exchange-api.d.ts +1 -1
- package/dist/api/exchange-api.js +1 -1
- package/dist/api/fcm-api.d.ts +1 -1
- package/dist/api/fcm-api.js +1 -1
- package/dist/api/incentive-programs-api.d.ts +1 -1
- package/dist/api/incentive-programs-api.js +1 -1
- package/dist/api/live-data-api.d.ts +1 -1
- package/dist/api/live-data-api.js +1 -1
- package/dist/api/market-api.d.ts +37 -21
- package/dist/api/market-api.js +61 -33
- package/dist/api/milestone-api.d.ts +1 -1
- package/dist/api/milestone-api.js +1 -1
- package/dist/api/multivariate-api.d.ts +1 -1
- package/dist/api/multivariate-api.js +1 -1
- package/dist/api/order-groups-api.d.ts +98 -13
- package/dist/api/order-groups-api.js +196 -19
- package/dist/api/orders-api.d.ts +25 -13
- package/dist/api/orders-api.js +43 -22
- package/dist/api/portfolio-api.d.ts +145 -9
- package/dist/api/portfolio-api.js +307 -15
- package/dist/api/search-api.d.ts +1 -1
- package/dist/api/search-api.js +1 -1
- package/dist/api/structured-targets-api.d.ts +1 -1
- package/dist/api/structured-targets-api.js +1 -1
- package/dist/api.d.ts +2 -1
- package/dist/api.js +2 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api/account-api.d.ts +63 -0
- package/dist/esm/api/account-api.js +123 -0
- package/dist/esm/api/api-keys-api.d.ts +1 -1
- package/dist/esm/api/api-keys-api.js +1 -1
- package/dist/esm/api/communications-api.d.ts +1 -1
- package/dist/esm/api/communications-api.js +1 -1
- package/dist/esm/api/events-api.d.ts +1 -1
- package/dist/esm/api/events-api.js +1 -1
- package/dist/esm/api/exchange-api.d.ts +1 -1
- package/dist/esm/api/exchange-api.js +1 -1
- package/dist/esm/api/fcm-api.d.ts +1 -1
- package/dist/esm/api/fcm-api.js +1 -1
- package/dist/esm/api/incentive-programs-api.d.ts +1 -1
- package/dist/esm/api/incentive-programs-api.js +1 -1
- package/dist/esm/api/live-data-api.d.ts +1 -1
- package/dist/esm/api/live-data-api.js +1 -1
- package/dist/esm/api/market-api.d.ts +37 -21
- package/dist/esm/api/market-api.js +61 -33
- package/dist/esm/api/milestone-api.d.ts +1 -1
- package/dist/esm/api/milestone-api.js +1 -1
- package/dist/esm/api/multivariate-api.d.ts +1 -1
- package/dist/esm/api/multivariate-api.js +1 -1
- package/dist/esm/api/order-groups-api.d.ts +98 -13
- package/dist/esm/api/order-groups-api.js +196 -19
- package/dist/esm/api/orders-api.d.ts +25 -13
- package/dist/esm/api/orders-api.js +43 -22
- package/dist/esm/api/portfolio-api.d.ts +145 -9
- package/dist/esm/api/portfolio-api.js +308 -16
- package/dist/esm/api/search-api.d.ts +1 -1
- package/dist/esm/api/search-api.js +1 -1
- package/dist/esm/api/structured-targets-api.d.ts +1 -1
- package/dist/esm/api/structured-targets-api.js +1 -1
- package/dist/esm/api.d.ts +2 -1
- package/dist/esm/api.js +2 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/models/accept-quote-request.d.ts +1 -1
- package/dist/esm/models/accept-quote-request.js +1 -1
- package/dist/esm/models/account-limit.d.ts +25 -0
- package/dist/esm/models/account-limit.js +14 -0
- package/dist/esm/models/amend-order-request.d.ts +12 -4
- package/dist/esm/models/amend-order-request.js +1 -1
- package/dist/esm/models/amend-order-response.d.ts +1 -1
- package/dist/esm/models/amend-order-response.js +1 -1
- package/dist/esm/models/announcement.d.ts +1 -1
- package/dist/esm/models/announcement.js +1 -1
- package/dist/esm/models/api-key.d.ts +1 -1
- package/dist/esm/models/api-key.js +1 -1
- package/dist/esm/models/apply-subaccount-transfer-request.d.ts +29 -0
- package/dist/esm/models/apply-subaccount-transfer-request.js +14 -0
- package/dist/esm/models/associated-event.d.ts +1 -1
- package/dist/esm/models/associated-event.js +1 -1
- package/dist/esm/models/batch-cancel-orders-individual-response.d.ts +5 -1
- package/dist/esm/models/batch-cancel-orders-individual-response.js +1 -1
- package/dist/esm/models/batch-cancel-orders-request-order.d.ts +21 -0
- package/dist/esm/models/batch-cancel-orders-request-order.js +14 -0
- package/dist/esm/models/batch-cancel-orders-request.d.ts +8 -2
- package/dist/esm/models/batch-cancel-orders-request.js +1 -1
- package/dist/esm/models/batch-cancel-orders-response.d.ts +1 -1
- package/dist/esm/models/batch-cancel-orders-response.js +1 -1
- package/dist/esm/models/batch-create-orders-individual-response.d.ts +1 -1
- package/dist/esm/models/batch-create-orders-individual-response.js +1 -1
- package/dist/esm/models/batch-create-orders-request.d.ts +1 -1
- package/dist/esm/models/batch-create-orders-request.js +1 -1
- package/dist/esm/models/batch-create-orders-response.d.ts +1 -1
- package/dist/esm/models/batch-create-orders-response.js +1 -1
- package/dist/esm/models/batch-get-market-candlesticks-response.d.ts +1 -1
- package/dist/esm/models/batch-get-market-candlesticks-response.js +1 -1
- package/dist/esm/models/bid-ask-distribution.d.ts +1 -1
- package/dist/esm/models/bid-ask-distribution.js +1 -1
- package/dist/esm/models/cancel-order-response.d.ts +5 -1
- package/dist/esm/models/cancel-order-response.js +1 -1
- package/dist/esm/models/create-api-key-request.d.ts +1 -1
- package/dist/esm/models/create-api-key-request.js +1 -1
- package/dist/esm/models/create-api-key-response.d.ts +1 -1
- package/dist/esm/models/create-api-key-response.js +1 -1
- package/dist/esm/models/create-market-in-multivariate-event-collection-request.d.ts +1 -1
- package/dist/esm/models/create-market-in-multivariate-event-collection-request.js +1 -1
- package/dist/esm/models/create-market-in-multivariate-event-collection-response.d.ts +1 -1
- package/dist/esm/models/create-market-in-multivariate-event-collection-response.js +1 -1
- package/dist/esm/models/create-order-group-request.d.ts +11 -3
- package/dist/esm/models/create-order-group-request.js +1 -1
- package/dist/esm/models/create-order-group-response.d.ts +1 -1
- package/dist/esm/models/create-order-group-response.js +1 -1
- package/dist/esm/models/create-order-request.d.ts +13 -2
- package/dist/esm/models/create-order-request.js +1 -1
- package/dist/esm/models/create-order-response.d.ts +1 -1
- package/dist/esm/models/create-order-response.js +1 -1
- package/dist/esm/models/create-quote-request.d.ts +5 -1
- package/dist/esm/models/create-quote-request.js +1 -1
- package/dist/esm/models/create-quote-response.d.ts +1 -1
- package/dist/esm/models/create-quote-response.js +1 -1
- package/dist/esm/models/create-rfqrequest.d.ts +6 -2
- package/dist/esm/models/create-rfqrequest.js +1 -1
- package/dist/esm/models/create-rfqresponse.d.ts +1 -1
- package/dist/esm/models/create-rfqresponse.js +1 -1
- package/dist/esm/models/create-subaccount-response.d.ts +17 -0
- package/dist/esm/models/create-subaccount-response.js +14 -0
- package/dist/esm/models/daily-schedule.d.ts +1 -1
- package/dist/esm/models/daily-schedule.js +1 -1
- package/dist/esm/models/decrease-order-request.d.ts +19 -1
- package/dist/esm/models/decrease-order-request.js +1 -1
- package/dist/esm/models/decrease-order-response.d.ts +1 -1
- package/dist/esm/models/decrease-order-response.js +1 -1
- package/dist/esm/models/error-response.d.ts +1 -1
- package/dist/esm/models/error-response.js +1 -1
- package/dist/esm/models/event-data.d.ts +1 -1
- package/dist/esm/models/event-data.js +1 -1
- package/dist/esm/models/event-position.d.ts +5 -1
- package/dist/esm/models/event-position.js +1 -1
- package/dist/esm/models/exchange-instance.d.ts +1 -1
- package/dist/esm/models/exchange-instance.js +1 -1
- package/dist/esm/models/exchange-status.d.ts +1 -1
- package/dist/esm/models/exchange-status.js +1 -1
- package/dist/esm/models/fill.d.ts +9 -1
- package/dist/esm/models/fill.js +1 -1
- package/dist/esm/models/forecast-percentiles-point.d.ts +1 -1
- package/dist/esm/models/forecast-percentiles-point.js +1 -1
- package/dist/esm/models/generate-api-key-request.d.ts +1 -1
- package/dist/esm/models/generate-api-key-request.js +1 -1
- package/dist/esm/models/generate-api-key-response.d.ts +1 -1
- package/dist/esm/models/generate-api-key-response.js +1 -1
- package/dist/esm/models/get-account-api-limits-response.d.ts +25 -0
- package/dist/esm/models/get-account-api-limits-response.js +14 -0
- package/dist/esm/models/get-api-keys-response.d.ts +1 -1
- package/dist/esm/models/get-api-keys-response.js +1 -1
- package/dist/esm/models/get-balance-response.d.ts +1 -1
- package/dist/esm/models/get-balance-response.js +1 -1
- package/dist/esm/models/get-communications-idresponse.d.ts +1 -1
- package/dist/esm/models/get-communications-idresponse.js +1 -1
- package/dist/esm/models/get-event-candlesticks-response.d.ts +1 -1
- package/dist/esm/models/get-event-candlesticks-response.js +1 -1
- package/dist/esm/models/get-event-forecast-percentiles-history-response.d.ts +1 -1
- package/dist/esm/models/get-event-forecast-percentiles-history-response.js +1 -1
- package/dist/esm/models/get-event-metadata-response.d.ts +1 -1
- package/dist/esm/models/get-event-metadata-response.js +1 -1
- package/dist/esm/models/get-event-response.d.ts +1 -1
- package/dist/esm/models/get-event-response.js +1 -1
- package/dist/esm/models/get-events-response.d.ts +1 -1
- package/dist/esm/models/get-events-response.js +1 -1
- package/dist/esm/models/get-exchange-announcements-response.d.ts +1 -1
- package/dist/esm/models/get-exchange-announcements-response.js +1 -1
- package/dist/esm/models/get-exchange-schedule-response.d.ts +1 -1
- package/dist/esm/models/get-exchange-schedule-response.js +1 -1
- package/dist/esm/models/get-fills-response.d.ts +1 -1
- package/dist/esm/models/get-fills-response.js +1 -1
- package/dist/esm/models/get-filters-by-sports-response.d.ts +1 -1
- package/dist/esm/models/get-filters-by-sports-response.js +1 -1
- package/dist/esm/models/get-incentive-programs-response.d.ts +1 -1
- package/dist/esm/models/get-incentive-programs-response.js +1 -1
- package/dist/esm/models/get-live-data-response.d.ts +1 -1
- package/dist/esm/models/get-live-data-response.js +1 -1
- package/dist/esm/models/get-live-datas-response.d.ts +1 -1
- package/dist/esm/models/get-live-datas-response.js +1 -1
- package/dist/esm/models/get-market-candlesticks-response.d.ts +1 -1
- package/dist/esm/models/get-market-candlesticks-response.js +1 -1
- package/dist/esm/models/get-market-orderbook-response.d.ts +3 -1
- package/dist/esm/models/get-market-orderbook-response.js +1 -1
- package/dist/esm/models/get-market-response.d.ts +1 -1
- package/dist/esm/models/get-market-response.js +1 -1
- package/dist/esm/models/get-markets-response.d.ts +1 -1
- package/dist/esm/models/get-markets-response.js +1 -1
- package/dist/esm/models/get-milestone-response.d.ts +1 -1
- package/dist/esm/models/get-milestone-response.js +1 -1
- package/dist/esm/models/get-milestones-response.d.ts +1 -1
- package/dist/esm/models/get-milestones-response.js +1 -1
- package/dist/esm/models/get-multivariate-event-collection-lookup-history-response.d.ts +1 -1
- package/dist/esm/models/get-multivariate-event-collection-lookup-history-response.js +1 -1
- package/dist/esm/models/get-multivariate-event-collection-response.d.ts +1 -1
- package/dist/esm/models/get-multivariate-event-collection-response.js +1 -1
- package/dist/esm/models/get-multivariate-event-collections-response.d.ts +1 -1
- package/dist/esm/models/get-multivariate-event-collections-response.js +1 -1
- package/dist/esm/models/get-multivariate-events-response.d.ts +1 -1
- package/dist/esm/models/get-multivariate-events-response.js +1 -1
- package/dist/esm/models/get-order-group-response.d.ts +9 -1
- package/dist/esm/models/get-order-group-response.js +1 -1
- package/dist/esm/models/get-order-groups-response.d.ts +1 -1
- package/dist/esm/models/get-order-groups-response.js +1 -1
- package/dist/esm/models/get-order-queue-position-response.d.ts +1 -1
- package/dist/esm/models/get-order-queue-position-response.js +1 -1
- package/dist/esm/models/get-order-queue-positions-response.d.ts +1 -1
- package/dist/esm/models/get-order-queue-positions-response.js +1 -1
- package/dist/esm/models/get-order-response.d.ts +1 -1
- package/dist/esm/models/get-order-response.js +1 -1
- package/dist/esm/models/get-orders-response.d.ts +1 -1
- package/dist/esm/models/get-orders-response.js +1 -1
- package/dist/esm/models/get-portfolio-resting-order-total-value-response.d.ts +1 -1
- package/dist/esm/models/get-portfolio-resting-order-total-value-response.js +1 -1
- package/dist/esm/models/get-positions-response.d.ts +1 -1
- package/dist/esm/models/get-positions-response.js +1 -1
- package/dist/esm/models/get-quote-response.d.ts +1 -1
- package/dist/esm/models/get-quote-response.js +1 -1
- package/dist/esm/models/get-quotes-response.d.ts +1 -1
- package/dist/esm/models/get-quotes-response.js +1 -1
- package/dist/esm/models/get-rfqresponse.d.ts +1 -1
- package/dist/esm/models/get-rfqresponse.js +1 -1
- package/dist/esm/models/get-rfqs-response.d.ts +1 -1
- package/dist/esm/models/get-rfqs-response.js +1 -1
- package/dist/esm/models/get-series-fee-changes-response.d.ts +1 -1
- package/dist/esm/models/get-series-fee-changes-response.js +1 -1
- package/dist/esm/models/get-series-list-response.d.ts +1 -1
- package/dist/esm/models/get-series-list-response.js +1 -1
- package/dist/esm/models/get-series-response.d.ts +1 -1
- package/dist/esm/models/get-series-response.js +1 -1
- package/dist/esm/models/get-settlements-response.d.ts +1 -1
- package/dist/esm/models/get-settlements-response.js +1 -1
- package/dist/esm/models/get-structured-target-response.d.ts +1 -1
- package/dist/esm/models/get-structured-target-response.js +1 -1
- package/dist/esm/models/get-structured-targets-response.d.ts +1 -1
- package/dist/esm/models/get-structured-targets-response.js +1 -1
- package/dist/esm/models/get-subaccount-balance-response.d.ts +21 -0
- package/dist/esm/models/get-subaccount-balance-response.js +14 -0
- package/dist/esm/models/get-subaccount-balances-response.d.ts +15 -0
- package/dist/esm/models/get-subaccount-balances-response.js +14 -0
- package/dist/esm/models/get-subaccount-transfers-response.d.ts +19 -0
- package/dist/esm/models/get-subaccount-transfers-response.js +14 -0
- package/dist/esm/models/get-tags-for-series-categories-response.d.ts +1 -1
- package/dist/esm/models/get-tags-for-series-categories-response.js +1 -1
- package/dist/esm/models/get-trades-response.d.ts +1 -1
- package/dist/esm/models/get-trades-response.js +1 -1
- package/dist/esm/models/get-user-data-timestamp-response.d.ts +1 -1
- package/dist/esm/models/get-user-data-timestamp-response.js +1 -1
- package/dist/esm/models/incentive-program.d.ts +5 -1
- package/dist/esm/models/incentive-program.js +1 -1
- package/dist/esm/models/index.d.ts +10 -0
- package/dist/esm/models/index.js +10 -0
- package/dist/esm/models/intra-exchange-instance-transfer-request.d.ts +9 -1
- package/dist/esm/models/intra-exchange-instance-transfer-request.js +1 -1
- package/dist/esm/models/intra-exchange-instance-transfer-response.d.ts +1 -1
- package/dist/esm/models/intra-exchange-instance-transfer-response.js +1 -1
- package/dist/esm/models/live-data.d.ts +1 -1
- package/dist/esm/models/live-data.js +1 -1
- package/dist/esm/models/lookup-point.d.ts +1 -1
- package/dist/esm/models/lookup-point.js +1 -1
- package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-request.d.ts +1 -1
- package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-request.js +1 -1
- package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-response.d.ts +1 -1
- package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-response.js +1 -1
- package/dist/esm/models/maintenance-window.d.ts +1 -1
- package/dist/esm/models/maintenance-window.js +1 -1
- package/dist/esm/models/market-candlestick.d.ts +9 -1
- package/dist/esm/models/market-candlestick.js +1 -1
- package/dist/esm/models/market-candlesticks-response.d.ts +1 -1
- package/dist/esm/models/market-candlesticks-response.js +1 -1
- package/dist/esm/models/market-metadata.d.ts +1 -1
- package/dist/esm/models/market-metadata.js +1 -1
- package/dist/esm/models/market-position.d.ts +5 -1
- package/dist/esm/models/market-position.js +1 -1
- package/dist/esm/models/market.d.ts +22 -1
- package/dist/esm/models/market.js +2 -1
- package/dist/esm/models/milestone.d.ts +1 -1
- package/dist/esm/models/milestone.js +1 -1
- package/dist/esm/models/multivariate-event-collection.d.ts +1 -1
- package/dist/esm/models/multivariate-event-collection.js +1 -1
- package/dist/esm/models/mve-selected-leg.d.ts +5 -1
- package/dist/esm/models/mve-selected-leg.js +1 -1
- package/dist/esm/models/order-group.d.ts +9 -1
- package/dist/esm/models/order-group.js +1 -1
- package/dist/esm/models/order-queue-position.d.ts +1 -1
- package/dist/esm/models/order-queue-position.js +1 -1
- package/dist/esm/models/order-status.d.ts +1 -1
- package/dist/esm/models/order-status.js +1 -1
- package/dist/esm/models/order.d.ts +13 -1
- package/dist/esm/models/order.js +1 -1
- package/dist/esm/models/orderbook-count-fp.d.ts +18 -0
- package/dist/esm/models/orderbook-count-fp.js +14 -0
- package/dist/esm/models/orderbook-level-count-fp-inner.d.ts +15 -0
- package/dist/esm/models/orderbook-level-count-fp-inner.js +14 -0
- package/dist/esm/models/orderbook.d.ts +4 -1
- package/dist/esm/models/orderbook.js +1 -1
- package/dist/esm/models/percentile-point.d.ts +1 -1
- package/dist/esm/models/percentile-point.js +1 -1
- package/dist/esm/models/price-distribution.d.ts +1 -1
- package/dist/esm/models/price-distribution.js +1 -1
- package/dist/esm/models/price-level-count-fp-inner.d.ts +15 -0
- package/dist/esm/models/price-level-count-fp-inner.js +14 -0
- package/dist/esm/models/price-level-dollars-inner.d.ts +15 -0
- package/dist/esm/models/price-level-dollars-inner.js +14 -0
- package/dist/esm/models/price-range.d.ts +1 -1
- package/dist/esm/models/price-range.js +1 -1
- package/dist/esm/models/quote.d.ts +5 -1
- package/dist/esm/models/quote.js +1 -1
- package/dist/esm/models/rfq.d.ts +6 -2
- package/dist/esm/models/rfq.js +1 -1
- package/dist/esm/models/schedule.d.ts +1 -1
- package/dist/esm/models/schedule.js +1 -1
- package/dist/esm/models/scope-list.d.ts +1 -1
- package/dist/esm/models/scope-list.js +1 -1
- package/dist/esm/models/self-trade-prevention-type.d.ts +1 -1
- package/dist/esm/models/self-trade-prevention-type.js +1 -1
- package/dist/esm/models/series-fee-change.d.ts +1 -1
- package/dist/esm/models/series-fee-change.js +1 -1
- package/dist/esm/models/series.d.ts +9 -1
- package/dist/esm/models/series.js +1 -1
- package/dist/esm/models/settlement-source.d.ts +1 -1
- package/dist/esm/models/settlement-source.js +1 -1
- package/dist/esm/models/settlement.d.ts +10 -2
- package/dist/esm/models/settlement.js +1 -1
- package/dist/esm/models/sport-filter-details.d.ts +1 -1
- package/dist/esm/models/sport-filter-details.js +1 -1
- package/dist/esm/models/structured-target.d.ts +1 -1
- package/dist/esm/models/structured-target.js +1 -1
- package/dist/esm/models/subaccount-balance.d.ts +25 -0
- package/dist/esm/models/subaccount-balance.js +14 -0
- package/dist/esm/models/subaccount-transfer.d.ts +33 -0
- package/dist/esm/models/subaccount-transfer.js +14 -0
- package/dist/esm/models/ticker-pair.d.ts +1 -1
- package/dist/esm/models/ticker-pair.js +1 -1
- package/dist/esm/models/trade.d.ts +5 -1
- package/dist/esm/models/trade.js +1 -1
- package/dist/esm/models/transfer-between-subaccounts-request.d.ts +25 -0
- package/dist/esm/models/transfer-between-subaccounts-request.js +14 -0
- package/dist/esm/models/update-order-group-limit-request.d.ts +21 -0
- package/dist/esm/models/update-order-group-limit-request.js +14 -0
- package/dist/esm/models/weekly-schedule.d.ts +1 -1
- package/dist/esm/models/weekly-schedule.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/accept-quote-request.d.ts +1 -1
- package/dist/models/accept-quote-request.js +1 -1
- package/dist/models/account-limit.d.ts +25 -0
- package/dist/models/account-limit.js +15 -0
- package/dist/models/amend-order-request.d.ts +12 -4
- package/dist/models/amend-order-request.js +1 -1
- package/dist/models/amend-order-response.d.ts +1 -1
- package/dist/models/amend-order-response.js +1 -1
- package/dist/models/announcement.d.ts +1 -1
- package/dist/models/announcement.js +1 -1
- package/dist/models/api-key.d.ts +1 -1
- package/dist/models/api-key.js +1 -1
- package/dist/models/apply-subaccount-transfer-request.d.ts +29 -0
- package/dist/models/apply-subaccount-transfer-request.js +15 -0
- package/dist/models/associated-event.d.ts +1 -1
- package/dist/models/associated-event.js +1 -1
- package/dist/models/batch-cancel-orders-individual-response.d.ts +5 -1
- package/dist/models/batch-cancel-orders-individual-response.js +1 -1
- package/dist/models/batch-cancel-orders-request-order.d.ts +21 -0
- package/dist/models/batch-cancel-orders-request-order.js +15 -0
- package/dist/models/batch-cancel-orders-request.d.ts +8 -2
- package/dist/models/batch-cancel-orders-request.js +1 -1
- package/dist/models/batch-cancel-orders-response.d.ts +1 -1
- package/dist/models/batch-cancel-orders-response.js +1 -1
- package/dist/models/batch-create-orders-individual-response.d.ts +1 -1
- package/dist/models/batch-create-orders-individual-response.js +1 -1
- package/dist/models/batch-create-orders-request.d.ts +1 -1
- package/dist/models/batch-create-orders-request.js +1 -1
- package/dist/models/batch-create-orders-response.d.ts +1 -1
- package/dist/models/batch-create-orders-response.js +1 -1
- package/dist/models/batch-get-market-candlesticks-response.d.ts +1 -1
- package/dist/models/batch-get-market-candlesticks-response.js +1 -1
- package/dist/models/bid-ask-distribution.d.ts +1 -1
- package/dist/models/bid-ask-distribution.js +1 -1
- package/dist/models/cancel-order-response.d.ts +5 -1
- package/dist/models/cancel-order-response.js +1 -1
- package/dist/models/create-api-key-request.d.ts +1 -1
- package/dist/models/create-api-key-request.js +1 -1
- package/dist/models/create-api-key-response.d.ts +1 -1
- package/dist/models/create-api-key-response.js +1 -1
- package/dist/models/create-market-in-multivariate-event-collection-request.d.ts +1 -1
- package/dist/models/create-market-in-multivariate-event-collection-request.js +1 -1
- package/dist/models/create-market-in-multivariate-event-collection-response.d.ts +1 -1
- package/dist/models/create-market-in-multivariate-event-collection-response.js +1 -1
- package/dist/models/create-order-group-request.d.ts +11 -3
- package/dist/models/create-order-group-request.js +1 -1
- package/dist/models/create-order-group-response.d.ts +1 -1
- package/dist/models/create-order-group-response.js +1 -1
- package/dist/models/create-order-request.d.ts +13 -2
- package/dist/models/create-order-request.js +1 -1
- package/dist/models/create-order-response.d.ts +1 -1
- package/dist/models/create-order-response.js +1 -1
- package/dist/models/create-quote-request.d.ts +5 -1
- package/dist/models/create-quote-request.js +1 -1
- package/dist/models/create-quote-response.d.ts +1 -1
- package/dist/models/create-quote-response.js +1 -1
- package/dist/models/create-rfqrequest.d.ts +6 -2
- package/dist/models/create-rfqrequest.js +1 -1
- package/dist/models/create-rfqresponse.d.ts +1 -1
- package/dist/models/create-rfqresponse.js +1 -1
- package/dist/models/create-subaccount-response.d.ts +17 -0
- package/dist/models/create-subaccount-response.js +15 -0
- package/dist/models/daily-schedule.d.ts +1 -1
- package/dist/models/daily-schedule.js +1 -1
- package/dist/models/decrease-order-request.d.ts +19 -1
- package/dist/models/decrease-order-request.js +1 -1
- package/dist/models/decrease-order-response.d.ts +1 -1
- package/dist/models/decrease-order-response.js +1 -1
- package/dist/models/error-response.d.ts +1 -1
- package/dist/models/error-response.js +1 -1
- package/dist/models/event-data.d.ts +1 -1
- package/dist/models/event-data.js +1 -1
- package/dist/models/event-position.d.ts +5 -1
- package/dist/models/event-position.js +1 -1
- package/dist/models/exchange-instance.d.ts +1 -1
- package/dist/models/exchange-instance.js +1 -1
- package/dist/models/exchange-status.d.ts +1 -1
- package/dist/models/exchange-status.js +1 -1
- package/dist/models/fill.d.ts +9 -1
- package/dist/models/fill.js +1 -1
- package/dist/models/forecast-percentiles-point.d.ts +1 -1
- package/dist/models/forecast-percentiles-point.js +1 -1
- package/dist/models/generate-api-key-request.d.ts +1 -1
- package/dist/models/generate-api-key-request.js +1 -1
- package/dist/models/generate-api-key-response.d.ts +1 -1
- package/dist/models/generate-api-key-response.js +1 -1
- package/dist/models/get-account-api-limits-response.d.ts +25 -0
- package/dist/models/get-account-api-limits-response.js +15 -0
- package/dist/models/get-api-keys-response.d.ts +1 -1
- package/dist/models/get-api-keys-response.js +1 -1
- package/dist/models/get-balance-response.d.ts +1 -1
- package/dist/models/get-balance-response.js +1 -1
- package/dist/models/get-communications-idresponse.d.ts +1 -1
- package/dist/models/get-communications-idresponse.js +1 -1
- package/dist/models/get-event-candlesticks-response.d.ts +1 -1
- package/dist/models/get-event-candlesticks-response.js +1 -1
- package/dist/models/get-event-forecast-percentiles-history-response.d.ts +1 -1
- package/dist/models/get-event-forecast-percentiles-history-response.js +1 -1
- package/dist/models/get-event-metadata-response.d.ts +1 -1
- package/dist/models/get-event-metadata-response.js +1 -1
- package/dist/models/get-event-response.d.ts +1 -1
- package/dist/models/get-event-response.js +1 -1
- package/dist/models/get-events-response.d.ts +1 -1
- package/dist/models/get-events-response.js +1 -1
- package/dist/models/get-exchange-announcements-response.d.ts +1 -1
- package/dist/models/get-exchange-announcements-response.js +1 -1
- package/dist/models/get-exchange-schedule-response.d.ts +1 -1
- package/dist/models/get-exchange-schedule-response.js +1 -1
- package/dist/models/get-fills-response.d.ts +1 -1
- package/dist/models/get-fills-response.js +1 -1
- package/dist/models/get-filters-by-sports-response.d.ts +1 -1
- package/dist/models/get-filters-by-sports-response.js +1 -1
- package/dist/models/get-incentive-programs-response.d.ts +1 -1
- package/dist/models/get-incentive-programs-response.js +1 -1
- package/dist/models/get-live-data-response.d.ts +1 -1
- package/dist/models/get-live-data-response.js +1 -1
- package/dist/models/get-live-datas-response.d.ts +1 -1
- package/dist/models/get-live-datas-response.js +1 -1
- package/dist/models/get-market-candlesticks-response.d.ts +1 -1
- package/dist/models/get-market-candlesticks-response.js +1 -1
- package/dist/models/get-market-orderbook-response.d.ts +3 -1
- package/dist/models/get-market-orderbook-response.js +1 -1
- package/dist/models/get-market-response.d.ts +1 -1
- package/dist/models/get-market-response.js +1 -1
- package/dist/models/get-markets-response.d.ts +1 -1
- package/dist/models/get-markets-response.js +1 -1
- package/dist/models/get-milestone-response.d.ts +1 -1
- package/dist/models/get-milestone-response.js +1 -1
- package/dist/models/get-milestones-response.d.ts +1 -1
- package/dist/models/get-milestones-response.js +1 -1
- package/dist/models/get-multivariate-event-collection-lookup-history-response.d.ts +1 -1
- package/dist/models/get-multivariate-event-collection-lookup-history-response.js +1 -1
- package/dist/models/get-multivariate-event-collection-response.d.ts +1 -1
- package/dist/models/get-multivariate-event-collection-response.js +1 -1
- package/dist/models/get-multivariate-event-collections-response.d.ts +1 -1
- package/dist/models/get-multivariate-event-collections-response.js +1 -1
- package/dist/models/get-multivariate-events-response.d.ts +1 -1
- package/dist/models/get-multivariate-events-response.js +1 -1
- package/dist/models/get-order-group-response.d.ts +9 -1
- package/dist/models/get-order-group-response.js +1 -1
- package/dist/models/get-order-groups-response.d.ts +1 -1
- package/dist/models/get-order-groups-response.js +1 -1
- package/dist/models/get-order-queue-position-response.d.ts +1 -1
- package/dist/models/get-order-queue-position-response.js +1 -1
- package/dist/models/get-order-queue-positions-response.d.ts +1 -1
- package/dist/models/get-order-queue-positions-response.js +1 -1
- package/dist/models/get-order-response.d.ts +1 -1
- package/dist/models/get-order-response.js +1 -1
- package/dist/models/get-orders-response.d.ts +1 -1
- package/dist/models/get-orders-response.js +1 -1
- package/dist/models/get-portfolio-resting-order-total-value-response.d.ts +1 -1
- package/dist/models/get-portfolio-resting-order-total-value-response.js +1 -1
- package/dist/models/get-positions-response.d.ts +1 -1
- package/dist/models/get-positions-response.js +1 -1
- package/dist/models/get-quote-response.d.ts +1 -1
- package/dist/models/get-quote-response.js +1 -1
- package/dist/models/get-quotes-response.d.ts +1 -1
- package/dist/models/get-quotes-response.js +1 -1
- package/dist/models/get-rfqresponse.d.ts +1 -1
- package/dist/models/get-rfqresponse.js +1 -1
- package/dist/models/get-rfqs-response.d.ts +1 -1
- package/dist/models/get-rfqs-response.js +1 -1
- package/dist/models/get-series-fee-changes-response.d.ts +1 -1
- package/dist/models/get-series-fee-changes-response.js +1 -1
- package/dist/models/get-series-list-response.d.ts +1 -1
- package/dist/models/get-series-list-response.js +1 -1
- package/dist/models/get-series-response.d.ts +1 -1
- package/dist/models/get-series-response.js +1 -1
- package/dist/models/get-settlements-response.d.ts +1 -1
- package/dist/models/get-settlements-response.js +1 -1
- package/dist/models/get-structured-target-response.d.ts +1 -1
- package/dist/models/get-structured-target-response.js +1 -1
- package/dist/models/get-structured-targets-response.d.ts +1 -1
- package/dist/models/get-structured-targets-response.js +1 -1
- package/dist/models/get-subaccount-balance-response.d.ts +21 -0
- package/dist/models/get-subaccount-balance-response.js +15 -0
- package/dist/models/get-subaccount-balances-response.d.ts +15 -0
- package/dist/models/get-subaccount-balances-response.js +15 -0
- package/dist/models/get-subaccount-transfers-response.d.ts +19 -0
- package/dist/models/get-subaccount-transfers-response.js +15 -0
- package/dist/models/get-tags-for-series-categories-response.d.ts +1 -1
- package/dist/models/get-tags-for-series-categories-response.js +1 -1
- package/dist/models/get-trades-response.d.ts +1 -1
- package/dist/models/get-trades-response.js +1 -1
- package/dist/models/get-user-data-timestamp-response.d.ts +1 -1
- package/dist/models/get-user-data-timestamp-response.js +1 -1
- package/dist/models/incentive-program.d.ts +5 -1
- package/dist/models/incentive-program.js +1 -1
- package/dist/models/index.d.ts +10 -0
- package/dist/models/index.js +10 -0
- package/dist/models/intra-exchange-instance-transfer-request.d.ts +9 -1
- package/dist/models/intra-exchange-instance-transfer-request.js +1 -1
- package/dist/models/intra-exchange-instance-transfer-response.d.ts +1 -1
- package/dist/models/intra-exchange-instance-transfer-response.js +1 -1
- package/dist/models/live-data.d.ts +1 -1
- package/dist/models/live-data.js +1 -1
- package/dist/models/lookup-point.d.ts +1 -1
- package/dist/models/lookup-point.js +1 -1
- package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-request.d.ts +1 -1
- package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-request.js +1 -1
- package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-response.d.ts +1 -1
- package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-response.js +1 -1
- package/dist/models/maintenance-window.d.ts +1 -1
- package/dist/models/maintenance-window.js +1 -1
- package/dist/models/market-candlestick.d.ts +9 -1
- package/dist/models/market-candlestick.js +1 -1
- package/dist/models/market-candlesticks-response.d.ts +1 -1
- package/dist/models/market-candlesticks-response.js +1 -1
- package/dist/models/market-metadata.d.ts +1 -1
- package/dist/models/market-metadata.js +1 -1
- package/dist/models/market-position.d.ts +5 -1
- package/dist/models/market-position.js +1 -1
- package/dist/models/market.d.ts +22 -1
- package/dist/models/market.js +2 -1
- package/dist/models/milestone.d.ts +1 -1
- package/dist/models/milestone.js +1 -1
- package/dist/models/multivariate-event-collection.d.ts +1 -1
- package/dist/models/multivariate-event-collection.js +1 -1
- package/dist/models/mve-selected-leg.d.ts +5 -1
- package/dist/models/mve-selected-leg.js +1 -1
- package/dist/models/order-group.d.ts +9 -1
- package/dist/models/order-group.js +1 -1
- package/dist/models/order-queue-position.d.ts +1 -1
- package/dist/models/order-queue-position.js +1 -1
- package/dist/models/order-status.d.ts +1 -1
- package/dist/models/order-status.js +1 -1
- package/dist/models/order.d.ts +13 -1
- package/dist/models/order.js +1 -1
- package/dist/models/orderbook-count-fp.d.ts +18 -0
- package/dist/models/orderbook-count-fp.js +15 -0
- package/dist/models/orderbook-level-count-fp-inner.d.ts +15 -0
- package/dist/models/orderbook-level-count-fp-inner.js +15 -0
- package/dist/models/orderbook.d.ts +4 -1
- package/dist/models/orderbook.js +1 -1
- package/dist/models/percentile-point.d.ts +1 -1
- package/dist/models/percentile-point.js +1 -1
- package/dist/models/price-distribution.d.ts +1 -1
- package/dist/models/price-distribution.js +1 -1
- package/dist/models/price-level-count-fp-inner.d.ts +15 -0
- package/dist/models/price-level-count-fp-inner.js +15 -0
- package/dist/models/price-level-dollars-inner.d.ts +15 -0
- package/dist/models/price-level-dollars-inner.js +15 -0
- package/dist/models/price-range.d.ts +1 -1
- package/dist/models/price-range.js +1 -1
- package/dist/models/quote.d.ts +5 -1
- package/dist/models/quote.js +1 -1
- package/dist/models/rfq.d.ts +6 -2
- package/dist/models/rfq.js +1 -1
- package/dist/models/schedule.d.ts +1 -1
- package/dist/models/schedule.js +1 -1
- package/dist/models/scope-list.d.ts +1 -1
- package/dist/models/scope-list.js +1 -1
- package/dist/models/self-trade-prevention-type.d.ts +1 -1
- package/dist/models/self-trade-prevention-type.js +1 -1
- package/dist/models/series-fee-change.d.ts +1 -1
- package/dist/models/series-fee-change.js +1 -1
- package/dist/models/series.d.ts +9 -1
- package/dist/models/series.js +1 -1
- package/dist/models/settlement-source.d.ts +1 -1
- package/dist/models/settlement-source.js +1 -1
- package/dist/models/settlement.d.ts +10 -2
- package/dist/models/settlement.js +1 -1
- package/dist/models/sport-filter-details.d.ts +1 -1
- package/dist/models/sport-filter-details.js +1 -1
- package/dist/models/structured-target.d.ts +1 -1
- package/dist/models/structured-target.js +1 -1
- package/dist/models/subaccount-balance.d.ts +25 -0
- package/dist/models/subaccount-balance.js +15 -0
- package/dist/models/subaccount-transfer.d.ts +33 -0
- package/dist/models/subaccount-transfer.js +15 -0
- package/dist/models/ticker-pair.d.ts +1 -1
- package/dist/models/ticker-pair.js +1 -1
- package/dist/models/trade.d.ts +5 -1
- package/dist/models/trade.js +1 -1
- package/dist/models/transfer-between-subaccounts-request.d.ts +25 -0
- package/dist/models/transfer-between-subaccounts-request.js +15 -0
- package/dist/models/update-order-group-limit-request.d.ts +21 -0
- package/dist/models/update-order-group-limit-request.js +15 -0
- package/dist/models/weekly-schedule.d.ts +1 -1
- package/dist/models/weekly-schedule.js +1 -1
- package/package.json +1 -1
package/dist/api/market-api.d.ts
CHANGED
|
@@ -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).
|
|
@@ -52,10 +52,11 @@ export declare const MarketApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
52
52
|
* @param {number} startTs Start timestamp (Unix timestamp). Candlesticks will include those ending on or after this time.
|
|
53
53
|
* @param {number} endTs End timestamp (Unix timestamp). Candlesticks will include those ending on or before this time.
|
|
54
54
|
* @param {GetMarketCandlesticksPeriodIntervalEnum} periodInterval Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day).
|
|
55
|
+
* @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
|
|
55
56
|
* @param {*} [options] Override http request option.
|
|
56
57
|
* @throws {RequiredError}
|
|
57
58
|
*/
|
|
58
|
-
getMarketCandlesticks: (seriesTicker: string, ticker: string, startTs: number, endTs: number, periodInterval: GetMarketCandlesticksPeriodIntervalEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
59
|
+
getMarketCandlesticks: (seriesTicker: string, ticker: string, startTs: number, endTs: number, periodInterval: GetMarketCandlesticksPeriodIntervalEnum, includeLatestBeforeStart?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
59
60
|
/**
|
|
60
61
|
* 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.
|
|
61
62
|
* @summary Get Market Orderbook
|
|
@@ -66,7 +67,7 @@ export declare const MarketApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
66
67
|
*/
|
|
67
68
|
getMarketOrderbook: (ticker: string, depth?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
69
|
/**
|
|
69
|
-
* 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|
|
|
70
|
+
* 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` |
|
|
70
71
|
* @summary Get Markets
|
|
71
72
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
|
|
72
73
|
* @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.
|
|
@@ -74,6 +75,7 @@ export declare const MarketApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
74
75
|
* @param {string} [seriesTicker] Filter by series ticker
|
|
75
76
|
* @param {number} [minCreatedTs] Filter items that created after this Unix timestamp
|
|
76
77
|
* @param {number} [maxCreatedTs] Filter items that created before this Unix timestamp
|
|
78
|
+
* @param {number} [minUpdatedTs] Return markets updated later than this Unix timestamp. Incompatible with any other filters.
|
|
77
79
|
* @param {number} [maxCloseTs] Filter items that close before this Unix timestamp
|
|
78
80
|
* @param {number} [minCloseTs] Filter items that close after this Unix timestamp
|
|
79
81
|
* @param {number} [minSettledTs] Filter items that settled after this Unix timestamp
|
|
@@ -84,25 +86,27 @@ export declare const MarketApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
84
86
|
* @param {*} [options] Override http request option.
|
|
85
87
|
* @throws {RequiredError}
|
|
86
88
|
*/
|
|
87
|
-
getMarkets: (limit?: number, cursor?: string, eventTicker?: string, seriesTicker?: string, minCreatedTs?: number, maxCreatedTs?: number, maxCloseTs?: number, minCloseTs?: number, minSettledTs?: number, maxSettledTs?: number, status?: GetMarketsStatusEnum, tickers?: string, mveFilter?: GetMarketsMveFilterEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
89
|
+
getMarkets: (limit?: number, cursor?: string, eventTicker?: string, seriesTicker?: string, minCreatedTs?: number, maxCreatedTs?: number, minUpdatedTs?: number, maxCloseTs?: number, minCloseTs?: number, minSettledTs?: number, maxSettledTs?: number, status?: GetMarketsStatusEnum, tickers?: string, mveFilter?: GetMarketsMveFilterEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
88
90
|
/**
|
|
89
91
|
* 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.
|
|
90
92
|
* @summary Get Series
|
|
91
93
|
* @param {string} seriesTicker The ticker of the series to retrieve
|
|
94
|
+
* @param {boolean} [includeVolume] If true, includes the total volume traded across all events in this series.
|
|
92
95
|
* @param {*} [options] Override http request option.
|
|
93
96
|
* @throws {RequiredError}
|
|
94
97
|
*/
|
|
95
|
-
getSeries: (seriesTicker: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
98
|
+
getSeries: (seriesTicker: string, includeVolume?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
96
99
|
/**
|
|
97
100
|
* 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.
|
|
98
101
|
* @summary Get Series List
|
|
99
102
|
* @param {string} [category]
|
|
100
103
|
* @param {string} [tags]
|
|
101
104
|
* @param {boolean} [includeProductMetadata]
|
|
105
|
+
* @param {boolean} [includeVolume] If true, includes the total volume traded across all events in each series.
|
|
102
106
|
* @param {*} [options] Override http request option.
|
|
103
107
|
* @throws {RequiredError}
|
|
104
108
|
*/
|
|
105
|
-
getSeriesList: (category?: string, tags?: string, includeProductMetadata?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
109
|
+
getSeriesList: (category?: string, tags?: string, includeProductMetadata?: boolean, includeVolume?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
106
110
|
/**
|
|
107
111
|
* 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.
|
|
108
112
|
* @summary Get Trades
|
|
@@ -148,10 +152,11 @@ export declare const MarketApiFp: (configuration?: Configuration) => {
|
|
|
148
152
|
* @param {number} startTs Start timestamp (Unix timestamp). Candlesticks will include those ending on or after this time.
|
|
149
153
|
* @param {number} endTs End timestamp (Unix timestamp). Candlesticks will include those ending on or before this time.
|
|
150
154
|
* @param {GetMarketCandlesticksPeriodIntervalEnum} periodInterval Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day).
|
|
155
|
+
* @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
|
|
151
156
|
* @param {*} [options] Override http request option.
|
|
152
157
|
* @throws {RequiredError}
|
|
153
158
|
*/
|
|
154
|
-
getMarketCandlesticks(seriesTicker: string, ticker: string, startTs: number, endTs: number, periodInterval: GetMarketCandlesticksPeriodIntervalEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMarketCandlesticksResponse>>;
|
|
159
|
+
getMarketCandlesticks(seriesTicker: string, ticker: string, startTs: number, endTs: number, periodInterval: GetMarketCandlesticksPeriodIntervalEnum, includeLatestBeforeStart?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMarketCandlesticksResponse>>;
|
|
155
160
|
/**
|
|
156
161
|
* 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.
|
|
157
162
|
* @summary Get Market Orderbook
|
|
@@ -162,7 +167,7 @@ export declare const MarketApiFp: (configuration?: Configuration) => {
|
|
|
162
167
|
*/
|
|
163
168
|
getMarketOrderbook(ticker: string, depth?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMarketOrderbookResponse>>;
|
|
164
169
|
/**
|
|
165
|
-
* 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|
|
|
170
|
+
* 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` |
|
|
166
171
|
* @summary Get Markets
|
|
167
172
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
|
|
168
173
|
* @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.
|
|
@@ -170,6 +175,7 @@ export declare const MarketApiFp: (configuration?: Configuration) => {
|
|
|
170
175
|
* @param {string} [seriesTicker] Filter by series ticker
|
|
171
176
|
* @param {number} [minCreatedTs] Filter items that created after this Unix timestamp
|
|
172
177
|
* @param {number} [maxCreatedTs] Filter items that created before this Unix timestamp
|
|
178
|
+
* @param {number} [minUpdatedTs] Return markets updated later than this Unix timestamp. Incompatible with any other filters.
|
|
173
179
|
* @param {number} [maxCloseTs] Filter items that close before this Unix timestamp
|
|
174
180
|
* @param {number} [minCloseTs] Filter items that close after this Unix timestamp
|
|
175
181
|
* @param {number} [minSettledTs] Filter items that settled after this Unix timestamp
|
|
@@ -180,25 +186,27 @@ export declare const MarketApiFp: (configuration?: Configuration) => {
|
|
|
180
186
|
* @param {*} [options] Override http request option.
|
|
181
187
|
* @throws {RequiredError}
|
|
182
188
|
*/
|
|
183
|
-
getMarkets(limit?: number, cursor?: string, eventTicker?: string, seriesTicker?: string, minCreatedTs?: number, maxCreatedTs?: number, maxCloseTs?: number, minCloseTs?: number, minSettledTs?: number, maxSettledTs?: number, status?: GetMarketsStatusEnum, tickers?: string, mveFilter?: GetMarketsMveFilterEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMarketsResponse>>;
|
|
189
|
+
getMarkets(limit?: number, cursor?: string, eventTicker?: string, seriesTicker?: string, minCreatedTs?: number, maxCreatedTs?: number, minUpdatedTs?: number, maxCloseTs?: number, minCloseTs?: number, minSettledTs?: number, maxSettledTs?: number, status?: GetMarketsStatusEnum, tickers?: string, mveFilter?: GetMarketsMveFilterEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMarketsResponse>>;
|
|
184
190
|
/**
|
|
185
191
|
* 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.
|
|
186
192
|
* @summary Get Series
|
|
187
193
|
* @param {string} seriesTicker The ticker of the series to retrieve
|
|
194
|
+
* @param {boolean} [includeVolume] If true, includes the total volume traded across all events in this series.
|
|
188
195
|
* @param {*} [options] Override http request option.
|
|
189
196
|
* @throws {RequiredError}
|
|
190
197
|
*/
|
|
191
|
-
getSeries(seriesTicker: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSeriesResponse>>;
|
|
198
|
+
getSeries(seriesTicker: string, includeVolume?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSeriesResponse>>;
|
|
192
199
|
/**
|
|
193
200
|
* 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.
|
|
194
201
|
* @summary Get Series List
|
|
195
202
|
* @param {string} [category]
|
|
196
203
|
* @param {string} [tags]
|
|
197
204
|
* @param {boolean} [includeProductMetadata]
|
|
205
|
+
* @param {boolean} [includeVolume] If true, includes the total volume traded across all events in each series.
|
|
198
206
|
* @param {*} [options] Override http request option.
|
|
199
207
|
* @throws {RequiredError}
|
|
200
208
|
*/
|
|
201
|
-
getSeriesList(category?: string, tags?: string, includeProductMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSeriesListResponse>>;
|
|
209
|
+
getSeriesList(category?: string, tags?: string, includeProductMetadata?: boolean, includeVolume?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSeriesListResponse>>;
|
|
202
210
|
/**
|
|
203
211
|
* 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.
|
|
204
212
|
* @summary Get Trades
|
|
@@ -244,10 +252,11 @@ export declare const MarketApiFactory: (configuration?: Configuration, basePath?
|
|
|
244
252
|
* @param {number} startTs Start timestamp (Unix timestamp). Candlesticks will include those ending on or after this time.
|
|
245
253
|
* @param {number} endTs End timestamp (Unix timestamp). Candlesticks will include those ending on or before this time.
|
|
246
254
|
* @param {GetMarketCandlesticksPeriodIntervalEnum} periodInterval Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day).
|
|
255
|
+
* @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
|
|
247
256
|
* @param {*} [options] Override http request option.
|
|
248
257
|
* @throws {RequiredError}
|
|
249
258
|
*/
|
|
250
|
-
getMarketCandlesticks(seriesTicker: string, ticker: string, startTs: number, endTs: number, periodInterval: GetMarketCandlesticksPeriodIntervalEnum, options?: RawAxiosRequestConfig): AxiosPromise<GetMarketCandlesticksResponse>;
|
|
259
|
+
getMarketCandlesticks(seriesTicker: string, ticker: string, startTs: number, endTs: number, periodInterval: GetMarketCandlesticksPeriodIntervalEnum, includeLatestBeforeStart?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<GetMarketCandlesticksResponse>;
|
|
251
260
|
/**
|
|
252
261
|
* 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.
|
|
253
262
|
* @summary Get Market Orderbook
|
|
@@ -258,7 +267,7 @@ export declare const MarketApiFactory: (configuration?: Configuration, basePath?
|
|
|
258
267
|
*/
|
|
259
268
|
getMarketOrderbook(ticker: string, depth?: number, options?: RawAxiosRequestConfig): AxiosPromise<GetMarketOrderbookResponse>;
|
|
260
269
|
/**
|
|
261
|
-
* 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|
|
|
270
|
+
* 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` |
|
|
262
271
|
* @summary Get Markets
|
|
263
272
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
|
|
264
273
|
* @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.
|
|
@@ -266,6 +275,7 @@ export declare const MarketApiFactory: (configuration?: Configuration, basePath?
|
|
|
266
275
|
* @param {string} [seriesTicker] Filter by series ticker
|
|
267
276
|
* @param {number} [minCreatedTs] Filter items that created after this Unix timestamp
|
|
268
277
|
* @param {number} [maxCreatedTs] Filter items that created before this Unix timestamp
|
|
278
|
+
* @param {number} [minUpdatedTs] Return markets updated later than this Unix timestamp. Incompatible with any other filters.
|
|
269
279
|
* @param {number} [maxCloseTs] Filter items that close before this Unix timestamp
|
|
270
280
|
* @param {number} [minCloseTs] Filter items that close after this Unix timestamp
|
|
271
281
|
* @param {number} [minSettledTs] Filter items that settled after this Unix timestamp
|
|
@@ -276,25 +286,27 @@ export declare const MarketApiFactory: (configuration?: Configuration, basePath?
|
|
|
276
286
|
* @param {*} [options] Override http request option.
|
|
277
287
|
* @throws {RequiredError}
|
|
278
288
|
*/
|
|
279
|
-
getMarkets(limit?: number, cursor?: string, eventTicker?: string, seriesTicker?: string, minCreatedTs?: number, maxCreatedTs?: number, maxCloseTs?: number, minCloseTs?: number, minSettledTs?: number, maxSettledTs?: number, status?: GetMarketsStatusEnum, tickers?: string, mveFilter?: GetMarketsMveFilterEnum, options?: RawAxiosRequestConfig): AxiosPromise<GetMarketsResponse>;
|
|
289
|
+
getMarkets(limit?: number, cursor?: string, eventTicker?: string, seriesTicker?: string, minCreatedTs?: number, maxCreatedTs?: number, minUpdatedTs?: number, maxCloseTs?: number, minCloseTs?: number, minSettledTs?: number, maxSettledTs?: number, status?: GetMarketsStatusEnum, tickers?: string, mveFilter?: GetMarketsMveFilterEnum, options?: RawAxiosRequestConfig): AxiosPromise<GetMarketsResponse>;
|
|
280
290
|
/**
|
|
281
291
|
* 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.
|
|
282
292
|
* @summary Get Series
|
|
283
293
|
* @param {string} seriesTicker The ticker of the series to retrieve
|
|
294
|
+
* @param {boolean} [includeVolume] If true, includes the total volume traded across all events in this series.
|
|
284
295
|
* @param {*} [options] Override http request option.
|
|
285
296
|
* @throws {RequiredError}
|
|
286
297
|
*/
|
|
287
|
-
getSeries(seriesTicker: string, options?: RawAxiosRequestConfig): AxiosPromise<GetSeriesResponse>;
|
|
298
|
+
getSeries(seriesTicker: string, includeVolume?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<GetSeriesResponse>;
|
|
288
299
|
/**
|
|
289
300
|
* 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.
|
|
290
301
|
* @summary Get Series List
|
|
291
302
|
* @param {string} [category]
|
|
292
303
|
* @param {string} [tags]
|
|
293
304
|
* @param {boolean} [includeProductMetadata]
|
|
305
|
+
* @param {boolean} [includeVolume] If true, includes the total volume traded across all events in each series.
|
|
294
306
|
* @param {*} [options] Override http request option.
|
|
295
307
|
* @throws {RequiredError}
|
|
296
308
|
*/
|
|
297
|
-
getSeriesList(category?: string, tags?: string, includeProductMetadata?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<GetSeriesListResponse>;
|
|
309
|
+
getSeriesList(category?: string, tags?: string, includeProductMetadata?: boolean, includeVolume?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<GetSeriesListResponse>;
|
|
298
310
|
/**
|
|
299
311
|
* 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.
|
|
300
312
|
* @summary Get Trades
|
|
@@ -340,10 +352,11 @@ export declare class MarketApi extends BaseAPI {
|
|
|
340
352
|
* @param {number} startTs Start timestamp (Unix timestamp). Candlesticks will include those ending on or after this time.
|
|
341
353
|
* @param {number} endTs End timestamp (Unix timestamp). Candlesticks will include those ending on or before this time.
|
|
342
354
|
* @param {GetMarketCandlesticksPeriodIntervalEnum} periodInterval Time period length of each candlestick in minutes. Valid values are 1 (1 minute), 60 (1 hour), or 1440 (1 day).
|
|
355
|
+
* @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
|
|
343
356
|
* @param {*} [options] Override http request option.
|
|
344
357
|
* @throws {RequiredError}
|
|
345
358
|
*/
|
|
346
|
-
getMarketCandlesticks(seriesTicker: string, ticker: string, startTs: number, endTs: number, periodInterval: GetMarketCandlesticksPeriodIntervalEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketCandlesticksResponse, any, {}>>;
|
|
359
|
+
getMarketCandlesticks(seriesTicker: string, ticker: string, startTs: number, endTs: number, periodInterval: GetMarketCandlesticksPeriodIntervalEnum, includeLatestBeforeStart?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketCandlesticksResponse, any, {}>>;
|
|
347
360
|
/**
|
|
348
361
|
* 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.
|
|
349
362
|
* @summary Get Market Orderbook
|
|
@@ -354,7 +367,7 @@ export declare class MarketApi extends BaseAPI {
|
|
|
354
367
|
*/
|
|
355
368
|
getMarketOrderbook(ticker: string, depth?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketOrderbookResponse, any, {}>>;
|
|
356
369
|
/**
|
|
357
|
-
* 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|
|
|
370
|
+
* 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` |
|
|
358
371
|
* @summary Get Markets
|
|
359
372
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
|
|
360
373
|
* @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.
|
|
@@ -362,6 +375,7 @@ export declare class MarketApi extends BaseAPI {
|
|
|
362
375
|
* @param {string} [seriesTicker] Filter by series ticker
|
|
363
376
|
* @param {number} [minCreatedTs] Filter items that created after this Unix timestamp
|
|
364
377
|
* @param {number} [maxCreatedTs] Filter items that created before this Unix timestamp
|
|
378
|
+
* @param {number} [minUpdatedTs] Return markets updated later than this Unix timestamp. Incompatible with any other filters.
|
|
365
379
|
* @param {number} [maxCloseTs] Filter items that close before this Unix timestamp
|
|
366
380
|
* @param {number} [minCloseTs] Filter items that close after this Unix timestamp
|
|
367
381
|
* @param {number} [minSettledTs] Filter items that settled after this Unix timestamp
|
|
@@ -372,25 +386,27 @@ export declare class MarketApi extends BaseAPI {
|
|
|
372
386
|
* @param {*} [options] Override http request option.
|
|
373
387
|
* @throws {RequiredError}
|
|
374
388
|
*/
|
|
375
|
-
getMarkets(limit?: number, cursor?: string, eventTicker?: string, seriesTicker?: string, minCreatedTs?: number, maxCreatedTs?: number, maxCloseTs?: number, minCloseTs?: number, minSettledTs?: number, maxSettledTs?: number, status?: GetMarketsStatusEnum, tickers?: string, mveFilter?: GetMarketsMveFilterEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketsResponse, any, {}>>;
|
|
389
|
+
getMarkets(limit?: number, cursor?: string, eventTicker?: string, seriesTicker?: string, minCreatedTs?: number, maxCreatedTs?: number, minUpdatedTs?: number, maxCloseTs?: number, minCloseTs?: number, minSettledTs?: number, maxSettledTs?: number, status?: GetMarketsStatusEnum, tickers?: string, mveFilter?: GetMarketsMveFilterEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketsResponse, any, {}>>;
|
|
376
390
|
/**
|
|
377
391
|
* 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.
|
|
378
392
|
* @summary Get Series
|
|
379
393
|
* @param {string} seriesTicker The ticker of the series to retrieve
|
|
394
|
+
* @param {boolean} [includeVolume] If true, includes the total volume traded across all events in this series.
|
|
380
395
|
* @param {*} [options] Override http request option.
|
|
381
396
|
* @throws {RequiredError}
|
|
382
397
|
*/
|
|
383
|
-
getSeries(seriesTicker: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSeriesResponse, any, {}>>;
|
|
398
|
+
getSeries(seriesTicker: string, includeVolume?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSeriesResponse, any, {}>>;
|
|
384
399
|
/**
|
|
385
400
|
* 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.
|
|
386
401
|
* @summary Get Series List
|
|
387
402
|
* @param {string} [category]
|
|
388
403
|
* @param {string} [tags]
|
|
389
404
|
* @param {boolean} [includeProductMetadata]
|
|
405
|
+
* @param {boolean} [includeVolume] If true, includes the total volume traded across all events in each series.
|
|
390
406
|
* @param {*} [options] Override http request option.
|
|
391
407
|
* @throws {RequiredError}
|
|
392
408
|
*/
|
|
393
|
-
getSeriesList(category?: string, tags?: string, includeProductMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSeriesListResponse, any, {}>>;
|
|
409
|
+
getSeriesList(category?: string, tags?: string, includeProductMetadata?: boolean, includeVolume?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSeriesListResponse, any, {}>>;
|
|
394
410
|
/**
|
|
395
411
|
* 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.
|
|
396
412
|
* @summary Get Trades
|