snaptrade 1.16.0 → 1.16.1

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.
Files changed (22) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +12 -10
  3. data/README.md +221 -221
  4. data/docs/APIStatusApi.md +1 -1
  5. data/docs/AccountInformationApi.md +8 -8
  6. data/docs/AuthenticationApi.md +5 -5
  7. data/docs/ConnectionsApi.md +4 -4
  8. data/docs/ErrorLogsApi.md +1 -1
  9. data/docs/MonthlyDividends.md +20 -20
  10. data/docs/NetContributions.md +22 -22
  11. data/docs/OptionsApi.md +5 -5
  12. data/docs/PastValue.md +22 -22
  13. data/docs/ReferenceDataApi.md +11 -11
  14. data/docs/SubPeriodReturnRate.md +22 -22
  15. data/docs/TradingApi.md +6 -6
  16. data/docs/TransactionsAndReportingApi.md +2 -2
  17. data/docs/TransactionsStatus.md +20 -20
  18. data/lib/snaptrade/api_client_custom.rb +32 -32
  19. data/lib/snaptrade/models/snap_trade_holdings_total_value.rb +227 -227
  20. data/lib/snaptrade/version.rb +13 -13
  21. data/spec/getting_started_spec.rb +108 -108
  22. metadata +116 -116
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 66efbd22c5142befa0a2988eca9c54f59bba7beaf50b40cfa89a652666d98d1b
4
- data.tar.gz: c477f1fc485265cf76abd8300fdf8bec60d9cae766e3ab05327c398bb235e688
3
+ metadata.gz: edc5a3308b36d4e16755637de3c0259012be32d55f40c6e15624c69f3f2dc003
4
+ data.tar.gz: 8d183dd2e7a1836bc9593436cf10aff5eae31d5ac98ba50d19528c532b3c1c51
5
5
  SHA512:
6
- metadata.gz: 0f65cf6485c1403e25e03d7b63daff0773f04b41eae32310907d75a49bd0aa505d01e9b38597b6d8e1afbce416db1151125449f8af6c2568cfee68619a5af8c3
7
- data.tar.gz: 27a214593021f3c1a4b6072889fca143dae46706a7845c750a1d6f7176a6c620eadc9a408581f08988d3bcbb628d22fc1cce98e1907f3636de8cebcfd5accc2c
6
+ metadata.gz: c6d935f35ae9d981540418150b09a31dbaa2b79461823db7609414cc5d633a669b8faaa9ffed74edebe1b537c32f1e8904778ad60549ac8ccc3d887146b176bf
7
+ data.tar.gz: 36b2427d480157283be9cb2eb641163e85afc9983e86edde1977637ec4120b12f8984c122b25faa22b02a762093e58390c2704ac46a2796af049c1e46010e0a6
data/Gemfile.lock CHANGED
@@ -22,23 +22,25 @@ GEM
22
22
  multipart-post (~> 2)
23
23
  faraday-net_http (3.0.2)
24
24
  io-console (0.6.0)
25
- irb (1.6.4)
26
- reline (>= 0.3.0)
25
+ irb (1.7.3)
26
+ reline (>= 0.3.6)
27
27
  method_source (1.0.0)
28
28
  multipart-post (2.3.0)
29
29
  parallel (1.23.0)
30
- parser (3.2.2.1)
30
+ parser (3.2.2.3)
31
31
  ast (~> 2.4.1)
32
+ racc
32
33
  pry (0.14.2)
33
34
  coderay (~> 1.1)
34
35
  method_source (~> 1.0)
35
36
  pry-byebug (3.10.1)
36
37
  byebug (~> 11.0)
37
38
  pry (>= 0.13, < 0.15)
39
+ racc (1.7.1)
38
40
  rainbow (3.1.1)
39
41
  rake (13.0.6)
40
- regexp_parser (2.8.0)
41
- reline (0.3.4)
42
+ regexp_parser (2.8.1)
43
+ reline (0.3.6)
42
44
  io-console (~> 0.5)
43
45
  rexml (3.2.5)
44
46
  rspec (3.12.0)
@@ -50,10 +52,10 @@ GEM
50
52
  rspec-expectations (3.12.3)
51
53
  diff-lcs (>= 1.2.0, < 2.0)
52
54
  rspec-support (~> 3.12.0)
53
- rspec-mocks (3.12.5)
55
+ rspec-mocks (3.12.6)
54
56
  diff-lcs (>= 1.2.0, < 2.0)
55
57
  rspec-support (~> 3.12.0)
56
- rspec-support (3.12.0)
58
+ rspec-support (3.12.1)
57
59
  rubocop (1.12.1)
58
60
  parallel (~> 1.10)
59
61
  parser (>= 3.0.0.0)
@@ -63,14 +65,14 @@ GEM
63
65
  rubocop-ast (>= 1.2.0, < 2.0)
64
66
  ruby-progressbar (~> 1.7)
65
67
  unicode-display_width (>= 1.4.0, < 3.0)
66
- rubocop-ast (1.28.1)
68
+ rubocop-ast (1.29.0)
67
69
  parser (>= 3.2.1.0)
68
70
  ruby-progressbar (1.13.0)
69
71
  ruby2_keywords (0.0.5)
70
72
  unicode-display_width (2.4.2)
71
73
 
72
74
  PLATFORMS
73
- arm64-darwin-21
75
+ x64-mingw-ucrt
74
76
 
75
77
  DEPENDENCIES
76
78
  debug (~> 1.8)
@@ -81,4 +83,4 @@ DEPENDENCIES
81
83
  snaptrade!
82
84
 
83
85
  BUNDLED WITH
