kalshi-typescript 2.1.3 → 3.0.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 +112 -42
- package/.openapi-generator/VERSION +1 -1
- package/README.md +110 -50
- package/api/api-keys-api.ts +52 -34
- package/api/collection-api.ts +506 -0
- package/api/communications-api.ts +284 -102
- package/api/events-api.ts +402 -53
- package/api/exchange-api.ts +99 -24
- package/api/fcm-api.ts +337 -0
- package/api/incentive-programs-api.ts +168 -0
- package/api/live-data-api.ts +207 -0
- package/api/market-api.ts +872 -0
- package/api/markets-api.ts +17 -18
- package/api/milestone-api.ts +258 -0
- package/api/milestones-api.ts +2 -3
- package/api/multivariate-api.ts +505 -0
- package/api/multivariate-collections-api.ts +7 -8
- package/api/order-groups-api.ts +454 -0
- package/api/orders-api.ts +941 -0
- package/api/portfolio-api.ts +206 -1357
- package/api/search-api.ts +183 -0
- package/api/series-api.ts +2 -3
- package/api/structured-targets-api.ts +44 -38
- package/api.ts +13 -8
- package/auth.ts +1 -1
- package/base.ts +8 -8
- package/common.ts +4 -4
- package/configuration.ts +4 -5
- package/dist/api/api-keys-api.d.ts +20 -20
- package/dist/api/api-keys-api.js +44 -32
- package/dist/api/collection-api.d.ts +242 -0
- package/dist/api/collection-api.js +467 -0
- package/dist/api/communications-api.d.ts +124 -60
- package/dist/api/communications-api.js +246 -102
- package/dist/api/events-api.d.ts +210 -36
- package/dist/api/events-api.js +370 -50
- package/dist/api/exchange-api.d.ts +57 -20
- package/dist/api/exchange-api.js +92 -23
- package/dist/api/fcm-api.d.ts +164 -0
- package/dist/api/fcm-api.js +313 -0
- package/dist/api/incentive-programs-api.d.ts +93 -0
- package/dist/api/incentive-programs-api.js +164 -0
- package/dist/api/live-data-api.d.ts +104 -0
- package/dist/api/live-data-api.js +205 -0
- package/dist/api/market-api.d.ts +417 -0
- package/dist/api/market-api.js +804 -0
- package/dist/api/milestone-api.d.ts +128 -0
- package/dist/api/milestone-api.js +249 -0
- package/dist/api/multivariate-api.d.ts +242 -0
- package/dist/api/multivariate-api.js +467 -0
- package/dist/api/order-groups-api.d.ts +198 -0
- package/dist/api/order-groups-api.js +421 -0
- package/dist/api/orders-api.d.ts +405 -0
- package/dist/api/orders-api.js +844 -0
- package/dist/api/portfolio-api.d.ts +83 -601
- package/dist/api/portfolio-api.js +154 -1203
- package/dist/api/search-api.d.ts +92 -0
- package/dist/api/search-api.js +182 -0
- package/dist/api/structured-targets-api.d.ts +32 -24
- package/dist/api/structured-targets-api.js +43 -35
- package/dist/api.d.ts +13 -8
- package/dist/api.js +13 -8
- package/dist/base.d.ts +4 -4
- package/dist/base.js +4 -4
- package/dist/common.d.ts +4 -4
- package/dist/common.js +4 -4
- package/dist/configuration.d.ts +4 -4
- package/dist/configuration.js +4 -4
- package/dist/esm/api/api-keys-api.d.ts +20 -20
- package/dist/esm/api/api-keys-api.js +45 -33
- package/dist/esm/api/collection-api.d.ts +242 -0
- package/dist/esm/api/collection-api.js +460 -0
- package/dist/esm/api/communications-api.d.ts +124 -60
- package/dist/esm/api/communications-api.js +247 -103
- package/dist/esm/api/events-api.d.ts +210 -36
- package/dist/esm/api/events-api.js +370 -50
- package/dist/esm/api/exchange-api.d.ts +57 -20
- package/dist/esm/api/exchange-api.js +93 -24
- package/dist/esm/api/fcm-api.d.ts +164 -0
- package/dist/esm/api/fcm-api.js +306 -0
- package/dist/esm/api/incentive-programs-api.d.ts +93 -0
- package/dist/esm/api/incentive-programs-api.js +157 -0
- package/dist/esm/api/live-data-api.d.ts +104 -0
- package/dist/esm/api/live-data-api.js +198 -0
- package/dist/esm/api/market-api.d.ts +417 -0
- package/dist/esm/api/market-api.js +797 -0
- package/dist/esm/api/milestone-api.d.ts +128 -0
- package/dist/esm/api/milestone-api.js +242 -0
- package/dist/esm/api/multivariate-api.d.ts +242 -0
- package/dist/esm/api/multivariate-api.js +460 -0
- package/dist/esm/api/order-groups-api.d.ts +198 -0
- package/dist/esm/api/order-groups-api.js +414 -0
- package/dist/esm/api/orders-api.d.ts +405 -0
- package/dist/esm/api/orders-api.js +837 -0
- package/dist/esm/api/portfolio-api.d.ts +83 -601
- package/dist/esm/api/portfolio-api.js +153 -1202
- package/dist/esm/api/search-api.d.ts +92 -0
- package/dist/esm/api/search-api.js +175 -0
- package/dist/esm/api/structured-targets-api.d.ts +32 -24
- package/dist/esm/api/structured-targets-api.js +44 -36
- package/dist/esm/api.d.ts +13 -8
- package/dist/esm/api.js +13 -8
- package/dist/esm/base.d.ts +4 -4
- package/dist/esm/base.js +4 -4
- package/dist/esm/common.d.ts +4 -4
- package/dist/esm/common.js +4 -4
- package/dist/esm/configuration.d.ts +4 -4
- package/dist/esm/configuration.js +4 -4
- package/dist/esm/index.d.ts +4 -4
- package/dist/esm/index.js +4 -4
- package/dist/esm/models/accept-quote-request.d.ts +13 -5
- package/dist/esm/models/accept-quote-request.js +8 -5
- package/dist/esm/models/amend-order-request.d.ts +27 -10
- package/dist/esm/models/amend-order-request.js +4 -4
- package/dist/esm/models/amend-order-response.d.ts +6 -5
- package/dist/esm/models/amend-order-response.js +4 -4
- package/dist/esm/models/announcement.d.ts +25 -13
- package/dist/esm/models/announcement.js +8 -8
- package/dist/esm/models/api-key.d.ts +4 -8
- package/dist/esm/models/api-key.js +4 -4
- package/dist/esm/models/associated-event.d.ts +33 -0
- package/dist/esm/models/associated-event.js +14 -0
- package/dist/esm/models/batch-cancel-orders-individual-response.d.ts +25 -0
- package/dist/esm/models/batch-cancel-orders-individual-response.js +14 -0
- package/dist/esm/models/batch-cancel-orders-request.d.ts +8 -5
- package/dist/esm/models/batch-cancel-orders-request.js +4 -4
- package/dist/esm/models/batch-cancel-orders-response.d.ts +6 -6
- package/dist/esm/models/batch-cancel-orders-response.js +4 -4
- package/dist/esm/models/batch-create-orders-individual-response.d.ts +18 -0
- package/dist/esm/models/batch-create-orders-individual-response.js +14 -0
- package/dist/esm/models/batch-create-orders-request.d.ts +4 -4
- package/dist/esm/models/batch-create-orders-request.js +4 -4
- package/dist/esm/models/batch-create-orders-response.d.ts +6 -6
- package/dist/esm/models/batch-create-orders-response.js +4 -4
- package/dist/esm/models/batch-get-market-candlesticks-response.d.ts +18 -0
- package/dist/esm/models/batch-get-market-candlesticks-response.js +14 -0
- package/dist/esm/models/bid-ask-distribution.d.ts +45 -0
- package/dist/esm/models/bid-ask-distribution.js +14 -0
- package/dist/esm/models/cancel-order-response.d.ts +6 -6
- package/dist/esm/models/cancel-order-response.js +4 -4
- package/dist/esm/models/create-api-key-request.d.ts +4 -4
- package/dist/esm/models/create-api-key-request.js +4 -4
- package/dist/esm/models/create-api-key-response.d.ts +4 -4
- package/dist/esm/models/create-api-key-response.js +4 -4
- package/dist/esm/models/create-market-in-multivariate-event-collection-request.d.ts +18 -0
- package/dist/esm/models/create-market-in-multivariate-event-collection-request.js +14 -0
- package/dist/esm/models/create-market-in-multivariate-event-collection-response.d.ts +21 -0
- package/dist/esm/models/create-market-in-multivariate-event-collection-response.js +14 -0
- package/dist/esm/models/create-order-group-request.d.ts +5 -5
- package/dist/esm/models/create-order-group-request.js +4 -4
- package/dist/esm/models/create-order-group-response.d.ts +5 -5
- package/dist/esm/models/create-order-group-response.js +4 -4
- package/dist/esm/models/create-order-request.d.ts +34 -9
- package/dist/esm/models/create-order-request.js +9 -4
- package/dist/esm/models/create-order-response.d.ts +5 -5
- package/dist/esm/models/create-order-response.js +4 -4
- package/dist/esm/models/create-quote-request.d.ts +19 -6
- package/dist/esm/models/create-quote-request.js +4 -4
- package/dist/esm/models/create-quote-response.d.ts +8 -6
- package/dist/esm/models/create-quote-response.js +4 -4
- package/dist/esm/models/create-rfqrequest.d.ts +28 -13
- package/dist/esm/models/create-rfqrequest.js +5 -8
- package/dist/esm/models/create-rfqresponse.d.ts +8 -6
- package/dist/esm/models/create-rfqresponse.js +4 -4
- package/dist/esm/models/daily-schedule.d.ts +12 -6
- package/dist/esm/models/daily-schedule.js +4 -4
- package/dist/esm/models/decrease-order-request.d.ts +6 -5
- package/dist/esm/models/decrease-order-request.js +4 -4
- package/dist/esm/models/decrease-order-response.d.ts +5 -5
- package/dist/esm/models/decrease-order-response.js +4 -4
- package/dist/esm/models/error-response.d.ts +20 -6
- package/dist/esm/models/error-response.js +4 -4
- package/dist/esm/models/event-data.d.ts +62 -0
- package/dist/esm/models/event-data.js +14 -0
- package/dist/esm/models/event-position.d.ts +24 -24
- package/dist/esm/models/event-position.js +4 -4
- package/dist/esm/models/exchange-status.d.ts +16 -6
- package/dist/esm/models/exchange-status.js +4 -4
- package/dist/esm/models/fill.d.ts +71 -12
- package/dist/esm/models/fill.js +4 -4
- package/dist/esm/models/forecast-percentiles-point.d.ts +30 -0
- package/dist/esm/models/forecast-percentiles-point.js +14 -0
- package/dist/esm/models/generate-api-key-request.d.ts +4 -4
- package/dist/esm/models/generate-api-key-request.js +4 -4
- package/dist/esm/models/generate-api-key-response.d.ts +4 -4
- package/dist/esm/models/generate-api-key-response.js +4 -4
- package/dist/esm/models/get-api-keys-response.d.ts +4 -4
- package/dist/esm/models/get-api-keys-response.js +4 -4
- package/dist/esm/models/get-balance-response.d.ts +14 -6
- package/dist/esm/models/get-balance-response.js +4 -4
- package/dist/esm/models/get-communications-idresponse.d.ts +6 -6
- package/dist/esm/models/get-communications-idresponse.js +4 -4
- package/dist/esm/models/get-event-candlesticks-response.d.ts +26 -0
- package/dist/esm/models/get-event-candlesticks-response.js +14 -0
- package/dist/esm/models/get-event-forecast-percentiles-history-response.d.ts +18 -0
- package/dist/esm/models/get-event-forecast-percentiles-history-response.js +14 -0
- package/dist/esm/models/get-event-metadata-response.d.ts +30 -5
- package/dist/esm/models/get-event-metadata-response.js +4 -4
- package/dist/esm/models/get-event-response.d.ts +10 -7
- package/dist/esm/models/get-event-response.js +4 -4
- package/dist/esm/models/get-events-candlesticks-response-events-inner.d.ts +30 -0
- package/dist/esm/models/get-events-candlesticks-response-events-inner.js +14 -0
- package/dist/esm/models/get-events-candlesticks-response.d.ts +18 -0
- package/dist/esm/models/get-events-candlesticks-response.js +14 -0
- package/dist/esm/models/get-events-response.d.ts +18 -7
- package/dist/esm/models/get-events-response.js +4 -4
- package/dist/esm/models/get-exchange-announcements-response.d.ts +8 -5
- package/dist/esm/models/get-exchange-announcements-response.js +4 -4
- package/dist/esm/models/get-exchange-schedule-response.d.ts +6 -6
- package/dist/esm/models/get-exchange-schedule-response.js +4 -4
- package/dist/esm/models/get-fills-response.d.ts +6 -6
- package/dist/esm/models/get-fills-response.js +4 -4
- package/dist/esm/models/get-filters-by-sports-response.d.ts +24 -0
- package/dist/esm/models/get-filters-by-sports-response.js +14 -0
- package/dist/esm/models/get-incentive-programs-response.d.ts +19 -0
- package/dist/esm/models/get-incentive-programs-response.js +14 -0
- package/dist/esm/models/get-live-data-response.d.ts +15 -0
- package/dist/esm/models/get-live-data-response.js +14 -0
- package/dist/esm/models/get-live-datas-response.d.ts +15 -0
- package/dist/esm/models/get-live-datas-response.js +14 -0
- package/dist/esm/models/get-market-candlesticks-response.d.ts +13 -6
- package/dist/esm/models/get-market-candlesticks-response.js +4 -4
- package/dist/esm/models/get-market-orderbook-response.d.ts +6 -6
- package/dist/esm/models/get-market-orderbook-response.js +4 -4
- package/dist/esm/models/get-market-response.d.ts +5 -5
- package/dist/esm/models/get-market-response.js +4 -4
- package/dist/esm/models/get-markets-response.d.ts +6 -6
- package/dist/esm/models/get-markets-response.js +4 -4
- package/dist/esm/models/get-milestone-response.d.ts +5 -5
- package/dist/esm/models/get-milestone-response.js +4 -4
- package/dist/esm/models/get-milestones-response.d.ts +12 -5
- package/dist/esm/models/get-milestones-response.js +4 -4
- package/dist/esm/models/get-multivariate-event-collection-lookup-history-response.d.ts +18 -0
- package/dist/esm/models/get-multivariate-event-collection-lookup-history-response.js +14 -0
- package/dist/esm/models/get-multivariate-event-collection-response.d.ts +5 -5
- package/dist/esm/models/get-multivariate-event-collection-response.js +4 -4
- package/dist/esm/models/get-multivariate-event-collections-response.d.ts +12 -5
- package/dist/esm/models/get-multivariate-event-collections-response.js +4 -4
- package/dist/esm/models/get-multivariate-events-response.d.ts +22 -0
- package/dist/esm/models/get-multivariate-events-response.js +14 -0
- package/dist/esm/models/get-order-group-response.d.ts +6 -6
- package/dist/esm/models/get-order-group-response.js +4 -4
- package/dist/esm/models/get-order-groups-response.d.ts +4 -5
- package/dist/esm/models/get-order-groups-response.js +4 -4
- package/dist/esm/models/get-order-queue-position-response.d.ts +8 -5
- package/dist/esm/models/get-order-queue-position-response.js +4 -4
- package/dist/esm/models/get-order-queue-positions-response.d.ts +18 -0
- package/dist/esm/models/get-order-queue-positions-response.js +14 -0
- package/dist/esm/models/get-order-response.d.ts +4 -4
- package/dist/esm/models/get-order-response.js +4 -4
- package/dist/esm/models/get-orders-response.d.ts +6 -6
- package/dist/esm/models/get-orders-response.js +4 -4
- package/dist/esm/models/get-portfolio-resting-order-total-value-response.d.ts +17 -0
- package/dist/esm/models/get-portfolio-resting-order-total-value-response.js +14 -0
- package/dist/esm/models/get-positions-response.d.ts +16 -7
- package/dist/esm/models/get-positions-response.js +4 -4
- package/dist/esm/models/get-quote-response.d.ts +5 -5
- package/dist/esm/models/get-quote-response.js +4 -4
- package/dist/esm/models/get-quotes-response.d.ts +12 -5
- package/dist/esm/models/get-quotes-response.js +4 -4
- package/dist/esm/models/get-rfqresponse.d.ts +5 -5
- package/dist/esm/models/get-rfqresponse.js +4 -4
- package/dist/esm/models/get-rfqs-response.d.ts +12 -5
- package/dist/esm/models/get-rfqs-response.js +4 -4
- package/dist/esm/models/get-series-fee-changes-response.d.ts +15 -0
- package/dist/esm/models/get-series-fee-changes-response.js +14 -0
- package/dist/esm/models/get-series-list-response.d.ts +15 -0
- package/dist/esm/models/get-series-list-response.js +14 -0
- package/dist/esm/models/get-series-response.d.ts +5 -5
- package/dist/esm/models/get-series-response.js +4 -4
- package/dist/esm/models/get-settlements-response.d.ts +5 -5
- package/dist/esm/models/get-settlements-response.js +4 -4
- package/dist/esm/models/get-structured-target-response.d.ts +4 -4
- package/dist/esm/models/get-structured-target-response.js +4 -4
- package/dist/esm/models/get-structured-targets-response.d.ts +8 -4
- package/dist/esm/models/get-structured-targets-response.js +4 -4
- package/dist/esm/models/get-tags-for-series-categories-response.d.ts +19 -0
- package/dist/esm/models/get-tags-for-series-categories-response.js +14 -0
- package/dist/esm/models/get-trades-response.d.ts +6 -6
- package/dist/esm/models/get-trades-response.js +4 -4
- package/dist/esm/models/get-user-data-timestamp-response.d.ts +8 -5
- package/dist/esm/models/get-user-data-timestamp-response.js +4 -4
- package/dist/esm/models/incentive-program.d.ts +54 -0
- package/dist/esm/models/incentive-program.js +17 -0
- package/dist/esm/models/index.d.ts +47 -17
- package/dist/esm/models/index.js +47 -17
- package/dist/esm/models/live-data.d.ts +27 -0
- package/dist/esm/models/live-data.js +14 -0
- package/dist/esm/models/lookup-point.d.ts +30 -0
- package/dist/esm/models/lookup-point.js +14 -0
- package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-request.d.ts +18 -0
- package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-request.js +14 -0
- package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-response.d.ts +21 -0
- package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-response.js +14 -0
- package/dist/esm/models/maintenance-window.d.ts +21 -0
- package/dist/esm/models/maintenance-window.js +14 -0
- package/dist/esm/models/market-candlestick.d.ts +30 -0
- package/dist/esm/models/market-candlestick.js +14 -0
- package/dist/esm/models/market-candlesticks-response.d.ts +22 -0
- package/dist/esm/models/market-candlesticks-response.js +14 -0
- package/dist/esm/models/market-metadata.d.ts +25 -0
- package/dist/esm/models/market-metadata.js +14 -0
- package/dist/esm/models/market-position.d.ts +61 -0
- package/dist/esm/models/market-position.js +14 -0
- package/dist/esm/models/market.d.ts +219 -26
- package/dist/esm/models/market.js +21 -4
- package/dist/esm/models/milestone.d.ts +54 -7
- package/dist/esm/models/milestone.js +4 -4
- package/dist/esm/models/multivariate-event-collection.d.ts +61 -9
- package/dist/esm/models/multivariate-event-collection.js +4 -4
- package/dist/esm/models/mve-selected-leg.d.ts +25 -0
- package/dist/esm/models/mve-selected-leg.js +14 -0
- package/dist/esm/models/order-group.d.ts +5 -5
- package/dist/esm/models/order-group.js +4 -4
- package/dist/esm/models/order-queue-position.d.ts +25 -0
- package/dist/esm/models/order-queue-position.js +14 -0
- package/dist/esm/models/order-status.d.ts +20 -0
- package/dist/esm/models/order-status.js +21 -0
- package/dist/esm/models/order.d.ts +75 -29
- package/dist/esm/models/order.js +4 -10
- package/dist/esm/models/orderbook.d.ts +17 -0
- package/dist/esm/models/orderbook.js +14 -0
- package/dist/esm/models/percentile-point.d.ts +29 -0
- package/dist/esm/models/percentile-point.js +14 -0
- package/dist/esm/models/price-distribution.d.ts +77 -0
- package/dist/esm/models/price-distribution.js +14 -0
- package/dist/esm/models/price-range.d.ts +25 -0
- package/dist/esm/models/price-range.js +14 -0
- package/dist/esm/models/quote.d.ts +116 -17
- package/dist/esm/models/quote.js +14 -7
- package/dist/esm/models/rfq.d.ts +65 -16
- package/dist/esm/models/rfq.js +7 -7
- package/dist/esm/models/schedule.d.ts +23 -0
- package/dist/esm/models/schedule.js +14 -0
- package/dist/esm/models/scope-list.d.ts +17 -0
- package/dist/esm/models/scope-list.js +14 -0
- package/dist/esm/models/self-trade-prevention-type.d.ts +19 -0
- package/dist/esm/models/self-trade-prevention-type.js +20 -0
- package/dist/esm/models/series-fee-change.d.ts +39 -0
- package/dist/esm/models/series-fee-change.js +18 -0
- package/dist/esm/models/series.d.ts +57 -9
- package/dist/esm/models/series.js +9 -5
- package/dist/esm/models/settlement-source.d.ts +21 -0
- package/dist/esm/models/settlement-source.js +14 -0
- package/dist/esm/models/settlement.d.ts +48 -12
- package/dist/esm/models/settlement.js +8 -6
- package/dist/esm/models/sport-filter-details.d.ts +24 -0
- package/dist/esm/models/sport-filter-details.js +14 -0
- package/dist/esm/models/structured-target.d.ts +28 -7
- package/dist/esm/models/structured-target.js +4 -4
- package/dist/esm/models/ticker-pair.d.ts +30 -0
- package/dist/esm/models/ticker-pair.js +17 -0
- package/dist/esm/models/trade.d.ts +45 -11
- package/dist/esm/models/trade.js +6 -6
- package/dist/esm/models/weekly-schedule.d.ts +50 -0
- package/dist/esm/models/weekly-schedule.js +14 -0
- package/dist/index.d.ts +4 -4
- package/dist/index.js +4 -4
- package/dist/models/accept-quote-request.d.ts +13 -5
- package/dist/models/accept-quote-request.js +9 -4
- package/dist/models/amend-order-request.d.ts +27 -10
- package/dist/models/amend-order-request.js +4 -4
- package/dist/models/amend-order-response.d.ts +6 -5
- package/dist/models/amend-order-response.js +4 -4
- package/dist/models/announcement.d.ts +25 -13
- package/dist/models/announcement.js +9 -9
- package/dist/models/api-key.d.ts +4 -8
- package/dist/models/api-key.js +4 -4
- package/dist/models/associated-event.d.ts +33 -0
- package/dist/models/associated-event.js +15 -0
- package/dist/models/batch-cancel-orders-individual-response.d.ts +25 -0
- package/dist/models/batch-cancel-orders-individual-response.js +15 -0
- package/dist/models/batch-cancel-orders-request.d.ts +8 -5
- package/dist/models/batch-cancel-orders-request.js +4 -4
- package/dist/models/batch-cancel-orders-response.d.ts +6 -6
- package/dist/models/batch-cancel-orders-response.js +4 -4
- package/dist/models/batch-create-orders-individual-response.d.ts +18 -0
- package/dist/models/batch-create-orders-individual-response.js +15 -0
- package/dist/models/batch-create-orders-request.d.ts +4 -4
- package/dist/models/batch-create-orders-request.js +4 -4
- package/dist/models/batch-create-orders-response.d.ts +6 -6
- package/dist/models/batch-create-orders-response.js +4 -4
- package/dist/models/batch-get-market-candlesticks-response.d.ts +18 -0
- package/dist/models/batch-get-market-candlesticks-response.js +15 -0
- package/dist/models/bid-ask-distribution.d.ts +45 -0
- package/dist/models/bid-ask-distribution.js +15 -0
- package/dist/models/cancel-order-response.d.ts +6 -6
- package/dist/models/cancel-order-response.js +4 -4
- package/dist/models/create-api-key-request.d.ts +4 -4
- package/dist/models/create-api-key-request.js +4 -4
- package/dist/models/create-api-key-response.d.ts +4 -4
- package/dist/models/create-api-key-response.js +4 -4
- package/dist/models/create-market-in-multivariate-event-collection-request.d.ts +18 -0
- package/dist/models/create-market-in-multivariate-event-collection-request.js +15 -0
- package/dist/models/create-market-in-multivariate-event-collection-response.d.ts +21 -0
- package/dist/models/create-market-in-multivariate-event-collection-response.js +15 -0
- package/dist/models/create-order-group-request.d.ts +5 -5
- package/dist/models/create-order-group-request.js +4 -4
- package/dist/models/create-order-group-response.d.ts +5 -5
- package/dist/models/create-order-group-response.js +4 -4
- package/dist/models/create-order-request.d.ts +34 -9
- package/dist/models/create-order-request.js +10 -5
- package/dist/models/create-order-response.d.ts +5 -5
- package/dist/models/create-order-response.js +4 -4
- package/dist/models/create-quote-request.d.ts +19 -6
- package/dist/models/create-quote-request.js +4 -4
- package/dist/models/create-quote-response.d.ts +8 -6
- package/dist/models/create-quote-response.js +4 -4
- package/dist/models/create-rfqrequest.d.ts +28 -13
- package/dist/models/create-rfqrequest.js +4 -9
- package/dist/models/create-rfqresponse.d.ts +8 -6
- package/dist/models/create-rfqresponse.js +4 -4
- package/dist/models/daily-schedule.d.ts +12 -6
- package/dist/models/daily-schedule.js +4 -4
- package/dist/models/decrease-order-request.d.ts +6 -5
- package/dist/models/decrease-order-request.js +4 -4
- package/dist/models/decrease-order-response.d.ts +5 -5
- package/dist/models/decrease-order-response.js +4 -4
- package/dist/models/error-response.d.ts +20 -6
- package/dist/models/error-response.js +4 -4
- package/dist/models/event-data.d.ts +62 -0
- package/dist/models/event-data.js +15 -0
- package/dist/models/event-position.d.ts +24 -24
- package/dist/models/event-position.js +4 -4
- package/dist/models/exchange-status.d.ts +16 -6
- package/dist/models/exchange-status.js +4 -4
- package/dist/models/fill.d.ts +71 -12
- package/dist/models/fill.js +4 -4
- package/dist/models/forecast-percentiles-point.d.ts +30 -0
- package/dist/models/forecast-percentiles-point.js +15 -0
- package/dist/models/generate-api-key-request.d.ts +4 -4
- package/dist/models/generate-api-key-request.js +4 -4
- package/dist/models/generate-api-key-response.d.ts +4 -4
- package/dist/models/generate-api-key-response.js +4 -4
- package/dist/models/get-api-keys-response.d.ts +4 -4
- package/dist/models/get-api-keys-response.js +4 -4
- package/dist/models/get-balance-response.d.ts +14 -6
- package/dist/models/get-balance-response.js +4 -4
- package/dist/models/get-communications-idresponse.d.ts +6 -6
- package/dist/models/get-communications-idresponse.js +4 -4
- package/dist/models/get-event-candlesticks-response.d.ts +26 -0
- package/dist/models/get-event-candlesticks-response.js +15 -0
- package/dist/models/get-event-forecast-percentiles-history-response.d.ts +18 -0
- package/dist/models/get-event-forecast-percentiles-history-response.js +15 -0
- package/dist/models/get-event-metadata-response.d.ts +30 -5
- package/dist/models/get-event-metadata-response.js +4 -4
- package/dist/models/get-event-response.d.ts +10 -7
- package/dist/models/get-event-response.js +4 -4
- package/dist/models/get-events-candlesticks-response-events-inner.d.ts +30 -0
- package/dist/models/get-events-candlesticks-response-events-inner.js +15 -0
- package/dist/models/get-events-candlesticks-response.d.ts +18 -0
- package/dist/models/get-events-candlesticks-response.js +15 -0
- package/dist/models/get-events-response.d.ts +18 -7
- package/dist/models/get-events-response.js +4 -4
- package/dist/models/get-exchange-announcements-response.d.ts +8 -5
- package/dist/models/get-exchange-announcements-response.js +4 -4
- package/dist/models/get-exchange-schedule-response.d.ts +6 -6
- package/dist/models/get-exchange-schedule-response.js +4 -4
- package/dist/models/get-fills-response.d.ts +6 -6
- package/dist/models/get-fills-response.js +4 -4
- package/dist/models/get-filters-by-sports-response.d.ts +24 -0
- package/dist/models/get-filters-by-sports-response.js +15 -0
- package/dist/models/get-incentive-programs-response.d.ts +19 -0
- package/dist/models/get-incentive-programs-response.js +15 -0
- package/dist/models/get-live-data-response.d.ts +15 -0
- package/dist/models/get-live-data-response.js +15 -0
- package/dist/models/get-live-datas-response.d.ts +15 -0
- package/dist/models/get-live-datas-response.js +15 -0
- package/dist/models/get-market-candlesticks-response.d.ts +13 -6
- package/dist/models/get-market-candlesticks-response.js +4 -4
- package/dist/models/get-market-orderbook-response.d.ts +6 -6
- package/dist/models/get-market-orderbook-response.js +4 -4
- package/dist/models/get-market-response.d.ts +5 -5
- package/dist/models/get-market-response.js +4 -4
- package/dist/models/get-markets-response.d.ts +6 -6
- package/dist/models/get-markets-response.js +4 -4
- package/dist/models/get-milestone-response.d.ts +5 -5
- package/dist/models/get-milestone-response.js +4 -4
- package/dist/models/get-milestones-response.d.ts +12 -5
- package/dist/models/get-milestones-response.js +4 -4
- package/dist/models/get-multivariate-event-collection-lookup-history-response.d.ts +18 -0
- package/dist/models/get-multivariate-event-collection-lookup-history-response.js +15 -0
- package/dist/models/get-multivariate-event-collection-response.d.ts +5 -5
- package/dist/models/get-multivariate-event-collection-response.js +4 -4
- package/dist/models/get-multivariate-event-collections-response.d.ts +12 -5
- package/dist/models/get-multivariate-event-collections-response.js +4 -4
- package/dist/models/get-multivariate-events-response.d.ts +22 -0
- package/dist/models/get-multivariate-events-response.js +15 -0
- package/dist/models/get-order-group-response.d.ts +6 -6
- package/dist/models/get-order-group-response.js +4 -4
- package/dist/models/get-order-groups-response.d.ts +4 -5
- package/dist/models/get-order-groups-response.js +4 -4
- package/dist/models/get-order-queue-position-response.d.ts +8 -5
- package/dist/models/get-order-queue-position-response.js +4 -4
- package/dist/models/get-order-queue-positions-response.d.ts +18 -0
- package/dist/models/get-order-queue-positions-response.js +15 -0
- package/dist/models/get-order-response.d.ts +4 -4
- package/dist/models/get-order-response.js +4 -4
- package/dist/models/get-orders-response.d.ts +6 -6
- package/dist/models/get-orders-response.js +4 -4
- package/dist/models/get-portfolio-resting-order-total-value-response.d.ts +17 -0
- package/dist/models/get-portfolio-resting-order-total-value-response.js +15 -0
- package/dist/models/get-positions-response.d.ts +16 -7
- package/dist/models/get-positions-response.js +4 -4
- package/dist/models/get-quote-response.d.ts +5 -5
- package/dist/models/get-quote-response.js +4 -4
- package/dist/models/get-quotes-response.d.ts +12 -5
- package/dist/models/get-quotes-response.js +4 -4
- package/dist/models/get-rfqresponse.d.ts +5 -5
- package/dist/models/get-rfqresponse.js +4 -4
- package/dist/models/get-rfqs-response.d.ts +12 -5
- package/dist/models/get-rfqs-response.js +4 -4
- package/dist/models/get-series-fee-changes-response.d.ts +15 -0
- package/dist/models/get-series-fee-changes-response.js +15 -0
- package/dist/models/get-series-list-response.d.ts +15 -0
- package/dist/models/get-series-list-response.js +15 -0
- package/dist/models/get-series-response.d.ts +5 -5
- package/dist/models/get-series-response.js +4 -4
- package/dist/models/get-settlements-response.d.ts +5 -5
- package/dist/models/get-settlements-response.js +4 -4
- package/dist/models/get-structured-target-response.d.ts +4 -4
- package/dist/models/get-structured-target-response.js +4 -4
- package/dist/models/get-structured-targets-response.d.ts +8 -4
- package/dist/models/get-structured-targets-response.js +4 -4
- package/dist/models/get-tags-for-series-categories-response.d.ts +19 -0
- package/dist/models/get-tags-for-series-categories-response.js +15 -0
- package/dist/models/get-trades-response.d.ts +6 -6
- package/dist/models/get-trades-response.js +4 -4
- package/dist/models/get-user-data-timestamp-response.d.ts +8 -5
- package/dist/models/get-user-data-timestamp-response.js +4 -4
- package/dist/models/incentive-program.d.ts +54 -0
- package/dist/models/incentive-program.js +20 -0
- package/dist/models/index.d.ts +47 -17
- package/dist/models/index.js +47 -17
- package/dist/models/live-data.d.ts +27 -0
- package/dist/models/live-data.js +15 -0
- package/dist/models/lookup-point.d.ts +30 -0
- package/dist/models/lookup-point.js +15 -0
- package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-request.d.ts +18 -0
- package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-request.js +15 -0
- package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-response.d.ts +21 -0
- package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-response.js +15 -0
- package/dist/models/maintenance-window.d.ts +21 -0
- package/dist/models/maintenance-window.js +15 -0
- package/dist/models/market-candlestick.d.ts +30 -0
- package/dist/models/market-candlestick.js +15 -0
- package/dist/models/market-candlesticks-response.d.ts +22 -0
- package/dist/models/market-candlesticks-response.js +15 -0
- package/dist/models/market-metadata.d.ts +25 -0
- package/dist/models/market-metadata.js +15 -0
- package/dist/models/market-position.d.ts +61 -0
- package/dist/models/market-position.js +15 -0
- package/dist/models/market.d.ts +219 -26
- package/dist/models/market.js +22 -5
- package/dist/models/milestone.d.ts +54 -7
- package/dist/models/milestone.js +4 -4
- package/dist/models/multivariate-event-collection.d.ts +61 -9
- package/dist/models/multivariate-event-collection.js +4 -4
- package/dist/models/mve-selected-leg.d.ts +25 -0
- package/dist/models/mve-selected-leg.js +15 -0
- package/dist/models/order-group.d.ts +5 -5
- package/dist/models/order-group.js +4 -4
- package/dist/models/order-queue-position.d.ts +25 -0
- package/dist/models/order-queue-position.js +15 -0
- package/dist/models/order-status.d.ts +20 -0
- package/dist/models/order-status.js +24 -0
- package/dist/models/order.d.ts +75 -29
- package/dist/models/order.js +5 -11
- package/dist/models/orderbook.d.ts +17 -0
- package/dist/models/orderbook.js +15 -0
- package/dist/models/percentile-point.d.ts +29 -0
- package/dist/models/percentile-point.js +15 -0
- package/dist/models/price-distribution.d.ts +77 -0
- package/dist/models/price-distribution.js +15 -0
- package/dist/models/price-range.d.ts +25 -0
- package/dist/models/price-range.js +15 -0
- package/dist/models/quote.d.ts +116 -17
- package/dist/models/quote.js +15 -8
- package/dist/models/rfq.d.ts +65 -16
- package/dist/models/rfq.js +8 -8
- package/dist/models/schedule.d.ts +23 -0
- package/dist/models/schedule.js +15 -0
- package/dist/models/scope-list.d.ts +17 -0
- package/dist/models/scope-list.js +15 -0
- package/dist/models/self-trade-prevention-type.d.ts +19 -0
- package/dist/models/self-trade-prevention-type.js +23 -0
- package/dist/models/series-fee-change.d.ts +39 -0
- package/dist/models/series-fee-change.js +21 -0
- package/dist/models/series.d.ts +57 -9
- package/dist/models/series.js +10 -4
- package/dist/models/settlement-source.d.ts +21 -0
- package/dist/models/settlement-source.js +15 -0
- package/dist/models/settlement.d.ts +48 -12
- package/dist/models/settlement.js +9 -7
- package/dist/models/sport-filter-details.d.ts +24 -0
- package/dist/models/sport-filter-details.js +15 -0
- package/dist/models/structured-target.d.ts +28 -7
- package/dist/models/structured-target.js +4 -4
- package/dist/models/ticker-pair.d.ts +30 -0
- package/dist/models/ticker-pair.js +20 -0
- package/dist/models/trade.d.ts +45 -11
- package/dist/models/trade.js +6 -6
- package/dist/models/weekly-schedule.d.ts +50 -0
- package/dist/models/weekly-schedule.js +15 -0
- package/docs/AcceptQuoteRequest.md +2 -2
- package/docs/AmendOrderRequest.md +12 -8
- package/docs/AmendOrderResponse.md +3 -1
- package/docs/Announcement.md +6 -6
- package/docs/ApiKey.md +0 -2
- package/docs/ApiKeysApi.md +16 -106
- package/docs/AssociatedEvent.md +28 -0
- package/docs/BatchCancelOrdersIndividualResponse.md +26 -0
- package/docs/BatchCancelOrdersRequest.md +2 -2
- package/docs/BatchCancelOrdersResponse.md +2 -2
- package/docs/BatchCreateOrdersIndividualResponse.md +24 -0
- package/docs/BatchCreateOrdersResponse.md +2 -2
- package/docs/BatchGetMarketCandlesticksResponse.md +20 -0
- package/docs/BidAskDistribution.md +34 -0
- package/docs/CancelOrderResponse.md +2 -2
- package/docs/CollectionApi.md +318 -0
- package/docs/CommunicationsApi.md +46 -271
- package/docs/CreateMarketInMultivariateEventCollectionRequest.md +20 -0
- package/docs/CreateMarketInMultivariateEventCollectionResponse.md +22 -0
- package/docs/CreateOrderGroupRequest.md +1 -1
- package/docs/CreateOrderGroupResponse.md +1 -1
- package/docs/CreateOrderRequest.md +18 -6
- package/docs/CreateOrderResponse.md +1 -1
- package/docs/CreateQuoteRequest.md +7 -5
- package/docs/CreateQuoteResponse.md +2 -2
- package/docs/CreateRFQRequest.md +12 -8
- package/docs/CreateRFQResponse.md +2 -2
- package/docs/DailySchedule.md +2 -2
- package/docs/DecreaseOrderRequest.md +3 -1
- package/docs/DecreaseOrderResponse.md +1 -1
- package/docs/ErrorResponse.md +8 -2
- package/docs/EventData.md +42 -0
- package/docs/EventPosition.md +11 -11
- package/docs/EventsApi.md +133 -93
- package/docs/ExchangeApi.md +42 -83
- package/docs/ExchangeStatus.md +4 -2
- package/docs/FcmApi.md +92 -0
- package/docs/Fill.md +25 -9
- package/docs/ForecastPercentilesPoint.md +26 -0
- package/docs/GetBalanceResponse.md +5 -1
- package/docs/GetCommunicationsIDResponse.md +1 -1
- package/docs/GetEventCandlesticksResponse.md +24 -0
- package/docs/GetEventForecastPercentilesHistoryResponse.md +20 -0
- package/docs/GetEventMetadataResponse.md +12 -2
- package/docs/GetEventResponse.md +2 -2
- package/docs/GetEventsCandlesticksResponse.md +20 -0
- package/docs/GetEventsCandlesticksResponseEventsInner.md +26 -0
- package/docs/GetEventsResponse.md +4 -2
- package/docs/GetExchangeAnnouncementsResponse.md +1 -1
- package/docs/GetExchangeScheduleResponse.md +1 -1
- package/docs/GetFillsResponse.md +2 -2
- package/docs/GetFiltersBySportsResponse.md +22 -0
- package/docs/GetIncentiveProgramsResponse.md +22 -0
- package/docs/GetLiveDataResponse.md +20 -0
- package/docs/GetLiveDatasResponse.md +20 -0
- package/docs/GetMarketCandlesticksResponse.md +3 -1
- package/docs/GetMarketOrderbookResponse.md +1 -1
- package/docs/GetMarketResponse.md +1 -1
- package/docs/GetMarketsResponse.md +2 -2
- package/docs/GetMilestoneResponse.md +1 -1
- package/docs/GetMilestonesResponse.md +3 -1
- package/docs/GetMultivariateEventCollectionLookupHistoryResponse.md +20 -0
- package/docs/GetMultivariateEventCollectionResponse.md +2 -2
- package/docs/GetMultivariateEventCollectionsResponse.md +4 -2
- package/docs/GetMultivariateEventsResponse.md +22 -0
- package/docs/GetOrderGroupResponse.md +2 -2
- package/docs/GetOrderGroupsResponse.md +0 -2
- package/docs/GetOrderQueuePositionResponse.md +1 -1
- package/docs/GetOrderQueuePositionsResponse.md +20 -0
- package/docs/GetOrdersResponse.md +2 -2
- package/docs/GetPortfolioRestingOrderTotalValueResponse.md +20 -0
- package/docs/GetPositionsResponse.md +4 -4
- package/docs/GetQuoteResponse.md +1 -1
- package/docs/GetQuotesResponse.md +3 -1
- package/docs/GetRFQResponse.md +1 -1
- package/docs/GetRFQsResponse.md +3 -1
- package/docs/GetSeriesFeeChangesResponse.md +20 -0
- package/docs/GetSeriesListResponse.md +20 -0
- package/docs/GetSeriesResponse.md +1 -1
- package/docs/GetSettlementsResponse.md +1 -1
- package/docs/GetStructuredTargetsResponse.md +2 -0
- package/docs/GetTagsForSeriesCategoriesResponse.md +20 -0
- package/docs/GetTradesResponse.md +2 -2
- package/docs/GetUserDataTimestampResponse.md +2 -2
- package/docs/IncentiveProgram.md +36 -0
- package/docs/IncentiveProgramsApi.md +44 -0
- package/docs/LiveData.md +24 -0
- package/docs/LiveDataApi.md +75 -0
- package/docs/LookupPoint.md +26 -0
- package/docs/LookupTickersForMarketInMultivariateEventCollectionRequest.md +20 -0
- package/docs/LookupTickersForMarketInMultivariateEventCollectionResponse.md +22 -0
- package/docs/MaintenanceWindow.md +22 -0
- package/docs/Market.md +105 -21
- package/docs/MarketApi.md +311 -0
- package/docs/MarketCandlestick.md +30 -0
- package/docs/MarketCandlesticksResponse.md +22 -0
- package/docs/MarketMetadata.md +24 -0
- package/docs/MarketPosition.md +42 -0
- package/docs/MarketsApi.md +3 -4
- package/docs/Milestone.md +23 -5
- package/docs/MilestoneApi.md +85 -0
- package/docs/MilestonesApi.md +0 -1
- package/docs/MultivariateApi.md +188 -0
- package/docs/MultivariateCollectionsApi.md +0 -1
- package/docs/MultivariateEventCollection.md +26 -6
- package/docs/MveSelectedLeg.md +24 -0
- package/docs/Order.md +42 -18
- package/docs/OrderGroup.md +1 -1
- package/docs/OrderGroupsApi.md +180 -0
- package/docs/OrderQueuePosition.md +24 -0
- package/docs/OrderStatus.md +13 -0
- package/docs/Orderbook.md +26 -0
- package/docs/OrdersApi.md +372 -0
- package/docs/PercentilePoint.md +26 -0
- package/docs/PortfolioApi.md +27 -1062
- package/docs/PriceDistribution.md +50 -0
- package/docs/PriceRange.md +24 -0
- package/docs/Quote.md +48 -16
- package/docs/RFQ.md +26 -14
- package/docs/Schedule.md +22 -0
- package/docs/ScopeList.md +20 -0
- package/docs/SearchApi.md +69 -0
- package/docs/SelfTradePreventionType.md +11 -0
- package/docs/Series.md +21 -5
- package/docs/SeriesApi.md +0 -1
- package/docs/SeriesFeeChange.md +28 -0
- package/docs/Settlement.md +15 -7
- package/docs/SettlementSource.md +22 -0
- package/docs/SportFilterDetails.md +22 -0
- package/docs/StructuredTarget.md +12 -6
- package/docs/StructuredTargetsApi.md +11 -57
- package/docs/TickerPair.md +24 -0
- package/docs/Trade.md +14 -6
- package/docs/WeeklySchedule.md +36 -0
- package/index.ts +4 -4
- package/models/accept-quote-request.ts +16 -5
- package/models/amend-order-request.ts +27 -10
- package/models/amend-order-response.ts +6 -5
- package/models/announcement.ts +26 -14
- package/models/api-key.ts +4 -8
- package/models/associated-event.ts +39 -0
- package/models/batch-cancel-orders-individual-response.ts +35 -0
- package/models/batch-cancel-orders-request.ts +8 -5
- package/models/batch-cancel-orders-response-responses-inner.ts +0 -1
- package/models/batch-cancel-orders-response.ts +6 -6
- package/models/batch-create-orders-individual-response.ts +28 -0
- package/models/batch-create-orders-request.ts +4 -4
- package/models/batch-create-orders-response-responses-inner.ts +0 -1
- package/models/batch-create-orders-response.ts +6 -6
- package/models/batch-get-market-candlesticks-response.ts +26 -0
- package/models/bid-ask-distribution.ts +51 -0
- package/models/cancel-order-response.ts +6 -6
- package/models/candlestick.ts +0 -1
- package/models/create-api-key-request.ts +4 -4
- package/models/create-api-key-response.ts +4 -4
- package/models/create-market-in-multivariate-event-collection-request.ts +26 -0
- package/models/create-market-in-multivariate-event-collection-response.ts +27 -0
- package/models/create-order-group-request.ts +5 -5
- package/models/create-order-group-response.ts +5 -5
- package/models/create-order-request.ts +37 -9
- package/models/create-order-response.ts +5 -5
- package/models/create-quote-request.ts +19 -6
- package/models/create-quote-response.ts +8 -8
- package/models/create-rfqrequest.ts +28 -16
- package/models/create-rfqresponse.ts +8 -8
- package/models/daily-schedule.ts +12 -6
- package/models/decrease-order-request.ts +6 -5
- package/models/decrease-order-response.ts +5 -5
- package/models/error-response-error.ts +0 -1
- package/models/error-response.ts +20 -8
- package/models/event-data.ts +70 -0
- package/models/event-position.ts +24 -24
- package/models/event.ts +0 -2
- package/models/exchange-status.ts +16 -6
- package/models/fill.ts +71 -12
- package/models/forecast-percentiles-point.ts +38 -0
- package/models/generate-api-key-request.ts +4 -4
- package/models/generate-api-key-response.ts +4 -4
- package/models/get-api-keys-response.ts +4 -4
- package/models/get-balance-response.ts +14 -6
- package/models/get-communications-idresponse.ts +6 -6
- package/models/get-event-candlesticks-response.ts +34 -0
- package/models/get-event-forecast-percentiles-history-response.ts +26 -0
- package/models/get-event-metadata-response.ts +34 -5
- package/models/get-event-response.ts +10 -7
- package/models/get-events-candlesticks-response-events-inner.ts +38 -0
- package/models/get-events-candlesticks-response.ts +26 -0
- package/models/get-events-response.ts +20 -7
- package/models/get-exchange-announcements-response.ts +8 -5
- package/models/get-exchange-schedule-response-schedule.ts +0 -1
- package/models/get-exchange-schedule-response.ts +6 -6
- package/models/get-fills-response.ts +6 -6
- package/models/get-filters-by-sports-response.ts +30 -0
- package/models/get-incentive-programs-response.ts +27 -0
- package/models/get-live-data-response.ts +23 -0
- package/models/get-live-datas-response.ts +23 -0
- package/models/get-market-candlesticks-response.ts +13 -6
- package/models/get-market-orderbook-response-orderbook.ts +0 -1
- package/models/get-market-orderbook-response.ts +6 -6
- package/models/get-market-response.ts +5 -5
- package/models/get-markets-response.ts +6 -6
- package/models/get-milestone-response.ts +5 -5
- package/models/get-milestones-response.ts +12 -5
- package/models/get-multivariate-event-collection-lookup-history-response.ts +26 -0
- package/models/get-multivariate-event-collection-response.ts +5 -5
- package/models/get-multivariate-event-collections-response.ts +12 -5
- package/models/get-multivariate-events-response.ts +30 -0
- package/models/get-order-group-response.ts +6 -6
- package/models/get-order-groups-response.ts +4 -5
- package/models/get-order-queue-position-response.ts +8 -5
- package/models/get-order-queue-positions-response.ts +26 -0
- package/models/get-order-response.ts +4 -4
- package/models/get-orders-response.ts +6 -6
- package/models/get-portfolio-resting-order-total-value-response.ts +23 -0
- package/models/get-positions-response.ts +16 -7
- package/models/get-queue-positions-request.ts +0 -1
- package/models/get-queue-positions-response.ts +0 -1
- package/models/get-quote-response.ts +5 -5
- package/models/get-quotes-response.ts +12 -5
- package/models/get-rfqresponse.ts +5 -5
- package/models/get-rfqs-response.ts +12 -5
- package/models/get-series-by-ticker-response.ts +0 -1
- package/models/get-series-fee-changes-response.ts +23 -0
- package/models/get-series-list-response.ts +23 -0
- package/models/get-series-response.ts +5 -5
- package/models/get-settlements-response.ts +5 -5
- package/models/get-structured-target-response.ts +4 -4
- package/models/get-structured-targets-response.ts +8 -4
- package/models/get-tags-for-series-categories-response.ts +23 -0
- package/models/get-total-resting-order-value-response.ts +0 -1
- package/models/get-trades-response.ts +6 -6
- package/models/get-user-data-timestamp-response.ts +8 -5
- package/models/incentive-program.ts +63 -0
- package/models/index.ts +47 -17
- package/models/live-data.ts +31 -0
- package/models/lookup-bundle-request-bundle-inner.ts +0 -1
- package/models/lookup-bundle-request.ts +0 -1
- package/models/lookup-bundle-response.ts +0 -1
- package/models/lookup-point.ts +38 -0
- package/models/lookup-tickers-for-market-in-multivariate-event-collection-request.ts +26 -0
- package/models/lookup-tickers-for-market-in-multivariate-event-collection-response.ts +27 -0
- package/models/maintenance-window.ts +27 -0
- package/models/market-candlestick.ts +40 -0
- package/models/market-candlesticks-response.ts +30 -0
- package/models/market-metadata.ts +31 -0
- package/models/market-position.ts +67 -0
- package/models/market.ts +226 -26
- package/models/milestone.ts +52 -7
- package/models/multivariate-event-collection-events-inner.ts +0 -1
- package/models/multivariate-event-collection.ts +61 -9
- package/models/mve-selected-leg.ts +31 -0
- package/models/order-group.ts +5 -5
- package/models/order-queue-position.ts +31 -0
- package/models/order-status.ts +30 -0
- package/models/order.ts +79 -30
- package/models/orderbook-level.ts +0 -1
- package/models/orderbook.ts +23 -0
- package/models/percentile-point.ts +35 -0
- package/models/position.ts +0 -2
- package/models/price-distribution.ts +83 -0
- package/models/price-range.ts +31 -0
- package/models/quote.ts +117 -17
- package/models/rfq.ts +67 -16
- package/models/schedule.ts +33 -0
- package/models/scope-list.ts +23 -0
- package/models/self-trade-prevention-type.ts +29 -0
- package/models/series-fee-change.ts +48 -0
- package/models/series.ts +62 -9
- package/models/settlement-source.ts +27 -0
- package/models/settlement.ts +49 -13
- package/models/sport-filter-details.ts +30 -0
- package/models/structured-target.ts +28 -7
- package/models/ticker-pair.ts +39 -0
- package/models/trade.ts +45 -11
- package/models/weekly-schedule.ts +58 -0
- package/package.json +1 -1
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Kalshi
|
|
3
|
-
*
|
|
2
|
+
* Kalshi Trade API Manual Endpoints
|
|
3
|
+
* Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 3.0.0
|
|
4
6
|
*
|
|
5
|
-
* The version of the OpenAPI document: 2.0.0
|
|
6
|
-
* Contact: support@kalshi.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
9
|
* https://openapi-generator.tech
|
|
@@ -12,110 +12,24 @@
|
|
|
12
12
|
import type { Configuration } from '../configuration';
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
|
-
import type { AmendOrderRequest } from '../models';
|
|
16
|
-
import type { AmendOrderResponse } from '../models';
|
|
17
|
-
import type { BatchCancelOrdersRequest } from '../models';
|
|
18
|
-
import type { BatchCancelOrdersResponse } from '../models';
|
|
19
|
-
import type { BatchCreateOrdersRequest } from '../models';
|
|
20
|
-
import type { BatchCreateOrdersResponse } from '../models';
|
|
21
|
-
import type { CancelOrderResponse } from '../models';
|
|
22
|
-
import type { CreateOrderGroupRequest } from '../models';
|
|
23
|
-
import type { CreateOrderGroupResponse } from '../models';
|
|
24
|
-
import type { CreateOrderRequest } from '../models';
|
|
25
|
-
import type { CreateOrderResponse } from '../models';
|
|
26
|
-
import type { DecreaseOrderRequest } from '../models';
|
|
27
|
-
import type { DecreaseOrderResponse } from '../models';
|
|
28
15
|
import type { GetBalanceResponse } from '../models';
|
|
29
16
|
import type { GetFillsResponse } from '../models';
|
|
30
|
-
import type {
|
|
31
|
-
import type { GetOrderGroupsResponse } from '../models';
|
|
32
|
-
import type { GetOrderQueuePositionResponse } from '../models';
|
|
33
|
-
import type { GetOrderResponse } from '../models';
|
|
34
|
-
import type { GetOrdersResponse } from '../models';
|
|
17
|
+
import type { GetPortfolioRestingOrderTotalValueResponse } from '../models';
|
|
35
18
|
import type { GetPositionsResponse } from '../models';
|
|
36
|
-
import type { GetQueuePositionsRequest } from '../models';
|
|
37
|
-
import type { GetQueuePositionsResponse } from '../models';
|
|
38
19
|
import type { GetSettlementsResponse } from '../models';
|
|
39
|
-
import type { GetTotalRestingOrderValueResponse } from '../models';
|
|
40
20
|
/**
|
|
41
21
|
* PortfolioApi - axios parameter creator
|
|
42
22
|
*/
|
|
43
23
|
export declare const PortfolioApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
44
24
|
/**
|
|
45
|
-
*
|
|
46
|
-
* @summary Amend Order
|
|
47
|
-
* @param {string} orderId Order ID
|
|
48
|
-
* @param {AmendOrderRequest} amendOrderRequest
|
|
49
|
-
* @param {*} [options] Override http request option.
|
|
50
|
-
* @throws {RequiredError}
|
|
51
|
-
*/
|
|
52
|
-
amendOrder: (orderId: string, amendOrderRequest: AmendOrderRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
53
|
-
/**
|
|
54
|
-
* Cancel multiple orders in a single request
|
|
55
|
-
* @summary Batch Cancel Orders
|
|
56
|
-
* @param {BatchCancelOrdersRequest} batchCancelOrdersRequest
|
|
57
|
-
* @param {*} [options] Override http request option.
|
|
58
|
-
* @throws {RequiredError}
|
|
59
|
-
*/
|
|
60
|
-
batchCancelOrders: (batchCancelOrdersRequest: BatchCancelOrdersRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
61
|
-
/**
|
|
62
|
-
* Create multiple orders in a single request
|
|
63
|
-
* @summary Batch Create Orders
|
|
64
|
-
* @param {BatchCreateOrdersRequest} batchCreateOrdersRequest
|
|
65
|
-
* @param {*} [options] Override http request option.
|
|
66
|
-
* @throws {RequiredError}
|
|
67
|
-
*/
|
|
68
|
-
batchCreateOrders: (batchCreateOrdersRequest: BatchCreateOrdersRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
|
-
/**
|
|
70
|
-
* Cancel an order
|
|
71
|
-
* @summary Cancel Order
|
|
72
|
-
* @param {string} orderId Order ID
|
|
73
|
-
* @param {*} [options] Override http request option.
|
|
74
|
-
* @throws {RequiredError}
|
|
75
|
-
*/
|
|
76
|
-
cancelOrder: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
77
|
-
/**
|
|
78
|
-
* Create a new order
|
|
79
|
-
* @summary Create Order
|
|
80
|
-
* @param {CreateOrderRequest} createOrderRequest
|
|
81
|
-
* @param {*} [options] Override http request option.
|
|
82
|
-
* @throws {RequiredError}
|
|
83
|
-
*/
|
|
84
|
-
createOrder: (createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
85
|
-
/**
|
|
86
|
-
* Create a new order group
|
|
87
|
-
* @summary Create Order Group
|
|
88
|
-
* @param {CreateOrderGroupRequest} createOrderGroupRequest
|
|
89
|
-
* @param {*} [options] Override http request option.
|
|
90
|
-
* @throws {RequiredError}
|
|
91
|
-
*/
|
|
92
|
-
createOrderGroup: (createOrderGroupRequest: CreateOrderGroupRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
93
|
-
/**
|
|
94
|
-
* Decrease the size of an existing order
|
|
95
|
-
* @summary Decrease Order
|
|
96
|
-
* @param {string} orderId Order ID
|
|
97
|
-
* @param {DecreaseOrderRequest} decreaseOrderRequest
|
|
98
|
-
* @param {*} [options] Override http request option.
|
|
99
|
-
* @throws {RequiredError}
|
|
100
|
-
*/
|
|
101
|
-
decreaseOrder: (orderId: string, decreaseOrderRequest: DecreaseOrderRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
102
|
-
/**
|
|
103
|
-
* Delete an order group
|
|
104
|
-
* @summary Delete Order Group
|
|
105
|
-
* @param {string} orderGroupId Order group ID
|
|
106
|
-
* @param {*} [options] Override http request option.
|
|
107
|
-
* @throws {RequiredError}
|
|
108
|
-
*/
|
|
109
|
-
deleteOrderGroup: (orderGroupId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
110
|
-
/**
|
|
111
|
-
* Get the user\'s current balance
|
|
25
|
+
* Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents.
|
|
112
26
|
* @summary Get Balance
|
|
113
27
|
* @param {*} [options] Override http request option.
|
|
114
28
|
* @throws {RequiredError}
|
|
115
29
|
*/
|
|
116
30
|
getBalance: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
117
31
|
/**
|
|
118
|
-
*
|
|
32
|
+
* Endpoint for getting all fills for the member. A fill is when a trade you have is matched.
|
|
119
33
|
* @summary Get Fills
|
|
120
34
|
* @param {string} [ticker] Filter by market ticker
|
|
121
35
|
* @param {string} [orderId] Filter by order ID
|
|
@@ -128,178 +42,52 @@ export declare const PortfolioApiAxiosParamCreator: (configuration?: Configurati
|
|
|
128
42
|
*/
|
|
129
43
|
getFills: (ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
130
44
|
/**
|
|
131
|
-
*
|
|
132
|
-
* @summary Get Order
|
|
133
|
-
* @param {string} orderId Order ID
|
|
134
|
-
* @param {*} [options] Override http request option.
|
|
135
|
-
* @throws {RequiredError}
|
|
136
|
-
*/
|
|
137
|
-
getOrder: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
138
|
-
/**
|
|
139
|
-
* Get details of a specific order group
|
|
140
|
-
* @summary Get Order Group
|
|
141
|
-
* @param {string} orderGroupId Order group ID
|
|
142
|
-
* @param {*} [options] Override http request option.
|
|
143
|
-
* @throws {RequiredError}
|
|
144
|
-
*/
|
|
145
|
-
getOrderGroup: (orderGroupId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
146
|
-
/**
|
|
147
|
-
* Get order groups for the logged-in user
|
|
148
|
-
* @summary Get Order Groups
|
|
149
|
-
* @param {string} [status] Filter by status. Possible values depend on the endpoint.
|
|
150
|
-
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
|
|
151
|
-
* @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
|
|
152
|
-
* @param {*} [options] Override http request option.
|
|
153
|
-
* @throws {RequiredError}
|
|
154
|
-
*/
|
|
155
|
-
getOrderGroups: (status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
156
|
-
/**
|
|
157
|
-
* Get the queue position for an order
|
|
158
|
-
* @summary Get Order Queue Position
|
|
159
|
-
* @param {string} orderId Order ID
|
|
160
|
-
* @param {*} [options] Override http request option.
|
|
161
|
-
* @throws {RequiredError}
|
|
162
|
-
*/
|
|
163
|
-
getOrderQueuePosition: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
164
|
-
/**
|
|
165
|
-
* Get orders for the logged-in user
|
|
166
|
-
* @summary Get Orders
|
|
167
|
-
* @param {string} [ticker] Filter by market ticker
|
|
168
|
-
* @param {string} [eventTicker] Filter by event ticker
|
|
169
|
-
* @param {number} [minTs] Filter items after this Unix timestamp
|
|
170
|
-
* @param {number} [maxTs] Filter items before this Unix timestamp
|
|
171
|
-
* @param {string} [status] Filter by status. Possible values depend on the endpoint.
|
|
172
|
-
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
|
|
173
|
-
* @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
|
|
45
|
+
* Endpoint for getting the total value, in cents, of resting orders. This endpoint is only intended for use by FCM members (rare). Note: If you\'re uncertain about this endpoint, it likely does not apply to you.
|
|
46
|
+
* @summary Get Total Resting Order Value
|
|
174
47
|
* @param {*} [options] Override http request option.
|
|
175
48
|
* @throws {RequiredError}
|
|
176
49
|
*/
|
|
177
|
-
|
|
50
|
+
getPortfolioRestingOrderTotalValue: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
178
51
|
/**
|
|
179
|
-
*
|
|
52
|
+
* Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted: position, total_traded
|
|
180
53
|
* @summary Get Positions
|
|
54
|
+
* @param {string} [cursor] The Cursor represents a pointer to the next page of records in the pagination. Use the value returned from the previous response to get the next page.
|
|
55
|
+
* @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
|
|
56
|
+
* @param {string} [countFilter] Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted - position, total_traded
|
|
57
|
+
* @param {GetPositionsSettlementStatusEnum} [settlementStatus] Settlement status of the markets to return. Defaults to unsettled.
|
|
181
58
|
* @param {string} [ticker] Filter by market ticker
|
|
182
|
-
* @param {string} [eventTicker]
|
|
183
|
-
* @param {number} [countDown] Filter positions by minimum count down value
|
|
184
|
-
* @param {number} [countUp] Filter positions by minimum count up value
|
|
185
|
-
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
|
|
186
|
-
* @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
|
|
59
|
+
* @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
|
|
187
60
|
* @param {*} [options] Override http request option.
|
|
188
61
|
* @throws {RequiredError}
|
|
189
62
|
*/
|
|
190
|
-
getPositions: (
|
|
63
|
+
getPositions: (cursor?: string, limit?: number, countFilter?: string, settlementStatus?: GetPositionsSettlementStatusEnum, ticker?: string, eventTicker?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
191
64
|
/**
|
|
192
|
-
*
|
|
193
|
-
* @summary Get Queue Positions
|
|
194
|
-
* @param {GetQueuePositionsRequest} getQueuePositionsRequest
|
|
195
|
-
* @param {*} [options] Override http request option.
|
|
196
|
-
* @throws {RequiredError}
|
|
197
|
-
*/
|
|
198
|
-
getQueuePositions: (getQueuePositionsRequest: GetQueuePositionsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
199
|
-
/**
|
|
200
|
-
* Get settlements for the logged-in user
|
|
65
|
+
* Endpoint for getting the member\'s settlements historical track.
|
|
201
66
|
* @summary Get Settlements
|
|
202
67
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
|
|
203
68
|
* @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
|
|
69
|
+
* @param {string} [ticker] Filter by market ticker
|
|
70
|
+
* @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
|
|
71
|
+
* @param {number} [minTs] Filter items after this Unix timestamp
|
|
72
|
+
* @param {number} [maxTs] Filter items before this Unix timestamp
|
|
204
73
|
* @param {*} [options] Override http request option.
|
|
205
74
|
* @throws {RequiredError}
|
|
206
75
|
*/
|
|
207
|
-
getSettlements: (limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
208
|
-
/**
|
|
209
|
-
* Get the total value of all resting orders
|
|
210
|
-
* @summary Get Total Resting Order Value
|
|
211
|
-
* @param {*} [options] Override http request option.
|
|
212
|
-
* @throws {RequiredError}
|
|
213
|
-
*/
|
|
214
|
-
getTotalRestingOrderValue: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
215
|
-
/**
|
|
216
|
-
* Reset an order group
|
|
217
|
-
* @summary Reset Order Group
|
|
218
|
-
* @param {string} orderGroupId Order group ID
|
|
219
|
-
* @param {*} [options] Override http request option.
|
|
220
|
-
* @throws {RequiredError}
|
|
221
|
-
*/
|
|
222
|
-
resetOrderGroup: (orderGroupId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
76
|
+
getSettlements: (limit?: number, cursor?: string, ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
223
77
|
};
|
|
224
78
|
/**
|
|
225
79
|
* PortfolioApi - functional programming interface
|
|
226
80
|
*/
|
|
227
81
|
export declare const PortfolioApiFp: (configuration?: Configuration) => {
|
|
228
82
|
/**
|
|
229
|
-
*
|
|
230
|
-
* @summary Amend Order
|
|
231
|
-
* @param {string} orderId Order ID
|
|
232
|
-
* @param {AmendOrderRequest} amendOrderRequest
|
|
233
|
-
* @param {*} [options] Override http request option.
|
|
234
|
-
* @throws {RequiredError}
|
|
235
|
-
*/
|
|
236
|
-
amendOrder(orderId: string, amendOrderRequest: AmendOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AmendOrderResponse>>;
|
|
237
|
-
/**
|
|
238
|
-
* Cancel multiple orders in a single request
|
|
239
|
-
* @summary Batch Cancel Orders
|
|
240
|
-
* @param {BatchCancelOrdersRequest} batchCancelOrdersRequest
|
|
241
|
-
* @param {*} [options] Override http request option.
|
|
242
|
-
* @throws {RequiredError}
|
|
243
|
-
*/
|
|
244
|
-
batchCancelOrders(batchCancelOrdersRequest: BatchCancelOrdersRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BatchCancelOrdersResponse>>;
|
|
245
|
-
/**
|
|
246
|
-
* Create multiple orders in a single request
|
|
247
|
-
* @summary Batch Create Orders
|
|
248
|
-
* @param {BatchCreateOrdersRequest} batchCreateOrdersRequest
|
|
249
|
-
* @param {*} [options] Override http request option.
|
|
250
|
-
* @throws {RequiredError}
|
|
251
|
-
*/
|
|
252
|
-
batchCreateOrders(batchCreateOrdersRequest: BatchCreateOrdersRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BatchCreateOrdersResponse>>;
|
|
253
|
-
/**
|
|
254
|
-
* Cancel an order
|
|
255
|
-
* @summary Cancel Order
|
|
256
|
-
* @param {string} orderId Order ID
|
|
257
|
-
* @param {*} [options] Override http request option.
|
|
258
|
-
* @throws {RequiredError}
|
|
259
|
-
*/
|
|
260
|
-
cancelOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelOrderResponse>>;
|
|
261
|
-
/**
|
|
262
|
-
* Create a new order
|
|
263
|
-
* @summary Create Order
|
|
264
|
-
* @param {CreateOrderRequest} createOrderRequest
|
|
265
|
-
* @param {*} [options] Override http request option.
|
|
266
|
-
* @throws {RequiredError}
|
|
267
|
-
*/
|
|
268
|
-
createOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderResponse>>;
|
|
269
|
-
/**
|
|
270
|
-
* Create a new order group
|
|
271
|
-
* @summary Create Order Group
|
|
272
|
-
* @param {CreateOrderGroupRequest} createOrderGroupRequest
|
|
273
|
-
* @param {*} [options] Override http request option.
|
|
274
|
-
* @throws {RequiredError}
|
|
275
|
-
*/
|
|
276
|
-
createOrderGroup(createOrderGroupRequest: CreateOrderGroupRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderGroupResponse>>;
|
|
277
|
-
/**
|
|
278
|
-
* Decrease the size of an existing order
|
|
279
|
-
* @summary Decrease Order
|
|
280
|
-
* @param {string} orderId Order ID
|
|
281
|
-
* @param {DecreaseOrderRequest} decreaseOrderRequest
|
|
282
|
-
* @param {*} [options] Override http request option.
|
|
283
|
-
* @throws {RequiredError}
|
|
284
|
-
*/
|
|
285
|
-
decreaseOrder(orderId: string, decreaseOrderRequest: DecreaseOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DecreaseOrderResponse>>;
|
|
286
|
-
/**
|
|
287
|
-
* Delete an order group
|
|
288
|
-
* @summary Delete Order Group
|
|
289
|
-
* @param {string} orderGroupId Order group ID
|
|
290
|
-
* @param {*} [options] Override http request option.
|
|
291
|
-
* @throws {RequiredError}
|
|
292
|
-
*/
|
|
293
|
-
deleteOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
294
|
-
/**
|
|
295
|
-
* Get the user\'s current balance
|
|
83
|
+
* Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents.
|
|
296
84
|
* @summary Get Balance
|
|
297
85
|
* @param {*} [options] Override http request option.
|
|
298
86
|
* @throws {RequiredError}
|
|
299
87
|
*/
|
|
300
88
|
getBalance(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBalanceResponse>>;
|
|
301
89
|
/**
|
|
302
|
-
*
|
|
90
|
+
* Endpoint for getting all fills for the member. A fill is when a trade you have is matched.
|
|
303
91
|
* @summary Get Fills
|
|
304
92
|
* @param {string} [ticker] Filter by market ticker
|
|
305
93
|
* @param {string} [orderId] Filter by order ID
|
|
@@ -312,178 +100,52 @@ export declare const PortfolioApiFp: (configuration?: Configuration) => {
|
|
|
312
100
|
*/
|
|
313
101
|
getFills(ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFillsResponse>>;
|
|
314
102
|
/**
|
|
315
|
-
*
|
|
316
|
-
* @summary Get Order
|
|
317
|
-
* @param {string} orderId Order ID
|
|
318
|
-
* @param {*} [options] Override http request option.
|
|
319
|
-
* @throws {RequiredError}
|
|
320
|
-
*/
|
|
321
|
-
getOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderResponse>>;
|
|
322
|
-
/**
|
|
323
|
-
* Get details of a specific order group
|
|
324
|
-
* @summary Get Order Group
|
|
325
|
-
* @param {string} orderGroupId Order group ID
|
|
326
|
-
* @param {*} [options] Override http request option.
|
|
327
|
-
* @throws {RequiredError}
|
|
328
|
-
*/
|
|
329
|
-
getOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderGroupResponse>>;
|
|
330
|
-
/**
|
|
331
|
-
* Get order groups for the logged-in user
|
|
332
|
-
* @summary Get Order Groups
|
|
333
|
-
* @param {string} [status] Filter by status. Possible values depend on the endpoint.
|
|
334
|
-
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
|
|
335
|
-
* @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
|
|
336
|
-
* @param {*} [options] Override http request option.
|
|
337
|
-
* @throws {RequiredError}
|
|
338
|
-
*/
|
|
339
|
-
getOrderGroups(status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderGroupsResponse>>;
|
|
340
|
-
/**
|
|
341
|
-
* Get the queue position for an order
|
|
342
|
-
* @summary Get Order Queue Position
|
|
343
|
-
* @param {string} orderId Order ID
|
|
344
|
-
* @param {*} [options] Override http request option.
|
|
345
|
-
* @throws {RequiredError}
|
|
346
|
-
*/
|
|
347
|
-
getOrderQueuePosition(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderQueuePositionResponse>>;
|
|
348
|
-
/**
|
|
349
|
-
* Get orders for the logged-in user
|
|
350
|
-
* @summary Get Orders
|
|
351
|
-
* @param {string} [ticker] Filter by market ticker
|
|
352
|
-
* @param {string} [eventTicker] Filter by event ticker
|
|
353
|
-
* @param {number} [minTs] Filter items after this Unix timestamp
|
|
354
|
-
* @param {number} [maxTs] Filter items before this Unix timestamp
|
|
355
|
-
* @param {string} [status] Filter by status. Possible values depend on the endpoint.
|
|
356
|
-
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
|
|
357
|
-
* @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
|
|
103
|
+
* Endpoint for getting the total value, in cents, of resting orders. This endpoint is only intended for use by FCM members (rare). Note: If you\'re uncertain about this endpoint, it likely does not apply to you.
|
|
104
|
+
* @summary Get Total Resting Order Value
|
|
358
105
|
* @param {*} [options] Override http request option.
|
|
359
106
|
* @throws {RequiredError}
|
|
360
107
|
*/
|
|
361
|
-
|
|
108
|
+
getPortfolioRestingOrderTotalValue(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPortfolioRestingOrderTotalValueResponse>>;
|
|
362
109
|
/**
|
|
363
|
-
*
|
|
110
|
+
* Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted: position, total_traded
|
|
364
111
|
* @summary Get Positions
|
|
112
|
+
* @param {string} [cursor] The Cursor represents a pointer to the next page of records in the pagination. Use the value returned from the previous response to get the next page.
|
|
113
|
+
* @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
|
|
114
|
+
* @param {string} [countFilter] Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted - position, total_traded
|
|
115
|
+
* @param {GetPositionsSettlementStatusEnum} [settlementStatus] Settlement status of the markets to return. Defaults to unsettled.
|
|
365
116
|
* @param {string} [ticker] Filter by market ticker
|
|
366
|
-
* @param {string} [eventTicker]
|
|
367
|
-
* @param {number} [countDown] Filter positions by minimum count down value
|
|
368
|
-
* @param {number} [countUp] Filter positions by minimum count up value
|
|
369
|
-
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
|
|
370
|
-
* @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
|
|
117
|
+
* @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
|
|
371
118
|
* @param {*} [options] Override http request option.
|
|
372
119
|
* @throws {RequiredError}
|
|
373
120
|
*/
|
|
374
|
-
getPositions(
|
|
121
|
+
getPositions(cursor?: string, limit?: number, countFilter?: string, settlementStatus?: GetPositionsSettlementStatusEnum, ticker?: string, eventTicker?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPositionsResponse>>;
|
|
375
122
|
/**
|
|
376
|
-
*
|
|
377
|
-
* @summary Get Queue Positions
|
|
378
|
-
* @param {GetQueuePositionsRequest} getQueuePositionsRequest
|
|
379
|
-
* @param {*} [options] Override http request option.
|
|
380
|
-
* @throws {RequiredError}
|
|
381
|
-
*/
|
|
382
|
-
getQueuePositions(getQueuePositionsRequest: GetQueuePositionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetQueuePositionsResponse>>;
|
|
383
|
-
/**
|
|
384
|
-
* Get settlements for the logged-in user
|
|
123
|
+
* Endpoint for getting the member\'s settlements historical track.
|
|
385
124
|
* @summary Get Settlements
|
|
386
125
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
|
|
387
126
|
* @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
|
|
127
|
+
* @param {string} [ticker] Filter by market ticker
|
|
128
|
+
* @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
|
|
129
|
+
* @param {number} [minTs] Filter items after this Unix timestamp
|
|
130
|
+
* @param {number} [maxTs] Filter items before this Unix timestamp
|
|
388
131
|
* @param {*} [options] Override http request option.
|
|
389
132
|
* @throws {RequiredError}
|
|
390
133
|
*/
|
|
391
|
-
getSettlements(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettlementsResponse>>;
|
|
392
|
-
/**
|
|
393
|
-
* Get the total value of all resting orders
|
|
394
|
-
* @summary Get Total Resting Order Value
|
|
395
|
-
* @param {*} [options] Override http request option.
|
|
396
|
-
* @throws {RequiredError}
|
|
397
|
-
*/
|
|
398
|
-
getTotalRestingOrderValue(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTotalRestingOrderValueResponse>>;
|
|
399
|
-
/**
|
|
400
|
-
* Reset an order group
|
|
401
|
-
* @summary Reset Order Group
|
|
402
|
-
* @param {string} orderGroupId Order group ID
|
|
403
|
-
* @param {*} [options] Override http request option.
|
|
404
|
-
* @throws {RequiredError}
|
|
405
|
-
*/
|
|
406
|
-
resetOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
134
|
+
getSettlements(limit?: number, cursor?: string, ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettlementsResponse>>;
|
|
407
135
|
};
|
|
408
136
|
/**
|
|
409
137
|
* PortfolioApi - factory interface
|
|
410
138
|
*/
|
|
411
139
|
export declare const PortfolioApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
412
140
|
/**
|
|
413
|
-
*
|
|
414
|
-
* @summary Amend Order
|
|
415
|
-
* @param {string} orderId Order ID
|
|
416
|
-
* @param {AmendOrderRequest} amendOrderRequest
|
|
417
|
-
* @param {*} [options] Override http request option.
|
|
418
|
-
* @throws {RequiredError}
|
|
419
|
-
*/
|
|
420
|
-
amendOrder(orderId: string, amendOrderRequest: AmendOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<AmendOrderResponse>;
|
|
421
|
-
/**
|
|
422
|
-
* Cancel multiple orders in a single request
|
|
423
|
-
* @summary Batch Cancel Orders
|
|
424
|
-
* @param {BatchCancelOrdersRequest} batchCancelOrdersRequest
|
|
425
|
-
* @param {*} [options] Override http request option.
|
|
426
|
-
* @throws {RequiredError}
|
|
427
|
-
*/
|
|
428
|
-
batchCancelOrders(batchCancelOrdersRequest: BatchCancelOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<BatchCancelOrdersResponse>;
|
|
429
|
-
/**
|
|
430
|
-
* Create multiple orders in a single request
|
|
431
|
-
* @summary Batch Create Orders
|
|
432
|
-
* @param {BatchCreateOrdersRequest} batchCreateOrdersRequest
|
|
433
|
-
* @param {*} [options] Override http request option.
|
|
434
|
-
* @throws {RequiredError}
|
|
435
|
-
*/
|
|
436
|
-
batchCreateOrders(batchCreateOrdersRequest: BatchCreateOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<BatchCreateOrdersResponse>;
|
|
437
|
-
/**
|
|
438
|
-
* Cancel an order
|
|
439
|
-
* @summary Cancel Order
|
|
440
|
-
* @param {string} orderId Order ID
|
|
441
|
-
* @param {*} [options] Override http request option.
|
|
442
|
-
* @throws {RequiredError}
|
|
443
|
-
*/
|
|
444
|
-
cancelOrder(orderId: string, options?: RawAxiosRequestConfig): AxiosPromise<CancelOrderResponse>;
|
|
445
|
-
/**
|
|
446
|
-
* Create a new order
|
|
447
|
-
* @summary Create Order
|
|
448
|
-
* @param {CreateOrderRequest} createOrderRequest
|
|
449
|
-
* @param {*} [options] Override http request option.
|
|
450
|
-
* @throws {RequiredError}
|
|
451
|
-
*/
|
|
452
|
-
createOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderResponse>;
|
|
453
|
-
/**
|
|
454
|
-
* Create a new order group
|
|
455
|
-
* @summary Create Order Group
|
|
456
|
-
* @param {CreateOrderGroupRequest} createOrderGroupRequest
|
|
457
|
-
* @param {*} [options] Override http request option.
|
|
458
|
-
* @throws {RequiredError}
|
|
459
|
-
*/
|
|
460
|
-
createOrderGroup(createOrderGroupRequest: CreateOrderGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderGroupResponse>;
|
|
461
|
-
/**
|
|
462
|
-
* Decrease the size of an existing order
|
|
463
|
-
* @summary Decrease Order
|
|
464
|
-
* @param {string} orderId Order ID
|
|
465
|
-
* @param {DecreaseOrderRequest} decreaseOrderRequest
|
|
466
|
-
* @param {*} [options] Override http request option.
|
|
467
|
-
* @throws {RequiredError}
|
|
468
|
-
*/
|
|
469
|
-
decreaseOrder(orderId: string, decreaseOrderRequest: DecreaseOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<DecreaseOrderResponse>;
|
|
470
|
-
/**
|
|
471
|
-
* Delete an order group
|
|
472
|
-
* @summary Delete Order Group
|
|
473
|
-
* @param {string} orderGroupId Order group ID
|
|
474
|
-
* @param {*} [options] Override http request option.
|
|
475
|
-
* @throws {RequiredError}
|
|
476
|
-
*/
|
|
477
|
-
deleteOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
478
|
-
/**
|
|
479
|
-
* Get the user\'s current balance
|
|
141
|
+
* Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents.
|
|
480
142
|
* @summary Get Balance
|
|
481
143
|
* @param {*} [options] Override http request option.
|
|
482
144
|
* @throws {RequiredError}
|
|
483
145
|
*/
|
|
484
146
|
getBalance(options?: RawAxiosRequestConfig): AxiosPromise<GetBalanceResponse>;
|
|
485
147
|
/**
|
|
486
|
-
*
|
|
148
|
+
* Endpoint for getting all fills for the member. A fill is when a trade you have is matched.
|
|
487
149
|
* @summary Get Fills
|
|
488
150
|
* @param {string} [ticker] Filter by market ticker
|
|
489
151
|
* @param {string} [orderId] Filter by order ID
|
|
@@ -496,178 +158,52 @@ export declare const PortfolioApiFactory: (configuration?: Configuration, basePa
|
|
|
496
158
|
*/
|
|
497
159
|
getFills(ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetFillsResponse>;
|
|
498
160
|
/**
|
|
499
|
-
*
|
|
500
|
-
* @summary Get Order
|
|
501
|
-
* @param {string} orderId Order ID
|
|
502
|
-
* @param {*} [options] Override http request option.
|
|
503
|
-
* @throws {RequiredError}
|
|
504
|
-
*/
|
|
505
|
-
getOrder(orderId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderResponse>;
|
|
506
|
-
/**
|
|
507
|
-
* Get details of a specific order group
|
|
508
|
-
* @summary Get Order Group
|
|
509
|
-
* @param {string} orderGroupId Order group ID
|
|
510
|
-
* @param {*} [options] Override http request option.
|
|
511
|
-
* @throws {RequiredError}
|
|
512
|
-
*/
|
|
513
|
-
getOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderGroupResponse>;
|
|
514
|
-
/**
|
|
515
|
-
* Get order groups for the logged-in user
|
|
516
|
-
* @summary Get Order Groups
|
|
517
|
-
* @param {string} [status] Filter by status. Possible values depend on the endpoint.
|
|
518
|
-
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
|
|
519
|
-
* @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
|
|
520
|
-
* @param {*} [options] Override http request option.
|
|
521
|
-
* @throws {RequiredError}
|
|
522
|
-
*/
|
|
523
|
-
getOrderGroups(status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderGroupsResponse>;
|
|
524
|
-
/**
|
|
525
|
-
* Get the queue position for an order
|
|
526
|
-
* @summary Get Order Queue Position
|
|
527
|
-
* @param {string} orderId Order ID
|
|
528
|
-
* @param {*} [options] Override http request option.
|
|
529
|
-
* @throws {RequiredError}
|
|
530
|
-
*/
|
|
531
|
-
getOrderQueuePosition(orderId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderQueuePositionResponse>;
|
|
532
|
-
/**
|
|
533
|
-
* Get orders for the logged-in user
|
|
534
|
-
* @summary Get Orders
|
|
535
|
-
* @param {string} [ticker] Filter by market ticker
|
|
536
|
-
* @param {string} [eventTicker] Filter by event ticker
|
|
537
|
-
* @param {number} [minTs] Filter items after this Unix timestamp
|
|
538
|
-
* @param {number} [maxTs] Filter items before this Unix timestamp
|
|
539
|
-
* @param {string} [status] Filter by status. Possible values depend on the endpoint.
|
|
540
|
-
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
|
|
541
|
-
* @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
|
|
161
|
+
* Endpoint for getting the total value, in cents, of resting orders. This endpoint is only intended for use by FCM members (rare). Note: If you\'re uncertain about this endpoint, it likely does not apply to you.
|
|
162
|
+
* @summary Get Total Resting Order Value
|
|
542
163
|
* @param {*} [options] Override http request option.
|
|
543
164
|
* @throws {RequiredError}
|
|
544
165
|
*/
|
|
545
|
-
|
|
166
|
+
getPortfolioRestingOrderTotalValue(options?: RawAxiosRequestConfig): AxiosPromise<GetPortfolioRestingOrderTotalValueResponse>;
|
|
546
167
|
/**
|
|
547
|
-
*
|
|
168
|
+
* Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted: position, total_traded
|
|
548
169
|
* @summary Get Positions
|
|
170
|
+
* @param {string} [cursor] The Cursor represents a pointer to the next page of records in the pagination. Use the value returned from the previous response to get the next page.
|
|
171
|
+
* @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
|
|
172
|
+
* @param {string} [countFilter] Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted - position, total_traded
|
|
173
|
+
* @param {GetPositionsSettlementStatusEnum} [settlementStatus] Settlement status of the markets to return. Defaults to unsettled.
|
|
549
174
|
* @param {string} [ticker] Filter by market ticker
|
|
550
|
-
* @param {string} [eventTicker]
|
|
551
|
-
* @param {number} [countDown] Filter positions by minimum count down value
|
|
552
|
-
* @param {number} [countUp] Filter positions by minimum count up value
|
|
553
|
-
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
|
|
554
|
-
* @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
|
|
555
|
-
* @param {*} [options] Override http request option.
|
|
556
|
-
* @throws {RequiredError}
|
|
557
|
-
*/
|
|
558
|
-
getPositions(ticker?: string, eventTicker?: string, countDown?: number, countUp?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetPositionsResponse>;
|
|
559
|
-
/**
|
|
560
|
-
* Get queue positions for multiple orders
|
|
561
|
-
* @summary Get Queue Positions
|
|
562
|
-
* @param {GetQueuePositionsRequest} getQueuePositionsRequest
|
|
175
|
+
* @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
|
|
563
176
|
* @param {*} [options] Override http request option.
|
|
564
177
|
* @throws {RequiredError}
|
|
565
178
|
*/
|
|
566
|
-
|
|
179
|
+
getPositions(cursor?: string, limit?: number, countFilter?: string, settlementStatus?: GetPositionsSettlementStatusEnum, ticker?: string, eventTicker?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetPositionsResponse>;
|
|
567
180
|
/**
|
|
568
|
-
*
|
|
181
|
+
* Endpoint for getting the member\'s settlements historical track.
|
|
569
182
|
* @summary Get Settlements
|
|
570
183
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
|
|
571
184
|
* @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
|
|
185
|
+
* @param {string} [ticker] Filter by market ticker
|
|
186
|
+
* @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
|
|
187
|
+
* @param {number} [minTs] Filter items after this Unix timestamp
|
|
188
|
+
* @param {number} [maxTs] Filter items before this Unix timestamp
|
|
572
189
|
* @param {*} [options] Override http request option.
|
|
573
190
|
* @throws {RequiredError}
|
|
574
191
|
*/
|
|
575
|
-
getSettlements(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetSettlementsResponse>;
|
|
576
|
-
/**
|
|
577
|
-
* Get the total value of all resting orders
|
|
578
|
-
* @summary Get Total Resting Order Value
|
|
579
|
-
* @param {*} [options] Override http request option.
|
|
580
|
-
* @throws {RequiredError}
|
|
581
|
-
*/
|
|
582
|
-
getTotalRestingOrderValue(options?: RawAxiosRequestConfig): AxiosPromise<GetTotalRestingOrderValueResponse>;
|
|
583
|
-
/**
|
|
584
|
-
* Reset an order group
|
|
585
|
-
* @summary Reset Order Group
|
|
586
|
-
* @param {string} orderGroupId Order group ID
|
|
587
|
-
* @param {*} [options] Override http request option.
|
|
588
|
-
* @throws {RequiredError}
|
|
589
|
-
*/
|
|
590
|
-
resetOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
192
|
+
getSettlements(limit?: number, cursor?: string, ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, options?: RawAxiosRequestConfig): AxiosPromise<GetSettlementsResponse>;
|
|
591
193
|
};
|
|
592
194
|
/**
|
|
593
195
|
* PortfolioApi - object-oriented interface
|
|
594
196
|
*/
|
|
595
197
|
export declare class PortfolioApi extends BaseAPI {
|
|
596
198
|
/**
|
|
597
|
-
*
|
|
598
|
-
* @summary Amend Order
|
|
599
|
-
* @param {string} orderId Order ID
|
|
600
|
-
* @param {AmendOrderRequest} amendOrderRequest
|
|
601
|
-
* @param {*} [options] Override http request option.
|
|
602
|
-
* @throws {RequiredError}
|
|
603
|
-
*/
|
|
604
|
-
amendOrder(orderId: string, amendOrderRequest: AmendOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AmendOrderResponse, any, {}>>;
|
|
605
|
-
/**
|
|
606
|
-
* Cancel multiple orders in a single request
|
|
607
|
-
* @summary Batch Cancel Orders
|
|
608
|
-
* @param {BatchCancelOrdersRequest} batchCancelOrdersRequest
|
|
609
|
-
* @param {*} [options] Override http request option.
|
|
610
|
-
* @throws {RequiredError}
|
|
611
|
-
*/
|
|
612
|
-
batchCancelOrders(batchCancelOrdersRequest: BatchCancelOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BatchCancelOrdersResponse, any, {}>>;
|
|
613
|
-
/**
|
|
614
|
-
* Create multiple orders in a single request
|
|
615
|
-
* @summary Batch Create Orders
|
|
616
|
-
* @param {BatchCreateOrdersRequest} batchCreateOrdersRequest
|
|
617
|
-
* @param {*} [options] Override http request option.
|
|
618
|
-
* @throws {RequiredError}
|
|
619
|
-
*/
|
|
620
|
-
batchCreateOrders(batchCreateOrdersRequest: BatchCreateOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BatchCreateOrdersResponse, any, {}>>;
|
|
621
|
-
/**
|
|
622
|
-
* Cancel an order
|
|
623
|
-
* @summary Cancel Order
|
|
624
|
-
* @param {string} orderId Order ID
|
|
625
|
-
* @param {*} [options] Override http request option.
|
|
626
|
-
* @throws {RequiredError}
|
|
627
|
-
*/
|
|
628
|
-
cancelOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CancelOrderResponse, any, {}>>;
|
|
629
|
-
/**
|
|
630
|
-
* Create a new order
|
|
631
|
-
* @summary Create Order
|
|
632
|
-
* @param {CreateOrderRequest} createOrderRequest
|
|
633
|
-
* @param {*} [options] Override http request option.
|
|
634
|
-
* @throws {RequiredError}
|
|
635
|
-
*/
|
|
636
|
-
createOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrderResponse, any, {}>>;
|
|
637
|
-
/**
|
|
638
|
-
* Create a new order group
|
|
639
|
-
* @summary Create Order Group
|
|
640
|
-
* @param {CreateOrderGroupRequest} createOrderGroupRequest
|
|
641
|
-
* @param {*} [options] Override http request option.
|
|
642
|
-
* @throws {RequiredError}
|
|
643
|
-
*/
|
|
644
|
-
createOrderGroup(createOrderGroupRequest: CreateOrderGroupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrderGroupResponse, any, {}>>;
|
|
645
|
-
/**
|
|
646
|
-
* Decrease the size of an existing order
|
|
647
|
-
* @summary Decrease Order
|
|
648
|
-
* @param {string} orderId Order ID
|
|
649
|
-
* @param {DecreaseOrderRequest} decreaseOrderRequest
|
|
650
|
-
* @param {*} [options] Override http request option.
|
|
651
|
-
* @throws {RequiredError}
|
|
652
|
-
*/
|
|
653
|
-
decreaseOrder(orderId: string, decreaseOrderRequest: DecreaseOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DecreaseOrderResponse, any, {}>>;
|
|
654
|
-
/**
|
|
655
|
-
* Delete an order group
|
|
656
|
-
* @summary Delete Order Group
|
|
657
|
-
* @param {string} orderGroupId Order group ID
|
|
658
|
-
* @param {*} [options] Override http request option.
|
|
659
|
-
* @throws {RequiredError}
|
|
660
|
-
*/
|
|
661
|
-
deleteOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
662
|
-
/**
|
|
663
|
-
* Get the user\'s current balance
|
|
199
|
+
* Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents.
|
|
664
200
|
* @summary Get Balance
|
|
665
201
|
* @param {*} [options] Override http request option.
|
|
666
202
|
* @throws {RequiredError}
|
|
667
203
|
*/
|
|
668
204
|
getBalance(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBalanceResponse, any, {}>>;
|
|
669
205
|
/**
|
|
670
|
-
*
|
|
206
|
+
* Endpoint for getting all fills for the member. A fill is when a trade you have is matched.
|
|
671
207
|
* @summary Get Fills
|
|
672
208
|
* @param {string} [ticker] Filter by market ticker
|
|
673
209
|
* @param {string} [orderId] Filter by order ID
|
|
@@ -680,96 +216,42 @@ export declare class PortfolioApi extends BaseAPI {
|
|
|
680
216
|
*/
|
|
681
217
|
getFills(ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFillsResponse, any, {}>>;
|
|
682
218
|
/**
|
|
683
|
-
*
|
|
684
|
-
* @summary Get Order
|
|
685
|
-
* @param {string} orderId Order ID
|
|
686
|
-
* @param {*} [options] Override http request option.
|
|
687
|
-
* @throws {RequiredError}
|
|
688
|
-
*/
|
|
689
|
-
getOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderResponse, any, {}>>;
|
|
690
|
-
/**
|
|
691
|
-
* Get details of a specific order group
|
|
692
|
-
* @summary Get Order Group
|
|
693
|
-
* @param {string} orderGroupId Order group ID
|
|
694
|
-
* @param {*} [options] Override http request option.
|
|
695
|
-
* @throws {RequiredError}
|
|
696
|
-
*/
|
|
697
|
-
getOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderGroupResponse, any, {}>>;
|
|
698
|
-
/**
|
|
699
|
-
* Get order groups for the logged-in user
|
|
700
|
-
* @summary Get Order Groups
|
|
701
|
-
* @param {string} [status] Filter by status. Possible values depend on the endpoint.
|
|
702
|
-
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
|
|
703
|
-
* @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
|
|
704
|
-
* @param {*} [options] Override http request option.
|
|
705
|
-
* @throws {RequiredError}
|
|
706
|
-
*/
|
|
707
|
-
getOrderGroups(status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderGroupsResponse, any, {}>>;
|
|
708
|
-
/**
|
|
709
|
-
* Get the queue position for an order
|
|
710
|
-
* @summary Get Order Queue Position
|
|
711
|
-
* @param {string} orderId Order ID
|
|
712
|
-
* @param {*} [options] Override http request option.
|
|
713
|
-
* @throws {RequiredError}
|
|
714
|
-
*/
|
|
715
|
-
getOrderQueuePosition(orderId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderQueuePositionResponse, any, {}>>;
|
|
716
|
-
/**
|
|
717
|
-
* Get orders for the logged-in user
|
|
718
|
-
* @summary Get Orders
|
|
719
|
-
* @param {string} [ticker] Filter by market ticker
|
|
720
|
-
* @param {string} [eventTicker] Filter by event ticker
|
|
721
|
-
* @param {number} [minTs] Filter items after this Unix timestamp
|
|
722
|
-
* @param {number} [maxTs] Filter items before this Unix timestamp
|
|
723
|
-
* @param {string} [status] Filter by status. Possible values depend on the endpoint.
|
|
724
|
-
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
|
|
725
|
-
* @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
|
|
219
|
+
* Endpoint for getting the total value, in cents, of resting orders. This endpoint is only intended for use by FCM members (rare). Note: If you\'re uncertain about this endpoint, it likely does not apply to you.
|
|
220
|
+
* @summary Get Total Resting Order Value
|
|
726
221
|
* @param {*} [options] Override http request option.
|
|
727
222
|
* @throws {RequiredError}
|
|
728
223
|
*/
|
|
729
|
-
|
|
224
|
+
getPortfolioRestingOrderTotalValue(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPortfolioRestingOrderTotalValueResponse, any, {}>>;
|
|
730
225
|
/**
|
|
731
|
-
*
|
|
226
|
+
* Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted: position, total_traded
|
|
732
227
|
* @summary Get Positions
|
|
228
|
+
* @param {string} [cursor] The Cursor represents a pointer to the next page of records in the pagination. Use the value returned from the previous response to get the next page.
|
|
229
|
+
* @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
|
|
230
|
+
* @param {string} [countFilter] Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted - position, total_traded
|
|
231
|
+
* @param {GetPositionsSettlementStatusEnum} [settlementStatus] Settlement status of the markets to return. Defaults to unsettled.
|
|
733
232
|
* @param {string} [ticker] Filter by market ticker
|
|
734
|
-
* @param {string} [eventTicker]
|
|
735
|
-
* @param {number} [countDown] Filter positions by minimum count down value
|
|
736
|
-
* @param {number} [countUp] Filter positions by minimum count up value
|
|
737
|
-
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
|
|
738
|
-
* @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
|
|
739
|
-
* @param {*} [options] Override http request option.
|
|
740
|
-
* @throws {RequiredError}
|
|
741
|
-
*/
|
|
742
|
-
getPositions(ticker?: string, eventTicker?: string, countDown?: number, countUp?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPositionsResponse, any, {}>>;
|
|
743
|
-
/**
|
|
744
|
-
* Get queue positions for multiple orders
|
|
745
|
-
* @summary Get Queue Positions
|
|
746
|
-
* @param {GetQueuePositionsRequest} getQueuePositionsRequest
|
|
233
|
+
* @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
|
|
747
234
|
* @param {*} [options] Override http request option.
|
|
748
235
|
* @throws {RequiredError}
|
|
749
236
|
*/
|
|
750
|
-
|
|
237
|
+
getPositions(cursor?: string, limit?: number, countFilter?: string, settlementStatus?: GetPositionsSettlementStatusEnum, ticker?: string, eventTicker?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPositionsResponse, any, {}>>;
|
|
751
238
|
/**
|
|
752
|
-
*
|
|
239
|
+
* Endpoint for getting the member\'s settlements historical track.
|
|
753
240
|
* @summary Get Settlements
|
|
754
241
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
|
|
755
242
|
* @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
|
|
243
|
+
* @param {string} [ticker] Filter by market ticker
|
|
244
|
+
* @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
|
|
245
|
+
* @param {number} [minTs] Filter items after this Unix timestamp
|
|
246
|
+
* @param {number} [maxTs] Filter items before this Unix timestamp
|
|
756
247
|
* @param {*} [options] Override http request option.
|
|
757
248
|
* @throws {RequiredError}
|
|
758
249
|
*/
|
|
759
|
-
getSettlements(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSettlementsResponse, any, {}>>;
|
|
760
|
-
/**
|
|
761
|
-
* Get the total value of all resting orders
|
|
762
|
-
* @summary Get Total Resting Order Value
|
|
763
|
-
* @param {*} [options] Override http request option.
|
|
764
|
-
* @throws {RequiredError}
|
|
765
|
-
*/
|
|
766
|
-
getTotalRestingOrderValue(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTotalRestingOrderValueResponse, any, {}>>;
|
|
767
|
-
/**
|
|
768
|
-
* Reset an order group
|
|
769
|
-
* @summary Reset Order Group
|
|
770
|
-
* @param {string} orderGroupId Order group ID
|
|
771
|
-
* @param {*} [options] Override http request option.
|
|
772
|
-
* @throws {RequiredError}
|
|
773
|
-
*/
|
|
774
|
-
resetOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
250
|
+
getSettlements(limit?: number, cursor?: string, ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSettlementsResponse, any, {}>>;
|
|
775
251
|
}
|
|
252
|
+
export declare const GetPositionsSettlementStatusEnum: {
|
|
253
|
+
readonly All: "all";
|
|
254
|
+
readonly Unsettled: "unsettled";
|
|
255
|
+
readonly Settled: "settled";
|
|
256
|
+
};
|
|
257
|
+
export type GetPositionsSettlementStatusEnum = typeof GetPositionsSettlementStatusEnum[keyof typeof GetPositionsSettlementStatusEnum];
|