kalshi-typescript 2.1.3 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (880) hide show
  1. package/.openapi-generator/FILES +112 -42
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +110 -50
  4. package/api/api-keys-api.ts +52 -34
  5. package/api/collection-api.ts +506 -0
  6. package/api/communications-api.ts +284 -102
  7. package/api/events-api.ts +402 -53
  8. package/api/exchange-api.ts +99 -24
  9. package/api/fcm-api.ts +337 -0
  10. package/api/incentive-programs-api.ts +168 -0
  11. package/api/live-data-api.ts +207 -0
  12. package/api/market-api.ts +872 -0
  13. package/api/markets-api.ts +17 -18
  14. package/api/milestone-api.ts +258 -0
  15. package/api/milestones-api.ts +2 -3
  16. package/api/multivariate-api.ts +505 -0
  17. package/api/multivariate-collections-api.ts +7 -8
  18. package/api/order-groups-api.ts +454 -0
  19. package/api/orders-api.ts +941 -0
  20. package/api/portfolio-api.ts +206 -1357
  21. package/api/search-api.ts +183 -0
  22. package/api/series-api.ts +2 -3
  23. package/api/structured-targets-api.ts +44 -38
  24. package/api.ts +13 -8
  25. package/auth.ts +1 -1
  26. package/base.ts +8 -8
  27. package/common.ts +4 -4
  28. package/configuration.ts +4 -5
  29. package/dist/api/api-keys-api.d.ts +20 -20
  30. package/dist/api/api-keys-api.js +44 -32
  31. package/dist/api/collection-api.d.ts +242 -0
  32. package/dist/api/collection-api.js +467 -0
  33. package/dist/api/communications-api.d.ts +124 -60
  34. package/dist/api/communications-api.js +246 -102
  35. package/dist/api/events-api.d.ts +210 -36
  36. package/dist/api/events-api.js +370 -50
  37. package/dist/api/exchange-api.d.ts +57 -20
  38. package/dist/api/exchange-api.js +92 -23
  39. package/dist/api/fcm-api.d.ts +164 -0
  40. package/dist/api/fcm-api.js +313 -0
  41. package/dist/api/incentive-programs-api.d.ts +93 -0
  42. package/dist/api/incentive-programs-api.js +164 -0
  43. package/dist/api/live-data-api.d.ts +104 -0
  44. package/dist/api/live-data-api.js +205 -0
  45. package/dist/api/market-api.d.ts +417 -0
  46. package/dist/api/market-api.js +804 -0
  47. package/dist/api/milestone-api.d.ts +128 -0
  48. package/dist/api/milestone-api.js +249 -0
  49. package/dist/api/multivariate-api.d.ts +242 -0
  50. package/dist/api/multivariate-api.js +467 -0
  51. package/dist/api/order-groups-api.d.ts +198 -0
  52. package/dist/api/order-groups-api.js +421 -0
  53. package/dist/api/orders-api.d.ts +405 -0
  54. package/dist/api/orders-api.js +844 -0
  55. package/dist/api/portfolio-api.d.ts +83 -601
  56. package/dist/api/portfolio-api.js +154 -1203
  57. package/dist/api/search-api.d.ts +92 -0
  58. package/dist/api/search-api.js +182 -0
  59. package/dist/api/structured-targets-api.d.ts +32 -24
  60. package/dist/api/structured-targets-api.js +43 -35
  61. package/dist/api.d.ts +13 -8
  62. package/dist/api.js +13 -8
  63. package/dist/base.d.ts +4 -4
  64. package/dist/base.js +4 -4
  65. package/dist/common.d.ts +4 -4
  66. package/dist/common.js +4 -4
  67. package/dist/configuration.d.ts +4 -4
  68. package/dist/configuration.js +4 -4
  69. package/dist/esm/api/api-keys-api.d.ts +20 -20
  70. package/dist/esm/api/api-keys-api.js +45 -33
  71. package/dist/esm/api/collection-api.d.ts +242 -0
  72. package/dist/esm/api/collection-api.js +460 -0
  73. package/dist/esm/api/communications-api.d.ts +124 -60
  74. package/dist/esm/api/communications-api.js +247 -103
  75. package/dist/esm/api/events-api.d.ts +210 -36
  76. package/dist/esm/api/events-api.js +370 -50
  77. package/dist/esm/api/exchange-api.d.ts +57 -20
  78. package/dist/esm/api/exchange-api.js +93 -24
  79. package/dist/esm/api/fcm-api.d.ts +164 -0
  80. package/dist/esm/api/fcm-api.js +306 -0
  81. package/dist/esm/api/incentive-programs-api.d.ts +93 -0
  82. package/dist/esm/api/incentive-programs-api.js +157 -0
  83. package/dist/esm/api/live-data-api.d.ts +104 -0
  84. package/dist/esm/api/live-data-api.js +198 -0
  85. package/dist/esm/api/market-api.d.ts +417 -0
  86. package/dist/esm/api/market-api.js +797 -0
  87. package/dist/esm/api/milestone-api.d.ts +128 -0
  88. package/dist/esm/api/milestone-api.js +242 -0
  89. package/dist/esm/api/multivariate-api.d.ts +242 -0
  90. package/dist/esm/api/multivariate-api.js +460 -0
  91. package/dist/esm/api/order-groups-api.d.ts +198 -0
  92. package/dist/esm/api/order-groups-api.js +414 -0
  93. package/dist/esm/api/orders-api.d.ts +405 -0
  94. package/dist/esm/api/orders-api.js +837 -0
  95. package/dist/esm/api/portfolio-api.d.ts +83 -601
  96. package/dist/esm/api/portfolio-api.js +153 -1202
  97. package/dist/esm/api/search-api.d.ts +92 -0
  98. package/dist/esm/api/search-api.js +175 -0
  99. package/dist/esm/api/structured-targets-api.d.ts +32 -24
  100. package/dist/esm/api/structured-targets-api.js +44 -36
  101. package/dist/esm/api.d.ts +13 -8
  102. package/dist/esm/api.js +13 -8
  103. package/dist/esm/base.d.ts +4 -4
  104. package/dist/esm/base.js +4 -4
  105. package/dist/esm/common.d.ts +4 -4
  106. package/dist/esm/common.js +4 -4
  107. package/dist/esm/configuration.d.ts +4 -4
  108. package/dist/esm/configuration.js +4 -4
  109. package/dist/esm/index.d.ts +4 -4
  110. package/dist/esm/index.js +4 -4
  111. package/dist/esm/models/accept-quote-request.d.ts +13 -5
  112. package/dist/esm/models/accept-quote-request.js +8 -5
  113. package/dist/esm/models/amend-order-request.d.ts +27 -10
  114. package/dist/esm/models/amend-order-request.js +4 -4
  115. package/dist/esm/models/amend-order-response.d.ts +6 -5
  116. package/dist/esm/models/amend-order-response.js +4 -4
  117. package/dist/esm/models/announcement.d.ts +25 -13
  118. package/dist/esm/models/announcement.js +8 -8
  119. package/dist/esm/models/api-key.d.ts +4 -8
  120. package/dist/esm/models/api-key.js +4 -4
  121. package/dist/esm/models/associated-event.d.ts +33 -0
  122. package/dist/esm/models/associated-event.js +14 -0
  123. package/dist/esm/models/batch-cancel-orders-individual-response.d.ts +25 -0
  124. package/dist/esm/models/batch-cancel-orders-individual-response.js +14 -0
  125. package/dist/esm/models/batch-cancel-orders-request.d.ts +8 -5
  126. package/dist/esm/models/batch-cancel-orders-request.js +4 -4
  127. package/dist/esm/models/batch-cancel-orders-response.d.ts +6 -6
  128. package/dist/esm/models/batch-cancel-orders-response.js +4 -4
  129. package/dist/esm/models/batch-create-orders-individual-response.d.ts +18 -0
  130. package/dist/esm/models/batch-create-orders-individual-response.js +14 -0
  131. package/dist/esm/models/batch-create-orders-request.d.ts +4 -4
  132. package/dist/esm/models/batch-create-orders-request.js +4 -4
  133. package/dist/esm/models/batch-create-orders-response.d.ts +6 -6
  134. package/dist/esm/models/batch-create-orders-response.js +4 -4
  135. package/dist/esm/models/batch-get-market-candlesticks-response.d.ts +18 -0
  136. package/dist/esm/models/batch-get-market-candlesticks-response.js +14 -0
  137. package/dist/esm/models/bid-ask-distribution.d.ts +45 -0
  138. package/dist/esm/models/bid-ask-distribution.js +14 -0
  139. package/dist/esm/models/cancel-order-response.d.ts +6 -6
  140. package/dist/esm/models/cancel-order-response.js +4 -4
  141. package/dist/esm/models/create-api-key-request.d.ts +4 -4
  142. package/dist/esm/models/create-api-key-request.js +4 -4
  143. package/dist/esm/models/create-api-key-response.d.ts +4 -4
  144. package/dist/esm/models/create-api-key-response.js +4 -4
  145. package/dist/esm/models/create-market-in-multivariate-event-collection-request.d.ts +18 -0
  146. package/dist/esm/models/create-market-in-multivariate-event-collection-request.js +14 -0
  147. package/dist/esm/models/create-market-in-multivariate-event-collection-response.d.ts +21 -0
  148. package/dist/esm/models/create-market-in-multivariate-event-collection-response.js +14 -0
  149. package/dist/esm/models/create-order-group-request.d.ts +5 -5
  150. package/dist/esm/models/create-order-group-request.js +4 -4
  151. package/dist/esm/models/create-order-group-response.d.ts +5 -5
  152. package/dist/esm/models/create-order-group-response.js +4 -4
  153. package/dist/esm/models/create-order-request.d.ts +34 -9
  154. package/dist/esm/models/create-order-request.js +9 -4
  155. package/dist/esm/models/create-order-response.d.ts +5 -5
  156. package/dist/esm/models/create-order-response.js +4 -4
  157. package/dist/esm/models/create-quote-request.d.ts +19 -6
  158. package/dist/esm/models/create-quote-request.js +4 -4
  159. package/dist/esm/models/create-quote-response.d.ts +8 -6
  160. package/dist/esm/models/create-quote-response.js +4 -4
  161. package/dist/esm/models/create-rfqrequest.d.ts +28 -13
  162. package/dist/esm/models/create-rfqrequest.js +5 -8
  163. package/dist/esm/models/create-rfqresponse.d.ts +8 -6
  164. package/dist/esm/models/create-rfqresponse.js +4 -4
  165. package/dist/esm/models/daily-schedule.d.ts +12 -6
  166. package/dist/esm/models/daily-schedule.js +4 -4
  167. package/dist/esm/models/decrease-order-request.d.ts +6 -5
  168. package/dist/esm/models/decrease-order-request.js +4 -4
  169. package/dist/esm/models/decrease-order-response.d.ts +5 -5
  170. package/dist/esm/models/decrease-order-response.js +4 -4
  171. package/dist/esm/models/error-response.d.ts +20 -6
  172. package/dist/esm/models/error-response.js +4 -4
  173. package/dist/esm/models/event-data.d.ts +62 -0
  174. package/dist/esm/models/event-data.js +14 -0
  175. package/dist/esm/models/event-position.d.ts +24 -24
  176. package/dist/esm/models/event-position.js +4 -4
  177. package/dist/esm/models/exchange-status.d.ts +16 -6
  178. package/dist/esm/models/exchange-status.js +4 -4
  179. package/dist/esm/models/fill.d.ts +71 -12
  180. package/dist/esm/models/fill.js +4 -4
  181. package/dist/esm/models/forecast-percentiles-point.d.ts +30 -0
  182. package/dist/esm/models/forecast-percentiles-point.js +14 -0
  183. package/dist/esm/models/generate-api-key-request.d.ts +4 -4
  184. package/dist/esm/models/generate-api-key-request.js +4 -4
  185. package/dist/esm/models/generate-api-key-response.d.ts +4 -4
  186. package/dist/esm/models/generate-api-key-response.js +4 -4
  187. package/dist/esm/models/get-api-keys-response.d.ts +4 -4
  188. package/dist/esm/models/get-api-keys-response.js +4 -4
  189. package/dist/esm/models/get-balance-response.d.ts +14 -6
  190. package/dist/esm/models/get-balance-response.js +4 -4
  191. package/dist/esm/models/get-communications-idresponse.d.ts +6 -6
  192. package/dist/esm/models/get-communications-idresponse.js +4 -4
  193. package/dist/esm/models/get-event-candlesticks-response.d.ts +26 -0
  194. package/dist/esm/models/get-event-candlesticks-response.js +14 -0
  195. package/dist/esm/models/get-event-forecast-percentiles-history-response.d.ts +18 -0
  196. package/dist/esm/models/get-event-forecast-percentiles-history-response.js +14 -0
  197. package/dist/esm/models/get-event-metadata-response.d.ts +30 -5
  198. package/dist/esm/models/get-event-metadata-response.js +4 -4
  199. package/dist/esm/models/get-event-response.d.ts +10 -7
  200. package/dist/esm/models/get-event-response.js +4 -4
  201. package/dist/esm/models/get-events-candlesticks-response-events-inner.d.ts +30 -0
  202. package/dist/esm/models/get-events-candlesticks-response-events-inner.js +14 -0
  203. package/dist/esm/models/get-events-candlesticks-response.d.ts +18 -0
  204. package/dist/esm/models/get-events-candlesticks-response.js +14 -0
  205. package/dist/esm/models/get-events-response.d.ts +18 -7
  206. package/dist/esm/models/get-events-response.js +4 -4
  207. package/dist/esm/models/get-exchange-announcements-response.d.ts +8 -5
  208. package/dist/esm/models/get-exchange-announcements-response.js +4 -4
  209. package/dist/esm/models/get-exchange-schedule-response.d.ts +6 -6
  210. package/dist/esm/models/get-exchange-schedule-response.js +4 -4
  211. package/dist/esm/models/get-fills-response.d.ts +6 -6
  212. package/dist/esm/models/get-fills-response.js +4 -4
  213. package/dist/esm/models/get-filters-by-sports-response.d.ts +24 -0
  214. package/dist/esm/models/get-filters-by-sports-response.js +14 -0
  215. package/dist/esm/models/get-incentive-programs-response.d.ts +19 -0
  216. package/dist/esm/models/get-incentive-programs-response.js +14 -0
  217. package/dist/esm/models/get-live-data-response.d.ts +15 -0
  218. package/dist/esm/models/get-live-data-response.js +14 -0
  219. package/dist/esm/models/get-live-datas-response.d.ts +15 -0
  220. package/dist/esm/models/get-live-datas-response.js +14 -0
  221. package/dist/esm/models/get-market-candlesticks-response.d.ts +13 -6
  222. package/dist/esm/models/get-market-candlesticks-response.js +4 -4
  223. package/dist/esm/models/get-market-orderbook-response.d.ts +6 -6
  224. package/dist/esm/models/get-market-orderbook-response.js +4 -4
  225. package/dist/esm/models/get-market-response.d.ts +5 -5
  226. package/dist/esm/models/get-market-response.js +4 -4
  227. package/dist/esm/models/get-markets-response.d.ts +6 -6
  228. package/dist/esm/models/get-markets-response.js +4 -4
  229. package/dist/esm/models/get-milestone-response.d.ts +5 -5
  230. package/dist/esm/models/get-milestone-response.js +4 -4
  231. package/dist/esm/models/get-milestones-response.d.ts +12 -5
  232. package/dist/esm/models/get-milestones-response.js +4 -4
  233. package/dist/esm/models/get-multivariate-event-collection-lookup-history-response.d.ts +18 -0
  234. package/dist/esm/models/get-multivariate-event-collection-lookup-history-response.js +14 -0
  235. package/dist/esm/models/get-multivariate-event-collection-response.d.ts +5 -5
  236. package/dist/esm/models/get-multivariate-event-collection-response.js +4 -4
  237. package/dist/esm/models/get-multivariate-event-collections-response.d.ts +12 -5
  238. package/dist/esm/models/get-multivariate-event-collections-response.js +4 -4
  239. package/dist/esm/models/get-multivariate-events-response.d.ts +22 -0
  240. package/dist/esm/models/get-multivariate-events-response.js +14 -0
  241. package/dist/esm/models/get-order-group-response.d.ts +6 -6
  242. package/dist/esm/models/get-order-group-response.js +4 -4
  243. package/dist/esm/models/get-order-groups-response.d.ts +4 -5
  244. package/dist/esm/models/get-order-groups-response.js +4 -4
  245. package/dist/esm/models/get-order-queue-position-response.d.ts +8 -5
  246. package/dist/esm/models/get-order-queue-position-response.js +4 -4
  247. package/dist/esm/models/get-order-queue-positions-response.d.ts +18 -0
  248. package/dist/esm/models/get-order-queue-positions-response.js +14 -0
  249. package/dist/esm/models/get-order-response.d.ts +4 -4
  250. package/dist/esm/models/get-order-response.js +4 -4
  251. package/dist/esm/models/get-orders-response.d.ts +6 -6
  252. package/dist/esm/models/get-orders-response.js +4 -4
  253. package/dist/esm/models/get-portfolio-resting-order-total-value-response.d.ts +17 -0
  254. package/dist/esm/models/get-portfolio-resting-order-total-value-response.js +14 -0
  255. package/dist/esm/models/get-positions-response.d.ts +16 -7
  256. package/dist/esm/models/get-positions-response.js +4 -4
  257. package/dist/esm/models/get-quote-response.d.ts +5 -5
  258. package/dist/esm/models/get-quote-response.js +4 -4
  259. package/dist/esm/models/get-quotes-response.d.ts +12 -5
  260. package/dist/esm/models/get-quotes-response.js +4 -4
  261. package/dist/esm/models/get-rfqresponse.d.ts +5 -5
  262. package/dist/esm/models/get-rfqresponse.js +4 -4
  263. package/dist/esm/models/get-rfqs-response.d.ts +12 -5
  264. package/dist/esm/models/get-rfqs-response.js +4 -4
  265. package/dist/esm/models/get-series-fee-changes-response.d.ts +15 -0
  266. package/dist/esm/models/get-series-fee-changes-response.js +14 -0
  267. package/dist/esm/models/get-series-list-response.d.ts +15 -0
  268. package/dist/esm/models/get-series-list-response.js +14 -0
  269. package/dist/esm/models/get-series-response.d.ts +5 -5
  270. package/dist/esm/models/get-series-response.js +4 -4
  271. package/dist/esm/models/get-settlements-response.d.ts +5 -5
  272. package/dist/esm/models/get-settlements-response.js +4 -4
  273. package/dist/esm/models/get-structured-target-response.d.ts +4 -4
  274. package/dist/esm/models/get-structured-target-response.js +4 -4
  275. package/dist/esm/models/get-structured-targets-response.d.ts +8 -4
  276. package/dist/esm/models/get-structured-targets-response.js +4 -4
  277. package/dist/esm/models/get-tags-for-series-categories-response.d.ts +19 -0
  278. package/dist/esm/models/get-tags-for-series-categories-response.js +14 -0
  279. package/dist/esm/models/get-trades-response.d.ts +6 -6
  280. package/dist/esm/models/get-trades-response.js +4 -4
  281. package/dist/esm/models/get-user-data-timestamp-response.d.ts +8 -5
  282. package/dist/esm/models/get-user-data-timestamp-response.js +4 -4
  283. package/dist/esm/models/incentive-program.d.ts +54 -0
  284. package/dist/esm/models/incentive-program.js +17 -0
  285. package/dist/esm/models/index.d.ts +47 -17
  286. package/dist/esm/models/index.js +47 -17
  287. package/dist/esm/models/live-data.d.ts +27 -0
  288. package/dist/esm/models/live-data.js +14 -0
  289. package/dist/esm/models/lookup-point.d.ts +30 -0
  290. package/dist/esm/models/lookup-point.js +14 -0
  291. package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-request.d.ts +18 -0
  292. package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-request.js +14 -0
  293. package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-response.d.ts +21 -0
  294. package/dist/esm/models/lookup-tickers-for-market-in-multivariate-event-collection-response.js +14 -0
  295. package/dist/esm/models/maintenance-window.d.ts +21 -0
  296. package/dist/esm/models/maintenance-window.js +14 -0
  297. package/dist/esm/models/market-candlestick.d.ts +30 -0
  298. package/dist/esm/models/market-candlestick.js +14 -0
  299. package/dist/esm/models/market-candlesticks-response.d.ts +22 -0
  300. package/dist/esm/models/market-candlesticks-response.js +14 -0
  301. package/dist/esm/models/market-metadata.d.ts +25 -0
  302. package/dist/esm/models/market-metadata.js +14 -0
  303. package/dist/esm/models/market-position.d.ts +61 -0
  304. package/dist/esm/models/market-position.js +14 -0
  305. package/dist/esm/models/market.d.ts +219 -26
  306. package/dist/esm/models/market.js +21 -4
  307. package/dist/esm/models/milestone.d.ts +54 -7
  308. package/dist/esm/models/milestone.js +4 -4
  309. package/dist/esm/models/multivariate-event-collection.d.ts +61 -9
  310. package/dist/esm/models/multivariate-event-collection.js +4 -4
  311. package/dist/esm/models/mve-selected-leg.d.ts +25 -0
  312. package/dist/esm/models/mve-selected-leg.js +14 -0
  313. package/dist/esm/models/order-group.d.ts +5 -5
  314. package/dist/esm/models/order-group.js +4 -4
  315. package/dist/esm/models/order-queue-position.d.ts +25 -0
  316. package/dist/esm/models/order-queue-position.js +14 -0
  317. package/dist/esm/models/order-status.d.ts +20 -0
  318. package/dist/esm/models/order-status.js +21 -0
  319. package/dist/esm/models/order.d.ts +75 -29
  320. package/dist/esm/models/order.js +4 -10
  321. package/dist/esm/models/orderbook.d.ts +17 -0
  322. package/dist/esm/models/orderbook.js +14 -0
  323. package/dist/esm/models/percentile-point.d.ts +29 -0
  324. package/dist/esm/models/percentile-point.js +14 -0
  325. package/dist/esm/models/price-distribution.d.ts +77 -0
  326. package/dist/esm/models/price-distribution.js +14 -0
  327. package/dist/esm/models/price-range.d.ts +25 -0
  328. package/dist/esm/models/price-range.js +14 -0
  329. package/dist/esm/models/quote.d.ts +116 -17
  330. package/dist/esm/models/quote.js +14 -7
  331. package/dist/esm/models/rfq.d.ts +65 -16
  332. package/dist/esm/models/rfq.js +7 -7
  333. package/dist/esm/models/schedule.d.ts +23 -0
  334. package/dist/esm/models/schedule.js +14 -0
  335. package/dist/esm/models/scope-list.d.ts +17 -0
  336. package/dist/esm/models/scope-list.js +14 -0
  337. package/dist/esm/models/self-trade-prevention-type.d.ts +19 -0
  338. package/dist/esm/models/self-trade-prevention-type.js +20 -0
  339. package/dist/esm/models/series-fee-change.d.ts +39 -0
  340. package/dist/esm/models/series-fee-change.js +18 -0
  341. package/dist/esm/models/series.d.ts +57 -9
  342. package/dist/esm/models/series.js +9 -5
  343. package/dist/esm/models/settlement-source.d.ts +21 -0
  344. package/dist/esm/models/settlement-source.js +14 -0
  345. package/dist/esm/models/settlement.d.ts +48 -12
  346. package/dist/esm/models/settlement.js +8 -6
  347. package/dist/esm/models/sport-filter-details.d.ts +24 -0
  348. package/dist/esm/models/sport-filter-details.js +14 -0
  349. package/dist/esm/models/structured-target.d.ts +28 -7
  350. package/dist/esm/models/structured-target.js +4 -4
  351. package/dist/esm/models/ticker-pair.d.ts +30 -0
  352. package/dist/esm/models/ticker-pair.js +17 -0
  353. package/dist/esm/models/trade.d.ts +45 -11
  354. package/dist/esm/models/trade.js +6 -6
  355. package/dist/esm/models/weekly-schedule.d.ts +50 -0
  356. package/dist/esm/models/weekly-schedule.js +14 -0
  357. package/dist/index.d.ts +4 -4
  358. package/dist/index.js +4 -4
  359. package/dist/models/accept-quote-request.d.ts +13 -5
  360. package/dist/models/accept-quote-request.js +9 -4
  361. package/dist/models/amend-order-request.d.ts +27 -10
  362. package/dist/models/amend-order-request.js +4 -4
  363. package/dist/models/amend-order-response.d.ts +6 -5
  364. package/dist/models/amend-order-response.js +4 -4
  365. package/dist/models/announcement.d.ts +25 -13
  366. package/dist/models/announcement.js +9 -9
  367. package/dist/models/api-key.d.ts +4 -8
  368. package/dist/models/api-key.js +4 -4
  369. package/dist/models/associated-event.d.ts +33 -0
  370. package/dist/models/associated-event.js +15 -0
  371. package/dist/models/batch-cancel-orders-individual-response.d.ts +25 -0
  372. package/dist/models/batch-cancel-orders-individual-response.js +15 -0
  373. package/dist/models/batch-cancel-orders-request.d.ts +8 -5
  374. package/dist/models/batch-cancel-orders-request.js +4 -4
  375. package/dist/models/batch-cancel-orders-response.d.ts +6 -6
  376. package/dist/models/batch-cancel-orders-response.js +4 -4
  377. package/dist/models/batch-create-orders-individual-response.d.ts +18 -0
  378. package/dist/models/batch-create-orders-individual-response.js +15 -0
  379. package/dist/models/batch-create-orders-request.d.ts +4 -4
  380. package/dist/models/batch-create-orders-request.js +4 -4
  381. package/dist/models/batch-create-orders-response.d.ts +6 -6
  382. package/dist/models/batch-create-orders-response.js +4 -4
  383. package/dist/models/batch-get-market-candlesticks-response.d.ts +18 -0
  384. package/dist/models/batch-get-market-candlesticks-response.js +15 -0
  385. package/dist/models/bid-ask-distribution.d.ts +45 -0
  386. package/dist/models/bid-ask-distribution.js +15 -0
  387. package/dist/models/cancel-order-response.d.ts +6 -6
  388. package/dist/models/cancel-order-response.js +4 -4
  389. package/dist/models/create-api-key-request.d.ts +4 -4
  390. package/dist/models/create-api-key-request.js +4 -4
  391. package/dist/models/create-api-key-response.d.ts +4 -4
  392. package/dist/models/create-api-key-response.js +4 -4
  393. package/dist/models/create-market-in-multivariate-event-collection-request.d.ts +18 -0
  394. package/dist/models/create-market-in-multivariate-event-collection-request.js +15 -0
  395. package/dist/models/create-market-in-multivariate-event-collection-response.d.ts +21 -0
  396. package/dist/models/create-market-in-multivariate-event-collection-response.js +15 -0
  397. package/dist/models/create-order-group-request.d.ts +5 -5
  398. package/dist/models/create-order-group-request.js +4 -4
  399. package/dist/models/create-order-group-response.d.ts +5 -5
  400. package/dist/models/create-order-group-response.js +4 -4
  401. package/dist/models/create-order-request.d.ts +34 -9
  402. package/dist/models/create-order-request.js +10 -5
  403. package/dist/models/create-order-response.d.ts +5 -5
  404. package/dist/models/create-order-response.js +4 -4
  405. package/dist/models/create-quote-request.d.ts +19 -6
  406. package/dist/models/create-quote-request.js +4 -4
  407. package/dist/models/create-quote-response.d.ts +8 -6
  408. package/dist/models/create-quote-response.js +4 -4
  409. package/dist/models/create-rfqrequest.d.ts +28 -13
  410. package/dist/models/create-rfqrequest.js +4 -9
  411. package/dist/models/create-rfqresponse.d.ts +8 -6
  412. package/dist/models/create-rfqresponse.js +4 -4
  413. package/dist/models/daily-schedule.d.ts +12 -6
  414. package/dist/models/daily-schedule.js +4 -4
  415. package/dist/models/decrease-order-request.d.ts +6 -5
  416. package/dist/models/decrease-order-request.js +4 -4
  417. package/dist/models/decrease-order-response.d.ts +5 -5
  418. package/dist/models/decrease-order-response.js +4 -4
  419. package/dist/models/error-response.d.ts +20 -6
  420. package/dist/models/error-response.js +4 -4
  421. package/dist/models/event-data.d.ts +62 -0
  422. package/dist/models/event-data.js +15 -0
  423. package/dist/models/event-position.d.ts +24 -24
  424. package/dist/models/event-position.js +4 -4
  425. package/dist/models/exchange-status.d.ts +16 -6
  426. package/dist/models/exchange-status.js +4 -4
  427. package/dist/models/fill.d.ts +71 -12
  428. package/dist/models/fill.js +4 -4
  429. package/dist/models/forecast-percentiles-point.d.ts +30 -0
  430. package/dist/models/forecast-percentiles-point.js +15 -0
  431. package/dist/models/generate-api-key-request.d.ts +4 -4
  432. package/dist/models/generate-api-key-request.js +4 -4
  433. package/dist/models/generate-api-key-response.d.ts +4 -4
  434. package/dist/models/generate-api-key-response.js +4 -4
  435. package/dist/models/get-api-keys-response.d.ts +4 -4
  436. package/dist/models/get-api-keys-response.js +4 -4
  437. package/dist/models/get-balance-response.d.ts +14 -6
  438. package/dist/models/get-balance-response.js +4 -4
  439. package/dist/models/get-communications-idresponse.d.ts +6 -6
  440. package/dist/models/get-communications-idresponse.js +4 -4
  441. package/dist/models/get-event-candlesticks-response.d.ts +26 -0
  442. package/dist/models/get-event-candlesticks-response.js +15 -0
  443. package/dist/models/get-event-forecast-percentiles-history-response.d.ts +18 -0
  444. package/dist/models/get-event-forecast-percentiles-history-response.js +15 -0
  445. package/dist/models/get-event-metadata-response.d.ts +30 -5
  446. package/dist/models/get-event-metadata-response.js +4 -4
  447. package/dist/models/get-event-response.d.ts +10 -7
  448. package/dist/models/get-event-response.js +4 -4
  449. package/dist/models/get-events-candlesticks-response-events-inner.d.ts +30 -0
  450. package/dist/models/get-events-candlesticks-response-events-inner.js +15 -0
  451. package/dist/models/get-events-candlesticks-response.d.ts +18 -0
  452. package/dist/models/get-events-candlesticks-response.js +15 -0
  453. package/dist/models/get-events-response.d.ts +18 -7
  454. package/dist/models/get-events-response.js +4 -4
  455. package/dist/models/get-exchange-announcements-response.d.ts +8 -5
  456. package/dist/models/get-exchange-announcements-response.js +4 -4
  457. package/dist/models/get-exchange-schedule-response.d.ts +6 -6
  458. package/dist/models/get-exchange-schedule-response.js +4 -4
  459. package/dist/models/get-fills-response.d.ts +6 -6
  460. package/dist/models/get-fills-response.js +4 -4
  461. package/dist/models/get-filters-by-sports-response.d.ts +24 -0
  462. package/dist/models/get-filters-by-sports-response.js +15 -0
  463. package/dist/models/get-incentive-programs-response.d.ts +19 -0
  464. package/dist/models/get-incentive-programs-response.js +15 -0
  465. package/dist/models/get-live-data-response.d.ts +15 -0
  466. package/dist/models/get-live-data-response.js +15 -0
  467. package/dist/models/get-live-datas-response.d.ts +15 -0
  468. package/dist/models/get-live-datas-response.js +15 -0
  469. package/dist/models/get-market-candlesticks-response.d.ts +13 -6
  470. package/dist/models/get-market-candlesticks-response.js +4 -4
  471. package/dist/models/get-market-orderbook-response.d.ts +6 -6
  472. package/dist/models/get-market-orderbook-response.js +4 -4
  473. package/dist/models/get-market-response.d.ts +5 -5
  474. package/dist/models/get-market-response.js +4 -4
  475. package/dist/models/get-markets-response.d.ts +6 -6
  476. package/dist/models/get-markets-response.js +4 -4
  477. package/dist/models/get-milestone-response.d.ts +5 -5
  478. package/dist/models/get-milestone-response.js +4 -4
  479. package/dist/models/get-milestones-response.d.ts +12 -5
  480. package/dist/models/get-milestones-response.js +4 -4
  481. package/dist/models/get-multivariate-event-collection-lookup-history-response.d.ts +18 -0
  482. package/dist/models/get-multivariate-event-collection-lookup-history-response.js +15 -0
  483. package/dist/models/get-multivariate-event-collection-response.d.ts +5 -5
  484. package/dist/models/get-multivariate-event-collection-response.js +4 -4
  485. package/dist/models/get-multivariate-event-collections-response.d.ts +12 -5
  486. package/dist/models/get-multivariate-event-collections-response.js +4 -4
  487. package/dist/models/get-multivariate-events-response.d.ts +22 -0
  488. package/dist/models/get-multivariate-events-response.js +15 -0
  489. package/dist/models/get-order-group-response.d.ts +6 -6
  490. package/dist/models/get-order-group-response.js +4 -4
  491. package/dist/models/get-order-groups-response.d.ts +4 -5
  492. package/dist/models/get-order-groups-response.js +4 -4
  493. package/dist/models/get-order-queue-position-response.d.ts +8 -5
  494. package/dist/models/get-order-queue-position-response.js +4 -4
  495. package/dist/models/get-order-queue-positions-response.d.ts +18 -0
  496. package/dist/models/get-order-queue-positions-response.js +15 -0
  497. package/dist/models/get-order-response.d.ts +4 -4
  498. package/dist/models/get-order-response.js +4 -4
  499. package/dist/models/get-orders-response.d.ts +6 -6
  500. package/dist/models/get-orders-response.js +4 -4
  501. package/dist/models/get-portfolio-resting-order-total-value-response.d.ts +17 -0
  502. package/dist/models/get-portfolio-resting-order-total-value-response.js +15 -0
  503. package/dist/models/get-positions-response.d.ts +16 -7
  504. package/dist/models/get-positions-response.js +4 -4
  505. package/dist/models/get-quote-response.d.ts +5 -5
  506. package/dist/models/get-quote-response.js +4 -4
  507. package/dist/models/get-quotes-response.d.ts +12 -5
  508. package/dist/models/get-quotes-response.js +4 -4
  509. package/dist/models/get-rfqresponse.d.ts +5 -5
  510. package/dist/models/get-rfqresponse.js +4 -4
  511. package/dist/models/get-rfqs-response.d.ts +12 -5
  512. package/dist/models/get-rfqs-response.js +4 -4
  513. package/dist/models/get-series-fee-changes-response.d.ts +15 -0
  514. package/dist/models/get-series-fee-changes-response.js +15 -0
  515. package/dist/models/get-series-list-response.d.ts +15 -0
  516. package/dist/models/get-series-list-response.js +15 -0
  517. package/dist/models/get-series-response.d.ts +5 -5
  518. package/dist/models/get-series-response.js +4 -4
  519. package/dist/models/get-settlements-response.d.ts +5 -5
  520. package/dist/models/get-settlements-response.js +4 -4
  521. package/dist/models/get-structured-target-response.d.ts +4 -4
  522. package/dist/models/get-structured-target-response.js +4 -4
  523. package/dist/models/get-structured-targets-response.d.ts +8 -4
  524. package/dist/models/get-structured-targets-response.js +4 -4
  525. package/dist/models/get-tags-for-series-categories-response.d.ts +19 -0
  526. package/dist/models/get-tags-for-series-categories-response.js +15 -0
  527. package/dist/models/get-trades-response.d.ts +6 -6
  528. package/dist/models/get-trades-response.js +4 -4
  529. package/dist/models/get-user-data-timestamp-response.d.ts +8 -5
  530. package/dist/models/get-user-data-timestamp-response.js +4 -4
  531. package/dist/models/incentive-program.d.ts +54 -0
  532. package/dist/models/incentive-program.js +20 -0
  533. package/dist/models/index.d.ts +47 -17
  534. package/dist/models/index.js +47 -17
  535. package/dist/models/live-data.d.ts +27 -0
  536. package/dist/models/live-data.js +15 -0
  537. package/dist/models/lookup-point.d.ts +30 -0
  538. package/dist/models/lookup-point.js +15 -0
  539. package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-request.d.ts +18 -0
  540. package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-request.js +15 -0
  541. package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-response.d.ts +21 -0
  542. package/dist/models/lookup-tickers-for-market-in-multivariate-event-collection-response.js +15 -0
  543. package/dist/models/maintenance-window.d.ts +21 -0
  544. package/dist/models/maintenance-window.js +15 -0
  545. package/dist/models/market-candlestick.d.ts +30 -0
  546. package/dist/models/market-candlestick.js +15 -0
  547. package/dist/models/market-candlesticks-response.d.ts +22 -0
  548. package/dist/models/market-candlesticks-response.js +15 -0
  549. package/dist/models/market-metadata.d.ts +25 -0
  550. package/dist/models/market-metadata.js +15 -0
  551. package/dist/models/market-position.d.ts +61 -0
  552. package/dist/models/market-position.js +15 -0
  553. package/dist/models/market.d.ts +219 -26
  554. package/dist/models/market.js +22 -5
  555. package/dist/models/milestone.d.ts +54 -7
  556. package/dist/models/milestone.js +4 -4
  557. package/dist/models/multivariate-event-collection.d.ts +61 -9
  558. package/dist/models/multivariate-event-collection.js +4 -4
  559. package/dist/models/mve-selected-leg.d.ts +25 -0
  560. package/dist/models/mve-selected-leg.js +15 -0
  561. package/dist/models/order-group.d.ts +5 -5
  562. package/dist/models/order-group.js +4 -4
  563. package/dist/models/order-queue-position.d.ts +25 -0
  564. package/dist/models/order-queue-position.js +15 -0
  565. package/dist/models/order-status.d.ts +20 -0
  566. package/dist/models/order-status.js +24 -0
  567. package/dist/models/order.d.ts +75 -29
  568. package/dist/models/order.js +5 -11
  569. package/dist/models/orderbook.d.ts +17 -0
  570. package/dist/models/orderbook.js +15 -0
  571. package/dist/models/percentile-point.d.ts +29 -0
  572. package/dist/models/percentile-point.js +15 -0
  573. package/dist/models/price-distribution.d.ts +77 -0
  574. package/dist/models/price-distribution.js +15 -0
  575. package/dist/models/price-range.d.ts +25 -0
  576. package/dist/models/price-range.js +15 -0
  577. package/dist/models/quote.d.ts +116 -17
  578. package/dist/models/quote.js +15 -8
  579. package/dist/models/rfq.d.ts +65 -16
  580. package/dist/models/rfq.js +8 -8
  581. package/dist/models/schedule.d.ts +23 -0
  582. package/dist/models/schedule.js +15 -0
  583. package/dist/models/scope-list.d.ts +17 -0
  584. package/dist/models/scope-list.js +15 -0
  585. package/dist/models/self-trade-prevention-type.d.ts +19 -0
  586. package/dist/models/self-trade-prevention-type.js +23 -0
  587. package/dist/models/series-fee-change.d.ts +39 -0
  588. package/dist/models/series-fee-change.js +21 -0
  589. package/dist/models/series.d.ts +57 -9
  590. package/dist/models/series.js +10 -4
  591. package/dist/models/settlement-source.d.ts +21 -0
  592. package/dist/models/settlement-source.js +15 -0
  593. package/dist/models/settlement.d.ts +48 -12
  594. package/dist/models/settlement.js +9 -7
  595. package/dist/models/sport-filter-details.d.ts +24 -0
  596. package/dist/models/sport-filter-details.js +15 -0
  597. package/dist/models/structured-target.d.ts +28 -7
  598. package/dist/models/structured-target.js +4 -4
  599. package/dist/models/ticker-pair.d.ts +30 -0
  600. package/dist/models/ticker-pair.js +20 -0
  601. package/dist/models/trade.d.ts +45 -11
  602. package/dist/models/trade.js +6 -6
  603. package/dist/models/weekly-schedule.d.ts +50 -0
  604. package/dist/models/weekly-schedule.js +15 -0
  605. package/docs/AcceptQuoteRequest.md +2 -2
  606. package/docs/AmendOrderRequest.md +12 -8
  607. package/docs/AmendOrderResponse.md +3 -1
  608. package/docs/Announcement.md +6 -6
  609. package/docs/ApiKey.md +0 -2
  610. package/docs/ApiKeysApi.md +16 -106
  611. package/docs/AssociatedEvent.md +28 -0
  612. package/docs/BatchCancelOrdersIndividualResponse.md +26 -0
  613. package/docs/BatchCancelOrdersRequest.md +2 -2
  614. package/docs/BatchCancelOrdersResponse.md +2 -2
  615. package/docs/BatchCreateOrdersIndividualResponse.md +24 -0
  616. package/docs/BatchCreateOrdersResponse.md +2 -2
  617. package/docs/BatchGetMarketCandlesticksResponse.md +20 -0
  618. package/docs/BidAskDistribution.md +34 -0
  619. package/docs/CancelOrderResponse.md +2 -2
  620. package/docs/CollectionApi.md +318 -0
  621. package/docs/CommunicationsApi.md +46 -271
  622. package/docs/CreateMarketInMultivariateEventCollectionRequest.md +20 -0
  623. package/docs/CreateMarketInMultivariateEventCollectionResponse.md +22 -0
  624. package/docs/CreateOrderGroupRequest.md +1 -1
  625. package/docs/CreateOrderGroupResponse.md +1 -1
  626. package/docs/CreateOrderRequest.md +18 -6
  627. package/docs/CreateOrderResponse.md +1 -1
  628. package/docs/CreateQuoteRequest.md +7 -5
  629. package/docs/CreateQuoteResponse.md +2 -2
  630. package/docs/CreateRFQRequest.md +12 -8
  631. package/docs/CreateRFQResponse.md +2 -2
  632. package/docs/DailySchedule.md +2 -2
  633. package/docs/DecreaseOrderRequest.md +3 -1
  634. package/docs/DecreaseOrderResponse.md +1 -1
  635. package/docs/ErrorResponse.md +8 -2
  636. package/docs/EventData.md +42 -0
  637. package/docs/EventPosition.md +11 -11
  638. package/docs/EventsApi.md +133 -93
  639. package/docs/ExchangeApi.md +42 -83
  640. package/docs/ExchangeStatus.md +4 -2
  641. package/docs/FcmApi.md +92 -0
  642. package/docs/Fill.md +25 -9
  643. package/docs/ForecastPercentilesPoint.md +26 -0
  644. package/docs/GetBalanceResponse.md +5 -1
  645. package/docs/GetCommunicationsIDResponse.md +1 -1
  646. package/docs/GetEventCandlesticksResponse.md +24 -0
  647. package/docs/GetEventForecastPercentilesHistoryResponse.md +20 -0
  648. package/docs/GetEventMetadataResponse.md +12 -2
  649. package/docs/GetEventResponse.md +2 -2
  650. package/docs/GetEventsCandlesticksResponse.md +20 -0
  651. package/docs/GetEventsCandlesticksResponseEventsInner.md +26 -0
  652. package/docs/GetEventsResponse.md +4 -2
  653. package/docs/GetExchangeAnnouncementsResponse.md +1 -1
  654. package/docs/GetExchangeScheduleResponse.md +1 -1
  655. package/docs/GetFillsResponse.md +2 -2
  656. package/docs/GetFiltersBySportsResponse.md +22 -0
  657. package/docs/GetIncentiveProgramsResponse.md +22 -0
  658. package/docs/GetLiveDataResponse.md +20 -0
  659. package/docs/GetLiveDatasResponse.md +20 -0
  660. package/docs/GetMarketCandlesticksResponse.md +3 -1
  661. package/docs/GetMarketOrderbookResponse.md +1 -1
  662. package/docs/GetMarketResponse.md +1 -1
  663. package/docs/GetMarketsResponse.md +2 -2
  664. package/docs/GetMilestoneResponse.md +1 -1
  665. package/docs/GetMilestonesResponse.md +3 -1
  666. package/docs/GetMultivariateEventCollectionLookupHistoryResponse.md +20 -0
  667. package/docs/GetMultivariateEventCollectionResponse.md +2 -2
  668. package/docs/GetMultivariateEventCollectionsResponse.md +4 -2
  669. package/docs/GetMultivariateEventsResponse.md +22 -0
  670. package/docs/GetOrderGroupResponse.md +2 -2
  671. package/docs/GetOrderGroupsResponse.md +0 -2
  672. package/docs/GetOrderQueuePositionResponse.md +1 -1
  673. package/docs/GetOrderQueuePositionsResponse.md +20 -0
  674. package/docs/GetOrdersResponse.md +2 -2
  675. package/docs/GetPortfolioRestingOrderTotalValueResponse.md +20 -0
  676. package/docs/GetPositionsResponse.md +4 -4
  677. package/docs/GetQuoteResponse.md +1 -1
  678. package/docs/GetQuotesResponse.md +3 -1
  679. package/docs/GetRFQResponse.md +1 -1
  680. package/docs/GetRFQsResponse.md +3 -1
  681. package/docs/GetSeriesFeeChangesResponse.md +20 -0
  682. package/docs/GetSeriesListResponse.md +20 -0
  683. package/docs/GetSeriesResponse.md +1 -1
  684. package/docs/GetSettlementsResponse.md +1 -1
  685. package/docs/GetStructuredTargetsResponse.md +2 -0
  686. package/docs/GetTagsForSeriesCategoriesResponse.md +20 -0
  687. package/docs/GetTradesResponse.md +2 -2
  688. package/docs/GetUserDataTimestampResponse.md +2 -2
  689. package/docs/IncentiveProgram.md +36 -0
  690. package/docs/IncentiveProgramsApi.md +44 -0
  691. package/docs/LiveData.md +24 -0
  692. package/docs/LiveDataApi.md +75 -0
  693. package/docs/LookupPoint.md +26 -0
  694. package/docs/LookupTickersForMarketInMultivariateEventCollectionRequest.md +20 -0
  695. package/docs/LookupTickersForMarketInMultivariateEventCollectionResponse.md +22 -0
  696. package/docs/MaintenanceWindow.md +22 -0
  697. package/docs/Market.md +105 -21
  698. package/docs/MarketApi.md +311 -0
  699. package/docs/MarketCandlestick.md +30 -0
  700. package/docs/MarketCandlesticksResponse.md +22 -0
  701. package/docs/MarketMetadata.md +24 -0
  702. package/docs/MarketPosition.md +42 -0
  703. package/docs/MarketsApi.md +3 -4
  704. package/docs/Milestone.md +23 -5
  705. package/docs/MilestoneApi.md +85 -0
  706. package/docs/MilestonesApi.md +0 -1
  707. package/docs/MultivariateApi.md +188 -0
  708. package/docs/MultivariateCollectionsApi.md +0 -1
  709. package/docs/MultivariateEventCollection.md +26 -6
  710. package/docs/MveSelectedLeg.md +24 -0
  711. package/docs/Order.md +42 -18
  712. package/docs/OrderGroup.md +1 -1
  713. package/docs/OrderGroupsApi.md +180 -0
  714. package/docs/OrderQueuePosition.md +24 -0
  715. package/docs/OrderStatus.md +13 -0
  716. package/docs/Orderbook.md +26 -0
  717. package/docs/OrdersApi.md +372 -0
  718. package/docs/PercentilePoint.md +26 -0
  719. package/docs/PortfolioApi.md +27 -1062
  720. package/docs/PriceDistribution.md +50 -0
  721. package/docs/PriceRange.md +24 -0
  722. package/docs/Quote.md +48 -16
  723. package/docs/RFQ.md +26 -14
  724. package/docs/Schedule.md +22 -0
  725. package/docs/ScopeList.md +20 -0
  726. package/docs/SearchApi.md +69 -0
  727. package/docs/SelfTradePreventionType.md +11 -0
  728. package/docs/Series.md +21 -5
  729. package/docs/SeriesApi.md +0 -1
  730. package/docs/SeriesFeeChange.md +28 -0
  731. package/docs/Settlement.md +15 -7
  732. package/docs/SettlementSource.md +22 -0
  733. package/docs/SportFilterDetails.md +22 -0
  734. package/docs/StructuredTarget.md +12 -6
  735. package/docs/StructuredTargetsApi.md +11 -57
  736. package/docs/TickerPair.md +24 -0
  737. package/docs/Trade.md +14 -6
  738. package/docs/WeeklySchedule.md +36 -0
  739. package/index.ts +4 -4
  740. package/models/accept-quote-request.ts +16 -5
  741. package/models/amend-order-request.ts +27 -10
  742. package/models/amend-order-response.ts +6 -5
  743. package/models/announcement.ts +26 -14
  744. package/models/api-key.ts +4 -8
  745. package/models/associated-event.ts +39 -0
  746. package/models/batch-cancel-orders-individual-response.ts +35 -0
  747. package/models/batch-cancel-orders-request.ts +8 -5
  748. package/models/batch-cancel-orders-response-responses-inner.ts +0 -1
  749. package/models/batch-cancel-orders-response.ts +6 -6
  750. package/models/batch-create-orders-individual-response.ts +28 -0
  751. package/models/batch-create-orders-request.ts +4 -4
  752. package/models/batch-create-orders-response-responses-inner.ts +0 -1
  753. package/models/batch-create-orders-response.ts +6 -6
  754. package/models/batch-get-market-candlesticks-response.ts +26 -0
  755. package/models/bid-ask-distribution.ts +51 -0
  756. package/models/cancel-order-response.ts +6 -6
  757. package/models/candlestick.ts +0 -1
  758. package/models/create-api-key-request.ts +4 -4
  759. package/models/create-api-key-response.ts +4 -4
  760. package/models/create-market-in-multivariate-event-collection-request.ts +26 -0
  761. package/models/create-market-in-multivariate-event-collection-response.ts +27 -0
  762. package/models/create-order-group-request.ts +5 -5
  763. package/models/create-order-group-response.ts +5 -5
  764. package/models/create-order-request.ts +37 -9
  765. package/models/create-order-response.ts +5 -5
  766. package/models/create-quote-request.ts +19 -6
  767. package/models/create-quote-response.ts +8 -8
  768. package/models/create-rfqrequest.ts +28 -16
  769. package/models/create-rfqresponse.ts +8 -8
  770. package/models/daily-schedule.ts +12 -6
  771. package/models/decrease-order-request.ts +6 -5
  772. package/models/decrease-order-response.ts +5 -5
  773. package/models/error-response-error.ts +0 -1
  774. package/models/error-response.ts +20 -8
  775. package/models/event-data.ts +70 -0
  776. package/models/event-position.ts +24 -24
  777. package/models/event.ts +0 -2
  778. package/models/exchange-status.ts +16 -6
  779. package/models/fill.ts +71 -12
  780. package/models/forecast-percentiles-point.ts +38 -0
  781. package/models/generate-api-key-request.ts +4 -4
  782. package/models/generate-api-key-response.ts +4 -4
  783. package/models/get-api-keys-response.ts +4 -4
  784. package/models/get-balance-response.ts +14 -6
  785. package/models/get-communications-idresponse.ts +6 -6
  786. package/models/get-event-candlesticks-response.ts +34 -0
  787. package/models/get-event-forecast-percentiles-history-response.ts +26 -0
  788. package/models/get-event-metadata-response.ts +34 -5
  789. package/models/get-event-response.ts +10 -7
  790. package/models/get-events-candlesticks-response-events-inner.ts +38 -0
  791. package/models/get-events-candlesticks-response.ts +26 -0
  792. package/models/get-events-response.ts +20 -7
  793. package/models/get-exchange-announcements-response.ts +8 -5
  794. package/models/get-exchange-schedule-response-schedule.ts +0 -1
  795. package/models/get-exchange-schedule-response.ts +6 -6
  796. package/models/get-fills-response.ts +6 -6
  797. package/models/get-filters-by-sports-response.ts +30 -0
  798. package/models/get-incentive-programs-response.ts +27 -0
  799. package/models/get-live-data-response.ts +23 -0
  800. package/models/get-live-datas-response.ts +23 -0
  801. package/models/get-market-candlesticks-response.ts +13 -6
  802. package/models/get-market-orderbook-response-orderbook.ts +0 -1
  803. package/models/get-market-orderbook-response.ts +6 -6
  804. package/models/get-market-response.ts +5 -5
  805. package/models/get-markets-response.ts +6 -6
  806. package/models/get-milestone-response.ts +5 -5
  807. package/models/get-milestones-response.ts +12 -5
  808. package/models/get-multivariate-event-collection-lookup-history-response.ts +26 -0
  809. package/models/get-multivariate-event-collection-response.ts +5 -5
  810. package/models/get-multivariate-event-collections-response.ts +12 -5
  811. package/models/get-multivariate-events-response.ts +30 -0
  812. package/models/get-order-group-response.ts +6 -6
  813. package/models/get-order-groups-response.ts +4 -5
  814. package/models/get-order-queue-position-response.ts +8 -5
  815. package/models/get-order-queue-positions-response.ts +26 -0
  816. package/models/get-order-response.ts +4 -4
  817. package/models/get-orders-response.ts +6 -6
  818. package/models/get-portfolio-resting-order-total-value-response.ts +23 -0
  819. package/models/get-positions-response.ts +16 -7
  820. package/models/get-queue-positions-request.ts +0 -1
  821. package/models/get-queue-positions-response.ts +0 -1
  822. package/models/get-quote-response.ts +5 -5
  823. package/models/get-quotes-response.ts +12 -5
  824. package/models/get-rfqresponse.ts +5 -5
  825. package/models/get-rfqs-response.ts +12 -5
  826. package/models/get-series-by-ticker-response.ts +0 -1
  827. package/models/get-series-fee-changes-response.ts +23 -0
  828. package/models/get-series-list-response.ts +23 -0
  829. package/models/get-series-response.ts +5 -5
  830. package/models/get-settlements-response.ts +5 -5
  831. package/models/get-structured-target-response.ts +4 -4
  832. package/models/get-structured-targets-response.ts +8 -4
  833. package/models/get-tags-for-series-categories-response.ts +23 -0
  834. package/models/get-total-resting-order-value-response.ts +0 -1
  835. package/models/get-trades-response.ts +6 -6
  836. package/models/get-user-data-timestamp-response.ts +8 -5
  837. package/models/incentive-program.ts +63 -0
  838. package/models/index.ts +47 -17
  839. package/models/live-data.ts +31 -0
  840. package/models/lookup-bundle-request-bundle-inner.ts +0 -1
  841. package/models/lookup-bundle-request.ts +0 -1
  842. package/models/lookup-bundle-response.ts +0 -1
  843. package/models/lookup-point.ts +38 -0
  844. package/models/lookup-tickers-for-market-in-multivariate-event-collection-request.ts +26 -0
  845. package/models/lookup-tickers-for-market-in-multivariate-event-collection-response.ts +27 -0
  846. package/models/maintenance-window.ts +27 -0
  847. package/models/market-candlestick.ts +40 -0
  848. package/models/market-candlesticks-response.ts +30 -0
  849. package/models/market-metadata.ts +31 -0
  850. package/models/market-position.ts +67 -0
  851. package/models/market.ts +226 -26
  852. package/models/milestone.ts +52 -7
  853. package/models/multivariate-event-collection-events-inner.ts +0 -1
  854. package/models/multivariate-event-collection.ts +61 -9
  855. package/models/mve-selected-leg.ts +31 -0
  856. package/models/order-group.ts +5 -5
  857. package/models/order-queue-position.ts +31 -0
  858. package/models/order-status.ts +30 -0
  859. package/models/order.ts +79 -30
  860. package/models/orderbook-level.ts +0 -1
  861. package/models/orderbook.ts +23 -0
  862. package/models/percentile-point.ts +35 -0
  863. package/models/position.ts +0 -2
  864. package/models/price-distribution.ts +83 -0
  865. package/models/price-range.ts +31 -0
  866. package/models/quote.ts +117 -17
  867. package/models/rfq.ts +67 -16
  868. package/models/schedule.ts +33 -0
  869. package/models/scope-list.ts +23 -0
  870. package/models/self-trade-prevention-type.ts +29 -0
  871. package/models/series-fee-change.ts +48 -0
  872. package/models/series.ts +62 -9
  873. package/models/settlement-source.ts +27 -0
  874. package/models/settlement.ts +49 -13
  875. package/models/sport-filter-details.ts +30 -0
  876. package/models/structured-target.ts +28 -7
  877. package/models/ticker-pair.ts +39 -0
  878. package/models/trade.ts +45 -11
  879. package/models/weekly-schedule.ts +58 -0
  880. package/package.json +1 -1