84
- 2.3.7
86
+ 2.4.16
data/README.md CHANGED
@@ -1,221 +1,221 @@
1
- # snaptrade
2
-
3
- Connect brokerage accounts to your app for live positions and trading
4
-
5
- For more information, please visit [https://snaptrade.com/](https://snaptrade.com/)
6
-
7
- ## Installation
8
-
9
- Add to Gemfile:
10
-
11
- ```ruby
12
- gem 'snaptrade', '~> 1.16.0'
13
- ```
14
-
15
- ## Getting Started
16
-
17
- ```ruby
18
- require 'snaptrade'
19
-
20
- SnapTrade.client_id = "YOUR_CLIENT_ID"
21
- SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
22
-
23
- user_id = "John.doe@snaptrade.com"
24
- user_secret = "USERSECRET123"
25
- brokerage_authorizations = "917c8734-8470-4a3e-a18f-57c3f2ee6631"
26
-
27
- begin
28
- # List all accounts for the user, plus balances, positions, and orders for each account.
29
- result = SnapTrade::AccountInformation.get_all_user_holdings(
30
- user_id: user_id,
31
- user_secret: user_secret,
32
- brokerage_authorizations: brokerage_authorizations,
33
- )
34
- p result
35
- rescue SnapTrade::ApiError => e
36
- puts "Exception when calling SnapTrade::AccountInformation.get_all_user_holdings: #{e}"
37
- end
38
- ```
39
-
40
- ## Documentation for API Endpoints
41
-
42
- All URIs are relative to *https://api.snaptrade.com/api/v1*
43
-
44
- Class | Method | HTTP request | Description
45
- ------------ | ------------- | ------------- | -------------
46
- *SnapTrade::AccountInformationApi* | [**get_all_user_holdings**](docs/AccountInformationApi.md#get_all_user_holdings) | **GET** /holdings | List all accounts for the user, plus balances, positions, and orders for each account.
47
- *SnapTrade::AccountInformationApi* | [**get_user_account_balance**](docs/AccountInformationApi.md#get_user_account_balance) | **GET** /accounts/{accountId}/balances | List account balances
48
- *SnapTrade::AccountInformationApi* | [**get_user_account_details**](docs/AccountInformationApi.md#get_user_account_details) | **GET** /accounts/{accountId} | Return details of a specific investment account
49
- *SnapTrade::AccountInformationApi* | [**get_user_account_orders**](docs/AccountInformationApi.md#get_user_account_orders) | **GET** /accounts/{accountId}/orders | Get history of orders placed in account
50
- *SnapTrade::AccountInformationApi* | [**get_user_account_positions**](docs/AccountInformationApi.md#get_user_account_positions) | **GET** /accounts/{accountId}/positions | List account positions
51
- *SnapTrade::AccountInformationApi* | [**get_user_holdings**](docs/AccountInformationApi.md#get_user_holdings) | **GET** /accounts/{accountId}/holdings | List balances, positions and orders for the specified account.
52
- *SnapTrade::AccountInformationApi* | [**list_user_accounts**](docs/AccountInformationApi.md#list_user_accounts) | **GET** /accounts | List accounts
53
- *SnapTrade::AccountInformationApi* | [**update_user_account**](docs/AccountInformationApi.md#update_user_account) | **PUT** /accounts/{accountId} | Update details of an investment account
54
- *SnapTrade::APIStatusApi* | [**check**](docs/APIStatusApi.md#check) | **GET** / | Get API Status
55
- *SnapTrade::AuthenticationApi* | [**delete_snap_trade_user**](docs/AuthenticationApi.md#delete_snap_trade_user) | **DELETE** /snapTrade/deleteUser | Delete SnapTrade user
56
- *SnapTrade::AuthenticationApi* | [**get_user_jwt**](docs/AuthenticationApi.md#get_user_jwt) | **GET** /snapTrade/encryptedJWT | Generate encrypted JWT token
57
- *SnapTrade::AuthenticationApi* | [**list_snap_trade_users**](docs/AuthenticationApi.md#list_snap_trade_users) | **GET** /snapTrade/listUsers | List SnapTrade users
58
- *SnapTrade::AuthenticationApi* | [**login_snap_trade_user**](docs/AuthenticationApi.md#login_snap_trade_user) | **POST** /snapTrade/login | Login user & generate connection link
59
- *SnapTrade::AuthenticationApi* | [**register_snap_trade_user**](docs/AuthenticationApi.md#register_snap_trade_user) | **POST** /snapTrade/registerUser | Create SnapTrade user
60
- *SnapTrade::ConnectionsApi* | [**detail_brokerage_authorization**](docs/ConnectionsApi.md#detail_brokerage_authorization) | **GET** /authorizations/{authorizationId} | Get brokerage authorization details
61
- *SnapTrade::ConnectionsApi* | [**list_brokerage_authorizations**](docs/ConnectionsApi.md#list_brokerage_authorizations) | **GET** /authorizations | List all brokerage authorizations for the user
62
- *SnapTrade::ConnectionsApi* | [**remove_brokerage_authorization**](docs/ConnectionsApi.md#remove_brokerage_authorization) | **DELETE** /authorizations/{authorizationId} | Delete brokerage authorization
63
- *SnapTrade::ConnectionsApi* | [**session_events**](docs/ConnectionsApi.md#session_events) | **GET** /sessionEvents | List all session events for the partner
64
- *SnapTrade::ErrorLogsApi* | [**list_user_errors**](docs/ErrorLogsApi.md#list_user_errors) | **GET** /snapTrade/listUserErrors | Retrieve error logs on behalf of your SnapTrade users
65
- *SnapTrade::OptionsApi* | [**get_option_strategy**](docs/OptionsApi.md#get_option_strategy) | **POST** /accounts/{accountId}/optionStrategy | Creates an option strategy object that will be used to place an option strategy order
66
- *SnapTrade::OptionsApi* | [**get_options_chain**](docs/OptionsApi.md#get_options_chain) | **GET** /accounts/{accountId}/optionsChain | Get the options chain
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
- *SnapTrade::OptionsApi* | [**list_option_holdings**](docs/OptionsApi.md#list_option_holdings) | **GET** /accounts/{accountId}/options | Get the options holdings in the account
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::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
71
- *SnapTrade::ReferenceDataApi* | [**get_partner_info**](docs/ReferenceDataApi.md#get_partner_info) | **GET** /snapTrade/partners | Get metadata related to Snaptrade partner
72
- *SnapTrade::ReferenceDataApi* | [**get_security_types**](docs/ReferenceDataApi.md#get_security_types) | **GET** /securityTypes | List of all security types.
73
- *SnapTrade::ReferenceDataApi* | [**get_stock_exchanges**](docs/ReferenceDataApi.md#get_stock_exchanges) | **GET** /exchanges | List exchanges
74
- *SnapTrade::ReferenceDataApi* | [**get_symbols**](docs/ReferenceDataApi.md#get_symbols) | **POST** /symbols | Search for symbols
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
76
- *SnapTrade::ReferenceDataApi* | [**list_all_brokerage_authorization_type**](docs/ReferenceDataApi.md#list_all_brokerage_authorization_type) | **GET** /brokerageAuthorizationTypes | List of all brokerage authorization types
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
81
- *SnapTrade::TradingApi* | [**cancel_user_account_order**](docs/TradingApi.md#cancel_user_account_order) | **POST** /accounts/{accountId}/orders/cancel | Cancel open order in account
82
- *SnapTrade::TradingApi* | [**get_order_impact**](docs/TradingApi.md#get_order_impact) | **POST** /trade/impact | Check impact of trades on account.
83
- *SnapTrade::TradingApi* | [**get_user_account_quotes**](docs/TradingApi.md#get_user_account_quotes) | **GET** /accounts/{accountId}/quotes | Get symbol quotes
84
- *SnapTrade::TradingApi* | [**place_force_order**](docs/TradingApi.md#place_force_order) | **POST** /trade/place | Place a trade with NO validation.
85
- *SnapTrade::TradingApi* | [**place_oco_order**](docs/TradingApi.md#place_oco_order) | **POST** /trade/oco | Place a OCO (One Cancels Other) order
86
- *SnapTrade::TradingApi* | [**place_order**](docs/TradingApi.md#place_order) | **POST** /trade/{tradeId} | Place order
87
- *SnapTrade::TransactionsAndReportingApi* | [**get_activities**](docs/TransactionsAndReportingApi.md#get_activities) | **GET** /activities | Get transaction history for a user
88
- *SnapTrade::TransactionsAndReportingApi* | [**get_reporting_custom_range**](docs/TransactionsAndReportingApi.md#get_reporting_custom_range) | **GET** /performance/custom | Get performance information for a specific timeframe
89
-
90
-
91
- ## Documentation for Models
92
-
93
- - [SnapTrade::Account](docs/Account.md)
94
- - [SnapTrade::AccountHoldings](docs/AccountHoldings.md)
95
- - [SnapTrade::AccountHoldingsAccount](docs/AccountHoldingsAccount.md)
96
- - [SnapTrade::AccountOrderRecord](docs/AccountOrderRecord.md)
97
- - [SnapTrade::AccountOrderRecordStatus](docs/AccountOrderRecordStatus.md)
98
- - [SnapTrade::AccountSimple](docs/AccountSimple.md)
99
- - [SnapTrade::AccountSyncStatus](docs/AccountSyncStatus.md)
100
- - [SnapTrade::Action](docs/Action.md)
101
- - [SnapTrade::AuthType](docs/AuthType.md)
102
- - [SnapTrade::AuthenticationLoginSnapTradeUser200Response](docs/AuthenticationLoginSnapTradeUser200Response.md)
103
- - [SnapTrade::Balance](docs/Balance.md)
104
- - [SnapTrade::Brokerage](docs/Brokerage.md)
105
- - [SnapTrade::BrokerageAuthorization](docs/BrokerageAuthorization.md)
106
- - [SnapTrade::BrokerageAuthorizationType](docs/BrokerageAuthorizationType.md)
107
- - [SnapTrade::BrokerageAuthorizationTypeReadOnly](docs/BrokerageAuthorizationTypeReadOnly.md)
108
- - [SnapTrade::BrokerageAuthorizationTypeReadOnlyBrokerage](docs/BrokerageAuthorizationTypeReadOnlyBrokerage.md)
109
- - [SnapTrade::BrokerageAuthorizationTypeReadOnlyType](docs/BrokerageAuthorizationTypeReadOnlyType.md)
110
- - [SnapTrade::BrokerageAuthorizationTypeType](docs/BrokerageAuthorizationTypeType.md)
111
- - [SnapTrade::BrokerageSymbol](docs/BrokerageSymbol.md)
112
- - [SnapTrade::BrokerageSymbolOptionSymbol](docs/BrokerageSymbolOptionSymbol.md)
113
- - [SnapTrade::BrokerageSymbolSymbol](docs/BrokerageSymbolSymbol.md)
114
- - [SnapTrade::BrokerageType](docs/BrokerageType.md)
115
- - [SnapTrade::CalculatedTrade](docs/CalculatedTrade.md)
116
- - [SnapTrade::CashRestriction](docs/CashRestriction.md)
117
- - [SnapTrade::ConnectionType](docs/ConnectionType.md)
118
- - [SnapTrade::ConnectionsSessionEvents200ResponseInner](docs/ConnectionsSessionEvents200ResponseInner.md)
119
- - [SnapTrade::Currency](docs/Currency.md)
120
- - [SnapTrade::DeleteUserResponse](docs/DeleteUserResponse.md)
121
- - [SnapTrade::DividendAtDate](docs/DividendAtDate.md)
122
- - [SnapTrade::EncryptedResponse](docs/EncryptedResponse.md)
123
- - [SnapTrade::EncryptedResponseEncryptedMessageData](docs/EncryptedResponseEncryptedMessageData.md)
124
- - [SnapTrade::Exchange](docs/Exchange.md)
125
- - [SnapTrade::ExchangeRatePairs](docs/ExchangeRatePairs.md)
126
- - [SnapTrade::ExcludedAsset](docs/ExcludedAsset.md)
127
- - [SnapTrade::JWT](docs/JWT.md)
128
- - [SnapTrade::LoginRedirectURI](docs/LoginRedirectURI.md)
129
- - [SnapTrade::ManualTrade](docs/ManualTrade.md)
130
- - [SnapTrade::ManualTradeAndImpact](docs/ManualTradeAndImpact.md)
131
- - [SnapTrade::ManualTradeBalance](docs/ManualTradeBalance.md)
132
- - [SnapTrade::ManualTradeForm](docs/ManualTradeForm.md)
133
- - [SnapTrade::ManualTradeSymbol](docs/ManualTradeSymbol.md)
134
- - [SnapTrade::Model400FailedRequestResponse](docs/Model400FailedRequestResponse.md)
135
- - [SnapTrade::Model401FailedRequestResponse](docs/Model401FailedRequestResponse.md)
136
- - [SnapTrade::Model403FailedRequestResponse](docs/Model403FailedRequestResponse.md)
137
- - [SnapTrade::Model404FailedRequestResponse](docs/Model404FailedRequestResponse.md)
138
- - [SnapTrade::ModelAssetClass](docs/ModelAssetClass.md)
139
- - [SnapTrade::ModelAssetClassDetails](docs/ModelAssetClassDetails.md)
140
- - [SnapTrade::ModelAssetClassTarget](docs/ModelAssetClassTarget.md)
141
- - [SnapTrade::ModelPortfolio](docs/ModelPortfolio.md)
142
- - [SnapTrade::ModelPortfolioAssetClass](docs/ModelPortfolioAssetClass.md)
143
- - [SnapTrade::ModelPortfolioDetails](docs/ModelPortfolioDetails.md)
144
- - [SnapTrade::ModelPortfolioSecurity](docs/ModelPortfolioSecurity.md)
145
- - [SnapTrade::ModelType](docs/ModelType.md)
146
- - [SnapTrade::MonthlyDividends](docs/MonthlyDividends.md)
147
- - [SnapTrade::NetContributions](docs/NetContributions.md)
148
- - [SnapTrade::NetDividend](docs/NetDividend.md)
149
- - [SnapTrade::OptionChainInner](docs/OptionChainInner.md)
150
- - [SnapTrade::OptionChainInnerChainPerRootInner](docs/OptionChainInnerChainPerRootInner.md)
151
- - [SnapTrade::OptionChainInnerChainPerRootInnerChainPerStrikePriceInner](docs/OptionChainInnerChainPerRootInnerChainPerStrikePriceInner.md)
152
- - [SnapTrade::OptionLeg](docs/OptionLeg.md)
153
- - [SnapTrade::OptionLegAction](docs/OptionLegAction.md)
154
- - [SnapTrade::OptionStrategy](docs/OptionStrategy.md)
155
- - [SnapTrade::OptionStrategyLegsInner](docs/OptionStrategyLegsInner.md)
156
- - [SnapTrade::OptionsGetOptionStrategyRequest](docs/OptionsGetOptionStrategyRequest.md)
157
- - [SnapTrade::OptionsHoldings](docs/OptionsHoldings.md)
158
- - [SnapTrade::OptionsPlaceOptionStrategyRequest](docs/OptionsPlaceOptionStrategyRequest.md)
159
- - [SnapTrade::OptionsPosition](docs/OptionsPosition.md)
160
- - [SnapTrade::OptionsPositionCurrency](docs/OptionsPositionCurrency.md)
161
- - [SnapTrade::OptionsSymbol](docs/OptionsSymbol.md)
162
- - [SnapTrade::OrderStrategyExecuteBodyOrderType](docs/OrderStrategyExecuteBodyOrderType.md)
163
- - [SnapTrade::OrderStrategyExecuteBodyTimeInForce](docs/OrderStrategyExecuteBodyTimeInForce.md)
164
- - [SnapTrade::OrderType](docs/OrderType.md)
165
- - [SnapTrade::PartnerData](docs/PartnerData.md)
166
- - [SnapTrade::PastValue](docs/PastValue.md)
167
- - [SnapTrade::PerformanceCustom](docs/PerformanceCustom.md)
168
- - [SnapTrade::PortfolioGroup](docs/PortfolioGroup.md)
169
- - [SnapTrade::PortfolioGroupInfo](docs/PortfolioGroupInfo.md)
170
- - [SnapTrade::PortfolioGroupPosition](docs/PortfolioGroupPosition.md)
171
- - [SnapTrade::PortfolioGroupSettings](docs/PortfolioGroupSettings.md)
172
- - [SnapTrade::Position](docs/Position.md)
173
- - [SnapTrade::PositionSymbol](docs/PositionSymbol.md)
174
- - [SnapTrade::RedirectTokenandPin](docs/RedirectTokenandPin.md)
175
- - [SnapTrade::SecurityType](docs/SecurityType.md)
176
- - [SnapTrade::SessionEvent](docs/SessionEvent.md)
177
- - [SnapTrade::SessionEventType](docs/SessionEventType.md)
178
- - [SnapTrade::SnapTradeAPIDisclaimerAcceptStatus](docs/SnapTradeAPIDisclaimerAcceptStatus.md)
179
- - [SnapTrade::SnapTradeHoldingsAccount](docs/SnapTradeHoldingsAccount.md)
180
- - [SnapTrade::SnapTradeHoldingsAccountAccountId](docs/SnapTradeHoldingsAccountAccountId.md)
181
- - [SnapTrade::SnapTradeHoldingsTotalValue](docs/SnapTradeHoldingsTotalValue.md)
182
- - [SnapTrade::SnapTradeLoginUserRequestBody](docs/SnapTradeLoginUserRequestBody.md)
183
- - [SnapTrade::SnapTradeRegisterUserRequestBody](docs/SnapTradeRegisterUserRequestBody.md)
184
- - [SnapTrade::State](docs/State.md)
185
- - [SnapTrade::Status](docs/Status.md)
186
- - [SnapTrade::StrategyImpact](docs/StrategyImpact.md)
187
- - [SnapTrade::StrategyImpactLegsInner](docs/StrategyImpactLegsInner.md)
188
- - [SnapTrade::StrategyOrderPlace](docs/StrategyOrderPlace.md)
189
- - [SnapTrade::StrategyOrderPlaceOrdersInner](docs/StrategyOrderPlaceOrdersInner.md)
190
- - [SnapTrade::StrategyOrderPlaceOrdersInnerLegsInner](docs/StrategyOrderPlaceOrdersInnerLegsInner.md)
191
- - [SnapTrade::StrategyOrderRecord](docs/StrategyOrderRecord.md)
192
- - [SnapTrade::StrategyOrderRecordOrderType](docs/StrategyOrderRecordOrderType.md)
193
- - [SnapTrade::StrategyOrderRecordStatus](docs/StrategyOrderRecordStatus.md)
194
- - [SnapTrade::StrategyOrderRecordTimeInForce](docs/StrategyOrderRecordTimeInForce.md)
195
- - [SnapTrade::StrategyQuotes](docs/StrategyQuotes.md)
196
- - [SnapTrade::StrategyQuotesGreek](docs/StrategyQuotesGreek.md)
197
- - [SnapTrade::StrategyType](docs/StrategyType.md)
198
- - [SnapTrade::SubPeriodReturnRate](docs/SubPeriodReturnRate.md)
199
- - [SnapTrade::Symbol](docs/Symbol.md)
200
- - [SnapTrade::SymbolQuery](docs/SymbolQuery.md)
201
- - [SnapTrade::SymbolsQuotesInner](docs/SymbolsQuotesInner.md)
202
- - [SnapTrade::TargetAsset](docs/TargetAsset.md)
203
- - [SnapTrade::TimeInForce](docs/TimeInForce.md)
204
- - [SnapTrade::Trade](docs/Trade.md)
205
- - [SnapTrade::TradeAction](docs/TradeAction.md)
206
- - [SnapTrade::TradeExecutionStatus](docs/TradeExecutionStatus.md)
207
- - [SnapTrade::TradeExecutionStatusAction](docs/TradeExecutionStatusAction.md)
208
- - [SnapTrade::TradeImpact](docs/TradeImpact.md)
209
- - [SnapTrade::TradingCancelUserAccountOrderRequest](docs/TradingCancelUserAccountOrderRequest.md)
210
- - [SnapTrade::TradingPlaceOCOOrderRequest](docs/TradingPlaceOCOOrderRequest.md)
211
- - [SnapTrade::TransactionsStatus](docs/TransactionsStatus.md)
212
- - [SnapTrade::Type](docs/Type.md)
213
- - [SnapTrade::USExchange](docs/USExchange.md)
214
- - [SnapTrade::UnderlyingSymbol](docs/UnderlyingSymbol.md)
215
- - [SnapTrade::UniversalActivity](docs/UniversalActivity.md)
216
- - [SnapTrade::UniversalSymbol](docs/UniversalSymbol.md)
217
- - [SnapTrade::UniversalSymbolTicker](docs/UniversalSymbolTicker.md)
218
- - [SnapTrade::UserErrorLog](docs/UserErrorLog.md)
219
- - [SnapTrade::UserIDandSecret](docs/UserIDandSecret.md)
220
- - [SnapTrade::UserSettings](docs/UserSettings.md)
221
-
1
+ # snaptrade
2
+
3
+ Connect brokerage accounts to your app for live positions and trading
4
+
5
+ For more information, please visit [https://snaptrade.com/](https://snaptrade.com/)
6
+
7
+ ## Installation
8
+
9
+ Add to Gemfile:
10
+
11
+ ```ruby
12
+ gem 'snaptrade', '~> 1.16.1'
13
+ ```
14
+
15
+ ## Getting Started
16
+
17
+ ```ruby
18
+ require 'snaptrade'
19
+
20
+ SnapTrade.client_id = "YOUR_CLIENT_ID"
21
+ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
22
+
23
+ user_id = "John.doe@snaptrade.com"
24
+ user_secret = "USERSECRET123"
25
+ brokerage_authorizations = "917c8734-8470-4a3e-a18f-57c3f2ee6631"
26
+
27
+ begin
28
+ # List all accounts for the user, plus balances, positions, and orders for each account.
29
+ result = SnapTrade::AccountInformation.get_all_user_holdings(
30
+ user_id: user_id,
31
+ user_secret: user_secret,
32
+ brokerage_authorizations: brokerage_authorizations,
33
+ )
34
+ p result
35
+ rescue SnapTrade::ApiError => e
36
+ puts "Exception when calling SnapTrade::AccountInformation.get_all_user_holdings: #{e}"
37
+ end
38
+ ```
39
+
40
+ ## Documentation for API Endpoints
41
+
42
+ All URIs are relative to *https://api.snaptrade.com/api/v1*
43
+
44
+ Class | Method | HTTP request | Description
45
+ ------------ | ------------- | ------------- | -------------
46
+ *SnapTrade::AccountInformationApi* | [**get_all_user_holdings**](docs/AccountInformationApi.md#get_all_user_holdings) | **GET** /holdings | List all accounts for the user, plus balances, positions, and orders for each account.
47
+ *SnapTrade::AccountInformationApi* | [**get_user_account_balance**](docs/AccountInformationApi.md#get_user_account_balance) | **GET** /accounts/{accountId}/balances | List account balances
48
+ *SnapTrade::AccountInformationApi* | [**get_user_account_details**](docs/AccountInformationApi.md#get_user_account_details) | **GET** /accounts/{accountId} | Return details of a specific investment account
49
+ *SnapTrade::AccountInformationApi* | [**get_user_account_orders**](docs/AccountInformationApi.md#get_user_account_orders) | **GET** /accounts/{accountId}/orders | Get history of orders placed in account
50
+ *SnapTrade::AccountInformationApi* | [**get_user_account_positions**](docs/AccountInformationApi.md#get_user_account_positions) | **GET** /accounts/{accountId}/positions | List account positions
51
+ *SnapTrade::AccountInformationApi* | [**get_user_holdings**](docs/AccountInformationApi.md#get_user_holdings) | **GET** /accounts/{accountId}/holdings | List balances, positions and orders for the specified account.
52
+ *SnapTrade::AccountInformationApi* | [**list_user_accounts**](docs/AccountInformationApi.md#list_user_accounts) | **GET** /accounts | List accounts
53
+ *SnapTrade::AccountInformationApi* | [**update_user_account**](docs/AccountInformationApi.md#update_user_account) | **PUT** /accounts/{accountId} | Update details of an investment account
54
+ *SnapTrade::APIStatusApi* | [**check**](docs/APIStatusApi.md#check) | **GET** / | Get API Status
55
+ *SnapTrade::AuthenticationApi* | [**delete_snap_trade_user**](docs/AuthenticationApi.md#delete_snap_trade_user) | **DELETE** /snapTrade/deleteUser | Delete SnapTrade user
56
+ *SnapTrade::AuthenticationApi* | [**get_user_jwt**](docs/AuthenticationApi.md#get_user_jwt) | **GET** /snapTrade/encryptedJWT | Generate encrypted JWT token
57
+ *SnapTrade::AuthenticationApi* | [**list_snap_trade_users**](docs/AuthenticationApi.md#list_snap_trade_users) | **GET** /snapTrade/listUsers | List SnapTrade users
58
+ *SnapTrade::AuthenticationApi* | [**login_snap_trade_user**](docs/AuthenticationApi.md#login_snap_trade_user) | **POST** /snapTrade/login | Login user & generate connection link
59
+ *SnapTrade::AuthenticationApi* | [**register_snap_trade_user**](docs/AuthenticationApi.md#register_snap_trade_user) | **POST** /snapTrade/registerUser | Create SnapTrade user
60
+ *SnapTrade::ConnectionsApi* | [**detail_brokerage_authorization**](docs/ConnectionsApi.md#detail_brokerage_authorization) | **GET** /authorizations/{authorizationId} | Get brokerage authorization details
61
+ *SnapTrade::ConnectionsApi* | [**list_brokerage_authorizations**](docs/ConnectionsApi.md#list_brokerage_authorizations) | **GET** /authorizations | List all brokerage authorizations for the user
62
+ *SnapTrade::ConnectionsApi* | [**remove_brokerage_authorization**](docs/ConnectionsApi.md#remove_brokerage_authorization) | **DELETE** /authorizations/{authorizationId} | Delete brokerage authorization
63
+ *SnapTrade::ConnectionsApi* | [**session_events**](docs/ConnectionsApi.md#session_events) | **GET** /sessionEvents | List all session events for the partner
64
+ *SnapTrade::ErrorLogsApi* | [**list_user_errors**](docs/ErrorLogsApi.md#list_user_errors) | **GET** /snapTrade/listUserErrors | Retrieve error logs on behalf of your SnapTrade users
65
+ *SnapTrade::OptionsApi* | [**get_option_strategy**](docs/OptionsApi.md#get_option_strategy) | **POST** /accounts/{accountId}/optionStrategy | Creates an option strategy object that will be used to place an option strategy order
66
+ *SnapTrade::OptionsApi* | [**get_options_chain**](docs/OptionsApi.md#get_options_chain) | **GET** /accounts/{accountId}/optionsChain | Get the options chain
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
+ *SnapTrade::OptionsApi* | [**list_option_holdings**](docs/OptionsApi.md#list_option_holdings) | **GET** /accounts/{accountId}/options | Get the options holdings in the account
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::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
71
+ *SnapTrade::ReferenceDataApi* | [**get_partner_info**](docs/ReferenceDataApi.md#get_partner_info) | **GET** /snapTrade/partners | Get metadata related to Snaptrade partner
72
+ *SnapTrade::ReferenceDataApi* | [**get_security_types**](docs/ReferenceDataApi.md#get_security_types) | **GET** /securityTypes | List of all security types.
73
+ *SnapTrade::ReferenceDataApi* | [**get_stock_exchanges**](docs/ReferenceDataApi.md#get_stock_exchanges) | **GET** /exchanges | List exchanges
74
+ *SnapTrade::ReferenceDataApi* | [**get_symbols**](docs/ReferenceDataApi.md#get_symbols) | **POST** /symbols | Search for symbols
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
76
+ *SnapTrade::ReferenceDataApi* | [**list_all_brokerage_authorization_type**](docs/ReferenceDataApi.md#list_all_brokerage_authorization_type) | **GET** /brokerageAuthorizationTypes | List of all brokerage authorization types
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
81
+ *SnapTrade::TradingApi* | [**cancel_user_account_order**](docs/TradingApi.md#cancel_user_account_order) | **POST** /accounts/{accountId}/orders/cancel | Cancel open order in account
82
+ *SnapTrade::TradingApi* | [**get_order_impact**](docs/TradingApi.md#get_order_impact) | **POST** /trade/impact | Check impact of trades on account.
83
+ *SnapTrade::TradingApi* | [**get_user_account_quotes**](docs/TradingApi.md#get_user_account_quotes) | **GET** /accounts/{accountId}/quotes | Get symbol quotes
84
+ *SnapTrade::TradingApi* | [**place_force_order**](docs/TradingApi.md#place_force_order) | **POST** /trade/place | Place a trade with NO validation.
85
+ *SnapTrade::TradingApi* | [**place_oco_order**](docs/TradingApi.md#place_oco_order) | **POST** /trade/oco | Place a OCO (One Cancels Other) order
86
+ *SnapTrade::TradingApi* | [**place_order**](docs/TradingApi.md#place_order) | **POST** /trade/{tradeId} | Place order
87
+ *SnapTrade::TransactionsAndReportingApi* | [**get_activities**](docs/TransactionsAndReportingApi.md#get_activities) | **GET** /activities | Get transaction history for a user
88
+ *SnapTrade::TransactionsAndReportingApi* | [**get_reporting_custom_range**](docs/TransactionsAndReportingApi.md#get_reporting_custom_range) | **GET** /performance/custom | Get performance information for a specific timeframe
89
+
90
+
91
+ ## Documentation for Models
92
+
93
+ - [SnapTrade::Account](docs/Account.md)
94
+ - [SnapTrade::AccountHoldings](docs/AccountHoldings.md)
95
+ - [SnapTrade::AccountHoldingsAccount](docs/AccountHoldingsAccount.md)
96
+ - [SnapTrade::AccountOrderRecord](docs/AccountOrderRecord.md)
97
+ - [SnapTrade::AccountOrderRecordStatus](docs/AccountOrderRecordStatus.md)
98
+ - [SnapTrade::AccountSimple](docs/AccountSimple.md)
99
+ - [SnapTrade::AccountSyncStatus](docs/AccountSyncStatus.md)
100
+ - [SnapTrade::Action](docs/Action.md)
101
+ - [SnapTrade::AuthType](docs/AuthType.md)
102
+ - [SnapTrade::AuthenticationLoginSnapTradeUser200Response](docs/AuthenticationLoginSnapTradeUser200Response.md)
103
+ - [SnapTrade::Balance](docs/Balance.md)
104
+ - [SnapTrade::Brokerage](docs/Brokerage.md)
105
+ - [SnapTrade::BrokerageAuthorization](docs/BrokerageAuthorization.md)
106
+ - [SnapTrade::BrokerageAuthorizationType](docs/BrokerageAuthorizationType.md)
107
+ - [SnapTrade::BrokerageAuthorizationTypeReadOnly](docs/BrokerageAuthorizationTypeReadOnly.md)
108
+ - [SnapTrade::BrokerageAuthorizationTypeReadOnlyBrokerage](docs/BrokerageAuthorizationTypeReadOnlyBrokerage.md)
109
+ - [SnapTrade::BrokerageAuthorizationTypeReadOnlyType](docs/BrokerageAuthorizationTypeReadOnlyType.md)
110
+ - [SnapTrade::BrokerageAuthorizationTypeType](docs/BrokerageAuthorizationTypeType.md)
111
+ - [SnapTrade::BrokerageSymbol](docs/BrokerageSymbol.md)
112
+ - [SnapTrade::BrokerageSymbolOptionSymbol](docs/BrokerageSymbolOptionSymbol.md)
113
+ - [SnapTrade::BrokerageSymbolSymbol](docs/BrokerageSymbolSymbol.md)
114
+ - [SnapTrade::BrokerageType](docs/BrokerageType.md)
115
+ - [SnapTrade::CalculatedTrade](docs/CalculatedTrade.md)
116
+ - [SnapTrade::CashRestriction](docs/CashRestriction.md)
117
+ - [SnapTrade::ConnectionType](docs/ConnectionType.md)
118
+ - [SnapTrade::ConnectionsSessionEvents200ResponseInner](docs/ConnectionsSessionEvents200ResponseInner.md)
119
+ - [SnapTrade::Currency](docs/Currency.md)
120
+ - [SnapTrade::DeleteUserResponse](docs/DeleteUserResponse.md)
121
+ - [SnapTrade::DividendAtDate](docs/DividendAtDate.md)
122
+ - [SnapTrade::EncryptedResponse](docs/EncryptedResponse.md)
123
+ - [SnapTrade::EncryptedResponseEncryptedMessageData](docs/EncryptedResponseEncryptedMessageData.md)
124
+ - [SnapTrade::Exchange](docs/Exchange.md)
125
+ - [SnapTrade::ExchangeRatePairs](docs/ExchangeRatePairs.md)
126
+ - [SnapTrade::ExcludedAsset](docs/ExcludedAsset.md)
127
+ - [SnapTrade::JWT](docs/JWT.md)
128
+ - [SnapTrade::LoginRedirectURI](docs/LoginRedirectURI.md)
129
+ - [SnapTrade::ManualTrade](docs/ManualTrade.md)
130
+ - [SnapTrade::ManualTradeAndImpact](docs/ManualTradeAndImpact.md)
131
+ - [SnapTrade::ManualTradeBalance](docs/ManualTradeBalance.md)
132
+ - [SnapTrade::ManualTradeForm](docs/ManualTradeForm.md)
133
+ - [SnapTrade::ManualTradeSymbol](docs/ManualTradeSymbol.md)
134
+ - [SnapTrade::Model400FailedRequestResponse](docs/Model400FailedRequestResponse.md)
135
+ - [SnapTrade::Model401FailedRequestResponse](docs/Model401FailedRequestResponse.md)
136
+ - [SnapTrade::Model403FailedRequestResponse](docs/Model403FailedRequestResponse.md)
137
+ - [SnapTrade::Model404FailedRequestResponse](docs/Model404FailedRequestResponse.md)
138
+ - [SnapTrade::ModelAssetClass](docs/ModelAssetClass.md)
139
+ - [SnapTrade::ModelAssetClassDetails](docs/ModelAssetClassDetails.md)
140
+ - [SnapTrade::ModelAssetClassTarget](docs/ModelAssetClassTarget.md)
141
+ - [SnapTrade::ModelPortfolio](docs/ModelPortfolio.md)
142
+ - [SnapTrade::ModelPortfolioAssetClass](docs/ModelPortfolioAssetClass.md)
143
+ - [SnapTrade::ModelPortfolioDetails](docs/ModelPortfolioDetails.md)
144
+ - [SnapTrade::ModelPortfolioSecurity](docs/ModelPortfolioSecurity.md)
145
+ - [SnapTrade::ModelType](docs/ModelType.md)
146
+ - [SnapTrade::MonthlyDividends](docs/MonthlyDividends.md)
147
+ - [SnapTrade::NetContributions](docs/NetContributions.md)
148
+ - [SnapTrade::NetDividend](docs/NetDividend.md)
149
+ - [SnapTrade::OptionChainInner](docs/OptionChainInner.md)
150
+ - [SnapTrade::OptionChainInnerChainPerRootInner](docs/OptionChainInnerChainPerRootInner.md)
151
+ - [SnapTrade::OptionChainInnerChainPerRootInnerChainPerStrikePriceInner](docs/OptionChainInnerChainPerRootInnerChainPerStrikePriceInner.md)
152
+ - [SnapTrade::OptionLeg](docs/OptionLeg.md)
153
+ - [SnapTrade::OptionLegAction](docs/OptionLegAction.md)
154
+ - [SnapTrade::OptionStrategy](docs/OptionStrategy.md)
155
+ - [SnapTrade::OptionStrategyLegsInner](docs/OptionStrategyLegsInner.md)
156
+ - [SnapTrade::OptionsGetOptionStrategyRequest](docs/OptionsGetOptionStrategyRequest.md)
157
+ - [SnapTrade::OptionsHoldings](docs/OptionsHoldings.md)
158
+ - [SnapTrade::OptionsPlaceOptionStrategyRequest](docs/OptionsPlaceOptionStrategyRequest.md)
159
+ - [SnapTrade::OptionsPosition](docs/OptionsPosition.md)
160
+ - [SnapTrade::OptionsPositionCurrency](docs/OptionsPositionCurrency.md)
161
+ - [SnapTrade::OptionsSymbol](docs/OptionsSymbol.md)
162
+ - [SnapTrade::OrderStrategyExecuteBodyOrderType](docs/OrderStrategyExecuteBodyOrderType.md)
163
+ - [SnapTrade::OrderStrategyExecuteBodyTimeInForce](docs/OrderStrategyExecuteBodyTimeInForce.md)
164
+ - [SnapTrade::OrderType](docs/OrderType.md)
165
+ - [SnapTrade::PartnerData](docs/PartnerData.md)
166
+ - [SnapTrade::PastValue](docs/PastValue.md)
167
+ - [SnapTrade::PerformanceCustom](docs/PerformanceCustom.md)
168
+ - [SnapTrade::PortfolioGroup](docs/PortfolioGroup.md)
169
+ - [SnapTrade::PortfolioGroupInfo](docs/PortfolioGroupInfo.md)
170
+ - [SnapTrade::PortfolioGroupPosition](docs/PortfolioGroupPosition.md)
171
+ - [SnapTrade::PortfolioGroupSettings](docs/PortfolioGroupSettings.md)
172
+ - [SnapTrade::Position](docs/Position.md)
173
+ - [SnapTrade::PositionSymbol](docs/PositionSymbol.md)
174
+ - [SnapTrade::RedirectTokenandPin](docs/RedirectTokenandPin.md)
175
+ - [SnapTrade::SecurityType](docs/SecurityType.md)
176
+ - [SnapTrade::SessionEvent](docs/SessionEvent.md)
177
+ - [SnapTrade::SessionEventType](docs/SessionEventType.md)
178
+ - [SnapTrade::SnapTradeAPIDisclaimerAcceptStatus](docs/SnapTradeAPIDisclaimerAcceptStatus.md)
179
+ - [SnapTrade::SnapTradeHoldingsAccount](docs/SnapTradeHoldingsAccount.md)
180
+ - [SnapTrade::SnapTradeHoldingsAccountAccountId](docs/SnapTradeHoldingsAccountAccountId.md)
181
+ - [SnapTrade::SnapTradeHoldingsTotalValue](docs/SnapTradeHoldingsTotalValue.md)
182
+ - [SnapTrade::SnapTradeLoginUserRequestBody](docs/SnapTradeLoginUserRequestBody.md)
183
+ - [SnapTrade::SnapTradeRegisterUserRequestBody](docs/SnapTradeRegisterUserRequestBody.md)
184
+ - [SnapTrade::State](docs/State.md)
185
+ - [SnapTrade::Status](docs/Status.md)
186
+ - [SnapTrade::StrategyImpact](docs/StrategyImpact.md)
187
+ - [SnapTrade::StrategyImpactLegsInner](docs/StrategyImpactLegsInner.md)
188
+ - [SnapTrade::StrategyOrderPlace](docs/StrategyOrderPlace.md)
189
+ - [SnapTrade::StrategyOrderPlaceOrdersInner](docs/StrategyOrderPlaceOrdersInner.md)
190
+ - [SnapTrade::StrategyOrderPlaceOrdersInnerLegsInner](docs/StrategyOrderPlaceOrdersInnerLegsInner.md)
191
+ - [SnapTrade::StrategyOrderRecord](docs/StrategyOrderRecord.md)
192
+ - [SnapTrade::StrategyOrderRecordOrderType](docs/StrategyOrderRecordOrderType.md)
193
+ - [SnapTrade::StrategyOrderRecordStatus](docs/StrategyOrderRecordStatus.md)
194
+ - [SnapTrade::StrategyOrderRecordTimeInForce](docs/StrategyOrderRecordTimeInForce.md)
195
+ - [SnapTrade::StrategyQuotes](docs/StrategyQuotes.md)
196
+ - [SnapTrade::StrategyQuotesGreek](docs/StrategyQuotesGreek.md)
197
+ - [SnapTrade::StrategyType](docs/StrategyType.md)
198
+ - [SnapTrade::SubPeriodReturnRate](docs/SubPeriodReturnRate.md)
199
+ - [SnapTrade::Symbol](docs/Symbol.md)
200
+ - [SnapTrade::SymbolQuery](docs/SymbolQuery.md)
201
+ - [SnapTrade::SymbolsQuotesInner](docs/SymbolsQuotesInner.md)
202
+ - [SnapTrade::TargetAsset](docs/TargetAsset.md)
203
+ - [SnapTrade::TimeInForce](docs/TimeInForce.md)
204
+ - [SnapTrade::Trade](docs/Trade.md)
205
+ - [SnapTrade::TradeAction](docs/TradeAction.md)
206
+ - [SnapTrade::TradeExecutionStatus](docs/TradeExecutionStatus.md)
207
+ - [SnapTrade::TradeExecutionStatusAction](docs/TradeExecutionStatusAction.md)
208
+ - [SnapTrade::TradeImpact](docs/TradeImpact.md)
209
+ - [SnapTrade::TradingCancelUserAccountOrderRequest](docs/TradingCancelUserAccountOrderRequest.md)
210
+ - [SnapTrade::TradingPlaceOCOOrderRequest](docs/TradingPlaceOCOOrderRequest.md)
211
+ - [SnapTrade::TransactionsStatus](docs/TransactionsStatus.md)
212
+ - [SnapTrade::Type](docs/Type.md)
213
+ - [SnapTrade::USExchange](docs/USExchange.md)
214
+ - [SnapTrade::UnderlyingSymbol](docs/UnderlyingSymbol.md)
215
+ - [SnapTrade::UniversalActivity](docs/UniversalActivity.md)
216
+ - [SnapTrade::UniversalSymbol](docs/UniversalSymbol.md)
217
+ - [SnapTrade::UniversalSymbolTicker](docs/UniversalSymbolTicker.md)
218
+ - [SnapTrade::UserErrorLog](docs/UserErrorLog.md)
219
+ - [SnapTrade::UserIDandSecret](docs/UserIDandSecret.md)
220
+ - [SnapTrade::UserSettings](docs/UserSettings.md)
221
+
data/docs/APIStatusApi.md CHANGED
@@ -17,7 +17,7 @@ Check whether the API is operational and verify timestamps.
17
17
  ```ruby
18
18
  require 'snaptrade'
19
19
 
20
- SnapTrade.client_id = "YOUR_CLIENT_ID"
20
+ SnapTrade.client_id = "YOUR_CLIENT_ID"
21
21
  SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
22
22
 
23
23
 
data/docs/AccountInformationApi.md CHANGED
@@ -22,7 +22,7 @@ List all accounts for the user, plus balances, positions, and orders for each ac
22
22
  ```ruby
23
23
  require 'snaptrade'
24
24
 
25
- SnapTrade.client_id = "YOUR_CLIENT_ID"
25
+ SnapTrade.client_id = "YOUR_CLIENT_ID"
26
26
  SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
27
27
 
28
28
  user_id = "John.doe@snaptrade.com"
@@ -87,7 +87,7 @@ List account balances
87
87
  ```ruby
88
88
  require 'snaptrade'
89
89
 
90
- SnapTrade.client_id = "YOUR_CLIENT_ID"
90
+ SnapTrade.client_id = "YOUR_CLIENT_ID"
91
91
  SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
92
92
 
93
93
  user_id = "John.doe@snaptrade.com"
@@ -152,7 +152,7 @@ Return details of a specific investment account
152
152
  ```ruby
153
153
  require 'snaptrade'
154
154
 
155
- SnapTrade.client_id = "YOUR_CLIENT_ID"
155
+ SnapTrade.client_id = "YOUR_CLIENT_ID"
156
156
  SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
157
157
 
158
158
  user_id = "John.doe@snaptrade.com"
@@ -217,7 +217,7 @@ Get history of orders placed in account
217
217
  ```ruby
218
218
  require 'snaptrade'
219
219
 
220
- SnapTrade.client_id = "YOUR_CLIENT_ID"
220
+ SnapTrade.client_id = "YOUR_CLIENT_ID"
221
221
  SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
222
222
 
223
223
  user_id = "John.doe@snaptrade.com"
@@ -287,7 +287,7 @@ List account positions
287
287
  ```ruby
288
288
  require 'snaptrade'
289
289
 
290
- SnapTrade.client_id = "YOUR_CLIENT_ID"
290
+ SnapTrade.client_id = "YOUR_CLIENT_ID"
291
291
  SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
292
292
 
293
293
  user_id = "John.doe@snaptrade.com"
@@ -352,7 +352,7 @@ List balances, positions and orders for the specified account.
352
352
  ```ruby
353
353
  require 'snaptrade'
354
354
 
355
- SnapTrade.client_id = "YOUR_CLIENT_ID"
355
+ SnapTrade.client_id = "YOUR_CLIENT_ID"
356
356
  SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
357
357
 
358
358
  account_id = "917c8734-8470-4a3e-a18f-57c3f2ee6631"
@@ -417,7 +417,7 @@ List accounts
417
417
  ```ruby
418
418
  require 'snaptrade'
419
419
 
420
- SnapTrade.client_id = "YOUR_CLIENT_ID"
420
+ SnapTrade.client_id = "YOUR_CLIENT_ID"
421
421
  SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
422
422
 
423
423
  user_id = "John.doe@snaptrade.com"
@@ -477,7 +477,7 @@ Update details of an investment account
477
477
  ```ruby
478
478
  require 'snaptrade'
479
479
 
480
- SnapTrade.client_id = "YOUR_CLIENT_ID"
480
+ SnapTrade.client_id = "YOUR_CLIENT_ID"
481
481
  SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
482
482
 
483
483
  user_id = "John.doe@snaptrade.com"