snaptrade 2.0.16 → 2.0.17
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 +15 -12
- data/lib/snaptrade/api/account_information_api.rb +4 -4
- data/lib/snaptrade/api/connections_api.rb +32 -8
- data/lib/snaptrade/api/options_api.rb +50 -20
- data/lib/snaptrade/version.rb +1 -1
- data/spec/api/account_information_api_spec.rb +1 -1
- data/spec/api/connections_api_spec.rb +6 -2
- data/spec/api/options_api_spec.rb +10 -5
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3d92b0f13dc8029767eab7132f8eb60c79cabd15cd4b67d4a791eaeda3002d40
|
4
|
+
data.tar.gz: ea03b59315889c14157aa3b1eb287207a2464ba8829bc7bcbfce4f7b6be4facc
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f462f87c7d23bc96049bab41e0ede58f1456b9b49c832acc87d3b085eb425992d7c001057a4be2e179a609647cbe23aa3ade7d069011e5d9a3b2d1b0a596cd40
|
7
|
+
data.tar.gz: 768feef57059c893141b5ee4aeb0cc57ea99145de77e733112cd6650d67449e8cffcadfe6ba18ec0af2f928e63fbd28d669d07a5784fa86d3af38314611bef20
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
|
7
7
|
Connect brokerage accounts to your app for live positions and trading
|
8
8
|
|
9
|
-
[![npm](https://img.shields.io/badge/gem-v2.0.
|
9
|
+
[![npm](https://img.shields.io/badge/gem-v2.0.17-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.17)
|
10
10
|
[![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
|
11
11
|
|
12
12
|
</div>
|
@@ -69,7 +69,7 @@ Connect brokerage accounts to your app for live positions and trading
|
|
69
69
|
Add to Gemfile:
|
70
70
|
|
71
71
|
```ruby
|
72
|
-
gem 'snaptrade', '~> 2.0.
|
72
|
+
gem 'snaptrade', '~> 2.0.17'
|
73
73
|
```
|
74
74
|
|
75
75
|
## Getting Started<a id="getting-started"></a>
|
@@ -264,7 +264,7 @@ Number of days in the past to fetch the most recent orders. Defaults to the last
|
|
264
264
|
|
265
265
|
### `snaptrade.account_information.get_user_account_positions`<a id="snaptradeaccount_informationget_user_account_positions"></a>
|
266
266
|
|
267
|
-
Returns a list of positions in the
|
267
|
+
Returns a list of positions in the specified account.
|
268
268
|
|
269
269
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
270
270
|
|
@@ -641,7 +641,7 @@ SnapTrade user.
|
|
641
641
|
|
642
642
|
### `snaptrade.connections.detail_brokerage_authorization`<a id="snaptradeconnectionsdetail_brokerage_authorization"></a>
|
643
643
|
|
644
|
-
|
644
|
+
Returns a single brokerage authorization object for the specified ID.
|
645
645
|
|
646
646
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
647
647
|
|
@@ -676,7 +676,7 @@ The ID of a brokerage authorization object.
|
|
676
676
|
|
677
677
|
### `snaptrade.connections.list_brokerage_authorizations`<a id="snaptradeconnectionslist_brokerage_authorizations"></a>
|
678
678
|
|
679
|
-
|
679
|
+
Returns a list of Brokerage Autherization objects for the specified userId.
|
680
680
|
|
681
681
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
682
682
|
|
@@ -707,7 +707,7 @@ p result
|
|
707
707
|
|
708
708
|
### `snaptrade.connections.remove_brokerage_authorization`<a id="snaptradeconnectionsremove_brokerage_authorization"></a>
|
709
709
|
|
710
|
-
|
710
|
+
Deletes a specified brokerage authorization given by the ID.
|
711
711
|
|
712
712
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
713
713
|
|
@@ -737,7 +737,7 @@ The ID of the Authorization to delete.
|
|
737
737
|
|
738
738
|
### `snaptrade.connections.session_events`<a id="snaptradeconnectionssession_events"></a>
|
739
739
|
|
740
|
-
|
740
|
+
Returns a list of session events associated with a user.
|
741
741
|
|
742
742
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
743
743
|
|
@@ -776,7 +776,8 @@ specific users
|
|
776
776
|
|
777
777
|
### `snaptrade.options.get_option_strategy`<a id="snaptradeoptionsget_option_strategy"></a>
|
778
778
|
|
779
|
-
Creates an option strategy object that will be used to place an option strategy order
|
779
|
+
Creates an option strategy object that will be used to place an option strategy order.
|
780
|
+
|
780
781
|
|
781
782
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
782
783
|
|
@@ -823,7 +824,7 @@ The ID of the account to create the option strategy object in.
|
|
823
824
|
|
824
825
|
### `snaptrade.options.get_options_chain`<a id="snaptradeoptionsget_options_chain"></a>
|
825
826
|
|
826
|
-
|
827
|
+
Returns the option chain for the specified symbol in the specified account.
|
827
828
|
|
828
829
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
829
830
|
|
@@ -862,7 +863,8 @@ Universal symbol ID if symbol
|
|
862
863
|
|
863
864
|
### `snaptrade.options.get_options_strategy_quote`<a id="snaptradeoptionsget_options_strategy_quote"></a>
|
864
865
|
|
865
|
-
|
866
|
+
Returns a Strategy Quotes object which has latest market data of the specified option strategy.
|
867
|
+
|
866
868
|
|
867
869
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
868
870
|
|
@@ -901,7 +903,8 @@ Option strategy id obtained from response when creating option strategy object
|
|
901
903
|
|
902
904
|
### `snaptrade.options.list_option_holdings`<a id="snaptradeoptionslist_option_holdings"></a>
|
903
905
|
|
904
|
-
|
906
|
+
Returns a list of Options Positions.
|
907
|
+
|
905
908
|
|
906
909
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
907
910
|
|
@@ -936,7 +939,7 @@ The ID of the account to fetch options holdings for.
|
|
936
939
|
|
937
940
|
### `snaptrade.options.place_option_strategy`<a id="snaptradeoptionsplace_option_strategy"></a>
|
938
941
|
|
939
|
-
|
942
|
+
Places the option strategy order and returns the order record received from the brokerage.
|
940
943
|
|
941
944
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
942
945
|
|
@@ -456,7 +456,7 @@ module SnapTrade
|
|
456
456
|
|
457
457
|
# List account positions
|
458
458
|
#
|
459
|
-
# Returns a list of positions in the
|
459
|
+
# Returns a list of positions in the specified account.
|
460
460
|
#
|
461
461
|
# @param user_id [String]
|
462
462
|
# @param user_secret [String]
|
@@ -469,7 +469,7 @@ module SnapTrade
|
|
469
469
|
|
470
470
|
# List account positions
|
471
471
|
#
|
472
|
-
# Returns a list of positions in the
|
472
|
+
# Returns a list of positions in the specified account.
|
473
473
|
#
|
474
474
|
# @param user_id [String]
|
475
475
|
# @param user_secret [String]
|
@@ -480,7 +480,7 @@ module SnapTrade
|
|
480
480
|
end
|
481
481
|
|
482
482
|
# List account positions
|
483
|
-
# Returns a list of positions in the
|
483
|
+
# Returns a list of positions in the specified account.
|
484
484
|
# @param user_id [String]
|
485
485
|
# @param user_secret [String]
|
486
486
|
# @param account_id [String] The ID of the account to get positions.
|
@@ -492,7 +492,7 @@ module SnapTrade
|
|
492
492
|
end
|
493
493
|
|
494
494
|
# List account positions
|
495
|
-
# Returns a list of positions in the
|
495
|
+
# Returns a list of positions in the specified account.
|
496
496
|
# @param user_id [String]
|
497
497
|
# @param user_secret [String]
|
498
498
|
# @param account_id [String] The ID of the account to get positions.
|
@@ -19,6 +19,8 @@ module SnapTrade
|
|
19
19
|
|
20
20
|
# Get brokerage authorization details
|
21
21
|
#
|
22
|
+
# Returns a single brokerage authorization object for the specified ID.
|
23
|
+
#
|
22
24
|
# @param authorization_id [String] The ID of a brokerage authorization object.
|
23
25
|
# @param user_id [String]
|
24
26
|
# @param user_secret [String]
|
@@ -30,6 +32,8 @@ module SnapTrade
|
|
30
32
|
|
31
33
|
# Get brokerage authorization details
|
32
34
|
#
|
35
|
+
# Returns a single brokerage authorization object for the specified ID.
|
36
|
+
#
|
33
37
|
# @param authorization_id [String] The ID of a brokerage authorization object.
|
34
38
|
# @param user_id [String]
|
35
39
|
# @param user_secret [String]
|
@@ -39,6 +43,7 @@ module SnapTrade
|
|
39
43
|
end
|
40
44
|
|
41
45
|
# Get brokerage authorization details
|
46
|
+
# Returns a single brokerage authorization object for the specified ID.
|
42
47
|
# @param authorization_id [String] The ID of a brokerage authorization object.
|
43
48
|
# @param user_id [String]
|
44
49
|
# @param user_secret [String]
|
@@ -50,6 +55,7 @@ module SnapTrade
|
|
50
55
|
end
|
51
56
|
|
52
57
|
# Get brokerage authorization details
|
58
|
+
# Returns a single brokerage authorization object for the specified ID.
|
53
59
|
# @param authorization_id [String] The ID of a brokerage authorization object.
|
54
60
|
# @param user_id [String]
|
55
61
|
# @param user_secret [String]
|
@@ -114,7 +120,9 @@ module SnapTrade
|
|
114
120
|
end
|
115
121
|
|
116
122
|
|
117
|
-
# List all brokerage authorizations for the
|
123
|
+
# List all brokerage authorizations for the User
|
124
|
+
#
|
125
|
+
# Returns a list of Brokerage Autherization objects for the specified userId.
|
118
126
|
#
|
119
127
|
# @param user_id [String]
|
120
128
|
# @param user_secret [String]
|
@@ -124,7 +132,9 @@ module SnapTrade
|
|
124
132
|
data
|
125
133
|
end
|
126
134
|
|
127
|
-
# List all brokerage authorizations for the
|
135
|
+
# List all brokerage authorizations for the User
|
136
|
+
#
|
137
|
+
# Returns a list of Brokerage Autherization objects for the specified userId.
|
128
138
|
#
|
129
139
|
# @param user_id [String]
|
130
140
|
# @param user_secret [String]
|
@@ -133,7 +143,8 @@ module SnapTrade
|
|
133
143
|
list_brokerage_authorizations_with_http_info_impl(user_id, user_secret, extra)
|
134
144
|
end
|
135
145
|
|
136
|
-
# List all brokerage authorizations for the
|
146
|
+
# List all brokerage authorizations for the User
|
147
|
+
# Returns a list of Brokerage Autherization objects for the specified userId.
|
137
148
|
# @param user_id [String]
|
138
149
|
# @param user_secret [String]
|
139
150
|
# @param [Hash] opts the optional parameters
|
@@ -143,7 +154,8 @@ module SnapTrade
|
|
143
154
|
data
|
144
155
|
end
|
145
156
|
|
146
|
-
# List all brokerage authorizations for the
|
157
|
+
# List all brokerage authorizations for the User
|
158
|
+
# Returns a list of Brokerage Autherization objects for the specified userId.
|
147
159
|
# @param user_id [String]
|
148
160
|
# @param user_secret [String]
|
149
161
|
# @param [Hash] opts the optional parameters
|
@@ -205,6 +217,8 @@ module SnapTrade
|
|
205
217
|
|
206
218
|
# Delete brokerage authorization
|
207
219
|
#
|
220
|
+
# Deletes a specified brokerage authorization given by the ID.
|
221
|
+
#
|
208
222
|
# @param authorization_id [String] The ID of the Authorization to delete.
|
209
223
|
# @param user_id [String]
|
210
224
|
# @param user_secret [String]
|
@@ -216,6 +230,8 @@ module SnapTrade
|
|
216
230
|
|
217
231
|
# Delete brokerage authorization
|
218
232
|
#
|
233
|
+
# Deletes a specified brokerage authorization given by the ID.
|
234
|
+
#
|
219
235
|
# @param authorization_id [String] The ID of the Authorization to delete.
|
220
236
|
# @param user_id [String]
|
221
237
|
# @param user_secret [String]
|
@@ -225,6 +241,7 @@ module SnapTrade
|
|
225
241
|
end
|
226
242
|
|
227
243
|
# Delete brokerage authorization
|
244
|
+
# Deletes a specified brokerage authorization given by the ID.
|
228
245
|
# @param authorization_id [String] The ID of the Authorization to delete.
|
229
246
|
# @param user_id [String]
|
230
247
|
# @param user_secret [String]
|
@@ -236,6 +253,7 @@ module SnapTrade
|
|
236
253
|
end
|
237
254
|
|
238
255
|
# Delete brokerage authorization
|
256
|
+
# Deletes a specified brokerage authorization given by the ID.
|
239
257
|
# @param authorization_id [String] The ID of the Authorization to delete.
|
240
258
|
# @param user_id [String]
|
241
259
|
# @param user_secret [String]
|
@@ -298,7 +316,9 @@ module SnapTrade
|
|
298
316
|
end
|
299
317
|
|
300
318
|
|
301
|
-
#
|
319
|
+
# Get all session events for a user
|
320
|
+
#
|
321
|
+
# Returns a list of session events associated with a user.
|
302
322
|
#
|
303
323
|
# @param partner_client_id [String]
|
304
324
|
# @param user_id [String] Optional comma seperated list of user IDs used to filter the request on specific users
|
@@ -311,7 +331,9 @@ module SnapTrade
|
|
311
331
|
data
|
312
332
|
end
|
313
333
|
|
314
|
-
#
|
334
|
+
# Get all session events for a user
|
335
|
+
#
|
336
|
+
# Returns a list of session events associated with a user.
|
315
337
|
#
|
316
338
|
# @param partner_client_id [String]
|
317
339
|
# @param user_id [String] Optional comma seperated list of user IDs used to filter the request on specific users
|
@@ -323,7 +345,8 @@ module SnapTrade
|
|
323
345
|
session_events_with_http_info_impl(partner_client_id, extra)
|
324
346
|
end
|
325
347
|
|
326
|
-
#
|
348
|
+
# Get all session events for a user
|
349
|
+
# Returns a list of session events associated with a user.
|
327
350
|
# @param partner_client_id [String]
|
328
351
|
# @param [Hash] opts the optional parameters
|
329
352
|
# @option opts [String] :user_id Optional comma seperated list of user IDs used to filter the request on specific users
|
@@ -334,7 +357,8 @@ module SnapTrade
|
|
334
357
|
data
|
335
358
|
end
|
336
359
|
|
337
|
-
#
|
360
|
+
# Get all session events for a user
|
361
|
+
# Returns a list of session events associated with a user.
|
338
362
|
# @param partner_client_id [String]
|
339
363
|
# @param [Hash] opts the optional parameters
|
340
364
|
# @option opts [String] :user_id Optional comma seperated list of user IDs used to filter the request on specific users
|
@@ -17,7 +17,9 @@ module SnapTrade
|
|
17
17
|
@api_client = api_client
|
18
18
|
end
|
19
19
|
|
20
|
-
#
|
20
|
+
# Create options strategy
|
21
|
+
#
|
22
|
+
# Creates an option strategy object that will be used to place an option strategy order.
|
21
23
|
#
|
22
24
|
# @param underlying_symbol_id [String]
|
23
25
|
# @param legs [Array<OptionLeg>]
|
@@ -37,7 +39,9 @@ module SnapTrade
|
|
37
39
|
data
|
38
40
|
end
|
39
41
|
|
40
|
-
#
|
42
|
+
# Create options strategy
|
43
|
+
#
|
44
|
+
# Creates an option strategy object that will be used to place an option strategy order.
|
41
45
|
#
|
42
46
|
# @param underlying_symbol_id [String]
|
43
47
|
# @param legs [Array<OptionLeg>]
|
@@ -56,7 +60,8 @@ module SnapTrade
|
|
56
60
|
get_option_strategy_with_http_info_impl(user_id, user_secret, account_id, options_get_option_strategy_request, extra)
|
57
61
|
end
|
58
62
|
|
59
|
-
#
|
63
|
+
# Create options strategy
|
64
|
+
# Creates an option strategy object that will be used to place an option strategy order.
|
60
65
|
# @param user_id [String]
|
61
66
|
# @param user_secret [String]
|
62
67
|
# @param account_id [String] The ID of the account to create the option strategy object in.
|
@@ -68,7 +73,8 @@ module SnapTrade
|
|
68
73
|
data
|
69
74
|
end
|
70
75
|
|
71
|
-
#
|
76
|
+
# Create options strategy
|
77
|
+
# Creates an option strategy object that will be used to place an option strategy order.
|
72
78
|
# @param user_id [String]
|
73
79
|
# @param user_secret [String]
|
74
80
|
# @param account_id [String] The ID of the account to create the option strategy object in.
|
@@ -143,7 +149,9 @@ module SnapTrade
|
|
143
149
|
end
|
144
150
|
|
145
151
|
|
146
|
-
# Get the options chain
|
152
|
+
# Get the options chain for a symbol
|
153
|
+
#
|
154
|
+
# Returns the option chain for the specified symbol in the specified account.
|
147
155
|
#
|
148
156
|
# @param user_id [String]
|
149
157
|
# @param user_secret [String]
|
@@ -155,7 +163,9 @@ module SnapTrade
|
|
155
163
|
data
|
156
164
|
end
|
157
165
|
|
158
|
-
# Get the options chain
|
166
|
+
# Get the options chain for a symbol
|
167
|
+
#
|
168
|
+
# Returns the option chain for the specified symbol in the specified account.
|
159
169
|
#
|
160
170
|
# @param user_id [String]
|
161
171
|
# @param user_secret [String]
|
@@ -166,7 +176,8 @@ module SnapTrade
|
|
166
176
|
get_options_chain_with_http_info_impl(user_id, user_secret, account_id, symbol, extra)
|
167
177
|
end
|
168
178
|
|
169
|
-
# Get the options chain
|
179
|
+
# Get the options chain for a symbol
|
180
|
+
# Returns the option chain for the specified symbol in the specified account.
|
170
181
|
# @param user_id [String]
|
171
182
|
# @param user_secret [String]
|
172
183
|
# @param account_id [String] The ID of the account to get the options chain from.
|
@@ -178,7 +189,8 @@ module SnapTrade
|
|
178
189
|
data
|
179
190
|
end
|
180
191
|
|
181
|
-
# Get the options chain
|
192
|
+
# Get the options chain for a symbol
|
193
|
+
# Returns the option chain for the specified symbol in the specified account.
|
182
194
|
# @param user_id [String]
|
183
195
|
# @param user_secret [String]
|
184
196
|
# @param account_id [String] The ID of the account to get the options chain from.
|
@@ -249,7 +261,9 @@ module SnapTrade
|
|
249
261
|
end
|
250
262
|
|
251
263
|
|
252
|
-
# Get
|
264
|
+
# Get options strategy quotes
|
265
|
+
#
|
266
|
+
# Returns a Strategy Quotes object which has latest market data of the specified option strategy.
|
253
267
|
#
|
254
268
|
# @param user_id [String]
|
255
269
|
# @param user_secret [String]
|
@@ -261,7 +275,9 @@ module SnapTrade
|
|
261
275
|
data
|
262
276
|
end
|
263
277
|
|
264
|
-
# Get
|
278
|
+
# Get options strategy quotes
|
279
|
+
#
|
280
|
+
# Returns a Strategy Quotes object which has latest market data of the specified option strategy.
|
265
281
|
#
|
266
282
|
# @param user_id [String]
|
267
283
|
# @param user_secret [String]
|
@@ -272,7 +288,8 @@ module SnapTrade
|
|
272
288
|
get_options_strategy_quote_with_http_info_impl(user_id, user_secret, account_id, option_strategy_id, extra)
|
273
289
|
end
|
274
290
|
|
275
|
-
# Get
|
291
|
+
# Get options strategy quotes
|
292
|
+
# Returns a Strategy Quotes object which has latest market data of the specified option strategy.
|
276
293
|
# @param user_id [String]
|
277
294
|
# @param user_secret [String]
|
278
295
|
# @param account_id [String] The ID of the account the strategy will be placed in.
|
@@ -284,7 +301,8 @@ module SnapTrade
|
|
284
301
|
data
|
285
302
|
end
|
286
303
|
|
287
|
-
# Get
|
304
|
+
# Get options strategy quotes
|
305
|
+
# Returns a Strategy Quotes object which has latest market data of the specified option strategy.
|
288
306
|
# @param user_id [String]
|
289
307
|
# @param user_secret [String]
|
290
308
|
# @param account_id [String] The ID of the account the strategy will be placed in.
|
@@ -354,7 +372,9 @@ module SnapTrade
|
|
354
372
|
end
|
355
373
|
|
356
374
|
|
357
|
-
# Get
|
375
|
+
# Get account option holdings
|
376
|
+
#
|
377
|
+
# Returns a list of Options Positions.
|
358
378
|
#
|
359
379
|
# @param user_id [String]
|
360
380
|
# @param user_secret [String]
|
@@ -365,7 +385,9 @@ module SnapTrade
|
|
365
385
|
data
|
366
386
|
end
|
367
387
|
|
368
|
-
# Get
|
388
|
+
# Get account option holdings
|
389
|
+
#
|
390
|
+
# Returns a list of Options Positions.
|
369
391
|
#
|
370
392
|
# @param user_id [String]
|
371
393
|
# @param user_secret [String]
|
@@ -375,7 +397,8 @@ module SnapTrade
|
|
375
397
|
list_option_holdings_with_http_info_impl(user_id, user_secret, account_id, extra)
|
376
398
|
end
|
377
399
|
|
378
|
-
# Get
|
400
|
+
# Get account option holdings
|
401
|
+
# Returns a list of Options Positions.
|
379
402
|
# @param user_id [String]
|
380
403
|
# @param user_secret [String]
|
381
404
|
# @param account_id [String] The ID of the account to fetch options holdings for.
|
@@ -386,7 +409,8 @@ module SnapTrade
|
|
386
409
|
data
|
387
410
|
end
|
388
411
|
|
389
|
-
# Get
|
412
|
+
# Get account option holdings
|
413
|
+
# Returns a list of Options Positions.
|
390
414
|
# @param user_id [String]
|
391
415
|
# @param user_secret [String]
|
392
416
|
# @param account_id [String] The ID of the account to fetch options holdings for.
|
@@ -451,7 +475,9 @@ module SnapTrade
|
|
451
475
|
end
|
452
476
|
|
453
477
|
|
454
|
-
# Place an option strategy order
|
478
|
+
# Place an option strategy order
|
479
|
+
#
|
480
|
+
# Places the option strategy order and returns the order record received from the brokerage.
|
455
481
|
#
|
456
482
|
# @param order_type [OrderType] Order Type
|
457
483
|
# @param time_in_force [TimeInForceStrict] Trade time in force examples: * FOK - Fill Or Kill * Day - Day * GTC - Good Til Canceled
|
@@ -472,7 +498,9 @@ module SnapTrade
|
|
472
498
|
data
|
473
499
|
end
|
474
500
|
|
475
|
-
# Place an option strategy order
|
501
|
+
# Place an option strategy order
|
502
|
+
#
|
503
|
+
# Places the option strategy order and returns the order record received from the brokerage.
|
476
504
|
#
|
477
505
|
# @param order_type [OrderType] Order Type
|
478
506
|
# @param time_in_force [TimeInForceStrict] Trade time in force examples: * FOK - Fill Or Kill * Day - Day * GTC - Good Til Canceled
|
@@ -492,7 +520,8 @@ module SnapTrade
|
|
492
520
|
place_option_strategy_with_http_info_impl(user_id, user_secret, account_id, option_strategy_id, options_place_option_strategy_request, extra)
|
493
521
|
end
|
494
522
|
|
495
|
-
# Place an option strategy order
|
523
|
+
# Place an option strategy order
|
524
|
+
# Places the option strategy order and returns the order record received from the brokerage.
|
496
525
|
# @param user_id [String]
|
497
526
|
# @param user_secret [String]
|
498
527
|
# @param account_id [String] The ID of the account to execute the strategy in.
|
@@ -505,7 +534,8 @@ module SnapTrade
|
|
505
534
|
data
|
506
535
|
end
|
507
536
|
|
508
|
-
# Place an option strategy order
|
537
|
+
# Place an option strategy order
|
538
|
+
# Places the option strategy order and returns the order record received from the brokerage.
|
509
539
|
# @param user_id [String]
|
510
540
|
# @param user_secret [String]
|
511
541
|
# @param account_id [String] The ID of the account to execute the strategy in.
|
data/lib/snaptrade/version.rb
CHANGED
@@ -87,7 +87,7 @@ describe 'AccountInformationApi' do
|
|
87
87
|
|
88
88
|
# unit tests for get_user_account_positions
|
89
89
|
# List account positions
|
90
|
-
# Returns a list of positions in the
|
90
|
+
# Returns a list of positions in the specified account.
|
91
91
|
# @param user_id
|
92
92
|
# @param user_secret
|
93
93
|
# @param account_id The ID of the account to get positions.
|
@@ -29,6 +29,7 @@ describe 'ConnectionsApi' do
|
|
29
29
|
|
30
30
|
# unit tests for detail_brokerage_authorization
|
31
31
|
# Get brokerage authorization details
|
32
|
+
# Returns a single brokerage authorization object for the specified ID.
|
32
33
|
# @param authorization_id The ID of a brokerage authorization object.
|
33
34
|
# @param user_id
|
34
35
|
# @param user_secret
|
@@ -41,7 +42,8 @@ describe 'ConnectionsApi' do
|
|
41
42
|
end
|
42
43
|
|
43
44
|
# unit tests for list_brokerage_authorizations
|
44
|
-
# List all brokerage authorizations for the
|
45
|
+
# List all brokerage authorizations for the User
|
46
|
+
# Returns a list of Brokerage Autherization objects for the specified userId.
|
45
47
|
# @param user_id
|
46
48
|
# @param user_secret
|
47
49
|
# @param [Hash] opts the optional parameters
|
@@ -54,6 +56,7 @@ describe 'ConnectionsApi' do
|
|
54
56
|
|
55
57
|
# unit tests for remove_brokerage_authorization
|
56
58
|
# Delete brokerage authorization
|
59
|
+
# Deletes a specified brokerage authorization given by the ID.
|
57
60
|
# @param authorization_id The ID of the Authorization to delete.
|
58
61
|
# @param user_id
|
59
62
|
# @param user_secret
|
@@ -66,7 +69,8 @@ describe 'ConnectionsApi' do
|
|
66
69
|
end
|
67
70
|
|
68
71
|
# unit tests for session_events
|
69
|
-
#
|
72
|
+
# Get all session events for a user
|
73
|
+
# Returns a list of session events associated with a user.
|
70
74
|
# @param partner_client_id
|
71
75
|
# @param [Hash] opts the optional parameters
|
72
76
|
# @option opts [String] :user_id Optional comma seperated list of user IDs used to filter the request on specific users
|
@@ -28,7 +28,8 @@ describe 'OptionsApi' do
|
|
28
28
|
end
|
29
29
|
|
30
30
|
# unit tests for get_option_strategy
|
31
|
-
#
|
31
|
+
# Create options strategy
|
32
|
+
# Creates an option strategy object that will be used to place an option strategy order.
|
32
33
|
# @param user_id
|
33
34
|
# @param user_secret
|
34
35
|
# @param account_id The ID of the account to create the option strategy object in.
|
@@ -42,7 +43,8 @@ describe 'OptionsApi' do
|
|
42
43
|
end
|
43
44
|
|
44
45
|
# unit tests for get_options_chain
|
45
|
-
# Get the options chain
|
46
|
+
# Get the options chain for a symbol
|
47
|
+
# Returns the option chain for the specified symbol in the specified account.
|
46
48
|
# @param user_id
|
47
49
|
# @param user_secret
|
48
50
|
# @param account_id The ID of the account to get the options chain from.
|
@@ -56,7 +58,8 @@ describe 'OptionsApi' do
|
|
56
58
|
end
|
57
59
|
|
58
60
|
# unit tests for get_options_strategy_quote
|
59
|
-
# Get
|
61
|
+
# Get options strategy quotes
|
62
|
+
# Returns a Strategy Quotes object which has latest market data of the specified option strategy.
|
60
63
|
# @param user_id
|
61
64
|
# @param user_secret
|
62
65
|
# @param account_id The ID of the account the strategy will be placed in.
|
@@ -70,7 +73,8 @@ describe 'OptionsApi' do
|
|
70
73
|
end
|
71
74
|
|
72
75
|
# unit tests for list_option_holdings
|
73
|
-
# Get
|
76
|
+
# Get account option holdings
|
77
|
+
# Returns a list of Options Positions.
|
74
78
|
# @param user_id
|
75
79
|
# @param user_secret
|
76
80
|
# @param account_id The ID of the account to fetch options holdings for.
|
@@ -83,7 +87,8 @@ describe 'OptionsApi' do
|
|
83
87
|
end
|
84
88
|
|
85
89
|
# unit tests for place_option_strategy
|
86
|
-
# Place an option strategy order
|
90
|
+
# Place an option strategy order
|
91
|
+
# Places the option strategy order and returns the order record received from the brokerage.
|
87
92
|
# @param user_id
|
88
93
|
# @param user_secret
|
89
94
|
# @param account_id The ID of the account to execute the strategy in.
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: snaptrade
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 2.0.
|
4
|
+
version: 2.0.17
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- SnapTrade
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-05-
|
11
|
+
date: 2024-05-08 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: faraday
|