@finatic/client 0.9.0 → 0.9.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (689) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/LICENSE +39 -0
  3. package/README.md +188 -363
  4. package/dist/index.d.ts +7335 -1579
  5. package/dist/index.js +8124 -6102
  6. package/dist/index.js.map +1 -1
  7. package/dist/index.mjs +8067 -6079
  8. package/dist/index.mjs.map +1 -1
  9. package/package.json +69 -33
  10. package/dist/custom/FinaticConnect.d.ts +0 -19
  11. package/dist/custom/FinaticConnect.d.ts.map +0 -1
  12. package/dist/custom/FinaticConnect.js +0 -24
  13. package/dist/custom/FinaticConnect.js.map +0 -1
  14. package/dist/custom/index.d.ts +0 -8
  15. package/dist/custom/index.d.ts.map +0 -1
  16. package/dist/custom/index.js +0 -20
  17. package/dist/custom/index.js.map +0 -1
  18. package/dist/custom/utils/logger-patch.d.ts +0 -13
  19. package/dist/custom/utils/logger-patch.d.ts.map +0 -1
  20. package/dist/custom/utils/logger-patch.js +0 -72
  21. package/dist/custom/utils/logger-patch.js.map +0 -1
  22. package/dist/custom/wrappers/brokers.d.ts +0 -17
  23. package/dist/custom/wrappers/brokers.d.ts.map +0 -1
  24. package/dist/custom/wrappers/brokers.js +0 -22
  25. package/dist/custom/wrappers/brokers.js.map +0 -1
  26. package/dist/custom/wrappers/market-data.d.ts +0 -13
  27. package/dist/custom/wrappers/market-data.d.ts.map +0 -1
  28. package/dist/custom/wrappers/market-data.js +0 -19
  29. package/dist/custom/wrappers/market-data.js.map +0 -1
  30. package/dist/custom/wrappers/session.d.ts +0 -16
  31. package/dist/custom/wrappers/session.d.ts.map +0 -1
  32. package/dist/custom/wrappers/session.js +0 -21
  33. package/dist/custom/wrappers/session.js.map +0 -1
  34. package/dist/generated/FinaticConnect.d.ts +0 -282
  35. package/dist/generated/FinaticConnect.d.ts.map +0 -1
  36. package/dist/generated/FinaticConnect.js +0 -890
  37. package/dist/generated/FinaticConnect.js.map +0 -1
  38. package/dist/generated/api/brokers-api.d.ts +0 -1126
  39. package/dist/generated/api/brokers-api.d.ts.map +0 -1
  40. package/dist/generated/api/brokers-api.js +0 -1430
  41. package/dist/generated/api/brokers-api.js.map +0 -1
  42. package/dist/generated/api/market-data-api.d.ts +0 -118
  43. package/dist/generated/api/market-data-api.d.ts.map +0 -1
  44. package/dist/generated/api/market-data-api.js +0 -155
  45. package/dist/generated/api/market-data-api.js.map +0 -1
  46. package/dist/generated/api/session-api.d.ts +0 -395
  47. package/dist/generated/api/session-api.d.ts.map +0 -1
  48. package/dist/generated/api/session-api.js +0 -577
  49. package/dist/generated/api/session-api.js.map +0 -1
  50. package/dist/generated/api.d.ts +0 -14
  51. package/dist/generated/api.d.ts.map +0 -1
  52. package/dist/generated/api.js +0 -31
  53. package/dist/generated/api.js.map +0 -1
  54. package/dist/generated/base.d.ts +0 -43
  55. package/dist/generated/base.d.ts.map +0 -1
  56. package/dist/generated/base.js +0 -48
  57. package/dist/generated/base.js.map +0 -1
  58. package/dist/generated/common.d.ts +0 -29
  59. package/dist/generated/common.d.ts.map +0 -1
  60. package/dist/generated/common.js +0 -110
  61. package/dist/generated/common.js.map +0 -1
  62. package/dist/generated/config.d.ts +0 -89
  63. package/dist/generated/config.d.ts.map +0 -1
  64. package/dist/generated/config.js +0 -85
  65. package/dist/generated/config.js.map +0 -1
  66. package/dist/generated/configuration.d.ts +0 -99
  67. package/dist/generated/configuration.d.ts.map +0 -1
  68. package/dist/generated/configuration.js +0 -50
  69. package/dist/generated/configuration.js.map +0 -1
  70. package/dist/generated/models/account-status.d.ts +0 -16
  71. package/dist/generated/models/account-status.d.ts.map +0 -1
  72. package/dist/generated/models/account-status.js +0 -22
  73. package/dist/generated/models/account-status.js.map +0 -1
  74. package/dist/generated/models/account-type.d.ts +0 -19
  75. package/dist/generated/models/account-type.d.ts.map +0 -1
  76. package/dist/generated/models/account-type.js +0 -25
  77. package/dist/generated/models/account-type.js.map +0 -1
  78. package/dist/generated/models/accountnumber.d.ts +0 -14
  79. package/dist/generated/models/accountnumber.d.ts.map +0 -1
  80. package/dist/generated/models/accountnumber.js +0 -16
  81. package/dist/generated/models/accountnumber.js.map +0 -1
  82. package/dist/generated/models/accounts.d.ts +0 -34
  83. package/dist/generated/models/accounts.d.ts.map +0 -1
  84. package/dist/generated/models/accounts.js +0 -16
  85. package/dist/generated/models/accounts.js.map +0 -1
  86. package/dist/generated/models/asset-type.d.ts +0 -18
  87. package/dist/generated/models/asset-type.d.ts.map +0 -1
  88. package/dist/generated/models/asset-type.js +0 -24
  89. package/dist/generated/models/asset-type.js.map +0 -1
  90. package/dist/generated/models/balances.d.ts +0 -28
  91. package/dist/generated/models/balances.d.ts.map +0 -1
  92. package/dist/generated/models/balances.js +0 -16
  93. package/dist/generated/models/balances.js.map +0 -1
  94. package/dist/generated/models/broker-connection-request.d.ts +0 -24
  95. package/dist/generated/models/broker-connection-request.d.ts.map +0 -1
  96. package/dist/generated/models/broker-connection-request.js +0 -16
  97. package/dist/generated/models/broker-connection-request.js.map +0 -1
  98. package/dist/generated/models/broker-connection-update-request.d.ts +0 -22
  99. package/dist/generated/models/broker-connection-update-request.d.ts.map +0 -1
  100. package/dist/generated/models/broker-connection-update-request.js +0 -16
  101. package/dist/generated/models/broker-connection-update-request.js.map +0 -1
  102. package/dist/generated/models/broker-info.d.ts +0 -29
  103. package/dist/generated/models/broker-info.d.ts.map +0 -1
  104. package/dist/generated/models/broker-info.js +0 -16
  105. package/dist/generated/models/broker-info.js.map +0 -1
  106. package/dist/generated/models/broker-permissions.d.ts +0 -25
  107. package/dist/generated/models/broker-permissions.d.ts.map +0 -1
  108. package/dist/generated/models/broker-permissions.js +0 -16
  109. package/dist/generated/models/broker-permissions.js.map +0 -1
  110. package/dist/generated/models/cancel-order-api-v1-brokers-orders-order-id-delete-request.d.ts +0 -26
  111. package/dist/generated/models/cancel-order-api-v1-brokers-orders-order-id-delete-request.d.ts.map +0 -1
  112. package/dist/generated/models/cancel-order-api-v1-brokers-orders-order-id-delete-request.js +0 -16
  113. package/dist/generated/models/cancel-order-api-v1-brokers-orders-order-id-delete-request.js.map +0 -1
  114. package/dist/generated/models/day-tif.d.ts +0 -21
  115. package/dist/generated/models/day-tif.d.ts.map +0 -1
  116. package/dist/generated/models/day-tif.js +0 -21
  117. package/dist/generated/models/day-tif.js.map +0 -1
  118. package/dist/generated/models/direct-auth-request.d.ts +0 -25
  119. package/dist/generated/models/direct-auth-request.d.ts.map +0 -1
  120. package/dist/generated/models/direct-auth-request.js +0 -16
  121. package/dist/generated/models/direct-auth-request.js.map +0 -1
  122. package/dist/generated/models/disconnect-action-result.d.ts +0 -20
  123. package/dist/generated/models/disconnect-action-result.d.ts.map +0 -1
  124. package/dist/generated/models/disconnect-action-result.js +0 -16
  125. package/dist/generated/models/disconnect-action-result.js.map +0 -1
  126. package/dist/generated/models/finatic-apiwarning.d.ts +0 -24
  127. package/dist/generated/models/finatic-apiwarning.d.ts.map +0 -1
  128. package/dist/generated/models/finatic-apiwarning.js +0 -16
  129. package/dist/generated/models/finatic-apiwarning.js.map +0 -1
  130. package/dist/generated/models/finatic-error.d.ts +0 -26
  131. package/dist/generated/models/finatic-error.d.ts.map +0 -1
  132. package/dist/generated/models/finatic-error.js +0 -16
  133. package/dist/generated/models/finatic-error.js.map +0 -1
  134. package/dist/generated/models/finatic-response-disconnect-action-result.d.ts +0 -38
  135. package/dist/generated/models/finatic-response-disconnect-action-result.d.ts.map +0 -1
  136. package/dist/generated/models/finatic-response-disconnect-action-result.js +0 -16
  137. package/dist/generated/models/finatic-response-disconnect-action-result.js.map +0 -1
  138. package/dist/generated/models/finatic-response-list-accounts.d.ts +0 -38
  139. package/dist/generated/models/finatic-response-list-accounts.d.ts.map +0 -1
  140. package/dist/generated/models/finatic-response-list-accounts.js +0 -16
  141. package/dist/generated/models/finatic-response-list-accounts.js.map +0 -1
  142. package/dist/generated/models/finatic-response-list-balances.d.ts +0 -38
  143. package/dist/generated/models/finatic-response-list-balances.d.ts.map +0 -1
  144. package/dist/generated/models/finatic-response-list-balances.js +0 -16
  145. package/dist/generated/models/finatic-response-list-balances.js.map +0 -1
  146. package/dist/generated/models/finatic-response-list-broker-info.d.ts +0 -38
  147. package/dist/generated/models/finatic-response-list-broker-info.d.ts.map +0 -1
  148. package/dist/generated/models/finatic-response-list-broker-info.js +0 -16
  149. package/dist/generated/models/finatic-response-list-broker-info.js.map +0 -1
  150. package/dist/generated/models/finatic-response-list-dict.d.ts +0 -41
  151. package/dist/generated/models/finatic-response-list-dict.d.ts.map +0 -1
  152. package/dist/generated/models/finatic-response-list-dict.js +0 -16
  153. package/dist/generated/models/finatic-response-list-dict.js.map +0 -1
  154. package/dist/generated/models/finatic-response-list-futures-historical-row.d.ts +0 -38
  155. package/dist/generated/models/finatic-response-list-futures-historical-row.d.ts.map +0 -1
  156. package/dist/generated/models/finatic-response-list-futures-historical-row.js +0 -16
  157. package/dist/generated/models/finatic-response-list-futures-historical-row.js.map +0 -1
  158. package/dist/generated/models/finatic-response-list-order-event-response.d.ts +0 -38
  159. package/dist/generated/models/finatic-response-list-order-event-response.d.ts.map +0 -1
  160. package/dist/generated/models/finatic-response-list-order-event-response.js +0 -16
  161. package/dist/generated/models/finatic-response-list-order-event-response.js.map +0 -1
  162. package/dist/generated/models/finatic-response-list-order-fill-response.d.ts +0 -38
  163. package/dist/generated/models/finatic-response-list-order-fill-response.d.ts.map +0 -1
  164. package/dist/generated/models/finatic-response-list-order-fill-response.js +0 -16
  165. package/dist/generated/models/finatic-response-list-order-fill-response.js.map +0 -1
  166. package/dist/generated/models/finatic-response-list-order-group-response.d.ts +0 -38
  167. package/dist/generated/models/finatic-response-list-order-group-response.d.ts.map +0 -1
  168. package/dist/generated/models/finatic-response-list-order-group-response.js +0 -16
  169. package/dist/generated/models/finatic-response-list-order-group-response.js.map +0 -1
  170. package/dist/generated/models/finatic-response-list-order-response.d.ts +0 -38
  171. package/dist/generated/models/finatic-response-list-order-response.d.ts.map +0 -1
  172. package/dist/generated/models/finatic-response-list-order-response.js +0 -16
  173. package/dist/generated/models/finatic-response-list-order-response.js.map +0 -1
  174. package/dist/generated/models/finatic-response-list-position-lot-fill-response.d.ts +0 -38
  175. package/dist/generated/models/finatic-response-list-position-lot-fill-response.d.ts.map +0 -1
  176. package/dist/generated/models/finatic-response-list-position-lot-fill-response.js +0 -16
  177. package/dist/generated/models/finatic-response-list-position-lot-fill-response.js.map +0 -1
  178. package/dist/generated/models/finatic-response-list-position-lot-response.d.ts +0 -38
  179. package/dist/generated/models/finatic-response-list-position-lot-response.d.ts.map +0 -1
  180. package/dist/generated/models/finatic-response-list-position-lot-response.js +0 -16
  181. package/dist/generated/models/finatic-response-list-position-lot-response.js.map +0 -1
  182. package/dist/generated/models/finatic-response-list-position-response.d.ts +0 -38
  183. package/dist/generated/models/finatic-response-list-position-response.d.ts.map +0 -1
  184. package/dist/generated/models/finatic-response-list-position-response.js +0 -16
  185. package/dist/generated/models/finatic-response-list-position-response.js.map +0 -1
  186. package/dist/generated/models/finatic-response-list-user-broker-connections.d.ts +0 -38
  187. package/dist/generated/models/finatic-response-list-user-broker-connections.d.ts.map +0 -1
  188. package/dist/generated/models/finatic-response-list-user-broker-connections.js +0 -16
  189. package/dist/generated/models/finatic-response-list-user-broker-connections.js.map +0 -1
  190. package/dist/generated/models/finatic-response-order-action-result.d.ts +0 -38
  191. package/dist/generated/models/finatic-response-order-action-result.d.ts.map +0 -1
  192. package/dist/generated/models/finatic-response-order-action-result.js +0 -16
  193. package/dist/generated/models/finatic-response-order-action-result.js.map +0 -1
  194. package/dist/generated/models/finatic-response-portal-url-response.d.ts +0 -18
  195. package/dist/generated/models/finatic-response-portal-url-response.d.ts.map +0 -1
  196. package/dist/generated/models/finatic-response-portal-url-response.js +0 -16
  197. package/dist/generated/models/finatic-response-portal-url-response.js.map +0 -1
  198. package/dist/generated/models/finatic-response-session-response-data.d.ts +0 -18
  199. package/dist/generated/models/finatic-response-session-response-data.d.ts.map +0 -1
  200. package/dist/generated/models/finatic-response-session-response-data.js +0 -16
  201. package/dist/generated/models/finatic-response-session-response-data.js.map +0 -1
  202. package/dist/generated/models/finatic-response-session-user-response.d.ts +0 -18
  203. package/dist/generated/models/finatic-response-session-user-response.d.ts.map +0 -1
  204. package/dist/generated/models/finatic-response-session-user-response.js +0 -16
  205. package/dist/generated/models/finatic-response-session-user-response.js.map +0 -1
  206. package/dist/generated/models/finatic-response-test-webhook-response.d.ts +0 -18
  207. package/dist/generated/models/finatic-response-test-webhook-response.d.ts.map +0 -1
  208. package/dist/generated/models/finatic-response-test-webhook-response.js +0 -16
  209. package/dist/generated/models/finatic-response-test-webhook-response.js.map +0 -1
  210. package/dist/generated/models/finatic-response-token-data.d.ts +0 -18
  211. package/dist/generated/models/finatic-response-token-data.d.ts.map +0 -1
  212. package/dist/generated/models/finatic-response-token-data.js +0 -16
  213. package/dist/generated/models/finatic-response-token-data.js.map +0 -1
  214. package/dist/generated/models/finatic-response-token-response-data.d.ts +0 -18
  215. package/dist/generated/models/finatic-response-token-response-data.d.ts.map +0 -1
  216. package/dist/generated/models/finatic-response-token-response-data.js +0 -16
  217. package/dist/generated/models/finatic-response-token-response-data.js.map +0 -1
  218. package/dist/generated/models/finatic-response-user-broker-connections.d.ts +0 -34
  219. package/dist/generated/models/finatic-response-user-broker-connections.d.ts.map +0 -1
  220. package/dist/generated/models/finatic-response-user-broker-connections.js +0 -16
  221. package/dist/generated/models/finatic-response-user-broker-connections.js.map +0 -1
  222. package/dist/generated/models/finaticapi-api-v1-routers-session-session-router-test-webhook-request.d.ts +0 -24
  223. package/dist/generated/models/finaticapi-api-v1-routers-session-session-router-test-webhook-request.d.ts.map +0 -1
  224. package/dist/generated/models/finaticapi-api-v1-routers-session-session-router-test-webhook-request.js +0 -16
  225. package/dist/generated/models/finaticapi-api-v1-routers-session-session-router-test-webhook-request.js.map +0 -1
  226. package/dist/generated/models/finaticapi-core-standard-models-abstract-responses-finatic-response.d.ts +0 -40
  227. package/dist/generated/models/finaticapi-core-standard-models-abstract-responses-finatic-response.d.ts.map +0 -1
  228. package/dist/generated/models/finaticapi-core-standard-models-abstract-responses-finatic-response.js +0 -16
  229. package/dist/generated/models/finaticapi-core-standard-models-abstract-responses-finatic-response.js.map +0 -1
  230. package/dist/generated/models/finaticapi-core-standard-models-finatic-response.d.ts +0 -20
  231. package/dist/generated/models/finaticapi-core-standard-models-finatic-response.d.ts.map +0 -1
  232. package/dist/generated/models/finaticapi-core-standard-models-finatic-response.js +0 -16
  233. package/dist/generated/models/finaticapi-core-standard-models-finatic-response.js.map +0 -1
  234. package/dist/generated/models/foktif.d.ts +0 -21
  235. package/dist/generated/models/foktif.d.ts.map +0 -1
  236. package/dist/generated/models/foktif.js +0 -21
  237. package/dist/generated/models/foktif.js.map +0 -1
  238. package/dist/generated/models/futures-historical-row.d.ts +0 -27
  239. package/dist/generated/models/futures-historical-row.d.ts.map +0 -1
  240. package/dist/generated/models/futures-historical-row.js +0 -16
  241. package/dist/generated/models/futures-historical-row.js.map +0 -1
  242. package/dist/generated/models/gtctif.d.ts +0 -21
  243. package/dist/generated/models/gtctif.d.ts.map +0 -1
  244. package/dist/generated/models/gtctif.js +0 -21
  245. package/dist/generated/models/gtctif.js.map +0 -1
  246. package/dist/generated/models/gtdtif.d.ts +0 -25
  247. package/dist/generated/models/gtdtif.d.ts.map +0 -1
  248. package/dist/generated/models/gtdtif.js +0 -21
  249. package/dist/generated/models/gtdtif.js.map +0 -1
  250. package/dist/generated/models/httpvalidation-error.d.ts +0 -16
  251. package/dist/generated/models/httpvalidation-error.d.ts.map +0 -1
  252. package/dist/generated/models/httpvalidation-error.js +0 -16
  253. package/dist/generated/models/httpvalidation-error.js.map +0 -1
  254. package/dist/generated/models/index.d.ts +0 -108
  255. package/dist/generated/models/index.d.ts.map +0 -1
  256. package/dist/generated/models/index.js +0 -125
  257. package/dist/generated/models/index.js.map +0 -1
  258. package/dist/generated/models/ioctif.d.ts +0 -21
  259. package/dist/generated/models/ioctif.d.ts.map +0 -1
  260. package/dist/generated/models/ioctif.js +0 -21
  261. package/dist/generated/models/ioctif.js.map +0 -1
  262. package/dist/generated/models/limit-order-modify-query-params.d.ts +0 -32
  263. package/dist/generated/models/limit-order-modify-query-params.d.ts.map +0 -1
  264. package/dist/generated/models/limit-order-modify-query-params.js +0 -21
  265. package/dist/generated/models/limit-order-modify-query-params.js.map +0 -1
  266. package/dist/generated/models/market-order-modify-query-params.d.ts +0 -31
  267. package/dist/generated/models/market-order-modify-query-params.d.ts.map +0 -1
  268. package/dist/generated/models/market-order-modify-query-params.js +0 -21
  269. package/dist/generated/models/market-order-modify-query-params.js.map +0 -1
  270. package/dist/generated/models/modify-order-api-v1-brokers-orders-order-id-patch-request.d.ts +0 -26
  271. package/dist/generated/models/modify-order-api-v1-brokers-orders-order-id-patch-request.d.ts.map +0 -1
  272. package/dist/generated/models/modify-order-api-v1-brokers-orders-order-id-patch-request.js +0 -16
  273. package/dist/generated/models/modify-order-api-v1-brokers-orders-order-id-patch-request.js.map +0 -1
  274. package/dist/generated/models/ninja-trader-limit-order-modify-query-params.d.ts +0 -38
  275. package/dist/generated/models/ninja-trader-limit-order-modify-query-params.d.ts.map +0 -1
  276. package/dist/generated/models/ninja-trader-limit-order-modify-query-params.js +0 -21
  277. package/dist/generated/models/ninja-trader-limit-order-modify-query-params.js.map +0 -1
  278. package/dist/generated/models/ninja-trader-limit-order-place-query-params.d.ts +0 -44
  279. package/dist/generated/models/ninja-trader-limit-order-place-query-params.d.ts.map +0 -1
  280. package/dist/generated/models/ninja-trader-limit-order-place-query-params.js +0 -30
  281. package/dist/generated/models/ninja-trader-limit-order-place-query-params.js.map +0 -1
  282. package/dist/generated/models/ninja-trader-market-order-modify-query-params.d.ts +0 -37
  283. package/dist/generated/models/ninja-trader-market-order-modify-query-params.d.ts.map +0 -1
  284. package/dist/generated/models/ninja-trader-market-order-modify-query-params.js +0 -21
  285. package/dist/generated/models/ninja-trader-market-order-modify-query-params.js.map +0 -1
  286. package/dist/generated/models/ninja-trader-market-order-place-query-params.d.ts +0 -43
  287. package/dist/generated/models/ninja-trader-market-order-place-query-params.d.ts.map +0 -1
  288. package/dist/generated/models/ninja-trader-market-order-place-query-params.js +0 -30
  289. package/dist/generated/models/ninja-trader-market-order-place-query-params.js.map +0 -1
  290. package/dist/generated/models/ninja-trader-order-cancel-query-params.d.ts +0 -26
  291. package/dist/generated/models/ninja-trader-order-cancel-query-params.d.ts.map +0 -1
  292. package/dist/generated/models/ninja-trader-order-cancel-query-params.js +0 -16
  293. package/dist/generated/models/ninja-trader-order-cancel-query-params.js.map +0 -1
  294. package/dist/generated/models/ninja-trader-order-cancel-request.d.ts +0 -21
  295. package/dist/generated/models/ninja-trader-order-cancel-request.d.ts.map +0 -1
  296. package/dist/generated/models/ninja-trader-order-cancel-request.js +0 -21
  297. package/dist/generated/models/ninja-trader-order-cancel-request.js.map +0 -1
  298. package/dist/generated/models/ninja-trader-order-modify-request.d.ts +0 -21
  299. package/dist/generated/models/ninja-trader-order-modify-request.d.ts.map +0 -1
  300. package/dist/generated/models/ninja-trader-order-modify-request.js +0 -21
  301. package/dist/generated/models/ninja-trader-order-modify-request.js.map +0 -1
  302. package/dist/generated/models/ninja-trader-order-place-request.d.ts +0 -24
  303. package/dist/generated/models/ninja-trader-order-place-request.d.ts.map +0 -1
  304. package/dist/generated/models/ninja-trader-order-place-request.js +0 -21
  305. package/dist/generated/models/ninja-trader-order-place-request.js.map +0 -1
  306. package/dist/generated/models/ninja-trader-stop-order-modify-query-params.d.ts +0 -38
  307. package/dist/generated/models/ninja-trader-stop-order-modify-query-params.d.ts.map +0 -1
  308. package/dist/generated/models/ninja-trader-stop-order-modify-query-params.js +0 -21
  309. package/dist/generated/models/ninja-trader-stop-order-modify-query-params.js.map +0 -1
  310. package/dist/generated/models/ninja-trader-stop-order-place-query-params.d.ts +0 -44
  311. package/dist/generated/models/ninja-trader-stop-order-place-query-params.d.ts.map +0 -1
  312. package/dist/generated/models/ninja-trader-stop-order-place-query-params.js +0 -30
  313. package/dist/generated/models/ninja-trader-stop-order-place-query-params.js.map +0 -1
  314. package/dist/generated/models/ninja-trader-trailing-stop-order-modify-query-params.d.ts +0 -38
  315. package/dist/generated/models/ninja-trader-trailing-stop-order-modify-query-params.d.ts.map +0 -1
  316. package/dist/generated/models/ninja-trader-trailing-stop-order-modify-query-params.js +0 -21
  317. package/dist/generated/models/ninja-trader-trailing-stop-order-modify-query-params.js.map +0 -1
  318. package/dist/generated/models/ninja-trader-trailing-stop-order-place-query-params.d.ts +0 -44
  319. package/dist/generated/models/ninja-trader-trailing-stop-order-place-query-params.d.ts.map +0 -1
  320. package/dist/generated/models/ninja-trader-trailing-stop-order-place-query-params.js +0 -30
  321. package/dist/generated/models/ninja-trader-trailing-stop-order-place-query-params.js.map +0 -1
  322. package/dist/generated/models/order-action-result.d.ts +0 -21
  323. package/dist/generated/models/order-action-result.d.ts.map +0 -1
  324. package/dist/generated/models/order-action-result.js +0 -16
  325. package/dist/generated/models/order-action-result.js.map +0 -1
  326. package/dist/generated/models/order-cancel-query-params.d.ts +0 -22
  327. package/dist/generated/models/order-cancel-query-params.d.ts.map +0 -1
  328. package/dist/generated/models/order-cancel-query-params.js +0 -16
  329. package/dist/generated/models/order-cancel-query-params.js.map +0 -1
  330. package/dist/generated/models/order-event-response.d.ts +0 -25
  331. package/dist/generated/models/order-event-response.d.ts.map +0 -1
  332. package/dist/generated/models/order-event-response.js +0 -16
  333. package/dist/generated/models/order-event-response.js.map +0 -1
  334. package/dist/generated/models/order-fill-response.d.ts +0 -24
  335. package/dist/generated/models/order-fill-response.d.ts.map +0 -1
  336. package/dist/generated/models/order-fill-response.js +0 -16
  337. package/dist/generated/models/order-fill-response.js.map +0 -1
  338. package/dist/generated/models/order-group-order.d.ts +0 -24
  339. package/dist/generated/models/order-group-order.d.ts.map +0 -1
  340. package/dist/generated/models/order-group-order.js +0 -16
  341. package/dist/generated/models/order-group-order.js.map +0 -1
  342. package/dist/generated/models/order-group-response.d.ts +0 -24
  343. package/dist/generated/models/order-group-response.d.ts.map +0 -1
  344. package/dist/generated/models/order-group-response.js +0 -16
  345. package/dist/generated/models/order-group-response.js.map +0 -1
  346. package/dist/generated/models/order-leg.d.ts +0 -22
  347. package/dist/generated/models/order-leg.d.ts.map +0 -1
  348. package/dist/generated/models/order-leg.js +0 -16
  349. package/dist/generated/models/order-leg.js.map +0 -1
  350. package/dist/generated/models/order-response.d.ts +0 -27
  351. package/dist/generated/models/order-response.d.ts.map +0 -1
  352. package/dist/generated/models/order-response.js +0 -16
  353. package/dist/generated/models/order-response.js.map +0 -1
  354. package/dist/generated/models/order-side.d.ts +0 -16
  355. package/dist/generated/models/order-side.d.ts.map +0 -1
  356. package/dist/generated/models/order-side.js +0 -22
  357. package/dist/generated/models/order-side.js.map +0 -1
  358. package/dist/generated/models/order-status.d.ts +0 -23
  359. package/dist/generated/models/order-status.d.ts.map +0 -1
  360. package/dist/generated/models/order-status.js +0 -29
  361. package/dist/generated/models/order-status.js.map +0 -1
  362. package/dist/generated/models/order.d.ts +0 -28
  363. package/dist/generated/models/order.d.ts.map +0 -1
  364. package/dist/generated/models/order.js +0 -16
  365. package/dist/generated/models/order.js.map +0 -1
  366. package/dist/generated/models/order1.d.ts +0 -28
  367. package/dist/generated/models/order1.d.ts.map +0 -1
  368. package/dist/generated/models/order1.js +0 -16
  369. package/dist/generated/models/order1.js.map +0 -1
  370. package/dist/generated/models/order2.d.ts +0 -28
  371. package/dist/generated/models/order2.d.ts.map +0 -1
  372. package/dist/generated/models/order2.js +0 -16
  373. package/dist/generated/models/order2.js.map +0 -1
  374. package/dist/generated/models/order3.d.ts +0 -28
  375. package/dist/generated/models/order3.d.ts.map +0 -1
  376. package/dist/generated/models/order3.js +0 -16
  377. package/dist/generated/models/order3.js.map +0 -1
  378. package/dist/generated/models/order4.d.ts +0 -28
  379. package/dist/generated/models/order4.d.ts.map +0 -1
  380. package/dist/generated/models/order4.js +0 -16
  381. package/dist/generated/models/order4.js.map +0 -1
  382. package/dist/generated/models/order5.d.ts +0 -28
  383. package/dist/generated/models/order5.d.ts.map +0 -1
  384. package/dist/generated/models/order5.js +0 -16
  385. package/dist/generated/models/order5.js.map +0 -1
  386. package/dist/generated/models/place-order-api-v1-brokers-orders-post-request.d.ts +0 -26
  387. package/dist/generated/models/place-order-api-v1-brokers-orders-post-request.d.ts.map +0 -1
  388. package/dist/generated/models/place-order-api-v1-brokers-orders-post-request.js +0 -16
  389. package/dist/generated/models/place-order-api-v1-brokers-orders-post-request.js.map +0 -1
  390. package/dist/generated/models/portal-url-response.d.ts +0 -21
  391. package/dist/generated/models/portal-url-response.d.ts.map +0 -1
  392. package/dist/generated/models/portal-url-response.js +0 -16
  393. package/dist/generated/models/portal-url-response.js.map +0 -1
  394. package/dist/generated/models/position-lot-fill-response.d.ts +0 -23
  395. package/dist/generated/models/position-lot-fill-response.d.ts.map +0 -1
  396. package/dist/generated/models/position-lot-fill-response.js +0 -16
  397. package/dist/generated/models/position-lot-fill-response.js.map +0 -1
  398. package/dist/generated/models/position-lot-response.d.ts +0 -27
  399. package/dist/generated/models/position-lot-response.d.ts.map +0 -1
  400. package/dist/generated/models/position-lot-response.js +0 -16
  401. package/dist/generated/models/position-lot-response.js.map +0 -1
  402. package/dist/generated/models/position-response.d.ts +0 -62
  403. package/dist/generated/models/position-response.d.ts.map +0 -1
  404. package/dist/generated/models/position-response.js +0 -16
  405. package/dist/generated/models/position-response.js.map +0 -1
  406. package/dist/generated/models/position-status.d.ts +0 -16
  407. package/dist/generated/models/position-status.d.ts.map +0 -1
  408. package/dist/generated/models/position-status.js +0 -22
  409. package/dist/generated/models/position-status.js.map +0 -1
  410. package/dist/generated/models/public-account-type-enum.d.ts +0 -17
  411. package/dist/generated/models/public-account-type-enum.d.ts.map +0 -1
  412. package/dist/generated/models/public-account-type-enum.js +0 -23
  413. package/dist/generated/models/public-account-type-enum.js.map +0 -1
  414. package/dist/generated/models/public-asset-type-enum.d.ts +0 -20
  415. package/dist/generated/models/public-asset-type-enum.d.ts.map +0 -1
  416. package/dist/generated/models/public-asset-type-enum.js +0 -26
  417. package/dist/generated/models/public-asset-type-enum.js.map +0 -1
  418. package/dist/generated/models/public-connection-status-enum.d.ts +0 -20
  419. package/dist/generated/models/public-connection-status-enum.d.ts.map +0 -1
  420. package/dist/generated/models/public-connection-status-enum.js +0 -26
  421. package/dist/generated/models/public-connection-status-enum.js.map +0 -1
  422. package/dist/generated/models/public-order-side-enum.d.ts +0 -16
  423. package/dist/generated/models/public-order-side-enum.d.ts.map +0 -1
  424. package/dist/generated/models/public-order-side-enum.js +0 -22
  425. package/dist/generated/models/public-order-side-enum.js.map +0 -1
  426. package/dist/generated/models/public-order-status-enum.d.ts +0 -24
  427. package/dist/generated/models/public-order-status-enum.d.ts.map +0 -1
  428. package/dist/generated/models/public-order-status-enum.js +0 -30
  429. package/dist/generated/models/public-order-status-enum.js.map +0 -1
  430. package/dist/generated/models/public-position-status-enum.d.ts +0 -17
  431. package/dist/generated/models/public-position-status-enum.d.ts.map +0 -1
  432. package/dist/generated/models/public-position-status-enum.js +0 -23
  433. package/dist/generated/models/public-position-status-enum.js.map +0 -1
  434. package/dist/generated/models/robinhood-limit-order-place-query-params.d.ts +0 -37
  435. package/dist/generated/models/robinhood-limit-order-place-query-params.d.ts.map +0 -1
  436. package/dist/generated/models/robinhood-limit-order-place-query-params.js +0 -30
  437. package/dist/generated/models/robinhood-limit-order-place-query-params.js.map +0 -1
  438. package/dist/generated/models/robinhood-market-order-place-query-params.d.ts +0 -36
  439. package/dist/generated/models/robinhood-market-order-place-query-params.d.ts.map +0 -1
  440. package/dist/generated/models/robinhood-market-order-place-query-params.js +0 -30
  441. package/dist/generated/models/robinhood-market-order-place-query-params.js.map +0 -1
  442. package/dist/generated/models/robinhood-order-cancel-request.d.ts +0 -21
  443. package/dist/generated/models/robinhood-order-cancel-request.d.ts.map +0 -1
  444. package/dist/generated/models/robinhood-order-cancel-request.js +0 -21
  445. package/dist/generated/models/robinhood-order-cancel-request.js.map +0 -1
  446. package/dist/generated/models/robinhood-order-modify-request.d.ts +0 -21
  447. package/dist/generated/models/robinhood-order-modify-request.d.ts.map +0 -1
  448. package/dist/generated/models/robinhood-order-modify-request.js +0 -21
  449. package/dist/generated/models/robinhood-order-modify-request.js.map +0 -1
  450. package/dist/generated/models/robinhood-order-place-request.d.ts +0 -24
  451. package/dist/generated/models/robinhood-order-place-request.d.ts.map +0 -1
  452. package/dist/generated/models/robinhood-order-place-request.js +0 -21
  453. package/dist/generated/models/robinhood-order-place-request.js.map +0 -1
  454. package/dist/generated/models/robinhood-stop-order-place-query-params.d.ts +0 -37
  455. package/dist/generated/models/robinhood-stop-order-place-query-params.d.ts.map +0 -1
  456. package/dist/generated/models/robinhood-stop-order-place-query-params.js +0 -30
  457. package/dist/generated/models/robinhood-stop-order-place-query-params.js.map +0 -1
  458. package/dist/generated/models/robinhood-trailing-stop-order-place-query-params.d.ts +0 -37
  459. package/dist/generated/models/robinhood-trailing-stop-order-place-query-params.d.ts.map +0 -1
  460. package/dist/generated/models/robinhood-trailing-stop-order-place-query-params.js +0 -30
  461. package/dist/generated/models/robinhood-trailing-stop-order-place-query-params.js.map +0 -1
  462. package/dist/generated/models/session-link-request.d.ts +0 -19
  463. package/dist/generated/models/session-link-request.d.ts.map +0 -1
  464. package/dist/generated/models/session-link-request.js +0 -16
  465. package/dist/generated/models/session-link-request.js.map +0 -1
  466. package/dist/generated/models/session-response-data.d.ts +0 -39
  467. package/dist/generated/models/session-response-data.d.ts.map +0 -1
  468. package/dist/generated/models/session-response-data.js +0 -16
  469. package/dist/generated/models/session-response-data.js.map +0 -1
  470. package/dist/generated/models/session-start-request.d.ts +0 -18
  471. package/dist/generated/models/session-start-request.d.ts.map +0 -1
  472. package/dist/generated/models/session-start-request.js +0 -16
  473. package/dist/generated/models/session-start-request.js.map +0 -1
  474. package/dist/generated/models/session-status.d.ts +0 -22
  475. package/dist/generated/models/session-status.d.ts.map +0 -1
  476. package/dist/generated/models/session-status.js +0 -28
  477. package/dist/generated/models/session-status.js.map +0 -1
  478. package/dist/generated/models/session-user-response.d.ts +0 -45
  479. package/dist/generated/models/session-user-response.d.ts.map +0 -1
  480. package/dist/generated/models/session-user-response.js +0 -16
  481. package/dist/generated/models/session-user-response.js.map +0 -1
  482. package/dist/generated/models/stop-order-modify-query-params.d.ts +0 -32
  483. package/dist/generated/models/stop-order-modify-query-params.d.ts.map +0 -1
  484. package/dist/generated/models/stop-order-modify-query-params.js +0 -21
  485. package/dist/generated/models/stop-order-modify-query-params.js.map +0 -1
  486. package/dist/generated/models/tasty-trade-limit-order-modify-query-params.d.ts +0 -38
  487. package/dist/generated/models/tasty-trade-limit-order-modify-query-params.d.ts.map +0 -1
  488. package/dist/generated/models/tasty-trade-limit-order-modify-query-params.js +0 -21
  489. package/dist/generated/models/tasty-trade-limit-order-modify-query-params.js.map +0 -1
  490. package/dist/generated/models/tasty-trade-limit-order-place-query-params.d.ts +0 -55
  491. package/dist/generated/models/tasty-trade-limit-order-place-query-params.d.ts.map +0 -1
  492. package/dist/generated/models/tasty-trade-limit-order-place-query-params.js +0 -40
  493. package/dist/generated/models/tasty-trade-limit-order-place-query-params.js.map +0 -1
  494. package/dist/generated/models/tasty-trade-market-order-modify-query-params.d.ts +0 -37
  495. package/dist/generated/models/tasty-trade-market-order-modify-query-params.d.ts.map +0 -1
  496. package/dist/generated/models/tasty-trade-market-order-modify-query-params.js +0 -21
  497. package/dist/generated/models/tasty-trade-market-order-modify-query-params.js.map +0 -1
  498. package/dist/generated/models/tasty-trade-market-order-place-query-params.d.ts +0 -54
  499. package/dist/generated/models/tasty-trade-market-order-place-query-params.d.ts.map +0 -1
  500. package/dist/generated/models/tasty-trade-market-order-place-query-params.js +0 -40
  501. package/dist/generated/models/tasty-trade-market-order-place-query-params.js.map +0 -1
  502. package/dist/generated/models/tasty-trade-order-cancel-query-params.d.ts +0 -26
  503. package/dist/generated/models/tasty-trade-order-cancel-query-params.d.ts.map +0 -1
  504. package/dist/generated/models/tasty-trade-order-cancel-query-params.js +0 -16
  505. package/dist/generated/models/tasty-trade-order-cancel-query-params.js.map +0 -1
  506. package/dist/generated/models/tasty-trade-order-cancel-request.d.ts +0 -21
  507. package/dist/generated/models/tasty-trade-order-cancel-request.d.ts.map +0 -1
  508. package/dist/generated/models/tasty-trade-order-cancel-request.js +0 -21
  509. package/dist/generated/models/tasty-trade-order-cancel-request.js.map +0 -1
  510. package/dist/generated/models/tasty-trade-order-modify-request.d.ts +0 -21
  511. package/dist/generated/models/tasty-trade-order-modify-request.d.ts.map +0 -1
  512. package/dist/generated/models/tasty-trade-order-modify-request.js +0 -21
  513. package/dist/generated/models/tasty-trade-order-modify-request.js.map +0 -1
  514. package/dist/generated/models/tasty-trade-order-place-request.d.ts +0 -24
  515. package/dist/generated/models/tasty-trade-order-place-request.d.ts.map +0 -1
  516. package/dist/generated/models/tasty-trade-order-place-request.js +0 -21
  517. package/dist/generated/models/tasty-trade-order-place-request.js.map +0 -1
  518. package/dist/generated/models/tasty-trade-stop-order-modify-query-params.d.ts +0 -38
  519. package/dist/generated/models/tasty-trade-stop-order-modify-query-params.d.ts.map +0 -1
  520. package/dist/generated/models/tasty-trade-stop-order-modify-query-params.js +0 -21
  521. package/dist/generated/models/tasty-trade-stop-order-modify-query-params.js.map +0 -1
  522. package/dist/generated/models/tasty-trade-stop-order-place-query-params.d.ts +0 -55
  523. package/dist/generated/models/tasty-trade-stop-order-place-query-params.d.ts.map +0 -1
  524. package/dist/generated/models/tasty-trade-stop-order-place-query-params.js +0 -40
  525. package/dist/generated/models/tasty-trade-stop-order-place-query-params.js.map +0 -1
  526. package/dist/generated/models/tasty-trade-trailing-stop-order-modify-query-params.d.ts +0 -38
  527. package/dist/generated/models/tasty-trade-trailing-stop-order-modify-query-params.d.ts.map +0 -1
  528. package/dist/generated/models/tasty-trade-trailing-stop-order-modify-query-params.js +0 -21
  529. package/dist/generated/models/tasty-trade-trailing-stop-order-modify-query-params.js.map +0 -1
  530. package/dist/generated/models/tasty-trade-trailing-stop-order-place-query-params.d.ts +0 -55
  531. package/dist/generated/models/tasty-trade-trailing-stop-order-place-query-params.d.ts.map +0 -1
  532. package/dist/generated/models/tasty-trade-trailing-stop-order-place-query-params.js +0 -40
  533. package/dist/generated/models/tasty-trade-trailing-stop-order-place-query-params.js.map +0 -1
  534. package/dist/generated/models/test-webhook-response.d.ts +0 -35
  535. package/dist/generated/models/test-webhook-response.d.ts.map +0 -1
  536. package/dist/generated/models/test-webhook-response.js +0 -16
  537. package/dist/generated/models/test-webhook-response.js.map +0 -1
  538. package/dist/generated/models/timeinforce.d.ts +0 -31
  539. package/dist/generated/models/timeinforce.d.ts.map +0 -1
  540. package/dist/generated/models/timeinforce.js +0 -16
  541. package/dist/generated/models/timeinforce.js.map +0 -1
  542. package/dist/generated/models/token-data.d.ts +0 -45
  543. package/dist/generated/models/token-data.d.ts.map +0 -1
  544. package/dist/generated/models/token-data.js +0 -16
  545. package/dist/generated/models/token-data.js.map +0 -1
  546. package/dist/generated/models/token-response-data.d.ts +0 -25
  547. package/dist/generated/models/token-response-data.d.ts.map +0 -1
  548. package/dist/generated/models/token-response-data.js +0 -16
  549. package/dist/generated/models/token-response-data.js.map +0 -1
  550. package/dist/generated/models/trailing-stop-order-modify-query-params.d.ts +0 -32
  551. package/dist/generated/models/trailing-stop-order-modify-query-params.d.ts.map +0 -1
  552. package/dist/generated/models/trailing-stop-order-modify-query-params.js +0 -21
  553. package/dist/generated/models/trailing-stop-order-modify-query-params.js.map +0 -1
  554. package/dist/generated/models/user-broker-connections.d.ts +0 -28
  555. package/dist/generated/models/user-broker-connections.d.ts.map +0 -1
  556. package/dist/generated/models/user-broker-connections.js +0 -16
  557. package/dist/generated/models/user-broker-connections.js.map +0 -1
  558. package/dist/generated/models/validation-error-loc-inner.d.ts +0 -14
  559. package/dist/generated/models/validation-error-loc-inner.d.ts.map +0 -1
  560. package/dist/generated/models/validation-error-loc-inner.js +0 -16
  561. package/dist/generated/models/validation-error-loc-inner.js.map +0 -1
  562. package/dist/generated/models/validation-error.d.ts +0 -18
  563. package/dist/generated/models/validation-error.d.ts.map +0 -1
  564. package/dist/generated/models/validation-error.js +0 -16
  565. package/dist/generated/models/validation-error.js.map +0 -1
  566. package/dist/generated/portal/PortalUI.d.ts +0 -28
  567. package/dist/generated/portal/PortalUI.d.ts.map +0 -1
  568. package/dist/generated/portal/PortalUI.js +0 -139
  569. package/dist/generated/portal/PortalUI.js.map +0 -1
  570. package/dist/generated/utils/cache.d.ts +0 -16
  571. package/dist/generated/utils/cache.d.ts.map +0 -1
  572. package/dist/generated/utils/cache.js +0 -56
  573. package/dist/generated/utils/cache.js.map +0 -1
  574. package/dist/generated/utils/enum-coercion.d.ts +0 -24
  575. package/dist/generated/utils/enum-coercion.d.ts.map +0 -1
  576. package/dist/generated/utils/enum-coercion.js +0 -49
  577. package/dist/generated/utils/enum-coercion.js.map +0 -1
  578. package/dist/generated/utils/error-handling.d.ts +0 -35
  579. package/dist/generated/utils/error-handling.d.ts.map +0 -1
  580. package/dist/generated/utils/error-handling.js +0 -75
  581. package/dist/generated/utils/error-handling.js.map +0 -1
  582. package/dist/generated/utils/events.d.ts +0 -18
  583. package/dist/generated/utils/events.d.ts.map +0 -1
  584. package/dist/generated/utils/events.js +0 -60
  585. package/dist/generated/utils/events.js.map +0 -1
  586. package/dist/generated/utils/index.d.ts +0 -17
  587. package/dist/generated/utils/index.d.ts.map +0 -1
  588. package/dist/generated/utils/index.js +0 -33
  589. package/dist/generated/utils/index.js.map +0 -1
  590. package/dist/generated/utils/interceptors.d.ts +0 -40
  591. package/dist/generated/utils/interceptors.d.ts.map +0 -1
  592. package/dist/generated/utils/interceptors.js +0 -76
  593. package/dist/generated/utils/interceptors.js.map +0 -1
  594. package/dist/generated/utils/logger.d.ts +0 -21
  595. package/dist/generated/utils/logger.d.ts.map +0 -1
  596. package/dist/generated/utils/logger.js +0 -292
  597. package/dist/generated/utils/logger.js.map +0 -1
  598. package/dist/generated/utils/plain-object.d.ts +0 -22
  599. package/dist/generated/utils/plain-object.d.ts.map +0 -1
  600. package/dist/generated/utils/plain-object.js +0 -51
  601. package/dist/generated/utils/plain-object.js.map +0 -1
  602. package/dist/generated/utils/request-id.d.ts +0 -10
  603. package/dist/generated/utils/request-id.d.ts.map +0 -1
  604. package/dist/generated/utils/request-id.js +0 -24
  605. package/dist/generated/utils/request-id.js.map +0 -1
  606. package/dist/generated/utils/retry.d.ts +0 -20
  607. package/dist/generated/utils/retry.d.ts.map +0 -1
  608. package/dist/generated/utils/retry.js +0 -83
  609. package/dist/generated/utils/retry.js.map +0 -1
  610. package/dist/generated/utils/url-utils.d.ts +0 -23
  611. package/dist/generated/utils/url-utils.d.ts.map +0 -1
  612. package/dist/generated/utils/url-utils.js +0 -64
  613. package/dist/generated/utils/url-utils.js.map +0 -1
  614. package/dist/generated/utils/validation.d.ts +0 -20
  615. package/dist/generated/utils/validation.d.ts.map +0 -1
  616. package/dist/generated/utils/validation.js +0 -103
  617. package/dist/generated/utils/validation.js.map +0 -1
  618. package/dist/generated/wrappers/brokers.d.ts +0 -1107
  619. package/dist/generated/wrappers/brokers.d.ts.map +0 -1
  620. package/dist/generated/wrappers/brokers.js +0 -3076
  621. package/dist/generated/wrappers/brokers.js.map +0 -1
  622. package/dist/generated/wrappers/index.d.ts +0 -8
  623. package/dist/generated/wrappers/index.d.ts.map +0 -1
  624. package/dist/generated/wrappers/index.js +0 -13
  625. package/dist/generated/wrappers/index.js.map +0 -1
  626. package/dist/generated/wrappers/market-data.d.ts +0 -37
  627. package/dist/generated/wrappers/market-data.d.ts.map +0 -1
  628. package/dist/generated/wrappers/market-data.js +0 -134
  629. package/dist/generated/wrappers/market-data.js.map +0 -1
  630. package/dist/generated/wrappers/session.d.ts +0 -394
  631. package/dist/generated/wrappers/session.d.ts.map +0 -1
  632. package/dist/generated/wrappers/session.js +0 -1232
  633. package/dist/generated/wrappers/session.js.map +0 -1
  634. package/dist/index.d.ts.map +0 -1
  635. package/dist/types/core/client/ApiClient.d.ts +0 -270
  636. package/dist/types/core/client/FinaticConnect.d.ts +0 -332
  637. package/dist/types/core/portal/PortalUI.d.ts +0 -37
  638. package/dist/types/index.d.ts +0 -12
  639. package/dist/types/lib/logger/index.d.ts +0 -2
  640. package/dist/types/lib/logger/logger.d.ts +0 -4
  641. package/dist/types/lib/logger/logger.types.d.ts +0 -28
  642. package/dist/types/mocks/MockApiClient.d.ts +0 -171
  643. package/dist/types/mocks/MockDataProvider.d.ts +0 -139
  644. package/dist/types/mocks/MockFactory.d.ts +0 -53
  645. package/dist/types/mocks/utils.d.ts +0 -24
  646. package/dist/types/themes/portalPresets.d.ts +0 -9
  647. package/dist/types/types/api/auth.d.ts +0 -93
  648. package/dist/types/types/api/broker.d.ts +0 -421
  649. package/dist/types/types/api/core.d.ts +0 -46
  650. package/dist/types/types/api/errors.d.ts +0 -31
  651. package/dist/types/types/api/orders.d.ts +0 -39
  652. package/dist/types/types/api/portfolio.d.ts +0 -55
  653. package/dist/types/types/common/pagination.d.ts +0 -33
  654. package/dist/types/types/connect.d.ts +0 -58
  655. package/dist/types/types/index.d.ts +0 -13
  656. package/dist/types/types/portal.d.ts +0 -204
  657. package/dist/types/types/ui/theme.d.ts +0 -104
  658. package/dist/types/utils/brokerUtils.d.ts +0 -30
  659. package/dist/types/utils/errors.d.ts +0 -45
  660. package/dist/types/utils/events.d.ts +0 -12
  661. package/dist/types/utils/themeUtils.d.ts +0 -34
  662. package/src/core/client/ApiClient.ts +0 -2004
  663. package/src/core/client/FinaticConnect.ts +0 -1606
  664. package/src/core/portal/PortalUI.ts +0 -335
  665. package/src/index.d.ts +0 -23
  666. package/src/index.ts +0 -100
  667. package/src/lib/logger/index.ts +0 -3
  668. package/src/lib/logger/logger.ts +0 -332
  669. package/src/lib/logger/logger.types.ts +0 -34
  670. package/src/mocks/MockApiClient.ts +0 -1058
  671. package/src/mocks/MockDataProvider.ts +0 -986
  672. package/src/mocks/MockFactory.ts +0 -97
  673. package/src/mocks/utils.ts +0 -133
  674. package/src/themes/portalPresets.ts +0 -1307
  675. package/src/types/api/auth.ts +0 -112
  676. package/src/types/api/broker.ts +0 -461
  677. package/src/types/api/core.ts +0 -53
  678. package/src/types/api/errors.ts +0 -35
  679. package/src/types/api/orders.ts +0 -45
  680. package/src/types/api/portfolio.ts +0 -59
  681. package/src/types/common/pagination.ts +0 -164
  682. package/src/types/connect.ts +0 -56
  683. package/src/types/index.ts +0 -25
  684. package/src/types/portal.ts +0 -214
  685. package/src/types/ui/theme.ts +0 -105
  686. package/src/utils/brokerUtils.ts +0 -104
  687. package/src/utils/errors.ts +0 -104
  688. package/src/utils/events.ts +0 -66
  689. package/src/utils/themeUtils.ts +0 -165
