snaptrade-typescript-sdk 9.0.199 → 10.0.1

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 (427) hide show
  1. package/README.md +42 -2
  2. package/dist/chunk-e9Ob2GDo.mjs +26 -0
  3. package/dist/index.cjs +6594 -0
  4. package/dist/index.cjs.map +1 -0
  5. package/dist/index.d.cts +1 -0
  6. package/dist/index.d.mts +10422 -0
  7. package/dist/index.d.ts +1 -5
  8. package/dist/index.mjs +6527 -0
  9. package/dist/index.mjs.map +1 -0
  10. package/package.json +27 -13
  11. package/dist/api/account-information-api-generated.d.ts +0 -950
  12. package/dist/api/account-information-api-generated.js +0 -1372
  13. package/dist/api/account-information-api.d.ts +0 -4
  14. package/dist/api/account-information-api.js +0 -22
  15. package/dist/api/api-status-api-generated.d.ts +0 -59
  16. package/dist/api/api-status-api-generated.js +0 -133
  17. package/dist/api/api-status-api.d.ts +0 -4
  18. package/dist/api/api-status-api.js +0 -22
  19. package/dist/api/authentication-api-generated.d.ts +0 -241
  20. package/dist/api/authentication-api-generated.js +0 -482
  21. package/dist/api/authentication-api.d.ts +0 -4
  22. package/dist/api/authentication-api.js +0 -22
  23. package/dist/api/connections-api-generated.d.ts +0 -576
  24. package/dist/api/connections-api-generated.js +0 -868
  25. package/dist/api/connections-api.d.ts +0 -4
  26. package/dist/api/connections-api.js +0 -22
  27. package/dist/api/options-api-generated.d.ts +0 -90
  28. package/dist/api/options-api-generated.js +0 -158
  29. package/dist/api/options-api.d.ts +0 -4
  30. package/dist/api/options-api.js +0 -22
  31. package/dist/api/reference-data-api-generated.d.ts +0 -497
  32. package/dist/api/reference-data-api-generated.js +0 -973
  33. package/dist/api/reference-data-api.d.ts +0 -4
  34. package/dist/api/reference-data-api.js +0 -22
  35. package/dist/api/trading-api-generated.d.ts +0 -1054
  36. package/dist/api/trading-api-generated.js +0 -1684
  37. package/dist/api/trading-api.d.ts +0 -4
  38. package/dist/api/trading-api.js +0 -22
  39. package/dist/api/transactions-and-reporting-api-generated.d.ts +0 -215
  40. package/dist/api/transactions-and-reporting-api-generated.js +0 -299
  41. package/dist/api/transactions-and-reporting-api.d.ts +0 -4
  42. package/dist/api/transactions-and-reporting-api.js +0 -22
  43. package/dist/api.d.ts +0 -8
  44. package/dist/api.js +0 -36
  45. package/dist/base.d.ts +0 -44
  46. package/dist/base.js +0 -60
  47. package/dist/browser.js +0 -2
  48. package/dist/browser.js.LICENSE.txt +0 -1
  49. package/dist/client-custom.d.ts +0 -4
  50. package/dist/client-custom.js +0 -7
  51. package/dist/client.d.ts +0 -14
  52. package/dist/client.js +0 -31
  53. package/dist/common.d.ts +0 -61
  54. package/dist/common.js +0 -220
  55. package/dist/configuration.d.ts +0 -98
  56. package/dist/configuration.js +0 -53
  57. package/dist/error.d.ts +0 -46
  58. package/dist/error.js +0 -105
  59. package/dist/index.js +0 -33
  60. package/dist/jest.config.d.ts +0 -3
  61. package/dist/jest.config.js +0 -13
  62. package/dist/mock.test.d.ts +0 -1
  63. package/dist/mock.test.js +0 -29
  64. package/dist/models/account-balance-total.d.ts +0 -19
  65. package/dist/models/account-balance-total.js +0 -2
  66. package/dist/models/account-balance.d.ts +0 -14
  67. package/dist/models/account-balance.js +0 -2
  68. package/dist/models/account-holdings-account.d.ts +0 -51
  69. package/dist/models/account-holdings-account.js +0 -2
  70. package/dist/models/account-holdings.d.ts +0 -37
  71. package/dist/models/account-holdings.js +0 -2
  72. package/dist/models/account-information-get-user-account-order-detail-request.d.ts +0 -13
  73. package/dist/models/account-information-get-user-account-order-detail-request.js +0 -2
  74. package/dist/models/account-order-record-child-brokerage-order-ids.d.ts +0 -19
  75. package/dist/models/account-order-record-child-brokerage-order-ids.js +0 -2
  76. package/dist/models/account-order-record-leg-instrument.d.ts +0 -38
  77. package/dist/models/account-order-record-leg-instrument.js +0 -2
  78. package/dist/models/account-order-record-leg.d.ts +0 -58
  79. package/dist/models/account-order-record-leg.js +0 -2
  80. package/dist/models/account-order-record-option-symbol.d.ts +0 -52
  81. package/dist/models/account-order-record-option-symbol.js +0 -2
  82. package/dist/models/account-order-record-quote-currency.d.ts +0 -25
  83. package/dist/models/account-order-record-quote-currency.js +0 -2
  84. package/dist/models/account-order-record-quote-universal-symbol.d.ts +0 -73
  85. package/dist/models/account-order-record-quote-universal-symbol.js +0 -2
  86. package/dist/models/account-order-record-status-v2.d.ts +0 -6
  87. package/dist/models/account-order-record-status-v2.js +0 -2
  88. package/dist/models/account-order-record-status.d.ts +0 -6
  89. package/dist/models/account-order-record-status.js +0 -2
  90. package/dist/models/account-order-record-trailing-stop.d.ts +0 -21
  91. package/dist/models/account-order-record-trailing-stop.js +0 -2
  92. package/dist/models/account-order-record-universal-symbol.d.ts +0 -73
  93. package/dist/models/account-order-record-universal-symbol.js +0 -2
  94. package/dist/models/account-order-record-v2.d.ts +0 -97
  95. package/dist/models/account-order-record-v2.js +0 -2
  96. package/dist/models/account-order-record.d.ts +0 -168
  97. package/dist/models/account-order-record.js +0 -2
  98. package/dist/models/account-orders-v2-response.d.ts +0 -15
  99. package/dist/models/account-orders-v2-response.js +0 -2
  100. package/dist/models/account-position.d.ts +0 -52
  101. package/dist/models/account-position.js +0 -2
  102. package/dist/models/account-simple.d.ts +0 -39
  103. package/dist/models/account-simple.js +0 -2
  104. package/dist/models/account-sync-status.d.ts +0 -21
  105. package/dist/models/account-sync-status.js +0 -2
  106. package/dist/models/account-universal-activity-currency.d.ts +0 -25
  107. package/dist/models/account-universal-activity-currency.js +0 -2
  108. package/dist/models/account-universal-activity-option-symbol.d.ts +0 -52
  109. package/dist/models/account-universal-activity-option-symbol.js +0 -2
  110. package/dist/models/account-universal-activity-symbol.d.ts +0 -65
  111. package/dist/models/account-universal-activity-symbol.js +0 -2
  112. package/dist/models/account-universal-activity.d.ts +0 -107
  113. package/dist/models/account-universal-activity.js +0 -2
  114. package/dist/models/account-value-history-item.d.ts +0 -20
  115. package/dist/models/account-value-history-item.js +0 -2
  116. package/dist/models/account-value-history-response.d.ts +0 -21
  117. package/dist/models/account-value-history-response.js +0 -2
  118. package/dist/models/account.d.ts +0 -126
  119. package/dist/models/account.js +0 -2
  120. package/dist/models/action-strict-with-options.d.ts +0 -6
  121. package/dist/models/action-strict-with-options.js +0 -2
  122. package/dist/models/action-strict.d.ts +0 -6
  123. package/dist/models/action-strict.js +0 -2
  124. package/dist/models/adr-instrument.d.ts +0 -59
  125. package/dist/models/adr-instrument.js +0 -2
  126. package/dist/models/all-account-positions-response.d.ts +0 -15
  127. package/dist/models/all-account-positions-response.js +0 -2
  128. package/dist/models/authentication-login-snap-trade-user200-response.d.ts +0 -7
  129. package/dist/models/authentication-login-snap-trade-user200-response.js +0 -2
  130. package/dist/models/balance-currency.d.ts +0 -25
  131. package/dist/models/balance-currency.js +0 -2
  132. package/dist/models/balance.d.ts +0 -27
  133. package/dist/models/balance.js +0 -2
  134. package/dist/models/brokerage-authorization-disabled-confirmation.d.ts +0 -14
  135. package/dist/models/brokerage-authorization-disabled-confirmation.js +0 -2
  136. package/dist/models/brokerage-authorization-refresh-confirmation.d.ts +0 -14
  137. package/dist/models/brokerage-authorization-refresh-confirmation.js +0 -2
  138. package/dist/models/brokerage-authorization-transactions-sync-confirmation.d.ts +0 -14
  139. package/dist/models/brokerage-authorization-transactions-sync-confirmation.js +0 -2
  140. package/dist/models/brokerage-authorization-type-read-only-brokerage.d.ts +0 -26
  141. package/dist/models/brokerage-authorization-type-read-only-brokerage.js +0 -2
  142. package/dist/models/brokerage-authorization-type-read-only.d.ts +0 -36
  143. package/dist/models/brokerage-authorization-type-read-only.js +0 -2
  144. package/dist/models/brokerage-authorization.d.ts +0 -73
  145. package/dist/models/brokerage-authorization.js +0 -2
  146. package/dist/models/brokerage-instrument.d.ts +0 -38
  147. package/dist/models/brokerage-instrument.js +0 -2
  148. package/dist/models/brokerage-instruments-response.d.ts +0 -15
  149. package/dist/models/brokerage-instruments-response.js +0 -2
  150. package/dist/models/brokerage-type.d.ts +0 -20
  151. package/dist/models/brokerage-type.js +0 -2
  152. package/dist/models/brokerage.d.ts +0 -122
  153. package/dist/models/brokerage.js +0 -2
  154. package/dist/models/cancel-order-response.d.ts +0 -22
  155. package/dist/models/cancel-order-response.js +0 -2
  156. package/dist/models/cef-instrument.d.ts +0 -59
  157. package/dist/models/cef-instrument.js +0 -2
  158. package/dist/models/child-brokerage-order-ids.d.ts +0 -20
  159. package/dist/models/child-brokerage-order-ids.js +0 -2
  160. package/dist/models/complex-order-leg.d.ts +0 -62
  161. package/dist/models/complex-order-leg.js +0 -2
  162. package/dist/models/complex-order-response.d.ts +0 -22
  163. package/dist/models/complex-order-response.js +0 -2
  164. package/dist/models/connections-session-events200-response-inner.d.ts +0 -6
  165. package/dist/models/connections-session-events200-response-inner.js +0 -2
  166. package/dist/models/crypto-instrument.d.ts +0 -59
  167. package/dist/models/crypto-instrument.js +0 -2
  168. package/dist/models/crypto-order-form.d.ts +0 -66
  169. package/dist/models/crypto-order-form.js +0 -2
  170. package/dist/models/crypto-order-preview-estimated-fee.d.ts +0 -20
  171. package/dist/models/crypto-order-preview-estimated-fee.js +0 -2
  172. package/dist/models/crypto-order-preview.d.ts +0 -15
  173. package/dist/models/crypto-order-preview.js +0 -2
  174. package/dist/models/crypto-trading-instrument.d.ts +0 -22
  175. package/dist/models/crypto-trading-instrument.js +0 -2
  176. package/dist/models/cryptocurrency-pair-quote.d.ts +0 -32
  177. package/dist/models/cryptocurrency-pair-quote.js +0 -2
  178. package/dist/models/cryptocurrency-pair.d.ts +0 -32
  179. package/dist/models/cryptocurrency-pair.js +0 -2
  180. package/dist/models/currency.d.ts +0 -26
  181. package/dist/models/currency.js +0 -2
  182. package/dist/models/delete-connection-confirmation.d.ts +0 -20
  183. package/dist/models/delete-connection-confirmation.js +0 -2
  184. package/dist/models/delete-user-response.d.ts +0 -26
  185. package/dist/models/delete-user-response.js +0 -2
  186. package/dist/models/dividend-at-date.d.ts +0 -26
  187. package/dist/models/dividend-at-date.js +0 -2
  188. package/dist/models/encrypted-response-encrypted-message-data.d.ts +0 -26
  189. package/dist/models/encrypted-response-encrypted-message-data.js +0 -2
  190. package/dist/models/encrypted-response.d.ts +0 -20
  191. package/dist/models/encrypted-response.js +0 -2
  192. package/dist/models/etf-instrument.d.ts +0 -59
  193. package/dist/models/etf-instrument.js +0 -2
  194. package/dist/models/exchange-rate-pairs.d.ts +0 -27
  195. package/dist/models/exchange-rate-pairs.js +0 -2
  196. package/dist/models/exchange.d.ts +0 -56
  197. package/dist/models/exchange.js +0 -2
  198. package/dist/models/figi-instrument.d.ts +0 -20
  199. package/dist/models/figi-instrument.js +0 -2
  200. package/dist/models/future-instrument.d.ts +0 -64
  201. package/dist/models/future-instrument.js +0 -2
  202. package/dist/models/holdings-status.d.ts +0 -19
  203. package/dist/models/holdings-status.js +0 -2
  204. package/dist/models/index.d.ts +0 -173
  205. package/dist/models/index.js +0 -189
  206. package/dist/models/instrument.d.ts +0 -33
  207. package/dist/models/instrument.js +0 -2
  208. package/dist/models/login-redirect-uri.d.ts +0 -19
  209. package/dist/models/login-redirect-uri.js +0 -2
  210. package/dist/models/manual-trade-and-impact.d.ts +0 -29
  211. package/dist/models/manual-trade-and-impact.js +0 -2
  212. package/dist/models/manual-trade-balance.d.ts +0 -28
  213. package/dist/models/manual-trade-balance.js +0 -2
  214. package/dist/models/manual-trade-form-bracket.d.ts +0 -67
  215. package/dist/models/manual-trade-form-bracket.js +0 -2
  216. package/dist/models/manual-trade-form-complex.d.ts +0 -28
  217. package/dist/models/manual-trade-form-complex.js +0 -2
  218. package/dist/models/manual-trade-form-notional-value.d.ts +0 -6
  219. package/dist/models/manual-trade-form-notional-value.js +0 -2
  220. package/dist/models/manual-trade-form-with-options.d.ts +0 -78
  221. package/dist/models/manual-trade-form-with-options.js +0 -2
  222. package/dist/models/manual-trade-form.d.ts +0 -65
  223. package/dist/models/manual-trade-form.js +0 -2
  224. package/dist/models/manual-trade-impact.d.ts +0 -38
  225. package/dist/models/manual-trade-impact.js +0 -2
  226. package/dist/models/manual-trade-replace-form.d.ts +0 -58
  227. package/dist/models/manual-trade-replace-form.js +0 -2
  228. package/dist/models/manual-trade-symbol.d.ts +0 -49
  229. package/dist/models/manual-trade-symbol.js +0 -2
  230. package/dist/models/manual-trade.d.ts +0 -60
  231. package/dist/models/manual-trade.js +0 -2
  232. package/dist/models/mleg-action-strict.d.ts +0 -6
  233. package/dist/models/mleg-action-strict.js +0 -2
  234. package/dist/models/mleg-instrument-type.d.ts +0 -6
  235. package/dist/models/mleg-instrument-type.js +0 -2
  236. package/dist/models/mleg-leg.d.ts +0 -28
  237. package/dist/models/mleg-leg.js +0 -2
  238. package/dist/models/mleg-order-response.d.ts +0 -21
  239. package/dist/models/mleg-order-response.js +0 -2
  240. package/dist/models/mleg-order-type-strict.d.ts +0 -6
  241. package/dist/models/mleg-order-type-strict.js +0 -2
  242. package/dist/models/mleg-price-effect-strict.d.ts +0 -6
  243. package/dist/models/mleg-price-effect-strict.js +0 -2
  244. package/dist/models/mleg-trade-form.d.ts +0 -47
  245. package/dist/models/mleg-trade-form.js +0 -2
  246. package/dist/models/mleg-trading-instrument.d.ts +0 -21
  247. package/dist/models/mleg-trading-instrument.js +0 -2
  248. package/dist/models/model400-failed-request-response.d.ts +0 -20
  249. package/dist/models/model400-failed-request-response.js +0 -2
  250. package/dist/models/model401-failed-request-response.d.ts +0 -20
  251. package/dist/models/model401-failed-request-response.js +0 -2
  252. package/dist/models/model402-brokerage-auth-already-disabled-exception.d.ts +0 -20
  253. package/dist/models/model402-brokerage-auth-already-disabled-exception.js +0 -2
  254. package/dist/models/model402-brokerage-auth-disabled-response.d.ts +0 -20
  255. package/dist/models/model402-brokerage-auth-disabled-response.js +0 -2
  256. package/dist/models/model403-failed-request-response.d.ts +0 -20
  257. package/dist/models/model403-failed-request-response.js +0 -2
  258. package/dist/models/model403-feature-not-enabled-response.d.ts +0 -20
  259. package/dist/models/model403-feature-not-enabled-response.js +0 -2
  260. package/dist/models/model404-failed-request-response.d.ts +0 -20
  261. package/dist/models/model404-failed-request-response.js +0 -2
  262. package/dist/models/model425-failed-request-response.d.ts +0 -20
  263. package/dist/models/model425-failed-request-response.js +0 -2
  264. package/dist/models/model500-unexpected-exception-response.d.ts +0 -26
  265. package/dist/models/model500-unexpected-exception-response.js +0 -2
  266. package/dist/models/monthly-dividends.d.ts +0 -21
  267. package/dist/models/monthly-dividends.js +0 -2
  268. package/dist/models/mutual-fund-instrument.d.ts +0 -59
  269. package/dist/models/mutual-fund-instrument.js +0 -2
  270. package/dist/models/net-contributions.d.ts +0 -26
  271. package/dist/models/net-contributions.js +0 -2
  272. package/dist/models/net-dividend.d.ts +0 -27
  273. package/dist/models/net-dividend.js +0 -2
  274. package/dist/models/notional-value.d.ts +0 -6
  275. package/dist/models/notional-value.js +0 -2
  276. package/dist/models/option-brokerage-symbol.d.ts +0 -29
  277. package/dist/models/option-brokerage-symbol.js +0 -2
  278. package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.d.ts +0 -26
  279. package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.js +0 -2
  280. package/dist/models/option-chain-inner-chain-per-root-inner.d.ts +0 -27
  281. package/dist/models/option-chain-inner-chain-per-root-inner.js +0 -2
  282. package/dist/models/option-chain-inner.d.ts +0 -39
  283. package/dist/models/option-chain-inner.js +0 -2
  284. package/dist/models/option-impact.d.ts +0 -28
  285. package/dist/models/option-impact.js +0 -2
  286. package/dist/models/option-instrument.d.ts +0 -60
  287. package/dist/models/option-instrument.js +0 -2
  288. package/dist/models/option-leg.d.ts +0 -28
  289. package/dist/models/option-leg.js +0 -2
  290. package/dist/models/option-quote-greeks.d.ts +0 -32
  291. package/dist/models/option-quote-greeks.js +0 -2
  292. package/dist/models/option-quote.d.ts +0 -39
  293. package/dist/models/option-quote.js +0 -2
  294. package/dist/models/option-strategy-legs-inner.d.ts +0 -31
  295. package/dist/models/option-strategy-legs-inner.js +0 -2
  296. package/dist/models/option-strategy.d.ts +0 -40
  297. package/dist/models/option-strategy.js +0 -2
  298. package/dist/models/options-position-currency.d.ts +0 -25
  299. package/dist/models/options-position-currency.js +0 -2
  300. package/dist/models/options-position.d.ts +0 -41
  301. package/dist/models/options-position.js +0 -2
  302. package/dist/models/options-symbol.d.ts +0 -53
  303. package/dist/models/options-symbol.js +0 -2
  304. package/dist/models/order-type-strict.d.ts +0 -6
  305. package/dist/models/order-type-strict.js +0 -2
  306. package/dist/models/order-updated-response-order.d.ts +0 -167
  307. package/dist/models/order-updated-response-order.js +0 -2
  308. package/dist/models/order-updated-response.d.ts +0 -21
  309. package/dist/models/order-updated-response.js +0 -2
  310. package/dist/models/other-instrument.d.ts +0 -59
  311. package/dist/models/other-instrument.js +0 -2
  312. package/dist/models/paginated-universal-activity.d.ts +0 -22
  313. package/dist/models/paginated-universal-activity.js +0 -2
  314. package/dist/models/pagination-details.d.ts +0 -26
  315. package/dist/models/pagination-details.js +0 -2
  316. package/dist/models/partner-data.d.ts +0 -82
  317. package/dist/models/partner-data.js +0 -2
  318. package/dist/models/past-value.d.ts +0 -26
  319. package/dist/models/past-value.js +0 -2
  320. package/dist/models/performance-custom.d.ts +0 -127
  321. package/dist/models/performance-custom.js +0 -2
  322. package/dist/models/position-currency.d.ts +0 -25
  323. package/dist/models/position-currency.js +0 -2
  324. package/dist/models/position-symbol.d.ts +0 -50
  325. package/dist/models/position-symbol.js +0 -2
  326. package/dist/models/position.d.ts +0 -66
  327. package/dist/models/position.js +0 -2
  328. package/dist/models/rate-of-return-object.d.ts +0 -28
  329. package/dist/models/rate-of-return-object.js +0 -2
  330. package/dist/models/rate-of-return-response.d.ts +0 -15
  331. package/dist/models/rate-of-return-response.js +0 -2
  332. package/dist/models/recent-orders-response.d.ts +0 -15
  333. package/dist/models/recent-orders-response.js +0 -2
  334. package/dist/models/security-type.d.ts +0 -33
  335. package/dist/models/security-type.js +0 -2
  336. package/dist/models/session-event.d.ts +0 -52
  337. package/dist/models/session-event.js +0 -2
  338. package/dist/models/simple-order-form.d.ts +0 -67
  339. package/dist/models/simple-order-form.js +0 -2
  340. package/dist/models/snap-trade-holdings-account.d.ts +0 -60
  341. package/dist/models/snap-trade-holdings-account.js +0 -2
  342. package/dist/models/snap-trade-holdings-total-value.d.ts +0 -20
  343. package/dist/models/snap-trade-holdings-total-value.js +0 -2
  344. package/dist/models/snap-trade-login-user-request-body.d.ts +0 -58
  345. package/dist/models/snap-trade-login-user-request-body.js +0 -2
  346. package/dist/models/snap-trade-register-user-request-body.d.ts +0 -13
  347. package/dist/models/snap-trade-register-user-request-body.js +0 -2
  348. package/dist/models/status.d.ts +0 -26
  349. package/dist/models/status.js +0 -2
  350. package/dist/models/stock-instrument-figi-instrument.d.ts +0 -19
  351. package/dist/models/stock-instrument-figi-instrument.js +0 -2
  352. package/dist/models/stock-instrument.d.ts +0 -59
  353. package/dist/models/stock-instrument.js +0 -2
  354. package/dist/models/stop-loss.d.ts +0 -20
  355. package/dist/models/stop-loss.js +0 -2
  356. package/dist/models/strategy-order-record.d.ts +0 -77
  357. package/dist/models/strategy-order-record.js +0 -2
  358. package/dist/models/strategy-quotes-greek.d.ts +0 -38
  359. package/dist/models/strategy-quotes-greek.js +0 -2
  360. package/dist/models/strategy-quotes.d.ts +0 -46
  361. package/dist/models/strategy-quotes.js +0 -2
  362. package/dist/models/sub-period-return-rate.d.ts +0 -26
  363. package/dist/models/sub-period-return-rate.js +0 -2
  364. package/dist/models/symbol-currency.d.ts +0 -25
  365. package/dist/models/symbol-currency.js +0 -2
  366. package/dist/models/symbol-exchange.d.ts +0 -55
  367. package/dist/models/symbol-exchange.js +0 -2
  368. package/dist/models/symbol-query.d.ts +0 -13
  369. package/dist/models/symbol-query.js +0 -2
  370. package/dist/models/symbol.d.ts +0 -66
  371. package/dist/models/symbol.js +0 -2
  372. package/dist/models/symbols-quotes-inner.d.ts +0 -44
  373. package/dist/models/symbols-quotes-inner.js +0 -2
  374. package/dist/models/take-profit.d.ts +0 -14
  375. package/dist/models/take-profit.js +0 -2
  376. package/dist/models/tax-lot.d.ts +0 -50
  377. package/dist/models/tax-lot.js +0 -2
  378. package/dist/models/time-in-force-strict.d.ts +0 -6
  379. package/dist/models/time-in-force-strict.js +0 -2
  380. package/dist/models/trade-detection-cancel-subscription-response.d.ts +0 -14
  381. package/dist/models/trade-detection-cancel-subscription-response.js +0 -2
  382. package/dist/models/trade-detection-subscription.d.ts +0 -26
  383. package/dist/models/trade-detection-subscription.js +0 -2
  384. package/dist/models/trading-instrument.d.ts +0 -22
  385. package/dist/models/trading-instrument.js +0 -2
  386. package/dist/models/trading-search-cryptocurrency-pair-instruments200-response.d.ts +0 -15
  387. package/dist/models/trading-search-cryptocurrency-pair-instruments200-response.js +0 -2
  388. package/dist/models/trading-session.d.ts +0 -6
  389. package/dist/models/trading-session.js +0 -2
  390. package/dist/models/trailing-stop.d.ts +0 -22
  391. package/dist/models/trailing-stop.js +0 -2
  392. package/dist/models/transactions-status.d.ts +0 -25
  393. package/dist/models/transactions-status.js +0 -2
  394. package/dist/models/underlying-option-instrument.d.ts +0 -27
  395. package/dist/models/underlying-option-instrument.js +0 -2
  396. package/dist/models/underlying-symbol-exchange.d.ts +0 -61
  397. package/dist/models/underlying-symbol-exchange.js +0 -2
  398. package/dist/models/underlying-symbol-type.d.ts +0 -32
  399. package/dist/models/underlying-symbol-type.js +0 -2
  400. package/dist/models/underlying-symbol.d.ts +0 -74
  401. package/dist/models/underlying-symbol.js +0 -2
  402. package/dist/models/universal-activity.d.ts +0 -114
  403. package/dist/models/universal-activity.js +0 -2
  404. package/dist/models/universal-symbol.d.ts +0 -74
  405. package/dist/models/universal-symbol.js +0 -2
  406. package/dist/models/user-idand-secret.d.ts +0 -19
  407. package/dist/models/user-idand-secret.js +0 -2
  408. package/dist/models/usexchange.d.ts +0 -62
  409. package/dist/models/usexchange.js +0 -2
  410. package/dist/models/validated-trade-body.d.ts +0 -13
  411. package/dist/models/validated-trade-body.js +0 -2
  412. package/dist/operationParameterMap.d.ts +0 -8
  413. package/dist/operationParameterMap.js +0 -966
  414. package/dist/pagination/page-types.d.ts +0 -16
  415. package/dist/pagination/page-types.js +0 -12
  416. package/dist/pagination/page.d.ts +0 -25
  417. package/dist/pagination/page.js +0 -32
  418. package/dist/pagination/pageable.d.ts +0 -47
  419. package/dist/pagination/pageable.js +0 -70
  420. package/dist/pagination/paginate.d.ts +0 -6
  421. package/dist/pagination/paginate.js +0 -39
  422. package/dist/requestAfterHook.d.ts +0 -8
  423. package/dist/requestAfterHook.js +0 -82
  424. package/dist/requestBeforeHook.d.ts +0 -10
  425. package/dist/requestBeforeHook.js +0 -8
  426. package/dist/requestBeforeUrlHook.d.ts +0 -7
  427. package/dist/requestBeforeUrlHook.js +0 -5
