snaptrade 1.16.2 → 1.16.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile +10 -10
- data/Gemfile.lock +16 -8
- data/README.md +222 -221
- data/docs/APIStatusApi.md +57 -57
- data/docs/AccountInformationApi.md +535 -535
- data/docs/AuthenticationApi.md +314 -314
- data/docs/BrokerageSymbolOptionSymbol.md +7 -5
- data/docs/ConnectionsApi.md +265 -265
- data/docs/ErrorLogsApi.md +68 -68
- data/docs/MonthlyDividends.md +1 -1
- data/docs/NetContributions.md +1 -1
- data/docs/OptionType.md +15 -0
- data/docs/OptionsApi.md +378 -378
- data/docs/OptionsSymbol.md +7 -5
- data/docs/PastValue.md +1 -1
- data/docs/ReferenceDataApi.md +595 -595
- data/docs/SubPeriodReturnRate.md +2 -2
- data/docs/TradingApi.md +478 -478
- data/docs/TransactionsAndReportingApi.md +183 -183
- data/docs/TransactionsStatus.md +1 -1
- data/lib/snaptrade/api/account_information_api.rb +801 -801
- data/lib/snaptrade/api/api_status_api.rb +98 -98
- data/lib/snaptrade/api/authentication_api.rb +481 -481
- data/lib/snaptrade/api/connections_api.rb +398 -398
- data/lib/snaptrade/api/error_logs_api.rb +112 -112
- data/lib/snaptrade/api/options_api.rb +591 -591
- data/lib/snaptrade/api/reference_data_api.rb +894 -894
- data/lib/snaptrade/api/trading_api.rb +741 -741
- data/lib/snaptrade/api/transactions_and_reporting_api.rb +283 -283
- data/lib/snaptrade/api_client.rb +427 -427
- data/lib/snaptrade/api_client_custom.rb +32 -32
- data/lib/snaptrade/api_error.rb +6 -6
- data/lib/snaptrade/configuration.rb +341 -341
- data/lib/snaptrade/models/account.rb +6 -6
- data/lib/snaptrade/models/account_holdings.rb +6 -6
- data/lib/snaptrade/models/account_holdings_account.rb +6 -6
- data/lib/snaptrade/models/account_order_record.rb +6 -6
- data/lib/snaptrade/models/account_order_record_status.rb +6 -6
- data/lib/snaptrade/models/account_simple.rb +6 -6
- data/lib/snaptrade/models/account_sync_status.rb +6 -6
- data/lib/snaptrade/models/action.rb +6 -6
- data/lib/snaptrade/models/auth_type.rb +6 -6
- data/lib/snaptrade/models/authentication_login_snap_trade_user200_response.rb +6 -6
- data/lib/snaptrade/models/balance.rb +6 -6
- data/lib/snaptrade/models/brokerage.rb +6 -6
- data/lib/snaptrade/models/brokerage_authorization.rb +6 -6
- data/lib/snaptrade/models/brokerage_authorization_type.rb +6 -6
- data/lib/snaptrade/models/brokerage_authorization_type_read_only.rb +6 -6
- data/lib/snaptrade/models/brokerage_authorization_type_read_only_brokerage.rb +6 -6
- data/lib/snaptrade/models/brokerage_authorization_type_read_only_type.rb +6 -6
- data/lib/snaptrade/models/brokerage_authorization_type_type.rb +6 -6
- data/lib/snaptrade/models/brokerage_symbol.rb +6 -6
- data/lib/snaptrade/models/brokerage_symbol_option_symbol.rb +46 -7
- data/lib/snaptrade/models/brokerage_symbol_symbol.rb +6 -6
- data/lib/snaptrade/models/brokerage_type.rb +6 -6
- data/lib/snaptrade/models/calculated_trade.rb +6 -6
- data/lib/snaptrade/models/cash_restriction.rb +6 -6
- data/lib/snaptrade/models/connection_type.rb +6 -6
- data/lib/snaptrade/models/connections_session_events200_response_inner.rb +6 -6
- data/lib/snaptrade/models/currency.rb +6 -6
- data/lib/snaptrade/models/delete_user_response.rb +6 -6
- data/lib/snaptrade/models/dividend_at_date.rb +6 -6
- data/lib/snaptrade/models/encrypted_response.rb +6 -6
- data/lib/snaptrade/models/encrypted_response_encrypted_message_data.rb +6 -6
- data/lib/snaptrade/models/exchange.rb +6 -6
- data/lib/snaptrade/models/exchange_rate_pairs.rb +6 -6
- data/lib/snaptrade/models/excluded_asset.rb +6 -6
- data/lib/snaptrade/models/jwt.rb +6 -6
- data/lib/snaptrade/models/login_redirect_uri.rb +6 -6
- data/lib/snaptrade/models/manual_trade.rb +6 -6
- data/lib/snaptrade/models/manual_trade_and_impact.rb +6 -6
- data/lib/snaptrade/models/manual_trade_balance.rb +6 -6
- data/lib/snaptrade/models/manual_trade_form.rb +6 -6
- data/lib/snaptrade/models/manual_trade_symbol.rb +6 -6
- data/lib/snaptrade/models/model400_failed_request_response.rb +6 -6
- data/lib/snaptrade/models/model401_failed_request_response.rb +6 -6
- data/lib/snaptrade/models/model403_failed_request_response.rb +6 -6
- data/lib/snaptrade/models/model404_failed_request_response.rb +6 -6
- data/lib/snaptrade/models/model_asset_class.rb +6 -6
- data/lib/snaptrade/models/model_asset_class_details.rb +6 -6
- data/lib/snaptrade/models/model_asset_class_target.rb +6 -6
- data/lib/snaptrade/models/model_portfolio.rb +6 -6
- data/lib/snaptrade/models/model_portfolio_asset_class.rb +6 -6
- data/lib/snaptrade/models/model_portfolio_details.rb +6 -6
- data/lib/snaptrade/models/model_portfolio_security.rb +6 -6
- data/lib/snaptrade/models/model_type.rb +6 -6
- data/lib/snaptrade/models/monthly_dividends.rb +6 -6
- data/lib/snaptrade/models/net_contributions.rb +6 -6
- data/lib/snaptrade/models/net_dividend.rb +6 -6
- data/lib/snaptrade/models/option_chain_inner.rb +6 -6
- data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner.rb +6 -6
- data/lib/snaptrade/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner.rb +6 -6
- data/lib/snaptrade/models/option_leg.rb +6 -6
- data/lib/snaptrade/models/option_leg_action.rb +6 -6
- data/lib/snaptrade/models/option_strategy.rb +6 -6
- data/lib/snaptrade/models/option_strategy_legs_inner.rb +6 -6
- data/lib/snaptrade/models/option_type.rb +38 -0
- data/lib/snaptrade/models/options_get_option_strategy_request.rb +6 -6
- data/lib/snaptrade/models/options_holdings.rb +6 -6
- data/lib/snaptrade/models/options_place_option_strategy_request.rb +6 -6
- data/lib/snaptrade/models/options_position.rb +6 -6
- data/lib/snaptrade/models/options_position_currency.rb +6 -6
- data/lib/snaptrade/models/options_symbol.rb +46 -7
- data/lib/snaptrade/models/order_strategy_execute_body_order_type.rb +6 -6
- data/lib/snaptrade/models/order_strategy_execute_body_time_in_force.rb +6 -6
- data/lib/snaptrade/models/order_type.rb +6 -6
- data/lib/snaptrade/models/partner_data.rb +6 -6
- data/lib/snaptrade/models/past_value.rb +6 -6
- data/lib/snaptrade/models/performance_custom.rb +6 -6
- data/lib/snaptrade/models/portfolio_group.rb +6 -6
- data/lib/snaptrade/models/portfolio_group_info.rb +6 -6
- data/lib/snaptrade/models/portfolio_group_position.rb +6 -6
- data/lib/snaptrade/models/portfolio_group_settings.rb +6 -6
- data/lib/snaptrade/models/position.rb +6 -6
- data/lib/snaptrade/models/position_symbol.rb +6 -6
- data/lib/snaptrade/models/redirect_tokenand_pin.rb +6 -6
- data/lib/snaptrade/models/security_type.rb +6 -6
- data/lib/snaptrade/models/session_event.rb +6 -6
- data/lib/snaptrade/models/session_event_type.rb +6 -6
- data/lib/snaptrade/models/snap_trade_api_disclaimer_accept_status.rb +6 -6
- data/lib/snaptrade/models/snap_trade_holdings_account.rb +6 -6
- data/lib/snaptrade/models/snap_trade_holdings_account_account_id.rb +6 -6
- data/lib/snaptrade/models/snap_trade_holdings_total_value.rb +6 -6
- data/lib/snaptrade/models/snap_trade_login_user_request_body.rb +6 -6
- data/lib/snaptrade/models/snap_trade_register_user_request_body.rb +6 -6
- data/lib/snaptrade/models/state.rb +6 -6
- data/lib/snaptrade/models/status.rb +6 -6
- data/lib/snaptrade/models/strategy_impact.rb +6 -6
- data/lib/snaptrade/models/strategy_impact_legs_inner.rb +6 -6
- data/lib/snaptrade/models/strategy_order_place.rb +6 -6
- data/lib/snaptrade/models/strategy_order_place_orders_inner.rb +6 -6
- data/lib/snaptrade/models/strategy_order_place_orders_inner_legs_inner.rb +6 -6
- data/lib/snaptrade/models/strategy_order_record.rb +6 -6
- data/lib/snaptrade/models/strategy_order_record_order_type.rb +6 -6
- data/lib/snaptrade/models/strategy_order_record_status.rb +6 -6
- data/lib/snaptrade/models/strategy_order_record_time_in_force.rb +6 -6
- data/lib/snaptrade/models/strategy_quotes.rb +6 -6
- data/lib/snaptrade/models/strategy_quotes_greek.rb +6 -6
- data/lib/snaptrade/models/strategy_type.rb +6 -6
- data/lib/snaptrade/models/sub_period_return_rate.rb +6 -6
- data/lib/snaptrade/models/symbol.rb +6 -6
- data/lib/snaptrade/models/symbol_query.rb +6 -6
- data/lib/snaptrade/models/symbols_quotes_inner.rb +6 -6
- data/lib/snaptrade/models/target_asset.rb +6 -6
- data/lib/snaptrade/models/time_in_force.rb +6 -6
- data/lib/snaptrade/models/trade.rb +6 -6
- data/lib/snaptrade/models/trade_action.rb +6 -6
- data/lib/snaptrade/models/trade_execution_status.rb +6 -6
- data/lib/snaptrade/models/trade_execution_status_action.rb +6 -6
- data/lib/snaptrade/models/trade_impact.rb +6 -6
- data/lib/snaptrade/models/trading_cancel_user_account_order_request.rb +6 -6
- data/lib/snaptrade/models/trading_place_oco_order_request.rb +6 -6
- data/lib/snaptrade/models/transactions_status.rb +6 -6
- data/lib/snaptrade/models/type.rb +6 -6
- data/lib/snaptrade/models/underlying_symbol.rb +6 -6
- data/lib/snaptrade/models/universal_activity.rb +6 -6
- data/lib/snaptrade/models/universal_symbol.rb +6 -6
- data/lib/snaptrade/models/universal_symbol_ticker.rb +6 -6
- data/lib/snaptrade/models/us_exchange.rb +6 -6
- data/lib/snaptrade/models/user_error_log.rb +6 -6
- data/lib/snaptrade/models/user_i_dand_secret.rb +6 -6
- data/lib/snaptrade/models/user_settings.rb +6 -6
- data/lib/snaptrade/version.rb +7 -7
- data/lib/snaptrade.rb +215 -214
- data/snaptrade.gemspec +41 -41
- data/spec/api/account_information_api_spec.rb +135 -135
- data/spec/api/api_status_api_spec.rb +42 -42
- data/spec/api/authentication_api_spec.rb +88 -88
- data/spec/api/connections_api_spec.rb +82 -82
- data/spec/api/error_logs_api_spec.rb +43 -43
- data/spec/api/options_api_spec.rb +101 -101
- data/spec/api/reference_data_api_spec.rb +150 -150
- data/spec/api/trading_api_spec.rb +112 -112
- data/spec/api/transactions_and_reporting_api_spec.rb +67 -67
- data/spec/api_client_spec.rb +193 -193
- data/spec/configuration_spec.rb +6 -6
- data/spec/getting_started_spec.rb +114 -114
- data/spec/models/account_holdings_account_spec.rb +54 -54
- data/spec/models/account_holdings_spec.rb +48 -48
- data/spec/models/account_order_record_spec.rb +132 -132
- data/spec/models/account_order_record_status_spec.rb +24 -24
- data/spec/models/account_simple_spec.rb +48 -48
- data/spec/models/account_spec.rb +84 -84
- data/spec/models/account_sync_status_spec.rb +30 -30
- data/spec/models/action_spec.rb +24 -24
- data/spec/models/auth_type_spec.rb +24 -24
- data/spec/models/authentication_login_snap_trade_user200_response_spec.rb +27 -27
- data/spec/models/balance_spec.rb +36 -36
- data/spec/models/brokerage_authorization_spec.rb +78 -78
- data/spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb +42 -42
- data/spec/models/brokerage_authorization_type_read_only_spec.rb +48 -48
- data/spec/models/brokerage_authorization_type_read_only_type_spec.rb +24 -24
- data/spec/models/brokerage_authorization_type_spec.rb +30 -30
- data/spec/models/brokerage_authorization_type_type_spec.rb +24 -24
- data/spec/models/brokerage_spec.rb +132 -132
- data/spec/models/brokerage_symbol_option_symbol_spec.rb +78 -72
- data/spec/models/brokerage_symbol_spec.rb +60 -60
- data/spec/models/brokerage_symbol_symbol_spec.rb +72 -72
- data/spec/models/brokerage_type_spec.rb +36 -36
- data/spec/models/calculated_trade_spec.rb +36 -36
- data/spec/models/cash_restriction_spec.rb +54 -54
- data/spec/models/connection_type_spec.rb +24 -24
- data/spec/models/connections_session_events200_response_inner_spec.rb +66 -66
- data/spec/models/currency_spec.rb +42 -42
- data/spec/models/delete_user_response_spec.rb +36 -36
- data/spec/models/dividend_at_date_spec.rb +42 -42
- data/spec/models/encrypted_response_encrypted_message_data_spec.rb +42 -42
- data/spec/models/encrypted_response_spec.rb +36 -36
- data/spec/models/exchange_rate_pairs_spec.rb +42 -42
- data/spec/models/exchange_spec.rb +72 -72
- data/spec/models/excluded_asset_spec.rb +30 -30
- data/spec/models/jwt_spec.rb +30 -30
- data/spec/models/login_redirect_uri_spec.rb +36 -36
- data/spec/models/manual_trade_and_impact_spec.rb +42 -42
- data/spec/models/manual_trade_balance_spec.rb +42 -42
- data/spec/models/manual_trade_form_spec.rb +72 -72
- data/spec/models/manual_trade_spec.rb +72 -72
- data/spec/models/manual_trade_symbol_spec.rb +60 -60
- data/spec/models/model400_failed_request_response_spec.rb +36 -36
- data/spec/models/model401_failed_request_response_spec.rb +36 -36
- data/spec/models/model403_failed_request_response_spec.rb +36 -36
- data/spec/models/model404_failed_request_response_spec.rb +36 -36
- data/spec/models/model_asset_class_details_spec.rb +36 -36
- data/spec/models/model_asset_class_spec.rb +36 -36
- data/spec/models/model_asset_class_target_spec.rb +30 -30
- data/spec/models/model_portfolio_asset_class_spec.rb +36 -36
- data/spec/models/model_portfolio_details_spec.rb +42 -42
- data/spec/models/model_portfolio_security_spec.rb +36 -36
- data/spec/models/model_portfolio_spec.rb +42 -42
- data/spec/models/model_type_spec.rb +24 -24
- data/spec/models/monthly_dividends_spec.rb +36 -36
- data/spec/models/net_contributions_spec.rb +42 -42
- data/spec/models/net_dividend_spec.rb +42 -42
- data/spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb +42 -42
- data/spec/models/option_chain_inner_chain_per_root_inner_spec.rb +42 -42
- data/spec/models/option_chain_inner_spec.rb +54 -54
- data/spec/models/option_leg_action_spec.rb +24 -24
- data/spec/models/option_leg_spec.rb +42 -42
- data/spec/models/option_strategy_legs_inner_spec.rb +48 -48
- data/spec/models/option_strategy_spec.rb +54 -54
- data/spec/models/option_type_spec.rb +24 -0
- data/spec/models/options_get_option_strategy_request_spec.rb +42 -42
- data/spec/models/options_holdings_spec.rb +60 -60
- data/spec/models/options_place_option_strategy_request_spec.rb +42 -42
- data/spec/models/options_position_currency_spec.rb +42 -42
- data/spec/models/options_position_spec.rb +66 -66
- data/spec/models/options_symbol_spec.rb +78 -72
- data/spec/models/order_strategy_execute_body_order_type_spec.rb +24 -24
- data/spec/models/order_strategy_execute_body_time_in_force_spec.rb +24 -24
- data/spec/models/order_type_spec.rb +24 -24
- data/spec/models/partner_data_spec.rb +96 -96
- data/spec/models/past_value_spec.rb +42 -42
- data/spec/models/performance_custom_spec.rb +138 -138
- data/spec/models/portfolio_group_info_spec.rb +90 -90
- data/spec/models/portfolio_group_position_spec.rb +42 -42
- data/spec/models/portfolio_group_settings_spec.rb +54 -54
- data/spec/models/portfolio_group_spec.rb +36 -36
- data/spec/models/position_spec.rb +60 -60
- data/spec/models/position_symbol_spec.rb +60 -60
- data/spec/models/redirect_tokenand_pin_spec.rb +36 -36
- data/spec/models/security_type_spec.rb +48 -48
- data/spec/models/session_event_spec.rb +66 -66
- data/spec/models/session_event_type_spec.rb +24 -24
- data/spec/models/snap_trade_api_disclaimer_accept_status_spec.rb +36 -36
- data/spec/models/snap_trade_holdings_account_account_id_spec.rb +78 -78
- data/spec/models/snap_trade_holdings_account_spec.rb +72 -72
- data/spec/models/snap_trade_holdings_total_value_spec.rb +36 -36
- data/spec/models/snap_trade_login_user_request_body_spec.rb +54 -54
- data/spec/models/snap_trade_register_user_request_body_spec.rb +36 -36
- data/spec/models/state_spec.rb +24 -24
- data/spec/models/status_spec.rb +42 -42
- data/spec/models/strategy_impact_legs_inner_spec.rb +66 -66
- data/spec/models/strategy_impact_spec.rb +90 -90
- data/spec/models/strategy_order_place_orders_inner_legs_inner_spec.rb +66 -66
- data/spec/models/strategy_order_place_orders_inner_spec.rb +282 -282
- data/spec/models/strategy_order_place_spec.rb +36 -36
- data/spec/models/strategy_order_record_order_type_spec.rb +24 -24
- data/spec/models/strategy_order_record_spec.rb +90 -90
- data/spec/models/strategy_order_record_status_spec.rb +24 -24
- data/spec/models/strategy_order_record_time_in_force_spec.rb +24 -24
- data/spec/models/strategy_quotes_greek_spec.rb +54 -54
- data/spec/models/strategy_quotes_spec.rb +60 -60
- data/spec/models/strategy_type_spec.rb +24 -24
- data/spec/models/sub_period_return_rate_spec.rb +42 -42
- data/spec/models/symbol_query_spec.rb +30 -30
- data/spec/models/symbol_spec.rb +66 -66
- data/spec/models/symbols_quotes_inner_spec.rb +60 -60
- data/spec/models/target_asset_spec.rb +60 -60
- data/spec/models/time_in_force_spec.rb +24 -24
- data/spec/models/trade_action_spec.rb +24 -24
- data/spec/models/trade_execution_status_action_spec.rb +24 -24
- data/spec/models/trade_execution_status_spec.rb +78 -78
- data/spec/models/trade_impact_spec.rb +54 -54
- data/spec/models/trade_spec.rb +72 -72
- data/spec/models/trading_cancel_user_account_order_request_spec.rb +30 -30
- data/spec/models/trading_place_oco_order_request_spec.rb +36 -36
- data/spec/models/transactions_status_spec.rb +36 -36
- data/spec/models/type_spec.rb +24 -24
- data/spec/models/underlying_symbol_spec.rb +66 -66
- data/spec/models/universal_activity_spec.rb +126 -126
- data/spec/models/universal_symbol_spec.rb +72 -72
- data/spec/models/universal_symbol_ticker_spec.rb +72 -72
- data/spec/models/us_exchange_spec.rb +78 -78
- data/spec/models/user_error_log_spec.rb +60 -60
- data/spec/models/user_i_dand_secret_spec.rb +36 -36
- data/spec/models/user_settings_spec.rb +84 -84
- data/spec/spec_helper.rb +6 -6
- metadata +119 -115
|
@@ -1,535 +1,535 @@
|
|
|
1
|
-
# SnapTrade::AccountInformationApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *https://api.snaptrade.com/api/v1*
|
|
4
|
-
|
|
5
|
-
| Method | HTTP request | Description |
|
|
6
|
-
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**get_all_user_holdings**](AccountInformationApi.md#get_all_user_holdings) | **GET** /holdings | List all accounts for the user, plus balances, positions, and orders for each account. |
|
|
8
|
-
| [**get_user_account_balance**](AccountInformationApi.md#get_user_account_balance) | **GET** /accounts/{accountId}/balances | List account balances |
|
|
9
|
-
| [**get_user_account_details**](AccountInformationApi.md#get_user_account_details) | **GET** /accounts/{accountId} | Return details of a specific investment account |
|
|
10
|
-
| [**get_user_account_orders**](AccountInformationApi.md#get_user_account_orders) | **GET** /accounts/{accountId}/orders | Get history of orders placed in account |
|
|
11
|
-
| [**get_user_account_positions**](AccountInformationApi.md#get_user_account_positions) | **GET** /accounts/{accountId}/positions | List account positions |
|
|
12
|
-
| [**get_user_holdings**](AccountInformationApi.md#get_user_holdings) | **GET** /accounts/{accountId}/holdings | List balances, positions and orders for the specified account. |
|
|
13
|
-
| [**list_user_accounts**](AccountInformationApi.md#list_user_accounts) | **GET** /accounts | List accounts |
|
|
14
|
-
| [**update_user_account**](AccountInformationApi.md#update_user_account) | **PUT** /accounts/{accountId} | Update details of an investment account |
|
|
15
|
-
|
|
16
|
-
## get_all_user_holdings
|
|
17
|
-
|
|
18
|
-
List all accounts for the user, plus balances, positions, and orders for each account.
|
|
19
|
-
|
|
20
|
-
### Example
|
|
21
|
-
|
|
22
|
-
```ruby
|
|
23
|
-
require 'snaptrade'
|
|
24
|
-
|
|
25
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
26
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
27
|
-
|
|
28
|
-
user_id = "John.doe@snaptrade.com"
|
|
29
|
-
user_secret = "USERSECRET123"
|
|
30
|
-
brokerage_authorizations = "917c8734-8470-4a3e-a18f-57c3f2ee6631"
|
|
31
|
-
|
|
32
|
-
begin
|
|
33
|
-
# List all accounts for the user, plus balances, positions, and orders for each account.
|
|
34
|
-
result = SnapTrade::AccountInformation.get_all_user_holdings(
|
|
35
|
-
user_id: user_id,
|
|
36
|
-
user_secret: user_secret,
|
|
37
|
-
brokerage_authorizations: brokerage_authorizations,
|
|
38
|
-
)
|
|
39
|
-
p result
|
|
40
|
-
rescue SnapTrade::ApiError => e
|
|
41
|
-
puts "Exception when calling SnapTrade::AccountInformation.get_all_user_holdings: #{e}"
|
|
42
|
-
end
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
#### Using the get_all_user_holdings_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
|
-
brokerage_authorizations = "917c8734-8470-4a3e-a18f-57c3f2ee6631"
|
|
53
|
-
|
|
54
|
-
begin
|
|
55
|
-
# List all accounts for the user, plus balances, positions, and orders for each account.
|
|
56
|
-
data, status_code, headers, response = SnapTrade::AccountInformation.get_all_user_holdings_with_http_info(
|
|
57
|
-
user_id: user_id,
|
|
58
|
-
user_secret: user_secret,
|
|
59
|
-
brokerage_authorizations: brokerage_authorizations,
|
|
60
|
-
)
|
|
61
|
-
p status_code # => 2xx
|
|
62
|
-
p headers # => { ... }
|
|
63
|
-
p data # => Array<AccountHoldings>
|
|
64
|
-
rescue SnapTrade::ApiError => e
|
|
65
|
-
puts "Exception when calling SnapTrade::AccountInformation.get_all_user_holdings: #{e}"
|
|
66
|
-
end
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
### Parameters
|
|
70
|
-
|
|
71
|
-
| Name | Type | Description | Notes |
|
|
72
|
-
| ---- | ---- | ----------- | ----- |
|
|
73
|
-
| **user_id** | **String** | | |
|
|
74
|
-
| **user_secret** | **String** | | |
|
|
75
|
-
| **brokerage_authorizations** | **String** | Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations). | [optional] |
|
|
76
|
-
|
|
77
|
-
### Return type
|
|
78
|
-
|
|
79
|
-
[**Array<AccountHoldings>**](AccountHoldings.md)
|
|
80
|
-
|
|
81
|
-
## get_user_account_balance
|
|
82
|
-
|
|
83
|
-
List account balances
|
|
84
|
-
|
|
85
|
-
### Example
|
|
86
|
-
|
|
87
|
-
```ruby
|
|
88
|
-
require 'snaptrade'
|
|
89
|
-
|
|
90
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
91
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
92
|
-
|
|
93
|
-
user_id = "John.doe@snaptrade.com"
|
|
94
|
-
user_secret = "USERSECRET123"
|
|
95
|
-
account_id = "accountId_example"
|
|
96
|
-
|
|
97
|
-
begin
|
|
98
|
-
# List account balances
|
|
99
|
-
result = SnapTrade::AccountInformation.get_user_account_balance(
|
|
100
|
-
user_id: user_id,
|
|
101
|
-
user_secret: user_secret,
|
|
102
|
-
account_id: account_id,
|
|
103
|
-
)
|
|
104
|
-
p result
|
|
105
|
-
rescue SnapTrade::ApiError => e
|
|
106
|
-
puts "Exception when calling SnapTrade::AccountInformation.get_user_account_balance: #{e}"
|
|
107
|
-
end
|
|
108
|
-
```
|
|
109
|
-
|
|
110
|
-
#### Using the get_user_account_balance_with_http_info variant
|
|
111
|
-
|
|
112
|
-
This returns an Array which contains the response data, status code and headers.
|
|
113
|
-
|
|
114
|
-
```ruby
|
|
115
|
-
user_id = "John.doe@snaptrade.com"
|
|
116
|
-
user_secret = "USERSECRET123"
|
|
117
|
-
account_id = "accountId_example"
|
|
118
|
-
|
|
119
|
-
begin
|
|
120
|
-
# List account balances
|
|
121
|
-
data, status_code, headers, response = SnapTrade::AccountInformation.get_user_account_balance_with_http_info(
|
|
122
|
-
user_id: user_id,
|
|
123
|
-
user_secret: user_secret,
|
|
124
|
-
account_id: account_id,
|
|
125
|
-
)
|
|
126
|
-
p status_code # => 2xx
|
|
127
|
-
p headers # => { ... }
|
|
128
|
-
p data # => Array<Balance>
|
|
129
|
-
rescue SnapTrade::ApiError => e
|
|
130
|
-
puts "Exception when calling SnapTrade::AccountInformation.get_user_account_balance: #{e}"
|
|
131
|
-
end
|
|
132
|
-
```
|
|
133
|
-
|
|
134
|
-
### Parameters
|
|
135
|
-
|
|
136
|
-
| Name | Type | Description | Notes |
|
|
137
|
-
| ---- | ---- | ----------- | ----- |
|
|
138
|
-
| **user_id** | **String** | | |
|
|
139
|
-
| **user_secret** | **String** | | |
|
|
140
|
-
| **account_id** | **String** | The ID of the account get positions. | |
|
|
141
|
-
|
|
142
|
-
### Return type
|
|
143
|
-
|
|
144
|
-
[**Array<Balance>**](Balance.md)
|
|
145
|
-
|
|
146
|
-
## get_user_account_details
|
|
147
|
-
|
|
148
|
-
Return details of a specific investment account
|
|
149
|
-
|
|
150
|
-
### Example
|
|
151
|
-
|
|
152
|
-
```ruby
|
|
153
|
-
require 'snaptrade'
|
|
154
|
-
|
|
155
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
156
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
157
|
-
|
|
158
|
-
user_id = "John.doe@snaptrade.com"
|
|
159
|
-
user_secret = "USERSECRET123"
|
|
160
|
-
account_id = "accountId_example"
|
|
161
|
-
|
|
162
|
-
begin
|
|
163
|
-
# Return details of a specific investment account
|
|
164
|
-
result = SnapTrade::AccountInformation.get_user_account_details(
|
|
165
|
-
user_id: user_id,
|
|
166
|
-
user_secret: user_secret,
|
|
167
|
-
account_id: account_id,
|
|
168
|
-
)
|
|
169
|
-
p result
|
|
170
|
-
rescue SnapTrade::ApiError => e
|
|
171
|
-
puts "Exception when calling SnapTrade::AccountInformation.get_user_account_details: #{e}"
|
|
172
|
-
end
|
|
173
|
-
```
|
|
174
|
-
|
|
175
|
-
#### Using the get_user_account_details_with_http_info variant
|
|
176
|
-
|
|
177
|
-
This returns an Array which contains the response data, status code and headers.
|
|
178
|
-
|
|
179
|
-
```ruby
|
|
180
|
-
user_id = "John.doe@snaptrade.com"
|
|
181
|
-
user_secret = "USERSECRET123"
|
|
182
|
-
account_id = "accountId_example"
|
|
183
|
-
|
|
184
|
-
begin
|
|
185
|
-
# Return details of a specific investment account
|
|
186
|
-
data, status_code, headers, response = SnapTrade::AccountInformation.get_user_account_details_with_http_info(
|
|
187
|
-
user_id: user_id,
|
|
188
|
-
user_secret: user_secret,
|
|
189
|
-
account_id: account_id,
|
|
190
|
-
)
|
|
191
|
-
p status_code # => 2xx
|
|
192
|
-
p headers # => { ... }
|
|
193
|
-
p data # => Account
|
|
194
|
-
rescue SnapTrade::ApiError => e
|
|
195
|
-
puts "Exception when calling SnapTrade::AccountInformation.get_user_account_details: #{e}"
|
|
196
|
-
end
|
|
197
|
-
```
|
|
198
|
-
|
|
199
|
-
### Parameters
|
|
200
|
-
|
|
201
|
-
| Name | Type | Description | Notes |
|
|
202
|
-
| ---- | ---- | ----------- | ----- |
|
|
203
|
-
| **user_id** | **String** | | |
|
|
204
|
-
| **user_secret** | **String** | | |
|
|
205
|
-
| **account_id** | **String** | The ID of the account to get detail of. | |
|
|
206
|
-
|
|
207
|
-
### Return type
|
|
208
|
-
|
|
209
|
-
[**Account**](Account.md)
|
|
210
|
-
|
|
211
|
-
## get_user_account_orders
|
|
212
|
-
|
|
213
|
-
Get history of orders placed in account
|
|
214
|
-
|
|
215
|
-
### Example
|
|
216
|
-
|
|
217
|
-
```ruby
|
|
218
|
-
require 'snaptrade'
|
|
219
|
-
|
|
220
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
221
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
222
|
-
|
|
223
|
-
user_id = "John.doe@snaptrade.com"
|
|
224
|
-
user_secret = "USERSECRET123"
|
|
225
|
-
account_id = "accountId_example"
|
|
226
|
-
state = "all"
|
|
227
|
-
|
|
228
|
-
begin
|
|
229
|
-
# Get history of orders placed in account
|
|
230
|
-
result = SnapTrade::AccountInformation.get_user_account_orders(
|
|
231
|
-
user_id: user_id,
|
|
232
|
-
user_secret: user_secret,
|
|
233
|
-
account_id: account_id,
|
|
234
|
-
state: state,
|
|
235
|
-
)
|
|
236
|
-
p result
|
|
237
|
-
rescue SnapTrade::ApiError => e
|
|
238
|
-
puts "Exception when calling SnapTrade::AccountInformation.get_user_account_orders: #{e}"
|
|
239
|
-
end
|
|
240
|
-
```
|
|
241
|
-
|
|
242
|
-
#### Using the get_user_account_orders_with_http_info variant
|
|
243
|
-
|
|
244
|
-
This returns an Array which contains the response data, status code and headers.
|
|
245
|
-
|
|
246
|
-
```ruby
|
|
247
|
-
user_id = "John.doe@snaptrade.com"
|
|
248
|
-
user_secret = "USERSECRET123"
|
|
249
|
-
account_id = "accountId_example"
|
|
250
|
-
state = "all"
|
|
251
|
-
|
|
252
|
-
begin
|
|
253
|
-
# Get history of orders placed in account
|
|
254
|
-
data, status_code, headers, response = SnapTrade::AccountInformation.get_user_account_orders_with_http_info(
|
|
255
|
-
user_id: user_id,
|
|
256
|
-
user_secret: user_secret,
|
|
257
|
-
account_id: account_id,
|
|
258
|
-
state: state,
|
|
259
|
-
)
|
|
260
|
-
p status_code # => 2xx
|
|
261
|
-
p headers # => { ... }
|
|
262
|
-
p data # => Array<AccountOrderRecord>
|
|
263
|
-
rescue SnapTrade::ApiError => e
|
|
264
|
-
puts "Exception when calling SnapTrade::AccountInformation.get_user_account_orders: #{e}"
|
|
265
|
-
end
|
|
266
|
-
```
|
|
267
|
-
|
|
268
|
-
### Parameters
|
|
269
|
-
|
|
270
|
-
| Name | Type | Description | Notes |
|
|
271
|
-
| ---- | ---- | ----------- | ----- |
|
|
272
|
-
| **user_id** | **String** | | |
|
|
273
|
-
| **user_secret** | **String** | | |
|
|
274
|
-
| **account_id** | **String** | The ID of the account get positions. | |
|
|
275
|
-
| **state** | **String** | defaults value is set to \"all\" | [optional] |
|
|
276
|
-
|
|
277
|
-
### Return type
|
|
278
|
-
|
|
279
|
-
[**Array<AccountOrderRecord>**](AccountOrderRecord.md)
|
|
280
|
-
|
|
281
|
-
## get_user_account_positions
|
|
282
|
-
|
|
283
|
-
List account positions
|
|
284
|
-
|
|
285
|
-
### Example
|
|
286
|
-
|
|
287
|
-
```ruby
|
|
288
|
-
require 'snaptrade'
|
|
289
|
-
|
|
290
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
291
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
292
|
-
|
|
293
|
-
user_id = "John.doe@snaptrade.com"
|
|
294
|
-
user_secret = "USERSECRET123"
|
|
295
|
-
account_id = "accountId_example"
|
|
296
|
-
|
|
297
|
-
begin
|
|
298
|
-
# List account positions
|
|
299
|
-
result = SnapTrade::AccountInformation.get_user_account_positions(
|
|
300
|
-
user_id: user_id,
|
|
301
|
-
user_secret: user_secret,
|
|
302
|
-
account_id: account_id,
|
|
303
|
-
)
|
|
304
|
-
p result
|
|
305
|
-
rescue SnapTrade::ApiError => e
|
|
306
|
-
puts "Exception when calling SnapTrade::AccountInformation.get_user_account_positions: #{e}"
|
|
307
|
-
end
|
|
308
|
-
```
|
|
309
|
-
|
|
310
|
-
#### Using the get_user_account_positions_with_http_info variant
|
|
311
|
-
|
|
312
|
-
This returns an Array which contains the response data, status code and headers.
|
|
313
|
-
|
|
314
|
-
```ruby
|
|
315
|
-
user_id = "John.doe@snaptrade.com"
|
|
316
|
-
user_secret = "USERSECRET123"
|
|
317
|
-
account_id = "accountId_example"
|
|
318
|
-
|
|
319
|
-
begin
|
|
320
|
-
# List account positions
|
|
321
|
-
data, status_code, headers, response = SnapTrade::AccountInformation.get_user_account_positions_with_http_info(
|
|
322
|
-
user_id: user_id,
|
|
323
|
-
user_secret: user_secret,
|
|
324
|
-
account_id: account_id,
|
|
325
|
-
)
|
|
326
|
-
p status_code # => 2xx
|
|
327
|
-
p headers # => { ... }
|
|
328
|
-
p data # => Array<Position>
|
|
329
|
-
rescue SnapTrade::ApiError => e
|
|
330
|
-
puts "Exception when calling SnapTrade::AccountInformation.get_user_account_positions: #{e}"
|
|
331
|
-
end
|
|
332
|
-
```
|
|
333
|
-
|
|
334
|
-
### Parameters
|
|
335
|
-
|
|
336
|
-
| Name | Type | Description | Notes |
|
|
337
|
-
| ---- | ---- | ----------- | ----- |
|
|
338
|
-
| **user_id** | **String** | | |
|
|
339
|
-
| **user_secret** | **String** | | |
|
|
340
|
-
| **account_id** | **String** | The ID of the account get positions. | |
|
|
341
|
-
|
|
342
|
-
### Return type
|
|
343
|
-
|
|
344
|
-
[**Array<Position>**](Position.md)
|
|
345
|
-
|
|
346
|
-
## get_user_holdings
|
|
347
|
-
|
|
348
|
-
List balances, positions and orders for the specified account.
|
|
349
|
-
|
|
350
|
-
### Example
|
|
351
|
-
|
|
352
|
-
```ruby
|
|
353
|
-
require 'snaptrade'
|
|
354
|
-
|
|
355
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
356
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
357
|
-
|
|
358
|
-
account_id = "917c8734-8470-4a3e-a18f-57c3f2ee6631"
|
|
359
|
-
user_id = "John.doe@snaptrade.com"
|
|
360
|
-
user_secret = "USERSECRET123"
|
|
361
|
-
|
|
362
|
-
begin
|
|
363
|
-
# List balances, positions and orders for the specified account.
|
|
364
|
-
result = SnapTrade::AccountInformation.get_user_holdings(
|
|
365
|
-
account_id: account_id,
|
|
366
|
-
user_id: user_id,
|
|
367
|
-
user_secret: user_secret,
|
|
368
|
-
)
|
|
369
|
-
p result
|
|
370
|
-
rescue SnapTrade::ApiError => e
|
|
371
|
-
puts "Exception when calling SnapTrade::AccountInformation.get_user_holdings: #{e}"
|
|
372
|
-
end
|
|
373
|
-
```
|
|
374
|
-
|
|
375
|
-
#### Using the get_user_holdings_with_http_info variant
|
|
376
|
-
|
|
377
|
-
This returns an Array which contains the response data, status code and headers.
|
|
378
|
-
|
|
379
|
-
```ruby
|
|
380
|
-
account_id = "917c8734-8470-4a3e-a18f-57c3f2ee6631"
|
|
381
|
-
user_id = "John.doe@snaptrade.com"
|
|
382
|
-
user_secret = "USERSECRET123"
|
|
383
|
-
|
|
384
|
-
begin
|
|
385
|
-
# List balances, positions and orders for the specified account.
|
|
386
|
-
data, status_code, headers, response = SnapTrade::AccountInformation.get_user_holdings_with_http_info(
|
|
387
|
-
account_id: account_id,
|
|
388
|
-
user_id: user_id,
|
|
389
|
-
user_secret: user_secret,
|
|
390
|
-
)
|
|
391
|
-
p status_code # => 2xx
|
|
392
|
-
p headers # => { ... }
|
|
393
|
-
p data # => AccountHoldingsAccount
|
|
394
|
-
rescue SnapTrade::ApiError => e
|
|
395
|
-
puts "Exception when calling SnapTrade::AccountInformation.get_user_holdings: #{e}"
|
|
396
|
-
end
|
|
397
|
-
```
|
|
398
|
-
|
|
399
|
-
### Parameters
|
|
400
|
-
|
|
401
|
-
| Name | Type | Description | Notes |
|
|
402
|
-
| ---- | ---- | ----------- | ----- |
|
|
403
|
-
| **account_id** | **String** | The ID of the account to fetch holdings for. | |
|
|
404
|
-
| **user_id** | **String** | | |
|
|
405
|
-
| **user_secret** | **String** | | |
|
|
406
|
-
|
|
407
|
-
### Return type
|
|
408
|
-
|
|
409
|
-
[**AccountHoldingsAccount**](AccountHoldingsAccount.md)
|
|
410
|
-
|
|
411
|
-
## list_user_accounts
|
|
412
|
-
|
|
413
|
-
List accounts
|
|
414
|
-
|
|
415
|
-
### Example
|
|
416
|
-
|
|
417
|
-
```ruby
|
|
418
|
-
require 'snaptrade'
|
|
419
|
-
|
|
420
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
421
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
422
|
-
|
|
423
|
-
user_id = "John.doe@snaptrade.com"
|
|
424
|
-
user_secret = "USERSECRET123"
|
|
425
|
-
|
|
426
|
-
begin
|
|
427
|
-
# List accounts
|
|
428
|
-
result = SnapTrade::AccountInformation.list_user_accounts(
|
|
429
|
-
user_id: user_id,
|
|
430
|
-
user_secret: user_secret,
|
|
431
|
-
)
|
|
432
|
-
p result
|
|
433
|
-
rescue SnapTrade::ApiError => e
|
|
434
|
-
puts "Exception when calling SnapTrade::AccountInformation.list_user_accounts: #{e}"
|
|
435
|
-
end
|
|
436
|
-
```
|
|
437
|
-
|
|
438
|
-
#### Using the list_user_accounts_with_http_info variant
|
|
439
|
-
|
|
440
|
-
This returns an Array which contains the response data, status code and headers.
|
|
441
|
-
|
|
442
|
-
```ruby
|
|
443
|
-
user_id = "John.doe@snaptrade.com"
|
|
444
|
-
user_secret = "USERSECRET123"
|
|
445
|
-
|
|
446
|
-
begin
|
|
447
|
-
# List accounts
|
|
448
|
-
data, status_code, headers, response = SnapTrade::AccountInformation.list_user_accounts_with_http_info(
|
|
449
|
-
user_id: user_id,
|
|
450
|
-
user_secret: user_secret,
|
|
451
|
-
)
|
|
452
|
-
p status_code # => 2xx
|
|
453
|
-
p headers # => { ... }
|
|
454
|
-
p data # => Array<Account>
|
|
455
|
-
rescue SnapTrade::ApiError => e
|
|
456
|
-
puts "Exception when calling SnapTrade::AccountInformation.list_user_accounts: #{e}"
|
|
457
|
-
end
|
|
458
|
-
```
|
|
459
|
-
|
|
460
|
-
### Parameters
|
|
461
|
-
|
|
462
|
-
| Name | Type | Description | Notes |
|
|
463
|
-
| ---- | ---- | ----------- | ----- |
|
|
464
|
-
| **user_id** | **String** | | |
|
|
465
|
-
| **user_secret** | **String** | | |
|
|
466
|
-
|
|
467
|
-
### Return type
|
|
468
|
-
|
|
469
|
-
[**Array<Account>**](Account.md)
|
|
470
|
-
|
|
471
|
-
## update_user_account
|
|
472
|
-
|
|
473
|
-
Update details of an investment account
|
|
474
|
-
|
|
475
|
-
### Example
|
|
476
|
-
|
|
477
|
-
```ruby
|
|
478
|
-
require 'snaptrade'
|
|
479
|
-
|
|
480
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
481
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
482
|
-
|
|
483
|
-
user_id = "John.doe@snaptrade.com"
|
|
484
|
-
user_secret = "USERSECRET123"
|
|
485
|
-
account_id = "accountId_example"
|
|
486
|
-
|
|
487
|
-
begin
|
|
488
|
-
# Update details of an investment account
|
|
489
|
-
result = SnapTrade::AccountInformation.update_user_account(
|
|
490
|
-
user_id: user_id,
|
|
491
|
-
user_secret: user_secret,
|
|
492
|
-
account_id: account_id,
|
|
493
|
-
)
|
|
494
|
-
p result
|
|
495
|
-
rescue SnapTrade::ApiError => e
|
|
496
|
-
puts "Exception when calling SnapTrade::AccountInformation.update_user_account: #{e}"
|
|
497
|
-
end
|
|
498
|
-
```
|
|
499
|
-
|
|
500
|
-
#### Using the update_user_account_with_http_info variant
|
|
501
|
-
|
|
502
|
-
This returns an Array which contains the response data, status code and headers.
|
|
503
|
-
|
|
504
|
-
```ruby
|
|
505
|
-
user_id = "John.doe@snaptrade.com"
|
|
506
|
-
user_secret = "USERSECRET123"
|
|
507
|
-
account_id = "accountId_example"
|
|
508
|
-
|
|
509
|
-
begin
|
|
510
|
-
# Update details of an investment account
|
|
511
|
-
data, status_code, headers, response = SnapTrade::AccountInformation.update_user_account_with_http_info(
|
|
512
|
-
user_id: user_id,
|
|
513
|
-
user_secret: user_secret,
|
|
514
|
-
account_id: account_id,
|
|
515
|
-
)
|
|
516
|
-
p status_code # => 2xx
|
|
517
|
-
p headers # => { ... }
|
|
518
|
-
p data # => Array<Account>
|
|
519
|
-
rescue SnapTrade::ApiError => e
|
|
520
|
-
puts "Exception when calling SnapTrade::AccountInformation.update_user_account: #{e}"
|
|
521
|
-
end
|
|
522
|
-
```
|
|
523
|
-
|
|
524
|
-
### Parameters
|
|
525
|
-
|
|
526
|
-
| Name | Type | Description | Notes |
|
|
527
|
-
| ---- | ---- | ----------- | ----- |
|
|
528
|
-
| **user_id** | **String** | | |
|
|
529
|
-
| **user_secret** | **String** | | |
|
|
530
|
-
| **account_id** | **String** | The ID of the account to update. | |
|
|
531
|
-
|
|
532
|
-
### Return type
|
|
533
|
-
|
|
534
|
-
[**Array<Account>**](Account.md)
|
|
535
|
-
|
|
1
|
+
# SnapTrade::AccountInformationApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.snaptrade.com/api/v1*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**get_all_user_holdings**](AccountInformationApi.md#get_all_user_holdings) | **GET** /holdings | List all accounts for the user, plus balances, positions, and orders for each account. |
|
|
8
|
+
| [**get_user_account_balance**](AccountInformationApi.md#get_user_account_balance) | **GET** /accounts/{accountId}/balances | List account balances |
|
|
9
|
+
| [**get_user_account_details**](AccountInformationApi.md#get_user_account_details) | **GET** /accounts/{accountId} | Return details of a specific investment account |
|
|
10
|
+
| [**get_user_account_orders**](AccountInformationApi.md#get_user_account_orders) | **GET** /accounts/{accountId}/orders | Get history of orders placed in account |
|
|
11
|
+
| [**get_user_account_positions**](AccountInformationApi.md#get_user_account_positions) | **GET** /accounts/{accountId}/positions | List account positions |
|
|
12
|
+
| [**get_user_holdings**](AccountInformationApi.md#get_user_holdings) | **GET** /accounts/{accountId}/holdings | List balances, positions and orders for the specified account. |
|
|
13
|
+
| [**list_user_accounts**](AccountInformationApi.md#list_user_accounts) | **GET** /accounts | List accounts |
|
|
14
|
+
| [**update_user_account**](AccountInformationApi.md#update_user_account) | **PUT** /accounts/{accountId} | Update details of an investment account |
|
|
15
|
+
|
|
16
|
+
## get_all_user_holdings
|
|
17
|
+
|
|
18
|
+
List all accounts for the user, plus balances, positions, and orders for each account.
|
|
19
|
+
|
|
20
|
+
### Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'snaptrade'
|
|
24
|
+
|
|
25
|
+
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
26
|
+
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
27
|
+
|
|
28
|
+
user_id = "John.doe@snaptrade.com"
|
|
29
|
+
user_secret = "USERSECRET123"
|
|
30
|
+
brokerage_authorizations = "917c8734-8470-4a3e-a18f-57c3f2ee6631"
|
|
31
|
+
|
|
32
|
+
begin
|
|
33
|
+
# List all accounts for the user, plus balances, positions, and orders for each account.
|
|
34
|
+
result = SnapTrade::AccountInformation.get_all_user_holdings(
|
|
35
|
+
user_id: user_id,
|
|
36
|
+
user_secret: user_secret,
|
|
37
|
+
brokerage_authorizations: brokerage_authorizations,
|
|
38
|
+
)
|
|
39
|
+
p result
|
|
40
|
+
rescue SnapTrade::ApiError => e
|
|
41
|
+
puts "Exception when calling SnapTrade::AccountInformation.get_all_user_holdings: #{e}"
|
|
42
|
+
end
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
#### Using the get_all_user_holdings_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
|
+
brokerage_authorizations = "917c8734-8470-4a3e-a18f-57c3f2ee6631"
|
|
53
|
+
|
|
54
|
+
begin
|
|
55
|
+
# List all accounts for the user, plus balances, positions, and orders for each account.
|
|
56
|
+
data, status_code, headers, response = SnapTrade::AccountInformation.get_all_user_holdings_with_http_info(
|
|
57
|
+
user_id: user_id,
|
|
58
|
+
user_secret: user_secret,
|
|
59
|
+
brokerage_authorizations: brokerage_authorizations,
|
|
60
|
+
)
|
|
61
|
+
p status_code # => 2xx
|
|
62
|
+
p headers # => { ... }
|
|
63
|
+
p data # => Array<AccountHoldings>
|
|
64
|
+
rescue SnapTrade::ApiError => e
|
|
65
|
+
puts "Exception when calling SnapTrade::AccountInformation.get_all_user_holdings: #{e}"
|
|
66
|
+
end
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Parameters
|
|
70
|
+
|
|
71
|
+
| Name | Type | Description | Notes |
|
|
72
|
+
| ---- | ---- | ----------- | ----- |
|
|
73
|
+
| **user_id** | **String** | | |
|
|
74
|
+
| **user_secret** | **String** | | |
|
|
75
|
+
| **brokerage_authorizations** | **String** | Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations). | [optional] |
|
|
76
|
+
|
|
77
|
+
### Return type
|
|
78
|
+
|
|
79
|
+
[**Array<AccountHoldings>**](AccountHoldings.md)
|
|
80
|
+
|
|
81
|
+
## get_user_account_balance
|
|
82
|
+
|
|
83
|
+
List account balances
|
|
84
|
+
|
|
85
|
+
### Example
|
|
86
|
+
|
|
87
|
+
```ruby
|
|
88
|
+
require 'snaptrade'
|
|
89
|
+
|
|
90
|
+
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
91
|
+
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
92
|
+
|
|
93
|
+
user_id = "John.doe@snaptrade.com"
|
|
94
|
+
user_secret = "USERSECRET123"
|
|
95
|
+
account_id = "accountId_example"
|
|
96
|
+
|
|
97
|
+
begin
|
|
98
|
+
# List account balances
|
|
99
|
+
result = SnapTrade::AccountInformation.get_user_account_balance(
|
|
100
|
+
user_id: user_id,
|
|
101
|
+
user_secret: user_secret,
|
|
102
|
+
account_id: account_id,
|
|
103
|
+
)
|
|
104
|
+
p result
|
|
105
|
+
rescue SnapTrade::ApiError => e
|
|
106
|
+
puts "Exception when calling SnapTrade::AccountInformation.get_user_account_balance: #{e}"
|
|
107
|
+
end
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
#### Using the get_user_account_balance_with_http_info variant
|
|
111
|
+
|
|
112
|
+
This returns an Array which contains the response data, status code and headers.
|
|
113
|
+
|
|
114
|
+
```ruby
|
|
115
|
+
user_id = "John.doe@snaptrade.com"
|
|
116
|
+
user_secret = "USERSECRET123"
|
|
117
|
+
account_id = "accountId_example"
|
|
118
|
+
|
|
119
|
+
begin
|
|
120
|
+
# List account balances
|
|
121
|
+
data, status_code, headers, response = SnapTrade::AccountInformation.get_user_account_balance_with_http_info(
|
|
122
|
+
user_id: user_id,
|
|
123
|
+
user_secret: user_secret,
|
|
124
|
+
account_id: account_id,
|
|
125
|
+
)
|
|
126
|
+
p status_code # => 2xx
|
|
127
|
+
p headers # => { ... }
|
|
128
|
+
p data # => Array<Balance>
|
|
129
|
+
rescue SnapTrade::ApiError => e
|
|
130
|
+
puts "Exception when calling SnapTrade::AccountInformation.get_user_account_balance: #{e}"
|
|
131
|
+
end
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
### Parameters
|
|
135
|
+
|
|
136
|
+
| Name | Type | Description | Notes |
|
|
137
|
+
| ---- | ---- | ----------- | ----- |
|
|
138
|
+
| **user_id** | **String** | | |
|
|
139
|
+
| **user_secret** | **String** | | |
|
|
140
|
+
| **account_id** | **String** | The ID of the account get positions. | |
|
|
141
|
+
|
|
142
|
+
### Return type
|
|
143
|
+
|
|
144
|
+
[**Array<Balance>**](Balance.md)
|
|
145
|
+
|
|
146
|
+
## get_user_account_details
|
|
147
|
+
|
|
148
|
+
Return details of a specific investment account
|
|
149
|
+
|
|
150
|
+
### Example
|
|
151
|
+
|
|
152
|
+
```ruby
|
|
153
|
+
require 'snaptrade'
|
|
154
|
+
|
|
155
|
+
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
156
|
+
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
157
|
+
|
|
158
|
+
user_id = "John.doe@snaptrade.com"
|
|
159
|
+
user_secret = "USERSECRET123"
|
|
160
|
+
account_id = "accountId_example"
|
|
161
|
+
|
|
162
|
+
begin
|
|
163
|
+
# Return details of a specific investment account
|
|
164
|
+
result = SnapTrade::AccountInformation.get_user_account_details(
|
|
165
|
+
user_id: user_id,
|
|
166
|
+
user_secret: user_secret,
|
|
167
|
+
account_id: account_id,
|
|
168
|
+
)
|
|
169
|
+
p result
|
|
170
|
+
rescue SnapTrade::ApiError => e
|
|
171
|
+
puts "Exception when calling SnapTrade::AccountInformation.get_user_account_details: #{e}"
|
|
172
|
+
end
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
#### Using the get_user_account_details_with_http_info variant
|
|
176
|
+
|
|
177
|
+
This returns an Array which contains the response data, status code and headers.
|
|
178
|
+
|
|
179
|
+
```ruby
|
|
180
|
+
user_id = "John.doe@snaptrade.com"
|
|
181
|
+
user_secret = "USERSECRET123"
|
|
182
|
+
account_id = "accountId_example"
|
|
183
|
+
|
|
184
|
+
begin
|
|
185
|
+
# Return details of a specific investment account
|
|
186
|
+
data, status_code, headers, response = SnapTrade::AccountInformation.get_user_account_details_with_http_info(
|
|
187
|
+
user_id: user_id,
|
|
188
|
+
user_secret: user_secret,
|
|
189
|
+
account_id: account_id,
|
|
190
|
+
)
|
|
191
|
+
p status_code # => 2xx
|
|
192
|
+
p headers # => { ... }
|
|
193
|
+
p data # => Account
|
|
194
|
+
rescue SnapTrade::ApiError => e
|
|
195
|
+
puts "Exception when calling SnapTrade::AccountInformation.get_user_account_details: #{e}"
|
|
196
|
+
end
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
### Parameters
|
|
200
|
+
|
|
201
|
+
| Name | Type | Description | Notes |
|
|
202
|
+
| ---- | ---- | ----------- | ----- |
|
|
203
|
+
| **user_id** | **String** | | |
|
|
204
|
+
| **user_secret** | **String** | | |
|
|
205
|
+
| **account_id** | **String** | The ID of the account to get detail of. | |
|
|
206
|
+
|
|
207
|
+
### Return type
|
|
208
|
+
|
|
209
|
+
[**Account**](Account.md)
|
|
210
|
+
|
|
211
|
+
## get_user_account_orders
|
|
212
|
+
|
|
213
|
+
Get history of orders placed in account
|
|
214
|
+
|
|
215
|
+
### Example
|
|
216
|
+
|
|
217
|
+
```ruby
|
|
218
|
+
require 'snaptrade'
|
|
219
|
+
|
|
220
|
+
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
221
|
+
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
222
|
+
|
|
223
|
+
user_id = "John.doe@snaptrade.com"
|
|
224
|
+
user_secret = "USERSECRET123"
|
|
225
|
+
account_id = "accountId_example"
|
|
226
|
+
state = "all"
|
|
227
|
+
|
|
228
|
+
begin
|
|
229
|
+
# Get history of orders placed in account
|
|
230
|
+
result = SnapTrade::AccountInformation.get_user_account_orders(
|
|
231
|
+
user_id: user_id,
|
|
232
|
+
user_secret: user_secret,
|
|
233
|
+
account_id: account_id,
|
|
234
|
+
state: state,
|
|
235
|
+
)
|
|
236
|
+
p result
|
|
237
|
+
rescue SnapTrade::ApiError => e
|
|
238
|
+
puts "Exception when calling SnapTrade::AccountInformation.get_user_account_orders: #{e}"
|
|
239
|
+
end
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
#### Using the get_user_account_orders_with_http_info variant
|
|
243
|
+
|
|
244
|
+
This returns an Array which contains the response data, status code and headers.
|
|
245
|
+
|
|
246
|
+
```ruby
|
|
247
|
+
user_id = "John.doe@snaptrade.com"
|
|
248
|
+
user_secret = "USERSECRET123"
|
|
249
|
+
account_id = "accountId_example"
|
|
250
|
+
state = "all"
|
|
251
|
+
|
|
252
|
+
begin
|
|
253
|
+
# Get history of orders placed in account
|
|
254
|
+
data, status_code, headers, response = SnapTrade::AccountInformation.get_user_account_orders_with_http_info(
|
|
255
|
+
user_id: user_id,
|
|
256
|
+
user_secret: user_secret,
|
|
257
|
+
account_id: account_id,
|
|
258
|
+
state: state,
|
|
259
|
+
)
|
|
260
|
+
p status_code # => 2xx
|
|
261
|
+
p headers # => { ... }
|
|
262
|
+
p data # => Array<AccountOrderRecord>
|
|
263
|
+
rescue SnapTrade::ApiError => e
|
|
264
|
+
puts "Exception when calling SnapTrade::AccountInformation.get_user_account_orders: #{e}"
|
|
265
|
+
end
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
### Parameters
|
|
269
|
+
|
|
270
|
+
| Name | Type | Description | Notes |
|
|
271
|
+
| ---- | ---- | ----------- | ----- |
|
|
272
|
+
| **user_id** | **String** | | |
|
|
273
|
+
| **user_secret** | **String** | | |
|
|
274
|
+
| **account_id** | **String** | The ID of the account get positions. | |
|
|
275
|
+
| **state** | **String** | defaults value is set to \"all\" | [optional] |
|
|
276
|
+
|
|
277
|
+
### Return type
|
|
278
|
+
|
|
279
|
+
[**Array<AccountOrderRecord>**](AccountOrderRecord.md)
|
|
280
|
+
|
|
281
|
+
## get_user_account_positions
|
|
282
|
+
|
|
283
|
+
List account positions
|
|
284
|
+
|
|
285
|
+
### Example
|
|
286
|
+
|
|
287
|
+
```ruby
|
|
288
|
+
require 'snaptrade'
|
|
289
|
+
|
|
290
|
+
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
291
|
+
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
292
|
+
|
|
293
|
+
user_id = "John.doe@snaptrade.com"
|
|
294
|
+
user_secret = "USERSECRET123"
|
|
295
|
+
account_id = "accountId_example"
|
|
296
|
+
|
|
297
|
+
begin
|
|
298
|
+
# List account positions
|
|
299
|
+
result = SnapTrade::AccountInformation.get_user_account_positions(
|
|
300
|
+
user_id: user_id,
|
|
301
|
+
user_secret: user_secret,
|
|
302
|
+
account_id: account_id,
|
|
303
|
+
)
|
|
304
|
+
p result
|
|
305
|
+
rescue SnapTrade::ApiError => e
|
|
306
|
+
puts "Exception when calling SnapTrade::AccountInformation.get_user_account_positions: #{e}"
|
|
307
|
+
end
|
|
308
|
+
```
|
|
309
|
+
|
|
310
|
+
#### Using the get_user_account_positions_with_http_info variant
|
|
311
|
+
|
|
312
|
+
This returns an Array which contains the response data, status code and headers.
|
|
313
|
+
|
|
314
|
+
```ruby
|
|
315
|
+
user_id = "John.doe@snaptrade.com"
|
|
316
|
+
user_secret = "USERSECRET123"
|
|
317
|
+
account_id = "accountId_example"
|
|
318
|
+
|
|
319
|
+
begin
|
|
320
|
+
# List account positions
|
|
321
|
+
data, status_code, headers, response = SnapTrade::AccountInformation.get_user_account_positions_with_http_info(
|
|
322
|
+
user_id: user_id,
|
|
323
|
+
user_secret: user_secret,
|
|
324
|
+
account_id: account_id,
|
|
325
|
+
)
|
|
326
|
+
p status_code # => 2xx
|
|
327
|
+
p headers # => { ... }
|
|
328
|
+
p data # => Array<Position>
|
|
329
|
+
rescue SnapTrade::ApiError => e
|
|
330
|
+
puts "Exception when calling SnapTrade::AccountInformation.get_user_account_positions: #{e}"
|
|
331
|
+
end
|
|
332
|
+
```
|
|
333
|
+
|
|
334
|
+
### Parameters
|
|
335
|
+
|
|
336
|
+
| Name | Type | Description | Notes |
|
|
337
|
+
| ---- | ---- | ----------- | ----- |
|
|
338
|
+
| **user_id** | **String** | | |
|
|
339
|
+
| **user_secret** | **String** | | |
|
|
340
|
+
| **account_id** | **String** | The ID of the account get positions. | |
|
|
341
|
+
|
|
342
|
+
### Return type
|
|
343
|
+
|
|
344
|
+
[**Array<Position>**](Position.md)
|
|
345
|
+
|
|
346
|
+
## get_user_holdings
|
|
347
|
+
|
|
348
|
+
List balances, positions and orders for the specified account.
|
|
349
|
+
|
|
350
|
+
### Example
|
|
351
|
+
|
|
352
|
+
```ruby
|
|
353
|
+
require 'snaptrade'
|
|
354
|
+
|
|
355
|
+
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
356
|
+
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
357
|
+
|
|
358
|
+
account_id = "917c8734-8470-4a3e-a18f-57c3f2ee6631"
|
|
359
|
+
user_id = "John.doe@snaptrade.com"
|
|
360
|
+
user_secret = "USERSECRET123"
|
|
361
|
+
|
|
362
|
+
begin
|
|
363
|
+
# List balances, positions and orders for the specified account.
|
|
364
|
+
result = SnapTrade::AccountInformation.get_user_holdings(
|
|
365
|
+
account_id: account_id,
|
|
366
|
+
user_id: user_id,
|
|
367
|
+
user_secret: user_secret,
|
|
368
|
+
)
|
|
369
|
+
p result
|
|
370
|
+
rescue SnapTrade::ApiError => e
|
|
371
|
+
puts "Exception when calling SnapTrade::AccountInformation.get_user_holdings: #{e}"
|
|
372
|
+
end
|
|
373
|
+
```
|
|
374
|
+
|
|
375
|
+
#### Using the get_user_holdings_with_http_info variant
|
|
376
|
+
|
|
377
|
+
This returns an Array which contains the response data, status code and headers.
|
|
378
|
+
|
|
379
|
+
```ruby
|
|
380
|
+
account_id = "917c8734-8470-4a3e-a18f-57c3f2ee6631"
|
|
381
|
+
user_id = "John.doe@snaptrade.com"
|
|
382
|
+
user_secret = "USERSECRET123"
|
|
383
|
+
|
|
384
|
+
begin
|
|
385
|
+
# List balances, positions and orders for the specified account.
|
|
386
|
+
data, status_code, headers, response = SnapTrade::AccountInformation.get_user_holdings_with_http_info(
|
|
387
|
+
account_id: account_id,
|
|
388
|
+
user_id: user_id,
|
|
389
|
+
user_secret: user_secret,
|
|
390
|
+
)
|
|
391
|
+
p status_code # => 2xx
|
|
392
|
+
p headers # => { ... }
|
|
393
|
+
p data # => AccountHoldingsAccount
|
|
394
|
+
rescue SnapTrade::ApiError => e
|
|
395
|
+
puts "Exception when calling SnapTrade::AccountInformation.get_user_holdings: #{e}"
|
|
396
|
+
end
|
|
397
|
+
```
|
|
398
|
+
|
|
399
|
+
### Parameters
|
|
400
|
+
|
|
401
|
+
| Name | Type | Description | Notes |
|
|
402
|
+
| ---- | ---- | ----------- | ----- |
|
|
403
|
+
| **account_id** | **String** | The ID of the account to fetch holdings for. | |
|
|
404
|
+
| **user_id** | **String** | | |
|
|
405
|
+
| **user_secret** | **String** | | |
|
|
406
|
+
|
|
407
|
+
### Return type
|
|
408
|
+
|
|
409
|
+
[**AccountHoldingsAccount**](AccountHoldingsAccount.md)
|
|
410
|
+
|
|
411
|
+
## list_user_accounts
|
|
412
|
+
|
|
413
|
+
List accounts
|
|
414
|
+
|
|
415
|
+
### Example
|
|
416
|
+
|
|
417
|
+
```ruby
|
|
418
|
+
require 'snaptrade'
|
|
419
|
+
|
|
420
|
+
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
421
|
+
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
422
|
+
|
|
423
|
+
user_id = "John.doe@snaptrade.com"
|
|
424
|
+
user_secret = "USERSECRET123"
|
|
425
|
+
|
|
426
|
+
begin
|
|
427
|
+
# List accounts
|
|
428
|
+
result = SnapTrade::AccountInformation.list_user_accounts(
|
|
429
|
+
user_id: user_id,
|
|
430
|
+
user_secret: user_secret,
|
|
431
|
+
)
|
|
432
|
+
p result
|
|
433
|
+
rescue SnapTrade::ApiError => e
|
|
434
|
+
puts "Exception when calling SnapTrade::AccountInformation.list_user_accounts: #{e}"
|
|
435
|
+
end
|
|
436
|
+
```
|
|
437
|
+
|
|
438
|
+
#### Using the list_user_accounts_with_http_info variant
|
|
439
|
+
|
|
440
|
+
This returns an Array which contains the response data, status code and headers.
|
|
441
|
+
|
|
442
|
+
```ruby
|
|
443
|
+
user_id = "John.doe@snaptrade.com"
|
|
444
|
+
user_secret = "USERSECRET123"
|
|
445
|
+
|
|
446
|
+
begin
|
|
447
|
+
# List accounts
|
|
448
|
+
data, status_code, headers, response = SnapTrade::AccountInformation.list_user_accounts_with_http_info(
|
|
449
|
+
user_id: user_id,
|
|
450
|
+
user_secret: user_secret,
|
|
451
|
+
)
|
|
452
|
+
p status_code # => 2xx
|
|
453
|
+
p headers # => { ... }
|
|
454
|
+
p data # => Array<Account>
|
|
455
|
+
rescue SnapTrade::ApiError => e
|
|
456
|
+
puts "Exception when calling SnapTrade::AccountInformation.list_user_accounts: #{e}"
|
|
457
|
+
end
|
|
458
|
+
```
|
|
459
|
+
|
|
460
|
+
### Parameters
|
|
461
|
+
|
|
462
|
+
| Name | Type | Description | Notes |
|
|
463
|
+
| ---- | ---- | ----------- | ----- |
|
|
464
|
+
| **user_id** | **String** | | |
|
|
465
|
+
| **user_secret** | **String** | | |
|
|
466
|
+
|
|
467
|
+
### Return type
|
|
468
|
+
|
|
469
|
+
[**Array<Account>**](Account.md)
|
|
470
|
+
|
|
471
|
+
## update_user_account
|
|
472
|
+
|
|
473
|
+
Update details of an investment account
|
|
474
|
+
|
|
475
|
+
### Example
|
|
476
|
+
|
|
477
|
+
```ruby
|
|
478
|
+
require 'snaptrade'
|
|
479
|
+
|
|
480
|
+
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
481
|
+
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
482
|
+
|
|
483
|
+
user_id = "John.doe@snaptrade.com"
|
|
484
|
+
user_secret = "USERSECRET123"
|
|
485
|
+
account_id = "accountId_example"
|
|
486
|
+
|
|
487
|
+
begin
|
|
488
|
+
# Update details of an investment account
|
|
489
|
+
result = SnapTrade::AccountInformation.update_user_account(
|
|
490
|
+
user_id: user_id,
|
|
491
|
+
user_secret: user_secret,
|
|
492
|
+
account_id: account_id,
|
|
493
|
+
)
|
|
494
|
+
p result
|
|
495
|
+
rescue SnapTrade::ApiError => e
|
|
496
|
+
puts "Exception when calling SnapTrade::AccountInformation.update_user_account: #{e}"
|
|
497
|
+
end
|
|
498
|
+
```
|
|
499
|
+
|
|
500
|
+
#### Using the update_user_account_with_http_info variant
|
|
501
|
+
|
|
502
|
+
This returns an Array which contains the response data, status code and headers.
|
|
503
|
+
|
|
504
|
+
```ruby
|
|
505
|
+
user_id = "John.doe@snaptrade.com"
|
|
506
|
+
user_secret = "USERSECRET123"
|
|
507
|
+
account_id = "accountId_example"
|
|
508
|
+
|
|
509
|
+
begin
|
|
510
|
+
# Update details of an investment account
|
|
511
|
+
data, status_code, headers, response = SnapTrade::AccountInformation.update_user_account_with_http_info(
|
|
512
|
+
user_id: user_id,
|
|
513
|
+
user_secret: user_secret,
|
|
514
|
+
account_id: account_id,
|
|
515
|
+
)
|
|
516
|
+
p status_code # => 2xx
|
|
517
|
+
p headers # => { ... }
|
|
518
|
+
p data # => Array<Account>
|
|
519
|
+
rescue SnapTrade::ApiError => e
|
|
520
|
+
puts "Exception when calling SnapTrade::AccountInformation.update_user_account: #{e}"
|
|
521
|
+
end
|
|
522
|
+
```
|
|
523
|
+
|
|
524
|
+
### Parameters
|
|
525
|
+
|
|
526
|
+
| Name | Type | Description | Notes |
|
|
527
|
+
| ---- | ---- | ----------- | ----- |
|
|
528
|
+
| **user_id** | **String** | | |
|
|
529
|
+
| **user_secret** | **String** | | |
|
|
530
|
+
| **account_id** | **String** | The ID of the account to update. | |
|
|
531
|
+
|
|
532
|
+
### Return type
|
|
533
|
+
|
|
534
|
+
[**Array<Account>**](Account.md)
|
|
535
|
+
|