kalshi-typescript 2.1.1 → 2.1.2

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.
Files changed (189) hide show
  1. package/.openapi-generator/FILES +4 -1
  2. package/.openapi-generator-ignore +9 -2
  3. package/README.md +200 -29
  4. package/api/exchange-api.ts +4 -4
  5. package/api/markets-api.ts +4 -4
  6. package/api/portfolio-api.ts +75 -1
  7. package/auth.ts +38 -0
  8. package/base.ts +51 -17
  9. package/common.ts +1 -1
  10. package/configuration.ts +1 -1
  11. package/dist/api/api-keys-api.d.ts +4 -4
  12. package/dist/api/communications-api.d.ts +11 -11
  13. package/dist/api/events-api.d.ts +3 -3
  14. package/dist/api/exchange-api.d.ts +8 -8
  15. package/dist/api/exchange-api.js +4 -4
  16. package/dist/api/markets-api.d.ts +9 -9
  17. package/dist/api/markets-api.js +4 -4
  18. package/dist/api/milestones-api.d.ts +2 -2
  19. package/dist/api/multivariate-collections-api.d.ts +3 -3
  20. package/dist/api/portfolio-api.d.ts +52 -19
  21. package/dist/api/portfolio-api.js +69 -1
  22. package/dist/api/series-api.d.ts +2 -2
  23. package/dist/api/structured-targets-api.d.ts +2 -2
  24. package/dist/auth.d.ts +7 -0
  25. package/dist/auth.js +33 -0
  26. package/dist/base.d.ts +25 -10
  27. package/dist/base.js +37 -6
  28. package/dist/esm/api/api-keys-api.d.ts +4 -4
  29. package/dist/esm/api/communications-api.d.ts +11 -11
  30. package/dist/esm/api/events-api.d.ts +3 -3
  31. package/dist/esm/api/exchange-api.d.ts +8 -8
  32. package/dist/esm/api/exchange-api.js +4 -4
  33. package/dist/esm/api/markets-api.d.ts +9 -9
  34. package/dist/esm/api/markets-api.js +4 -4
  35. package/dist/esm/api/milestones-api.d.ts +2 -2
  36. package/dist/esm/api/multivariate-collections-api.d.ts +3 -3
  37. package/dist/esm/api/portfolio-api.d.ts +52 -19
  38. package/dist/esm/api/portfolio-api.js +69 -1
  39. package/dist/esm/api/series-api.d.ts +2 -2
  40. package/dist/esm/api/structured-targets-api.d.ts +2 -2
  41. package/dist/esm/auth.d.ts +7 -0
  42. package/dist/esm/auth.js +29 -0
  43. package/dist/esm/base.d.ts +25 -10
  44. package/dist/esm/base.js +36 -5
  45. package/dist/esm/models/amend-order-request.d.ts +30 -0
  46. package/dist/esm/models/amend-order-request.js +8 -1
  47. package/dist/esm/models/create-order-group-request.d.ts +4 -1
  48. package/dist/esm/models/create-order-group-response.d.ts +4 -2
  49. package/dist/esm/models/create-order-request.d.ts +8 -0
  50. package/dist/esm/models/error-response-error.d.ts +1 -1
  51. package/dist/esm/models/event-position.d.ts +53 -0
  52. package/dist/esm/models/event-position.js +14 -0
  53. package/dist/esm/models/get-order-group-response.d.ts +21 -0
  54. package/dist/esm/models/get-order-group-response.js +14 -0
  55. package/dist/esm/models/get-order-response.d.ts +1 -1
  56. package/dist/esm/models/get-positions-response.d.ts +3 -1
  57. package/dist/esm/models/index.d.ts +2 -0
  58. package/dist/esm/models/index.js +2 -0
  59. package/dist/esm/models/order-group.d.ts +8 -4
  60. package/dist/esm/models/order.d.ts +16 -0
  61. package/dist/models/amend-order-request.d.ts +30 -0
  62. package/dist/models/amend-order-request.js +9 -0
  63. package/dist/models/create-order-group-request.d.ts +4 -1
  64. package/dist/models/create-order-group-response.d.ts +4 -2
  65. package/dist/models/create-order-request.d.ts +8 -0
  66. package/dist/models/error-response-error.d.ts +1 -1
  67. package/dist/models/event-position.d.ts +53 -0
  68. package/dist/models/event-position.js +15 -0
  69. package/dist/models/get-order-group-response.d.ts +21 -0
  70. package/dist/models/get-order-group-response.js +15 -0
  71. package/dist/models/get-order-response.d.ts +1 -1
  72. package/dist/models/get-positions-response.d.ts +3 -1
  73. package/dist/models/index.d.ts +2 -0
  74. package/dist/models/index.js +2 -0
  75. package/dist/models/order-group.d.ts +8 -4
  76. package/dist/models/order.d.ts +16 -0
  77. package/docs/AcceptQuoteRequest.md +1 -1
  78. package/docs/AmendOrderRequest.md +11 -1
  79. package/docs/AmendOrderResponse.md +1 -1
  80. package/docs/Announcement.md +1 -1
  81. package/docs/ApiKey.md +1 -1
  82. package/docs/ApiKeysApi.md +20 -8
  83. package/docs/BatchCancelOrdersRequest.md +1 -1
  84. package/docs/BatchCancelOrdersResponse.md +1 -1
  85. package/docs/BatchCancelOrdersResponseResponsesInner.md +1 -1
  86. package/docs/BatchCreateOrdersRequest.md +1 -1
  87. package/docs/BatchCreateOrdersResponse.md +1 -1
  88. package/docs/BatchCreateOrdersResponseResponsesInner.md +1 -1
  89. package/docs/CancelOrderResponse.md +1 -1
  90. package/docs/Candlestick.md +1 -1
  91. package/docs/CommunicationsApi.md +55 -22
  92. package/docs/CreateApiKeyRequest.md +1 -1
  93. package/docs/CreateApiKeyResponse.md +1 -1
  94. package/docs/CreateOrderGroupRequest.md +3 -3
  95. package/docs/CreateOrderGroupResponse.md +3 -3
  96. package/docs/CreateOrderRequest.md +5 -1
  97. package/docs/CreateOrderResponse.md +1 -1
  98. package/docs/CreateQuoteRequest.md +1 -1
  99. package/docs/CreateQuoteResponse.md +1 -1
  100. package/docs/CreateRFQRequest.md +1 -1
  101. package/docs/CreateRFQResponse.md +1 -1
  102. package/docs/DailySchedule.md +1 -1
  103. package/docs/DecreaseOrderRequest.md +1 -1
  104. package/docs/DecreaseOrderResponse.md +1 -1
  105. package/docs/ErrorResponse.md +1 -1
  106. package/docs/ErrorResponseError.md +2 -2
  107. package/docs/Event.md +1 -1
  108. package/docs/EventPosition.md +38 -0
  109. package/docs/EventsApi.md +15 -6
  110. package/docs/ExchangeApi.md +21 -9
  111. package/docs/ExchangeStatus.md +1 -1
  112. package/docs/Fill.md +1 -1
  113. package/docs/GenerateApiKeyRequest.md +1 -1
  114. package/docs/GenerateApiKeyResponse.md +1 -1
  115. package/docs/GetApiKeysResponse.md +1 -1
  116. package/docs/GetBalanceResponse.md +1 -1
  117. package/docs/GetCommunicationsIDResponse.md +1 -1
  118. package/docs/GetEventMetadataResponse.md +1 -1
  119. package/docs/GetEventResponse.md +1 -1
  120. package/docs/GetEventsResponse.md +1 -1
  121. package/docs/GetExchangeAnnouncementsResponse.md +1 -1
  122. package/docs/GetExchangeScheduleResponse.md +1 -1
  123. package/docs/GetExchangeScheduleResponseSchedule.md +1 -1
  124. package/docs/GetFillsResponse.md +1 -1
  125. package/docs/GetMarketCandlesticksResponse.md +1 -1
  126. package/docs/GetMarketOrderbookResponse.md +1 -1
  127. package/docs/GetMarketOrderbookResponseOrderbook.md +1 -1
  128. package/docs/GetMarketResponse.md +1 -1
  129. package/docs/GetMarketsResponse.md +1 -1
  130. package/docs/GetMilestoneResponse.md +1 -1
  131. package/docs/GetMilestonesResponse.md +1 -1
  132. package/docs/GetMultivariateEventCollectionResponse.md +1 -1
  133. package/docs/GetMultivariateEventCollectionsResponse.md +1 -1
  134. package/docs/GetOrderGroupResponse.md +22 -0
  135. package/docs/GetOrderGroupsResponse.md +1 -1
  136. package/docs/GetOrderQueuePositionResponse.md +1 -1
  137. package/docs/GetOrderResponse.md +2 -2
  138. package/docs/GetOrdersResponse.md +1 -1
  139. package/docs/GetPositionsResponse.md +5 -3
  140. package/docs/GetQueuePositionsRequest.md +1 -1
  141. package/docs/GetQueuePositionsResponse.md +1 -1
  142. package/docs/GetQuoteResponse.md +1 -1
  143. package/docs/GetQuotesResponse.md +1 -1
  144. package/docs/GetRFQResponse.md +1 -1
  145. package/docs/GetRFQsResponse.md +1 -1
  146. package/docs/GetSeriesByTickerResponse.md +1 -1
  147. package/docs/GetSeriesResponse.md +1 -1
  148. package/docs/GetSettlementsResponse.md +1 -1
  149. package/docs/GetStructuredTargetResponse.md +1 -1
  150. package/docs/GetStructuredTargetsResponse.md +1 -1
  151. package/docs/GetTotalRestingOrderValueResponse.md +1 -1
  152. package/docs/GetTradesResponse.md +1 -1
  153. package/docs/GetUserDataTimestampResponse.md +1 -1
  154. package/docs/LookupBundleRequest.md +1 -1
  155. package/docs/LookupBundleRequestBundleInner.md +1 -1
  156. package/docs/LookupBundleResponse.md +1 -1
  157. package/docs/Market.md +1 -1
  158. package/docs/MarketsApi.md +26 -11
  159. package/docs/Milestone.md +1 -1
  160. package/docs/MilestonesApi.md +10 -4
  161. package/docs/MultivariateCollectionsApi.md +15 -6
  162. package/docs/MultivariateEventCollection.md +1 -1
  163. package/docs/MultivariateEventCollectionEventsInner.md +1 -1
  164. package/docs/Order.md +9 -1
  165. package/docs/OrderGroup.md +5 -9
  166. package/docs/OrderbookLevel.md +1 -1
  167. package/docs/PortfolioApi.md +154 -39
  168. package/docs/Position.md +1 -1
  169. package/docs/Quote.md +1 -1
  170. package/docs/RFQ.md +1 -1
  171. package/docs/Series.md +1 -1
  172. package/docs/SeriesApi.md +10 -4
  173. package/docs/Settlement.md +1 -1
  174. package/docs/StructuredTarget.md +1 -1
  175. package/docs/StructuredTargetsApi.md +10 -4
  176. package/docs/Trade.md +1 -1
  177. package/models/amend-order-request.ts +34 -0
  178. package/models/create-order-group-request.ts +4 -1
  179. package/models/create-order-group-response.ts +4 -4
  180. package/models/create-order-request.ts +8 -0
  181. package/models/error-response-error.ts +1 -1
  182. package/models/event-position.ts +59 -0
  183. package/models/get-order-group-response.ts +27 -0
  184. package/models/get-order-response.ts +1 -1
  185. package/models/get-positions-response.ts +5 -1
  186. package/models/index.ts +2 -0
  187. package/models/order-group.ts +8 -4
  188. package/models/order.ts +16 -0
  189. package/package.json +4 -4
