snaptrade 2.0.144 → 2.0.146
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 +116 -10
- data/lib/snaptrade/api/account_information_api.rb +48 -24
- data/lib/snaptrade/api/connections_api.rb +4 -4
- data/lib/snaptrade/api/experimental_endpoints_api.rb +273 -0
- data/lib/snaptrade/api/options_api.rb +8 -4
- data/lib/snaptrade/models/account_order_record_leg.rb +292 -0
- data/lib/snaptrade/models/account_order_record_leg_instrument.rb +259 -0
- data/lib/snaptrade/models/account_order_record_status_v2.rb +45 -0
- data/lib/snaptrade/models/account_order_record_v2.rb +325 -0
- data/lib/snaptrade/models/account_orders_v2_response.rb +225 -0
- data/lib/snaptrade/version.rb +1 -1
- data/lib/snaptrade.rb +8 -0
- data/spec/api/account_information_api_spec.rb +6 -6
- data/spec/api/connections_api_spec.rb +1 -1
- data/spec/api/experimental_endpoints_api_spec.rb +61 -0
- data/spec/api/options_api_spec.rb +1 -1
- data/spec/models/account_order_record_leg_instrument_spec.rb +53 -0
- data/spec/models/account_order_record_leg_spec.rb +71 -0
- data/spec/models/account_order_record_status_v2_spec.rb +23 -0
- data/spec/models/account_order_record_v2_spec.rb +89 -0
- data/spec/models/account_orders_v2_response_spec.rb +29 -0
- metadata +20 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 9dc93f6ba47560a7625dc7d9131286397846559dae48f66645b91a7279be983d
|
|
4
|
+
data.tar.gz: 557c29bc302ac3a0c2ed2e6290d6c75bfb320ff4ef8c7ab3e7be9fefc9183ac9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 52695d003c0ff1b3836deddd1cf772244b961374e0a9928b6e8bbf3461345ff6c4c41885531ce26d98d0b3dac8e09b1d1b39e84ad30cf1afa00e51d08a765e38
|
|
7
|
+
data.tar.gz: 617aced40e9e86c5a43d54156ba65944b2fa64f0eb1aaa457073816b896257ddbed4d7c388b55d72024e714c0787c4c8e7fef94bbaa8ab421fc6827b89b0fa46
|
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.146)
|
|
10
10
|
[](https://snaptrade.com/)
|
|
11
11
|
|
|
12
12
|
</div>
|
|
@@ -44,6 +44,8 @@ Connect brokerage accounts to your app for live positions and trading
|
|
|
44
44
|
* [`snaptrade.connections.remove_brokerage_authorization`](#snaptradeconnectionsremove_brokerage_authorization)
|
|
45
45
|
* [`snaptrade.connections.return_rates`](#snaptradeconnectionsreturn_rates)
|
|
46
46
|
* [`snaptrade.connections.session_events`](#snaptradeconnectionssession_events)
|
|
47
|
+
* [`snaptrade.experimental_endpoints.get_user_account_orders_v2`](#snaptradeexperimental_endpointsget_user_account_orders_v2)
|
|
48
|
+
* [`snaptrade.experimental_endpoints.get_user_account_recent_orders_v2`](#snaptradeexperimental_endpointsget_user_account_recent_orders_v2)
|
|
47
49
|
* [`snaptrade.options.get_options_chain`](#snaptradeoptionsget_options_chain)
|
|
48
50
|
* [`snaptrade.options.list_option_holdings`](#snaptradeoptionslist_option_holdings)
|
|
49
51
|
* [`snaptrade.reference_data.get_currency_exchange_rate_pair`](#snaptradereference_dataget_currency_exchange_rate_pair)
|
|
@@ -81,7 +83,7 @@ Connect brokerage accounts to your app for live positions and trading
|
|
|
81
83
|
Add to Gemfile:
|
|
82
84
|
|
|
83
85
|
```ruby
|
|
84
|
-
gem 'snaptrade', '~> 2.0.
|
|
86
|
+
gem 'snaptrade', '~> 2.0.146'
|
|
85
87
|
```
|
|
86
88
|
|
|
87
89
|
## Getting Started<a id="getting-started"></a>
|
|
@@ -253,7 +255,9 @@ needed on one or more authorizations).
|
|
|
253
255
|
|
|
254
256
|
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).
|
|
255
257
|
|
|
256
|
-
|
|
258
|
+
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:
|
|
259
|
+
- If you do, this endpoint returns real-time data.
|
|
260
|
+
- If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
257
261
|
|
|
258
262
|
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.
|
|
259
263
|
|
|
@@ -291,7 +295,9 @@ p result
|
|
|
291
295
|
|
|
292
296
|
Returns account detail known to SnapTrade for the specified account.
|
|
293
297
|
|
|
294
|
-
|
|
298
|
+
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:
|
|
299
|
+
- If you do, this endpoint returns real-time data.
|
|
300
|
+
- If you don't, the data is cached and refreshed once a day. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
295
301
|
|
|
296
302
|
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.
|
|
297
303
|
|
|
@@ -374,7 +380,9 @@ the brokerage system.
|
|
|
374
380
|
|
|
375
381
|
Returns a list of recent orders in the specified account.
|
|
376
382
|
|
|
377
|
-
|
|
383
|
+
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:
|
|
384
|
+
- If you do, this endpoint returns real-time data.
|
|
385
|
+
- If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
378
386
|
|
|
379
387
|
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.
|
|
380
388
|
|
|
@@ -421,7 +429,9 @@ Number of days in the past to fetch the most recent orders. Defaults to the last
|
|
|
421
429
|
|
|
422
430
|
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).
|
|
423
431
|
|
|
424
|
-
|
|
432
|
+
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:
|
|
433
|
+
- If you do, this endpoint returns real-time data.
|
|
434
|
+
- If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
425
435
|
|
|
426
436
|
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.
|
|
427
437
|
|
|
@@ -536,7 +546,9 @@ p result
|
|
|
536
546
|
|
|
537
547
|
Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
|
|
538
548
|
|
|
539
|
-
|
|
549
|
+
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:
|
|
550
|
+
- If you do, this endpoint returns real-time data.
|
|
551
|
+
- If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
540
552
|
|
|
541
553
|
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.
|
|
542
554
|
|
|
@@ -574,7 +586,9 @@ p result
|
|
|
574
586
|
|
|
575
587
|
Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
|
|
576
588
|
|
|
577
|
-
|
|
589
|
+
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:
|
|
590
|
+
- If you do, this endpoint returns real-time data.
|
|
591
|
+
- If you don't, the data is cached and refreshed once a day. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
578
592
|
|
|
579
593
|
|
|
580
594
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
@@ -978,7 +992,7 @@ p result
|
|
|
978
992
|
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.
|
|
979
993
|
This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.
|
|
980
994
|
|
|
981
|
-
**
|
|
995
|
+
**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)**
|
|
982
996
|
|
|
983
997
|
|
|
984
998
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
@@ -1111,6 +1125,96 @@ specific users
|
|
|
1111
1125
|
---
|
|
1112
1126
|
|
|
1113
1127
|
|
|
1128
|
+
### `snaptrade.experimental_endpoints.get_user_account_orders_v2`<a id="snaptradeexperimental_endpointsget_user_account_orders_v2"></a>
|
|
1129
|
+
|
|
1130
|
+
Returns a list of recent orders in the specified account.
|
|
1131
|
+
|
|
1132
|
+
The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.
|
|
1133
|
+
|
|
1134
|
+
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.
|
|
1135
|
+
|
|
1136
|
+
|
|
1137
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
1138
|
+
|
|
1139
|
+
```ruby
|
|
1140
|
+
result = snaptrade.experimental_endpoints.get_user_account_orders_v2(
|
|
1141
|
+
user_id: "snaptrade-user-123",
|
|
1142
|
+
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
|
|
1143
|
+
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
|
|
1144
|
+
state: "all",
|
|
1145
|
+
days: 30,
|
|
1146
|
+
)
|
|
1147
|
+
p result
|
|
1148
|
+
```
|
|
1149
|
+
|
|
1150
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
|
1151
|
+
|
|
1152
|
+
##### user_id: `String`<a id="user_id-string"></a>
|
|
1153
|
+
##### user_secret: `String`<a id="user_secret-string"></a>
|
|
1154
|
+
##### account_id: `String`<a id="account_id-string"></a>
|
|
1155
|
+
##### state: `String`<a id="state-string"></a>
|
|
1156
|
+
defaults value is set to \"all\"
|
|
1157
|
+
|
|
1158
|
+
##### days: `Integer`<a id="days-integer"></a>
|
|
1159
|
+
Number of days in the past to fetch the most recent orders. Defaults to the last
|
|
1160
|
+
30 days if no value is passed in.
|
|
1161
|
+
|
|
1162
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
|
1163
|
+
|
|
1164
|
+
[AccountOrdersV2Response](./lib/snaptrade/models/account_orders_v2_response.rb)
|
|
1165
|
+
|
|
1166
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
|
1167
|
+
|
|
1168
|
+
`/accounts/{accountId}/orders/v2` `GET`
|
|
1169
|
+
|
|
1170
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
|
1171
|
+
|
|
1172
|
+
---
|
|
1173
|
+
|
|
1174
|
+
|
|
1175
|
+
### `snaptrade.experimental_endpoints.get_user_account_recent_orders_v2`<a id="snaptradeexperimental_endpointsget_user_account_recent_orders_v2"></a>
|
|
1176
|
+
|
|
1177
|
+
A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format.
|
|
1178
|
+
This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders.
|
|
1179
|
+
Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days.
|
|
1180
|
+
By default only returns executed orders, but that can be changed by setting *only_executed* to false.
|
|
1181
|
+
**Because of the cost of realtime requests, 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)**
|
|
1182
|
+
|
|
1183
|
+
|
|
1184
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
1185
|
+
|
|
1186
|
+
```ruby
|
|
1187
|
+
result = snaptrade.experimental_endpoints.get_user_account_recent_orders_v2(
|
|
1188
|
+
user_id: "snaptrade-user-123",
|
|
1189
|
+
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
|
|
1190
|
+
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
|
|
1191
|
+
only_executed: true,
|
|
1192
|
+
)
|
|
1193
|
+
p result
|
|
1194
|
+
```
|
|
1195
|
+
|
|
1196
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
|
1197
|
+
|
|
1198
|
+
##### user_id: `String`<a id="user_id-string"></a>
|
|
1199
|
+
##### user_secret: `String`<a id="user_secret-string"></a>
|
|
1200
|
+
##### account_id: `String`<a id="account_id-string"></a>
|
|
1201
|
+
##### only_executed: `Boolean`<a id="only_executed-boolean"></a>
|
|
1202
|
+
Defaults to true. Indicates if request should fetch only executed orders. Set to
|
|
1203
|
+
false to retrieve non executed orders as well
|
|
1204
|
+
|
|
1205
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
|
1206
|
+
|
|
1207
|
+
[AccountOrdersV2Response](./lib/snaptrade/models/account_orders_v2_response.rb)
|
|
1208
|
+
|
|
1209
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
|
1210
|
+
|
|
1211
|
+
`/accounts/{accountId}/recentOrders/v2` `GET`
|
|
1212
|
+
|
|
1213
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
|
1214
|
+
|
|
1215
|
+
---
|
|
1216
|
+
|
|
1217
|
+
|
|
1114
1218
|
### `snaptrade.options.get_options_chain`<a id="snaptradeoptionsget_options_chain"></a>
|
|
1115
1219
|
|
|
1116
1220
|
Returns the option chain for the specified symbol in the specified account.
|
|
@@ -1154,7 +1258,9 @@ Universal symbol ID if symbol
|
|
|
1154
1258
|
|
|
1155
1259
|
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).
|
|
1156
1260
|
|
|
1157
|
-
|
|
1261
|
+
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:
|
|
1262
|
+
- If you do, this endpoint returns real-time data.
|
|
1263
|
+
- If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
1158
1264
|
|
|
1159
1265
|
|
|
1160
1266
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
@@ -291,7 +291,9 @@ module SnapTrade
|
|
|
291
291
|
#
|
|
292
292
|
# 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).
|
|
293
293
|
#
|
|
294
|
-
#
|
|
294
|
+
# 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:
|
|
295
|
+
# - If you do, this endpoint returns real-time data.
|
|
296
|
+
# - If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
295
297
|
#
|
|
296
298
|
# 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.
|
|
297
299
|
#
|
|
@@ -308,7 +310,9 @@ module SnapTrade
|
|
|
308
310
|
#
|
|
309
311
|
# 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).
|
|
310
312
|
#
|
|
311
|
-
#
|
|
313
|
+
# 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:
|
|
314
|
+
# - If you do, this endpoint returns real-time data.
|
|
315
|
+
# - If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
312
316
|
#
|
|
313
317
|
# 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.
|
|
314
318
|
#
|
|
@@ -321,7 +325,7 @@ module SnapTrade
|
|
|
321
325
|
end
|
|
322
326
|
|
|
323
327
|
# List account balances
|
|
324
|
-
# 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).
|
|
328
|
+
# 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, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific 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.
|
|
325
329
|
# @param user_id [String]
|
|
326
330
|
# @param user_secret [String]
|
|
327
331
|
# @param account_id [String]
|
|
@@ -333,7 +337,7 @@ module SnapTrade
|
|
|
333
337
|
end
|
|
334
338
|
|
|
335
339
|
# List account balances
|
|
336
|
-
# 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).
|
|
340
|
+
# 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, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific 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.
|
|
337
341
|
# @param user_id [String]
|
|
338
342
|
# @param user_secret [String]
|
|
339
343
|
# @param account_id [String]
|
|
@@ -402,7 +406,9 @@ module SnapTrade
|
|
|
402
406
|
#
|
|
403
407
|
# Returns account detail known to SnapTrade for the specified account.
|
|
404
408
|
#
|
|
405
|
-
#
|
|
409
|
+
# 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:
|
|
410
|
+
# - If you do, this endpoint returns real-time data.
|
|
411
|
+
# - If you don't, the data is cached and refreshed once a day. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
406
412
|
#
|
|
407
413
|
# 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.
|
|
408
414
|
#
|
|
@@ -419,7 +425,9 @@ module SnapTrade
|
|
|
419
425
|
#
|
|
420
426
|
# Returns account detail known to SnapTrade for the specified account.
|
|
421
427
|
#
|
|
422
|
-
#
|
|
428
|
+
# 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:
|
|
429
|
+
# - If you do, this endpoint returns real-time data.
|
|
430
|
+
# - If you don't, the data is cached and refreshed once a day. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
423
431
|
#
|
|
424
432
|
# 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.
|
|
425
433
|
#
|
|
@@ -432,7 +440,7 @@ module SnapTrade
|
|
|
432
440
|
end
|
|
433
441
|
|
|
434
442
|
# Get account detail
|
|
435
|
-
# Returns account detail known to SnapTrade for the specified account.
|
|
443
|
+
# 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, the data is cached and refreshed once a day. 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.
|
|
436
444
|
# @param user_id [String]
|
|
437
445
|
# @param user_secret [String]
|
|
438
446
|
# @param account_id [String]
|
|
@@ -444,7 +452,7 @@ module SnapTrade
|
|
|
444
452
|
end
|
|
445
453
|
|
|
446
454
|
# Get account detail
|
|
447
|
-
# Returns account detail known to SnapTrade for the specified account.
|
|
455
|
+
# 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, the data is cached and refreshed once a day. 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.
|
|
448
456
|
# @param user_id [String]
|
|
449
457
|
# @param user_secret [String]
|
|
450
458
|
# @param account_id [String]
|
|
@@ -649,7 +657,9 @@ module SnapTrade
|
|
|
649
657
|
#
|
|
650
658
|
# Returns a list of recent orders in the specified account.
|
|
651
659
|
#
|
|
652
|
-
#
|
|
660
|
+
# 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:
|
|
661
|
+
# - If you do, this endpoint returns real-time data.
|
|
662
|
+
# - If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
653
663
|
#
|
|
654
664
|
# 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
665
|
#
|
|
@@ -670,7 +680,9 @@ module SnapTrade
|
|
|
670
680
|
#
|
|
671
681
|
# Returns a list of recent orders in the specified account.
|
|
672
682
|
#
|
|
673
|
-
#
|
|
683
|
+
# 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:
|
|
684
|
+
# - If you do, this endpoint returns real-time data.
|
|
685
|
+
# - If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
674
686
|
#
|
|
675
687
|
# 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.
|
|
676
688
|
#
|
|
@@ -687,7 +699,7 @@ module SnapTrade
|
|
|
687
699
|
end
|
|
688
700
|
|
|
689
701
|
# List account orders
|
|
690
|
-
# Returns a list of recent orders in the specified account.
|
|
702
|
+
# 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, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific 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.
|
|
691
703
|
# @param user_id [String]
|
|
692
704
|
# @param user_secret [String]
|
|
693
705
|
# @param account_id [String]
|
|
@@ -701,7 +713,7 @@ module SnapTrade
|
|
|
701
713
|
end
|
|
702
714
|
|
|
703
715
|
# List account orders
|
|
704
|
-
# Returns a list of recent orders in the specified account.
|
|
716
|
+
# 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, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific 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.
|
|
705
717
|
# @param user_id [String]
|
|
706
718
|
# @param user_secret [String]
|
|
707
719
|
# @param account_id [String]
|
|
@@ -782,7 +794,9 @@ module SnapTrade
|
|
|
782
794
|
#
|
|
783
795
|
# 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).
|
|
784
796
|
#
|
|
785
|
-
#
|
|
797
|
+
# 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:
|
|
798
|
+
# - If you do, this endpoint returns real-time data.
|
|
799
|
+
# - If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
786
800
|
#
|
|
787
801
|
# 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.
|
|
788
802
|
#
|
|
@@ -799,7 +813,9 @@ module SnapTrade
|
|
|
799
813
|
#
|
|
800
814
|
# 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).
|
|
801
815
|
#
|
|
802
|
-
#
|
|
816
|
+
# 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:
|
|
817
|
+
# - If you do, this endpoint returns real-time data.
|
|
818
|
+
# - If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
803
819
|
#
|
|
804
820
|
# 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.
|
|
805
821
|
#
|
|
@@ -812,7 +828,7 @@ module SnapTrade
|
|
|
812
828
|
end
|
|
813
829
|
|
|
814
830
|
# List account positions
|
|
815
|
-
# 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).
|
|
831
|
+
# 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, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific 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.
|
|
816
832
|
# @param user_id [String]
|
|
817
833
|
# @param user_secret [String]
|
|
818
834
|
# @param account_id [String]
|
|
@@ -824,7 +840,7 @@ module SnapTrade
|
|
|
824
840
|
end
|
|
825
841
|
|
|
826
842
|
# List account positions
|
|
827
|
-
# 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).
|
|
843
|
+
# 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, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific 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.
|
|
828
844
|
# @param user_id [String]
|
|
829
845
|
# @param user_secret [String]
|
|
830
846
|
# @param account_id [String]
|
|
@@ -1114,7 +1130,9 @@ module SnapTrade
|
|
|
1114
1130
|
#
|
|
1115
1131
|
# Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
|
|
1116
1132
|
#
|
|
1117
|
-
#
|
|
1133
|
+
# 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:
|
|
1134
|
+
# - If you do, this endpoint returns real-time data.
|
|
1135
|
+
# - If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
1118
1136
|
#
|
|
1119
1137
|
# 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.
|
|
1120
1138
|
#
|
|
@@ -1131,7 +1149,9 @@ module SnapTrade
|
|
|
1131
1149
|
#
|
|
1132
1150
|
# Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
|
|
1133
1151
|
#
|
|
1134
|
-
#
|
|
1152
|
+
# 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:
|
|
1153
|
+
# - If you do, this endpoint returns real-time data.
|
|
1154
|
+
# - If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
1135
1155
|
#
|
|
1136
1156
|
# 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.
|
|
1137
1157
|
#
|
|
@@ -1144,7 +1164,7 @@ module SnapTrade
|
|
|
1144
1164
|
end
|
|
1145
1165
|
|
|
1146
1166
|
# List account holdings
|
|
1147
|
-
# Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
|
|
1167
|
+
# Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__ 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, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific 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.
|
|
1148
1168
|
# @param account_id [String]
|
|
1149
1169
|
# @param user_id [String]
|
|
1150
1170
|
# @param user_secret [String]
|
|
@@ -1156,7 +1176,7 @@ module SnapTrade
|
|
|
1156
1176
|
end
|
|
1157
1177
|
|
|
1158
1178
|
# List account holdings
|
|
1159
|
-
# Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
|
|
1179
|
+
# Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__ 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, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific 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.
|
|
1160
1180
|
# @param account_id [String]
|
|
1161
1181
|
# @param user_id [String]
|
|
1162
1182
|
# @param user_secret [String]
|
|
@@ -1225,7 +1245,9 @@ module SnapTrade
|
|
|
1225
1245
|
#
|
|
1226
1246
|
# Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
|
|
1227
1247
|
#
|
|
1228
|
-
#
|
|
1248
|
+
# 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:
|
|
1249
|
+
# - If you do, this endpoint returns real-time data.
|
|
1250
|
+
# - If you don't, the data is cached and refreshed once a day. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
1229
1251
|
#
|
|
1230
1252
|
# @param user_id [String]
|
|
1231
1253
|
# @param user_secret [String]
|
|
@@ -1239,7 +1261,9 @@ module SnapTrade
|
|
|
1239
1261
|
#
|
|
1240
1262
|
# Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
|
|
1241
1263
|
#
|
|
1242
|
-
#
|
|
1264
|
+
# 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:
|
|
1265
|
+
# - If you do, this endpoint returns real-time data.
|
|
1266
|
+
# - If you don't, the data is cached and refreshed once a day. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
1243
1267
|
#
|
|
1244
1268
|
# @param user_id [String]
|
|
1245
1269
|
# @param user_secret [String]
|
|
@@ -1249,7 +1273,7 @@ module SnapTrade
|
|
|
1249
1273
|
end
|
|
1250
1274
|
|
|
1251
1275
|
# List accounts
|
|
1252
|
-
# Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
|
|
1276
|
+
# Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. 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, the data is cached and refreshed once a day. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
1253
1277
|
# @param user_id [String]
|
|
1254
1278
|
# @param user_secret [String]
|
|
1255
1279
|
# @param [Hash] opts the optional parameters
|
|
@@ -1260,7 +1284,7 @@ module SnapTrade
|
|
|
1260
1284
|
end
|
|
1261
1285
|
|
|
1262
1286
|
# List accounts
|
|
1263
|
-
# Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
|
|
1287
|
+
# Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. 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, the data is cached and refreshed once a day. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
1264
1288
|
# @param user_id [String]
|
|
1265
1289
|
# @param user_secret [String]
|
|
1266
1290
|
# @param [Hash] opts the optional parameters
|
|
@@ -337,7 +337,7 @@ module SnapTrade
|
|
|
337
337
|
# 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.
|
|
338
338
|
# This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.
|
|
339
339
|
#
|
|
340
|
-
# **
|
|
340
|
+
# **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)**
|
|
341
341
|
#
|
|
342
342
|
# @param authorization_id [String]
|
|
343
343
|
# @param user_id [String]
|
|
@@ -353,7 +353,7 @@ module SnapTrade
|
|
|
353
353
|
# 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.
|
|
354
354
|
# This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.
|
|
355
355
|
#
|
|
356
|
-
# **
|
|
356
|
+
# **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)**
|
|
357
357
|
#
|
|
358
358
|
# @param authorization_id [String]
|
|
359
359
|
# @param user_id [String]
|
|
@@ -364,7 +364,7 @@ module SnapTrade
|
|
|
364
364
|
end
|
|
365
365
|
|
|
366
366
|
# Refresh holdings for a connection
|
|
367
|
-
# 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. **
|
|
367
|
+
# 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)**
|
|
368
368
|
# @param authorization_id [String]
|
|
369
369
|
# @param user_id [String]
|
|
370
370
|
# @param user_secret [String]
|
|
@@ -376,7 +376,7 @@ module SnapTrade
|
|
|
376
376
|
end
|
|
377
377
|
|
|
378
378
|
# Refresh holdings for a connection
|
|
379
|
-
# 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. **
|
|
379
|
+
# 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)**
|
|
380
380
|
# @param authorization_id [String]
|
|
381
381
|
# @param user_id [String]
|
|
382
382
|
# @param user_secret [String]
|