@@ -1,11 +1,11 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
3
  /**
4
- * Kalshi Trading API
5
- * Complete API for the Kalshi trading platform including all handlers for SDK generation
4
+ * Kalshi Trade API Manual Endpoints
5
+ * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
6
6
  *
7
- * The version of the OpenAPI document: 2.0.0
8
- * Contact: support@kalshi.com
7
+ * The version of the OpenAPI document: 3.0.0
8
+ *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
11
  * https://openapi-generator.tech
@@ -25,77 +25,30 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
25
25
  // @ts-ignore
26
26
  import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError } from '../base';
27
27
  // @ts-ignore
28
- import type { AmendOrderRequest } from '../models';
29
- // @ts-ignore
30
- import type { AmendOrderResponse } from '../models';
31
- // @ts-ignore
32
- import type { BatchCancelOrdersRequest } from '../models';
33
- // @ts-ignore
34
- import type { BatchCancelOrdersResponse } from '../models';
35
- // @ts-ignore
36
- import type { BatchCreateOrdersRequest } from '../models';
37
- // @ts-ignore
38
- import type { BatchCreateOrdersResponse } from '../models';
39
- // @ts-ignore
40
- import type { CancelOrderResponse } from '../models';
41
- // @ts-ignore
42
- import type { CreateOrderGroupRequest } from '../models';
43
- // @ts-ignore
44
- import type { CreateOrderGroupResponse } from '../models';
45
- // @ts-ignore
46
- import type { CreateOrderRequest } from '../models';
47
- // @ts-ignore
48
- import type { CreateOrderResponse } from '../models';
49
- // @ts-ignore
50
- import type { DecreaseOrderRequest } from '../models';
51
- // @ts-ignore
52
- import type { DecreaseOrderResponse } from '../models';
53
- // @ts-ignore
54
28
  import type { ErrorResponse } from '../models';
55
29
  // @ts-ignore
56
30
  import type { GetBalanceResponse } from '../models';
57
31
  // @ts-ignore
58
32
  import type { GetFillsResponse } from '../models';
59
33
  // @ts-ignore
60
- import type { GetOrderGroupResponse } from '../models';
61
- // @ts-ignore
62
- import type { GetOrderGroupsResponse } from '../models';
63
- // @ts-ignore
64
- import type { GetOrderQueuePositionResponse } from '../models';
65
- // @ts-ignore
66
- import type { GetOrderResponse } from '../models';
67
- // @ts-ignore
68
- import type { GetOrdersResponse } from '../models';
34
+ import type { GetPortfolioRestingOrderTotalValueResponse } from '../models';
69
35
  // @ts-ignore
70
36
  import type { GetPositionsResponse } from '../models';
71
37
  // @ts-ignore
72
- import type { GetQueuePositionsRequest } from '../models';
73
- // @ts-ignore
74
- import type { GetQueuePositionsResponse } from '../models';
75
- // @ts-ignore
76
38
  import type { GetSettlementsResponse } from '../models';
77
- // @ts-ignore
78
- import type { GetTotalRestingOrderValueResponse } from '../models';
79
39
  /**
80
40
  * PortfolioApi - axios parameter creator
81
41
  */
