snaptrade 2.0.214 → 2.0.216
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 +39 -31
- data/lib/snaptrade/api/account_information_api.rb +32 -22
- data/lib/snaptrade/api/options_api.rb +6 -6
- data/lib/snaptrade/api/trading_api.rb +14 -14
- data/lib/snaptrade/api/transactions_and_reporting_api.rb +16 -16
- data/lib/snaptrade/models/account_universal_activity.rb +1 -1
- data/lib/snaptrade/models/universal_activity.rb +1 -1
- data/lib/snaptrade/version.rb +1 -1
- data/spec/api/account_information_api_spec.rb +5 -5
- data/spec/api/options_api_spec.rb +1 -1
- data/spec/api/trading_api_spec.rb +3 -3
- data/spec/api/transactions_and_reporting_api_spec.rb +3 -3
- metadata +200 -200
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a0414ddb4679c61852aebde968aae4c30b35257734fb9b3206453a838c03fb7f
|
|
4
|
+
data.tar.gz: bed437e25bab641c574e1da0e876a04e8cdfb6873cf18447e068ae449823305f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 25eeb551572ba574c9be3522fa90d5c7a0252fa343aa87e71475551702825eea03c567c05e45798f264b07671211356de0a34b0bc48478b673d4ed09227a651f
|
|
7
|
+
data.tar.gz: a8b2676106a3307b5b060efd1414cdef8ac1caee96a80339b2e4b1336484d3ce98b3fa833aedda82adf6442157d5bdd16d30bbc4b3a03599b108c82bda80135b
|
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.216)
|
|
10
10
|
[](https://snaptrade.com/)
|
|
11
11
|
|
|
12
12
|
</div>
|
|
@@ -94,7 +94,7 @@ Connect brokerage accounts to your app for live positions and trading
|
|
|
94
94
|
Add to Gemfile:
|
|
95
95
|
|
|
96
96
|
```ruby
|
|
97
|
-
gem 'snaptrade', '~> 2.0.
|
|
97
|
+
gem 'snaptrade', '~> 2.0.216'
|
|
98
98
|
```
|
|
99
99
|
|
|
100
100
|
## Getting Started<a id="getting-started"></a>
|
|
@@ -145,6 +145,8 @@ p.result[3] # [Faraday::Response] Raw HTTP response
|
|
|
145
145
|
|
|
146
146
|
### `snaptrade.account_information.get_account_activities`<a id="snaptradeaccount_informationget_account_activities"></a>
|
|
147
147
|
|
|
148
|
+
This endpoint is not deprecated and has no planned sunset. Responses to requests using the legacy `/api/v1` path prefix include `Deprecation: @1781222400` (June 12, 2026); that header applies only to the path prefix. Use the canonical root path `/accounts/{accountId}/activities`.
|
|
149
|
+
|
|
148
150
|
Returns all historical transactions for the specified account.
|
|
149
151
|
|
|
150
152
|
This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options.
|
|
@@ -199,14 +201,15 @@ of 1000.
|
|
|
199
201
|
Optional comma separated list of transaction types to filter by. SnapTrade does
|
|
200
202
|
a best effort to categorize brokerage transaction types into a common set of
|
|
201
203
|
values. Here are some of the most popular values: - `BUY` - Asset bought. -
|
|
202
|
-
`SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
`
|
|
208
|
-
|
|
209
|
-
|
|
204
|
+
`SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `SUBSTITUTE_DIVIDEND` -
|
|
205
|
+
Payment in lieu of a dividend. - `CONTRIBUTION` - Cash contribution. -
|
|
206
|
+
`WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. -
|
|
207
|
+
`STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead
|
|
208
|
+
of cash - `INTEREST` - Interest deposited into the account. - `FEE` - Fee
|
|
209
|
+
withdrawn from the account. - `TAX` - A tax related fee. - `OPTIONEXPIRATION` -
|
|
210
|
+
Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. -
|
|
211
|
+
`OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from
|
|
212
|
+
one account to another. - `SPLIT` - A stock share split.
|
|
210
213
|
|
|
211
214
|
#### 🔄 Return<a id="🔄-return"></a>
|
|
212
215
|
|
|
@@ -298,13 +301,13 @@ p result
|
|
|
298
301
|
### `snaptrade.account_information.get_all_user_holdings`<a id="snaptradeaccount_informationget_all_user_holdings"></a>
|
|
299
302
|
|
|
300
303
|
|
|
301
|
-
**Deprecated
|
|
304
|
+
**Deprecated.** Use the account-specific holdings endpoint instead.
|
|
305
|
+
|
|
306
|
+
This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
302
307
|
|
|
303
308
|
List all accounts for the user, plus balances, positions, and orders for each
|
|
304
309
|
account.
|
|
305
310
|
|
|
306
|
-
**Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
307
|
-
|
|
308
311
|
|
|
309
312
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
310
313
|
|
|
@@ -515,9 +518,9 @@ Number of days in the past to fetch the most recent orders. Defaults to the last
|
|
|
515
518
|
### `snaptrade.account_information.get_user_account_positions`<a id="snaptradeaccount_informationget_user_account_positions"></a>
|
|
516
519
|
|
|
517
520
|
|
|
518
|
-
|
|
521
|
+
**Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures.
|
|
519
522
|
|
|
520
|
-
|
|
523
|
+
Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings).
|
|
521
524
|
|
|
522
525
|
Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:
|
|
523
526
|
- If you do, this endpoint returns real-time data.
|
|
@@ -641,6 +644,9 @@ returns all six supported timeframes.
|
|
|
641
644
|
|
|
642
645
|
|
|
643
646
|
**Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders).
|
|
647
|
+
|
|
648
|
+
This endpoint will return HTTP 410 Gone for all customers that sign up after May 11, 2026.
|
|
649
|
+
|
|
644
650
|
Returns a list of balances, positions, and recent orders for the specified account.
|
|
645
651
|
|
|
646
652
|
Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:
|
|
@@ -1575,9 +1581,9 @@ p result
|
|
|
1575
1581
|
### `snaptrade.options.list_option_holdings`<a id="snaptradeoptionslist_option_holdings"></a>
|
|
1576
1582
|
|
|
1577
1583
|
|
|
1578
|
-
|
|
1584
|
+
**Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures.
|
|
1579
1585
|
|
|
1580
|
-
|
|
1586
|
+
Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).
|
|
1581
1587
|
|
|
1582
1588
|
Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:
|
|
1583
1589
|
- If you do, this endpoint returns real-time data.
|
|
@@ -1997,7 +2003,8 @@ the brokerage system.
|
|
|
1997
2003
|
### `snaptrade.trading.cancel_user_account_order`<a id="snaptradetradingcancel_user_account_order"></a>
|
|
1998
2004
|
|
|
1999
2005
|
|
|
2000
|
-
**
|
|
2006
|
+
**Deprecated.** Use [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) instead.
|
|
2007
|
+
|
|
2001
2008
|
Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
|
2002
2009
|
|
|
2003
2010
|
|
|
@@ -2267,8 +2274,6 @@ The quotes returned can be delayed depending on the brokerage the account belong
|
|
|
2267
2274
|
|
|
2268
2275
|
This endpoint does not work for options quotes.
|
|
2269
2276
|
|
|
2270
|
-
This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
2271
|
-
|
|
2272
2277
|
|
|
2273
2278
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
2274
2279
|
|
|
@@ -2312,7 +2317,8 @@ Should be set to `True` if `symbols` are comprised of tickers. Defaults to
|
|
|
2312
2317
|
### `snaptrade.trading.place_bracket_order`<a id="snaptradetradingplace_bracket_order"></a>
|
|
2313
2318
|
|
|
2314
2319
|
|
|
2315
|
-
**
|
|
2320
|
+
**Deprecated.** Use [the new complex order endpoint](/reference/Trading/Trading_placeComplexOrder) instead.
|
|
2321
|
+
|
|
2316
2322
|
Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for
|
|
2317
2323
|
use. Only supported on certain brokerages
|
|
2318
2324
|
|
|
@@ -2980,7 +2986,9 @@ p result
|
|
|
2980
2986
|
### `snaptrade.transactions_and_reporting.get_activities`<a id="snaptradetransactions_and_reportingget_activities"></a>
|
|
2981
2987
|
|
|
2982
2988
|
|
|
2983
|
-
|
|
2989
|
+
**Deprecated.** Use [the account level endpoint](/reference/Account%20Information/AccountInformation_getAccountActivities) instead, if possible.
|
|
2990
|
+
|
|
2991
|
+
This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
2984
2992
|
|
|
2985
2993
|
Returns all historical transactions for the specified user and filtering criteria. It's recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There's a max number of 10000 transactions returned per request.
|
|
2986
2994
|
|
|
@@ -2988,8 +2996,6 @@ There is no guarantee to the ordering of the transactions returned. Please sort
|
|
|
2988
2996
|
|
|
2989
2997
|
This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.
|
|
2990
2998
|
|
|
2991
|
-
**Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
2992
|
-
|
|
2993
2999
|
|
|
2994
3000
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
2995
3001
|
|
|
@@ -3036,12 +3042,13 @@ parameter takes precedence over the `accounts` parameter.
|
|
|
3036
3042
|
Optional comma separated list of transaction types to filter by. SnapTrade does
|
|
3037
3043
|
a best effort to categorize brokerage transaction types into a common set of
|
|
3038
3044
|
values. Here are some of the most popular values: - `BUY` - Asset bought. -
|
|
3039
|
-
`SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `
|
|
3040
|
-
|
|
3041
|
-
|
|
3042
|
-
the account. - `
|
|
3043
|
-
`
|
|
3044
|
-
|
|
3045
|
+
`SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `SUBSTITUTE_DIVIDEND` -
|
|
3046
|
+
Payment in lieu of a dividend. - `CONTRIBUTION` - Cash contribution. -
|
|
3047
|
+
`WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` -
|
|
3048
|
+
Interest deposited into the account. - `FEE` - Fee withdrawn from the account. -
|
|
3049
|
+
`OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option
|
|
3050
|
+
assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` -
|
|
3051
|
+
Transfer of assets from one account to another
|
|
3045
3052
|
|
|
3046
3053
|
#### 🔄 Return<a id="🔄-return"></a>
|
|
3047
3054
|
|
|
@@ -3059,7 +3066,8 @@ exercise event. - `TRANSFER` - Transfer of assets from one account to another
|
|
|
3059
3066
|
### `snaptrade.transactions_and_reporting.get_reporting_custom_range`<a id="snaptradetransactions_and_reportingget_reporting_custom_range"></a>
|
|
3060
3067
|
|
|
3061
3068
|
|
|
3062
|
-
Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
|
|
3069
|
+
**Deprecated.** Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
|
|
3070
|
+
|
|
3063
3071
|
|
|
3064
3072
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
3065
3073
|
|
|
@@ -19,6 +19,8 @@ module SnapTrade
|
|
|
19
19
|
|
|
20
20
|
# List account activities
|
|
21
21
|
#
|
|
22
|
+
# This endpoint is not deprecated and has no planned sunset. Responses to requests using the legacy `/api/v1` path prefix include `Deprecation: @1781222400` (June 12, 2026); that header applies only to the path prefix. Use the canonical root path `/accounts/{accountId}/activities`.
|
|
23
|
+
#
|
|
22
24
|
# Returns all historical transactions for the specified account.
|
|
23
25
|
#
|
|
24
26
|
# This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options.
|
|
@@ -36,7 +38,7 @@ module SnapTrade
|
|
|
36
38
|
# @param end_date [Date] The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
|
|
37
39
|
# @param offset [Integer] An integer that specifies the starting point of the paginated results. Default is 0.
|
|
38
40
|
# @param limit [Integer] An integer that specifies the maximum number of transactions to return. Default of 1000.
|
|
39
|
-
# @param type [String] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead of cash - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `TAX` - A tax related fee. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another. - `SPLIT` - A stock share split.
|
|
41
|
+
# @param type [String] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `SUBSTITUTE_DIVIDEND` - Payment in lieu of a dividend. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead of cash - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `TAX` - A tax related fee. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another. - `SPLIT` - A stock share split.
|
|
40
42
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
|
41
43
|
def get_account_activities(account_id:, user_id:, user_secret:, start_date: SENTINEL, end_date: SENTINEL, offset: SENTINEL, limit: SENTINEL, type: SENTINEL, extra: {})
|
|
42
44
|
extra[:start_date] = start_date if start_date != SENTINEL
|
|
@@ -50,6 +52,8 @@ module SnapTrade
|
|
|
50
52
|
|
|
51
53
|
# List account activities
|
|
52
54
|
#
|
|
55
|
+
# This endpoint is not deprecated and has no planned sunset. Responses to requests using the legacy `/api/v1` path prefix include `Deprecation: @1781222400` (June 12, 2026); that header applies only to the path prefix. Use the canonical root path `/accounts/{accountId}/activities`.
|
|
56
|
+
#
|
|
53
57
|
# Returns all historical transactions for the specified account.
|
|
54
58
|
#
|
|
55
59
|
# This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options.
|
|
@@ -67,7 +71,7 @@ module SnapTrade
|
|
|
67
71
|
# @param end_date [Date] The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
|
|
68
72
|
# @param offset [Integer] An integer that specifies the starting point of the paginated results. Default is 0.
|
|
69
73
|
# @param limit [Integer] An integer that specifies the maximum number of transactions to return. Default of 1000.
|
|
70
|
-
# @param type [String] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead of cash - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `TAX` - A tax related fee. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another. - `SPLIT` - A stock share split.
|
|
74
|
+
# @param type [String] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `SUBSTITUTE_DIVIDEND` - Payment in lieu of a dividend. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead of cash - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `TAX` - A tax related fee. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another. - `SPLIT` - A stock share split.
|
|
71
75
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
|
72
76
|
def get_account_activities_with_http_info(account_id:, user_id:, user_secret:, start_date: SENTINEL, end_date: SENTINEL, offset: SENTINEL, limit: SENTINEL, type: SENTINEL, extra: {})
|
|
73
77
|
extra[:start_date] = start_date if start_date != SENTINEL
|
|
@@ -79,7 +83,7 @@ module SnapTrade
|
|
|
79
83
|
end
|
|
80
84
|
|
|
81
85
|
# List account activities
|
|
82
|
-
# Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
86
|
+
# This endpoint is not deprecated and has no planned sunset. Responses to requests using the legacy `/api/v1` path prefix include `Deprecation: @1781222400` (June 12, 2026); that header applies only to the path prefix. Use the canonical root path `/accounts/{accountId}/activities`. Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
83
87
|
# @param account_id [String]
|
|
84
88
|
# @param user_id [String]
|
|
85
89
|
# @param user_secret [String]
|
|
@@ -88,7 +92,7 @@ module SnapTrade
|
|
|
88
92
|
# @option opts [Date] :end_date The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
|
|
89
93
|
# @option opts [Integer] :offset An integer that specifies the starting point of the paginated results. Default is 0.
|
|
90
94
|
# @option opts [Integer] :limit An integer that specifies the maximum number of transactions to return. Default of 1000.
|
|
91
|
-
# @option opts [String] :type Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead of cash - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `TAX` - A tax related fee. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another. - `SPLIT` - A stock share split.
|
|
95
|
+
# @option opts [String] :type Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `SUBSTITUTE_DIVIDEND` - Payment in lieu of a dividend. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead of cash - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `TAX` - A tax related fee. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another. - `SPLIT` - A stock share split.
|
|
92
96
|
# @return [PaginatedUniversalActivity]
|
|
93
97
|
private def get_account_activities_impl(account_id, user_id, user_secret, opts = {})
|
|
94
98
|
data, _status_code, _headers = get_account_activities_with_http_info(account_id, user_id, user_secret, opts)
|
|
@@ -96,7 +100,7 @@ module SnapTrade
|
|
|
96
100
|
end
|
|
97
101
|
|
|
98
102
|
# List account activities
|
|
99
|
-
# Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
103
|
+
# This endpoint is not deprecated and has no planned sunset. Responses to requests using the legacy `/api/v1` path prefix include `Deprecation: @1781222400` (June 12, 2026); that header applies only to the path prefix. Use the canonical root path `/accounts/{accountId}/activities`. Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
100
104
|
# @param account_id [String]
|
|
101
105
|
# @param user_id [String]
|
|
102
106
|
# @param user_secret [String]
|
|
@@ -105,7 +109,7 @@ module SnapTrade
|
|
|
105
109
|
# @option opts [Date] :end_date The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
|
|
106
110
|
# @option opts [Integer] :offset An integer that specifies the starting point of the paginated results. Default is 0.
|
|
107
111
|
# @option opts [Integer] :limit An integer that specifies the maximum number of transactions to return. Default of 1000.
|
|
108
|
-
# @option opts [String] :type Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead of cash - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `TAX` - A tax related fee. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another. - `SPLIT` - A stock share split.
|
|
112
|
+
# @option opts [String] :type Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `SUBSTITUTE_DIVIDEND` - Payment in lieu of a dividend. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead of cash - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `TAX` - A tax related fee. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another. - `SPLIT` - A stock share split.
|
|
109
113
|
# @return [Array<(PaginatedUniversalActivity, Integer, Hash)>] PaginatedUniversalActivity data, response status code and response headers
|
|
110
114
|
private def get_account_activities_with_http_info_impl(account_id, user_id, user_secret, opts = {})
|
|
111
115
|
if @api_client.config.debugging
|
|
@@ -399,12 +403,12 @@ module SnapTrade
|
|
|
399
403
|
|
|
400
404
|
# List all accounts for the user, plus balances, positions, and orders for each account.
|
|
401
405
|
#
|
|
402
|
-
# **Deprecated
|
|
406
|
+
# **Deprecated.** Use the account-specific holdings endpoint instead.
|
|
407
|
+
#
|
|
408
|
+
# This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
403
409
|
#
|
|
404
410
|
# List all accounts for the user, plus balances, positions, and orders for each
|
|
405
411
|
# account.
|
|
406
|
-
#
|
|
407
|
-
# **Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
408
412
|
#
|
|
409
413
|
# @param user_id [String]
|
|
410
414
|
# @param user_secret [String]
|
|
@@ -418,12 +422,12 @@ module SnapTrade
|
|
|
418
422
|
|
|
419
423
|
# List all accounts for the user, plus balances, positions, and orders for each account.
|
|
420
424
|
#
|
|
421
|
-
# **Deprecated
|
|
425
|
+
# **Deprecated.** Use the account-specific holdings endpoint instead.
|
|
426
|
+
#
|
|
427
|
+
# This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
422
428
|
#
|
|
423
429
|
# List all accounts for the user, plus balances, positions, and orders for each
|
|
424
430
|
# account.
|
|
425
|
-
#
|
|
426
|
-
# **Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
427
431
|
#
|
|
428
432
|
# @param user_id [String]
|
|
429
433
|
# @param user_secret [String]
|
|
@@ -435,7 +439,7 @@ module SnapTrade
|
|
|
435
439
|
end
|
|
436
440
|
|
|
437
441
|
# List all accounts for the user, plus balances, positions, and orders for each account.
|
|
438
|
-
# **Deprecated
|
|
442
|
+
# **Deprecated.** Use the account-specific holdings endpoint instead. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. List all accounts for the user, plus balances, positions, and orders for each account.
|
|
439
443
|
# @param user_id [String]
|
|
440
444
|
# @param user_secret [String]
|
|
441
445
|
# @param [Hash] opts the optional parameters
|
|
@@ -447,7 +451,7 @@ module SnapTrade
|
|
|
447
451
|
end
|
|
448
452
|
|
|
449
453
|
# List all accounts for the user, plus balances, positions, and orders for each account.
|
|
450
|
-
# **Deprecated
|
|
454
|
+
# **Deprecated.** Use the account-specific holdings endpoint instead. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. List all accounts for the user, plus balances, positions, and orders for each account.
|
|
451
455
|
# @param user_id [String]
|
|
452
456
|
# @param user_secret [String]
|
|
453
457
|
# @param [Hash] opts the optional parameters
|
|
@@ -1018,9 +1022,9 @@ module SnapTrade
|
|
|
1018
1022
|
|
|
1019
1023
|
# List account positions
|
|
1020
1024
|
#
|
|
1021
|
-
#
|
|
1025
|
+
# **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures.
|
|
1022
1026
|
#
|
|
1023
|
-
#
|
|
1027
|
+
# Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings).
|
|
1024
1028
|
#
|
|
1025
1029
|
# Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:
|
|
1026
1030
|
# - If you do, this endpoint returns real-time data.
|
|
@@ -1039,9 +1043,9 @@ module SnapTrade
|
|
|
1039
1043
|
|
|
1040
1044
|
# List account positions
|
|
1041
1045
|
#
|
|
1042
|
-
#
|
|
1046
|
+
# **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures.
|
|
1043
1047
|
#
|
|
1044
|
-
#
|
|
1048
|
+
# Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings).
|
|
1045
1049
|
#
|
|
1046
1050
|
# Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:
|
|
1047
1051
|
# - If you do, this endpoint returns real-time data.
|
|
@@ -1058,7 +1062,7 @@ module SnapTrade
|
|
|
1058
1062
|
end
|
|
1059
1063
|
|
|
1060
1064
|
# List account positions
|
|
1061
|
-
#
|
|
1065
|
+
# **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1062
1066
|
# @param user_id [String]
|
|
1063
1067
|
# @param user_secret [String]
|
|
1064
1068
|
# @param account_id [String]
|
|
@@ -1070,7 +1074,7 @@ module SnapTrade
|
|
|
1070
1074
|
end
|
|
1071
1075
|
|
|
1072
1076
|
# List account positions
|
|
1073
|
-
#
|
|
1077
|
+
# **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1074
1078
|
# @param user_id [String]
|
|
1075
1079
|
# @param user_secret [String]
|
|
1076
1080
|
# @param account_id [String]
|
|
@@ -1364,6 +1368,9 @@ module SnapTrade
|
|
|
1364
1368
|
# List account holdings
|
|
1365
1369
|
#
|
|
1366
1370
|
# **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders).
|
|
1371
|
+
#
|
|
1372
|
+
# This endpoint will return HTTP 410 Gone for all customers that sign up after May 11, 2026.
|
|
1373
|
+
#
|
|
1367
1374
|
# Returns a list of balances, positions, and recent orders for the specified account.
|
|
1368
1375
|
#
|
|
1369
1376
|
# Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:
|
|
@@ -1384,6 +1391,9 @@ module SnapTrade
|
|
|
1384
1391
|
# List account holdings
|
|
1385
1392
|
#
|
|
1386
1393
|
# **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders).
|
|
1394
|
+
#
|
|
1395
|
+
# This endpoint will return HTTP 410 Gone for all customers that sign up after May 11, 2026.
|
|
1396
|
+
#
|
|
1387
1397
|
# Returns a list of balances, positions, and recent orders for the specified account.
|
|
1388
1398
|
#
|
|
1389
1399
|
# Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:
|
|
@@ -1401,7 +1411,7 @@ module SnapTrade
|
|
|
1401
1411
|
end
|
|
1402
1412
|
|
|
1403
1413
|
# List account holdings
|
|
1404
|
-
# **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders). Returns a list of balances, positions, and recent orders for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1414
|
+
# **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders). This endpoint will return HTTP 410 Gone for all customers that sign up after May 11, 2026. Returns a list of balances, positions, and recent orders for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1405
1415
|
# @param account_id [String]
|
|
1406
1416
|
# @param user_id [String]
|
|
1407
1417
|
# @param user_secret [String]
|
|
@@ -1413,7 +1423,7 @@ module SnapTrade
|
|
|
1413
1423
|
end
|
|
1414
1424
|
|
|
1415
1425
|
# List account holdings
|
|
1416
|
-
# **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders). Returns a list of balances, positions, and recent orders for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1426
|
+
# **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders). This endpoint will return HTTP 410 Gone for all customers that sign up after May 11, 2026. Returns a list of balances, positions, and recent orders for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1417
1427
|
# @param account_id [String]
|
|
1418
1428
|
# @param user_id [String]
|
|
1419
1429
|
# @param user_secret [String]
|
|
@@ -19,9 +19,9 @@ module SnapTrade
|
|
|
19
19
|
|
|
20
20
|
# List account option positions
|
|
21
21
|
#
|
|
22
|
-
#
|
|
22
|
+
# **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures.
|
|
23
23
|
#
|
|
24
|
-
#
|
|
24
|
+
# Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).
|
|
25
25
|
#
|
|
26
26
|
# Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:
|
|
27
27
|
# - If you do, this endpoint returns real-time data.
|
|
@@ -38,9 +38,9 @@ module SnapTrade
|
|
|
38
38
|
|
|
39
39
|
# List account option positions
|
|
40
40
|
#
|
|
41
|
-
#
|
|
41
|
+
# **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures.
|
|
42
42
|
#
|
|
43
|
-
#
|
|
43
|
+
# Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).
|
|
44
44
|
#
|
|
45
45
|
# Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:
|
|
46
46
|
# - If you do, this endpoint returns real-time data.
|
|
@@ -55,7 +55,7 @@ module SnapTrade
|
|
|
55
55
|
end
|
|
56
56
|
|
|
57
57
|
# List account option positions
|
|
58
|
-
#
|
|
58
|
+
# **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
59
59
|
# @param user_id [String]
|
|
60
60
|
# @param user_secret [String]
|
|
61
61
|
# @param account_id [String]
|
|
@@ -67,7 +67,7 @@ module SnapTrade
|
|
|
67
67
|
end
|
|
68
68
|
|
|
69
69
|
# List account option positions
|
|
70
|
-
#
|
|
70
|
+
# **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
71
71
|
# @param user_id [String]
|
|
72
72
|
# @param user_secret [String]
|
|
73
73
|
# @param account_id [String]
|
|
@@ -143,7 +143,8 @@ module SnapTrade
|
|
|
143
143
|
|
|
144
144
|
# Cancel equity order
|
|
145
145
|
#
|
|
146
|
-
# **
|
|
146
|
+
# **Deprecated.** Use [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) instead.
|
|
147
|
+
#
|
|
147
148
|
# Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
|
148
149
|
#
|
|
149
150
|
# @param brokerage_order_id [String] Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
|
|
@@ -162,7 +163,8 @@ module SnapTrade
|
|
|
162
163
|
|
|
163
164
|
# Cancel equity order
|
|
164
165
|
#
|
|
165
|
-
# **
|
|
166
|
+
# **Deprecated.** Use [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) instead.
|
|
167
|
+
#
|
|
166
168
|
# Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
|
167
169
|
#
|
|
168
170
|
# @param brokerage_order_id [String] Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
|
|
@@ -179,7 +181,7 @@ module SnapTrade
|
|
|
179
181
|
end
|
|
180
182
|
|
|
181
183
|
# Cancel equity order
|
|
182
|
-
# **
|
|
184
|
+
# **Deprecated.** Use [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) instead. Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
|
183
185
|
# @param user_id [String]
|
|
184
186
|
# @param user_secret [String]
|
|
185
187
|
# @param account_id [String]
|
|
@@ -192,7 +194,7 @@ module SnapTrade
|
|
|
192
194
|
end
|
|
193
195
|
|
|
194
196
|
# Cancel equity order
|
|
195
|
-
# **
|
|
197
|
+
# **Deprecated.** Use [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) instead. Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
|
196
198
|
# @param user_id [String]
|
|
197
199
|
# @param user_secret [String]
|
|
198
200
|
# @param account_id [String]
|
|
@@ -795,8 +797,6 @@ module SnapTrade
|
|
|
795
797
|
# **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys**
|
|
796
798
|
#
|
|
797
799
|
# This endpoint does not work for options quotes.
|
|
798
|
-
#
|
|
799
|
-
# This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
800
800
|
#
|
|
801
801
|
# @param user_id [String]
|
|
802
802
|
# @param user_secret [String]
|
|
@@ -819,8 +819,6 @@ module SnapTrade
|
|
|
819
819
|
# **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys**
|
|
820
820
|
#
|
|
821
821
|
# This endpoint does not work for options quotes.
|
|
822
|
-
#
|
|
823
|
-
# This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
824
822
|
#
|
|
825
823
|
# @param user_id [String]
|
|
826
824
|
# @param user_secret [String]
|
|
@@ -834,7 +832,7 @@ module SnapTrade
|
|
|
834
832
|
end
|
|
835
833
|
|
|
836
834
|
# Get equity symbol quotes
|
|
837
|
-
# Returns a maximum of 10 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 is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes.
|
|
835
|
+
# Returns a maximum of 10 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 is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes.
|
|
838
836
|
# @param user_id [String]
|
|
839
837
|
# @param user_secret [String]
|
|
840
838
|
# @param symbols [String] List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator. Maximum of 10 values allowed
|
|
@@ -848,7 +846,7 @@ module SnapTrade
|
|
|
848
846
|
end
|
|
849
847
|
|
|
850
848
|
# Get equity symbol quotes
|
|
851
|
-
# Returns a maximum of 10 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 is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes.
|
|
849
|
+
# Returns a maximum of 10 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 is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes.
|
|
852
850
|
# @param user_id [String]
|
|
853
851
|
# @param user_secret [String]
|
|
854
852
|
# @param symbols [String] List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator. Maximum of 10 values allowed
|
|
@@ -923,7 +921,8 @@ module SnapTrade
|
|
|
923
921
|
|
|
924
922
|
# Place bracket order
|
|
925
923
|
#
|
|
926
|
-
# **
|
|
924
|
+
# **Deprecated.** Use [the new complex order endpoint](/reference/Trading/Trading_placeComplexOrder) instead.
|
|
925
|
+
#
|
|
927
926
|
# Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for
|
|
928
927
|
# use. Only supported on certain brokerages
|
|
929
928
|
#
|
|
@@ -959,7 +958,8 @@ module SnapTrade
|
|
|
959
958
|
|
|
960
959
|
# Place bracket order
|
|
961
960
|
#
|
|
962
|
-
# **
|
|
961
|
+
# **Deprecated.** Use [the new complex order endpoint](/reference/Trading/Trading_placeComplexOrder) instead.
|
|
962
|
+
#
|
|
963
963
|
# Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for
|
|
964
964
|
# use. Only supported on certain brokerages
|
|
965
965
|
#
|
|
@@ -993,7 +993,7 @@ module SnapTrade
|
|
|
993
993
|
end
|
|
994
994
|
|
|
995
995
|
# Place bracket order
|
|
996
|
-
# **
|
|
996
|
+
# **Deprecated.** Use [the new complex order endpoint](/reference/Trading/Trading_placeComplexOrder) instead. 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
|
|
997
997
|
# @param account_id [String] The ID of the account to execute the trade on.
|
|
998
998
|
# @param user_id [String]
|
|
999
999
|
# @param user_secret [String]
|
|
@@ -1006,7 +1006,7 @@ module SnapTrade
|
|
|
1006
1006
|
end
|
|
1007
1007
|
|
|
1008
1008
|
# Place bracket order
|
|
1009
|
-
# **
|
|
1009
|
+
# **Deprecated.** Use [the new complex order endpoint](/reference/Trading/Trading_placeComplexOrder) instead. 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
|
|
1010
1010
|
# @param account_id [String] The ID of the account to execute the trade on.
|
|
1011
1011
|
# @param user_id [String]
|
|
1012
1012
|
# @param user_secret [String]
|