@@ -1,1126 +0,0 @@
1
- /**
2
- * Finatic FastAPI Backend
3
- * FinaticAPI REST API
4
- *
5
- * The version of the OpenAPI document: 1.0.0
6
- *
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 { AccountStatus } from '../models';
16
- import type { CancelOrderApiV1BrokersOrdersOrderIdDeleteRequest } from '../models';
17
- import type { FinaticResponseDisconnectActionResult } from '../models';
18
- import type { FinaticResponseListAccounts } from '../models';
19
- import type { FinaticResponseListBalances } from '../models';
20
- import type { FinaticResponseListBrokerInfo } from '../models';
21
- import type { FinaticResponseListOrderEventResponse } from '../models';
22
- import type { FinaticResponseListOrderFillResponse } from '../models';
23
- import type { FinaticResponseListOrderGroupResponse } from '../models';
24
- import type { FinaticResponseListOrderResponse } from '../models';
25
- import type { FinaticResponseListPositionLotFillResponse } from '../models';
26
- import type { FinaticResponseListPositionLotResponse } from '../models';
27
- import type { FinaticResponseListPositionResponse } from '../models';
28
- import type { FinaticResponseListUserBrokerConnections } from '../models';
29
- import type { FinaticResponseOrderActionResult } from '../models';
30
- import type { ModifyOrderApiV1BrokersOrdersOrderIdPatchRequest } from '../models';
31
- import type { PlaceOrderApiV1BrokersOrdersPostRequest } from '../models';
32
- import type { PublicAccountTypeEnum } from '../models';
33
- import type { PublicAssetTypeEnum } from '../models';
34
- import type { PublicOrderSideEnum } from '../models';
35
- import type { PublicOrderStatusEnum } from '../models';
36
- import type { PublicPositionStatusEnum } from '../models';
37
- /**
38
- * BrokersApi - axios parameter creator
39
- */
40
- export declare const BrokersApiAxiosParamCreator: (configuration?: Configuration) => {
41
- /**
42
- * Cancel an existing order. This endpoint is accessible from the portal and uses session-only authentication. Requires trading permissions for the company.
43
- * @summary Cancel Order
44
- * @param {string} orderId
45
- * @param {string | null} [accountNumber] Account number owning the order
46
- * @param {string | null} [connectionId] Temporary bypass for testing: specify connection ID directly
47
- * @param {CancelOrderApiV1BrokersOrdersOrderIdDeleteRequest | null} [cancelOrderApiV1BrokersOrdersOrderIdDeleteRequest]
48
- * @param {*} [options] Override http request option.
49
- * @throws {RequiredError}
50
- */
51
- cancelOrderApiV1BrokersOrdersOrderIdDelete: (orderId: string, accountNumber?: string | null, connectionId?: string | null, cancelOrderApiV1BrokersOrdersOrderIdDeleteRequest?: CancelOrderApiV1BrokersOrdersOrderIdDeleteRequest | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
52
- /**
53
- * Remove a company\'s access to a broker connection. If the company is the only one with access, the entire connection is deleted. If other companies have access, only the company\'s access is removed.
54
- * @summary Disconnect Company From Broker
55
- * @param {string} connectionId
56
- * @param {*} [options] Override http request option.
57
- * @throws {RequiredError}
58
- */
59
- disconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDelete: (connectionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
60
- /**
61
- * Get accounts for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns accounts from connections the company has read access to.
62
- * @summary Get Accounts
63
- * @param {string | null} [brokerId] Filter by broker ID
64
- * @param {string | null} [connectionId] Filter by connection ID
65
- * @param {PublicAccountTypeEnum | null} [accountType] Filter by account type (e.g., \&#39;margin\&#39;, \&#39;cash\&#39;, \&#39;crypto_wallet\&#39;, \&#39;live\&#39;, \&#39;sim\&#39;)
66
- * @param {AccountStatus | null} [status] Filter by account status (e.g., \&#39;active\&#39;, \&#39;inactive\&#39;)
67
- * @param {string | null} [currency] Filter by currency (e.g., \&#39;USD\&#39;, \&#39;EUR\&#39;)
68
- * @param {number} [limit] Maximum number of accounts to return
69
- * @param {number} [offset] Number of accounts to skip for pagination
70
- * @param {boolean} [withMetadata] Include connection metadata in response
71
- * @param {*} [options] Override http request option.
72
- * @throws {RequiredError}
73
- */
74
- getAccountsApiV1BrokersDataAccountsGet: (brokerId?: string | null, connectionId?: string | null, accountType?: PublicAccountTypeEnum | null, status?: AccountStatus | null, currency?: string | null, limit?: number, offset?: number, withMetadata?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
75
- /**
76
- * Get balances for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns balances from connections the company has read access to.
77
- * @summary Get Balances
78
- * @param {string | null} [brokerId] Filter by broker ID
79
- * @param {string | null} [connectionId] Filter by connection ID
80
- * @param {string | null} [accountId] Filter by broker provided account ID
81
- * @param {boolean | null} [isEndOfDaySnapshot] Filter by end-of-day snapshot status (true/false)
82
- * @param {number} [limit] Maximum number of balances to return
83
- * @param {number} [offset] Number of balances to skip for pagination
84
- * @param {string | null} [balanceCreatedAfter] Filter balances created after this timestamp
85
- * @param {string | null} [balanceCreatedBefore] Filter balances created before this timestamp
86
- * @param {boolean} [withMetadata] Include balance metadata in response
87
- * @param {*} [options] Override http request option.
88
- * @throws {RequiredError}
89
- */
90
- getBalancesApiV1BrokersDataBalancesGet: (brokerId?: string | null, connectionId?: string | null, accountId?: string | null, isEndOfDaySnapshot?: boolean | null, limit?: number, offset?: number, balanceCreatedAfter?: string | null, balanceCreatedBefore?: string | null, withMetadata?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
91
- /**
92
- * Get all available brokers. This is a fast operation that returns a cached list of available brokers. The list is loaded once at startup and never changes during runtime. Returns ------- FinaticResponse[list[BrokerInfo]] list of available brokers with their metadata.
93
- * @summary Get Brokers
94
- * @param {*} [options] Override http request option.
95
- * @throws {RequiredError}
96
- */
97
- getBrokersApiV1BrokersGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
98
- /**
99
- * Get order events for a specific order. This endpoint returns all lifecycle events for the specified order.
100
- * @summary Get Order Events
101
- * @param {string} orderId
102
- * @param {string | null} [connectionId] Filter by connection ID
103
- * @param {number} [limit] Maximum number of events to return
104
- * @param {number} [offset] Number of events to skip for pagination
105
- * @param {*} [options] Override http request option.
106
- * @throws {RequiredError}
107
- */
108
- getOrderEventsApiV1BrokersDataOrdersOrderIdEventsGet: (orderId: string, connectionId?: string | null, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
109
- /**
110
- * Get order fills for a specific order. This endpoint returns all execution fills for the specified order.
111
- * @summary Get Order Fills
112
- * @param {string} orderId
113
- * @param {string | null} [connectionId] Filter by connection ID
114
- * @param {number} [limit] Maximum number of fills to return
115
- * @param {number} [offset] Number of fills to skip for pagination
116
- * @param {*} [options] Override http request option.
117
- * @throws {RequiredError}
118
- */
119
- getOrderFillsApiV1BrokersDataOrdersOrderIdFillsGet: (orderId: string, connectionId?: string | null, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
120
- /**
121
- * Get order groups. This endpoint returns order groups that contain multiple orders.
122
- * @summary Get Order Groups
123
- * @param {string | null} [brokerId] Filter by broker ID
124
- * @param {string | null} [connectionId] Filter by connection ID
125
- * @param {number} [limit] Maximum number of order groups to return
126
- * @param {number} [offset] Number of order groups to skip for pagination
127
- * @param {string | null} [createdAfter] Filter order groups created after this timestamp
128
- * @param {string | null} [createdBefore] Filter order groups created before this timestamp
129
- * @param {*} [options] Override http request option.
130
- * @throws {RequiredError}
131
- */
132
- getOrderGroupsApiV1BrokersDataOrdersGroupsGet: (brokerId?: string | null, connectionId?: string | null, limit?: number, offset?: number, createdAfter?: string | null, createdBefore?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
133
- /**
134
- * Get orders for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns orders from connections the company has read access to.
135
- * @summary Get Orders
136
- * @param {string | null} [brokerId] Filter by broker ID
137
- * @param {string | null} [connectionId] Filter by connection ID
138
- * @param {string | null} [accountId] Filter by broker provided account ID
139
- * @param {string | null} [symbol] Filter by symbol
140
- * @param {PublicOrderStatusEnum | null} [orderStatus] Filter by order status (e.g., \&#39;filled\&#39;, \&#39;pending_new\&#39;, \&#39;cancelled\&#39;)
141
- * @param {PublicOrderSideEnum | null} [side] Filter by order side (e.g., \&#39;buy\&#39;, \&#39;sell\&#39;)
142
- * @param {PublicAssetTypeEnum | null} [assetType] Filter by asset type (e.g., \&#39;stock\&#39;, \&#39;option\&#39;, \&#39;crypto\&#39;, \&#39;future\&#39;)
143
- * @param {number} [limit] Maximum number of orders to return
144
- * @param {number} [offset] Number of orders to skip for pagination
145
- * @param {string | null} [createdAfter] Filter orders created after this timestamp
146
- * @param {string | null} [createdBefore] Filter orders created before this timestamp
147
- * @param {boolean} [withMetadata] Include order metadata in response
148
- * @param {*} [options] Override http request option.
149
- * @throws {RequiredError}
150
- */
151
- getOrdersApiV1BrokersDataOrdersGet: (brokerId?: string | null, connectionId?: string | null, accountId?: string | null, symbol?: string | null, orderStatus?: PublicOrderStatusEnum | null, side?: PublicOrderSideEnum | null, assetType?: PublicAssetTypeEnum | null, limit?: number, offset?: number, createdAfter?: string | null, createdBefore?: string | null, withMetadata?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
152
- /**
153
- * Get position lot fills for a specific lot. This endpoint returns all fills associated with a specific position lot.
154
- * @summary Get Position Lot Fills
155
- * @param {string} lotId
156
- * @param {string | null} [connectionId] Filter by connection ID
157
- * @param {number} [limit] Maximum number of fills to return
158
- * @param {number} [offset] Number of fills to skip for pagination
159
- * @param {*} [options] Override http request option.
160
- * @throws {RequiredError}
161
- */
162
- getPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGet: (lotId: string, connectionId?: string | null, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
163
- /**
164
- * Get position lots (tax lots for positions). This endpoint returns tax lots for positions, which are used for tax reporting. Each lot tracks when a position was opened/closed and at what prices.
165
- * @summary Get Position Lots
166
- * @param {string | null} [brokerId] Filter by broker ID
167
- * @param {string | null} [connectionId] Filter by connection ID
168
- * @param {string | null} [accountId] Filter by broker provided account ID
169
- * @param {string | null} [symbol] Filter by symbol
170
- * @param {string | null} [positionId] Filter by position ID
171
- * @param {number} [limit] Maximum number of position lots to return
172
- * @param {number} [offset] Number of position lots to skip for pagination
173
- * @param {*} [options] Override http request option.
174
- * @throws {RequiredError}
175
- */
176
- getPositionLotsApiV1BrokersDataPositionsLotsGet: (brokerId?: string | null, connectionId?: string | null, accountId?: string | null, symbol?: string | null, positionId?: string | null, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
177
- /**
178
- * Get positions for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns positions from connections the company has read access to.
179
- * @summary Get Positions
180
- * @param {string | null} [brokerId] Filter by broker ID
181
- * @param {string | null} [connectionId] Filter by connection ID
182
- * @param {string | null} [accountId] Filter by broker provided account ID
183
- * @param {string | null} [symbol] Filter by symbol
184
- * @param {PublicOrderSideEnum | null} [side] Filter by position side (e.g., \&#39;long\&#39;, \&#39;short\&#39;)
185
- * @param {PublicAssetTypeEnum | null} [assetType] Filter by asset type (e.g., \&#39;stock\&#39;, \&#39;option\&#39;, \&#39;crypto\&#39;, \&#39;future\&#39;)
186
- * @param {PublicPositionStatusEnum | null} [positionStatus] Filter by position status: \&#39;open\&#39; (quantity &gt; 0) or \&#39;closed\&#39; (quantity &#x3D; 0)
187
- * @param {number} [limit] Maximum number of positions to return
188
- * @param {number} [offset] Number of positions to skip for pagination
189
- * @param {string | null} [updatedAfter] Filter positions updated after this timestamp
190
- * @param {string | null} [updatedBefore] Filter positions updated before this timestamp
191
- * @param {boolean} [withMetadata] Include position metadata in response
192
- * @param {*} [options] Override http request option.
193
- * @throws {RequiredError}
194
- */
195
- getPositionsApiV1BrokersDataPositionsGet: (brokerId?: string | null, connectionId?: string | null, accountId?: string | null, symbol?: string | null, side?: PublicOrderSideEnum | null, assetType?: PublicAssetTypeEnum | null, positionStatus?: PublicPositionStatusEnum | null, limit?: number, offset?: number, updatedAfter?: string | null, updatedBefore?: string | null, withMetadata?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
196
- /**
197
- * List all broker connections for the current user. This endpoint is accessible from the portal and uses session-only authentication. Returns connections that the user has any permissions for.
198
- * @summary List Broker Connections
199
- * @param {*} [options] Override http request option.
200
- * @throws {RequiredError}
201
- */
202
- listBrokerConnectionsApiV1BrokersConnectionsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
203
- /**
204
- * Modify an existing order. This endpoint is accessible from the portal and uses session-only authentication. Requires trading permissions for the company.
205
- * @summary Modify Order
206
- * @param {string} orderId
207
- * @param {string | null} [accountNumber] Account number owning the order
208
- * @param {string | null} [connectionId] Temporary bypass for testing: specify connection ID directly
209
- * @param {ModifyOrderApiV1BrokersOrdersOrderIdPatchRequest | null} [modifyOrderApiV1BrokersOrdersOrderIdPatchRequest]
210
- * @param {*} [options] Override http request option.
211
- * @throws {RequiredError}
212
- */
213
- modifyOrderApiV1BrokersOrdersOrderIdPatch: (orderId: string, accountNumber?: string | null, connectionId?: string | null, modifyOrderApiV1BrokersOrdersOrderIdPatchRequest?: ModifyOrderApiV1BrokersOrdersOrderIdPatchRequest | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
214
- /**
215
- * Create a new order via the specified broker connection. This endpoint is accessible from the portal and uses session-only authentication. Requires trading permissions for the company. Standard parameters ------------------- The following fields constitute the unified Finatic *common order schema* and therefore appear individually as query parameters in the autogenerated OpenAPI documentation: - ``broker`` - ``account_number`` - ``order_type`` - ``asset_type`` - ``action`` - ``time_in_force`` - ``symbol`` - ``order_qty`` They are surfaced as *query* parameters **only to make the accepted fields obvious in the interactive docs**. In production usage you should send these fields inside the JSON body (see ``order_request``) so that the entire order specification travels in one payload. (Nothing will break if you send both, but there is no need to do so.) Body payload & broker-specific extras ------------------------------------- Put the standard parameters plus any broker-specific extensions under the ``order`` key of the body. Refer to the bundled OpenAPI examples below to see complete payloads for common order types (market, limit, spreads, etc.) across supported brokers. For a formal reference of broker-specific extensions inspect the ``BrokerOrderPlaceExtras`` schema. The endpoint resolves the active ``user_broker_connection`` by calling the ``get_user_broker_connection_ids_for_broker`` RPC in Supabase. If no active connection exists it returns a list of *available* brokers so your client can guide the user accordingly. Broker Notes ------------ - The responses that you get back from the broker are not always the same. The response models are validated for each broker, but we do not standardize the repsonses. - Tasty Trade: If you want to trade options for a particular stock, first fetch the full option chain via the GET https://api.tastyworks.com/option-chains/{stock_symbol}/nested endpoint. This endpoint returns all available expirations that tastytrade offers for that equity symbol. Each expiration contains a list of strikes, where each strike has a call and put field representing the call symbol and put symbol respectively. We are planning to add a new endpoint to fetch the option chain for a particular stock and handle this logic for you, but for now you need to fetch the option chain manually.
216
- * @summary Place Order
217
- * @param {string | null} [connectionId] Temporary bypass for testing: specify connection ID directly
218
- * @param {PlaceOrderApiV1BrokersOrdersPostRequest | null} [placeOrderApiV1BrokersOrdersPostRequest]
219
- * @param {*} [options] Override http request option.
220
- * @throws {RequiredError}
221
- */
222
- placeOrderApiV1BrokersOrdersPost: (connectionId?: string | null, placeOrderApiV1BrokersOrdersPostRequest?: PlaceOrderApiV1BrokersOrdersPostRequest | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
223
- };
224
- /**
225
- * BrokersApi - functional programming interface
226
- */
227
- export declare const BrokersApiFp: (configuration?: Configuration) => {
228
- /**
229
- * Cancel an existing order. This endpoint is accessible from the portal and uses session-only authentication. Requires trading permissions for the company.
230
- * @summary Cancel Order
231
- * @param {string} orderId
232
- * @param {string | null} [accountNumber] Account number owning the order
233
- * @param {string | null} [connectionId] Temporary bypass for testing: specify connection ID directly
234
- * @param {CancelOrderApiV1BrokersOrdersOrderIdDeleteRequest | null} [cancelOrderApiV1BrokersOrdersOrderIdDeleteRequest]
235
- * @param {*} [options] Override http request option.
236
- * @throws {RequiredError}
237
- */
238
- cancelOrderApiV1BrokersOrdersOrderIdDelete(orderId: string, accountNumber?: string | null, connectionId?: string | null, cancelOrderApiV1BrokersOrdersOrderIdDeleteRequest?: CancelOrderApiV1BrokersOrdersOrderIdDeleteRequest | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseOrderActionResult>>;
239
- /**
240
- * Remove a company\'s access to a broker connection. If the company is the only one with access, the entire connection is deleted. If other companies have access, only the company\'s access is removed.
241
- * @summary Disconnect Company From Broker
242
- * @param {string} connectionId
243
- * @param {*} [options] Override http request option.
244
- * @throws {RequiredError}
245
- */
246
- disconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDelete(connectionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseDisconnectActionResult>>;
247
- /**
248
- * Get accounts for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns accounts from connections the company has read access to.
249
- * @summary Get Accounts
250
- * @param {string | null} [brokerId] Filter by broker ID
251
- * @param {string | null} [connectionId] Filter by connection ID
252
- * @param {PublicAccountTypeEnum | null} [accountType] Filter by account type (e.g., \&#39;margin\&#39;, \&#39;cash\&#39;, \&#39;crypto_wallet\&#39;, \&#39;live\&#39;, \&#39;sim\&#39;)
253
- * @param {AccountStatus | null} [status] Filter by account status (e.g., \&#39;active\&#39;, \&#39;inactive\&#39;)
254
- * @param {string | null} [currency] Filter by currency (e.g., \&#39;USD\&#39;, \&#39;EUR\&#39;)
255
- * @param {number} [limit] Maximum number of accounts to return
256
- * @param {number} [offset] Number of accounts to skip for pagination
257
- * @param {boolean} [withMetadata] Include connection metadata in response
258
- * @param {*} [options] Override http request option.
259
- * @throws {RequiredError}
260
- */
261
- getAccountsApiV1BrokersDataAccountsGet(brokerId?: string | null, connectionId?: string | null, accountType?: PublicAccountTypeEnum | null, status?: AccountStatus | null, currency?: string | null, limit?: number, offset?: number, withMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListAccounts>>;
262
- /**
263
- * Get balances for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns balances from connections the company has read access to.
264
- * @summary Get Balances
265
- * @param {string | null} [brokerId] Filter by broker ID
266
- * @param {string | null} [connectionId] Filter by connection ID
267
- * @param {string | null} [accountId] Filter by broker provided account ID
268
- * @param {boolean | null} [isEndOfDaySnapshot] Filter by end-of-day snapshot status (true/false)
269
- * @param {number} [limit] Maximum number of balances to return
270
- * @param {number} [offset] Number of balances to skip for pagination
271
- * @param {string | null} [balanceCreatedAfter] Filter balances created after this timestamp
272
- * @param {string | null} [balanceCreatedBefore] Filter balances created before this timestamp
273
- * @param {boolean} [withMetadata] Include balance metadata in response
274
- * @param {*} [options] Override http request option.
275
- * @throws {RequiredError}
276
- */
277
- getBalancesApiV1BrokersDataBalancesGet(brokerId?: string | null, connectionId?: string | null, accountId?: string | null, isEndOfDaySnapshot?: boolean | null, limit?: number, offset?: number, balanceCreatedAfter?: string | null, balanceCreatedBefore?: string | null, withMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListBalances>>;
278
- /**
279
- * Get all available brokers. This is a fast operation that returns a cached list of available brokers. The list is loaded once at startup and never changes during runtime. Returns ------- FinaticResponse[list[BrokerInfo]] list of available brokers with their metadata.
280
- * @summary Get Brokers
281
- * @param {*} [options] Override http request option.
282
- * @throws {RequiredError}
283
- */
284
- getBrokersApiV1BrokersGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListBrokerInfo>>;
285
- /**
286
- * Get order events for a specific order. This endpoint returns all lifecycle events for the specified order.
287
- * @summary Get Order Events
288
- * @param {string} orderId
289
- * @param {string | null} [connectionId] Filter by connection ID
290
- * @param {number} [limit] Maximum number of events to return
291
- * @param {number} [offset] Number of events to skip for pagination
292
- * @param {*} [options] Override http request option.
293
- * @throws {RequiredError}
294
- */
295
- getOrderEventsApiV1BrokersDataOrdersOrderIdEventsGet(orderId: string, connectionId?: string | null, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListOrderEventResponse>>;
296
- /**
297
- * Get order fills for a specific order. This endpoint returns all execution fills for the specified order.
298
- * @summary Get Order Fills
299
- * @param {string} orderId
300
- * @param {string | null} [connectionId] Filter by connection ID
301
- * @param {number} [limit] Maximum number of fills to return
302
- * @param {number} [offset] Number of fills to skip for pagination
303
- * @param {*} [options] Override http request option.
304
- * @throws {RequiredError}
305
- */
306
- getOrderFillsApiV1BrokersDataOrdersOrderIdFillsGet(orderId: string, connectionId?: string | null, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListOrderFillResponse>>;
307
- /**
308
- * Get order groups. This endpoint returns order groups that contain multiple orders.
309
- * @summary Get Order Groups
310
- * @param {string | null} [brokerId] Filter by broker ID
311
- * @param {string | null} [connectionId] Filter by connection ID
312
- * @param {number} [limit] Maximum number of order groups to return
313
- * @param {number} [offset] Number of order groups to skip for pagination
314
- * @param {string | null} [createdAfter] Filter order groups created after this timestamp
315
- * @param {string | null} [createdBefore] Filter order groups created before this timestamp
316
- * @param {*} [options] Override http request option.
317
- * @throws {RequiredError}
318
- */
319
- getOrderGroupsApiV1BrokersDataOrdersGroupsGet(brokerId?: string | null, connectionId?: string | null, limit?: number, offset?: number, createdAfter?: string | null, createdBefore?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListOrderGroupResponse>>;
320
- /**
321
- * Get orders for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns orders from connections the company has read access to.
322
- * @summary Get Orders
323
- * @param {string | null} [brokerId] Filter by broker ID
324
- * @param {string | null} [connectionId] Filter by connection ID
325
- * @param {string | null} [accountId] Filter by broker provided account ID
326
- * @param {string | null} [symbol] Filter by symbol
327
- * @param {PublicOrderStatusEnum | null} [orderStatus] Filter by order status (e.g., \&#39;filled\&#39;, \&#39;pending_new\&#39;, \&#39;cancelled\&#39;)
328
- * @param {PublicOrderSideEnum | null} [side] Filter by order side (e.g., \&#39;buy\&#39;, \&#39;sell\&#39;)
329
- * @param {PublicAssetTypeEnum | null} [assetType] Filter by asset type (e.g., \&#39;stock\&#39;, \&#39;option\&#39;, \&#39;crypto\&#39;, \&#39;future\&#39;)
330
- * @param {number} [limit] Maximum number of orders to return
331
- * @param {number} [offset] Number of orders to skip for pagination
332
- * @param {string | null} [createdAfter] Filter orders created after this timestamp
333
- * @param {string | null} [createdBefore] Filter orders created before this timestamp
334
- * @param {boolean} [withMetadata] Include order metadata in response
335
- * @param {*} [options] Override http request option.
336
- * @throws {RequiredError}
337
- */
338
- getOrdersApiV1BrokersDataOrdersGet(brokerId?: string | null, connectionId?: string | null, accountId?: string | null, symbol?: string | null, orderStatus?: PublicOrderStatusEnum | null, side?: PublicOrderSideEnum | null, assetType?: PublicAssetTypeEnum | null, limit?: number, offset?: number, createdAfter?: string | null, createdBefore?: string | null, withMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListOrderResponse>>;
339
- /**
340
- * Get position lot fills for a specific lot. This endpoint returns all fills associated with a specific position lot.
341
- * @summary Get Position Lot Fills
342
- * @param {string} lotId
343
- * @param {string | null} [connectionId] Filter by connection ID
344
- * @param {number} [limit] Maximum number of fills to return
345
- * @param {number} [offset] Number of fills to skip for pagination
346
- * @param {*} [options] Override http request option.
347
- * @throws {RequiredError}
348
- */
349
- getPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGet(lotId: string, connectionId?: string | null, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListPositionLotFillResponse>>;
350
- /**
351
- * Get position lots (tax lots for positions). This endpoint returns tax lots for positions, which are used for tax reporting. Each lot tracks when a position was opened/closed and at what prices.
352
- * @summary Get Position Lots
353
- * @param {string | null} [brokerId] Filter by broker ID
354
- * @param {string | null} [connectionId] Filter by connection ID
355
- * @param {string | null} [accountId] Filter by broker provided account ID
356
- * @param {string | null} [symbol] Filter by symbol
357
- * @param {string | null} [positionId] Filter by position ID
358
- * @param {number} [limit] Maximum number of position lots to return
359
- * @param {number} [offset] Number of position lots to skip for pagination
360
- * @param {*} [options] Override http request option.
361
- * @throws {RequiredError}
362
- */
363
- getPositionLotsApiV1BrokersDataPositionsLotsGet(brokerId?: string | null, connectionId?: string | null, accountId?: string | null, symbol?: string | null, positionId?: string | null, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListPositionLotResponse>>;
364
- /**
365
- * Get positions for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns positions from connections the company has read access to.
366
- * @summary Get Positions
367
- * @param {string | null} [brokerId] Filter by broker ID
368
- * @param {string | null} [connectionId] Filter by connection ID
369
- * @param {string | null} [accountId] Filter by broker provided account ID
370
- * @param {string | null} [symbol] Filter by symbol
371
- * @param {PublicOrderSideEnum | null} [side] Filter by position side (e.g., \&#39;long\&#39;, \&#39;short\&#39;)
372
- * @param {PublicAssetTypeEnum | null} [assetType] Filter by asset type (e.g., \&#39;stock\&#39;, \&#39;option\&#39;, \&#39;crypto\&#39;, \&#39;future\&#39;)
373
- * @param {PublicPositionStatusEnum | null} [positionStatus] Filter by position status: \&#39;open\&#39; (quantity &gt; 0) or \&#39;closed\&#39; (quantity &#x3D; 0)
374
- * @param {number} [limit] Maximum number of positions to return
375
- * @param {number} [offset] Number of positions to skip for pagination
376
- * @param {string | null} [updatedAfter] Filter positions updated after this timestamp
377
- * @param {string | null} [updatedBefore] Filter positions updated before this timestamp
378
- * @param {boolean} [withMetadata] Include position metadata in response
379
- * @param {*} [options] Override http request option.
380
- * @throws {RequiredError}
381
- */
382
- getPositionsApiV1BrokersDataPositionsGet(brokerId?: string | null, connectionId?: string | null, accountId?: string | null, symbol?: string | null, side?: PublicOrderSideEnum | null, assetType?: PublicAssetTypeEnum | null, positionStatus?: PublicPositionStatusEnum | null, limit?: number, offset?: number, updatedAfter?: string | null, updatedBefore?: string | null, withMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListPositionResponse>>;
383
- /**
384
- * List all broker connections for the current user. This endpoint is accessible from the portal and uses session-only authentication. Returns connections that the user has any permissions for.
385
- * @summary List Broker Connections
386
- * @param {*} [options] Override http request option.
387
- * @throws {RequiredError}
388
- */
389
- listBrokerConnectionsApiV1BrokersConnectionsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListUserBrokerConnections>>;
390
- /**
391
- * Modify an existing order. This endpoint is accessible from the portal and uses session-only authentication. Requires trading permissions for the company.
392
- * @summary Modify Order
393
- * @param {string} orderId
394
- * @param {string | null} [accountNumber] Account number owning the order
395
- * @param {string | null} [connectionId] Temporary bypass for testing: specify connection ID directly
396
- * @param {ModifyOrderApiV1BrokersOrdersOrderIdPatchRequest | null} [modifyOrderApiV1BrokersOrdersOrderIdPatchRequest]
397
- * @param {*} [options] Override http request option.
398
- * @throws {RequiredError}
399
- */
400
- modifyOrderApiV1BrokersOrdersOrderIdPatch(orderId: string, accountNumber?: string | null, connectionId?: string | null, modifyOrderApiV1BrokersOrdersOrderIdPatchRequest?: ModifyOrderApiV1BrokersOrdersOrderIdPatchRequest | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseOrderActionResult>>;
401
- /**
402
- * Create a new order via the specified broker connection. This endpoint is accessible from the portal and uses session-only authentication. Requires trading permissions for the company. Standard parameters ------------------- The following fields constitute the unified Finatic *common order schema* and therefore appear individually as query parameters in the autogenerated OpenAPI documentation: - ``broker`` - ``account_number`` - ``order_type`` - ``asset_type`` - ``action`` - ``time_in_force`` - ``symbol`` - ``order_qty`` They are surfaced as *query* parameters **only to make the accepted fields obvious in the interactive docs**. In production usage you should send these fields inside the JSON body (see ``order_request``) so that the entire order specification travels in one payload. (Nothing will break if you send both, but there is no need to do so.) Body payload & broker-specific extras ------------------------------------- Put the standard parameters plus any broker-specific extensions under the ``order`` key of the body. Refer to the bundled OpenAPI examples below to see complete payloads for common order types (market, limit, spreads, etc.) across supported brokers. For a formal reference of broker-specific extensions inspect the ``BrokerOrderPlaceExtras`` schema. The endpoint resolves the active ``user_broker_connection`` by calling the ``get_user_broker_connection_ids_for_broker`` RPC in Supabase. If no active connection exists it returns a list of *available* brokers so your client can guide the user accordingly. Broker Notes ------------ - The responses that you get back from the broker are not always the same. The response models are validated for each broker, but we do not standardize the repsonses. - Tasty Trade: If you want to trade options for a particular stock, first fetch the full option chain via the GET https://api.tastyworks.com/option-chains/{stock_symbol}/nested endpoint. This endpoint returns all available expirations that tastytrade offers for that equity symbol. Each expiration contains a list of strikes, where each strike has a call and put field representing the call symbol and put symbol respectively. We are planning to add a new endpoint to fetch the option chain for a particular stock and handle this logic for you, but for now you need to fetch the option chain manually.
403
- * @summary Place Order
404
- * @param {string | null} [connectionId] Temporary bypass for testing: specify connection ID directly
405
- * @param {PlaceOrderApiV1BrokersOrdersPostRequest | null} [placeOrderApiV1BrokersOrdersPostRequest]
406
- * @param {*} [options] Override http request option.
407
- * @throws {RequiredError}
408
- */
409
- placeOrderApiV1BrokersOrdersPost(connectionId?: string | null, placeOrderApiV1BrokersOrdersPostRequest?: PlaceOrderApiV1BrokersOrdersPostRequest | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseOrderActionResult>>;
410
- };
411
- /**
412
- * BrokersApi - factory interface
413
- */
414
- export declare const BrokersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
415
- /**
416
- * Cancel an existing order. This endpoint is accessible from the portal and uses session-only authentication. Requires trading permissions for the company.
417
- * @summary Cancel Order
418
- * @param {BrokersApiCancelOrderApiV1BrokersOrdersOrderIdDeleteRequest} requestParameters Request parameters.
419
- * @param {*} [options] Override http request option.
420
- * @throws {RequiredError}
421
- */
422
- cancelOrderApiV1BrokersOrdersOrderIdDelete(requestParameters: BrokersApiCancelOrderApiV1BrokersOrdersOrderIdDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseOrderActionResult>;
423
- /**
424
- * Remove a company\'s access to a broker connection. If the company is the only one with access, the entire connection is deleted. If other companies have access, only the company\'s access is removed.
425
- * @summary Disconnect Company From Broker
426
- * @param {BrokersApiDisconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDeleteRequest} requestParameters Request parameters.
427
- * @param {*} [options] Override http request option.
428
- * @throws {RequiredError}
429
- */
430
- disconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDelete(requestParameters: BrokersApiDisconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseDisconnectActionResult>;
431
- /**
432
- * Get accounts for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns accounts from connections the company has read access to.
433
- * @summary Get Accounts
434
- * @param {BrokersApiGetAccountsApiV1BrokersDataAccountsGetRequest} requestParameters Request parameters.
435
- * @param {*} [options] Override http request option.
436
- * @throws {RequiredError}
437
- */
438
- getAccountsApiV1BrokersDataAccountsGet(requestParameters?: BrokersApiGetAccountsApiV1BrokersDataAccountsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListAccounts>;
439
- /**
440
- * Get balances for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns balances from connections the company has read access to.
441
- * @summary Get Balances
442
- * @param {BrokersApiGetBalancesApiV1BrokersDataBalancesGetRequest} requestParameters Request parameters.
443
- * @param {*} [options] Override http request option.
444
- * @throws {RequiredError}
445
- */
446
- getBalancesApiV1BrokersDataBalancesGet(requestParameters?: BrokersApiGetBalancesApiV1BrokersDataBalancesGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListBalances>;
447
- /**
448
- * Get all available brokers. This is a fast operation that returns a cached list of available brokers. The list is loaded once at startup and never changes during runtime. Returns ------- FinaticResponse[list[BrokerInfo]] list of available brokers with their metadata.
449
- * @summary Get Brokers
450
- * @param {*} [options] Override http request option.
451
- * @throws {RequiredError}
452
- */
453
- getBrokersApiV1BrokersGet(options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListBrokerInfo>;
454
- /**
455
- * Get order events for a specific order. This endpoint returns all lifecycle events for the specified order.
456
- * @summary Get Order Events
457
- * @param {BrokersApiGetOrderEventsApiV1BrokersDataOrdersOrderIdEventsGetRequest} requestParameters Request parameters.
458
- * @param {*} [options] Override http request option.
459
- * @throws {RequiredError}
460
- */
461
- getOrderEventsApiV1BrokersDataOrdersOrderIdEventsGet(requestParameters: BrokersApiGetOrderEventsApiV1BrokersDataOrdersOrderIdEventsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListOrderEventResponse>;
462
- /**
463
- * Get order fills for a specific order. This endpoint returns all execution fills for the specified order.
464
- * @summary Get Order Fills
465
- * @param {BrokersApiGetOrderFillsApiV1BrokersDataOrdersOrderIdFillsGetRequest} requestParameters Request parameters.
466
- * @param {*} [options] Override http request option.
467
- * @throws {RequiredError}
468
- */
469
- getOrderFillsApiV1BrokersDataOrdersOrderIdFillsGet(requestParameters: BrokersApiGetOrderFillsApiV1BrokersDataOrdersOrderIdFillsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListOrderFillResponse>;
470
- /**
471
- * Get order groups. This endpoint returns order groups that contain multiple orders.
472
- * @summary Get Order Groups
473
- * @param {BrokersApiGetOrderGroupsApiV1BrokersDataOrdersGroupsGetRequest} requestParameters Request parameters.
474
- * @param {*} [options] Override http request option.
475
- * @throws {RequiredError}
476
- */
477
- getOrderGroupsApiV1BrokersDataOrdersGroupsGet(requestParameters?: BrokersApiGetOrderGroupsApiV1BrokersDataOrdersGroupsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListOrderGroupResponse>;
478
- /**
479
- * Get orders for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns orders from connections the company has read access to.
480
- * @summary Get Orders
481
- * @param {BrokersApiGetOrdersApiV1BrokersDataOrdersGetRequest} requestParameters Request parameters.
482
- * @param {*} [options] Override http request option.
483
- * @throws {RequiredError}
484
- */
485
- getOrdersApiV1BrokersDataOrdersGet(requestParameters?: BrokersApiGetOrdersApiV1BrokersDataOrdersGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListOrderResponse>;
486
- /**
487
- * Get position lot fills for a specific lot. This endpoint returns all fills associated with a specific position lot.
488
- * @summary Get Position Lot Fills
489
- * @param {BrokersApiGetPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGetRequest} requestParameters Request parameters.
490
- * @param {*} [options] Override http request option.
491
- * @throws {RequiredError}
492
- */
493
- getPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGet(requestParameters: BrokersApiGetPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListPositionLotFillResponse>;
494
- /**
495
- * Get position lots (tax lots for positions). This endpoint returns tax lots for positions, which are used for tax reporting. Each lot tracks when a position was opened/closed and at what prices.
496
- * @summary Get Position Lots
497
- * @param {BrokersApiGetPositionLotsApiV1BrokersDataPositionsLotsGetRequest} requestParameters Request parameters.
498
- * @param {*} [options] Override http request option.
499
- * @throws {RequiredError}
500
- */
501
- getPositionLotsApiV1BrokersDataPositionsLotsGet(requestParameters?: BrokersApiGetPositionLotsApiV1BrokersDataPositionsLotsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListPositionLotResponse>;
502
- /**
503
- * Get positions for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns positions from connections the company has read access to.
504
- * @summary Get Positions
505
- * @param {BrokersApiGetPositionsApiV1BrokersDataPositionsGetRequest} requestParameters Request parameters.
506
- * @param {*} [options] Override http request option.
507
- * @throws {RequiredError}
508
- */
509
- getPositionsApiV1BrokersDataPositionsGet(requestParameters?: BrokersApiGetPositionsApiV1BrokersDataPositionsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListPositionResponse>;
510
- /**
511
- * List all broker connections for the current user. This endpoint is accessible from the portal and uses session-only authentication. Returns connections that the user has any permissions for.
512
- * @summary List Broker Connections
513
- * @param {*} [options] Override http request option.
514
- * @throws {RequiredError}
515
- */
516
- listBrokerConnectionsApiV1BrokersConnectionsGet(options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListUserBrokerConnections>;
517
- /**
518
- * Modify an existing order. This endpoint is accessible from the portal and uses session-only authentication. Requires trading permissions for the company.
519
- * @summary Modify Order
520
- * @param {BrokersApiModifyOrderApiV1BrokersOrdersOrderIdPatchRequest} requestParameters Request parameters.
521
- * @param {*} [options] Override http request option.
522
- * @throws {RequiredError}
523
- */
524
- modifyOrderApiV1BrokersOrdersOrderIdPatch(requestParameters: BrokersApiModifyOrderApiV1BrokersOrdersOrderIdPatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseOrderActionResult>;
525
- /**
526
- * Create a new order via the specified broker connection. This endpoint is accessible from the portal and uses session-only authentication. Requires trading permissions for the company. Standard parameters ------------------- The following fields constitute the unified Finatic *common order schema* and therefore appear individually as query parameters in the autogenerated OpenAPI documentation: - ``broker`` - ``account_number`` - ``order_type`` - ``asset_type`` - ``action`` - ``time_in_force`` - ``symbol`` - ``order_qty`` They are surfaced as *query* parameters **only to make the accepted fields obvious in the interactive docs**. In production usage you should send these fields inside the JSON body (see ``order_request``) so that the entire order specification travels in one payload. (Nothing will break if you send both, but there is no need to do so.) Body payload & broker-specific extras ------------------------------------- Put the standard parameters plus any broker-specific extensions under the ``order`` key of the body. Refer to the bundled OpenAPI examples below to see complete payloads for common order types (market, limit, spreads, etc.) across supported brokers. For a formal reference of broker-specific extensions inspect the ``BrokerOrderPlaceExtras`` schema. The endpoint resolves the active ``user_broker_connection`` by calling the ``get_user_broker_connection_ids_for_broker`` RPC in Supabase. If no active connection exists it returns a list of *available* brokers so your client can guide the user accordingly. Broker Notes ------------ - The responses that you get back from the broker are not always the same. The response models are validated for each broker, but we do not standardize the repsonses. - Tasty Trade: If you want to trade options for a particular stock, first fetch the full option chain via the GET https://api.tastyworks.com/option-chains/{stock_symbol}/nested endpoint. This endpoint returns all available expirations that tastytrade offers for that equity symbol. Each expiration contains a list of strikes, where each strike has a call and put field representing the call symbol and put symbol respectively. We are planning to add a new endpoint to fetch the option chain for a particular stock and handle this logic for you, but for now you need to fetch the option chain manually.
527
- * @summary Place Order
528
- * @param {BrokersApiPlaceOrderApiV1BrokersOrdersPostRequest} requestParameters Request parameters.
529
- * @param {*} [options] Override http request option.
530
- * @throws {RequiredError}
531
- */
532
- placeOrderApiV1BrokersOrdersPost(requestParameters?: BrokersApiPlaceOrderApiV1BrokersOrdersPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseOrderActionResult>;
533
- };
534
- /**
535
- * BrokersApi - interface
536
- */
537
- export interface BrokersApiInterface {
538
- /**
539
- * Cancel an existing order. This endpoint is accessible from the portal and uses session-only authentication. Requires trading permissions for the company.
540
- * @summary Cancel Order
541
- * @param {BrokersApiCancelOrderApiV1BrokersOrdersOrderIdDeleteRequest} requestParameters Request parameters.
542
- * @param {*} [options] Override http request option.
543
- * @throws {RequiredError}
544
- */
545
- cancelOrderApiV1BrokersOrdersOrderIdDelete(requestParameters: BrokersApiCancelOrderApiV1BrokersOrdersOrderIdDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseOrderActionResult>;
546
- /**
547
- * Remove a company\'s access to a broker connection. If the company is the only one with access, the entire connection is deleted. If other companies have access, only the company\'s access is removed.
548
- * @summary Disconnect Company From Broker
549
- * @param {BrokersApiDisconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDeleteRequest} requestParameters Request parameters.
550
- * @param {*} [options] Override http request option.
551
- * @throws {RequiredError}
552
- */
553
- disconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDelete(requestParameters: BrokersApiDisconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseDisconnectActionResult>;
554
- /**
555
- * Get accounts for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns accounts from connections the company has read access to.
556
- * @summary Get Accounts
557
- * @param {BrokersApiGetAccountsApiV1BrokersDataAccountsGetRequest} requestParameters Request parameters.
558
- * @param {*} [options] Override http request option.
559
- * @throws {RequiredError}
560
- */
561
- getAccountsApiV1BrokersDataAccountsGet(requestParameters?: BrokersApiGetAccountsApiV1BrokersDataAccountsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListAccounts>;
562
- /**
563
- * Get balances for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns balances from connections the company has read access to.
564
- * @summary Get Balances
565
- * @param {BrokersApiGetBalancesApiV1BrokersDataBalancesGetRequest} requestParameters Request parameters.
566
- * @param {*} [options] Override http request option.
567
- * @throws {RequiredError}
568
- */
569
- getBalancesApiV1BrokersDataBalancesGet(requestParameters?: BrokersApiGetBalancesApiV1BrokersDataBalancesGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListBalances>;
570
- /**
571
- * Get all available brokers. This is a fast operation that returns a cached list of available brokers. The list is loaded once at startup and never changes during runtime. Returns ------- FinaticResponse[list[BrokerInfo]] list of available brokers with their metadata.
572
- * @summary Get Brokers
573
- * @param {*} [options] Override http request option.
574
- * @throws {RequiredError}
575
- */
576
- getBrokersApiV1BrokersGet(options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListBrokerInfo>;
577
- /**
578
- * Get order events for a specific order. This endpoint returns all lifecycle events for the specified order.
579
- * @summary Get Order Events
580
- * @param {BrokersApiGetOrderEventsApiV1BrokersDataOrdersOrderIdEventsGetRequest} requestParameters Request parameters.
581
- * @param {*} [options] Override http request option.
582
- * @throws {RequiredError}
583
- */
584
- getOrderEventsApiV1BrokersDataOrdersOrderIdEventsGet(requestParameters: BrokersApiGetOrderEventsApiV1BrokersDataOrdersOrderIdEventsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListOrderEventResponse>;
585
- /**
586
- * Get order fills for a specific order. This endpoint returns all execution fills for the specified order.
587
- * @summary Get Order Fills
588
- * @param {BrokersApiGetOrderFillsApiV1BrokersDataOrdersOrderIdFillsGetRequest} requestParameters Request parameters.
589
- * @param {*} [options] Override http request option.
590
- * @throws {RequiredError}
591
- */
592
- getOrderFillsApiV1BrokersDataOrdersOrderIdFillsGet(requestParameters: BrokersApiGetOrderFillsApiV1BrokersDataOrdersOrderIdFillsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListOrderFillResponse>;
593
- /**
594
- * Get order groups. This endpoint returns order groups that contain multiple orders.
595
- * @summary Get Order Groups
596
- * @param {BrokersApiGetOrderGroupsApiV1BrokersDataOrdersGroupsGetRequest} requestParameters Request parameters.
597
- * @param {*} [options] Override http request option.
598
- * @throws {RequiredError}
599
- */
600
- getOrderGroupsApiV1BrokersDataOrdersGroupsGet(requestParameters?: BrokersApiGetOrderGroupsApiV1BrokersDataOrdersGroupsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListOrderGroupResponse>;
601
- /**
602
- * Get orders for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns orders from connections the company has read access to.
603
- * @summary Get Orders
604
- * @param {BrokersApiGetOrdersApiV1BrokersDataOrdersGetRequest} requestParameters Request parameters.
605
- * @param {*} [options] Override http request option.
606
- * @throws {RequiredError}
607
- */
608
- getOrdersApiV1BrokersDataOrdersGet(requestParameters?: BrokersApiGetOrdersApiV1BrokersDataOrdersGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListOrderResponse>;
609
- /**
610
- * Get position lot fills for a specific lot. This endpoint returns all fills associated with a specific position lot.
611
- * @summary Get Position Lot Fills
612
- * @param {BrokersApiGetPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGetRequest} requestParameters Request parameters.
613
- * @param {*} [options] Override http request option.
614
- * @throws {RequiredError}
615
- */
616
- getPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGet(requestParameters: BrokersApiGetPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListPositionLotFillResponse>;
617
- /**
618
- * Get position lots (tax lots for positions). This endpoint returns tax lots for positions, which are used for tax reporting. Each lot tracks when a position was opened/closed and at what prices.
619
- * @summary Get Position Lots
620
- * @param {BrokersApiGetPositionLotsApiV1BrokersDataPositionsLotsGetRequest} requestParameters Request parameters.
621
- * @param {*} [options] Override http request option.
622
- * @throws {RequiredError}
623
- */
624
- getPositionLotsApiV1BrokersDataPositionsLotsGet(requestParameters?: BrokersApiGetPositionLotsApiV1BrokersDataPositionsLotsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListPositionLotResponse>;
625
- /**
626
- * Get positions for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns positions from connections the company has read access to.
627
- * @summary Get Positions
628
- * @param {BrokersApiGetPositionsApiV1BrokersDataPositionsGetRequest} requestParameters Request parameters.
629
- * @param {*} [options] Override http request option.
630
- * @throws {RequiredError}
631
- */
632
- getPositionsApiV1BrokersDataPositionsGet(requestParameters?: BrokersApiGetPositionsApiV1BrokersDataPositionsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListPositionResponse>;
633
- /**
634
- * List all broker connections for the current user. This endpoint is accessible from the portal and uses session-only authentication. Returns connections that the user has any permissions for.
635
- * @summary List Broker Connections
636
- * @param {*} [options] Override http request option.
637
- * @throws {RequiredError}
638
- */
639
- listBrokerConnectionsApiV1BrokersConnectionsGet(options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseListUserBrokerConnections>;
640
- /**
641
- * Modify an existing order. This endpoint is accessible from the portal and uses session-only authentication. Requires trading permissions for the company.
642
- * @summary Modify Order
643
- * @param {BrokersApiModifyOrderApiV1BrokersOrdersOrderIdPatchRequest} requestParameters Request parameters.
644
- * @param {*} [options] Override http request option.
645
- * @throws {RequiredError}
646
- */
647
- modifyOrderApiV1BrokersOrdersOrderIdPatch(requestParameters: BrokersApiModifyOrderApiV1BrokersOrdersOrderIdPatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseOrderActionResult>;
648
- /**
649
- * Create a new order via the specified broker connection. This endpoint is accessible from the portal and uses session-only authentication. Requires trading permissions for the company. Standard parameters ------------------- The following fields constitute the unified Finatic *common order schema* and therefore appear individually as query parameters in the autogenerated OpenAPI documentation: - ``broker`` - ``account_number`` - ``order_type`` - ``asset_type`` - ``action`` - ``time_in_force`` - ``symbol`` - ``order_qty`` They are surfaced as *query* parameters **only to make the accepted fields obvious in the interactive docs**. In production usage you should send these fields inside the JSON body (see ``order_request``) so that the entire order specification travels in one payload. (Nothing will break if you send both, but there is no need to do so.) Body payload & broker-specific extras ------------------------------------- Put the standard parameters plus any broker-specific extensions under the ``order`` key of the body. Refer to the bundled OpenAPI examples below to see complete payloads for common order types (market, limit, spreads, etc.) across supported brokers. For a formal reference of broker-specific extensions inspect the ``BrokerOrderPlaceExtras`` schema. The endpoint resolves the active ``user_broker_connection`` by calling the ``get_user_broker_connection_ids_for_broker`` RPC in Supabase. If no active connection exists it returns a list of *available* brokers so your client can guide the user accordingly. Broker Notes ------------ - The responses that you get back from the broker are not always the same. The response models are validated for each broker, but we do not standardize the repsonses. - Tasty Trade: If you want to trade options for a particular stock, first fetch the full option chain via the GET https://api.tastyworks.com/option-chains/{stock_symbol}/nested endpoint. This endpoint returns all available expirations that tastytrade offers for that equity symbol. Each expiration contains a list of strikes, where each strike has a call and put field representing the call symbol and put symbol respectively. We are planning to add a new endpoint to fetch the option chain for a particular stock and handle this logic for you, but for now you need to fetch the option chain manually.
650
- * @summary Place Order
651
- * @param {BrokersApiPlaceOrderApiV1BrokersOrdersPostRequest} requestParameters Request parameters.
652
- * @param {*} [options] Override http request option.
653
- * @throws {RequiredError}
654
- */
655
- placeOrderApiV1BrokersOrdersPost(requestParameters?: BrokersApiPlaceOrderApiV1BrokersOrdersPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<FinaticResponseOrderActionResult>;
656
- }
657
- /**
658
- * Request parameters for cancelOrderApiV1BrokersOrdersOrderIdDelete operation in BrokersApi.
659
- */
660
- export interface BrokersApiCancelOrderApiV1BrokersOrdersOrderIdDeleteRequest {
661
- readonly orderId: string;
662
- /**
663
- * Account number owning the order
664
- */
665
- readonly accountNumber?: string | null;
666
- /**
667
- * Temporary bypass for testing: specify connection ID directly
668
- */
669
- readonly connectionId?: string | null;
670
- readonly cancelOrderApiV1BrokersOrdersOrderIdDeleteRequest?: CancelOrderApiV1BrokersOrdersOrderIdDeleteRequest | null;
671
- }
672
- /**
673
- * Request parameters for disconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDelete operation in BrokersApi.
674
- */
675
- export interface BrokersApiDisconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDeleteRequest {
676
- readonly connectionId: string;
677
- }
678
- /**
679
- * Request parameters for getAccountsApiV1BrokersDataAccountsGet operation in BrokersApi.
680
- */
681
- export interface BrokersApiGetAccountsApiV1BrokersDataAccountsGetRequest {
682
- /**
683
- * Filter by broker ID
684
- */
685
- readonly brokerId?: string | null;
686
- /**
687
- * Filter by connection ID
688
- */
689
- readonly connectionId?: string | null;
690
- /**
691
- * Filter by account type (e.g., \&#39;margin\&#39;, \&#39;cash\&#39;, \&#39;crypto_wallet\&#39;, \&#39;live\&#39;, \&#39;sim\&#39;)
692
- */
693
- readonly accountType?: PublicAccountTypeEnum | null;
694
- /**
695
- * Filter by account status (e.g., \&#39;active\&#39;, \&#39;inactive\&#39;)
696
- */
697
- readonly status?: AccountStatus | null;
698
- /**
699
- * Filter by currency (e.g., \&#39;USD\&#39;, \&#39;EUR\&#39;)
700
- */
701
- readonly currency?: string | null;
702
- /**
703
- * Maximum number of accounts to return
704
- */
705
- readonly limit?: number;
706
- /**
707
- * Number of accounts to skip for pagination
708
- */
709
- readonly offset?: number;
710
- /**
711
- * Include connection metadata in response
712
- */
713
- readonly withMetadata?: boolean;
714
- }
715
- /**
716
- * Request parameters for getBalancesApiV1BrokersDataBalancesGet operation in BrokersApi.
717
- */
718
- export interface BrokersApiGetBalancesApiV1BrokersDataBalancesGetRequest {
719
- /**
720
- * Filter by broker ID
721
- */
722
- readonly brokerId?: string | null;
723
- /**
724
- * Filter by connection ID
725
- */
726
- readonly connectionId?: string | null;
727
- /**
728
- * Filter by broker provided account ID
729
- */
730
- readonly accountId?: string | null;
731
- /**
732
- * Filter by end-of-day snapshot status (true/false)
733
- */
734
- readonly isEndOfDaySnapshot?: boolean | null;
735
- /**
736
- * Maximum number of balances to return
737
- */
738
- readonly limit?: number;
739
- /**
740
- * Number of balances to skip for pagination
741
- */
742
- readonly offset?: number;
743
- /**
744
- * Filter balances created after this timestamp
745
- */
746
- readonly balanceCreatedAfter?: string | null;
747
- /**
748
- * Filter balances created before this timestamp
749
- */
750
- readonly balanceCreatedBefore?: string | null;
751
- /**
752
- * Include balance metadata in response
753
- */
754
- readonly withMetadata?: boolean;
755
- }
756
- /**
757
- * Request parameters for getOrderEventsApiV1BrokersDataOrdersOrderIdEventsGet operation in BrokersApi.
758
- */
759
- export interface BrokersApiGetOrderEventsApiV1BrokersDataOrdersOrderIdEventsGetRequest {
760
- readonly orderId: string;
761
- /**
762
- * Filter by connection ID
763
- */
764
- readonly connectionId?: string | null;
765
- /**
766
- * Maximum number of events to return
767
- */
768
- readonly limit?: number;
769
- /**
770
- * Number of events to skip for pagination
771
- */
772
- readonly offset?: number;
773
- }
774
- /**
775
- * Request parameters for getOrderFillsApiV1BrokersDataOrdersOrderIdFillsGet operation in BrokersApi.
776
- */
777
- export interface BrokersApiGetOrderFillsApiV1BrokersDataOrdersOrderIdFillsGetRequest {
778
- readonly orderId: string;
779
- /**
780
- * Filter by connection ID
781
- */
782
- readonly connectionId?: string | null;
783
- /**
784
- * Maximum number of fills to return
785
- */
786
- readonly limit?: number;
787
- /**
788
- * Number of fills to skip for pagination
789
- */
790
- readonly offset?: number;
791
- }
792
- /**
793
- * Request parameters for getOrderGroupsApiV1BrokersDataOrdersGroupsGet operation in BrokersApi.
794
- */
795
- export interface BrokersApiGetOrderGroupsApiV1BrokersDataOrdersGroupsGetRequest {
796
- /**
797
- * Filter by broker ID
798
- */
799
- readonly brokerId?: string | null;
800
- /**
801
- * Filter by connection ID
802
- */
803
- readonly connectionId?: string | null;
804
- /**
805
- * Maximum number of order groups to return
806
- */
807
- readonly limit?: number;
808
- /**
809
- * Number of order groups to skip for pagination
810
- */
811
- readonly offset?: number;
812
- /**
813
- * Filter order groups created after this timestamp
814
- */
815
- readonly createdAfter?: string | null;
816
- /**
817
- * Filter order groups created before this timestamp
818
- */
819
- readonly createdBefore?: string | null;
820
- }
821
- /**
822
- * Request parameters for getOrdersApiV1BrokersDataOrdersGet operation in BrokersApi.
823
- */
824
- export interface BrokersApiGetOrdersApiV1BrokersDataOrdersGetRequest {
825
- /**
826
- * Filter by broker ID
827
- */
828
- readonly brokerId?: string | null;
829
- /**
830
- * Filter by connection ID
831
- */
832
- readonly connectionId?: string | null;
833
- /**
834
- * Filter by broker provided account ID
835
- */
836
- readonly accountId?: string | null;
837
- /**
838
- * Filter by symbol
839
- */
840
- readonly symbol?: string | null;
841
- /**
842
- * Filter by order status (e.g., \&#39;filled\&#39;, \&#39;pending_new\&#39;, \&#39;cancelled\&#39;)
843
- */
844
- readonly orderStatus?: PublicOrderStatusEnum | null;
845
- /**
846
- * Filter by order side (e.g., \&#39;buy\&#39;, \&#39;sell\&#39;)
847
- */
848
- readonly side?: PublicOrderSideEnum | null;
849
- /**
850
- * Filter by asset type (e.g., \&#39;stock\&#39;, \&#39;option\&#39;, \&#39;crypto\&#39;, \&#39;future\&#39;)
851
- */
852
- readonly assetType?: PublicAssetTypeEnum | null;
853
- /**
854
- * Maximum number of orders to return
855
- */
856
- readonly limit?: number;
857
- /**
858
- * Number of orders to skip for pagination
859
- */
860
- readonly offset?: number;
861
- /**
862
- * Filter orders created after this timestamp
863
- */
864
- readonly createdAfter?: string | null;
865
- /**
866
- * Filter orders created before this timestamp
867
- */
868
- readonly createdBefore?: string | null;
869
- /**
870
- * Include order metadata in response
871
- */
872
- readonly withMetadata?: boolean;
873
- }
874
- /**
875
- * Request parameters for getPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGet operation in BrokersApi.
876
- */
877
- export interface BrokersApiGetPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGetRequest {
878
- readonly lotId: string;
879
- /**
880
- * Filter by connection ID
881
- */
882
- readonly connectionId?: string | null;
883
- /**
884
- * Maximum number of fills to return
885
- */
886
- readonly limit?: number;
887
- /**
888
- * Number of fills to skip for pagination
889
- */
890
- readonly offset?: number;
891
- }
892
- /**
893
- * Request parameters for getPositionLotsApiV1BrokersDataPositionsLotsGet operation in BrokersApi.
894
- */
895
- export interface BrokersApiGetPositionLotsApiV1BrokersDataPositionsLotsGetRequest {
896
- /**
897
- * Filter by broker ID
898
- */
899
- readonly brokerId?: string | null;
900
- /**
901
- * Filter by connection ID
902
- */
903
- readonly connectionId?: string | null;
904
- /**
905
- * Filter by broker provided account ID
906
- */
907
- readonly accountId?: string | null;
908
- /**
909
- * Filter by symbol
910
- */
911
- readonly symbol?: string | null;
912
- /**
913
- * Filter by position ID
914
- */
915
- readonly positionId?: string | null;
916
- /**
917
- * Maximum number of position lots to return
918
- */
919
- readonly limit?: number;
920
- /**
921
- * Number of position lots to skip for pagination
922
- */
923
- readonly offset?: number;
924
- }
925
- /**
926
- * Request parameters for getPositionsApiV1BrokersDataPositionsGet operation in BrokersApi.
927
- */
928
- export interface BrokersApiGetPositionsApiV1BrokersDataPositionsGetRequest {
929
- /**
930
- * Filter by broker ID
931
- */
932
- readonly brokerId?: string | null;
933
- /**
934
- * Filter by connection ID
935
- */
936
- readonly connectionId?: string | null;
937
- /**
938
- * Filter by broker provided account ID
939
- */
940
- readonly accountId?: string | null;
941
- /**
942
- * Filter by symbol
943
- */
944
- readonly symbol?: string | null;
945
- /**
946
- * Filter by position side (e.g., \&#39;long\&#39;, \&#39;short\&#39;)
947
- */
948
- readonly side?: PublicOrderSideEnum | null;
949
- /**
950
- * Filter by asset type (e.g., \&#39;stock\&#39;, \&#39;option\&#39;, \&#39;crypto\&#39;, \&#39;future\&#39;)
951
- */
952
- readonly assetType?: PublicAssetTypeEnum | null;
953
- /**
954
- * Filter by position status: \&#39;open\&#39; (quantity &gt; 0) or \&#39;closed\&#39; (quantity &#x3D; 0)
955
- */
956
- readonly positionStatus?: PublicPositionStatusEnum | null;
957
- /**
958
- * Maximum number of positions to return
959
- */
960
- readonly limit?: number;
961
- /**
962
- * Number of positions to skip for pagination
963
- */
964
- readonly offset?: number;
965
- /**
966
- * Filter positions updated after this timestamp
967
- */
968
- readonly updatedAfter?: string | null;
969
- /**
970
- * Filter positions updated before this timestamp
971
- */
972
- readonly updatedBefore?: string | null;
973
- /**
974
- * Include position metadata in response
975
- */
976
- readonly withMetadata?: boolean;
977
- }
978
- /**
979
- * Request parameters for modifyOrderApiV1BrokersOrdersOrderIdPatch operation in BrokersApi.
980
- */
981
- export interface BrokersApiModifyOrderApiV1BrokersOrdersOrderIdPatchRequest {
982
- readonly orderId: string;
983
- /**
984
- * Account number owning the order
985
- */
986
- readonly accountNumber?: string | null;
987
- /**
988
- * Temporary bypass for testing: specify connection ID directly
989
- */
990
- readonly connectionId?: string | null;
991
- readonly modifyOrderApiV1BrokersOrdersOrderIdPatchRequest?: ModifyOrderApiV1BrokersOrdersOrderIdPatchRequest | null;
992
- }
993
- /**
994
- * Request parameters for placeOrderApiV1BrokersOrdersPost operation in BrokersApi.
995
- */
996
- export interface BrokersApiPlaceOrderApiV1BrokersOrdersPostRequest {
997
- /**
998
- * Temporary bypass for testing: specify connection ID directly
999
- */
1000
- readonly connectionId?: string | null;
1001
- readonly placeOrderApiV1BrokersOrdersPostRequest?: PlaceOrderApiV1BrokersOrdersPostRequest | null;
1002
- }
1003
- /**
1004
- * BrokersApi - object-oriented interface
1005
- */
1006
- export declare class BrokersApi extends BaseAPI implements BrokersApiInterface {
1007
- /**
1008
- * Cancel an existing order. This endpoint is accessible from the portal and uses session-only authentication. Requires trading permissions for the company.
1009
- * @summary Cancel Order
1010
- * @param {BrokersApiCancelOrderApiV1BrokersOrdersOrderIdDeleteRequest} requestParameters Request parameters.
1011
- * @param {*} [options] Override http request option.
1012
- * @throws {RequiredError}
1013
- */
1014
- cancelOrderApiV1BrokersOrdersOrderIdDelete(requestParameters: BrokersApiCancelOrderApiV1BrokersOrdersOrderIdDeleteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FinaticResponseOrderActionResult, any, {}>>;
1015
- /**
1016
- * Remove a company\'s access to a broker connection. If the company is the only one with access, the entire connection is deleted. If other companies have access, only the company\'s access is removed.
1017
- * @summary Disconnect Company From Broker
1018
- * @param {BrokersApiDisconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDeleteRequest} requestParameters Request parameters.
1019
- * @param {*} [options] Override http request option.
1020
- * @throws {RequiredError}
1021
- */
1022
- disconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDelete(requestParameters: BrokersApiDisconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDeleteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FinaticResponseDisconnectActionResult, any, {}>>;
1023
- /**
1024
- * Get accounts for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns accounts from connections the company has read access to.
1025
- * @summary Get Accounts
1026
- * @param {BrokersApiGetAccountsApiV1BrokersDataAccountsGetRequest} requestParameters Request parameters.
1027
- * @param {*} [options] Override http request option.
1028
- * @throws {RequiredError}
1029
- */
1030
- getAccountsApiV1BrokersDataAccountsGet(requestParameters?: BrokersApiGetAccountsApiV1BrokersDataAccountsGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FinaticResponseListAccounts, any, {}>>;
1031
- /**
1032
- * Get balances for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns balances from connections the company has read access to.
1033
- * @summary Get Balances
1034
- * @param {BrokersApiGetBalancesApiV1BrokersDataBalancesGetRequest} requestParameters Request parameters.
1035
- * @param {*} [options] Override http request option.
1036
- * @throws {RequiredError}
1037
- */
1038
- getBalancesApiV1BrokersDataBalancesGet(requestParameters?: BrokersApiGetBalancesApiV1BrokersDataBalancesGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FinaticResponseListBalances, any, {}>>;
1039
- /**
1040
- * Get all available brokers. This is a fast operation that returns a cached list of available brokers. The list is loaded once at startup and never changes during runtime. Returns ------- FinaticResponse[list[BrokerInfo]] list of available brokers with their metadata.
1041
- * @summary Get Brokers
1042
- * @param {*} [options] Override http request option.
1043
- * @throws {RequiredError}
1044
- */
1045
- getBrokersApiV1BrokersGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FinaticResponseListBrokerInfo, any, {}>>;
1046
- /**
1047
- * Get order events for a specific order. This endpoint returns all lifecycle events for the specified order.
1048
- * @summary Get Order Events
1049
- * @param {BrokersApiGetOrderEventsApiV1BrokersDataOrdersOrderIdEventsGetRequest} requestParameters Request parameters.
1050
- * @param {*} [options] Override http request option.
1051
- * @throws {RequiredError}
1052
- */
1053
- getOrderEventsApiV1BrokersDataOrdersOrderIdEventsGet(requestParameters: BrokersApiGetOrderEventsApiV1BrokersDataOrdersOrderIdEventsGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FinaticResponseListOrderEventResponse, any, {}>>;
1054
- /**
1055
- * Get order fills for a specific order. This endpoint returns all execution fills for the specified order.
1056
- * @summary Get Order Fills
1057
- * @param {BrokersApiGetOrderFillsApiV1BrokersDataOrdersOrderIdFillsGetRequest} requestParameters Request parameters.
1058
- * @param {*} [options] Override http request option.
1059
- * @throws {RequiredError}
1060
- */
1061
- getOrderFillsApiV1BrokersDataOrdersOrderIdFillsGet(requestParameters: BrokersApiGetOrderFillsApiV1BrokersDataOrdersOrderIdFillsGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FinaticResponseListOrderFillResponse, any, {}>>;
1062
- /**
1063
- * Get order groups. This endpoint returns order groups that contain multiple orders.
1064
- * @summary Get Order Groups
1065
- * @param {BrokersApiGetOrderGroupsApiV1BrokersDataOrdersGroupsGetRequest} requestParameters Request parameters.
1066
- * @param {*} [options] Override http request option.
1067
- * @throws {RequiredError}
1068
- */
1069
- getOrderGroupsApiV1BrokersDataOrdersGroupsGet(requestParameters?: BrokersApiGetOrderGroupsApiV1BrokersDataOrdersGroupsGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FinaticResponseListOrderGroupResponse, any, {}>>;
1070
- /**
1071
- * Get orders for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns orders from connections the company has read access to.
1072
- * @summary Get Orders
1073
- * @param {BrokersApiGetOrdersApiV1BrokersDataOrdersGetRequest} requestParameters Request parameters.
1074
- * @param {*} [options] Override http request option.
1075
- * @throws {RequiredError}
1076
- */
1077
- getOrdersApiV1BrokersDataOrdersGet(requestParameters?: BrokersApiGetOrdersApiV1BrokersDataOrdersGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FinaticResponseListOrderResponse, any, {}>>;
1078
- /**
1079
- * Get position lot fills for a specific lot. This endpoint returns all fills associated with a specific position lot.
1080
- * @summary Get Position Lot Fills
1081
- * @param {BrokersApiGetPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGetRequest} requestParameters Request parameters.
1082
- * @param {*} [options] Override http request option.
1083
- * @throws {RequiredError}
1084
- */
1085
- getPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGet(requestParameters: BrokersApiGetPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FinaticResponseListPositionLotFillResponse, any, {}>>;
1086
- /**
1087
- * Get position lots (tax lots for positions). This endpoint returns tax lots for positions, which are used for tax reporting. Each lot tracks when a position was opened/closed and at what prices.
1088
- * @summary Get Position Lots
1089
- * @param {BrokersApiGetPositionLotsApiV1BrokersDataPositionsLotsGetRequest} requestParameters Request parameters.
1090
- * @param {*} [options] Override http request option.
1091
- * @throws {RequiredError}
1092
- */
1093
- getPositionLotsApiV1BrokersDataPositionsLotsGet(requestParameters?: BrokersApiGetPositionLotsApiV1BrokersDataPositionsLotsGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FinaticResponseListPositionLotResponse, any, {}>>;
1094
- /**
1095
- * Get positions for all authorized broker connections. This endpoint is accessible from the portal and uses session-only authentication. Returns positions from connections the company has read access to.
1096
- * @summary Get Positions
1097
- * @param {BrokersApiGetPositionsApiV1BrokersDataPositionsGetRequest} requestParameters Request parameters.
1098
- * @param {*} [options] Override http request option.
1099
- * @throws {RequiredError}
1100
- */
1101
- getPositionsApiV1BrokersDataPositionsGet(requestParameters?: BrokersApiGetPositionsApiV1BrokersDataPositionsGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FinaticResponseListPositionResponse, any, {}>>;
1102
- /**
1103
- * List all broker connections for the current user. This endpoint is accessible from the portal and uses session-only authentication. Returns connections that the user has any permissions for.
1104
- * @summary List Broker Connections
1105
- * @param {*} [options] Override http request option.
1106
- * @throws {RequiredError}
1107
- */
1108
- listBrokerConnectionsApiV1BrokersConnectionsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FinaticResponseListUserBrokerConnections, any, {}>>;
1109
- /**
1110
- * Modify an existing order. This endpoint is accessible from the portal and uses session-only authentication. Requires trading permissions for the company.
1111
- * @summary Modify Order
1112
- * @param {BrokersApiModifyOrderApiV1BrokersOrdersOrderIdPatchRequest} requestParameters Request parameters.
1113
- * @param {*} [options] Override http request option.
1114
- * @throws {RequiredError}
1115
- */
1116
- modifyOrderApiV1BrokersOrdersOrderIdPatch(requestParameters: BrokersApiModifyOrderApiV1BrokersOrdersOrderIdPatchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FinaticResponseOrderActionResult, any, {}>>;
1117
- /**
1118
- * Create a new order via the specified broker connection. This endpoint is accessible from the portal and uses session-only authentication. Requires trading permissions for the company. Standard parameters ------------------- The following fields constitute the unified Finatic *common order schema* and therefore appear individually as query parameters in the autogenerated OpenAPI documentation: - ``broker`` - ``account_number`` - ``order_type`` - ``asset_type`` - ``action`` - ``time_in_force`` - ``symbol`` - ``order_qty`` They are surfaced as *query* parameters **only to make the accepted fields obvious in the interactive docs**. In production usage you should send these fields inside the JSON body (see ``order_request``) so that the entire order specification travels in one payload. (Nothing will break if you send both, but there is no need to do so.) Body payload & broker-specific extras ------------------------------------- Put the standard parameters plus any broker-specific extensions under the ``order`` key of the body. Refer to the bundled OpenAPI examples below to see complete payloads for common order types (market, limit, spreads, etc.) across supported brokers. For a formal reference of broker-specific extensions inspect the ``BrokerOrderPlaceExtras`` schema. The endpoint resolves the active ``user_broker_connection`` by calling the ``get_user_broker_connection_ids_for_broker`` RPC in Supabase. If no active connection exists it returns a list of *available* brokers so your client can guide the user accordingly. Broker Notes ------------ - The responses that you get back from the broker are not always the same. The response models are validated for each broker, but we do not standardize the repsonses. - Tasty Trade: If you want to trade options for a particular stock, first fetch the full option chain via the GET https://api.tastyworks.com/option-chains/{stock_symbol}/nested endpoint. This endpoint returns all available expirations that tastytrade offers for that equity symbol. Each expiration contains a list of strikes, where each strike has a call and put field representing the call symbol and put symbol respectively. We are planning to add a new endpoint to fetch the option chain for a particular stock and handle this logic for you, but for now you need to fetch the option chain manually.
1119
- * @summary Place Order
1120
- * @param {BrokersApiPlaceOrderApiV1BrokersOrdersPostRequest} requestParameters Request parameters.
1121
- * @param {*} [options] Override http request option.
1122
- * @throws {RequiredError}
1123
- */
1124
- placeOrderApiV1BrokersOrdersPost(requestParameters?: BrokersApiPlaceOrderApiV1BrokersOrdersPostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FinaticResponseOrderActionResult, any, {}>>;
1125
- }
1126
- //# sourceMappingURL=brokers-api.d.ts.map