kalshi-typescript 2.1.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 (626) hide show
  1. package/.openapi-generator/FILES +210 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +25 -0
  4. package/README.md +212 -0
  5. package/api/api-keys-api.ts +354 -0
  6. package/api/communications-api.ts +863 -0
  7. package/api/events-api.ts +330 -0
  8. package/api/exchange-api.ts +315 -0
  9. package/api/markets-api.ts +554 -0
  10. package/api/milestones-api.ts +216 -0
  11. package/api/multivariate-collections-api.ts +293 -0
  12. package/api/portfolio-api.ts +1646 -0
  13. package/api/series-api.ts +208 -0
  14. package/api/structured-targets-api.ts +216 -0
  15. package/api.ts +27 -0
  16. package/base.ts +62 -0
  17. package/common.ts +98 -0
  18. package/configuration.ts +94 -0
  19. package/dist/api/api-keys-api.d.ts +163 -0
  20. package/dist/api/api-keys-api.js +333 -0
  21. package/dist/api/communications-api.d.ts +388 -0
  22. package/dist/api/communications-api.js +803 -0
  23. package/dist/api/events-api.d.ts +157 -0
  24. package/dist/api/events-api.js +312 -0
  25. package/dist/api/exchange-api.d.ts +150 -0
  26. package/dist/api/exchange-api.js +301 -0
  27. package/dist/api/markets-api.d.ts +263 -0
  28. package/dist/api/markets-api.js +515 -0
  29. package/dist/api/milestones-api.d.ts +104 -0
  30. package/dist/api/milestones-api.js +209 -0
  31. package/dist/api/multivariate-collections-api.d.ts +138 -0
  32. package/dist/api/multivariate-collections-api.js +278 -0
  33. package/dist/api/portfolio-api.d.ts +742 -0
  34. package/dist/api/portfolio-api.js +1498 -0
  35. package/dist/api/series-api.d.ts +100 -0
  36. package/dist/api/series-api.js +202 -0
  37. package/dist/api/structured-targets-api.d.ts +104 -0
  38. package/dist/api/structured-targets-api.js +209 -0
  39. package/dist/api.d.ts +21 -0
  40. package/dist/api.js +39 -0
  41. package/dist/base.d.ts +42 -0
  42. package/dist/base.js +46 -0
  43. package/dist/common.d.ts +29 -0
  44. package/dist/common.js +109 -0
  45. package/dist/configuration.d.ts +75 -0
  46. package/dist/configuration.js +40 -0
  47. package/dist/esm/api/api-keys-api.d.ts +163 -0
  48. package/dist/esm/api/api-keys-api.js +326 -0
  49. package/dist/esm/api/communications-api.d.ts +388 -0
  50. package/dist/esm/api/communications-api.js +796 -0
  51. package/dist/esm/api/events-api.d.ts +157 -0
  52. package/dist/esm/api/events-api.js +305 -0
  53. package/dist/esm/api/exchange-api.d.ts +150 -0
  54. package/dist/esm/api/exchange-api.js +294 -0
  55. package/dist/esm/api/markets-api.d.ts +263 -0
  56. package/dist/esm/api/markets-api.js +508 -0
  57. package/dist/esm/api/milestones-api.d.ts +104 -0
  58. package/dist/esm/api/milestones-api.js +202 -0
  59. package/dist/esm/api/multivariate-collections-api.d.ts +138 -0
  60. package/dist/esm/api/multivariate-collections-api.js +271 -0
  61. package/dist/esm/api/portfolio-api.d.ts +742 -0
  62. package/dist/esm/api/portfolio-api.js +1491 -0
  63. package/dist/esm/api/series-api.d.ts +100 -0
  64. package/dist/esm/api/series-api.js +195 -0
  65. package/dist/esm/api/structured-targets-api.d.ts +104 -0
  66. package/dist/esm/api/structured-targets-api.js +202 -0
  67. package/dist/esm/api.d.ts +21 -0
  68. package/dist/esm/api.js +23 -0
  69. package/dist/esm/base.d.ts +42 -0
  70. package/dist/esm/base.js +41 -0
  71. package/dist/esm/common.d.ts +29 -0
  72. package/dist/esm/common.js +97 -0
  73. package/dist/esm/configuration.d.ts +75 -0
  74. package/dist/esm/configuration.js +36 -0
  75. package/dist/esm/index.d.ts +14 -0
  76. package/dist/esm/index.js +16 -0
  77. package/dist/esm/models/accept-quote-request.d.ts +14 -0
  78. package/dist/esm/models/accept-quote-request.js +14 -0
  79. package/dist/esm/models/amend-order-request.d.ts +16 -0
  80. package/dist/esm/models/amend-order-request.js +14 -0
  81. package/dist/esm/models/amend-order-response.d.ts +15 -0
  82. package/dist/esm/models/amend-order-response.js +14 -0
  83. package/dist/esm/models/announcement.d.ts +28 -0
  84. package/dist/esm/models/announcement.js +22 -0
  85. package/dist/esm/models/api-key.d.ts +25 -0
  86. package/dist/esm/models/api-key.js +14 -0
  87. package/dist/esm/models/batch-cancel-orders-request.d.ts +14 -0
  88. package/dist/esm/models/batch-cancel-orders-request.js +14 -0
  89. package/dist/esm/models/batch-cancel-orders-response-responses-inner.d.ts +17 -0
  90. package/dist/esm/models/batch-cancel-orders-response-responses-inner.js +14 -0
  91. package/dist/esm/models/batch-cancel-orders-response.d.ts +15 -0
  92. package/dist/esm/models/batch-cancel-orders-response.js +14 -0
  93. package/dist/esm/models/batch-create-orders-request.d.ts +15 -0
  94. package/dist/esm/models/batch-create-orders-request.js +14 -0
  95. package/dist/esm/models/batch-create-orders-response-responses-inner.d.ts +17 -0
  96. package/dist/esm/models/batch-create-orders-response-responses-inner.js +14 -0
  97. package/dist/esm/models/batch-create-orders-response.d.ts +15 -0
  98. package/dist/esm/models/batch-create-orders-response.js +14 -0
  99. package/dist/esm/models/cancel-order-response.d.ts +16 -0
  100. package/dist/esm/models/cancel-order-response.js +14 -0
  101. package/dist/esm/models/candlestick.d.ts +20 -0
  102. package/dist/esm/models/candlestick.js +14 -0
  103. package/dist/esm/models/create-api-key-request.d.ts +21 -0
  104. package/dist/esm/models/create-api-key-request.js +14 -0
  105. package/dist/esm/models/create-api-key-response.d.ts +17 -0
  106. package/dist/esm/models/create-api-key-response.js +14 -0
  107. package/dist/esm/models/create-order-group-request.d.ts +14 -0
  108. package/dist/esm/models/create-order-group-request.js +14 -0
  109. package/dist/esm/models/create-order-group-response.d.ts +15 -0
  110. package/dist/esm/models/create-order-group-response.js +14 -0
  111. package/dist/esm/models/create-order-request.d.ts +39 -0
  112. package/dist/esm/models/create-order-request.js +25 -0
  113. package/dist/esm/models/create-order-response.d.ts +15 -0
  114. package/dist/esm/models/create-order-response.js +14 -0
  115. package/dist/esm/models/create-quote-request.d.ts +16 -0
  116. package/dist/esm/models/create-quote-request.js +14 -0
  117. package/dist/esm/models/create-quote-response.d.ts +15 -0
  118. package/dist/esm/models/create-quote-response.js +14 -0
  119. package/dist/esm/models/create-rfqrequest.d.ts +22 -0
  120. package/dist/esm/models/create-rfqrequest.js +17 -0
  121. package/dist/esm/models/create-rfqresponse.d.ts +15 -0
  122. package/dist/esm/models/create-rfqresponse.js +14 -0
  123. package/dist/esm/models/daily-schedule.d.ts +15 -0
  124. package/dist/esm/models/daily-schedule.js +14 -0
  125. package/dist/esm/models/decrease-order-request.d.ts +14 -0
  126. package/dist/esm/models/decrease-order-request.js +14 -0
  127. package/dist/esm/models/decrease-order-response.d.ts +15 -0
  128. package/dist/esm/models/decrease-order-response.js +14 -0
  129. package/dist/esm/models/error-response-error.d.ts +25 -0
  130. package/dist/esm/models/error-response-error.js +14 -0
  131. package/dist/esm/models/error-response.d.ts +15 -0
  132. package/dist/esm/models/error-response.js +14 -0
  133. package/dist/esm/models/event.d.ts +26 -0
  134. package/dist/esm/models/event.js +18 -0
  135. package/dist/esm/models/exchange-status.d.ts +15 -0
  136. package/dist/esm/models/exchange-status.js +14 -0
  137. package/dist/esm/models/fill.d.ts +32 -0
  138. package/dist/esm/models/fill.js +21 -0
  139. package/dist/esm/models/generate-api-key-request.d.ts +17 -0
  140. package/dist/esm/models/generate-api-key-request.js +14 -0
  141. package/dist/esm/models/generate-api-key-response.d.ts +21 -0
  142. package/dist/esm/models/generate-api-key-response.js +14 -0
  143. package/dist/esm/models/get-api-keys-response.d.ts +18 -0
  144. package/dist/esm/models/get-api-keys-response.js +14 -0
  145. package/dist/esm/models/get-balance-response.d.ts +17 -0
  146. package/dist/esm/models/get-balance-response.js +14 -0
  147. package/dist/esm/models/get-communications-idresponse.d.ts +17 -0
  148. package/dist/esm/models/get-communications-idresponse.js +14 -0
  149. package/dist/esm/models/get-event-metadata-response.d.ts +14 -0
  150. package/dist/esm/models/get-event-metadata-response.js +14 -0
  151. package/dist/esm/models/get-event-response.d.ts +17 -0
  152. package/dist/esm/models/get-event-response.js +14 -0
  153. package/dist/esm/models/get-events-response.d.ts +16 -0
  154. package/dist/esm/models/get-events-response.js +14 -0
  155. package/dist/esm/models/get-exchange-announcements-response.d.ts +15 -0
  156. package/dist/esm/models/get-exchange-announcements-response.js +14 -0
  157. package/dist/esm/models/get-exchange-schedule-response-schedule.d.ts +21 -0
  158. package/dist/esm/models/get-exchange-schedule-response-schedule.js +14 -0
  159. package/dist/esm/models/get-exchange-schedule-response.d.ts +15 -0
  160. package/dist/esm/models/get-exchange-schedule-response.js +14 -0
  161. package/dist/esm/models/get-fills-response.d.ts +16 -0
  162. package/dist/esm/models/get-fills-response.js +14 -0
  163. package/dist/esm/models/get-market-candlesticks-response.d.ts +15 -0
  164. package/dist/esm/models/get-market-candlesticks-response.js +14 -0
  165. package/dist/esm/models/get-market-orderbook-response-orderbook.d.ts +16 -0
  166. package/dist/esm/models/get-market-orderbook-response-orderbook.js +14 -0
  167. package/dist/esm/models/get-market-orderbook-response.d.ts +15 -0
  168. package/dist/esm/models/get-market-orderbook-response.js +14 -0
  169. package/dist/esm/models/get-market-response.d.ts +15 -0
  170. package/dist/esm/models/get-market-response.js +14 -0
  171. package/dist/esm/models/get-markets-response.d.ts +16 -0
  172. package/dist/esm/models/get-markets-response.js +14 -0
  173. package/dist/esm/models/get-milestone-response.d.ts +15 -0
  174. package/dist/esm/models/get-milestone-response.js +14 -0
  175. package/dist/esm/models/get-milestones-response.d.ts +15 -0
  176. package/dist/esm/models/get-milestones-response.js +14 -0
  177. package/dist/esm/models/get-multivariate-event-collection-response.d.ts +15 -0
  178. package/dist/esm/models/get-multivariate-event-collection-response.js +14 -0
  179. package/dist/esm/models/get-multivariate-event-collections-response.d.ts +15 -0
  180. package/dist/esm/models/get-multivariate-event-collections-response.js +14 -0
  181. package/dist/esm/models/get-order-groups-response.d.ts +16 -0
  182. package/dist/esm/models/get-order-groups-response.js +14 -0
  183. package/dist/esm/models/get-order-queue-position-response.d.ts +14 -0
  184. package/dist/esm/models/get-order-queue-position-response.js +14 -0
  185. package/dist/esm/models/get-order-response.d.ts +15 -0
  186. package/dist/esm/models/get-order-response.js +14 -0
  187. package/dist/esm/models/get-orders-response.d.ts +16 -0
  188. package/dist/esm/models/get-orders-response.js +14 -0
  189. package/dist/esm/models/get-positions-response.d.ts +16 -0
  190. package/dist/esm/models/get-positions-response.js +14 -0
  191. package/dist/esm/models/get-queue-positions-request.d.ts +14 -0
  192. package/dist/esm/models/get-queue-positions-request.js +14 -0
  193. package/dist/esm/models/get-queue-positions-response.d.ts +16 -0
  194. package/dist/esm/models/get-queue-positions-response.js +14 -0
  195. package/dist/esm/models/get-quote-response.d.ts +15 -0
  196. package/dist/esm/models/get-quote-response.js +14 -0
  197. package/dist/esm/models/get-quotes-response.d.ts +15 -0
  198. package/dist/esm/models/get-quotes-response.js +14 -0
  199. package/dist/esm/models/get-rfqresponse.d.ts +15 -0
  200. package/dist/esm/models/get-rfqresponse.js +14 -0
  201. package/dist/esm/models/get-rfqs-response.d.ts +15 -0
  202. package/dist/esm/models/get-rfqs-response.js +14 -0
  203. package/dist/esm/models/get-series-by-ticker-response.d.ts +15 -0
  204. package/dist/esm/models/get-series-by-ticker-response.js +14 -0
  205. package/dist/esm/models/get-series-response.d.ts +15 -0
  206. package/dist/esm/models/get-series-response.js +14 -0
  207. package/dist/esm/models/get-settlements-response.d.ts +16 -0
  208. package/dist/esm/models/get-settlements-response.js +14 -0
  209. package/dist/esm/models/get-structured-target-response.d.ts +15 -0
  210. package/dist/esm/models/get-structured-target-response.js +14 -0
  211. package/dist/esm/models/get-structured-targets-response.d.ts +15 -0
  212. package/dist/esm/models/get-structured-targets-response.js +14 -0
  213. package/dist/esm/models/get-total-resting-order-value-response.d.ts +14 -0
  214. package/dist/esm/models/get-total-resting-order-value-response.js +14 -0
  215. package/dist/esm/models/get-trades-response.d.ts +16 -0
  216. package/dist/esm/models/get-trades-response.js +14 -0
  217. package/dist/esm/models/get-user-data-timestamp-response.d.ts +14 -0
  218. package/dist/esm/models/get-user-data-timestamp-response.js +14 -0
  219. package/dist/esm/models/index.d.ts +88 -0
  220. package/dist/esm/models/index.js +88 -0
  221. package/dist/esm/models/lookup-bundle-request-bundle-inner.d.ts +15 -0
  222. package/dist/esm/models/lookup-bundle-request-bundle-inner.js +14 -0
  223. package/dist/esm/models/lookup-bundle-request.d.ts +15 -0
  224. package/dist/esm/models/lookup-bundle-request.js +14 -0
  225. package/dist/esm/models/lookup-bundle-response.d.ts +15 -0
  226. package/dist/esm/models/lookup-bundle-response.js +14 -0
  227. package/dist/esm/models/market.d.ts +49 -0
  228. package/dist/esm/models/market.js +25 -0
  229. package/dist/esm/models/milestone.d.ts +16 -0
  230. package/dist/esm/models/milestone.js +14 -0
  231. package/dist/esm/models/multivariate-event-collection-events-inner.d.ts +17 -0
  232. package/dist/esm/models/multivariate-event-collection-events-inner.js +14 -0
  233. package/dist/esm/models/multivariate-event-collection.d.ts +18 -0
  234. package/dist/esm/models/multivariate-event-collection.js +14 -0
  235. package/dist/esm/models/order-group.d.ts +17 -0
  236. package/dist/esm/models/order-group.js +14 -0
  237. package/dist/esm/models/order.d.ts +49 -0
  238. package/dist/esm/models/order.js +31 -0
  239. package/dist/esm/models/orderbook-level.d.ts +15 -0
  240. package/dist/esm/models/orderbook-level.js +14 -0
  241. package/dist/esm/models/position.d.ts +26 -0
  242. package/dist/esm/models/position.js +17 -0
  243. package/dist/esm/models/quote.d.ts +27 -0
  244. package/dist/esm/models/quote.js +17 -0
  245. package/dist/esm/models/rfq.d.ts +26 -0
  246. package/dist/esm/models/rfq.js +17 -0
  247. package/dist/esm/models/series.d.ts +20 -0
  248. package/dist/esm/models/series.js +14 -0
  249. package/dist/esm/models/settlement.d.ts +24 -0
  250. package/dist/esm/models/settlement.js +17 -0
  251. package/dist/esm/models/structured-target.d.ts +16 -0
  252. package/dist/esm/models/structured-target.js +14 -0
  253. package/dist/esm/models/trade.d.ts +24 -0
  254. package/dist/esm/models/trade.js +17 -0
  255. package/dist/index.d.ts +14 -0
  256. package/dist/index.js +32 -0
  257. package/dist/models/accept-quote-request.d.ts +14 -0
  258. package/dist/models/accept-quote-request.js +15 -0
  259. package/dist/models/amend-order-request.d.ts +16 -0
  260. package/dist/models/amend-order-request.js +15 -0
  261. package/dist/models/amend-order-response.d.ts +15 -0
  262. package/dist/models/amend-order-response.js +15 -0
  263. package/dist/models/announcement.d.ts +28 -0
  264. package/dist/models/announcement.js +25 -0
  265. package/dist/models/api-key.d.ts +25 -0
  266. package/dist/models/api-key.js +15 -0
  267. package/dist/models/batch-cancel-orders-request.d.ts +14 -0
  268. package/dist/models/batch-cancel-orders-request.js +15 -0
  269. package/dist/models/batch-cancel-orders-response-responses-inner.d.ts +17 -0
  270. package/dist/models/batch-cancel-orders-response-responses-inner.js +15 -0
  271. package/dist/models/batch-cancel-orders-response.d.ts +15 -0
  272. package/dist/models/batch-cancel-orders-response.js +15 -0
  273. package/dist/models/batch-create-orders-request.d.ts +15 -0
  274. package/dist/models/batch-create-orders-request.js +15 -0
  275. package/dist/models/batch-create-orders-response-responses-inner.d.ts +17 -0
  276. package/dist/models/batch-create-orders-response-responses-inner.js +15 -0
  277. package/dist/models/batch-create-orders-response.d.ts +15 -0
  278. package/dist/models/batch-create-orders-response.js +15 -0
  279. package/dist/models/cancel-order-response.d.ts +16 -0
  280. package/dist/models/cancel-order-response.js +15 -0
  281. package/dist/models/candlestick.d.ts +20 -0
  282. package/dist/models/candlestick.js +15 -0
  283. package/dist/models/create-api-key-request.d.ts +21 -0
  284. package/dist/models/create-api-key-request.js +15 -0
  285. package/dist/models/create-api-key-response.d.ts +17 -0
  286. package/dist/models/create-api-key-response.js +15 -0
  287. package/dist/models/create-order-group-request.d.ts +14 -0
  288. package/dist/models/create-order-group-request.js +15 -0
  289. package/dist/models/create-order-group-response.d.ts +15 -0
  290. package/dist/models/create-order-group-response.js +15 -0
  291. package/dist/models/create-order-request.d.ts +39 -0
  292. package/dist/models/create-order-request.js +28 -0
  293. package/dist/models/create-order-response.d.ts +15 -0
  294. package/dist/models/create-order-response.js +15 -0
  295. package/dist/models/create-quote-request.d.ts +16 -0
  296. package/dist/models/create-quote-request.js +15 -0
  297. package/dist/models/create-quote-response.d.ts +15 -0
  298. package/dist/models/create-quote-response.js +15 -0
  299. package/dist/models/create-rfqrequest.d.ts +22 -0
  300. package/dist/models/create-rfqrequest.js +20 -0
  301. package/dist/models/create-rfqresponse.d.ts +15 -0
  302. package/dist/models/create-rfqresponse.js +15 -0
  303. package/dist/models/daily-schedule.d.ts +15 -0
  304. package/dist/models/daily-schedule.js +15 -0
  305. package/dist/models/decrease-order-request.d.ts +14 -0
  306. package/dist/models/decrease-order-request.js +15 -0
  307. package/dist/models/decrease-order-response.d.ts +15 -0
  308. package/dist/models/decrease-order-response.js +15 -0
  309. package/dist/models/error-response-error.d.ts +25 -0
  310. package/dist/models/error-response-error.js +15 -0
  311. package/dist/models/error-response.d.ts +15 -0
  312. package/dist/models/error-response.js +15 -0
  313. package/dist/models/event.d.ts +26 -0
  314. package/dist/models/event.js +21 -0
  315. package/dist/models/exchange-status.d.ts +15 -0
  316. package/dist/models/exchange-status.js +15 -0
  317. package/dist/models/fill.d.ts +32 -0
  318. package/dist/models/fill.js +24 -0
  319. package/dist/models/generate-api-key-request.d.ts +17 -0
  320. package/dist/models/generate-api-key-request.js +15 -0
  321. package/dist/models/generate-api-key-response.d.ts +21 -0
  322. package/dist/models/generate-api-key-response.js +15 -0
  323. package/dist/models/get-api-keys-response.d.ts +18 -0
  324. package/dist/models/get-api-keys-response.js +15 -0
  325. package/dist/models/get-balance-response.d.ts +17 -0
  326. package/dist/models/get-balance-response.js +15 -0
  327. package/dist/models/get-communications-idresponse.d.ts +17 -0
  328. package/dist/models/get-communications-idresponse.js +15 -0
  329. package/dist/models/get-event-metadata-response.d.ts +14 -0
  330. package/dist/models/get-event-metadata-response.js +15 -0
  331. package/dist/models/get-event-response.d.ts +17 -0
  332. package/dist/models/get-event-response.js +15 -0
  333. package/dist/models/get-events-response.d.ts +16 -0
  334. package/dist/models/get-events-response.js +15 -0
  335. package/dist/models/get-exchange-announcements-response.d.ts +15 -0
  336. package/dist/models/get-exchange-announcements-response.js +15 -0
  337. package/dist/models/get-exchange-schedule-response-schedule.d.ts +21 -0
  338. package/dist/models/get-exchange-schedule-response-schedule.js +15 -0
  339. package/dist/models/get-exchange-schedule-response.d.ts +15 -0
  340. package/dist/models/get-exchange-schedule-response.js +15 -0
  341. package/dist/models/get-fills-response.d.ts +16 -0
  342. package/dist/models/get-fills-response.js +15 -0
  343. package/dist/models/get-market-candlesticks-response.d.ts +15 -0
  344. package/dist/models/get-market-candlesticks-response.js +15 -0
  345. package/dist/models/get-market-orderbook-response-orderbook.d.ts +16 -0
  346. package/dist/models/get-market-orderbook-response-orderbook.js +15 -0
  347. package/dist/models/get-market-orderbook-response.d.ts +15 -0
  348. package/dist/models/get-market-orderbook-response.js +15 -0
  349. package/dist/models/get-market-response.d.ts +15 -0
  350. package/dist/models/get-market-response.js +15 -0
  351. package/dist/models/get-markets-response.d.ts +16 -0
  352. package/dist/models/get-markets-response.js +15 -0
  353. package/dist/models/get-milestone-response.d.ts +15 -0
  354. package/dist/models/get-milestone-response.js +15 -0
  355. package/dist/models/get-milestones-response.d.ts +15 -0
  356. package/dist/models/get-milestones-response.js +15 -0
  357. package/dist/models/get-multivariate-event-collection-response.d.ts +15 -0
  358. package/dist/models/get-multivariate-event-collection-response.js +15 -0
  359. package/dist/models/get-multivariate-event-collections-response.d.ts +15 -0
  360. package/dist/models/get-multivariate-event-collections-response.js +15 -0
  361. package/dist/models/get-order-groups-response.d.ts +16 -0
  362. package/dist/models/get-order-groups-response.js +15 -0
  363. package/dist/models/get-order-queue-position-response.d.ts +14 -0
  364. package/dist/models/get-order-queue-position-response.js +15 -0
  365. package/dist/models/get-order-response.d.ts +15 -0
  366. package/dist/models/get-order-response.js +15 -0
  367. package/dist/models/get-orders-response.d.ts +16 -0
  368. package/dist/models/get-orders-response.js +15 -0
  369. package/dist/models/get-positions-response.d.ts +16 -0
  370. package/dist/models/get-positions-response.js +15 -0
  371. package/dist/models/get-queue-positions-request.d.ts +14 -0
  372. package/dist/models/get-queue-positions-request.js +15 -0
  373. package/dist/models/get-queue-positions-response.d.ts +16 -0
  374. package/dist/models/get-queue-positions-response.js +15 -0
  375. package/dist/models/get-quote-response.d.ts +15 -0
  376. package/dist/models/get-quote-response.js +15 -0
  377. package/dist/models/get-quotes-response.d.ts +15 -0
  378. package/dist/models/get-quotes-response.js +15 -0
  379. package/dist/models/get-rfqresponse.d.ts +15 -0
  380. package/dist/models/get-rfqresponse.js +15 -0
  381. package/dist/models/get-rfqs-response.d.ts +15 -0
  382. package/dist/models/get-rfqs-response.js +15 -0
  383. package/dist/models/get-series-by-ticker-response.d.ts +15 -0
  384. package/dist/models/get-series-by-ticker-response.js +15 -0
  385. package/dist/models/get-series-response.d.ts +15 -0
  386. package/dist/models/get-series-response.js +15 -0
  387. package/dist/models/get-settlements-response.d.ts +16 -0
  388. package/dist/models/get-settlements-response.js +15 -0
  389. package/dist/models/get-structured-target-response.d.ts +15 -0
  390. package/dist/models/get-structured-target-response.js +15 -0
  391. package/dist/models/get-structured-targets-response.d.ts +15 -0
  392. package/dist/models/get-structured-targets-response.js +15 -0
  393. package/dist/models/get-total-resting-order-value-response.d.ts +14 -0
  394. package/dist/models/get-total-resting-order-value-response.js +15 -0
  395. package/dist/models/get-trades-response.d.ts +16 -0
  396. package/dist/models/get-trades-response.js +15 -0
  397. package/dist/models/get-user-data-timestamp-response.d.ts +14 -0
  398. package/dist/models/get-user-data-timestamp-response.js +15 -0
  399. package/dist/models/index.d.ts +88 -0
  400. package/dist/models/index.js +104 -0
  401. package/dist/models/lookup-bundle-request-bundle-inner.d.ts +15 -0
  402. package/dist/models/lookup-bundle-request-bundle-inner.js +15 -0
  403. package/dist/models/lookup-bundle-request.d.ts +15 -0
  404. package/dist/models/lookup-bundle-request.js +15 -0
  405. package/dist/models/lookup-bundle-response.d.ts +15 -0
  406. package/dist/models/lookup-bundle-response.js +15 -0
  407. package/dist/models/market.d.ts +49 -0
  408. package/dist/models/market.js +28 -0
  409. package/dist/models/milestone.d.ts +16 -0
  410. package/dist/models/milestone.js +15 -0
  411. package/dist/models/multivariate-event-collection-events-inner.d.ts +17 -0
  412. package/dist/models/multivariate-event-collection-events-inner.js +15 -0
  413. package/dist/models/multivariate-event-collection.d.ts +18 -0
  414. package/dist/models/multivariate-event-collection.js +15 -0
  415. package/dist/models/order-group.d.ts +17 -0
  416. package/dist/models/order-group.js +15 -0
  417. package/dist/models/order.d.ts +49 -0
  418. package/dist/models/order.js +34 -0
  419. package/dist/models/orderbook-level.d.ts +15 -0
  420. package/dist/models/orderbook-level.js +15 -0
  421. package/dist/models/position.d.ts +26 -0
  422. package/dist/models/position.js +20 -0
  423. package/dist/models/quote.d.ts +27 -0
  424. package/dist/models/quote.js +20 -0
  425. package/dist/models/rfq.d.ts +26 -0
  426. package/dist/models/rfq.js +20 -0
  427. package/dist/models/series.d.ts +20 -0
  428. package/dist/models/series.js +15 -0
  429. package/dist/models/settlement.d.ts +24 -0
  430. package/dist/models/settlement.js +20 -0
  431. package/dist/models/structured-target.d.ts +16 -0
  432. package/dist/models/structured-target.js +15 -0
  433. package/dist/models/trade.d.ts +24 -0
  434. package/dist/models/trade.js +20 -0
  435. package/docs/AcceptQuoteRequest.md +20 -0
  436. package/docs/AmendOrderRequest.md +24 -0
  437. package/docs/AmendOrderResponse.md +20 -0
  438. package/docs/Announcement.md +26 -0
  439. package/docs/ApiKey.md +24 -0
  440. package/docs/ApiKeysApi.md +223 -0
  441. package/docs/BatchCancelOrdersRequest.md +20 -0
  442. package/docs/BatchCancelOrdersResponse.md +20 -0
  443. package/docs/BatchCancelOrdersResponseResponsesInner.md +24 -0
  444. package/docs/BatchCreateOrdersRequest.md +20 -0
  445. package/docs/BatchCreateOrdersResponse.md +20 -0
  446. package/docs/BatchCreateOrdersResponseResponsesInner.md +22 -0
  447. package/docs/CancelOrderResponse.md +22 -0
  448. package/docs/Candlestick.md +32 -0
  449. package/docs/CommunicationsApi.md +595 -0
  450. package/docs/CreateApiKeyRequest.md +22 -0
  451. package/docs/CreateApiKeyResponse.md +20 -0
  452. package/docs/CreateOrderGroupRequest.md +20 -0
  453. package/docs/CreateOrderGroupResponse.md +20 -0
  454. package/docs/CreateOrderRequest.md +40 -0
  455. package/docs/CreateOrderResponse.md +20 -0
  456. package/docs/CreateQuoteRequest.md +24 -0
  457. package/docs/CreateQuoteResponse.md +20 -0
  458. package/docs/CreateRFQRequest.md +26 -0
  459. package/docs/CreateRFQResponse.md +20 -0
  460. package/docs/DailySchedule.md +22 -0
  461. package/docs/DecreaseOrderRequest.md +20 -0
  462. package/docs/DecreaseOrderResponse.md +20 -0
  463. package/docs/ErrorResponse.md +20 -0
  464. package/docs/ErrorResponseError.md +24 -0
  465. package/docs/Event.md +30 -0
  466. package/docs/EventsApi.md +190 -0
  467. package/docs/ExchangeApi.md +192 -0
  468. package/docs/ExchangeStatus.md +22 -0
  469. package/docs/Fill.md +36 -0
  470. package/docs/GenerateApiKeyRequest.md +20 -0
  471. package/docs/GenerateApiKeyResponse.md +22 -0
  472. package/docs/GetApiKeysResponse.md +20 -0
  473. package/docs/GetBalanceResponse.md +20 -0
  474. package/docs/GetCommunicationsIDResponse.md +20 -0
  475. package/docs/GetEventMetadataResponse.md +20 -0
  476. package/docs/GetEventResponse.md +22 -0
  477. package/docs/GetEventsResponse.md +22 -0
  478. package/docs/GetExchangeAnnouncementsResponse.md +20 -0
  479. package/docs/GetExchangeScheduleResponse.md +20 -0
  480. package/docs/GetExchangeScheduleResponseSchedule.md +32 -0
  481. package/docs/GetFillsResponse.md +22 -0
  482. package/docs/GetMarketCandlesticksResponse.md +20 -0
  483. package/docs/GetMarketOrderbookResponse.md +20 -0
  484. package/docs/GetMarketOrderbookResponseOrderbook.md +22 -0
  485. package/docs/GetMarketResponse.md +20 -0
  486. package/docs/GetMarketsResponse.md +22 -0
  487. package/docs/GetMilestoneResponse.md +20 -0
  488. package/docs/GetMilestonesResponse.md +20 -0
  489. package/docs/GetMultivariateEventCollectionResponse.md +20 -0
  490. package/docs/GetMultivariateEventCollectionsResponse.md +20 -0
  491. package/docs/GetOrderGroupsResponse.md +22 -0
  492. package/docs/GetOrderQueuePositionResponse.md +20 -0
  493. package/docs/GetOrderResponse.md +20 -0
  494. package/docs/GetOrdersResponse.md +22 -0
  495. package/docs/GetPositionsResponse.md +22 -0
  496. package/docs/GetQueuePositionsRequest.md +20 -0
  497. package/docs/GetQueuePositionsResponse.md +20 -0
  498. package/docs/GetQuoteResponse.md +20 -0
  499. package/docs/GetQuotesResponse.md +20 -0
  500. package/docs/GetRFQResponse.md +20 -0
  501. package/docs/GetRFQsResponse.md +20 -0
  502. package/docs/GetSeriesByTickerResponse.md +20 -0
  503. package/docs/GetSeriesResponse.md +20 -0
  504. package/docs/GetSettlementsResponse.md +22 -0
  505. package/docs/GetStructuredTargetResponse.md +20 -0
  506. package/docs/GetStructuredTargetsResponse.md +20 -0
  507. package/docs/GetTotalRestingOrderValueResponse.md +20 -0
  508. package/docs/GetTradesResponse.md +22 -0
  509. package/docs/GetUserDataTimestampResponse.md +20 -0
  510. package/docs/LookupBundleRequest.md +20 -0
  511. package/docs/LookupBundleRequestBundleInner.md +22 -0
  512. package/docs/LookupBundleResponse.md +22 -0
  513. package/docs/Market.md +56 -0
  514. package/docs/MarketsApi.md +330 -0
  515. package/docs/Milestone.md +24 -0
  516. package/docs/MilestonesApi.md +119 -0
  517. package/docs/MultivariateCollectionsApi.md +176 -0
  518. package/docs/MultivariateEventCollection.md +26 -0
  519. package/docs/MultivariateEventCollectionEventsInner.md +26 -0
  520. package/docs/Order.md +46 -0
  521. package/docs/OrderGroup.md +26 -0
  522. package/docs/OrderbookLevel.md +22 -0
  523. package/docs/PortfolioApi.md +1109 -0
  524. package/docs/Position.md +34 -0
  525. package/docs/Quote.md +36 -0
  526. package/docs/RFQ.md +34 -0
  527. package/docs/Series.md +26 -0
  528. package/docs/SeriesApi.md +116 -0
  529. package/docs/Settlement.md +30 -0
  530. package/docs/StructuredTarget.md +24 -0
  531. package/docs/StructuredTargetsApi.md +119 -0
  532. package/docs/Trade.md +30 -0
  533. package/git_push.sh +57 -0
  534. package/index.ts +18 -0
  535. package/models/accept-quote-request.ts +20 -0
  536. package/models/amend-order-request.ts +22 -0
  537. package/models/amend-order-response.ts +23 -0
  538. package/models/announcement.ts +38 -0
  539. package/models/api-key.ts +31 -0
  540. package/models/batch-cancel-orders-request.ts +20 -0
  541. package/models/batch-cancel-orders-response-responses-inner.ts +25 -0
  542. package/models/batch-cancel-orders-response.ts +23 -0
  543. package/models/batch-create-orders-request.ts +23 -0
  544. package/models/batch-create-orders-response-responses-inner.ts +27 -0
  545. package/models/batch-create-orders-response.ts +23 -0
  546. package/models/cancel-order-response.ts +24 -0
  547. package/models/candlestick.ts +26 -0
  548. package/models/create-api-key-request.ts +27 -0
  549. package/models/create-api-key-response.ts +23 -0
  550. package/models/create-order-group-request.ts +20 -0
  551. package/models/create-order-group-response.ts +23 -0
  552. package/models/create-order-request.ts +50 -0
  553. package/models/create-order-response.ts +23 -0
  554. package/models/create-quote-request.ts +22 -0
  555. package/models/create-quote-response.ts +23 -0
  556. package/models/create-rfqrequest.ts +31 -0
  557. package/models/create-rfqresponse.ts +23 -0
  558. package/models/daily-schedule.ts +21 -0
  559. package/models/decrease-order-request.ts +20 -0
  560. package/models/decrease-order-response.ts +23 -0
  561. package/models/error-response-error.ts +31 -0
  562. package/models/error-response.ts +23 -0
  563. package/models/event.ts +37 -0
  564. package/models/exchange-status.ts +21 -0
  565. package/models/fill.ts +42 -0
  566. package/models/generate-api-key-request.ts +23 -0
  567. package/models/generate-api-key-response.ts +27 -0
  568. package/models/get-api-keys-response.ts +26 -0
  569. package/models/get-balance-response.ts +23 -0
  570. package/models/get-communications-idresponse.ts +23 -0
  571. package/models/get-event-metadata-response.ts +20 -0
  572. package/models/get-event-response.ts +27 -0
  573. package/models/get-events-response.ts +24 -0
  574. package/models/get-exchange-announcements-response.ts +23 -0
  575. package/models/get-exchange-schedule-response-schedule.ts +29 -0
  576. package/models/get-exchange-schedule-response.ts +23 -0
  577. package/models/get-fills-response.ts +24 -0
  578. package/models/get-market-candlesticks-response.ts +23 -0
  579. package/models/get-market-orderbook-response-orderbook.ts +24 -0
  580. package/models/get-market-orderbook-response.ts +23 -0
  581. package/models/get-market-response.ts +23 -0
  582. package/models/get-markets-response.ts +24 -0
  583. package/models/get-milestone-response.ts +23 -0
  584. package/models/get-milestones-response.ts +23 -0
  585. package/models/get-multivariate-event-collection-response.ts +23 -0
  586. package/models/get-multivariate-event-collections-response.ts +23 -0
  587. package/models/get-order-groups-response.ts +24 -0
  588. package/models/get-order-queue-position-response.ts +20 -0
  589. package/models/get-order-response.ts +23 -0
  590. package/models/get-orders-response.ts +24 -0
  591. package/models/get-positions-response.ts +24 -0
  592. package/models/get-queue-positions-request.ts +20 -0
  593. package/models/get-queue-positions-response.ts +20 -0
  594. package/models/get-quote-response.ts +23 -0
  595. package/models/get-quotes-response.ts +23 -0
  596. package/models/get-rfqresponse.ts +23 -0
  597. package/models/get-rfqs-response.ts +23 -0
  598. package/models/get-series-by-ticker-response.ts +23 -0
  599. package/models/get-series-response.ts +23 -0
  600. package/models/get-settlements-response.ts +24 -0
  601. package/models/get-structured-target-response.ts +23 -0
  602. package/models/get-structured-targets-response.ts +23 -0
  603. package/models/get-total-resting-order-value-response.ts +20 -0
  604. package/models/get-trades-response.ts +24 -0
  605. package/models/get-user-data-timestamp-response.ts +20 -0
  606. package/models/index.ts +88 -0
  607. package/models/lookup-bundle-request-bundle-inner.ts +21 -0
  608. package/models/lookup-bundle-request.ts +23 -0
  609. package/models/lookup-bundle-response.ts +21 -0
  610. package/models/market.ts +59 -0
  611. package/models/milestone.ts +22 -0
  612. package/models/multivariate-event-collection-events-inner.ts +23 -0
  613. package/models/multivariate-event-collection.ts +26 -0
  614. package/models/order-group.ts +23 -0
  615. package/models/order.ts +61 -0
  616. package/models/orderbook-level.ts +21 -0
  617. package/models/position.ts +35 -0
  618. package/models/quote.ts +36 -0
  619. package/models/rfq.ts +35 -0
  620. package/models/series.ts +26 -0
  621. package/models/settlement.ts +33 -0
  622. package/models/structured-target.ts +22 -0
  623. package/models/trade.ts +33 -0
  624. package/package.json +33 -0
  625. package/tsconfig.esm.json +7 -0
  626. package/tsconfig.json +18 -0
