snaptrade 1.17.1 → 1.17.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 +1 -1
- data/README.md +4 -3
- data/docs/AccountInformationApi.md +11 -7
- data/docs/AuthenticationApi.md +6 -4
- data/docs/Model500UnexpectedExceptionResponse.md +22 -0
- data/docs/OptionsApi.md +5 -5
- data/docs/OptionsPosition.md +1 -5
- data/docs/ReferenceDataApi.md +7 -5
- data/docs/SnapTradeLoginUserRequestBody.md +4 -4
- data/docs/SnapTradeRegisterUserRequestBody.md +1 -3
- data/docs/TradingApi.md +1 -1
- data/docs/TransactionsAndReportingApi.md +1 -1
- data/lib/snaptrade/api/account_information_api.rb +24 -16
- data/lib/snaptrade/api/authentication_api.rb +22 -14
- data/lib/snaptrade/api/options_api.rb +20 -20
- data/lib/snaptrade/api/reference_data_api.rb +12 -8
- data/lib/snaptrade/api/trading_api.rb +4 -4
- data/lib/snaptrade/api/transactions_and_reporting_api.rb +4 -4
- data/lib/snaptrade/models/model500_unexpected_exception_response.rb +239 -0
- data/lib/snaptrade/models/options_position.rb +5 -26
- data/lib/snaptrade/models/snap_trade_login_user_request_body.rb +4 -0
- data/lib/snaptrade/models/snap_trade_register_user_request_body.rb +4 -14
- data/lib/snaptrade/version.rb +1 -1
- data/lib/snaptrade.rb +1 -0
- data/spec/api/account_information_api_spec.rb +6 -4
- data/spec/api/authentication_api_spec.rb +3 -0
- data/spec/api/options_api_spec.rb +5 -5
- data/spec/api/reference_data_api_spec.rb +3 -2
- data/spec/api/trading_api_spec.rb +1 -1
- data/spec/api/transactions_and_reporting_api_spec.rb +1 -1
- data/spec/models/model500_unexpected_exception_response_spec.rb +42 -0
- data/spec/models/options_position_spec.rb +0 -12
- data/spec/models/snap_trade_register_user_request_body_spec.rb +0 -6
- metadata +6 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: dc9780823d9dfda53279fb57e020586fad08fc3376e130257ff683ac8aab475d
|
4
|
+
data.tar.gz: 86b12bc58d21c07c1254d05f4a11dad2fc44ed891d056fad98ac04930a9f05d3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ce243da503eab37607f7c4e524c610595586c2b38222f605cb040e2599a428a99640892be4e965e23789f8b75ded0415e007522094422ba40173e3194b17777e
|
7
|
+
data.tar.gz: f5c76b6e59d65d28bdfd6de6e2a3765ea68f8669838595f1827a9df761e0bf6529f97f1bcf1c934973843b0297475088f0dcc9f710999241d63a0e5377f71193
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -9,7 +9,7 @@ For more information, please visit [https://snaptrade.com/](https://snaptrade.co
|
|
9
9
|
Add to Gemfile:
|
10
10
|
|
11
11
|
```ruby
|
12
|
-
gem 'snaptrade', '~> 1.17.
|
12
|
+
gem 'snaptrade', '~> 1.17.3'
|
13
13
|
```
|
14
14
|
|
15
15
|
## Getting Started
|
@@ -48,7 +48,7 @@ Class | Method | HTTP request | Description
|
|
48
48
|
*SnapTrade::AccountInformationApi* | [**get_user_account_details**](docs/AccountInformationApi.md#get_user_account_details) | **GET** /accounts/{accountId} | Return details of a specific investment account
|
49
49
|
*SnapTrade::AccountInformationApi* | [**get_user_account_orders**](docs/AccountInformationApi.md#get_user_account_orders) | **GET** /accounts/{accountId}/orders | Get history of orders placed in account
|
50
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
|
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
52
|
*SnapTrade::AccountInformationApi* | [**list_user_accounts**](docs/AccountInformationApi.md#list_user_accounts) | **GET** /accounts | List accounts
|
53
53
|
*SnapTrade::AccountInformationApi* | [**update_user_account**](docs/AccountInformationApi.md#update_user_account) | **PUT** /accounts/{accountId} | Update details of an investment account
|
54
54
|
*SnapTrade::APIStatusApi* | [**check**](docs/APIStatusApi.md#check) | **GET** / | Get API Status
|
@@ -69,7 +69,7 @@ Class | Method | HTTP request | Description
|
|
69
69
|
*SnapTrade::OptionsApi* | [**place_option_strategy**](docs/OptionsApi.md#place_option_strategy) | **POST** /accounts/{accountId}/optionStrategy/{optionStrategyId}/execute | Place an option strategy order on the brokerage
|
70
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
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
|
72
|
+
*SnapTrade::ReferenceDataApi* | [**get_security_types**](docs/ReferenceDataApi.md#get_security_types) | **GET** /securityTypes | List of all security types
|
73
73
|
*SnapTrade::ReferenceDataApi* | [**get_stock_exchanges**](docs/ReferenceDataApi.md#get_stock_exchanges) | **GET** /exchanges | List exchanges
|
74
74
|
*SnapTrade::ReferenceDataApi* | [**get_symbols**](docs/ReferenceDataApi.md#get_symbols) | **POST** /symbols | Search for symbols
|
75
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
|
@@ -135,6 +135,7 @@ Class | Method | HTTP request | Description
|
|
135
135
|
- [SnapTrade::Model401FailedRequestResponse](docs/Model401FailedRequestResponse.md)
|
136
136
|
- [SnapTrade::Model403FailedRequestResponse](docs/Model403FailedRequestResponse.md)
|
137
137
|
- [SnapTrade::Model404FailedRequestResponse](docs/Model404FailedRequestResponse.md)
|
138
|
+
- [SnapTrade::Model500UnexpectedExceptionResponse](docs/Model500UnexpectedExceptionResponse.md)
|
138
139
|
- [SnapTrade::ModelAssetClass](docs/ModelAssetClass.md)
|
139
140
|
- [SnapTrade::ModelAssetClassDetails](docs/ModelAssetClassDetails.md)
|
140
141
|
- [SnapTrade::ModelAssetClassTarget](docs/ModelAssetClassTarget.md)
|
@@ -9,7 +9,7 @@ All URIs are relative to *https://api.snaptrade.com/api/v1*
|
|
9
9
|
| [**get_user_account_details**](AccountInformationApi.md#get_user_account_details) | **GET** /accounts/{accountId} | Return details of a specific investment account |
|
10
10
|
| [**get_user_account_orders**](AccountInformationApi.md#get_user_account_orders) | **GET** /accounts/{accountId}/orders | Get history of orders placed in account |
|
11
11
|
| [**get_user_account_positions**](AccountInformationApi.md#get_user_account_positions) | **GET** /accounts/{accountId}/positions | List account positions |
|
12
|
-
| [**get_user_holdings**](AccountInformationApi.md#get_user_holdings) | **GET** /accounts/{accountId}/holdings | List balances, positions and orders for the specified account
|
12
|
+
| [**get_user_holdings**](AccountInformationApi.md#get_user_holdings) | **GET** /accounts/{accountId}/holdings | List balances, positions and orders for the specified account |
|
13
13
|
| [**list_user_accounts**](AccountInformationApi.md#list_user_accounts) | **GET** /accounts | List accounts |
|
14
14
|
| [**update_user_account**](AccountInformationApi.md#update_user_account) | **PUT** /accounts/{accountId} | Update details of an investment account |
|
15
15
|
|
@@ -82,6 +82,8 @@ end
|
|
82
82
|
|
83
83
|
List account balances
|
84
84
|
|
85
|
+
A list of account balances for the specified account (one per currency that the account holds).
|
86
|
+
|
85
87
|
### Example
|
86
88
|
|
87
89
|
```ruby
|
@@ -137,7 +139,7 @@ end
|
|
137
139
|
| ---- | ---- | ----------- | ----- |
|
138
140
|
| **user_id** | **String** | | |
|
139
141
|
| **user_secret** | **String** | | |
|
140
|
-
| **account_id** | **String** | The ID of the account get
|
142
|
+
| **account_id** | **String** | The ID of the account to get balances. | |
|
141
143
|
|
142
144
|
### Return type
|
143
145
|
|
@@ -212,6 +214,8 @@ end
|
|
212
214
|
|
213
215
|
Get history of orders placed in account
|
214
216
|
|
217
|
+
Fetch all recent orders from a user's account.
|
218
|
+
|
215
219
|
### Example
|
216
220
|
|
217
221
|
```ruby
|
@@ -271,7 +275,7 @@ end
|
|
271
275
|
| ---- | ---- | ----------- | ----- |
|
272
276
|
| **user_id** | **String** | | |
|
273
277
|
| **user_secret** | **String** | | |
|
274
|
-
| **account_id** | **String** | The ID of the account get
|
278
|
+
| **account_id** | **String** | The ID of the account to get orders. | |
|
275
279
|
| **state** | **String** | defaults value is set to \"all\" | [optional] |
|
276
280
|
|
277
281
|
### Return type
|
@@ -337,7 +341,7 @@ end
|
|
337
341
|
| ---- | ---- | ----------- | ----- |
|
338
342
|
| **user_id** | **String** | | |
|
339
343
|
| **user_secret** | **String** | | |
|
340
|
-
| **account_id** | **String** | The ID of the account get positions. | |
|
344
|
+
| **account_id** | **String** | The ID of the account to get positions. | |
|
341
345
|
|
342
346
|
### Return type
|
343
347
|
|
@@ -345,7 +349,7 @@ end
|
|
345
349
|
|
346
350
|
## get_user_holdings
|
347
351
|
|
348
|
-
List balances, positions and orders for the specified account
|
352
|
+
List balances, positions and orders for the specified account
|
349
353
|
|
350
354
|
### Example
|
351
355
|
|
@@ -360,7 +364,7 @@ user_id = "John.doe@snaptrade.com"
|
|
360
364
|
user_secret = "USERSECRET123"
|
361
365
|
|
362
366
|
begin
|
363
|
-
# List balances, positions and orders for the specified account
|
367
|
+
# List balances, positions and orders for the specified account
|
364
368
|
result = SnapTrade::AccountInformation.get_user_holdings(
|
365
369
|
account_id: account_id,
|
366
370
|
user_id: user_id,
|
@@ -382,7 +386,7 @@ user_id = "John.doe@snaptrade.com"
|
|
382
386
|
user_secret = "USERSECRET123"
|
383
387
|
|
384
388
|
begin
|
385
|
-
# List balances, positions and orders for the specified account
|
389
|
+
# List balances, positions and orders for the specified account
|
386
390
|
data, status_code, headers, response = SnapTrade::AccountInformation.get_user_holdings_with_http_info(
|
387
391
|
account_id: account_id,
|
388
392
|
user_id: user_id,
|
data/docs/AuthenticationApi.md
CHANGED
@@ -14,6 +14,8 @@ All URIs are relative to *https://api.snaptrade.com/api/v1*
|
|
14
14
|
|
15
15
|
Delete SnapTrade user
|
16
16
|
|
17
|
+
Deletes a user you've registered over the SnapTrade API, and any data associated with them or their investment accounts.
|
18
|
+
|
17
19
|
### Example
|
18
20
|
|
19
21
|
```ruby
|
@@ -129,6 +131,8 @@ end
|
|
129
131
|
|
130
132
|
List SnapTrade users
|
131
133
|
|
134
|
+
Returns a list of users you've registered over the SnapTrade API.
|
135
|
+
|
132
136
|
### Example
|
133
137
|
|
134
138
|
```ruby
|
@@ -176,6 +180,8 @@ This endpoint does not need any parameter.
|
|
176
180
|
|
177
181
|
Login user & generate connection link
|
178
182
|
|
183
|
+
Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
|
184
|
+
|
179
185
|
### Example
|
180
186
|
|
181
187
|
```ruby
|
@@ -266,13 +272,11 @@ SnapTrade.client_id = "YOUR_CLIENT_ID"
|
|
266
272
|
SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
267
273
|
|
268
274
|
user_id = "snaptrade-user-123"
|
269
|
-
rsa_public_key = "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC7vbqajDw4o6gJy8UtmIbkcpnkO3Kwc4qsEnSZp/TR+fQi62F79RHWmwKOtFmwteURgLbj7D/WGuNLGOfa/2vse3G2eHnHl5CB8ruRX9fBl/KgwCVr2JaEuUm66bBQeP5XeBotdR4cvX38uPYivCDdPjJ1QWPdspTBKcxeFbccDw=="
|
270
275
|
|
271
276
|
begin
|
272
277
|
# Create SnapTrade user
|
273
278
|
result = SnapTrade::Authentication.register_snap_trade_user(
|
274
279
|
user_id: user_id,
|
275
|
-
rsa_public_key: rsa_public_key,
|
276
280
|
)
|
277
281
|
p result
|
278
282
|
rescue SnapTrade::ApiError => e
|
@@ -286,13 +290,11 @@ This returns an Array which contains the response data, status code and headers.
|
|
286
290
|
|
287
291
|
```ruby
|
288
292
|
user_id = "snaptrade-user-123"
|
289
|
-
rsa_public_key = "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC7vbqajDw4o6gJy8UtmIbkcpnkO3Kwc4qsEnSZp/TR+fQi62F79RHWmwKOtFmwteURgLbj7D/WGuNLGOfa/2vse3G2eHnHl5CB8ruRX9fBl/KgwCVr2JaEuUm66bBQeP5XeBotdR4cvX38uPYivCDdPjJ1QWPdspTBKcxeFbccDw=="
|
290
293
|
|
291
294
|
begin
|
292
295
|
# Create SnapTrade user
|
293
296
|
data, status_code, headers, response = SnapTrade::Authentication.register_snap_trade_user_with_http_info(
|
294
297
|
user_id: user_id,
|
295
|
-
rsa_public_key: rsa_public_key,
|
296
298
|
)
|
297
299
|
p status_code # => 2xx
|
298
300
|
p headers # => { ... }
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# SnapTrade::Model500UnexpectedExceptionResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **detail** | **Object** | | [optional] |
|
8
|
+
| **status_code** | **Object** | | [optional] |
|
9
|
+
| **code** | **Object** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'snaptrade'
|
15
|
+
|
16
|
+
instance = SnapTrade::Model500UnexpectedExceptionResponse.new(
|
17
|
+
detail: Encountered an unexpected exception.,
|
18
|
+
status_code: 500,
|
19
|
+
code: 1000
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/OptionsApi.md
CHANGED
@@ -93,7 +93,7 @@ end
|
|
93
93
|
| ---- | ---- | ----------- | ----- |
|
94
94
|
| **user_id** | **String** | | |
|
95
95
|
| **user_secret** | **String** | | |
|
96
|
-
| **account_id** | **String** | The ID of the account
|
96
|
+
| **account_id** | **String** | The ID of the account to create the option strategy object in. | |
|
97
97
|
| **options_get_option_strategy_request** | [**OptionsGetOptionStrategyRequest**](OptionsGetOptionStrategyRequest.md) | | |
|
98
98
|
|
99
99
|
### Return type
|
@@ -163,7 +163,7 @@ end
|
|
163
163
|
| ---- | ---- | ----------- | ----- |
|
164
164
|
| **user_id** | **String** | | |
|
165
165
|
| **user_secret** | **String** | | |
|
166
|
-
| **account_id** | **String** | The ID of the account get
|
166
|
+
| **account_id** | **String** | The ID of the account to get the options chain from. | |
|
167
167
|
| **symbol** | **String** | Universal symbol ID if symbol | |
|
168
168
|
|
169
169
|
### Return type
|
@@ -233,7 +233,7 @@ end
|
|
233
233
|
| ---- | ---- | ----------- | ----- |
|
234
234
|
| **user_id** | **String** | | |
|
235
235
|
| **user_secret** | **String** | | |
|
236
|
-
| **account_id** | **String** | The ID of the account
|
236
|
+
| **account_id** | **String** | The ID of the account the strategy will be placed in. | |
|
237
237
|
| **option_strategy_id** | **String** | Option strategy id obtained from response when creating option strategy object | |
|
238
238
|
|
239
239
|
### Return type
|
@@ -299,7 +299,7 @@ end
|
|
299
299
|
| ---- | ---- | ----------- | ----- |
|
300
300
|
| **user_id** | **String** | | |
|
301
301
|
| **user_secret** | **String** | | |
|
302
|
-
| **account_id** | **String** | The ID of the account
|
302
|
+
| **account_id** | **String** | The ID of the account to fetch options holdings for. | |
|
303
303
|
|
304
304
|
### Return type
|
305
305
|
|
@@ -380,7 +380,7 @@ end
|
|
380
380
|
| ---- | ---- | ----------- | ----- |
|
381
381
|
| **user_id** | **String** | | |
|
382
382
|
| **user_secret** | **String** | | |
|
383
|
-
| **account_id** | **String** | The ID of the account
|
383
|
+
| **account_id** | **String** | The ID of the account to execute the strategy in. | |
|
384
384
|
| **option_strategy_id** | **String** | Option strategy id obtained from response when creating option strategy object | |
|
385
385
|
| **options_place_option_strategy_request** | [**OptionsPlaceOptionStrategyRequest**](OptionsPlaceOptionStrategyRequest.md) | | |
|
386
386
|
|
data/docs/OptionsPosition.md
CHANGED
@@ -9,8 +9,6 @@
|
|
9
9
|
| **units** | **Float** | | [optional] |
|
10
10
|
| **currency** | [**OptionsPositionCurrency**](OptionsPositionCurrency.md) | | [optional] |
|
11
11
|
| **average_purchase_price** | **Float** | Average purchase price for this position | [optional] |
|
12
|
-
| **open_pnl** | **Float** | | [optional] |
|
13
|
-
| **fractional_units** | **Float** | Deprecated, use the units field for both fractional and integer units going forward | [optional] |
|
14
12
|
|
15
13
|
## Example
|
16
14
|
|
@@ -22,9 +20,7 @@ instance = SnapTrade::OptionsPosition.new(
|
|
22
20
|
price: 31.33,
|
23
21
|
units: 10,
|
24
22
|
currency: null,
|
25
|
-
average_purchase_price: 108.3353
|
26
|
-
open_pnl: 0.44,
|
27
|
-
fractional_units: 1.44
|
23
|
+
average_purchase_price: 108.3353
|
28
24
|
)
|
29
25
|
```
|
30
26
|
|
data/docs/ReferenceDataApi.md
CHANGED
@@ -6,7 +6,7 @@ All URIs are relative to *https://api.snaptrade.com/api/v1*
|
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**get_currency_exchange_rate_pair**](ReferenceDataApi.md#get_currency_exchange_rate_pair) | **GET** /currencies/rates/{currencyPair} | Return the exchange rate of a currency pair |
|
8
8
|
| [**get_partner_info**](ReferenceDataApi.md#get_partner_info) | **GET** /snapTrade/partners | Get metadata related to Snaptrade partner |
|
9
|
-
| [**get_security_types**](ReferenceDataApi.md#get_security_types) | **GET** /securityTypes | List of all security types
|
9
|
+
| [**get_security_types**](ReferenceDataApi.md#get_security_types) | **GET** /securityTypes | List of all security types |
|
10
10
|
| [**get_stock_exchanges**](ReferenceDataApi.md#get_stock_exchanges) | **GET** /exchanges | List exchanges |
|
11
11
|
| [**get_symbols**](ReferenceDataApi.md#get_symbols) | **POST** /symbols | Search for symbols |
|
12
12
|
| [**get_symbols_by_ticker**](ReferenceDataApi.md#get_symbols_by_ticker) | **GET** /symbols/{ticker} | Get details of a symbol by the ticker |
|
@@ -120,7 +120,9 @@ This endpoint does not need any parameter.
|
|
120
120
|
|
121
121
|
## get_security_types
|
122
122
|
|
123
|
-
List of all security types
|
123
|
+
List of all security types
|
124
|
+
|
125
|
+
List security types available on SnapTrade.
|
124
126
|
|
125
127
|
### Example
|
126
128
|
|
@@ -132,7 +134,7 @@ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
|
|
132
134
|
|
133
135
|
|
134
136
|
begin
|
135
|
-
# List of all security types
|
137
|
+
# List of all security types
|
136
138
|
result = SnapTrade::ReferenceData.get_security_types
|
137
139
|
p result
|
138
140
|
rescue SnapTrade::ApiError => e
|
@@ -147,7 +149,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
147
149
|
```ruby
|
148
150
|
|
149
151
|
begin
|
150
|
-
# List of all security types
|
152
|
+
# List of all security types
|
151
153
|
data, status_code, headers, response = SnapTrade::ReferenceData.get_security_types_with_http_info
|
152
154
|
p status_code # => 2xx
|
153
155
|
p headers # => { ... }
|
@@ -586,7 +588,7 @@ end
|
|
586
588
|
| ---- | ---- | ----------- | ----- |
|
587
589
|
| **user_id** | **String** | | |
|
588
590
|
| **user_secret** | **String** | | |
|
589
|
-
| **account_id** | **String** | The ID of the account
|
591
|
+
| **account_id** | **String** | The ID of the account to search for symbols within. | |
|
590
592
|
| **symbol_query** | [**SymbolQuery**](SymbolQuery.md) | | [optional] |
|
591
593
|
|
592
594
|
### Return type
|
@@ -4,10 +4,10 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **broker** | **String** |
|
8
|
-
| **immediate_redirect** | **Boolean** |
|
9
|
-
| **custom_redirect** | **String** |
|
10
|
-
| **reconnect** | **String** |
|
7
|
+
| **broker** | **String** | Slug of the brokerage to connect the user to | [optional] |
|
8
|
+
| **immediate_redirect** | **Boolean** | When set to True, user will be redirected back to the partner's site instead of the connection portal | [optional] |
|
9
|
+
| **custom_redirect** | **String** | URL to redirect the user to after the user connects their brokerage account | [optional] |
|
10
|
+
| **reconnect** | **String** | The UUID of the brokerage connection to be reconnected | [optional] |
|
11
11
|
| **connection_type** | [**ConnectionType**](ConnectionType.md) | | [optional] |
|
12
12
|
|
13
13
|
## Example
|
@@ -5,7 +5,6 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **user_id** | **String** | SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user | [optional] |
|
8
|
-
| **rsa_public_key** | **String** | Open SSH RSA public key | [optional] |
|
9
8
|
|
10
9
|
## Example
|
11
10
|
|
@@ -13,8 +12,7 @@
|
|
13
12
|
require 'snaptrade'
|
14
13
|
|
15
14
|
instance = SnapTrade::SnapTradeRegisterUserRequestBody.new(
|
16
|
-
user_id: snaptrade-user-123
|
17
|
-
rsa_public_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC7vbqajDw4o6gJy8UtmIbkcpnkO3Kwc4qsEnSZp/TR+fQi62F79RHWmwKOtFmwteURgLbj7D/WGuNLGOfa/2vse3G2eHnHl5CB8ruRX9fBl/KgwCVr2JaEuUm66bBQeP5XeBotdR4cvX38uPYivCDdPjJ1QWPdspTBKcxeFbccDw==
|
15
|
+
user_id: snaptrade-user-123
|
18
16
|
)
|
19
17
|
```
|
20
18
|
|
data/docs/TradingApi.md
CHANGED
@@ -74,7 +74,7 @@ end
|
|
74
74
|
| ---- | ---- | ----------- | ----- |
|
75
75
|
| **user_id** | **String** | | |
|
76
76
|
| **user_secret** | **String** | | |
|
77
|
-
| **account_id** | **String** | The ID of the account
|
77
|
+
| **account_id** | **String** | The ID of the account to cancel the order in. | |
|
78
78
|
| **trading_cancel_user_account_order_request** | [**TradingCancelUserAccountOrderRequest**](TradingCancelUserAccountOrderRequest.md) | The Order ID to be canceled | |
|
79
79
|
|
80
80
|
### Return type
|
@@ -11,7 +11,7 @@ All URIs are relative to *https://api.snaptrade.com/api/v1*
|
|
11
11
|
|
12
12
|
Get transaction history for a user
|
13
13
|
|
14
|
-
Returns activities (transactions) for a user. Specifing start and end date is highly recommended for
|
14
|
+
Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
|
15
15
|
|
16
16
|
### Example
|
17
17
|
|
@@ -113,9 +113,10 @@ module SnapTrade
|
|
113
113
|
|
114
114
|
|
115
115
|
# List account balances
|
116
|
+
# A list of account balances for the specified account (one per currency that the account holds).
|
116
117
|
# @param user_id [String]
|
117
118
|
# @param user_secret [String]
|
118
|
-
# @param account_id [String] The ID of the account get
|
119
|
+
# @param account_id [String] The ID of the account to get balances.
|
119
120
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
120
121
|
def get_user_account_balance(user_id:, user_secret:, account_id:, extra: {})
|
121
122
|
data, _status_code, _headers = get_user_account_balance_with_http_info_impl(user_id, user_secret, account_id, extra)
|
@@ -123,18 +124,20 @@ module SnapTrade
|
|
123
124
|
end
|
124
125
|
|
125
126
|
# List account balances
|
127
|
+
# A list of account balances for the specified account (one per currency that the account holds).
|
126
128
|
# @param user_id [String]
|
127
129
|
# @param user_secret [String]
|
128
|
-
# @param account_id [String] The ID of the account get
|
130
|
+
# @param account_id [String] The ID of the account to get balances.
|
129
131
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
130
132
|
def get_user_account_balance_with_http_info(user_id:, user_secret:, account_id:, extra: {})
|
131
133
|
get_user_account_balance_with_http_info_impl(user_id, user_secret, account_id, extra)
|
132
134
|
end
|
133
135
|
|
134
136
|
# List account balances
|
137
|
+
# A list of account balances for the specified account (one per currency that the account holds).
|
135
138
|
# @param user_id [String]
|
136
139
|
# @param user_secret [String]
|
137
|
-
# @param account_id [String] The ID of the account get
|
140
|
+
# @param account_id [String] The ID of the account to get balances.
|
138
141
|
# @param [Hash] opts the optional parameters
|
139
142
|
# @return [Array<Balance>]
|
140
143
|
def get_user_account_balance_impl(user_id, user_secret, account_id, opts = {})
|
@@ -143,9 +146,10 @@ module SnapTrade
|
|
143
146
|
end
|
144
147
|
|
145
148
|
# List account balances
|
149
|
+
# A list of account balances for the specified account (one per currency that the account holds).
|
146
150
|
# @param user_id [String]
|
147
151
|
# @param user_secret [String]
|
148
|
-
# @param account_id [String] The ID of the account get
|
152
|
+
# @param account_id [String] The ID of the account to get balances.
|
149
153
|
# @param [Hash] opts the optional parameters
|
150
154
|
# @return [Array<(Array<Balance>, Integer, Hash)>] Array<Balance> data, response status code and response headers
|
151
155
|
def get_user_account_balance_with_http_info_impl(user_id, user_secret, account_id, opts = {})
|
@@ -303,9 +307,10 @@ module SnapTrade
|
|
303
307
|
|
304
308
|
|
305
309
|
# Get history of orders placed in account
|
310
|
+
# Fetch all recent orders from a user's account.
|
306
311
|
# @param user_id [String]
|
307
312
|
# @param user_secret [String]
|
308
|
-
# @param account_id [String] The ID of the account get
|
313
|
+
# @param account_id [String] The ID of the account to get orders.
|
309
314
|
# @param state [String] defaults value is set to \"all\"
|
310
315
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
311
316
|
def get_user_account_orders(user_id:, user_secret:, account_id:, state: SENTINEL, extra: {})
|
@@ -315,9 +320,10 @@ module SnapTrade
|
|
315
320
|
end
|
316
321
|
|
317
322
|
# Get history of orders placed in account
|
323
|
+
# Fetch all recent orders from a user's account.
|
318
324
|
# @param user_id [String]
|
319
325
|
# @param user_secret [String]
|
320
|
-
# @param account_id [String] The ID of the account get
|
326
|
+
# @param account_id [String] The ID of the account to get orders.
|
321
327
|
# @param state [String] defaults value is set to \"all\"
|
322
328
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
323
329
|
def get_user_account_orders_with_http_info(user_id:, user_secret:, account_id:, state: SENTINEL, extra: {})
|
@@ -326,9 +332,10 @@ module SnapTrade
|
|
326
332
|
end
|
327
333
|
|
328
334
|
# Get history of orders placed in account
|
335
|
+
# Fetch all recent orders from a user's account.
|
329
336
|
# @param user_id [String]
|
330
337
|
# @param user_secret [String]
|
331
|
-
# @param account_id [String] The ID of the account get
|
338
|
+
# @param account_id [String] The ID of the account to get orders.
|
332
339
|
# @param [Hash] opts the optional parameters
|
333
340
|
# @option opts [String] :state defaults value is set to \"all\"
|
334
341
|
# @return [Array<AccountOrderRecord>]
|
@@ -338,9 +345,10 @@ module SnapTrade
|
|
338
345
|
end
|
339
346
|
|
340
347
|
# Get history of orders placed in account
|
348
|
+
# Fetch all recent orders from a user's account.
|
341
349
|
# @param user_id [String]
|
342
350
|
# @param user_secret [String]
|
343
|
-
# @param account_id [String] The ID of the account get
|
351
|
+
# @param account_id [String] The ID of the account to get orders.
|
344
352
|
# @param [Hash] opts the optional parameters
|
345
353
|
# @option opts [String] :state defaults value is set to \"all\"
|
346
354
|
# @return [Array<(Array<AccountOrderRecord>, Integer, Hash)>] Array<AccountOrderRecord> data, response status code and response headers
|
@@ -411,7 +419,7 @@ module SnapTrade
|
|
411
419
|
# List account positions
|
412
420
|
# @param user_id [String]
|
413
421
|
# @param user_secret [String]
|
414
|
-
# @param account_id [String] The ID of the account get positions.
|
422
|
+
# @param account_id [String] The ID of the account to get positions.
|
415
423
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
416
424
|
def get_user_account_positions(user_id:, user_secret:, account_id:, extra: {})
|
417
425
|
data, _status_code, _headers = get_user_account_positions_with_http_info_impl(user_id, user_secret, account_id, extra)
|
@@ -421,7 +429,7 @@ module SnapTrade
|
|
421
429
|
# List account positions
|
422
430
|
# @param user_id [String]
|
423
431
|
# @param user_secret [String]
|
424
|
-
# @param account_id [String] The ID of the account get positions.
|
432
|
+
# @param account_id [String] The ID of the account to get positions.
|
425
433
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
426
434
|
def get_user_account_positions_with_http_info(user_id:, user_secret:, account_id:, extra: {})
|
427
435
|
get_user_account_positions_with_http_info_impl(user_id, user_secret, account_id, extra)
|
@@ -430,7 +438,7 @@ module SnapTrade
|
|
430
438
|
# List account positions
|
431
439
|
# @param user_id [String]
|
432
440
|
# @param user_secret [String]
|
433
|
-
# @param account_id [String] The ID of the account get positions.
|
441
|
+
# @param account_id [String] The ID of the account to get positions.
|
434
442
|
# @param [Hash] opts the optional parameters
|
435
443
|
# @return [Array<Position>]
|
436
444
|
def get_user_account_positions_impl(user_id, user_secret, account_id, opts = {})
|
@@ -441,7 +449,7 @@ module SnapTrade
|
|
441
449
|
# List account positions
|
442
450
|
# @param user_id [String]
|
443
451
|
# @param user_secret [String]
|
444
|
-
# @param account_id [String] The ID of the account get positions.
|
452
|
+
# @param account_id [String] The ID of the account to get positions.
|
445
453
|
# @param [Hash] opts the optional parameters
|
446
454
|
# @return [Array<(Array<Position>, Integer, Hash)>] Array<Position> data, response status code and response headers
|
447
455
|
def get_user_account_positions_with_http_info_impl(user_id, user_secret, account_id, opts = {})
|
@@ -503,7 +511,7 @@ module SnapTrade
|
|
503
511
|
end
|
504
512
|
|
505
513
|
|
506
|
-
# List balances, positions and orders for the specified account
|
514
|
+
# List balances, positions and orders for the specified account
|
507
515
|
# @param account_id [String] The ID of the account to fetch holdings for.
|
508
516
|
# @param user_id [String]
|
509
517
|
# @param user_secret [String]
|
@@ -513,7 +521,7 @@ module SnapTrade
|
|
513
521
|
data
|
514
522
|
end
|
515
523
|
|
516
|
-
# List balances, positions and orders for the specified account
|
524
|
+
# List balances, positions and orders for the specified account
|
517
525
|
# @param account_id [String] The ID of the account to fetch holdings for.
|
518
526
|
# @param user_id [String]
|
519
527
|
# @param user_secret [String]
|
@@ -522,7 +530,7 @@ module SnapTrade
|
|
522
530
|
get_user_holdings_with_http_info_impl(account_id, user_id, user_secret, extra)
|
523
531
|
end
|
524
532
|
|
525
|
-
# List balances, positions and orders for the specified account
|
533
|
+
# List balances, positions and orders for the specified account
|
526
534
|
# @param account_id [String] The ID of the account to fetch holdings for.
|
527
535
|
# @param user_id [String]
|
528
536
|
# @param user_secret [String]
|
@@ -533,7 +541,7 @@ module SnapTrade
|
|
533
541
|
data
|
534
542
|
end
|
535
543
|
|
536
|
-
# List balances, positions and orders for the specified account
|
544
|
+
# List balances, positions and orders for the specified account
|
537
545
|
# @param account_id [String] The ID of the account to fetch holdings for.
|
538
546
|
# @param user_id [String]
|
539
547
|
# @param user_secret [String]
|