snaptrade 1.16.3 → 1.17.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +5 -5
- data/docs/AccountHoldings.md +2 -2
- data/docs/AccountHoldingsAccount.md +2 -2
- data/docs/AccountInformationApi.md +64 -64
- data/docs/AccountOrderRecord.md +2 -2
- data/docs/AuthenticationApi.md +32 -32
- data/docs/Balance.md +1 -1
- data/docs/Brokerage.md +1 -1
- data/docs/BrokerageAuthorization.md +1 -1
- data/docs/BrokerageAuthorizationTypeReadOnly.md +1 -1
- data/docs/BrokerageSymbol.md +1 -1
- data/docs/BrokerageSymbolOptionSymbol.md +1 -1
- data/docs/BrokerageSymbolSymbol.md +7 -7
- data/docs/ConnectionsApi.md +30 -30
- data/docs/EncryptedResponse.md +1 -1
- data/docs/ErrorLogsApi.md +6 -6
- data/docs/ExchangeRatePairs.md +2 -2
- data/docs/ExcludedAsset.md +1 -1
- data/docs/ManualTrade.md +1 -1
- data/docs/ManualTradeAndImpact.md +2 -2
- data/docs/ManualTradeBalance.md +2 -2
- data/docs/ManualTradeSymbol.md +1 -1
- data/docs/ModelAssetClassDetails.md +1 -1
- data/docs/ModelAssetClassTarget.md +1 -1
- data/docs/ModelPortfolioAssetClass.md +1 -1
- data/docs/ModelPortfolioDetails.md +1 -1
- data/docs/ModelPortfolioSecurity.md +1 -1
- data/docs/NetDividend.md +1 -1
- data/docs/OptionStrategy.md +1 -1
- data/docs/OptionsApi.md +58 -58
- data/docs/OptionsHoldings.md +2 -2
- data/docs/OptionsPosition.md +1 -1
- data/docs/OptionsSymbol.md +1 -1
- data/docs/PerformanceCustom.md +1 -1
- data/docs/PortfolioGroupInfo.md +1 -1
- data/docs/PortfolioGroupPosition.md +1 -1
- data/docs/PortfolioGroupSettings.md +1 -1
- data/docs/Position.md +1 -1
- data/docs/PositionSymbol.md +1 -1
- data/docs/ReferenceDataApi.md +28 -28
- data/docs/SnapTradeHoldingsAccount.md +1 -1
- data/docs/StrategyOrderRecord.md +1 -1
- data/docs/StrategyQuotes.md +2 -2
- data/docs/Symbol.md +3 -3
- data/docs/SymbolsQuotesInner.md +1 -1
- data/docs/TargetAsset.md +1 -1
- data/docs/Trade.md +3 -3
- data/docs/TradeExecutionStatus.md +3 -3
- data/docs/TradeImpact.md +2 -2
- data/docs/TradingApi.md +84 -84
- data/docs/TransactionsAndReportingApi.md +32 -32
- data/docs/UnderlyingSymbol.md +3 -3
- data/docs/UniversalActivity.md +5 -5
- data/docs/UniversalSymbol.md +7 -7
- data/docs/UniversalSymbolTicker.md +3 -3
- data/docs/UserSettings.md +1 -1
- data/header.png +0 -0
- data/lib/snaptrade/api/account_information_api.rb +0 -16
- data/lib/snaptrade/api/api_status_api.rb +0 -2
- data/lib/snaptrade/api/authentication_api.rb +0 -10
- data/lib/snaptrade/api/connections_api.rb +0 -8
- data/lib/snaptrade/api/error_logs_api.rb +0 -2
- data/lib/snaptrade/api/options_api.rb +0 -10
- data/lib/snaptrade/api/reference_data_api.rb +0 -22
- data/lib/snaptrade/api/trading_api.rb +0 -12
- data/lib/snaptrade/api/transactions_and_reporting_api.rb +0 -4
- data/lib/snaptrade/api_client_custom.rb +1 -1
- data/lib/snaptrade/models/brokerage_symbol_symbol.rb +30 -0
- data/lib/snaptrade/models/universal_activity.rb +1 -1
- data/lib/snaptrade/models/universal_symbol.rb +30 -0
- data/lib/snaptrade/version.rb +1 -1
- metadata +3 -2
data/docs/TargetAsset.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional] |
|
8
|
-
| **symbol** |
|
8
|
+
| **symbol** | **UniversalSymbol** | | [optional] |
|
9
9
|
| **percent** | **Float** | | [optional] |
|
10
10
|
| **is_supported** | **Boolean** | | [optional] |
|
11
11
|
| **is_excluded** | **Boolean** | | [optional] |
|
data/docs/Trade.md
CHANGED
@@ -5,9 +5,9 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional] |
|
8
|
-
| **account** |
|
9
|
-
| **symbol** |
|
10
|
-
| **universal_symbol** |
|
8
|
+
| **account** | **Account** | | [optional] |
|
9
|
+
| **symbol** | **BrokerageSymbol** | | [optional] |
|
10
|
+
| **universal_symbol** | **UniversalSymbol** | | [optional] |
|
11
11
|
| **action** | [**TradeAction**](TradeAction.md) | | [optional] |
|
12
12
|
| **units** | **Integer** | | [optional] |
|
13
13
|
| **price** | **Float** | | [optional] |
|
@@ -4,9 +4,9 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **symbol** |
|
8
|
-
| **universal_symbol** |
|
9
|
-
| **trade** |
|
7
|
+
| **symbol** | **BrokerageSymbol** | | [optional] |
|
8
|
+
| **universal_symbol** | **UniversalSymbol** | | [optional] |
|
9
|
+
| **trade** | **Trade** | | [optional] |
|
10
10
|
| **state** | [**State**](State.md) | | [optional] |
|
11
11
|
| **filled_units** | **Integer** | Number of filled units | [optional] |
|
12
12
|
| **action** | [**TradeExecutionStatusAction**](TradeExecutionStatusAction.md) | | [optional] |
|
data/docs/TradeImpact.md
CHANGED
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **account** |
|
8
|
-
| **currency** |
|
7
|
+
| **account** | **Account** | | [optional] |
|
8
|
+
| **currency** | **Currency** | | [optional] |
|
9
9
|
| **remaining_cash** | **Float** | Remaining balance after executing all trades | [optional] |
|
10
10
|
| **estimated_commissions** | **Float** | Total estimated commissions across all trades to make | [optional] |
|
11
11
|
| **forex_fees** | **Float** | Estimated forex fees to pay to excute trades | [optional] |
|
data/docs/TradingApi.md
CHANGED
@@ -31,11 +31,11 @@ brokerage_order_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
|
|
31
31
|
begin
|
32
32
|
# Cancel open order in account
|
33
33
|
result = SnapTrade::Trading.cancel_user_account_order(
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
34
|
+
user_id: user_id,
|
35
|
+
user_secret: user_secret,
|
36
|
+
account_id: account_id,
|
37
|
+
brokerage_order_id: brokerage_order_id,
|
38
|
+
)
|
39
39
|
p result
|
40
40
|
rescue SnapTrade::ApiError => e
|
41
41
|
puts "Exception when calling SnapTrade::Trading.cancel_user_account_order: #{e}"
|
@@ -55,11 +55,11 @@ brokerage_order_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
|
|
55
55
|
begin
|
56
56
|
# Cancel open order in account
|
57
57
|
data, status_code, headers, response = SnapTrade::Trading.cancel_user_account_order_with_http_info(
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
58
|
+
user_id: user_id,
|
59
|
+
user_secret: user_secret,
|
60
|
+
account_id: account_id,
|
61
|
+
brokerage_order_id: brokerage_order_id,
|
62
|
+
)
|
63
63
|
p status_code # => 2xx
|
64
64
|
p headers # => { ... }
|
65
65
|
p data # => AccountOrderRecord
|
@@ -107,17 +107,17 @@ universal_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
|
|
107
107
|
begin
|
108
108
|
# Check impact of trades on account.
|
109
109
|
result = SnapTrade::Trading.get_order_impact(
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
|
119
|
-
|
120
|
-
|
110
|
+
user_id: user_id,
|
111
|
+
user_secret: user_secret,
|
112
|
+
account_id: account_id,
|
113
|
+
action: action,
|
114
|
+
order_type: order_type,
|
115
|
+
price: price,
|
116
|
+
stop: stop,
|
117
|
+
time_in_force: time_in_force,
|
118
|
+
units: units,
|
119
|
+
universal_symbol_id: universal_symbol_id,
|
120
|
+
)
|
121
121
|
p result
|
122
122
|
rescue SnapTrade::ApiError => e
|
123
123
|
puts "Exception when calling SnapTrade::Trading.get_order_impact: #{e}"
|
@@ -143,17 +143,17 @@ universal_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
|
|
143
143
|
begin
|
144
144
|
# Check impact of trades on account.
|
145
145
|
data, status_code, headers, response = SnapTrade::Trading.get_order_impact_with_http_info(
|
146
|
-
|
147
|
-
|
148
|
-
|
149
|
-
|
150
|
-
|
151
|
-
|
152
|
-
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
|
146
|
+
user_id: user_id,
|
147
|
+
user_secret: user_secret,
|
148
|
+
account_id: account_id,
|
149
|
+
action: action,
|
150
|
+
order_type: order_type,
|
151
|
+
price: price,
|
152
|
+
stop: stop,
|
153
|
+
time_in_force: time_in_force,
|
154
|
+
units: units,
|
155
|
+
universal_symbol_id: universal_symbol_id,
|
156
|
+
)
|
157
157
|
p status_code # => 2xx
|
158
158
|
p headers # => { ... }
|
159
159
|
p data # => ManualTradeAndImpact
|
@@ -195,12 +195,12 @@ use_ticker = True
|
|
195
195
|
begin
|
196
196
|
# Get symbol quotes
|
197
197
|
result = SnapTrade::Trading.get_user_account_quotes(
|
198
|
-
|
199
|
-
|
200
|
-
|
201
|
-
|
202
|
-
|
203
|
-
|
198
|
+
user_id: user_id,
|
199
|
+
user_secret: user_secret,
|
200
|
+
symbols: symbols,
|
201
|
+
account_id: account_id,
|
202
|
+
use_ticker: use_ticker,
|
203
|
+
)
|
204
204
|
p result
|
205
205
|
rescue SnapTrade::ApiError => e
|
206
206
|
puts "Exception when calling SnapTrade::Trading.get_user_account_quotes: #{e}"
|
@@ -221,12 +221,12 @@ use_ticker = True
|
|
221
221
|
begin
|
222
222
|
# Get symbol quotes
|
223
223
|
data, status_code, headers, response = SnapTrade::Trading.get_user_account_quotes_with_http_info(
|
224
|
-
|
225
|
-
|
226
|
-
|
227
|
-
|
228
|
-
|
229
|
-
|
224
|
+
user_id: user_id,
|
225
|
+
user_secret: user_secret,
|
226
|
+
symbols: symbols,
|
227
|
+
account_id: account_id,
|
228
|
+
use_ticker: use_ticker,
|
229
|
+
)
|
230
230
|
p status_code # => 2xx
|
231
231
|
p headers # => { ... }
|
232
232
|
p data # => Array<SymbolsQuotesInner>
|
@@ -275,17 +275,17 @@ universal_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
|
|
275
275
|
begin
|
276
276
|
# Place a trade with NO validation.
|
277
277
|
result = SnapTrade::Trading.place_force_order(
|
278
|
-
|
279
|
-
|
280
|
-
|
281
|
-
|
282
|
-
|
283
|
-
|
284
|
-
|
285
|
-
|
286
|
-
|
287
|
-
|
288
|
-
|
278
|
+
user_id: user_id,
|
279
|
+
user_secret: user_secret,
|
280
|
+
account_id: account_id,
|
281
|
+
action: action,
|
282
|
+
order_type: order_type,
|
283
|
+
price: price,
|
284
|
+
stop: stop,
|
285
|
+
time_in_force: time_in_force,
|
286
|
+
units: units,
|
287
|
+
universal_symbol_id: universal_symbol_id,
|
288
|
+
)
|
289
289
|
p result
|
290
290
|
rescue SnapTrade::ApiError => e
|
291
291
|
puts "Exception when calling SnapTrade::Trading.place_force_order: #{e}"
|
@@ -311,17 +311,17 @@ universal_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
|
|
311
311
|
begin
|
312
312
|
# Place a trade with NO validation.
|
313
313
|
data, status_code, headers, response = SnapTrade::Trading.place_force_order_with_http_info(
|
314
|
-
|
315
|
-
|
316
|
-
|
317
|
-
|
318
|
-
|
319
|
-
|
320
|
-
|
321
|
-
|
322
|
-
|
323
|
-
|
324
|
-
|
314
|
+
user_id: user_id,
|
315
|
+
user_secret: user_secret,
|
316
|
+
account_id: account_id,
|
317
|
+
action: action,
|
318
|
+
order_type: order_type,
|
319
|
+
price: price,
|
320
|
+
stop: stop,
|
321
|
+
time_in_force: time_in_force,
|
322
|
+
units: units,
|
323
|
+
universal_symbol_id: universal_symbol_id,
|
324
|
+
)
|
325
325
|
p status_code # => 2xx
|
326
326
|
p headers # => { ... }
|
327
327
|
p data # => AccountOrderRecord
|
@@ -362,11 +362,11 @@ second_trade_id = None
|
|
362
362
|
begin
|
363
363
|
# Place a OCO (One Cancels Other) order
|
364
364
|
result = SnapTrade::Trading.place_oco_order(
|
365
|
-
|
366
|
-
|
367
|
-
|
368
|
-
|
369
|
-
|
365
|
+
user_id: user_id,
|
366
|
+
user_secret: user_secret,
|
367
|
+
first_trade_id: first_trade_id,
|
368
|
+
second_trade_id: second_trade_id,
|
369
|
+
)
|
370
370
|
p result
|
371
371
|
rescue SnapTrade::ApiError => e
|
372
372
|
puts "Exception when calling SnapTrade::Trading.place_oco_order: #{e}"
|
@@ -386,11 +386,11 @@ second_trade_id = None
|
|
386
386
|
begin
|
387
387
|
# Place a OCO (One Cancels Other) order
|
388
388
|
data, status_code, headers, response = SnapTrade::Trading.place_oco_order_with_http_info(
|
389
|
-
|
390
|
-
|
391
|
-
|
392
|
-
|
393
|
-
|
389
|
+
user_id: user_id,
|
390
|
+
user_secret: user_secret,
|
391
|
+
first_trade_id: first_trade_id,
|
392
|
+
second_trade_id: second_trade_id,
|
393
|
+
)
|
394
394
|
p status_code # => 2xx
|
395
395
|
p headers # => { ... }
|
396
396
|
p data # => AccountOrderRecord
|
@@ -430,10 +430,10 @@ user_secret = "USERSECRET123"
|
|
430
430
|
begin
|
431
431
|
# Place order
|
432
432
|
result = SnapTrade::Trading.place_order(
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
|
433
|
+
trade_id: trade_id,
|
434
|
+
user_id: user_id,
|
435
|
+
user_secret: user_secret,
|
436
|
+
)
|
437
437
|
p result
|
438
438
|
rescue SnapTrade::ApiError => e
|
439
439
|
puts "Exception when calling SnapTrade::Trading.place_order: #{e}"
|
@@ -452,10 +452,10 @@ user_secret = "USERSECRET123"
|
|
452
452
|
begin
|
453
453
|
# Place order
|
454
454
|
data, status_code, headers, response = SnapTrade::Trading.place_order_with_http_info(
|
455
|
-
|
456
|
-
|
457
|
-
|
458
|
-
|
455
|
+
trade_id: trade_id,
|
456
|
+
user_id: user_id,
|
457
|
+
user_secret: user_secret,
|
458
|
+
)
|
459
459
|
p status_code # => 2xx
|
460
460
|
p headers # => { ... }
|
461
461
|
p data # => AccountOrderRecord
|
@@ -32,14 +32,14 @@ type = "DIVIDEND"
|
|
32
32
|
begin
|
33
33
|
# Get transaction history for a user
|
34
34
|
result = SnapTrade::TransactionsAndReporting.get_activities(
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
35
|
+
user_id: user_id,
|
36
|
+
user_secret: user_secret,
|
37
|
+
start_date: start_date,
|
38
|
+
end_date: end_date,
|
39
|
+
accounts: accounts,
|
40
|
+
brokerage_authorizations: brokerage_authorizations,
|
41
|
+
type: type,
|
42
|
+
)
|
43
43
|
p result
|
44
44
|
rescue SnapTrade::ApiError => e
|
45
45
|
puts "Exception when calling SnapTrade::TransactionsAndReporting.get_activities: #{e}"
|
@@ -62,14 +62,14 @@ type = "DIVIDEND"
|
|
62
62
|
begin
|
63
63
|
# Get transaction history for a user
|
64
64
|
data, status_code, headers, response = SnapTrade::TransactionsAndReporting.get_activities_with_http_info(
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
65
|
+
user_id: user_id,
|
66
|
+
user_secret: user_secret,
|
67
|
+
start_date: start_date,
|
68
|
+
end_date: end_date,
|
69
|
+
accounts: accounts,
|
70
|
+
brokerage_authorizations: brokerage_authorizations,
|
71
|
+
type: type,
|
72
|
+
)
|
73
73
|
p status_code # => 2xx
|
74
74
|
p headers # => { ... }
|
75
75
|
p data # => Array<UniversalActivity>
|
@@ -119,14 +119,14 @@ frequency = "monthly"
|
|
119
119
|
begin
|
120
120
|
# Get performance information for a specific timeframe
|
121
121
|
result = SnapTrade::TransactionsAndReporting.get_reporting_custom_range(
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
|
129
|
-
|
122
|
+
start_date: start_date,
|
123
|
+
end_date: end_date,
|
124
|
+
user_id: user_id,
|
125
|
+
user_secret: user_secret,
|
126
|
+
accounts: accounts,
|
127
|
+
detailed: detailed,
|
128
|
+
frequency: frequency,
|
129
|
+
)
|
130
130
|
p result
|
131
131
|
rescue SnapTrade::ApiError => e
|
132
132
|
puts "Exception when calling SnapTrade::TransactionsAndReporting.get_reporting_custom_range: #{e}"
|
@@ -149,14 +149,14 @@ frequency = "monthly"
|
|
149
149
|
begin
|
150
150
|
# Get performance information for a specific timeframe
|
151
151
|
data, status_code, headers, response = SnapTrade::TransactionsAndReporting.get_reporting_custom_range_with_http_info(
|
152
|
-
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
|
157
|
-
|
158
|
-
|
159
|
-
|
152
|
+
start_date: start_date,
|
153
|
+
end_date: end_date,
|
154
|
+
user_id: user_id,
|
155
|
+
user_secret: user_secret,
|
156
|
+
accounts: accounts,
|
157
|
+
detailed: detailed,
|
158
|
+
frequency: frequency,
|
159
|
+
)
|
160
160
|
p status_code # => 2xx
|
161
161
|
p headers # => { ... }
|
162
162
|
p data # => PerformanceCustom
|
data/docs/UnderlyingSymbol.md
CHANGED
@@ -7,9 +7,9 @@
|
|
7
7
|
| **id** | **String** | | [optional] |
|
8
8
|
| **symbol** | **String** | | [optional] |
|
9
9
|
| **description** | **String** | | [optional] |
|
10
|
-
| **currency** |
|
11
|
-
| **exchange** |
|
12
|
-
| **type** |
|
10
|
+
| **currency** | **Currency** | | [optional] |
|
11
|
+
| **exchange** | **USExchange** | | [optional] |
|
12
|
+
| **type** | **SecurityType** | | [optional] |
|
13
13
|
| **currencies** | [**Array<Currency>**](Currency.md) | | [optional] |
|
14
14
|
|
15
15
|
## Example
|
data/docs/UniversalActivity.md
CHANGED
@@ -5,19 +5,19 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional] |
|
8
|
-
| **account** |
|
8
|
+
| **account** | **AccountSimple** | | [optional] |
|
9
9
|
| **amount** | **Float** | | [optional] |
|
10
|
-
| **currency** |
|
10
|
+
| **currency** | **Currency** | | [optional] |
|
11
11
|
| **description** | **String** | | [optional] |
|
12
12
|
| **fee** | **Float** | | [optional] |
|
13
|
-
| **fx_rate** | **Float** | The forex conversion rate involved in the transaction if provided by the brokerage | [optional] |
|
13
|
+
| **fx_rate** | **Float** | The forex conversion rate involved in the transaction if provided by the brokerage. Used in cases where securities of one currency are purchased in a different currency, and the forex conversion is automatic. In those cases, price, amount and fee will be in the top level currency (activity -> currency) | [optional] |
|
14
14
|
| **institution** | **String** | | [optional] |
|
15
15
|
| **option_type** | **String** | If an option transaction, then it's type (BUY_TO_OPEN, SELL_TO_CLOSE, etc), otherwise empty string | [optional] |
|
16
16
|
| **price** | **Float** | | [optional] |
|
17
17
|
| **settlement_date** | **String** | | [optional] |
|
18
18
|
| **external_reference_id** | **String** | Reference ID from brokerage used to identify related transactions. For example if an order comprises of several transactions (buy, fee, fx), they can be grouped if they share the same external_reference_id | [optional] |
|
19
|
-
| **symbol** |
|
20
|
-
| **option_symbol** |
|
19
|
+
| **symbol** | **Symbol** | | [optional] |
|
20
|
+
| **option_symbol** | **OptionsSymbol** | | [optional] |
|
21
21
|
| **trade_date** | **String** | | [optional] |
|
22
22
|
| **type** | **String** | Potential values include (but are not limited to) - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT | [optional] |
|
23
23
|
| **units** | **Float** | Usually but not necessarily an integer | [optional] |
|
data/docs/UniversalSymbol.md
CHANGED
@@ -4,14 +4,14 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **String** | |
|
8
|
-
| **symbol** | **String** | |
|
9
|
-
| **raw_symbol** | **String** | |
|
7
|
+
| **id** | **String** | | |
|
8
|
+
| **symbol** | **String** | | |
|
9
|
+
| **raw_symbol** | **String** | | |
|
10
10
|
| **description** | **String** | | [optional] |
|
11
|
-
| **currency** |
|
12
|
-
| **exchange** |
|
13
|
-
| **type** |
|
14
|
-
| **currencies** | [**Array<Currency>**](Currency.md) | |
|
11
|
+
| **currency** | **Currency** | | |
|
12
|
+
| **exchange** | **Exchange** | | [optional] |
|
13
|
+
| **type** | **SecurityType** | | |
|
14
|
+
| **currencies** | [**Array<Currency>**](Currency.md) | | |
|
15
15
|
|
16
16
|
## Example
|
17
17
|
|
@@ -8,9 +8,9 @@
|
|
8
8
|
| **symbol** | **String** | | [optional] |
|
9
9
|
| **raw_symbol** | **String** | | [optional] |
|
10
10
|
| **description** | **String** | | [optional] |
|
11
|
-
| **currency** |
|
12
|
-
| **exchange** |
|
13
|
-
| **type** |
|
11
|
+
| **currency** | **Currency** | | [optional] |
|
12
|
+
| **exchange** | **Exchange** | | [optional] |
|
13
|
+
| **type** | **SecurityType** | | [optional] |
|
14
14
|
| **currencies** | [**Array<Currency>**](Currency.md) | | [optional] |
|
15
15
|
|
16
16
|
## Example
|
data/docs/UserSettings.md
CHANGED
@@ -13,7 +13,7 @@
|
|
13
13
|
| **demo** | **Boolean** | | [optional] |
|
14
14
|
| **api_enabled** | **Boolean** | | [optional] |
|
15
15
|
| **drift_threshold** | **Float** | | [optional] |
|
16
|
-
| **preferred_currency** |
|
16
|
+
| **preferred_currency** | **Currency** | | [optional] |
|
17
17
|
|
18
18
|
## Example
|
19
19
|
|
data/header.png
ADDED
Binary file
|
@@ -25,7 +25,6 @@ module SnapTrade
|
|
25
25
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
26
26
|
def get_all_user_holdings(user_id:, user_secret:, brokerage_authorizations: SENTINEL, extra: {})
|
27
27
|
extra[:brokerage_authorizations] = brokerage_authorizations if brokerage_authorizations != SENTINEL
|
28
|
-
|
29
28
|
data, _status_code, _headers = get_all_user_holdings_with_http_info_impl(user_id, user_secret, extra)
|
30
29
|
data
|
31
30
|
end
|
@@ -37,7 +36,6 @@ module SnapTrade
|
|
37
36
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
38
37
|
def get_all_user_holdings_with_http_info(user_id:, user_secret:, brokerage_authorizations: SENTINEL, extra: {})
|
39
38
|
extra[:brokerage_authorizations] = brokerage_authorizations if brokerage_authorizations != SENTINEL
|
40
|
-
|
41
39
|
get_all_user_holdings_with_http_info_impl(user_id, user_secret, extra)
|
42
40
|
end
|
43
41
|
|
@@ -120,7 +118,6 @@ module SnapTrade
|
|
120
118
|
# @param account_id [String] The ID of the account get positions.
|
121
119
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
122
120
|
def get_user_account_balance(user_id:, user_secret:, account_id:, extra: {})
|
123
|
-
|
124
121
|
data, _status_code, _headers = get_user_account_balance_with_http_info_impl(user_id, user_secret, account_id, extra)
|
125
122
|
data
|
126
123
|
end
|
@@ -131,7 +128,6 @@ module SnapTrade
|
|
131
128
|
# @param account_id [String] The ID of the account get positions.
|
132
129
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
133
130
|
def get_user_account_balance_with_http_info(user_id:, user_secret:, account_id:, extra: {})
|
134
|
-
|
135
131
|
get_user_account_balance_with_http_info_impl(user_id, user_secret, account_id, extra)
|
136
132
|
end
|
137
133
|
|
@@ -217,7 +213,6 @@ module SnapTrade
|
|
217
213
|
# @param account_id [String] The ID of the account to get detail of.
|
218
214
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
219
215
|
def get_user_account_details(user_id:, user_secret:, account_id:, extra: {})
|
220
|
-
|
221
216
|
data, _status_code, _headers = get_user_account_details_with_http_info_impl(user_id, user_secret, account_id, extra)
|
222
217
|
data
|
223
218
|
end
|
@@ -228,7 +223,6 @@ module SnapTrade
|
|
228
223
|
# @param account_id [String] The ID of the account to get detail of.
|
229
224
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
230
225
|
def get_user_account_details_with_http_info(user_id:, user_secret:, account_id:, extra: {})
|
231
|
-
|
232
226
|
get_user_account_details_with_http_info_impl(user_id, user_secret, account_id, extra)
|
233
227
|
end
|
234
228
|
|
@@ -316,7 +310,6 @@ module SnapTrade
|
|
316
310
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
317
311
|
def get_user_account_orders(user_id:, user_secret:, account_id:, state: SENTINEL, extra: {})
|
318
312
|
extra[:state] = state if state != SENTINEL
|
319
|
-
|
320
313
|
data, _status_code, _headers = get_user_account_orders_with_http_info_impl(user_id, user_secret, account_id, extra)
|
321
314
|
data
|
322
315
|
end
|
@@ -329,7 +322,6 @@ module SnapTrade
|
|
329
322
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
330
323
|
def get_user_account_orders_with_http_info(user_id:, user_secret:, account_id:, state: SENTINEL, extra: {})
|
331
324
|
extra[:state] = state if state != SENTINEL
|
332
|
-
|
333
325
|
get_user_account_orders_with_http_info_impl(user_id, user_secret, account_id, extra)
|
334
326
|
end
|
335
327
|
|
@@ -422,7 +414,6 @@ module SnapTrade
|
|
422
414
|
# @param account_id [String] The ID of the account get positions.
|
423
415
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
424
416
|
def get_user_account_positions(user_id:, user_secret:, account_id:, extra: {})
|
425
|
-
|
426
417
|
data, _status_code, _headers = get_user_account_positions_with_http_info_impl(user_id, user_secret, account_id, extra)
|
427
418
|
data
|
428
419
|
end
|
@@ -433,7 +424,6 @@ module SnapTrade
|
|
433
424
|
# @param account_id [String] The ID of the account get positions.
|
434
425
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
435
426
|
def get_user_account_positions_with_http_info(user_id:, user_secret:, account_id:, extra: {})
|
436
|
-
|
437
427
|
get_user_account_positions_with_http_info_impl(user_id, user_secret, account_id, extra)
|
438
428
|
end
|
439
429
|
|
@@ -519,7 +509,6 @@ module SnapTrade
|
|
519
509
|
# @param user_secret [String]
|
520
510
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
521
511
|
def get_user_holdings(account_id:, user_id:, user_secret:, extra: {})
|
522
|
-
|
523
512
|
data, _status_code, _headers = get_user_holdings_with_http_info_impl(account_id, user_id, user_secret, extra)
|
524
513
|
data
|
525
514
|
end
|
@@ -530,7 +519,6 @@ module SnapTrade
|
|
530
519
|
# @param user_secret [String]
|
531
520
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
532
521
|
def get_user_holdings_with_http_info(account_id:, user_id:, user_secret:, extra: {})
|
533
|
-
|
534
522
|
get_user_holdings_with_http_info_impl(account_id, user_id, user_secret, extra)
|
535
523
|
end
|
536
524
|
|
@@ -615,7 +603,6 @@ module SnapTrade
|
|
615
603
|
# @param user_secret [String]
|
616
604
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
617
605
|
def list_user_accounts(user_id:, user_secret:, extra: {})
|
618
|
-
|
619
606
|
data, _status_code, _headers = list_user_accounts_with_http_info_impl(user_id, user_secret, extra)
|
620
607
|
data
|
621
608
|
end
|
@@ -625,7 +612,6 @@ module SnapTrade
|
|
625
612
|
# @param user_secret [String]
|
626
613
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
627
614
|
def list_user_accounts_with_http_info(user_id:, user_secret:, extra: {})
|
628
|
-
|
629
615
|
list_user_accounts_with_http_info_impl(user_id, user_secret, extra)
|
630
616
|
end
|
631
617
|
|
@@ -705,7 +691,6 @@ module SnapTrade
|
|
705
691
|
# @param account_id [String] The ID of the account to update.
|
706
692
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
707
693
|
def update_user_account(user_id:, user_secret:, account_id:, extra: {})
|
708
|
-
|
709
694
|
data, _status_code, _headers = update_user_account_with_http_info_impl(user_id, user_secret, account_id, extra)
|
710
695
|
data
|
711
696
|
end
|
@@ -716,7 +701,6 @@ module SnapTrade
|
|
716
701
|
# @param account_id [String] The ID of the account to update.
|
717
702
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
718
703
|
def update_user_account_with_http_info(user_id:, user_secret:, account_id:, extra: {})
|
719
|
-
|
720
704
|
update_user_account_with_http_info_impl(user_id, user_secret, account_id, extra)
|
721
705
|
end
|
722
706
|
|
@@ -22,7 +22,6 @@ module SnapTrade
|
|
22
22
|
# Check whether the API is operational and verify timestamps.
|
23
23
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
24
24
|
def check(extra: {})
|
25
|
-
|
26
25
|
data, _status_code, _headers = check_with_http_info_impl(extra)
|
27
26
|
data
|
28
27
|
end
|
@@ -31,7 +30,6 @@ module SnapTrade
|
|
31
30
|
# Check whether the API is operational and verify timestamps.
|
32
31
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
33
32
|
def check_with_http_info(extra: {})
|
34
|
-
|
35
33
|
check_with_http_info_impl(extra)
|
36
34
|
end
|
37
35
|
|