82
42
  export const PortfolioApiAxiosParamCreator = function (configuration?: Configuration) {
83
43
  return {
84
44
  /**
85
- * Amend an existing order
86
- * @summary Amend Order
87
- * @param {string} orderId Order ID
88
- * @param {AmendOrderRequest} amendOrderRequest
45
+ * Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents.
46
+ * @summary Get Balance
89
47
  * @param {*} [options] Override http request option.
90
48
  * @throws {RequiredError}
91
49
  */
92
- amendOrder: async (orderId: string, amendOrderRequest: AmendOrderRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
93
- // verify required parameter 'orderId' is not null or undefined
94
- assertParamExists('amendOrder', 'orderId', orderId)
95
- // verify required parameter 'amendOrderRequest' is not null or undefined
96
- assertParamExists('amendOrder', 'amendOrderRequest', amendOrderRequest)
97
- const localVarPath = `/portfolio/orders/{order_id}/amend`
98
- .replace(`{${"order_id"}}`, encodeURIComponent(String(orderId)));
50
+ getBalance: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
51
+ const localVarPath = `/portfolio/balance`;
99
52
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
100
53
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
101
54
  let baseOptions;
@@ -103,62 +56,24 @@ export const PortfolioApiAxiosParamCreator = function (configuration?: Configura
103
56
  baseOptions = configuration.baseOptions;
104
57
  }
105
58
 
106
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
59
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
107
60
  const localVarHeaderParameter = {} as any;
108
61
  const localVarQueryParameter = {} as any;
109
62
 
110
- // authentication bearerAuth required
111
- // http bearer authentication required
112
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
113
-
114
-
115
-
116
- localVarHeaderParameter['Content-Type'] = 'application/json';
117
-
118
- setSearchParams(localVarUrlObj, localVarQueryParameter);
119
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
120
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
121
- localVarRequestOptions.data = serializeDataIfNeeded(amendOrderRequest, localVarRequestOptions, configuration)
122
-
123
- return {
124
- url: toPathString(localVarUrlObj),
125
- options: localVarRequestOptions,
126
- };
127
- },
128
- /**
129
- * Cancel multiple orders in a single request
130
- * @summary Batch Cancel Orders
131
- * @param {BatchCancelOrdersRequest} batchCancelOrdersRequest
132
- * @param {*} [options] Override http request option.
133
- * @throws {RequiredError}
134
- */
135
- batchCancelOrders: async (batchCancelOrdersRequest: BatchCancelOrdersRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
136
- // verify required parameter 'batchCancelOrdersRequest' is not null or undefined
137
- assertParamExists('batchCancelOrders', 'batchCancelOrdersRequest', batchCancelOrdersRequest)
138
- const localVarPath = `/portfolio/orders/batched`;
139
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
140
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
141
- let baseOptions;
142
- if (configuration) {
143
- baseOptions = configuration.baseOptions;
144
- }
63
+ // authentication kalshiAccessSignature required
64
+ await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration)
145
65
 
146
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
147
- const localVarHeaderParameter = {} as any;
148
- const localVarQueryParameter = {} as any;
66
+ // authentication kalshiAccessKey required
67
+ await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration)
149
68
 
150
- // authentication bearerAuth required
151
- // http bearer authentication required
152
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
69
+ // authentication kalshiAccessTimestamp required
70
+ await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration)
153
71
 
