snaptrade 1.16.1 → 1.16.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +16 -8
- data/README.md +222 -221
- data/docs/APIStatusApi.md +1 -1
- data/docs/AccountInformationApi.md +8 -8
- data/docs/AuthenticationApi.md +5 -5
- data/docs/BrokerageSymbolOptionSymbol.md +7 -5
- data/docs/ConnectionsApi.md +4 -4
- data/docs/ErrorLogsApi.md +1 -1
- data/docs/MonthlyDividends.md +20 -20
- data/docs/NetContributions.md +22 -22
- data/docs/OptionType.md +15 -0
- data/docs/OptionsApi.md +5 -5
- data/docs/OptionsSymbol.md +7 -5
- data/docs/PastValue.md +22 -22
- data/docs/ReferenceDataApi.md +11 -11
- data/docs/SubPeriodReturnRate.md +22 -22
- data/docs/TradingApi.md +6 -6
- data/docs/TransactionsAndReportingApi.md +2 -2
- data/docs/TransactionsStatus.md +20 -20
- data/lib/snaptrade/api_client_custom.rb +32 -32
- data/lib/snaptrade/configuration.rb +7 -0
- data/lib/snaptrade/models/brokerage_symbol_option_symbol.rb +40 -1
- data/lib/snaptrade/models/option_type.rb +38 -0
- data/lib/snaptrade/models/options_symbol.rb +40 -1
- data/lib/snaptrade/models/snap_trade_holdings_total_value.rb +227 -227
- data/lib/snaptrade/version.rb +13 -13
- data/lib/snaptrade.rb +1 -0
- data/spec/getting_started_spec.rb +114 -108
- data/spec/models/brokerage_symbol_option_symbol_spec.rb +6 -0
- data/spec/models/option_type_spec.rb +24 -0
- data/spec/models/options_symbol_spec.rb +6 -0
- metadata +119 -115
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 637d8022e613a393d86427f19b86a11415845c03179c18707553e7b2c00b899f
|
4
|
+
data.tar.gz: 1543318937c91af211f55b8041f64d75e38cf9f7efec8eda669b1986fc83fb34
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: eeedca094dd77a08b22da9b457f409a170920f84176fbc6e6e7077f479756b6db858dfd65fe2ebc28f0110f4dd157478db4448293a5fdf97ff1b99183b8b8398
|
7
|
+
data.tar.gz: 416974dcc5c5128d9622acf8d50e5277d0f324178ec8e0bb1d808cf5ce58c4b6e1294bdcaf4c465ccf8ef9ea0836fe995361a86d9f1b7cb94bb581e1754f21cd
|
data/Gemfile.lock
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
snaptrade (1.16.
|
4
|
+
snaptrade (1.16.2)
|
5
5
|
faraday (>= 1.0.1, < 3.0)
|
6
6
|
faraday-multipart (~> 1.0, >= 1.0.4)
|
7
7
|
|
@@ -9,21 +9,24 @@ GEM
|
|
9
9
|
remote: https://rubygems.org/
|
10
10
|
specs:
|
11
11
|
ast (2.4.2)
|
12
|
+
base64 (0.1.1)
|
12
13
|
byebug (11.1.3)
|
13
14
|
coderay (1.1.3)
|
14
15
|
debug (1.8.0)
|
15
16
|
irb (>= 1.5.0)
|
16
17
|
reline (>= 0.3.1)
|
17
18
|
diff-lcs (1.5.0)
|
18
|
-
faraday (2.7.
|
19
|
+
faraday (2.7.11)
|
20
|
+
base64
|
19
21
|
faraday-net_http (>= 2.0, < 3.1)
|
20
22
|
ruby2_keywords (>= 0.0.4)
|
21
23
|
faraday-multipart (1.0.4)
|
22
24
|
multipart-post (~> 2)
|
23
25
|
faraday-net_http (3.0.2)
|
24
26
|
io-console (0.6.0)
|
25
|
-
irb (1.
|
26
|
-
|
27
|
+
irb (1.8.1)
|
28
|
+
rdoc
|
29
|
+
reline (>= 0.3.8)
|
27
30
|
method_source (1.0.0)
|
28
31
|
multipart-post (2.3.0)
|
29
32
|
parallel (1.23.0)
|
@@ -36,13 +39,17 @@ GEM
|
|
36
39
|
pry-byebug (3.10.1)
|
37
40
|
byebug (~> 11.0)
|
38
41
|
pry (>= 0.13, < 0.15)
|
42
|
+
psych (5.1.0)
|
43
|
+
stringio
|
39
44
|
racc (1.7.1)
|
40
45
|
rainbow (3.1.1)
|
41
46
|
rake (13.0.6)
|
47
|
+
rdoc (6.5.0)
|
48
|
+
psych (>= 4.0.0)
|
42
49
|
regexp_parser (2.8.1)
|
43
|
-
reline (0.3.
|
50
|
+
reline (0.3.8)
|
44
51
|
io-console (~> 0.5)
|
45
|
-
rexml (3.2.
|
52
|
+
rexml (3.2.6)
|
46
53
|
rspec (3.12.0)
|
47
54
|
rspec-core (~> 3.12.0)
|
48
55
|
rspec-expectations (~> 3.12.0)
|
@@ -69,10 +76,11 @@ GEM
|
|
69
76
|
parser (>= 3.2.1.0)
|
70
77
|
ruby-progressbar (1.13.0)
|
71
78
|
ruby2_keywords (0.0.5)
|
79
|
+
stringio (3.0.8)
|
72
80
|
unicode-display_width (2.4.2)
|
73
81
|
|
74
82
|
PLATFORMS
|
75
|
-
|
83
|
+
arm64-darwin-22
|
76
84
|
|
77
85
|
DEPENDENCIES
|
78
86
|
debug (~> 1.8)
|
@@ -83,4 +91,4 @@ DEPENDENCIES
|
|
83
91
|
snaptrade!
|
84
92
|
|
85
93
|
BUNDLED WITH
|
86
|
-
2.4.
|
94
|
+
2.4.19
|
data/README.md
CHANGED
@@ -1,221 +1,222 @@
|
|
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.
|
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::
|
157
|
-
- [SnapTrade::
|
158
|
-
- [SnapTrade::
|
159
|
-
- [SnapTrade::
|
160
|
-
- [SnapTrade::
|
161
|
-
- [SnapTrade::
|
162
|
-
- [SnapTrade::
|
163
|
-
- [SnapTrade::
|
164
|
-
- [SnapTrade::
|
165
|
-
- [SnapTrade::
|
166
|
-
- [SnapTrade::
|
167
|
-
- [SnapTrade::
|
168
|
-
- [SnapTrade::
|
169
|
-
- [SnapTrade::
|
170
|
-
- [SnapTrade::
|
171
|
-
- [SnapTrade::
|
172
|
-
- [SnapTrade::
|
173
|
-
- [SnapTrade::
|
174
|
-
- [SnapTrade::
|
175
|
-
- [SnapTrade::
|
176
|
-
- [SnapTrade::
|
177
|
-
- [SnapTrade::
|
178
|
-
- [SnapTrade::
|
179
|
-
- [SnapTrade::
|
180
|
-
- [SnapTrade::
|
181
|
-
- [SnapTrade::
|
182
|
-
- [SnapTrade::
|
183
|
-
- [SnapTrade::
|
184
|
-
- [SnapTrade::
|
185
|
-
- [SnapTrade::
|
186
|
-
- [SnapTrade::
|
187
|
-
- [SnapTrade::
|
188
|
-
- [SnapTrade::
|
189
|
-
- [SnapTrade::
|
190
|
-
- [SnapTrade::
|
191
|
-
- [SnapTrade::
|
192
|
-
- [SnapTrade::
|
193
|
-
- [SnapTrade::
|
194
|
-
- [SnapTrade::
|
195
|
-
- [SnapTrade::
|
196
|
-
- [SnapTrade::
|
197
|
-
- [SnapTrade::
|
198
|
-
- [SnapTrade::
|
199
|
-
- [SnapTrade::
|
200
|
-
- [SnapTrade::
|
201
|
-
- [SnapTrade::
|
202
|
-
- [SnapTrade::
|
203
|
-
- [SnapTrade::
|
204
|
-
- [SnapTrade::
|
205
|
-
- [SnapTrade::
|
206
|
-
- [SnapTrade::
|
207
|
-
- [SnapTrade::
|
208
|
-
- [SnapTrade::
|
209
|
-
- [SnapTrade::
|
210
|
-
- [SnapTrade::
|
211
|
-
- [SnapTrade::
|
212
|
-
- [SnapTrade::
|
213
|
-
- [SnapTrade::
|
214
|
-
- [SnapTrade::
|
215
|
-
- [SnapTrade::
|
216
|
-
- [SnapTrade::
|
217
|
-
- [SnapTrade::
|
218
|
-
- [SnapTrade::
|
219
|
-
- [SnapTrade::
|
220
|
-
- [SnapTrade::
|
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.3'
|
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::OptionType](docs/OptionType.md)
|
157
|
+
- [SnapTrade::OptionsGetOptionStrategyRequest](docs/OptionsGetOptionStrategyRequest.md)
|
158
|
+
- [SnapTrade::OptionsHoldings](docs/OptionsHoldings.md)
|
159
|
+
- [SnapTrade::OptionsPlaceOptionStrategyRequest](docs/OptionsPlaceOptionStrategyRequest.md)
|
160
|
+
- [SnapTrade::OptionsPosition](docs/OptionsPosition.md)
|
161
|
+
- [SnapTrade::OptionsPositionCurrency](docs/OptionsPositionCurrency.md)
|
162
|
+
- [SnapTrade::OptionsSymbol](docs/OptionsSymbol.md)
|
163
|
+
- [SnapTrade::OrderStrategyExecuteBodyOrderType](docs/OrderStrategyExecuteBodyOrderType.md)
|
164
|
+
- [SnapTrade::OrderStrategyExecuteBodyTimeInForce](docs/OrderStrategyExecuteBodyTimeInForce.md)
|
165
|
+
- [SnapTrade::OrderType](docs/OrderType.md)
|
166
|
+
- [SnapTrade::PartnerData](docs/PartnerData.md)
|
167
|
+
- [SnapTrade::PastValue](docs/PastValue.md)
|
168
|
+
- [SnapTrade::PerformanceCustom](docs/PerformanceCustom.md)
|
169
|
+
- [SnapTrade::PortfolioGroup](docs/PortfolioGroup.md)
|
170
|
+
- [SnapTrade::PortfolioGroupInfo](docs/PortfolioGroupInfo.md)
|
171
|
+
- [SnapTrade::PortfolioGroupPosition](docs/PortfolioGroupPosition.md)
|
172
|
+
- [SnapTrade::PortfolioGroupSettings](docs/PortfolioGroupSettings.md)
|
173
|
+
- [SnapTrade::Position](docs/Position.md)
|
174
|
+
- [SnapTrade::PositionSymbol](docs/PositionSymbol.md)
|
175
|
+
- [SnapTrade::RedirectTokenandPin](docs/RedirectTokenandPin.md)
|
176
|
+
- [SnapTrade::SecurityType](docs/SecurityType.md)
|
177
|
+
- [SnapTrade::SessionEvent](docs/SessionEvent.md)
|
178
|
+
- [SnapTrade::SessionEventType](docs/SessionEventType.md)
|
179
|
+
- [SnapTrade::SnapTradeAPIDisclaimerAcceptStatus](docs/SnapTradeAPIDisclaimerAcceptStatus.md)
|
180
|
+
- [SnapTrade::SnapTradeHoldingsAccount](docs/SnapTradeHoldingsAccount.md)
|
181
|
+
- [SnapTrade::SnapTradeHoldingsAccountAccountId](docs/SnapTradeHoldingsAccountAccountId.md)
|
182
|
+
- [SnapTrade::SnapTradeHoldingsTotalValue](docs/SnapTradeHoldingsTotalValue.md)
|
183
|
+
- [SnapTrade::SnapTradeLoginUserRequestBody](docs/SnapTradeLoginUserRequestBody.md)
|
184
|
+
- [SnapTrade::SnapTradeRegisterUserRequestBody](docs/SnapTradeRegisterUserRequestBody.md)
|
185
|
+
- [SnapTrade::State](docs/State.md)
|
186
|
+
- [SnapTrade::Status](docs/Status.md)
|
187
|
+
- [SnapTrade::StrategyImpact](docs/StrategyImpact.md)
|
188
|
+
- [SnapTrade::StrategyImpactLegsInner](docs/StrategyImpactLegsInner.md)
|
189
|
+
- [SnapTrade::StrategyOrderPlace](docs/StrategyOrderPlace.md)
|
190
|
+
- [SnapTrade::StrategyOrderPlaceOrdersInner](docs/StrategyOrderPlaceOrdersInner.md)
|
191
|
+
- [SnapTrade::StrategyOrderPlaceOrdersInnerLegsInner](docs/StrategyOrderPlaceOrdersInnerLegsInner.md)
|
192
|
+
- [SnapTrade::StrategyOrderRecord](docs/StrategyOrderRecord.md)
|
193
|
+
- [SnapTrade::StrategyOrderRecordOrderType](docs/StrategyOrderRecordOrderType.md)
|
194
|
+
- [SnapTrade::StrategyOrderRecordStatus](docs/StrategyOrderRecordStatus.md)
|
195
|
+
- [SnapTrade::StrategyOrderRecordTimeInForce](docs/StrategyOrderRecordTimeInForce.md)
|
196
|
+
- [SnapTrade::StrategyQuotes](docs/StrategyQuotes.md)
|
197
|
+
- [SnapTrade::StrategyQuotesGreek](docs/StrategyQuotesGreek.md)
|
198
|
+
- [SnapTrade::StrategyType](docs/StrategyType.md)
|
199
|
+
- [SnapTrade::SubPeriodReturnRate](docs/SubPeriodReturnRate.md)
|
200
|
+
- [SnapTrade::Symbol](docs/Symbol.md)
|
201
|
+
- [SnapTrade::SymbolQuery](docs/SymbolQuery.md)
|
202
|
+
- [SnapTrade::SymbolsQuotesInner](docs/SymbolsQuotesInner.md)
|
203
|
+
- [SnapTrade::TargetAsset](docs/TargetAsset.md)
|
204
|
+
- [SnapTrade::TimeInForce](docs/TimeInForce.md)
|
205
|
+
- [SnapTrade::Trade](docs/Trade.md)
|
206
|
+
- [SnapTrade::TradeAction](docs/TradeAction.md)
|
207
|
+
- [SnapTrade::TradeExecutionStatus](docs/TradeExecutionStatus.md)
|
208
|
+
- [SnapTrade::TradeExecutionStatusAction](docs/TradeExecutionStatusAction.md)
|
209
|
+
- [SnapTrade::TradeImpact](docs/TradeImpact.md)
|
210
|
+
- [SnapTrade::TradingCancelUserAccountOrderRequest](docs/TradingCancelUserAccountOrderRequest.md)
|
211
|
+
- [SnapTrade::TradingPlaceOCOOrderRequest](docs/TradingPlaceOCOOrderRequest.md)
|
212
|
+
- [SnapTrade::TransactionsStatus](docs/TransactionsStatus.md)
|
213
|
+
- [SnapTrade::Type](docs/Type.md)
|
214
|
+
- [SnapTrade::USExchange](docs/USExchange.md)
|
215
|
+
- [SnapTrade::UnderlyingSymbol](docs/UnderlyingSymbol.md)
|
216
|
+
- [SnapTrade::UniversalActivity](docs/UniversalActivity.md)
|
217
|
+
- [SnapTrade::UniversalSymbol](docs/UniversalSymbol.md)
|
218
|
+
- [SnapTrade::UniversalSymbolTicker](docs/UniversalSymbolTicker.md)
|
219
|
+
- [SnapTrade::UserErrorLog](docs/UserErrorLog.md)
|
220
|
+
- [SnapTrade::UserIDandSecret](docs/UserIDandSecret.md)
|
221
|
+
- [SnapTrade::UserSettings](docs/UserSettings.md)
|
222
|
+
|
data/docs/APIStatusApi.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"
|