snaptrade 1.16.1 → 1.16.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (303) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +10 -10
  3. data/Gemfile.lock +1 -1
  4. data/README.md +1 -1
  5. data/docs/APIStatusApi.md +56 -56
  6. data/docs/AccountInformationApi.md +527 -527
  7. data/docs/AuthenticationApi.md +309 -309
  8. data/docs/ConnectionsApi.md +261 -261
  9. data/docs/ErrorLogsApi.md +67 -67
  10. data/docs/MonthlyDividends.md +20 -20
  11. data/docs/NetContributions.md +22 -22
  12. data/docs/OptionsApi.md +373 -373
  13. data/docs/PastValue.md +22 -22
  14. data/docs/ReferenceDataApi.md +584 -584
  15. data/docs/SubPeriodReturnRate.md +22 -22
  16. data/docs/TradingApi.md +472 -472
  17. data/docs/TransactionsAndReportingApi.md +181 -181
  18. data/docs/TransactionsStatus.md +20 -20
  19. data/lib/snaptrade/api/account_information_api.rb +801 -801
  20. data/lib/snaptrade/api/api_status_api.rb +98 -98
  21. data/lib/snaptrade/api/authentication_api.rb +481 -481
  22. data/lib/snaptrade/api/connections_api.rb +398 -398
  23. data/lib/snaptrade/api/error_logs_api.rb +112 -112
  24. data/lib/snaptrade/api/options_api.rb +591 -591
  25. data/lib/snaptrade/api/reference_data_api.rb +894 -894
  26. data/lib/snaptrade/api/trading_api.rb +741 -741
  27. data/lib/snaptrade/api/transactions_and_reporting_api.rb +283 -283
  28. data/lib/snaptrade/api_client.rb +427 -427
  29. data/lib/snaptrade/api_error.rb +6 -6
  30. data/lib/snaptrade/configuration.rb +341 -334
  31. data/lib/snaptrade/models/account.rb +6 -6
  32. data/lib/snaptrade/models/account_holdings.rb +6 -6
  33. data/lib/snaptrade/models/account_holdings_account.rb +6 -6
  34. data/lib/snaptrade/models/account_order_record.rb +6 -6
  35. data/lib/snaptrade/models/account_order_record_status.rb +6 -6
  36. data/lib/snaptrade/models/account_simple.rb +6 -6
  37. data/lib/snaptrade/models/account_sync_status.rb +6 -6
  38. data/lib/snaptrade/models/action.rb +6 -6
  39. data/lib/snaptrade/models/auth_type.rb +6 -6
  40. data/lib/snaptrade/models/authentication_login_snap_trade_user200_response.rb +6 -6
  41. data/lib/snaptrade/models/balance.rb +6 -6
  42. data/lib/snaptrade/models/brokerage.rb +6 -6
  43. data/lib/snaptrade/models/brokerage_authorization.rb +6 -6
  44. data/lib/snaptrade/models/brokerage_authorization_type.rb +6 -6
  45. data/lib/snaptrade/models/brokerage_authorization_type_read_only.rb +6 -6
  46. data/lib/snaptrade/models/brokerage_authorization_type_read_only_brokerage.rb +6 -6
  47. data/lib/snaptrade/models/brokerage_authorization_type_read_only_type.rb +6 -6
  48. data/lib/snaptrade/models/brokerage_authorization_type_type.rb +6 -6
  49. data/lib/snaptrade/models/brokerage_symbol.rb +6 -6
  50. data/lib/snaptrade/models/brokerage_symbol_option_symbol.rb +6 -6
  51. data/lib/snaptrade/models/brokerage_symbol_symbol.rb +6 -6
  52. data/lib/snaptrade/models/brokerage_type.rb +6 -6
  53. data/lib/snaptrade/models/calculated_trade.rb +6 -6
  54. data/lib/snaptrade/models/cash_restriction.rb +6 -6
  55. data/lib/snaptrade/models/connection_type.rb +6 -6
  56. data/lib/snaptrade/models/connections_session_events200_response_inner.rb +6 -6
  57. data/lib/snaptrade/models/currency.rb +6 -6
  58. data/lib/snaptrade/models/delete_user_response.rb +6 -6
  59. data/lib/snaptrade/models/dividend_at_date.rb +6 -6
  60. data/lib/snaptrade/models/encrypted_response.rb +6 -6
  61. data/lib/snaptrade/models/encrypted_response_encrypted_message_data.rb +6 -6
  62. data/lib/snaptrade/models/exchange.rb +6 -6
  63. data/lib/snaptrade/models/exchange_rate_pairs.rb +6 -6
  64. data/lib/snaptrade/models/excluded_asset.rb +6 -6
  65. data/lib/snaptrade/models/jwt.rb +6 -6
  66. data/lib/snaptrade/models/login_redirect_uri.rb +6 -6
  67. data/lib/snaptrade/models/manual_trade.rb +6 -6
  68. data/lib/snaptrade/models/manual_trade_and_impact.rb +6 -6
  69. data/lib/snaptrade/models/manual_trade_balance.rb +6 -6
  70. data/lib/snaptrade/models/manual_trade_form.rb +6 -6
  71. data/lib/snaptrade/models/manual_trade_symbol.rb +6 -6
  72. data/lib/snaptrade/models/model400_failed_request_response.rb +6 -6
  73. data/lib/snaptrade/models/model401_failed_request_response.rb +6 -6
  74. data/lib/snaptrade/models/model403_failed_request_response.rb +6 -6
  75. data/lib/snaptrade/models/model404_failed_request_response.rb +6 -6
  76. data/lib/snaptrade/models/model_asset_class.rb +6 -6
  77. data/lib/snaptrade/models/model_asset_class_details.rb +6 -6
  78. data/lib/snaptrade/models/model_asset_class_target.rb +6 -6
  79. data/lib/snaptrade/models/model_portfolio.rb +6 -6
  80. data/lib/snaptrade/models/model_portfolio_asset_class.rb +6 -6
  81. data/lib/snaptrade/models/model_portfolio_details.rb +6 -6
  82. data/lib/snaptrade/models/model_portfolio_security.rb +6 -6
  83. data/lib/snaptrade/models/model_type.rb +6 -6
  84. data/lib/snaptrade/models/monthly_dividends.rb +6 -6
  85. data/lib/snaptrade/models/net_contributions.rb +6 -6
  86. data/lib/snaptrade/models/net_dividend.rb +6 -6
  87. data/lib/snaptrade/models/option_chain_inner.rb +6 -6
  88. data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner.rb +6 -6
  89. data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner.rb +6 -6
  90. data/lib/snaptrade/models/option_leg.rb +6 -6
  91. data/lib/snaptrade/models/option_leg_action.rb +6 -6
  92. data/lib/snaptrade/models/option_strategy.rb +6 -6
  93. data/lib/snaptrade/models/option_strategy_legs_inner.rb +6 -6
  94. data/lib/snaptrade/models/options_get_option_strategy_request.rb +6 -6
  95. data/lib/snaptrade/models/options_holdings.rb +6 -6
  96. data/lib/snaptrade/models/options_place_option_strategy_request.rb +6 -6
  97. data/lib/snaptrade/models/options_position.rb +6 -6
  98. data/lib/snaptrade/models/options_position_currency.rb +6 -6
  99. data/lib/snaptrade/models/options_symbol.rb +6 -6
  100. data/lib/snaptrade/models/order_strategy_execute_body_order_type.rb +6 -6
  101. data/lib/snaptrade/models/order_strategy_execute_body_time_in_force.rb +6 -6
  102. data/lib/snaptrade/models/order_type.rb +6 -6
  103. data/lib/snaptrade/models/partner_data.rb +6 -6
  104. data/lib/snaptrade/models/past_value.rb +6 -6
  105. data/lib/snaptrade/models/performance_custom.rb +6 -6
  106. data/lib/snaptrade/models/portfolio_group.rb +6 -6
  107. data/lib/snaptrade/models/portfolio_group_info.rb +6 -6
  108. data/lib/snaptrade/models/portfolio_group_position.rb +6 -6
  109. data/lib/snaptrade/models/portfolio_group_settings.rb +6 -6
  110. data/lib/snaptrade/models/position.rb +6 -6
  111. data/lib/snaptrade/models/position_symbol.rb +6 -6
  112. data/lib/snaptrade/models/redirect_tokenand_pin.rb +6 -6
  113. data/lib/snaptrade/models/security_type.rb +6 -6
  114. data/lib/snaptrade/models/session_event.rb +6 -6
  115. data/lib/snaptrade/models/session_event_type.rb +6 -6
  116. data/lib/snaptrade/models/snap_trade_api_disclaimer_accept_status.rb +6 -6
  117. data/lib/snaptrade/models/snap_trade_holdings_account.rb +6 -6
  118. data/lib/snaptrade/models/snap_trade_holdings_account_account_id.rb +6 -6
  119. data/lib/snaptrade/models/snap_trade_holdings_total_value.rb +221 -221
  120. data/lib/snaptrade/models/snap_trade_login_user_request_body.rb +6 -6
  121. data/lib/snaptrade/models/snap_trade_register_user_request_body.rb +6 -6
  122. data/lib/snaptrade/models/state.rb +6 -6
  123. data/lib/snaptrade/models/status.rb +6 -6
  124. data/lib/snaptrade/models/strategy_impact.rb +6 -6
  125. data/lib/snaptrade/models/strategy_impact_legs_inner.rb +6 -6
  126. data/lib/snaptrade/models/strategy_order_place.rb +6 -6
  127. data/lib/snaptrade/models/strategy_order_place_orders_inner.rb +6 -6
  128. data/lib/snaptrade/models/strategy_order_place_orders_inner_legs_inner.rb +6 -6
  129. data/lib/snaptrade/models/strategy_order_record.rb +6 -6
  130. data/lib/snaptrade/models/strategy_order_record_order_type.rb +6 -6
  131. data/lib/snaptrade/models/strategy_order_record_status.rb +6 -6
  132. data/lib/snaptrade/models/strategy_order_record_time_in_force.rb +6 -6
  133. data/lib/snaptrade/models/strategy_quotes.rb +6 -6
  134. data/lib/snaptrade/models/strategy_quotes_greek.rb +6 -6
  135. data/lib/snaptrade/models/strategy_type.rb +6 -6
  136. data/lib/snaptrade/models/sub_period_return_rate.rb +6 -6
  137. data/lib/snaptrade/models/symbol.rb +6 -6
  138. data/lib/snaptrade/models/symbol_query.rb +6 -6
  139. data/lib/snaptrade/models/symbols_quotes_inner.rb +6 -6
  140. data/lib/snaptrade/models/target_asset.rb +6 -6
  141. data/lib/snaptrade/models/time_in_force.rb +6 -6
  142. data/lib/snaptrade/models/trade.rb +6 -6
  143. data/lib/snaptrade/models/trade_action.rb +6 -6
  144. data/lib/snaptrade/models/trade_execution_status.rb +6 -6
  145. data/lib/snaptrade/models/trade_execution_status_action.rb +6 -6
  146. data/lib/snaptrade/models/trade_impact.rb +6 -6
  147. data/lib/snaptrade/models/trading_cancel_user_account_order_request.rb +6 -6
  148. data/lib/snaptrade/models/trading_place_oco_order_request.rb +6 -6
  149. data/lib/snaptrade/models/transactions_status.rb +6 -6
  150. data/lib/snaptrade/models/type.rb +6 -6
  151. data/lib/snaptrade/models/underlying_symbol.rb +6 -6
  152. data/lib/snaptrade/models/universal_activity.rb +6 -6
  153. data/lib/snaptrade/models/universal_symbol.rb +6 -6
  154. data/lib/snaptrade/models/universal_symbol_ticker.rb +6 -6
  155. data/lib/snaptrade/models/us_exchange.rb +6 -6
  156. data/lib/snaptrade/models/user_error_log.rb +6 -6
  157. data/lib/snaptrade/models/user_i_dand_secret.rb +6 -6
  158. data/lib/snaptrade/models/user_settings.rb +6 -6
  159. data/lib/snaptrade/version.rb +7 -7
  160. data/lib/snaptrade.rb +214 -214
  161. data/snaptrade.gemspec +41 -41
  162. data/spec/api/account_information_api_spec.rb +135 -135
  163. data/spec/api/api_status_api_spec.rb +42 -42
  164. data/spec/api/authentication_api_spec.rb +88 -88
  165. data/spec/api/connections_api_spec.rb +82 -82
  166. data/spec/api/error_logs_api_spec.rb +43 -43
  167. data/spec/api/options_api_spec.rb +101 -101
  168. data/spec/api/reference_data_api_spec.rb +150 -150
  169. data/spec/api/trading_api_spec.rb +112 -112
  170. data/spec/api/transactions_and_reporting_api_spec.rb +67 -67
  171. data/spec/api_client_spec.rb +193 -193
  172. data/spec/configuration_spec.rb +6 -6
  173. data/spec/getting_started_spec.rb +6 -0
  174. data/spec/models/account_holdings_account_spec.rb +54 -54
  175. data/spec/models/account_holdings_spec.rb +48 -48
  176. data/spec/models/account_order_record_spec.rb +132 -132
  177. data/spec/models/account_order_record_status_spec.rb +24 -24
  178. data/spec/models/account_simple_spec.rb +48 -48
  179. data/spec/models/account_spec.rb +84 -84
  180. data/spec/models/account_sync_status_spec.rb +30 -30
  181. data/spec/models/action_spec.rb +24 -24
  182. data/spec/models/auth_type_spec.rb +24 -24
  183. data/spec/models/authentication_login_snap_trade_user200_response_spec.rb +27 -27
  184. data/spec/models/balance_spec.rb +36 -36
  185. data/spec/models/brokerage_authorization_spec.rb +78 -78
  186. data/spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb +42 -42
  187. data/spec/models/brokerage_authorization_type_read_only_spec.rb +48 -48
  188. data/spec/models/brokerage_authorization_type_read_only_type_spec.rb +24 -24
  189. data/spec/models/brokerage_authorization_type_spec.rb +30 -30
  190. data/spec/models/brokerage_authorization_type_type_spec.rb +24 -24
  191. data/spec/models/brokerage_spec.rb +132 -132
  192. data/spec/models/brokerage_symbol_option_symbol_spec.rb +72 -72
  193. data/spec/models/brokerage_symbol_spec.rb +60 -60
  194. data/spec/models/brokerage_symbol_symbol_spec.rb +72 -72
  195. data/spec/models/brokerage_type_spec.rb +36 -36
  196. data/spec/models/calculated_trade_spec.rb +36 -36
  197. data/spec/models/cash_restriction_spec.rb +54 -54
  198. data/spec/models/connection_type_spec.rb +24 -24
  199. data/spec/models/connections_session_events200_response_inner_spec.rb +66 -66
  200. data/spec/models/currency_spec.rb +42 -42
  201. data/spec/models/delete_user_response_spec.rb +36 -36
  202. data/spec/models/dividend_at_date_spec.rb +42 -42
  203. data/spec/models/encrypted_response_encrypted_message_data_spec.rb +42 -42
  204. data/spec/models/encrypted_response_spec.rb +36 -36
  205. data/spec/models/exchange_rate_pairs_spec.rb +42 -42
  206. data/spec/models/exchange_spec.rb +72 -72
  207. data/spec/models/excluded_asset_spec.rb +30 -30
  208. data/spec/models/jwt_spec.rb +30 -30
  209. data/spec/models/login_redirect_uri_spec.rb +36 -36
  210. data/spec/models/manual_trade_and_impact_spec.rb +42 -42
  211. data/spec/models/manual_trade_balance_spec.rb +42 -42
  212. data/spec/models/manual_trade_form_spec.rb +72 -72
  213. data/spec/models/manual_trade_spec.rb +72 -72
  214. data/spec/models/manual_trade_symbol_spec.rb +60 -60
  215. data/spec/models/model400_failed_request_response_spec.rb +36 -36
  216. data/spec/models/model401_failed_request_response_spec.rb +36 -36
  217. data/spec/models/model403_failed_request_response_spec.rb +36 -36
  218. data/spec/models/model404_failed_request_response_spec.rb +36 -36
  219. data/spec/models/model_asset_class_details_spec.rb +36 -36
  220. data/spec/models/model_asset_class_spec.rb +36 -36
  221. data/spec/models/model_asset_class_target_spec.rb +30 -30
  222. data/spec/models/model_portfolio_asset_class_spec.rb +36 -36
  223. data/spec/models/model_portfolio_details_spec.rb +42 -42
  224. data/spec/models/model_portfolio_security_spec.rb +36 -36
  225. data/spec/models/model_portfolio_spec.rb +42 -42
  226. data/spec/models/model_type_spec.rb +24 -24
  227. data/spec/models/monthly_dividends_spec.rb +36 -36
  228. data/spec/models/net_contributions_spec.rb +42 -42
  229. data/spec/models/net_dividend_spec.rb +42 -42
  230. data/spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb +42 -42
  231. data/spec/models/option_chain_inner_chain_per_root_inner_spec.rb +42 -42
  232. data/spec/models/option_chain_inner_spec.rb +54 -54
  233. data/spec/models/option_leg_action_spec.rb +24 -24
  234. data/spec/models/option_leg_spec.rb +42 -42
  235. data/spec/models/option_strategy_legs_inner_spec.rb +48 -48
  236. data/spec/models/option_strategy_spec.rb +54 -54
  237. data/spec/models/options_get_option_strategy_request_spec.rb +42 -42
  238. data/spec/models/options_holdings_spec.rb +60 -60
  239. data/spec/models/options_place_option_strategy_request_spec.rb +42 -42
  240. data/spec/models/options_position_currency_spec.rb +42 -42
  241. data/spec/models/options_position_spec.rb +66 -66
  242. data/spec/models/options_symbol_spec.rb +72 -72
  243. data/spec/models/order_strategy_execute_body_order_type_spec.rb +24 -24
  244. data/spec/models/order_strategy_execute_body_time_in_force_spec.rb +24 -24
  245. data/spec/models/order_type_spec.rb +24 -24
  246. data/spec/models/partner_data_spec.rb +96 -96
  247. data/spec/models/past_value_spec.rb +42 -42
  248. data/spec/models/performance_custom_spec.rb +138 -138
  249. data/spec/models/portfolio_group_info_spec.rb +90 -90
  250. data/spec/models/portfolio_group_position_spec.rb +42 -42
  251. data/spec/models/portfolio_group_settings_spec.rb +54 -54
  252. data/spec/models/portfolio_group_spec.rb +36 -36
  253. data/spec/models/position_spec.rb +60 -60
  254. data/spec/models/position_symbol_spec.rb +60 -60
  255. data/spec/models/redirect_tokenand_pin_spec.rb +36 -36
  256. data/spec/models/security_type_spec.rb +48 -48
  257. data/spec/models/session_event_spec.rb +66 -66
  258. data/spec/models/session_event_type_spec.rb +24 -24
  259. data/spec/models/snap_trade_api_disclaimer_accept_status_spec.rb +36 -36
  260. data/spec/models/snap_trade_holdings_account_account_id_spec.rb +78 -78
  261. data/spec/models/snap_trade_holdings_account_spec.rb +72 -72
  262. data/spec/models/snap_trade_holdings_total_value_spec.rb +36 -36
  263. data/spec/models/snap_trade_login_user_request_body_spec.rb +54 -54
  264. data/spec/models/snap_trade_register_user_request_body_spec.rb +36 -36
  265. data/spec/models/state_spec.rb +24 -24
  266. data/spec/models/status_spec.rb +42 -42
  267. data/spec/models/strategy_impact_legs_inner_spec.rb +66 -66
  268. data/spec/models/strategy_impact_spec.rb +90 -90
  269. data/spec/models/strategy_order_place_orders_inner_legs_inner_spec.rb +66 -66
  270. data/spec/models/strategy_order_place_orders_inner_spec.rb +282 -282
  271. data/spec/models/strategy_order_place_spec.rb +36 -36
  272. data/spec/models/strategy_order_record_order_type_spec.rb +24 -24
  273. data/spec/models/strategy_order_record_spec.rb +90 -90
  274. data/spec/models/strategy_order_record_status_spec.rb +24 -24
  275. data/spec/models/strategy_order_record_time_in_force_spec.rb +24 -24
  276. data/spec/models/strategy_quotes_greek_spec.rb +54 -54
  277. data/spec/models/strategy_quotes_spec.rb +60 -60
  278. data/spec/models/strategy_type_spec.rb +24 -24
  279. data/spec/models/sub_period_return_rate_spec.rb +42 -42
  280. data/spec/models/symbol_query_spec.rb +30 -30
  281. data/spec/models/symbol_spec.rb +66 -66
  282. data/spec/models/symbols_quotes_inner_spec.rb +60 -60
  283. data/spec/models/target_asset_spec.rb +60 -60
  284. data/spec/models/time_in_force_spec.rb +24 -24
  285. data/spec/models/trade_action_spec.rb +24 -24
  286. data/spec/models/trade_execution_status_action_spec.rb +24 -24
  287. data/spec/models/trade_execution_status_spec.rb +78 -78
  288. data/spec/models/trade_impact_spec.rb +54 -54
  289. data/spec/models/trade_spec.rb +72 -72
  290. data/spec/models/trading_cancel_user_account_order_request_spec.rb +30 -30
  291. data/spec/models/trading_place_oco_order_request_spec.rb +36 -36
  292. data/spec/models/transactions_status_spec.rb +36 -36
  293. data/spec/models/type_spec.rb +24 -24
  294. data/spec/models/underlying_symbol_spec.rb +66 -66
  295. data/spec/models/universal_activity_spec.rb +126 -126
  296. data/spec/models/universal_symbol_spec.rb +72 -72
  297. data/spec/models/universal_symbol_ticker_spec.rb +72 -72
  298. data/spec/models/us_exchange_spec.rb +78 -78
  299. data/spec/models/user_error_log_spec.rb +60 -60
  300. data/spec/models/user_i_dand_secret_spec.rb +36 -36
  301. data/spec/models/user_settings_spec.rb +84 -84
  302. data/spec/spec_helper.rb +6 -6
  303. metadata +1 -1