154
72
 
155
73
 
156
- localVarHeaderParameter['Content-Type'] = 'application/json';
157
-
158
74
  setSearchParams(localVarUrlObj, localVarQueryParameter);
159
75
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
160
76
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
161
- localVarRequestOptions.data = serializeDataIfNeeded(batchCancelOrdersRequest, localVarRequestOptions, configuration)
162
77
 
163
78
  return {
164
79
  url: toPathString(localVarUrlObj),
@@ -166,16 +81,19 @@ export const PortfolioApiAxiosParamCreator = function (configuration?: Configura
166
81
  };
167
82
  },
168
83
  /**
169
- * Create multiple orders in a single request
170
- * @summary Batch Create Orders
171
- * @param {BatchCreateOrdersRequest} batchCreateOrdersRequest
84
+ * Endpoint for getting all fills for the member. A fill is when a trade you have is matched.
85
+ * @summary Get Fills
86
+ * @param {string} [ticker] Filter by market ticker
87
+ * @param {string} [orderId] Filter by order ID
88
+ * @param {number} [minTs] Filter items after this Unix timestamp
89
+ * @param {number} [maxTs] Filter items before this Unix timestamp
90
+ * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
91
+ * @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
92
  * @param {*} [options] Override http request option.
173
93
  * @throws {RequiredError}
174
94
  */
175
- batchCreateOrders: async (batchCreateOrdersRequest: BatchCreateOrdersRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
176
- // verify required parameter 'batchCreateOrdersRequest' is not null or undefined
177
- assertParamExists('batchCreateOrders', 'batchCreateOrdersRequest', batchCreateOrdersRequest)
178
- const localVarPath = `/portfolio/orders/batched`;
95
+ getFills: async (ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
96
+ const localVarPath = `/portfolio/fills`;
179
97
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
180
98
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
181
99
  let baseOptions;
@@ -183,100 +101,48 @@ export const PortfolioApiAxiosParamCreator = function (configuration?: Configura
183
101
  baseOptions = configuration.baseOptions;
184
102
  }
185
103
 
186
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
104
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
187
105
  const localVarHeaderParameter = {} as any;
188
106
  const localVarQueryParameter = {} as any;
189
107
 
190
- // authentication bearerAuth required
191
- // http bearer authentication required
192
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
108
+ // authentication kalshiAccessSignature required
109
+ await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration)
193
110
 
111
+ // authentication kalshiAccessKey required
112
+ await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration)
194
113
 
195
-
196
- localVarHeaderParameter['Content-Type'] = 'application/json';
197
-
198
- setSearchParams(localVarUrlObj, localVarQueryParameter);
199
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
200
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
201
- localVarRequestOptions.data = serializeDataIfNeeded(batchCreateOrdersRequest, localVarRequestOptions, configuration)
114
+ // authentication kalshiAccessTimestamp required
115
+ await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration)
202
116
 
