snaptrade 1.7.0 → 1.12.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +2 -2
- data/README.md +16 -52
- data/docs/AccountInformationApi.md +18 -18
- data/docs/AuthenticationApi.md +20 -20
- data/docs/OptionsApi.md +2 -2
- data/docs/ReferenceDataApi.md +20 -20
- data/docs/TradingApi.md +0 -321
- data/docs/TransactionsAndReportingApi.md +1 -1
- data/lib/snaptrade/api/account_information_api.rb +19 -19
- data/lib/snaptrade/api/authentication_api.rb +20 -20
- data/lib/snaptrade/api/options_api.rb +3 -3
- data/lib/snaptrade/api/reference_data_api.rb +20 -20
- data/lib/snaptrade/api/trading_api.rb +0 -409
- data/lib/snaptrade/api/transactions_and_reporting_api.rb +4 -4
- data/lib/snaptrade/models/account_holdings.rb +2 -0
- data/lib/snaptrade/models/account_holdings_account.rb +3 -0
- data/lib/snaptrade/version.rb +1 -1
- data/lib/snaptrade.rb +0 -3
- data/spec/api/account_information_api_spec.rb +5 -5
- data/spec/api/authentication_api_spec.rb +5 -5
- data/spec/api/options_api_spec.rb +1 -1
- data/spec/api/reference_data_api_spec.rb +5 -5
- data/spec/api/trading_api_spec.rb +0 -51
- data/spec/api/transactions_and_reporting_api_spec.rb +1 -1
- data/spec/getting_started_spec.rb +0 -36
- metadata +2 -6
- data/docs/PortfolioManagementApi.md +0 -2064
- data/lib/snaptrade/api/portfolio_management_api.rb +0 -2867
- data/spec/api/portfolio_management_api_spec.rb +0 -403
data/docs/TradingApi.md
CHANGED
@@ -5,12 +5,8 @@ All URIs are relative to *https://api.snaptrade.com/api/v1*
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**cancel_user_account_order**](TradingApi.md#cancel_user_account_order) | **POST** /accounts/{accountId}/orders/cancel | Cancel open order in account |
|
8
|
-
| [**get_calculated_trade_impact_by_id**](TradingApi.md#get_calculated_trade_impact_by_id) | **GET** /portfolioGroups/{portfolioGroupId}/calculatedtrades/{calculatedTradeId}/modify/{tradeId} | Return details of a specific trade before it's placed |
|
9
|
-
| [**get_calculated_trades_impact**](TradingApi.md#get_calculated_trades_impact) | **GET** /portfolioGroups/{portfolioGroupId}/calculatedtrades/{calculatedTradeId}/impact | Return the impact of placing a series of trades on the portfolio |
|
10
8
|
| [**get_order_impact**](TradingApi.md#get_order_impact) | **POST** /trade/impact | Check impact of trades on account. |
|
11
9
|
| [**get_user_account_quotes**](TradingApi.md#get_user_account_quotes) | **GET** /accounts/{accountId}/quotes | Get symbol quotes |
|
12
|
-
| [**modify_calculated_trade_by_id**](TradingApi.md#modify_calculated_trade_by_id) | **PATCH** /portfolioGroups/{portfolioGroupId}/calculatedtrades/{calculatedTradeId}/modify/{tradeId} | Modify units of a trade before it is placed |
|
13
|
-
| [**place_calculated_trades**](TradingApi.md#place_calculated_trades) | **POST** /portfolioGroups/{portfolioGroupId}/calculatedtrades/{calculatedTradeId}/placeOrders | Place orders for the CalculatedTrades in series |
|
14
10
|
| [**place_force_order**](TradingApi.md#place_force_order) | **POST** /trade/place | Place a trade with NO validation. |
|
15
11
|
| [**place_oco_order**](TradingApi.md#place_oco_order) | **POST** /trade/oco | Place a OCO (One Cancels Other) order |
|
16
12
|
| [**place_order**](TradingApi.md#place_order) | **POST** /trade/{tradeId} | Place order |
|
@@ -85,131 +81,6 @@ end
|
|
85
81
|
|
86
82
|
[**AccountOrderRecord**](AccountOrderRecord.md)
|
87
83
|
|
88
|
-
## get_calculated_trade_impact_by_id
|
89
|
-
|
90
|
-
Return details of a specific trade before it's placed
|
91
|
-
|
92
|
-
### Example
|
93
|
-
|
94
|
-
```ruby
|
95
|
-
require 'snaptrade'
|
96
|
-
|
97
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
98
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
99
|
-
|
100
|
-
portfolio_group_id = "portfolioGroupId_example"
|
101
|
-
calculated_trade_id = "calculatedTradeId_example"
|
102
|
-
trade_id = "tradeId_example"
|
103
|
-
|
104
|
-
begin
|
105
|
-
# Return details of a specific trade before it's placed
|
106
|
-
result = SnapTrade::Trading.get_calculated_trade_impact_by_id(
|
107
|
-
portfolio_group_id: portfolio_group_id,
|
108
|
-
calculated_trade_id: calculated_trade_id,
|
109
|
-
trade_id: trade_id,
|
110
|
-
)
|
111
|
-
p result
|
112
|
-
rescue SnapTrade::ApiError => e
|
113
|
-
puts "Exception when calling SnapTrade::Trading.get_calculated_trade_impact_by_id: #{e}"
|
114
|
-
end
|
115
|
-
```
|
116
|
-
|
117
|
-
#### Using the get_calculated_trade_impact_by_id_with_http_info variant
|
118
|
-
|
119
|
-
This returns an Array which contains the response data, status code and headers.
|
120
|
-
|
121
|
-
```ruby
|
122
|
-
portfolio_group_id = "portfolioGroupId_example"
|
123
|
-
calculated_trade_id = "calculatedTradeId_example"
|
124
|
-
trade_id = "tradeId_example"
|
125
|
-
|
126
|
-
begin
|
127
|
-
# Return details of a specific trade before it's placed
|
128
|
-
data, status_code, headers, response = SnapTrade::Trading.get_calculated_trade_impact_by_id_with_http_info(
|
129
|
-
portfolio_group_id: portfolio_group_id,
|
130
|
-
calculated_trade_id: calculated_trade_id,
|
131
|
-
trade_id: trade_id,
|
132
|
-
)
|
133
|
-
p status_code # => 2xx
|
134
|
-
p headers # => { ... }
|
135
|
-
p data # => Trade
|
136
|
-
rescue SnapTrade::ApiError => e
|
137
|
-
puts "Exception when calling SnapTrade::Trading.get_calculated_trade_impact_by_id: #{e}"
|
138
|
-
end
|
139
|
-
```
|
140
|
-
|
141
|
-
### Parameters
|
142
|
-
|
143
|
-
| Name | Type | Description | Notes |
|
144
|
-
| ---- | ---- | ----------- | ----- |
|
145
|
-
| **portfolio_group_id** | **String** | The ID of the PortfolioGroup to perform rebalancing calculations | |
|
146
|
-
| **calculated_trade_id** | **String** | The ID of calculated trade to get account impact | |
|
147
|
-
| **trade_id** | **String** | The ID of trade object | |
|
148
|
-
|
149
|
-
### Return type
|
150
|
-
|
151
|
-
[**Trade**](Trade.md)
|
152
|
-
|
153
|
-
## get_calculated_trades_impact
|
154
|
-
|
155
|
-
Return the impact of placing a series of trades on the portfolio
|
156
|
-
|
157
|
-
### Example
|
158
|
-
|
159
|
-
```ruby
|
160
|
-
require 'snaptrade'
|
161
|
-
|
162
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
163
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
164
|
-
|
165
|
-
portfolio_group_id = "portfolioGroupId_example"
|
166
|
-
calculated_trade_id = "calculatedTradeId_example"
|
167
|
-
|
168
|
-
begin
|
169
|
-
# Return the impact of placing a series of trades on the portfolio
|
170
|
-
result = SnapTrade::Trading.get_calculated_trades_impact(
|
171
|
-
portfolio_group_id: portfolio_group_id,
|
172
|
-
calculated_trade_id: calculated_trade_id,
|
173
|
-
)
|
174
|
-
p result
|
175
|
-
rescue SnapTrade::ApiError => e
|
176
|
-
puts "Exception when calling SnapTrade::Trading.get_calculated_trades_impact: #{e}"
|
177
|
-
end
|
178
|
-
```
|
179
|
-
|
180
|
-
#### Using the get_calculated_trades_impact_with_http_info variant
|
181
|
-
|
182
|
-
This returns an Array which contains the response data, status code and headers.
|
183
|
-
|
184
|
-
```ruby
|
185
|
-
portfolio_group_id = "portfolioGroupId_example"
|
186
|
-
calculated_trade_id = "calculatedTradeId_example"
|
187
|
-
|
188
|
-
begin
|
189
|
-
# Return the impact of placing a series of trades on the portfolio
|
190
|
-
data, status_code, headers, response = SnapTrade::Trading.get_calculated_trades_impact_with_http_info(
|
191
|
-
portfolio_group_id: portfolio_group_id,
|
192
|
-
calculated_trade_id: calculated_trade_id,
|
193
|
-
)
|
194
|
-
p status_code # => 2xx
|
195
|
-
p headers # => { ... }
|
196
|
-
p data # => Array<TradeImpact>
|
197
|
-
rescue SnapTrade::ApiError => e
|
198
|
-
puts "Exception when calling SnapTrade::Trading.get_calculated_trades_impact: #{e}"
|
199
|
-
end
|
200
|
-
```
|
201
|
-
|
202
|
-
### Parameters
|
203
|
-
|
204
|
-
| Name | Type | Description | Notes |
|
205
|
-
| ---- | ---- | ----------- | ----- |
|
206
|
-
| **portfolio_group_id** | **String** | The ID of the PortfolioGroup to perform rebalancing calculations | |
|
207
|
-
| **calculated_trade_id** | **String** | The ID of calculated trade to get account impact | |
|
208
|
-
|
209
|
-
### Return type
|
210
|
-
|
211
|
-
[**Array<TradeImpact>**](TradeImpact.md)
|
212
|
-
|
213
84
|
## get_order_impact
|
214
85
|
|
215
86
|
Check impact of trades on account.
|
@@ -378,198 +249,6 @@ end
|
|
378
249
|
|
379
250
|
[**Array<SymbolsQuotesInner>**](SymbolsQuotesInner.md)
|
380
251
|
|
381
|
-
## modify_calculated_trade_by_id
|
382
|
-
|
383
|
-
Modify units of a trade before it is placed
|
384
|
-
|
385
|
-
### Example
|
386
|
-
|
387
|
-
```ruby
|
388
|
-
require 'snaptrade'
|
389
|
-
|
390
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
391
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
392
|
-
|
393
|
-
portfolio_group_id = "portfolioGroupId_example"
|
394
|
-
calculated_trade_id = "calculatedTradeId_example"
|
395
|
-
trade_id = "tradeId_example"
|
396
|
-
id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
|
397
|
-
account = {
|
398
|
-
"id" => "2bcd7cc3-e922-4976-bce1-9858296801c3",
|
399
|
-
"brokerage_authorization" => "2bcd7cc3-e922-4976-bce1-9858296801c3",
|
400
|
-
"portfolio_group" => "2bcd7cc3-e922-4976-bce1-9858296801c3",
|
401
|
-
"name" => "Registered Retirement Savings Account",
|
402
|
-
"number" => "Q6542138443",
|
403
|
-
"institution_name" => "Alpaca",
|
404
|
-
"created_date" => "2021-06-04T16:26:46.523Z",
|
405
|
-
}
|
406
|
-
symbol = {
|
407
|
-
"id" => "2bcd7cc3-e922-4976-bce1-9858296801c3",
|
408
|
-
"description" => "VANGUARD CDN AGGREGATE BOND INDEX ETF",
|
409
|
-
"allows_fractional_units" => True,
|
410
|
-
}
|
411
|
-
universal_symbol = {
|
412
|
-
"id" => "2bcd7cc3-e922-4976-bce1-9858296801c3",
|
413
|
-
"symbol" => "VAB.TO",
|
414
|
-
"raw_symbol" => "VAB",
|
415
|
-
"description" => "VANGUARD CDN AGGREGATE BOND INDEX ETF",
|
416
|
-
}
|
417
|
-
action = "BUY"
|
418
|
-
units = 6
|
419
|
-
price = 24.81
|
420
|
-
sequence = 1
|
421
|
-
|
422
|
-
begin
|
423
|
-
# Modify units of a trade before it is placed
|
424
|
-
result = SnapTrade::Trading.modify_calculated_trade_by_id(
|
425
|
-
portfolio_group_id: portfolio_group_id,
|
426
|
-
calculated_trade_id: calculated_trade_id,
|
427
|
-
trade_id: trade_id,
|
428
|
-
id: id,
|
429
|
-
account: account,
|
430
|
-
symbol: symbol,
|
431
|
-
universal_symbol: universal_symbol,
|
432
|
-
action: action,
|
433
|
-
units: units,
|
434
|
-
price: price,
|
435
|
-
sequence: sequence,
|
436
|
-
)
|
437
|
-
p result
|
438
|
-
rescue SnapTrade::ApiError => e
|
439
|
-
puts "Exception when calling SnapTrade::Trading.modify_calculated_trade_by_id: #{e}"
|
440
|
-
end
|
441
|
-
```
|
442
|
-
|
443
|
-
#### Using the modify_calculated_trade_by_id_with_http_info variant
|
444
|
-
|
445
|
-
This returns an Array which contains the response data, status code and headers.
|
446
|
-
|
447
|
-
```ruby
|
448
|
-
portfolio_group_id = "portfolioGroupId_example"
|
449
|
-
calculated_trade_id = "calculatedTradeId_example"
|
450
|
-
trade_id = "tradeId_example"
|
451
|
-
id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
|
452
|
-
account = {
|
453
|
-
"id" => "2bcd7cc3-e922-4976-bce1-9858296801c3",
|
454
|
-
"brokerage_authorization" => "2bcd7cc3-e922-4976-bce1-9858296801c3",
|
455
|
-
"portfolio_group" => "2bcd7cc3-e922-4976-bce1-9858296801c3",
|
456
|
-
"name" => "Registered Retirement Savings Account",
|
457
|
-
"number" => "Q6542138443",
|
458
|
-
"institution_name" => "Alpaca",
|
459
|
-
"created_date" => "2021-06-04T16:26:46.523Z",
|
460
|
-
}
|
461
|
-
symbol = {
|
462
|
-
"id" => "2bcd7cc3-e922-4976-bce1-9858296801c3",
|
463
|
-
"description" => "VANGUARD CDN AGGREGATE BOND INDEX ETF",
|
464
|
-
"allows_fractional_units" => True,
|
465
|
-
}
|
466
|
-
universal_symbol = {
|
467
|
-
"id" => "2bcd7cc3-e922-4976-bce1-9858296801c3",
|
468
|
-
"symbol" => "VAB.TO",
|
469
|
-
"raw_symbol" => "VAB",
|
470
|
-
"description" => "VANGUARD CDN AGGREGATE BOND INDEX ETF",
|
471
|
-
}
|
472
|
-
action = "BUY"
|
473
|
-
units = 6
|
474
|
-
price = 24.81
|
475
|
-
sequence = 1
|
476
|
-
|
477
|
-
begin
|
478
|
-
# Modify units of a trade before it is placed
|
479
|
-
data, status_code, headers, response = SnapTrade::Trading.modify_calculated_trade_by_id_with_http_info(
|
480
|
-
portfolio_group_id: portfolio_group_id,
|
481
|
-
calculated_trade_id: calculated_trade_id,
|
482
|
-
trade_id: trade_id,
|
483
|
-
id: id,
|
484
|
-
account: account,
|
485
|
-
symbol: symbol,
|
486
|
-
universal_symbol: universal_symbol,
|
487
|
-
action: action,
|
488
|
-
units: units,
|
489
|
-
price: price,
|
490
|
-
sequence: sequence,
|
491
|
-
)
|
492
|
-
p status_code # => 2xx
|
493
|
-
p headers # => { ... }
|
494
|
-
p data # => Trade
|
495
|
-
rescue SnapTrade::ApiError => e
|
496
|
-
puts "Exception when calling SnapTrade::Trading.modify_calculated_trade_by_id: #{e}"
|
497
|
-
end
|
498
|
-
```
|
499
|
-
|
500
|
-
### Parameters
|
501
|
-
|
502
|
-
| Name | Type | Description | Notes |
|
503
|
-
| ---- | ---- | ----------- | ----- |
|
504
|
-
| **portfolio_group_id** | **String** | The ID of the PortfolioGroup to perform rebalancing calculations | |
|
505
|
-
| **calculated_trade_id** | **String** | The ID of calculated trade to get account impact | |
|
506
|
-
| **trade_id** | **String** | The ID of trade object | |
|
507
|
-
| **trade** | [**Trade**](Trade.md) | | [optional] |
|
508
|
-
|
509
|
-
### Return type
|
510
|
-
|
511
|
-
[**Trade**](Trade.md)
|
512
|
-
|
513
|
-
## place_calculated_trades
|
514
|
-
|
515
|
-
Place orders for the CalculatedTrades in series
|
516
|
-
|
517
|
-
### Example
|
518
|
-
|
519
|
-
```ruby
|
520
|
-
require 'snaptrade'
|
521
|
-
|
522
|
-
SnapTrade.client_id = "YOUR_CLIENT_ID"
|
523
|
-
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
524
|
-
|
525
|
-
portfolio_group_id = "portfolioGroupId_example"
|
526
|
-
calculated_trade_id = "calculatedTradeId_example"
|
527
|
-
|
528
|
-
begin
|
529
|
-
# Place orders for the CalculatedTrades in series
|
530
|
-
result = SnapTrade::Trading.place_calculated_trades(
|
531
|
-
portfolio_group_id: portfolio_group_id,
|
532
|
-
calculated_trade_id: calculated_trade_id,
|
533
|
-
)
|
534
|
-
p result
|
535
|
-
rescue SnapTrade::ApiError => e
|
536
|
-
puts "Exception when calling SnapTrade::Trading.place_calculated_trades: #{e}"
|
537
|
-
end
|
538
|
-
```
|
539
|
-
|
540
|
-
#### Using the place_calculated_trades_with_http_info variant
|
541
|
-
|
542
|
-
This returns an Array which contains the response data, status code and headers.
|
543
|
-
|
544
|
-
```ruby
|
545
|
-
portfolio_group_id = "portfolioGroupId_example"
|
546
|
-
calculated_trade_id = "calculatedTradeId_example"
|
547
|
-
|
548
|
-
begin
|
549
|
-
# Place orders for the CalculatedTrades in series
|
550
|
-
data, status_code, headers, response = SnapTrade::Trading.place_calculated_trades_with_http_info(
|
551
|
-
portfolio_group_id: portfolio_group_id,
|
552
|
-
calculated_trade_id: calculated_trade_id,
|
553
|
-
)
|
554
|
-
p status_code # => 2xx
|
555
|
-
p headers # => { ... }
|
556
|
-
p data # => Array<TradeExecutionStatus>
|
557
|
-
rescue SnapTrade::ApiError => e
|
558
|
-
puts "Exception when calling SnapTrade::Trading.place_calculated_trades: #{e}"
|
559
|
-
end
|
560
|
-
```
|
561
|
-
|
562
|
-
### Parameters
|
563
|
-
|
564
|
-
| Name | Type | Description | Notes |
|
565
|
-
| ---- | ---- | ----------- | ----- |
|
566
|
-
| **portfolio_group_id** | **String** | The ID of the PortfolioGroup to perform rebalancing calculations | |
|
567
|
-
| **calculated_trade_id** | **String** | The ID of calculated trade to get account impact | |
|
568
|
-
|
569
|
-
### Return type
|
570
|
-
|
571
|
-
[**Array<TradeExecutionStatus>**](TradeExecutionStatus.md)
|
572
|
-
|
573
252
|
## place_force_order
|
574
253
|
|
575
254
|
Place a trade with NO validation.
|
@@ -88,7 +88,7 @@ end
|
|
88
88
|
| **end_date** | **Date** | | [optional] |
|
89
89
|
| **accounts** | **String** | Optional comma seperated list of account IDs used to filter the request on specific accounts | [optional] |
|
90
90
|
| **brokerage_authorizations** | **String** | Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations | [optional] |
|
91
|
-
| **type** | **String** | Optional comma seperated list of types to filter activities by. Potential values include - 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] |
|
91
|
+
| **type** | **String** | Optional comma seperated list of types to filter activities by. This is not an exhaustive list, if we fail to match to these types, we will return the raw description from the brokerage. Potential values include - 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] |
|
92
92
|
|
93
93
|
### Return type
|
94
94
|
|
@@ -18,7 +18,7 @@ module SnapTrade
|
|
18
18
|
@api_client = api_client
|
19
19
|
end
|
20
20
|
|
21
|
-
# List all accounts for the user, plus balances and
|
21
|
+
# List all accounts for the user, plus balances, positions, and orders for each account.
|
22
22
|
# @param user_id [String]
|
23
23
|
# @param user_secret [String]
|
24
24
|
# @param brokerage_authorizations [String] Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
|
@@ -30,7 +30,7 @@ module SnapTrade
|
|
30
30
|
data
|
31
31
|
end
|
32
32
|
|
33
|
-
# List all accounts for the user, plus balances and
|
33
|
+
# List all accounts for the user, plus balances, positions, and orders for each account.
|
34
34
|
# @param user_id [String]
|
35
35
|
# @param user_secret [String]
|
36
36
|
# @param brokerage_authorizations [String] Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
|
@@ -41,7 +41,7 @@ module SnapTrade
|
|
41
41
|
get_all_user_holdings_with_http_info_impl(user_id, user_secret, extra)
|
42
42
|
end
|
43
43
|
|
44
|
-
# List all accounts for the user, plus balances and
|
44
|
+
# List all accounts for the user, plus balances, positions, and orders for each account.
|
45
45
|
# @param user_id [String]
|
46
46
|
# @param user_secret [String]
|
47
47
|
# @param [Hash] opts the optional parameters
|
@@ -52,7 +52,7 @@ module SnapTrade
|
|
52
52
|
data
|
53
53
|
end
|
54
54
|
|
55
|
-
# List all accounts for the user, plus balances and
|
55
|
+
# List all accounts for the user, plus balances, positions, and orders for each account.
|
56
56
|
# @param user_id [String]
|
57
57
|
# @param user_secret [String]
|
58
58
|
# @param [Hash] opts the optional parameters
|
@@ -114,7 +114,7 @@ module SnapTrade
|
|
114
114
|
end
|
115
115
|
|
116
116
|
|
117
|
-
#
|
117
|
+
# List account balances
|
118
118
|
# @param user_id [String]
|
119
119
|
# @param user_secret [String]
|
120
120
|
# @param account_id [String] The ID of the account get positions.
|
@@ -125,7 +125,7 @@ module SnapTrade
|
|
125
125
|
data
|
126
126
|
end
|
127
127
|
|
128
|
-
#
|
128
|
+
# List account balances
|
129
129
|
# @param user_id [String]
|
130
130
|
# @param user_secret [String]
|
131
131
|
# @param account_id [String] The ID of the account get positions.
|
@@ -135,7 +135,7 @@ module SnapTrade
|
|
135
135
|
get_user_account_balance_with_http_info_impl(user_id, user_secret, account_id, extra)
|
136
136
|
end
|
137
137
|
|
138
|
-
#
|
138
|
+
# List account balances
|
139
139
|
# @param user_id [String]
|
140
140
|
# @param user_secret [String]
|
141
141
|
# @param account_id [String] The ID of the account get positions.
|
@@ -146,7 +146,7 @@ module SnapTrade
|
|
146
146
|
data
|
147
147
|
end
|
148
148
|
|
149
|
-
#
|
149
|
+
# List account balances
|
150
150
|
# @param user_id [String]
|
151
151
|
# @param user_secret [String]
|
152
152
|
# @param account_id [String] The ID of the account get positions.
|
@@ -237,7 +237,7 @@ module SnapTrade
|
|
237
237
|
# @param user_secret [String]
|
238
238
|
# @param account_id [String] The ID of the account to get detail of.
|
239
239
|
# @param [Hash] opts the optional parameters
|
240
|
-
# @return [
|
240
|
+
# @return [Account]
|
241
241
|
def get_user_account_details_impl(user_id, user_secret, account_id, opts = {})
|
242
242
|
data, _status_code, _headers = get_user_account_details_with_http_info(user_id, user_secret, account_id, opts)
|
243
243
|
data
|
@@ -248,7 +248,7 @@ module SnapTrade
|
|
248
248
|
# @param user_secret [String]
|
249
249
|
# @param account_id [String] The ID of the account to get detail of.
|
250
250
|
# @param [Hash] opts the optional parameters
|
251
|
-
# @return [Array<(
|
251
|
+
# @return [Array<(Account, Integer, Hash)>] Account data, response status code and response headers
|
252
252
|
def get_user_account_details_with_http_info_impl(user_id, user_secret, account_id, opts = {})
|
253
253
|
if @api_client.config.debugging
|
254
254
|
@api_client.config.logger.debug 'Calling API: AccountInformationApi.get_user_account_details ...'
|
@@ -285,7 +285,7 @@ module SnapTrade
|
|
285
285
|
post_body = opts[:debug_body]
|
286
286
|
|
287
287
|
# return_type
|
288
|
-
return_type = opts[:debug_return_type] || '
|
288
|
+
return_type = opts[:debug_return_type] || 'Account'
|
289
289
|
|
290
290
|
# auth_names
|
291
291
|
auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
|
@@ -416,7 +416,7 @@ module SnapTrade
|
|
416
416
|
end
|
417
417
|
|
418
418
|
|
419
|
-
#
|
419
|
+
# List account positions
|
420
420
|
# @param user_id [String]
|
421
421
|
# @param user_secret [String]
|
422
422
|
# @param account_id [String] The ID of the account get positions.
|
@@ -427,7 +427,7 @@ module SnapTrade
|
|
427
427
|
data
|
428
428
|
end
|
429
429
|
|
430
|
-
#
|
430
|
+
# List account positions
|
431
431
|
# @param user_id [String]
|
432
432
|
# @param user_secret [String]
|
433
433
|
# @param account_id [String] The ID of the account get positions.
|
@@ -437,7 +437,7 @@ module SnapTrade
|
|
437
437
|
get_user_account_positions_with_http_info_impl(user_id, user_secret, account_id, extra)
|
438
438
|
end
|
439
439
|
|
440
|
-
#
|
440
|
+
# List account positions
|
441
441
|
# @param user_id [String]
|
442
442
|
# @param user_secret [String]
|
443
443
|
# @param account_id [String] The ID of the account get positions.
|
@@ -448,7 +448,7 @@ module SnapTrade
|
|
448
448
|
data
|
449
449
|
end
|
450
450
|
|
451
|
-
#
|
451
|
+
# List account positions
|
452
452
|
# @param user_id [String]
|
453
453
|
# @param user_secret [String]
|
454
454
|
# @param account_id [String] The ID of the account get positions.
|
@@ -610,7 +610,7 @@ module SnapTrade
|
|
610
610
|
end
|
611
611
|
|
612
612
|
|
613
|
-
# List
|
613
|
+
# List accounts
|
614
614
|
# @param user_id [String]
|
615
615
|
# @param user_secret [String]
|
616
616
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
@@ -620,7 +620,7 @@ module SnapTrade
|
|
620
620
|
data
|
621
621
|
end
|
622
622
|
|
623
|
-
# List
|
623
|
+
# List accounts
|
624
624
|
# @param user_id [String]
|
625
625
|
# @param user_secret [String]
|
626
626
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
@@ -629,7 +629,7 @@ module SnapTrade
|
|
629
629
|
list_user_accounts_with_http_info_impl(user_id, user_secret, extra)
|
630
630
|
end
|
631
631
|
|
632
|
-
# List
|
632
|
+
# List accounts
|
633
633
|
# @param user_id [String]
|
634
634
|
# @param user_secret [String]
|
635
635
|
# @param [Hash] opts the optional parameters
|
@@ -639,7 +639,7 @@ module SnapTrade
|
|
639
639
|
data
|
640
640
|
end
|
641
641
|
|
642
|
-
# List
|
642
|
+
# List accounts
|
643
643
|
# @param user_id [String]
|
644
644
|
# @param user_secret [String]
|
645
645
|
# @param [Hash] opts the optional parameters
|
@@ -18,7 +18,7 @@ module SnapTrade
|
|
18
18
|
@api_client = api_client
|
19
19
|
end
|
20
20
|
|
21
|
-
# Delete
|
21
|
+
# Delete SnapTrade user
|
22
22
|
# @param user_id [String]
|
23
23
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
24
24
|
def delete_snap_trade_user(user_id:, extra: {})
|
@@ -27,7 +27,7 @@ module SnapTrade
|
|
27
27
|
data
|
28
28
|
end
|
29
29
|
|
30
|
-
# Delete
|
30
|
+
# Delete SnapTrade user
|
31
31
|
# @param user_id [String]
|
32
32
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
33
33
|
def delete_snap_trade_user_with_http_info(user_id:, extra: {})
|
@@ -35,7 +35,7 @@ module SnapTrade
|
|
35
35
|
delete_snap_trade_user_with_http_info_impl(user_id, extra)
|
36
36
|
end
|
37
37
|
|
38
|
-
# Delete
|
38
|
+
# Delete SnapTrade user
|
39
39
|
# @param user_id [String]
|
40
40
|
# @param [Hash] opts the optional parameters
|
41
41
|
# @return [DeleteUserResponse]
|
@@ -44,7 +44,7 @@ module SnapTrade
|
|
44
44
|
data
|
45
45
|
end
|
46
46
|
|
47
|
-
# Delete
|
47
|
+
# Delete SnapTrade user
|
48
48
|
# @param user_id [String]
|
49
49
|
# @param [Hash] opts the optional parameters
|
50
50
|
# @return [Array<(DeleteUserResponse, Integer, Hash)>] DeleteUserResponse data, response status code and response headers
|
@@ -98,7 +98,7 @@ module SnapTrade
|
|
98
98
|
end
|
99
99
|
|
100
100
|
|
101
|
-
#
|
101
|
+
# Generate encrypted JWT token
|
102
102
|
# @param user_id [String]
|
103
103
|
# @param user_secret [String]
|
104
104
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
@@ -108,7 +108,7 @@ module SnapTrade
|
|
108
108
|
data
|
109
109
|
end
|
110
110
|
|
111
|
-
#
|
111
|
+
# Generate encrypted JWT token
|
112
112
|
# @param user_id [String]
|
113
113
|
# @param user_secret [String]
|
114
114
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
@@ -117,7 +117,7 @@ module SnapTrade
|
|
117
117
|
get_user_jwt_with_http_info_impl(user_id, user_secret, extra)
|
118
118
|
end
|
119
119
|
|
120
|
-
#
|
120
|
+
# Generate encrypted JWT token
|
121
121
|
# @param user_id [String]
|
122
122
|
# @param user_secret [String]
|
123
123
|
# @param [Hash] opts the optional parameters
|
@@ -127,7 +127,7 @@ module SnapTrade
|
|
127
127
|
data
|
128
128
|
end
|
129
129
|
|
130
|
-
#
|
130
|
+
# Generate encrypted JWT token
|
131
131
|
# @param user_id [String]
|
132
132
|
# @param user_secret [String]
|
133
133
|
# @param [Hash] opts the optional parameters
|
@@ -187,7 +187,7 @@ module SnapTrade
|
|
187
187
|
end
|
188
188
|
|
189
189
|
|
190
|
-
#
|
190
|
+
# List SnapTrade users
|
191
191
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
192
192
|
def list_snap_trade_users(extra: {})
|
193
193
|
|
@@ -195,14 +195,14 @@ module SnapTrade
|
|
195
195
|
data
|
196
196
|
end
|
197
197
|
|
198
|
-
#
|
198
|
+
# List SnapTrade users
|
199
199
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
200
200
|
def list_snap_trade_users_with_http_info(extra: {})
|
201
201
|
|
202
202
|
list_snap_trade_users_with_http_info_impl(extra)
|
203
203
|
end
|
204
204
|
|
205
|
-
#
|
205
|
+
# List SnapTrade users
|
206
206
|
# @param [Hash] opts the optional parameters
|
207
207
|
# @return [Array<String>]
|
208
208
|
def list_snap_trade_users_impl(opts = {})
|
@@ -210,7 +210,7 @@ module SnapTrade
|
|
210
210
|
data
|
211
211
|
end
|
212
212
|
|
213
|
-
#
|
213
|
+
# List SnapTrade users
|
214
214
|
# @param [Hash] opts the optional parameters
|
215
215
|
# @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
|
216
216
|
def list_snap_trade_users_with_http_info_impl(opts = {})
|
@@ -258,7 +258,7 @@ module SnapTrade
|
|
258
258
|
end
|
259
259
|
|
260
260
|
|
261
|
-
#
|
261
|
+
# Login user & generate connection link
|
262
262
|
# @param user_id [String]
|
263
263
|
# @param user_secret [String]
|
264
264
|
# @param broker [String]
|
@@ -281,7 +281,7 @@ module SnapTrade
|
|
281
281
|
data
|
282
282
|
end
|
283
283
|
|
284
|
-
#
|
284
|
+
# Login user & generate connection link
|
285
285
|
# @param user_id [String]
|
286
286
|
# @param user_secret [String]
|
287
287
|
# @param broker [String]
|
@@ -303,7 +303,7 @@ module SnapTrade
|
|
303
303
|
login_snap_trade_user_with_http_info_impl(user_id, user_secret, extra)
|
304
304
|
end
|
305
305
|
|
306
|
-
#
|
306
|
+
# Login user & generate connection link
|
307
307
|
# @param user_id [String]
|
308
308
|
# @param user_secret [String]
|
309
309
|
# @param [Hash] opts the optional parameters
|
@@ -314,7 +314,7 @@ module SnapTrade
|
|
314
314
|
data
|
315
315
|
end
|
316
316
|
|
317
|
-
#
|
317
|
+
# Login user & generate connection link
|
318
318
|
# @param user_id [String]
|
319
319
|
# @param user_secret [String]
|
320
320
|
# @param [Hash] opts the optional parameters
|
@@ -380,7 +380,7 @@ module SnapTrade
|
|
380
380
|
end
|
381
381
|
|
382
382
|
|
383
|
-
#
|
383
|
+
# Create SnapTrade user
|
384
384
|
# @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
|
385
385
|
# @param rsa_public_key [String] Open SSH RSA public key
|
386
386
|
# @param body [SnapTradeRegisterUserRequestBody]
|
@@ -395,7 +395,7 @@ module SnapTrade
|
|
395
395
|
data
|
396
396
|
end
|
397
397
|
|
398
|
-
#
|
398
|
+
# Create SnapTrade user
|
399
399
|
# @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
|
400
400
|
# @param rsa_public_key [String] Open SSH RSA public key
|
401
401
|
# @param body [SnapTradeRegisterUserRequestBody]
|
@@ -409,7 +409,7 @@ module SnapTrade
|
|
409
409
|
register_snap_trade_user_with_http_info_impl(snap_trade_register_user_request_body, extra)
|
410
410
|
end
|
411
411
|
|
412
|
-
#
|
412
|
+
# Create SnapTrade user
|
413
413
|
# @param snap_trade_register_user_request_body [SnapTradeRegisterUserRequestBody]
|
414
414
|
# @param [Hash] opts the optional parameters
|
415
415
|
# @return [UserIDandSecret]
|
@@ -418,7 +418,7 @@ module SnapTrade
|
|
418
418
|
data
|
419
419
|
end
|
420
420
|
|
421
|
-
#
|
421
|
+
# Create SnapTrade user
|
422
422
|
# @param snap_trade_register_user_request_body [SnapTradeRegisterUserRequestBody]
|
423
423
|
# @param [Hash] opts the optional parameters
|
424
424
|
# @return [Array<(UserIDandSecret, Integer, Hash)>] UserIDandSecret data, response status code and response headers
|