kalshi-typescript 3.14.0 → 3.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +14 -0
- package/README.md +12 -3
- package/api/account-api.ts +1 -1
- package/api/api-keys-api.ts +5 -5
- package/api/communications-api.ts +41 -15
- package/api/events-api.ts +10 -1
- package/api/exchange-api.ts +1 -1
- package/api/fcm-api.ts +1 -1
- package/api/historical-api.ts +5 -5
- package/api/incentive-programs-api.ts +1 -1
- package/api/live-data-api.ts +1 -1
- package/api/market-api.ts +27 -9
- package/api/milestone-api.ts +1 -1
- package/api/multivariate-api.ts +1 -1
- package/api/order-groups-api.ts +1 -1
- package/api/orders-api.ts +9 -9
- package/api/portfolio-api.ts +185 -9
- package/api/search-api.ts +1 -1
- package/api/structured-targets-api.ts +1 -1
- package/api.ts +1 -1
- package/base.ts +2 -2
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api/account-api.d.ts +1 -1
- package/dist/api/account-api.js +1 -1
- package/dist/api/api-keys-api.d.ts +5 -5
- package/dist/api/api-keys-api.js +5 -5
- package/dist/api/communications-api.d.ts +22 -9
- package/dist/api/communications-api.js +36 -15
- package/dist/api/events-api.d.ts +1 -1
- package/dist/api/events-api.js +7 -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/historical-api.d.ts +5 -5
- package/dist/api/historical-api.js +5 -5
- 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 +9 -9
- package/dist/api/market-api.js +21 -9
- 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 +1 -1
- package/dist/api/order-groups-api.js +1 -1
- package/dist/api/orders-api.d.ts +9 -9
- package/dist/api/orders-api.js +9 -9
- package/dist/api/portfolio-api.d.ts +83 -9
- package/dist/api/portfolio-api.js +165 -9
- 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 +1 -1
- package/dist/api.js +1 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +2 -2
- 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 +1 -1
- package/dist/esm/api/account-api.js +1 -1
- package/dist/esm/api/api-keys-api.d.ts +5 -5
- package/dist/esm/api/api-keys-api.js +5 -5
- package/dist/esm/api/communications-api.d.ts +22 -9
- package/dist/esm/api/communications-api.js +36 -15
- package/dist/esm/api/events-api.d.ts +1 -1
- package/dist/esm/api/events-api.js +8 -2
- 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/historical-api.d.ts +5 -5
- package/dist/esm/api/historical-api.js +5 -5
- 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 +9 -9
- package/dist/esm/api/market-api.js +22 -10
- 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 +1 -1
- package/dist/esm/api/order-groups-api.js +1 -1
- package/dist/esm/api/orders-api.d.ts +9 -9
- package/dist/esm/api/orders-api.js +9 -9
- package/dist/esm/api/portfolio-api.d.ts +83 -9
- package/dist/esm/api/portfolio-api.js +165 -9
- 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 +1 -1
- package/dist/esm/api.js +1 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +2 -2
- 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/amend-order-request.d.ts +1 -1
- 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/amend-order-v2-request.d.ts +1 -1
- package/dist/esm/models/amend-order-v2-request.js +1 -1
- package/dist/esm/models/amend-order-v2-response.d.ts +5 -1
- package/dist/esm/models/amend-order-v2-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 +1 -1
- package/dist/esm/models/apply-subaccount-transfer-request.js +1 -1
- 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 +1 -1
- package/dist/esm/models/batch-cancel-orders-individual-response.js +1 -1
- package/dist/esm/models/batch-cancel-orders-request-order.d.ts +1 -1
- package/dist/esm/models/batch-cancel-orders-request-order.js +1 -1
- package/dist/esm/models/batch-cancel-orders-request.d.ts +1 -1
- 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-cancel-orders-v2-request-orders-inner.d.ts +1 -1
- package/dist/esm/models/batch-cancel-orders-v2-request-orders-inner.js +1 -1
- package/dist/esm/models/batch-cancel-orders-v2-request.d.ts +1 -1
- package/dist/esm/models/batch-cancel-orders-v2-request.js +1 -1
- package/dist/esm/models/batch-cancel-orders-v2-response-orders-inner.d.ts +5 -1
- package/dist/esm/models/batch-cancel-orders-v2-response-orders-inner.js +1 -1
- package/dist/esm/models/batch-cancel-orders-v2-response.d.ts +1 -1
- package/dist/esm/models/batch-cancel-orders-v2-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-create-orders-v2-request.d.ts +1 -1
- package/dist/esm/models/batch-create-orders-v2-request.js +1 -1
- package/dist/esm/models/batch-create-orders-v2-response-orders-inner.d.ts +5 -1
- package/dist/esm/models/batch-create-orders-v2-response-orders-inner.js +1 -1
- package/dist/esm/models/batch-create-orders-v2-response.d.ts +1 -1
- package/dist/esm/models/batch-create-orders-v2-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-historical.d.ts +1 -1
- package/dist/esm/models/bid-ask-distribution-historical.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/book-side.d.ts +1 -1
- package/dist/esm/models/book-side.js +1 -1
- package/dist/esm/models/bucket-limit.d.ts +24 -0
- package/dist/esm/models/bucket-limit.js +14 -0
- package/dist/esm/models/cancel-order-response.d.ts +1 -1
- package/dist/esm/models/cancel-order-response.js +1 -1
- package/dist/esm/models/cancel-order-v2-response.d.ts +5 -1
- package/dist/esm/models/cancel-order-v2-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 +1 -1
- package/dist/esm/models/create-order-group-request.js +1 -1
- package/dist/esm/models/create-order-group-response.d.ts +5 -1
- package/dist/esm/models/create-order-group-response.js +1 -1
- package/dist/esm/models/create-order-request.d.ts +11 -1
- 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-order-v2-request.d.ts +11 -1
- package/dist/esm/models/create-order-v2-request.js +1 -1
- package/dist/esm/models/create-order-v2-response.d.ts +5 -1
- package/dist/esm/models/create-order-v2-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 +1 -1
- 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 +1 -1
- package/dist/esm/models/create-subaccount-response.js +1 -1
- 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 +1 -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/decrease-order-v2-request.d.ts +1 -1
- package/dist/esm/models/decrease-order-v2-request.js +1 -1
- package/dist/esm/models/decrease-order-v2-response.d.ts +5 -1
- package/dist/esm/models/decrease-order-v2-response.js +1 -1
- package/dist/esm/models/deposit.d.ts +56 -0
- package/dist/esm/models/deposit.js +26 -0
- package/dist/esm/models/endpoint-token-cost.d.ts +1 -1
- package/dist/esm/models/endpoint-token-cost.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 +9 -1
- package/dist/esm/models/event-data.js +1 -1
- package/dist/esm/models/event-position.d.ts +1 -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 +16 -3
- package/dist/esm/models/fill.js +5 -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 +5 -10
- package/dist/esm/models/get-account-api-limits-response.js +1 -1
- package/dist/esm/models/get-account-endpoint-costs-response.d.ts +1 -1
- package/dist/esm/models/get-account-endpoint-costs-response.js +1 -1
- 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 +6 -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-deposits-response.d.ts +16 -0
- package/dist/esm/models/get-deposits-response.js +14 -0
- 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-game-stats-response.d.ts +1 -1
- package/dist/esm/models/get-game-stats-response.js +1 -1
- package/dist/esm/models/get-historical-cutoff-response.d.ts +1 -1
- package/dist/esm/models/get-historical-cutoff-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-historical-response.d.ts +1 -1
- package/dist/esm/models/get-market-candlesticks-historical-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 +1 -1
- package/dist/esm/models/get-market-orderbook-response.js +1 -1
- package/dist/esm/models/get-market-orderbooks-response.d.ts +1 -1
- package/dist/esm/models/get-market-orderbooks-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 +1 -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-balances-response.d.ts +1 -1
- package/dist/esm/models/get-subaccount-balances-response.js +1 -1
- package/dist/esm/models/get-subaccount-netting-response.d.ts +1 -1
- package/dist/esm/models/get-subaccount-netting-response.js +1 -1
- package/dist/esm/models/get-subaccount-transfers-response.d.ts +1 -1
- package/dist/esm/models/get-subaccount-transfers-response.js +1 -1
- 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/get-withdrawals-response.d.ts +16 -0
- package/dist/esm/models/get-withdrawals-response.js +14 -0
- package/dist/esm/models/incentive-program.d.ts +1 -1
- package/dist/esm/models/incentive-program.js +1 -1
- package/dist/esm/models/index.d.ts +7 -0
- package/dist/esm/models/index.js +7 -0
- package/dist/esm/models/indexed-balance.d.ts +21 -0
- package/dist/esm/models/indexed-balance.js +14 -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-historical.d.ts +1 -1
- package/dist/esm/models/market-candlestick-historical.js +1 -1
- package/dist/esm/models/market-candlestick.d.ts +1 -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-orderbook-fp.d.ts +1 -1
- package/dist/esm/models/market-orderbook-fp.js +1 -1
- package/dist/esm/models/market-position.d.ts +1 -1
- package/dist/esm/models/market-position.js +1 -1
- package/dist/esm/models/market.d.ts +5 -6
- package/dist/esm/models/market.js +1 -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 +1 -1
- package/dist/esm/models/mve-selected-leg.js +1 -1
- package/dist/esm/models/order-group.d.ts +1 -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 +20 -1
- package/dist/esm/models/order.js +5 -1
- package/dist/esm/models/orderbook-count-fp.d.ts +1 -1
- package/dist/esm/models/orderbook-count-fp.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/play-by-play-periods-inner.d.ts +1 -1
- package/dist/esm/models/play-by-play-periods-inner.js +1 -1
- package/dist/esm/models/play-by-play.d.ts +1 -1
- package/dist/esm/models/play-by-play.js +1 -1
- package/dist/esm/models/price-distribution-historical.d.ts +1 -1
- package/dist/esm/models/price-distribution-historical.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-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 +1 -1
- 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 +2 -2
- package/dist/esm/models/self-trade-prevention-type.js +2 -2
- 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 +1 -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 +1 -1
- 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 +1 -1
- package/dist/esm/models/subaccount-balance.js +1 -1
- package/dist/esm/models/subaccount-netting-config.d.ts +1 -1
- package/dist/esm/models/subaccount-netting-config.js +1 -1
- package/dist/esm/models/subaccount-transfer.d.ts +1 -1
- package/dist/esm/models/subaccount-transfer.js +1 -1
- 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 +14 -2
- package/dist/esm/models/trade.js +5 -1
- package/dist/esm/models/update-order-group-limit-request.d.ts +1 -1
- package/dist/esm/models/update-order-group-limit-request.js +1 -1
- package/dist/esm/models/update-subaccount-netting-request.d.ts +1 -1
- package/dist/esm/models/update-subaccount-netting-request.js +1 -1
- package/dist/esm/models/user-filter.d.ts +18 -0
- package/dist/esm/models/user-filter.js +19 -0
- package/dist/esm/models/weekly-schedule.d.ts +1 -1
- package/dist/esm/models/weekly-schedule.js +1 -1
- package/dist/esm/models/withdrawal.d.ts +56 -0
- package/dist/esm/models/withdrawal.js +26 -0
- 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/amend-order-request.d.ts +1 -1
- 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/amend-order-v2-request.d.ts +1 -1
- package/dist/models/amend-order-v2-request.js +1 -1
- package/dist/models/amend-order-v2-response.d.ts +5 -1
- package/dist/models/amend-order-v2-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 +1 -1
- package/dist/models/apply-subaccount-transfer-request.js +1 -1
- 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 +1 -1
- package/dist/models/batch-cancel-orders-individual-response.js +1 -1
- package/dist/models/batch-cancel-orders-request-order.d.ts +1 -1
- package/dist/models/batch-cancel-orders-request-order.js +1 -1
- package/dist/models/batch-cancel-orders-request.d.ts +1 -1
- 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-cancel-orders-v2-request-orders-inner.d.ts +1 -1
- package/dist/models/batch-cancel-orders-v2-request-orders-inner.js +1 -1
- package/dist/models/batch-cancel-orders-v2-request.d.ts +1 -1
- package/dist/models/batch-cancel-orders-v2-request.js +1 -1
- package/dist/models/batch-cancel-orders-v2-response-orders-inner.d.ts +5 -1
- package/dist/models/batch-cancel-orders-v2-response-orders-inner.js +1 -1
- package/dist/models/batch-cancel-orders-v2-response.d.ts +1 -1
- package/dist/models/batch-cancel-orders-v2-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-create-orders-v2-request.d.ts +1 -1
- package/dist/models/batch-create-orders-v2-request.js +1 -1
- package/dist/models/batch-create-orders-v2-response-orders-inner.d.ts +5 -1
- package/dist/models/batch-create-orders-v2-response-orders-inner.js +1 -1
- package/dist/models/batch-create-orders-v2-response.d.ts +1 -1
- package/dist/models/batch-create-orders-v2-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-historical.d.ts +1 -1
- package/dist/models/bid-ask-distribution-historical.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/book-side.d.ts +1 -1
- package/dist/models/book-side.js +1 -1
- package/dist/models/bucket-limit.d.ts +24 -0
- package/dist/models/bucket-limit.js +15 -0
- package/dist/models/cancel-order-response.d.ts +1 -1
- package/dist/models/cancel-order-response.js +1 -1
- package/dist/models/cancel-order-v2-response.d.ts +5 -1
- package/dist/models/cancel-order-v2-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 +1 -1
- package/dist/models/create-order-group-request.js +1 -1
- package/dist/models/create-order-group-response.d.ts +5 -1
- package/dist/models/create-order-group-response.js +1 -1
- package/dist/models/create-order-request.d.ts +11 -1
- 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-order-v2-request.d.ts +11 -1
- package/dist/models/create-order-v2-request.js +1 -1
- package/dist/models/create-order-v2-response.d.ts +5 -1
- package/dist/models/create-order-v2-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 +1 -1
- 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 +1 -1
- package/dist/models/create-subaccount-response.js +1 -1
- 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 +1 -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/decrease-order-v2-request.d.ts +1 -1
- package/dist/models/decrease-order-v2-request.js +1 -1
- package/dist/models/decrease-order-v2-response.d.ts +5 -1
- package/dist/models/decrease-order-v2-response.js +1 -1
- package/dist/models/deposit.d.ts +56 -0
- package/dist/models/deposit.js +29 -0
- package/dist/models/endpoint-token-cost.d.ts +1 -1
- package/dist/models/endpoint-token-cost.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 +9 -1
- package/dist/models/event-data.js +1 -1
- package/dist/models/event-position.d.ts +1 -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 +16 -3
- package/dist/models/fill.js +6 -2
- 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 +5 -10
- package/dist/models/get-account-api-limits-response.js +1 -1
- package/dist/models/get-account-endpoint-costs-response.d.ts +1 -1
- package/dist/models/get-account-endpoint-costs-response.js +1 -1
- 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 +6 -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-deposits-response.d.ts +16 -0
- package/dist/models/get-deposits-response.js +15 -0
- 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-game-stats-response.d.ts +1 -1
- package/dist/models/get-game-stats-response.js +1 -1
- package/dist/models/get-historical-cutoff-response.d.ts +1 -1
- package/dist/models/get-historical-cutoff-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-historical-response.d.ts +1 -1
- package/dist/models/get-market-candlesticks-historical-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 +1 -1
- package/dist/models/get-market-orderbook-response.js +1 -1
- package/dist/models/get-market-orderbooks-response.d.ts +1 -1
- package/dist/models/get-market-orderbooks-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 +1 -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-balances-response.d.ts +1 -1
- package/dist/models/get-subaccount-balances-response.js +1 -1
- package/dist/models/get-subaccount-netting-response.d.ts +1 -1
- package/dist/models/get-subaccount-netting-response.js +1 -1
- package/dist/models/get-subaccount-transfers-response.d.ts +1 -1
- package/dist/models/get-subaccount-transfers-response.js +1 -1
- 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/get-withdrawals-response.d.ts +16 -0
- package/dist/models/get-withdrawals-response.js +15 -0
- package/dist/models/incentive-program.d.ts +1 -1
- package/dist/models/incentive-program.js +1 -1
- package/dist/models/index.d.ts +7 -0
- package/dist/models/index.js +7 -0
- package/dist/models/indexed-balance.d.ts +21 -0
- package/dist/models/indexed-balance.js +15 -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-historical.d.ts +1 -1
- package/dist/models/market-candlestick-historical.js +1 -1
- package/dist/models/market-candlestick.d.ts +1 -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-orderbook-fp.d.ts +1 -1
- package/dist/models/market-orderbook-fp.js +1 -1
- package/dist/models/market-position.d.ts +1 -1
- package/dist/models/market-position.js +1 -1
- package/dist/models/market.d.ts +5 -6
- package/dist/models/market.js +1 -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 +1 -1
- package/dist/models/mve-selected-leg.js +1 -1
- package/dist/models/order-group.d.ts +1 -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 +20 -1
- package/dist/models/order.js +6 -2
- package/dist/models/orderbook-count-fp.d.ts +1 -1
- package/dist/models/orderbook-count-fp.js +1 -1
- package/dist/models/percentile-point.d.ts +1 -1
- package/dist/models/percentile-point.js +1 -1
- package/dist/models/play-by-play-periods-inner.d.ts +1 -1
- package/dist/models/play-by-play-periods-inner.js +1 -1
- package/dist/models/play-by-play.d.ts +1 -1
- package/dist/models/play-by-play.js +1 -1
- package/dist/models/price-distribution-historical.d.ts +1 -1
- package/dist/models/price-distribution-historical.js +1 -1
- package/dist/models/price-distribution.d.ts +1 -1
- package/dist/models/price-distribution.js +1 -1
- 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 +1 -1
- 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 +2 -2
- package/dist/models/self-trade-prevention-type.js +2 -2
- 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 +1 -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 +1 -1
- 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 +1 -1
- package/dist/models/subaccount-balance.js +1 -1
- package/dist/models/subaccount-netting-config.d.ts +1 -1
- package/dist/models/subaccount-netting-config.js +1 -1
- package/dist/models/subaccount-transfer.d.ts +1 -1
- package/dist/models/subaccount-transfer.js +1 -1
- package/dist/models/ticker-pair.d.ts +1 -1
- package/dist/models/ticker-pair.js +1 -1
- package/dist/models/trade.d.ts +14 -2
- package/dist/models/trade.js +6 -2
- package/dist/models/update-order-group-limit-request.d.ts +1 -1
- package/dist/models/update-order-group-limit-request.js +1 -1
- package/dist/models/update-subaccount-netting-request.d.ts +1 -1
- package/dist/models/update-subaccount-netting-request.js +1 -1
- package/dist/models/user-filter.d.ts +18 -0
- package/dist/models/user-filter.js +22 -0
- package/dist/models/weekly-schedule.d.ts +1 -1
- package/dist/models/weekly-schedule.js +1 -1
- package/dist/models/withdrawal.d.ts +56 -0
- package/dist/models/withdrawal.js +29 -0
- package/docs/AccountApi.md +1 -1
- package/docs/AmendOrderV2Response.md +2 -0
- package/docs/ApiKeysApi.md +2 -2
- package/docs/BatchCancelOrdersV2ResponseOrdersInner.md +2 -0
- package/docs/BatchCreateOrdersV2ResponseOrdersInner.md +2 -0
- package/docs/BucketLimit.md +23 -0
- package/docs/CancelOrderV2Response.md +2 -0
- package/docs/CommunicationsApi.md +4 -1
- package/docs/CreateOrderGroupResponse.md +2 -0
- package/docs/CreateOrderRequest.md +4 -2
- package/docs/CreateOrderV2Request.md +4 -2
- package/docs/CreateOrderV2Response.md +2 -0
- package/docs/CreateQuoteRequest.md +2 -0
- package/docs/DecreaseOrderV2Response.md +2 -0
- package/docs/Deposit.md +32 -0
- package/docs/EventData.md +4 -0
- package/docs/EventsApi.md +2 -2
- package/docs/ExchangeApi.md +1 -1
- package/docs/FcmApi.md +1 -1
- package/docs/Fill.md +6 -2
- package/docs/GetAccountApiLimitsResponse.md +5 -5
- package/docs/GetBalanceResponse.md +2 -0
- package/docs/GetDepositsResponse.md +22 -0
- package/docs/GetWithdrawalsResponse.md +22 -0
- package/docs/HistoricalApi.md +2 -2
- package/docs/IncentiveProgramsApi.md +1 -1
- package/docs/IndexedBalance.md +22 -0
- package/docs/IntraExchangeInstanceTransferRequest.md +4 -0
- package/docs/LiveDataApi.md +1 -1
- package/docs/Market.md +1 -3
- package/docs/MarketApi.md +5 -5
- package/docs/MilestoneApi.md +1 -1
- package/docs/MultivariateApi.md +1 -1
- package/docs/Order.md +6 -2
- package/docs/OrderGroupsApi.md +1 -1
- package/docs/OrdersApi.md +3 -3
- package/docs/PortfolioApi.md +75 -3
- package/docs/Quote.md +2 -0
- package/docs/SearchApi.md +1 -1
- package/docs/SelfTradePreventionType.md +1 -1
- package/docs/StructuredTargetsApi.md +1 -1
- package/docs/Trade.md +5 -1
- package/docs/UserFilter.md +9 -0
- package/docs/Withdrawal.md +32 -0
- package/index.ts +1 -1
- package/models/accept-quote-request.ts +1 -1
- package/models/amend-order-request.ts +1 -1
- package/models/amend-order-response.ts +1 -1
- package/models/amend-order-v2-request.ts +1 -1
- package/models/amend-order-v2-response.ts +5 -1
- package/models/announcement.ts +1 -1
- package/models/api-key.ts +1 -1
- package/models/apply-subaccount-transfer-request.ts +1 -1
- package/models/associated-event.ts +1 -1
- package/models/batch-cancel-orders-individual-response.ts +1 -1
- package/models/batch-cancel-orders-request-order.ts +1 -1
- package/models/batch-cancel-orders-request.ts +1 -1
- package/models/batch-cancel-orders-response.ts +1 -1
- package/models/batch-cancel-orders-v2-request-orders-inner.ts +1 -1
- package/models/batch-cancel-orders-v2-request.ts +1 -1
- package/models/batch-cancel-orders-v2-response-orders-inner.ts +5 -1
- package/models/batch-cancel-orders-v2-response.ts +1 -1
- package/models/batch-create-orders-individual-response.ts +1 -1
- package/models/batch-create-orders-request.ts +1 -1
- package/models/batch-create-orders-response.ts +1 -1
- package/models/batch-create-orders-v2-request.ts +1 -1
- package/models/batch-create-orders-v2-response-orders-inner.ts +5 -1
- package/models/batch-create-orders-v2-response.ts +1 -1
- package/models/batch-get-market-candlesticks-response.ts +1 -1
- package/models/bid-ask-distribution-historical.ts +1 -1
- package/models/bid-ask-distribution.ts +1 -1
- package/models/book-side.ts +1 -1
- package/models/bucket-limit.ts +30 -0
- package/models/cancel-order-response.ts +1 -1
- package/models/cancel-order-v2-response.ts +5 -1
- package/models/create-api-key-request.ts +1 -1
- package/models/create-api-key-response.ts +1 -1
- package/models/create-market-in-multivariate-event-collection-request.ts +1 -1
- package/models/create-market-in-multivariate-event-collection-response.ts +1 -1
- package/models/create-order-group-request.ts +1 -1
- package/models/create-order-group-response.ts +5 -1
- package/models/create-order-request.ts +11 -1
- package/models/create-order-response.ts +1 -1
- package/models/create-order-v2-request.ts +11 -1
- package/models/create-order-v2-response.ts +5 -1
- package/models/create-quote-request.ts +5 -1
- package/models/create-quote-response.ts +1 -1
- package/models/create-rfqrequest.ts +1 -1
- package/models/create-rfqresponse.ts +1 -1
- package/models/create-subaccount-response.ts +1 -1
- package/models/daily-schedule.ts +1 -1
- package/models/decrease-order-request.ts +1 -1
- package/models/decrease-order-response.ts +1 -1
- package/models/decrease-order-v2-request.ts +1 -1
- package/models/decrease-order-v2-response.ts +5 -1
- package/models/deposit.ts +66 -0
- package/models/endpoint-token-cost.ts +1 -1
- package/models/error-response.ts +1 -1
- package/models/event-data.ts +9 -1
- package/models/event-position.ts +1 -1
- package/models/exchange-instance.ts +1 -1
- package/models/exchange-status.ts +1 -1
- package/models/fill.ts +19 -3
- package/models/forecast-percentiles-point.ts +1 -1
- package/models/generate-api-key-request.ts +1 -1
- package/models/generate-api-key-response.ts +1 -1
- package/models/get-account-api-limits-response.ts +7 -10
- package/models/get-account-endpoint-costs-response.ts +1 -1
- package/models/get-api-keys-response.ts +1 -1
- package/models/get-balance-response.ts +8 -1
- package/models/get-communications-idresponse.ts +1 -1
- package/models/get-deposits-response.ts +24 -0
- package/models/get-event-candlesticks-response.ts +1 -1
- package/models/get-event-forecast-percentiles-history-response.ts +1 -1
- package/models/get-event-metadata-response.ts +1 -1
- package/models/get-event-response.ts +1 -1
- package/models/get-events-response.ts +1 -1
- package/models/get-exchange-announcements-response.ts +1 -1
- package/models/get-exchange-schedule-response.ts +1 -1
- package/models/get-fills-response.ts +1 -1
- package/models/get-filters-by-sports-response.ts +1 -1
- package/models/get-game-stats-response.ts +1 -1
- package/models/get-historical-cutoff-response.ts +1 -1
- package/models/get-incentive-programs-response.ts +1 -1
- package/models/get-live-data-response.ts +1 -1
- package/models/get-live-datas-response.ts +1 -1
- package/models/get-market-candlesticks-historical-response.ts +1 -1
- package/models/get-market-candlesticks-response.ts +1 -1
- package/models/get-market-orderbook-response.ts +1 -1
- package/models/get-market-orderbooks-response.ts +1 -1
- package/models/get-market-response.ts +1 -1
- package/models/get-markets-response.ts +1 -1
- package/models/get-milestone-response.ts +1 -1
- package/models/get-milestones-response.ts +1 -1
- package/models/get-multivariate-event-collection-lookup-history-response.ts +1 -1
- package/models/get-multivariate-event-collection-response.ts +1 -1
- package/models/get-multivariate-event-collections-response.ts +1 -1
- package/models/get-multivariate-events-response.ts +1 -1
- package/models/get-order-group-response.ts +1 -1
- package/models/get-order-groups-response.ts +1 -1
- package/models/get-order-queue-position-response.ts +1 -1
- package/models/get-order-queue-positions-response.ts +1 -1
- package/models/get-order-response.ts +1 -1
- package/models/get-orders-response.ts +1 -1
- package/models/get-portfolio-resting-order-total-value-response.ts +1 -1
- package/models/get-positions-response.ts +1 -1
- package/models/get-quote-response.ts +1 -1
- package/models/get-quotes-response.ts +1 -1
- package/models/get-rfqresponse.ts +1 -1
- package/models/get-rfqs-response.ts +1 -1
- package/models/get-series-fee-changes-response.ts +1 -1
- package/models/get-series-list-response.ts +1 -1
- package/models/get-series-response.ts +1 -1
- package/models/get-settlements-response.ts +1 -1
- package/models/get-structured-target-response.ts +1 -1
- package/models/get-structured-targets-response.ts +1 -1
- package/models/get-subaccount-balances-response.ts +1 -1
- package/models/get-subaccount-netting-response.ts +1 -1
- package/models/get-subaccount-transfers-response.ts +1 -1
- package/models/get-tags-for-series-categories-response.ts +1 -1
- package/models/get-trades-response.ts +1 -1
- package/models/get-user-data-timestamp-response.ts +1 -1
- package/models/get-withdrawals-response.ts +24 -0
- package/models/incentive-program.ts +1 -1
- package/models/index.ts +7 -0
- package/models/indexed-balance.ts +27 -0
- package/models/intra-exchange-instance-transfer-request.ts +9 -1
- package/models/intra-exchange-instance-transfer-response.ts +1 -1
- package/models/live-data.ts +1 -1
- package/models/lookup-point.ts +1 -1
- package/models/lookup-tickers-for-market-in-multivariate-event-collection-request.ts +1 -1
- package/models/lookup-tickers-for-market-in-multivariate-event-collection-response.ts +1 -1
- package/models/maintenance-window.ts +1 -1
- package/models/market-candlestick-historical.ts +1 -1
- package/models/market-candlestick.ts +1 -1
- package/models/market-candlesticks-response.ts +1 -1
- package/models/market-metadata.ts +1 -1
- package/models/market-orderbook-fp.ts +1 -1
- package/models/market-position.ts +1 -1
- package/models/market.ts +5 -6
- package/models/milestone.ts +1 -1
- package/models/multivariate-event-collection.ts +1 -1
- package/models/mve-selected-leg.ts +1 -1
- package/models/order-group.ts +1 -1
- package/models/order-queue-position.ts +1 -1
- package/models/order-status.ts +1 -1
- package/models/order.ts +23 -1
- package/models/orderbook-count-fp.ts +1 -1
- package/models/percentile-point.ts +1 -1
- package/models/play-by-play-periods-inner.ts +1 -1
- package/models/play-by-play.ts +1 -1
- package/models/price-distribution-historical.ts +1 -1
- package/models/price-distribution.ts +1 -1
- package/models/price-range.ts +1 -1
- package/models/quote.ts +5 -1
- package/models/rfq.ts +1 -1
- package/models/schedule.ts +1 -1
- package/models/scope-list.ts +1 -1
- package/models/self-trade-prevention-type.ts +2 -2
- package/models/series-fee-change.ts +1 -1
- package/models/series.ts +1 -1
- package/models/settlement-source.ts +1 -1
- package/models/settlement.ts +1 -1
- package/models/sport-filter-details.ts +1 -1
- package/models/structured-target.ts +1 -1
- package/models/subaccount-balance.ts +1 -1
- package/models/subaccount-netting-config.ts +1 -1
- package/models/subaccount-transfer.ts +1 -1
- package/models/ticker-pair.ts +1 -1
- package/models/trade.ts +17 -2
- package/models/update-order-group-limit-request.ts +1 -1
- package/models/update-subaccount-netting-request.ts +1 -1
- package/models/user-filter.ts +28 -0
- package/models/weekly-schedule.ts +1 -1
- package/models/withdrawal.ts +66 -0
- package/package.json +1 -1
package/docs/ApiKeysApi.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# ApiKeysApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://api.
|
|
3
|
+
All URIs are relative to *https://external-api.kalshi.com/trade-api/v2*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
@@ -12,7 +12,7 @@ All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
|
|
|
12
12
|
# **createApiKey**
|
|
13
13
|
> CreateApiKeyResponse createApiKey(createApiKeyRequest)
|
|
14
14
|
|
|
15
|
-
Endpoint for creating a new API key with a user-provided public key.
|
|
15
|
+
Endpoint for creating a new API key with a user-provided public key. This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests.
|
|
16
16
|
|
|
17
17
|
### Parameters
|
|
18
18
|
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**order_id** | **string** | The order ID identifying which order this entry corresponds to. | [default to undefined]
|
|
9
9
|
**client_order_id** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**reduced_by** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
|
|
11
|
+
**ts_ms** | **number** | Matching engine timestamp at which the cancellation was processed, as Unix epoch milliseconds. Absent when the cancel errored. | [optional] [default to undefined]
|
|
11
12
|
**error** | [**ErrorResponse**](ErrorResponse.md) | | [optional] [default to undefined]
|
|
12
13
|
|
|
13
14
|
## Example
|
|
@@ -19,6 +20,7 @@ const instance: BatchCancelOrdersV2ResponseOrdersInner = {
|
|
|
19
20
|
order_id,
|
|
20
21
|
client_order_id,
|
|
21
22
|
reduced_by,
|
|
23
|
+
ts_ms,
|
|
22
24
|
error,
|
|
23
25
|
};
|
|
24
26
|
```
|
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**remaining_count** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [optional] [default to undefined]
|
|
12
12
|
**average_fill_price** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [optional] [default to undefined]
|
|
13
13
|
**average_fee_paid** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [optional] [default to undefined]
|
|
14
|
+
**ts_ms** | **number** | Matching engine timestamp at which the order was processed, as Unix epoch milliseconds. Absent when the request errored. | [optional] [default to undefined]
|
|
14
15
|
**error** | [**ErrorResponse**](ErrorResponse.md) | | [optional] [default to undefined]
|
|
15
16
|
|
|
16
17
|
## Example
|
|
@@ -25,6 +26,7 @@ const instance: BatchCreateOrdersV2ResponseOrdersInner = {
|
|
|
25
26
|
remaining_count,
|
|
26
27
|
average_fill_price,
|
|
27
28
|
average_fee_paid,
|
|
29
|
+
ts_ms,
|
|
28
30
|
error,
|
|
29
31
|
};
|
|
30
32
|
```
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# BucketLimit
|
|
2
|
+
|
|
3
|
+
Token-bucket budget for one rate-limit bucket. Each request deducts tokens equal to its endpoint cost; the bucket refills at refill_rate tokens per second up to bucket_capacity. A request is allowed if the bucket holds enough tokens to cover its cost; otherwise the request is rejected with HTTP 429.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**refill_rate** | **number** | Tokens added to the bucket per second. | [default to undefined]
|
|
10
|
+
**bucket_capacity** | **number** | Maximum tokens the bucket can hold. When equal to refill_rate the bucket holds one second of budget; larger values represent burst headroom that idle clients accumulate and can spend in a single pulse (e.g. write buckets at non-Basic tiers hold two seconds of budget). | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { BucketLimit } from 'kalshi-typescript';
|
|
16
|
+
|
|
17
|
+
const instance: BucketLimit = {
|
|
18
|
+
refill_rate,
|
|
19
|
+
bucket_capacity,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**order_id** | **string** | | [default to undefined]
|
|
9
9
|
**client_order_id** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**reduced_by** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
|
|
11
|
+
**ts_ms** | **number** | Matching engine timestamp at which the cancellation was processed, as Unix epoch milliseconds. | [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -18,6 +19,7 @@ const instance: CancelOrderV2Response = {
|
|
|
18
19
|
order_id,
|
|
19
20
|
client_order_id,
|
|
20
21
|
reduced_by,
|
|
22
|
+
ts_ms,
|
|
21
23
|
};
|
|
22
24
|
```
|
|
23
25
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# CommunicationsApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://api.
|
|
3
|
+
All URIs are relative to *https://external-api.kalshi.com/trade-api/v2*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
@@ -303,6 +303,8 @@ This endpoint does not have any parameters.
|
|
|
303
303
|
| **limit** | [**number**] | Parameter to specify the number of results per page. Defaults to 500. | (optional) defaults to 500|
|
|
304
304
|
| **status** | [**string**] | Filter quotes by status | (optional) defaults to undefined|
|
|
305
305
|
| **quoteCreatorUserId** | [**string**] | Filter quotes by quote creator user ID | (optional) defaults to undefined|
|
|
306
|
+
| **userFilter** | **UserFilter** | Filter for quotes created by the authenticated user. | (optional) defaults to undefined|
|
|
307
|
+
| **rfqUserFilter** | **UserFilter** | Filter for quotes responding to RFQs created by the authenticated user. | (optional) defaults to undefined|
|
|
306
308
|
| **rfqCreatorUserId** | [**string**] | Filter quotes by RFQ creator user ID | (optional) defaults to undefined|
|
|
307
309
|
| **rfqCreatorSubtraderId** | [**string**] | Filter quotes by RFQ creator subtrader ID (FCM members only) | (optional) defaults to undefined|
|
|
308
310
|
| **rfqId** | [**string**] | Filter quotes by RFQ ID | (optional) defaults to undefined|
|
|
@@ -379,6 +381,7 @@ This endpoint does not have any parameters.
|
|
|
379
381
|
| **limit** | [**number**] | Parameter to specify the number of results per page. Defaults to 100. | (optional) defaults to 100|
|
|
380
382
|
| **status** | [**string**] | Filter RFQs by status | (optional) defaults to undefined|
|
|
381
383
|
| **creatorUserId** | [**string**] | Filter RFQs by creator user ID | (optional) defaults to undefined|
|
|
384
|
+
| **userFilter** | **UserFilter** | | (optional) defaults to undefined|
|
|
382
385
|
|
|
383
386
|
|
|
384
387
|
### Return type
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**order_group_id** | **string** | The unique identifier for the created order group | [default to undefined]
|
|
9
|
+
**subaccount** | **number** | Subaccount number that owns the created order group (0 for primary, 1-32 for subaccounts). | [default to undefined]
|
|
9
10
|
|
|
10
11
|
## Example
|
|
11
12
|
|
|
@@ -14,6 +15,7 @@ import { CreateOrderGroupResponse } from 'kalshi-typescript';
|
|
|
14
15
|
|
|
15
16
|
const instance: CreateOrderGroupResponse = {
|
|
16
17
|
order_group_id,
|
|
18
|
+
subaccount,
|
|
17
19
|
};
|
|
18
20
|
```
|
|
19
21
|
|
|
@@ -15,8 +15,8 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**no_price** | **number** | | [optional] [default to undefined]
|
|
16
16
|
**yes_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [optional] [default to undefined]
|
|
17
17
|
**no_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [optional] [default to undefined]
|
|
18
|
-
**expiration_ts** | **number** | | [optional] [default to undefined]
|
|
19
|
-
**time_in_force** | **string** | | [optional] [default to undefined]
|
|
18
|
+
**expiration_ts** | **number** | Optional Unix timestamp in seconds for when the order expires. To place an expiring order, set `time_in_force` to `good_till_canceled` and provide this `expiration_ts`. `GTT` is an internal execution type and is not a valid API value for `time_in_force`. The `immediate_or_cancel` time-in-force value cannot be combined with `expiration_ts`. | [optional] [default to undefined]
|
|
19
|
+
**time_in_force** | **string** | Specifies how long the order remains active. Use `good_till_canceled` with `expiration_ts` for an order that should rest until a specific expiration time; without `expiration_ts`, `good_till_canceled` is a true good-till-canceled order. `GTT` is not a valid API value. | [optional] [default to undefined]
|
|
20
20
|
**buy_max_cost** | **number** | Maximum cost in cents. When specified, the order will automatically have Fill-or-Kill (FoK) behavior. | [optional] [default to undefined]
|
|
21
21
|
**post_only** | **boolean** | | [optional] [default to undefined]
|
|
22
22
|
**reduce_only** | **boolean** | | [optional] [default to undefined]
|
|
@@ -25,6 +25,7 @@ Name | Type | Description | Notes
|
|
|
25
25
|
**order_group_id** | **string** | The order group this order is part of | [optional] [default to undefined]
|
|
26
26
|
**cancel_order_on_pause** | **boolean** | If this flag is set to true, the order will be canceled if the order is open and trading on the exchange is paused for any reason. | [optional] [default to undefined]
|
|
27
27
|
**subaccount** | **number** | The subaccount number to use for this order. 0 is the primary subaccount. | [optional] [default to 0]
|
|
28
|
+
**exchange_index** | **number** | Defaults to 0. Note: currently only 0 supported. | [optional] [default to undefined]
|
|
28
29
|
|
|
29
30
|
## Example
|
|
30
31
|
|
|
@@ -52,6 +53,7 @@ const instance: CreateOrderRequest = {
|
|
|
52
53
|
order_group_id,
|
|
53
54
|
cancel_order_on_pause,
|
|
54
55
|
subaccount,
|
|
56
|
+
exchange_index,
|
|
55
57
|
};
|
|
56
58
|
```
|
|
57
59
|
|
|
@@ -10,14 +10,15 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**side** | [**BookSide**](BookSide.md) | | [default to undefined]
|
|
11
11
|
**count** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
|
|
12
12
|
**price** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
13
|
-
**expiration_time** | **number** | | [optional] [default to undefined]
|
|
14
|
-
**time_in_force** | **string** | | [default to undefined]
|
|
13
|
+
**expiration_time** | **number** | Optional Unix timestamp in seconds for when the order expires. To place an expiring order, set `time_in_force` to `good_till_canceled` and provide this `expiration_time`. `GTT` is an internal execution type and is not a valid API value for `time_in_force`. The `immediate_or_cancel` time-in-force value cannot be combined with `expiration_time`. | [optional] [default to undefined]
|
|
14
|
+
**time_in_force** | **string** | Specifies how long the order remains active. Use `good_till_canceled` with `expiration_time` for an order that should rest until a specific expiration time; without `expiration_time`, `good_till_canceled` is a true good-till-canceled order. `GTT` is not a valid API value. | [default to undefined]
|
|
15
15
|
**post_only** | **boolean** | | [optional] [default to undefined]
|
|
16
16
|
**self_trade_prevention_type** | [**SelfTradePreventionType**](SelfTradePreventionType.md) | | [default to undefined]
|
|
17
17
|
**cancel_order_on_pause** | **boolean** | If this flag is set to true, the order will be canceled if the order is open and trading on the exchange is paused for any reason. | [optional] [default to undefined]
|
|
18
18
|
**reduce_only** | **boolean** | Specifies whether the order place count should be capped by the member\'s current position. | [optional] [default to undefined]
|
|
19
19
|
**subaccount** | **number** | The subaccount number to use for this order. 0 is the primary subaccount. | [optional] [default to 0]
|
|
20
20
|
**order_group_id** | **string** | The order group this order is part of | [optional] [default to undefined]
|
|
21
|
+
**exchange_index** | **number** | Defaults to 0. Note: currently only 0 supported. | [optional] [default to undefined]
|
|
21
22
|
|
|
22
23
|
## Example
|
|
23
24
|
|
|
@@ -38,6 +39,7 @@ const instance: CreateOrderV2Request = {
|
|
|
38
39
|
reduce_only,
|
|
39
40
|
subaccount,
|
|
40
41
|
order_group_id,
|
|
42
|
+
exchange_index,
|
|
41
43
|
};
|
|
42
44
|
```
|
|
43
45
|
|
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**remaining_count** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
|
|
12
12
|
**average_fill_price** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [optional] [default to undefined]
|
|
13
13
|
**average_fee_paid** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [optional] [default to undefined]
|
|
14
|
+
**ts_ms** | **number** | Matching engine timestamp at which the order was processed, as Unix epoch milliseconds. | [default to undefined]
|
|
14
15
|
|
|
15
16
|
## Example
|
|
16
17
|
|
|
@@ -24,6 +25,7 @@ const instance: CreateOrderV2Response = {
|
|
|
24
25
|
remaining_count,
|
|
25
26
|
average_fill_price,
|
|
26
27
|
average_fee_paid,
|
|
28
|
+
ts_ms,
|
|
27
29
|
};
|
|
28
30
|
```
|
|
29
31
|
|
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**yes_bid** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
10
10
|
**no_bid** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
11
11
|
**rest_remainder** | **boolean** | Whether to rest the remainder of the quote after execution | [default to undefined]
|
|
12
|
+
**post_only** | **boolean** | If true, the quote creator\'s resting order will be cancelled rather than crossed if it would take liquidity. Defaults to false. | [optional] [default to undefined]
|
|
12
13
|
**subaccount** | **number** | Optional subaccount number to place the quote under (0 for primary, 1-32 for subaccounts) | [optional] [default to undefined]
|
|
13
14
|
|
|
14
15
|
## Example
|
|
@@ -21,6 +22,7 @@ const instance: CreateQuoteRequest = {
|
|
|
21
22
|
yes_bid,
|
|
22
23
|
no_bid,
|
|
23
24
|
rest_remainder,
|
|
25
|
+
post_only,
|
|
24
26
|
subaccount,
|
|
25
27
|
};
|
|
26
28
|
```
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**order_id** | **string** | | [default to undefined]
|
|
9
9
|
**client_order_id** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**remaining_count** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
|
|
11
|
+
**ts_ms** | **number** | Matching engine timestamp at which the decrease was processed, as Unix epoch milliseconds. | [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -18,6 +19,7 @@ const instance: DecreaseOrderV2Response = {
|
|
|
18
19
|
order_id,
|
|
19
20
|
client_order_id,
|
|
20
21
|
remaining_count,
|
|
22
|
+
ts_ms,
|
|
21
23
|
};
|
|
22
24
|
```
|
|
23
25
|
|
package/docs/Deposit.md
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Deposit
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | Unique identifier for the deposit. | [default to undefined]
|
|
9
|
+
**status** | **string** | Current status of the deposit. \'applied\' means funds are reflected in balance. | [default to undefined]
|
|
10
|
+
**type** | **string** | Payment method used for the deposit. | [default to undefined]
|
|
11
|
+
**amount_cents** | **number** | Deposit amount in cents. | [default to undefined]
|
|
12
|
+
**fee_cents** | **number** | Fee charged for the deposit in cents. | [default to undefined]
|
|
13
|
+
**created_ts** | **number** | Unix timestamp of when the deposit was created. | [default to undefined]
|
|
14
|
+
**finalized_ts** | **number** | Unix timestamp of when the deposit was finalized (applied, failed, or returned). | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { Deposit } from 'kalshi-typescript';
|
|
20
|
+
|
|
21
|
+
const instance: Deposit = {
|
|
22
|
+
id,
|
|
23
|
+
status,
|
|
24
|
+
type,
|
|
25
|
+
amount_cents,
|
|
26
|
+
fee_cents,
|
|
27
|
+
created_ts,
|
|
28
|
+
finalized_ts,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/EventData.md
CHANGED
|
@@ -18,6 +18,8 @@ Name | Type | Description | Notes
|
|
|
18
18
|
**available_on_brokers** | **boolean** | Whether this event is available to trade on brokers. | [default to undefined]
|
|
19
19
|
**product_metadata** | **object** | Additional metadata for the event. | [default to undefined]
|
|
20
20
|
**last_updated_ts** | **string** | Timestamp of when this event\'s metadata was last updated. | [optional] [default to undefined]
|
|
21
|
+
**fee_type_override** | **string** | Fee type override for this event. When present, takes precedence over the series-level fee for this event\'s markets. | [optional] [default to undefined]
|
|
22
|
+
**fee_multiplier_override** | **number** | Fee multiplier override for this event. Paired with fee_type_override. | [optional] [default to undefined]
|
|
21
23
|
|
|
22
24
|
## Example
|
|
23
25
|
|
|
@@ -38,6 +40,8 @@ const instance: EventData = {
|
|
|
38
40
|
available_on_brokers,
|
|
39
41
|
product_metadata,
|
|
40
42
|
last_updated_ts,
|
|
43
|
+
fee_type_override,
|
|
44
|
+
fee_multiplier_override,
|
|
41
45
|
};
|
|
42
46
|
```
|
|
43
47
|
|
package/docs/EventsApi.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# EventsApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://api.
|
|
3
|
+
All URIs are relative to *https://external-api.kalshi.com/trade-api/v2*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
@@ -70,7 +70,7 @@ Endpoint for getting the historical raw and formatted forecast numbers for an ev
|
|
|
70
70
|
|
|
71
71
|
### Authorization
|
|
72
72
|
|
|
73
|
-
|
|
73
|
+
[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
|
|
74
74
|
|
|
75
75
|
### HTTP request headers
|
|
76
76
|
|
package/docs/ExchangeApi.md
CHANGED
package/docs/FcmApi.md
CHANGED
package/docs/Fill.md
CHANGED
|
@@ -10,8 +10,10 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**order_id** | **string** | Unique identifier for the order that resulted in this fill | [default to undefined]
|
|
11
11
|
**ticker** | **string** | Unique identifier for the market | [default to undefined]
|
|
12
12
|
**market_ticker** | **string** | Unique identifier for the market (legacy field name, same as ticker) | [default to undefined]
|
|
13
|
-
**side** | **string** |
|
|
14
|
-
**action** | **string** |
|
|
13
|
+
**side** | **string** | Deprecated. Use `outcome_side` (or `book_side`) instead. See [Order direction](/getting_started/order_direction). This field will not be removed before May 14, 2026. | [default to undefined]
|
|
14
|
+
**action** | **string** | Deprecated. Use `outcome_side` (or `book_side`) instead. See [Order direction](/getting_started/order_direction). This field will not be removed before May 14, 2026. | [default to undefined]
|
|
15
|
+
**outcome_side** | **string** | The outcome side this fill positioned the user for. buy-yes and sell-no produce \'yes\'; buy-no and sell-yes produce \'no\'. `outcome_side` describes directional exposure only; it does not change the fill\'s price. A fill at price `p` with `outcome_side=no` is matched against an order at the same price `p` with `outcome_side=yes` — both parties trade at the same price, just on opposite directions. `outcome_side` and `book_side` will become the canonical way to determine fill direction. The legacy `action` and `side` fields will be deprecated in a future release — please migrate to these new fields. | [default to undefined]
|
|
16
|
+
**book_side** | [**BookSide**](BookSide.md) | | [default to undefined]
|
|
15
17
|
**count_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
|
|
16
18
|
**yes_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
17
19
|
**no_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
@@ -34,6 +36,8 @@ const instance: Fill = {
|
|
|
34
36
|
market_ticker,
|
|
35
37
|
side,
|
|
36
38
|
action,
|
|
39
|
+
outcome_side,
|
|
40
|
+
book_side,
|
|
37
41
|
count_fp,
|
|
38
42
|
yes_price_dollars,
|
|
39
43
|
no_price_dollars,
|
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**usage_tier** | **string** | User\'s API usage tier | [default to undefined]
|
|
9
|
-
**
|
|
10
|
-
**
|
|
8
|
+
**usage_tier** | **string** | User\'s API usage tier. | [default to undefined]
|
|
9
|
+
**read** | [**BucketLimit**](BucketLimit.md) | | [default to undefined]
|
|
10
|
+
**write** | [**BucketLimit**](BucketLimit.md) | | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -16,8 +16,8 @@ import { GetAccountApiLimitsResponse } from 'kalshi-typescript';
|
|
|
16
16
|
|
|
17
17
|
const instance: GetAccountApiLimitsResponse = {
|
|
18
18
|
usage_tier,
|
|
19
|
-
|
|
20
|
-
|
|
19
|
+
read,
|
|
20
|
+
write,
|
|
21
21
|
};
|
|
22
22
|
```
|
|
23
23
|
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**balance** | **number** | Member\'s available balance in cents. This represents the amount available for trading. | [default to undefined]
|
|
9
9
|
**portfolio_value** | **number** | Member\'s portfolio value in cents. This is the current value of all positions held. | [default to undefined]
|
|
10
10
|
**updated_ts** | **number** | Unix timestamp of the last update to the balance. | [default to undefined]
|
|
11
|
+
**balance_breakdown** | [**Array<IndexedBalance>**](IndexedBalance.md) | Balance broken down per exchange index. | [optional] [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -18,6 +19,7 @@ const instance: GetBalanceResponse = {
|
|
|
18
19
|
balance,
|
|
19
20
|
portfolio_value,
|
|
20
21
|
updated_ts,
|
|
22
|
+
balance_breakdown,
|
|
21
23
|
};
|
|
22
24
|
```
|
|
23
25
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# GetDepositsResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**deposits** | [**Array<Deposit>**](Deposit.md) | | [default to undefined]
|
|
9
|
+
**cursor** | **string** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { GetDepositsResponse } from 'kalshi-typescript';
|
|
15
|
+
|
|
16
|
+
const instance: GetDepositsResponse = {
|
|
17
|
+
deposits,
|
|
18
|
+
cursor,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# GetWithdrawalsResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**withdrawals** | [**Array<Withdrawal>**](Withdrawal.md) | | [default to undefined]
|
|
9
|
+
**cursor** | **string** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { GetWithdrawalsResponse } from 'kalshi-typescript';
|
|
15
|
+
|
|
16
|
+
const instance: GetWithdrawalsResponse = {
|
|
17
|
+
withdrawals,
|
|
18
|
+
cursor,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/HistoricalApi.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# HistoricalApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://api.
|
|
3
|
+
All URIs are relative to *https://external-api.kalshi.com/trade-api/v2*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
@@ -227,7 +227,7 @@ No authorization required
|
|
|
227
227
|
# **getTradesHistorical**
|
|
228
228
|
> GetTradesResponse getTradesHistorical()
|
|
229
229
|
|
|
230
|
-
Endpoint for getting all historical trades for all markets. Trades that were filled before the historical cutoff are available via this endpoint. See [Historical Data](https://kalshi.com/
|
|
230
|
+
Endpoint for getting all historical trades for all markets. Trades that were filled before the historical cutoff are available via this endpoint. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.
|
|
231
231
|
|
|
232
232
|
### Parameters
|
|
233
233
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# IndexedBalance
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**exchange_index** | **number** | Defaults to 0. Note: currently only 0 supported. | [default to undefined]
|
|
9
|
+
**balance** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { IndexedBalance } from 'kalshi-typescript';
|
|
15
|
+
|
|
16
|
+
const instance: IndexedBalance = {
|
|
17
|
+
exchange_index,
|
|
18
|
+
balance,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -8,6 +8,8 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**source** | [**ExchangeInstance**](ExchangeInstance.md) | | [default to undefined]
|
|
9
9
|
**destination** | [**ExchangeInstance**](ExchangeInstance.md) | | [default to undefined]
|
|
10
10
|
**amount** | **number** | The amount to transfer in centicents | [default to undefined]
|
|
11
|
+
**source_exchange_shard** | **number** | Source exchange shard index (default 0) | [optional] [default to 0]
|
|
12
|
+
**destination_exchange_shard** | **number** | Destination exchange shard index (default 0) | [optional] [default to 0]
|
|
11
13
|
|
|
12
14
|
## Example
|
|
13
15
|
|
|
@@ -18,6 +20,8 @@ const instance: IntraExchangeInstanceTransferRequest = {
|
|
|
18
20
|
source,
|
|
19
21
|
destination,
|
|
20
22
|
amount,
|
|
23
|
+
source_exchange_shard,
|
|
24
|
+
destination_exchange_shard,
|
|
21
25
|
};
|
|
22
26
|
```
|
|
23
27
|
|
package/docs/LiveDataApi.md
CHANGED
package/docs/Market.md
CHANGED
|
@@ -33,7 +33,7 @@ Name | Type | Description | Notes
|
|
|
33
33
|
**volume_24h_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
|
|
34
34
|
**result** | **string** | | [default to undefined]
|
|
35
35
|
**can_close_early** | **boolean** | | [default to undefined]
|
|
36
|
-
**fractional_trading_enabled** | **boolean** |
|
|
36
|
+
**fractional_trading_enabled** | **boolean** | Deprecated. This flag is always `true` and carries no information. Will be removed after a pre-announcement with the removal date. | [default to undefined]
|
|
37
37
|
**open_interest_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
|
|
38
38
|
**notional_value_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
39
39
|
**previous_yes_bid_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
@@ -46,7 +46,6 @@ Name | Type | Description | Notes
|
|
|
46
46
|
**occurrence_datetime** | **string** | The recorded datetime when the underlying event occurred, if available | [optional] [default to undefined]
|
|
47
47
|
**fee_waiver_expiration_time** | **string** | Time when this market\'s fee waiver expires | [optional] [default to undefined]
|
|
48
48
|
**early_close_condition** | **string** | The condition under which the market can close early | [optional] [default to undefined]
|
|
49
|
-
**tick_size** | **number** | DEPRECATED: Use price_level_structure and price_ranges instead. | [optional] [default to undefined]
|
|
50
49
|
**strike_type** | **string** | Strike type defines how the market strike is defined and evaluated | [optional] [default to undefined]
|
|
51
50
|
**floor_strike** | **number** | Minimum expiration value that leads to a YES settlement | [optional] [default to undefined]
|
|
52
51
|
**cap_strike** | **number** | Maximum expiration value that leads to a YES settlement | [optional] [default to undefined]
|
|
@@ -108,7 +107,6 @@ const instance: Market = {
|
|
|
108
107
|
occurrence_datetime,
|
|
109
108
|
fee_waiver_expiration_time,
|
|
110
109
|
early_close_condition,
|
|
111
|
-
tick_size,
|
|
112
110
|
strike_type,
|
|
113
111
|
floor_strike,
|
|
114
112
|
cap_strike,
|
package/docs/MarketApi.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# MarketApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://api.
|
|
3
|
+
All URIs are relative to *https://external-api.kalshi.com/trade-api/v2*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
@@ -89,7 +89,7 @@ No authorization required
|
|
|
89
89
|
# **getMarketCandlesticks**
|
|
90
90
|
> GetMarketCandlesticksResponse getMarketCandlesticks()
|
|
91
91
|
|
|
92
|
-
Time period length of each candlestick in minutes. Valid values: 1 (1 minute), 60 (1 hour), 1440 (1 day). Candlesticks for markets that settled before the historical cutoff are only available via `GET /historical/markets/{ticker}/candlesticks`. See [Historical Data](https://kalshi.com/
|
|
92
|
+
Time period length of each candlestick in minutes. Valid values: 1 (1 minute), 60 (1 hour), 1440 (1 day). Candlesticks for markets that settled before the historical cutoff are only available via `GET /historical/markets/{ticker}/candlesticks`. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.
|
|
93
93
|
|
|
94
94
|
### Parameters
|
|
95
95
|
|
|
@@ -144,7 +144,7 @@ No authorization required
|
|
|
144
144
|
|
|
145
145
|
### Authorization
|
|
146
146
|
|
|
147
|
-
|
|
147
|
+
[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
|
|
148
148
|
|
|
149
149
|
### HTTP request headers
|
|
150
150
|
|
|
@@ -178,7 +178,7 @@ Endpoint for getting the current order books for multiple markets in a single re
|
|
|
178
178
|
|
|
179
179
|
### Authorization
|
|
180
180
|
|
|
181
|
-
|
|
181
|
+
[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
|
|
182
182
|
|
|
183
183
|
### HTTP request headers
|
|
184
184
|
|
|
@@ -197,7 +197,7 @@ No authorization required
|
|
|
197
197
|
# **getMarkets**
|
|
198
198
|
> GetMarketsResponse getMarkets()
|
|
199
199
|
|
|
200
|
-
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` | Markets that settled before the historical cutoff are only available via `GET /historical/markets`. See [Historical Data](https://kalshi.com/
|
|
200
|
+
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` | Markets that settled before the historical cutoff are only available via `GET /historical/markets`. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.
|
|
201
201
|
|
|
202
202
|
### Parameters
|
|
203
203
|
|
package/docs/MilestoneApi.md
CHANGED
package/docs/MultivariateApi.md
CHANGED