203
- return {
204
- url: toPathString(localVarUrlObj),
205
- options: localVarRequestOptions,
206
- };
207
- },
208
- /**
209
- * Cancel an order
210
- * @summary Cancel Order
211
- * @param {string} orderId Order ID
212
- * @param {*} [options] Override http request option.
213
- * @throws {RequiredError}
214
- */
215
- cancelOrder: async (orderId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
216
- // verify required parameter 'orderId' is not null or undefined
217
- assertParamExists('cancelOrder', 'orderId', orderId)
218
- const localVarPath = `/portfolio/orders/{order_id}`
219
- .replace(`{${"order_id"}}`, encodeURIComponent(String(orderId)));
220
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
221
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
222
- let baseOptions;
223
- if (configuration) {
224
- baseOptions = configuration.baseOptions;
117
+ if (ticker !== undefined) {
118
+ localVarQueryParameter['ticker'] = ticker;
225
119
  }
226
120
 
227
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
228
- const localVarHeaderParameter = {} as any;
229
- const localVarQueryParameter = {} as any;
230
-
231
- // authentication bearerAuth required
232
- // http bearer authentication required
233
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
234
-
121
+ if (orderId !== undefined) {
122
+ localVarQueryParameter['order_id'] = orderId;
123
+ }
235
124
 
236
-
237
- setSearchParams(localVarUrlObj, localVarQueryParameter);
238
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
239
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
125
+ if (minTs !== undefined) {
126
+ localVarQueryParameter['min_ts'] = minTs;
127
+ }
240
128
 
241
- return {
242
- url: toPathString(localVarUrlObj),
243
- options: localVarRequestOptions,
244
- };
245
- },
246
- /**
247
- * Create a new order
248
- * @summary Create Order
249
- * @param {CreateOrderRequest} createOrderRequest
250
- * @param {*} [options] Override http request option.
251
- * @throws {RequiredError}
252
- */
253
- createOrder: async (createOrderRequest: CreateOrderRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
254
- // verify required parameter 'createOrderRequest' is not null or undefined
255
- assertParamExists('createOrder', 'createOrderRequest', createOrderRequest)
256
- const localVarPath = `/portfolio/orders`;
257
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
258
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
259
- let baseOptions;
260
- if (configuration) {
261
- baseOptions = configuration.baseOptions;
129
+ if (maxTs !== undefined) {
130
+ localVarQueryParameter['max_ts'] = maxTs;
262
131
  }
263
132
 
264
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
265
- const localVarHeaderParameter = {} as any;
266
- const localVarQueryParameter = {} as any;
133
+ if (limit !== undefined) {
134
+ localVarQueryParameter['limit'] = limit;
135
+ }
267
136
 
268
- // authentication bearerAuth required
269
- // http bearer authentication required
270
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
137
+ if (cursor !== undefined) {
138
+ localVarQueryParameter['cursor'] = cursor;
139
+ }
271
140
 
272
141
 
273
142
 
274
- localVarHeaderParameter['Content-Type'] = 'application/json';
275
-
276
143
  setSearchParams(localVarUrlObj, localVarQueryParameter);
277
144
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
278
145
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
279
- localVarRequestOptions.data = serializeDataIfNeeded(createOrderRequest, localVarRequestOptions, configuration)
280
146
 
281
147
  return {
282
148
  url: toPathString(localVarUrlObj),
@@ -284,16 +150,13 @@ export const PortfolioApiAxiosParamCreator = function (configuration?: Configura
284
150
  };
285
151
  },
286
152
  /**
287
- * Create a new order group
288
- * @summary Create Order Group
289
- * @param {CreateOrderGroupRequest} createOrderGroupRequest
153
+ * 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.
154
+ * @summary Get Total Resting Order Value
290
155
  * @param {*} [options] Override http request option.
291
156
  * @throws {RequiredError}
292
157
  */
293
- createOrderGroup: async (createOrderGroupRequest: CreateOrderGroupRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
294
- // verify required parameter 'createOrderGroupRequest' is not null or undefined
295
- assertParamExists('createOrderGroup', 'createOrderGroupRequest', createOrderGroupRequest)
296
- const localVarPath = `/portfolio/order_groups/create`;
158
+ getPortfolioRestingOrderTotalValue: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
159
+ const localVarPath = `/portfolio/summary/total_resting_order_value`;
297
160
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
298
161
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
299
162
  let baseOptions;
@@ -301,22 +164,24 @@ export const PortfolioApiAxiosParamCreator = function (configuration?: Configura
301
164
  baseOptions = configuration.baseOptions;
302
165
  }
303
166
 
304
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
167
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
305
168
  const localVarHeaderParameter = {} as any;
306
169
  const localVarQueryParameter = {} as any;
307
170
 
308
- // authentication bearerAuth required
309
- // http bearer authentication required
310
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
171
+ // authentication kalshiAccessSignature required
172
+ await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration)
311
173
 
174
+ // authentication kalshiAccessKey required
175
+ await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration)
312
176
 
313
-
314
- localVarHeaderParameter['Content-Type'] = 'application/json';
177
+ // authentication kalshiAccessTimestamp required
178
+ await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration)
315
179
 
180
+
181
+
316
182
  setSearchParams(localVarUrlObj, localVarQueryParameter);
317
183
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
318
184
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
319
- localVarRequestOptions.data = serializeDataIfNeeded(createOrderGroupRequest, localVarRequestOptions, configuration)
320
185
 
321
186
  return {
322
187
  url: toPathString(localVarUrlObj),
@@ -324,20 +189,19 @@ export const PortfolioApiAxiosParamCreator = function (configuration?: Configura
324
189
  };
325
190
  },
326
191
  /**
327
- * Decrease the size of an existing order
328
- * @summary Decrease Order
329
- * @param {string} orderId Order ID
330
- * @param {DecreaseOrderRequest} decreaseOrderRequest
192
+ * 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
193
+ * @summary Get Positions
194
+ * @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.
195
+ * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
196
+ * @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
197
+ * @param {GetPositionsSettlementStatusEnum} [settlementStatus] Settlement status of the markets to return. Defaults to unsettled.
198
+ * @param {string} [ticker] Filter by market ticker
199
+ * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
331
200
  * @param {*} [options] Override http request option.
332
201
  * @throws {RequiredError}
333
202
  */
334
- decreaseOrder: async (orderId: string, decreaseOrderRequest: DecreaseOrderRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
335
- // verify required parameter 'orderId' is not null or undefined
336
- assertParamExists('decreaseOrder', 'orderId', orderId)
337
- // verify required parameter 'decreaseOrderRequest' is not null or undefined
338
- assertParamExists('decreaseOrder', 'decreaseOrderRequest', decreaseOrderRequest)
339
- const localVarPath = `/portfolio/orders/{order_id}/decrease`
340
- .replace(`{${"order_id"}}`, encodeURIComponent(String(orderId)));
203
+ getPositions: async (cursor?: string, limit?: number, countFilter?: string, settlementStatus?: GetPositionsSettlementStatusEnum, ticker?: string, eventTicker?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
204
+ const localVarPath = `/portfolio/positions`;
341
205
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
342
206
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
343
207
  let baseOptions;
@@ -345,88 +209,42 @@ export const PortfolioApiAxiosParamCreator = function (configuration?: Configura
345
209
  baseOptions = configuration.baseOptions;
346
210
  }
347
211
 
348
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
212
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
349
213
  const localVarHeaderParameter = {} as any;
350
214
  const localVarQueryParameter = {} as any;
351
215
 
352
- // authentication bearerAuth required
353
- // http bearer authentication required
354
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
216
+ // authentication kalshiAccessSignature required
217
+ await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration)
355
218
 
219
+ // authentication kalshiAccessKey required
220
+ await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration)
356
221
 
357
-
358
- localVarHeaderParameter['Content-Type'] = 'application/json';
359
-
360
- setSearchParams(localVarUrlObj, localVarQueryParameter);
361
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
362
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
363
- localVarRequestOptions.data = serializeDataIfNeeded(decreaseOrderRequest, localVarRequestOptions, configuration)
222
+ // authentication kalshiAccessTimestamp required
223
+ await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration)
364
224
 
