snaptrade 2.0.7 → 2.0.8

Sign up to get free protection for your applications and to get access to all the features.
Files changed (431) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -0
  3. data/Gemfile.lock +4 -9
  4. data/README.md +1680 -206
  5. data/lib/snaptrade/api/account_information_api.rb +40 -21
  6. data/lib/snaptrade/api/api_status_api.rb +6 -3
  7. data/lib/snaptrade/api/authentication_api.rb +40 -23
  8. data/lib/snaptrade/api/connections_api.rb +16 -9
  9. data/lib/snaptrade/api/error_logs_api.rb +4 -3
  10. data/lib/snaptrade/api/options_api.rb +24 -15
  11. data/lib/snaptrade/api/reference_data_api.rb +46 -23
  12. data/lib/snaptrade/api/trading_api.rb +38 -27
  13. data/lib/snaptrade/api/transactions_and_reporting_api.rb +12 -5
  14. data/lib/snaptrade/api_client.rb +24 -14
  15. data/lib/snaptrade/api_error.rb +0 -1
  16. data/lib/snaptrade/configuration.rb +11 -29
  17. data/lib/snaptrade/models/account.rb +0 -1
  18. data/lib/snaptrade/models/account_balance.rb +0 -1
  19. data/lib/snaptrade/models/account_balance_total.rb +0 -1
  20. data/lib/snaptrade/models/account_holdings.rb +0 -1
  21. data/lib/snaptrade/models/account_holdings_account.rb +0 -1
  22. data/lib/snaptrade/models/account_order_record.rb +3 -2
  23. data/lib/snaptrade/models/account_order_record_status.rb +0 -1
  24. data/lib/snaptrade/models/account_simple.rb +0 -1
  25. data/lib/snaptrade/models/account_sync_status.rb +0 -1
  26. data/lib/snaptrade/models/action.rb +0 -1
  27. data/lib/snaptrade/models/amount.rb +0 -1
  28. data/lib/snaptrade/models/auth_type.rb +0 -1
  29. data/lib/snaptrade/models/authentication_login_snap_trade_user200_response.rb +0 -1
  30. data/lib/snaptrade/models/balance.rb +0 -1
  31. data/lib/snaptrade/models/brokerage.rb +0 -1
  32. data/lib/snaptrade/models/brokerage_authorization.rb +0 -1
  33. data/lib/snaptrade/models/brokerage_authorization_type.rb +0 -1
  34. data/lib/snaptrade/models/brokerage_authorization_type_read_only.rb +0 -1
  35. data/lib/snaptrade/models/brokerage_authorization_type_read_only_brokerage.rb +0 -1
  36. data/lib/snaptrade/models/brokerage_authorization_type_read_only_type.rb +0 -1
  37. data/lib/snaptrade/models/brokerage_authorization_type_type.rb +0 -1
  38. data/lib/snaptrade/models/brokerage_symbol.rb +0 -1
  39. data/lib/snaptrade/models/brokerage_symbol_option_symbol.rb +0 -1
  40. data/lib/snaptrade/models/brokerage_symbol_symbol.rb +0 -1
  41. data/lib/snaptrade/models/brokerage_type.rb +0 -1
  42. data/lib/snaptrade/models/calculated_trade.rb +0 -1
  43. data/lib/snaptrade/models/cash_restriction.rb +0 -1
  44. data/lib/snaptrade/models/connection_portal_version.rb +0 -1
  45. data/lib/snaptrade/models/connection_type.rb +0 -1
  46. data/lib/snaptrade/models/connections_session_events200_response_inner.rb +0 -1
  47. data/lib/snaptrade/models/currency.rb +0 -1
  48. data/lib/snaptrade/models/delete_user_response.rb +0 -1
  49. data/lib/snaptrade/models/dividend_at_date.rb +0 -1
  50. data/lib/snaptrade/models/encrypted_response.rb +0 -1
  51. data/lib/snaptrade/models/encrypted_response_encrypted_message_data.rb +0 -1
  52. data/lib/snaptrade/models/exchange.rb +0 -1
  53. data/lib/snaptrade/models/exchange_rate_pairs.rb +0 -1
  54. data/lib/snaptrade/models/excluded_asset.rb +0 -1
  55. data/lib/snaptrade/models/jwt.rb +0 -1
  56. data/lib/snaptrade/models/login_redirect_uri.rb +0 -1
  57. data/lib/snaptrade/models/manual_trade.rb +3 -2
  58. data/lib/snaptrade/models/manual_trade_and_impact.rb +0 -1
  59. data/lib/snaptrade/models/manual_trade_balance.rb +0 -1
  60. data/lib/snaptrade/models/manual_trade_form.rb +3 -1
  61. data/lib/snaptrade/models/manual_trade_symbol.rb +0 -1
  62. data/lib/snaptrade/models/model400_failed_request_response.rb +0 -1
  63. data/lib/snaptrade/models/model401_failed_request_response.rb +0 -1
  64. data/lib/snaptrade/models/model403_failed_request_response.rb +0 -1
  65. data/lib/snaptrade/models/model404_failed_request_response.rb +0 -1
  66. data/lib/snaptrade/models/model500_unexpected_exception_response.rb +0 -1
  67. data/lib/snaptrade/models/model_asset_class.rb +0 -1
  68. data/lib/snaptrade/models/model_asset_class_details.rb +0 -1
  69. data/lib/snaptrade/models/model_asset_class_target.rb +0 -1
  70. data/lib/snaptrade/models/model_portfolio.rb +0 -1
  71. data/lib/snaptrade/models/model_portfolio_asset_class.rb +0 -1
  72. data/lib/snaptrade/models/model_portfolio_details.rb +0 -1
  73. data/lib/snaptrade/models/model_portfolio_security.rb +0 -1
  74. data/lib/snaptrade/models/model_type.rb +0 -1
  75. data/lib/snaptrade/models/monthly_dividends.rb +0 -1
  76. data/lib/snaptrade/models/net_contributions.rb +0 -1
  77. data/lib/snaptrade/models/net_dividend.rb +0 -1
  78. data/lib/snaptrade/models/option_chain_inner.rb +0 -1
  79. data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner.rb +0 -1
  80. data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner.rb +0 -1
  81. data/lib/snaptrade/models/option_leg.rb +0 -1
  82. data/lib/snaptrade/models/option_leg_action.rb +0 -1
  83. data/lib/snaptrade/models/option_strategy.rb +0 -1
  84. data/lib/snaptrade/models/option_strategy_legs_inner.rb +0 -1
  85. data/lib/snaptrade/models/option_type.rb +0 -1
  86. data/lib/snaptrade/models/options_get_option_strategy_request.rb +0 -1
  87. data/lib/snaptrade/models/options_holdings.rb +0 -1
  88. data/lib/snaptrade/models/options_place_option_strategy_request.rb +2 -1
  89. data/lib/snaptrade/models/options_position.rb +0 -1
  90. data/lib/snaptrade/models/options_position_currency.rb +0 -1
  91. data/lib/snaptrade/models/options_symbol.rb +0 -1
  92. data/lib/snaptrade/models/order_type.rb +0 -1
  93. data/lib/snaptrade/models/partner_data.rb +0 -1
  94. data/lib/snaptrade/models/past_value.rb +0 -1
  95. data/lib/snaptrade/models/performance_custom.rb +0 -1
  96. data/lib/snaptrade/models/portfolio_group.rb +0 -1
  97. data/lib/snaptrade/models/portfolio_group_info.rb +0 -1
  98. data/lib/snaptrade/models/portfolio_group_position.rb +0 -1
  99. data/lib/snaptrade/models/portfolio_group_settings.rb +0 -1
  100. data/lib/snaptrade/models/position.rb +0 -1
  101. data/lib/snaptrade/models/position_symbol.rb +0 -1
  102. data/lib/snaptrade/models/redirect_tokenand_pin.rb +0 -1
  103. data/lib/snaptrade/models/security_type.rb +0 -1
  104. data/lib/snaptrade/models/session_event.rb +0 -1
  105. data/lib/snaptrade/models/session_event_type.rb +0 -1
  106. data/lib/snaptrade/models/snap_trade_api_disclaimer_accept_status.rb +0 -1
  107. data/lib/snaptrade/models/snap_trade_holdings_account.rb +0 -1
  108. data/lib/snaptrade/models/snap_trade_holdings_account_account_id.rb +0 -1
  109. data/lib/snaptrade/models/snap_trade_holdings_total_value.rb +0 -1
  110. data/lib/snaptrade/models/snap_trade_login_user_request_body.rb +2 -1
  111. data/lib/snaptrade/models/snap_trade_register_user_request_body.rb +0 -1
  112. data/lib/snaptrade/models/state.rb +0 -1
  113. data/lib/snaptrade/models/status.rb +0 -1
  114. data/lib/snaptrade/models/strategy_impact.rb +0 -1
  115. data/lib/snaptrade/models/strategy_impact_legs_inner.rb +0 -1
  116. data/lib/snaptrade/models/strategy_order_place.rb +0 -1
  117. data/lib/snaptrade/models/strategy_order_place_orders_inner.rb +0 -1
  118. data/lib/snaptrade/models/strategy_order_place_orders_inner_legs_inner.rb +0 -1
  119. data/lib/snaptrade/models/strategy_order_record.rb +1 -1
  120. data/lib/snaptrade/models/strategy_order_record_status.rb +0 -1
  121. data/lib/snaptrade/models/strategy_quotes.rb +0 -1
  122. data/lib/snaptrade/models/strategy_quotes_greek.rb +0 -1
  123. data/lib/snaptrade/models/strategy_type.rb +0 -1
  124. data/lib/snaptrade/models/sub_period_return_rate.rb +0 -1
  125. data/lib/snaptrade/models/symbol.rb +0 -1
  126. data/lib/snaptrade/models/symbol_query.rb +0 -1
  127. data/lib/snaptrade/models/symbols_quotes_inner.rb +0 -1
  128. data/lib/snaptrade/models/target_asset.rb +0 -1
  129. data/lib/snaptrade/models/time_in_force_strict.rb +0 -1
  130. data/lib/snaptrade/models/trade.rb +0 -1
  131. data/lib/snaptrade/models/trade_action.rb +0 -1
  132. data/lib/snaptrade/models/trade_execution_status.rb +2 -1
  133. data/lib/snaptrade/models/trade_execution_status_action.rb +0 -1
  134. data/lib/snaptrade/models/trade_impact.rb +0 -1
  135. data/lib/snaptrade/models/trading_cancel_user_account_order_request.rb +0 -1
  136. data/lib/snaptrade/models/trading_place_oco_order_request.rb +0 -1
  137. data/lib/snaptrade/models/transactions_status.rb +0 -1
  138. data/lib/snaptrade/models/type.rb +0 -1
  139. data/lib/snaptrade/models/underlying_symbol.rb +0 -1
  140. data/lib/snaptrade/models/universal_activity.rb +0 -1
  141. data/lib/snaptrade/models/universal_symbol.rb +0 -1
  142. data/lib/snaptrade/models/us_exchange.rb +0 -1
  143. data/lib/snaptrade/models/user_error_log.rb +0 -1
  144. data/lib/snaptrade/models/user_i_dand_secret.rb +0 -1
  145. data/lib/snaptrade/models/user_settings.rb +0 -1
  146. data/lib/snaptrade/models/validated_trade_body.rb +0 -1
  147. data/lib/snaptrade/version.rb +1 -2
  148. data/lib/snaptrade.rb +50 -18
  149. data/snaptrade.gemspec +0 -1
  150. data/spec/api/account_information_api_spec.rb +0 -1
  151. data/spec/api/api_status_api_spec.rb +0 -1
  152. data/spec/api/authentication_api_spec.rb +0 -1
  153. data/spec/api/connections_api_spec.rb +0 -1
  154. data/spec/api/error_logs_api_spec.rb +0 -1
  155. data/spec/api/options_api_spec.rb +0 -1
  156. data/spec/api/reference_data_api_spec.rb +0 -1
  157. data/spec/api/trading_api_spec.rb +0 -1
  158. data/spec/api/transactions_and_reporting_api_spec.rb +0 -1
  159. data/spec/api_client_spec.rb +0 -1
  160. data/spec/configuration_spec.rb +0 -1
  161. data/spec/models/account_balance_spec.rb +0 -1
  162. data/spec/models/account_balance_total_spec.rb +0 -1
  163. data/spec/models/account_holdings_account_spec.rb +0 -1
  164. data/spec/models/account_holdings_spec.rb +0 -1
  165. data/spec/models/account_order_record_spec.rb +0 -1
  166. data/spec/models/account_order_record_status_spec.rb +0 -1
  167. data/spec/models/account_simple_spec.rb +0 -1
  168. data/spec/models/account_spec.rb +0 -1
  169. data/spec/models/account_sync_status_spec.rb +0 -1
  170. data/spec/models/action_spec.rb +0 -1
  171. data/spec/models/amount_spec.rb +0 -1
  172. data/spec/models/auth_type_spec.rb +0 -1
  173. data/spec/models/authentication_login_snap_trade_user200_response_spec.rb +0 -1
  174. data/spec/models/balance_spec.rb +0 -1
  175. data/spec/models/brokerage_authorization_spec.rb +0 -1
  176. data/spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb +0 -1
  177. data/spec/models/brokerage_authorization_type_read_only_spec.rb +0 -1
  178. data/spec/models/brokerage_authorization_type_read_only_type_spec.rb +0 -1
  179. data/spec/models/brokerage_authorization_type_spec.rb +0 -1
  180. data/spec/models/brokerage_authorization_type_type_spec.rb +0 -1
  181. data/spec/models/brokerage_spec.rb +0 -1
  182. data/spec/models/brokerage_symbol_option_symbol_spec.rb +0 -1
  183. data/spec/models/brokerage_symbol_spec.rb +0 -1
  184. data/spec/models/brokerage_symbol_symbol_spec.rb +0 -1
  185. data/spec/models/brokerage_type_spec.rb +0 -1
  186. data/spec/models/calculated_trade_spec.rb +0 -1
  187. data/spec/models/cash_restriction_spec.rb +0 -1
  188. data/spec/models/connection_portal_version_spec.rb +0 -1
  189. data/spec/models/connection_type_spec.rb +0 -1
  190. data/spec/models/connections_session_events200_response_inner_spec.rb +0 -1
  191. data/spec/models/currency_spec.rb +0 -1
  192. data/spec/models/delete_user_response_spec.rb +0 -1
  193. data/spec/models/dividend_at_date_spec.rb +0 -1
  194. data/spec/models/encrypted_response_encrypted_message_data_spec.rb +0 -1
  195. data/spec/models/encrypted_response_spec.rb +0 -1
  196. data/spec/models/exchange_rate_pairs_spec.rb +0 -1
  197. data/spec/models/exchange_spec.rb +0 -1
  198. data/spec/models/excluded_asset_spec.rb +0 -1
  199. data/spec/models/jwt_spec.rb +0 -1
  200. data/spec/models/login_redirect_uri_spec.rb +0 -1
  201. data/spec/models/manual_trade_and_impact_spec.rb +0 -1
  202. data/spec/models/manual_trade_balance_spec.rb +0 -1
  203. data/spec/models/manual_trade_form_spec.rb +0 -1
  204. data/spec/models/manual_trade_spec.rb +0 -1
  205. data/spec/models/manual_trade_symbol_spec.rb +0 -1
  206. data/spec/models/model400_failed_request_response_spec.rb +0 -1
  207. data/spec/models/model401_failed_request_response_spec.rb +0 -1
  208. data/spec/models/model403_failed_request_response_spec.rb +0 -1
  209. data/spec/models/model404_failed_request_response_spec.rb +0 -1
  210. data/spec/models/model500_unexpected_exception_response_spec.rb +0 -1
  211. data/spec/models/model_asset_class_details_spec.rb +0 -1
  212. data/spec/models/model_asset_class_spec.rb +0 -1
  213. data/spec/models/model_asset_class_target_spec.rb +0 -1
  214. data/spec/models/model_portfolio_asset_class_spec.rb +0 -1
  215. data/spec/models/model_portfolio_details_spec.rb +0 -1
  216. data/spec/models/model_portfolio_security_spec.rb +0 -1
  217. data/spec/models/model_portfolio_spec.rb +0 -1
  218. data/spec/models/model_type_spec.rb +0 -1
  219. data/spec/models/monthly_dividends_spec.rb +0 -1
  220. data/spec/models/net_contributions_spec.rb +0 -1
  221. data/spec/models/net_dividend_spec.rb +0 -1
  222. data/spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb +0 -1
  223. data/spec/models/option_chain_inner_chain_per_root_inner_spec.rb +0 -1
  224. data/spec/models/option_chain_inner_spec.rb +0 -1
  225. data/spec/models/option_leg_action_spec.rb +0 -1
  226. data/spec/models/option_leg_spec.rb +0 -1
  227. data/spec/models/option_strategy_legs_inner_spec.rb +0 -1
  228. data/spec/models/option_strategy_spec.rb +0 -1
  229. data/spec/models/option_type_spec.rb +0 -1
  230. data/spec/models/options_get_option_strategy_request_spec.rb +0 -1
  231. data/spec/models/options_holdings_spec.rb +0 -1
  232. data/spec/models/options_place_option_strategy_request_spec.rb +0 -1
  233. data/spec/models/options_position_currency_spec.rb +0 -1
  234. data/spec/models/options_position_spec.rb +0 -1
  235. data/spec/models/options_symbol_spec.rb +0 -1
  236. data/spec/models/order_type_spec.rb +0 -1
  237. data/spec/models/partner_data_spec.rb +0 -1
  238. data/spec/models/past_value_spec.rb +0 -1
  239. data/spec/models/performance_custom_spec.rb +0 -1
  240. data/spec/models/portfolio_group_info_spec.rb +0 -1
  241. data/spec/models/portfolio_group_position_spec.rb +0 -1
  242. data/spec/models/portfolio_group_settings_spec.rb +0 -1
  243. data/spec/models/portfolio_group_spec.rb +0 -1
  244. data/spec/models/position_spec.rb +0 -1
  245. data/spec/models/position_symbol_spec.rb +0 -1
  246. data/spec/models/redirect_tokenand_pin_spec.rb +0 -1
  247. data/spec/models/security_type_spec.rb +0 -1
  248. data/spec/models/session_event_spec.rb +0 -1
  249. data/spec/models/session_event_type_spec.rb +0 -1
  250. data/spec/models/snap_trade_api_disclaimer_accept_status_spec.rb +0 -1
  251. data/spec/models/snap_trade_holdings_account_account_id_spec.rb +0 -1
  252. data/spec/models/snap_trade_holdings_account_spec.rb +0 -1
  253. data/spec/models/snap_trade_holdings_total_value_spec.rb +0 -1
  254. data/spec/models/snap_trade_login_user_request_body_spec.rb +0 -1
  255. data/spec/models/snap_trade_register_user_request_body_spec.rb +0 -1
  256. data/spec/models/state_spec.rb +0 -1
  257. data/spec/models/status_spec.rb +0 -1
  258. data/spec/models/strategy_impact_legs_inner_spec.rb +0 -1
  259. data/spec/models/strategy_impact_spec.rb +0 -1
  260. data/spec/models/strategy_order_place_orders_inner_legs_inner_spec.rb +0 -1
  261. data/spec/models/strategy_order_place_orders_inner_spec.rb +0 -1
  262. data/spec/models/strategy_order_place_spec.rb +0 -1
  263. data/spec/models/strategy_order_record_spec.rb +0 -1
  264. data/spec/models/strategy_order_record_status_spec.rb +0 -1
  265. data/spec/models/strategy_quotes_greek_spec.rb +0 -1
  266. data/spec/models/strategy_quotes_spec.rb +0 -1
  267. data/spec/models/strategy_type_spec.rb +0 -1
  268. data/spec/models/sub_period_return_rate_spec.rb +0 -1
  269. data/spec/models/symbol_query_spec.rb +0 -1
  270. data/spec/models/symbol_spec.rb +0 -1
  271. data/spec/models/symbols_quotes_inner_spec.rb +0 -1
  272. data/spec/models/target_asset_spec.rb +0 -1
  273. data/spec/models/time_in_force_strict_spec.rb +0 -1
  274. data/spec/models/trade_action_spec.rb +0 -1
  275. data/spec/models/trade_execution_status_action_spec.rb +0 -1
  276. data/spec/models/trade_execution_status_spec.rb +0 -1
  277. data/spec/models/trade_impact_spec.rb +0 -1
  278. data/spec/models/trade_spec.rb +0 -1
  279. data/spec/models/trading_cancel_user_account_order_request_spec.rb +0 -1
  280. data/spec/models/trading_place_oco_order_request_spec.rb +0 -1
  281. data/spec/models/transactions_status_spec.rb +0 -1
  282. data/spec/models/type_spec.rb +0 -1
  283. data/spec/models/underlying_symbol_spec.rb +0 -1
  284. data/spec/models/universal_activity_spec.rb +0 -1
  285. data/spec/models/universal_symbol_spec.rb +0 -1
  286. data/spec/models/us_exchange_spec.rb +0 -1
  287. data/spec/models/user_error_log_spec.rb +0 -1
  288. data/spec/models/user_i_dand_secret_spec.rb +0 -1
  289. data/spec/models/user_settings_spec.rb +0 -1
  290. data/spec/models/validated_trade_body_spec.rb +0 -1
  291. data/spec/spec_helper.rb +0 -1
  292. metadata +2 -141
  293. data/docs/APIStatusApi.md +0 -57
  294. data/docs/Account.md +0 -38
  295. data/docs/AccountBalance.md +0 -18
  296. data/docs/AccountBalanceTotal.md +0 -20
  297. data/docs/AccountHoldings.md +0 -24
  298. data/docs/AccountHoldingsAccount.md +0 -26
  299. data/docs/AccountInformationApi.md +0 -544
  300. data/docs/AccountOrderRecord.md +0 -52
  301. data/docs/AccountOrderRecordStatus.md +0 -15
  302. data/docs/AccountSimple.md +0 -24
  303. data/docs/AccountSyncStatus.md +0 -18
  304. data/docs/Action.md +0 -15
  305. data/docs/Amount.md +0 -20
  306. data/docs/AuthType.md +0 -15
  307. data/docs/AuthenticationApi.md +0 -380
  308. data/docs/AuthenticationLoginSnapTradeUser200Response.md +0 -49
  309. data/docs/Balance.md +0 -22
  310. data/docs/Brokerage.md +0 -56
  311. data/docs/BrokerageAuthorization.md +0 -34
  312. data/docs/BrokerageAuthorizationType.md +0 -18
  313. data/docs/BrokerageAuthorizationTypeReadOnly.md +0 -24
  314. data/docs/BrokerageAuthorizationTypeReadOnlyBrokerage.md +0 -22
  315. data/docs/BrokerageAuthorizationTypeReadOnlyType.md +0 -15
  316. data/docs/BrokerageAuthorizationTypeType.md +0 -15
  317. data/docs/BrokerageSymbol.md +0 -28
  318. data/docs/BrokerageSymbolOptionSymbol.md +0 -34
  319. data/docs/BrokerageSymbolSymbol.md +0 -34
  320. data/docs/BrokerageType.md +0 -20
  321. data/docs/CalculatedTrade.md +0 -20
  322. data/docs/CashRestriction.md +0 -26
  323. data/docs/ConnectionPortalVersion.md +0 -15
  324. data/docs/ConnectionType.md +0 -15
  325. data/docs/ConnectionsApi.md +0 -265
  326. data/docs/ConnectionsSessionEvents200ResponseInner.md +0 -30
  327. data/docs/Currency.md +0 -22
  328. data/docs/DeleteUserResponse.md +0 -20
  329. data/docs/DividendAtDate.md +0 -22
  330. data/docs/EncryptedResponse.md +0 -20
  331. data/docs/EncryptedResponseEncryptedMessageData.md +0 -22
  332. data/docs/ErrorLogsApi.md +0 -68
  333. data/docs/Exchange.md +0 -32
  334. data/docs/ExchangeRatePairs.md +0 -22
  335. data/docs/ExcludedAsset.md +0 -18
  336. data/docs/JWT.md +0 -18
  337. data/docs/LoginRedirectURI.md +0 -20
  338. data/docs/ManualTrade.md +0 -32
  339. data/docs/ManualTradeAndImpact.md +0 -22
  340. data/docs/ManualTradeBalance.md +0 -22
  341. data/docs/ManualTradeForm.md +0 -34
  342. data/docs/ManualTradeSymbol.md +0 -28
  343. data/docs/Model400FailedRequestResponse.md +0 -20
  344. data/docs/Model401FailedRequestResponse.md +0 -20
  345. data/docs/Model403FailedRequestResponse.md +0 -20
  346. data/docs/Model404FailedRequestResponse.md +0 -20
  347. data/docs/Model500UnexpectedExceptionResponse.md +0 -22
  348. data/docs/ModelAssetClass.md +0 -20
  349. data/docs/ModelAssetClassDetails.md +0 -20
  350. data/docs/ModelAssetClassTarget.md +0 -18
  351. data/docs/ModelPortfolio.md +0 -22
  352. data/docs/ModelPortfolioAssetClass.md +0 -20
  353. data/docs/ModelPortfolioDetails.md +0 -22
  354. data/docs/ModelPortfolioSecurity.md +0 -20
  355. data/docs/ModelType.md +0 -15
  356. data/docs/MonthlyDividends.md +0 -20
  357. data/docs/NetContributions.md +0 -22
  358. data/docs/NetDividend.md +0 -22
  359. data/docs/OptionChainInner.md +0 -26
  360. data/docs/OptionChainInnerChainPerRootInner.md +0 -22
  361. data/docs/OptionChainInnerChainPerRootInnerChainPerStrikePriceInner.md +0 -22
  362. data/docs/OptionLeg.md +0 -22
  363. data/docs/OptionLegAction.md +0 -15
  364. data/docs/OptionStrategy.md +0 -26
  365. data/docs/OptionStrategyLegsInner.md +0 -24
  366. data/docs/OptionType.md +0 -15
  367. data/docs/OptionsApi.md +0 -390
  368. data/docs/OptionsGetOptionStrategyRequest.md +0 -22
  369. data/docs/OptionsHoldings.md +0 -28
  370. data/docs/OptionsPlaceOptionStrategyRequest.md +0 -22
  371. data/docs/OptionsPosition.md +0 -26
  372. data/docs/OptionsPositionCurrency.md +0 -22
  373. data/docs/OptionsSymbol.md +0 -34
  374. data/docs/OrderType.md +0 -15
  375. data/docs/PartnerData.md +0 -40
  376. data/docs/PastValue.md +0 -22
  377. data/docs/PerformanceCustom.md +0 -54
  378. data/docs/PortfolioGroup.md +0 -20
  379. data/docs/PortfolioGroupInfo.md +0 -38
  380. data/docs/PortfolioGroupPosition.md +0 -22
  381. data/docs/PortfolioGroupSettings.md +0 -26
  382. data/docs/Position.md +0 -28
  383. data/docs/PositionSymbol.md +0 -28
  384. data/docs/RedirectTokenandPin.md +0 -20
  385. data/docs/ReferenceDataApi.md +0 -592
  386. data/docs/SecurityType.md +0 -24
  387. data/docs/SessionEvent.md +0 -30
  388. data/docs/SessionEventType.md +0 -15
  389. data/docs/SnapTradeAPIDisclaimerAcceptStatus.md +0 -20
  390. data/docs/SnapTradeHoldingsAccount.md +0 -32
  391. data/docs/SnapTradeHoldingsAccountAccountId.md +0 -34
  392. data/docs/SnapTradeHoldingsTotalValue.md +0 -20
  393. data/docs/SnapTradeLoginUserRequestBody.md +0 -28
  394. data/docs/SnapTradeRegisterUserRequestBody.md +0 -18
  395. data/docs/State.md +0 -15
  396. data/docs/Status.md +0 -22
  397. data/docs/StrategyImpact.md +0 -38
  398. data/docs/StrategyImpactLegsInner.md +0 -30
  399. data/docs/StrategyOrderPlace.md +0 -20
  400. data/docs/StrategyOrderPlaceOrdersInner.md +0 -102
  401. data/docs/StrategyOrderPlaceOrdersInnerLegsInner.md +0 -30
  402. data/docs/StrategyOrderRecord.md +0 -38
  403. data/docs/StrategyOrderRecordStatus.md +0 -15
  404. data/docs/StrategyQuotes.md +0 -28
  405. data/docs/StrategyQuotesGreek.md +0 -26
  406. data/docs/StrategyType.md +0 -15
  407. data/docs/SubPeriodReturnRate.md +0 -22
  408. data/docs/Symbol.md +0 -32
  409. data/docs/SymbolQuery.md +0 -18
  410. data/docs/SymbolsQuotesInner.md +0 -28
  411. data/docs/TargetAsset.md +0 -28
  412. data/docs/TimeInForceStrict.md +0 -15
  413. data/docs/Trade.md +0 -32
  414. data/docs/TradeAction.md +0 -15
  415. data/docs/TradeExecutionStatus.md +0 -34
  416. data/docs/TradeExecutionStatusAction.md +0 -15
  417. data/docs/TradeImpact.md +0 -26
  418. data/docs/TradingApi.md +0 -491
  419. data/docs/TradingCancelUserAccountOrderRequest.md +0 -18
  420. data/docs/TradingPlaceOCOOrderRequest.md +0 -20
  421. data/docs/TransactionsAndReportingApi.md +0 -183
  422. data/docs/TransactionsStatus.md +0 -20
  423. data/docs/Type.md +0 -15
  424. data/docs/USExchange.md +0 -34
  425. data/docs/UnderlyingSymbol.md +0 -32
  426. data/docs/UniversalActivity.md +0 -50
  427. data/docs/UniversalSymbol.md +0 -34
  428. data/docs/UserErrorLog.md +0 -28
  429. data/docs/UserIDandSecret.md +0 -20
  430. data/docs/UserSettings.md +0 -36
  431. data/docs/ValidatedTradeBody.md +0 -18
