snaptrade 2.0.192 → 2.0.194
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 +18 -16
- data/lib/snaptrade/api/account_information_api.rb +36 -34
- data/lib/snaptrade/api/connections_api.rb +10 -10
- data/lib/snaptrade/api/options_api.rb +4 -4
- data/lib/snaptrade/api/transactions_and_reporting_api.rb +4 -4
- data/lib/snaptrade/models/account.rb +1 -0
- data/lib/snaptrade/models/account_position.rb +1 -1
- data/lib/snaptrade/models/future_instrument.rb +1 -0
- data/lib/snaptrade/models/option_instrument.rb +1 -0
- data/lib/snaptrade/version.rb +1 -1
- data/spec/api/account_information_api_spec.rb +8 -8
- data/spec/api/connections_api_spec.rb +2 -2
- data/spec/api/options_api_spec.rb +1 -1
- data/spec/api/transactions_and_reporting_api_spec.rb +1 -1
- 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: 6be02c4adb2cc7c3f8fbd660bc2a256a7e2bfd171bc8ecb1390b707ec4a977f5
|
|
4
|
+
data.tar.gz: e822641bffd2b31a2ce8ebdb5e2bc233c09a4b942a20910f129fb78ca2c4aea9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d3c1c0d3157bc67d732b66c830212321ef6b5acf2f16e795c4eecc8514189a9fa3da1aafbc76a433702ef5f71015b19d65fd8b143fc17f41b27f9e3eb71d94d1
|
|
7
|
+
data.tar.gz: 915f143950dd6c5999d9f89056437c091aaa4cafbae1f04296031f513f3746d5da6fd4a02f929d973a7b178052804421221f4231f0a662bcd4a34b940f69fdb2
|
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.194)
|
|
10
10
|
[](https://snaptrade.com/)
|
|
11
11
|
|
|
12
12
|
</div>
|
|
@@ -91,7 +91,7 @@ Connect brokerage accounts to your app for live positions and trading
|
|
|
91
91
|
Add to Gemfile:
|
|
92
92
|
|
|
93
93
|
```ruby
|
|
94
|
-
gem 'snaptrade', '~> 2.0.
|
|
94
|
+
gem 'snaptrade', '~> 2.0.194'
|
|
95
95
|
```
|
|
96
96
|
|
|
97
97
|
## Getting Started<a id="getting-started"></a>
|
|
@@ -148,7 +148,7 @@ This endpoint is paginated with a default page size of 1000. The endpoint will r
|
|
|
148
148
|
|
|
149
149
|
Transaction are returned in reverse chronological order, using the `trade_date` field.
|
|
150
150
|
|
|
151
|
-
|
|
151
|
+
This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.
|
|
152
152
|
|
|
153
153
|
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.
|
|
154
154
|
|
|
@@ -258,7 +258,7 @@ Returns a list of all positions in the specified account.
|
|
|
258
258
|
|
|
259
259
|
The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.
|
|
260
260
|
|
|
261
|
-
|
|
261
|
+
`mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account.
|
|
262
262
|
|
|
263
263
|
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.
|
|
264
264
|
|
|
@@ -341,7 +341,7 @@ Returns a list of balances for the account. Each element of the list has a disti
|
|
|
341
341
|
|
|
342
342
|
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:
|
|
343
343
|
- If you do, this endpoint returns real-time data.
|
|
344
|
-
- If you don't,
|
|
344
|
+
- 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.
|
|
345
345
|
|
|
346
346
|
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.
|
|
347
347
|
|
|
@@ -381,7 +381,7 @@ Returns account detail known to SnapTrade for the specified account.
|
|
|
381
381
|
|
|
382
382
|
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:
|
|
383
383
|
- If you do, this endpoint returns real-time data.
|
|
384
|
-
- If you don't,
|
|
384
|
+
- 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.
|
|
385
385
|
|
|
386
386
|
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.
|
|
387
387
|
|
|
@@ -466,7 +466,7 @@ Returns a list of recent orders in the specified account.
|
|
|
466
466
|
|
|
467
467
|
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:
|
|
468
468
|
- If you do, this endpoint returns real-time data.
|
|
469
|
-
- If you don't,
|
|
469
|
+
- 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.
|
|
470
470
|
|
|
471
471
|
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.
|
|
472
472
|
|
|
@@ -517,7 +517,7 @@ Consider using the newer [unified positions endpoint](/reference/Account%20Infor
|
|
|
517
517
|
|
|
518
518
|
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:
|
|
519
519
|
- If you do, this endpoint returns real-time data.
|
|
520
|
-
- If you don't,
|
|
520
|
+
- 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.
|
|
521
521
|
|
|
522
522
|
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.
|
|
523
523
|
|
|
@@ -634,12 +634,14 @@ returns all six supported timeframes.
|
|
|
634
634
|
|
|
635
635
|
|
|
636
636
|
### `snaptrade.account_information.get_user_holdings`<a id="snaptradeaccount_informationget_user_holdings"></a>
|
|
637
|
+
|
|
637
638
|
|
|
638
|
-
|
|
639
|
+
**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).
|
|
640
|
+
Returns a list of balances, positions, and recent orders for the specified account.
|
|
639
641
|
|
|
640
642
|
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:
|
|
641
643
|
- If you do, this endpoint returns real-time data.
|
|
642
|
-
- If you don't,
|
|
644
|
+
- 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.
|
|
643
645
|
|
|
644
646
|
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.
|
|
645
647
|
|
|
@@ -680,7 +682,7 @@ p result
|
|
|
680
682
|
|
|
681
683
|
Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
|
|
682
684
|
|
|
683
|
-
This data is cached and
|
|
685
|
+
This endpoint returns Daily data regardless of the customer's plan. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the connection-scoped endpoint linked above. Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
684
686
|
|
|
685
687
|
|
|
686
688
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
@@ -1084,9 +1086,9 @@ p result
|
|
|
1084
1086
|
|
|
1085
1087
|
Returns all brokerage accounts that belong to the specified connection for the authenticated user.
|
|
1086
1088
|
|
|
1087
|
-
On
|
|
1089
|
+
On Pay as you Go / Real-time, this endpoint refreshes each account's opening date, funding date, and total value live from the brokerage on each call.
|
|
1088
1090
|
|
|
1089
|
-
On
|
|
1091
|
+
On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
1090
1092
|
|
|
1091
1093
|
Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
|
|
1092
1094
|
|
|
@@ -1162,7 +1164,7 @@ Trigger a holdings update for all accounts under this connection. Updates will b
|
|
|
1162
1164
|
This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.
|
|
1163
1165
|
|
|
1164
1166
|
**Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
|
|
1165
|
-
**Please note this endpoint is disabled for
|
|
1167
|
+
**Please note this endpoint is disabled for Pay as you Go / Real-time plans. Pay as you Go / Real-time plans do not benefit from this feature since data is refreshed when calls are made**
|
|
1166
1168
|
|
|
1167
1169
|
|
|
1168
1170
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
@@ -1476,7 +1478,7 @@ Consider using the newer [unified positions endpoint](/reference/Account%20Infor
|
|
|
1476
1478
|
|
|
1477
1479
|
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:
|
|
1478
1480
|
- If you do, this endpoint returns real-time data.
|
|
1479
|
-
- If you don't,
|
|
1481
|
+
- 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.
|
|
1480
1482
|
|
|
1481
1483
|
|
|
1482
1484
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
@@ -2868,7 +2870,7 @@ Returns all historical transactions for the specified user and filtering criteri
|
|
|
2868
2870
|
|
|
2869
2871
|
There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.
|
|
2870
2872
|
|
|
2871
|
-
|
|
2873
|
+
This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.
|
|
2872
2874
|
|
|
2873
2875
|
**Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
2874
2876
|
|
|
@@ -25,7 +25,7 @@ module SnapTrade
|
|
|
25
25
|
#
|
|
26
26
|
# Transaction are returned in reverse chronological order, using the `trade_date` field.
|
|
27
27
|
#
|
|
28
|
-
#
|
|
28
|
+
# This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.
|
|
29
29
|
#
|
|
30
30
|
# 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.
|
|
31
31
|
#
|
|
@@ -56,7 +56,7 @@ module SnapTrade
|
|
|
56
56
|
#
|
|
57
57
|
# Transaction are returned in reverse chronological order, using the `trade_date` field.
|
|
58
58
|
#
|
|
59
|
-
#
|
|
59
|
+
# This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.
|
|
60
60
|
#
|
|
61
61
|
# 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.
|
|
62
62
|
#
|
|
@@ -79,7 +79,7 @@ module SnapTrade
|
|
|
79
79
|
end
|
|
80
80
|
|
|
81
81
|
# 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.
|
|
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.
|
|
83
83
|
# @param account_id [String]
|
|
84
84
|
# @param user_id [String]
|
|
85
85
|
# @param user_secret [String]
|
|
@@ -96,7 +96,7 @@ module SnapTrade
|
|
|
96
96
|
end
|
|
97
97
|
|
|
98
98
|
# 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.
|
|
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.
|
|
100
100
|
# @param account_id [String]
|
|
101
101
|
# @param user_id [String]
|
|
102
102
|
# @param user_secret [String]
|
|
@@ -288,7 +288,7 @@ module SnapTrade
|
|
|
288
288
|
#
|
|
289
289
|
# The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.
|
|
290
290
|
#
|
|
291
|
-
#
|
|
291
|
+
# `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account.
|
|
292
292
|
#
|
|
293
293
|
# 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.
|
|
294
294
|
#
|
|
@@ -307,7 +307,7 @@ module SnapTrade
|
|
|
307
307
|
#
|
|
308
308
|
# The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.
|
|
309
309
|
#
|
|
310
|
-
#
|
|
310
|
+
# `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account.
|
|
311
311
|
#
|
|
312
312
|
# 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.
|
|
313
313
|
#
|
|
@@ -320,7 +320,7 @@ module SnapTrade
|
|
|
320
320
|
end
|
|
321
321
|
|
|
322
322
|
# List all account positions
|
|
323
|
-
# Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.
|
|
323
|
+
# Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account. 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.
|
|
324
324
|
# @param user_id [String]
|
|
325
325
|
# @param user_secret [String]
|
|
326
326
|
# @param account_id [String]
|
|
@@ -332,7 +332,7 @@ module SnapTrade
|
|
|
332
332
|
end
|
|
333
333
|
|
|
334
334
|
# List all account positions
|
|
335
|
-
# Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.
|
|
335
|
+
# Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account. 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.
|
|
336
336
|
# @param user_id [String]
|
|
337
337
|
# @param user_secret [String]
|
|
338
338
|
# @param account_id [String]
|
|
@@ -515,7 +515,7 @@ module SnapTrade
|
|
|
515
515
|
#
|
|
516
516
|
# 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:
|
|
517
517
|
# - If you do, this endpoint returns real-time data.
|
|
518
|
-
# - If you don't,
|
|
518
|
+
# - 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.
|
|
519
519
|
#
|
|
520
520
|
# 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.
|
|
521
521
|
#
|
|
@@ -534,7 +534,7 @@ module SnapTrade
|
|
|
534
534
|
#
|
|
535
535
|
# 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:
|
|
536
536
|
# - If you do, this endpoint returns real-time data.
|
|
537
|
-
# - If you don't,
|
|
537
|
+
# - 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.
|
|
538
538
|
#
|
|
539
539
|
# 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.
|
|
540
540
|
#
|
|
@@ -547,7 +547,7 @@ module SnapTrade
|
|
|
547
547
|
end
|
|
548
548
|
|
|
549
549
|
# List account balances
|
|
550
|
-
# Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). 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,
|
|
550
|
+
# Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). 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.
|
|
551
551
|
# @param user_id [String]
|
|
552
552
|
# @param user_secret [String]
|
|
553
553
|
# @param account_id [String]
|
|
@@ -559,7 +559,7 @@ module SnapTrade
|
|
|
559
559
|
end
|
|
560
560
|
|
|
561
561
|
# List account balances
|
|
562
|
-
# Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). 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,
|
|
562
|
+
# Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). 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.
|
|
563
563
|
# @param user_id [String]
|
|
564
564
|
# @param user_secret [String]
|
|
565
565
|
# @param account_id [String]
|
|
@@ -630,7 +630,7 @@ module SnapTrade
|
|
|
630
630
|
#
|
|
631
631
|
# 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:
|
|
632
632
|
# - If you do, this endpoint returns real-time data.
|
|
633
|
-
# - If you don't,
|
|
633
|
+
# - 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.
|
|
634
634
|
#
|
|
635
635
|
# 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.
|
|
636
636
|
#
|
|
@@ -649,7 +649,7 @@ module SnapTrade
|
|
|
649
649
|
#
|
|
650
650
|
# 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:
|
|
651
651
|
# - If you do, this endpoint returns real-time data.
|
|
652
|
-
# - If you don't,
|
|
652
|
+
# - 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.
|
|
653
653
|
#
|
|
654
654
|
# 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.
|
|
655
655
|
#
|
|
@@ -662,7 +662,7 @@ module SnapTrade
|
|
|
662
662
|
end
|
|
663
663
|
|
|
664
664
|
# Get account detail
|
|
665
|
-
# Returns account detail known to SnapTrade 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,
|
|
665
|
+
# Returns account detail known to SnapTrade 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.
|
|
666
666
|
# @param user_id [String]
|
|
667
667
|
# @param user_secret [String]
|
|
668
668
|
# @param account_id [String]
|
|
@@ -674,7 +674,7 @@ module SnapTrade
|
|
|
674
674
|
end
|
|
675
675
|
|
|
676
676
|
# Get account detail
|
|
677
|
-
# Returns account detail known to SnapTrade 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,
|
|
677
|
+
# Returns account detail known to SnapTrade 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.
|
|
678
678
|
# @param user_id [String]
|
|
679
679
|
# @param user_secret [String]
|
|
680
680
|
# @param account_id [String]
|
|
@@ -881,7 +881,7 @@ module SnapTrade
|
|
|
881
881
|
#
|
|
882
882
|
# 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:
|
|
883
883
|
# - If you do, this endpoint returns real-time data.
|
|
884
|
-
# - If you don't,
|
|
884
|
+
# - 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.
|
|
885
885
|
#
|
|
886
886
|
# 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.
|
|
887
887
|
#
|
|
@@ -904,7 +904,7 @@ module SnapTrade
|
|
|
904
904
|
#
|
|
905
905
|
# 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:
|
|
906
906
|
# - If you do, this endpoint returns real-time data.
|
|
907
|
-
# - If you don't,
|
|
907
|
+
# - 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.
|
|
908
908
|
#
|
|
909
909
|
# 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.
|
|
910
910
|
#
|
|
@@ -921,7 +921,7 @@ module SnapTrade
|
|
|
921
921
|
end
|
|
922
922
|
|
|
923
923
|
# List account orders
|
|
924
|
-
# Returns a list of recent orders in 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,
|
|
924
|
+
# Returns a list of recent orders in 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.
|
|
925
925
|
# @param user_id [String]
|
|
926
926
|
# @param user_secret [String]
|
|
927
927
|
# @param account_id [String]
|
|
@@ -935,7 +935,7 @@ module SnapTrade
|
|
|
935
935
|
end
|
|
936
936
|
|
|
937
937
|
# List account orders
|
|
938
|
-
# Returns a list of recent orders in 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,
|
|
938
|
+
# Returns a list of recent orders in 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.
|
|
939
939
|
# @param user_id [String]
|
|
940
940
|
# @param user_secret [String]
|
|
941
941
|
# @param account_id [String]
|
|
@@ -1024,7 +1024,7 @@ module SnapTrade
|
|
|
1024
1024
|
#
|
|
1025
1025
|
# 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
1026
|
# - If you do, this endpoint returns real-time data.
|
|
1027
|
-
# - If you don't,
|
|
1027
|
+
# - 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.
|
|
1028
1028
|
#
|
|
1029
1029
|
# 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.
|
|
1030
1030
|
#
|
|
@@ -1045,7 +1045,7 @@ module SnapTrade
|
|
|
1045
1045
|
#
|
|
1046
1046
|
# 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
1047
|
# - If you do, this endpoint returns real-time data.
|
|
1048
|
-
# - If you don't,
|
|
1048
|
+
# - 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.
|
|
1049
1049
|
#
|
|
1050
1050
|
# 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.
|
|
1051
1051
|
#
|
|
@@ -1058,7 +1058,7 @@ module SnapTrade
|
|
|
1058
1058
|
end
|
|
1059
1059
|
|
|
1060
1060
|
# List account positions
|
|
1061
|
-
# 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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,
|
|
1061
|
+
# 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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
1062
|
# @param user_id [String]
|
|
1063
1063
|
# @param user_secret [String]
|
|
1064
1064
|
# @param account_id [String]
|
|
@@ -1070,7 +1070,7 @@ module SnapTrade
|
|
|
1070
1070
|
end
|
|
1071
1071
|
|
|
1072
1072
|
# List account positions
|
|
1073
|
-
# 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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,
|
|
1073
|
+
# 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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
1074
|
# @param user_id [String]
|
|
1075
1075
|
# @param user_secret [String]
|
|
1076
1076
|
# @param account_id [String]
|
|
@@ -1363,11 +1363,12 @@ module SnapTrade
|
|
|
1363
1363
|
|
|
1364
1364
|
# List account holdings
|
|
1365
1365
|
#
|
|
1366
|
-
#
|
|
1366
|
+
# **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).
|
|
1367
|
+
# Returns a list of balances, positions, and recent orders for the specified account.
|
|
1367
1368
|
#
|
|
1368
1369
|
# 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:
|
|
1369
1370
|
# - If you do, this endpoint returns real-time data.
|
|
1370
|
-
# - If you don't,
|
|
1371
|
+
# - 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.
|
|
1371
1372
|
#
|
|
1372
1373
|
# 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.
|
|
1373
1374
|
#
|
|
@@ -1382,11 +1383,12 @@ module SnapTrade
|
|
|
1382
1383
|
|
|
1383
1384
|
# List account holdings
|
|
1384
1385
|
#
|
|
1385
|
-
#
|
|
1386
|
+
# **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).
|
|
1387
|
+
# Returns a list of balances, positions, and recent orders for the specified account.
|
|
1386
1388
|
#
|
|
1387
1389
|
# 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:
|
|
1388
1390
|
# - If you do, this endpoint returns real-time data.
|
|
1389
|
-
# - If you don't,
|
|
1391
|
+
# - 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.
|
|
1390
1392
|
#
|
|
1391
1393
|
# 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.
|
|
1392
1394
|
#
|
|
@@ -1399,7 +1401,7 @@ module SnapTrade
|
|
|
1399
1401
|
end
|
|
1400
1402
|
|
|
1401
1403
|
# List account holdings
|
|
1402
|
-
#
|
|
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.
|
|
1403
1405
|
# @param account_id [String]
|
|
1404
1406
|
# @param user_id [String]
|
|
1405
1407
|
# @param user_secret [String]
|
|
@@ -1411,7 +1413,7 @@ module SnapTrade
|
|
|
1411
1413
|
end
|
|
1412
1414
|
|
|
1413
1415
|
# List account holdings
|
|
1414
|
-
#
|
|
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.
|
|
1415
1417
|
# @param account_id [String]
|
|
1416
1418
|
# @param user_id [String]
|
|
1417
1419
|
# @param user_secret [String]
|
|
@@ -1482,7 +1484,7 @@ module SnapTrade
|
|
|
1482
1484
|
#
|
|
1483
1485
|
# Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
|
|
1484
1486
|
#
|
|
1485
|
-
# This data is cached and
|
|
1487
|
+
# This endpoint returns Daily data regardless of the customer's plan. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the connection-scoped endpoint linked above. Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
1486
1488
|
#
|
|
1487
1489
|
# @param user_id [String]
|
|
1488
1490
|
# @param user_secret [String]
|
|
@@ -1498,7 +1500,7 @@ module SnapTrade
|
|
|
1498
1500
|
#
|
|
1499
1501
|
# Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
|
|
1500
1502
|
#
|
|
1501
|
-
# This data is cached and
|
|
1503
|
+
# This endpoint returns Daily data regardless of the customer's plan. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the connection-scoped endpoint linked above. Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
1502
1504
|
#
|
|
1503
1505
|
# @param user_id [String]
|
|
1504
1506
|
# @param user_secret [String]
|
|
@@ -1508,7 +1510,7 @@ module SnapTrade
|
|
|
1508
1510
|
end
|
|
1509
1511
|
|
|
1510
1512
|
# List accounts
|
|
1511
|
-
# **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This data is cached and
|
|
1513
|
+
# **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This endpoint returns Daily data regardless of the customer's plan. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the connection-scoped endpoint linked above. Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
1512
1514
|
# @param user_id [String]
|
|
1513
1515
|
# @param user_secret [String]
|
|
1514
1516
|
# @param [Hash] opts the optional parameters
|
|
@@ -1519,7 +1521,7 @@ module SnapTrade
|
|
|
1519
1521
|
end
|
|
1520
1522
|
|
|
1521
1523
|
# List accounts
|
|
1522
|
-
# **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This data is cached and
|
|
1524
|
+
# **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This endpoint returns Daily data regardless of the customer's plan. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the connection-scoped endpoint linked above. Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
1523
1525
|
# @param user_id [String]
|
|
1524
1526
|
# @param user_secret [String]
|
|
1525
1527
|
# @param [Hash] opts the optional parameters
|
|
@@ -336,9 +336,9 @@ module SnapTrade
|
|
|
336
336
|
#
|
|
337
337
|
# Returns all brokerage accounts that belong to the specified connection for the authenticated user.
|
|
338
338
|
#
|
|
339
|
-
# On
|
|
339
|
+
# On Pay as you Go / Real-time, this endpoint refreshes each account's opening date, funding date, and total value live from the brokerage on each call.
|
|
340
340
|
#
|
|
341
|
-
# On
|
|
341
|
+
# On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
342
342
|
#
|
|
343
343
|
# Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
|
|
344
344
|
#
|
|
@@ -355,9 +355,9 @@ module SnapTrade
|
|
|
355
355
|
#
|
|
356
356
|
# Returns all brokerage accounts that belong to the specified connection for the authenticated user.
|
|
357
357
|
#
|
|
358
|
-
# On
|
|
358
|
+
# On Pay as you Go / Real-time, this endpoint refreshes each account's opening date, funding date, and total value live from the brokerage on each call.
|
|
359
359
|
#
|
|
360
|
-
# On
|
|
360
|
+
# On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
361
361
|
#
|
|
362
362
|
# Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
|
|
363
363
|
#
|
|
@@ -370,7 +370,7 @@ module SnapTrade
|
|
|
370
370
|
end
|
|
371
371
|
|
|
372
372
|
# List accounts for a connection
|
|
373
|
-
# Returns all brokerage accounts that belong to the specified connection for the authenticated user. On
|
|
373
|
+
# Returns all brokerage accounts that belong to the specified connection for the authenticated user. On Pay as you Go / Real-time, this endpoint refreshes each account's opening date, funding date, and total value live from the brokerage on each call. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
|
|
374
374
|
# @param authorization_id [String]
|
|
375
375
|
# @param user_id [String]
|
|
376
376
|
# @param user_secret [String]
|
|
@@ -382,7 +382,7 @@ module SnapTrade
|
|
|
382
382
|
end
|
|
383
383
|
|
|
384
384
|
# List accounts for a connection
|
|
385
|
-
# Returns all brokerage accounts that belong to the specified connection for the authenticated user. On
|
|
385
|
+
# Returns all brokerage accounts that belong to the specified connection for the authenticated user. On Pay as you Go / Real-time, this endpoint refreshes each account's opening date, funding date, and total value live from the brokerage on each call. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
|
|
386
386
|
# @param authorization_id [String]
|
|
387
387
|
# @param user_id [String]
|
|
388
388
|
# @param user_secret [String]
|
|
@@ -556,7 +556,7 @@ module SnapTrade
|
|
|
556
556
|
# This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.
|
|
557
557
|
#
|
|
558
558
|
# **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
|
|
559
|
-
# **Please note this endpoint is disabled for
|
|
559
|
+
# **Please note this endpoint is disabled for Pay as you Go / Real-time plans. Pay as you Go / Real-time plans do not benefit from this feature since data is refreshed when calls are made**
|
|
560
560
|
#
|
|
561
561
|
# @param authorization_id [String]
|
|
562
562
|
# @param user_id [String]
|
|
@@ -573,7 +573,7 @@ module SnapTrade
|
|
|
573
573
|
# This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.
|
|
574
574
|
#
|
|
575
575
|
# **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
|
|
576
|
-
# **Please note this endpoint is disabled for
|
|
576
|
+
# **Please note this endpoint is disabled for Pay as you Go / Real-time plans. Pay as you Go / Real-time plans do not benefit from this feature since data is refreshed when calls are made**
|
|
577
577
|
#
|
|
578
578
|
# @param authorization_id [String]
|
|
579
579
|
# @param user_id [String]
|
|
@@ -584,7 +584,7 @@ module SnapTrade
|
|
|
584
584
|
end
|
|
585
585
|
|
|
586
586
|
# Refresh holdings for a connection
|
|
587
|
-
# Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for
|
|
587
|
+
# Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Pay as you Go / Real-time plans. Pay as you Go / Real-time plans do not benefit from this feature since data is refreshed when calls are made**
|
|
588
588
|
# @param authorization_id [String]
|
|
589
589
|
# @param user_id [String]
|
|
590
590
|
# @param user_secret [String]
|
|
@@ -596,7 +596,7 @@ module SnapTrade
|
|
|
596
596
|
end
|
|
597
597
|
|
|
598
598
|
# Refresh holdings for a connection
|
|
599
|
-
# Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for
|
|
599
|
+
# Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Pay as you Go / Real-time plans. Pay as you Go / Real-time plans do not benefit from this feature since data is refreshed when calls are made**
|
|
600
600
|
# @param authorization_id [String]
|
|
601
601
|
# @param user_id [String]
|
|
602
602
|
# @param user_secret [String]
|
|
@@ -25,7 +25,7 @@ module SnapTrade
|
|
|
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.
|
|
28
|
-
# - If you don't,
|
|
28
|
+
# - 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.
|
|
29
29
|
#
|
|
30
30
|
# @param user_id [String]
|
|
31
31
|
# @param user_secret [String]
|
|
@@ -44,7 +44,7 @@ module SnapTrade
|
|
|
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.
|
|
47
|
-
# - If you don't,
|
|
47
|
+
# - 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.
|
|
48
48
|
#
|
|
49
49
|
# @param user_id [String]
|
|
50
50
|
# @param user_secret [String]
|
|
@@ -55,7 +55,7 @@ module SnapTrade
|
|
|
55
55
|
end
|
|
56
56
|
|
|
57
57
|
# List account option positions
|
|
58
|
-
# 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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,
|
|
58
|
+
# 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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
|
-
# 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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,
|
|
70
|
+
# 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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]
|
|
@@ -25,7 +25,7 @@ module SnapTrade
|
|
|
25
25
|
#
|
|
26
26
|
# There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.
|
|
27
27
|
#
|
|
28
|
-
#
|
|
28
|
+
# This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.
|
|
29
29
|
#
|
|
30
30
|
# **Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
31
31
|
#
|
|
@@ -55,7 +55,7 @@ module SnapTrade
|
|
|
55
55
|
#
|
|
56
56
|
# There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.
|
|
57
57
|
#
|
|
58
|
-
#
|
|
58
|
+
# This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.
|
|
59
59
|
#
|
|
60
60
|
# **Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
61
61
|
#
|
|
@@ -77,7 +77,7 @@ module SnapTrade
|
|
|
77
77
|
end
|
|
78
78
|
|
|
79
79
|
# Get transaction history for a user
|
|
80
|
-
# This endpoint is being deprecated but will continue to be available for use via SDKs, please use [the account level endpoint](/reference/Account%20Information/AccountInformation_getAccountActivities) if possible 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. There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.
|
|
80
|
+
# This endpoint is being deprecated but will continue to be available for use via SDKs, please use [the account level endpoint](/reference/Account%20Information/AccountInformation_getAccountActivities) if possible 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. There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. **Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
81
81
|
# @param user_id [String]
|
|
82
82
|
# @param user_secret [String]
|
|
83
83
|
# @param [Hash] opts the optional parameters
|
|
@@ -93,7 +93,7 @@ module SnapTrade
|
|
|
93
93
|
end
|
|
94
94
|
|
|
95
95
|
# Get transaction history for a user
|
|
96
|
-
# This endpoint is being deprecated but will continue to be available for use via SDKs, please use [the account level endpoint](/reference/Account%20Information/AccountInformation_getAccountActivities) if possible 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. There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.
|
|
96
|
+
# This endpoint is being deprecated but will continue to be available for use via SDKs, please use [the account level endpoint](/reference/Account%20Information/AccountInformation_getAccountActivities) if possible 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. There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. **Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
97
97
|
# @param user_id [String]
|
|
98
98
|
# @param user_secret [String]
|
|
99
99
|
# @param [Hash] opts the optional parameters
|
|
@@ -27,7 +27,7 @@ module SnapTrade
|
|
|
27
27
|
# ISO-4217 currency code for the position `price` and `cost_basis`.
|
|
28
28
|
attr_accessor :currency
|
|
29
29
|
|
|
30
|
-
# Present for
|
|
30
|
+
# Present for mutual fund positions that are also counted in cash balance or buying power.
|
|
31
31
|
attr_accessor :cash_equivalent
|
|
32
32
|
|
|
33
33
|
# Present for stock positions when tax lot data is enabled for the account.
|
data/lib/snaptrade/version.rb
CHANGED
|
@@ -29,7 +29,7 @@ describe 'AccountInformationApi' do
|
|
|
29
29
|
|
|
30
30
|
# unit tests for get_account_activities
|
|
31
31
|
# List account activities
|
|
32
|
-
# 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.
|
|
32
|
+
# 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.
|
|
33
33
|
# @param account_id
|
|
34
34
|
# @param user_id
|
|
35
35
|
# @param user_secret
|
|
@@ -62,7 +62,7 @@ describe 'AccountInformationApi' do
|
|
|
62
62
|
|
|
63
63
|
# unit tests for get_all_account_positions
|
|
64
64
|
# List all account positions
|
|
65
|
-
# Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.
|
|
65
|
+
# Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account. 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.
|
|
66
66
|
# @param user_id
|
|
67
67
|
# @param user_secret
|
|
68
68
|
# @param account_id
|
|
@@ -90,7 +90,7 @@ describe 'AccountInformationApi' do
|
|
|
90
90
|
|
|
91
91
|
# unit tests for get_user_account_balance
|
|
92
92
|
# List account balances
|
|
93
|
-
# Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). 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,
|
|
93
|
+
# Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). 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.
|
|
94
94
|
# @param user_id
|
|
95
95
|
# @param user_secret
|
|
96
96
|
# @param account_id
|
|
@@ -104,7 +104,7 @@ describe 'AccountInformationApi' do
|
|
|
104
104
|
|
|
105
105
|
# unit tests for get_user_account_details
|
|
106
106
|
# Get account detail
|
|
107
|
-
# Returns account detail known to SnapTrade 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,
|
|
107
|
+
# Returns account detail known to SnapTrade 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.
|
|
108
108
|
# @param user_id
|
|
109
109
|
# @param user_secret
|
|
110
110
|
# @param account_id
|
|
@@ -133,7 +133,7 @@ describe 'AccountInformationApi' do
|
|
|
133
133
|
|
|
134
134
|
# unit tests for get_user_account_orders
|
|
135
135
|
# List account orders
|
|
136
|
-
# Returns a list of recent orders in 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,
|
|
136
|
+
# Returns a list of recent orders in 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.
|
|
137
137
|
# @param user_id
|
|
138
138
|
# @param user_secret
|
|
139
139
|
# @param account_id
|
|
@@ -149,7 +149,7 @@ describe 'AccountInformationApi' do
|
|
|
149
149
|
|
|
150
150
|
# unit tests for get_user_account_positions
|
|
151
151
|
# List account positions
|
|
152
|
-
# 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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,
|
|
152
|
+
# 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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.
|
|
153
153
|
# @param user_id
|
|
154
154
|
# @param user_secret
|
|
155
155
|
# @param account_id
|
|
@@ -193,7 +193,7 @@ describe 'AccountInformationApi' do
|
|
|
193
193
|
|
|
194
194
|
# unit tests for get_user_holdings
|
|
195
195
|
# List account holdings
|
|
196
|
-
#
|
|
196
|
+
# **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.
|
|
197
197
|
# @param account_id
|
|
198
198
|
# @param user_id
|
|
199
199
|
# @param user_secret
|
|
@@ -207,7 +207,7 @@ describe 'AccountInformationApi' do
|
|
|
207
207
|
|
|
208
208
|
# unit tests for list_user_accounts
|
|
209
209
|
# List accounts
|
|
210
|
-
# **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This data is cached and
|
|
210
|
+
# **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This endpoint returns Daily data regardless of the customer's plan. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the connection-scoped endpoint linked above. Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
211
211
|
# @param user_id
|
|
212
212
|
# @param user_secret
|
|
213
213
|
# @param [Hash] opts the optional parameters
|
|
@@ -71,7 +71,7 @@ describe 'ConnectionsApi' do
|
|
|
71
71
|
|
|
72
72
|
# unit tests for list_brokerage_authorization_accounts
|
|
73
73
|
# List accounts for a connection
|
|
74
|
-
# Returns all brokerage accounts that belong to the specified connection for the authenticated user. On
|
|
74
|
+
# Returns all brokerage accounts that belong to the specified connection for the authenticated user. On Pay as you Go / Real-time, this endpoint refreshes each account's opening date, funding date, and total value live from the brokerage on each call. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
|
|
75
75
|
# @param authorization_id
|
|
76
76
|
# @param user_id
|
|
77
77
|
# @param user_secret
|
|
@@ -98,7 +98,7 @@ describe 'ConnectionsApi' do
|
|
|
98
98
|
|
|
99
99
|
# unit tests for refresh_brokerage_authorization
|
|
100
100
|
# Refresh holdings for a connection
|
|
101
|
-
# Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for
|
|
101
|
+
# Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Pay as you Go / Real-time plans. Pay as you Go / Real-time plans do not benefit from this feature since data is refreshed when calls are made**
|
|
102
102
|
# @param authorization_id
|
|
103
103
|
# @param user_id
|
|
104
104
|
# @param user_secret
|
|
@@ -29,7 +29,7 @@ describe 'OptionsApi' do
|
|
|
29
29
|
|
|
30
30
|
# unit tests for list_option_holdings
|
|
31
31
|
# List account option positions
|
|
32
|
-
# 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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,
|
|
32
|
+
# 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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.
|
|
33
33
|
# @param user_id
|
|
34
34
|
# @param user_secret
|
|
35
35
|
# @param account_id
|
|
@@ -29,7 +29,7 @@ describe 'TransactionsAndReportingApi' do
|
|
|
29
29
|
|
|
30
30
|
# unit tests for get_activities
|
|
31
31
|
# Get transaction history for a user
|
|
32
|
-
# This endpoint is being deprecated but will continue to be available for use via SDKs, please use [the account level endpoint](/reference/Account%20Information/AccountInformation_getAccountActivities) if possible 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. There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.
|
|
32
|
+
# This endpoint is being deprecated but will continue to be available for use via SDKs, please use [the account level endpoint](/reference/Account%20Information/AccountInformation_getAccountActivities) if possible 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. There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. **Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
33
33
|
# @param user_id
|
|
34
34
|
# @param user_secret
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
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.194
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- SnapTrade
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-05-
|
|
11
|
+
date: 2026-05-13 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: faraday
|