365
- return {
366
- url: toPathString(localVarUrlObj),
367
- options: localVarRequestOptions,
368
- };
369
- },
370
- /**
371
- * Delete an order group
372
- * @summary Delete Order Group
373
- * @param {string} orderGroupId Order group ID
374
- * @param {*} [options] Override http request option.
375
- * @throws {RequiredError}
376
- */
377
- deleteOrderGroup: async (orderGroupId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
378
- // verify required parameter 'orderGroupId' is not null or undefined
379
- assertParamExists('deleteOrderGroup', 'orderGroupId', orderGroupId)
380
- const localVarPath = `/portfolio/order_groups/{order_group_id}`
381
- .replace(`{${"order_group_id"}}`, encodeURIComponent(String(orderGroupId)));
382
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
383
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
384
- let baseOptions;
385
- if (configuration) {
386
- baseOptions = configuration.baseOptions;
225
+ if (cursor !== undefined) {
226
+ localVarQueryParameter['cursor'] = cursor;
387
227
  }
388
228
 
389
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
390
- const localVarHeaderParameter = {} as any;
391
- const localVarQueryParameter = {} as any;
392
-
393
- // authentication bearerAuth required
394
- // http bearer authentication required
395
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
396
-
229
+ if (limit !== undefined) {
230
+ localVarQueryParameter['limit'] = limit;
231
+ }
397
232
 
398
-
399
- setSearchParams(localVarUrlObj, localVarQueryParameter);
400
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
401
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
233
+ if (countFilter !== undefined) {
234
+ localVarQueryParameter['count_filter'] = countFilter;
235
+ }
402
236
 
403
- return {
404
- url: toPathString(localVarUrlObj),
405
- options: localVarRequestOptions,
406
- };
407
- },
408
- /**
409
- * Get the user\'s current balance
410
- * @summary Get Balance
411
- * @param {*} [options] Override http request option.
412
- * @throws {RequiredError}
413
- */
414
- getBalance: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
415
- const localVarPath = `/portfolio/balance`;
416
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
417
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
418
- let baseOptions;
419
- if (configuration) {
420
- baseOptions = configuration.baseOptions;
237
+ if (settlementStatus !== undefined) {
238
+ localVarQueryParameter['settlement_status'] = settlementStatus;
421
239
  }
422
240
 
423
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
424
- const localVarHeaderParameter = {} as any;
425
- const localVarQueryParameter = {} as any;
241
+ if (ticker !== undefined) {
242
+ localVarQueryParameter['ticker'] = ticker;
243
+ }
426
244
 
427
- // authentication bearerAuth required
428
- // http bearer authentication required
429
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
245
+ if (eventTicker !== undefined) {
246
+ localVarQueryParameter['event_ticker'] = eventTicker;
247
+ }
430
248
 
431
249
 
432
250
 
@@ -440,19 +258,19 @@ export const PortfolioApiAxiosParamCreator = function (configuration?: Configura
440
258
  };
441
259
  },
442
260
  /**
443
- * 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.
444
- * @summary Get Fills
261
+ * Endpoint for getting the member\'s settlements historical track.
262
+ * @summary Get Settlements
263
+ * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
264
+ * @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.
445
265
  * @param {string} [ticker] Filter by market ticker
446
- * @param {string} [orderId] Filter by order ID
266
+ * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
447
267
  * @param {number} [minTs] Filter items after this Unix timestamp
448
268
  * @param {number} [maxTs] Filter items before this Unix timestamp
449
- * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
450
- * @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.
451
269
  * @param {*} [options] Override http request option.
452
270
  * @throws {RequiredError}
453
271
  */
454
- getFills: async (ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
455
- const localVarPath = `/portfolio/fills`;
272
+ getSettlements: async (limit?: number, cursor?: string, ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
273
+ const localVarPath = `/portfolio/settlements`;
456
274
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
457
275
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
458
276
  let baseOptions;
@@ -464,25 +282,14 @@ export const PortfolioApiAxiosParamCreator = function (configuration?: Configura
464
282
  const localVarHeaderParameter = {} as any;
465
283
  const localVarQueryParameter = {} as any;
466
284
 
467
- // authentication bearerAuth required
468
- // http bearer authentication required
469
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
470
-
471
- if (ticker !== undefined) {
472
- localVarQueryParameter['ticker'] = ticker;
473
- }
474
-
475
- if (orderId !== undefined) {
476
- localVarQueryParameter['order_id'] = orderId;
477
- }
285
+ // authentication kalshiAccessSignature required
286
+ await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-SIGNATURE", configuration)
478
287
 
479
- if (minTs !== undefined) {
480
- localVarQueryParameter['min_ts'] = minTs;
481
- }
288
+ // authentication kalshiAccessKey required
289
+ await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-KEY", configuration)
482
290
 
483
- if (maxTs !== undefined) {
484
- localVarQueryParameter['max_ts'] = maxTs;
485
- }
291
+ // authentication kalshiAccessTimestamp required
292
+ await setApiKeyToObject(localVarHeaderParameter, "KALSHI-ACCESS-TIMESTAMP", configuration)
486
293
 
487
294
  if (limit !== undefined) {
488
295
  localVarQueryParameter['limit'] = limit;
@@ -492,43 +299,21 @@ export const PortfolioApiAxiosParamCreator = function (configuration?: Configura
492
299
  localVarQueryParameter['cursor'] = cursor;
493
300
  }
494
301
 
302
+ if (ticker !== undefined) {
303
+ localVarQueryParameter['ticker'] = ticker;
304
+ }
495
305
 
496
-
497
- setSearchParams(localVarUrlObj, localVarQueryParameter);
498
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
499
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
500
-
501
- return {
502
- url: toPathString(localVarUrlObj),
503
- options: localVarRequestOptions,
504
- };
505
- },
506
- /**
507
- * Get a single order by ID
508
- * @summary Get Order
509
- * @param {string} orderId Order ID
510
- * @param {*} [options] Override http request option.
511
- * @throws {RequiredError}
512
- */
513
- getOrder: async (orderId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
514
- // verify required parameter 'orderId' is not null or undefined
515
- assertParamExists('getOrder', 'orderId', orderId)
516
- const localVarPath = `/portfolio/orders/{order_id}`
517
- .replace(`{${"order_id"}}`, encodeURIComponent(String(orderId)));
518
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
519
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
520
- let baseOptions;
521
- if (configuration) {
522
- baseOptions = configuration.baseOptions;
306
+ if (eventTicker !== undefined) {
307
+ localVarQueryParameter['event_ticker'] = eventTicker;
523
308
  }
524
309
 
525
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
526
- const localVarHeaderParameter = {} as any;
527
- const localVarQueryParameter = {} as any;
310
+ if (minTs !== undefined) {
311
+ localVarQueryParameter['min_ts'] = minTs;
312
+ }
528
313
 
529
- // authentication bearerAuth required
530
- // http bearer authentication required
531
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
314
+ if (maxTs !== undefined) {
315
+ localVarQueryParameter['max_ts'] = maxTs;
316
+ }
532
317
 
533
318
 
534
319
 
@@ -541,704 +326,89 @@ export const PortfolioApiAxiosParamCreator = function (configuration?: Configura
541
326
  options: localVarRequestOptions,
542
327
  };
543
328
  },
329
+ }
330
+ };
331
+
332
+ /**
333
+ * PortfolioApi - functional programming interface
334
+ */
335
+ export const PortfolioApiFp = function(configuration?: Configuration) {
336
+ const localVarAxiosParamCreator = PortfolioApiAxiosParamCreator(configuration)
337
+ return {
544
338
  /**
545
- * Get details of a specific order group
546
- * @summary Get Order Group
547
- * @param {string} orderGroupId Order group ID
339
+ * Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents.
340
+ * @summary Get Balance
548
341
  * @param {*} [options] Override http request option.
549
342
  * @throws {RequiredError}
550
343
  */
551
- getOrderGroup: async (orderGroupId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
552
- // verify required parameter 'orderGroupId' is not null or undefined
553
- assertParamExists('getOrderGroup', 'orderGroupId', orderGroupId)
554
- const localVarPath = `/portfolio/order_groups/{order_group_id}`
555
- .replace(`{${"order_group_id"}}`, encodeURIComponent(String(orderGroupId)));
556
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
557
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
558
- let baseOptions;
559
- if (configuration) {
560
- baseOptions = configuration.baseOptions;
561
- }
562
-
563
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
564
- const localVarHeaderParameter = {} as any;
565
- const localVarQueryParameter = {} as any;
566
-
567
- // authentication bearerAuth required
568
- // http bearer authentication required
569
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
570
-
571
-
572
-
573
- setSearchParams(localVarUrlObj, localVarQueryParameter);
574
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
575
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
576
-
577
- return {
578
- url: toPathString(localVarUrlObj),
579
- options: localVarRequestOptions,
580
- };
581
- },
582
- /**
583
- * Get order groups for the logged-in user
584
- * @summary Get Order Groups
585
- * @param {string} [status] Filter by status. Possible values depend on the endpoint.
586
- * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
587
- * @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.
588
- * @param {*} [options] Override http request option.
589
- * @throws {RequiredError}
590
- */
591
- getOrderGroups: async (status?: string, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
592
- const localVarPath = `/portfolio/order_groups`;
593
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
594
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
595
- let baseOptions;
596
- if (configuration) {
597
- baseOptions = configuration.baseOptions;
598
- }
599
-
600
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
601
- const localVarHeaderParameter = {} as any;
602
- const localVarQueryParameter = {} as any;
603
-
604
- // authentication bearerAuth required
605
- // http bearer authentication required
606
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
607
-
608
- if (status !== undefined) {
609
- localVarQueryParameter['status'] = status;
610
- }
611
-
612
- if (limit !== undefined) {
613
- localVarQueryParameter['limit'] = limit;
614
- }
615
-
616
- if (cursor !== undefined) {
617
- localVarQueryParameter['cursor'] = cursor;
618
- }
619
-
620
-
621
-
622
- setSearchParams(localVarUrlObj, localVarQueryParameter);
623
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
624
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
625
-
626
- return {
627
- url: toPathString(localVarUrlObj),
628
- options: localVarRequestOptions,
629
- };
630
- },
631
- /**
632
- * Get the queue position for an order
633
- * @summary Get Order Queue Position
634
- * @param {string} orderId Order ID
635
- * @param {*} [options] Override http request option.
636
- * @throws {RequiredError}
637
- */
638
- getOrderQueuePosition: async (orderId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
639
- // verify required parameter 'orderId' is not null or undefined
640
- assertParamExists('getOrderQueuePosition', 'orderId', orderId)
641
- const localVarPath = `/portfolio/orders/{order_id}/queue_position`
642
- .replace(`{${"order_id"}}`, encodeURIComponent(String(orderId)));
643
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
644
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
645
- let baseOptions;
646
- if (configuration) {
647
- baseOptions = configuration.baseOptions;
648
- }
649
-
650
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
651
- const localVarHeaderParameter = {} as any;
652
- const localVarQueryParameter = {} as any;
653
-
654
- // authentication bearerAuth required
655
- // http bearer authentication required
656
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
657
-
658
-
659
-
660
- setSearchParams(localVarUrlObj, localVarQueryParameter);
661
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
662
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
663
-
664
- return {
665
- url: toPathString(localVarUrlObj),
666
- options: localVarRequestOptions,
667
- };
668
- },
669
- /**
670
- * Get orders for the logged-in user
671
- * @summary Get Orders
672
- * @param {string} [ticker] Filter by market ticker
673
- * @param {string} [eventTicker] Filter by event ticker
674
- * @param {number} [minTs] Filter items after this Unix timestamp
675
- * @param {number} [maxTs] Filter items before this Unix timestamp
676
- * @param {string} [status] Filter by status. Possible values depend on the endpoint.
677
- * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
678
- * @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.
679
- * @param {*} [options] Override http request option.
680
- * @throws {RequiredError}
681
- */
682
- getOrders: async (ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, status?: string, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
683
- const localVarPath = `/portfolio/orders`;
684
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
685
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
686
- let baseOptions;
687
- if (configuration) {
688
- baseOptions = configuration.baseOptions;
689
- }
690
-
691
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
692
- const localVarHeaderParameter = {} as any;
693
- const localVarQueryParameter = {} as any;
694
-
695
- // authentication bearerAuth required
696
- // http bearer authentication required
697
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
698
-
699
- if (ticker !== undefined) {
700
- localVarQueryParameter['ticker'] = ticker;
701
- }
702
-
703
- if (eventTicker !== undefined) {
704
- localVarQueryParameter['event_ticker'] = eventTicker;
705
- }
706
-
707
- if (minTs !== undefined) {
708
- localVarQueryParameter['min_ts'] = minTs;
709
- }
710
-
711
- if (maxTs !== undefined) {
712
- localVarQueryParameter['max_ts'] = maxTs;
713
- }
714
-
715
- if (status !== undefined) {
716
- localVarQueryParameter['status'] = status;
717
- }
718
-
719
- if (limit !== undefined) {
720
- localVarQueryParameter['limit'] = limit;
721
- }
722
-
723
- if (cursor !== undefined) {
724
- localVarQueryParameter['cursor'] = cursor;
725
- }
726
-
727
-
728
-
729
- setSearchParams(localVarUrlObj, localVarQueryParameter);
730
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
731
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
732
-
733
- return {
734
- url: toPathString(localVarUrlObj),
735
- options: localVarRequestOptions,
736
- };
737
- },
738
- /**
739
- * Get positions for the logged-in user
740
- * @summary Get Positions
741
- * @param {string} [ticker] Filter by market ticker
742
- * @param {string} [eventTicker] Filter by event ticker
743
- * @param {number} [countDown] Filter positions by minimum count down value
744
- * @param {number} [countUp] Filter positions by minimum count up value
745
- * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
746
- * @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.
747
- * @param {*} [options] Override http request option.
748
- * @throws {RequiredError}
749
- */
750
- getPositions: async (ticker?: string, eventTicker?: string, countDown?: number, countUp?: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
751
- const localVarPath = `/portfolio/positions`;
752
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
753
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
754
- let baseOptions;
755
- if (configuration) {
756
- baseOptions = configuration.baseOptions;
757
- }
758
-
759
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
760
- const localVarHeaderParameter = {} as any;
761
- const localVarQueryParameter = {} as any;
762
-
763
- // authentication bearerAuth required
764
- // http bearer authentication required
765
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
766
-
767
- if (ticker !== undefined) {
768
- localVarQueryParameter['ticker'] = ticker;
769
- }
770
-
771
- if (eventTicker !== undefined) {
772
- localVarQueryParameter['event_ticker'] = eventTicker;
773
- }
774
-
775
- if (countDown !== undefined) {
776
- localVarQueryParameter['count_down'] = countDown;
777
- }
778
-
779
- if (countUp !== undefined) {
780
- localVarQueryParameter['count_up'] = countUp;
781
- }
782
-
783
- if (limit !== undefined) {
784
- localVarQueryParameter['limit'] = limit;
785
- }
786
-
787
- if (cursor !== undefined) {
788
- localVarQueryParameter['cursor'] = cursor;
789
- }
790
-
791
-
792
-
793
- setSearchParams(localVarUrlObj, localVarQueryParameter);
794
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
795
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
796
-
797
- return {
798
- url: toPathString(localVarUrlObj),
799
- options: localVarRequestOptions,
800
- };
801
- },
802
- /**
803
- * Get queue positions for multiple orders
804
- * @summary Get Queue Positions
805
- * @param {GetQueuePositionsRequest} getQueuePositionsRequest
806
- * @param {*} [options] Override http request option.
807
- * @throws {RequiredError}
808
- */
809
- getQueuePositions: async (getQueuePositionsRequest: GetQueuePositionsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
810
- // verify required parameter 'getQueuePositionsRequest' is not null or undefined
811
- assertParamExists('getQueuePositions', 'getQueuePositionsRequest', getQueuePositionsRequest)
812
- const localVarPath = `/portfolio/orders/queue_positions`;
813
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
814
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
815
- let baseOptions;
816
- if (configuration) {
817
- baseOptions = configuration.baseOptions;
818
- }
819
-
820
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
821
- const localVarHeaderParameter = {} as any;
822
- const localVarQueryParameter = {} as any;
823
-
824
- // authentication bearerAuth required
825
- // http bearer authentication required
826
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
827
-
828
-
829
-
830
- localVarHeaderParameter['Content-Type'] = 'application/json';
831
-
832
- setSearchParams(localVarUrlObj, localVarQueryParameter);
833
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
834
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
835
- localVarRequestOptions.data = serializeDataIfNeeded(getQueuePositionsRequest, localVarRequestOptions, configuration)
836
-
837
- return {
838
- url: toPathString(localVarUrlObj),
839
- options: localVarRequestOptions,
840
- };
841
- },
842
- /**
843
- * Get settlements for the logged-in user
844
- * @summary Get Settlements
845
- * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
846
- * @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.
847
- * @param {*} [options] Override http request option.
848
- * @throws {RequiredError}
849
- */
850
- getSettlements: async (limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
851
- const localVarPath = `/portfolio/settlements`;
852
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
853
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
854
- let baseOptions;
855
- if (configuration) {
856
- baseOptions = configuration.baseOptions;
857
- }
858
-
859
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
860
- const localVarHeaderParameter = {} as any;
861
- const localVarQueryParameter = {} as any;
862
-
863
- // authentication bearerAuth required
864
- // http bearer authentication required
865
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
866
-
867
- if (limit !== undefined) {
868
- localVarQueryParameter['limit'] = limit;
869
- }
870
-
871
- if (cursor !== undefined) {
872
- localVarQueryParameter['cursor'] = cursor;
873
- }
874
-
875
-
876
-
877
- setSearchParams(localVarUrlObj, localVarQueryParameter);
878
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
879
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
880
-
881
- return {
882
- url: toPathString(localVarUrlObj),
883
- options: localVarRequestOptions,
884
- };
885
- },
886
- /**
887
- * Get the total value of all resting orders
888
- * @summary Get Total Resting Order Value
889
- * @param {*} [options] Override http request option.
890
- * @throws {RequiredError}
891
- */
892
- getTotalRestingOrderValue: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
893
- const localVarPath = `/portfolio/summary/total_resting_order_value`;
894
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
895
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
896
- let baseOptions;
897
- if (configuration) {
898
- baseOptions = configuration.baseOptions;
899
- }
900
-
901
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
902
- const localVarHeaderParameter = {} as any;
903
- const localVarQueryParameter = {} as any;
904
-
905
- // authentication bearerAuth required
906
- // http bearer authentication required
907
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
908
-
909
-
910
-
911
- setSearchParams(localVarUrlObj, localVarQueryParameter);
912
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
913
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
914
-
915
- return {
916
- url: toPathString(localVarUrlObj),
917
- options: localVarRequestOptions,
918
- };
919
- },
920
- /**
921
- * Reset an order group
922
- * @summary Reset Order Group
923
- * @param {string} orderGroupId Order group ID
924
- * @param {*} [options] Override http request option.
925
- * @throws {RequiredError}
926
- */
927
- resetOrderGroup: async (orderGroupId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
928
- // verify required parameter 'orderGroupId' is not null or undefined
929
- assertParamExists('resetOrderGroup', 'orderGroupId', orderGroupId)
930
- const localVarPath = `/portfolio/order_groups/{order_group_id}/reset`
931
- .replace(`{${"order_group_id"}}`, encodeURIComponent(String(orderGroupId)));
932
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
933
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
934
- let baseOptions;
935
- if (configuration) {
936
- baseOptions = configuration.baseOptions;
937
- }
938
-
939
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
940
- const localVarHeaderParameter = {} as any;
941
- const localVarQueryParameter = {} as any;
942
-
943
- // authentication bearerAuth required
944
- // http bearer authentication required
945
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
946
-
947
-
948
-
949
- setSearchParams(localVarUrlObj, localVarQueryParameter);
950
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
951
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
952
-
953
- return {
954
- url: toPathString(localVarUrlObj),
955
- options: localVarRequestOptions,
956
- };
957
- },
958
- }
959
- };
960
-
961
- /**
962
- * PortfolioApi - functional programming interface
963
- */
964
- export const PortfolioApiFp = function(configuration?: Configuration) {
965
- const localVarAxiosParamCreator = PortfolioApiAxiosParamCreator(configuration)
966
- return {
967
- /**
968
- * Amend an existing order
969
- * @summary Amend Order
970
- * @param {string} orderId Order ID
971
- * @param {AmendOrderRequest} amendOrderRequest
972
- * @param {*} [options] Override http request option.
973
- * @throws {RequiredError}
974
- */
975
- async amendOrder(orderId: string, amendOrderRequest: AmendOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AmendOrderResponse>> {
976
- const localVarAxiosArgs = await localVarAxiosParamCreator.amendOrder(orderId, amendOrderRequest, options);
977
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
978
- const localVarOperationServerBasePath: string | undefined = undefined;
979
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
980
- },
981
- /**
982
- * Cancel multiple orders in a single request
983
- * @summary Batch Cancel Orders
984
- * @param {BatchCancelOrdersRequest} batchCancelOrdersRequest
985
- * @param {*} [options] Override http request option.
986
- * @throws {RequiredError}
987
- */
988
- async batchCancelOrders(batchCancelOrdersRequest: BatchCancelOrdersRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BatchCancelOrdersResponse>> {
989
- const localVarAxiosArgs = await localVarAxiosParamCreator.batchCancelOrders(batchCancelOrdersRequest, options);
990
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
991
- const localVarOperationServerBasePath: string | undefined = undefined;
992
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
993
- },
994
- /**
995
- * Create multiple orders in a single request
996
- * @summary Batch Create Orders
997
- * @param {BatchCreateOrdersRequest} batchCreateOrdersRequest
998
- * @param {*} [options] Override http request option.
999
- * @throws {RequiredError}
1000
- */
1001
- async batchCreateOrders(batchCreateOrdersRequest: BatchCreateOrdersRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BatchCreateOrdersResponse>> {
1002
- const localVarAxiosArgs = await localVarAxiosParamCreator.batchCreateOrders(batchCreateOrdersRequest, options);
1003
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1004
- const localVarOperationServerBasePath: string | undefined = undefined;
1005
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1006
- },
1007
- /**
1008
- * Cancel an order
1009
- * @summary Cancel Order
1010
- * @param {string} orderId Order ID
1011
- * @param {*} [options] Override http request option.
1012
- * @throws {RequiredError}
1013
- */
1014
- async cancelOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelOrderResponse>> {
1015
- const localVarAxiosArgs = await localVarAxiosParamCreator.cancelOrder(orderId, options);
1016
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1017
- const localVarOperationServerBasePath: string | undefined = undefined;
1018
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1019
- },
1020
- /**
1021
- * Create a new order
1022
- * @summary Create Order
1023
- * @param {CreateOrderRequest} createOrderRequest
1024
- * @param {*} [options] Override http request option.
1025
- * @throws {RequiredError}
1026
- */
1027
- async createOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderResponse>> {
1028
- const localVarAxiosArgs = await localVarAxiosParamCreator.createOrder(createOrderRequest, options);
1029
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1030
- const localVarOperationServerBasePath: string | undefined = undefined;
1031
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1032
- },
1033
- /**
1034
- * Create a new order group
1035
- * @summary Create Order Group
1036
- * @param {CreateOrderGroupRequest} createOrderGroupRequest
1037
- * @param {*} [options] Override http request option.
1038
- * @throws {RequiredError}
1039
- */
1040
- async createOrderGroup(createOrderGroupRequest: CreateOrderGroupRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderGroupResponse>> {
1041
- const localVarAxiosArgs = await localVarAxiosParamCreator.createOrderGroup(createOrderGroupRequest, options);
1042
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1043
- const localVarOperationServerBasePath: string | undefined = undefined;
1044
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1045
- },
1046
- /**
1047
- * Decrease the size of an existing order
1048
- * @summary Decrease Order
1049
- * @param {string} orderId Order ID
1050
- * @param {DecreaseOrderRequest} decreaseOrderRequest
1051
- * @param {*} [options] Override http request option.
1052
- * @throws {RequiredError}
1053
- */
1054
- async decreaseOrder(orderId: string, decreaseOrderRequest: DecreaseOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DecreaseOrderResponse>> {
1055
- const localVarAxiosArgs = await localVarAxiosParamCreator.decreaseOrder(orderId, decreaseOrderRequest, options);
1056
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1057
- const localVarOperationServerBasePath: string | undefined = undefined;
1058
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1059
- },
1060
- /**
1061
- * Delete an order group
1062
- * @summary Delete Order Group
1063
- * @param {string} orderGroupId Order group ID
1064
- * @param {*} [options] Override http request option.
1065
- * @throws {RequiredError}
1066
- */
1067
- async deleteOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
1068
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteOrderGroup(orderGroupId, options);
1069
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1070
- const localVarOperationServerBasePath: string | undefined = undefined;
1071
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1072
- },
1073
- /**
1074
- * Get the user\'s current balance
1075
- * @summary Get Balance
1076
- * @param {*} [options] Override http request option.
1077
- * @throws {RequiredError}
1078
- */
1079
- async getBalance(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBalanceResponse>> {
1080
- const localVarAxiosArgs = await localVarAxiosParamCreator.getBalance(options);
1081
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1082
- const localVarOperationServerBasePath: string | undefined = undefined;
1083
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1084
- },
1085
- /**
1086
- * 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.
1087
- * @summary Get Fills
1088
- * @param {string} [ticker] Filter by market ticker
1089
- * @param {string} [orderId] Filter by order ID
1090
- * @param {number} [minTs] Filter items after this Unix timestamp
1091
- * @param {number} [maxTs] Filter items before this Unix timestamp
1092
- * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
1093
- * @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.
1094
- * @param {*} [options] Override http request option.
1095
- * @throws {RequiredError}
1096
- */
1097
- async getFills(ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFillsResponse>> {
1098
- const localVarAxiosArgs = await localVarAxiosParamCreator.getFills(ticker, orderId, minTs, maxTs, limit, cursor, options);
1099
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1100
- const localVarOperationServerBasePath: string | undefined = undefined;
1101
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1102
- },
1103
- /**
1104
- * Get a single order by ID
1105
- * @summary Get Order
1106
- * @param {string} orderId Order ID
1107
- * @param {*} [options] Override http request option.
1108
- * @throws {RequiredError}
1109
- */
1110
- async getOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderResponse>> {
1111
- const localVarAxiosArgs = await localVarAxiosParamCreator.getOrder(orderId, options);
1112
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1113
- const localVarOperationServerBasePath: string | undefined = undefined;
1114
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1115
- },
1116
- /**
1117
- * Get details of a specific order group
1118
- * @summary Get Order Group
1119
- * @param {string} orderGroupId Order group ID
1120
- * @param {*} [options] Override http request option.
1121
- * @throws {RequiredError}
1122
- */
1123
- async getOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderGroupResponse>> {
1124
- const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderGroup(orderGroupId, options);
1125
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1126
- const localVarOperationServerBasePath: string | undefined = undefined;
1127
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1128
- },
1129
- /**
1130
- * Get order groups for the logged-in user
1131
- * @summary Get Order Groups
1132
- * @param {string} [status] Filter by status. Possible values depend on the endpoint.
1133
- * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
1134
- * @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.
1135
- * @param {*} [options] Override http request option.
1136
- * @throws {RequiredError}
1137
- */
1138
- async getOrderGroups(status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderGroupsResponse>> {
1139
- const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderGroups(status, limit, cursor, options);
1140
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1141
- const localVarOperationServerBasePath: string | undefined = undefined;
1142
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1143
- },
1144
- /**
1145
- * Get the queue position for an order
1146
- * @summary Get Order Queue Position
1147
- * @param {string} orderId Order ID
1148
- * @param {*} [options] Override http request option.
1149
- * @throws {RequiredError}
1150
- */
1151
- async getOrderQueuePosition(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderQueuePositionResponse>> {
1152
- const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderQueuePosition(orderId, options);
344
+ async getBalance(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBalanceResponse>> {
345
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getBalance(options);
1153
346
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1154
347
  const localVarOperationServerBasePath: string | undefined = undefined;
1155
348
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1156
349
  },
1157
350
  /**
1158
- * Get orders for the logged-in user
1159
- * @summary Get Orders
351
+ * Endpoint for getting all fills for the member. A fill is when a trade you have is matched.
352
+ * @summary Get Fills
1160
353
  * @param {string} [ticker] Filter by market ticker
1161
- * @param {string} [eventTicker] Filter by event ticker
354
+ * @param {string} [orderId] Filter by order ID
1162
355
  * @param {number} [minTs] Filter items after this Unix timestamp
1163
356
  * @param {number} [maxTs] Filter items before this Unix timestamp
1164
- * @param {string} [status] Filter by status. Possible values depend on the endpoint.
1165
357
  * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
1166
358
  * @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.
1167
359
  * @param {*} [options] Override http request option.
1168
360
  * @throws {RequiredError}
1169
361
  */
1170
- async getOrders(ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrdersResponse>> {
1171
- const localVarAxiosArgs = await localVarAxiosParamCreator.getOrders(ticker, eventTicker, minTs, maxTs, status, limit, cursor, options);
362
+ async getFills(ticker?: string, orderId?: string, minTs?: number, maxTs?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFillsResponse>> {
363
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getFills(ticker, orderId, minTs, maxTs, limit, cursor, options);
1172
364
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1173
365
  const localVarOperationServerBasePath: string | undefined = undefined;
1174
366
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1175
367
  },
1176
368
  /**
1177
- * Get positions for the logged-in user
1178
- * @summary Get Positions
1179
- * @param {string} [ticker] Filter by market ticker
1180
- * @param {string} [eventTicker] Filter by event ticker
1181
- * @param {number} [countDown] Filter positions by minimum count down value
1182
- * @param {number} [countUp] Filter positions by minimum count up value
1183
- * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
1184
- * @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.
369
+ * 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.
370
+ * @summary Get Total Resting Order Value
1185
371
  * @param {*} [options] Override http request option.
1186
372
  * @throws {RequiredError}
1187
373
  */
1188
- async getPositions(ticker?: string, eventTicker?: string, countDown?: number, countUp?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPositionsResponse>> {
1189
- const localVarAxiosArgs = await localVarAxiosParamCreator.getPositions(ticker, eventTicker, countDown, countUp, limit, cursor, options);
374
+ async getPortfolioRestingOrderTotalValue(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPortfolioRestingOrderTotalValueResponse>> {
375
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getPortfolioRestingOrderTotalValue(options);
1190
376
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1191
377
  const localVarOperationServerBasePath: string | undefined = undefined;
1192
378
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1193
379
  },
1194
380
  /**
1195
- * Get queue positions for multiple orders
1196
- * @summary Get Queue Positions
1197
- * @param {GetQueuePositionsRequest} getQueuePositionsRequest
381
+ * 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
382
+ * @summary Get Positions
383
+ * @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.
384
+ * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
385
+ * @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
386
+ * @param {GetPositionsSettlementStatusEnum} [settlementStatus] Settlement status of the markets to return. Defaults to unsettled.
387
+ * @param {string} [ticker] Filter by market ticker
388
+ * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
1198
389
  * @param {*} [options] Override http request option.
1199
390
  * @throws {RequiredError}
1200
391
  */
1201
- async getQueuePositions(getQueuePositionsRequest: GetQueuePositionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetQueuePositionsResponse>> {
1202
- const localVarAxiosArgs = await localVarAxiosParamCreator.getQueuePositions(getQueuePositionsRequest, options);
392
+ async getPositions(cursor?: string, limit?: number, countFilter?: string, settlementStatus?: GetPositionsSettlementStatusEnum, ticker?: string, eventTicker?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPositionsResponse>> {
393
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getPositions(cursor, limit, countFilter, settlementStatus, ticker, eventTicker, options);
1203
394
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1204
395
  const localVarOperationServerBasePath: string | undefined = undefined;
1205
396
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1206
397
  },
1207
398
  /**
1208
- * Get settlements for the logged-in user
399
+ * Endpoint for getting the member\'s settlements historical track.
1209
400
  * @summary Get Settlements
1210
401
  * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
1211
402
  * @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
+ * @param {string} [ticker] Filter by market ticker
404
+ * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
405
+ * @param {number} [minTs] Filter items after this Unix timestamp
406
+ * @param {number} [maxTs] Filter items before this Unix timestamp
1212
407
  * @param {*} [options] Override http request option.
1213
408
  * @throws {RequiredError}
1214
409
  */
1215
- async getSettlements(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettlementsResponse>> {
1216
- const localVarAxiosArgs = await localVarAxiosParamCreator.getSettlements(limit, cursor, options);
1217
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1218
- const localVarOperationServerBasePath: string | undefined = undefined;
1219
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1220
- },
1221
- /**
1222
- * Get the total value of all resting orders
1223
- * @summary Get Total Resting Order Value
1224
- * @param {*} [options] Override http request option.
1225
- * @throws {RequiredError}
1226
- */
1227
- async getTotalRestingOrderValue(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTotalRestingOrderValueResponse>> {
1228
- const localVarAxiosArgs = await localVarAxiosParamCreator.getTotalRestingOrderValue(options);
1229
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1230
- const localVarOperationServerBasePath: string | undefined = undefined;
1231
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1232
- },
1233
- /**
1234
- * Reset an order group
1235
- * @summary Reset Order Group
1236
- * @param {string} orderGroupId Order group ID
1237
- * @param {*} [options] Override http request option.
1238
- * @throws {RequiredError}
1239
- */
1240
- async resetOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
1241
- const localVarAxiosArgs = await localVarAxiosParamCreator.resetOrderGroup(orderGroupId, options);
410
+ async getSettlements(limit?: number, cursor?: string, ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettlementsResponse>> {
411
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getSettlements(limit, cursor, ticker, eventTicker, minTs, maxTs, options);
1242
412
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1243
413
  const localVarOperationServerBasePath: string | undefined = undefined;
1244
414
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1253,89 +423,7 @@ export const PortfolioApiFactory = function (configuration?: Configuration, base
1253
423
  const localVarFp = PortfolioApiFp(configuration)
1254
424
  return {
1255
425
  /**
1256
- * Amend an existing order
1257
- * @summary Amend Order
1258
- * @param {string} orderId Order ID
1259
- * @param {AmendOrderRequest} amendOrderRequest
1260
- * @param {*} [options] Override http request option.
1261
- * @throws {RequiredError}
1262
- */
1263
- amendOrder(orderId: string, amendOrderRequest: AmendOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<AmendOrderResponse> {
1264
- return localVarFp.amendOrder(orderId, amendOrderRequest, options).then((request) => request(axios, basePath));
1265
- },
1266
- /**
1267
- * Cancel multiple orders in a single request
1268
- * @summary Batch Cancel Orders
1269
- * @param {BatchCancelOrdersRequest} batchCancelOrdersRequest
1270
- * @param {*} [options] Override http request option.
1271
- * @throws {RequiredError}
1272
- */
1273
- batchCancelOrders(batchCancelOrdersRequest: BatchCancelOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<BatchCancelOrdersResponse> {
1274
- return localVarFp.batchCancelOrders(batchCancelOrdersRequest, options).then((request) => request(axios, basePath));
1275
- },
1276
- /**
1277
- * Create multiple orders in a single request
1278
- * @summary Batch Create Orders
1279
- * @param {BatchCreateOrdersRequest} batchCreateOrdersRequest
1280
- * @param {*} [options] Override http request option.
1281
- * @throws {RequiredError}
1282
- */
1283
- batchCreateOrders(batchCreateOrdersRequest: BatchCreateOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<BatchCreateOrdersResponse> {
1284
- return localVarFp.batchCreateOrders(batchCreateOrdersRequest, options).then((request) => request(axios, basePath));
1285
- },
1286
- /**
1287
- * Cancel an order
1288
- * @summary Cancel Order
1289
- * @param {string} orderId Order ID
1290
- * @param {*} [options] Override http request option.
1291
- * @throws {RequiredError}
1292
- */
1293
- cancelOrder(orderId: string, options?: RawAxiosRequestConfig): AxiosPromise<CancelOrderResponse> {
1294
- return localVarFp.cancelOrder(orderId, options).then((request) => request(axios, basePath));
1295
- },
1296
- /**
1297
- * Create a new order
1298
- * @summary Create Order
1299
- * @param {CreateOrderRequest} createOrderRequest
1300
- * @param {*} [options] Override http request option.
1301
- * @throws {RequiredError}
1302
- */
1303
- createOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderResponse> {
1304
- return localVarFp.createOrder(createOrderRequest, options).then((request) => request(axios, basePath));
1305
- },
1306
- /**
1307
- * Create a new order group
1308
- * @summary Create Order Group
1309
- * @param {CreateOrderGroupRequest} createOrderGroupRequest
1310
- * @param {*} [options] Override http request option.
1311
- * @throws {RequiredError}
1312
- */
1313
- createOrderGroup(createOrderGroupRequest: CreateOrderGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderGroupResponse> {
1314
- return localVarFp.createOrderGroup(createOrderGroupRequest, options).then((request) => request(axios, basePath));
1315
- },
1316
- /**
1317
- * Decrease the size of an existing order
1318
- * @summary Decrease Order
1319
- * @param {string} orderId Order ID
1320
- * @param {DecreaseOrderRequest} decreaseOrderRequest
1321
- * @param {*} [options] Override http request option.
1322
- * @throws {RequiredError}
1323
- */
1324
- decreaseOrder(orderId: string, decreaseOrderRequest: DecreaseOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<DecreaseOrderResponse> {
1325
- return localVarFp.decreaseOrder(orderId, decreaseOrderRequest, options).then((request) => request(axios, basePath));
1326
- },
1327
- /**
1328
- * Delete an order group
1329
- * @summary Delete Order Group
1330
- * @param {string} orderGroupId Order group ID
1331
- * @param {*} [options] Override http request option.
1332
- * @throws {RequiredError}
1333
- */
1334
- deleteOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
1335
- return localVarFp.deleteOrderGroup(orderGroupId, options).then((request) => request(axios, basePath));
1336
- },
1337
- /**
1338
- * Get the user\'s current balance
426
+ * Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents.
1339
427
  * @summary Get Balance
1340
428
  * @param {*} [options] Override http request option.
1341
429
  * @throws {RequiredError}
@@ -1344,7 +432,7 @@ export const PortfolioApiFactory = function (configuration?: Configuration, base
1344
432
  return localVarFp.getBalance(options).then((request) => request(axios, basePath));
1345
433
  },
1346
434
  /**
1347
- * 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.
435
+ * Endpoint for getting all fills for the member. A fill is when a trade you have is matched.
1348
436
  * @summary Get Fills
1349
437
  * @param {string} [ticker] Filter by market ticker
1350
438
  * @param {string} [orderId] Filter by order ID
@@ -1359,117 +447,43 @@ export const PortfolioApiFactory = function (configuration?: Configuration, base
1359
447
  return localVarFp.getFills(ticker, orderId, minTs, maxTs, limit, cursor, options).then((request) => request(axios, basePath));
1360
448
  },
1361
449
  /**
1362
- * Get a single order by ID
1363
- * @summary Get Order
1364
- * @param {string} orderId Order ID
1365
- * @param {*} [options] Override http request option.
1366
- * @throws {RequiredError}
1367
- */
1368
- getOrder(orderId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderResponse> {
1369
- return localVarFp.getOrder(orderId, options).then((request) => request(axios, basePath));
1370
- },
1371
- /**
1372
- * Get details of a specific order group
1373
- * @summary Get Order Group
1374
- * @param {string} orderGroupId Order group ID
1375
- * @param {*} [options] Override http request option.
1376
- * @throws {RequiredError}
1377
- */
1378
- getOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderGroupResponse> {
1379
- return localVarFp.getOrderGroup(orderGroupId, options).then((request) => request(axios, basePath));
1380
- },
1381
- /**
1382
- * Get order groups for the logged-in user
1383
- * @summary Get Order Groups
1384
- * @param {string} [status] Filter by status. Possible values depend on the endpoint.
1385
- * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
1386
- * @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.
1387
- * @param {*} [options] Override http request option.
1388
- * @throws {RequiredError}
1389
- */
1390
- getOrderGroups(status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderGroupsResponse> {
1391
- return localVarFp.getOrderGroups(status, limit, cursor, options).then((request) => request(axios, basePath));
1392
- },
1393
- /**
1394
- * Get the queue position for an order
1395
- * @summary Get Order Queue Position
1396
- * @param {string} orderId Order ID
1397
- * @param {*} [options] Override http request option.
1398
- * @throws {RequiredError}
1399
- */
1400
- getOrderQueuePosition(orderId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderQueuePositionResponse> {
1401
- return localVarFp.getOrderQueuePosition(orderId, options).then((request) => request(axios, basePath));
1402
- },
1403
- /**
1404
- * Get orders for the logged-in user
1405
- * @summary Get Orders
1406
- * @param {string} [ticker] Filter by market ticker
1407
- * @param {string} [eventTicker] Filter by event ticker
1408
- * @param {number} [minTs] Filter items after this Unix timestamp
1409
- * @param {number} [maxTs] Filter items before this Unix timestamp
1410
- * @param {string} [status] Filter by status. Possible values depend on the endpoint.
1411
- * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
1412
- * @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.
450
+ * 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.
451
+ * @summary Get Total Resting Order Value
1413
452
  * @param {*} [options] Override http request option.
1414
453
  * @throws {RequiredError}
1415
454
  */
1416
- getOrders(ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetOrdersResponse> {
1417
- return localVarFp.getOrders(ticker, eventTicker, minTs, maxTs, status, limit, cursor, options).then((request) => request(axios, basePath));
455
+ getPortfolioRestingOrderTotalValue(options?: RawAxiosRequestConfig): AxiosPromise<GetPortfolioRestingOrderTotalValueResponse> {
456
+ return localVarFp.getPortfolioRestingOrderTotalValue(options).then((request) => request(axios, basePath));
1418
457
  },
1419
458
  /**
1420
- * Get positions for the logged-in user
459
+ * 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
1421
460
  * @summary Get Positions
461
+ * @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.
462
+ * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
463
+ * @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
464
+ * @param {GetPositionsSettlementStatusEnum} [settlementStatus] Settlement status of the markets to return. Defaults to unsettled.
1422
465
  * @param {string} [ticker] Filter by market ticker
1423
- * @param {string} [eventTicker] Filter by event ticker
1424
- * @param {number} [countDown] Filter positions by minimum count down value
1425
- * @param {number} [countUp] Filter positions by minimum count up value
1426
- * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
1427
- * @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.
1428
- * @param {*} [options] Override http request option.
1429
- * @throws {RequiredError}
1430
- */
1431
- getPositions(ticker?: string, eventTicker?: string, countDown?: number, countUp?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetPositionsResponse> {
1432
- return localVarFp.getPositions(ticker, eventTicker, countDown, countUp, limit, cursor, options).then((request) => request(axios, basePath));
1433
- },
1434
- /**
1435
- * Get queue positions for multiple orders
1436
- * @summary Get Queue Positions
1437
- * @param {GetQueuePositionsRequest} getQueuePositionsRequest
466
+ * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
1438
467
  * @param {*} [options] Override http request option.
1439
468
  * @throws {RequiredError}
1440
469
  */
1441
- getQueuePositions(getQueuePositionsRequest: GetQueuePositionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetQueuePositionsResponse> {
1442
- return localVarFp.getQueuePositions(getQueuePositionsRequest, options).then((request) => request(axios, basePath));
470
+ getPositions(cursor?: string, limit?: number, countFilter?: string, settlementStatus?: GetPositionsSettlementStatusEnum, ticker?: string, eventTicker?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetPositionsResponse> {
471
+ return localVarFp.getPositions(cursor, limit, countFilter, settlementStatus, ticker, eventTicker, options).then((request) => request(axios, basePath));
1443
472
  },
1444
473
  /**
1445
- * Get settlements for the logged-in user
474
+ * Endpoint for getting the member\'s settlements historical track.
1446
475
  * @summary Get Settlements
1447
476
  * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
1448
477
  * @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.
478
+ * @param {string} [ticker] Filter by market ticker
479
+ * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
480
+ * @param {number} [minTs] Filter items after this Unix timestamp
481
+ * @param {number} [maxTs] Filter items before this Unix timestamp
1449
482
  * @param {*} [options] Override http request option.
1450
483
  * @throws {RequiredError}
1451
484
  */
1452
- getSettlements(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetSettlementsResponse> {
1453
- return localVarFp.getSettlements(limit, cursor, options).then((request) => request(axios, basePath));
1454
- },
1455
- /**
1456
- * Get the total value of all resting orders
1457
- * @summary Get Total Resting Order Value
1458
- * @param {*} [options] Override http request option.
1459
- * @throws {RequiredError}
1460
- */
1461
- getTotalRestingOrderValue(options?: RawAxiosRequestConfig): AxiosPromise<GetTotalRestingOrderValueResponse> {
1462
- return localVarFp.getTotalRestingOrderValue(options).then((request) => request(axios, basePath));
1463
- },
1464
- /**
1465
- * Reset an order group
1466
- * @summary Reset Order Group
1467
- * @param {string} orderGroupId Order group ID
1468
- * @param {*} [options] Override http request option.
1469
- * @throws {RequiredError}
1470
- */
1471
- resetOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
1472
- return localVarFp.resetOrderGroup(orderGroupId, options).then((request) => request(axios, basePath));
485
+ getSettlements(limit?: number, cursor?: string, ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, options?: RawAxiosRequestConfig): AxiosPromise<GetSettlementsResponse> {
486
+ return localVarFp.getSettlements(limit, cursor, ticker, eventTicker, minTs, maxTs, options).then((request) => request(axios, basePath));
1473
487
  },
1474
488
  };
1475
489
  };
@@ -1479,97 +493,7 @@ export const PortfolioApiFactory = function (configuration?: Configuration, base
1479
493
  */
1480
494
  export class PortfolioApi extends BaseAPI {
1481
495
  /**
1482
- * Amend an existing order
1483
- * @summary Amend Order
1484
- * @param {string} orderId Order ID
1485
- * @param {AmendOrderRequest} amendOrderRequest
1486
- * @param {*} [options] Override http request option.
1487
- * @throws {RequiredError}
1488
- */
1489
- public amendOrder(orderId: string, amendOrderRequest: AmendOrderRequest, options?: RawAxiosRequestConfig) {
1490
- return PortfolioApiFp(this.configuration).amendOrder(orderId, amendOrderRequest, options).then((request) => request(this.axios, this.basePath));
1491
- }
1492
-
1493
- /**
1494
- * Cancel multiple orders in a single request
1495
- * @summary Batch Cancel Orders
1496
- * @param {BatchCancelOrdersRequest} batchCancelOrdersRequest
1497
- * @param {*} [options] Override http request option.
1498
- * @throws {RequiredError}
1499
- */
1500
- public batchCancelOrders(batchCancelOrdersRequest: BatchCancelOrdersRequest, options?: RawAxiosRequestConfig) {
1501
- return PortfolioApiFp(this.configuration).batchCancelOrders(batchCancelOrdersRequest, options).then((request) => request(this.axios, this.basePath));
1502
- }
1503
-
1504
- /**
1505
- * Create multiple orders in a single request
1506
- * @summary Batch Create Orders
1507
- * @param {BatchCreateOrdersRequest} batchCreateOrdersRequest
1508
- * @param {*} [options] Override http request option.
1509
- * @throws {RequiredError}
1510
- */
1511
- public batchCreateOrders(batchCreateOrdersRequest: BatchCreateOrdersRequest, options?: RawAxiosRequestConfig) {
1512
- return PortfolioApiFp(this.configuration).batchCreateOrders(batchCreateOrdersRequest, options).then((request) => request(this.axios, this.basePath));
1513
- }
1514
-
1515
- /**
1516
- * Cancel an order
1517
- * @summary Cancel Order
1518
- * @param {string} orderId Order ID
1519
- * @param {*} [options] Override http request option.
1520
- * @throws {RequiredError}
1521
- */
1522
- public cancelOrder(orderId: string, options?: RawAxiosRequestConfig) {
1523
- return PortfolioApiFp(this.configuration).cancelOrder(orderId, options).then((request) => request(this.axios, this.basePath));
1524
- }
1525
-
1526
- /**
1527
- * Create a new order
1528
- * @summary Create Order
1529
- * @param {CreateOrderRequest} createOrderRequest
1530
- * @param {*} [options] Override http request option.
1531
- * @throws {RequiredError}
1532
- */
1533
- public createOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig) {
1534
- return PortfolioApiFp(this.configuration).createOrder(createOrderRequest, options).then((request) => request(this.axios, this.basePath));
1535
- }
1536
-
1537
- /**
1538
- * Create a new order group
1539
- * @summary Create Order Group
1540
- * @param {CreateOrderGroupRequest} createOrderGroupRequest
1541
- * @param {*} [options] Override http request option.
1542
- * @throws {RequiredError}
1543
- */
1544
- public createOrderGroup(createOrderGroupRequest: CreateOrderGroupRequest, options?: RawAxiosRequestConfig) {
1545
- return PortfolioApiFp(this.configuration).createOrderGroup(createOrderGroupRequest, options).then((request) => request(this.axios, this.basePath));
1546
- }
1547
-
1548
- /**
1549
- * Decrease the size of an existing order
1550
- * @summary Decrease Order
1551
- * @param {string} orderId Order ID
1552
- * @param {DecreaseOrderRequest} decreaseOrderRequest
1553
- * @param {*} [options] Override http request option.
1554
- * @throws {RequiredError}
1555
- */
1556
- public decreaseOrder(orderId: string, decreaseOrderRequest: DecreaseOrderRequest, options?: RawAxiosRequestConfig) {
1557
- return PortfolioApiFp(this.configuration).decreaseOrder(orderId, decreaseOrderRequest, options).then((request) => request(this.axios, this.basePath));
1558
- }
1559
-
1560
- /**
1561
- * Delete an order group
1562
- * @summary Delete Order Group
1563
- * @param {string} orderGroupId Order group ID
1564
- * @param {*} [options] Override http request option.
1565
- * @throws {RequiredError}
1566
- */
1567
- public deleteOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig) {
1568
- return PortfolioApiFp(this.configuration).deleteOrderGroup(orderGroupId, options).then((request) => request(this.axios, this.basePath));
1569
- }
1570
-
1571
- /**
1572
- * Get the user\'s current balance
496
+ * Endpoint for getting the balance and portfolio value of a member. Both values are returned in cents.
1573
497
  * @summary Get Balance
1574
498
  * @param {*} [options] Override http request option.
1575
499
  * @throws {RequiredError}
@@ -1579,7 +503,7 @@ export class PortfolioApi extends BaseAPI {
1579
503
  }
1580
504
 
1581
505
  /**
1582
- * 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.
506
+ * Endpoint for getting all fills for the member. A fill is when a trade you have is matched.
1583
507
  * @summary Get Fills
1584
508
  * @param {string} [ticker] Filter by market ticker
1585
509
  * @param {string} [orderId] Filter by order ID
@@ -1595,126 +519,51 @@ export class PortfolioApi extends BaseAPI {
1595
519
  }
1596
520
 
1597
521
  /**
1598
- * Get a single order by ID
1599
- * @summary Get Order
1600
- * @param {string} orderId Order ID
1601
- * @param {*} [options] Override http request option.
1602
- * @throws {RequiredError}
1603
- */
1604
- public getOrder(orderId: string, options?: RawAxiosRequestConfig) {
1605
- return PortfolioApiFp(this.configuration).getOrder(orderId, options).then((request) => request(this.axios, this.basePath));
1606
- }
1607
-
1608
- /**
1609
- * Get details of a specific order group
1610
- * @summary Get Order Group
1611
- * @param {string} orderGroupId Order group ID
1612
- * @param {*} [options] Override http request option.
1613
- * @throws {RequiredError}
1614
- */
1615
- public getOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig) {
1616
- return PortfolioApiFp(this.configuration).getOrderGroup(orderGroupId, options).then((request) => request(this.axios, this.basePath));
1617
- }
1618
-
1619
- /**
1620
- * Get order groups for the logged-in user
1621
- * @summary Get Order Groups
1622
- * @param {string} [status] Filter by status. Possible values depend on the endpoint.
1623
- * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
1624
- * @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.
1625
- * @param {*} [options] Override http request option.
1626
- * @throws {RequiredError}
1627
- */
1628
- public getOrderGroups(status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) {
1629
- return PortfolioApiFp(this.configuration).getOrderGroups(status, limit, cursor, options).then((request) => request(this.axios, this.basePath));
1630
- }
1631
-
1632
- /**
1633
- * Get the queue position for an order
1634
- * @summary Get Order Queue Position
1635
- * @param {string} orderId Order ID
1636
- * @param {*} [options] Override http request option.
1637
- * @throws {RequiredError}
1638
- */
1639
- public getOrderQueuePosition(orderId: string, options?: RawAxiosRequestConfig) {
1640
- return PortfolioApiFp(this.configuration).getOrderQueuePosition(orderId, options).then((request) => request(this.axios, this.basePath));
1641
- }
1642
-
1643
- /**
1644
- * Get orders for the logged-in user
1645
- * @summary Get Orders
1646
- * @param {string} [ticker] Filter by market ticker
1647
- * @param {string} [eventTicker] Filter by event ticker
1648
- * @param {number} [minTs] Filter items after this Unix timestamp
1649
- * @param {number} [maxTs] Filter items before this Unix timestamp
1650
- * @param {string} [status] Filter by status. Possible values depend on the endpoint.
1651
- * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
1652
- * @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.
522
+ * 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.
523
+ * @summary Get Total Resting Order Value
1653
524
  * @param {*} [options] Override http request option.
1654
525
  * @throws {RequiredError}
1655
526
  */
1656
- public getOrders(ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, status?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) {
1657
- return PortfolioApiFp(this.configuration).getOrders(ticker, eventTicker, minTs, maxTs, status, limit, cursor, options).then((request) => request(this.axios, this.basePath));
527
+ public getPortfolioRestingOrderTotalValue(options?: RawAxiosRequestConfig) {
528
+ return PortfolioApiFp(this.configuration).getPortfolioRestingOrderTotalValue(options).then((request) => request(this.axios, this.basePath));
1658
529
  }
1659
530
 
1660
531
  /**
1661
- * Get positions for the logged-in user
532
+ * 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
1662
533
  * @summary Get Positions
534
+ * @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.
535
+ * @param {number} [limit] Parameter to specify the number of results per page. Defaults to 100.
536
+ * @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
537
+ * @param {GetPositionsSettlementStatusEnum} [settlementStatus] Settlement status of the markets to return. Defaults to unsettled.
1663
538
  * @param {string} [ticker] Filter by market ticker
1664
- * @param {string} [eventTicker] Filter by event ticker
1665
- * @param {number} [countDown] Filter positions by minimum count down value
1666
- * @param {number} [countUp] Filter positions by minimum count up value
1667
- * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
1668
- * @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.
1669
- * @param {*} [options] Override http request option.
1670
- * @throws {RequiredError}
1671
- */
1672
- public getPositions(ticker?: string, eventTicker?: string, countDown?: number, countUp?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) {
1673
- return PortfolioApiFp(this.configuration).getPositions(ticker, eventTicker, countDown, countUp, limit, cursor, options).then((request) => request(this.axios, this.basePath));
1674
- }
1675
-
1676
- /**
1677
- * Get queue positions for multiple orders
1678
- * @summary Get Queue Positions
1679
- * @param {GetQueuePositionsRequest} getQueuePositionsRequest
539
+ * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
1680
540
  * @param {*} [options] Override http request option.
1681
541
  * @throws {RequiredError}
1682
542
  */
1683
- public getQueuePositions(getQueuePositionsRequest: GetQueuePositionsRequest, options?: RawAxiosRequestConfig) {
1684
- return PortfolioApiFp(this.configuration).getQueuePositions(getQueuePositionsRequest, options).then((request) => request(this.axios, this.basePath));
543
+ public getPositions(cursor?: string, limit?: number, countFilter?: string, settlementStatus?: GetPositionsSettlementStatusEnum, ticker?: string, eventTicker?: string, options?: RawAxiosRequestConfig) {
544
+ return PortfolioApiFp(this.configuration).getPositions(cursor, limit, countFilter, settlementStatus, ticker, eventTicker, options).then((request) => request(this.axios, this.basePath));
1685
545
  }
1686
546
 
1687
547
  /**
1688
- * Get settlements for the logged-in user
548
+ * Endpoint for getting the member\'s settlements historical track.
1689
549
  * @summary Get Settlements
1690
550
  * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
1691
551
  * @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.
552
+ * @param {string} [ticker] Filter by market ticker
553
+ * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
554
+ * @param {number} [minTs] Filter items after this Unix timestamp
555
+ * @param {number} [maxTs] Filter items before this Unix timestamp
1692
556
  * @param {*} [options] Override http request option.
1693
557
  * @throws {RequiredError}
1694
558
  */
1695
- public getSettlements(limit?: number, cursor?: string, options?: RawAxiosRequestConfig) {
1696
- return PortfolioApiFp(this.configuration).getSettlements(limit, cursor, options).then((request) => request(this.axios, this.basePath));
1697
- }
1698
-
1699
- /**
1700
- * Get the total value of all resting orders
1701
- * @summary Get Total Resting Order Value
1702
- * @param {*} [options] Override http request option.
1703
- * @throws {RequiredError}
1704
- */
1705
- public getTotalRestingOrderValue(options?: RawAxiosRequestConfig) {
1706
- return PortfolioApiFp(this.configuration).getTotalRestingOrderValue(options).then((request) => request(this.axios, this.basePath));
1707
- }
1708
-
1709
- /**
1710
- * Reset an order group
1711
- * @summary Reset Order Group
1712
- * @param {string} orderGroupId Order group ID
1713
- * @param {*} [options] Override http request option.
1714
- * @throws {RequiredError}
1715
- */
1716
- public resetOrderGroup(orderGroupId: string, options?: RawAxiosRequestConfig) {
1717
- return PortfolioApiFp(this.configuration).resetOrderGroup(orderGroupId, options).then((request) => request(this.axios, this.basePath));
559
+ public getSettlements(limit?: number, cursor?: string, ticker?: string, eventTicker?: string, minTs?: number, maxTs?: number, options?: RawAxiosRequestConfig) {
560
+ return PortfolioApiFp(this.configuration).getSettlements(limit, cursor, ticker, eventTicker, minTs, maxTs, options).then((request) => request(this.axios, this.basePath));
1718
561
  }
1719
562
  }
1720
563
 
564
+ export const GetPositionsSettlementStatusEnum = {
565
+ All: 'all',
566
+ Unsettled: 'unsettled',
567
+ Settled: 'settled'
568
+ } as const;
569
+ export type GetPositionsSettlementStatusEnum = typeof GetPositionsSettlementStatusEnum[keyof typeof GetPositionsSettlementStatusEnum];