kalshi-typescript 2.1.3 → 3.3.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/README.md +110 -50
- 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 +425 -0
- package/dist/api/market-api.js +811 -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 +73 -601
- package/dist/api/portfolio-api.js +141 -1202
- 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 +425 -0
- package/dist/esm/api/market-api.js +804 -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 +73 -601
- package/dist/esm/api/portfolio-api.js +141 -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 +6 -6
- 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 +8 -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 +8 -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/{models/accept-quote-request.ts → dist/esm/models/get-events-candlesticks-response-events-inner.js} +4 -10
- package/dist/esm/models/get-events-candlesticks-response.d.ts +18 -0
- package/{models/decrease-order-request.ts → dist/esm/models/get-events-candlesticks-response.js} +4 -10
- 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 +226 -27
- package/dist/esm/models/market.js +26 -6
- 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 +52 -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 +6 -6
- 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 +8 -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 +8 -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/{models/get-event-metadata-response.ts → dist/models/get-events-candlesticks-response-events-inner.js} +5 -10
- package/dist/models/get-events-candlesticks-response.d.ts +18 -0
- package/{models/get-user-data-timestamp-response.ts → dist/models/get-events-candlesticks-response.js} +5 -10
- 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 +226 -27
- package/dist/models/market.js +27 -7
- 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 +52 -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/package.json +13 -13
- package/.openapi-generator/FILES +0 -213
- package/.openapi-generator/VERSION +0 -1
- package/.openapi-generator-ignore +0 -33
- package/api/api-keys-api.ts +0 -354
- package/api/communications-api.ts +0 -863
- package/api/events-api.ts +0 -330
- package/api/exchange-api.ts +0 -315
- package/api/markets-api.ts +0 -554
- package/api/milestones-api.ts +0 -216
- package/api/multivariate-collections-api.ts +0 -293
- package/api/portfolio-api.ts +0 -1720
- package/api/series-api.ts +0 -208
- package/api/structured-targets-api.ts +0 -216
- package/api.ts +0 -27
- package/auth.ts +0 -38
- package/base.ts +0 -96
- package/common.ts +0 -98
- package/configuration.ts +0 -94
- package/docs/AcceptQuoteRequest.md +0 -20
- package/docs/AmendOrderRequest.md +0 -34
- package/docs/AmendOrderResponse.md +0 -20
- package/docs/Announcement.md +0 -26
- package/docs/ApiKey.md +0 -24
- package/docs/ApiKeysApi.md +0 -235
- package/docs/BatchCancelOrdersRequest.md +0 -20
- package/docs/BatchCancelOrdersResponse.md +0 -20
- package/docs/BatchCancelOrdersResponseResponsesInner.md +0 -24
- package/docs/BatchCreateOrdersRequest.md +0 -20
- package/docs/BatchCreateOrdersResponse.md +0 -20
- package/docs/BatchCreateOrdersResponseResponsesInner.md +0 -22
- package/docs/CancelOrderResponse.md +0 -22
- package/docs/Candlestick.md +0 -32
- package/docs/CommunicationsApi.md +0 -628
- package/docs/CreateApiKeyRequest.md +0 -22
- package/docs/CreateApiKeyResponse.md +0 -20
- package/docs/CreateOrderGroupRequest.md +0 -20
- package/docs/CreateOrderGroupResponse.md +0 -20
- package/docs/CreateOrderRequest.md +0 -44
- package/docs/CreateOrderResponse.md +0 -20
- package/docs/CreateQuoteRequest.md +0 -24
- package/docs/CreateQuoteResponse.md +0 -20
- package/docs/CreateRFQRequest.md +0 -26
- package/docs/CreateRFQResponse.md +0 -20
- package/docs/DailySchedule.md +0 -22
- package/docs/DecreaseOrderRequest.md +0 -20
- package/docs/DecreaseOrderResponse.md +0 -20
- package/docs/ErrorResponse.md +0 -20
- package/docs/ErrorResponseError.md +0 -24
- package/docs/Event.md +0 -30
- package/docs/EventPosition.md +0 -38
- package/docs/EventsApi.md +0 -199
- package/docs/ExchangeApi.md +0 -204
- package/docs/ExchangeStatus.md +0 -22
- package/docs/Fill.md +0 -36
- package/docs/GenerateApiKeyRequest.md +0 -20
- package/docs/GenerateApiKeyResponse.md +0 -22
- package/docs/GetApiKeysResponse.md +0 -20
- package/docs/GetBalanceResponse.md +0 -20
- package/docs/GetCommunicationsIDResponse.md +0 -20
- package/docs/GetEventMetadataResponse.md +0 -20
- package/docs/GetEventResponse.md +0 -22
- package/docs/GetEventsResponse.md +0 -22
- package/docs/GetExchangeAnnouncementsResponse.md +0 -20
- package/docs/GetExchangeScheduleResponse.md +0 -20
- package/docs/GetExchangeScheduleResponseSchedule.md +0 -32
- package/docs/GetFillsResponse.md +0 -22
- package/docs/GetMarketCandlesticksResponse.md +0 -20
- package/docs/GetMarketOrderbookResponse.md +0 -20
- package/docs/GetMarketOrderbookResponseOrderbook.md +0 -22
- package/docs/GetMarketResponse.md +0 -20
- package/docs/GetMarketsResponse.md +0 -22
- package/docs/GetMilestoneResponse.md +0 -20
- package/docs/GetMilestonesResponse.md +0 -20
- package/docs/GetMultivariateEventCollectionResponse.md +0 -20
- package/docs/GetMultivariateEventCollectionsResponse.md +0 -20
- package/docs/GetOrderGroupResponse.md +0 -22
- package/docs/GetOrderGroupsResponse.md +0 -22
- package/docs/GetOrderQueuePositionResponse.md +0 -20
- package/docs/GetOrderResponse.md +0 -20
- package/docs/GetOrdersResponse.md +0 -22
- package/docs/GetPositionsResponse.md +0 -24
- package/docs/GetQueuePositionsRequest.md +0 -20
- package/docs/GetQueuePositionsResponse.md +0 -20
- package/docs/GetQuoteResponse.md +0 -20
- package/docs/GetQuotesResponse.md +0 -20
- package/docs/GetRFQResponse.md +0 -20
- package/docs/GetRFQsResponse.md +0 -20
- package/docs/GetSeriesByTickerResponse.md +0 -20
- package/docs/GetSeriesResponse.md +0 -20
- package/docs/GetSettlementsResponse.md +0 -22
- package/docs/GetStructuredTargetResponse.md +0 -20
- package/docs/GetStructuredTargetsResponse.md +0 -20
- package/docs/GetTotalRestingOrderValueResponse.md +0 -20
- package/docs/GetTradesResponse.md +0 -22
- package/docs/GetUserDataTimestampResponse.md +0 -20
- package/docs/LookupBundleRequest.md +0 -20
- package/docs/LookupBundleRequestBundleInner.md +0 -22
- package/docs/LookupBundleResponse.md +0 -22
- package/docs/Market.md +0 -56
- package/docs/MarketsApi.md +0 -345
- package/docs/Milestone.md +0 -24
- package/docs/MilestonesApi.md +0 -125
- package/docs/MultivariateCollectionsApi.md +0 -185
- package/docs/MultivariateEventCollection.md +0 -26
- package/docs/MultivariateEventCollectionEventsInner.md +0 -26
- package/docs/Order.md +0 -54
- package/docs/OrderGroup.md +0 -22
- package/docs/OrderbookLevel.md +0 -22
- package/docs/PortfolioApi.md +0 -1224
- package/docs/Position.md +0 -34
- package/docs/Quote.md +0 -36
- package/docs/RFQ.md +0 -34
- package/docs/Series.md +0 -26
- package/docs/SeriesApi.md +0 -122
- package/docs/Settlement.md +0 -30
- package/docs/StructuredTarget.md +0 -24
- package/docs/StructuredTargetsApi.md +0 -125
- package/docs/Trade.md +0 -30
- package/git_push.sh +0 -57
- package/index.ts +0 -18
- package/models/amend-order-request.ts +0 -56
- package/models/amend-order-response.ts +0 -23
- package/models/announcement.ts +0 -38
- package/models/api-key.ts +0 -31
- package/models/batch-cancel-orders-request.ts +0 -20
- package/models/batch-cancel-orders-response-responses-inner.ts +0 -25
- package/models/batch-cancel-orders-response.ts +0 -23
- package/models/batch-create-orders-request.ts +0 -23
- package/models/batch-create-orders-response-responses-inner.ts +0 -27
- package/models/batch-create-orders-response.ts +0 -23
- package/models/cancel-order-response.ts +0 -24
- package/models/candlestick.ts +0 -26
- package/models/create-api-key-request.ts +0 -27
- package/models/create-api-key-response.ts +0 -23
- package/models/create-order-group-request.ts +0 -23
- package/models/create-order-group-response.ts +0 -23
- package/models/create-order-request.ts +0 -58
- package/models/create-order-response.ts +0 -23
- package/models/create-quote-request.ts +0 -22
- package/models/create-quote-response.ts +0 -23
- package/models/create-rfqrequest.ts +0 -31
- package/models/create-rfqresponse.ts +0 -23
- package/models/daily-schedule.ts +0 -21
- package/models/decrease-order-response.ts +0 -23
- package/models/error-response-error.ts +0 -31
- package/models/error-response.ts +0 -23
- package/models/event-position.ts +0 -59
- package/models/event.ts +0 -37
- package/models/exchange-status.ts +0 -21
- package/models/fill.ts +0 -42
- package/models/generate-api-key-request.ts +0 -23
- package/models/generate-api-key-response.ts +0 -27
- package/models/get-api-keys-response.ts +0 -26
- package/models/get-balance-response.ts +0 -23
- package/models/get-communications-idresponse.ts +0 -23
- package/models/get-event-response.ts +0 -27
- package/models/get-events-response.ts +0 -24
- package/models/get-exchange-announcements-response.ts +0 -23
- package/models/get-exchange-schedule-response-schedule.ts +0 -29
- package/models/get-exchange-schedule-response.ts +0 -23
- package/models/get-fills-response.ts +0 -24
- package/models/get-market-candlesticks-response.ts +0 -23
- package/models/get-market-orderbook-response-orderbook.ts +0 -24
- package/models/get-market-orderbook-response.ts +0 -23
- package/models/get-market-response.ts +0 -23
- package/models/get-markets-response.ts +0 -24
- package/models/get-milestone-response.ts +0 -23
- package/models/get-milestones-response.ts +0 -23
- package/models/get-multivariate-event-collection-response.ts +0 -23
- package/models/get-multivariate-event-collections-response.ts +0 -23
- package/models/get-order-group-response.ts +0 -27
- package/models/get-order-groups-response.ts +0 -24
- package/models/get-order-queue-position-response.ts +0 -20
- package/models/get-order-response.ts +0 -23
- package/models/get-orders-response.ts +0 -24
- package/models/get-positions-response.ts +0 -28
- package/models/get-queue-positions-request.ts +0 -20
- package/models/get-queue-positions-response.ts +0 -20
- package/models/get-quote-response.ts +0 -23
- package/models/get-quotes-response.ts +0 -23
- package/models/get-rfqresponse.ts +0 -23
- package/models/get-rfqs-response.ts +0 -23
- package/models/get-series-by-ticker-response.ts +0 -23
- package/models/get-series-response.ts +0 -23
- package/models/get-settlements-response.ts +0 -24
- package/models/get-structured-target-response.ts +0 -23
- package/models/get-structured-targets-response.ts +0 -23
- package/models/get-total-resting-order-value-response.ts +0 -20
- package/models/get-trades-response.ts +0 -24
- package/models/index.ts +0 -90
- package/models/lookup-bundle-request-bundle-inner.ts +0 -21
- package/models/lookup-bundle-request.ts +0 -23
- package/models/lookup-bundle-response.ts +0 -21
- package/models/market.ts +0 -59
- package/models/milestone.ts +0 -22
- package/models/multivariate-event-collection-events-inner.ts +0 -23
- package/models/multivariate-event-collection.ts +0 -26
- package/models/order-group.ts +0 -27
- package/models/order.ts +0 -77
- package/models/orderbook-level.ts +0 -21
- package/models/position.ts +0 -35
- package/models/quote.ts +0 -36
- package/models/rfq.ts +0 -35
- package/models/series.ts +0 -26
- package/models/settlement.ts +0 -33
- package/models/structured-target.ts +0 -22
- package/models/trade.ts +0 -33
- package/tsconfig.esm.json +0 -7
- package/tsconfig.json +0 -18
|
@@ -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.3.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,51 @@ 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
|
|
181
57
|
* @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.
|
|
58
|
+
* @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
|
|
187
59
|
* @param {*} [options] Override http request option.
|
|
188
60
|
* @throws {RequiredError}
|
|
189
61
|
*/
|
|
190
|
-
getPositions: (
|
|
62
|
+
getPositions: (cursor?: string, limit?: number, countFilter?: string, ticker?: string, eventTicker?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
191
63
|
/**
|
|
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
|
|
64
|
+
* Endpoint for getting the member\'s settlements historical track.
|
|
201
65
|
* @summary Get Settlements
|
|
202
66
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
|
|
203
67
|
* @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.
|
|
68
|
+
* @param {string} [ticker] Filter by market ticker
|
|
69
|
+
* @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
|
|
70
|
+
* @param {number} [minTs] Filter items after this Unix timestamp
|
|
71
|
+
* @param {number} [maxTs] Filter items before this Unix timestamp
|
|
204
72
|
* @param {*} [options] Override http request option.
|
|
205
73
|
* @throws {RequiredError}
|
|
206
74
|
*/
|
|
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>;
|
|
75
|
+
getSettlements: (limit?: number, cursor?: string, ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
223
76
|
};
|
|
224
77
|
/**
|
|
225
78
|
* PortfolioApi - functional programming interface
|
|
226
79
|
*/
|
|
227
80
|
export declare const PortfolioApiFp: (configuration?: Configuration) => {
|
|
228
81
|
/**
|
|
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
|
|
82
|
+
* Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents.
|
|
296
83
|
* @summary Get Balance
|
|
297
84
|
* @param {*} [options] Override http request option.
|
|
298
85
|
* @throws {RequiredError}
|
|
299
86
|
*/
|
|
300
87
|
getBalance(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBalanceResponse>>;
|
|
301
88
|
/**
|
|
302
|
-
*
|
|
89
|
+
* Endpoint for getting all fills for the member. A fill is when a trade you have is matched.
|
|
303
90
|
* @summary Get Fills
|
|
304
91
|
* @param {string} [ticker] Filter by market ticker
|
|
305
92
|
* @param {string} [orderId] Filter by order ID
|
|
@@ -312,178 +99,51 @@ export declare const PortfolioApiFp: (configuration?: Configuration) => {
|
|
|
312
99
|
*/
|
|
313
100
|
getFills(ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFillsResponse>>;
|
|
314
101
|
/**
|
|
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.
|
|
102
|
+
* 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.
|
|
103
|
+
* @summary Get Total Resting Order Value
|
|
358
104
|
* @param {*} [options] Override http request option.
|
|
359
105
|
* @throws {RequiredError}
|
|
360
106
|
*/
|
|
361
|
-
|
|
107
|
+
getPortfolioRestingOrderTotalValue(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPortfolioRestingOrderTotalValueResponse>>;
|
|
362
108
|
/**
|
|
363
|
-
*
|
|
109
|
+
* 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
110
|
* @summary Get Positions
|
|
111
|
+
* @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.
|
|
112
|
+
* @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
|
|
113
|
+
* @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
|
|
365
114
|
* @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.
|
|
115
|
+
* @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
|
|
371
116
|
* @param {*} [options] Override http request option.
|
|
372
117
|
* @throws {RequiredError}
|
|
373
118
|
*/
|
|
374
|
-
getPositions(
|
|
119
|
+
getPositions(cursor?: string, limit?: number, countFilter?: string, ticker?: string, eventTicker?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPositionsResponse>>;
|
|
375
120
|
/**
|
|
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
|
|
121
|
+
* Endpoint for getting the member\'s settlements historical track.
|
|
385
122
|
* @summary Get Settlements
|
|
386
123
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
|
|
387
124
|
* @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.
|
|
125
|
+
* @param {string} [ticker] Filter by market ticker
|
|
126
|
+
* @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
|
|
127
|
+
* @param {number} [minTs] Filter items after this Unix timestamp
|
|
128
|
+
* @param {number} [maxTs] Filter items before this Unix timestamp
|
|
388
129
|
* @param {*} [options] Override http request option.
|
|
389
130
|
* @throws {RequiredError}
|
|
390
131
|
*/
|
|
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>>;
|
|
132
|
+
getSettlements(limit?: number, cursor?: string, ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettlementsResponse>>;
|
|
407
133
|
};
|
|
408
134
|
/**
|
|
409
135
|
* PortfolioApi - factory interface
|
|
410
136
|
*/
|
|
411
137
|
export declare const PortfolioApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
412
138
|
/**
|
|
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
|
|
139
|
+
* Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents.
|
|
480
140
|
* @summary Get Balance
|
|
481
141
|
* @param {*} [options] Override http request option.
|
|
482
142
|
* @throws {RequiredError}
|
|
483
143
|
*/
|
|
484
144
|
getBalance(options?: RawAxiosRequestConfig): AxiosPromise<GetBalanceResponse>;
|
|
485
145
|
/**
|
|
486
|
-
*
|
|
146
|
+
* Endpoint for getting all fills for the member. A fill is when a trade you have is matched.
|
|
487
147
|
* @summary Get Fills
|
|
488
148
|
* @param {string} [ticker] Filter by market ticker
|
|
489
149
|
* @param {string} [orderId] Filter by order ID
|
|
@@ -496,178 +156,51 @@ export declare const PortfolioApiFactory: (configuration?: Configuration, basePa
|
|
|
496
156
|
*/
|
|
497
157
|
getFills(ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetFillsResponse>;
|
|
498
158
|
/**
|
|
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.
|
|
159
|
+
* 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.
|
|
160
|
+
* @summary Get Total Resting Order Value
|
|
542
161
|
* @param {*} [options] Override http request option.
|
|
543
162
|
* @throws {RequiredError}
|
|
544
163
|
*/
|
|
545
|
-
|
|
164
|
+
getPortfolioRestingOrderTotalValue(options?: RawAxiosRequestConfig): AxiosPromise<GetPortfolioRestingOrderTotalValueResponse>;
|
|
546
165
|
/**
|
|
547
|
-
*
|
|
166
|
+
* 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
167
|
* @summary Get Positions
|
|
168
|
+
* @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.
|
|
169
|
+
* @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
|
|
170
|
+
* @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
|
|
549
171
|
* @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.
|
|
172
|
+
* @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
|
|
555
173
|
* @param {*} [options] Override http request option.
|
|
556
174
|
* @throws {RequiredError}
|
|
557
175
|
*/
|
|
558
|
-
getPositions(
|
|
176
|
+
getPositions(cursor?: string, limit?: number, countFilter?: string, ticker?: string, eventTicker?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetPositionsResponse>;
|
|
559
177
|
/**
|
|
560
|
-
*
|
|
561
|
-
* @summary Get Queue Positions
|
|
562
|
-
* @param {GetQueuePositionsRequest} getQueuePositionsRequest
|
|
563
|
-
* @param {*} [options] Override http request option.
|
|
564
|
-
* @throws {RequiredError}
|
|
565
|
-
*/
|
|
566
|
-
getQueuePositions(getQueuePositionsRequest: GetQueuePositionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetQueuePositionsResponse>;
|
|
567
|
-
/**
|
|
568
|
-
* Get settlements for the logged-in user
|
|
178
|
+
* Endpoint for getting the member\'s settlements historical track.
|
|
569
179
|
* @summary Get Settlements
|
|
570
180
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
|
|
571
181
|
* @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.
|
|
182
|
+
* @param {string} [ticker] Filter by market ticker
|
|
183
|
+
* @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
|
|
184
|
+
* @param {number} [minTs] Filter items after this Unix timestamp
|
|
185
|
+
* @param {number} [maxTs] Filter items before this Unix timestamp
|
|
572
186
|
* @param {*} [options] Override http request option.
|
|
573
187
|
* @throws {RequiredError}
|
|
574
188
|
*/
|
|
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>;
|
|
189
|
+
getSettlements(limit?: number, cursor?: string, ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, options?: RawAxiosRequestConfig): AxiosPromise<GetSettlementsResponse>;
|
|
591
190
|
};
|
|
592
191
|
/**
|
|
593
192
|
* PortfolioApi - object-oriented interface
|
|
594
193
|
*/
|
|
595
194
|
export declare class PortfolioApi extends BaseAPI {
|
|
596
195
|
/**
|
|
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
|
|
196
|
+
* Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents.
|
|
664
197
|
* @summary Get Balance
|
|
665
198
|
* @param {*} [options] Override http request option.
|
|
666
199
|
* @throws {RequiredError}
|
|
667
200
|
*/
|
|
668
201
|
getBalance(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBalanceResponse, any, {}>>;
|
|
669
202
|
/**
|
|
670
|
-
*
|
|
203
|
+
* Endpoint for getting all fills for the member. A fill is when a trade you have is matched.
|
|
671
204
|
* @summary Get Fills
|
|
672
205
|
* @param {string} [ticker] Filter by market ticker
|
|
673
206
|
* @param {string} [orderId] Filter by order ID
|
|
@@ -680,96 +213,35 @@ export declare class PortfolioApi extends BaseAPI {
|
|
|
680
213
|
*/
|
|
681
214
|
getFills(ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFillsResponse, any, {}>>;
|
|
682
215
|
/**
|
|
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.
|
|
216
|
+
* 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.
|
|
217
|
+
* @summary Get Total Resting Order Value
|
|
726
218
|
* @param {*} [options] Override http request option.
|
|
727
219
|
* @throws {RequiredError}
|
|
728
220
|
*/
|
|
729
|
-
|
|
221
|
+
getPortfolioRestingOrderTotalValue(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPortfolioRestingOrderTotalValueResponse, any, {}>>;
|
|
730
222
|
/**
|
|
731
|
-
*
|
|
223
|
+
* 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
224
|
* @summary Get Positions
|
|
225
|
+
* @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.
|
|
226
|
+
* @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
|
|
227
|
+
* @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
|
|
733
228
|
* @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.
|
|
229
|
+
* @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
|
|
739
230
|
* @param {*} [options] Override http request option.
|
|
740
231
|
* @throws {RequiredError}
|
|
741
232
|
*/
|
|
742
|
-
getPositions(
|
|
233
|
+
getPositions(cursor?: string, limit?: number, countFilter?: string, ticker?: string, eventTicker?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPositionsResponse, any, {}>>;
|
|
743
234
|
/**
|
|
744
|
-
*
|
|
745
|
-
* @summary Get Queue Positions
|
|
746
|
-
* @param {GetQueuePositionsRequest} getQueuePositionsRequest
|
|
747
|
-
* @param {*} [options] Override http request option.
|
|
748
|
-
* @throws {RequiredError}
|
|
749
|
-
*/
|
|
750
|
-
getQueuePositions(getQueuePositionsRequest: GetQueuePositionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetQueuePositionsResponse, any, {}>>;
|
|
751
|
-
/**
|
|
752
|
-
* Get settlements for the logged-in user
|
|
235
|
+
* Endpoint for getting the member\'s settlements historical track.
|
|
753
236
|
* @summary Get Settlements
|
|
754
237
|
* @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
|
|
755
238
|
* @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.
|
|
239
|
+
* @param {string} [ticker] Filter by market ticker
|
|
240
|
+
* @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
|
|
241
|
+
* @param {number} [minTs] Filter items after this Unix timestamp
|
|
242
|
+
* @param {number} [maxTs] Filter items before this Unix timestamp
|
|
756
243
|
* @param {*} [options] Override http request option.
|
|
757
244
|
* @throws {RequiredError}
|
|
758
245
|
*/
|
|
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, {}>>;
|
|
246
|
+
getSettlements(limit?: number, cursor?: string, ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSettlementsResponse, any, {}>>;
|
|
775
247
|
}
|