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/TradingApi.md CHANGED
@@ -1,478 +1,478 @@
1
- # SnapTrade::TradingApi
2
-
3
- All URIs are relative to *https://api.snaptrade.com/api/v1*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**cancel_user_account_order**](TradingApi.md#cancel_user_account_order) | **POST** /accounts/{accountId}/orders/cancel | Cancel open order in account |
8
- | [**get_order_impact**](TradingApi.md#get_order_impact) | **POST** /trade/impact | Check impact of trades on account. |
9
- | [**get_user_account_quotes**](TradingApi.md#get_user_account_quotes) | **GET** /accounts/{accountId}/quotes | Get symbol quotes |
10
- | [**place_force_order**](TradingApi.md#place_force_order) | **POST** /trade/place | Place a trade with NO validation. |
11
- | [**place_oco_order**](TradingApi.md#place_oco_order) | **POST** /trade/oco | Place a OCO (One Cancels Other) order |
12
- | [**place_order**](TradingApi.md#place_order) | **POST** /trade/{tradeId} | Place order |
13
-
14
- ## cancel_user_account_order
15
-
16
- Cancel open order in account
17
-
18
- ### Example
19
-
20
- ```ruby
21
- require 'snaptrade'
22
-
1
+ # SnapTrade::TradingApi
2
+
3
+ All URIs are relative to *https://api.snaptrade.com/api/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**cancel_user_account_order**](TradingApi.md#cancel_user_account_order) | **POST** /accounts/{accountId}/orders/cancel | Cancel open order in account |
8
+ | [**get_order_impact**](TradingApi.md#get_order_impact) | **POST** /trade/impact | Check impact of trades on account. |
9
+ | [**get_user_account_quotes**](TradingApi.md#get_user_account_quotes) | **GET** /accounts/{accountId}/quotes | Get symbol quotes |
10
+ | [**place_force_order**](TradingApi.md#place_force_order) | **POST** /trade/place | Place a trade with NO validation. |
11
+ | [**place_oco_order**](TradingApi.md#place_oco_order) | **POST** /trade/oco | Place a OCO (One Cancels Other) order |
12
+ | [**place_order**](TradingApi.md#place_order) | **POST** /trade/{tradeId} | Place order |
13
+
14
+ ## cancel_user_account_order
15
+
16
+ Cancel open order in account
17
+
18
+ ### Example
19
+
20
+ ```ruby
21
+ require 'snaptrade'
22
+
23
23
  SnapTrade.client_id = "YOUR_CLIENT_ID"
24
- SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
25
-
26
- user_id = "John.doe@snaptrade.com"
27
- user_secret = "USERSECRET123"
28
- account_id = "accountId_example"
29
- brokerage_order_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
30
-
31
- begin
32
- # Cancel open order in account
33
- result = SnapTrade::Trading.cancel_user_account_order(
34
- user_id: user_id,
35
- user_secret: user_secret,
36
- account_id: account_id,
37
- brokerage_order_id: brokerage_order_id,
38
- )
39
- p result
40
- rescue SnapTrade::ApiError => e
41
- puts "Exception when calling SnapTrade::Trading.cancel_user_account_order: #{e}"
42
- end
43
- ```
44
-
45
- #### Using the cancel_user_account_order_with_http_info variant
46
-
47
- This returns an Array which contains the response data, status code and headers.
48
-
49
- ```ruby
50
- user_id = "John.doe@snaptrade.com"
51
- user_secret = "USERSECRET123"
52
- account_id = "accountId_example"
53
- brokerage_order_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
54
-
55
- begin
56
- # Cancel open order in account
57
- data, status_code, headers, response = SnapTrade::Trading.cancel_user_account_order_with_http_info(
58
- user_id: user_id,
59
- user_secret: user_secret,
60
- account_id: account_id,
61
- brokerage_order_id: brokerage_order_id,
62
- )
63
- p status_code # => 2xx
64
- p headers # => { ... }
65
- p data # => AccountOrderRecord
66
- rescue SnapTrade::ApiError => e
67
- puts "Exception when calling SnapTrade::Trading.cancel_user_account_order: #{e}"
68
- end
69
- ```
70
-
71
- ### Parameters
72
-
73
- | Name | Type | Description | Notes |
74
- | ---- | ---- | ----------- | ----- |
75
- | **user_id** | **String** | | |
76
- | **user_secret** | **String** | | |
77
- | **account_id** | **String** | The ID of the account get positions. | |
78
- | **trading_cancel_user_account_order_request** | [**TradingCancelUserAccountOrderRequest**](TradingCancelUserAccountOrderRequest.md) | The Order ID to be canceled | |
79
-
80
- ### Return type
81
-
82
- [**AccountOrderRecord**](AccountOrderRecord.md)
83
-
84
- ## get_order_impact
85
-
86
- Check impact of trades on account.
87
-
88
- ### Example
89
-
90
- ```ruby
91
- require 'snaptrade'
92
-
24
+ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
25
+
26
+ user_id = "John.doe@snaptrade.com"
27
+ user_secret = "USERSECRET123"
28
+ account_id = "accountId_example"
29
+ brokerage_order_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
30
+
31
+ begin
32
+ # Cancel open order in account
33
+ result = SnapTrade::Trading.cancel_user_account_order(
34
+ user_id: user_id,
35
+ user_secret: user_secret,
36
+ account_id: account_id,
37
+ brokerage_order_id: brokerage_order_id,
38
+ )
39
+ p result
40
+ rescue SnapTrade::ApiError => e
41
+ puts "Exception when calling SnapTrade::Trading.cancel_user_account_order: #{e}"
42
+ end
43
+ ```
44
+
45
+ #### Using the cancel_user_account_order_with_http_info variant
46
+
47
+ This returns an Array which contains the response data, status code and headers.
48
+
49
+ ```ruby
50
+ user_id = "John.doe@snaptrade.com"
51
+ user_secret = "USERSECRET123"
52
+ account_id = "accountId_example"
53
+ brokerage_order_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
54
+
55
+ begin
56
+ # Cancel open order in account
57
+ data, status_code, headers, response = SnapTrade::Trading.cancel_user_account_order_with_http_info(
58
+ user_id: user_id,
59
+ user_secret: user_secret,
60
+ account_id: account_id,
61
+ brokerage_order_id: brokerage_order_id,
62
+ )
63
+ p status_code # => 2xx
64
+ p headers # => { ... }
65
+ p data # => AccountOrderRecord
66
+ rescue SnapTrade::ApiError => e
67
+ puts "Exception when calling SnapTrade::Trading.cancel_user_account_order: #{e}"
68
+ end
69
+ ```
70
+
71
+ ### Parameters
72
+
73
+ | Name | Type | Description | Notes |
74
+ | ---- | ---- | ----------- | ----- |
75
+ | **user_id** | **String** | | |
76
+ | **user_secret** | **String** | | |
77
+ | **account_id** | **String** | The ID of the account get positions. | |
78
+ | **trading_cancel_user_account_order_request** | [**TradingCancelUserAccountOrderRequest**](TradingCancelUserAccountOrderRequest.md) | The Order ID to be canceled | |
79
+
80
+ ### Return type
81
+
82
+ [**AccountOrderRecord**](AccountOrderRecord.md)
83
+
84
+ ## get_order_impact
85
+
86
+ Check impact of trades on account.
87
+
88
+ ### Example
89
+
90
+ ```ruby
91
+ require 'snaptrade'
92
+
93
93
  SnapTrade.client_id = "YOUR_CLIENT_ID"
94
- SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
95
-
96
- user_id = "John.doe@snaptrade.com"
97
- user_secret = "USERSECRET123"
98
- account_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
99
- action = "BUY"
100
- order_type = "Limit"
101
- price = 31.33
102
- stop = 31.33
103
- time_in_force = "Day"
104
- units = 3.14
105
- universal_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
106
-
107
- begin
108
- # Check impact of trades on account.
109
- result = SnapTrade::Trading.get_order_impact(
110
- user_id: user_id,
111
- user_secret: user_secret,
112
- account_id: account_id,
113
- action: action,
114
- order_type: order_type,
115
- price: price,
116
- stop: stop,
117
- time_in_force: time_in_force,
118
- units: units,
119
- universal_symbol_id: universal_symbol_id,
120
- )
121
- p result
122
- rescue SnapTrade::ApiError => e
123
- puts "Exception when calling SnapTrade::Trading.get_order_impact: #{e}"
124
- end
125
- ```
126
-
127
- #### Using the get_order_impact_with_http_info variant
128
-
129
- This returns an Array which contains the response data, status code and headers.
130
-
131
- ```ruby
132
- user_id = "John.doe@snaptrade.com"
133
- user_secret = "USERSECRET123"
134
- account_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
135
- action = "BUY"
136
- order_type = "Limit"
137
- price = 31.33
138
- stop = 31.33
139
- time_in_force = "Day"
140
- units = 3.14
141
- universal_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
142
-
143
- begin
144
- # Check impact of trades on account.
145
- data, status_code, headers, response = SnapTrade::Trading.get_order_impact_with_http_info(
146
- user_id: user_id,
147
- user_secret: user_secret,
148
- account_id: account_id,
149
- action: action,
150
- order_type: order_type,
151
- price: price,
152
- stop: stop,
153
- time_in_force: time_in_force,
154
- units: units,
155
- universal_symbol_id: universal_symbol_id,
156
- )
157
- p status_code # => 2xx
158
- p headers # => { ... }
159
- p data # => ManualTradeAndImpact
160
- rescue SnapTrade::ApiError => e
161
- puts "Exception when calling SnapTrade::Trading.get_order_impact: #{e}"
162
- end
163
- ```
164
-
165
- ### Parameters
166
-
167
- | Name | Type | Description | Notes |
168
- | ---- | ---- | ----------- | ----- |
169
- | **user_id** | **String** | | |
170
- | **user_secret** | **String** | | |
171
- | **manual_trade_form** | [**ManualTradeForm**](ManualTradeForm.md) | | |
172
-
173
- ### Return type
174
-
175
- [**ManualTradeAndImpact**](ManualTradeAndImpact.md)
176
-
177
- ## get_user_account_quotes
178
-
179
- Get symbol quotes
180
-
181
- ### Example
182
-
183
- ```ruby
184
- require 'snaptrade'
185
-
94
+ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
95
+
96
+ user_id = "John.doe@snaptrade.com"
97
+ user_secret = "USERSECRET123"
98
+ account_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
99
+ action = "BUY"
100
+ order_type = "Limit"
101
+ price = 31.33
102
+ stop = 31.33
103
+ time_in_force = "Day"
104
+ units = 3.14
105
+ universal_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
106
+
107
+ begin
108
+ # Check impact of trades on account.
109
+ result = SnapTrade::Trading.get_order_impact(
110
+ user_id: user_id,
111
+ user_secret: user_secret,
112
+ account_id: account_id,
113
+ action: action,
114
+ order_type: order_type,
115
+ price: price,
116
+ stop: stop,
117
+ time_in_force: time_in_force,
118
+ units: units,
119
+ universal_symbol_id: universal_symbol_id,
120
+ )
121
+ p result
122
+ rescue SnapTrade::ApiError => e
123
+ puts "Exception when calling SnapTrade::Trading.get_order_impact: #{e}"
124
+ end
125
+ ```
126
+
127
+ #### Using the get_order_impact_with_http_info variant
128
+
129
+ This returns an Array which contains the response data, status code and headers.
130
+
131
+ ```ruby
132
+ user_id = "John.doe@snaptrade.com"
133
+ user_secret = "USERSECRET123"
134
+ account_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
135
+ action = "BUY"
136
+ order_type = "Limit"
137
+ price = 31.33
138
+ stop = 31.33
139
+ time_in_force = "Day"
140
+ units = 3.14
141
+ universal_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
142
+
143
+ begin
144
+ # Check impact of trades on account.
145
+ data, status_code, headers, response = SnapTrade::Trading.get_order_impact_with_http_info(
146
+ user_id: user_id,
147
+ user_secret: user_secret,
148
+ account_id: account_id,
149
+ action: action,
150
+ order_type: order_type,
151
+ price: price,
152
+ stop: stop,
153
+ time_in_force: time_in_force,
154
+ units: units,
155
+ universal_symbol_id: universal_symbol_id,
156
+ )
157
+ p status_code # => 2xx
158
+ p headers # => { ... }
159
+ p data # => ManualTradeAndImpact
160
+ rescue SnapTrade::ApiError => e
161
+ puts "Exception when calling SnapTrade::Trading.get_order_impact: #{e}"
162
+ end
163
+ ```
164
+
165
+ ### Parameters
166
+
167
+ | Name | Type | Description | Notes |
168
+ | ---- | ---- | ----------- | ----- |
169
+ | **user_id** | **String** | | |
170
+ | **user_secret** | **String** | | |
171
+ | **manual_trade_form** | [**ManualTradeForm**](ManualTradeForm.md) | | |
172
+
173
+ ### Return type
174
+
175
+ [**ManualTradeAndImpact**](ManualTradeAndImpact.md)
176
+
177
+ ## get_user_account_quotes
178
+
179
+ Get symbol quotes
180
+
181
+ ### Example
182
+
183
+ ```ruby
184
+ require 'snaptrade'
185
+
186
186
  SnapTrade.client_id = "YOUR_CLIENT_ID"
187
- SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
188
-
189
- user_id = "John.doe@snaptrade.com"
190
- user_secret = "USERSECRET123"
191
- symbols = "symbols_example"
192
- account_id = "accountId_example"
193
- use_ticker = True
194
-
195
- begin
196
- # Get symbol quotes
197
- result = SnapTrade::Trading.get_user_account_quotes(
198
- user_id: user_id,
199
- user_secret: user_secret,
200
- symbols: symbols,
201
- account_id: account_id,
202
- use_ticker: use_ticker,
203
- )
204
- p result
205
- rescue SnapTrade::ApiError => e
206
- puts "Exception when calling SnapTrade::Trading.get_user_account_quotes: #{e}"
207
- end
208
- ```
209
-
210
- #### Using the get_user_account_quotes_with_http_info variant
211
-
212
- This returns an Array which contains the response data, status code and headers.
213
-
214
- ```ruby
215
- user_id = "John.doe@snaptrade.com"
216
- user_secret = "USERSECRET123"
217
- symbols = "symbols_example"
218
- account_id = "accountId_example"
219
- use_ticker = True
220
-
221
- begin
222
- # Get symbol quotes
223
- data, status_code, headers, response = SnapTrade::Trading.get_user_account_quotes_with_http_info(
224
- user_id: user_id,
225
- user_secret: user_secret,
226
- symbols: symbols,
227
- account_id: account_id,
228
- use_ticker: use_ticker,
229
- )
230
- p status_code # => 2xx
231
- p headers # => { ... }
232
- p data # => Array<SymbolsQuotesInner>
233
- rescue SnapTrade::ApiError => e
234
- puts "Exception when calling SnapTrade::Trading.get_user_account_quotes: #{e}"
235
- end
236
- ```
237
-
238
- ### Parameters
239
-
240
- | Name | Type | Description | Notes |
241
- | ---- | ---- | ----------- | ----- |
242
- | **user_id** | **String** | | |
243
- | **user_secret** | **String** | | |
244
- | **symbols** | **String** | List of universal_symbol_id or tickers to get quotes for. | |
245
- | **account_id** | **String** | The ID of the account to get quotes. | |
246
- | **use_ticker** | **Boolean** | Should be set to True if providing tickers. | [optional] |
247
-
248
- ### Return type
249
-
250
- [**Array&lt;SymbolsQuotesInner&gt;**](SymbolsQuotesInner.md)
251
-
252
- ## place_force_order
253
-
254
- Place a trade with NO validation.
255
-
256
- ### Example
257
-
258
- ```ruby
259
- require 'snaptrade'
260
-
187
+ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
188
+
189
+ user_id = "John.doe@snaptrade.com"
190
+ user_secret = "USERSECRET123"
191
+ symbols = "symbols_example"
192
+ account_id = "accountId_example"
193
+ use_ticker = True
194
+
195
+ begin
196
+ # Get symbol quotes
197
+ result = SnapTrade::Trading.get_user_account_quotes(
198
+ user_id: user_id,
199
+ user_secret: user_secret,
200
+ symbols: symbols,
201
+ account_id: account_id,
202
+ use_ticker: use_ticker,
203
+ )
204
+ p result
205
+ rescue SnapTrade::ApiError => e
206
+ puts "Exception when calling SnapTrade::Trading.get_user_account_quotes: #{e}"
207
+ end
208
+ ```
209
+
210
+ #### Using the get_user_account_quotes_with_http_info variant
211
+
212
+ This returns an Array which contains the response data, status code and headers.
213
+
214
+ ```ruby
215
+ user_id = "John.doe@snaptrade.com"
216
+ user_secret = "USERSECRET123"
217
+ symbols = "symbols_example"
218
+ account_id = "accountId_example"
219
+ use_ticker = True
220
+
221
+ begin
222
+ # Get symbol quotes
223
+ data, status_code, headers, response = SnapTrade::Trading.get_user_account_quotes_with_http_info(
224
+ user_id: user_id,
225
+ user_secret: user_secret,
226
+ symbols: symbols,
227
+ account_id: account_id,
228
+ use_ticker: use_ticker,
229
+ )
230
+ p status_code # => 2xx
231
+ p headers # => { ... }
232
+ p data # => Array<SymbolsQuotesInner>
233
+ rescue SnapTrade::ApiError => e
234
+ puts "Exception when calling SnapTrade::Trading.get_user_account_quotes: #{e}"
235
+ end
236
+ ```
237
+
238
+ ### Parameters
239
+
240
+ | Name | Type | Description | Notes |
241
+ | ---- | ---- | ----------- | ----- |
242
+ | **user_id** | **String** | | |
243
+ | **user_secret** | **String** | | |
244
+ | **symbols** | **String** | List of universal_symbol_id or tickers to get quotes for. | |
245
+ | **account_id** | **String** | The ID of the account to get quotes. | |
246
+ | **use_ticker** | **Boolean** | Should be set to True if providing tickers. | [optional] |
247
+
248
+ ### Return type
249
+
250
+ [**Array&lt;SymbolsQuotesInner&gt;**](SymbolsQuotesInner.md)
251
+
252
+ ## place_force_order
253
+
254
+ Place a trade with NO validation.
255
+
256
+ ### Example
257
+
258
+ ```ruby
259
+ require 'snaptrade'
260
+
261
261
  SnapTrade.client_id = "YOUR_CLIENT_ID"
262
- SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
263
-
264
- user_id = "John.doe@snaptrade.com"
265
- user_secret = "USERSECRET123"
266
- account_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
267
- action = "BUY"
268
- order_type = "Limit"
269
- price = 31.33
270
- stop = 31.33
271
- time_in_force = "Day"
272
- units = 3.14
273
- universal_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
274
-
275
- begin
276
- # Place a trade with NO validation.
277
- result = SnapTrade::Trading.place_force_order(
278
- user_id: user_id,
279
- user_secret: user_secret,
280
- account_id: account_id,
281
- action: action,
282
- order_type: order_type,
283
- price: price,
284
- stop: stop,
285
- time_in_force: time_in_force,
286
- units: units,
287
- universal_symbol_id: universal_symbol_id,
288
- )
289
- p result
290
- rescue SnapTrade::ApiError => e
291
- puts "Exception when calling SnapTrade::Trading.place_force_order: #{e}"
292
- end
293
- ```
294
-
295
- #### Using the place_force_order_with_http_info variant
296
-
297
- This returns an Array which contains the response data, status code and headers.
298
-
299
- ```ruby
300
- user_id = "John.doe@snaptrade.com"
301
- user_secret = "USERSECRET123"
302
- account_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
303
- action = "BUY"
304
- order_type = "Limit"
305
- price = 31.33
306
- stop = 31.33
307
- time_in_force = "Day"
308
- units = 3.14
309
- universal_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
310
-
311
- begin
312
- # Place a trade with NO validation.
313
- data, status_code, headers, response = SnapTrade::Trading.place_force_order_with_http_info(
314
- user_id: user_id,
315
- user_secret: user_secret,
316
- account_id: account_id,
317
- action: action,
318
- order_type: order_type,
319
- price: price,
320
- stop: stop,
321
- time_in_force: time_in_force,
322
- units: units,
323
- universal_symbol_id: universal_symbol_id,
324
- )
325
- p status_code # => 2xx
326
- p headers # => { ... }
327
- p data # => AccountOrderRecord
328
- rescue SnapTrade::ApiError => e
329
- puts "Exception when calling SnapTrade::Trading.place_force_order: #{e}"
330
- end
331
- ```
332
-
333
- ### Parameters
334
-
335
- | Name | Type | Description | Notes |
336
- | ---- | ---- | ----------- | ----- |
337
- | **user_id** | **String** | | |
338
- | **user_secret** | **String** | | |
339
- | **manual_trade_form** | [**ManualTradeForm**](ManualTradeForm.md) | | |
340
-
341
- ### Return type
342
-
343
- [**AccountOrderRecord**](AccountOrderRecord.md)
344
-
345
- ## place_oco_order
346
-
347
- Place a OCO (One Cancels Other) order
348
-
349
- ### Example
350
-
351
- ```ruby
352
- require 'snaptrade'
353
-
262
+ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
263
+
264
+ user_id = "John.doe@snaptrade.com"
265
+ user_secret = "USERSECRET123"
266
+ account_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
267
+ action = "BUY"
268
+ order_type = "Limit"
269
+ price = 31.33
270
+ stop = 31.33
271
+ time_in_force = "Day"
272
+ units = 3.14
273
+ universal_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
274
+
275
+ begin
276
+ # Place a trade with NO validation.
277
+ result = SnapTrade::Trading.place_force_order(
278
+ user_id: user_id,
279
+ user_secret: user_secret,
280
+ account_id: account_id,
281
+ action: action,
282
+ order_type: order_type,
283
+ price: price,
284
+ stop: stop,
285
+ time_in_force: time_in_force,
286
+ units: units,
287
+ universal_symbol_id: universal_symbol_id,
288
+ )
289
+ p result
290
+ rescue SnapTrade::ApiError => e
291
+ puts "Exception when calling SnapTrade::Trading.place_force_order: #{e}"
292
+ end
293
+ ```
294
+
295
+ #### Using the place_force_order_with_http_info variant
296
+
297
+ This returns an Array which contains the response data, status code and headers.
298
+
299
+ ```ruby
300
+ user_id = "John.doe@snaptrade.com"
301
+ user_secret = "USERSECRET123"
302
+ account_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
303
+ action = "BUY"
304
+ order_type = "Limit"
305
+ price = 31.33
306
+ stop = 31.33
307
+ time_in_force = "Day"
308
+ units = 3.14
309
+ universal_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
310
+
311
+ begin
312
+ # Place a trade with NO validation.
313
+ data, status_code, headers, response = SnapTrade::Trading.place_force_order_with_http_info(
314
+ user_id: user_id,
315
+ user_secret: user_secret,
316
+ account_id: account_id,
317
+ action: action,
318
+ order_type: order_type,
319
+ price: price,
320
+ stop: stop,
321
+ time_in_force: time_in_force,
322
+ units: units,
323
+ universal_symbol_id: universal_symbol_id,
324
+ )
325
+ p status_code # => 2xx
326
+ p headers # => { ... }
327
+ p data # => AccountOrderRecord
328
+ rescue SnapTrade::ApiError => e
329
+ puts "Exception when calling SnapTrade::Trading.place_force_order: #{e}"
330
+ end
331
+ ```
332
+
333
+ ### Parameters
334
+
335
+ | Name | Type | Description | Notes |
336
+ | ---- | ---- | ----------- | ----- |
337
+ | **user_id** | **String** | | |
338
+ | **user_secret** | **String** | | |
339
+ | **manual_trade_form** | [**ManualTradeForm**](ManualTradeForm.md) | | |
340
+
341
+ ### Return type
342
+
343
+ [**AccountOrderRecord**](AccountOrderRecord.md)
344
+
345
+ ## place_oco_order
346
+
347
+ Place a OCO (One Cancels Other) order
348
+
349
+ ### Example
350
+
351
+ ```ruby
352
+ require 'snaptrade'
353
+
354
354
  SnapTrade.client_id = "YOUR_CLIENT_ID"
355
- SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
356
-
357
- user_id = "John.doe@snaptrade.com"
358
- user_secret = "USERSECRET123"
359
- first_trade_id = None
360
- second_trade_id = None
361
-
362
- begin
363
- # Place a OCO (One Cancels Other) order
364
- result = SnapTrade::Trading.place_oco_order(
365
- user_id: user_id,
366
- user_secret: user_secret,
367
- first_trade_id: first_trade_id,
368
- second_trade_id: second_trade_id,
369
- )
370
- p result
371
- rescue SnapTrade::ApiError => e
372
- puts "Exception when calling SnapTrade::Trading.place_oco_order: #{e}"
373
- end
374
- ```
375
-
376
- #### Using the place_oco_order_with_http_info variant
377
-
378
- This returns an Array which contains the response data, status code and headers.
379
-
380
- ```ruby
381
- user_id = "John.doe@snaptrade.com"
382
- user_secret = "USERSECRET123"
383
- first_trade_id = None
384
- second_trade_id = None
385
-
386
- begin
387
- # Place a OCO (One Cancels Other) order
388
- data, status_code, headers, response = SnapTrade::Trading.place_oco_order_with_http_info(
389
- user_id: user_id,
390
- user_secret: user_secret,
391
- first_trade_id: first_trade_id,
392
- second_trade_id: second_trade_id,
393
- )
394
- p status_code # => 2xx
395
- p headers # => { ... }
396
- p data # => AccountOrderRecord
397
- rescue SnapTrade::ApiError => e
398
- puts "Exception when calling SnapTrade::Trading.place_oco_order: #{e}"
399
- end
400
- ```
401
-
402
- ### Parameters
403
-
404
- | Name | Type | Description | Notes |
405
- | ---- | ---- | ----------- | ----- |
406
- | **user_id** | **String** | | |
407
- | **user_secret** | **String** | | |
408
- | **trading_place_oco_order_request** | [**TradingPlaceOCOOrderRequest**](TradingPlaceOCOOrderRequest.md) | | |
409
-
410
- ### Return type
411
-
412
- [**AccountOrderRecord**](AccountOrderRecord.md)
413
-
414
- ## place_order
415
-
416
- Place order
417
-
418
- ### Example
419
-
420
- ```ruby
421
- require 'snaptrade'
422
-
355
+ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
356
+
357
+ user_id = "John.doe@snaptrade.com"
358
+ user_secret = "USERSECRET123"
359
+ first_trade_id = None
360
+ second_trade_id = None
361
+
362
+ begin
363
+ # Place a OCO (One Cancels Other) order
364
+ result = SnapTrade::Trading.place_oco_order(
365
+ user_id: user_id,
366
+ user_secret: user_secret,
367
+ first_trade_id: first_trade_id,
368
+ second_trade_id: second_trade_id,
369
+ )
370
+ p result
371
+ rescue SnapTrade::ApiError => e
372
+ puts "Exception when calling SnapTrade::Trading.place_oco_order: #{e}"
373
+ end
374
+ ```
375
+
376
+ #### Using the place_oco_order_with_http_info variant
377
+
378
+ This returns an Array which contains the response data, status code and headers.
379
+
380
+ ```ruby
381
+ user_id = "John.doe@snaptrade.com"
382
+ user_secret = "USERSECRET123"
383
+ first_trade_id = None
384
+ second_trade_id = None
385
+
386
+ begin
387
+ # Place a OCO (One Cancels Other) order
388
+ data, status_code, headers, response = SnapTrade::Trading.place_oco_order_with_http_info(
389
+ user_id: user_id,
390
+ user_secret: user_secret,
391
+ first_trade_id: first_trade_id,
392
+ second_trade_id: second_trade_id,
393
+ )
394
+ p status_code # => 2xx
395
+ p headers # => { ... }
396
+ p data # => AccountOrderRecord
397
+ rescue SnapTrade::ApiError => e
398
+ puts "Exception when calling SnapTrade::Trading.place_oco_order: #{e}"
399
+ end
400
+ ```
401
+
402
+ ### Parameters
403
+
404
+ | Name | Type | Description | Notes |
405
+ | ---- | ---- | ----------- | ----- |
406
+ | **user_id** | **String** | | |
407
+ | **user_secret** | **String** | | |
408
+ | **trading_place_oco_order_request** | [**TradingPlaceOCOOrderRequest**](TradingPlaceOCOOrderRequest.md) | | |
409
+
410
+ ### Return type
411
+
412
+ [**AccountOrderRecord**](AccountOrderRecord.md)
413
+
414
+ ## place_order
415
+
416
+ Place order
417
+
418
+ ### Example
419
+
420
+ ```ruby
421
+ require 'snaptrade'
422
+
423
423
  SnapTrade.client_id = "YOUR_CLIENT_ID"
424
- SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
425
-
426
- trade_id = "tradeId_example"
427
- user_id = "John.doe@snaptrade.com"
428
- user_secret = "USERSECRET123"
429
-
430
- begin
431
- # Place order
432
- result = SnapTrade::Trading.place_order(
433
- trade_id: trade_id,
434
- user_id: user_id,
435
- user_secret: user_secret,
436
- )
437
- p result
438
- rescue SnapTrade::ApiError => e
439
- puts "Exception when calling SnapTrade::Trading.place_order: #{e}"
440
- end
441
- ```
442
-
443
- #### Using the place_order_with_http_info variant
444
-
445
- This returns an Array which contains the response data, status code and headers.
446
-
447
- ```ruby
448
- trade_id = "tradeId_example"
449
- user_id = "John.doe@snaptrade.com"
450
- user_secret = "USERSECRET123"
451
-
452
- begin
453
- # Place order
454
- data, status_code, headers, response = SnapTrade::Trading.place_order_with_http_info(
455
- trade_id: trade_id,
456
- user_id: user_id,
457
- user_secret: user_secret,
458
- )
459
- p status_code # => 2xx
460
- p headers # => { ... }
461
- p data # => AccountOrderRecord
462
- rescue SnapTrade::ApiError => e
463
- puts "Exception when calling SnapTrade::Trading.place_order: #{e}"
464
- end
465
- ```
466
-
467
- ### Parameters
468
-
469
- | Name | Type | Description | Notes |
470
- | ---- | ---- | ----------- | ----- |
471
- | **trade_id** | **String** | The ID of trade object obtained from trade/impact endpoint | |
472
- | **user_id** | **String** | | |
473
- | **user_secret** | **String** | | |
474
-
475
- ### Return type
476
-
477
- [**AccountOrderRecord**](AccountOrderRecord.md)
478
-
424
+ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
425
+
426
+ trade_id = "tradeId_example"
427
+ user_id = "John.doe@snaptrade.com"
428
+ user_secret = "USERSECRET123"
429
+
430
+ begin
431
+ # Place order
432
+ result = SnapTrade::Trading.place_order(
433
+ trade_id: trade_id,
434
+ user_id: user_id,
435
+ user_secret: user_secret,
436
+ )
437
+ p result
438
+ rescue SnapTrade::ApiError => e
439
+ puts "Exception when calling SnapTrade::Trading.place_order: #{e}"
440
+ end
441
+ ```
442
+
443
+ #### Using the place_order_with_http_info variant
444
+
445
+ This returns an Array which contains the response data, status code and headers.
446
+
447
+ ```ruby
448
+ trade_id = "tradeId_example"
449
+ user_id = "John.doe@snaptrade.com"
450
+ user_secret = "USERSECRET123"
451
+
452
+ begin
453
+ # Place order
454
+ data, status_code, headers, response = SnapTrade::Trading.place_order_with_http_info(
455
+ trade_id: trade_id,
456
+ user_id: user_id,
457
+ user_secret: user_secret,
458
+ )
459
+ p status_code # => 2xx
460
+ p headers # => { ... }
461
+ p data # => AccountOrderRecord
462
+ rescue SnapTrade::ApiError => e
463
+ puts "Exception when calling SnapTrade::Trading.place_order: #{e}"
464
+ end
465
+ ```
466
+
467
+ ### Parameters
468
+
469
+ | Name | Type | Description | Notes |
470
+ | ---- | ---- | ----------- | ----- |
471
+ | **trade_id** | **String** | The ID of trade object obtained from trade/impact endpoint | |
472
+ | **user_id** | **String** | | |
473
+ | **user_secret** | **String** | | |
474
+
475
+ ### Return type
476
+
477
+ [**AccountOrderRecord**](AccountOrderRecord.md)
478
+