@@ -307,7 +307,7 @@ export declare class CommunicationsApi extends BaseAPI {
307
307
  * @param {*} [options] Override http request option.
308
308
  * @throws {RequiredError}
309
309
  */
310
- acceptQuote(quoteId: string, acceptQuoteRequest: AcceptQuoteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
310
+ acceptQuote(quoteId: string, acceptQuoteRequest: AcceptQuoteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
311
311
  /**
312
312
  * Confirm a quote. This will start a timer for order execution
313
313
  * @summary Confirm Quote
@@ -315,7 +315,7 @@ export declare class CommunicationsApi extends BaseAPI {
315
315
  * @param {*} [options] Override http request option.
316
316
  * @throws {RequiredError}
317
317
  */
318
- confirmQuote(quoteId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
318
+ confirmQuote(quoteId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
319
319
  /**
320
320
  * Create a quote in response to an RFQ
321
321
  * @summary Create Quote
@@ -323,7 +323,7 @@ export declare class CommunicationsApi extends BaseAPI {
323
323
  * @param {*} [options] Override http request option.
324
324
  * @throws {RequiredError}
325
325
  */
326
- createQuote(createQuoteRequest: CreateQuoteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateQuoteResponse, any>>;
326
+ createQuote(createQuoteRequest: CreateQuoteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateQuoteResponse, any, {}>>;
327
327
  /**
328
328
  * Create a new RFQ
329
329
  * @summary Create RFQ
@@ -331,7 +331,7 @@ export declare class CommunicationsApi extends BaseAPI {
331
331
  * @param {*} [options] Override http request option.
332
332
  * @throws {RequiredError}
333
333
  */
334
- createRFQ(createRFQRequest: CreateRFQRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateRFQResponse, any>>;
334
+ createRFQ(createRFQRequest: CreateRFQRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateRFQResponse, any, {}>>;
335
335
  /**
336
336
  * Delete a quote, which means it can no longer be accepted
337
337
  * @summary Delete Quote
@@ -339,7 +339,7 @@ export declare class CommunicationsApi extends BaseAPI {
339
339
  * @param {*} [options] Override http request option.
340
340
  * @throws {RequiredError}
341
341
  */
342
- deleteQuote(quoteId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
342
+ deleteQuote(quoteId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
343
343
  /**
344
344
  * Delete an RFQ by ID
345
345
  * @summary Delete RFQ
@@ -347,14 +347,14 @@ export declare class CommunicationsApi extends BaseAPI {
347
347
  * @param {*} [options] Override http request option.
348
348
  * @throws {RequiredError}
349
349
  */
350
- deleteRFQ(rfqId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
350
+ deleteRFQ(rfqId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
351
351
  /**
352
352
  * Get the communications ID of the logged-in user
353
353
  * @summary Get Communications ID
354
354
  * @param {*} [options] Override http request option.
355
355
  * @throws {RequiredError}
356
356
  */
357
- getCommunicationsID(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCommunicationsIDResponse, any>>;
357
+ getCommunicationsID(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCommunicationsIDResponse, any, {}>>;
358
358
  /**
359
359
  * Get a particular quote by ID
360
360
  * @summary Get Quote
@@ -362,14 +362,14 @@ export declare class CommunicationsApi extends BaseAPI {
362
362
  * @param {*} [options] Override http request option.
363
363
  * @throws {RequiredError}
364
364
  */
365
- getQuote(quoteId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetQuoteResponse, any>>;
365
+ getQuote(quoteId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetQuoteResponse, any, {}>>;
366
366
  /**
367
367
  * Retrieve all quotes
368
368
  * @summary Get Quotes
369
369
  * @param {*} [options] Override http request option.
370
370
  * @throws {RequiredError}
371
371
  */
372
- getQuotes(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetQuotesResponse, any>>;
372
+ getQuotes(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetQuotesResponse, any, {}>>;
373
373
  /**
374
374
  * Get a single RFQ by ID
375
375
  * @summary Get RFQ
@@ -377,12 +377,12 @@ export declare class CommunicationsApi extends BaseAPI {
377
377
  * @param {*} [options] Override http request option.
378
378
  * @throws {RequiredError}
379
379
  */
380
- getRFQ(rfqId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetRFQResponse, any>>;
380
+ getRFQ(rfqId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetRFQResponse, any, {}>>;
381
381
  /**
382
382
  * Retrieve all RFQs
383
383
  * @summary Get RFQs
384
384
  * @param {*} [options] Override http request option.
385
385
  * @throws {RequiredError}
386
386
  */
387
- getRFQs(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetRFQsResponse, any>>;
387
+ getRFQs(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetRFQsResponse, any, {}>>;
388
388
  }
@@ -132,7 +132,7 @@ export declare class EventsApi extends BaseAPI {
132
132
  * @param {*} [options] Override http request option.
133
133
  * @throws {RequiredError}
134
134
  */
135
- getEvent(eventTicker: string, withNestedMarkets?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventResponse, any>>;
135
+ getEvent(eventTicker: string, withNestedMarkets?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventResponse, any, {}>>;
136
136
  /**
137
137
  * Get metadata about an event by its ticker
138
138
  * @summary Get Event Metadata
@@ -140,7 +140,7 @@ export declare class EventsApi extends BaseAPI {
140
140
  * @param {*} [options] Override http request option.
141
141
  * @throws {RequiredError}
142
142
  */
143
- getEventMetadata(eventTicker: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventMetadataResponse, any>>;
143
+ getEventMetadata(eventTicker: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventMetadataResponse, any, {}>>;
144
144
  /**
145
145
  * Get data about all events. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-200, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
146
146
  * @summary Get Events
@@ -153,5 +153,5 @@ export declare class EventsApi extends BaseAPI {
153
153
  * @param {*} [options] Override http request option.
154
154
  * @throws {RequiredError}
155
155
  */
156
- getEvents(limit?: number, cursor?: string, withNestedMarkets?: boolean, status?: string, seriesTicker?: string, minCloseTs?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventsResponse, any>>;
156
+ getEvents(limit?: number, cursor?: string, withNestedMarkets?: boolean, status?: string, seriesTicker?: string, minCloseTs?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventsResponse, any, {}>>;
157
157
  }
@@ -42,7 +42,7 @@ export declare const ExchangeApiAxiosParamCreator: (configuration?: Configuratio
42
42
  */
43
43
  getExchangeStatus: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
44
44
  /**
45
- * There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
45
+ * There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
46
46
  * @summary Get User Data Timestamp
47
47
  * @param {*} [options] Override http request option.
48
48
  * @throws {RequiredError}
@@ -75,7 +75,7 @@ export declare const ExchangeApiFp: (configuration?: Configuration) => {
75
75
  */
76
76
  getExchangeStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExchangeStatus>>;
77
77
  /**
78
- * There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
78
+ * There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
79
79
  * @summary Get User Data Timestamp
80
80
  * @param {*} [options] Override http request option.
81
81
  * @throws {RequiredError}
@@ -108,7 +108,7 @@ export declare const ExchangeApiFactory: (configuration?: Configuration, basePat
108
108
  */
109
109
  getExchangeStatus(options?: RawAxiosRequestConfig): AxiosPromise<ExchangeStatus>;
110
110
  /**
111
- * There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
111
+ * There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
112
112
  * @summary Get User Data Timestamp
113
113
  * @param {*} [options] Override http request option.
114
114
  * @throws {RequiredError}
@@ -125,26 +125,26 @@ export declare class ExchangeApi extends BaseAPI {
125
125
  * @param {*} [options] Override http request option.
126
126
  * @throws {RequiredError}
127
127
  */
128
- getExchangeAnnouncements(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetExchangeAnnouncementsResponse, any>>;
128
+ getExchangeAnnouncements(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetExchangeAnnouncementsResponse, any, {}>>;
129
129
  /**
130
130
  * Get the exchange schedule
131
131
  * @summary Get Exchange Schedule
132
132
  * @param {*} [options] Override http request option.
133
133
  * @throws {RequiredError}
134
134
  */
135
- getExchangeSchedule(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetExchangeScheduleResponse, any>>;
135
+ getExchangeSchedule(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetExchangeScheduleResponse, any, {}>>;
136
136
  /**
137
137
  * Get the exchange status
138
138
  * @summary Get Exchange Status
139
139
  * @param {*} [options] Override http request option.
140
140
  * @throws {RequiredError}
141
141
  */
142
- getExchangeStatus(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExchangeStatus, any>>;
142
+ getExchangeStatus(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExchangeStatus, any, {}>>;
143
143
  /**
144
- * There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
144
+ * There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
145
145
  * @summary Get User Data Timestamp
146
146
  * @param {*} [options] Override http request option.
147
147
  * @throws {RequiredError}
148
148
  */
149
- getUserDataTimestamp(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserDataTimestampResponse, any>>;
149
+ getUserDataTimestamp(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserDataTimestampResponse, any, {}>>;
150
150
  }
@@ -110,7 +110,7 @@ export const ExchangeApiAxiosParamCreator = function (configuration) {
110
110
  };
111
111
  }),
112
112
  /**
113
- * There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
113
+ * There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
114
114
  * @summary Get User Data Timestamp
115
115
  * @param {*} [options] Override http request option.
116
116
  * @throws {RequiredError}
@@ -191,7 +191,7 @@ export const ExchangeApiFp = function (configuration) {
191
191
  });
192
192
  },
193
193
  /**
194
- * There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
194
+ * There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
195
195
  * @summary Get User Data Timestamp
196
196
  * @param {*} [options] Override http request option.
197
197
  * @throws {RequiredError}
@@ -241,7 +241,7 @@ export const ExchangeApiFactory = function (configuration, basePath, axios) {
241
241
  return localVarFp.getExchangeStatus(options).then((request) => request(axios, basePath));
242
242
  },
243
243
  /**
244
- * There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
244
+ * There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
245
245
  * @summary Get User Data Timestamp
246
246
  * @param {*} [options] Override http request option.
247
247
  * @throws {RequiredError}
@@ -283,7 +283,7 @@ export class ExchangeApi extends BaseAPI {
283
283
  return ExchangeApiFp(this.configuration).getExchangeStatus(options).then((request) => request(this.axios, this.basePath));
284
284
  }
285
285
  /**
286
- * There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
286
+ * There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
287
287
  * @summary Get User Data Timestamp
288
288
  * @param {*} [options] Override http request option.
289
289
  * @throws {RequiredError}
@@ -51,7 +51,7 @@ export declare const MarketsApiAxiosParamCreator: (configuration?: Configuration
51
51
  */
52
52
  getMarketOrderbook: (ticker: string, depth?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
53
53
  /**
54
- * List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
54
+ * List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
55
55
  * @summary Get Markets
56
56
  * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
57
57
  * @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.
@@ -112,7 +112,7 @@ export declare const MarketsApiFp: (configuration?: Configuration) => {
112
112
  */
113
113
  getMarketOrderbook(ticker: string, depth?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMarketOrderbookResponse>>;
114
114
  /**
115
- * List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
115
+ * List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
116
116
  * @summary Get Markets
117
117
  * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
118
118
  * @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.
@@ -173,7 +173,7 @@ export declare const MarketsApiFactory: (configuration?: Configuration, basePath
173
173
  */
174
174
  getMarketOrderbook(ticker: string, depth?: number, options?: RawAxiosRequestConfig): AxiosPromise<GetMarketOrderbookResponse>;
175
175
  /**
176
- * List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
176
+ * List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
177
177
  * @summary Get Markets
178
178
  * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
179
179
  * @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.
@@ -211,7 +211,7 @@ export declare class MarketsApi extends BaseAPI {
211
211
  * @param {*} [options] Override http request option.
212
212
  * @throws {RequiredError}
213
213
  */
214
- getMarket(ticker: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketResponse, any>>;
214
+ getMarket(ticker: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketResponse, any, {}>>;
215
215
  /**
216
216
  * Get candlestick data for a market within a series
217
217
  * @summary Get Market Candlesticks
@@ -223,7 +223,7 @@ export declare class MarketsApi extends BaseAPI {
223
223
  * @param {*} [options] Override http request option.
224
224
  * @throws {RequiredError}
225
225
  */
226
- getMarketCandlesticks(ticker: string, marketTicker: string, startTs?: number, endTs?: number, periodInterval?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketCandlesticksResponse, any>>;
226
+ getMarketCandlesticks(ticker: string, marketTicker: string, startTs?: number, endTs?: number, periodInterval?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketCandlesticksResponse, any, {}>>;
227
227
  /**
228
228
  * Get the orderbook for a market
229
229
  * @summary Get Market Orderbook
@@ -232,9 +232,9 @@ export declare class MarketsApi extends BaseAPI {
232
232
  * @param {*} [options] Override http request option.
233
233
  * @throws {RequiredError}
234
234
  */
235
- getMarketOrderbook(ticker: string, depth?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketOrderbookResponse, any>>;
235
+ getMarketOrderbook(ticker: string, depth?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketOrderbookResponse, any, {}>>;
236
236
  /**
237
- * List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
237
+ * List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
238
238
  * @summary Get Markets
239
239
  * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
240
240
  * @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.
@@ -247,7 +247,7 @@ export declare class MarketsApi extends BaseAPI {
247
247
  * @param {*} [options] Override http request option.
248
248
  * @throws {RequiredError}
249
249
  */
250
- getMarkets(limit?: number, cursor?: string, eventTicker?: string, seriesTicker?: string, maxCloseTs?: number, minCloseTs?: number, status?: string, tickers?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketsResponse, any>>;
250
+ getMarkets(limit?: number, cursor?: string, eventTicker?: string, seriesTicker?: string, maxCloseTs?: number, minCloseTs?: number, status?: string, tickers?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMarketsResponse, any, {}>>;
251
251
  /**
252
252
  * Get all trades for all markets. A trade represents a completed transaction between two users on a specific market. Each trade includes the market ticker, price, quantity, and timestamp information. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
253
253
  * @summary Get Trades
@@ -259,5 +259,5 @@ export declare class MarketsApi extends BaseAPI {
259
259
  * @param {*} [options] Override http request option.
260
260
  * @throws {RequiredError}
261
261
  */
262
- getTrades(limit?: number, cursor?: string, ticker?: string, minTs?: number, maxTs?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTradesResponse, any>>;
262
+ getTrades(limit?: number, cursor?: string, ticker?: string, minTs?: number, maxTs?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTradesResponse, any, {}>>;
263
263
  }
@@ -151,7 +151,7 @@ export const MarketsApiAxiosParamCreator = function (configuration) {
151
151
  };
152
152
  }),
153
153
  /**
154
- * List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
154
+ * List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
155
155
  * @summary Get Markets
156
156
  * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
157
157
  * @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.
@@ -317,7 +317,7 @@ export const MarketsApiFp = function (configuration) {
317
317
  });
318
318
  },
319
319
  /**
320
- * List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
320
+ * List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
321
321
  * @summary Get Markets
322
322
  * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
323
323
  * @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.
@@ -403,7 +403,7 @@ export const MarketsApiFactory = function (configuration, basePath, axios) {
403
403
  return localVarFp.getMarketOrderbook(ticker, depth, options).then((request) => request(axios, basePath));
404
404
  },
405
405
  /**
406
- * List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
406
+ * List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
407
407
  * @summary Get Markets
408
408
  * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
409
409
  * @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.
@@ -475,7 +475,7 @@ export class MarketsApi extends BaseAPI {
475
475
  return MarketsApiFp(this.configuration).getMarketOrderbook(ticker, depth, options).then((request) => request(this.axios, this.basePath));
476
476
  }
477
477
  /**
478
- * List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
478
+ * List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
479
479
  * @summary Get Markets
480
480
  * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 1000.
481
481
  * @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.
@@ -91,7 +91,7 @@ export declare class MilestonesApi extends BaseAPI {
91
91
  * @param {*} [options] Override http request option.
92
92
  * @throws {RequiredError}
93
93
  */
94
- getMilestone(milestoneId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMilestoneResponse, any>>;
94
+ getMilestone(milestoneId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMilestoneResponse, any, {}>>;
95
95
  /**
96
96
  * Get all milestones
97
97
  * @summary Get Milestones
@@ -100,5 +100,5 @@ export declare class MilestonesApi extends BaseAPI {
100
100
  * @param {*} [options] Override http request option.
101
101
  * @throws {RequiredError}
102
102
  */
103
- getMilestones(status?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMilestonesResponse, any>>;
103
+ getMilestones(status?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMilestonesResponse, any, {}>>;
104
104
  }
@@ -117,7 +117,7 @@ export declare class MultivariateCollectionsApi extends BaseAPI {
117
117
  * @param {*} [options] Override http request option.
118
118
  * @throws {RequiredError}
119
119
  */
120
- getMultivariateEventCollection(collectionTicker: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMultivariateEventCollectionResponse, any>>;
120
+ getMultivariateEventCollection(collectionTicker: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMultivariateEventCollectionResponse, any, {}>>;
121
121
  /**
122
122
  * Get all multivariate event collections
123
123
  * @summary Get Multivariate Event Collections
@@ -125,7 +125,7 @@ export declare class MultivariateCollectionsApi extends BaseAPI {
125
125
  * @param {*} [options] Override http request option.
126
126
  * @throws {RequiredError}
127
127
  */
128
- getMultivariateEventCollections(status?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMultivariateEventCollectionsResponse, any>>;
128
+ getMultivariateEventCollections(status?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMultivariateEventCollectionsResponse, any, {}>>;
129
129
  /**
130
130
  * Lookup a bundle in a multivariate event collection
131
131
  * @summary Lookup Multivariate Event Collection Bundle
@@ -134,5 +134,5 @@ export declare class MultivariateCollectionsApi extends BaseAPI {
134
134
  * @param {*} [options] Override http request option.
135
135
  * @throws {RequiredError}
136
136
  */
137
- lookupMultivariateEventCollectionBundle(collectionTicker: string, lookupBundleRequest: LookupBundleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LookupBundleResponse, any>>;
137
+ lookupMultivariateEventCollectionBundle(collectionTicker: string, lookupBundleRequest: LookupBundleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LookupBundleResponse, any, {}>>;
138
138
  }
@@ -27,6 +27,7 @@ import type { DecreaseOrderRequest } from '../models';
27
27
  import type { DecreaseOrderResponse } from '../models';
28
28
  import type { GetBalanceResponse } from '../models';
29
29
  import type { GetFillsResponse } from '../models';
30
+ import type { GetOrderGroupResponse } from '../models';
30
31
  import type { GetOrderGroupsResponse } from '../models';
31
32
  import type { GetOrderQueuePositionResponse } from '../models';
32
33
  import type { GetOrderResponse } from '../models';
@@ -134,6 +135,14 @@ export declare const PortfolioApiAxiosParamCreator: (configuration?: Configurati
134
135
  * @throws {RequiredError}
135
136
  */
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>;
137
146
  /**
138
147
  * Get order groups for the logged-in user
139
148
  * @summary Get Order Groups
@@ -310,6 +319,14 @@ export declare const PortfolioApiFp: (configuration?: Configuration) => {
310
319
  * @throws {RequiredError}
311
320
  */
312
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>>;
313
330
  /**
314
331
  * Get order groups for the logged-in user
315
332
  * @summary Get Order Groups
@@ -486,6 +503,14 @@ export declare const PortfolioApiFactory: (configuration?: Configuration, basePa
486
503
  * @throws {RequiredError}
487
504
  */
488
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>;
489
514
  /**
490
515
  * Get order groups for the logged-in user
491
516
  * @summary Get Order Groups
@@ -576,7 +601,7 @@ export declare class PortfolioApi extends BaseAPI {
576
601
  * @param {*} [options] Override http request option.
577
602
  * @throws {RequiredError}
578
603
  */
579
- amendOrder(orderId: string, amendOrderRequest: AmendOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AmendOrderResponse, any>>;
604
+ amendOrder(orderId: string, amendOrderRequest: AmendOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AmendOrderResponse, any, {}>>;
580
605
  /**
581
606
  * Cancel multiple orders in a single request
582
607
  * @summary Batch Cancel Orders
@@ -584,7 +609,7 @@ export declare class PortfolioApi extends BaseAPI {
584
609
  * @param {*} [options] Override http request option.
585
610
  * @throws {RequiredError}
586
611
  */
587
- batchCancelOrders(batchCancelOrdersRequest: BatchCancelOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BatchCancelOrdersResponse, any>>;
612
+ batchCancelOrders(batchCancelOrdersRequest: BatchCancelOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BatchCancelOrdersResponse, any, {}>>;
588
613
  /**
589
614
  * Create multiple orders in a single request
590
615
  * @summary Batch Create Orders
@@ -592,7 +617,7 @@ export declare class PortfolioApi extends BaseAPI {
592
617
  * @param {*} [options] Override http request option.
593
618
  * @throws {RequiredError}
594
619
  */
595
- batchCreateOrders(batchCreateOrdersRequest: BatchCreateOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BatchCreateOrdersResponse, any>>;
620
+ batchCreateOrders(batchCreateOrdersRequest: BatchCreateOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BatchCreateOrdersResponse, any, {}>>;
596
621
  /**
597
622
  * Cancel an order
598
623
  * @summary Cancel Order
@@ -600,7 +625,7 @@ export declare class PortfolioApi extends BaseAPI {
600
625
  * @param {*} [options] Override http request option.
601
626
  * @throws {RequiredError}
602
627
  */
603
- cancelOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CancelOrderResponse, any>>;
628
+ cancelOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CancelOrderResponse, any, {}>>;
604
629
  /**
605
630
  * Create a new order
606
631
  * @summary Create Order
@@ -608,7 +633,7 @@ export declare class PortfolioApi extends BaseAPI {
608
633
  * @param {*} [options] Override http request option.
609
634
  * @throws {RequiredError}
610
635
  */
611
- createOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrderResponse, any>>;
636
+ createOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrderResponse, any, {}>>;
612
637
  /**
613
638
  * Create a new order group
614
639
  * @summary Create Order Group
@@ -616,7 +641,7 @@ export declare class PortfolioApi extends BaseAPI {
616
641
  * @param {*} [options] Override http request option.
617
642
  * @throws {RequiredError}
618
643
  */
619
- createOrderGroup(createOrderGroupRequest: CreateOrderGroupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrderGroupResponse, any>>;
644
+ createOrderGroup(createOrderGroupRequest: CreateOrderGroupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrderGroupResponse, any, {}>>;
620
645
  /**
621
646
  * Decrease the size of an existing order
622
647
  * @summary Decrease Order
@@ -625,7 +650,7 @@ export declare class PortfolioApi extends BaseAPI {
625
650
  * @param {*} [options] Override http request option.
626
651
  * @throws {RequiredError}
627
652
  */
628
- decreaseOrder(orderId: string, decreaseOrderRequest: DecreaseOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DecreaseOrderResponse, any>>;
653
+ decreaseOrder(orderId: string, decreaseOrderRequest: DecreaseOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DecreaseOrderResponse, any, {}>>;
629
654
  /**
630
655
  * Delete an order group
631
656
  * @summary Delete Order Group
@@ -633,14 +658,14 @@ export declare class PortfolioApi extends BaseAPI {
633
658
  * @param {*} [options] Override http request option.
634
659
  * @throws {RequiredError}
635
660
  */
636
- deleteOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
661
+ deleteOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
637
662
  /**
638
663
  * Get the user\'s current balance
639
664
  * @summary Get Balance
640
665
  * @param {*} [options] Override http request option.
641
666
  * @throws {RequiredError}
642
667
  */
643
- getBalance(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBalanceResponse, any>>;
668
+ getBalance(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBalanceResponse, any, {}>>;
644
669
  /**
645
670
  * Get fills for the logged-in user. A fill represents a partial or complete execution of an order. When an order matches with another order in the orderbook, a fill is created for each side of the trade.
646
671
  * @summary Get Fills
@@ -653,7 +678,7 @@ export declare class PortfolioApi extends BaseAPI {
653
678
  * @param {*} [options] Override http request option.
654
679
  * @throws {RequiredError}
655
680
  */
656
- getFills(ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFillsResponse, any>>;
681
+ getFills(ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFillsResponse, any, {}>>;
657
682
  /**
658
683
  * Get a single order by ID
659
684
  * @summary Get Order
@@ -661,7 +686,15 @@ export declare class PortfolioApi extends BaseAPI {
661
686
  * @param {*} [options] Override http request option.
662
687
  * @throws {RequiredError}
663
688
  */
664
- getOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderResponse, any>>;
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, {}>>;
665
698
  /**
666
699
  * Get order groups for the logged-in user
667
700
  * @summary Get Order Groups
@@ -671,7 +704,7 @@ export declare class PortfolioApi extends BaseAPI {
671
704
  * @param {*} [options] Override http request option.
672
705
  * @throws {RequiredError}
673
706
  */
674
- getOrderGroups(status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderGroupsResponse, any>>;
707
+ getOrderGroups(status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderGroupsResponse, any, {}>>;
675
708
  /**
676
709
  * Get the queue position for an order
677
710
  * @summary Get Order Queue Position
@@ -679,7 +712,7 @@ export declare class PortfolioApi extends BaseAPI {
679
712
  * @param {*} [options] Override http request option.
680
713
  * @throws {RequiredError}
681
714
  */
682
- getOrderQueuePosition(orderId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderQueuePositionResponse, any>>;
715
+ getOrderQueuePosition(orderId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderQueuePositionResponse, any, {}>>;
683
716
  /**
684
717
  * Get orders for the logged-in user
685
718
  * @summary Get Orders
@@ -693,7 +726,7 @@ export declare class PortfolioApi extends BaseAPI {
693
726
  * @param {*} [options] Override http request option.
694
727
  * @throws {RequiredError}
695
728
  */
696
- getOrders(ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrdersResponse, any>>;
729
+ getOrders(ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrdersResponse, any, {}>>;
697
730
  /**
698
731
  * Get positions for the logged-in user
699
732
  * @summary Get Positions
@@ -706,7 +739,7 @@ export declare class PortfolioApi extends BaseAPI {
706
739
  * @param {*} [options] Override http request option.
707
740
  * @throws {RequiredError}
708
741
  */
709
- getPositions(ticker?: string, eventTicker?: string, countDown?: number, countUp?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPositionsResponse, any>>;
742
+ getPositions(ticker?: string, eventTicker?: string, countDown?: number, countUp?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPositionsResponse, any, {}>>;
710
743
  /**
711
744
  * Get queue positions for multiple orders
712
745
  * @summary Get Queue Positions
@@ -714,7 +747,7 @@ export declare class PortfolioApi extends BaseAPI {
714
747
  * @param {*} [options] Override http request option.
715
748
  * @throws {RequiredError}
716
749
  */
717
- getQueuePositions(getQueuePositionsRequest: GetQueuePositionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetQueuePositionsResponse, any>>;
750
+ getQueuePositions(getQueuePositionsRequest: GetQueuePositionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetQueuePositionsResponse, any, {}>>;
718
751
  /**
719
752
  * Get settlements for the logged-in user
720
753
  * @summary Get Settlements
@@ -723,14 +756,14 @@ export declare class PortfolioApi extends BaseAPI {
723
756
  * @param {*} [options] Override http request option.
724
757
  * @throws {RequiredError}
725
758
  */
726
- getSettlements(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSettlementsResponse, any>>;
759
+ getSettlements(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSettlementsResponse, any, {}>>;
727
760
  /**
728
761
  * Get the total value of all resting orders
729
762
  * @summary Get Total Resting Order Value
730
763
  * @param {*} [options] Override http request option.
731
764
  * @throws {RequiredError}
732
765
  */
733
- getTotalRestingOrderValue(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTotalRestingOrderValueResponse, any>>;
766
+ getTotalRestingOrderValue(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTotalRestingOrderValueResponse, any, {}>>;
734
767
  /**
735
768
  * Reset an order group
736
769
  * @summary Reset Order Group
@@ -738,5 +771,5 @@ export declare class PortfolioApi extends BaseAPI {
738
771
  * @param {*} [options] Override http request option.
739
772
  * @throws {RequiredError}
740
773
  */
741
- resetOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
774
+ resetOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
742
775
  }