snaptrade 2.0.112 → 2.0.114
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +2 -2
- data/lib/snaptrade/api/trading_api.rb +52 -52
- data/lib/snaptrade/version.rb +1 -1
- data/spec/api/trading_api_spec.rb +13 -13
- 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: ccf699109cb7d585e4fb2011b3eec6affc324b8b50ac2f878a2f7d57ee3c4625
|
4
|
+
data.tar.gz: ce49d3d894cdcd14e373e9cc8e683c086001d76b8af1070691e726c899509bf2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2a04f6804a9356fef36a0ad2fd59ad12558cb6988f1d1504c60aea209559bb458f0d4559d373772a744e62addf870db882c703d4d7c9dc25a40f0c0343ac2c58
|
7
|
+
data.tar.gz: f7c1e52fce04937395efaaadb14c617985a4ee2e7b0a0809682d8afa8d1c0b696d7c209af348a24f9ca1feed7274a87f602b9b6920936595e4eee8324b2c2692
|
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
|
-
[](https://rubygems.org/gems/snaptrade/versions/2.0.114)
|
10
10
|
[](https://snaptrade.com/)
|
11
11
|
|
12
12
|
</div>
|
@@ -82,7 +82,7 @@ Connect brokerage accounts to your app for live positions and trading
|
|
82
82
|
Add to Gemfile:
|
83
83
|
|
84
84
|
```ruby
|
85
|
-
gem 'snaptrade', '~> 2.0.
|
85
|
+
gem 'snaptrade', '~> 2.0.114'
|
86
86
|
```
|
87
87
|
|
88
88
|
## Getting Started<a id="getting-started"></a>
|
@@ -17,7 +17,7 @@ module SnapTrade
|
|
17
17
|
@api_client = api_client
|
18
18
|
end
|
19
19
|
|
20
|
-
# Cancel
|
20
|
+
# Cancel crypto order
|
21
21
|
#
|
22
22
|
# Cancels an order in the specified account.
|
23
23
|
#
|
@@ -31,7 +31,7 @@ module SnapTrade
|
|
31
31
|
data
|
32
32
|
end
|
33
33
|
|
34
|
-
# Cancel
|
34
|
+
# Cancel crypto order
|
35
35
|
#
|
36
36
|
# Cancels an order in the specified account.
|
37
37
|
#
|
@@ -44,7 +44,7 @@ module SnapTrade
|
|
44
44
|
cancel_order_with_http_info_impl(user_id, user_secret, account_id, brokerage_order_id, extra)
|
45
45
|
end
|
46
46
|
|
47
|
-
# Cancel
|
47
|
+
# Cancel crypto order
|
48
48
|
# Cancels an order in the specified account.
|
49
49
|
# @param user_id [String]
|
50
50
|
# @param user_secret [String]
|
@@ -57,7 +57,7 @@ module SnapTrade
|
|
57
57
|
data
|
58
58
|
end
|
59
59
|
|
60
|
-
# Cancel
|
60
|
+
# Cancel crypto order
|
61
61
|
# Cancels an order in the specified account.
|
62
62
|
# @param user_id [String]
|
63
63
|
# @param user_secret [String]
|
@@ -128,7 +128,7 @@ module SnapTrade
|
|
128
128
|
end
|
129
129
|
|
130
130
|
|
131
|
-
# Cancel order
|
131
|
+
# Cancel equity order
|
132
132
|
#
|
133
133
|
# Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
134
134
|
#
|
@@ -146,7 +146,7 @@ module SnapTrade
|
|
146
146
|
data
|
147
147
|
end
|
148
148
|
|
149
|
-
# Cancel order
|
149
|
+
# Cancel equity order
|
150
150
|
#
|
151
151
|
# Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
152
152
|
#
|
@@ -163,7 +163,7 @@ module SnapTrade
|
|
163
163
|
cancel_user_account_order_with_http_info_impl(user_id, user_secret, account_id, trading_cancel_user_account_order_request, extra)
|
164
164
|
end
|
165
165
|
|
166
|
-
# Cancel order
|
166
|
+
# Cancel equity order
|
167
167
|
# Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
168
168
|
# @param user_id [String]
|
169
169
|
# @param user_secret [String]
|
@@ -176,7 +176,7 @@ module SnapTrade
|
|
176
176
|
data
|
177
177
|
end
|
178
178
|
|
179
|
-
# Cancel order
|
179
|
+
# Cancel equity order
|
180
180
|
# Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
181
181
|
# @param user_id [String]
|
182
182
|
# @param user_secret [String]
|
@@ -252,7 +252,7 @@ module SnapTrade
|
|
252
252
|
end
|
253
253
|
|
254
254
|
|
255
|
-
# Get
|
255
|
+
# Get crypto pair quote
|
256
256
|
#
|
257
257
|
# Gets a quote for the specified account.
|
258
258
|
#
|
@@ -266,7 +266,7 @@ module SnapTrade
|
|
266
266
|
data
|
267
267
|
end
|
268
268
|
|
269
|
-
# Get
|
269
|
+
# Get crypto pair quote
|
270
270
|
#
|
271
271
|
# Gets a quote for the specified account.
|
272
272
|
#
|
@@ -279,7 +279,7 @@ module SnapTrade
|
|
279
279
|
get_cryptocurrency_pair_quote_with_http_info_impl(user_id, user_secret, account_id, instrument_symbol, extra)
|
280
280
|
end
|
281
281
|
|
282
|
-
# Get
|
282
|
+
# Get crypto pair quote
|
283
283
|
# Gets a quote for the specified account.
|
284
284
|
# @param user_id [String]
|
285
285
|
# @param user_secret [String]
|
@@ -292,7 +292,7 @@ module SnapTrade
|
|
292
292
|
data
|
293
293
|
end
|
294
294
|
|
295
|
-
# Get
|
295
|
+
# Get crypto pair quote
|
296
296
|
# Gets a quote for the specified account.
|
297
297
|
# @param user_id [String]
|
298
298
|
# @param user_secret [String]
|
@@ -363,7 +363,7 @@ module SnapTrade
|
|
363
363
|
end
|
364
364
|
|
365
365
|
|
366
|
-
# Check order impact
|
366
|
+
# Check equity order impact
|
367
367
|
#
|
368
368
|
# Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
|
369
369
|
#
|
@@ -396,7 +396,7 @@ module SnapTrade
|
|
396
396
|
data
|
397
397
|
end
|
398
398
|
|
399
|
-
# Check order impact
|
399
|
+
# Check equity order impact
|
400
400
|
#
|
401
401
|
# Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
|
402
402
|
#
|
@@ -428,7 +428,7 @@ module SnapTrade
|
|
428
428
|
get_order_impact_with_http_info_impl(user_id, user_secret, manual_trade_form, extra)
|
429
429
|
end
|
430
430
|
|
431
|
-
# Check order impact
|
431
|
+
# Check equity order impact
|
432
432
|
# Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
|
433
433
|
# @param user_id [String]
|
434
434
|
# @param user_secret [String]
|
@@ -440,7 +440,7 @@ module SnapTrade
|
|
440
440
|
data
|
441
441
|
end
|
442
442
|
|
443
|
-
# Check order impact
|
443
|
+
# Check equity order impact
|
444
444
|
# Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
|
445
445
|
# @param user_id [String]
|
446
446
|
# @param user_secret [String]
|
@@ -511,7 +511,7 @@ module SnapTrade
|
|
511
511
|
end
|
512
512
|
|
513
513
|
|
514
|
-
# Get symbol quotes
|
514
|
+
# Get equity symbol quotes
|
515
515
|
#
|
516
516
|
# Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. This endpoint does not work for options quotes.
|
517
517
|
#
|
@@ -527,7 +527,7 @@ module SnapTrade
|
|
527
527
|
data
|
528
528
|
end
|
529
529
|
|
530
|
-
# Get symbol quotes
|
530
|
+
# Get equity symbol quotes
|
531
531
|
#
|
532
532
|
# Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. This endpoint does not work for options quotes.
|
533
533
|
#
|
@@ -542,7 +542,7 @@ module SnapTrade
|
|
542
542
|
get_user_account_quotes_with_http_info_impl(user_id, user_secret, symbols, account_id, extra)
|
543
543
|
end
|
544
544
|
|
545
|
-
# Get symbol quotes
|
545
|
+
# Get equity symbol quotes
|
546
546
|
# Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. This endpoint does not work for options quotes.
|
547
547
|
# @param user_id [String]
|
548
548
|
# @param user_secret [String]
|
@@ -556,7 +556,7 @@ module SnapTrade
|
|
556
556
|
data
|
557
557
|
end
|
558
558
|
|
559
|
-
# Get symbol quotes
|
559
|
+
# Get equity symbol quotes
|
560
560
|
# Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. This endpoint does not work for options quotes.
|
561
561
|
# @param user_id [String]
|
562
562
|
# @param user_secret [String]
|
@@ -630,7 +630,7 @@ module SnapTrade
|
|
630
630
|
end
|
631
631
|
|
632
632
|
|
633
|
-
# Place
|
633
|
+
# Place bracket equity order
|
634
634
|
#
|
635
635
|
# Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for
|
636
636
|
# use. Only supported on certain brokerages
|
@@ -667,7 +667,7 @@ module SnapTrade
|
|
667
667
|
data
|
668
668
|
end
|
669
669
|
|
670
|
-
# Place
|
670
|
+
# Place bracket equity order
|
671
671
|
#
|
672
672
|
# Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for
|
673
673
|
# use. Only supported on certain brokerages
|
@@ -703,7 +703,7 @@ module SnapTrade
|
|
703
703
|
place_bracket_order_with_http_info_impl(account_id, user_id, user_secret, manual_trade_form_bracket, extra)
|
704
704
|
end
|
705
705
|
|
706
|
-
# Place
|
706
|
+
# Place bracket equity order
|
707
707
|
# Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
|
708
708
|
# @param account_id [String] The ID of the account to execute the trade on.
|
709
709
|
# @param user_id [String]
|
@@ -716,7 +716,7 @@ module SnapTrade
|
|
716
716
|
data
|
717
717
|
end
|
718
718
|
|
719
|
-
# Place
|
719
|
+
# Place bracket equity order
|
720
720
|
# Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
|
721
721
|
# @param account_id [String] The ID of the account to execute the trade on.
|
722
722
|
# @param user_id [String]
|
@@ -792,7 +792,7 @@ module SnapTrade
|
|
792
792
|
end
|
793
793
|
|
794
794
|
|
795
|
-
# Place order
|
795
|
+
# Place equity order
|
796
796
|
#
|
797
797
|
# Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.
|
798
798
|
#
|
@@ -831,7 +831,7 @@ module SnapTrade
|
|
831
831
|
data
|
832
832
|
end
|
833
833
|
|
834
|
-
# Place order
|
834
|
+
# Place equity order
|
835
835
|
#
|
836
836
|
# Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.
|
837
837
|
#
|
@@ -869,7 +869,7 @@ module SnapTrade
|
|
869
869
|
place_force_order_with_http_info_impl(user_id, user_secret, manual_trade_form_with_options, extra)
|
870
870
|
end
|
871
871
|
|
872
|
-
# Place order
|
872
|
+
# Place equity order
|
873
873
|
# Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds. This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). It's recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
|
874
874
|
# @param user_id [String]
|
875
875
|
# @param user_secret [String]
|
@@ -881,7 +881,7 @@ module SnapTrade
|
|
881
881
|
data
|
882
882
|
end
|
883
883
|
|
884
|
-
# Place order
|
884
|
+
# Place equity order
|
885
885
|
# Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds. This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). It's recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
|
886
886
|
# @param user_id [String]
|
887
887
|
# @param user_secret [String]
|
@@ -952,7 +952,7 @@ module SnapTrade
|
|
952
952
|
end
|
953
953
|
|
954
954
|
|
955
|
-
# Place
|
955
|
+
# Place option order
|
956
956
|
#
|
957
957
|
# Places a multi-leg option order. Only supported on certain option trading brokerages. https://snaptrade.notion.site/brokerages has information on brokerage trading support
|
958
958
|
#
|
@@ -980,7 +980,7 @@ module SnapTrade
|
|
980
980
|
data
|
981
981
|
end
|
982
982
|
|
983
|
-
# Place
|
983
|
+
# Place option order
|
984
984
|
#
|
985
985
|
# Places a multi-leg option order. Only supported on certain option trading brokerages. https://snaptrade.notion.site/brokerages has information on brokerage trading support
|
986
986
|
#
|
@@ -1007,7 +1007,7 @@ module SnapTrade
|
|
1007
1007
|
place_mleg_order_with_http_info_impl(user_id, user_secret, account_id, mleg_trade_form, extra)
|
1008
1008
|
end
|
1009
1009
|
|
1010
|
-
# Place
|
1010
|
+
# Place option order
|
1011
1011
|
# Places a multi-leg option order. Only supported on certain option trading brokerages. https://snaptrade.notion.site/brokerages has information on brokerage trading support
|
1012
1012
|
# @param user_id [String]
|
1013
1013
|
# @param user_secret [String]
|
@@ -1020,7 +1020,7 @@ module SnapTrade
|
|
1020
1020
|
data
|
1021
1021
|
end
|
1022
1022
|
|
1023
|
-
# Place
|
1023
|
+
# Place option order
|
1024
1024
|
# Places a multi-leg option order. Only supported on certain option trading brokerages. https://snaptrade.notion.site/brokerages has information on brokerage trading support
|
1025
1025
|
# @param user_id [String]
|
1026
1026
|
# @param user_secret [String]
|
@@ -1096,7 +1096,7 @@ module SnapTrade
|
|
1096
1096
|
end
|
1097
1097
|
|
1098
1098
|
|
1099
|
-
# Place checked order
|
1099
|
+
# Place checked equity order
|
1100
1100
|
#
|
1101
1101
|
# Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder).
|
1102
1102
|
#
|
@@ -1116,7 +1116,7 @@ module SnapTrade
|
|
1116
1116
|
data
|
1117
1117
|
end
|
1118
1118
|
|
1119
|
-
# Place checked order
|
1119
|
+
# Place checked equity order
|
1120
1120
|
#
|
1121
1121
|
# Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder).
|
1122
1122
|
#
|
@@ -1135,7 +1135,7 @@ module SnapTrade
|
|
1135
1135
|
place_order_with_http_info_impl(trade_id, user_id, user_secret, extra)
|
1136
1136
|
end
|
1137
1137
|
|
1138
|
-
# Place checked order
|
1138
|
+
# Place checked equity order
|
1139
1139
|
# Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder). It's recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
|
1140
1140
|
# @param trade_id [String] Obtained from calling the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact)
|
1141
1141
|
# @param user_id [String]
|
@@ -1148,7 +1148,7 @@ module SnapTrade
|
|
1148
1148
|
data
|
1149
1149
|
end
|
1150
1150
|
|
1151
|
-
# Place checked order
|
1151
|
+
# Place checked equity order
|
1152
1152
|
# Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder). It's recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
|
1153
1153
|
# @param trade_id [String] Obtained from calling the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact)
|
1154
1154
|
# @param user_id [String]
|
@@ -1220,7 +1220,7 @@ module SnapTrade
|
|
1220
1220
|
end
|
1221
1221
|
|
1222
1222
|
|
1223
|
-
# Place order
|
1223
|
+
# Place crypto order
|
1224
1224
|
#
|
1225
1225
|
# Places an order in the specified account.
|
1226
1226
|
# This endpoint does not compute the impact to the account balance from the order before submitting the order.
|
@@ -1255,7 +1255,7 @@ module SnapTrade
|
|
1255
1255
|
data
|
1256
1256
|
end
|
1257
1257
|
|
1258
|
-
# Place order
|
1258
|
+
# Place crypto order
|
1259
1259
|
#
|
1260
1260
|
# Places an order in the specified account.
|
1261
1261
|
# This endpoint does not compute the impact to the account balance from the order before submitting the order.
|
@@ -1289,7 +1289,7 @@ module SnapTrade
|
|
1289
1289
|
place_simple_order_with_http_info_impl(user_id, user_secret, account_id, simple_order_form, extra)
|
1290
1290
|
end
|
1291
1291
|
|
1292
|
-
# Place order
|
1292
|
+
# Place crypto order
|
1293
1293
|
# Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
|
1294
1294
|
# @param user_id [String]
|
1295
1295
|
# @param user_secret [String]
|
@@ -1302,7 +1302,7 @@ module SnapTrade
|
|
1302
1302
|
data
|
1303
1303
|
end
|
1304
1304
|
|
1305
|
-
# Place order
|
1305
|
+
# Place crypto order
|
1306
1306
|
# Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
|
1307
1307
|
# @param user_id [String]
|
1308
1308
|
# @param user_secret [String]
|
@@ -1378,7 +1378,7 @@ module SnapTrade
|
|
1378
1378
|
end
|
1379
1379
|
|
1380
1380
|
|
1381
|
-
# Preview order
|
1381
|
+
# Preview crypto order
|
1382
1382
|
#
|
1383
1383
|
# Previews an order using the specified account.
|
1384
1384
|
#
|
@@ -1412,7 +1412,7 @@ module SnapTrade
|
|
1412
1412
|
data
|
1413
1413
|
end
|
1414
1414
|
|
1415
|
-
# Preview order
|
1415
|
+
# Preview crypto order
|
1416
1416
|
#
|
1417
1417
|
# Previews an order using the specified account.
|
1418
1418
|
#
|
@@ -1445,7 +1445,7 @@ module SnapTrade
|
|
1445
1445
|
preview_simple_order_with_http_info_impl(user_id, user_secret, account_id, simple_order_form, extra)
|
1446
1446
|
end
|
1447
1447
|
|
1448
|
-
# Preview order
|
1448
|
+
# Preview crypto order
|
1449
1449
|
# Previews an order using the specified account.
|
1450
1450
|
# @param user_id [String]
|
1451
1451
|
# @param user_secret [String]
|
@@ -1458,7 +1458,7 @@ module SnapTrade
|
|
1458
1458
|
data
|
1459
1459
|
end
|
1460
1460
|
|
1461
|
-
# Preview order
|
1461
|
+
# Preview crypto order
|
1462
1462
|
# Previews an order using the specified account.
|
1463
1463
|
# @param user_id [String]
|
1464
1464
|
# @param user_secret [String]
|
@@ -1534,7 +1534,7 @@ module SnapTrade
|
|
1534
1534
|
end
|
1535
1535
|
|
1536
1536
|
|
1537
|
-
#
|
1537
|
+
# Replace crypto order
|
1538
1538
|
#
|
1539
1539
|
# Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling
|
1540
1540
|
# the existing order and placing a new one. The order's brokerage_order_id may or may not change, be sure to use the one
|
@@ -1567,7 +1567,7 @@ module SnapTrade
|
|
1567
1567
|
data
|
1568
1568
|
end
|
1569
1569
|
|
1570
|
-
#
|
1570
|
+
# Replace crypto order
|
1571
1571
|
#
|
1572
1572
|
# Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling
|
1573
1573
|
# the existing order and placing a new one. The order's brokerage_order_id may or may not change, be sure to use the one
|
@@ -1599,7 +1599,7 @@ module SnapTrade
|
|
1599
1599
|
replace_order_with_http_info_impl(account_id, brokerage_order_id, user_id, user_secret, manual_trade_replace_form, extra)
|
1600
1600
|
end
|
1601
1601
|
|
1602
|
-
#
|
1602
|
+
# Replace crypto order
|
1603
1603
|
# Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order's brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages
|
1604
1604
|
# @param account_id [String] The ID of the account to execute the trade on.
|
1605
1605
|
# @param brokerage_order_id [String] The Brokerage Order ID of the order to replace.
|
@@ -1613,7 +1613,7 @@ module SnapTrade
|
|
1613
1613
|
data
|
1614
1614
|
end
|
1615
1615
|
|
1616
|
-
#
|
1616
|
+
# Replace crypto order
|
1617
1617
|
# Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order's brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages
|
1618
1618
|
# @param account_id [String] The ID of the account to execute the trade on.
|
1619
1619
|
# @param brokerage_order_id [String] The Brokerage Order ID of the order to replace.
|
@@ -1694,7 +1694,7 @@ module SnapTrade
|
|
1694
1694
|
end
|
1695
1695
|
|
1696
1696
|
|
1697
|
-
#
|
1697
|
+
# Get crypto pairs
|
1698
1698
|
#
|
1699
1699
|
# Searches cryptocurrency pairs instruments accessible to the specified account.
|
1700
1700
|
#
|
@@ -1711,7 +1711,7 @@ module SnapTrade
|
|
1711
1711
|
data
|
1712
1712
|
end
|
1713
1713
|
|
1714
|
-
#
|
1714
|
+
# Get crypto pairs
|
1715
1715
|
#
|
1716
1716
|
# Searches cryptocurrency pairs instruments accessible to the specified account.
|
1717
1717
|
#
|
@@ -1727,7 +1727,7 @@ module SnapTrade
|
|
1727
1727
|
search_cryptocurrency_pair_instruments_with_http_info_impl(user_id, user_secret, account_id, extra)
|
1728
1728
|
end
|
1729
1729
|
|
1730
|
-
#
|
1730
|
+
# Get crypto pairs
|
1731
1731
|
# Searches cryptocurrency pairs instruments accessible to the specified account.
|
1732
1732
|
# @param user_id [String]
|
1733
1733
|
# @param user_secret [String]
|
@@ -1741,7 +1741,7 @@ module SnapTrade
|
|
1741
1741
|
data
|
1742
1742
|
end
|
1743
1743
|
|
1744
|
-
#
|
1744
|
+
# Get crypto pairs
|
1745
1745
|
# Searches cryptocurrency pairs instruments accessible to the specified account.
|
1746
1746
|
# @param user_id [String]
|
1747
1747
|
# @param user_secret [String]
|
data/lib/snaptrade/version.rb
CHANGED
@@ -28,7 +28,7 @@ describe 'TradingApi' do
|
|
28
28
|
end
|
29
29
|
|
30
30
|
# unit tests for cancel_order
|
31
|
-
# Cancel
|
31
|
+
# Cancel crypto order
|
32
32
|
# Cancels an order in the specified account.
|
33
33
|
# @param user_id
|
34
34
|
# @param user_secret
|
@@ -43,7 +43,7 @@ describe 'TradingApi' do
|
|
43
43
|
end
|
44
44
|
|
45
45
|
# unit tests for cancel_user_account_order
|
46
|
-
# Cancel order
|
46
|
+
# Cancel equity order
|
47
47
|
# Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
48
48
|
# @param user_id
|
49
49
|
# @param user_secret
|
@@ -58,7 +58,7 @@ describe 'TradingApi' do
|
|
58
58
|
end
|
59
59
|
|
60
60
|
# unit tests for get_cryptocurrency_pair_quote
|
61
|
-
# Get
|
61
|
+
# Get crypto pair quote
|
62
62
|
# Gets a quote for the specified account.
|
63
63
|
# @param user_id
|
64
64
|
# @param user_secret
|
@@ -73,7 +73,7 @@ describe 'TradingApi' do
|
|
73
73
|
end
|
74
74
|
|
75
75
|
# unit tests for get_order_impact
|
76
|
-
# Check order impact
|
76
|
+
# Check equity order impact
|
77
77
|
# Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
|
78
78
|
# @param user_id
|
79
79
|
# @param user_secret
|
@@ -87,7 +87,7 @@ describe 'TradingApi' do
|
|
87
87
|
end
|
88
88
|
|
89
89
|
# unit tests for get_user_account_quotes
|
90
|
-
# Get symbol quotes
|
90
|
+
# Get equity symbol quotes
|
91
91
|
# Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. This endpoint does not work for options quotes.
|
92
92
|
# @param user_id
|
93
93
|
# @param user_secret
|
@@ -103,7 +103,7 @@ describe 'TradingApi' do
|
|
103
103
|
end
|
104
104
|
|
105
105
|
# unit tests for place_bracket_order
|
106
|
-
# Place
|
106
|
+
# Place bracket equity order
|
107
107
|
# Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
|
108
108
|
# @param account_id The ID of the account to execute the trade on.
|
109
109
|
# @param user_id
|
@@ -118,7 +118,7 @@ describe 'TradingApi' do
|
|
118
118
|
end
|
119
119
|
|
120
120
|
# unit tests for place_force_order
|
121
|
-
# Place order
|
121
|
+
# Place equity order
|
122
122
|
# Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds. This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). It's recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
|
123
123
|
# @param user_id
|
124
124
|
# @param user_secret
|
@@ -132,7 +132,7 @@ describe 'TradingApi' do
|
|
132
132
|
end
|
133
133
|
|
134
134
|
# unit tests for place_mleg_order
|
135
|
-
# Place
|
135
|
+
# Place option order
|
136
136
|
# Places a multi-leg option order. Only supported on certain option trading brokerages. https://snaptrade.notion.site/brokerages has information on brokerage trading support
|
137
137
|
# @param user_id
|
138
138
|
# @param user_secret
|
@@ -147,7 +147,7 @@ describe 'TradingApi' do
|
|
147
147
|
end
|
148
148
|
|
149
149
|
# unit tests for place_order
|
150
|
-
# Place checked order
|
150
|
+
# Place checked equity order
|
151
151
|
# Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder). It's recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
|
152
152
|
# @param trade_id Obtained from calling the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact)
|
153
153
|
# @param user_id
|
@@ -162,7 +162,7 @@ describe 'TradingApi' do
|
|
162
162
|
end
|
163
163
|
|
164
164
|
# unit tests for place_simple_order
|
165
|
-
# Place order
|
165
|
+
# Place crypto order
|
166
166
|
# Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
|
167
167
|
# @param user_id
|
168
168
|
# @param user_secret
|
@@ -177,7 +177,7 @@ describe 'TradingApi' do
|
|
177
177
|
end
|
178
178
|
|
179
179
|
# unit tests for preview_simple_order
|
180
|
-
# Preview order
|
180
|
+
# Preview crypto order
|
181
181
|
# Previews an order using the specified account.
|
182
182
|
# @param user_id
|
183
183
|
# @param user_secret
|
@@ -192,7 +192,7 @@ describe 'TradingApi' do
|
|
192
192
|
end
|
193
193
|
|
194
194
|
# unit tests for replace_order
|
195
|
-
#
|
195
|
+
# Replace crypto order
|
196
196
|
# Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order's brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages
|
197
197
|
# @param account_id The ID of the account to execute the trade on.
|
198
198
|
# @param brokerage_order_id The Brokerage Order ID of the order to replace.
|
@@ -208,7 +208,7 @@ describe 'TradingApi' do
|
|
208
208
|
end
|
209
209
|
|
210
210
|
# unit tests for search_cryptocurrency_pair_instruments
|
211
|
-
#
|
211
|
+
# Get crypto pairs
|
212
212
|
# Searches cryptocurrency pairs instruments accessible to the specified account.
|
213
213
|
# @param user_id
|
214
214
|
# @param user_secret
|
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.114
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- SnapTrade
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2025-07-
|
11
|
+
date: 2025-07-09 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: faraday
|