data/README.md CHANGED
@@ -1,224 +1,1698 @@
1
- # snaptrade
1
+ <div align="center">
2
+
3
+ [![Visit SnapTrade](./header.png)](https://snaptrade.com)
4
+
5
+ # [SnapTrade](https://snaptrade.com)<a id="snaptrade"></a>
2
6
 
3
7
  Connect brokerage accounts to your app for live positions and trading
4
8
 
5
- For more information, please visit [https://snaptrade.com/](https://snaptrade.com/)
9
+ [![npm](https://img.shields.io/badge/gem-v2.0.8-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.8)
10
+ [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
11
+
12
+ </div>
13
+
14
+ ## Table of Contents<a id="table-of-contents"></a>
6
15
 
7
- ## Installation
16
+ <!-- toc -->
17
+
18
+ - [Installation](#installation)
19
+ - [Getting Started](#getting-started)
20
+ - [Raw HTTP Response](#raw-http-response)
21
+ - [Reference](#reference)
22
+ * [`snaptrade.account_information.get_all_user_holdings`](#snaptradeaccount_informationget_all_user_holdings)
23
+ * [`snaptrade.account_information.get_user_account_balance`](#snaptradeaccount_informationget_user_account_balance)
24
+ * [`snaptrade.account_information.get_user_account_details`](#snaptradeaccount_informationget_user_account_details)
25
+ * [`snaptrade.account_information.get_user_account_orders`](#snaptradeaccount_informationget_user_account_orders)
26
+ * [`snaptrade.account_information.get_user_account_positions`](#snaptradeaccount_informationget_user_account_positions)
27
+ * [`snaptrade.account_information.get_user_holdings`](#snaptradeaccount_informationget_user_holdings)
28
+ * [`snaptrade.account_information.list_user_accounts`](#snaptradeaccount_informationlist_user_accounts)
29
+ * [`snaptrade.account_information.update_user_account`](#snaptradeaccount_informationupdate_user_account)
30
+ * [`snaptrade.api_status.check`](#snaptradeapi_statuscheck)
31
+ * [`snaptrade.authentication.delete_snap_trade_user`](#snaptradeauthenticationdelete_snap_trade_user)
32
+ * [`snaptrade.authentication.get_user_jwt`](#snaptradeauthenticationget_user_jwt)
33
+ * [`snaptrade.authentication.list_snap_trade_users`](#snaptradeauthenticationlist_snap_trade_users)
34
+ * [`snaptrade.authentication.login_snap_trade_user`](#snaptradeauthenticationlogin_snap_trade_user)
35
+ * [`snaptrade.authentication.register_snap_trade_user`](#snaptradeauthenticationregister_snap_trade_user)
36
+ * [`snaptrade.authentication.reset_snap_trade_user_secret`](#snaptradeauthenticationreset_snap_trade_user_secret)
37
+ * [`snaptrade.connections.detail_brokerage_authorization`](#snaptradeconnectionsdetail_brokerage_authorization)
38
+ * [`snaptrade.connections.list_brokerage_authorizations`](#snaptradeconnectionslist_brokerage_authorizations)
39
+ * [`snaptrade.connections.remove_brokerage_authorization`](#snaptradeconnectionsremove_brokerage_authorization)
40
+ * [`snaptrade.connections.session_events`](#snaptradeconnectionssession_events)
41
+ * [`snaptrade.error_logs.list_user_errors`](#snaptradeerror_logslist_user_errors)
42
+ * [`snaptrade.options.get_option_strategy`](#snaptradeoptionsget_option_strategy)
43
+ * [`snaptrade.options.get_options_chain`](#snaptradeoptionsget_options_chain)
44
+ * [`snaptrade.options.get_options_strategy_quote`](#snaptradeoptionsget_options_strategy_quote)
45
+ * [`snaptrade.options.list_option_holdings`](#snaptradeoptionslist_option_holdings)
46
+ * [`snaptrade.options.place_option_strategy`](#snaptradeoptionsplace_option_strategy)
47
+ * [`snaptrade.reference_data.get_currency_exchange_rate_pair`](#snaptradereference_dataget_currency_exchange_rate_pair)
48
+ * [`snaptrade.reference_data.get_partner_info`](#snaptradereference_dataget_partner_info)
49
+ * [`snaptrade.reference_data.get_security_types`](#snaptradereference_dataget_security_types)
50
+ * [`snaptrade.reference_data.get_stock_exchanges`](#snaptradereference_dataget_stock_exchanges)
51
+ * [`snaptrade.reference_data.get_symbols`](#snaptradereference_dataget_symbols)
52
+ * [`snaptrade.reference_data.get_symbols_by_ticker`](#snaptradereference_dataget_symbols_by_ticker)
53
+ * [`snaptrade.reference_data.list_all_brokerage_authorization_type`](#snaptradereference_datalist_all_brokerage_authorization_type)
54
+ * [`snaptrade.reference_data.list_all_brokerages`](#snaptradereference_datalist_all_brokerages)
55
+ * [`snaptrade.reference_data.list_all_currencies`](#snaptradereference_datalist_all_currencies)
56
+ * [`snaptrade.reference_data.list_all_currencies_rates`](#snaptradereference_datalist_all_currencies_rates)
57
+ * [`snaptrade.reference_data.symbol_search_user_account`](#snaptradereference_datasymbol_search_user_account)
58
+ * [`snaptrade.trading.cancel_user_account_order`](#snaptradetradingcancel_user_account_order)
59
+ * [`snaptrade.trading.get_order_impact`](#snaptradetradingget_order_impact)
60
+ * [`snaptrade.trading.get_user_account_quotes`](#snaptradetradingget_user_account_quotes)
61
+ * [`snaptrade.trading.place_force_order`](#snaptradetradingplace_force_order)
62
+ * [`snaptrade.trading.place_oco_order`](#snaptradetradingplace_oco_order)
63
+ * [`snaptrade.trading.place_order`](#snaptradetradingplace_order)
64
+ * [`snaptrade.transactions_and_reporting.get_activities`](#snaptradetransactions_and_reportingget_activities)
65
+ * [`snaptrade.transactions_and_reporting.get_reporting_custom_range`](#snaptradetransactions_and_reportingget_reporting_custom_range)
66
+
67
+ <!-- tocstop -->
68
+
69
+ ## Installation<a id="installation"></a>
8
70
 
9
71
  Add to Gemfile:
10
72
 
11
73
  ```ruby
12
- gem 'snaptrade', '~> 2.0.7'
74
+ gem 'snaptrade', '~> 2.0.8'
13
75
  ```
14
76
 
15
- ## Getting Started
77
+ ## Getting Started<a id="getting-started"></a>
16
78
 
17
79
  ```ruby
18
80
  require 'snaptrade'
19
81
 
20
82
  SnapTrade.client_id = "YOUR_CLIENT_ID"
21
83
  SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
84
+ result = snaptrade.account_information.get_all_user_holdings(
85
+ user_id: "John.doe@snaptrade.com",
86
+ user_secret: "USERSECRET123",
87
+ brokerage_authorizations: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
88
+ )
89
+ p result
90
+ ```
91
+
92
+ ## Raw HTTP Response<a id="raw-http-response"></a>
93
+
94
+ To access the raw HTTP response, suffix any method with `_with_http_info`.
95
+
96
+ ```ruby
97
+ result = snaptrade.account_information.get_all_user_holdings_with_http_info(
98
+ user_id: "John.doe@snaptrade.com",
99
+ user_secret: "USERSECRET123",
100
+ brokerage_authorizations: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
101
+ )
102
+ p result[0] # [Array<AccountHoldings>] Deserialized data
103
+ p.result[1] # [Integer] HTTP status code
104
+ p.result[2] # [Hash] HTTP headers
105
+ p.result[3] # [Faraday::Response] Raw HTTP response
106
+ ```
107
+
108
+ ## Reference<a id="reference"></a>
109
+
110
+
111
+ ### `snaptrade.account_information.get_all_user_holdings`<a id="snaptradeaccount_informationget_all_user_holdings"></a>
112
+
113
+ List all accounts for the user, plus balances, positions, and orders for each account.
114
+
115
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
116
+
117
+ ```ruby
118
+ result = snaptrade.account_information.get_all_user_holdings(
119
+ user_id: "John.doe@snaptrade.com",
120
+ user_secret: "USERSECRET123",
121
+ brokerage_authorizations: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
122
+ )
123
+ p result
124
+ ```
125
+
126
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
127
+
128
+ ##### user_id: `String`<a id="user_id-string"></a>
129
+ ##### user_secret: `String`<a id="user_secret-string"></a>
130
+ ##### brokerage_authorizations: `String`<a id="brokerage_authorizations-string"></a>
131
+ Optional. Comma seperated list of authorization IDs (only use if filtering is
132
+ needed on one or more authorizations).
133
+
134
+ #### 🔄 Return<a id="🔄-return"></a>
135
+
136
+ [AccountHoldings](./lib/snaptrade/models/account_holdings.rb)
137
+
138
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
139
+
140
+ `/holdings` `GET`
141
+
142
+ [🔙 **Back to Table of Contents**](#table-of-contents)
143
+
144
+ ---
145
+
146
+
147
+ ### `snaptrade.account_information.get_user_account_balance`<a id="snaptradeaccount_informationget_user_account_balance"></a>
148
+
149
+ A list of account balances for the specified account (one per currency that the account holds).
150
+
151
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
152
+
153
+ ```ruby
154
+ result = snaptrade.account_information.get_user_account_balance(
155
+ user_id: "John.doe@snaptrade.com",
156
+ user_secret: "USERSECRET123",
157
+ account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
158
+ )
159
+ p result
160
+ ```
161
+
162
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
163
+
164
+ ##### user_id: `String`<a id="user_id-string"></a>
165
+ ##### user_secret: `String`<a id="user_secret-string"></a>
166
+ ##### account_id: `String`<a id="account_id-string"></a>
167
+ The ID of the account to get balances.
168
+
169
+ #### 🔄 Return<a id="🔄-return"></a>
170
+
171
+ [Balance](./lib/snaptrade/models/balance.rb)
172
+
173
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
174
+
175
+ `/accounts/{accountId}/balances` `GET`
176
+
177
+ [🔙 **Back to Table of Contents**](#table-of-contents)
178
+
179
+ ---
180
+
181
+
182
+ ### `snaptrade.account_information.get_user_account_details`<a id="snaptradeaccount_informationget_user_account_details"></a>
183
+
184
+ Return details of a specific investment account
185
+
186
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
187
+
188
+ ```ruby
189
+ result = snaptrade.account_information.get_user_account_details(
190
+ user_id: "John.doe@snaptrade.com",
191
+ user_secret: "USERSECRET123",
192
+ account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
193
+ )
194
+ p result
195
+ ```
196
+
197
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
198
+
199
+ ##### user_id: `String`<a id="user_id-string"></a>
200
+ ##### user_secret: `String`<a id="user_secret-string"></a>
201
+ ##### account_id: `String`<a id="account_id-string"></a>
202
+ The ID of the account to get detail of.
203
+
204
+ #### 🔄 Return<a id="🔄-return"></a>
205
+
206
+ [Account](./lib/snaptrade/models/account.rb)
207
+
208
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
209
+
210
+ `/accounts/{accountId}` `GET`
211
+
212
+ [🔙 **Back to Table of Contents**](#table-of-contents)
213
+
214
+ ---
215
+
216
+
217
+ ### `snaptrade.account_information.get_user_account_orders`<a id="snaptradeaccount_informationget_user_account_orders"></a>
218
+
219
+ Fetch all recent orders from a user's account.
220
+
221
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
222
+
223
+ ```ruby
224
+ result = snaptrade.account_information.get_user_account_orders(
225
+ user_id: "John.doe@snaptrade.com",
226
+ user_secret: "USERSECRET123",
227
+ account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
228
+ state: "all",
229
+ days: 30,
230
+ )
231
+ p result
232
+ ```
233
+
234
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
235
+
236
+ ##### user_id: `String`<a id="user_id-string"></a>
237
+ ##### user_secret: `String`<a id="user_secret-string"></a>
238
+ ##### account_id: `String`<a id="account_id-string"></a>
239
+ The ID of the account to get orders.
240
+
241
+ ##### state: `String`<a id="state-string"></a>
242
+ defaults value is set to \"all\"
243
+
244
+ ##### days: `Integer`<a id="days-integer"></a>
245
+ Number of days in the past to fetch the most recent orders. Defaults to the last
246
+ 90 days if no value is passed in.
247
+
248
+ #### 🔄 Return<a id="🔄-return"></a>
249
+
250
+ [AccountOrderRecord](./lib/snaptrade/models/account_order_record.rb)
251
+
252
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
253
+
254
+ `/accounts/{accountId}/orders` `GET`
255
+
256
+ [🔙 **Back to Table of Contents**](#table-of-contents)
257
+
258
+ ---
259
+
260
+
261
+ ### `snaptrade.account_information.get_user_account_positions`<a id="snaptradeaccount_informationget_user_account_positions"></a>
262
+
263
+ List account positions
264
+
265
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
266
+
267
+ ```ruby
268
+ result = snaptrade.account_information.get_user_account_positions(
269
+ user_id: "John.doe@snaptrade.com",
270
+ user_secret: "USERSECRET123",
271
+ account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
272
+ )
273
+ p result
274
+ ```
275
+
276
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
277
+
278
+ ##### user_id: `String`<a id="user_id-string"></a>
279
+ ##### user_secret: `String`<a id="user_secret-string"></a>
280
+ ##### account_id: `String`<a id="account_id-string"></a>
281
+ The ID of the account to get positions.
282
+
283
+ #### 🔄 Return<a id="🔄-return"></a>
284
+
285
+ [Position](./lib/snaptrade/models/position.rb)
286
+
287
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
288
+
289
+ `/accounts/{accountId}/positions` `GET`
290
+
291
+ [🔙 **Back to Table of Contents**](#table-of-contents)
292
+
293
+ ---
294
+
295
+
296
+ ### `snaptrade.account_information.get_user_holdings`<a id="snaptradeaccount_informationget_user_holdings"></a>
297
+
298
+ List balances, positions and orders for the specified account
299
+
300
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
301
+
302
+ ```ruby
303
+ result = snaptrade.account_information.get_user_holdings(
304
+ account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
305
+ user_id: "John.doe@snaptrade.com",
306
+ user_secret: "USERSECRET123",
307
+ )
308
+ p result
309
+ ```
310
+
311
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
312
+
313
+ ##### account_id: `String`<a id="account_id-string"></a>
314
+ The ID of the account to fetch holdings for.
315
+
316
+ ##### user_id: `String`<a id="user_id-string"></a>
317
+ ##### user_secret: `String`<a id="user_secret-string"></a>
318
+ #### 🔄 Return<a id="🔄-return"></a>
319
+
320
+ [AccountHoldingsAccount](./lib/snaptrade/models/account_holdings_account.rb)
321
+
322
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
323
+
324
+ `/accounts/{accountId}/holdings` `GET`
325
+
326
+ [🔙 **Back to Table of Contents**](#table-of-contents)
327
+
328
+ ---
329
+
330
+
331
+ ### `snaptrade.account_information.list_user_accounts`<a id="snaptradeaccount_informationlist_user_accounts"></a>
332
+
333
+ List accounts
334
+
335
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
336
+
337
+ ```ruby
338
+ result = snaptrade.account_information.list_user_accounts(
339
+ user_id: "John.doe@snaptrade.com",
340
+ user_secret: "USERSECRET123",
341
+ )
342
+ p result
343
+ ```
344
+
345
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
346
+
347
+ ##### user_id: `String`<a id="user_id-string"></a>
348
+ ##### user_secret: `String`<a id="user_secret-string"></a>
349
+ #### 🔄 Return<a id="🔄-return"></a>
350
+
351
+ [Account](./lib/snaptrade/models/account.rb)
352
+
353
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
354
+
355
+ `/accounts` `GET`
356
+
357
+ [🔙 **Back to Table of Contents**](#table-of-contents)
358
+
359
+ ---
360
+
361
+
362
+ ### `snaptrade.account_information.update_user_account`<a id="snaptradeaccount_informationupdate_user_account"></a>
363
+
364
+ Update details of an investment account
365
+
366
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
367
+
368
+ ```ruby
369
+ result = snaptrade.account_information.update_user_account(
370
+ user_id: "John.doe@snaptrade.com",
371
+ user_secret: "USERSECRET123",
372
+ account_id: "accountId_example",
373
+ )
374
+ p result
375
+ ```
376
+
377
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
378
+
379
+ ##### user_id: `String`<a id="user_id-string"></a>
380
+ ##### user_secret: `String`<a id="user_secret-string"></a>
381
+ ##### account_id: `String`<a id="account_id-string"></a>
382
+ The ID of the account to update.
383
+
384
+ #### 🔄 Return<a id="🔄-return"></a>
385
+
386
+ [Account](./lib/snaptrade/models/account.rb)
387
+
388
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
389
+
390
+ `/accounts/{accountId}` `PUT`
391
+
392
+ [🔙 **Back to Table of Contents**](#table-of-contents)
393
+
394
+ ---
395
+
396
+
397
+ ### `snaptrade.api_status.check`<a id="snaptradeapi_statuscheck"></a>
398
+
399
+ Check whether the API is operational and verify timestamps.
400
+
401
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
402
+
403
+ ```ruby
404
+ result = snaptrade.api_status.check
405
+ p result
406
+ ```
407
+
408
+ #### 🔄 Return<a id="🔄-return"></a>
409
+
410
+ [Status](./lib/snaptrade/models/status.rb)
411
+
412
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
413
+
414
+ `/` `GET`
415
+
416
+ [🔙 **Back to Table of Contents**](#table-of-contents)
417
+
418
+ ---
419
+
420
+
421
+ ### `snaptrade.authentication.delete_snap_trade_user`<a id="snaptradeauthenticationdelete_snap_trade_user"></a>
422
+
423
+ Deletes a user you've registered over the SnapTrade API, and any data associated with them or their investment accounts.
424
+
425
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
426
+
427
+ ```ruby
428
+ result = snaptrade.authentication.delete_snap_trade_user(
429
+ user_id: "John.doe@snaptrade.com",
430
+ )
431
+ p result
432
+ ```
433
+
434
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
435
+
436
+ ##### user_id: `String`<a id="user_id-string"></a>
437
+ #### 🔄 Return<a id="🔄-return"></a>
438
+
439
+ [DeleteUserResponse](./lib/snaptrade/models/delete_user_response.rb)
440
+
441
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
442
+
443
+ `/snapTrade/deleteUser` `DELETE`
444
+
445
+ [🔙 **Back to Table of Contents**](#table-of-contents)
446
+
447
+ ---
448
+
449
+
450
+ ### `snaptrade.authentication.get_user_jwt`<a id="snaptradeauthenticationget_user_jwt"></a>
451
+
452
+ Generate encrypted JWT token
453
+
454
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
455
+
456
+ ```ruby
457
+ result = snaptrade.authentication.get_user_jwt(
458
+ user_id: "John.doe@snaptrade.com",
459
+ user_secret: "USERSECRET123",
460
+ )
461
+ p result
462
+ ```
463
+
464
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
465
+
466
+ ##### user_id: `String`<a id="user_id-string"></a>
467
+ ##### user_secret: `String`<a id="user_secret-string"></a>
468
+ #### 🔄 Return<a id="🔄-return"></a>
469
+
470
+ [EncryptedResponse](./lib/snaptrade/models/encrypted_response.rb)
471
+
472
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
473
+
474
+ `/snapTrade/encryptedJWT` `GET`
475
+
476
+ [🔙 **Back to Table of Contents**](#table-of-contents)
477
+
478
+ ---
479
+
480
+
481
+ ### `snaptrade.authentication.list_snap_trade_users`<a id="snaptradeauthenticationlist_snap_trade_users"></a>
482
+
483
+ Returns a list of users you've registered over the SnapTrade API.
484
+
485
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
486
+
487
+ ```ruby
488
+ result = snaptrade.authentication.list_snap_trade_users
489
+ p result
490
+ ```
491
+
492
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
493
+
494
+ `/snapTrade/listUsers` `GET`
495
+
496
+ [🔙 **Back to Table of Contents**](#table-of-contents)
497
+
498
+ ---
499
+
500
+
501
+ ### `snaptrade.authentication.login_snap_trade_user`<a id="snaptradeauthenticationlogin_snap_trade_user"></a>
502
+
503
+ Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
504
+
505
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
506
+
507
+ ```ruby
508
+ result = snaptrade.authentication.login_snap_trade_user(
509
+ user_id: "John.doe@snaptrade.com",
510
+ user_secret: "USERSECRET123",
511
+ broker: "ALPACA",
512
+ immediate_redirect: true,
513
+ custom_redirect: "https://snaptrade.com",
514
+ reconnect: "8b5f262d-4bb9-365d-888a-202bd3b15fa1",
515
+ connection_type: "read",
516
+ connection_portal_version: "v2",
517
+ )
518
+ p result
519
+ ```
520
+
521
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
522
+
523
+ ##### user_id: `String`<a id="user_id-string"></a>
524
+ ##### user_secret: `String`<a id="user_secret-string"></a>
525
+ ##### broker: `String`<a id="broker-string"></a>
526
+ Slug of the brokerage to connect the user to
527
+
528
+ ##### immediateRedirect: `Boolean`<a id="immediateredirect-boolean"></a>
529
+ When set to True, user will be redirected back to the partner's site instead of
530
+ the connection portal
531
+
532
+ ##### customRedirect: `String`<a id="customredirect-string"></a>
533
+ URL to redirect the user to after the user connects their brokerage account
534
+
535
+ ##### reconnect: `String`<a id="reconnect-string"></a>
536
+ The UUID of the brokerage connection to be reconnected. This parameter should be
537
+ left empty unless you are reconnecting a disabled connection. See ‘Reconnecting
538
+ Accounts’ for more information.
539
+
540
+ ##### connectionType: [`ConnectionType`](./lib/snaptrade/models/connection_type.rb)<a id="connectiontype-connectiontypelibsnaptrademodelsconnection_typerb"></a>
541
+ Sets whether the connection should be read or trade
542
+
543
+ ##### connectionPortalVersion: [`ConnectionPortalVersion`](./lib/snaptrade/models/connection_portal_version.rb)<a id="connectionportalversion-connectionportalversionlibsnaptrademodelsconnection_portal_versionrb"></a>
544
+ Sets the version of the connection portal to render, with a default to 'v2'
545
+
546
+ #### 🔄 Return<a id="🔄-return"></a>
547
+
548
+ [AuthenticationLoginSnapTradeUser200Response](./lib/snaptrade/models/authentication_login_snap_trade_user200_response.rb)
549
+
550
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
551
+
552
+ `/snapTrade/login` `POST`
553
+
554
+ [🔙 **Back to Table of Contents**](#table-of-contents)
555
+
556
+ ---
557
+
558
+
559
+ ### `snaptrade.authentication.register_snap_trade_user`<a id="snaptradeauthenticationregister_snap_trade_user"></a>
560
+
561
+ Create SnapTrade user
562
+
563
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
564
+
565
+ ```ruby
566
+ result = snaptrade.authentication.register_snap_trade_user(
567
+ user_id: "snaptrade-user-123",
568
+ )
569
+ p result
570
+ ```
571
+
572
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
573
+
574
+ ##### userId: `String`<a id="userid-string"></a>
575
+ SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as
576
+ it's unique to a user
577
+
578
+ #### 🔄 Return<a id="🔄-return"></a>
579
+
580
+ [UserIDandSecret](./lib/snaptrade/models/user_i_dand_secret.rb)
581
+
582
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
583
+
584
+ `/snapTrade/registerUser` `POST`
585
+
586
+ [🔙 **Back to Table of Contents**](#table-of-contents)
587
+
588
+ ---
589
+
590
+
591
+ ### `snaptrade.authentication.reset_snap_trade_user_secret`<a id="snaptradeauthenticationreset_snap_trade_user_secret"></a>
592
+
593
+ Obtain a new user secret for a user
594
+
595
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
596
+
597
+ ```ruby
598
+ result = snaptrade.authentication.reset_snap_trade_user_secret(
599
+ user_id: "snaptrade-user-123",
600
+ user_secret: "h81@cx1lkalablakwjaltkejraj11=",
601
+ )
602
+ p result
603
+ ```
604
+
605
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
606
+
607
+ ##### userId: `String`<a id="userid-string"></a>
608
+ SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as
609
+ it's unique to a user
610
+
611
+ ##### userSecret: `String`<a id="usersecret-string"></a>
612
+ SnapTrade User Secret randomly generated by SnapTrade. This should be considered
613
+ priviledged information and if compromised, you should delete and re-create this
614
+ SnapTrade user.
615
+
616
+ #### 🔄 Return<a id="🔄-return"></a>
617
+
618
+ [UserIDandSecret](./lib/snaptrade/models/user_i_dand_secret.rb)
619
+
620
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
621
+
622
+ `/snapTrade/resetUserSecret` `POST`
623
+
624
+ [🔙 **Back to Table of Contents**](#table-of-contents)
625
+
626
+ ---
627
+
628
+
629
+ ### `snaptrade.connections.detail_brokerage_authorization`<a id="snaptradeconnectionsdetail_brokerage_authorization"></a>
630
+
631
+ Get brokerage authorization details
632
+
633
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
634
+
635
+ ```ruby
636
+ result = snaptrade.connections.detail_brokerage_authorization(
637
+ authorization_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
638
+ user_id: "John.doe@snaptrade.com",
639
+ user_secret: "USERSECRET123",
640
+ )
641
+ p result
642
+ ```
643
+
644
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
645
+
646
+ ##### authorization_id: `String`<a id="authorization_id-string"></a>
647
+ The ID of a brokerage authorization object.
648
+
649
+ ##### user_id: `String`<a id="user_id-string"></a>
650
+ ##### user_secret: `String`<a id="user_secret-string"></a>
651
+ #### 🔄 Return<a id="🔄-return"></a>
652
+
653
+ [BrokerageAuthorization](./lib/snaptrade/models/brokerage_authorization.rb)
654
+
655
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
656
+
657
+ `/authorizations/{authorizationId}` `GET`
658
+
659
+ [🔙 **Back to Table of Contents**](#table-of-contents)
660
+
661
+ ---
662
+
663
+
664
+ ### `snaptrade.connections.list_brokerage_authorizations`<a id="snaptradeconnectionslist_brokerage_authorizations"></a>
665
+
666
+ List all brokerage authorizations for the user
667
+
668
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
669
+
670
+ ```ruby
671
+ result = snaptrade.connections.list_brokerage_authorizations(
672
+ user_id: "John.doe@snaptrade.com",
673
+ user_secret: "USERSECRET123",
674
+ )
675
+ p result
676
+ ```
677
+
678
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
679
+
680
+ ##### user_id: `String`<a id="user_id-string"></a>
681
+ ##### user_secret: `String`<a id="user_secret-string"></a>
682
+ #### 🔄 Return<a id="🔄-return"></a>
683
+
684
+ [BrokerageAuthorization](./lib/snaptrade/models/brokerage_authorization.rb)
685
+
686
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
687
+
688
+ `/authorizations` `GET`
689
+
690
+ [🔙 **Back to Table of Contents**](#table-of-contents)
691
+
692
+ ---
693
+
694
+
695
+ ### `snaptrade.connections.remove_brokerage_authorization`<a id="snaptradeconnectionsremove_brokerage_authorization"></a>
696
+
697
+ Delete brokerage authorization
698
+
699
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
700
+
701
+ ```ruby
702
+ snaptrade.connections.remove_brokerage_authorization(
703
+ authorization_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
704
+ user_id: "John.doe@snaptrade.com",
705
+ user_secret: "USERSECRET123",
706
+ )
707
+ ```
708
+
709
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
710
+
711
+ ##### authorization_id: `String`<a id="authorization_id-string"></a>
712
+ The ID of the Authorization to delete.
713
+
714
+ ##### user_id: `String`<a id="user_id-string"></a>
715
+ ##### user_secret: `String`<a id="user_secret-string"></a>
716
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
717
+
718
+ `/authorizations/{authorizationId}` `DELETE`
719
+
720
+ [🔙 **Back to Table of Contents**](#table-of-contents)
721
+
722
+ ---
723
+
724
+
725
+ ### `snaptrade.connections.session_events`<a id="snaptradeconnectionssession_events"></a>
726
+
727
+ List all session events for the partner
728
+
729
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
730
+
731
+ ```ruby
732
+ result = snaptrade.connections.session_events(
733
+ partner_client_id: "SNAPTRADETEST",
734
+ user_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
735
+ session_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
736
+ )
737
+ p result
738
+ ```
739
+
740
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
741
+
742
+ ##### partner_client_id: `String`<a id="partner_client_id-string"></a>
743
+ ##### user_id: `String`<a id="user_id-string"></a>
744
+ Optional comma seperated list of user IDs used to filter the request on specific
745
+ users
746
+
747
+ ##### session_id: `String`<a id="session_id-string"></a>
748
+ Optional comma seperated list of session IDs used to filter the request on
749
+ specific users
750
+
751
+ #### 🔄 Return<a id="🔄-return"></a>
752
+
753
+ [ConnectionsSessionEvents200ResponseInner](./lib/snaptrade/models/connections_session_events200_response_inner.rb)
754
+
755
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
756
+
757
+ `/sessionEvents` `GET`
758
+
759
+ [🔙 **Back to Table of Contents**](#table-of-contents)
760
+
761
+ ---
762
+
763
+
764
+ ### `snaptrade.error_logs.list_user_errors`<a id="snaptradeerror_logslist_user_errors"></a>
765
+
766
+ Retrieve error logs on behalf of your SnapTrade users
767
+
768
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
769
+
770
+ ```ruby
771
+ result = snaptrade.error_logs.list_user_errors(
772
+ user_id: "John.doe@snaptrade.com",
773
+ user_secret: "USERSECRET123",
774
+ )
775
+ p result
776
+ ```
777
+
778
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
779
+
780
+ ##### user_id: `String`<a id="user_id-string"></a>
781
+ ##### user_secret: `String`<a id="user_secret-string"></a>
782
+ #### 🔄 Return<a id="🔄-return"></a>
783
+
784
+ [UserErrorLog](./lib/snaptrade/models/user_error_log.rb)
785
+
786
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
787
+
788
+ `/snapTrade/listUserErrors` `GET`
789
+
790
+ [🔙 **Back to Table of Contents**](#table-of-contents)
791
+
792
+ ---
793
+
794
+
795
+ ### `snaptrade.options.get_option_strategy`<a id="snaptradeoptionsget_option_strategy"></a>
796
+
797
+ Creates an option strategy object that will be used to place an option strategy order
798
+
799
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
800
+
801
+ ```ruby
802
+ result = snaptrade.options.get_option_strategy(
803
+ underlying_symbol_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
804
+ legs: [
805
+ {
806
+ "action" => "BUY_TO_OPEN",
807
+ "option_symbol_id" => "SPY220819P00200000",
808
+ "quantity" => 1,
809
+ }
810
+ ],
811
+ strategy_type: "CUSTOM",
812
+ user_id: "John.doe@snaptrade.com",
813
+ user_secret: "USERSECRET123",
814
+ account_id: "accountId_example",
815
+ )
816
+ p result
817
+ ```
818
+
819
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
820
+
821
+ ##### underlying_symbol_id: `String`<a id="underlying_symbol_id-string"></a>
822
+ ##### legs: Array<[`OptionLeg`](./lib/snaptrade/models/option_leg.rb)><a id="legs-array"></a>
823
+ ##### strategy_type: [`StrategyType`](./lib/snaptrade/models/strategy_type.rb)<a id="strategy_type-strategytypelibsnaptrademodelsstrategy_typerb"></a>
824
+ ##### user_id: `String`<a id="user_id-string"></a>
825
+ ##### user_secret: `String`<a id="user_secret-string"></a>
826
+ ##### account_id: `String`<a id="account_id-string"></a>
827
+ The ID of the account to create the option strategy object in.
828
+
829
+ #### 🔄 Return<a id="🔄-return"></a>
830
+
831
+ [StrategyQuotes](./lib/snaptrade/models/strategy_quotes.rb)
832
+
833
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
834
+
835
+ `/accounts/{accountId}/optionStrategy` `POST`
836
+
837
+ [🔙 **Back to Table of Contents**](#table-of-contents)
838
+
839
+ ---
840
+
841
+
842
+ ### `snaptrade.options.get_options_chain`<a id="snaptradeoptionsget_options_chain"></a>
843
+
844
+ Get the options chain
845
+
846
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
847
+
848
+ ```ruby
849
+ result = snaptrade.options.get_options_chain(
850
+ user_id: "John.doe@snaptrade.com",
851
+ user_secret: "USERSECRET123",
852
+ account_id: "accountId_example",
853
+ symbol: "symbol_example",
854
+ )
855
+ p result
856
+ ```
857
+
858
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
859
+
860
+ ##### user_id: `String`<a id="user_id-string"></a>
861
+ ##### user_secret: `String`<a id="user_secret-string"></a>
862
+ ##### account_id: `String`<a id="account_id-string"></a>
863
+ The ID of the account to get the options chain from.
864
+
865
+ ##### symbol: `String`<a id="symbol-string"></a>
866
+ Universal symbol ID if symbol
867
+
868
+ #### 🔄 Return<a id="🔄-return"></a>
869
+
870
+ [OptionChainInner](./lib/snaptrade/models/option_chain_inner.rb)
871
+
872
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
873
+
874
+ `/accounts/{accountId}/optionsChain` `GET`
875
+
876
+ [🔙 **Back to Table of Contents**](#table-of-contents)
877
+
878
+ ---
879
+
880
+
881
+ ### `snaptrade.options.get_options_strategy_quote`<a id="snaptradeoptionsget_options_strategy_quote"></a>
882
+
883
+ Get latest market data of option strategy
884
+
885
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
886
+
887
+ ```ruby
888
+ result = snaptrade.options.get_options_strategy_quote(
889
+ user_id: "John.doe@snaptrade.com",
890
+ user_secret: "USERSECRET123",
891
+ account_id: "accountId_example",
892
+ option_strategy_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
893
+ )
894
+ p result
895
+ ```
896
+
897
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
898
+
899
+ ##### user_id: `String`<a id="user_id-string"></a>
900
+ ##### user_secret: `String`<a id="user_secret-string"></a>
901
+ ##### account_id: `String`<a id="account_id-string"></a>
902
+ The ID of the account the strategy will be placed in.
903
+
904
+ ##### option_strategy_id: `String`<a id="option_strategy_id-string"></a>
905
+ Option strategy id obtained from response when creating option strategy object
906
+
907
+ #### 🔄 Return<a id="🔄-return"></a>
908
+
909
+ [StrategyQuotes](./lib/snaptrade/models/strategy_quotes.rb)
910
+
911
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
912
+
913
+ `/accounts/{accountId}/optionStrategy/{optionStrategyId}` `GET`
914
+
915
+ [🔙 **Back to Table of Contents**](#table-of-contents)
916
+
917
+ ---
918
+
919
+
920
+ ### `snaptrade.options.list_option_holdings`<a id="snaptradeoptionslist_option_holdings"></a>
921
+
922
+ Get the options holdings in the account
923
+
924
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
925
+
926
+ ```ruby
927
+ result = snaptrade.options.list_option_holdings(
928
+ user_id: "John.doe@snaptrade.com",
929
+ user_secret: "USERSECRET123",
930
+ account_id: "accountId_example",
931
+ )
932
+ p result
933
+ ```
934
+
935
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
936
+
937
+ ##### user_id: `String`<a id="user_id-string"></a>
938
+ ##### user_secret: `String`<a id="user_secret-string"></a>
939
+ ##### account_id: `String`<a id="account_id-string"></a>
940
+ The ID of the account to fetch options holdings for.
941
+
942
+ #### 🔄 Return<a id="🔄-return"></a>
943
+
944
+ [OptionsPosition](./lib/snaptrade/models/options_position.rb)
945
+
946
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
947
+
948
+ `/accounts/{accountId}/options` `GET`
949
+
950
+ [🔙 **Back to Table of Contents**](#table-of-contents)
951
+
952
+ ---
953
+
954
+
955
+ ### `snaptrade.options.place_option_strategy`<a id="snaptradeoptionsplace_option_strategy"></a>
956
+
957
+ Place an option strategy order on the brokerage
958
+
959
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
960
+
961
+ ```ruby
962
+ result = snaptrade.options.place_option_strategy(
963
+ order_type: "Limit",
964
+ time_in_force: "FOK",
965
+ user_id: "John.doe@snaptrade.com",
966
+ user_secret: "USERSECRET123",
967
+ account_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
968
+ option_strategy_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
969
+ price: 31.33,
970
+ )
971
+ p result
972
+ ```
973
+
974
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
975
+
976
+ ##### order_type: [`OrderType`](./lib/snaptrade/models/order_type.rb)<a id="order_type-ordertypelibsnaptrademodelsorder_typerb"></a>
977
+ Order Type
978
+
979
+ ##### time_in_force: [`TimeInForceStrict`](./lib/snaptrade/models/time_in_force_strict.rb)<a id="time_in_force-timeinforcestrictlibsnaptrademodelstime_in_force_strictrb"></a>
980
+ Trade time in force examples: * FOK - Fill Or Kill * Day - Day * GTC - Good Til
981
+ Canceled
982
+
983
+ ##### user_id: `String`<a id="user_id-string"></a>
984
+ ##### user_secret: `String`<a id="user_secret-string"></a>
985
+ ##### account_id: `String`<a id="account_id-string"></a>
986
+ The ID of the account to execute the strategy in.
987
+
988
+ ##### option_strategy_id: `String`<a id="option_strategy_id-string"></a>
989
+ Option strategy id obtained from response when creating option strategy object
990
+
991
+ ##### price: `Float`<a id="price-float"></a>
992
+ Trade Price if limit or stop limit order
993
+
994
+ #### 🔄 Return<a id="🔄-return"></a>
995
+
996
+ [StrategyOrderRecord](./lib/snaptrade/models/strategy_order_record.rb)
997
+
998
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
999
+
1000
+ `/accounts/{accountId}/optionStrategy/{optionStrategyId}/execute` `POST`
1001
+
1002
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1003
+
1004
+ ---
1005
+
1006
+
1007
+ ### `snaptrade.reference_data.get_currency_exchange_rate_pair`<a id="snaptradereference_dataget_currency_exchange_rate_pair"></a>
1008
+
1009
+ Return the exchange rate of a currency pair
1010
+
1011
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1012
+
1013
+ ```ruby
1014
+ result = snaptrade.reference_data.get_currency_exchange_rate_pair(
1015
+ currency_pair: "currencyPair_example",
1016
+ )
1017
+ p result
1018
+ ```
1019
+
1020
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1021
+
1022
+ ##### currency_pair: `String`<a id="currency_pair-string"></a>
1023
+ A currency pair based on currency code for example, {CAD-USD}
1024
+
1025
+ #### 🔄 Return<a id="🔄-return"></a>
1026
+
1027
+ [ExchangeRatePairs](./lib/snaptrade/models/exchange_rate_pairs.rb)
1028
+
1029
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1030
+
1031
+ `/currencies/rates/{currencyPair}` `GET`
1032
+
1033
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1034
+
1035
+ ---
1036
+
1037
+
1038
+ ### `snaptrade.reference_data.get_partner_info`<a id="snaptradereference_dataget_partner_info"></a>
1039
+
1040
+ Get metadata related to Snaptrade partner
1041
+
1042
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1043
+
1044
+ ```ruby
1045
+ result = snaptrade.reference_data.get_partner_info
1046
+ p result
1047
+ ```
1048
+
1049
+ #### 🔄 Return<a id="🔄-return"></a>
1050
+
1051
+ [PartnerData](./lib/snaptrade/models/partner_data.rb)
1052
+
1053
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1054
+
1055
+ `/snapTrade/partners` `GET`
1056
+
1057
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1058
+
1059
+ ---
1060
+
1061
+
1062
+ ### `snaptrade.reference_data.get_security_types`<a id="snaptradereference_dataget_security_types"></a>
1063
+
1064
+ List security types available on SnapTrade.
1065
+
1066
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1067
+
1068
+ ```ruby
1069
+ result = snaptrade.reference_data.get_security_types
1070
+ p result
1071
+ ```
1072
+
1073
+ #### 🔄 Return<a id="🔄-return"></a>
1074
+
1075
+ [SecurityType](./lib/snaptrade/models/security_type.rb)
1076
+
1077
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1078
+
1079
+ `/securityTypes` `GET`
1080
+
1081
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1082
+
1083
+ ---
1084
+
1085
+
1086
+ ### `snaptrade.reference_data.get_stock_exchanges`<a id="snaptradereference_dataget_stock_exchanges"></a>
1087
+
1088
+ List exchanges
1089
+
1090
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1091
+
1092
+ ```ruby
1093
+ result = snaptrade.reference_data.get_stock_exchanges
1094
+ p result
1095
+ ```
1096
+
1097
+ #### 🔄 Return<a id="🔄-return"></a>
1098
+
1099
+ [Exchange](./lib/snaptrade/models/exchange.rb)
1100
+
1101
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1102
+
1103
+ `/exchanges` `GET`
1104
+
1105
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1106
+
1107
+ ---
1108
+
1109
+
1110
+ ### `snaptrade.reference_data.get_symbols`<a id="snaptradereference_dataget_symbols"></a>
1111
+
1112
+ Search for symbols
1113
+
1114
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1115
+
1116
+ ```ruby
1117
+ result = snaptrade.reference_data.get_symbols(
1118
+ substring: "apple",
1119
+ )
1120
+ p result
1121
+ ```
1122
+
1123
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1124
+
1125
+ ##### substring: `String`<a id="substring-string"></a>
1126
+ #### 🔄 Return<a id="🔄-return"></a>
1127
+
1128
+ [UniversalSymbol](./lib/snaptrade/models/universal_symbol.rb)
1129
+
1130
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1131
+
1132
+ `/symbols` `POST`
1133
+
1134
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1135
+
1136
+ ---
1137
+
1138
+
1139
+ ### `snaptrade.reference_data.get_symbols_by_ticker`<a id="snaptradereference_dataget_symbols_by_ticker"></a>
1140
+
1141
+ Get details of a symbol by the ticker or the universal_symbol_id
1142
+
1143
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1144
+
1145
+ ```ruby
1146
+ result = snaptrade.reference_data.get_symbols_by_ticker(
1147
+ query: "query_example",
1148
+ )
1149
+ p result
1150
+ ```
1151
+
1152
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1153
+
1154
+ ##### query: `String`<a id="query-string"></a>
1155
+ The ticker or universal_symbol_id of the UniversalSymbol to get.
1156
+
1157
+ #### 🔄 Return<a id="🔄-return"></a>
1158
+
1159
+ [UniversalSymbol](./lib/snaptrade/models/universal_symbol.rb)
1160
+
1161
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1162
+
1163
+ `/symbols/{query}` `GET`
1164
+
1165
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1166
+
1167
+ ---
1168
+
1169
+
1170
+ ### `snaptrade.reference_data.list_all_brokerage_authorization_type`<a id="snaptradereference_datalist_all_brokerage_authorization_type"></a>
1171
+
1172
+ List of all brokerage authorization types
1173
+
1174
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1175
+
1176
+ ```ruby
1177
+ result = snaptrade.reference_data.list_all_brokerage_authorization_type(
1178
+ brokerage: "QUESTRADE,ALPACA",
1179
+ )
1180
+ p result
1181
+ ```
1182
+
1183
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1184
+
1185
+ ##### brokerage: `String`<a id="brokerage-string"></a>
1186
+ Comma separated value of brokerage slugs
1187
+
1188
+ #### 🔄 Return<a id="🔄-return"></a>
1189
+
1190
+ [BrokerageAuthorizationTypeReadOnly](./lib/snaptrade/models/brokerage_authorization_type_read_only.rb)
1191
+
1192
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1193
+
1194
+ `/brokerageAuthorizationTypes` `GET`
1195
+
1196
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1197
+
1198
+ ---
1199
+
1200
+
1201
+ ### `snaptrade.reference_data.list_all_brokerages`<a id="snaptradereference_datalist_all_brokerages"></a>
1202
+
1203
+ List brokerages
1204
+
1205
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1206
+
1207
+ ```ruby
1208
+ result = snaptrade.reference_data.list_all_brokerages
1209
+ p result
1210
+ ```
1211
+
1212
+ #### 🔄 Return<a id="🔄-return"></a>
1213
+
1214
+ [Brokerage](./lib/snaptrade/models/brokerage.rb)
1215
+
1216
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1217
+
1218
+ `/brokerages` `GET`
1219
+
1220
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1221
+
1222
+ ---
1223
+
1224
+
1225
+ ### `snaptrade.reference_data.list_all_currencies`<a id="snaptradereference_datalist_all_currencies"></a>
1226
+
1227
+ List currencies
1228
+
1229
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1230
+
1231
+ ```ruby
1232
+ result = snaptrade.reference_data.list_all_currencies
1233
+ p result
1234
+ ```
1235
+
1236
+ #### 🔄 Return<a id="🔄-return"></a>
1237
+
1238
+ [Currency](./lib/snaptrade/models/currency.rb)
1239
+
1240
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1241
+
1242
+ `/currencies` `GET`
1243
+
1244
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1245
+
1246
+ ---
1247
+
1248
+
1249
+ ### `snaptrade.reference_data.list_all_currencies_rates`<a id="snaptradereference_datalist_all_currencies_rates"></a>
1250
+
1251
+ List currency exchange rates
1252
+
1253
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1254
+
1255
+ ```ruby
1256
+ result = snaptrade.reference_data.list_all_currencies_rates
1257
+ p result
1258
+ ```
1259
+
1260
+ #### 🔄 Return<a id="🔄-return"></a>
1261
+
1262
+ [ExchangeRatePairs](./lib/snaptrade/models/exchange_rate_pairs.rb)
1263
+
1264
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1265
+
1266
+ `/currencies/rates` `GET`
1267
+
1268
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1269
+
1270
+ ---
1271
+
1272
+
1273
+ ### `snaptrade.reference_data.symbol_search_user_account`<a id="snaptradereference_datasymbol_search_user_account"></a>
1274
+
1275
+ Search for symbols available in an account
1276
+
1277
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1278
+
1279
+ ```ruby
1280
+ result = snaptrade.reference_data.symbol_search_user_account(
1281
+ user_id: "John.doe@snaptrade.com",
1282
+ user_secret: "USERSECRET123",
1283
+ account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
1284
+ substring: "apple",
1285
+ )
1286
+ p result
1287
+ ```
1288
+
1289
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1290
+
1291
+ ##### user_id: `String`<a id="user_id-string"></a>
1292
+ ##### user_secret: `String`<a id="user_secret-string"></a>
1293
+ ##### account_id: `String`<a id="account_id-string"></a>
1294
+ The ID of the account to search for symbols within.
1295
+
1296
+ ##### substring: `String`<a id="substring-string"></a>
1297
+ #### 🔄 Return<a id="🔄-return"></a>
1298
+
1299
+ [UniversalSymbol](./lib/snaptrade/models/universal_symbol.rb)
1300
+
1301
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1302
+
1303
+ `/accounts/{accountId}/symbols` `POST`
1304
+
1305
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1306
+
1307
+ ---
1308
+
1309
+
1310
+ ### `snaptrade.trading.cancel_user_account_order`<a id="snaptradetradingcancel_user_account_order"></a>
1311
+
1312
+ Cancel open order in account
1313
+
1314
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1315
+
1316
+ ```ruby
1317
+ result = snaptrade.trading.cancel_user_account_order(
1318
+ user_id: "John.doe@snaptrade.com",
1319
+ user_secret: "USERSECRET123",
1320
+ account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
1321
+ brokerage_order_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
1322
+ )
1323
+ p result
1324
+ ```
1325
+
1326
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1327
+
1328
+ ##### user_id: `String`<a id="user_id-string"></a>
1329
+ ##### user_secret: `String`<a id="user_secret-string"></a>
1330
+ ##### account_id: `String`<a id="account_id-string"></a>
1331
+ The ID of the account to cancel the order in.
1332
+
1333
+ ##### brokerage_order_id: `String`<a id="brokerage_order_id-string"></a>
1334
+ #### 🔄 Return<a id="🔄-return"></a>
1335
+
1336
+ [AccountOrderRecord](./lib/snaptrade/models/account_order_record.rb)
1337
+
1338
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1339
+
1340
+ `/accounts/{accountId}/orders/cancel` `POST`
1341
+
1342
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1343
+
1344
+ ---
1345
+
1346
+
1347
+ ### `snaptrade.trading.get_order_impact`<a id="snaptradetradingget_order_impact"></a>
1348
+
1349
+ Check impact of trades on account.
1350
+
1351
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1352
+
1353
+ ```ruby
1354
+ result = snaptrade.trading.get_order_impact(
1355
+ user_id: "John.doe@snaptrade.com",
1356
+ user_secret: "USERSECRET123",
1357
+ account_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
1358
+ action: "BUY",
1359
+ order_type: "Limit",
1360
+ price: 31.33,
1361
+ stop: 31.33,
1362
+ time_in_force: "FOK",
1363
+ units: 3.14,
1364
+ universal_symbol_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
1365
+ notional_value: 100,
1366
+ )
1367
+ p result
1368
+ ```
1369
+
1370
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1371
+
1372
+ ##### user_id: `String`<a id="user_id-string"></a>
1373
+ ##### user_secret: `String`<a id="user_secret-string"></a>
1374
+ ##### account_id: `String`<a id="account_id-string"></a>
1375
+ ##### action: [`Action`](./lib/snaptrade/models/action.rb)<a id="action-actionlibsnaptrademodelsactionrb"></a>
1376
+ Trade Action
1377
+
1378
+ ##### order_type: [`OrderType`](./lib/snaptrade/models/order_type.rb)<a id="order_type-ordertypelibsnaptrademodelsorder_typerb"></a>
1379
+ Order Type
1380
+
1381
+ ##### price: `Float`<a id="price-float"></a>
1382
+ Trade Price if limit or stop limit order
1383
+
1384
+ ##### stop: `Float`<a id="stop-float"></a>
1385
+ Stop Price. If stop loss or stop limit order, the price to trigger the stop
1386
+
1387
+ ##### time_in_force: [`TimeInForceStrict`](./lib/snaptrade/models/time_in_force_strict.rb)<a id="time_in_force-timeinforcestrictlibsnaptrademodelstime_in_force_strictrb"></a>
1388
+ Trade time in force examples: * FOK - Fill Or Kill * Day - Day * GTC - Good Til
1389
+ Canceled
1390
+
1391
+ ##### units: [`Float`](./lib/snaptrade/models/float.rb)<a id="units-floatlibsnaptrademodelsfloatrb"></a>
1392
+ ##### universal_symbol_id: `String`<a id="universal_symbol_id-string"></a>
1393
+ ##### notional_value: [`Float`](./lib/snaptrade/models/float.rb)<a id="notional_value-floatlibsnaptrademodelsfloatrb"></a>
1394
+ #### 🔄 Return<a id="🔄-return"></a>
1395
+
1396
+ [ManualTradeAndImpact](./lib/snaptrade/models/manual_trade_and_impact.rb)
1397
+
1398
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1399
+
1400
+ `/trade/impact` `POST`
1401
+
1402
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1403
+
1404
+ ---
1405
+
1406
+
1407
+ ### `snaptrade.trading.get_user_account_quotes`<a id="snaptradetradingget_user_account_quotes"></a>
1408
+
1409
+ Get symbol quotes
1410
+
1411
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1412
+
1413
+ ```ruby
1414
+ result = snaptrade.trading.get_user_account_quotes(
1415
+ user_id: "John.doe@snaptrade.com",
1416
+ user_secret: "USERSECRET123",
1417
+ symbols: "symbols_example",
1418
+ account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
1419
+ use_ticker: true,
1420
+ )
1421
+ p result
1422
+ ```
1423
+
1424
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1425
+
1426
+ ##### user_id: `String`<a id="user_id-string"></a>
1427
+ ##### user_secret: `String`<a id="user_secret-string"></a>
1428
+ ##### symbols: `String`<a id="symbols-string"></a>
1429
+ List of universal_symbol_id or tickers to get quotes for.
1430
+
1431
+ ##### account_id: `String`<a id="account_id-string"></a>
1432
+ The ID of the account to get quotes.
1433
+
1434
+ ##### use_ticker: `Boolean`<a id="use_ticker-boolean"></a>
1435
+ Should be set to True if providing tickers.
1436
+
1437
+ #### 🔄 Return<a id="🔄-return"></a>
1438
+
1439
+ [SymbolsQuotesInner](./lib/snaptrade/models/symbols_quotes_inner.rb)
1440
+
1441
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1442
+
1443
+ `/accounts/{accountId}/quotes` `GET`
1444
+
1445
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1446
+
1447
+ ---
1448
+
1449
+
1450
+ ### `snaptrade.trading.place_force_order`<a id="snaptradetradingplace_force_order"></a>
1451
+
1452
+ Place a trade with NO validation.
1453
+
1454
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1455
+
1456
+ ```ruby
1457
+ result = snaptrade.trading.place_force_order(
1458
+ user_id: "John.doe@snaptrade.com",
1459
+ user_secret: "USERSECRET123",
1460
+ account_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
1461
+ action: "BUY",
1462
+ order_type: "Limit",
1463
+ price: 31.33,
1464
+ stop: 31.33,
1465
+ time_in_force: "FOK",
1466
+ units: 3.14,
1467
+ universal_symbol_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
1468
+ notional_value: 100,
1469
+ )
1470
+ p result
1471
+ ```
1472
+
1473
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1474
+
1475
+ ##### user_id: `String`<a id="user_id-string"></a>
1476
+ ##### user_secret: `String`<a id="user_secret-string"></a>
1477
+ ##### account_id: `String`<a id="account_id-string"></a>
1478
+ ##### action: [`Action`](./lib/snaptrade/models/action.rb)<a id="action-actionlibsnaptrademodelsactionrb"></a>
1479
+ Trade Action
1480
+
1481
+ ##### order_type: [`OrderType`](./lib/snaptrade/models/order_type.rb)<a id="order_type-ordertypelibsnaptrademodelsorder_typerb"></a>
1482
+ Order Type
1483
+
1484
+ ##### price: `Float`<a id="price-float"></a>
1485
+ Trade Price if limit or stop limit order
1486
+
1487
+ ##### stop: `Float`<a id="stop-float"></a>
1488
+ Stop Price. If stop loss or stop limit order, the price to trigger the stop
1489
+
1490
+ ##### time_in_force: [`TimeInForceStrict`](./lib/snaptrade/models/time_in_force_strict.rb)<a id="time_in_force-timeinforcestrictlibsnaptrademodelstime_in_force_strictrb"></a>
1491
+ Trade time in force examples: * FOK - Fill Or Kill * Day - Day * GTC - Good Til
1492
+ Canceled
1493
+
1494
+ ##### units: [`Float`](./lib/snaptrade/models/float.rb)<a id="units-floatlibsnaptrademodelsfloatrb"></a>
1495
+ ##### universal_symbol_id: `String`<a id="universal_symbol_id-string"></a>
1496
+ ##### notional_value: [`Float`](./lib/snaptrade/models/float.rb)<a id="notional_value-floatlibsnaptrademodelsfloatrb"></a>
1497
+ #### 🔄 Return<a id="🔄-return"></a>
1498
+
1499
+ [AccountOrderRecord](./lib/snaptrade/models/account_order_record.rb)
1500
+
1501
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1502
+
1503
+ `/trade/place` `POST`
1504
+
1505
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1506
+
1507
+ ---
1508
+
1509
+
1510
+ ### `snaptrade.trading.place_oco_order`<a id="snaptradetradingplace_oco_order"></a>
1511
+
1512
+ Place a OCO (One Cancels Other) order
1513
+
1514
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1515
+
1516
+ ```ruby
1517
+ result = snaptrade.trading.place_oco_order(
1518
+ user_id: "John.doe@snaptrade.com",
1519
+ user_secret: "USERSECRET123",
1520
+ first_trade_id: None,
1521
+ second_trade_id: None,
1522
+ )
1523
+ p result
1524
+ ```
1525
+
1526
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1527
+
1528
+ ##### user_id: `String`<a id="user_id-string"></a>
1529
+ ##### user_secret: `String`<a id="user_secret-string"></a>
1530
+ ##### first_trade_id: `Object`<a id="first_trade_id-object"></a>
1531
+ The ID of first trade object obtained from trade/impact endpoint
1532
+
1533
+ ##### second_trade_id: `Object`<a id="second_trade_id-object"></a>
1534
+ The ID of second trade object obtained from trade/impact endpoint
1535
+
1536
+ #### 🔄 Return<a id="🔄-return"></a>
1537
+
1538
+ [AccountOrderRecord](./lib/snaptrade/models/account_order_record.rb)
1539
+
1540
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1541
+
1542
+ `/trade/oco` `POST`
1543
+
1544
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1545
+
1546
+ ---
1547
+
1548
+
1549
+ ### `snaptrade.trading.place_order`<a id="snaptradetradingplace_order"></a>
1550
+
1551
+ Place order
1552
+
1553
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1554
+
1555
+ ```ruby
1556
+ result = snaptrade.trading.place_order(
1557
+ trade_id: "tradeId_example",
1558
+ user_id: "John.doe@snaptrade.com",
1559
+ user_secret: "USERSECRET123",
1560
+ wait_to_confirm: true,
1561
+ )
1562
+ p result
1563
+ ```
1564
+
1565
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1566
+
1567
+ ##### trade_id: `String`<a id="trade_id-string"></a>
1568
+ The ID of trade object obtained from trade/impact endpoint
1569
+
1570
+ ##### user_id: `String`<a id="user_id-string"></a>
1571
+ ##### user_secret: `String`<a id="user_secret-string"></a>
1572
+ ##### wait_to_confirm: `Boolean`<a id="wait_to_confirm-boolean"></a>
1573
+ Optional, defaults to true. Determines if a wait is performed to check on order
1574
+ status. If false, latency will be reduced but orders returned will be more
1575
+ likely to be of status PENDING as we will not wait to check on the status before
1576
+ responding to the request
1577
+
1578
+ #### 🔄 Return<a id="🔄-return"></a>
1579
+
1580
+ [AccountOrderRecord](./lib/snaptrade/models/account_order_record.rb)
1581
+
1582
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1583
+
1584
+ `/trade/{tradeId}` `POST`
1585
+
1586
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1587
+
1588
+ ---
1589
+
1590
+
1591
+ ### `snaptrade.transactions_and_reporting.get_activities`<a id="snaptradetransactions_and_reportingget_activities"></a>
1592
+
1593
+ Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
1594
+
1595
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1596
+
1597
+ ```ruby
1598
+ result = snaptrade.transactions_and_reporting.get_activities(
1599
+ user_id: "John.doe@snaptrade.com",
1600
+ user_secret: "USERSECRET123",
1601
+ start_date: "2022-01-24",
1602
+ end_date: "2022-01-24",
1603
+ accounts: "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
1604
+ brokerage_authorizations: "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
1605
+ type: "DIVIDEND",
1606
+ )
1607
+ p result
1608
+ ```
1609
+
1610
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1611
+
1612
+ ##### user_id: `String`<a id="user_id-string"></a>
1613
+ ##### user_secret: `String`<a id="user_secret-string"></a>
1614
+ ##### start_date: `Date`<a id="start_date-date"></a>
1615
+ ##### end_date: `Date`<a id="end_date-date"></a>
1616
+ ##### accounts: `String`<a id="accounts-string"></a>
1617
+ Optional comma seperated list of account IDs used to filter the request on
1618
+ specific accounts
1619
+
1620
+ ##### brokerage_authorizations: `String`<a id="brokerage_authorizations-string"></a>
1621
+ Optional comma seperated list of brokerage authorization IDs used to filter the
1622
+ request on only accounts that belong to those authorizations
1623
+
1624
+ ##### type: `String`<a id="type-string"></a>
1625
+ Optional comma seperated list of types to filter activities by. This is not an
1626
+ exhaustive list, if we fail to match to these types, we will return the raw
1627
+ description from the brokerage. Potential values include - DIVIDEND - BUY - SELL
1628
+ - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN -
1629
+ EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN -
1630
+ INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN -
1631
+ INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI -
1632
+ FXT
1633
+
1634
+ #### 🔄 Return<a id="🔄-return"></a>
1635
+
1636
+ [UniversalActivity](./lib/snaptrade/models/universal_activity.rb)
1637
+
1638
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1639
+
1640
+ `/activities` `GET`
1641
+
1642
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1643
+
1644
+ ---
1645
+
1646
+
1647
+ ### `snaptrade.transactions_and_reporting.get_reporting_custom_range`<a id="snaptradetransactions_and_reportingget_reporting_custom_range"></a>
1648
+
1649
+ Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
1650
+
1651
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1652
+
1653
+ ```ruby
1654
+ result = snaptrade.transactions_and_reporting.get_reporting_custom_range(
1655
+ start_date: "2022-01-24",
1656
+ end_date: "2022-01-24",
1657
+ user_id: "John.doe@snaptrade.com",
1658
+ user_secret: "USERSECRET123",
1659
+ accounts: "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
1660
+ detailed: true,
1661
+ frequency: "monthly",
1662
+ )
1663
+ p result
1664
+ ```
1665
+
1666
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1667
+
1668
+ ##### start_date: `Date`<a id="start_date-date"></a>
1669
+ ##### end_date: `Date`<a id="end_date-date"></a>
1670
+ ##### user_id: `String`<a id="user_id-string"></a>
1671
+ ##### user_secret: `String`<a id="user_secret-string"></a>
1672
+ ##### accounts: `String`<a id="accounts-string"></a>
1673
+ Optional comma seperated list of account IDs used to filter the request on
1674
+ specific accounts
1675
+
1676
+ ##### detailed: `Boolean`<a id="detailed-boolean"></a>
1677
+ Optional, increases frequency of data points for the total value and
1678
+ contribution charts if set to true
1679
+
1680
+ ##### frequency: `String`<a id="frequency-string"></a>
1681
+ Optional frequency for the rate of return chart (defaults to monthly). Possible
1682
+ values are daily, weekly, monthly, quarterly, yearly.
1683
+
1684
+ #### 🔄 Return<a id="🔄-return"></a>
1685
+
1686
+ [PerformanceCustom](./lib/snaptrade/models/performance_custom.rb)
1687
+
1688
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1689
+
1690
+ `/performance/custom` `GET`
1691
+
1692
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1693
+
1694
+ ---
22
1695
 
23
- user_id = "John.doe@snaptrade.com"
24
- user_secret = "USERSECRET123"
25
- brokerage_authorizations = "917c8734-8470-4a3e-a18f-57c3f2ee6631"
26
-
27
- begin
28
- # List all accounts for the user, plus balances, positions, and orders for each account.
29
- result = SnapTrade::AccountInformation.get_all_user_holdings(
30
- user_id: user_id,
31
- user_secret: user_secret,
32
- brokerage_authorizations: brokerage_authorizations,
33
- )
34
- p result
35
- rescue SnapTrade::ApiError => e
36
- puts "Exception when calling SnapTrade::AccountInformation.get_all_user_holdings: #{e}"
37
- end
38
- ```
39
-
40
- ## Documentation for API Endpoints
41
-
42
- All URIs are relative to *https://api.snaptrade.com/api/v1*
43
-
44
- Class | Method | HTTP request | Description
45
- ------------ | ------------- | ------------- | -------------
46
- *SnapTrade::AccountInformationApi* | [**get_all_user_holdings**](docs/AccountInformationApi.md#get_all_user_holdings) | **GET** /holdings | List all accounts for the user, plus balances, positions, and orders for each account.
47
- *SnapTrade::AccountInformationApi* | [**get_user_account_balance**](docs/AccountInformationApi.md#get_user_account_balance) | **GET** /accounts/{accountId}/balances | List account balances
48
- *SnapTrade::AccountInformationApi* | [**get_user_account_details**](docs/AccountInformationApi.md#get_user_account_details) | **GET** /accounts/{accountId} | Return details of a specific investment account
49
- *SnapTrade::AccountInformationApi* | [**get_user_account_orders**](docs/AccountInformationApi.md#get_user_account_orders) | **GET** /accounts/{accountId}/orders | List account orders
50
- *SnapTrade::AccountInformationApi* | [**get_user_account_positions**](docs/AccountInformationApi.md#get_user_account_positions) | **GET** /accounts/{accountId}/positions | List account positions
51
- *SnapTrade::AccountInformationApi* | [**get_user_holdings**](docs/AccountInformationApi.md#get_user_holdings) | **GET** /accounts/{accountId}/holdings | List balances, positions and orders for the specified account
52
- *SnapTrade::AccountInformationApi* | [**list_user_accounts**](docs/AccountInformationApi.md#list_user_accounts) | **GET** /accounts | List accounts
53
- *SnapTrade::AccountInformationApi* | [**update_user_account**](docs/AccountInformationApi.md#update_user_account) | **PUT** /accounts/{accountId} | Update details of an investment account
54
- *SnapTrade::APIStatusApi* | [**check**](docs/APIStatusApi.md#check) | **GET** / | Get API Status
55
- *SnapTrade::AuthenticationApi* | [**delete_snap_trade_user**](docs/AuthenticationApi.md#delete_snap_trade_user) | **DELETE** /snapTrade/deleteUser | Delete SnapTrade user
56
- *SnapTrade::AuthenticationApi* | [**get_user_jwt**](docs/AuthenticationApi.md#get_user_jwt) | **GET** /snapTrade/encryptedJWT | Generate encrypted JWT token
57
- *SnapTrade::AuthenticationApi* | [**list_snap_trade_users**](docs/AuthenticationApi.md#list_snap_trade_users) | **GET** /snapTrade/listUsers | List SnapTrade users
58
- *SnapTrade::AuthenticationApi* | [**login_snap_trade_user**](docs/AuthenticationApi.md#login_snap_trade_user) | **POST** /snapTrade/login | Login user & generate connection link
59
- *SnapTrade::AuthenticationApi* | [**register_snap_trade_user**](docs/AuthenticationApi.md#register_snap_trade_user) | **POST** /snapTrade/registerUser | Create SnapTrade user
60
- *SnapTrade::AuthenticationApi* | [**reset_snap_trade_user_secret**](docs/AuthenticationApi.md#reset_snap_trade_user_secret) | **POST** /snapTrade/resetUserSecret | Obtain a new user secret for a user
61
- *SnapTrade::ConnectionsApi* | [**detail_brokerage_authorization**](docs/ConnectionsApi.md#detail_brokerage_authorization) | **GET** /authorizations/{authorizationId} | Get brokerage authorization details
62
- *SnapTrade::ConnectionsApi* | [**list_brokerage_authorizations**](docs/ConnectionsApi.md#list_brokerage_authorizations) | **GET** /authorizations | List all brokerage authorizations for the user
63
- *SnapTrade::ConnectionsApi* | [**remove_brokerage_authorization**](docs/ConnectionsApi.md#remove_brokerage_authorization) | **DELETE** /authorizations/{authorizationId} | Delete brokerage authorization
64
- *SnapTrade::ConnectionsApi* | [**session_events**](docs/ConnectionsApi.md#session_events) | **GET** /sessionEvents | List all session events for the partner
65
- *SnapTrade::ErrorLogsApi* | [**list_user_errors**](docs/ErrorLogsApi.md#list_user_errors) | **GET** /snapTrade/listUserErrors | Retrieve error logs on behalf of your SnapTrade users
66
- *SnapTrade::OptionsApi* | [**get_option_strategy**](docs/OptionsApi.md#get_option_strategy) | **POST** /accounts/{accountId}/optionStrategy | Creates an option strategy object that will be used to place an option strategy order
67
- *SnapTrade::OptionsApi* | [**get_options_chain**](docs/OptionsApi.md#get_options_chain) | **GET** /accounts/{accountId}/optionsChain | Get the options chain
68
- *SnapTrade::OptionsApi* | [**get_options_strategy_quote**](docs/OptionsApi.md#get_options_strategy_quote) | **GET** /accounts/{accountId}/optionStrategy/{optionStrategyId} | Get latest market data of option strategy
69
- *SnapTrade::OptionsApi* | [**list_option_holdings**](docs/OptionsApi.md#list_option_holdings) | **GET** /accounts/{accountId}/options | Get the options holdings in the account
70
- *SnapTrade::OptionsApi* | [**place_option_strategy**](docs/OptionsApi.md#place_option_strategy) | **POST** /accounts/{accountId}/optionStrategy/{optionStrategyId}/execute | Place an option strategy order on the brokerage
71
- *SnapTrade::ReferenceDataApi* | [**get_currency_exchange_rate_pair**](docs/ReferenceDataApi.md#get_currency_exchange_rate_pair) | **GET** /currencies/rates/{currencyPair} | Return the exchange rate of a currency pair
72
- *SnapTrade::ReferenceDataApi* | [**get_partner_info**](docs/ReferenceDataApi.md#get_partner_info) | **GET** /snapTrade/partners | Get metadata related to Snaptrade partner
73
- *SnapTrade::ReferenceDataApi* | [**get_security_types**](docs/ReferenceDataApi.md#get_security_types) | **GET** /securityTypes | List of all security types
74
- *SnapTrade::ReferenceDataApi* | [**get_stock_exchanges**](docs/ReferenceDataApi.md#get_stock_exchanges) | **GET** /exchanges | List exchanges
75
- *SnapTrade::ReferenceDataApi* | [**get_symbols**](docs/ReferenceDataApi.md#get_symbols) | **POST** /symbols | Search for symbols
76
- *SnapTrade::ReferenceDataApi* | [**get_symbols_by_ticker**](docs/ReferenceDataApi.md#get_symbols_by_ticker) | **GET** /symbols/{query} | Get details of a symbol by the ticker or the universal_symbol_id
77
- *SnapTrade::ReferenceDataApi* | [**list_all_brokerage_authorization_type**](docs/ReferenceDataApi.md#list_all_brokerage_authorization_type) | **GET** /brokerageAuthorizationTypes | List of all brokerage authorization types
78
- *SnapTrade::ReferenceDataApi* | [**list_all_brokerages**](docs/ReferenceDataApi.md#list_all_brokerages) | **GET** /brokerages | List brokerages
79
- *SnapTrade::ReferenceDataApi* | [**list_all_currencies**](docs/ReferenceDataApi.md#list_all_currencies) | **GET** /currencies | List currencies
80
- *SnapTrade::ReferenceDataApi* | [**list_all_currencies_rates**](docs/ReferenceDataApi.md#list_all_currencies_rates) | **GET** /currencies/rates | List currency exchange rates
81
- *SnapTrade::ReferenceDataApi* | [**symbol_search_user_account**](docs/ReferenceDataApi.md#symbol_search_user_account) | **POST** /accounts/{accountId}/symbols | Search for symbols available in an account
82
- *SnapTrade::TradingApi* | [**cancel_user_account_order**](docs/TradingApi.md#cancel_user_account_order) | **POST** /accounts/{accountId}/orders/cancel | Cancel open order in account
83
- *SnapTrade::TradingApi* | [**get_order_impact**](docs/TradingApi.md#get_order_impact) | **POST** /trade/impact | Check impact of trades on account.
84
- *SnapTrade::TradingApi* | [**get_user_account_quotes**](docs/TradingApi.md#get_user_account_quotes) | **GET** /accounts/{accountId}/quotes | Get symbol quotes
85
- *SnapTrade::TradingApi* | [**place_force_order**](docs/TradingApi.md#place_force_order) | **POST** /trade/place | Place a trade with NO validation.
86
- *SnapTrade::TradingApi* | [**place_oco_order**](docs/TradingApi.md#place_oco_order) | **POST** /trade/oco | Place a OCO (One Cancels Other) order
87
- *SnapTrade::TradingApi* | [**place_order**](docs/TradingApi.md#place_order) | **POST** /trade/{tradeId} | Place order
88
- *SnapTrade::TransactionsAndReportingApi* | [**get_activities**](docs/TransactionsAndReportingApi.md#get_activities) | **GET** /activities | Get transaction history for a user
89
- *SnapTrade::TransactionsAndReportingApi* | [**get_reporting_custom_range**](docs/TransactionsAndReportingApi.md#get_reporting_custom_range) | **GET** /performance/custom | Get performance information for a specific timeframe
90
-
91
-
92
- ## Documentation for Models
93
-
94
- - [SnapTrade::Account](docs/Account.md)
95
- - [SnapTrade::AccountBalance](docs/AccountBalance.md)
96
- - [SnapTrade::AccountBalanceTotal](docs/AccountBalanceTotal.md)
97
- - [SnapTrade::AccountHoldings](docs/AccountHoldings.md)
98
- - [SnapTrade::AccountHoldingsAccount](docs/AccountHoldingsAccount.md)
99
- - [SnapTrade::AccountOrderRecord](docs/AccountOrderRecord.md)
100
- - [SnapTrade::AccountOrderRecordStatus](docs/AccountOrderRecordStatus.md)
101
- - [SnapTrade::AccountSimple](docs/AccountSimple.md)
102
- - [SnapTrade::AccountSyncStatus](docs/AccountSyncStatus.md)
103
- - [SnapTrade::Action](docs/Action.md)
104
- - [SnapTrade::Amount](docs/Amount.md)
105
- - [SnapTrade::AuthType](docs/AuthType.md)
106
- - [SnapTrade::AuthenticationLoginSnapTradeUser200Response](docs/AuthenticationLoginSnapTradeUser200Response.md)
107
- - [SnapTrade::Balance](docs/Balance.md)
108
- - [SnapTrade::Brokerage](docs/Brokerage.md)
109
- - [SnapTrade::BrokerageAuthorization](docs/BrokerageAuthorization.md)
110
- - [SnapTrade::BrokerageAuthorizationType](docs/BrokerageAuthorizationType.md)
111
- - [SnapTrade::BrokerageAuthorizationTypeReadOnly](docs/BrokerageAuthorizationTypeReadOnly.md)
112
- - [SnapTrade::BrokerageAuthorizationTypeReadOnlyBrokerage](docs/BrokerageAuthorizationTypeReadOnlyBrokerage.md)
113
- - [SnapTrade::BrokerageAuthorizationTypeReadOnlyType](docs/BrokerageAuthorizationTypeReadOnlyType.md)
114
- - [SnapTrade::BrokerageAuthorizationTypeType](docs/BrokerageAuthorizationTypeType.md)
115
- - [SnapTrade::BrokerageSymbol](docs/BrokerageSymbol.md)
116
- - [SnapTrade::BrokerageSymbolOptionSymbol](docs/BrokerageSymbolOptionSymbol.md)
117
- - [SnapTrade::BrokerageSymbolSymbol](docs/BrokerageSymbolSymbol.md)
118
- - [SnapTrade::BrokerageType](docs/BrokerageType.md)
119
- - [SnapTrade::CalculatedTrade](docs/CalculatedTrade.md)
120
- - [SnapTrade::CashRestriction](docs/CashRestriction.md)
121
- - [SnapTrade::ConnectionPortalVersion](docs/ConnectionPortalVersion.md)
122
- - [SnapTrade::ConnectionType](docs/ConnectionType.md)
123
- - [SnapTrade::ConnectionsSessionEvents200ResponseInner](docs/ConnectionsSessionEvents200ResponseInner.md)
124
- - [SnapTrade::Currency](docs/Currency.md)
125
- - [SnapTrade::DeleteUserResponse](docs/DeleteUserResponse.md)
126
- - [SnapTrade::DividendAtDate](docs/DividendAtDate.md)
127
- - [SnapTrade::EncryptedResponse](docs/EncryptedResponse.md)
128
- - [SnapTrade::EncryptedResponseEncryptedMessageData](docs/EncryptedResponseEncryptedMessageData.md)
129
- - [SnapTrade::Exchange](docs/Exchange.md)
130
- - [SnapTrade::ExchangeRatePairs](docs/ExchangeRatePairs.md)
131
- - [SnapTrade::ExcludedAsset](docs/ExcludedAsset.md)
132
- - [SnapTrade::JWT](docs/JWT.md)
133
- - [SnapTrade::LoginRedirectURI](docs/LoginRedirectURI.md)
134
- - [SnapTrade::ManualTrade](docs/ManualTrade.md)
135
- - [SnapTrade::ManualTradeAndImpact](docs/ManualTradeAndImpact.md)
136
- - [SnapTrade::ManualTradeBalance](docs/ManualTradeBalance.md)
137
- - [SnapTrade::ManualTradeForm](docs/ManualTradeForm.md)
138
- - [SnapTrade::ManualTradeSymbol](docs/ManualTradeSymbol.md)
139
- - [SnapTrade::Model400FailedRequestResponse](docs/Model400FailedRequestResponse.md)
140
- - [SnapTrade::Model401FailedRequestResponse](docs/Model401FailedRequestResponse.md)
141
- - [SnapTrade::Model403FailedRequestResponse](docs/Model403FailedRequestResponse.md)
142
- - [SnapTrade::Model404FailedRequestResponse](docs/Model404FailedRequestResponse.md)
143
- - [SnapTrade::Model500UnexpectedExceptionResponse](docs/Model500UnexpectedExceptionResponse.md)
144
- - [SnapTrade::ModelAssetClass](docs/ModelAssetClass.md)
145
- - [SnapTrade::ModelAssetClassDetails](docs/ModelAssetClassDetails.md)
146
- - [SnapTrade::ModelAssetClassTarget](docs/ModelAssetClassTarget.md)
147
- - [SnapTrade::ModelPortfolio](docs/ModelPortfolio.md)
148
- - [SnapTrade::ModelPortfolioAssetClass](docs/ModelPortfolioAssetClass.md)
149
- - [SnapTrade::ModelPortfolioDetails](docs/ModelPortfolioDetails.md)
150
- - [SnapTrade::ModelPortfolioSecurity](docs/ModelPortfolioSecurity.md)
151
- - [SnapTrade::ModelType](docs/ModelType.md)
152
- - [SnapTrade::MonthlyDividends](docs/MonthlyDividends.md)
153
- - [SnapTrade::NetContributions](docs/NetContributions.md)
154
- - [SnapTrade::NetDividend](docs/NetDividend.md)
155
- - [SnapTrade::OptionChainInner](docs/OptionChainInner.md)
156
- - [SnapTrade::OptionChainInnerChainPerRootInner](docs/OptionChainInnerChainPerRootInner.md)
157
- - [SnapTrade::OptionChainInnerChainPerRootInnerChainPerStrikePriceInner](docs/OptionChainInnerChainPerRootInnerChainPerStrikePriceInner.md)
158
- - [SnapTrade::OptionLeg](docs/OptionLeg.md)
159
- - [SnapTrade::OptionLegAction](docs/OptionLegAction.md)
160
- - [SnapTrade::OptionStrategy](docs/OptionStrategy.md)
161
- - [SnapTrade::OptionStrategyLegsInner](docs/OptionStrategyLegsInner.md)
162
- - [SnapTrade::OptionType](docs/OptionType.md)
163
- - [SnapTrade::OptionsGetOptionStrategyRequest](docs/OptionsGetOptionStrategyRequest.md)
164
- - [SnapTrade::OptionsHoldings](docs/OptionsHoldings.md)
165
- - [SnapTrade::OptionsPlaceOptionStrategyRequest](docs/OptionsPlaceOptionStrategyRequest.md)
166
- - [SnapTrade::OptionsPosition](docs/OptionsPosition.md)
167
- - [SnapTrade::OptionsPositionCurrency](docs/OptionsPositionCurrency.md)
168
- - [SnapTrade::OptionsSymbol](docs/OptionsSymbol.md)
169
- - [SnapTrade::OrderType](docs/OrderType.md)
170
- - [SnapTrade::PartnerData](docs/PartnerData.md)
171
- - [SnapTrade::PastValue](docs/PastValue.md)
172
- - [SnapTrade::PerformanceCustom](docs/PerformanceCustom.md)
173
- - [SnapTrade::PortfolioGroup](docs/PortfolioGroup.md)
174
- - [SnapTrade::PortfolioGroupInfo](docs/PortfolioGroupInfo.md)
175
- - [SnapTrade::PortfolioGroupPosition](docs/PortfolioGroupPosition.md)
176
- - [SnapTrade::PortfolioGroupSettings](docs/PortfolioGroupSettings.md)
177
- - [SnapTrade::Position](docs/Position.md)
178
- - [SnapTrade::PositionSymbol](docs/PositionSymbol.md)
179
- - [SnapTrade::RedirectTokenandPin](docs/RedirectTokenandPin.md)
180
- - [SnapTrade::SecurityType](docs/SecurityType.md)
181
- - [SnapTrade::SessionEvent](docs/SessionEvent.md)
182
- - [SnapTrade::SessionEventType](docs/SessionEventType.md)
183
- - [SnapTrade::SnapTradeAPIDisclaimerAcceptStatus](docs/SnapTradeAPIDisclaimerAcceptStatus.md)
184
- - [SnapTrade::SnapTradeHoldingsAccount](docs/SnapTradeHoldingsAccount.md)
185
- - [SnapTrade::SnapTradeHoldingsAccountAccountId](docs/SnapTradeHoldingsAccountAccountId.md)
186
- - [SnapTrade::SnapTradeHoldingsTotalValue](docs/SnapTradeHoldingsTotalValue.md)
187
- - [SnapTrade::SnapTradeLoginUserRequestBody](docs/SnapTradeLoginUserRequestBody.md)
188
- - [SnapTrade::SnapTradeRegisterUserRequestBody](docs/SnapTradeRegisterUserRequestBody.md)
189
- - [SnapTrade::State](docs/State.md)
190
- - [SnapTrade::Status](docs/Status.md)
191
- - [SnapTrade::StrategyImpact](docs/StrategyImpact.md)
192
- - [SnapTrade::StrategyImpactLegsInner](docs/StrategyImpactLegsInner.md)
193
- - [SnapTrade::StrategyOrderPlace](docs/StrategyOrderPlace.md)
194
- - [SnapTrade::StrategyOrderPlaceOrdersInner](docs/StrategyOrderPlaceOrdersInner.md)
195
- - [SnapTrade::StrategyOrderPlaceOrdersInnerLegsInner](docs/StrategyOrderPlaceOrdersInnerLegsInner.md)
196
- - [SnapTrade::StrategyOrderRecord](docs/StrategyOrderRecord.md)
197
- - [SnapTrade::StrategyOrderRecordStatus](docs/StrategyOrderRecordStatus.md)
198
- - [SnapTrade::StrategyQuotes](docs/StrategyQuotes.md)
199
- - [SnapTrade::StrategyQuotesGreek](docs/StrategyQuotesGreek.md)
200
- - [SnapTrade::StrategyType](docs/StrategyType.md)
201
- - [SnapTrade::SubPeriodReturnRate](docs/SubPeriodReturnRate.md)
202
- - [SnapTrade::Symbol](docs/Symbol.md)
203
- - [SnapTrade::SymbolQuery](docs/SymbolQuery.md)
204
- - [SnapTrade::SymbolsQuotesInner](docs/SymbolsQuotesInner.md)
205
- - [SnapTrade::TargetAsset](docs/TargetAsset.md)
206
- - [SnapTrade::TimeInForceStrict](docs/TimeInForceStrict.md)
207
- - [SnapTrade::Trade](docs/Trade.md)
208
- - [SnapTrade::TradeAction](docs/TradeAction.md)
209
- - [SnapTrade::TradeExecutionStatus](docs/TradeExecutionStatus.md)
210
- - [SnapTrade::TradeExecutionStatusAction](docs/TradeExecutionStatusAction.md)
211
- - [SnapTrade::TradeImpact](docs/TradeImpact.md)
212
- - [SnapTrade::TradingCancelUserAccountOrderRequest](docs/TradingCancelUserAccountOrderRequest.md)
213
- - [SnapTrade::TradingPlaceOCOOrderRequest](docs/TradingPlaceOCOOrderRequest.md)
214
- - [SnapTrade::TransactionsStatus](docs/TransactionsStatus.md)
215
- - [SnapTrade::Type](docs/Type.md)
216
- - [SnapTrade::USExchange](docs/USExchange.md)
217
- - [SnapTrade::UnderlyingSymbol](docs/UnderlyingSymbol.md)
218
- - [SnapTrade::UniversalActivity](docs/UniversalActivity.md)
219
- - [SnapTrade::UniversalSymbol](docs/UniversalSymbol.md)
220
- - [SnapTrade::UserErrorLog](docs/UserErrorLog.md)
221
- - [SnapTrade::UserIDandSecret](docs/UserIDandSecret.md)
222
- - [SnapTrade::UserSettings](docs/UserSettings.md)
223
- - [SnapTrade::ValidatedTradeBody](docs/ValidatedTradeBody.md)
224
1696
 
1697
+ ## Author<a id="author"></a>
1698
+ This TypeScript package is automatically generated by [Konfig](https://konfigthis.com)