kalshi-typescript 3.13.0 → 3.15.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 +46 -0
- package/README.md +35 -3
- package/api/account-api.ts +64 -1
- package/api/api-keys-api.ts +1 -1
- package/api/communications-api.ts +33 -15
- package/api/events-api.ts +1 -1
- package/api/exchange-api.ts +1 -1
- package/api/fcm-api.ts +1 -1
- package/api/historical-api.ts +5 -5
- package/api/incentive-programs-api.ts +16 -8
- package/api/live-data-api.ts +1 -1
- package/api/market-api.ts +9 -9
- package/api/milestone-api.ts +1 -1
- package/api/multivariate-api.ts +17 -9
- package/api/order-groups-api.ts +1 -1
- package/api/orders-api.ts +545 -13
- package/api/portfolio-api.ts +181 -5
- package/api/search-api.ts +1 -1
- package/api/structured-targets-api.ts +1 -1
- package/api.ts +1 -1
- package/base.ts +2 -2
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api/account-api.d.ts +30 -1
- package/dist/api/account-api.js +59 -1
- 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 +18 -9
- package/dist/api/communications-api.js +29 -15
- package/dist/api/events-api.d.ts +1 -1
- package/dist/api/events-api.js +1 -1
- package/dist/api/exchange-api.d.ts +1 -1
- package/dist/api/exchange-api.js +1 -1
- package/dist/api/fcm-api.d.ts +1 -1
- package/dist/api/fcm-api.js +1 -1
- package/dist/api/historical-api.d.ts +5 -5
- package/dist/api/historical-api.js +5 -5
- package/dist/api/incentive-programs-api.d.ts +9 -5
- package/dist/api/incentive-programs-api.js +15 -8
- package/dist/api/live-data-api.d.ts +1 -1
- package/dist/api/live-data-api.js +1 -1
- package/dist/api/market-api.d.ts +9 -9
- package/dist/api/market-api.js +9 -9
- package/dist/api/milestone-api.d.ts +1 -1
- package/dist/api/milestone-api.js +1 -1
- package/dist/api/multivariate-api.d.ts +17 -9
- package/dist/api/multivariate-api.js +17 -9
- package/dist/api/order-groups-api.d.ts +1 -1
- package/dist/api/order-groups-api.js +1 -1
- package/dist/api/orders-api.d.ts +236 -13
- package/dist/api/orders-api.js +479 -13
- package/dist/api/portfolio-api.d.ts +79 -5
- package/dist/api/portfolio-api.js +161 -5
- package/dist/api/search-api.d.ts +1 -1
- package/dist/api/search-api.js +1 -1
- package/dist/api/structured-targets-api.d.ts +1 -1
- package/dist/api/structured-targets-api.js +1 -1
- package/dist/api.d.ts +1 -1
- package/dist/api.js +1 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +2 -2
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api/account-api.d.ts +30 -1
- package/dist/esm/api/account-api.js +59 -1
- 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 +18 -9
- package/dist/esm/api/communications-api.js +29 -15
- package/dist/esm/api/events-api.d.ts +1 -1
- package/dist/esm/api/events-api.js +1 -1
- package/dist/esm/api/exchange-api.d.ts +1 -1
- package/dist/esm/api/exchange-api.js +1 -1
- package/dist/esm/api/fcm-api.d.ts +1 -1
- package/dist/esm/api/fcm-api.js +1 -1
- package/dist/esm/api/historical-api.d.ts +5 -5
- package/dist/esm/api/historical-api.js +5 -5
- package/dist/esm/api/incentive-programs-api.d.ts +9 -5
- package/dist/esm/api/incentive-programs-api.js +15 -8
- package/dist/esm/api/live-data-api.d.ts +1 -1
- package/dist/esm/api/live-data-api.js +1 -1
- package/dist/esm/api/market-api.d.ts +9 -9
- package/dist/esm/api/market-api.js +9 -9
- 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 +17 -9
- package/dist/esm/api/multivariate-api.js +17 -9
- package/dist/esm/api/order-groups-api.d.ts +1 -1
- package/dist/esm/api/order-groups-api.js +1 -1
- package/dist/esm/api/orders-api.d.ts +236 -13
- package/dist/esm/api/orders-api.js +479 -13
- package/dist/esm/api/portfolio-api.d.ts +79 -5
- package/dist/esm/api/portfolio-api.js +161 -5
- package/dist/esm/api/search-api.d.ts +1 -1
- package/dist/esm/api/search-api.js +1 -1
- package/dist/esm/api/structured-targets-api.d.ts +1 -1
- package/dist/esm/api/structured-targets-api.js +1 -1
- package/dist/esm/api.d.ts +1 -1
- package/dist/esm/api.js +1 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +2 -2
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/models/accept-quote-request.d.ts +1 -1
- package/dist/esm/models/accept-quote-request.js +1 -1
- package/dist/esm/models/amend-order-request.d.ts +1 -1
- package/dist/esm/models/amend-order-request.js +1 -1
- package/dist/esm/models/amend-order-response.d.ts +1 -1
- package/dist/esm/models/amend-order-response.js +1 -1
- package/dist/esm/models/amend-order-v2-request.d.ts +35 -0
- package/dist/esm/models/amend-order-v2-request.js +14 -0
- package/dist/esm/models/amend-order-v2-response.d.ts +35 -0
- package/dist/esm/models/amend-order-v2-response.js +14 -0
- package/dist/esm/models/announcement.d.ts +1 -1
- package/dist/esm/models/announcement.js +1 -1
- package/dist/esm/models/api-key.d.ts +1 -1
- package/dist/esm/models/api-key.js +1 -1
- package/dist/esm/models/apply-subaccount-transfer-request.d.ts +1 -1
- package/dist/esm/models/apply-subaccount-transfer-request.js +1 -1
- package/dist/esm/models/associated-event.d.ts +1 -1
- package/dist/esm/models/associated-event.js +1 -1
- package/dist/esm/models/batch-cancel-orders-individual-response.d.ts +1 -1
- package/dist/esm/models/batch-cancel-orders-individual-response.js +1 -1
- package/dist/esm/models/batch-cancel-orders-request-order.d.ts +1 -1
- package/dist/esm/models/batch-cancel-orders-request-order.js +1 -1
- package/dist/esm/models/batch-cancel-orders-request.d.ts +1 -1
- package/dist/esm/models/batch-cancel-orders-request.js +1 -1
- package/dist/esm/models/batch-cancel-orders-response.d.ts +1 -1
- package/dist/esm/models/batch-cancel-orders-response.js +1 -1
- package/dist/esm/models/batch-cancel-orders-v2-request-orders-inner.d.ts +21 -0
- package/dist/esm/models/batch-cancel-orders-v2-request-orders-inner.js +14 -0
- package/dist/esm/models/batch-cancel-orders-v2-request.d.ts +18 -0
- package/dist/esm/models/batch-cancel-orders-v2-request.js +14 -0
- package/dist/esm/models/batch-cancel-orders-v2-response-orders-inner.d.ts +28 -0
- package/dist/esm/models/batch-cancel-orders-v2-response-orders-inner.js +14 -0
- package/dist/esm/models/batch-cancel-orders-v2-response.d.ts +15 -0
- package/dist/esm/models/batch-cancel-orders-v2-response.js +14 -0
- 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 +15 -0
- package/dist/esm/models/batch-create-orders-v2-request.js +14 -0
- package/dist/esm/models/batch-create-orders-v2-response-orders-inner.d.ts +37 -0
- package/dist/esm/models/batch-create-orders-v2-response-orders-inner.js +14 -0
- package/dist/esm/models/batch-create-orders-v2-response.d.ts +15 -0
- package/dist/esm/models/batch-create-orders-v2-response.js +14 -0
- package/dist/esm/models/batch-get-market-candlesticks-response.d.ts +1 -1
- package/dist/esm/models/batch-get-market-candlesticks-response.js +1 -1
- package/dist/esm/models/bid-ask-distribution-historical.d.ts +1 -1
- package/dist/esm/models/bid-ask-distribution-historical.js +1 -1
- package/dist/esm/models/bid-ask-distribution.d.ts +1 -1
- package/dist/esm/models/bid-ask-distribution.js +1 -1
- package/dist/esm/models/book-side.d.ts +19 -0
- package/dist/esm/models/book-side.js +20 -0
- package/dist/esm/models/bucket-limit.d.ts +24 -0
- package/dist/esm/models/bucket-limit.js +14 -0
- package/dist/esm/models/cancel-order-response.d.ts +1 -1
- package/dist/esm/models/cancel-order-response.js +1 -1
- package/dist/esm/models/cancel-order-v2-response.d.ts +23 -0
- package/dist/esm/models/cancel-order-v2-response.js +14 -0
- package/dist/esm/models/create-api-key-request.d.ts +1 -1
- package/dist/esm/models/create-api-key-request.js +1 -1
- package/dist/esm/models/create-api-key-response.d.ts +1 -1
- package/dist/esm/models/create-api-key-response.js +1 -1
- package/dist/esm/models/create-market-in-multivariate-event-collection-request.d.ts +1 -1
- package/dist/esm/models/create-market-in-multivariate-event-collection-request.js +1 -1
- package/dist/esm/models/create-market-in-multivariate-event-collection-response.d.ts +1 -1
- package/dist/esm/models/create-market-in-multivariate-event-collection-response.js +1 -1
- package/dist/esm/models/create-order-group-request.d.ts +1 -1
- package/dist/esm/models/create-order-group-request.js +1 -1
- package/dist/esm/models/create-order-group-response.d.ts +1 -1
- 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 +52 -0
- package/dist/esm/models/create-order-v2-request.js +18 -0
- package/dist/esm/models/create-order-v2-response.d.ts +35 -0
- package/dist/esm/models/create-order-v2-response.js +14 -0
- package/dist/esm/models/create-quote-request.d.ts +5 -1
- package/dist/esm/models/create-quote-request.js +1 -1
- package/dist/esm/models/create-quote-response.d.ts +1 -1
- package/dist/esm/models/create-quote-response.js +1 -1
- package/dist/esm/models/create-rfqrequest.d.ts +1 -1
- package/dist/esm/models/create-rfqrequest.js +1 -1
- package/dist/esm/models/create-rfqresponse.d.ts +1 -1
- package/dist/esm/models/create-rfqresponse.js +1 -1
- package/dist/esm/models/create-subaccount-response.d.ts +1 -1
- package/dist/esm/models/create-subaccount-response.js +1 -1
- package/dist/esm/models/daily-schedule.d.ts +1 -1
- package/dist/esm/models/daily-schedule.js +1 -1
- package/dist/esm/models/decrease-order-request.d.ts +1 -1
- package/dist/esm/models/decrease-order-request.js +1 -1
- package/dist/esm/models/decrease-order-response.d.ts +1 -1
- package/dist/esm/models/decrease-order-response.js +1 -1
- package/dist/esm/models/decrease-order-v2-request.d.ts +17 -0
- package/dist/esm/models/decrease-order-v2-request.js +14 -0
- package/dist/esm/models/decrease-order-v2-response.d.ts +23 -0
- package/dist/esm/models/decrease-order-v2-response.js +14 -0
- package/dist/esm/models/deposit.d.ts +56 -0
- package/dist/esm/models/deposit.js +26 -0
- package/dist/esm/models/endpoint-token-cost.d.ts +25 -0
- package/dist/esm/models/endpoint-token-cost.js +14 -0
- package/dist/esm/models/error-response.d.ts +1 -1
- package/dist/esm/models/error-response.js +1 -1
- package/dist/esm/models/event-data.d.ts +1 -1
- package/dist/esm/models/event-data.js +1 -1
- package/dist/esm/models/event-position.d.ts +1 -1
- package/dist/esm/models/event-position.js +1 -1
- package/dist/esm/models/exchange-instance.d.ts +1 -1
- package/dist/esm/models/exchange-instance.js +1 -1
- package/dist/esm/models/exchange-status.d.ts +1 -1
- package/dist/esm/models/exchange-status.js +1 -1
- package/dist/esm/models/fill.d.ts +1 -1
- package/dist/esm/models/fill.js +1 -1
- package/dist/esm/models/forecast-percentiles-point.d.ts +1 -1
- package/dist/esm/models/forecast-percentiles-point.js +1 -1
- package/dist/esm/models/generate-api-key-request.d.ts +1 -1
- package/dist/esm/models/generate-api-key-request.js +1 -1
- package/dist/esm/models/generate-api-key-response.d.ts +1 -1
- package/dist/esm/models/generate-api-key-response.js +1 -1
- package/dist/esm/models/get-account-api-limits-response.d.ts +5 -10
- package/dist/esm/models/get-account-api-limits-response.js +1 -1
- package/dist/esm/models/get-account-endpoint-costs-response.d.ts +22 -0
- package/dist/esm/models/get-account-endpoint-costs-response.js +14 -0
- package/dist/esm/models/get-api-keys-response.d.ts +1 -1
- package/dist/esm/models/get-api-keys-response.js +1 -1
- package/dist/esm/models/get-balance-response.d.ts +1 -1
- package/dist/esm/models/get-balance-response.js +1 -1
- package/dist/esm/models/get-communications-idresponse.d.ts +1 -1
- package/dist/esm/models/get-communications-idresponse.js +1 -1
- package/dist/esm/models/get-deposits-response.d.ts +16 -0
- package/dist/esm/models/get-deposits-response.js +14 -0
- package/dist/esm/models/get-event-candlesticks-response.d.ts +1 -1
- package/dist/esm/models/get-event-candlesticks-response.js +1 -1
- package/dist/esm/models/get-event-forecast-percentiles-history-response.d.ts +1 -1
- package/dist/esm/models/get-event-forecast-percentiles-history-response.js +1 -1
- package/dist/esm/models/get-event-metadata-response.d.ts +1 -1
- package/dist/esm/models/get-event-metadata-response.js +1 -1
- package/dist/esm/models/get-event-response.d.ts +1 -1
- package/dist/esm/models/get-event-response.js +1 -1
- package/dist/esm/models/get-events-response.d.ts +1 -1
- package/dist/esm/models/get-events-response.js +1 -1
- package/dist/esm/models/get-exchange-announcements-response.d.ts +1 -1
- package/dist/esm/models/get-exchange-announcements-response.js +1 -1
- package/dist/esm/models/get-exchange-schedule-response.d.ts +1 -1
- package/dist/esm/models/get-exchange-schedule-response.js +1 -1
- package/dist/esm/models/get-fills-response.d.ts +1 -1
- package/dist/esm/models/get-fills-response.js +1 -1
- package/dist/esm/models/get-filters-by-sports-response.d.ts +1 -1
- package/dist/esm/models/get-filters-by-sports-response.js +1 -1
- package/dist/esm/models/get-game-stats-response.d.ts +1 -1
- package/dist/esm/models/get-game-stats-response.js +1 -1
- package/dist/esm/models/get-historical-cutoff-response.d.ts +1 -1
- package/dist/esm/models/get-historical-cutoff-response.js +1 -1
- package/dist/esm/models/get-incentive-programs-response.d.ts +1 -1
- package/dist/esm/models/get-incentive-programs-response.js +1 -1
- package/dist/esm/models/get-live-data-response.d.ts +1 -1
- package/dist/esm/models/get-live-data-response.js +1 -1
- package/dist/esm/models/get-live-datas-response.d.ts +1 -1
- package/dist/esm/models/get-live-datas-response.js +1 -1
- package/dist/esm/models/get-market-candlesticks-historical-response.d.ts +1 -1
- package/dist/esm/models/get-market-candlesticks-historical-response.js +1 -1
- package/dist/esm/models/get-market-candlesticks-response.d.ts +1 -1
- package/dist/esm/models/get-market-candlesticks-response.js +1 -1
- package/dist/esm/models/get-market-orderbook-response.d.ts +1 -1
- package/dist/esm/models/get-market-orderbook-response.js +1 -1
- package/dist/esm/models/get-market-orderbooks-response.d.ts +1 -1
- package/dist/esm/models/get-market-orderbooks-response.js +1 -1
- package/dist/esm/models/get-market-response.d.ts +1 -1
- package/dist/esm/models/get-market-response.js +1 -1
- package/dist/esm/models/get-markets-response.d.ts +1 -1
- package/dist/esm/models/get-markets-response.js +1 -1
- package/dist/esm/models/get-milestone-response.d.ts +1 -1
- package/dist/esm/models/get-milestone-response.js +1 -1
- package/dist/esm/models/get-milestones-response.d.ts +1 -1
- package/dist/esm/models/get-milestones-response.js +1 -1
- package/dist/esm/models/get-multivariate-event-collection-lookup-history-response.d.ts +1 -1
- package/dist/esm/models/get-multivariate-event-collection-lookup-history-response.js +1 -1
- package/dist/esm/models/get-multivariate-event-collection-response.d.ts +1 -1
- package/dist/esm/models/get-multivariate-event-collection-response.js +1 -1
- package/dist/esm/models/get-multivariate-event-collections-response.d.ts +1 -1
- package/dist/esm/models/get-multivariate-event-collections-response.js +1 -1
- package/dist/esm/models/get-multivariate-events-response.d.ts +1 -1
- package/dist/esm/models/get-multivariate-events-response.js +1 -1
- package/dist/esm/models/get-order-group-response.d.ts +1 -1
- package/dist/esm/models/get-order-group-response.js +1 -1
- package/dist/esm/models/get-order-groups-response.d.ts +1 -1
- package/dist/esm/models/get-order-groups-response.js +1 -1
- package/dist/esm/models/get-order-queue-position-response.d.ts +1 -1
- package/dist/esm/models/get-order-queue-position-response.js +1 -1
- package/dist/esm/models/get-order-queue-positions-response.d.ts +1 -1
- package/dist/esm/models/get-order-queue-positions-response.js +1 -1
- package/dist/esm/models/get-order-response.d.ts +1 -1
- package/dist/esm/models/get-order-response.js +1 -1
- package/dist/esm/models/get-orders-response.d.ts +1 -1
- package/dist/esm/models/get-orders-response.js +1 -1
- package/dist/esm/models/get-portfolio-resting-order-total-value-response.d.ts +1 -1
- package/dist/esm/models/get-portfolio-resting-order-total-value-response.js +1 -1
- package/dist/esm/models/get-positions-response.d.ts +1 -1
- package/dist/esm/models/get-positions-response.js +1 -1
- package/dist/esm/models/get-quote-response.d.ts +1 -1
- package/dist/esm/models/get-quote-response.js +1 -1
- package/dist/esm/models/get-quotes-response.d.ts +1 -1
- package/dist/esm/models/get-quotes-response.js +1 -1
- package/dist/esm/models/get-rfqresponse.d.ts +1 -1
- package/dist/esm/models/get-rfqresponse.js +1 -1
- package/dist/esm/models/get-rfqs-response.d.ts +1 -1
- package/dist/esm/models/get-rfqs-response.js +1 -1
- package/dist/esm/models/get-series-fee-changes-response.d.ts +1 -1
- package/dist/esm/models/get-series-fee-changes-response.js +1 -1
- package/dist/esm/models/get-series-list-response.d.ts +1 -1
- package/dist/esm/models/get-series-list-response.js +1 -1
- package/dist/esm/models/get-series-response.d.ts +1 -1
- package/dist/esm/models/get-series-response.js +1 -1
- package/dist/esm/models/get-settlements-response.d.ts +1 -1
- package/dist/esm/models/get-settlements-response.js +1 -1
- package/dist/esm/models/get-structured-target-response.d.ts +1 -1
- package/dist/esm/models/get-structured-target-response.js +1 -1
- package/dist/esm/models/get-structured-targets-response.d.ts +1 -1
- package/dist/esm/models/get-structured-targets-response.js +1 -1
- package/dist/esm/models/get-subaccount-balances-response.d.ts +1 -1
- package/dist/esm/models/get-subaccount-balances-response.js +1 -1
- package/dist/esm/models/get-subaccount-netting-response.d.ts +1 -1
- package/dist/esm/models/get-subaccount-netting-response.js +1 -1
- package/dist/esm/models/get-subaccount-transfers-response.d.ts +1 -1
- package/dist/esm/models/get-subaccount-transfers-response.js +1 -1
- package/dist/esm/models/get-tags-for-series-categories-response.d.ts +1 -1
- package/dist/esm/models/get-tags-for-series-categories-response.js +1 -1
- package/dist/esm/models/get-trades-response.d.ts +1 -1
- package/dist/esm/models/get-trades-response.js +1 -1
- package/dist/esm/models/get-user-data-timestamp-response.d.ts +1 -1
- package/dist/esm/models/get-user-data-timestamp-response.js +1 -1
- package/dist/esm/models/get-withdrawals-response.d.ts +16 -0
- package/dist/esm/models/get-withdrawals-response.js +14 -0
- package/dist/esm/models/incentive-program.d.ts +5 -1
- package/dist/esm/models/incentive-program.js +1 -1
- package/dist/esm/models/index.d.ts +23 -0
- package/dist/esm/models/index.js +23 -0
- 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 +9 -6
- package/dist/esm/models/market.js +1 -1
- package/dist/esm/models/milestone.d.ts +1 -1
- package/dist/esm/models/milestone.js +1 -1
- package/dist/esm/models/multivariate-event-collection.d.ts +1 -1
- package/dist/esm/models/multivariate-event-collection.js +1 -1
- package/dist/esm/models/mve-selected-leg.d.ts +1 -1
- package/dist/esm/models/mve-selected-leg.js +1 -1
- package/dist/esm/models/order-group.d.ts +1 -1
- package/dist/esm/models/order-group.js +1 -1
- package/dist/esm/models/order-queue-position.d.ts +1 -1
- package/dist/esm/models/order-queue-position.js +1 -1
- package/dist/esm/models/order-status.d.ts +1 -1
- package/dist/esm/models/order-status.js +1 -1
- package/dist/esm/models/order.d.ts +1 -1
- 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/quote.d.ts +13 -1
- package/dist/esm/models/quote.js +1 -1
- package/dist/esm/models/rfq.d.ts +5 -1
- package/dist/esm/models/rfq.js +1 -1
- package/dist/esm/models/schedule.d.ts +1 -1
- package/dist/esm/models/schedule.js +1 -1
- package/dist/esm/models/scope-list.d.ts +1 -1
- package/dist/esm/models/scope-list.js +1 -1
- package/dist/esm/models/self-trade-prevention-type.d.ts +2 -2
- package/dist/esm/models/self-trade-prevention-type.js +2 -2
- package/dist/esm/models/series-fee-change.d.ts +1 -1
- package/dist/esm/models/series-fee-change.js +1 -1
- package/dist/esm/models/series.d.ts +1 -1
- package/dist/esm/models/series.js +1 -1
- package/dist/esm/models/settlement-source.d.ts +1 -1
- package/dist/esm/models/settlement-source.js +1 -1
- package/dist/esm/models/settlement.d.ts +1 -1
- package/dist/esm/models/settlement.js +1 -1
- package/dist/esm/models/sport-filter-details.d.ts +1 -1
- package/dist/esm/models/sport-filter-details.js +1 -1
- package/dist/esm/models/structured-target.d.ts +1 -1
- package/dist/esm/models/structured-target.js +1 -1
- package/dist/esm/models/subaccount-balance.d.ts +1 -1
- package/dist/esm/models/subaccount-balance.js +1 -1
- package/dist/esm/models/subaccount-netting-config.d.ts +1 -1
- package/dist/esm/models/subaccount-netting-config.js +1 -1
- package/dist/esm/models/subaccount-transfer.d.ts +1 -1
- package/dist/esm/models/subaccount-transfer.js +1 -1
- package/dist/esm/models/ticker-pair.d.ts +1 -1
- package/dist/esm/models/ticker-pair.js +1 -1
- package/dist/esm/models/trade.d.ts +1 -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 +1 -1
- package/dist/esm/models/update-subaccount-netting-request.js +1 -1
- package/dist/esm/models/user-filter.d.ts +18 -0
- package/dist/esm/models/user-filter.js +19 -0
- package/dist/esm/models/weekly-schedule.d.ts +1 -1
- package/dist/esm/models/weekly-schedule.js +1 -1
- package/dist/esm/models/withdrawal.d.ts +56 -0
- package/dist/esm/models/withdrawal.js +26 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/accept-quote-request.d.ts +1 -1
- package/dist/models/accept-quote-request.js +1 -1
- package/dist/models/amend-order-request.d.ts +1 -1
- package/dist/models/amend-order-request.js +1 -1
- package/dist/models/amend-order-response.d.ts +1 -1
- package/dist/models/amend-order-response.js +1 -1
- package/dist/models/amend-order-v2-request.d.ts +35 -0
- package/dist/models/amend-order-v2-request.js +15 -0
- package/dist/models/amend-order-v2-response.d.ts +35 -0
- package/dist/models/amend-order-v2-response.js +15 -0
- package/dist/models/announcement.d.ts +1 -1
- package/dist/models/announcement.js +1 -1
- package/dist/models/api-key.d.ts +1 -1
- package/dist/models/api-key.js +1 -1
- package/dist/models/apply-subaccount-transfer-request.d.ts +1 -1
- package/dist/models/apply-subaccount-transfer-request.js +1 -1
- package/dist/models/associated-event.d.ts +1 -1
- package/dist/models/associated-event.js +1 -1
- package/dist/models/batch-cancel-orders-individual-response.d.ts +1 -1
- package/dist/models/batch-cancel-orders-individual-response.js +1 -1
- package/dist/models/batch-cancel-orders-request-order.d.ts +1 -1
- package/dist/models/batch-cancel-orders-request-order.js +1 -1
- package/dist/models/batch-cancel-orders-request.d.ts +1 -1
- package/dist/models/batch-cancel-orders-request.js +1 -1
- package/dist/models/batch-cancel-orders-response.d.ts +1 -1
- package/dist/models/batch-cancel-orders-response.js +1 -1
- package/dist/models/batch-cancel-orders-v2-request-orders-inner.d.ts +21 -0
- package/dist/models/batch-cancel-orders-v2-request-orders-inner.js +15 -0
- package/dist/models/batch-cancel-orders-v2-request.d.ts +18 -0
- package/dist/models/batch-cancel-orders-v2-request.js +15 -0
- package/dist/models/batch-cancel-orders-v2-response-orders-inner.d.ts +28 -0
- package/dist/models/batch-cancel-orders-v2-response-orders-inner.js +15 -0
- package/dist/models/batch-cancel-orders-v2-response.d.ts +15 -0
- package/dist/models/batch-cancel-orders-v2-response.js +15 -0
- 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 +15 -0
- package/dist/models/batch-create-orders-v2-request.js +15 -0
- package/dist/models/batch-create-orders-v2-response-orders-inner.d.ts +37 -0
- package/dist/models/batch-create-orders-v2-response-orders-inner.js +15 -0
- package/dist/models/batch-create-orders-v2-response.d.ts +15 -0
- package/dist/models/batch-create-orders-v2-response.js +15 -0
- package/dist/models/batch-get-market-candlesticks-response.d.ts +1 -1
- package/dist/models/batch-get-market-candlesticks-response.js +1 -1
- package/dist/models/bid-ask-distribution-historical.d.ts +1 -1
- package/dist/models/bid-ask-distribution-historical.js +1 -1
- package/dist/models/bid-ask-distribution.d.ts +1 -1
- package/dist/models/bid-ask-distribution.js +1 -1
- package/dist/models/book-side.d.ts +19 -0
- package/dist/models/book-side.js +23 -0
- package/dist/models/bucket-limit.d.ts +24 -0
- package/dist/models/bucket-limit.js +15 -0
- package/dist/models/cancel-order-response.d.ts +1 -1
- package/dist/models/cancel-order-response.js +1 -1
- package/dist/models/cancel-order-v2-response.d.ts +23 -0
- package/dist/models/cancel-order-v2-response.js +15 -0
- package/dist/models/create-api-key-request.d.ts +1 -1
- package/dist/models/create-api-key-request.js +1 -1
- package/dist/models/create-api-key-response.d.ts +1 -1
- package/dist/models/create-api-key-response.js +1 -1
- package/dist/models/create-market-in-multivariate-event-collection-request.d.ts +1 -1
- package/dist/models/create-market-in-multivariate-event-collection-request.js +1 -1
- package/dist/models/create-market-in-multivariate-event-collection-response.d.ts +1 -1
- package/dist/models/create-market-in-multivariate-event-collection-response.js +1 -1
- package/dist/models/create-order-group-request.d.ts +1 -1
- package/dist/models/create-order-group-request.js +1 -1
- package/dist/models/create-order-group-response.d.ts +1 -1
- 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 +52 -0
- package/dist/models/create-order-v2-request.js +21 -0
- package/dist/models/create-order-v2-response.d.ts +35 -0
- package/dist/models/create-order-v2-response.js +15 -0
- package/dist/models/create-quote-request.d.ts +5 -1
- package/dist/models/create-quote-request.js +1 -1
- package/dist/models/create-quote-response.d.ts +1 -1
- package/dist/models/create-quote-response.js +1 -1
- package/dist/models/create-rfqrequest.d.ts +1 -1
- package/dist/models/create-rfqrequest.js +1 -1
- package/dist/models/create-rfqresponse.d.ts +1 -1
- package/dist/models/create-rfqresponse.js +1 -1
- package/dist/models/create-subaccount-response.d.ts +1 -1
- package/dist/models/create-subaccount-response.js +1 -1
- package/dist/models/daily-schedule.d.ts +1 -1
- package/dist/models/daily-schedule.js +1 -1
- package/dist/models/decrease-order-request.d.ts +1 -1
- package/dist/models/decrease-order-request.js +1 -1
- package/dist/models/decrease-order-response.d.ts +1 -1
- package/dist/models/decrease-order-response.js +1 -1
- package/dist/models/decrease-order-v2-request.d.ts +17 -0
- package/dist/models/decrease-order-v2-request.js +15 -0
- package/dist/models/decrease-order-v2-response.d.ts +23 -0
- package/dist/models/decrease-order-v2-response.js +15 -0
- package/dist/models/deposit.d.ts +56 -0
- package/dist/models/deposit.js +29 -0
- package/dist/models/endpoint-token-cost.d.ts +25 -0
- package/dist/models/endpoint-token-cost.js +15 -0
- package/dist/models/error-response.d.ts +1 -1
- package/dist/models/error-response.js +1 -1
- package/dist/models/event-data.d.ts +1 -1
- package/dist/models/event-data.js +1 -1
- package/dist/models/event-position.d.ts +1 -1
- package/dist/models/event-position.js +1 -1
- package/dist/models/exchange-instance.d.ts +1 -1
- package/dist/models/exchange-instance.js +1 -1
- package/dist/models/exchange-status.d.ts +1 -1
- package/dist/models/exchange-status.js +1 -1
- package/dist/models/fill.d.ts +1 -1
- package/dist/models/fill.js +1 -1
- package/dist/models/forecast-percentiles-point.d.ts +1 -1
- package/dist/models/forecast-percentiles-point.js +1 -1
- package/dist/models/generate-api-key-request.d.ts +1 -1
- package/dist/models/generate-api-key-request.js +1 -1
- package/dist/models/generate-api-key-response.d.ts +1 -1
- package/dist/models/generate-api-key-response.js +1 -1
- package/dist/models/get-account-api-limits-response.d.ts +5 -10
- package/dist/models/get-account-api-limits-response.js +1 -1
- package/dist/models/get-account-endpoint-costs-response.d.ts +22 -0
- package/dist/models/get-account-endpoint-costs-response.js +15 -0
- package/dist/models/get-api-keys-response.d.ts +1 -1
- package/dist/models/get-api-keys-response.js +1 -1
- package/dist/models/get-balance-response.d.ts +1 -1
- package/dist/models/get-balance-response.js +1 -1
- package/dist/models/get-communications-idresponse.d.ts +1 -1
- package/dist/models/get-communications-idresponse.js +1 -1
- package/dist/models/get-deposits-response.d.ts +16 -0
- package/dist/models/get-deposits-response.js +15 -0
- package/dist/models/get-event-candlesticks-response.d.ts +1 -1
- package/dist/models/get-event-candlesticks-response.js +1 -1
- package/dist/models/get-event-forecast-percentiles-history-response.d.ts +1 -1
- package/dist/models/get-event-forecast-percentiles-history-response.js +1 -1
- package/dist/models/get-event-metadata-response.d.ts +1 -1
- package/dist/models/get-event-metadata-response.js +1 -1
- package/dist/models/get-event-response.d.ts +1 -1
- package/dist/models/get-event-response.js +1 -1
- package/dist/models/get-events-response.d.ts +1 -1
- package/dist/models/get-events-response.js +1 -1
- package/dist/models/get-exchange-announcements-response.d.ts +1 -1
- package/dist/models/get-exchange-announcements-response.js +1 -1
- package/dist/models/get-exchange-schedule-response.d.ts +1 -1
- package/dist/models/get-exchange-schedule-response.js +1 -1
- package/dist/models/get-fills-response.d.ts +1 -1
- package/dist/models/get-fills-response.js +1 -1
- package/dist/models/get-filters-by-sports-response.d.ts +1 -1
- package/dist/models/get-filters-by-sports-response.js +1 -1
- package/dist/models/get-game-stats-response.d.ts +1 -1
- package/dist/models/get-game-stats-response.js +1 -1
- package/dist/models/get-historical-cutoff-response.d.ts +1 -1
- package/dist/models/get-historical-cutoff-response.js +1 -1
- package/dist/models/get-incentive-programs-response.d.ts +1 -1
- package/dist/models/get-incentive-programs-response.js +1 -1
- package/dist/models/get-live-data-response.d.ts +1 -1
- package/dist/models/get-live-data-response.js +1 -1
- package/dist/models/get-live-datas-response.d.ts +1 -1
- package/dist/models/get-live-datas-response.js +1 -1
- package/dist/models/get-market-candlesticks-historical-response.d.ts +1 -1
- package/dist/models/get-market-candlesticks-historical-response.js +1 -1
- package/dist/models/get-market-candlesticks-response.d.ts +1 -1
- package/dist/models/get-market-candlesticks-response.js +1 -1
- package/dist/models/get-market-orderbook-response.d.ts +1 -1
- package/dist/models/get-market-orderbook-response.js +1 -1
- package/dist/models/get-market-orderbooks-response.d.ts +1 -1
- package/dist/models/get-market-orderbooks-response.js +1 -1
- package/dist/models/get-market-response.d.ts +1 -1
- package/dist/models/get-market-response.js +1 -1
- package/dist/models/get-markets-response.d.ts +1 -1
- package/dist/models/get-markets-response.js +1 -1
- package/dist/models/get-milestone-response.d.ts +1 -1
- package/dist/models/get-milestone-response.js +1 -1
- package/dist/models/get-milestones-response.d.ts +1 -1
- package/dist/models/get-milestones-response.js +1 -1
- package/dist/models/get-multivariate-event-collection-lookup-history-response.d.ts +1 -1
- package/dist/models/get-multivariate-event-collection-lookup-history-response.js +1 -1
- package/dist/models/get-multivariate-event-collection-response.d.ts +1 -1
- package/dist/models/get-multivariate-event-collection-response.js +1 -1
- package/dist/models/get-multivariate-event-collections-response.d.ts +1 -1
- package/dist/models/get-multivariate-event-collections-response.js +1 -1
- package/dist/models/get-multivariate-events-response.d.ts +1 -1
- package/dist/models/get-multivariate-events-response.js +1 -1
- package/dist/models/get-order-group-response.d.ts +1 -1
- package/dist/models/get-order-group-response.js +1 -1
- package/dist/models/get-order-groups-response.d.ts +1 -1
- package/dist/models/get-order-groups-response.js +1 -1
- package/dist/models/get-order-queue-position-response.d.ts +1 -1
- package/dist/models/get-order-queue-position-response.js +1 -1
- package/dist/models/get-order-queue-positions-response.d.ts +1 -1
- package/dist/models/get-order-queue-positions-response.js +1 -1
- package/dist/models/get-order-response.d.ts +1 -1
- package/dist/models/get-order-response.js +1 -1
- package/dist/models/get-orders-response.d.ts +1 -1
- package/dist/models/get-orders-response.js +1 -1
- package/dist/models/get-portfolio-resting-order-total-value-response.d.ts +1 -1
- package/dist/models/get-portfolio-resting-order-total-value-response.js +1 -1
- package/dist/models/get-positions-response.d.ts +1 -1
- package/dist/models/get-positions-response.js +1 -1
- package/dist/models/get-quote-response.d.ts +1 -1
- package/dist/models/get-quote-response.js +1 -1
- package/dist/models/get-quotes-response.d.ts +1 -1
- package/dist/models/get-quotes-response.js +1 -1
- package/dist/models/get-rfqresponse.d.ts +1 -1
- package/dist/models/get-rfqresponse.js +1 -1
- package/dist/models/get-rfqs-response.d.ts +1 -1
- package/dist/models/get-rfqs-response.js +1 -1
- package/dist/models/get-series-fee-changes-response.d.ts +1 -1
- package/dist/models/get-series-fee-changes-response.js +1 -1
- package/dist/models/get-series-list-response.d.ts +1 -1
- package/dist/models/get-series-list-response.js +1 -1
- package/dist/models/get-series-response.d.ts +1 -1
- package/dist/models/get-series-response.js +1 -1
- package/dist/models/get-settlements-response.d.ts +1 -1
- package/dist/models/get-settlements-response.js +1 -1
- package/dist/models/get-structured-target-response.d.ts +1 -1
- package/dist/models/get-structured-target-response.js +1 -1
- package/dist/models/get-structured-targets-response.d.ts +1 -1
- package/dist/models/get-structured-targets-response.js +1 -1
- package/dist/models/get-subaccount-balances-response.d.ts +1 -1
- package/dist/models/get-subaccount-balances-response.js +1 -1
- package/dist/models/get-subaccount-netting-response.d.ts +1 -1
- package/dist/models/get-subaccount-netting-response.js +1 -1
- package/dist/models/get-subaccount-transfers-response.d.ts +1 -1
- package/dist/models/get-subaccount-transfers-response.js +1 -1
- package/dist/models/get-tags-for-series-categories-response.d.ts +1 -1
- package/dist/models/get-tags-for-series-categories-response.js +1 -1
- package/dist/models/get-trades-response.d.ts +1 -1
- package/dist/models/get-trades-response.js +1 -1
- package/dist/models/get-user-data-timestamp-response.d.ts +1 -1
- package/dist/models/get-user-data-timestamp-response.js +1 -1
- package/dist/models/get-withdrawals-response.d.ts +16 -0
- package/dist/models/get-withdrawals-response.js +15 -0
- package/dist/models/incentive-program.d.ts +5 -1
- package/dist/models/incentive-program.js +1 -1
- package/dist/models/index.d.ts +23 -0
- package/dist/models/index.js +23 -0
- 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 +9 -6
- package/dist/models/market.js +1 -1
- package/dist/models/milestone.d.ts +1 -1
- package/dist/models/milestone.js +1 -1
- package/dist/models/multivariate-event-collection.d.ts +1 -1
- package/dist/models/multivariate-event-collection.js +1 -1
- package/dist/models/mve-selected-leg.d.ts +1 -1
- package/dist/models/mve-selected-leg.js +1 -1
- package/dist/models/order-group.d.ts +1 -1
- package/dist/models/order-group.js +1 -1
- package/dist/models/order-queue-position.d.ts +1 -1
- package/dist/models/order-queue-position.js +1 -1
- package/dist/models/order-status.d.ts +1 -1
- package/dist/models/order-status.js +1 -1
- package/dist/models/order.d.ts +1 -1
- 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/quote.d.ts +13 -1
- package/dist/models/quote.js +1 -1
- package/dist/models/rfq.d.ts +5 -1
- package/dist/models/rfq.js +1 -1
- package/dist/models/schedule.d.ts +1 -1
- package/dist/models/schedule.js +1 -1
- package/dist/models/scope-list.d.ts +1 -1
- package/dist/models/scope-list.js +1 -1
- package/dist/models/self-trade-prevention-type.d.ts +2 -2
- package/dist/models/self-trade-prevention-type.js +2 -2
- package/dist/models/series-fee-change.d.ts +1 -1
- package/dist/models/series-fee-change.js +1 -1
- package/dist/models/series.d.ts +1 -1
- package/dist/models/series.js +1 -1
- package/dist/models/settlement-source.d.ts +1 -1
- package/dist/models/settlement-source.js +1 -1
- package/dist/models/settlement.d.ts +1 -1
- package/dist/models/settlement.js +1 -1
- package/dist/models/sport-filter-details.d.ts +1 -1
- package/dist/models/sport-filter-details.js +1 -1
- package/dist/models/structured-target.d.ts +1 -1
- package/dist/models/structured-target.js +1 -1
- package/dist/models/subaccount-balance.d.ts +1 -1
- package/dist/models/subaccount-balance.js +1 -1
- package/dist/models/subaccount-netting-config.d.ts +1 -1
- package/dist/models/subaccount-netting-config.js +1 -1
- package/dist/models/subaccount-transfer.d.ts +1 -1
- package/dist/models/subaccount-transfer.js +1 -1
- package/dist/models/ticker-pair.d.ts +1 -1
- package/dist/models/ticker-pair.js +1 -1
- package/dist/models/trade.d.ts +1 -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 +1 -1
- package/dist/models/update-subaccount-netting-request.js +1 -1
- package/dist/models/user-filter.d.ts +18 -0
- package/dist/models/user-filter.js +22 -0
- package/dist/models/weekly-schedule.d.ts +1 -1
- package/dist/models/weekly-schedule.js +1 -1
- package/dist/models/withdrawal.d.ts +56 -0
- package/dist/models/withdrawal.js +29 -0
- package/docs/AccountApi.md +31 -1
- package/docs/AmendOrderV2Request.md +30 -0
- package/docs/AmendOrderV2Response.md +32 -0
- package/docs/ApiKeysApi.md +1 -1
- package/docs/BatchCancelOrdersV2Request.md +20 -0
- package/docs/BatchCancelOrdersV2RequestOrdersInner.md +22 -0
- package/docs/BatchCancelOrdersV2Response.md +20 -0
- package/docs/BatchCancelOrdersV2ResponseOrdersInner.md +28 -0
- package/docs/BatchCreateOrdersV2Request.md +20 -0
- package/docs/BatchCreateOrdersV2Response.md +20 -0
- package/docs/BatchCreateOrdersV2ResponseOrdersInner.md +34 -0
- package/docs/BookSide.md +11 -0
- package/docs/BucketLimit.md +23 -0
- package/docs/CancelOrderV2Response.md +26 -0
- package/docs/CommunicationsApi.md +3 -1
- package/docs/CreateOrderV2Request.md +44 -0
- package/docs/CreateOrderV2Response.md +32 -0
- package/docs/CreateQuoteRequest.md +2 -0
- package/docs/DecreaseOrderV2Request.md +20 -0
- package/docs/DecreaseOrderV2Response.md +26 -0
- package/docs/Deposit.md +32 -0
- package/docs/EndpointTokenCost.md +24 -0
- package/docs/EventsApi.md +1 -1
- package/docs/ExchangeApi.md +1 -1
- package/docs/FcmApi.md +1 -1
- package/docs/GetAccountApiLimitsResponse.md +5 -5
- package/docs/GetAccountEndpointCostsResponse.md +22 -0
- package/docs/GetDepositsResponse.md +22 -0
- package/docs/GetWithdrawalsResponse.md +22 -0
- package/docs/HistoricalApi.md +2 -2
- package/docs/IncentiveProgram.md +2 -0
- package/docs/IncentiveProgramsApi.md +2 -1
- package/docs/LiveDataApi.md +1 -1
- package/docs/Market.md +3 -3
- package/docs/MarketApi.md +3 -3
- package/docs/MilestoneApi.md +1 -1
- package/docs/MultivariateApi.md +4 -4
- package/docs/OrderGroupsApi.md +1 -1
- package/docs/OrdersApi.md +226 -5
- package/docs/PortfolioApi.md +74 -2
- package/docs/Quote.md +6 -0
- package/docs/RFQ.md +2 -0
- package/docs/SearchApi.md +1 -1
- package/docs/SelfTradePreventionType.md +1 -1
- package/docs/StructuredTargetsApi.md +1 -1
- package/docs/UserFilter.md +9 -0
- package/docs/Withdrawal.md +32 -0
- package/index.ts +1 -1
- package/models/accept-quote-request.ts +1 -1
- package/models/amend-order-request.ts +1 -1
- package/models/amend-order-response.ts +1 -1
- package/models/amend-order-v2-request.ts +45 -0
- package/models/amend-order-v2-response.ts +41 -0
- package/models/announcement.ts +1 -1
- package/models/api-key.ts +1 -1
- package/models/apply-subaccount-transfer-request.ts +1 -1
- package/models/associated-event.ts +1 -1
- package/models/batch-cancel-orders-individual-response.ts +1 -1
- package/models/batch-cancel-orders-request-order.ts +1 -1
- package/models/batch-cancel-orders-request.ts +1 -1
- package/models/batch-cancel-orders-response.ts +1 -1
- package/models/batch-cancel-orders-v2-request-orders-inner.ts +27 -0
- package/models/batch-cancel-orders-v2-request.ts +26 -0
- package/models/batch-cancel-orders-v2-response-orders-inner.ts +36 -0
- package/models/batch-cancel-orders-v2-response.ts +23 -0
- 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 +23 -0
- package/models/batch-create-orders-v2-response-orders-inner.ts +45 -0
- package/models/batch-create-orders-v2-response.ts +23 -0
- package/models/batch-get-market-candlesticks-response.ts +1 -1
- package/models/bid-ask-distribution-historical.ts +1 -1
- package/models/bid-ask-distribution.ts +1 -1
- package/models/book-side.ts +29 -0
- package/models/bucket-limit.ts +30 -0
- package/models/cancel-order-response.ts +1 -1
- package/models/cancel-order-v2-response.ts +29 -0
- package/models/create-api-key-request.ts +1 -1
- package/models/create-api-key-response.ts +1 -1
- package/models/create-market-in-multivariate-event-collection-request.ts +1 -1
- package/models/create-market-in-multivariate-event-collection-response.ts +1 -1
- package/models/create-order-group-request.ts +1 -1
- package/models/create-order-group-response.ts +1 -1
- package/models/create-order-request.ts +1 -1
- package/models/create-order-response.ts +1 -1
- package/models/create-order-v2-request.ts +65 -0
- package/models/create-order-v2-response.ts +41 -0
- package/models/create-quote-request.ts +5 -1
- package/models/create-quote-response.ts +1 -1
- package/models/create-rfqrequest.ts +1 -1
- package/models/create-rfqresponse.ts +1 -1
- package/models/create-subaccount-response.ts +1 -1
- package/models/daily-schedule.ts +1 -1
- package/models/decrease-order-request.ts +1 -1
- package/models/decrease-order-response.ts +1 -1
- package/models/decrease-order-v2-request.ts +23 -0
- package/models/decrease-order-v2-response.ts +29 -0
- package/models/deposit.ts +66 -0
- package/models/endpoint-token-cost.ts +31 -0
- package/models/error-response.ts +1 -1
- package/models/event-data.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/fill.ts +1 -1
- package/models/forecast-percentiles-point.ts +1 -1
- package/models/generate-api-key-request.ts +1 -1
- package/models/generate-api-key-response.ts +1 -1
- package/models/get-account-api-limits-response.ts +7 -10
- package/models/get-account-endpoint-costs-response.ts +30 -0
- package/models/get-api-keys-response.ts +1 -1
- package/models/get-balance-response.ts +1 -1
- package/models/get-communications-idresponse.ts +1 -1
- package/models/get-deposits-response.ts +24 -0
- package/models/get-event-candlesticks-response.ts +1 -1
- package/models/get-event-forecast-percentiles-history-response.ts +1 -1
- package/models/get-event-metadata-response.ts +1 -1
- package/models/get-event-response.ts +1 -1
- package/models/get-events-response.ts +1 -1
- package/models/get-exchange-announcements-response.ts +1 -1
- package/models/get-exchange-schedule-response.ts +1 -1
- package/models/get-fills-response.ts +1 -1
- package/models/get-filters-by-sports-response.ts +1 -1
- package/models/get-game-stats-response.ts +1 -1
- package/models/get-historical-cutoff-response.ts +1 -1
- package/models/get-incentive-programs-response.ts +1 -1
- package/models/get-live-data-response.ts +1 -1
- package/models/get-live-datas-response.ts +1 -1
- package/models/get-market-candlesticks-historical-response.ts +1 -1
- package/models/get-market-candlesticks-response.ts +1 -1
- package/models/get-market-orderbook-response.ts +1 -1
- package/models/get-market-orderbooks-response.ts +1 -1
- package/models/get-market-response.ts +1 -1
- package/models/get-markets-response.ts +1 -1
- package/models/get-milestone-response.ts +1 -1
- package/models/get-milestones-response.ts +1 -1
- package/models/get-multivariate-event-collection-lookup-history-response.ts +1 -1
- package/models/get-multivariate-event-collection-response.ts +1 -1
- package/models/get-multivariate-event-collections-response.ts +1 -1
- package/models/get-multivariate-events-response.ts +1 -1
- package/models/get-order-group-response.ts +1 -1
- package/models/get-order-groups-response.ts +1 -1
- package/models/get-order-queue-position-response.ts +1 -1
- package/models/get-order-queue-positions-response.ts +1 -1
- package/models/get-order-response.ts +1 -1
- package/models/get-orders-response.ts +1 -1
- package/models/get-portfolio-resting-order-total-value-response.ts +1 -1
- package/models/get-positions-response.ts +1 -1
- package/models/get-quote-response.ts +1 -1
- package/models/get-quotes-response.ts +1 -1
- package/models/get-rfqresponse.ts +1 -1
- package/models/get-rfqs-response.ts +1 -1
- package/models/get-series-fee-changes-response.ts +1 -1
- package/models/get-series-list-response.ts +1 -1
- package/models/get-series-response.ts +1 -1
- package/models/get-settlements-response.ts +1 -1
- package/models/get-structured-target-response.ts +1 -1
- package/models/get-structured-targets-response.ts +1 -1
- package/models/get-subaccount-balances-response.ts +1 -1
- package/models/get-subaccount-netting-response.ts +1 -1
- package/models/get-subaccount-transfers-response.ts +1 -1
- package/models/get-tags-for-series-categories-response.ts +1 -1
- package/models/get-trades-response.ts +1 -1
- package/models/get-user-data-timestamp-response.ts +1 -1
- package/models/get-withdrawals-response.ts +24 -0
- package/models/incentive-program.ts +5 -1
- package/models/index.ts +23 -0
- 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 +9 -6
- package/models/milestone.ts +1 -1
- package/models/multivariate-event-collection.ts +1 -1
- package/models/mve-selected-leg.ts +1 -1
- package/models/order-group.ts +1 -1
- package/models/order-queue-position.ts +1 -1
- package/models/order-status.ts +1 -1
- package/models/order.ts +1 -1
- package/models/orderbook-count-fp.ts +1 -1
- package/models/percentile-point.ts +1 -1
- package/models/play-by-play-periods-inner.ts +1 -1
- package/models/play-by-play.ts +1 -1
- package/models/price-distribution-historical.ts +1 -1
- package/models/price-distribution.ts +1 -1
- package/models/price-range.ts +1 -1
- package/models/quote.ts +13 -1
- package/models/rfq.ts +5 -1
- package/models/schedule.ts +1 -1
- package/models/scope-list.ts +1 -1
- package/models/self-trade-prevention-type.ts +2 -2
- package/models/series-fee-change.ts +1 -1
- package/models/series.ts +1 -1
- package/models/settlement-source.ts +1 -1
- package/models/settlement.ts +1 -1
- package/models/sport-filter-details.ts +1 -1
- package/models/structured-target.ts +1 -1
- package/models/subaccount-balance.ts +1 -1
- package/models/subaccount-netting-config.ts +1 -1
- package/models/subaccount-transfer.ts +1 -1
- package/models/ticker-pair.ts +1 -1
- package/models/trade.ts +1 -1
- package/models/update-order-group-limit-request.ts +1 -1
- package/models/update-subaccount-netting-request.ts +1 -1
- package/models/user-filter.ts +28 -0
- package/models/weekly-schedule.ts +1 -1
- package/models/withdrawal.ts +66 -0
- package/package.json +1 -1
package/dist/api/orders-api.js
CHANGED
|
@@ -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.15.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -78,7 +78,51 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
78
78
|
};
|
|
79
79
|
}),
|
|
80
80
|
/**
|
|
81
|
-
*
|
|
81
|
+
* Endpoint for amending the price and/or remaining count of an existing event-market order using the V2 request/response shape.
|
|
82
|
+
* @summary Amend Order (V2)
|
|
83
|
+
* @param {string} orderId Order ID
|
|
84
|
+
* @param {AmendOrderV2Request} amendOrderV2Request
|
|
85
|
+
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
|
|
86
|
+
* @param {*} [options] Override http request option.
|
|
87
|
+
* @throws {RequiredError}
|
|
88
|
+
*/
|
|
89
|
+
amendOrderV2: (orderId_1, amendOrderV2Request_1, subaccount_1, ...args_1) => __awaiter(this, [orderId_1, amendOrderV2Request_1, subaccount_1, ...args_1], void 0, function* (orderId, amendOrderV2Request, subaccount, options = {}) {
|
|
90
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
91
|
+
(0, common_1.assertParamExists)('amendOrderV2', 'orderId', orderId);
|
|
92
|
+
// verify required parameter 'amendOrderV2Request' is not null or undefined
|
|
93
|
+
(0, common_1.assertParamExists)('amendOrderV2', 'amendOrderV2Request', amendOrderV2Request);
|
|
94
|
+
const localVarPath = `/portfolio/events/orders/{order_id}/amend`
|
|
95
|
+
.replace(`{${"order_id"}}`, encodeURIComponent(String(orderId)));
|
|
96
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
97
|
+
const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
98
|
+
let baseOptions;
|
|
99
|
+
if (configuration) {
|
|
100
|
+
baseOptions = configuration.baseOptions;
|
|
101
|
+
}
|
|
102
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
103
|
+
const localVarHeaderParameter = {};
|
|
104
|
+
const localVarQueryParameter = {};
|
|
105
|
+
// authentication kalshiAccessSignature required
|
|
106
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration);
|
|
107
|
+
// authentication kalshiAccessKey required
|
|
108
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration);
|
|
109
|
+
// authentication kalshiAccessTimestamp required
|
|
110
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration);
|
|
111
|
+
if (subaccount !== undefined) {
|
|
112
|
+
localVarQueryParameter['subaccount'] = subaccount;
|
|
113
|
+
}
|
|
114
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
115
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
116
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
117
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
118
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(amendOrderV2Request, localVarRequestOptions, configuration);
|
|
119
|
+
return {
|
|
120
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
121
|
+
options: localVarRequestOptions,
|
|
122
|
+
};
|
|
123
|
+
}),
|
|
124
|
+
/**
|
|
125
|
+
* Endpoint for cancelling a batch of orders. The maximum batch size scales with your tier\'s write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
|
|
82
126
|
* @summary Batch Cancel Orders
|
|
83
127
|
* @param {BatchCancelOrdersRequest} batchCancelOrdersRequest
|
|
84
128
|
* @param {*} [options] Override http request option.
|
|
@@ -114,7 +158,43 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
114
158
|
};
|
|
115
159
|
}),
|
|
116
160
|
/**
|
|
117
|
-
*
|
|
161
|
+
* Endpoint for cancelling a batch of event-market orders using the V2 response shape. The maximum batch size scales with your tier\'s write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
|
|
162
|
+
* @summary Batch Cancel Orders (V2)
|
|
163
|
+
* @param {BatchCancelOrdersV2Request} batchCancelOrdersV2Request
|
|
164
|
+
* @param {*} [options] Override http request option.
|
|
165
|
+
* @throws {RequiredError}
|
|
166
|
+
*/
|
|
167
|
+
batchCancelOrdersV2: (batchCancelOrdersV2Request_1, ...args_1) => __awaiter(this, [batchCancelOrdersV2Request_1, ...args_1], void 0, function* (batchCancelOrdersV2Request, options = {}) {
|
|
168
|
+
// verify required parameter 'batchCancelOrdersV2Request' is not null or undefined
|
|
169
|
+
(0, common_1.assertParamExists)('batchCancelOrdersV2', 'batchCancelOrdersV2Request', batchCancelOrdersV2Request);
|
|
170
|
+
const localVarPath = `/portfolio/events/orders/batched`;
|
|
171
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
172
|
+
const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
173
|
+
let baseOptions;
|
|
174
|
+
if (configuration) {
|
|
175
|
+
baseOptions = configuration.baseOptions;
|
|
176
|
+
}
|
|
177
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
178
|
+
const localVarHeaderParameter = {};
|
|
179
|
+
const localVarQueryParameter = {};
|
|
180
|
+
// authentication kalshiAccessSignature required
|
|
181
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration);
|
|
182
|
+
// authentication kalshiAccessKey required
|
|
183
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration);
|
|
184
|
+
// authentication kalshiAccessTimestamp required
|
|
185
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration);
|
|
186
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
187
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
188
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
189
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
190
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(batchCancelOrdersV2Request, localVarRequestOptions, configuration);
|
|
191
|
+
return {
|
|
192
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
193
|
+
options: localVarRequestOptions,
|
|
194
|
+
};
|
|
195
|
+
}),
|
|
196
|
+
/**
|
|
197
|
+
* Endpoint for submitting a batch of orders. The maximum batch size scales with your tier\'s write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
|
|
118
198
|
* @summary Batch Create Orders
|
|
119
199
|
* @param {BatchCreateOrdersRequest} batchCreateOrdersRequest
|
|
120
200
|
* @param {*} [options] Override http request option.
|
|
@@ -149,6 +229,42 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
149
229
|
options: localVarRequestOptions,
|
|
150
230
|
};
|
|
151
231
|
}),
|
|
232
|
+
/**
|
|
233
|
+
* Endpoint for submitting a batch of event-market orders using the V2 request/response shape. The maximum batch size scales with your tier\'s write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
|
|
234
|
+
* @summary Batch Create Orders (V2)
|
|
235
|
+
* @param {BatchCreateOrdersV2Request} batchCreateOrdersV2Request
|
|
236
|
+
* @param {*} [options] Override http request option.
|
|
237
|
+
* @throws {RequiredError}
|
|
238
|
+
*/
|
|
239
|
+
batchCreateOrdersV2: (batchCreateOrdersV2Request_1, ...args_1) => __awaiter(this, [batchCreateOrdersV2Request_1, ...args_1], void 0, function* (batchCreateOrdersV2Request, options = {}) {
|
|
240
|
+
// verify required parameter 'batchCreateOrdersV2Request' is not null or undefined
|
|
241
|
+
(0, common_1.assertParamExists)('batchCreateOrdersV2', 'batchCreateOrdersV2Request', batchCreateOrdersV2Request);
|
|
242
|
+
const localVarPath = `/portfolio/events/orders/batched`;
|
|
243
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
244
|
+
const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
245
|
+
let baseOptions;
|
|
246
|
+
if (configuration) {
|
|
247
|
+
baseOptions = configuration.baseOptions;
|
|
248
|
+
}
|
|
249
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
250
|
+
const localVarHeaderParameter = {};
|
|
251
|
+
const localVarQueryParameter = {};
|
|
252
|
+
// authentication kalshiAccessSignature required
|
|
253
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration);
|
|
254
|
+
// authentication kalshiAccessKey required
|
|
255
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration);
|
|
256
|
+
// authentication kalshiAccessTimestamp required
|
|
257
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration);
|
|
258
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
259
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
260
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
261
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
262
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(batchCreateOrdersV2Request, localVarRequestOptions, configuration);
|
|
263
|
+
return {
|
|
264
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
265
|
+
options: localVarRequestOptions,
|
|
266
|
+
};
|
|
267
|
+
}),
|
|
152
268
|
/**
|
|
153
269
|
* Endpoint for canceling orders. The value for the orderId should match the id field of the order you want to decrease. Commonly, DELETE-type endpoints return 204 status with no body content on success. But we can\'t completely delete the order, as it may be partially filled already. Instead, the DeleteOrder endpoint reduce the order completely, essentially zeroing the remaining resting contracts on it. The zeroed order is returned on the response payload as a form of validation for the client.
|
|
154
270
|
* @summary Cancel Order
|
|
@@ -188,6 +304,45 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
188
304
|
options: localVarRequestOptions,
|
|
189
305
|
};
|
|
190
306
|
}),
|
|
307
|
+
/**
|
|
308
|
+
* Endpoint for cancelling event-market orders using the V2 response shape. Returns `{order_id, client_order_id, reduced_by}` rather than a full order object.
|
|
309
|
+
* @summary Cancel Order (V2)
|
|
310
|
+
* @param {string} orderId Order ID
|
|
311
|
+
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
|
|
312
|
+
* @param {*} [options] Override http request option.
|
|
313
|
+
* @throws {RequiredError}
|
|
314
|
+
*/
|
|
315
|
+
cancelOrderV2: (orderId_1, subaccount_1, ...args_1) => __awaiter(this, [orderId_1, subaccount_1, ...args_1], void 0, function* (orderId, subaccount, options = {}) {
|
|
316
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
317
|
+
(0, common_1.assertParamExists)('cancelOrderV2', 'orderId', orderId);
|
|
318
|
+
const localVarPath = `/portfolio/events/orders/{order_id}`
|
|
319
|
+
.replace(`{${"order_id"}}`, encodeURIComponent(String(orderId)));
|
|
320
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
321
|
+
const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
322
|
+
let baseOptions;
|
|
323
|
+
if (configuration) {
|
|
324
|
+
baseOptions = configuration.baseOptions;
|
|
325
|
+
}
|
|
326
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
327
|
+
const localVarHeaderParameter = {};
|
|
328
|
+
const localVarQueryParameter = {};
|
|
329
|
+
// authentication kalshiAccessSignature required
|
|
330
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration);
|
|
331
|
+
// authentication kalshiAccessKey required
|
|
332
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration);
|
|
333
|
+
// authentication kalshiAccessTimestamp required
|
|
334
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration);
|
|
335
|
+
if (subaccount !== undefined) {
|
|
336
|
+
localVarQueryParameter['subaccount'] = subaccount;
|
|
337
|
+
}
|
|
338
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
339
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
340
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
341
|
+
return {
|
|
342
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
343
|
+
options: localVarRequestOptions,
|
|
344
|
+
};
|
|
345
|
+
}),
|
|
191
346
|
/**
|
|
192
347
|
* Endpoint for submitting orders in a market. Each user is limited to 200 000 open orders at a time.
|
|
193
348
|
* @summary Create Order
|
|
@@ -224,6 +379,42 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
224
379
|
options: localVarRequestOptions,
|
|
225
380
|
};
|
|
226
381
|
}),
|
|
382
|
+
/**
|
|
383
|
+
* Endpoint for submitting event-market orders using the V2 request/response shape (single-book `bid`/`ask` side and fixed-point dollar prices). The legacy `/portfolio/orders` endpoint will be deprecated no earlier than May 6, 2026 — clients should migrate to this path.
|
|
384
|
+
* @summary Create Order (V2)
|
|
385
|
+
* @param {CreateOrderV2Request} createOrderV2Request
|
|
386
|
+
* @param {*} [options] Override http request option.
|
|
387
|
+
* @throws {RequiredError}
|
|
388
|
+
*/
|
|
389
|
+
createOrderV2: (createOrderV2Request_1, ...args_1) => __awaiter(this, [createOrderV2Request_1, ...args_1], void 0, function* (createOrderV2Request, options = {}) {
|
|
390
|
+
// verify required parameter 'createOrderV2Request' is not null or undefined
|
|
391
|
+
(0, common_1.assertParamExists)('createOrderV2', 'createOrderV2Request', createOrderV2Request);
|
|
392
|
+
const localVarPath = `/portfolio/events/orders`;
|
|
393
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
394
|
+
const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
395
|
+
let baseOptions;
|
|
396
|
+
if (configuration) {
|
|
397
|
+
baseOptions = configuration.baseOptions;
|
|
398
|
+
}
|
|
399
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
400
|
+
const localVarHeaderParameter = {};
|
|
401
|
+
const localVarQueryParameter = {};
|
|
402
|
+
// authentication kalshiAccessSignature required
|
|
403
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration);
|
|
404
|
+
// authentication kalshiAccessKey required
|
|
405
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration);
|
|
406
|
+
// authentication kalshiAccessTimestamp required
|
|
407
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration);
|
|
408
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
409
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
410
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
411
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
412
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createOrderV2Request, localVarRequestOptions, configuration);
|
|
413
|
+
return {
|
|
414
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
415
|
+
options: localVarRequestOptions,
|
|
416
|
+
};
|
|
417
|
+
}),
|
|
227
418
|
/**
|
|
228
419
|
* Endpoint for decreasing the number of contracts in an existing order. This is the only kind of edit available on order quantity. Cancelling an order is equivalent to decreasing an order amount to zero.
|
|
229
420
|
* @summary Decrease Order
|
|
@@ -264,6 +455,50 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
264
455
|
options: localVarRequestOptions,
|
|
265
456
|
};
|
|
266
457
|
}),
|
|
458
|
+
/**
|
|
459
|
+
* Endpoint for decreasing the remaining count of an existing event-market order using the V2 request/response shape. Only `reduce_to` is supported.
|
|
460
|
+
* @summary Decrease Order (V2)
|
|
461
|
+
* @param {string} orderId Order ID
|
|
462
|
+
* @param {DecreaseOrderV2Request} decreaseOrderV2Request
|
|
463
|
+
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
|
|
464
|
+
* @param {*} [options] Override http request option.
|
|
465
|
+
* @throws {RequiredError}
|
|
466
|
+
*/
|
|
467
|
+
decreaseOrderV2: (orderId_1, decreaseOrderV2Request_1, subaccount_1, ...args_1) => __awaiter(this, [orderId_1, decreaseOrderV2Request_1, subaccount_1, ...args_1], void 0, function* (orderId, decreaseOrderV2Request, subaccount, options = {}) {
|
|
468
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
469
|
+
(0, common_1.assertParamExists)('decreaseOrderV2', 'orderId', orderId);
|
|
470
|
+
// verify required parameter 'decreaseOrderV2Request' is not null or undefined
|
|
471
|
+
(0, common_1.assertParamExists)('decreaseOrderV2', 'decreaseOrderV2Request', decreaseOrderV2Request);
|
|
472
|
+
const localVarPath = `/portfolio/events/orders/{order_id}/decrease`
|
|
473
|
+
.replace(`{${"order_id"}}`, encodeURIComponent(String(orderId)));
|
|
474
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
475
|
+
const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
476
|
+
let baseOptions;
|
|
477
|
+
if (configuration) {
|
|
478
|
+
baseOptions = configuration.baseOptions;
|
|
479
|
+
}
|
|
480
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
481
|
+
const localVarHeaderParameter = {};
|
|
482
|
+
const localVarQueryParameter = {};
|
|
483
|
+
// authentication kalshiAccessSignature required
|
|
484
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration);
|
|
485
|
+
// authentication kalshiAccessKey required
|
|
486
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration);
|
|
487
|
+
// authentication kalshiAccessTimestamp required
|
|
488
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration);
|
|
489
|
+
if (subaccount !== undefined) {
|
|
490
|
+
localVarQueryParameter['subaccount'] = subaccount;
|
|
491
|
+
}
|
|
492
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
493
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
494
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
495
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
496
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(decreaseOrderV2Request, localVarRequestOptions, configuration);
|
|
497
|
+
return {
|
|
498
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
499
|
+
options: localVarRequestOptions,
|
|
500
|
+
};
|
|
501
|
+
}),
|
|
267
502
|
/**
|
|
268
503
|
* Endpoint for getting a single order.
|
|
269
504
|
* @summary Get Order
|
|
@@ -378,7 +613,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
378
613
|
};
|
|
379
614
|
}),
|
|
380
615
|
/**
|
|
381
|
-
* Restricts the response to orders that have a certain status: resting, canceled, or executed. Orders that have been canceled or fully executed before the historical cutoff are only available via `GET /historical/orders`. Resting orders will always be available through this endpoint. See [Historical Data](https://kalshi.com/
|
|
616
|
+
* Restricts the response to orders that have a certain status: resting, canceled, or executed. Orders that have been canceled or fully executed before the historical cutoff are only available via `GET /historical/orders`. Resting orders will always be available through this endpoint. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.
|
|
382
617
|
* @summary Get Orders
|
|
383
618
|
* @param {string} [ticker] Filter by market ticker
|
|
384
619
|
* @param {string} [eventTicker] Event tickers to filter by, as a comma-separated list (maximum 10).
|
|
@@ -467,7 +702,25 @@ const OrdersApiFp = function (configuration) {
|
|
|
467
702
|
});
|
|
468
703
|
},
|
|
469
704
|
/**
|
|
470
|
-
*
|
|
705
|
+
* Endpoint for amending the price and/or remaining count of an existing event-market order using the V2 request/response shape.
|
|
706
|
+
* @summary Amend Order (V2)
|
|
707
|
+
* @param {string} orderId Order ID
|
|
708
|
+
* @param {AmendOrderV2Request} amendOrderV2Request
|
|
709
|
+
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
|
|
710
|
+
* @param {*} [options] Override http request option.
|
|
711
|
+
* @throws {RequiredError}
|
|
712
|
+
*/
|
|
713
|
+
amendOrderV2(orderId, amendOrderV2Request, subaccount, options) {
|
|
714
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
715
|
+
var _a;
|
|
716
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.amendOrderV2(orderId, amendOrderV2Request, subaccount, options);
|
|
717
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
718
|
+
const localVarOperationServerBasePath = undefined;
|
|
719
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
720
|
+
});
|
|
721
|
+
},
|
|
722
|
+
/**
|
|
723
|
+
* Endpoint for cancelling a batch of orders. The maximum batch size scales with your tier\'s write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
|
|
471
724
|
* @summary Batch Cancel Orders
|
|
472
725
|
* @param {BatchCancelOrdersRequest} batchCancelOrdersRequest
|
|
473
726
|
* @param {*} [options] Override http request option.
|
|
@@ -483,7 +736,23 @@ const OrdersApiFp = function (configuration) {
|
|
|
483
736
|
});
|
|
484
737
|
},
|
|
485
738
|
/**
|
|
486
|
-
*
|
|
739
|
+
* Endpoint for cancelling a batch of event-market orders using the V2 response shape. The maximum batch size scales with your tier\'s write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
|
|
740
|
+
* @summary Batch Cancel Orders (V2)
|
|
741
|
+
* @param {BatchCancelOrdersV2Request} batchCancelOrdersV2Request
|
|
742
|
+
* @param {*} [options] Override http request option.
|
|
743
|
+
* @throws {RequiredError}
|
|
744
|
+
*/
|
|
745
|
+
batchCancelOrdersV2(batchCancelOrdersV2Request, options) {
|
|
746
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
747
|
+
var _a;
|
|
748
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.batchCancelOrdersV2(batchCancelOrdersV2Request, options);
|
|
749
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
750
|
+
const localVarOperationServerBasePath = undefined;
|
|
751
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
752
|
+
});
|
|
753
|
+
},
|
|
754
|
+
/**
|
|
755
|
+
* Endpoint for submitting a batch of orders. The maximum batch size scales with your tier\'s write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
|
|
487
756
|
* @summary Batch Create Orders
|
|
488
757
|
* @param {BatchCreateOrdersRequest} batchCreateOrdersRequest
|
|
489
758
|
* @param {*} [options] Override http request option.
|
|
@@ -498,6 +767,22 @@ const OrdersApiFp = function (configuration) {
|
|
|
498
767
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
499
768
|
});
|
|
500
769
|
},
|
|
770
|
+
/**
|
|
771
|
+
* Endpoint for submitting a batch of event-market orders using the V2 request/response shape. The maximum batch size scales with your tier\'s write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
|
|
772
|
+
* @summary Batch Create Orders (V2)
|
|
773
|
+
* @param {BatchCreateOrdersV2Request} batchCreateOrdersV2Request
|
|
774
|
+
* @param {*} [options] Override http request option.
|
|
775
|
+
* @throws {RequiredError}
|
|
776
|
+
*/
|
|
777
|
+
batchCreateOrdersV2(batchCreateOrdersV2Request, options) {
|
|
778
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
779
|
+
var _a;
|
|
780
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.batchCreateOrdersV2(batchCreateOrdersV2Request, options);
|
|
781
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
782
|
+
const localVarOperationServerBasePath = undefined;
|
|
783
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
784
|
+
});
|
|
785
|
+
},
|
|
501
786
|
/**
|
|
502
787
|
* Endpoint for canceling orders. The value for the orderId should match the id field of the order you want to decrease. Commonly, DELETE-type endpoints return 204 status with no body content on success. But we can\'t completely delete the order, as it may be partially filled already. Instead, the DeleteOrder endpoint reduce the order completely, essentially zeroing the remaining resting contracts on it. The zeroed order is returned on the response payload as a form of validation for the client.
|
|
503
788
|
* @summary Cancel Order
|
|
@@ -515,6 +800,23 @@ const OrdersApiFp = function (configuration) {
|
|
|
515
800
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
516
801
|
});
|
|
517
802
|
},
|
|
803
|
+
/**
|
|
804
|
+
* Endpoint for cancelling event-market orders using the V2 response shape. Returns `{order_id, client_order_id, reduced_by}` rather than a full order object.
|
|
805
|
+
* @summary Cancel Order (V2)
|
|
806
|
+
* @param {string} orderId Order ID
|
|
807
|
+
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
|
|
808
|
+
* @param {*} [options] Override http request option.
|
|
809
|
+
* @throws {RequiredError}
|
|
810
|
+
*/
|
|
811
|
+
cancelOrderV2(orderId, subaccount, options) {
|
|
812
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
813
|
+
var _a;
|
|
814
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.cancelOrderV2(orderId, subaccount, options);
|
|
815
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
816
|
+
const localVarOperationServerBasePath = undefined;
|
|
817
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
818
|
+
});
|
|
819
|
+
},
|
|
518
820
|
/**
|
|
519
821
|
* Endpoint for submitting orders in a market. Each user is limited to 200 000 open orders at a time.
|
|
520
822
|
* @summary Create Order
|
|
@@ -531,6 +833,22 @@ const OrdersApiFp = function (configuration) {
|
|
|
531
833
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
532
834
|
});
|
|
533
835
|
},
|
|
836
|
+
/**
|
|
837
|
+
* Endpoint for submitting event-market orders using the V2 request/response shape (single-book `bid`/`ask` side and fixed-point dollar prices). The legacy `/portfolio/orders` endpoint will be deprecated no earlier than May 6, 2026 — clients should migrate to this path.
|
|
838
|
+
* @summary Create Order (V2)
|
|
839
|
+
* @param {CreateOrderV2Request} createOrderV2Request
|
|
840
|
+
* @param {*} [options] Override http request option.
|
|
841
|
+
* @throws {RequiredError}
|
|
842
|
+
*/
|
|
843
|
+
createOrderV2(createOrderV2Request, options) {
|
|
844
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
845
|
+
var _a;
|
|
846
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createOrderV2(createOrderV2Request, options);
|
|
847
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
848
|
+
const localVarOperationServerBasePath = undefined;
|
|
849
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
850
|
+
});
|
|
851
|
+
},
|
|
534
852
|
/**
|
|
535
853
|
* Endpoint for decreasing the number of contracts in an existing order. This is the only kind of edit available on order quantity. Cancelling an order is equivalent to decreasing an order amount to zero.
|
|
536
854
|
* @summary Decrease Order
|
|
@@ -548,6 +866,24 @@ const OrdersApiFp = function (configuration) {
|
|
|
548
866
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
549
867
|
});
|
|
550
868
|
},
|
|
869
|
+
/**
|
|
870
|
+
* Endpoint for decreasing the remaining count of an existing event-market order using the V2 request/response shape. Only `reduce_to` is supported.
|
|
871
|
+
* @summary Decrease Order (V2)
|
|
872
|
+
* @param {string} orderId Order ID
|
|
873
|
+
* @param {DecreaseOrderV2Request} decreaseOrderV2Request
|
|
874
|
+
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
|
|
875
|
+
* @param {*} [options] Override http request option.
|
|
876
|
+
* @throws {RequiredError}
|
|
877
|
+
*/
|
|
878
|
+
decreaseOrderV2(orderId, decreaseOrderV2Request, subaccount, options) {
|
|
879
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
880
|
+
var _a;
|
|
881
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.decreaseOrderV2(orderId, decreaseOrderV2Request, subaccount, options);
|
|
882
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
883
|
+
const localVarOperationServerBasePath = undefined;
|
|
884
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
885
|
+
});
|
|
886
|
+
},
|
|
551
887
|
/**
|
|
552
888
|
* Endpoint for getting a single order.
|
|
553
889
|
* @summary Get Order
|
|
@@ -599,7 +935,7 @@ const OrdersApiFp = function (configuration) {
|
|
|
599
935
|
});
|
|
600
936
|
},
|
|
601
937
|
/**
|
|
602
|
-
* Restricts the response to orders that have a certain status: resting, canceled, or executed. Orders that have been canceled or fully executed before the historical cutoff are only available via `GET /historical/orders`. Resting orders will always be available through this endpoint. See [Historical Data](https://kalshi.com/
|
|
938
|
+
* Restricts the response to orders that have a certain status: resting, canceled, or executed. Orders that have been canceled or fully executed before the historical cutoff are only available via `GET /historical/orders`. Resting orders will always be available through this endpoint. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.
|
|
603
939
|
* @summary Get Orders
|
|
604
940
|
* @param {string} [ticker] Filter by market ticker
|
|
605
941
|
* @param {string} [eventTicker] Event tickers to filter by, as a comma-separated list (maximum 10).
|
|
@@ -642,7 +978,19 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
642
978
|
return localVarFp.amendOrder(orderId, amendOrderRequest, options).then((request) => request(axios, basePath));
|
|
643
979
|
},
|
|
644
980
|
/**
|
|
645
|
-
*
|
|
981
|
+
* Endpoint for amending the price and/or remaining count of an existing event-market order using the V2 request/response shape.
|
|
982
|
+
* @summary Amend Order (V2)
|
|
983
|
+
* @param {string} orderId Order ID
|
|
984
|
+
* @param {AmendOrderV2Request} amendOrderV2Request
|
|
985
|
+
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
|
|
986
|
+
* @param {*} [options] Override http request option.
|
|
987
|
+
* @throws {RequiredError}
|
|
988
|
+
*/
|
|
989
|
+
amendOrderV2(orderId, amendOrderV2Request, subaccount, options) {
|
|
990
|
+
return localVarFp.amendOrderV2(orderId, amendOrderV2Request, subaccount, options).then((request) => request(axios, basePath));
|
|
991
|
+
},
|
|
992
|
+
/**
|
|
993
|
+
* Endpoint for cancelling a batch of orders. The maximum batch size scales with your tier\'s write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
|
|
646
994
|
* @summary Batch Cancel Orders
|
|
647
995
|
* @param {BatchCancelOrdersRequest} batchCancelOrdersRequest
|
|
648
996
|
* @param {*} [options] Override http request option.
|
|
@@ -652,7 +1000,17 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
652
1000
|
return localVarFp.batchCancelOrders(batchCancelOrdersRequest, options).then((request) => request(axios, basePath));
|
|
653
1001
|
},
|
|
654
1002
|
/**
|
|
655
|
-
*
|
|
1003
|
+
* Endpoint for cancelling a batch of event-market orders using the V2 response shape. The maximum batch size scales with your tier\'s write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
|
|
1004
|
+
* @summary Batch Cancel Orders (V2)
|
|
1005
|
+
* @param {BatchCancelOrdersV2Request} batchCancelOrdersV2Request
|
|
1006
|
+
* @param {*} [options] Override http request option.
|
|
1007
|
+
* @throws {RequiredError}
|
|
1008
|
+
*/
|
|
1009
|
+
batchCancelOrdersV2(batchCancelOrdersV2Request, options) {
|
|
1010
|
+
return localVarFp.batchCancelOrdersV2(batchCancelOrdersV2Request, options).then((request) => request(axios, basePath));
|
|
1011
|
+
},
|
|
1012
|
+
/**
|
|
1013
|
+
* Endpoint for submitting a batch of orders. The maximum batch size scales with your tier\'s write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
|
|
656
1014
|
* @summary Batch Create Orders
|
|
657
1015
|
* @param {BatchCreateOrdersRequest} batchCreateOrdersRequest
|
|
658
1016
|
* @param {*} [options] Override http request option.
|
|
@@ -661,6 +1019,16 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
661
1019
|
batchCreateOrders(batchCreateOrdersRequest, options) {
|
|
662
1020
|
return localVarFp.batchCreateOrders(batchCreateOrdersRequest, options).then((request) => request(axios, basePath));
|
|
663
1021
|
},
|
|
1022
|
+
/**
|
|
1023
|
+
* Endpoint for submitting a batch of event-market orders using the V2 request/response shape. The maximum batch size scales with your tier\'s write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
|
|
1024
|
+
* @summary Batch Create Orders (V2)
|
|
1025
|
+
* @param {BatchCreateOrdersV2Request} batchCreateOrdersV2Request
|
|
1026
|
+
* @param {*} [options] Override http request option.
|
|
1027
|
+
* @throws {RequiredError}
|
|
1028
|
+
*/
|
|
1029
|
+
batchCreateOrdersV2(batchCreateOrdersV2Request, options) {
|
|
1030
|
+
return localVarFp.batchCreateOrdersV2(batchCreateOrdersV2Request, options).then((request) => request(axios, basePath));
|
|
1031
|
+
},
|
|
664
1032
|
/**
|
|
665
1033
|
* Endpoint for canceling orders. The value for the orderId should match the id field of the order you want to decrease. Commonly, DELETE-type endpoints return 204 status with no body content on success. But we can\'t completely delete the order, as it may be partially filled already. Instead, the DeleteOrder endpoint reduce the order completely, essentially zeroing the remaining resting contracts on it. The zeroed order is returned on the response payload as a form of validation for the client.
|
|
666
1034
|
* @summary Cancel Order
|
|
@@ -672,6 +1040,17 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
672
1040
|
cancelOrder(orderId, subaccount, options) {
|
|
673
1041
|
return localVarFp.cancelOrder(orderId, subaccount, options).then((request) => request(axios, basePath));
|
|
674
1042
|
},
|
|
1043
|
+
/**
|
|
1044
|
+
* Endpoint for cancelling event-market orders using the V2 response shape. Returns `{order_id, client_order_id, reduced_by}` rather than a full order object.
|
|
1045
|
+
* @summary Cancel Order (V2)
|
|
1046
|
+
* @param {string} orderId Order ID
|
|
1047
|
+
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
|
|
1048
|
+
* @param {*} [options] Override http request option.
|
|
1049
|
+
* @throws {RequiredError}
|
|
1050
|
+
*/
|
|
1051
|
+
cancelOrderV2(orderId, subaccount, options) {
|
|
1052
|
+
return localVarFp.cancelOrderV2(orderId, subaccount, options).then((request) => request(axios, basePath));
|
|
1053
|
+
},
|
|
675
1054
|
/**
|
|
676
1055
|
* Endpoint for submitting orders in a market. Each user is limited to 200 000 open orders at a time.
|
|
677
1056
|
* @summary Create Order
|
|
@@ -682,6 +1061,16 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
682
1061
|
createOrder(createOrderRequest, options) {
|
|
683
1062
|
return localVarFp.createOrder(createOrderRequest, options).then((request) => request(axios, basePath));
|
|
684
1063
|
},
|
|
1064
|
+
/**
|
|
1065
|
+
* Endpoint for submitting event-market orders using the V2 request/response shape (single-book `bid`/`ask` side and fixed-point dollar prices). The legacy `/portfolio/orders` endpoint will be deprecated no earlier than May 6, 2026 — clients should migrate to this path.
|
|
1066
|
+
* @summary Create Order (V2)
|
|
1067
|
+
* @param {CreateOrderV2Request} createOrderV2Request
|
|
1068
|
+
* @param {*} [options] Override http request option.
|
|
1069
|
+
* @throws {RequiredError}
|
|
1070
|
+
*/
|
|
1071
|
+
createOrderV2(createOrderV2Request, options) {
|
|
1072
|
+
return localVarFp.createOrderV2(createOrderV2Request, options).then((request) => request(axios, basePath));
|
|
1073
|
+
},
|
|
685
1074
|
/**
|
|
686
1075
|
* Endpoint for decreasing the number of contracts in an existing order. This is the only kind of edit available on order quantity. Cancelling an order is equivalent to decreasing an order amount to zero.
|
|
687
1076
|
* @summary Decrease Order
|
|
@@ -693,6 +1082,18 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
693
1082
|
decreaseOrder(orderId, decreaseOrderRequest, options) {
|
|
694
1083
|
return localVarFp.decreaseOrder(orderId, decreaseOrderRequest, options).then((request) => request(axios, basePath));
|
|
695
1084
|
},
|
|
1085
|
+
/**
|
|
1086
|
+
* Endpoint for decreasing the remaining count of an existing event-market order using the V2 request/response shape. Only `reduce_to` is supported.
|
|
1087
|
+
* @summary Decrease Order (V2)
|
|
1088
|
+
* @param {string} orderId Order ID
|
|
1089
|
+
* @param {DecreaseOrderV2Request} decreaseOrderV2Request
|
|
1090
|
+
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
|
|
1091
|
+
* @param {*} [options] Override http request option.
|
|
1092
|
+
* @throws {RequiredError}
|
|
1093
|
+
*/
|
|
1094
|
+
decreaseOrderV2(orderId, decreaseOrderV2Request, subaccount, options) {
|
|
1095
|
+
return localVarFp.decreaseOrderV2(orderId, decreaseOrderV2Request, subaccount, options).then((request) => request(axios, basePath));
|
|
1096
|
+
},
|
|
696
1097
|
/**
|
|
697
1098
|
* Endpoint for getting a single order.
|
|
698
1099
|
* @summary Get Order
|
|
@@ -726,7 +1127,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
726
1127
|
return localVarFp.getOrderQueuePositions(marketTickers, eventTicker, subaccount, options).then((request) => request(axios, basePath));
|
|
727
1128
|
},
|
|
728
1129
|
/**
|
|
729
|
-
* Restricts the response to orders that have a certain status: resting, canceled, or executed. Orders that have been canceled or fully executed before the historical cutoff are only available via `GET /historical/orders`. Resting orders will always be available through this endpoint. See [Historical Data](https://kalshi.com/
|
|
1130
|
+
* Restricts the response to orders that have a certain status: resting, canceled, or executed. Orders that have been canceled or fully executed before the historical cutoff are only available via `GET /historical/orders`. Resting orders will always be available through this endpoint. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.
|
|
730
1131
|
* @summary Get Orders
|
|
731
1132
|
* @param {string} [ticker] Filter by market ticker
|
|
732
1133
|
* @param {string} [eventTicker] Event tickers to filter by, as a comma-separated list (maximum 10).
|
|
@@ -761,7 +1162,19 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
761
1162
|
return (0, exports.OrdersApiFp)(this.configuration).amendOrder(orderId, amendOrderRequest, options).then((request) => request(this.axios, this.basePath));
|
|
762
1163
|
}
|
|
763
1164
|
/**
|
|
764
|
-
*
|
|
1165
|
+
* Endpoint for amending the price and/or remaining count of an existing event-market order using the V2 request/response shape.
|
|
1166
|
+
* @summary Amend Order (V2)
|
|
1167
|
+
* @param {string} orderId Order ID
|
|
1168
|
+
* @param {AmendOrderV2Request} amendOrderV2Request
|
|
1169
|
+
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
|
|
1170
|
+
* @param {*} [options] Override http request option.
|
|
1171
|
+
* @throws {RequiredError}
|
|
1172
|
+
*/
|
|
1173
|
+
amendOrderV2(orderId, amendOrderV2Request, subaccount, options) {
|
|
1174
|
+
return (0, exports.OrdersApiFp)(this.configuration).amendOrderV2(orderId, amendOrderV2Request, subaccount, options).then((request) => request(this.axios, this.basePath));
|
|
1175
|
+
}
|
|
1176
|
+
/**
|
|
1177
|
+
* Endpoint for cancelling a batch of orders. The maximum batch size scales with your tier\'s write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
|
|
765
1178
|
* @summary Batch Cancel Orders
|
|
766
1179
|
* @param {BatchCancelOrdersRequest} batchCancelOrdersRequest
|
|
767
1180
|
* @param {*} [options] Override http request option.
|
|
@@ -771,7 +1184,17 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
771
1184
|
return (0, exports.OrdersApiFp)(this.configuration).batchCancelOrders(batchCancelOrdersRequest, options).then((request) => request(this.axios, this.basePath));
|
|
772
1185
|
}
|
|
773
1186
|
/**
|
|
774
|
-
*
|
|
1187
|
+
* Endpoint for cancelling a batch of event-market orders using the V2 response shape. The maximum batch size scales with your tier\'s write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
|
|
1188
|
+
* @summary Batch Cancel Orders (V2)
|
|
1189
|
+
* @param {BatchCancelOrdersV2Request} batchCancelOrdersV2Request
|
|
1190
|
+
* @param {*} [options] Override http request option.
|
|
1191
|
+
* @throws {RequiredError}
|
|
1192
|
+
*/
|
|
1193
|
+
batchCancelOrdersV2(batchCancelOrdersV2Request, options) {
|
|
1194
|
+
return (0, exports.OrdersApiFp)(this.configuration).batchCancelOrdersV2(batchCancelOrdersV2Request, options).then((request) => request(this.axios, this.basePath));
|
|
1195
|
+
}
|
|
1196
|
+
/**
|
|
1197
|
+
* Endpoint for submitting a batch of orders. The maximum batch size scales with your tier\'s write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
|
|
775
1198
|
* @summary Batch Create Orders
|
|
776
1199
|
* @param {BatchCreateOrdersRequest} batchCreateOrdersRequest
|
|
777
1200
|
* @param {*} [options] Override http request option.
|
|
@@ -780,6 +1203,16 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
780
1203
|
batchCreateOrders(batchCreateOrdersRequest, options) {
|
|
781
1204
|
return (0, exports.OrdersApiFp)(this.configuration).batchCreateOrders(batchCreateOrdersRequest, options).then((request) => request(this.axios, this.basePath));
|
|
782
1205
|
}
|
|
1206
|
+
/**
|
|
1207
|
+
* Endpoint for submitting a batch of event-market orders using the V2 request/response shape. The maximum batch size scales with your tier\'s write budget — see [Rate Limits and Tiers](/getting_started/rate_limits).
|
|
1208
|
+
* @summary Batch Create Orders (V2)
|
|
1209
|
+
* @param {BatchCreateOrdersV2Request} batchCreateOrdersV2Request
|
|
1210
|
+
* @param {*} [options] Override http request option.
|
|
1211
|
+
* @throws {RequiredError}
|
|
1212
|
+
*/
|
|
1213
|
+
batchCreateOrdersV2(batchCreateOrdersV2Request, options) {
|
|
1214
|
+
return (0, exports.OrdersApiFp)(this.configuration).batchCreateOrdersV2(batchCreateOrdersV2Request, options).then((request) => request(this.axios, this.basePath));
|
|
1215
|
+
}
|
|
783
1216
|
/**
|
|
784
1217
|
* Endpoint for canceling orders. The value for the orderId should match the id field of the order you want to decrease. Commonly, DELETE-type endpoints return 204 status with no body content on success. But we can\'t completely delete the order, as it may be partially filled already. Instead, the DeleteOrder endpoint reduce the order completely, essentially zeroing the remaining resting contracts on it. The zeroed order is returned on the response payload as a form of validation for the client.
|
|
785
1218
|
* @summary Cancel Order
|
|
@@ -791,6 +1224,17 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
791
1224
|
cancelOrder(orderId, subaccount, options) {
|
|
792
1225
|
return (0, exports.OrdersApiFp)(this.configuration).cancelOrder(orderId, subaccount, options).then((request) => request(this.axios, this.basePath));
|
|
793
1226
|
}
|
|
1227
|
+
/**
|
|
1228
|
+
* Endpoint for cancelling event-market orders using the V2 response shape. Returns `{order_id, client_order_id, reduced_by}` rather than a full order object.
|
|
1229
|
+
* @summary Cancel Order (V2)
|
|
1230
|
+
* @param {string} orderId Order ID
|
|
1231
|
+
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
|
|
1232
|
+
* @param {*} [options] Override http request option.
|
|
1233
|
+
* @throws {RequiredError}
|
|
1234
|
+
*/
|
|
1235
|
+
cancelOrderV2(orderId, subaccount, options) {
|
|
1236
|
+
return (0, exports.OrdersApiFp)(this.configuration).cancelOrderV2(orderId, subaccount, options).then((request) => request(this.axios, this.basePath));
|
|
1237
|
+
}
|
|
794
1238
|
/**
|
|
795
1239
|
* Endpoint for submitting orders in a market. Each user is limited to 200 000 open orders at a time.
|
|
796
1240
|
* @summary Create Order
|
|
@@ -801,6 +1245,16 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
801
1245
|
createOrder(createOrderRequest, options) {
|
|
802
1246
|
return (0, exports.OrdersApiFp)(this.configuration).createOrder(createOrderRequest, options).then((request) => request(this.axios, this.basePath));
|
|
803
1247
|
}
|
|
1248
|
+
/**
|
|
1249
|
+
* Endpoint for submitting event-market orders using the V2 request/response shape (single-book `bid`/`ask` side and fixed-point dollar prices). The legacy `/portfolio/orders` endpoint will be deprecated no earlier than May 6, 2026 — clients should migrate to this path.
|
|
1250
|
+
* @summary Create Order (V2)
|
|
1251
|
+
* @param {CreateOrderV2Request} createOrderV2Request
|
|
1252
|
+
* @param {*} [options] Override http request option.
|
|
1253
|
+
* @throws {RequiredError}
|
|
1254
|
+
*/
|
|
1255
|
+
createOrderV2(createOrderV2Request, options) {
|
|
1256
|
+
return (0, exports.OrdersApiFp)(this.configuration).createOrderV2(createOrderV2Request, options).then((request) => request(this.axios, this.basePath));
|
|
1257
|
+
}
|
|
804
1258
|
/**
|
|
805
1259
|
* Endpoint for decreasing the number of contracts in an existing order. This is the only kind of edit available on order quantity. Cancelling an order is equivalent to decreasing an order amount to zero.
|
|
806
1260
|
* @summary Decrease Order
|
|
@@ -812,6 +1266,18 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
812
1266
|
decreaseOrder(orderId, decreaseOrderRequest, options) {
|
|
813
1267
|
return (0, exports.OrdersApiFp)(this.configuration).decreaseOrder(orderId, decreaseOrderRequest, options).then((request) => request(this.axios, this.basePath));
|
|
814
1268
|
}
|
|
1269
|
+
/**
|
|
1270
|
+
* Endpoint for decreasing the remaining count of an existing event-market order using the V2 request/response shape. Only `reduce_to` is supported.
|
|
1271
|
+
* @summary Decrease Order (V2)
|
|
1272
|
+
* @param {string} orderId Order ID
|
|
1273
|
+
* @param {DecreaseOrderV2Request} decreaseOrderV2Request
|
|
1274
|
+
* @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
|
|
1275
|
+
* @param {*} [options] Override http request option.
|
|
1276
|
+
* @throws {RequiredError}
|
|
1277
|
+
*/
|
|
1278
|
+
decreaseOrderV2(orderId, decreaseOrderV2Request, subaccount, options) {
|
|
1279
|
+
return (0, exports.OrdersApiFp)(this.configuration).decreaseOrderV2(orderId, decreaseOrderV2Request, subaccount, options).then((request) => request(this.axios, this.basePath));
|
|
1280
|
+
}
|
|
815
1281
|
/**
|
|
816
1282
|
* Endpoint for getting a single order.
|
|
817
1283
|
* @summary Get Order
|
|
@@ -845,7 +1311,7 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
845
1311
|
return (0, exports.OrdersApiFp)(this.configuration).getOrderQueuePositions(marketTickers, eventTicker, subaccount, options).then((request) => request(this.axios, this.basePath));
|
|
846
1312
|
}
|
|
847
1313
|
/**
|
|
848
|
-
* Restricts the response to orders that have a certain status: resting, canceled, or executed. Orders that have been canceled or fully executed before the historical cutoff are only available via `GET /historical/orders`. Resting orders will always be available through this endpoint. See [Historical Data](https://kalshi.com/
|
|
1314
|
+
* Restricts the response to orders that have a certain status: resting, canceled, or executed. Orders that have been canceled or fully executed before the historical cutoff are only available via `GET /historical/orders`. Resting orders will always be available through this endpoint. See [Historical Data](https://docs.kalshi.com/getting_started/historical_data) for details.
|
|
849
1315
|
* @summary Get Orders
|
|
850
1316
|
* @param {string} [ticker] Filter by market ticker
|
|
851
1317
|
* @param {string} [eventTicker] Event tickers to filter by, as a comma-separated list (maximum 10).
|