kalshi-typescript 3.19.0 → 3.21.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 +20 -0
- package/README.md +17 -2
- package/api/account-api.ts +147 -5
- package/api/api-keys-api.ts +1 -1
- package/api/communications-api.ts +301 -12
- package/api/events-api.ts +16 -8
- package/api/exchange-api.ts +5 -5
- package/api/fcm-api.ts +1 -1
- package/api/historical-api.ts +20 -12
- package/api/incentive-programs-api.ts +1 -1
- package/api/live-data-api.ts +1 -1
- package/api/market-api.ts +28 -20
- package/api/milestone-api.ts +1 -1
- package/api/multivariate-api.ts +1 -1
- package/api/order-groups-api.ts +21 -21
- package/api/orders-api.ts +25 -25
- package/api/portfolio-api.ts +33 -33
- package/api/search-api.ts +1 -1
- package/api/structured-targets-api.ts +1 -1
- package/api.ts +1 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api/account-api.d.ts +62 -5
- package/dist/api/account-api.js +133 -5
- package/dist/api/api-keys-api.d.ts +1 -1
- package/dist/api/api-keys-api.js +1 -1
- package/dist/api/communications-api.d.ts +133 -9
- package/dist/api/communications-api.js +267 -12
- package/dist/api/events-api.d.ts +9 -5
- package/dist/api/events-api.js +15 -8
- package/dist/api/exchange-api.d.ts +5 -5
- package/dist/api/exchange-api.js +5 -5
- package/dist/api/fcm-api.d.ts +1 -1
- package/dist/api/fcm-api.js +1 -1
- package/dist/api/historical-api.d.ts +13 -9
- package/dist/api/historical-api.js +19 -12
- 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 +21 -17
- package/dist/api/market-api.js +27 -20
- 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 +21 -21
- package/dist/api/order-groups-api.js +21 -21
- package/dist/api/orders-api.d.ts +25 -25
- package/dist/api/orders-api.js +25 -25
- package/dist/api/portfolio-api.d.ts +33 -33
- package/dist/api/portfolio-api.js +33 -33
- 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 +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api/account-api.d.ts +62 -5
- package/dist/esm/api/account-api.js +133 -5
- package/dist/esm/api/api-keys-api.d.ts +1 -1
- package/dist/esm/api/api-keys-api.js +1 -1
- package/dist/esm/api/communications-api.d.ts +133 -9
- package/dist/esm/api/communications-api.js +267 -12
- package/dist/esm/api/events-api.d.ts +9 -5
- package/dist/esm/api/events-api.js +15 -8
- package/dist/esm/api/exchange-api.d.ts +5 -5
- package/dist/esm/api/exchange-api.js +5 -5
- 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 +13 -9
- package/dist/esm/api/historical-api.js +19 -12
- 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 +21 -17
- package/dist/esm/api/market-api.js +27 -20
- 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 +21 -21
- package/dist/esm/api/order-groups-api.js +21 -21
- package/dist/esm/api/orders-api.d.ts +25 -25
- package/dist/esm/api/orders-api.js +25 -25
- package/dist/esm/api/portfolio-api.d.ts +33 -33
- package/dist/esm/api/portfolio-api.js +33 -33
- 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 +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/models/accept-block-trade-proposal-request.d.ts +21 -0
- package/dist/esm/models/accept-block-trade-proposal-request.js +14 -0
- package/dist/esm/models/accept-quote-request.d.ts +1 -1
- package/dist/esm/models/accept-quote-request.js +1 -1
- package/dist/esm/models/account-api-usage-level-volume-goal.d.ts +25 -0
- package/dist/esm/models/account-api-usage-level-volume-goal.js +14 -0
- package/dist/esm/models/account-api-usage-level-volume-progress.d.ts +23 -0
- package/dist/esm/models/account-api-usage-level-volume-progress.js +14 -0
- package/dist/esm/models/amend-order-request.d.ts +2 -2
- 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 +1 -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-scope.d.ts +23 -0
- package/dist/esm/models/api-key-scope.js +24 -0
- package/dist/esm/models/api-key.d.ts +4 -3
- package/dist/esm/models/api-key.js +1 -1
- package/dist/esm/models/api-usage-level-grant.d.ts +27 -0
- package/dist/esm/models/api-usage-level-grant.js +14 -0
- package/dist/esm/models/apply-subaccount-transfer-request.d.ts +3 -3
- 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 +2 -2
- 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 +2 -2
- 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 +1 -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 +1 -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/block-trade-proposal.d.ts +102 -0
- package/dist/esm/models/block-trade-proposal.js +17 -0
- 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 +1 -1
- package/dist/esm/models/bucket-limit.js +1 -1
- 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 +1 -1
- package/dist/esm/models/cancel-order-v2-response.js +1 -1
- package/dist/esm/models/create-api-key-request.d.ts +4 -3
- 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 +2 -2
- package/dist/esm/models/create-order-group-request.js +1 -1
- package/dist/esm/models/create-order-group-response.d.ts +2 -2
- package/dist/esm/models/create-order-group-response.js +1 -1
- package/dist/esm/models/create-order-request.d.ts +1 -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 +2 -2
- package/dist/esm/models/create-order-v2-request.js +1 -1
- package/dist/esm/models/create-order-v2-response.d.ts +1 -1
- package/dist/esm/models/create-order-v2-response.js +1 -1
- package/dist/esm/models/create-quote-request.d.ts +2 -2
- 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 +3 -3
- 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 +2 -2
- 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 +2 -2
- 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 +1 -1
- package/dist/esm/models/decrease-order-v2-response.js +1 -1
- package/dist/esm/models/deposit.d.ts +1 -1
- package/dist/esm/models/deposit.js +1 -1
- 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 +1 -1
- package/dist/esm/models/event-data.js +1 -1
- package/dist/esm/models/event-fee-change.d.ts +1 -1
- package/dist/esm/models/event-fee-change.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/fee-type.d.ts +1 -1
- package/dist/esm/models/fee-type.js +1 -1
- package/dist/esm/models/fill.d.ts +2 -2
- package/dist/esm/models/fill.js +1 -1
- package/dist/esm/models/forecast-percentiles-point.d.ts +1 -1
- package/dist/esm/models/forecast-percentiles-point.js +1 -1
- package/dist/esm/models/generate-api-key-request.d.ts +4 -3
- 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 +7 -2
- package/dist/esm/models/get-account-api-limits-response.js +1 -1
- package/dist/esm/models/get-account-api-usage-level-volume-progress-response.d.ts +18 -0
- package/dist/esm/models/get-account-api-usage-level-volume-progress-response.js +14 -0
- 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 +1 -1
- package/dist/esm/models/get-balance-response.js +1 -1
- package/dist/esm/models/get-block-trade-proposals-response.d.ts +22 -0
- package/dist/esm/models/get-block-trade-proposals-response.js +14 -0
- 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 +1 -1
- package/dist/esm/models/get-deposits-response.js +1 -1
- package/dist/esm/models/get-event-candlesticks-response.d.ts +1 -1
- package/dist/esm/models/get-event-candlesticks-response.js +1 -1
- package/dist/esm/models/get-event-fee-changes-response.d.ts +1 -1
- package/dist/esm/models/get-event-fee-changes-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 +1 -1
- package/dist/esm/models/get-withdrawals-response.js +1 -1
- 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 +10 -0
- package/dist/esm/models/index.js +10 -0
- package/dist/esm/models/indexed-balance.d.ts +1 -1
- package/dist/esm/models/indexed-balance.js +1 -1
- package/dist/esm/models/intra-exchange-instance-transfer-request.d.ts +1 -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 +1 -1
- 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 +2 -2
- package/dist/esm/models/order.js +1 -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/propose-block-trade-request.d.ts +62 -0
- package/dist/esm/models/propose-block-trade-request.js +17 -0
- package/dist/esm/models/propose-block-trade-response.d.ts +17 -0
- package/dist/esm/models/propose-block-trade-response.js +14 -0
- package/dist/esm/models/quote.d.ts +1 -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 +1 -1
- package/dist/esm/models/self-trade-prevention-type.js +1 -1
- package/dist/esm/models/series-fee-change.d.ts +1 -1
- package/dist/esm/models/series-fee-change.js +1 -1
- package/dist/esm/models/series.d.ts +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 +2 -3
- package/dist/esm/models/settlement.js +2 -3
- 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 +2 -2
- package/dist/esm/models/subaccount-balance.js +1 -1
- package/dist/esm/models/subaccount-netting-config.d.ts +2 -2
- package/dist/esm/models/subaccount-netting-config.js +1 -1
- package/dist/esm/models/subaccount-transfer.d.ts +3 -3
- 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 +5 -1
- package/dist/esm/models/trade.js +1 -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 +2 -2
- package/dist/esm/models/update-subaccount-netting-request.js +1 -1
- package/dist/esm/models/user-filter.d.ts +1 -1
- package/dist/esm/models/user-filter.js +1 -1
- 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 +1 -1
- package/dist/esm/models/withdrawal.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/accept-block-trade-proposal-request.d.ts +21 -0
- package/dist/models/accept-block-trade-proposal-request.js +15 -0
- package/dist/models/accept-quote-request.d.ts +1 -1
- package/dist/models/accept-quote-request.js +1 -1
- package/dist/models/account-api-usage-level-volume-goal.d.ts +25 -0
- package/dist/models/account-api-usage-level-volume-goal.js +15 -0
- package/dist/models/account-api-usage-level-volume-progress.d.ts +23 -0
- package/dist/models/account-api-usage-level-volume-progress.js +15 -0
- package/dist/models/amend-order-request.d.ts +2 -2
- 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 +1 -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-scope.d.ts +23 -0
- package/dist/models/api-key-scope.js +27 -0
- package/dist/models/api-key.d.ts +4 -3
- package/dist/models/api-key.js +1 -1
- package/dist/models/api-usage-level-grant.d.ts +27 -0
- package/dist/models/api-usage-level-grant.js +15 -0
- package/dist/models/apply-subaccount-transfer-request.d.ts +3 -3
- 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 +2 -2
- 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 +2 -2
- 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 +1 -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 +1 -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/block-trade-proposal.d.ts +102 -0
- package/dist/models/block-trade-proposal.js +20 -0
- package/dist/models/book-side.d.ts +1 -1
- package/dist/models/book-side.js +1 -1
- package/dist/models/bucket-limit.d.ts +1 -1
- package/dist/models/bucket-limit.js +1 -1
- 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 +1 -1
- package/dist/models/cancel-order-v2-response.js +1 -1
- package/dist/models/create-api-key-request.d.ts +4 -3
- 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 +2 -2
- package/dist/models/create-order-group-request.js +1 -1
- package/dist/models/create-order-group-response.d.ts +2 -2
- package/dist/models/create-order-group-response.js +1 -1
- package/dist/models/create-order-request.d.ts +1 -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 +2 -2
- package/dist/models/create-order-v2-request.js +1 -1
- package/dist/models/create-order-v2-response.d.ts +1 -1
- package/dist/models/create-order-v2-response.js +1 -1
- package/dist/models/create-quote-request.d.ts +2 -2
- 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 +3 -3
- 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 +2 -2
- 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 +2 -2
- 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 +1 -1
- package/dist/models/decrease-order-v2-response.js +1 -1
- package/dist/models/deposit.d.ts +1 -1
- package/dist/models/deposit.js +1 -1
- 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 +1 -1
- package/dist/models/event-data.js +1 -1
- package/dist/models/event-fee-change.d.ts +1 -1
- package/dist/models/event-fee-change.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/fee-type.d.ts +1 -1
- package/dist/models/fee-type.js +1 -1
- package/dist/models/fill.d.ts +2 -2
- package/dist/models/fill.js +1 -1
- package/dist/models/forecast-percentiles-point.d.ts +1 -1
- package/dist/models/forecast-percentiles-point.js +1 -1
- package/dist/models/generate-api-key-request.d.ts +4 -3
- 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 +7 -2
- package/dist/models/get-account-api-limits-response.js +1 -1
- package/dist/models/get-account-api-usage-level-volume-progress-response.d.ts +18 -0
- package/dist/models/get-account-api-usage-level-volume-progress-response.js +15 -0
- 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 +1 -1
- package/dist/models/get-balance-response.js +1 -1
- package/dist/models/get-block-trade-proposals-response.d.ts +22 -0
- package/dist/models/get-block-trade-proposals-response.js +15 -0
- 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 +1 -1
- package/dist/models/get-deposits-response.js +1 -1
- package/dist/models/get-event-candlesticks-response.d.ts +1 -1
- package/dist/models/get-event-candlesticks-response.js +1 -1
- package/dist/models/get-event-fee-changes-response.d.ts +1 -1
- package/dist/models/get-event-fee-changes-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 +1 -1
- package/dist/models/get-withdrawals-response.js +1 -1
- package/dist/models/incentive-program.d.ts +1 -1
- package/dist/models/incentive-program.js +1 -1
- package/dist/models/index.d.ts +10 -0
- package/dist/models/index.js +10 -0
- package/dist/models/indexed-balance.d.ts +1 -1
- package/dist/models/indexed-balance.js +1 -1
- package/dist/models/intra-exchange-instance-transfer-request.d.ts +1 -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 +1 -1
- 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 +2 -2
- package/dist/models/order.js +1 -1
- 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/propose-block-trade-request.d.ts +62 -0
- package/dist/models/propose-block-trade-request.js +20 -0
- package/dist/models/propose-block-trade-response.d.ts +17 -0
- package/dist/models/propose-block-trade-response.js +15 -0
- package/dist/models/quote.d.ts +1 -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 +1 -1
- package/dist/models/self-trade-prevention-type.js +1 -1
- package/dist/models/series-fee-change.d.ts +1 -1
- package/dist/models/series-fee-change.js +1 -1
- package/dist/models/series.d.ts +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 +2 -3
- package/dist/models/settlement.js +2 -3
- 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 +2 -2
- package/dist/models/subaccount-balance.js +1 -1
- package/dist/models/subaccount-netting-config.d.ts +2 -2
- package/dist/models/subaccount-netting-config.js +1 -1
- package/dist/models/subaccount-transfer.d.ts +3 -3
- 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 +5 -1
- package/dist/models/trade.js +1 -1
- 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 +2 -2
- package/dist/models/update-subaccount-netting-request.js +1 -1
- package/dist/models/user-filter.d.ts +1 -1
- package/dist/models/user-filter.js +1 -1
- package/dist/models/weekly-schedule.d.ts +1 -1
- package/dist/models/weekly-schedule.js +1 -1
- package/dist/models/withdrawal.d.ts +1 -1
- package/dist/models/withdrawal.js +1 -1
- package/docs/AcceptBlockTradeProposalRequest.md +22 -0
- package/docs/AccountApi.md +65 -1
- package/docs/AccountApiUsageLevelVolumeGoal.md +24 -0
- package/docs/AccountApiUsageLevelVolumeProgress.md +24 -0
- package/docs/AmendOrderRequest.md +1 -1
- package/docs/ApiKey.md +1 -1
- package/docs/ApiKeyScope.md +19 -0
- package/docs/ApiUsageLevelGrant.md +26 -0
- package/docs/ApplySubaccountTransferRequest.md +2 -2
- package/docs/BatchCancelOrdersRequestOrder.md +1 -1
- package/docs/BatchCancelOrdersV2RequestOrdersInner.md +1 -1
- package/docs/BlockTradeProposal.md +60 -0
- package/docs/CommunicationsApi.md +114 -1
- package/docs/CreateApiKeyRequest.md +1 -1
- package/docs/CreateOrderGroupRequest.md +1 -1
- package/docs/CreateOrderGroupResponse.md +1 -1
- package/docs/CreateOrderV2Request.md +1 -1
- package/docs/CreateQuoteRequest.md +1 -1
- package/docs/CreateRFQRequest.md +2 -2
- package/docs/CreateSubaccountResponse.md +1 -1
- package/docs/DecreaseOrderRequest.md +1 -1
- package/docs/EventsApi.md +1 -0
- package/docs/ExchangeApi.md +1 -1
- package/docs/Fill.md +1 -1
- package/docs/GenerateApiKeyRequest.md +1 -1
- package/docs/GetAccountApiLimitsResponse.md +3 -1
- package/docs/GetAccountApiUsageLevelVolumeProgressResponse.md +20 -0
- package/docs/GetBlockTradeProposalsResponse.md +22 -0
- package/docs/HistoricalApi.md +2 -1
- package/docs/MarketApi.md +4 -3
- package/docs/MultivariateApi.md +1 -1
- package/docs/Order.md +1 -1
- package/docs/OrderGroupsApi.md +5 -5
- package/docs/OrdersApi.md +8 -8
- package/docs/PortfolioApi.md +8 -8
- package/docs/ProposeBlockTradeRequest.md +40 -0
- package/docs/ProposeBlockTradeResponse.md +20 -0
- package/docs/Settlement.md +1 -1
- package/docs/SubaccountBalance.md +1 -1
- package/docs/SubaccountNettingConfig.md +1 -1
- package/docs/SubaccountTransfer.md +2 -2
- package/docs/Trade.md +2 -0
- package/docs/UpdateSubaccountNettingRequest.md +1 -1
- package/index.ts +1 -1
- package/models/accept-block-trade-proposal-request.ts +27 -0
- package/models/accept-quote-request.ts +1 -1
- package/models/account-api-usage-level-volume-goal.ts +31 -0
- package/models/account-api-usage-level-volume-progress.ts +31 -0
- package/models/amend-order-request.ts +2 -2
- package/models/amend-order-response.ts +1 -1
- package/models/amend-order-v2-request.ts +1 -1
- package/models/amend-order-v2-response.ts +1 -1
- package/models/announcement.ts +1 -1
- package/models/api-key-scope.ts +33 -0
- package/models/api-key.ts +6 -3
- package/models/api-usage-level-grant.ts +37 -0
- package/models/apply-subaccount-transfer-request.ts +3 -3
- 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 +2 -2
- 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 +2 -2
- package/models/batch-cancel-orders-v2-request.ts +1 -1
- package/models/batch-cancel-orders-v2-response-orders-inner.ts +1 -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 +1 -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/block-trade-proposal.ts +111 -0
- package/models/book-side.ts +1 -1
- package/models/bucket-limit.ts +1 -1
- package/models/cancel-order-response.ts +1 -1
- package/models/cancel-order-v2-response.ts +1 -1
- package/models/create-api-key-request.ts +6 -3
- 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 +2 -2
- package/models/create-order-group-response.ts +2 -2
- package/models/create-order-request.ts +1 -1
- package/models/create-order-response.ts +1 -1
- package/models/create-order-v2-request.ts +2 -2
- package/models/create-order-v2-response.ts +1 -1
- package/models/create-quote-request.ts +2 -2
- package/models/create-quote-response.ts +1 -1
- package/models/create-rfqrequest.ts +3 -3
- package/models/create-rfqresponse.ts +1 -1
- package/models/create-subaccount-response.ts +2 -2
- package/models/daily-schedule.ts +1 -1
- package/models/decrease-order-request.ts +2 -2
- package/models/decrease-order-response.ts +1 -1
- package/models/decrease-order-v2-request.ts +1 -1
- package/models/decrease-order-v2-response.ts +1 -1
- package/models/deposit.ts +1 -1
- package/models/endpoint-token-cost.ts +1 -1
- package/models/error-response.ts +1 -1
- package/models/event-data.ts +1 -1
- package/models/event-fee-change.ts +1 -1
- package/models/event-position.ts +1 -1
- package/models/exchange-instance.ts +1 -1
- package/models/exchange-status.ts +1 -1
- package/models/fee-type.ts +1 -1
- package/models/fill.ts +2 -2
- package/models/forecast-percentiles-point.ts +1 -1
- package/models/generate-api-key-request.ts +6 -3
- package/models/generate-api-key-response.ts +1 -1
- package/models/get-account-api-limits-response.ts +9 -2
- package/models/get-account-api-usage-level-volume-progress-response.ts +26 -0
- 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 +1 -1
- package/models/get-block-trade-proposals-response.ts +30 -0
- package/models/get-communications-idresponse.ts +1 -1
- package/models/get-deposits-response.ts +1 -1
- package/models/get-event-candlesticks-response.ts +1 -1
- package/models/get-event-fee-changes-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 +1 -1
- package/models/incentive-program.ts +1 -1
- package/models/index.ts +10 -0
- package/models/indexed-balance.ts +1 -1
- package/models/intra-exchange-instance-transfer-request.ts +1 -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 +1 -1
- 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 +2 -2
- 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/propose-block-trade-request.ts +71 -0
- package/models/propose-block-trade-response.ts +23 -0
- package/models/quote.ts +1 -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 +1 -1
- 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 +3 -4
- package/models/sport-filter-details.ts +1 -1
- package/models/structured-target.ts +1 -1
- package/models/subaccount-balance.ts +2 -2
- package/models/subaccount-netting-config.ts +2 -2
- package/models/subaccount-transfer.ts +3 -3
- package/models/ticker-pair.ts +1 -1
- package/models/trade.ts +5 -1
- package/models/update-order-group-limit-request.ts +1 -1
- package/models/update-subaccount-netting-request.ts +2 -2
- package/models/user-filter.ts +1 -1
- package/models/weekly-schedule.ts +1 -1
- package/models/withdrawal.ts +1 -1
- package/package.json +1 -1
package/docs/ExchangeApi.md
CHANGED
|
@@ -135,7 +135,7 @@ No authorization required
|
|
|
135
135
|
# **getUserDataTimestamp**
|
|
136
136
|
> GetUserDataTimestampResponse getUserDataTimestamp()
|
|
137
137
|
|
|
138
|
-
There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with
|
|
138
|
+
There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with WebSocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
|
|
139
139
|
|
|
140
140
|
### Parameters
|
|
141
141
|
This endpoint does not have any parameters.
|
package/docs/Fill.md
CHANGED
|
@@ -20,7 +20,7 @@ Name | Type | Description | Notes
|
|
|
20
20
|
**is_taker** | **boolean** | If true, this fill was a taker (removed liquidity from the order book) | [default to undefined]
|
|
21
21
|
**created_time** | **string** | Timestamp when this fill was executed | [optional] [default to undefined]
|
|
22
22
|
**fee_cost** | **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]
|
|
23
|
-
**subaccount_number** | **number** | Subaccount number (0 for primary, 1-
|
|
23
|
+
**subaccount_number** | **number** | Subaccount number (0 for primary, 1-63 for subaccounts). Present for direct users. | [optional] [default to undefined]
|
|
24
24
|
**ts** | **number** | Unix timestamp when this fill was executed (legacy field name) | [optional] [default to undefined]
|
|
25
25
|
|
|
26
26
|
## Example
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**name** | **string** | Name for the API key. This helps identify the key\'s purpose | [default to undefined]
|
|
9
|
-
**scopes** | **Array<
|
|
9
|
+
**scopes** | [**Array<ApiKeyScope>**](ApiKeyScope.md) | List of scopes to grant to the API key. If the broad `write` parent scope is included, `read` must also be included. Child scopes may be granted without the broad parent scope. Defaults to full access (`read`, `write`) if not provided. | [optional] [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
@@ -5,9 +5,10 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**usage_tier** | **string** | User\'s API usage tier. | [default to undefined]
|
|
8
|
+
**usage_tier** | **string** | User\'s effective Predictions API usage tier for these limits (for example, basic, advanced, expert, premier, paragon, prime, or prestige). | [default to undefined]
|
|
9
9
|
**read** | [**BucketLimit**](BucketLimit.md) | | [default to undefined]
|
|
10
10
|
**write** | [**BucketLimit**](BucketLimit.md) | | [default to undefined]
|
|
11
|
+
**grants** | [**Array<ApiUsageLevelGrant>**](ApiUsageLevelGrant.md) | The caller\'s active API usage level grants across exchange lanes, where each grant applies to its exchange_instance and usage_tier reflects the effective tier for the lane reported by this endpoint. | [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -18,6 +19,7 @@ const instance: GetAccountApiLimitsResponse = {
|
|
|
18
19
|
usage_tier,
|
|
19
20
|
read,
|
|
20
21
|
write,
|
|
22
|
+
grants,
|
|
21
23
|
};
|
|
22
24
|
```
|
|
23
25
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# GetAccountApiUsageLevelVolumeProgressResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**volume_progress** | [**Array<AccountApiUsageLevelVolumeProgress>**](AccountApiUsageLevelVolumeProgress.md) | Latest cron-computed trading volume progress toward volume-based API usage tiers for the predictions (event_contract) lane. Volume-based public tiers are Expert, Premier, Paragon, Prime, and Prestige. | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { GetAccountApiUsageLevelVolumeProgressResponse } from 'kalshi-typescript';
|
|
14
|
+
|
|
15
|
+
const instance: GetAccountApiUsageLevelVolumeProgressResponse = {
|
|
16
|
+
volume_progress,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[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
|
+
# GetBlockTradeProposalsResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**block_trade_proposals** | [**Array<BlockTradeProposal>**](BlockTradeProposal.md) | List of block trade proposals | [default to undefined]
|
|
9
|
+
**cursor** | **string** | Cursor for pagination to get the next page of results | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { GetBlockTradeProposalsResponse } from 'kalshi-typescript';
|
|
15
|
+
|
|
16
|
+
const instance: GetBlockTradeProposalsResponse = {
|
|
17
|
+
block_trade_proposals,
|
|
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
|
@@ -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://docs.kalshi.com/getting_started/historical_data) for details.
|
|
230
|
+
Endpoint for getting all historical trades for all markets. Trades that were filled before the historical cutoff are available via this endpoint. Block trades are included by default and identified by the `is_block_trade` field; use the `is_block_trade` query parameter to filter by block / non-block. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.
|
|
231
231
|
|
|
232
232
|
### Parameters
|
|
233
233
|
|
|
@@ -238,6 +238,7 @@ No authorization required
|
|
|
238
238
|
| **maxTs** | [**number**] | Filter items before this Unix timestamp | (optional) defaults to undefined|
|
|
239
239
|
| **limit** | [**number**] | Number of results per page. Defaults to 100. Maximum value is 1000. | (optional) defaults to 100|
|
|
240
240
|
| **cursor** | [**string**] | Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. | (optional) defaults to undefined|
|
|
241
|
+
| **isBlockTrade** | [**boolean**] | Filter trades by whether they are block trades. Omit to return all trades. Set to `true` to return only block trades. Set to `false` to return only non-block trades. | (optional) defaults to undefined|
|
|
241
242
|
|
|
242
243
|
|
|
243
244
|
### Return type
|
package/docs/MarketApi.md
CHANGED
|
@@ -197,7 +197,7 @@ Endpoint for getting the current order books for multiple markets in a single re
|
|
|
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://docs.kalshi.com/getting_started/historical_data) for details.
|
|
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`. May be combined with `series_ticker`, which requires `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
|
|
|
@@ -209,7 +209,7 @@ Filter by market status. Possible values: `unopened`, `open`, `closed`, `settled
|
|
|
209
209
|
| **seriesTicker** | [**string**] | Filter by series ticker | (optional) defaults to undefined|
|
|
210
210
|
| **minCreatedTs** | [**number**] | Filter items that created after this Unix timestamp | (optional) defaults to undefined|
|
|
211
211
|
| **maxCreatedTs** | [**number**] | Filter items that created before this Unix timestamp | (optional) defaults to undefined|
|
|
212
|
-
| **minUpdatedTs** | [**number**] | Return markets with metadata updated later than this Unix timestamp. Tracks non-trading changes only. Incompatible with any other filters. | (optional) defaults to undefined|
|
|
212
|
+
| **minUpdatedTs** | [**number**] | Return markets with metadata updated later than this Unix timestamp. Tracks non-trading changes only. Incompatible with any other filters except mve_filter=exclude. May be combined with series_ticker, which requires mve_filter=exclude. | (optional) defaults to undefined|
|
|
213
213
|
| **maxCloseTs** | [**number**] | Filter items that close before this Unix timestamp | (optional) defaults to undefined|
|
|
214
214
|
| **minCloseTs** | [**number**] | Filter items that close after this Unix timestamp | (optional) defaults to undefined|
|
|
215
215
|
| **minSettledTs** | [**number**] | Filter items that settled after this Unix timestamp | (optional) defaults to undefined|
|
|
@@ -315,7 +315,7 @@ No authorization required
|
|
|
315
315
|
# **getTrades**
|
|
316
316
|
> GetTradesResponse getTrades()
|
|
317
317
|
|
|
318
|
-
Endpoint for getting all trades for all markets. A trade represents a completed transaction between two users on a specific market. Each trade includes the market ticker, price, quantity, and timestamp information. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
|
|
318
|
+
Endpoint for getting all trades for all markets. A trade represents a completed transaction between two users on a specific market. Each trade includes the market ticker, price, quantity, and timestamp information. Block trades are included in the response by default and identified by the `is_block_trade` field; use the `is_block_trade` query parameter to filter by block / non-block. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
|
|
319
319
|
|
|
320
320
|
### Parameters
|
|
321
321
|
|
|
@@ -326,6 +326,7 @@ Endpoint for getting all trades for all markets. A trade represents a completed
|
|
|
326
326
|
| **ticker** | [**string**] | Filter by market ticker | (optional) defaults to undefined|
|
|
327
327
|
| **minTs** | [**number**] | Filter items after this Unix timestamp | (optional) defaults to undefined|
|
|
328
328
|
| **maxTs** | [**number**] | Filter items before this Unix timestamp | (optional) defaults to undefined|
|
|
329
|
+
| **isBlockTrade** | [**boolean**] | Filter trades by whether they are block trades. Omit to return all trades. Set to `true` to return only block trades. Set to `false` to return only non-block trades. | (optional) defaults to undefined|
|
|
329
330
|
|
|
330
331
|
|
|
331
332
|
### Return type
|
package/docs/MultivariateApi.md
CHANGED
|
@@ -43,7 +43,7 @@ Endpoint for creating an individual market in a multivariate event collection. T
|
|
|
43
43
|
|**200** | Market created successfully | - |
|
|
44
44
|
|**400** | Bad request - invalid input | - |
|
|
45
45
|
|**401** | Unauthorized - authentication required | - |
|
|
46
|
-
|**429** | Rate limit exceeded. The default cost is 10 tokens per request
|
|
46
|
+
|**429** | Rate limit exceeded. The default cost is 10 tokens per request. Use GET /trade-api/v2/account/endpoint_costs to list non-default endpoint costs. | - |
|
|
47
47
|
|**500** | Internal server error | - |
|
|
48
48
|
|
|
49
49
|
# **getMultivariateEventCollection**
|
package/docs/Order.md
CHANGED
|
@@ -30,7 +30,7 @@ Name | Type | Description | Notes
|
|
|
30
30
|
**self_trade_prevention_type** | [**SelfTradePreventionType**](SelfTradePreventionType.md) | | [optional] [default to undefined]
|
|
31
31
|
**order_group_id** | **string** | The order group this order is part of | [optional] [default to undefined]
|
|
32
32
|
**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]
|
|
33
|
-
**subaccount_number** | **number** | Subaccount number (0 for primary, 1-
|
|
33
|
+
**subaccount_number** | **number** | Subaccount number (0 for primary, 1-63 for subaccounts). | [optional] [default to undefined]
|
|
34
34
|
**exchange_index** | **number** | Identifier for an exchange shard. Defaults to 0 if unspecified. Note: currently only 0 supported. | [optional] [default to undefined]
|
|
35
35
|
|
|
36
36
|
## Example
|
package/docs/OrderGroupsApi.md
CHANGED
|
@@ -56,7 +56,7 @@ All URIs are relative to *https://external-api.kalshi.com/trade-api/v2*
|
|
|
56
56
|
|Name | Type | Description | Notes|
|
|
57
57
|
|------------- | ------------- | ------------- | -------------|
|
|
58
58
|
| **orderGroupId** | [**string**] | Order group ID | defaults to undefined|
|
|
59
|
-
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-
|
|
59
|
+
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
|
|
60
60
|
| **exchangeIndex** | [**number**] | | (optional) defaults to undefined|
|
|
61
61
|
|
|
62
62
|
|
|
@@ -92,7 +92,7 @@ All URIs are relative to *https://external-api.kalshi.com/trade-api/v2*
|
|
|
92
92
|
|Name | Type | Description | Notes|
|
|
93
93
|
|------------- | ------------- | ------------- | -------------|
|
|
94
94
|
| **orderGroupId** | [**string**] | Order group ID | defaults to undefined|
|
|
95
|
-
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-
|
|
95
|
+
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts. | (optional) defaults to undefined|
|
|
96
96
|
|
|
97
97
|
|
|
98
98
|
### Return type
|
|
@@ -126,7 +126,7 @@ All URIs are relative to *https://external-api.kalshi.com/trade-api/v2*
|
|
|
126
126
|
|
|
127
127
|
|Name | Type | Description | Notes|
|
|
128
128
|
|------------- | ------------- | ------------- | -------------|
|
|
129
|
-
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-
|
|
129
|
+
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts. | (optional) defaults to undefined|
|
|
130
130
|
|
|
131
131
|
|
|
132
132
|
### Return type
|
|
@@ -162,7 +162,7 @@ All URIs are relative to *https://external-api.kalshi.com/trade-api/v2*
|
|
|
162
162
|
|------------- | ------------- | ------------- | -------------|
|
|
163
163
|
| **body** | **object**| | |
|
|
164
164
|
| **orderGroupId** | [**string**] | Order group ID | defaults to undefined|
|
|
165
|
-
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-
|
|
165
|
+
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
|
|
166
166
|
| **exchangeIndex** | [**number**] | | (optional) defaults to undefined|
|
|
167
167
|
|
|
168
168
|
|
|
@@ -199,7 +199,7 @@ All URIs are relative to *https://external-api.kalshi.com/trade-api/v2*
|
|
|
199
199
|
|------------- | ------------- | ------------- | -------------|
|
|
200
200
|
| **body** | **object**| | |
|
|
201
201
|
| **orderGroupId** | [**string**] | Order group ID | defaults to undefined|
|
|
202
|
-
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-
|
|
202
|
+
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
|
|
203
203
|
| **exchangeIndex** | [**number**] | | (optional) defaults to undefined|
|
|
204
204
|
|
|
205
205
|
|
package/docs/OrdersApi.md
CHANGED
|
@@ -68,7 +68,7 @@ Endpoint for amending the price and/or max fillable count of an existing event-m
|
|
|
68
68
|
|------------- | ------------- | ------------- | -------------|
|
|
69
69
|
| **amendOrderV2Request** | **AmendOrderV2Request**| | |
|
|
70
70
|
| **orderId** | [**string**] | Order ID | defaults to undefined|
|
|
71
|
-
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-
|
|
71
|
+
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
|
|
72
72
|
|
|
73
73
|
|
|
74
74
|
### Return type
|
|
@@ -244,7 +244,7 @@ Endpoint for submitting a batch of event-market orders using the V2 request/resp
|
|
|
244
244
|
|Name | Type | Description | Notes|
|
|
245
245
|
|------------- | ------------- | ------------- | -------------|
|
|
246
246
|
| **orderId** | [**string**] | Order ID | defaults to undefined|
|
|
247
|
-
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-
|
|
247
|
+
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
|
|
248
248
|
| **exchangeIndex** | [**number**] | | (optional) defaults to undefined|
|
|
249
249
|
|
|
250
250
|
|
|
@@ -280,7 +280,7 @@ Endpoint for cancelling event-market orders using the V2 response shape. Returns
|
|
|
280
280
|
|Name | Type | Description | Notes|
|
|
281
281
|
|------------- | ------------- | ------------- | -------------|
|
|
282
282
|
| **orderId** | [**string**] | Order ID | defaults to undefined|
|
|
283
|
-
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-
|
|
283
|
+
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
|
|
284
284
|
| **exchangeIndex** | [**number**] | | (optional) defaults to undefined|
|
|
285
285
|
|
|
286
286
|
|
|
@@ -339,7 +339,7 @@ Endpoint for cancelling event-market orders using the V2 response shape. Returns
|
|
|
339
339
|
|**400** | Bad request - invalid input | - |
|
|
340
340
|
|**401** | Unauthorized - authentication required | - |
|
|
341
341
|
|**409** | Conflict - resource already exists or cannot be modified | - |
|
|
342
|
-
|**429** | Rate limit exceeded. The default cost is 10 tokens per request
|
|
342
|
+
|**429** | Rate limit exceeded. The default cost is 10 tokens per request. Use GET /trade-api/v2/account/endpoint_costs to list non-default endpoint costs. | - |
|
|
343
343
|
|**500** | Internal server error | - |
|
|
344
344
|
|
|
345
345
|
# **createOrderV2**
|
|
@@ -375,7 +375,7 @@ Endpoint for submitting event-market orders using the V2 request/response shape
|
|
|
375
375
|
|**400** | Bad request - invalid input | - |
|
|
376
376
|
|**401** | Unauthorized - authentication required | - |
|
|
377
377
|
|**409** | Conflict - resource already exists or cannot be modified | - |
|
|
378
|
-
|**429** | Rate limit exceeded. The default cost is 10 tokens per request
|
|
378
|
+
|**429** | Rate limit exceeded. The default cost is 10 tokens per request. Use GET /trade-api/v2/account/endpoint_costs to list non-default endpoint costs. | - |
|
|
379
379
|
|**500** | Internal server error | - |
|
|
380
380
|
|
|
381
381
|
# **decreaseOrder**
|
|
@@ -425,7 +425,7 @@ Endpoint for decreasing the remaining count of an existing event-market order us
|
|
|
425
425
|
|------------- | ------------- | ------------- | -------------|
|
|
426
426
|
| **decreaseOrderV2Request** | **DecreaseOrderV2Request**| | |
|
|
427
427
|
| **orderId** | [**string**] | Order ID | defaults to undefined|
|
|
428
|
-
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-
|
|
428
|
+
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
|
|
429
429
|
|
|
430
430
|
|
|
431
431
|
### Return type
|
|
@@ -530,7 +530,7 @@ Endpoint for decreasing the remaining count of an existing event-market order us
|
|
|
530
530
|
|------------- | ------------- | ------------- | -------------|
|
|
531
531
|
| **marketTickers** | [**string**] | Comma-separated list of market tickers to filter by | (optional) defaults to undefined|
|
|
532
532
|
| **eventTicker** | [**string**] | Event ticker to filter by | (optional) defaults to undefined|
|
|
533
|
-
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-
|
|
533
|
+
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
|
|
534
534
|
|
|
535
535
|
|
|
536
536
|
### Return type
|
|
@@ -571,7 +571,7 @@ Restricts the response to orders that have a certain status: resting, canceled,
|
|
|
571
571
|
| **status** | [**string**] | Filter by status. Possible values depend on the endpoint. | (optional) defaults to undefined|
|
|
572
572
|
| **limit** | [**number**] | Number of results per page. Defaults to 100. | (optional) defaults to 100|
|
|
573
573
|
| **cursor** | [**string**] | Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. | (optional) defaults to undefined|
|
|
574
|
-
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-
|
|
574
|
+
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts. | (optional) defaults to undefined|
|
|
575
575
|
|
|
576
576
|
|
|
577
577
|
### Return type
|
package/docs/PortfolioApi.md
CHANGED
|
@@ -21,7 +21,7 @@ All URIs are relative to *https://external-api.kalshi.com/trade-api/v2*
|
|
|
21
21
|
# **applySubaccountTransfer**
|
|
22
22
|
> object applySubaccountTransfer(applySubaccountTransferRequest)
|
|
23
23
|
|
|
24
|
-
Transfers funds between the authenticated user\'s subaccounts. Use 0 for the primary account, or 1-
|
|
24
|
+
Transfers funds between the authenticated user\'s subaccounts. Use 0 for the primary account, or 1-63 for numbered subaccounts.
|
|
25
25
|
|
|
26
26
|
### Parameters
|
|
27
27
|
|
|
@@ -55,7 +55,7 @@ Transfers funds between the authenticated user\'s subaccounts. Use 0 for the pri
|
|
|
55
55
|
# **createSubaccount**
|
|
56
56
|
> CreateSubaccountResponse createSubaccount()
|
|
57
57
|
|
|
58
|
-
Creates a new subaccount for the authenticated user. This endpoint is currently only available to institutions and market makers. Subaccounts are numbered sequentially starting from 1. Maximum
|
|
58
|
+
Creates a new subaccount for the authenticated user. This endpoint is currently only available to institutions and market makers. Subaccounts are numbered sequentially starting from 1. Maximum 63 numbered subaccounts per user (64 including the primary account).
|
|
59
59
|
|
|
60
60
|
### Parameters
|
|
61
61
|
This endpoint does not have any parameters.
|
|
@@ -86,13 +86,13 @@ This endpoint does not have any parameters.
|
|
|
86
86
|
# **getBalance**
|
|
87
87
|
> GetBalanceResponse getBalance()
|
|
88
88
|
|
|
89
|
-
|
|
89
|
+
Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents. This endpoint also accepts API keys with the \'read::portfolio_balance\' scope.
|
|
90
90
|
|
|
91
91
|
### Parameters
|
|
92
92
|
|
|
93
93
|
|Name | Type | Description | Notes|
|
|
94
94
|
|------------- | ------------- | ------------- | -------------|
|
|
95
|
-
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-
|
|
95
|
+
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
|
|
96
96
|
|
|
97
97
|
|
|
98
98
|
### Return type
|
|
@@ -166,7 +166,7 @@ Endpoint for getting all fills for the member. A fill is when a trade you have i
|
|
|
166
166
|
| **maxTs** | [**number**] | Filter items before this Unix timestamp | (optional) defaults to undefined|
|
|
167
167
|
| **limit** | [**number**] | Number of results per page. Defaults to 100. | (optional) defaults to 100|
|
|
168
168
|
| **cursor** | [**string**] | Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. | (optional) defaults to undefined|
|
|
169
|
-
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-
|
|
169
|
+
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts. | (optional) defaults to undefined|
|
|
170
170
|
|
|
171
171
|
|
|
172
172
|
### Return type
|
|
@@ -235,7 +235,7 @@ Restricts the positions to those with any of following fields with non-zero valu
|
|
|
235
235
|
| **countFilter** | [**string**] | Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted - position, total_traded | (optional) defaults to undefined|
|
|
236
236
|
| **ticker** | [**string**] | Filter by market ticker | (optional) defaults to undefined|
|
|
237
237
|
| **eventTicker** | [**string**] | Event ticker to filter by. Only a single event ticker is supported. | (optional) defaults to undefined|
|
|
238
|
-
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-
|
|
238
|
+
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. | (optional) defaults to undefined|
|
|
239
239
|
|
|
240
240
|
|
|
241
241
|
### Return type
|
|
@@ -275,7 +275,7 @@ Restricts the positions to those with any of following fields with non-zero valu
|
|
|
275
275
|
| **eventTicker** | [**string**] | Event ticker to filter by. Only a single event ticker is supported. | (optional) defaults to undefined|
|
|
276
276
|
| **minTs** | [**number**] | Filter items after this Unix timestamp | (optional) defaults to undefined|
|
|
277
277
|
| **maxTs** | [**number**] | Filter items before this Unix timestamp | (optional) defaults to undefined|
|
|
278
|
-
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-
|
|
278
|
+
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts. | (optional) defaults to undefined|
|
|
279
279
|
|
|
280
280
|
|
|
281
281
|
### Return type
|
|
@@ -432,7 +432,7 @@ Endpoint for getting the member\'s withdrawal history.
|
|
|
432
432
|
# **updateSubaccountNetting**
|
|
433
433
|
> updateSubaccountNetting(updateSubaccountNettingRequest)
|
|
434
434
|
|
|
435
|
-
Updates the netting enabled setting for a specific subaccount. Use 0 for the primary account, or 1-
|
|
435
|
+
Updates the netting enabled setting for a specific subaccount. Use 0 for the primary account, or 1-63 for numbered subaccounts.
|
|
436
436
|
|
|
437
437
|
### Parameters
|
|
438
438
|
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# ProposeBlockTradeRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**buyer_user_id** | **string** | User ID of the buyer | [default to undefined]
|
|
9
|
+
**buyer_subtrader_id** | **string** | Subtrader ID of the buyer. Provide either this or buyer_subaccount, not both. | [optional] [default to undefined]
|
|
10
|
+
**buyer_subaccount** | **number** | User-managed subaccount number of the buyer (0 for primary, 1-63 for numbered subaccounts). Provide either this or buyer_subtrader_id, not both. | [optional] [default to undefined]
|
|
11
|
+
**seller_user_id** | **string** | User ID of the seller | [default to undefined]
|
|
12
|
+
**seller_subtrader_id** | **string** | Subtrader ID of the seller. Provide either this or seller_subaccount, not both. | [optional] [default to undefined]
|
|
13
|
+
**seller_subaccount** | **number** | User-managed subaccount number of the seller (0 for primary, 1-63 for numbered subaccounts). Provide either this or seller_subtrader_id, not both. | [optional] [default to undefined]
|
|
14
|
+
**market_ticker** | **string** | The ticker of the market for this block trade | [default to undefined]
|
|
15
|
+
**price_centi_cents** | **number** | Price in centi-cents | [default to undefined]
|
|
16
|
+
**centicount** | **number** | Number of contracts in centicounts | [default to undefined]
|
|
17
|
+
**maker_side** | **string** | The maker side of the trade | [default to undefined]
|
|
18
|
+
**expiration_ts** | **string** | Expiration time of the proposal | [default to undefined]
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import { ProposeBlockTradeRequest } from 'kalshi-typescript';
|
|
24
|
+
|
|
25
|
+
const instance: ProposeBlockTradeRequest = {
|
|
26
|
+
buyer_user_id,
|
|
27
|
+
buyer_subtrader_id,
|
|
28
|
+
buyer_subaccount,
|
|
29
|
+
seller_user_id,
|
|
30
|
+
seller_subtrader_id,
|
|
31
|
+
seller_subaccount,
|
|
32
|
+
market_ticker,
|
|
33
|
+
price_centi_cents,
|
|
34
|
+
centicount,
|
|
35
|
+
maker_side,
|
|
36
|
+
expiration_ts,
|
|
37
|
+
};
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
[[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,20 @@
|
|
|
1
|
+
# ProposeBlockTradeResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**block_trade_proposal_id** | **string** | The ID of the newly created block trade proposal | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { ProposeBlockTradeResponse } from 'kalshi-typescript';
|
|
14
|
+
|
|
15
|
+
const instance: ProposeBlockTradeResponse = {
|
|
16
|
+
block_trade_proposal_id,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[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/Settlement.md
CHANGED
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**ticker** | **string** | The ticker symbol of the market that was settled. | [default to undefined]
|
|
9
9
|
**event_ticker** | **string** | The event ticker symbol of the market that was settled. | [default to undefined]
|
|
10
|
-
**market_result** | **string** | The outcome of the market settlement. \'yes\' = market resolved to YES, \'no\' = market resolved to NO, \'scalar\' = scalar market settled at a specific value
|
|
10
|
+
**market_result** | **string** | The outcome of the market settlement. \'yes\' = market resolved to YES, \'no\' = market resolved to NO, \'scalar\' = scalar market settled at a specific value. | [default to undefined]
|
|
11
11
|
**yes_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]
|
|
12
12
|
**yes_total_cost_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]
|
|
13
13
|
**no_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]
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**subaccount_number** | **number** | Subaccount number (0 for primary, 1-
|
|
8
|
+
**subaccount_number** | **number** | Subaccount number (0 for primary, 1-63 for subaccounts). | [default to undefined]
|
|
9
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
10
|
**updated_ts** | **number** | Unix timestamp of last balance update. | [default to undefined]
|
|
11
11
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**subaccount_number** | **number** | Subaccount number (0 for primary, 1-
|
|
8
|
+
**subaccount_number** | **number** | Subaccount number (0 for primary, 1-63 for subaccounts). | [default to undefined]
|
|
9
9
|
**enabled** | **boolean** | Whether netting is enabled for this subaccount. | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**transfer_id** | **string** | Unique identifier for this transfer. | [default to undefined]
|
|
9
|
-
**from_subaccount** | **number** | Source subaccount number (0 for primary, 1-
|
|
10
|
-
**to_subaccount** | **number** | Destination subaccount number (0 for primary, 1-
|
|
9
|
+
**from_subaccount** | **number** | Source subaccount number (0 for primary, 1-63 for subaccounts). | [default to undefined]
|
|
10
|
+
**to_subaccount** | **number** | Destination subaccount number (0 for primary, 1-63 for subaccounts). | [default to undefined]
|
|
11
11
|
**amount_cents** | **number** | Transfer amount in cents. | [default to undefined]
|
|
12
12
|
**created_ts** | **number** | Unix timestamp when the transfer was created. | [default to undefined]
|
|
13
13
|
|
package/docs/Trade.md
CHANGED
|
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**taker_outcome_side** | **string** | The outcome side the taker is positioned for. buy-yes and sell-no produce \'yes\'; buy-no and sell-yes produce \'no\'. `taker_outcome_side` describes directional exposure only; it does not change the trade\'s price. A trade at price `p` with `taker_outcome_side=no` is matched against the maker at the same price `p` with the opposite direction — both parties trade at the same price. `taker_outcome_side` and `taker_book_side` will become the canonical way to determine trade direction. The legacy `taker_side` field will be deprecated in a future release — please migrate to these new fields. | [default to undefined]
|
|
15
15
|
**taker_book_side** | [**BookSide**](BookSide.md) | | [default to undefined]
|
|
16
16
|
**created_time** | **string** | Timestamp when this trade was executed | [default to undefined]
|
|
17
|
+
**is_block_trade** | **boolean** | True if this trade was matched off-book as a block trade (e.g. via RFQ / negotiated block proposal); false for trades that filled on the standard order book. | [default to undefined]
|
|
17
18
|
|
|
18
19
|
## Example
|
|
19
20
|
|
|
@@ -30,6 +31,7 @@ const instance: Trade = {
|
|
|
30
31
|
taker_outcome_side,
|
|
31
32
|
taker_book_side,
|
|
32
33
|
created_time,
|
|
34
|
+
is_block_trade,
|
|
33
35
|
};
|
|
34
36
|
```
|
|
35
37
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**subaccount_number** | **number** | Subaccount number (0 for primary, 1-
|
|
8
|
+
**subaccount_number** | **number** | Subaccount number (0 for primary, 1-63 for subaccounts). | [default to undefined]
|
|
9
9
|
**enabled** | **boolean** | Whether netting is enabled for this subaccount. | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
package/index.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Kalshi Trade API Manual Endpoints
|
|
5
5
|
* Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 3.
|
|
7
|
+
* The version of the OpenAPI document: 3.21.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Kalshi Trade API Manual Endpoints
|
|
5
|
+
* Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 3.21.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
export interface AcceptBlockTradeProposalRequest {
|
|
18
|
+
/**
|
|
19
|
+
* Subtrader ID to accept as. Provide either this or subaccount, not both.
|
|
20
|
+
*/
|
|
21
|
+
'subtrader_id'?: string;
|
|
22
|
+
/**
|
|
23
|
+
* User-managed subaccount number to accept as (0 for primary, 1-63 for numbered subaccounts). Provide either this or subtrader_id, not both.
|
|
24
|
+
*/
|
|
25
|
+
'subaccount'?: number;
|
|
26
|
+
}
|
|
27
|
+
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Kalshi Trade API Manual Endpoints
|
|
5
5
|
* Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 3.
|
|
7
|
+
* The version of the OpenAPI document: 3.21.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Kalshi Trade API Manual Endpoints
|
|
5
|
+
* Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 3.21.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
export interface AccountApiUsageLevelVolumeGoal {
|
|
18
|
+
/**
|
|
19
|
+
* API usage level for this Predictions volume goal.
|
|
20
|
+
*/
|
|
21
|
+
'level': string;
|
|
22
|
+
/**
|
|
23
|
+
* 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.
|
|
24
|
+
*/
|
|
25
|
+
'earn_volume_goal_fp': string;
|
|
26
|
+
/**
|
|
27
|
+
* 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.
|
|
28
|
+
*/
|
|
29
|
+
'keep_volume_goal_fp': string;
|
|
30
|
+
}
|
|
31
|
+
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Kalshi Trade API Manual Endpoints
|
|
5
|
+
* Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 3.21.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
// May contain unused imports in some cases
|
|
17
|
+
// @ts-ignore
|
|
18
|
+
import type { AccountApiUsageLevelVolumeGoal } from './account-api-usage-level-volume-goal';
|
|
19
|
+
|
|
20
|
+
export interface AccountApiUsageLevelVolumeProgress {
|
|
21
|
+
/**
|
|
22
|
+
* Unix timestamp (seconds) when this progress was computed; trailing_30d_volume_fp covers the trailing 30 days ending at this time.
|
|
23
|
+
*/
|
|
24
|
+
'computed_ts': number;
|
|
25
|
+
/**
|
|
26
|
+
* 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.
|
|
27
|
+
*/
|
|
28
|
+
'trailing_30d_volume_fp': string;
|
|
29
|
+
'goals': Array<AccountApiUsageLevelVolumeGoal>;
|
|
30
|
+
}
|
|
31
|
+
|