data/docs/OptionsApi.md CHANGED
@@ -1,390 +1,390 @@
1
- # SnapTrade::OptionsApi
2
-
3
- All URIs are relative to *https://api.snaptrade.com/api/v1*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**get_option_strategy**](OptionsApi.md#get_option_strategy) | **POST** /accounts/{accountId}/optionStrategy | Creates an option strategy object that will be used to place an option strategy order |
8
- | [**get_options_chain**](OptionsApi.md#get_options_chain) | **GET** /accounts/{accountId}/optionsChain | Get the options chain |
9
- | [**get_options_strategy_quote**](OptionsApi.md#get_options_strategy_quote) | **GET** /accounts/{accountId}/optionStrategy/{optionStrategyId} | Get latest market data of option strategy |
10
- | [**list_option_holdings**](OptionsApi.md#list_option_holdings) | **GET** /accounts/{accountId}/options | Get the options holdings in the account |
11
- | [**place_option_strategy**](OptionsApi.md#place_option_strategy) | **POST** /accounts/{accountId}/optionStrategy/{optionStrategyId}/execute | Place an option strategy order on the brokerage |
12
-
13
- ## get_option_strategy
14
-
15
- Creates an option strategy object that will be used to place an option strategy order
16
-
17
- ### Example
18
-
19
- ```ruby
20
- require 'snaptrade'
21
-
1
+ # SnapTrade::OptionsApi
2
+
3
+ All URIs are relative to *https://api.snaptrade.com/api/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**get_option_strategy**](OptionsApi.md#get_option_strategy) | **POST** /accounts/{accountId}/optionStrategy | Creates an option strategy object that will be used to place an option strategy order |
8
+ | [**get_options_chain**](OptionsApi.md#get_options_chain) | **GET** /accounts/{accountId}/optionsChain | Get the options chain |
9
+ | [**get_options_strategy_quote**](OptionsApi.md#get_options_strategy_quote) | **GET** /accounts/{accountId}/optionStrategy/{optionStrategyId} | Get latest market data of option strategy |
10
+ | [**list_option_holdings**](OptionsApi.md#list_option_holdings) | **GET** /accounts/{accountId}/options | Get the options holdings in the account |
11
+ | [**place_option_strategy**](OptionsApi.md#place_option_strategy) | **POST** /accounts/{accountId}/optionStrategy/{optionStrategyId}/execute | Place an option strategy order on the brokerage |
12
+
13
+ ## get_option_strategy
14
+
15
+ Creates an option strategy object that will be used to place an option strategy order
16
+
17
+ ### Example
18
+
19
+ ```ruby
20
+ require 'snaptrade'
21
+
22
22
  SnapTrade.client_id = "YOUR_CLIENT_ID"
23
- SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
24
-
25
- underlying_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
23
+ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
24
+
25
+ underlying_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
26
26
  legs = [
27
27
  {
28
28
  "action" => "BUY_TO_OPEN",
29
29
  "option_symbol_id" => "SPY220819P00200000",
30
30
  "quantity" => 1,
31
31
  }
32
- ]
33
- strategy_type = "CUSTOM"
34
- user_id = "John.doe@snaptrade.com"
35
- user_secret = "USERSECRET123"
36
- account_id = "accountId_example"
37
-
38
- begin
39
- # Creates an option strategy object that will be used to place an option strategy order
40
- result = SnapTrade::Options.get_option_strategy(
41
- underlying_symbol_id: underlying_symbol_id,
42
- legs: legs,
43
- strategy_type: strategy_type,
44
- user_id: user_id,
45
- user_secret: user_secret,
46
- account_id: account_id,
47
- )
48
- p result
49
- rescue SnapTrade::ApiError => e
50
- puts "Exception when calling SnapTrade::Options.get_option_strategy: #{e}"
51
- end
52
- ```
53
-
54
- #### Using the get_option_strategy_with_http_info variant
55
-
56
- This returns an Array which contains the response data, status code and headers.
57
-
58
- ```ruby
59
- underlying_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
32
+ ]
33
+ strategy_type = "CUSTOM"
34
+ user_id = "John.doe@snaptrade.com"
35
+ user_secret = "USERSECRET123"
36
+ account_id = "accountId_example"
37
+
38
+ begin
39
+ # Creates an option strategy object that will be used to place an option strategy order
40
+ result = SnapTrade::Options.get_option_strategy(
41
+ underlying_symbol_id: underlying_symbol_id,
42
+ legs: legs,
43
+ strategy_type: strategy_type,
44
+ user_id: user_id,
45
+ user_secret: user_secret,
46
+ account_id: account_id,
47
+ )
48
+ p result
49
+ rescue SnapTrade::ApiError => e
50
+ puts "Exception when calling SnapTrade::Options.get_option_strategy: #{e}"
51
+ end
52
+ ```
53
+
54
+ #### Using the get_option_strategy_with_http_info variant
55
+
56
+ This returns an Array which contains the response data, status code and headers.
57
+
58
+ ```ruby
59
+ underlying_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
60
60
  legs = [
61
61
  {
62
62
  "action" => "BUY_TO_OPEN",
63
63
  "option_symbol_id" => "SPY220819P00200000",
64
64
  "quantity" => 1,
65
65
  }
66
- ]
67
- strategy_type = "CUSTOM"
68
- user_id = "John.doe@snaptrade.com"
69
- user_secret = "USERSECRET123"
70
- account_id = "accountId_example"
71
-
72
- begin
73
- # Creates an option strategy object that will be used to place an option strategy order
74
- data, status_code, headers, response = SnapTrade::Options.get_option_strategy_with_http_info(
75
- underlying_symbol_id: underlying_symbol_id,
76
- legs: legs,
77
- strategy_type: strategy_type,
78
- user_id: user_id,
79
- user_secret: user_secret,
80
- account_id: account_id,
81
- )
82
- p status_code # => 2xx
83
- p headers # => { ... }
84
- p data # => StrategyQuotes
85
- rescue SnapTrade::ApiError => e
86
- puts "Exception when calling SnapTrade::Options.get_option_strategy: #{e}"
87
- end
88
- ```
89
-
90
- ### Parameters
91
-
92
- | Name | Type | Description | Notes |
93
- | ---- | ---- | ----------- | ----- |
94
- | **user_id** | **String** | | |
95
- | **user_secret** | **String** | | |
96
- | **account_id** | **String** | The ID of the account get positions. | |
97
- | **options_get_option_strategy_request** | [**OptionsGetOptionStrategyRequest**](OptionsGetOptionStrategyRequest.md) | | |
98
-
99
- ### Return type
100
-
101
- [**StrategyQuotes**](StrategyQuotes.md)
102
-
103
- ## get_options_chain
104
-
105
- Get the options chain
106
-
107
- ### Example
108
-
109
- ```ruby
110
- require 'snaptrade'
111
-
66
+ ]
67
+ strategy_type = "CUSTOM"
68
+ user_id = "John.doe@snaptrade.com"
69
+ user_secret = "USERSECRET123"
70
+ account_id = "accountId_example"
71
+
72
+ begin
73
+ # Creates an option strategy object that will be used to place an option strategy order
74
+ data, status_code, headers, response = SnapTrade::Options.get_option_strategy_with_http_info(
75
+ underlying_symbol_id: underlying_symbol_id,
76
+ legs: legs,
77
+ strategy_type: strategy_type,
78
+ user_id: user_id,
79
+ user_secret: user_secret,
80
+ account_id: account_id,
81
+ )
82
+ p status_code # => 2xx
83
+ p headers # => { ... }
84
+ p data # => StrategyQuotes
85
+ rescue SnapTrade::ApiError => e
86
+ puts "Exception when calling SnapTrade::Options.get_option_strategy: #{e}"
87
+ end
88
+ ```
89
+
90
+ ### Parameters
91
+
92
+ | Name | Type | Description | Notes |
93
+ | ---- | ---- | ----------- | ----- |
94
+ | **user_id** | **String** | | |
95
+ | **user_secret** | **String** | | |
96
+ | **account_id** | **String** | The ID of the account get positions. | |
97
+ | **options_get_option_strategy_request** | [**OptionsGetOptionStrategyRequest**](OptionsGetOptionStrategyRequest.md) | | |
98
+
99
+ ### Return type
100
+
101
+ [**StrategyQuotes**](StrategyQuotes.md)
102
+
103
+ ## get_options_chain
104
+
105
+ Get the options chain
106
+
107
+ ### Example
108
+
109
+ ```ruby
110
+ require 'snaptrade'
111
+
112
112
  SnapTrade.client_id = "YOUR_CLIENT_ID"
113
- SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
114
-
115
- user_id = "John.doe@snaptrade.com"
116
- user_secret = "USERSECRET123"
117
- account_id = "accountId_example"
118
- symbol = "symbol_example"
119
-
120
- begin
121
- # Get the options chain
122
- result = SnapTrade::Options.get_options_chain(
123
- user_id: user_id,
124
- user_secret: user_secret,
125
- account_id: account_id,
126
- symbol: symbol,
127
- )
128
- p result
129
- rescue SnapTrade::ApiError => e
130
- puts "Exception when calling SnapTrade::Options.get_options_chain: #{e}"
131
- end
132
- ```
133
-
134
- #### Using the get_options_chain_with_http_info variant
135
-
136
- This returns an Array which contains the response data, status code and headers.
137
-
138
- ```ruby
139
- user_id = "John.doe@snaptrade.com"
140
- user_secret = "USERSECRET123"
141
- account_id = "accountId_example"
142
- symbol = "symbol_example"
143
-
144
- begin
145
- # Get the options chain
146
- data, status_code, headers, response = SnapTrade::Options.get_options_chain_with_http_info(
147
- user_id: user_id,
148
- user_secret: user_secret,
149
- account_id: account_id,
150
- symbol: symbol,
151
- )
152
- p status_code # => 2xx
153
- p headers # => { ... }
154
- p data # => Array<OptionChainInner>
155
- rescue SnapTrade::ApiError => e
156
- puts "Exception when calling SnapTrade::Options.get_options_chain: #{e}"
157
- end
158
- ```
159
-
160
- ### Parameters
161
-
162
- | Name | Type | Description | Notes |
163
- | ---- | ---- | ----------- | ----- |
164
- | **user_id** | **String** | | |
165
- | **user_secret** | **String** | | |
166
- | **account_id** | **String** | The ID of the account get positions. | |
167
- | **symbol** | **String** | Universal symbol ID if symbol | |
168
-
169
- ### Return type
170
-
171
- [**Array&lt;OptionChainInner&gt;**](OptionChainInner.md)
172
-
173
- ## get_options_strategy_quote
174
-
175
- Get latest market data of option strategy
176
-
177
- ### Example
178
-
179
- ```ruby
180
- require 'snaptrade'
181
-
113
+ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
114
+
115
+ user_id = "John.doe@snaptrade.com"
116
+ user_secret = "USERSECRET123"
117
+ account_id = "accountId_example"
118
+ symbol = "symbol_example"
119
+
120
+ begin
121
+ # Get the options chain
122
+ result = SnapTrade::Options.get_options_chain(
123
+ user_id: user_id,
124
+ user_secret: user_secret,
125
+ account_id: account_id,
126
+ symbol: symbol,
127
+ )
128
+ p result
129
+ rescue SnapTrade::ApiError => e
130
+ puts "Exception when calling SnapTrade::Options.get_options_chain: #{e}"
131
+ end
132
+ ```
133
+
134
+ #### Using the get_options_chain_with_http_info variant
135
+
136
+ This returns an Array which contains the response data, status code and headers.
137
+
138
+ ```ruby
139
+ user_id = "John.doe@snaptrade.com"
140
+ user_secret = "USERSECRET123"
141
+ account_id = "accountId_example"
142
+ symbol = "symbol_example"
143
+
144
+ begin
145
+ # Get the options chain
146
+ data, status_code, headers, response = SnapTrade::Options.get_options_chain_with_http_info(
147
+ user_id: user_id,
148
+ user_secret: user_secret,
149
+ account_id: account_id,
150
+ symbol: symbol,
151
+ )
152
+ p status_code # => 2xx
153
+ p headers # => { ... }
154
+ p data # => Array<OptionChainInner>
155
+ rescue SnapTrade::ApiError => e
156
+ puts "Exception when calling SnapTrade::Options.get_options_chain: #{e}"
157
+ end
158
+ ```
159
+
160
+ ### Parameters
161
+
162
+ | Name | Type | Description | Notes |
163
+ | ---- | ---- | ----------- | ----- |
164
+ | **user_id** | **String** | | |
165
+ | **user_secret** | **String** | | |
166
+ | **account_id** | **String** | The ID of the account get positions. | |
167
+ | **symbol** | **String** | Universal symbol ID if symbol | |
168
+
169
+ ### Return type
170
+
171
+ [**Array&lt;OptionChainInner&gt;**](OptionChainInner.md)
172
+
173
+ ## get_options_strategy_quote
174
+
175
+ Get latest market data of option strategy
176
+
177
+ ### Example
178
+
179
+ ```ruby
180
+ require 'snaptrade'
181
+
182
182
  SnapTrade.client_id = "YOUR_CLIENT_ID"
183
- SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
184
-
185
- user_id = "John.doe@snaptrade.com"
186
- user_secret = "USERSECRET123"
187
- account_id = "accountId_example"
188
- option_strategy_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
189
-
190
- begin
191
- # Get latest market data of option strategy
192
- result = SnapTrade::Options.get_options_strategy_quote(
193
- user_id: user_id,
194
- user_secret: user_secret,
195
- account_id: account_id,
196
- option_strategy_id: option_strategy_id,
197
- )
198
- p result
199
- rescue SnapTrade::ApiError => e
200
- puts "Exception when calling SnapTrade::Options.get_options_strategy_quote: #{e}"
201
- end
202
- ```
203
-
204
- #### Using the get_options_strategy_quote_with_http_info variant
205
-
206
- This returns an Array which contains the response data, status code and headers.
207
-
208
- ```ruby
209
- user_id = "John.doe@snaptrade.com"
210
- user_secret = "USERSECRET123"
211
- account_id = "accountId_example"
212
- option_strategy_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
213
-
214
- begin
215
- # Get latest market data of option strategy
216
- data, status_code, headers, response = SnapTrade::Options.get_options_strategy_quote_with_http_info(
217
- user_id: user_id,
218
- user_secret: user_secret,
219
- account_id: account_id,
220
- option_strategy_id: option_strategy_id,
221
- )
222
- p status_code # => 2xx
223
- p headers # => { ... }
224
- p data # => StrategyQuotes
225
- rescue SnapTrade::ApiError => e
226
- puts "Exception when calling SnapTrade::Options.get_options_strategy_quote: #{e}"
227
- end
228
- ```
229
-
230
- ### Parameters
231
-
232
- | Name | Type | Description | Notes |
233
- | ---- | ---- | ----------- | ----- |
234
- | **user_id** | **String** | | |
235
- | **user_secret** | **String** | | |
236
- | **account_id** | **String** | The ID of the account get positions. | |
237
- | **option_strategy_id** | **String** | Option strategy id obtained from response when creating option strategy object | |
238
-
239
- ### Return type
240
-
241
- [**StrategyQuotes**](StrategyQuotes.md)
242
-
243
- ## list_option_holdings
244
-
245
- Get the options holdings in the account
246
-
247
- ### Example
248
-
249
- ```ruby
250
- require 'snaptrade'
251
-
183
+ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
184
+
185
+ user_id = "John.doe@snaptrade.com"
186
+ user_secret = "USERSECRET123"
187
+ account_id = "accountId_example"
188
+ option_strategy_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
189
+
190
+ begin
191
+ # Get latest market data of option strategy
192
+ result = SnapTrade::Options.get_options_strategy_quote(
193
+ user_id: user_id,
194
+ user_secret: user_secret,
195
+ account_id: account_id,
196
+ option_strategy_id: option_strategy_id,
197
+ )
198
+ p result
199
+ rescue SnapTrade::ApiError => e
200
+ puts "Exception when calling SnapTrade::Options.get_options_strategy_quote: #{e}"
201
+ end
202
+ ```
203
+
204
+ #### Using the get_options_strategy_quote_with_http_info variant
205
+
206
+ This returns an Array which contains the response data, status code and headers.
207
+
208
+ ```ruby
209
+ user_id = "John.doe@snaptrade.com"
210
+ user_secret = "USERSECRET123"
211
+ account_id = "accountId_example"
212
+ option_strategy_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
213
+
214
+ begin
215
+ # Get latest market data of option strategy
216
+ data, status_code, headers, response = SnapTrade::Options.get_options_strategy_quote_with_http_info(
217
+ user_id: user_id,
218
+ user_secret: user_secret,
219
+ account_id: account_id,
220
+ option_strategy_id: option_strategy_id,
221
+ )
222
+ p status_code # => 2xx
223
+ p headers # => { ... }
224
+ p data # => StrategyQuotes
225
+ rescue SnapTrade::ApiError => e
226
+ puts "Exception when calling SnapTrade::Options.get_options_strategy_quote: #{e}"
227
+ end
228
+ ```
229
+
230
+ ### Parameters
231
+
232
+ | Name | Type | Description | Notes |
233
+ | ---- | ---- | ----------- | ----- |
234
+ | **user_id** | **String** | | |
235
+ | **user_secret** | **String** | | |
236
+ | **account_id** | **String** | The ID of the account get positions. | |
237
+ | **option_strategy_id** | **String** | Option strategy id obtained from response when creating option strategy object | |
238
+
239
+ ### Return type
240
+
241
+ [**StrategyQuotes**](StrategyQuotes.md)
242
+
243
+ ## list_option_holdings
244
+
245
+ Get the options holdings in the account
246
+
247
+ ### Example
248
+
249
+ ```ruby
250
+ require 'snaptrade'
251
+
252
252
  SnapTrade.client_id = "YOUR_CLIENT_ID"
253
- SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
254
-
255
- user_id = "John.doe@snaptrade.com"
256
- user_secret = "USERSECRET123"
257
- account_id = "accountId_example"
258
-
259
- begin
260
- # Get the options holdings in the account
261
- result = SnapTrade::Options.list_option_holdings(
262
- user_id: user_id,
263
- user_secret: user_secret,
264
- account_id: account_id,
265
- )
266
- p result
267
- rescue SnapTrade::ApiError => e
268
- puts "Exception when calling SnapTrade::Options.list_option_holdings: #{e}"
269
- end
270
- ```
271
-
272
- #### Using the list_option_holdings_with_http_info variant
273
-
274
- This returns an Array which contains the response data, status code and headers.
275
-
276
- ```ruby
277
- user_id = "John.doe@snaptrade.com"
278
- user_secret = "USERSECRET123"
279
- account_id = "accountId_example"
280
-
281
- begin
282
- # Get the options holdings in the account
283
- data, status_code, headers, response = SnapTrade::Options.list_option_holdings_with_http_info(
284
- user_id: user_id,
285
- user_secret: user_secret,
286
- account_id: account_id,
287
- )
288
- p status_code # => 2xx
289
- p headers # => { ... }
290
- p data # => Array<OptionsPosition>
291
- rescue SnapTrade::ApiError => e
292
- puts "Exception when calling SnapTrade::Options.list_option_holdings: #{e}"
293
- end
294
- ```
295
-
296
- ### Parameters
297
-
298
- | Name | Type | Description | Notes |
299
- | ---- | ---- | ----------- | ----- |
300
- | **user_id** | **String** | | |
301
- | **user_secret** | **String** | | |
302
- | **account_id** | **String** | The ID of the account get positions. | |
303
-
304
- ### Return type
305
-
306
- [**Array&lt;OptionsPosition&gt;**](OptionsPosition.md)
307
-
308
- ## place_option_strategy
309
-
310
- Place an option strategy order on the brokerage
311
-
312
- ### Example
313
-
314
- ```ruby
315
- require 'snaptrade'
316
-
253
+ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
254
+
255
+ user_id = "John.doe@snaptrade.com"
256
+ user_secret = "USERSECRET123"
257
+ account_id = "accountId_example"
258
+
259
+ begin
260
+ # Get the options holdings in the account
261
+ result = SnapTrade::Options.list_option_holdings(
262
+ user_id: user_id,
263
+ user_secret: user_secret,
264
+ account_id: account_id,
265
+ )
266
+ p result
267
+ rescue SnapTrade::ApiError => e
268
+ puts "Exception when calling SnapTrade::Options.list_option_holdings: #{e}"
269
+ end
270
+ ```
271
+
272
+ #### Using the list_option_holdings_with_http_info variant
273
+
274
+ This returns an Array which contains the response data, status code and headers.
275
+
276
+ ```ruby
277
+ user_id = "John.doe@snaptrade.com"
278
+ user_secret = "USERSECRET123"
279
+ account_id = "accountId_example"
280
+
281
+ begin
282
+ # Get the options holdings in the account
283
+ data, status_code, headers, response = SnapTrade::Options.list_option_holdings_with_http_info(
284
+ user_id: user_id,
285
+ user_secret: user_secret,
286
+ account_id: account_id,
287
+ )
288
+ p status_code # => 2xx
289
+ p headers # => { ... }
290
+ p data # => Array<OptionsPosition>
291
+ rescue SnapTrade::ApiError => e
292
+ puts "Exception when calling SnapTrade::Options.list_option_holdings: #{e}"
293
+ end
294
+ ```
295
+
296
+ ### Parameters
297
+
298
+ | Name | Type | Description | Notes |
299
+ | ---- | ---- | ----------- | ----- |
300
+ | **user_id** | **String** | | |
301
+ | **user_secret** | **String** | | |
302
+ | **account_id** | **String** | The ID of the account get positions. | |
303
+
304
+ ### Return type
305
+
306
+ [**Array&lt;OptionsPosition&gt;**](OptionsPosition.md)
307
+
308
+ ## place_option_strategy
309
+
310
+ Place an option strategy order on the brokerage
311
+
312
+ ### Example
313
+
314
+ ```ruby
315
+ require 'snaptrade'
316
+
317
317
  SnapTrade.client_id = "YOUR_CLIENT_ID"
318
- SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
319
-
320
- order_type = "Limit"
321
- time_in_force = "DAY"
322
- price = 31.33
323
- user_id = "John.doe@snaptrade.com"
324
- user_secret = "USERSECRET123"
325
- account_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
326
- option_strategy_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
327
-
328
- begin
329
- # Place an option strategy order on the brokerage
330
- result = SnapTrade::Options.place_option_strategy(
331
- order_type: order_type,
332
- time_in_force: time_in_force,
333
- price: price,
334
- user_id: user_id,
335
- user_secret: user_secret,
336
- account_id: account_id,
337
- option_strategy_id: option_strategy_id,
338
- )
339
- p result
340
- rescue SnapTrade::ApiError => e
341
- puts "Exception when calling SnapTrade::Options.place_option_strategy: #{e}"
342
- end
343
- ```
344
-
345
- #### Using the place_option_strategy_with_http_info variant
346
-
347
- This returns an Array which contains the response data, status code and headers.
348
-
349
- ```ruby
350
- order_type = "Limit"
351
- time_in_force = "DAY"
352
- price = 31.33
353
- user_id = "John.doe@snaptrade.com"
354
- user_secret = "USERSECRET123"
355
- account_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
356
- option_strategy_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
357
-
358
- begin
359
- # Place an option strategy order on the brokerage
360
- data, status_code, headers, response = SnapTrade::Options.place_option_strategy_with_http_info(
361
- order_type: order_type,
362
- time_in_force: time_in_force,
363
- price: price,
364
- user_id: user_id,
365
- user_secret: user_secret,
366
- account_id: account_id,
367
- option_strategy_id: option_strategy_id,
368
- )
369
- p status_code # => 2xx
370
- p headers # => { ... }
371
- p data # => StrategyOrderRecord
372
- rescue SnapTrade::ApiError => e
373
- puts "Exception when calling SnapTrade::Options.place_option_strategy: #{e}"
374
- end
375
- ```
376
-
377
- ### Parameters
378
-
379
- | Name | Type | Description | Notes |
380
- | ---- | ---- | ----------- | ----- |
381
- | **user_id** | **String** | | |
382
- | **user_secret** | **String** | | |
383
- | **account_id** | **String** | The ID of the account get positions. | |
384
- | **option_strategy_id** | **String** | Option strategy id obtained from response when creating option strategy object | |
385
- | **options_place_option_strategy_request** | [**OptionsPlaceOptionStrategyRequest**](OptionsPlaceOptionStrategyRequest.md) | | |
386
-
387
- ### Return type
388
-
389
- [**StrategyOrderRecord**](StrategyOrderRecord.md)
390
-
318
+ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
319
+
320
+ order_type = "Limit"
321
+ time_in_force = "DAY"
322
+ price = 31.33
323
+ user_id = "John.doe@snaptrade.com"
324
+ user_secret = "USERSECRET123"
325
+ account_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
326
+ option_strategy_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
327
+
328
+ begin
329
+ # Place an option strategy order on the brokerage
330
+ result = SnapTrade::Options.place_option_strategy(
331
+ order_type: order_type,
332
+ time_in_force: time_in_force,
333
+ price: price,
334
+ user_id: user_id,
335
+ user_secret: user_secret,
336
+ account_id: account_id,
337
+ option_strategy_id: option_strategy_id,
338
+ )
339
+ p result
340
+ rescue SnapTrade::ApiError => e
341
+ puts "Exception when calling SnapTrade::Options.place_option_strategy: #{e}"
342
+ end
343
+ ```
344
+
345
+ #### Using the place_option_strategy_with_http_info variant
346
+
347
+ This returns an Array which contains the response data, status code and headers.
348
+
349
+ ```ruby
350
+ order_type = "Limit"
351
+ time_in_force = "DAY"
352
+ price = 31.33
353
+ user_id = "John.doe@snaptrade.com"
354
+ user_secret = "USERSECRET123"
355
+ account_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
356
+ option_strategy_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
357
+
358
+ begin
359
+ # Place an option strategy order on the brokerage
360
+ data, status_code, headers, response = SnapTrade::Options.place_option_strategy_with_http_info(
361
+ order_type: order_type,
362
+ time_in_force: time_in_force,
363
+ price: price,
364
+ user_id: user_id,
365
+ user_secret: user_secret,
366
+ account_id: account_id,
367
+ option_strategy_id: option_strategy_id,
368
+ )
369
+ p status_code # => 2xx
370
+ p headers # => { ... }
371
+ p data # => StrategyOrderRecord
372
+ rescue SnapTrade::ApiError => e
373
+ puts "Exception when calling SnapTrade::Options.place_option_strategy: #{e}"
374
+ end
375
+ ```
376
+
377
+ ### Parameters
378
+
379
+ | Name | Type | Description | Notes |
380
+ | ---- | ---- | ----------- | ----- |
381
+ | **user_id** | **String** | | |
382
+ | **user_secret** | **String** | | |
383
+ | **account_id** | **String** | The ID of the account get positions. | |
384
+ | **option_strategy_id** | **String** | Option strategy id obtained from response when creating option strategy object | |
385
+ | **options_place_option_strategy_request** | [**OptionsPlaceOptionStrategyRequest**](OptionsPlaceOptionStrategyRequest.md) | | |
386
+
387
+ ### Return type
388
+
389
+ [**StrategyOrderRecord**](StrategyOrderRecord.md)
390
+