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
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Kalshi Trade API Manual Endpoints
|
|
3
3
|
* Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.
|
|
5
|
+
* The version of the OpenAPI document: 3.21.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Kalshi Trade API Manual Endpoints
|
|
6
6
|
* Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 3.
|
|
8
|
+
* The version of the OpenAPI document: 3.21.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Kalshi Trade API Manual Endpoints
|
|
3
3
|
* Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.
|
|
5
|
+
* The version of the OpenAPI document: 3.21.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Kalshi Trade API Manual Endpoints
|
|
6
6
|
* Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 3.
|
|
8
|
+
* The version of the OpenAPI document: 3.21.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# AcceptBlockTradeProposalRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**subtrader_id** | **string** | Subtrader ID to accept as. Provide either this or subaccount, not both. | [optional] [default to undefined]
|
|
9
|
+
**subaccount** | **number** | User-managed subaccount number to accept as (0 for primary, 1-63 for numbered subaccounts). Provide either this or subtrader_id, not both. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { AcceptBlockTradeProposalRequest } from 'kalshi-typescript';
|
|
15
|
+
|
|
16
|
+
const instance: AcceptBlockTradeProposalRequest = {
|
|
17
|
+
subtrader_id,
|
|
18
|
+
subaccount,
|
|
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/AccountApi.md
CHANGED
|
@@ -5,12 +5,14 @@ All URIs are relative to *https://external-api.kalshi.com/trade-api/v2*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**getAccountApiLimits**](#getaccountapilimits) | **GET** /account/limits | Get Account API Limits|
|
|
8
|
+
|[**getAccountApiUsageLevelVolumeProgress**](#getaccountapiusagelevelvolumeprogress) | **GET** /account/api_usage_level/volume_progress | Get Account API Usage Level Volume Progress|
|
|
8
9
|
|[**getAccountEndpointCosts**](#getaccountendpointcosts) | **GET** /account/endpoint_costs | List Non-Default Endpoint Costs|
|
|
10
|
+
|[**upgradeAccountApiUsageLevel**](#upgradeaccountapiusagelevel) | **POST** /account/api_usage_level/upgrade | Upgrade Account API Usage Level|
|
|
9
11
|
|
|
10
12
|
# **getAccountApiLimits**
|
|
11
13
|
> GetAccountApiLimitsResponse getAccountApiLimits()
|
|
12
14
|
|
|
13
|
-
|
|
15
|
+
Endpoint to retrieve the authenticated user\'s Predictions API usage tier and token-bucket limits. Public Predictions tiers include Basic, Advanced, Expert, Premier, Paragon, Prime, and Prestige.
|
|
14
16
|
|
|
15
17
|
### Parameters
|
|
16
18
|
This endpoint does not have any parameters.
|
|
@@ -37,6 +39,36 @@ This endpoint does not have any parameters.
|
|
|
37
39
|
|**401** | Unauthorized | - |
|
|
38
40
|
|**500** | Internal server error | - |
|
|
39
41
|
|
|
42
|
+
# **getAccountApiUsageLevelVolumeProgress**
|
|
43
|
+
> GetAccountApiUsageLevelVolumeProgressResponse getAccountApiUsageLevelVolumeProgress()
|
|
44
|
+
|
|
45
|
+
Returns the authenticated user\'s latest cron-computed trading volume progress toward volume-based API usage tiers for the predictions (event_contract) lane. Volume figures are reported as fixed-point contract counts.
|
|
46
|
+
|
|
47
|
+
### Parameters
|
|
48
|
+
This endpoint does not have any parameters.
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
### Return type
|
|
52
|
+
|
|
53
|
+
**GetAccountApiUsageLevelVolumeProgressResponse**
|
|
54
|
+
|
|
55
|
+
### Authorization
|
|
56
|
+
|
|
57
|
+
[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
|
|
58
|
+
|
|
59
|
+
### HTTP request headers
|
|
60
|
+
|
|
61
|
+
- **Content-Type**: Not defined
|
|
62
|
+
- **Accept**: application/json
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
### HTTP response details
|
|
66
|
+
| Status code | Description | Response headers |
|
|
67
|
+
|-------------|-------------|------------------|
|
|
68
|
+
|**200** | Account API usage level volume progress retrieved successfully | - |
|
|
69
|
+
|**401** | Unauthorized | - |
|
|
70
|
+
|**500** | Internal server error | - |
|
|
71
|
+
|
|
40
72
|
# **getAccountEndpointCosts**
|
|
41
73
|
> GetAccountEndpointCostsResponse getAccountEndpointCosts()
|
|
42
74
|
|
|
@@ -66,3 +98,35 @@ No authorization required
|
|
|
66
98
|
|**200** | Non-default endpoint costs retrieved successfully | - |
|
|
67
99
|
|**500** | Internal server error | - |
|
|
68
100
|
|
|
101
|
+
# **upgradeAccountApiUsageLevel**
|
|
102
|
+
> upgradeAccountApiUsageLevel()
|
|
103
|
+
|
|
104
|
+
Grants a permanent Advanced API usage-level grant. Currently only the Predictions exchange instance is supported. Criteria: at least 1 of the user\'s last 100 Predictions orders was created via API. Use Get Account API Limits to inspect the resulting usage tier and grants.
|
|
105
|
+
|
|
106
|
+
### Parameters
|
|
107
|
+
This endpoint does not have any parameters.
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
### Return type
|
|
111
|
+
|
|
112
|
+
void (empty response body)
|
|
113
|
+
|
|
114
|
+
### Authorization
|
|
115
|
+
|
|
116
|
+
[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
|
|
117
|
+
|
|
118
|
+
### HTTP request headers
|
|
119
|
+
|
|
120
|
+
- **Content-Type**: Not defined
|
|
121
|
+
- **Accept**: Not defined
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
### HTTP response details
|
|
125
|
+
| Status code | Description | Response headers |
|
|
126
|
+
|-------------|-------------|------------------|
|
|
127
|
+
|**201** | Advanced API usage-level grant created or refreshed successfully | - |
|
|
128
|
+
|**401** | Unauthorized | - |
|
|
129
|
+
|**403** | No API-created order was found in the user\'s latest 100 Predictions orders | - |
|
|
130
|
+
|**429** | Rate limit exceeded. This endpoint costs 30 tokens and uses the Predictions Write bucket. | - |
|
|
131
|
+
|**500** | Internal server error | - |
|
|
132
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# AccountApiUsageLevelVolumeGoal
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**level** | **string** | API usage level for this Predictions volume goal. | [default to undefined]
|
|
9
|
+
**earn_volume_goal_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]
|
|
10
|
+
**keep_volume_goal_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]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { AccountApiUsageLevelVolumeGoal } from 'kalshi-typescript';
|
|
16
|
+
|
|
17
|
+
const instance: AccountApiUsageLevelVolumeGoal = {
|
|
18
|
+
level,
|
|
19
|
+
earn_volume_goal_fp,
|
|
20
|
+
keep_volume_goal_fp,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[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,24 @@
|
|
|
1
|
+
# AccountApiUsageLevelVolumeProgress
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**computed_ts** | **number** | Unix timestamp (seconds) when this progress was computed; trailing_30d_volume_fp covers the trailing 30 days ending at this time. | [default to undefined]
|
|
9
|
+
**trailing_30d_volume_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]
|
|
10
|
+
**goals** | [**Array<AccountApiUsageLevelVolumeGoal>**](AccountApiUsageLevelVolumeGoal.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { AccountApiUsageLevelVolumeProgress } from 'kalshi-typescript';
|
|
16
|
+
|
|
17
|
+
const instance: AccountApiUsageLevelVolumeProgress = {
|
|
18
|
+
computed_ts,
|
|
19
|
+
trailing_30d_volume_fp,
|
|
20
|
+
goals,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**subaccount** | **number** | Optional subaccount number to use for this amendment (0 for primary, 1-
|
|
8
|
+
**subaccount** | **number** | Optional subaccount number to use for this amendment (0 for primary, 1-63 for subaccounts) | [optional] [default to 0]
|
|
9
9
|
**ticker** | **string** | Market ticker | [default to undefined]
|
|
10
10
|
**side** | **string** | Side of the order | [default to undefined]
|
|
11
11
|
**action** | **string** | Action of the order | [default to undefined]
|
package/docs/ApiKey.md
CHANGED
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**api_key_id** | **string** | Unique identifier for the API key | [default to undefined]
|
|
9
9
|
**name** | **string** | User-provided name for the API key | [default to undefined]
|
|
10
|
-
**scopes** | **Array<
|
|
10
|
+
**scopes** | [**Array<ApiKeyScope>**](ApiKeyScope.md) | List of scopes granted to this API key. | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ApiKeyScope
|
|
2
|
+
|
|
3
|
+
Scope granted to an API key. Parent scopes grant broad access; for example, `read` grants all read endpoints and `write` grants all write endpoints. Child scopes such as `read::block_trade_accept`, `read::portfolio_balance`, `write::transfer`, and `write::block_trade_accept` grant only their specific endpoint group and can be granted without the parent scope.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `ApiKeyScopeRead` (value: `'read'`)
|
|
8
|
+
|
|
9
|
+
* `ApiKeyScopeWrite` (value: `'write'`)
|
|
10
|
+
|
|
11
|
+
* `ApiKeyScopeReadBlockTradeAccept` (value: `'read::block_trade_accept'`)
|
|
12
|
+
|
|
13
|
+
* `ApiKeyScopeReadPortfolioBalance` (value: `'read::portfolio_balance'`)
|
|
14
|
+
|
|
15
|
+
* `ApiKeyScopeWriteTransfer` (value: `'write::transfer'`)
|
|
16
|
+
|
|
17
|
+
* `ApiKeyScopeWriteBlockTradeAccept` (value: `'write::block_trade_accept'`)
|
|
18
|
+
|
|
19
|
+
[[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,26 @@
|
|
|
1
|
+
# ApiUsageLevelGrant
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**exchange_instance** | [**ExchangeInstance**](ExchangeInstance.md) | | [default to undefined]
|
|
9
|
+
**level** | **string** | API usage level this grant confers (for example, expert, premier, paragon, prime, or prestige). | [default to undefined]
|
|
10
|
+
**expires_ts** | **number** | Unix timestamp (seconds) when the grant expires. Absent for permanent grants. | [optional] [default to undefined]
|
|
11
|
+
**source** | **string** | How the grant was created: \"volume\" (earned from trading volume) or \"manual\" (assigned by Kalshi). | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ApiUsageLevelGrant } from 'kalshi-typescript';
|
|
17
|
+
|
|
18
|
+
const instance: ApiUsageLevelGrant = {
|
|
19
|
+
exchange_instance,
|
|
20
|
+
level,
|
|
21
|
+
expires_ts,
|
|
22
|
+
source,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**client_transfer_id** | **string** | Unique client-provided transfer ID for idempotency. | [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 numbered subaccounts). | [default to undefined]
|
|
10
|
+
**to_subaccount** | **number** | Destination subaccount number (0 for primary, 1-63 for numbered subaccounts). | [default to undefined]
|
|
11
11
|
**amount_cents** | **number** | Amount to transfer in cents. | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**order_id** | **string** | Order ID to cancel | [default to undefined]
|
|
9
|
-
**subaccount** | **number** | Optional subaccount number to use for this cancellation (0 for primary, 1-
|
|
9
|
+
**subaccount** | **number** | Optional subaccount number to use for this cancellation (0 for primary, 1-63 for subaccounts) | [optional] [default to 0]
|
|
10
10
|
**exchange_index** | **number** | Identifier for an exchange shard. Defaults to 0 if unspecified. Note: currently only 0 supported. | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**order_id** | **string** | Order ID to cancel. | [default to undefined]
|
|
9
|
-
**subaccount** | **number** | Optional subaccount number to use for this cancellation (0 for primary, 1-
|
|
9
|
+
**subaccount** | **number** | Optional subaccount number to use for this cancellation (0 for primary, 1-63 for subaccounts). | [optional] [default to 0]
|
|
10
10
|
**exchange_index** | **number** | Identifier for an exchange shard. Defaults to 0 if unspecified. Note: currently only 0 supported. | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# BlockTradeProposal
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | Unique identifier for the block trade proposal | [default to undefined]
|
|
9
|
+
**proposer_user_id** | **string** | User ID of the proposal creator | [default to undefined]
|
|
10
|
+
**buyer_user_id** | **string** | User ID of the buyer. Empty when the authenticated user is not the buyer. | [default to undefined]
|
|
11
|
+
**buyer_subtrader_id** | **string** | Subtrader ID of the buyer. Empty when the authenticated user is not the buyer. | [optional] [default to undefined]
|
|
12
|
+
**seller_user_id** | **string** | User ID of the seller. Empty when the authenticated user is not the seller. | [default to undefined]
|
|
13
|
+
**seller_subtrader_id** | **string** | Subtrader ID of the seller. Empty when the authenticated user is not the seller. | [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
|
+
**status** | **string** | Current status of the proposal | [default to undefined]
|
|
20
|
+
**created_ts** | **string** | Timestamp when the proposal was created | [default to undefined]
|
|
21
|
+
**updated_ts** | **string** | Timestamp when the proposal was last updated | [default to undefined]
|
|
22
|
+
**buyer_accepted** | **boolean** | Whether the buyer has accepted the proposal | [default to undefined]
|
|
23
|
+
**seller_accepted** | **boolean** | Whether the seller has accepted the proposal | [default to undefined]
|
|
24
|
+
**buyer_accepted_ts** | **string** | Timestamp when the buyer accepted | [optional] [default to undefined]
|
|
25
|
+
**seller_accepted_ts** | **string** | Timestamp when the seller accepted | [optional] [default to undefined]
|
|
26
|
+
**executed_ts** | **string** | Timestamp when the proposal was executed | [optional] [default to undefined]
|
|
27
|
+
**buyer_order_id** | **string** | Order ID for the buyer after the proposal is executed | [optional] [default to undefined]
|
|
28
|
+
**seller_order_id** | **string** | Order ID for the seller after the proposal is executed | [optional] [default to undefined]
|
|
29
|
+
|
|
30
|
+
## Example
|
|
31
|
+
|
|
32
|
+
```typescript
|
|
33
|
+
import { BlockTradeProposal } from 'kalshi-typescript';
|
|
34
|
+
|
|
35
|
+
const instance: BlockTradeProposal = {
|
|
36
|
+
id,
|
|
37
|
+
proposer_user_id,
|
|
38
|
+
buyer_user_id,
|
|
39
|
+
buyer_subtrader_id,
|
|
40
|
+
seller_user_id,
|
|
41
|
+
seller_subtrader_id,
|
|
42
|
+
market_ticker,
|
|
43
|
+
price_centi_cents,
|
|
44
|
+
centicount,
|
|
45
|
+
maker_side,
|
|
46
|
+
expiration_ts,
|
|
47
|
+
status,
|
|
48
|
+
created_ts,
|
|
49
|
+
updated_ts,
|
|
50
|
+
buyer_accepted,
|
|
51
|
+
seller_accepted,
|
|
52
|
+
buyer_accepted_ts,
|
|
53
|
+
seller_accepted_ts,
|
|
54
|
+
executed_ts,
|
|
55
|
+
buyer_order_id,
|
|
56
|
+
seller_order_id,
|
|
57
|
+
};
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -4,17 +4,56 @@ All URIs are relative to *https://external-api.kalshi.com/trade-api/v2*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**acceptBlockTradeProposal**](#acceptblocktradeproposal) | **POST** /communications/block-trade-proposals/{block_trade_proposal_id}/accept | Accept Block Trade Proposal|
|
|
7
8
|
|[**acceptQuote**](#acceptquote) | **PUT** /communications/quotes/{quote_id}/accept | Accept Quote|
|
|
8
9
|
|[**confirmQuote**](#confirmquote) | **PUT** /communications/quotes/{quote_id}/confirm | Confirm Quote|
|
|
9
10
|
|[**createQuote**](#createquote) | **POST** /communications/quotes | Create Quote|
|
|
10
11
|
|[**createRFQ**](#createrfq) | **POST** /communications/rfqs | Create RFQ|
|
|
11
12
|
|[**deleteQuote**](#deletequote) | **DELETE** /communications/quotes/{quote_id} | Delete Quote|
|
|
12
13
|
|[**deleteRFQ**](#deleterfq) | **DELETE** /communications/rfqs/{rfq_id} | Delete RFQ|
|
|
14
|
+
|[**getBlockTradeProposals**](#getblocktradeproposals) | **GET** /communications/block-trade-proposals | Get Block Trade Proposals|
|
|
13
15
|
|[**getCommunicationsID**](#getcommunicationsid) | **GET** /communications/id | Get Communications ID|
|
|
14
16
|
|[**getQuote**](#getquote) | **GET** /communications/quotes/{quote_id} | Get Quote|
|
|
15
17
|
|[**getQuotes**](#getquotes) | **GET** /communications/quotes | Get Quotes|
|
|
16
18
|
|[**getRFQ**](#getrfq) | **GET** /communications/rfqs/{rfq_id} | Get RFQ|
|
|
17
19
|
|[**getRFQs**](#getrfqs) | **GET** /communications/rfqs | Get RFQs|
|
|
20
|
+
|[**proposeBlockTrade**](#proposeblocktrade) | **POST** /communications/block-trade-proposals | Propose Block Trade|
|
|
21
|
+
|
|
22
|
+
# **acceptBlockTradeProposal**
|
|
23
|
+
> acceptBlockTradeProposal()
|
|
24
|
+
|
|
25
|
+
Endpoint for accepting a block trade proposal.
|
|
26
|
+
|
|
27
|
+
### Parameters
|
|
28
|
+
|
|
29
|
+
|Name | Type | Description | Notes|
|
|
30
|
+
|------------- | ------------- | ------------- | -------------|
|
|
31
|
+
| **acceptBlockTradeProposalRequest** | **AcceptBlockTradeProposalRequest**| | |
|
|
32
|
+
| **blockTradeProposalId** | [**string**] | Block trade proposal ID | defaults to undefined|
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
### Return type
|
|
36
|
+
|
|
37
|
+
void (empty response body)
|
|
38
|
+
|
|
39
|
+
### Authorization
|
|
40
|
+
|
|
41
|
+
[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
|
|
42
|
+
|
|
43
|
+
### HTTP request headers
|
|
44
|
+
|
|
45
|
+
- **Content-Type**: application/json
|
|
46
|
+
- **Accept**: application/json
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
### HTTP response details
|
|
50
|
+
| Status code | Description | Response headers |
|
|
51
|
+
|-------------|-------------|------------------|
|
|
52
|
+
|**204** | Block trade proposal accepted successfully | - |
|
|
53
|
+
|**400** | Bad request - invalid input | - |
|
|
54
|
+
|**401** | Unauthorized - authentication required | - |
|
|
55
|
+
|**404** | Resource not found | - |
|
|
56
|
+
|**500** | Internal server error | - |
|
|
18
57
|
|
|
19
58
|
# **acceptQuote**
|
|
20
59
|
> acceptQuote(acceptQuoteRequest)
|
|
@@ -224,6 +263,43 @@ void (empty response body)
|
|
|
224
263
|
|**404** | Resource not found | - |
|
|
225
264
|
|**500** | Internal server error | - |
|
|
226
265
|
|
|
266
|
+
# **getBlockTradeProposals**
|
|
267
|
+
> GetBlockTradeProposalsResponse getBlockTradeProposals()
|
|
268
|
+
|
|
269
|
+
Endpoint for getting block trade proposals visible to the authenticated user.
|
|
270
|
+
|
|
271
|
+
### Parameters
|
|
272
|
+
|
|
273
|
+
|Name | Type | Description | Notes|
|
|
274
|
+
|------------- | ------------- | ------------- | -------------|
|
|
275
|
+
| **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|
|
|
276
|
+
| **marketTicker** | [**string**] | Filter by market ticker | (optional) defaults to undefined|
|
|
277
|
+
| **limit** | [**number**] | Parameter to specify the number of results per page. Defaults to 100. | (optional) defaults to 100|
|
|
278
|
+
| **status** | [**string**] | Filter block trade proposals by status | (optional) defaults to undefined|
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
### Return type
|
|
282
|
+
|
|
283
|
+
**GetBlockTradeProposalsResponse**
|
|
284
|
+
|
|
285
|
+
### Authorization
|
|
286
|
+
|
|
287
|
+
[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
|
|
288
|
+
|
|
289
|
+
### HTTP request headers
|
|
290
|
+
|
|
291
|
+
- **Content-Type**: Not defined
|
|
292
|
+
- **Accept**: application/json
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
### HTTP response details
|
|
296
|
+
| Status code | Description | Response headers |
|
|
297
|
+
|-------------|-------------|------------------|
|
|
298
|
+
|**200** | Block trade proposals retrieved successfully | - |
|
|
299
|
+
|**400** | Bad request - invalid input | - |
|
|
300
|
+
|**401** | Unauthorized - authentication required | - |
|
|
301
|
+
|**500** | Internal server error | - |
|
|
302
|
+
|
|
227
303
|
# **getCommunicationsID**
|
|
228
304
|
> GetCommunicationsIDResponse getCommunicationsID()
|
|
229
305
|
|
|
@@ -300,6 +376,8 @@ This endpoint does not have any parameters.
|
|
|
300
376
|
| **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|
|
|
301
377
|
| **eventTicker** | [**string**] | Event ticker to filter by. Only a single event ticker is supported. | (optional) defaults to undefined|
|
|
302
378
|
| **marketTicker** | [**string**] | Filter by market ticker | (optional) defaults to undefined|
|
|
379
|
+
| **minTs** | [**number**] | Restricts the response to quotes last updated after a timestamp, formatted as a Unix Timestamp | (optional) defaults to undefined|
|
|
380
|
+
| **maxTs** | [**number**] | Restricts the response to quotes last updated before a timestamp, formatted as a Unix Timestamp | (optional) defaults to undefined|
|
|
303
381
|
| **limit** | [**number**] | Parameter to specify the number of results per page. Defaults to 500. | (optional) defaults to 500|
|
|
304
382
|
| **status** | [**string**] | Filter quotes by status | (optional) defaults to undefined|
|
|
305
383
|
| **quoteCreatorUserId** | [**string**] | Filter quotes by quote creator user ID | (optional) defaults to undefined|
|
|
@@ -377,7 +455,7 @@ This endpoint does not have any parameters.
|
|
|
377
455
|
| **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|
|
|
378
456
|
| **eventTicker** | [**string**] | Event ticker to filter by. Only a single event ticker is supported. | (optional) defaults to undefined|
|
|
379
457
|
| **marketTicker** | [**string**] | Filter by market ticker | (optional) defaults to undefined|
|
|
380
|
-
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-
|
|
458
|
+
| **subaccount** | [**number**] | Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts. | (optional) defaults to undefined|
|
|
381
459
|
| **limit** | [**number**] | Parameter to specify the number of results per page. Defaults to 100. | (optional) defaults to 100|
|
|
382
460
|
| **status** | [**string**] | Filter RFQs by status | (optional) defaults to undefined|
|
|
383
461
|
| **creatorUserId** | [**string**] | Filter RFQs by creator user ID | (optional) defaults to undefined|
|
|
@@ -405,3 +483,38 @@ This endpoint does not have any parameters.
|
|
|
405
483
|
|**401** | Unauthorized - authentication required | - |
|
|
406
484
|
|**500** | Internal server error | - |
|
|
407
485
|
|
|
486
|
+
# **proposeBlockTrade**
|
|
487
|
+
> ProposeBlockTradeResponse proposeBlockTrade(proposeBlockTradeRequest)
|
|
488
|
+
|
|
489
|
+
Endpoint for creating a block trade proposal.
|
|
490
|
+
|
|
491
|
+
### Parameters
|
|
492
|
+
|
|
493
|
+
|Name | Type | Description | Notes|
|
|
494
|
+
|------------- | ------------- | ------------- | -------------|
|
|
495
|
+
| **proposeBlockTradeRequest** | **ProposeBlockTradeRequest**| | |
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
### Return type
|
|
499
|
+
|
|
500
|
+
**ProposeBlockTradeResponse**
|
|
501
|
+
|
|
502
|
+
### Authorization
|
|
503
|
+
|
|
504
|
+
[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
|
|
505
|
+
|
|
506
|
+
### HTTP request headers
|
|
507
|
+
|
|
508
|
+
- **Content-Type**: application/json
|
|
509
|
+
- **Accept**: application/json
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
### HTTP response details
|
|
513
|
+
| Status code | Description | Response headers |
|
|
514
|
+
|-------------|-------------|------------------|
|
|
515
|
+
|**201** | Block trade proposal created successfully | - |
|
|
516
|
+
|**400** | Bad request - invalid input | - |
|
|
517
|
+
|**401** | Unauthorized - authentication required | - |
|
|
518
|
+
|**403** | Forbidden - insufficient permissions | - |
|
|
519
|
+
|**500** | Internal server error | - |
|
|
520
|
+
|
|
@@ -7,7 +7,7 @@ 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
9
|
**public_key** | **string** | RSA public key in PEM format. This will be used to verify signatures on API requests | [default to undefined]
|
|
10
|
-
**scopes** | **Array<
|
|
10
|
+
**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]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**subaccount** | **number** | Optional subaccount number to use for this order group (0 for primary, 1-
|
|
8
|
+
**subaccount** | **number** | Optional subaccount number to use for this order group (0 for primary, 1-63 for subaccounts) | [optional] [default to 0]
|
|
9
9
|
**contracts_limit** | **number** | Specifies the maximum number of contracts that can be matched within this group over a rolling 15-second window. Whole contracts only. Provide contracts_limit or contracts_limit_fp; if both provided they must match. | [optional] [default to undefined]
|
|
10
10
|
**contracts_limit_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. | [optional] [default to undefined]
|
|
11
11
|
**exchange_index** | **number** | Identifier for an exchange shard. Defaults to 0 if unspecified. Note: currently only 0 supported. | [optional] [default to undefined]
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**order_group_id** | **string** | The unique identifier for the created order group | [default to undefined]
|
|
9
|
-
**subaccount** | **number** | Subaccount number that owns the created order group (0 for primary, 1-
|
|
9
|
+
**subaccount** | **number** | Subaccount number that owns the created order group (0 for primary, 1-63 for subaccounts). | [default to undefined]
|
|
10
10
|
**exchange_index** | **number** | Identifier for an exchange shard. Defaults to 0 if unspecified. Note: currently only 0 supported. | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**ticker** | **string** | | [default to undefined]
|
|
9
|
-
**client_order_id** | **string** | | [default to undefined]
|
|
9
|
+
**client_order_id** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**side** | [**BookSide**](BookSide.md) | | [default to undefined]
|
|
11
11
|
**count** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Fractional contract values (e.g., \"2.50\") are supported on markets with fractional trading enabled; the minimum granularity is 0.01 contracts. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
|
|
12
12
|
**price** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**no_bid** | **string** | US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
|
|
11
11
|
**rest_remainder** | **boolean** | Whether to rest the remainder of the quote after execution | [default to undefined]
|
|
12
12
|
**post_only** | **boolean** | If true, the quote creator\'s resting order will be cancelled rather than crossed if it would take liquidity. Defaults to false. | [optional] [default to undefined]
|
|
13
|
-
**subaccount** | **number** | Optional subaccount number to place the quote under (0 for primary, 1-
|
|
13
|
+
**subaccount** | **number** | Optional subaccount number to place the quote under (0 for primary, 1-63 for subaccounts) | [optional] [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
package/docs/CreateRFQRequest.md
CHANGED
|
@@ -6,14 +6,14 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**market_ticker** | **string** | The ticker of the market for which to create an RFQ | [default to undefined]
|
|
9
|
-
**contracts** | **number** |
|
|
9
|
+
**contracts** | **number** | Whole-contract count for the RFQ. Use contracts_fp for partial contract values; if both are provided, they must match. | [optional] [default to undefined]
|
|
10
10
|
**contracts_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. | [optional] [default to undefined]
|
|
11
11
|
**target_cost_centi_cents** | **number** | DEPRECATED: The target cost for the RFQ in centi-cents. Use target_cost_dollars instead. | [optional] [default to undefined]
|
|
12
12
|
**target_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. | [optional] [default to undefined]
|
|
13
13
|
**rest_remainder** | **boolean** | Whether to rest the remainder of the RFQ after execution | [default to undefined]
|
|
14
14
|
**replace_existing** | **boolean** | Whether to delete existing RFQs as part of this RFQ\'s creation | [optional] [default to false]
|
|
15
15
|
**subtrader_id** | **string** | The subtrader to create the RFQ for (FCM members only) | [optional] [default to undefined]
|
|
16
|
-
**subaccount** | **number** | The subaccount number to create the RFQ for (direct members only; 0 for primary, 1-
|
|
16
|
+
**subaccount** | **number** | The subaccount number to create the RFQ for (direct members only; 0 for primary, 1-63 for subaccounts) | [optional] [default to undefined]
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**subaccount_number** | **number** | The sequential number assigned to this subaccount (1-
|
|
8
|
+
**subaccount_number** | **number** | The sequential number assigned to this subaccount (1-63). | [default to undefined]
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**subaccount** | **number** | Optional subaccount number to use for this decrease (0 for primary, 1-
|
|
8
|
+
**subaccount** | **number** | Optional subaccount number to use for this decrease (0 for primary, 1-63 for subaccounts) | [optional] [default to 0]
|
|
9
9
|
**reduce_by** | **number** | Number of contracts to reduce by (whole contracts only). Reduce-by may be provided via reduce_by or reduce_by_fp; if both provided they must match. Exactly one of reduce_by(/reduce_by_fp) or reduce_to(/reduce_to_fp) must be provided. | [optional] [default to undefined]
|
|
10
10
|
**reduce_by_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. | [optional] [default to undefined]
|
|
11
11
|
**reduce_to** | **number** | Number of contracts to reduce to (whole contracts only). Reduce-to may be provided via reduce_to or reduce_to_fp; if both provided they must match. Exactly one of reduce_by(/reduce_by_fp) or reduce_to(/reduce_to_fp) must be provided. | [optional] [default to undefined]
|
package/docs/EventsApi.md
CHANGED
|
@@ -172,6 +172,7 @@ Get all events. This endpoint excludes multivariate events. To retrieve multivar
|
|
|
172
172
|
| **withMilestones** | [**boolean**] | If true, includes related milestones as a field alongside events. | (optional) defaults to false|
|
|
173
173
|
| **status** | [**'unopened' | 'open' | 'closed' | 'settled'**]**Array<'unopened' | 'open' | 'closed' | 'settled'>** | Filter by event status. Possible values are \'unopened\', \'open\', \'closed\', \'settled\'. Leave empty to return events with any status. | (optional) defaults to undefined|
|
|
174
174
|
| **seriesTicker** | [**string**] | Filter by series ticker | (optional) defaults to undefined|
|
|
175
|
+
| **tickers** | [**string**] | Filter by specific event tickers. Comma-separated list of event tickers to retrieve. | (optional) defaults to undefined|
|
|
175
176
|
| **minCloseTs** | [**number**] | Filter events with at least one market with close timestamp greater than this Unix timestamp (in seconds). | (optional) defaults to undefined|
|
|
176
177
|
| **minUpdatedTs** | [**number**] | Filter events with metadata updated after this Unix timestamp (in seconds). Use this to efficiently poll for changes. | (optional) defaults to undefined|
|
|
177
178
|
|