snaptrade 1.7.0 → 1.12.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1769673c853617ca0e94a2acc4eaadaba1831a2971f291b80c576ca7e5464dd2
4
- data.tar.gz: 5c5c775a28a00d28f89f8b20f6dc7461827295858ac259e5e27858a47b25c4d2
3
+ metadata.gz: 2d35c598e43136c15bacb0ae8e7735a22e8cba4b7e3b116c375494c7738a332b
4
+ data.tar.gz: fa5c5fdc708d4947d2ac92461ba8623397bcd81d4b8a7156f6b2d740d74c617c
5
5
  SHA512:
6
- metadata.gz: 868307b18a77b533051cb5cbeeb70b3e2e0d2d91459c975b676460472afc834fc12c52f352a0c56d86b8dd1609042a6dcba8a40107db387ba23ce03a3907b4d0
7
- data.tar.gz: 9463a53e1b49cd98e299eb699c2ed6e223f2e3ab79deca8cf8ccd5f370fdb042f2d5e0252d55ed96c643784272311216e2a887da8be0fce92558f97cc4749fcd
6
+ metadata.gz: 4860f8b325a55ae350ba4e1f9e5d219aad96232d521ac1ee73f5b9f147012be15997e0fea884e326817856ed7d8e1f63b6f74216c87626c9196054f89193499a
7
+ data.tar.gz: c9860eefbdf60793799dbe23e26ae9e7026a0a3823849d44e04f5b021fd3cdc2e9d602b68fb50078c2ecadf15d9d8cd900f5dc148036075c6ec89c189aba02ff
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- snaptrade (1.7.0)
4
+ snaptrade (1.12.0)
5
5
  faraday (>= 1.0.1, < 3.0)
6
6
  faraday-multipart (~> 1.0, >= 1.0.4)
7
7
 
@@ -15,7 +15,7 @@ GEM
15
15
  irb (>= 1.5.0)
16
16
  reline (>= 0.3.1)
17
17
  diff-lcs (1.5.0)
18
- faraday (2.7.7)
18
+ faraday (2.7.10)
19
19
  faraday-net_http (>= 2.0, < 3.1)
20
20
  ruby2_keywords (>= 0.0.4)
21
21
  faraday-multipart (1.0.4)