@@ -0,0 +1,157 @@
1
+ /**
2
+ * Kalshi Trading API
3
+ * Complete API for the Kalshi trading platform including all handlers for SDK generation
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@kalshi.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { Configuration } from '../configuration';
13
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
+ import { type RequestArgs, BaseAPI } from '../base';
15
+ import type { GetEventMetadataResponse } from '../models';
16
+ import type { GetEventResponse } from '../models';
17
+ import type { GetEventsResponse } from '../models';
18
+ /**
19
+ * EventsApi - axios parameter creator
20
+ */
21
+ export declare const EventsApiAxiosParamCreator: (configuration?: Configuration) => {
22
+ /**
23
+ * Get data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
24
+ * @summary Get Event
25
+ * @param {string} eventTicker Event ticker
26
+ * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
27
+ * @param {*} [options] Override http request option.
28
+ * @throws {RequiredError}
29
+ */
30
+ getEvent: (eventTicker: string, withNestedMarkets?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
31
+ /**
32
+ * Get metadata about an event by its ticker
33
+ * @summary Get Event Metadata
34
+ * @param {string} eventTicker Event ticker
35
+ * @param {*} [options] Override http request option.
36
+ * @throws {RequiredError}
37
+ */
38
+ getEventMetadata: (eventTicker: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
39
+ /**
40
+ * Get data about all events. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-200, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
41
+ * @summary Get Events
42
+ * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
43
+ * @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.
44
+ * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
45
+ * @param {string} [status] Filter by status. Possible values depend on the endpoint.
46
+ * @param {string} [seriesTicker] Filter by series ticker
47
+ * @param {number} [minCloseTs] Filter items that close after this Unix timestamp
48
+ * @param {*} [options] Override http request option.
49
+ * @throws {RequiredError}
50
+ */
51
+ getEvents: (limit?: number, cursor?: string, withNestedMarkets?: boolean, status?: string, seriesTicker?: string, minCloseTs?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
52
+ };
53
+ /**
54
+ * EventsApi - functional programming interface
55
+ */
56
+ export declare const EventsApiFp: (configuration?: Configuration) => {
57
+ /**
58
+ * Get data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
59
+ * @summary Get Event
60
+ * @param {string} eventTicker Event ticker
61
+ * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
62
+ * @param {*} [options] Override http request option.
63
+ * @throws {RequiredError}
64
+ */
65
+ getEvent(eventTicker: string, withNestedMarkets?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventResponse>>;
66
+ /**
67
+ * Get metadata about an event by its ticker
68
+ * @summary Get Event Metadata
69
+ * @param {string} eventTicker Event ticker
70
+ * @param {*} [options] Override http request option.
71
+ * @throws {RequiredError}
72
+ */
73
+ getEventMetadata(eventTicker: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventMetadataResponse>>;
74
+ /**
75
+ * Get data about all events. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-200, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
76
+ * @summary Get Events
77
+ * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
78
+ * @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.
79
+ * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
80
+ * @param {string} [status] Filter by status. Possible values depend on the endpoint.
81
+ * @param {string} [seriesTicker] Filter by series ticker
82
+ * @param {number} [minCloseTs] Filter items that close after this Unix timestamp
83
+ * @param {*} [options] Override http request option.
84
+ * @throws {RequiredError}
85
+ */
86
+ getEvents(limit?: number, cursor?: string, withNestedMarkets?: boolean, status?: string, seriesTicker?: string, minCloseTs?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventsResponse>>;
87
+ };
88
+ /**
89
+ * EventsApi - factory interface
90
+ */
91
+ export declare const EventsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
92
+ /**
93
+ * Get data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
94
+ * @summary Get Event
95
+ * @param {string} eventTicker Event ticker
96
+ * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
97
+ * @param {*} [options] Override http request option.
98
+ * @throws {RequiredError}
99
+ */
100
+ getEvent(eventTicker: string, withNestedMarkets?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<GetEventResponse>;
101
+ /**
102
+ * Get metadata about an event by its ticker
103
+ * @summary Get Event Metadata
104
+ * @param {string} eventTicker Event ticker
105
+ * @param {*} [options] Override http request option.
106
+ * @throws {RequiredError}
107
+ */
108
+ getEventMetadata(eventTicker: string, options?: RawAxiosRequestConfig): AxiosPromise<GetEventMetadataResponse>;
109
+ /**
110
+ * Get data about all events. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-200, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
111
+ * @summary Get Events
112
+ * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
113
+ * @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.
114
+ * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
115
+ * @param {string} [status] Filter by status. Possible values depend on the endpoint.
116
+ * @param {string} [seriesTicker] Filter by series ticker
117
+ * @param {number} [minCloseTs] Filter items that close after this Unix timestamp
118
+ * @param {*} [options] Override http request option.
119
+ * @throws {RequiredError}
120
+ */
121
+ getEvents(limit?: number, cursor?: string, withNestedMarkets?: boolean, status?: string, seriesTicker?: string, minCloseTs?: number, options?: RawAxiosRequestConfig): AxiosPromise<GetEventsResponse>;
122
+ };
123
+ /**
124
+ * EventsApi - object-oriented interface
125
+ */
126
+ export declare class EventsApi extends BaseAPI {
127
+ /**
128
+ * Get data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
129
+ * @summary Get Event
130
+ * @param {string} eventTicker Event ticker
131
+ * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
132
+ * @param {*} [options] Override http request option.
133
+ * @throws {RequiredError}
134
+ */
135
+ getEvent(eventTicker: string, withNestedMarkets?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventResponse, any>>;
136
+ /**
137
+ * Get metadata about an event by its ticker
138
+ * @summary Get Event Metadata
139
+ * @param {string} eventTicker Event ticker
140
+ * @param {*} [options] Override http request option.
141
+ * @throws {RequiredError}
142
+ */
143
+ getEventMetadata(eventTicker: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventMetadataResponse, any>>;
144
+ /**
145
+ * Get data about all events. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-200, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
146
+ * @summary Get Events
147
+ * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
148
+ * @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.
149
+ * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
150
+ * @param {string} [status] Filter by status. Possible values depend on the endpoint.
151
+ * @param {string} [seriesTicker] Filter by series ticker
152
+ * @param {number} [minCloseTs] Filter items that close after this Unix timestamp
153
+ * @param {*} [options] Override http request option.
154
+ * @throws {RequiredError}
155
+ */
156
+ getEvents(limit?: number, cursor?: string, withNestedMarkets?: boolean, status?: string, seriesTicker?: string, minCloseTs?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventsResponse, any>>;
157
+ }
@@ -0,0 +1,305 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Kalshi Trading API
5
+ * Complete API for the Kalshi trading platform including all handlers for SDK generation
6
+ *
7
+ * The version of the OpenAPI document: 2.0.0
8
+ * Contact: support@kalshi.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
+ return new (P || (P = Promise))(function (resolve, reject) {
17
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
18
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
19
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
20
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
21
+ });
22
+ };
23
+ import globalAxios from 'axios';
24
+ // URLSearchParams not necessarily used
25
+ // @ts-ignore
26
+ import { URL } from 'url';
27
+ // Some imports not used depending on template conditions
28
+ // @ts-ignore
29
+ import { DUMMY_BASE_URL, assertParamExists, setBearerAuthToObject, setSearchParams, toPathString, createRequestFunction } from '../common';
30
+ // @ts-ignore
31
+ import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
32
+ /**
33
+ * EventsApi - axios parameter creator
34
+ */
35
+ export const EventsApiAxiosParamCreator = function (configuration) {
36
+ return {
37
+ /**
38
+ * Get data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
39
+ * @summary Get Event
40
+ * @param {string} eventTicker Event ticker
41
+ * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
42
+ * @param {*} [options] Override http request option.
43
+ * @throws {RequiredError}
44
+ */
45
+ getEvent: (eventTicker_1, withNestedMarkets_1, ...args_1) => __awaiter(this, [eventTicker_1, withNestedMarkets_1, ...args_1], void 0, function* (eventTicker, withNestedMarkets, options = {}) {
46
+ // verify required parameter 'eventTicker' is not null or undefined
47
+ assertParamExists('getEvent', 'eventTicker', eventTicker);
48
+ const localVarPath = `/events/{event_ticker}`
49
+ .replace(`{${"event_ticker"}}`, encodeURIComponent(String(eventTicker)));
50
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
51
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
52
+ let baseOptions;
53
+ if (configuration) {
54
+ baseOptions = configuration.baseOptions;
55
+ }
56
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
57
+ const localVarHeaderParameter = {};
58
+ const localVarQueryParameter = {};
59
+ // authentication bearerAuth required
60
+ // http bearer authentication required
61
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
62
+ if (withNestedMarkets !== undefined) {
63
+ localVarQueryParameter['with_nested_markets'] = withNestedMarkets;
64
+ }
65
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
66
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
67
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
68
+ return {
69
+ url: toPathString(localVarUrlObj),
70
+ options: localVarRequestOptions,
71
+ };
72
+ }),
73
+ /**
74
+ * Get metadata about an event by its ticker
75
+ * @summary Get Event Metadata
76
+ * @param {string} eventTicker Event ticker
77
+ * @param {*} [options] Override http request option.
78
+ * @throws {RequiredError}
79
+ */
80
+ getEventMetadata: (eventTicker_1, ...args_1) => __awaiter(this, [eventTicker_1, ...args_1], void 0, function* (eventTicker, options = {}) {
81
+ // verify required parameter 'eventTicker' is not null or undefined
82
+ assertParamExists('getEventMetadata', 'eventTicker', eventTicker);
83
+ const localVarPath = `/events/{event_ticker}/metadata`
84
+ .replace(`{${"event_ticker"}}`, encodeURIComponent(String(eventTicker)));
85
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
86
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
87
+ let baseOptions;
88
+ if (configuration) {
89
+ baseOptions = configuration.baseOptions;
90
+ }
91
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
92
+ const localVarHeaderParameter = {};
93
+ const localVarQueryParameter = {};
94
+ // authentication bearerAuth required
95
+ // http bearer authentication required
96
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
97
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
98
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
99
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
100
+ return {
101
+ url: toPathString(localVarUrlObj),
102
+ options: localVarRequestOptions,
103
+ };
104
+ }),
105
+ /**
106
+ * Get data about all events. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-200, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
107
+ * @summary Get Events
108
+ * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
109
+ * @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.
110
+ * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
111
+ * @param {string} [status] Filter by status. Possible values depend on the endpoint.
112
+ * @param {string} [seriesTicker] Filter by series ticker
113
+ * @param {number} [minCloseTs] Filter items that close after this Unix timestamp
114
+ * @param {*} [options] Override http request option.
115
+ * @throws {RequiredError}
116
+ */
117
+ getEvents: (limit_1, cursor_1, withNestedMarkets_1, status_1, seriesTicker_1, minCloseTs_1, ...args_1) => __awaiter(this, [limit_1, cursor_1, withNestedMarkets_1, status_1, seriesTicker_1, minCloseTs_1, ...args_1], void 0, function* (limit, cursor, withNestedMarkets, status, seriesTicker, minCloseTs, options = {}) {
118
+ const localVarPath = `/events`;
119
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
120
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
121
+ let baseOptions;
122
+ if (configuration) {
123
+ baseOptions = configuration.baseOptions;
124
+ }
125
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
126
+ const localVarHeaderParameter = {};
127
+ const localVarQueryParameter = {};
128
+ // authentication bearerAuth required
129
+ // http bearer authentication required
130
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
131
+ if (limit !== undefined) {
132
+ localVarQueryParameter['limit'] = limit;
133
+ }
134
+ if (cursor !== undefined) {
135
+ localVarQueryParameter['cursor'] = cursor;
136
+ }
137
+ if (withNestedMarkets !== undefined) {
138
+ localVarQueryParameter['with_nested_markets'] = withNestedMarkets;
139
+ }
140
+ if (status !== undefined) {
141
+ localVarQueryParameter['status'] = status;
142
+ }
143
+ if (seriesTicker !== undefined) {
144
+ localVarQueryParameter['series_ticker'] = seriesTicker;
145
+ }
146
+ if (minCloseTs !== undefined) {
147
+ localVarQueryParameter['min_close_ts'] = minCloseTs;
148
+ }
149
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
150
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
151
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
152
+ return {
153
+ url: toPathString(localVarUrlObj),
154
+ options: localVarRequestOptions,
155
+ };
156
+ }),
157
+ };
158
+ };
159
+ /**
160
+ * EventsApi - functional programming interface
161
+ */
162
+ export const EventsApiFp = function (configuration) {
163
+ const localVarAxiosParamCreator = EventsApiAxiosParamCreator(configuration);
164
+ return {
165
+ /**
166
+ * Get data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
167
+ * @summary Get Event
168
+ * @param {string} eventTicker Event ticker
169
+ * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
170
+ * @param {*} [options] Override http request option.
171
+ * @throws {RequiredError}
172
+ */
173
+ getEvent(eventTicker, withNestedMarkets, options) {
174
+ return __awaiter(this, void 0, void 0, function* () {
175
+ var _a, _b, _c;
176
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getEvent(eventTicker, withNestedMarkets, options);
177
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
178
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsApi.getEvent']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
179
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
180
+ });
181
+ },
182
+ /**
183
+ * Get metadata about an event by its ticker
184
+ * @summary Get Event Metadata
185
+ * @param {string} eventTicker Event ticker
186
+ * @param {*} [options] Override http request option.
187
+ * @throws {RequiredError}
188
+ */
189
+ getEventMetadata(eventTicker, options) {
190
+ return __awaiter(this, void 0, void 0, function* () {
191
+ var _a, _b, _c;
192
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getEventMetadata(eventTicker, options);
193
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
194
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsApi.getEventMetadata']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
195
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
196
+ });
197
+ },
198
+ /**
199
+ * Get data about all events. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-200, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
200
+ * @summary Get Events
201
+ * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
202
+ * @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.
203
+ * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
204
+ * @param {string} [status] Filter by status. Possible values depend on the endpoint.
205
+ * @param {string} [seriesTicker] Filter by series ticker
206
+ * @param {number} [minCloseTs] Filter items that close after this Unix timestamp
207
+ * @param {*} [options] Override http request option.
208
+ * @throws {RequiredError}
209
+ */
210
+ getEvents(limit, cursor, withNestedMarkets, status, seriesTicker, minCloseTs, options) {
211
+ return __awaiter(this, void 0, void 0, function* () {
212
+ var _a, _b, _c;
213
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getEvents(limit, cursor, withNestedMarkets, status, seriesTicker, minCloseTs, options);
214
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
215
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsApi.getEvents']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
216
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
217
+ });
218
+ },
219
+ };
220
+ };
221
+ /**
222
+ * EventsApi - factory interface
223
+ */
224
+ export const EventsApiFactory = function (configuration, basePath, axios) {
225
+ const localVarFp = EventsApiFp(configuration);
226
+ return {
227
+ /**
228
+ * Get data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
229
+ * @summary Get Event
230
+ * @param {string} eventTicker Event ticker
231
+ * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
232
+ * @param {*} [options] Override http request option.
233
+ * @throws {RequiredError}
234
+ */
235
+ getEvent(eventTicker, withNestedMarkets, options) {
236
+ return localVarFp.getEvent(eventTicker, withNestedMarkets, options).then((request) => request(axios, basePath));
237
+ },
238
+ /**
239
+ * Get metadata about an event by its ticker
240
+ * @summary Get Event Metadata
241
+ * @param {string} eventTicker Event ticker
242
+ * @param {*} [options] Override http request option.
243
+ * @throws {RequiredError}
244
+ */
245
+ getEventMetadata(eventTicker, options) {
246
+ return localVarFp.getEventMetadata(eventTicker, options).then((request) => request(axios, basePath));
247
+ },
248
+ /**
249
+ * Get data about all events. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-200, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
250
+ * @summary Get Events
251
+ * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
252
+ * @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.
253
+ * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
254
+ * @param {string} [status] Filter by status. Possible values depend on the endpoint.
255
+ * @param {string} [seriesTicker] Filter by series ticker
256
+ * @param {number} [minCloseTs] Filter items that close after this Unix timestamp
257
+ * @param {*} [options] Override http request option.
258
+ * @throws {RequiredError}
259
+ */
260
+ getEvents(limit, cursor, withNestedMarkets, status, seriesTicker, minCloseTs, options) {
261
+ return localVarFp.getEvents(limit, cursor, withNestedMarkets, status, seriesTicker, minCloseTs, options).then((request) => request(axios, basePath));
262
+ },
263
+ };
264
+ };
265
+ /**
266
+ * EventsApi - object-oriented interface
267
+ */
268
+ export class EventsApi extends BaseAPI {
269
+ /**
270
+ * Get data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.
271
+ * @summary Get Event
272
+ * @param {string} eventTicker Event ticker
273
+ * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
274
+ * @param {*} [options] Override http request option.
275
+ * @throws {RequiredError}
276
+ */
277
+ getEvent(eventTicker, withNestedMarkets, options) {
278
+ return EventsApiFp(this.configuration).getEvent(eventTicker, withNestedMarkets, options).then((request) => request(this.axios, this.basePath));
279
+ }
280
+ /**
281
+ * Get metadata about an event by its ticker
282
+ * @summary Get Event Metadata
283
+ * @param {string} eventTicker Event ticker
284
+ * @param {*} [options] Override http request option.
285
+ * @throws {RequiredError}
286
+ */
287
+ getEventMetadata(eventTicker, options) {
288
+ return EventsApiFp(this.configuration).getEventMetadata(eventTicker, options).then((request) => request(this.axios, this.basePath));
289
+ }
290
+ /**
291
+ * Get data about all events. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes. This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-200, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
292
+ * @summary Get Events
293
+ * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
294
+ * @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.
295
+ * @param {boolean} [withNestedMarkets] If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response.
296
+ * @param {string} [status] Filter by status. Possible values depend on the endpoint.
297
+ * @param {string} [seriesTicker] Filter by series ticker
298
+ * @param {number} [minCloseTs] Filter items that close after this Unix timestamp
299
+ * @param {*} [options] Override http request option.
300
+ * @throws {RequiredError}
301
+ */
302
+ getEvents(limit, cursor, withNestedMarkets, status, seriesTicker, minCloseTs, options) {
303
+ return EventsApiFp(this.configuration).getEvents(limit, cursor, withNestedMarkets, status, seriesTicker, minCloseTs, options).then((request) => request(this.axios, this.basePath));
304
+ }
305
+ }
@@ -0,0 +1,150 @@
1
+ /**
2
+ * Kalshi Trading API
3
+ * Complete API for the Kalshi trading platform including all handlers for SDK generation
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@kalshi.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { Configuration } from '../configuration';
13
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
+ import { type RequestArgs, BaseAPI } from '../base';
15
+ import type { ExchangeStatus } from '../models';
16
+ import type { GetExchangeAnnouncementsResponse } from '../models';
17
+ import type { GetExchangeScheduleResponse } from '../models';
18
+ import type { GetUserDataTimestampResponse } from '../models';
19
+ /**
20
+ * ExchangeApi - axios parameter creator
21
+ */
22
+ export declare const ExchangeApiAxiosParamCreator: (configuration?: Configuration) => {
23
+ /**
24
+ * Get all exchange-wide announcements
25
+ * @summary Get Exchange Announcements
26
+ * @param {*} [options] Override http request option.
27
+ * @throws {RequiredError}
28
+ */
29
+ getExchangeAnnouncements: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
30
+ /**
31
+ * Get the exchange schedule
32
+ * @summary Get Exchange Schedule
33
+ * @param {*} [options] Override http request option.
34
+ * @throws {RequiredError}
35
+ */
36
+ getExchangeSchedule: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
37
+ /**
38
+ * Get the exchange status
39
+ * @summary Get Exchange Status
40
+ * @param {*} [options] Override http request option.
41
+ * @throws {RequiredError}
42
+ */
43
+ getExchangeStatus: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
44
+ /**
45
+ * There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
46
+ * @summary Get User Data Timestamp
47
+ * @param {*} [options] Override http request option.
48
+ * @throws {RequiredError}
49
+ */
50
+ getUserDataTimestamp: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
51
+ };
52
+ /**
53
+ * ExchangeApi - functional programming interface
54
+ */
55
+ export declare const ExchangeApiFp: (configuration?: Configuration) => {
56
+ /**
57
+ * Get all exchange-wide announcements
58
+ * @summary Get Exchange Announcements
59
+ * @param {*} [options] Override http request option.
60
+ * @throws {RequiredError}
61
+ */
62
+ getExchangeAnnouncements(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetExchangeAnnouncementsResponse>>;
63
+ /**
64
+ * Get the exchange schedule
65
+ * @summary Get Exchange Schedule
66
+ * @param {*} [options] Override http request option.
67
+ * @throws {RequiredError}
68
+ */
69
+ getExchangeSchedule(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetExchangeScheduleResponse>>;
70
+ /**
71
+ * Get the exchange status
72
+ * @summary Get Exchange Status
73
+ * @param {*} [options] Override http request option.
74
+ * @throws {RequiredError}
75
+ */
76
+ getExchangeStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExchangeStatus>>;
77
+ /**
78
+ * There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
79
+ * @summary Get User Data Timestamp
80
+ * @param {*} [options] Override http request option.
81
+ * @throws {RequiredError}
82
+ */
83
+ getUserDataTimestamp(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUserDataTimestampResponse>>;
84
+ };
85
+ /**
86
+ * ExchangeApi - factory interface
87
+ */
88
+ export declare const ExchangeApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
89
+ /**
90
+ * Get all exchange-wide announcements
91
+ * @summary Get Exchange Announcements
92
+ * @param {*} [options] Override http request option.
93
+ * @throws {RequiredError}
94
+ */
95
+ getExchangeAnnouncements(options?: RawAxiosRequestConfig): AxiosPromise<GetExchangeAnnouncementsResponse>;
96
+ /**
97
+ * Get the exchange schedule
98
+ * @summary Get Exchange Schedule
99
+ * @param {*} [options] Override http request option.
100
+ * @throws {RequiredError}
101
+ */
102
+ getExchangeSchedule(options?: RawAxiosRequestConfig): AxiosPromise<GetExchangeScheduleResponse>;
103
+ /**
104
+ * Get the exchange status
105
+ * @summary Get Exchange Status
106
+ * @param {*} [options] Override http request option.
107
+ * @throws {RequiredError}
108
+ */
109
+ getExchangeStatus(options?: RawAxiosRequestConfig): AxiosPromise<ExchangeStatus>;
110
+ /**
111
+ * There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
112
+ * @summary Get User Data Timestamp
113
+ * @param {*} [options] Override http request option.
114
+ * @throws {RequiredError}
115
+ */
116
+ getUserDataTimestamp(options?: RawAxiosRequestConfig): AxiosPromise<GetUserDataTimestampResponse>;
117
+ };
118
+ /**
119
+ * ExchangeApi - object-oriented interface
120
+ */
121
+ export declare class ExchangeApi extends BaseAPI {
122
+ /**
123
+ * Get all exchange-wide announcements
124
+ * @summary Get Exchange Announcements
125
+ * @param {*} [options] Override http request option.
126
+ * @throws {RequiredError}
127
+ */
128
+ getExchangeAnnouncements(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetExchangeAnnouncementsResponse, any>>;
129
+ /**
130
+ * Get the exchange schedule
131
+ * @summary Get Exchange Schedule
132
+ * @param {*} [options] Override http request option.
133
+ * @throws {RequiredError}
134
+ */
135
+ getExchangeSchedule(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetExchangeScheduleResponse, any>>;
136
+ /**
137
+ * Get the exchange status
138
+ * @summary Get Exchange Status
139
+ * @param {*} [options] Override http request option.
140
+ * @throws {RequiredError}
141
+ */
142
+ getExchangeStatus(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExchangeStatus, any>>;
143
+ /**
144
+ * There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
145
+ * @summary Get User Data Timestamp
146
+ * @param {*} [options] Override http request option.
147
+ * @throws {RequiredError}
148
+ */
149
+ getUserDataTimestamp(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserDataTimestampResponse, any>>;
150
+ }