@@ -1,1054 +0,0 @@
1
- import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
2
- import { Configuration } from '../configuration';
3
- import { RequestArgs, BaseAPI } from '../base';
4
- import { AccountInformationGetUserAccountOrderDetailRequest } from '../models';
5
- import { AccountOrderRecord } from '../models';
6
- import { CancelOrderResponse } from '../models';
7
- import { ComplexOrderResponse } from '../models';
8
- import { CryptoOrderForm } from '../models';
9
- import { CryptoOrderPreview } from '../models';
10
- import { CryptocurrencyPairQuote } from '../models';
11
- import { ManualTradeAndImpact } from '../models';
12
- import { ManualTradeForm } from '../models';
13
- import { ManualTradeFormBracket } from '../models';
14
- import { ManualTradeFormComplex } from '../models';
15
- import { ManualTradeFormWithOptions } from '../models';
16
- import { ManualTradeReplaceForm } from '../models';
17
- import { MlegOrderResponse } from '../models';
18
- import { MlegTradeForm } from '../models';
19
- import { OptionImpact } from '../models';
20
- import { OptionQuote } from '../models';
21
- import { OrderUpdatedResponse } from '../models';
22
- import { SymbolsQuotesInner } from '../models';
23
- import { TradingSearchCryptocurrencyPairInstruments200Response } from '../models';
24
- import { ValidatedTradeBody } from '../models';
25
- /**
26
- * TradingApi - axios parameter creator
27
- * @export
28
- */
29
- export declare const TradingApiAxiosParamCreator: (configuration?: Configuration) => {
30
- /**
31
- * Cancels an order in the specified account. Accepts order IDs for all asset types.
32
- * @summary Cancel order
33
- * @param {string} userId
34
- * @param {string} userSecret
35
- * @param {string} accountId
36
- * @param {AccountInformationGetUserAccountOrderDetailRequest} accountInformationGetUserAccountOrderDetailRequest
37
- * @param {*} [options] Override http request option.
38
- * @throws {RequiredError}
39
- */
40
- cancelOrder: (userId: string, userSecret: string, accountId: string, accountInformationGetUserAccountOrderDetailRequest: AccountInformationGetUserAccountOrderDetailRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
41
- /**
42
- * **This endpoint is deprecated. Please switch to [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) ** Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
43
- * @summary Cancel equity order
44
- * @param {string} userId
45
- * @param {string} userSecret
46
- * @param {string} accountId
47
- * @param {AccountInformationGetUserAccountOrderDetailRequest} accountInformationGetUserAccountOrderDetailRequest
48
- * @param {*} [options] Override http request option.
49
- * @deprecated
50
- * @throws {RequiredError}
51
- */
52
- cancelUserAccountOrder: (userId: string, userSecret: string, accountId: string, accountInformationGetUserAccountOrderDetailRequest: AccountInformationGetUserAccountOrderDetailRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53
- /**
54
- * Gets a quote for the specified account.
55
- * @summary Get crypto pair quote
56
- * @param {string} userId
57
- * @param {string} userSecret
58
- * @param {string} accountId
59
- * @param {string} instrumentSymbol
60
- * @param {*} [options] Override http request option.
61
- * @throws {RequiredError}
62
- */
63
- getCryptocurrencyPairQuote: (userId: string, userSecret: string, accountId: string, instrumentSymbol: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
64
- /**
65
- * Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain enabled brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for more information on which brokerages support this endpoint.
66
- * @summary Get option order impact
67
- * @param {string} userId
68
- * @param {string} userSecret
69
- * @param {string} accountId
70
- * @param {MlegTradeForm} mlegTradeForm
71
- * @param {*} [options] Override http request option.
72
- * @throws {RequiredError}
73
- */
74
- getOptionImpact: (userId: string, userSecret: string, accountId: string, mlegTradeForm: MlegTradeForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
75
- /**
76
- * Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
77
- * @summary Check equity order impact
78
- * @param {string} userId
79
- * @param {string} userSecret
80
- * @param {ManualTradeForm} manualTradeForm
81
- * @param {*} [options] Override http request option.
82
- * @throws {RequiredError}
83
- */
84
- getOrderImpact: (userId: string, userSecret: string, manualTradeForm: ManualTradeForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
85
- /**
86
- * Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL 251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
87
- * @summary Get option quote
88
- * @param {string} userId
89
- * @param {string} userSecret
90
- * @param {string} accountId
91
- * @param {string} symbol The OCC-formatted option symbol.
92
- * @param {*} [options] Override http request option.
93
- * @throws {RequiredError}
94
- */
95
- getUserAccountOptionQuotes: (userId: string, userSecret: string, accountId: string, symbol: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
96
- /**
97
- * Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
98
- * @summary Get equity symbol quotes
99
- * @param {string} userId
100
- * @param {string} userSecret
101
- * @param {string} symbols List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator. Maximum of 10 values allowed
102
- * @param {string} accountId
103
- * @param {boolean} [useTicker] Should be set to &#x60;True&#x60; if &#x60;symbols&#x60; are comprised of tickers. Defaults to &#x60;False&#x60; if not provided.
104
- * @param {*} [options] Override http request option.
105
- * @throws {RequiredError}
106
- */
107
- getUserAccountQuotes: (userId: string, userSecret: string, symbols: string, accountId: string, useTicker?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
108
- /**
109
- * Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
110
- * @summary Place bracket order
111
- * @param {string} accountId The ID of the account to execute the trade on.
112
- * @param {string} userId
113
- * @param {string} userSecret
114
- * @param {ManualTradeFormBracket} manualTradeFormBracket
115
- * @param {*} [options] Override http request option.
116
- * @throws {RequiredError}
117
- */
118
- placeBracketOrder: (accountId: string, userId: string, userSecret: string, manualTradeFormBracket: ManualTradeFormBracket, options?: AxiosRequestConfig) => Promise<RequestArgs>;
119
- /**
120
- * Places a complex conditional order (OCO, OTO, or OTOCO). Disabled by default — contact support to enable. Only supported on certain brokerages. - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
121
- * @summary Place complex order
122
- * @param {string} accountId The ID of the account to execute the trade on.
123
- * @param {string} userId
124
- * @param {string} userSecret
125
- * @param {ManualTradeFormComplex} manualTradeFormComplex
126
- * @param {*} [options] Override http request option.
127
- * @throws {RequiredError}
128
- */
129
- placeComplexOrder: (accountId: string, userId: string, userSecret: string, manualTradeFormComplex: ManualTradeFormComplex, options?: AxiosRequestConfig) => Promise<RequestArgs>;
130
- /**
131
- * Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
132
- * @summary Place crypto order
133
- * @param {string} userId
134
- * @param {string} userSecret
135
- * @param {string} accountId
136
- * @param {CryptoOrderForm} cryptoOrderForm
137
- * @param {*} [options] Override http request option.
138
- * @throws {RequiredError}
139
- */
140
- placeCryptoOrder: (userId: string, userSecret: string, accountId: string, cryptoOrderForm: CryptoOrderForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
141
- /**
142
- * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds. This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
143
- * @summary Place equity order
144
- * @param {string} userId
145
- * @param {string} userSecret
146
- * @param {ManualTradeFormWithOptions} manualTradeFormWithOptions
147
- * @param {*} [options] Override http request option.
148
- * @throws {RequiredError}
149
- */
150
- placeForceOrder: (userId: string, userSecret: string, manualTradeFormWithOptions: ManualTradeFormWithOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>;
151
- /**
152
- * Places a multi-leg option order. Only supported on certain option trading brokerages. https://support.snaptrade.com/brokerages has information on brokerage trading support
153
- * @summary Place option order
154
- * @param {string} userId
155
- * @param {string} userSecret
156
- * @param {string} accountId
157
- * @param {MlegTradeForm} mlegTradeForm
158
- * @param {*} [options] Override http request option.
159
- * @throws {RequiredError}
160
- */
161
- placeMlegOrder: (userId: string, userSecret: string, accountId: string, mlegTradeForm: MlegTradeForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
162
- /**
163
- * Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
164
- * @summary Place checked equity order
165
- * @param {string} tradeId Obtained from calling the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact)
166
- * @param {string} userId
167
- * @param {string} userSecret
168
- * @param {ValidatedTradeBody} [validatedTradeBody]
169
- * @param {*} [options] Override http request option.
170
- * @throws {RequiredError}
171
- */
172
- placeOrder: (tradeId: string, userId: string, userSecret: string, validatedTradeBody?: ValidatedTradeBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
173
- /**
174
- * Previews an order using the specified account.
175
- * @summary Preview crypto order
176
- * @param {string} userId
177
- * @param {string} userSecret
178
- * @param {string} accountId
179
- * @param {CryptoOrderForm} cryptoOrderForm
180
- * @param {*} [options] Override http request option.
181
- * @throws {RequiredError}
182
- */
183
- previewCryptoOrder: (userId: string, userSecret: string, accountId: string, cryptoOrderForm: CryptoOrderForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
184
- /**
185
- * Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order\'s brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages
186
- * @summary Replace order
187
- * @param {string} accountId The ID of the account to execute the trade on.
188
- * @param {string} userId
189
- * @param {string} userSecret
190
- * @param {ManualTradeReplaceForm} manualTradeReplaceForm
191
- * @param {*} [options] Override http request option.
192
- * @throws {RequiredError}
193
- */
194
- replaceOrder: (accountId: string, userId: string, userSecret: string, manualTradeReplaceForm: ManualTradeReplaceForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
195
- /**
196
- * Searches cryptocurrency pairs instruments accessible to the specified account. Both `base` and `quote` are optional. Omit both for a full list of cryptocurrency pairs.
197
- * @summary Get crypto pairs
198
- * @param {string} userId
199
- * @param {string} userSecret
200
- * @param {string} accountId
201
- * @param {string} [base]
202
- * @param {string} [quote]
203
- * @param {*} [options] Override http request option.
204
- * @throws {RequiredError}
205
- */
206
- searchCryptocurrencyPairInstruments: (userId: string, userSecret: string, accountId: string, base?: string, quote?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
207
- };
208
- /**
209
- * TradingApi - functional programming interface
210
- * @export
211
- */
212
- export declare const TradingApiFp: (configuration?: Configuration) => {
213
- /**
214
- * Cancels an order in the specified account. Accepts order IDs for all asset types.
215
- * @summary Cancel order
216
- * @param {TradingApiCancelOrderRequest} requestParameters Request parameters.
217
- * @param {*} [options] Override http request option.
218
- * @throws {RequiredError}
219
- */
220
- cancelOrder(requestParameters: TradingApiCancelOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelOrderResponse>>;
221
- /**
222
- * **This endpoint is deprecated. Please switch to [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) ** Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
223
- * @summary Cancel equity order
224
- * @param {TradingApiCancelUserAccountOrderRequest} requestParameters Request parameters.
225
- * @param {*} [options] Override http request option.
226
- * @deprecated
227
- * @throws {RequiredError}
228
- */
229
- cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
230
- /**
231
- * Gets a quote for the specified account.
232
- * @summary Get crypto pair quote
233
- * @param {TradingApiGetCryptocurrencyPairQuoteRequest} requestParameters Request parameters.
234
- * @param {*} [options] Override http request option.
235
- * @throws {RequiredError}
236
- */
237
- getCryptocurrencyPairQuote(requestParameters: TradingApiGetCryptocurrencyPairQuoteRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CryptocurrencyPairQuote>>;
238
- /**
239
- * Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain enabled brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for more information on which brokerages support this endpoint.
240
- * @summary Get option order impact
241
- * @param {TradingApiGetOptionImpactRequest} requestParameters Request parameters.
242
- * @param {*} [options] Override http request option.
243
- * @throws {RequiredError}
244
- */
245
- getOptionImpact(requestParameters: TradingApiGetOptionImpactRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionImpact>>;
246
- /**
247
- * Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
248
- * @summary Check equity order impact
249
- * @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
250
- * @param {*} [options] Override http request option.
251
- * @throws {RequiredError}
252
- */
253
- getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManualTradeAndImpact>>;
254
- /**
255
- * Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL 251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
256
- * @summary Get option quote
257
- * @param {TradingApiGetUserAccountOptionQuotesRequest} requestParameters Request parameters.
258
- * @param {*} [options] Override http request option.
259
- * @throws {RequiredError}
260
- */
261
- getUserAccountOptionQuotes(requestParameters: TradingApiGetUserAccountOptionQuotesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionQuote>>;
262
- /**
263
- * Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
264
- * @summary Get equity symbol quotes
265
- * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
266
- * @param {*} [options] Override http request option.
267
- * @throws {RequiredError}
268
- */
269
- getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SymbolsQuotesInner>>>;
270
- /**
271
- * Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
272
- * @summary Place bracket order
273
- * @param {TradingApiPlaceBracketOrderRequest} requestParameters Request parameters.
274
- * @param {*} [options] Override http request option.
275
- * @throws {RequiredError}
276
- */
277
- placeBracketOrder(requestParameters: TradingApiPlaceBracketOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
278
- /**
279
- * Places a complex conditional order (OCO, OTO, or OTOCO). Disabled by default — contact support to enable. Only supported on certain brokerages. - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
280
- * @summary Place complex order
281
- * @param {TradingApiPlaceComplexOrderRequest} requestParameters Request parameters.
282
- * @param {*} [options] Override http request option.
283
- * @throws {RequiredError}
284
- */
285
- placeComplexOrder(requestParameters: TradingApiPlaceComplexOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ComplexOrderResponse>>;
286
- /**
287
- * Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
288
- * @summary Place crypto order
289
- * @param {TradingApiPlaceCryptoOrderRequest} requestParameters Request parameters.
290
- * @param {*} [options] Override http request option.
291
- * @throws {RequiredError}
292
- */
293
- placeCryptoOrder(requestParameters: TradingApiPlaceCryptoOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderUpdatedResponse>>;
294
- /**
295
- * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds. This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
296
- * @summary Place equity order
297
- * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
298
- * @param {*} [options] Override http request option.
299
- * @throws {RequiredError}
300
- */
301
- placeForceOrder(requestParameters: TradingApiPlaceForceOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
302
- /**
303
- * Places a multi-leg option order. Only supported on certain option trading brokerages. https://support.snaptrade.com/brokerages has information on brokerage trading support
304
- * @summary Place option order
305
- * @param {TradingApiPlaceMlegOrderRequest} requestParameters Request parameters.
306
- * @param {*} [options] Override http request option.
307
- * @throws {RequiredError}
308
- */
309
- placeMlegOrder(requestParameters: TradingApiPlaceMlegOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MlegOrderResponse>>;
310
- /**
311
- * Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
312
- * @summary Place checked equity order
313
- * @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
314
- * @param {*} [options] Override http request option.
315
- * @throws {RequiredError}
316
- */
317
- placeOrder(requestParameters: TradingApiPlaceOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
318
- /**
319
- * Previews an order using the specified account.
320
- * @summary Preview crypto order
321
- * @param {TradingApiPreviewCryptoOrderRequest} requestParameters Request parameters.
322
- * @param {*} [options] Override http request option.
323
- * @throws {RequiredError}
324
- */
325
- previewCryptoOrder(requestParameters: TradingApiPreviewCryptoOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CryptoOrderPreview>>;
326
- /**
327
- * Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order\'s brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages
328
- * @summary Replace order
329
- * @param {TradingApiReplaceOrderRequest} requestParameters Request parameters.
330
- * @param {*} [options] Override http request option.
331
- * @throws {RequiredError}
332
- */
333
- replaceOrder(requestParameters: TradingApiReplaceOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
334
- /**
335
- * Searches cryptocurrency pairs instruments accessible to the specified account. Both `base` and `quote` are optional. Omit both for a full list of cryptocurrency pairs.
336
- * @summary Get crypto pairs
337
- * @param {TradingApiSearchCryptocurrencyPairInstrumentsRequest} requestParameters Request parameters.
338
- * @param {*} [options] Override http request option.
339
- * @throws {RequiredError}
340
- */
341
- searchCryptocurrencyPairInstruments(requestParameters: TradingApiSearchCryptocurrencyPairInstrumentsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TradingSearchCryptocurrencyPairInstruments200Response>>;
342
- };
343
- /**
344
- * TradingApi - factory interface
345
- * @export
346
- */
347
- export declare const TradingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
348
- /**
349
- * Cancels an order in the specified account. Accepts order IDs for all asset types.
350
- * @summary Cancel order
351
- * @param {TradingApiCancelOrderRequest} requestParameters Request parameters.
352
- * @param {*} [options] Override http request option.
353
- * @throws {RequiredError}
354
- */
355
- cancelOrder(requestParameters: TradingApiCancelOrderRequest, options?: AxiosRequestConfig): AxiosPromise<CancelOrderResponse>;
356
- /**
357
- * **This endpoint is deprecated. Please switch to [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) ** Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
358
- * @summary Cancel equity order
359
- * @param {TradingApiCancelUserAccountOrderRequest} requestParameters Request parameters.
360
- * @param {*} [options] Override http request option.
361
- * @deprecated
362
- * @throws {RequiredError}
363
- */
364
- cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
365
- /**
366
- * Gets a quote for the specified account.
367
- * @summary Get crypto pair quote
368
- * @param {TradingApiGetCryptocurrencyPairQuoteRequest} requestParameters Request parameters.
369
- * @param {*} [options] Override http request option.
370
- * @throws {RequiredError}
371
- */
372
- getCryptocurrencyPairQuote(requestParameters: TradingApiGetCryptocurrencyPairQuoteRequest, options?: AxiosRequestConfig): AxiosPromise<CryptocurrencyPairQuote>;
373
- /**
374
- * Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain enabled brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for more information on which brokerages support this endpoint.
375
- * @summary Get option order impact
376
- * @param {TradingApiGetOptionImpactRequest} requestParameters Request parameters.
377
- * @param {*} [options] Override http request option.
378
- * @throws {RequiredError}
379
- */
380
- getOptionImpact(requestParameters: TradingApiGetOptionImpactRequest, options?: AxiosRequestConfig): AxiosPromise<OptionImpact>;
381
- /**
382
- * Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
383
- * @summary Check equity order impact
384
- * @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
385
- * @param {*} [options] Override http request option.
386
- * @throws {RequiredError}
387
- */
388
- getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): AxiosPromise<ManualTradeAndImpact>;
389
- /**
390
- * Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL 251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
391
- * @summary Get option quote
392
- * @param {TradingApiGetUserAccountOptionQuotesRequest} requestParameters Request parameters.
393
- * @param {*} [options] Override http request option.
394
- * @throws {RequiredError}
395
- */
396
- getUserAccountOptionQuotes(requestParameters: TradingApiGetUserAccountOptionQuotesRequest, options?: AxiosRequestConfig): AxiosPromise<OptionQuote>;
397
- /**
398
- * Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
399
- * @summary Get equity symbol quotes
400
- * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
401
- * @param {*} [options] Override http request option.
402
- * @throws {RequiredError}
403
- */
404
- getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<SymbolsQuotesInner>>;
405
- /**
406
- * Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
407
- * @summary Place bracket order
408
- * @param {TradingApiPlaceBracketOrderRequest} requestParameters Request parameters.
409
- * @param {*} [options] Override http request option.
410
- * @throws {RequiredError}
411
- */
412
- placeBracketOrder(requestParameters: TradingApiPlaceBracketOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
413
- /**
414
- * Places a complex conditional order (OCO, OTO, or OTOCO). Disabled by default — contact support to enable. Only supported on certain brokerages. - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
415
- * @summary Place complex order
416
- * @param {TradingApiPlaceComplexOrderRequest} requestParameters Request parameters.
417
- * @param {*} [options] Override http request option.
418
- * @throws {RequiredError}
419
- */
420
- placeComplexOrder(requestParameters: TradingApiPlaceComplexOrderRequest, options?: AxiosRequestConfig): AxiosPromise<ComplexOrderResponse>;
421
- /**
422
- * Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
423
- * @summary Place crypto order
424
- * @param {TradingApiPlaceCryptoOrderRequest} requestParameters Request parameters.
425
- * @param {*} [options] Override http request option.
426
- * @throws {RequiredError}
427
- */
428
- placeCryptoOrder(requestParameters: TradingApiPlaceCryptoOrderRequest, options?: AxiosRequestConfig): AxiosPromise<OrderUpdatedResponse>;
429
- /**
430
- * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds. This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
431
- * @summary Place equity order
432
- * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
433
- * @param {*} [options] Override http request option.
434
- * @throws {RequiredError}
435
- */
436
- placeForceOrder(requestParameters: TradingApiPlaceForceOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
437
- /**
438
- * Places a multi-leg option order. Only supported on certain option trading brokerages. https://support.snaptrade.com/brokerages has information on brokerage trading support
439
- * @summary Place option order
440
- * @param {TradingApiPlaceMlegOrderRequest} requestParameters Request parameters.
441
- * @param {*} [options] Override http request option.
442
- * @throws {RequiredError}
443
- */
444
- placeMlegOrder(requestParameters: TradingApiPlaceMlegOrderRequest, options?: AxiosRequestConfig): AxiosPromise<MlegOrderResponse>;
445
- /**
446
- * Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
447
- * @summary Place checked equity order
448
- * @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
449
- * @param {*} [options] Override http request option.
450
- * @throws {RequiredError}
451
- */
452
- placeOrder(requestParameters: TradingApiPlaceOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
453
- /**
454
- * Previews an order using the specified account.
455
- * @summary Preview crypto order
456
- * @param {TradingApiPreviewCryptoOrderRequest} requestParameters Request parameters.
457
- * @param {*} [options] Override http request option.
458
- * @throws {RequiredError}
459
- */
460
- previewCryptoOrder(requestParameters: TradingApiPreviewCryptoOrderRequest, options?: AxiosRequestConfig): AxiosPromise<CryptoOrderPreview>;
461
- /**
462
- * Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order\'s brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages
463
- * @summary Replace order
464
- * @param {TradingApiReplaceOrderRequest} requestParameters Request parameters.
465
- * @param {*} [options] Override http request option.
466
- * @throws {RequiredError}
467
- */
468
- replaceOrder(requestParameters: TradingApiReplaceOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
469
- /**
470
- * Searches cryptocurrency pairs instruments accessible to the specified account. Both `base` and `quote` are optional. Omit both for a full list of cryptocurrency pairs.
471
- * @summary Get crypto pairs
472
- * @param {TradingApiSearchCryptocurrencyPairInstrumentsRequest} requestParameters Request parameters.
473
- * @param {*} [options] Override http request option.
474
- * @throws {RequiredError}
475
- */
476
- searchCryptocurrencyPairInstruments(requestParameters: TradingApiSearchCryptocurrencyPairInstrumentsRequest, options?: AxiosRequestConfig): AxiosPromise<TradingSearchCryptocurrencyPairInstruments200Response>;
477
- };
478
- /**
479
- * Request parameters for cancelOrder operation in TradingApi.
480
- * @export
481
- * @interface TradingApiCancelOrderRequest
482
- */
483
- export type TradingApiCancelOrderRequest = {
484
- /**
485
- *
486
- * @type {string}
487
- * @memberof TradingApiCancelOrder
488
- */
489
- readonly userId: string;
490
- /**
491
- *
492
- * @type {string}
493
- * @memberof TradingApiCancelOrder
494
- */
495
- readonly userSecret: string;
496
- /**
497
- *
498
- * @type {string}
499
- * @memberof TradingApiCancelOrder
500
- */
501
- readonly accountId: string;
502
- } & AccountInformationGetUserAccountOrderDetailRequest;
503
- /**
504
- * Request parameters for cancelUserAccountOrder operation in TradingApi.
505
- * @export
506
- * @interface TradingApiCancelUserAccountOrderRequest
507
- */
508
- export type TradingApiCancelUserAccountOrderRequest = {
509
- /**
510
- *
511
- * @type {string}
512
- * @memberof TradingApiCancelUserAccountOrder
513
- */
514
- readonly userId: string;
515
- /**
516
- *
517
- * @type {string}
518
- * @memberof TradingApiCancelUserAccountOrder
519
- */
520
- readonly userSecret: string;
521
- /**
522
- *
523
- * @type {string}
524
- * @memberof TradingApiCancelUserAccountOrder
525
- */
526
- readonly accountId: string;
527
- } & AccountInformationGetUserAccountOrderDetailRequest;
528
- /**
529
- * Request parameters for getCryptocurrencyPairQuote operation in TradingApi.
530
- * @export
531
- * @interface TradingApiGetCryptocurrencyPairQuoteRequest
532
- */
533
- export type TradingApiGetCryptocurrencyPairQuoteRequest = {
534
- /**
535
- *
536
- * @type {string}
537
- * @memberof TradingApiGetCryptocurrencyPairQuote
538
- */
539
- readonly userId: string;
540
- /**
541
- *
542
- * @type {string}
543
- * @memberof TradingApiGetCryptocurrencyPairQuote
544
- */
545
- readonly userSecret: string;
546
- /**
547
- *
548
- * @type {string}
549
- * @memberof TradingApiGetCryptocurrencyPairQuote
550
- */
551
- readonly accountId: string;
552
- /**
553
- *
554
- * @type {string}
555
- * @memberof TradingApiGetCryptocurrencyPairQuote
556
- */
557
- readonly instrumentSymbol: string;
558
- };
559
- /**
560
- * Request parameters for getOptionImpact operation in TradingApi.
561
- * @export
562
- * @interface TradingApiGetOptionImpactRequest
563
- */
564
- export type TradingApiGetOptionImpactRequest = {
565
- /**
566
- *
567
- * @type {string}
568
- * @memberof TradingApiGetOptionImpact
569
- */
570
- readonly userId: string;
571
- /**
572
- *
573
- * @type {string}
574
- * @memberof TradingApiGetOptionImpact
575
- */
576
- readonly userSecret: string;
577
- /**
578
- *
579
- * @type {string}
580
- * @memberof TradingApiGetOptionImpact
581
- */
582
- readonly accountId: string;
583
- } & MlegTradeForm;
584
- /**
585
- * Request parameters for getOrderImpact operation in TradingApi.
586
- * @export
587
- * @interface TradingApiGetOrderImpactRequest
588
- */
589
- export type TradingApiGetOrderImpactRequest = {
590
- /**
591
- *
592
- * @type {string}
593
- * @memberof TradingApiGetOrderImpact
594
- */
595
- readonly userId: string;
596
- /**
597
- *
598
- * @type {string}
599
- * @memberof TradingApiGetOrderImpact
600
- */
601
- readonly userSecret: string;
602
- } & ManualTradeForm;
603
- /**
604
- * Request parameters for getUserAccountOptionQuotes operation in TradingApi.
605
- * @export
606
- * @interface TradingApiGetUserAccountOptionQuotesRequest
607
- */
608
- export type TradingApiGetUserAccountOptionQuotesRequest = {
609
- /**
610
- *
611
- * @type {string}
612
- * @memberof TradingApiGetUserAccountOptionQuotes
613
- */
614
- readonly userId: string;
615
- /**
616
- *
617
- * @type {string}
618
- * @memberof TradingApiGetUserAccountOptionQuotes
619
- */
620
- readonly userSecret: string;
621
- /**
622
- *
623
- * @type {string}
624
- * @memberof TradingApiGetUserAccountOptionQuotes
625
- */
626
- readonly accountId: string;
627
- /**
628
- * The OCC-formatted option symbol.
629
- * @type {string}
630
- * @memberof TradingApiGetUserAccountOptionQuotes
631
- */
632
- readonly symbol: string;
633
- };
634
- /**
635
- * Request parameters for getUserAccountQuotes operation in TradingApi.
636
- * @export
637
- * @interface TradingApiGetUserAccountQuotesRequest
638
- */
639
- export type TradingApiGetUserAccountQuotesRequest = {
640
- /**
641
- *
642
- * @type {string}
643
- * @memberof TradingApiGetUserAccountQuotes
644
- */
645
- readonly userId: string;
646
- /**
647
- *
648
- * @type {string}
649
- * @memberof TradingApiGetUserAccountQuotes
650
- */
651
- readonly userSecret: string;
652
- /**
653
- * List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator. Maximum of 10 values allowed
654
- * @type {string}
655
- * @memberof TradingApiGetUserAccountQuotes
656
- */
657
- readonly symbols: string;
658
- /**
659
- *
660
- * @type {string}
661
- * @memberof TradingApiGetUserAccountQuotes
662
- */
663
- readonly accountId: string;
664
- /**
665
- * Should be set to `True` if `symbols` are comprised of tickers. Defaults to `False` if not provided.
666
- * @type {boolean}
667
- * @memberof TradingApiGetUserAccountQuotes
668
- */
669
- readonly useTicker?: boolean;
670
- };
671
- /**
672
- * Request parameters for placeBracketOrder operation in TradingApi.
673
- * @export
674
- * @interface TradingApiPlaceBracketOrderRequest
675
- */
676
- export type TradingApiPlaceBracketOrderRequest = {
677
- /**
678
- * The ID of the account to execute the trade on.
679
- * @type {string}
680
- * @memberof TradingApiPlaceBracketOrder
681
- */
682
- readonly accountId: string;
683
- /**
684
- *
685
- * @type {string}
686
- * @memberof TradingApiPlaceBracketOrder
687
- */
688
- readonly userId: string;
689
- /**
690
- *
691
- * @type {string}
692
- * @memberof TradingApiPlaceBracketOrder
693
- */
694
- readonly userSecret: string;
695
- } & ManualTradeFormBracket;
696
- /**
697
- * Request parameters for placeComplexOrder operation in TradingApi.
698
- * @export
699
- * @interface TradingApiPlaceComplexOrderRequest
700
- */
701
- export type TradingApiPlaceComplexOrderRequest = {
702
- /**
703
- * The ID of the account to execute the trade on.
704
- * @type {string}
705
- * @memberof TradingApiPlaceComplexOrder
706
- */
707
- readonly accountId: string;
708
- /**
709
- *
710
- * @type {string}
711
- * @memberof TradingApiPlaceComplexOrder
712
- */
713
- readonly userId: string;
714
- /**
715
- *
716
- * @type {string}
717
- * @memberof TradingApiPlaceComplexOrder
718
- */
719
- readonly userSecret: string;
720
- } & ManualTradeFormComplex;
721
- /**
722
- * Request parameters for placeCryptoOrder operation in TradingApi.
723
- * @export
724
- * @interface TradingApiPlaceCryptoOrderRequest
725
- */
726
- export type TradingApiPlaceCryptoOrderRequest = {
727
- /**
728
- *
729
- * @type {string}
730
- * @memberof TradingApiPlaceCryptoOrder
731
- */
732
- readonly userId: string;
733
- /**
734
- *
735
- * @type {string}
736
- * @memberof TradingApiPlaceCryptoOrder
737
- */
738
- readonly userSecret: string;
739
- /**
740
- *
741
- * @type {string}
742
- * @memberof TradingApiPlaceCryptoOrder
743
- */
744
- readonly accountId: string;
745
- } & CryptoOrderForm;
746
- /**
747
- * Request parameters for placeForceOrder operation in TradingApi.
748
- * @export
749
- * @interface TradingApiPlaceForceOrderRequest
750
- */
751
- export type TradingApiPlaceForceOrderRequest = {
752
- /**
753
- *
754
- * @type {string}
755
- * @memberof TradingApiPlaceForceOrder
756
- */
757
- readonly userId: string;
758
- /**
759
- *
760
- * @type {string}
761
- * @memberof TradingApiPlaceForceOrder
762
- */
763
- readonly userSecret: string;
764
- } & ManualTradeFormWithOptions;
765
- /**
766
- * Request parameters for placeMlegOrder operation in TradingApi.
767
- * @export
768
- * @interface TradingApiPlaceMlegOrderRequest
769
- */
770
- export type TradingApiPlaceMlegOrderRequest = {
771
- /**
772
- *
773
- * @type {string}
774
- * @memberof TradingApiPlaceMlegOrder
775
- */
776
- readonly userId: string;
777
- /**
778
- *
779
- * @type {string}
780
- * @memberof TradingApiPlaceMlegOrder
781
- */
782
- readonly userSecret: string;
783
- /**
784
- *
785
- * @type {string}
786
- * @memberof TradingApiPlaceMlegOrder
787
- */
788
- readonly accountId: string;
789
- } & MlegTradeForm;
790
- /**
791
- * Request parameters for placeOrder operation in TradingApi.
792
- * @export
793
- * @interface TradingApiPlaceOrderRequest
794
- */
795
- export type TradingApiPlaceOrderRequest = {
796
- /**
797
- * Obtained from calling the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact)
798
- * @type {string}
799
- * @memberof TradingApiPlaceOrder
800
- */
801
- readonly tradeId: string;
802
- /**
803
- *
804
- * @type {string}
805
- * @memberof TradingApiPlaceOrder
806
- */
807
- readonly userId: string;
808
- /**
809
- *
810
- * @type {string}
811
- * @memberof TradingApiPlaceOrder
812
- */
813
- readonly userSecret: string;
814
- } & ValidatedTradeBody;
815
- /**
816
- * Request parameters for previewCryptoOrder operation in TradingApi.
817
- * @export
818
- * @interface TradingApiPreviewCryptoOrderRequest
819
- */
820
- export type TradingApiPreviewCryptoOrderRequest = {
821
- /**
822
- *
823
- * @type {string}
824
- * @memberof TradingApiPreviewCryptoOrder
825
- */
826
- readonly userId: string;
827
- /**
828
- *
829
- * @type {string}
830
- * @memberof TradingApiPreviewCryptoOrder
831
- */
832
- readonly userSecret: string;
833
- /**
834
- *
835
- * @type {string}
836
- * @memberof TradingApiPreviewCryptoOrder
837
- */
838
- readonly accountId: string;
839
- } & CryptoOrderForm;
840
- /**
841
- * Request parameters for replaceOrder operation in TradingApi.
842
- * @export
843
- * @interface TradingApiReplaceOrderRequest
844
- */
845
- export type TradingApiReplaceOrderRequest = {
846
- /**
847
- * The ID of the account to execute the trade on.
848
- * @type {string}
849
- * @memberof TradingApiReplaceOrder
850
- */
851
- readonly accountId: string;
852
- /**
853
- *
854
- * @type {string}
855
- * @memberof TradingApiReplaceOrder
856
- */
857
- readonly userId: string;
858
- /**
859
- *
860
- * @type {string}
861
- * @memberof TradingApiReplaceOrder
862
- */
863
- readonly userSecret: string;
864
- } & ManualTradeReplaceForm;
865
- /**
866
- * Request parameters for searchCryptocurrencyPairInstruments operation in TradingApi.
867
- * @export
868
- * @interface TradingApiSearchCryptocurrencyPairInstrumentsRequest
869
- */
870
- export type TradingApiSearchCryptocurrencyPairInstrumentsRequest = {
871
- /**
872
- *
873
- * @type {string}
874
- * @memberof TradingApiSearchCryptocurrencyPairInstruments
875
- */
876
- readonly userId: string;
877
- /**
878
- *
879
- * @type {string}
880
- * @memberof TradingApiSearchCryptocurrencyPairInstruments
881
- */
882
- readonly userSecret: string;
883
- /**
884
- *
885
- * @type {string}
886
- * @memberof TradingApiSearchCryptocurrencyPairInstruments
887
- */
888
- readonly accountId: string;
889
- /**
890
- *
891
- * @type {string}
892
- * @memberof TradingApiSearchCryptocurrencyPairInstruments
893
- */
894
- readonly base?: string;
895
- /**
896
- *
897
- * @type {string}
898
- * @memberof TradingApiSearchCryptocurrencyPairInstruments
899
- */
900
- readonly quote?: string;
901
- };
902
- /**
903
- * TradingApiGenerated - object-oriented interface
904
- * @export
905
- * @class TradingApiGenerated
906
- * @extends {BaseAPI}
907
- */
908
- export declare class TradingApiGenerated extends BaseAPI {
909
- /**
910
- * Cancels an order in the specified account. Accepts order IDs for all asset types.
911
- * @summary Cancel order
912
- * @param {TradingApiCancelOrderRequest} requestParameters Request parameters.
913
- * @param {*} [options] Override http request option.
914
- * @throws {RequiredError}
915
- * @memberof TradingApiGenerated
916
- */
917
- cancelOrder(requestParameters: TradingApiCancelOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CancelOrderResponse, any, {}>>;
918
- /**
919
- * **This endpoint is deprecated. Please switch to [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) ** Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
920
- * @summary Cancel equity order
921
- * @param {TradingApiCancelUserAccountOrderRequest} requestParameters Request parameters.
922
- * @param {*} [options] Override http request option.
923
- * @deprecated
924
- * @throws {RequiredError}
925
- * @memberof TradingApiGenerated
926
- */
927
- cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any, {}>>;
928
- /**
929
- * Gets a quote for the specified account.
930
- * @summary Get crypto pair quote
931
- * @param {TradingApiGetCryptocurrencyPairQuoteRequest} requestParameters Request parameters.
932
- * @param {*} [options] Override http request option.
933
- * @throws {RequiredError}
934
- * @memberof TradingApiGenerated
935
- */
936
- getCryptocurrencyPairQuote(requestParameters: TradingApiGetCryptocurrencyPairQuoteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CryptocurrencyPairQuote, any, {}>>;
937
- /**
938
- * Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain enabled brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for more information on which brokerages support this endpoint.
939
- * @summary Get option order impact
940
- * @param {TradingApiGetOptionImpactRequest} requestParameters Request parameters.
941
- * @param {*} [options] Override http request option.
942
- * @throws {RequiredError}
943
- * @memberof TradingApiGenerated
944
- */
945
- getOptionImpact(requestParameters: TradingApiGetOptionImpactRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionImpact, any, {}>>;
946
- /**
947
- * Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
948
- * @summary Check equity order impact
949
- * @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
950
- * @param {*} [options] Override http request option.
951
- * @throws {RequiredError}
952
- * @memberof TradingApiGenerated
953
- */
954
- getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManualTradeAndImpact, any, {}>>;
955
- /**
956
- * Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL 251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
957
- * @summary Get option quote
958
- * @param {TradingApiGetUserAccountOptionQuotesRequest} requestParameters Request parameters.
959
- * @param {*} [options] Override http request option.
960
- * @throws {RequiredError}
961
- * @memberof TradingApiGenerated
962
- */
963
- getUserAccountOptionQuotes(requestParameters: TradingApiGetUserAccountOptionQuotesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionQuote, any, {}>>;
964
- /**
965
- * Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
966
- * @summary Get equity symbol quotes
967
- * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
968
- * @param {*} [options] Override http request option.
969
- * @throws {RequiredError}
970
- * @memberof TradingApiGenerated
971
- */
972
- getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SymbolsQuotesInner[], any, {}>>;
973
- /**
974
- * Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
975
- * @summary Place bracket order
976
- * @param {TradingApiPlaceBracketOrderRequest} requestParameters Request parameters.
977
- * @param {*} [options] Override http request option.
978
- * @throws {RequiredError}
979
- * @memberof TradingApiGenerated
980
- */
981
- placeBracketOrder(requestParameters: TradingApiPlaceBracketOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any, {}>>;
982
- /**
983
- * Places a complex conditional order (OCO, OTO, or OTOCO). Disabled by default — contact support to enable. Only supported on certain brokerages. - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
984
- * @summary Place complex order
985
- * @param {TradingApiPlaceComplexOrderRequest} requestParameters Request parameters.
986
- * @param {*} [options] Override http request option.
987
- * @throws {RequiredError}
988
- * @memberof TradingApiGenerated
989
- */
990
- placeComplexOrder(requestParameters: TradingApiPlaceComplexOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ComplexOrderResponse, any, {}>>;
991
- /**
992
- * Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
993
- * @summary Place crypto order
994
- * @param {TradingApiPlaceCryptoOrderRequest} requestParameters Request parameters.
995
- * @param {*} [options] Override http request option.
996
- * @throws {RequiredError}
997
- * @memberof TradingApiGenerated
998
- */
999
- placeCryptoOrder(requestParameters: TradingApiPlaceCryptoOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderUpdatedResponse, any, {}>>;
1000
- /**
1001
- * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds. This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
1002
- * @summary Place equity order
1003
- * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
1004
- * @param {*} [options] Override http request option.
1005
- * @throws {RequiredError}
1006
- * @memberof TradingApiGenerated
1007
- */
1008
- placeForceOrder(requestParameters: TradingApiPlaceForceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any, {}>>;
1009
- /**
1010
- * Places a multi-leg option order. Only supported on certain option trading brokerages. https://support.snaptrade.com/brokerages has information on brokerage trading support
1011
- * @summary Place option order
1012
- * @param {TradingApiPlaceMlegOrderRequest} requestParameters Request parameters.
1013
- * @param {*} [options] Override http request option.
1014
- * @throws {RequiredError}
1015
- * @memberof TradingApiGenerated
1016
- */
1017
- placeMlegOrder(requestParameters: TradingApiPlaceMlegOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MlegOrderResponse, any, {}>>;
1018
- /**
1019
- * Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
1020
- * @summary Place checked equity order
1021
- * @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
1022
- * @param {*} [options] Override http request option.
1023
- * @throws {RequiredError}
1024
- * @memberof TradingApiGenerated
1025
- */
1026
- placeOrder(requestParameters: TradingApiPlaceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any, {}>>;
1027
- /**
1028
- * Previews an order using the specified account.
1029
- * @summary Preview crypto order
1030
- * @param {TradingApiPreviewCryptoOrderRequest} requestParameters Request parameters.
1031
- * @param {*} [options] Override http request option.
1032
- * @throws {RequiredError}
1033
- * @memberof TradingApiGenerated
1034
- */
1035
- previewCryptoOrder(requestParameters: TradingApiPreviewCryptoOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CryptoOrderPreview, any, {}>>;
1036
- /**
1037
- * Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order\'s brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages
1038
- * @summary Replace order
1039
- * @param {TradingApiReplaceOrderRequest} requestParameters Request parameters.
1040
- * @param {*} [options] Override http request option.
1041
- * @throws {RequiredError}
1042
- * @memberof TradingApiGenerated
1043
- */
1044
- replaceOrder(requestParameters: TradingApiReplaceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any, {}>>;
1045
- /**
1046
- * Searches cryptocurrency pairs instruments accessible to the specified account. Both `base` and `quote` are optional. Omit both for a full list of cryptocurrency pairs.
1047
- * @summary Get crypto pairs
1048
- * @param {TradingApiSearchCryptocurrencyPairInstrumentsRequest} requestParameters Request parameters.
1049
- * @param {*} [options] Override http request option.
1050
- * @throws {RequiredError}
1051
- * @memberof TradingApiGenerated
1052
- */
1053
- searchCryptocurrencyPairInstruments(requestParameters: TradingApiSearchCryptocurrencyPairInstrumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TradingSearchCryptocurrencyPairInstruments200Response, any, {}>>;
1054
- }