data/README.md CHANGED
@@ -9,7 +9,7 @@ For more information, please visit [https://snaptrade.com/](https://snaptrade.co
9
9
  Add to Gemfile:
10
10
 
11
11
  ```ruby
12
- gem 'snaptrade', '~> 1.7.0'
12
+ gem 'snaptrade', '~> 1.12.0'
13
13
  ```
14
14
 
15
15
  ## Getting Started
@@ -25,7 +25,7 @@ user_secret = "USERSECRET123"
25
25
  brokerage_authorizations = "917c8734-8470-4a3e-a18f-57c3f2ee6631"
26
26
 
27
27
  begin
28
- # List all accounts for the user, plus balances and positions for each account.
28
+ # List all accounts for the user, plus balances, positions, and orders for each account.
29
29
  result = SnapTrade::AccountInformation.get_all_user_holdings(
30
30
  user_id: user_id,
31
31
  user_secret: user_secret,
@@ -43,20 +43,20 @@ All URIs are relative to *https://api.snaptrade.com/api/v1*
43
43
 
44
44
  Class | Method | HTTP request | Description
45
45
  ------------ | ------------- | ------------- | -------------
46
- *SnapTrade::AccountInformationApi* | [**get_all_user_holdings**](docs/AccountInformationApi.md#get_all_user_holdings) | **GET** /holdings | List all accounts for the user, plus balances and positions for each account.
47
- *SnapTrade::AccountInformationApi* | [**get_user_account_balance**](docs/AccountInformationApi.md#get_user_account_balance) | **GET** /accounts/{accountId}/balances | Get all cash balances of an investment account
46
+ *SnapTrade::AccountInformationApi* | [**get_all_user_holdings**](docs/AccountInformationApi.md#get_all_user_holdings) | **GET** /holdings | List all accounts for the user, plus balances, positions, and orders for each account.
47
+ *SnapTrade::AccountInformationApi* | [**get_user_account_balance**](docs/AccountInformationApi.md#get_user_account_balance) | **GET** /accounts/{accountId}/balances | List account balances
48
48
  *SnapTrade::AccountInformationApi* | [**get_user_account_details**](docs/AccountInformationApi.md#get_user_account_details) | **GET** /accounts/{accountId} | Return details of a specific investment account
49
49
  *SnapTrade::AccountInformationApi* | [**get_user_account_orders**](docs/AccountInformationApi.md#get_user_account_orders) | **GET** /accounts/{accountId}/orders | Get all history of orders placed in account
50
- *SnapTrade::AccountInformationApi* | [**get_user_account_positions**](docs/AccountInformationApi.md#get_user_account_positions) | **GET** /accounts/{accountId}/positions | Get all positions of an investment account
50
+ *SnapTrade::AccountInformationApi* | [**get_user_account_positions**](docs/AccountInformationApi.md#get_user_account_positions) | **GET** /accounts/{accountId}/positions | List account positions
51
51
  *SnapTrade::AccountInformationApi* | [**get_user_holdings**](docs/AccountInformationApi.md#get_user_holdings) | **GET** /accounts/{accountId}/holdings | List balances, positions and orders for the specified account.
52
- *SnapTrade::AccountInformationApi* | [**list_user_accounts**](docs/AccountInformationApi.md#list_user_accounts) | **GET** /accounts | List all investment accounts for the user
52
+ *SnapTrade::AccountInformationApi* | [**list_user_accounts**](docs/AccountInformationApi.md#list_user_accounts) | **GET** /accounts | List accounts
53
53
  *SnapTrade::AccountInformationApi* | [**update_user_account**](docs/AccountInformationApi.md#update_user_account) | **PUT** /accounts/{accountId} | Update details of an investment account
54
54
  *SnapTrade::APIStatusApi* | [**check**](docs/APIStatusApi.md#check) | **GET** / | Get API Status
55
- *SnapTrade::AuthenticationApi* | [**delete_snap_trade_user**](docs/AuthenticationApi.md#delete_snap_trade_user) | **DELETE** /snapTrade/deleteUser | Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
56
- *SnapTrade::AuthenticationApi* | [**get_user_jwt**](docs/AuthenticationApi.md#get_user_jwt) | **GET** /snapTrade/encryptedJWT | Obtains an encrypted JWT tokens that should be decrypted on a user's local device
57
- *SnapTrade::AuthenticationApi* | [**list_snap_trade_users**](docs/AuthenticationApi.md#list_snap_trade_users) | **GET** /snapTrade/listUsers | Get a list of all SnapTrade users you've registered on our platform
58
- *SnapTrade::AuthenticationApi* | [**login_snap_trade_user**](docs/AuthenticationApi.md#login_snap_trade_user) | **POST** /snapTrade/login | Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
59
- *SnapTrade::AuthenticationApi* | [**register_snap_trade_user**](docs/AuthenticationApi.md#register_snap_trade_user) | **POST** /snapTrade/registerUser | Register user with SnapTrade in order to create secure brokerage authorizations
55
+ *SnapTrade::AuthenticationApi* | [**delete_snap_trade_user**](docs/AuthenticationApi.md#delete_snap_trade_user) | **DELETE** /snapTrade/deleteUser | Delete SnapTrade user
56
+ *SnapTrade::AuthenticationApi* | [**get_user_jwt**](docs/AuthenticationApi.md#get_user_jwt) | **GET** /snapTrade/encryptedJWT | Generate encrypted JWT token
57
+ *SnapTrade::AuthenticationApi* | [**list_snap_trade_users**](docs/AuthenticationApi.md#list_snap_trade_users) | **GET** /snapTrade/listUsers | List SnapTrade users
58
+ *SnapTrade::AuthenticationApi* | [**login_snap_trade_user**](docs/AuthenticationApi.md#login_snap_trade_user) | **POST** /snapTrade/login | Login user & generate connection link
59
+ *SnapTrade::AuthenticationApi* | [**register_snap_trade_user**](docs/AuthenticationApi.md#register_snap_trade_user) | **POST** /snapTrade/registerUser | Create SnapTrade user
60
60
  *SnapTrade::ConnectionsApi* | [**detail_brokerage_authorization**](docs/ConnectionsApi.md#detail_brokerage_authorization) | **GET** /authorizations/{authorizationId} | Get detail of a specific brokerage authorizations for the user
61
61
  *SnapTrade::ConnectionsApi* | [**list_brokerage_authorizations**](docs/ConnectionsApi.md#list_brokerage_authorizations) | **GET** /authorizations | List all brokerage authorizations for the user
62
62
  *SnapTrade::ConnectionsApi* | [**remove_brokerage_authorization**](docs/ConnectionsApi.md#remove_brokerage_authorization) | **DELETE** /authorizations/{authorizationId} | Remove a brokerage authorization.
@@ -67,56 +67,20 @@ Class | Method | HTTP request | Description
67
67
  *SnapTrade::OptionsApi* | [**get_options_strategy_quote**](docs/OptionsApi.md#get_options_strategy_quote) | **GET** /accounts/{accountId}/optionStrategy/{optionStrategyId} | Get latest market data of option strategy
68
68
  *SnapTrade::OptionsApi* | [**list_option_holdings**](docs/OptionsApi.md#list_option_holdings) | **GET** /accounts/{accountId}/options | Get the options holdings in the account
69
69
  *SnapTrade::OptionsApi* | [**place_option_strategy**](docs/OptionsApi.md#place_option_strategy) | **POST** /accounts/{accountId}/optionStrategy/{optionStrategyId}/execute | Place an option strategy order on the brokerage
70
- *SnapTrade::PortfolioManagementApi* | [**add_portfolio_excluded_asset**](docs/PortfolioManagementApi.md#add_portfolio_excluded_asset) | **POST** /portfolioGroups/{portfolioGroupId}/excludedassets | Adds an asset to exclude to a portfolio group
71
- *SnapTrade::PortfolioManagementApi* | [**create**](docs/PortfolioManagementApi.md#create) | **POST** /portfolioGroups | Create new portfolio group
72
- *SnapTrade::PortfolioManagementApi* | [**create_asset_class**](docs/PortfolioManagementApi.md#create_asset_class) | **POST** /modelAssetClass | Create a new model asset class
73
- *SnapTrade::PortfolioManagementApi* | [**create_model_portfolio**](docs/PortfolioManagementApi.md#create_model_portfolio) | **POST** /modelPortfolio | Creates a new model portfolio
74
- *SnapTrade::PortfolioManagementApi* | [**delete_asset_class**](docs/PortfolioManagementApi.md#delete_asset_class) | **DELETE** /modelAssetClass/{modelAssetClassId} | Deletes a model asset class
75
- *SnapTrade::PortfolioManagementApi* | [**delete_excluded_asset**](docs/PortfolioManagementApi.md#delete_excluded_asset) | **DELETE** /portfolioGroups/{portfolioGroupId}/excludedassets/{symbolId} | Unexclude an asset from a portfolio group
76
- *SnapTrade::PortfolioManagementApi* | [**delete_model_portfolio_by_id**](docs/PortfolioManagementApi.md#delete_model_portfolio_by_id) | **DELETE** /modelPortfolio/{modelPortfolioId} | Deletes a model portfolio
77
- *SnapTrade::PortfolioManagementApi* | [**delete_portfoli**](docs/PortfolioManagementApi.md#delete_portfoli) | **DELETE** /portfolioGroups/{portfolioGroupId} | Remove a target portfolio.
78
- *SnapTrade::PortfolioManagementApi* | [**delete_portfolio_target_by_id**](docs/PortfolioManagementApi.md#delete_portfolio_target_by_id) | **DELETE** /portfolioGroups/{portfolioGroupId}/targets/{targetAssetId} | Remove a TargetAsset.
79
- *SnapTrade::PortfolioManagementApi* | [**detail_asset_class**](docs/PortfolioManagementApi.md#detail_asset_class) | **GET** /modelAssetClass/{modelAssetClassId} | Get details of a model asset class
80
- *SnapTrade::PortfolioManagementApi* | [**get_calculated_trade_by_id**](docs/PortfolioManagementApi.md#get_calculated_trade_by_id) | **GET** /portfolioGroups/{portfolioGroupId}/calculatedtrades/{calculatedTradeId}/{TradeId} | Return an individual trade
81
- *SnapTrade::PortfolioManagementApi* | [**get_model_details_by_id**](docs/PortfolioManagementApi.md#get_model_details_by_id) | **GET** /modelPortfolio/{modelPortfolioId} | Get details of a model portfolio
82
- *SnapTrade::PortfolioManagementApi* | [**get_portfolio_balances**](docs/PortfolioManagementApi.md#get_portfolio_balances) | **GET** /portfolioGroups/{portfolioGroupId}/balances | Get sum of cash balances in portfolio group
83
- *SnapTrade::PortfolioManagementApi* | [**get_portfolio_details_by_id**](docs/PortfolioManagementApi.md#get_portfolio_details_by_id) | **GET** /portfolioGroups/{portfolioGroupId} | Get details of a target portfolio
84
- *SnapTrade::PortfolioManagementApi* | [**get_portfolio_info**](docs/PortfolioManagementApi.md#get_portfolio_info) | **GET** /portfolioGroups/{portfolioGroupId}/info | Return a whole bunch of relevant information relating to a portfolio group.
85
- *SnapTrade::PortfolioManagementApi* | [**get_portfolio_settings**](docs/PortfolioManagementApi.md#get_portfolio_settings) | **GET** /portfolioGroups/{portfolioGroupId}/settings | Get portfolio group settings
86
- *SnapTrade::PortfolioManagementApi* | [**get_portfolio_target_by_id**](docs/PortfolioManagementApi.md#get_portfolio_target_by_id) | **GET** /portfolioGroups/{portfolioGroupId}/targets/{targetAssetId} | Get a specific target from a portfolio group
87
- *SnapTrade::PortfolioManagementApi* | [**get_portfolio_targets**](docs/PortfolioManagementApi.md#get_portfolio_targets) | **GET** /portfolioGroups/{portfolioGroupId}/targets | Get all target assets under the specified PortfolioGroup.
88
- *SnapTrade::PortfolioManagementApi* | [**get_portoflio_excluded_assets**](docs/PortfolioManagementApi.md#get_portoflio_excluded_assets) | **GET** /portfolioGroups/{portfolioGroupId}/excludedassets | Get an array of excluded assets associated with a portfolio group\\
89
- *SnapTrade::PortfolioManagementApi* | [**import_model_portfolio**](docs/PortfolioManagementApi.md#import_model_portfolio) | **POST** /portfolioGroups/{portfolioGroupId}/import | Import target allocation based on portfolio group
90
- *SnapTrade::PortfolioManagementApi* | [**list**](docs/PortfolioManagementApi.md#list) | **GET** /portfolioGroups | List all portfolio groups
91
- *SnapTrade::PortfolioManagementApi* | [**list_asset_classes**](docs/PortfolioManagementApi.md#list_asset_classes) | **GET** /modelAssetClass | List of model asset class
92
- *SnapTrade::PortfolioManagementApi* | [**list_calculated_trades**](docs/PortfolioManagementApi.md#list_calculated_trades) | **GET** /portfolioGroups/{portfolioGroupId}/calculatedtrades | List of trades to make to rebalance portfolio group
93
- *SnapTrade::PortfolioManagementApi* | [**list_model_portfolio**](docs/PortfolioManagementApi.md#list_model_portfolio) | **GET** /modelPortfolio | List of model portfolio
94
- *SnapTrade::PortfolioManagementApi* | [**list_portfolio_accounts**](docs/PortfolioManagementApi.md#list_portfolio_accounts) | **GET** /portfolioGroups/{portfolioGroupId}/accounts | Get all accounts associated with a portfolio group
95
- *SnapTrade::PortfolioManagementApi* | [**modify_model_portfolio_by_id**](docs/PortfolioManagementApi.md#modify_model_portfolio_by_id) | **POST** /modelPortfolio/{modelPortfolioId} | Updates model portfolio object
96
- *SnapTrade::PortfolioManagementApi* | [**save_portfolio**](docs/PortfolioManagementApi.md#save_portfolio) | **PATCH** /portfolioGroups/{portfolioGroupId} | Update an existing target portfolio.
97
- *SnapTrade::PortfolioManagementApi* | [**search_portfolio_symbols**](docs/PortfolioManagementApi.md#search_portfolio_symbols) | **POST** /portfolioGroups/{portfolioGroupId}/symbols | Search for symbols limited to brokerages under the specified portfolio group
98
- *SnapTrade::PortfolioManagementApi* | [**set_portfolio_targets**](docs/PortfolioManagementApi.md#set_portfolio_targets) | **POST** /portfolioGroups/{portfolioGroupId}/targets | Set a new list of target assets under the specified PortfolioGroup. All existing target assets under this portfolio group will be replaced with the new list.
99
- *SnapTrade::PortfolioManagementApi* | [**update_asset_class**](docs/PortfolioManagementApi.md#update_asset_class) | **POST** /modelAssetClass/{modelAssetClassId} | Updates model asset class objects
100
- *SnapTrade::PortfolioManagementApi* | [**update_portfolio_settings**](docs/PortfolioManagementApi.md#update_portfolio_settings) | **PATCH** /portfolioGroups/{portfolioGroupId}/settings | Updates portfolio group settings
101
- *SnapTrade::PortfolioManagementApi* | [**update_portfolio_target_by_id**](docs/PortfolioManagementApi.md#update_portfolio_target_by_id) | **PATCH** /portfolioGroups/{portfolioGroupId}/targets/{targetAssetId} | Update a TargetAsset under the specified PortfolioGroup.
102
70
  *SnapTrade::ReferenceDataApi* | [**get_currency_exchange_rate_pair**](docs/ReferenceDataApi.md#get_currency_exchange_rate_pair) | **GET** /currencies/rates/{currencyPair} | Return the exchange rate of a currency pair
103
71
  *SnapTrade::ReferenceDataApi* | [**get_partner_info**](docs/ReferenceDataApi.md#get_partner_info) | **GET** /snapTrade/partners | Get metadata related to Snaptrade partner
104
72
  *SnapTrade::ReferenceDataApi* | [**get_security_types**](docs/ReferenceDataApi.md#get_security_types) | **GET** /securityTypes | List of all security types.
105
- *SnapTrade::ReferenceDataApi* | [**get_stock_exchanges**](docs/ReferenceDataApi.md#get_stock_exchanges) | **GET** /exchanges | Return list of stock exchanges on Passiv and their suffixes
73
+ *SnapTrade::ReferenceDataApi* | [**get_stock_exchanges**](docs/ReferenceDataApi.md#get_stock_exchanges) | **GET** /exchanges | List exchanges
106
74
  *SnapTrade::ReferenceDataApi* | [**get_symbols**](docs/ReferenceDataApi.md#get_symbols) | **POST** /symbols | Search for symbols
107
75
  *SnapTrade::ReferenceDataApi* | [**get_symbols_by_ticker**](docs/ReferenceDataApi.md#get_symbols_by_ticker) | **GET** /symbols/{ticker} | Get details of a symbol by the ticker
108
76
  *SnapTrade::ReferenceDataApi* | [**list_all_brokerage_authorization_type**](docs/ReferenceDataApi.md#list_all_brokerage_authorization_type) | **GET** /brokerageAuthorizationTypes | List of all brokerage authorization types
109
- *SnapTrade::ReferenceDataApi* | [**list_all_brokerages**](docs/ReferenceDataApi.md#list_all_brokerages) | **GET** /brokerages | List of all brokerages.
110
- *SnapTrade::ReferenceDataApi* | [**list_all_currencies**](docs/ReferenceDataApi.md#list_all_currencies) | **GET** /currencies | List of all supported currencies
111
- *SnapTrade::ReferenceDataApi* | [**list_all_currencies_rates**](docs/ReferenceDataApi.md#list_all_currencies_rates) | **GET** /currencies/rates | Return the exchange rates of all supported currencies
112
- *SnapTrade::ReferenceDataApi* | [**symbol_search_user_account**](docs/ReferenceDataApi.md#symbol_search_user_account) | **POST** /accounts/{accountId}/symbols | Search for symbols that are supported by a brokerage account using a substring
77
+ *SnapTrade::ReferenceDataApi* | [**list_all_brokerages**](docs/ReferenceDataApi.md#list_all_brokerages) | **GET** /brokerages | List brokerages
78
+ *SnapTrade::ReferenceDataApi* | [**list_all_currencies**](docs/ReferenceDataApi.md#list_all_currencies) | **GET** /currencies | List currencies
79
+ *SnapTrade::ReferenceDataApi* | [**list_all_currencies_rates**](docs/ReferenceDataApi.md#list_all_currencies_rates) | **GET** /currencies/rates | List currency exchange rates
80
+ *SnapTrade::ReferenceDataApi* | [**symbol_search_user_account**](docs/ReferenceDataApi.md#symbol_search_user_account) | **POST** /accounts/{accountId}/symbols | Search for symbols available in an account
113
81
  *SnapTrade::TradingApi* | [**cancel_user_account_order**](docs/TradingApi.md#cancel_user_account_order) | **POST** /accounts/{accountId}/orders/cancel | Cancel open order in account
114
- *SnapTrade::TradingApi* | [**get_calculated_trade_impact_by_id**](docs/TradingApi.md#get_calculated_trade_impact_by_id) | **GET** /portfolioGroups/{portfolioGroupId}/calculatedtrades/{calculatedTradeId}/modify/{tradeId} | Return details of a specific trade before it's placed
115
- *SnapTrade::TradingApi* | [**get_calculated_trades_impact**](docs/TradingApi.md#get_calculated_trades_impact) | **GET** /portfolioGroups/{portfolioGroupId}/calculatedtrades/{calculatedTradeId}/impact | Return the impact of placing a series of trades on the portfolio
116
82
  *SnapTrade::TradingApi* | [**get_order_impact**](docs/TradingApi.md#get_order_impact) | **POST** /trade/impact | Check impact of trades on account.
117
83
  *SnapTrade::TradingApi* | [**get_user_account_quotes**](docs/TradingApi.md#get_user_account_quotes) | **GET** /accounts/{accountId}/quotes | Get symbol quotes
118
- *SnapTrade::TradingApi* | [**modify_calculated_trade_by_id**](docs/TradingApi.md#modify_calculated_trade_by_id) | **PATCH** /portfolioGroups/{portfolioGroupId}/calculatedtrades/{calculatedTradeId}/modify/{tradeId} | Modify units of a trade before it is placed
119
- *SnapTrade::TradingApi* | [**place_calculated_trades**](docs/TradingApi.md#place_calculated_trades) | **POST** /portfolioGroups/{portfolioGroupId}/calculatedtrades/{calculatedTradeId}/placeOrders | Place orders for the CalculatedTrades in series
120
84
  *SnapTrade::TradingApi* | [**place_force_order**](docs/TradingApi.md#place_force_order) | **POST** /trade/place | Place a trade with NO validation.
121
85
  *SnapTrade::TradingApi* | [**place_oco_order**](docs/TradingApi.md#place_oco_order) | **POST** /trade/oco | Place a OCO (One Cancels Other) order
122
86
  *SnapTrade::TradingApi* | [**place_order**](docs/TradingApi.md#place_order) | **POST** /trade/{tradeId} | Place order
@@ -4,18 +4,18 @@ All URIs are relative to *https://api.snaptrade.com/api/v1*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**get_all_user_holdings**](AccountInformationApi.md#get_all_user_holdings) | **GET** /holdings | List all accounts for the user, plus balances and positions for each account. |
8
- | [**get_user_account_balance**](AccountInformationApi.md#get_user_account_balance) | **GET** /accounts/{accountId}/balances | Get all cash balances of an investment account |
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
9
  | [**get_user_account_details**](AccountInformationApi.md#get_user_account_details) | **GET** /accounts/{accountId} | Return details of a specific investment account |
10
10
  | [**get_user_account_orders**](AccountInformationApi.md#get_user_account_orders) | **GET** /accounts/{accountId}/orders | Get all history of orders placed in account |
11
- | [**get_user_account_positions**](AccountInformationApi.md#get_user_account_positions) | **GET** /accounts/{accountId}/positions | Get all positions of an investment account |
11
+ | [**get_user_account_positions**](AccountInformationApi.md#get_user_account_positions) | **GET** /accounts/{accountId}/positions | List account positions |
12
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 all investment accounts for the user |
13
+ | [**list_user_accounts**](AccountInformationApi.md#list_user_accounts) | **GET** /accounts | List accounts |
14
14
  | [**update_user_account**](AccountInformationApi.md#update_user_account) | **PUT** /accounts/{accountId} | Update details of an investment account |
15
15
 
16
16
  ## get_all_user_holdings
17
17
 
18
- List all accounts for the user, plus balances and positions for each account.
18
+ List all accounts for the user, plus balances, positions, and orders for each account.
19
19
 
20
20
  ### Example
21
21
 
@@ -30,7 +30,7 @@ user_secret = "USERSECRET123"
30
30
  brokerage_authorizations = "917c8734-8470-4a3e-a18f-57c3f2ee6631"
31
31
 
32
32
  begin
33
- # List all accounts for the user, plus balances and positions for each account.
33
+ # List all accounts for the user, plus balances, positions, and orders for each account.
34
34
  result = SnapTrade::AccountInformation.get_all_user_holdings(
35
35
  user_id: user_id,
36
36
  user_secret: user_secret,
@@ -52,7 +52,7 @@ user_secret = "USERSECRET123"
52
52
  brokerage_authorizations = "917c8734-8470-4a3e-a18f-57c3f2ee6631"
53
53
 
54
54
  begin
55
- # List all accounts for the user, plus balances and positions for each account.
55
+ # List all accounts for the user, plus balances, positions, and orders for each account.
56
56
  data, status_code, headers, response = SnapTrade::AccountInformation.get_all_user_holdings_with_http_info(
57
57
  user_id: user_id,
58
58
  user_secret: user_secret,
@@ -80,7 +80,7 @@ end
80
80
 
81
81
  ## get_user_account_balance
82
82
 
83
- Get all cash balances of an investment account
83
+ List account balances
84
84
 
85
85
  ### Example
86
86
 
@@ -95,7 +95,7 @@ user_secret = "USERSECRET123"
95
95
  account_id = "accountId_example"
96
96
 
97
97
  begin
98
- # Get all cash balances of an investment account
98
+ # List account balances
99
99
  result = SnapTrade::AccountInformation.get_user_account_balance(
100
100
  user_id: user_id,
101
101
  user_secret: user_secret,
@@ -117,7 +117,7 @@ user_secret = "USERSECRET123"
117
117
  account_id = "accountId_example"
118
118
 
119
119
  begin
120
- # Get all cash balances of an investment account
120
+ # List account balances
121
121
  data, status_code, headers, response = SnapTrade::AccountInformation.get_user_account_balance_with_http_info(
122
122
  user_id: user_id,
123
123
  user_secret: user_secret,
@@ -190,7 +190,7 @@ begin
190
190
  )
191
191
  p status_code # => 2xx
192
192
  p headers # => { ... }
193
- p data # => Array<Account>
193
+ p data # => Account
194
194
  rescue SnapTrade::ApiError => e
195
195
  puts "Exception when calling SnapTrade::AccountInformation.get_user_account_details: #{e}"
196
196
  end
@@ -206,7 +206,7 @@ end
206
206
 
207
207
  ### Return type
208
208
 
209
- [**Array&lt;Account&gt;**](Account.md)
209
+ [**Account**](Account.md)
210
210
 
211
211
  ## get_user_account_orders
212
212
 
@@ -280,7 +280,7 @@ end
280
280
 
281
281
  ## get_user_account_positions
282
282
 
283
- Get all positions of an investment account
283
+ List account positions
284
284
 
285
285
  ### Example
286
286
 
@@ -295,7 +295,7 @@ user_secret = "USERSECRET123"
295
295
  account_id = "accountId_example"
296
296
 
297
297
  begin
298
- # Get all positions of an investment account
298
+ # List account positions
299
299
  result = SnapTrade::AccountInformation.get_user_account_positions(
300
300
  user_id: user_id,
301
301
  user_secret: user_secret,
@@ -317,7 +317,7 @@ user_secret = "USERSECRET123"
317
317
  account_id = "accountId_example"
318
318
 
319
319
  begin
320
- # Get all positions of an investment account
320
+ # List account positions
321
321
  data, status_code, headers, response = SnapTrade::AccountInformation.get_user_account_positions_with_http_info(
322
322
  user_id: user_id,
323
323
  user_secret: user_secret,
@@ -410,7 +410,7 @@ end
410
410
 
411
411
  ## list_user_accounts
412
412
 
413
- List all investment accounts for the user
413
+ List accounts
414
414
 
415
415
  ### Example
416
416
 
@@ -424,7 +424,7 @@ user_id = "John.doe@snaptrade.com"
424
424
  user_secret = "USERSECRET123"
425
425
 
426
426
  begin
427
- # List all investment accounts for the user
427
+ # List accounts
428
428
  result = SnapTrade::AccountInformation.list_user_accounts(
429
429
  user_id: user_id,
430
430
  user_secret: user_secret,
@@ -444,7 +444,7 @@ user_id = "John.doe@snaptrade.com"
444
444
  user_secret = "USERSECRET123"
445
445
 
446
446
  begin
447
- # List all investment accounts for the user
447
+ # List accounts
448
448
  data, status_code, headers, response = SnapTrade::AccountInformation.list_user_accounts_with_http_info(
449
449
  user_id: user_id,
450
450
  user_secret: user_secret,
@@ -4,15 +4,15 @@ All URIs are relative to *https://api.snaptrade.com/api/v1*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**delete_snap_trade_user**](AuthenticationApi.md#delete_snap_trade_user) | **DELETE** /snapTrade/deleteUser | Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user |
8
- | [**get_user_jwt**](AuthenticationApi.md#get_user_jwt) | **GET** /snapTrade/encryptedJWT | Obtains an encrypted JWT tokens that should be decrypted on a user&#39;s local device |
9
- | [**list_snap_trade_users**](AuthenticationApi.md#list_snap_trade_users) | **GET** /snapTrade/listUsers | Get a list of all SnapTrade users you&#39;ve registered on our platform |
10
- | [**login_snap_trade_user**](AuthenticationApi.md#login_snap_trade_user) | **POST** /snapTrade/login | Generate a redirect URI to securely login a user to the SnapTrade Connection Portal |
11
- | [**register_snap_trade_user**](AuthenticationApi.md#register_snap_trade_user) | **POST** /snapTrade/registerUser | Register user with SnapTrade in order to create secure brokerage authorizations |
7
+ | [**delete_snap_trade_user**](AuthenticationApi.md#delete_snap_trade_user) | **DELETE** /snapTrade/deleteUser | Delete SnapTrade user |
8
+ | [**get_user_jwt**](AuthenticationApi.md#get_user_jwt) | **GET** /snapTrade/encryptedJWT | Generate encrypted JWT token |
9
+ | [**list_snap_trade_users**](AuthenticationApi.md#list_snap_trade_users) | **GET** /snapTrade/listUsers | List SnapTrade users |
10
+ | [**login_snap_trade_user**](AuthenticationApi.md#login_snap_trade_user) | **POST** /snapTrade/login | Login user &amp; generate connection link |
11
+ | [**register_snap_trade_user**](AuthenticationApi.md#register_snap_trade_user) | **POST** /snapTrade/registerUser | Create SnapTrade user |
12
12
 
13
13
  ## delete_snap_trade_user
14
14
 
15
- Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
15
+ Delete SnapTrade user
16
16
 
17
17
  ### Example
18
18
 
@@ -25,7 +25,7 @@ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
25
25
  user_id = "John.doe@snaptrade.com"
26
26
 
27
27
  begin
28
- # Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
28
+ # Delete SnapTrade user
29
29
  result = SnapTrade::Authentication.delete_snap_trade_user(
30
30
  user_id: user_id,
31
31
  )
@@ -43,7 +43,7 @@ This returns an Array which contains the response data, status code and headers.
43
43
  user_id = "John.doe@snaptrade.com"
44
44
 
45
45
  begin
46
- # Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
46
+ # Delete SnapTrade user
47
47
  data, status_code, headers, response = SnapTrade::Authentication.delete_snap_trade_user_with_http_info(
48
48
  user_id: user_id,
49
49
  )
@@ -67,7 +67,7 @@ end
67
67
 
68
68
  ## get_user_jwt
69
69
 
70
- Obtains an encrypted JWT tokens that should be decrypted on a user's local device
70
+ Generate encrypted JWT token
71
71
 
72
72
  ### Example
73
73
 
@@ -81,7 +81,7 @@ user_id = "John.doe@snaptrade.com"
81
81
  user_secret = "USERSECRET123"
82
82
 
83
83
  begin
84
- # Obtains an encrypted JWT tokens that should be decrypted on a user's local device
84
+ # Generate encrypted JWT token
85
85
  result = SnapTrade::Authentication.get_user_jwt(
86
86
  user_id: user_id,
87
87
  user_secret: user_secret,
@@ -101,7 +101,7 @@ user_id = "John.doe@snaptrade.com"
101
101
  user_secret = "USERSECRET123"
102
102
 
103
103
  begin
104
- # Obtains an encrypted JWT tokens that should be decrypted on a user's local device
104
+ # Generate encrypted JWT token
105
105
  data, status_code, headers, response = SnapTrade::Authentication.get_user_jwt_with_http_info(
106
106
  user_id: user_id,
107
107
  user_secret: user_secret,
@@ -127,7 +127,7 @@ end
127
127
 
128
128
  ## list_snap_trade_users
129
129
 
130
- Get a list of all SnapTrade users you've registered on our platform
130
+ List SnapTrade users
131
131
 
132
132
  ### Example
133
133
 
@@ -139,7 +139,7 @@ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
139
139
 
140
140
 
141
141
  begin
142
- # Get a list of all SnapTrade users you've registered on our platform
142
+ # List SnapTrade users
143
143
  result = SnapTrade::Authentication.list_snap_trade_users
144
144
  p result
145
145
  rescue SnapTrade::ApiError => e
@@ -154,7 +154,7 @@ This returns an Array which contains the response data, status code and headers.
154
154
  ```ruby
155
155
 
156
156
  begin
157
- # Get a list of all SnapTrade users you've registered on our platform
157
+ # List SnapTrade users
158
158
  data, status_code, headers, response = SnapTrade::Authentication.list_snap_trade_users_with_http_info
159
159
  p status_code # => 2xx
160
160
  p headers # => { ... }
@@ -174,7 +174,7 @@ This endpoint does not need any parameter.
174
174
 
175
175
  ## login_snap_trade_user
176
176
 
177
- Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
177
+ Login user & generate connection link
178
178
 
179
179
  ### Example
180
180
 
@@ -193,7 +193,7 @@ reconnect = "8b5f262d-4bb9-365d-888a-202bd3b15fa1"
193
193
  connection_type = "read"
194
194
 
195
195
  begin
196
- # Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
196
+ # Login user & generate connection link
197
197
  result = SnapTrade::Authentication.login_snap_trade_user(
198
198
  user_id: user_id,
199
199
  user_secret: user_secret,
@@ -223,7 +223,7 @@ reconnect = "8b5f262d-4bb9-365d-888a-202bd3b15fa1"
223
223
  connection_type = "read"
224
224
 
225
225
  begin
226
- # Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
226
+ # Login user & generate connection link
227
227
  data, status_code, headers, response = SnapTrade::Authentication.login_snap_trade_user_with_http_info(
228
228
  user_id: user_id,
229
229
  user_secret: user_secret,
@@ -255,7 +255,7 @@ end
255
255
 
256
256
  ## register_snap_trade_user
257
257
 
258
- Register user with SnapTrade in order to create secure brokerage authorizations
258
+ Create SnapTrade user
259
259
 
260
260
  ### Example
261
261
 
@@ -269,7 +269,7 @@ user_id = "snaptrade-user-123"
269
269
  rsa_public_key = "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC7vbqajDw4o6gJy8UtmIbkcpnkO3Kwc4qsEnSZp/TR+fQi62F79RHWmwKOtFmwteURgLbj7D/WGuNLGOfa/2vse3G2eHnHl5CB8ruRX9fBl/KgwCVr2JaEuUm66bBQeP5XeBotdR4cvX38uPYivCDdPjJ1QWPdspTBKcxeFbccDw=="
270
270
 
271
271
  begin
272
- # Register user with SnapTrade in order to create secure brokerage authorizations
272
+ # Create SnapTrade user
273
273
  result = SnapTrade::Authentication.register_snap_trade_user(
274
274
  user_id: user_id,
275
275
  rsa_public_key: rsa_public_key,
@@ -289,7 +289,7 @@ user_id = "snaptrade-user-123"
289
289
  rsa_public_key = "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC7vbqajDw4o6gJy8UtmIbkcpnkO3Kwc4qsEnSZp/TR+fQi62F79RHWmwKOtFmwteURgLbj7D/WGuNLGOfa/2vse3G2eHnHl5CB8ruRX9fBl/KgwCVr2JaEuUm66bBQeP5XeBotdR4cvX38uPYivCDdPjJ1QWPdspTBKcxeFbccDw=="
290
290
 
291
291
  begin
292
- # Register user with SnapTrade in order to create secure brokerage authorizations
292
+ # Create SnapTrade user
293
293
  data, status_code, headers, response = SnapTrade::Authentication.register_snap_trade_user_with_http_info(
294
294
  user_id: user_id,
295
295
  rsa_public_key: rsa_public_key,
data/docs/OptionsApi.md CHANGED
@@ -287,7 +287,7 @@ begin
287
287
  )
288
288
  p status_code # => 2xx
289
289
  p headers # => { ... }
290
- p data # => OptionsHoldings
290
+ p data # => Array<OptionsPosition>
291
291
  rescue SnapTrade::ApiError => e
292
292
  puts "Exception when calling SnapTrade::Options.list_option_holdings: #{e}"
293
293
  end
@@ -303,7 +303,7 @@ end
303
303
 
304
304
  ### Return type
305
305
 
306
- [**OptionsHoldings**](OptionsHoldings.md)
306
+ [**Array&lt;OptionsPosition&gt;**](OptionsPosition.md)
307
307
 
308
308
  ## place_option_strategy
309
309
 
@@ -7,14 +7,14 @@ All URIs are relative to *https://api.snaptrade.com/api/v1*
7
7
  | [**get_currency_exchange_rate_pair**](ReferenceDataApi.md#get_currency_exchange_rate_pair) | **GET** /currencies/rates/{currencyPair} | Return the exchange rate of a currency pair |
8
8
  | [**get_partner_info**](ReferenceDataApi.md#get_partner_info) | **GET** /snapTrade/partners | Get metadata related to Snaptrade partner |
9
9
  | [**get_security_types**](ReferenceDataApi.md#get_security_types) | **GET** /securityTypes | List of all security types. |
10
- | [**get_stock_exchanges**](ReferenceDataApi.md#get_stock_exchanges) | **GET** /exchanges | Return list of stock exchanges on Passiv and their suffixes |
10
+ | [**get_stock_exchanges**](ReferenceDataApi.md#get_stock_exchanges) | **GET** /exchanges | List exchanges |
11
11
  | [**get_symbols**](ReferenceDataApi.md#get_symbols) | **POST** /symbols | Search for symbols |
12
12
  | [**get_symbols_by_ticker**](ReferenceDataApi.md#get_symbols_by_ticker) | **GET** /symbols/{ticker} | Get details of a symbol by the ticker |
13
13
  | [**list_all_brokerage_authorization_type**](ReferenceDataApi.md#list_all_brokerage_authorization_type) | **GET** /brokerageAuthorizationTypes | List of all brokerage authorization types |
14
- | [**list_all_brokerages**](ReferenceDataApi.md#list_all_brokerages) | **GET** /brokerages | List of all brokerages. |
15
- | [**list_all_currencies**](ReferenceDataApi.md#list_all_currencies) | **GET** /currencies | List of all supported currencies |
16
- | [**list_all_currencies_rates**](ReferenceDataApi.md#list_all_currencies_rates) | **GET** /currencies/rates | Return the exchange rates of all supported currencies |
17
- | [**symbol_search_user_account**](ReferenceDataApi.md#symbol_search_user_account) | **POST** /accounts/{accountId}/symbols | Search for symbols that are supported by a brokerage account using a substring |
14
+ | [**list_all_brokerages**](ReferenceDataApi.md#list_all_brokerages) | **GET** /brokerages | List brokerages |
15
+ | [**list_all_currencies**](ReferenceDataApi.md#list_all_currencies) | **GET** /currencies | List currencies |
16
+ | [**list_all_currencies_rates**](ReferenceDataApi.md#list_all_currencies_rates) | **GET** /currencies/rates | List currency exchange rates |
17
+ | [**symbol_search_user_account**](ReferenceDataApi.md#symbol_search_user_account) | **POST** /accounts/{accountId}/symbols | Search for symbols available in an account |
18
18
 
19
19
  ## get_currency_exchange_rate_pair
20
20
 
@@ -167,7 +167,7 @@ This endpoint does not need any parameter.
167
167
 
168
168
  ## get_stock_exchanges
169
169
 
170
- Return list of stock exchanges on Passiv and their suffixes
170
+ List exchanges
171
171
 
172
172
  ### Example
173
173
 
@@ -179,7 +179,7 @@ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
179
179
 
180
180
 
181
181
  begin
182
- # Return list of stock exchanges on Passiv and their suffixes
182
+ # List exchanges
183
183
  result = SnapTrade::ReferenceData.get_stock_exchanges
184
184
  p result
185
185
  rescue SnapTrade::ApiError => e
@@ -194,7 +194,7 @@ This returns an Array which contains the response data, status code and headers.
194
194
  ```ruby
195
195
 
196
196
  begin
197
- # Return list of stock exchanges on Passiv and their suffixes
197
+ # List exchanges
198
198
  data, status_code, headers, response = SnapTrade::ReferenceData.get_stock_exchanges_with_http_info
199
199
  p status_code # => 2xx
200
200
  p headers # => { ... }
@@ -384,7 +384,7 @@ end
384
384
 
385
385
  ## list_all_brokerages
386
386
 
387
- List of all brokerages.
387
+ List brokerages
388
388
 
389
389
  ### Example
390
390
 
@@ -396,7 +396,7 @@ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
396
396
 
397
397
 
398
398
  begin
399
- # List of all brokerages.
399
+ # List brokerages
400
400
  result = SnapTrade::ReferenceData.list_all_brokerages
401
401
  p result
402
402
  rescue SnapTrade::ApiError => e
@@ -411,7 +411,7 @@ This returns an Array which contains the response data, status code and headers.
411
411
  ```ruby
412
412
 
413
413
  begin
414
- # List of all brokerages.
414
+ # List brokerages
415
415
  data, status_code, headers, response = SnapTrade::ReferenceData.list_all_brokerages_with_http_info
416
416
  p status_code # => 2xx
417
417
  p headers # => { ... }
@@ -431,7 +431,7 @@ This endpoint does not need any parameter.
431
431
 
432
432
  ## list_all_currencies
433
433
 
434
- List of all supported currencies
434
+ List currencies
435
435
 
436
436
  ### Example
437
437
 
@@ -443,7 +443,7 @@ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
443
443
 
444
444
 
445
445
  begin
446
- # List of all supported currencies
446
+ # List currencies
447
447
  result = SnapTrade::ReferenceData.list_all_currencies
448
448
  p result
449
449
  rescue SnapTrade::ApiError => e
@@ -458,7 +458,7 @@ This returns an Array which contains the response data, status code and headers.
458
458
  ```ruby
459
459
 
460
460
  begin
461
- # List of all supported currencies
461
+ # List currencies
462
462
  data, status_code, headers, response = SnapTrade::ReferenceData.list_all_currencies_with_http_info
463
463
  p status_code # => 2xx
464
464
  p headers # => { ... }
@@ -478,7 +478,7 @@ This endpoint does not need any parameter.
478
478
 
479
479
  ## list_all_currencies_rates
480
480
 
481
- Return the exchange rates of all supported currencies
481
+ List currency exchange rates
482
482
 
483
483
  ### Example
484
484
 
@@ -490,7 +490,7 @@ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
490
490
 
491
491
 
492
492
  begin
493
- # Return the exchange rates of all supported currencies
493
+ # List currency exchange rates
494
494
  result = SnapTrade::ReferenceData.list_all_currencies_rates
495
495
  p result
496
496
  rescue SnapTrade::ApiError => e
@@ -505,7 +505,7 @@ This returns an Array which contains the response data, status code and headers.
505
505
  ```ruby
506
506
 
507
507
  begin
508
- # Return the exchange rates of all supported currencies
508
+ # List currency exchange rates
509
509
  data, status_code, headers, response = SnapTrade::ReferenceData.list_all_currencies_rates_with_http_info
510
510
  p status_code # => 2xx
511
511
  p headers # => { ... }
@@ -525,7 +525,7 @@ This endpoint does not need any parameter.
525
525
 
526
526
  ## symbol_search_user_account
527
527
 
528
- Search for symbols that are supported by a brokerage account using a substring
528
+ Search for symbols available in an account
529
529
 
530
530
  ### Example
531
531
 
@@ -541,7 +541,7 @@ account_id = "accountId_example"
541
541
  substring = "apple"
542
542
 
543
543
  begin
544
- # Search for symbols that are supported by a brokerage account using a substring
544
+ # Search for symbols available in an account
545
545
  result = SnapTrade::ReferenceData.symbol_search_user_account(
546
546
  user_id: user_id,
547
547
  user_secret: user_secret,
@@ -565,7 +565,7 @@ account_id = "accountId_example"
565
565
  substring = "apple"
566
566
 
567
567
  begin
568
- # Search for symbols that are supported by a brokerage account using a substring
568
+ # Search for symbols available in an account
569
569
  data, status_code, headers, response = SnapTrade::ReferenceData.symbol_search_user_account_with_http_info(
570
570
  user_id: user_id,
571
571
  user_secret: user_secret,