snaptrade-typescript-sdk 9.0.34 → 9.0.36
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.
- package/README.md +54 -41
- package/dist/api/account-information-api-generated.d.ts +42 -42
- package/dist/api/account-information-api-generated.js +37 -37
- package/dist/api/authentication-api-generated.d.ts +28 -28
- package/dist/api/authentication-api-generated.js +28 -28
- package/dist/api/connections-api-generated.d.ts +4 -4
- package/dist/api/connections-api-generated.js +2 -2
- package/dist/api/options-api-generated.d.ts +10 -10
- package/dist/api/options-api-generated.js +9 -9
- package/dist/api/transactions-and-reporting-api-generated.d.ts +16 -16
- package/dist/api/transactions-and-reporting-api-generated.js +10 -10
- package/dist/browser.js +1 -1
- package/dist/configuration.js +1 -1
- package/dist/models/account-balance-total.d.ts +1 -1
- package/dist/models/account-holdings-account.d.ts +3 -3
- package/dist/models/account-order-record-universal-symbol.d.ts +6 -6
- package/dist/models/account-order-record.d.ts +1 -1
- package/dist/models/account-simple.d.ts +4 -4
- package/dist/models/account-sync-status.d.ts +1 -1
- package/dist/models/account.d.ts +12 -10
- package/dist/models/balance-currency.d.ts +25 -0
- package/dist/models/balance.d.ts +3 -3
- package/dist/models/delete-user-response.d.ts +8 -2
- package/dist/models/holdings-status.d.ts +4 -4
- package/dist/models/index.d.ts +6 -5
- package/dist/models/index.js +6 -5
- package/dist/models/login-redirect-uri.d.ts +4 -4
- package/dist/models/snap-trade-login-user-request-body.d.ts +6 -6
- package/dist/models/{universal-symbol-currency.d.ts → symbol-currency.d.ts} +5 -5
- package/dist/models/{universal-symbol-exchange.d.ts → symbol-exchange.d.ts} +10 -10
- package/dist/models/symbol.d.ts +13 -13
- package/dist/models/transactions-status.d.ts +6 -6
- package/dist/models/underlying-symbol.d.ts +3 -3
- package/dist/models/universal-activity-currency.d.ts +25 -0
- package/dist/models/universal-activity-option-symbol.d.ts +52 -0
- package/dist/models/universal-activity-symbol.d.ts +65 -0
- package/dist/models/universal-activity-symbol.js +2 -0
- package/dist/models/universal-activity.d.ts +40 -40
- package/dist/models/universal-symbol.d.ts +6 -6
- package/dist/models/user-idand-secret.d.ts +1 -1
- package/package.json +1 -1
- package/dist/models/amount.d.ts +0 -19
- package/dist/models/snap-trade-holdings-account-account-id-balance.d.ts +0 -14
- package/dist/models/snap-trade-holdings-account-account-id.d.ts +0 -74
- /package/dist/models/{amount.js → balance-currency.js} +0 -0
- /package/dist/models/{snap-trade-holdings-account-account-id-balance.js → symbol-currency.js} +0 -0
- /package/dist/models/{snap-trade-holdings-account-account-id.js → symbol-exchange.js} +0 -0
- /package/dist/models/{universal-symbol-currency.js → universal-activity-currency.js} +0 -0
- /package/dist/models/{universal-symbol-exchange.js → universal-activity-option-symbol.js} +0 -0
package/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://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.36)
|
|
10
10
|
[](https://snaptrade.com/)
|
|
11
11
|
|
|
12
12
|
</div>
|
|
@@ -205,7 +205,7 @@ const getAllUserHoldingsResponse =
|
|
|
205
205
|
|
|
206
206
|
##### brokerageAuthorizations: `string`<a id="brokerageauthorizations-string"></a>
|
|
207
207
|
|
|
208
|
-
Optional. Comma
|
|
208
|
+
Optional. Comma separated list of authorization IDs (only use if filtering is needed on one or more authorizations).
|
|
209
209
|
|
|
210
210
|
#### 🔄 Return<a id="🔄-return"></a>
|
|
211
211
|
|
|
@@ -222,7 +222,10 @@ Optional. Comma seperated list of authorization IDs (only use if filtering is ne
|
|
|
222
222
|
|
|
223
223
|
### `snaptrade.accountInformation.getUserAccountBalance`<a id="snaptradeaccountinformationgetuseraccountbalance"></a>
|
|
224
224
|
|
|
225
|
-
|
|
225
|
+
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).
|
|
226
|
+
|
|
227
|
+
The data returned here is cached. 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 data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
228
|
+
|
|
226
229
|
|
|
227
230
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
228
231
|
|
|
@@ -243,8 +246,6 @@ const getUserAccountBalanceResponse =
|
|
|
243
246
|
|
|
244
247
|
##### accountId: `string`<a id="accountid-string"></a>
|
|
245
248
|
|
|
246
|
-
The ID of the account to get balances.
|
|
247
|
-
|
|
248
249
|
#### 🔄 Return<a id="🔄-return"></a>
|
|
249
250
|
|
|
250
251
|
[Balance](./models/balance.ts)
|
|
@@ -260,8 +261,9 @@ The ID of the account to get balances.
|
|
|
260
261
|
|
|
261
262
|
### `snaptrade.accountInformation.getUserAccountDetails`<a id="snaptradeaccountinformationgetuseraccountdetails"></a>
|
|
262
263
|
|
|
263
|
-
Returns
|
|
264
|
-
|
|
264
|
+
Returns account detail known to SnapTrade for the specified account.
|
|
265
|
+
|
|
266
|
+
The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
265
267
|
|
|
266
268
|
|
|
267
269
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
@@ -283,8 +285,6 @@ const getUserAccountDetailsResponse =
|
|
|
283
285
|
|
|
284
286
|
##### accountId: `string`<a id="accountid-string"></a>
|
|
285
287
|
|
|
286
|
-
The ID of the account to get detail of.
|
|
287
|
-
|
|
288
288
|
#### 🔄 Return<a id="🔄-return"></a>
|
|
289
289
|
|
|
290
290
|
[Account](./models/account.ts)
|
|
@@ -300,7 +300,10 @@ The ID of the account to get detail of.
|
|
|
300
300
|
|
|
301
301
|
### `snaptrade.accountInformation.getUserAccountOrders`<a id="snaptradeaccountinformationgetuseraccountorders"></a>
|
|
302
302
|
|
|
303
|
-
|
|
303
|
+
Returns a list of recent orders in the specified account.
|
|
304
|
+
|
|
305
|
+
The data returned here is cached. 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 data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
306
|
+
|
|
304
307
|
|
|
305
308
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
306
309
|
|
|
@@ -323,8 +326,6 @@ const getUserAccountOrdersResponse =
|
|
|
323
326
|
|
|
324
327
|
##### accountId: `string`<a id="accountid-string"></a>
|
|
325
328
|
|
|
326
|
-
The ID of the account to get orders.
|
|
327
|
-
|
|
328
329
|
##### state: `'all' | 'open' | 'executed'`<a id="state-all--open--executed"></a>
|
|
329
330
|
|
|
330
331
|
defaults value is set to \"all\"
|
|
@@ -348,7 +349,10 @@ Number of days in the past to fetch the most recent orders. Defaults to the last
|
|
|
348
349
|
|
|
349
350
|
### `snaptrade.accountInformation.getUserAccountPositions`<a id="snaptradeaccountinformationgetuseraccountpositions"></a>
|
|
350
351
|
|
|
351
|
-
Returns a list of positions in the specified account.
|
|
352
|
+
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).
|
|
353
|
+
|
|
354
|
+
The data returned here is cached. 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 data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
355
|
+
|
|
352
356
|
|
|
353
357
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
354
358
|
|
|
@@ -369,8 +373,6 @@ const getUserAccountPositionsResponse =
|
|
|
369
373
|
|
|
370
374
|
##### accountId: `string`<a id="accountid-string"></a>
|
|
371
375
|
|
|
372
|
-
The ID of the account to get positions.
|
|
373
|
-
|
|
374
376
|
#### 🔄 Return<a id="🔄-return"></a>
|
|
375
377
|
|
|
376
378
|
[Position](./models/position.ts)
|
|
@@ -386,7 +388,7 @@ The ID of the account to get positions.
|
|
|
386
388
|
|
|
387
389
|
### `snaptrade.accountInformation.getUserHoldings`<a id="snaptradeaccountinformationgetuserholdings"></a>
|
|
388
390
|
|
|
389
|
-
|
|
391
|
+
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.__
|
|
390
392
|
|
|
391
393
|
The data returned here is cached. 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 data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
392
394
|
|
|
@@ -425,7 +427,10 @@ const getUserHoldingsResponse =
|
|
|
425
427
|
|
|
426
428
|
### `snaptrade.accountInformation.listUserAccounts`<a id="snaptradeaccountinformationlistuseraccounts"></a>
|
|
427
429
|
|
|
428
|
-
|
|
430
|
+
Returns all brokerage accounts known to SnapTrade for the authenticated user.
|
|
431
|
+
|
|
432
|
+
The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
433
|
+
|
|
429
434
|
|
|
430
435
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
431
436
|
|
|
@@ -519,7 +524,7 @@ const checkResponse = await snaptrade.apiStatus.check();
|
|
|
519
524
|
|
|
520
525
|
### `snaptrade.authentication.deleteSnapTradeUser`<a id="snaptradeauthenticationdeletesnaptradeuser"></a>
|
|
521
526
|
|
|
522
|
-
Deletes a user
|
|
527
|
+
Deletes a registered user and all associated data. This action is irreversible. This API is asynchronous and will return a 200 status code if the request is accepted. The user and all associated data will be queued for deletion. Once deleted, a `USER_DELETED` webhook will be sent.
|
|
523
528
|
|
|
524
529
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
525
530
|
|
|
@@ -549,7 +554,7 @@ const deleteSnapTradeUserResponse =
|
|
|
549
554
|
|
|
550
555
|
### `snaptrade.authentication.listSnapTradeUsers`<a id="snaptradeauthenticationlistsnaptradeusers"></a>
|
|
551
556
|
|
|
552
|
-
Returns a list of
|
|
557
|
+
Returns a list of all registered user IDs.
|
|
553
558
|
|
|
554
559
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
555
560
|
|
|
@@ -583,7 +588,7 @@ const loginSnapTradeUserResponse =
|
|
|
583
588
|
customRedirect: "https://snaptrade.com",
|
|
584
589
|
reconnect: "8b5f262d-4bb9-365d-888a-202bd3b15fa1",
|
|
585
590
|
connectionType: "read",
|
|
586
|
-
connectionPortalVersion: "
|
|
591
|
+
connectionPortalVersion: "v3",
|
|
587
592
|
});
|
|
588
593
|
```
|
|
589
594
|
|
|
@@ -595,27 +600,27 @@ const loginSnapTradeUserResponse =
|
|
|
595
600
|
|
|
596
601
|
##### broker: `string`<a id="broker-string"></a>
|
|
597
602
|
|
|
598
|
-
Slug of the brokerage to connect the user to. See [
|
|
603
|
+
Slug of the brokerage to connect the user to. See [the integrations page](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=3cfea70ef4254afc89704e47275a7a9a&pvs=4) for a list of supported brokerages and their slugs.
|
|
599
604
|
|
|
600
605
|
##### immediateRedirect: `boolean`<a id="immediateredirect-boolean"></a>
|
|
601
606
|
|
|
602
|
-
When set to
|
|
607
|
+
When set to `true`, user will be redirected back to the partner\\\'s site instead of the connection portal. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](https://docs.snaptrade.com/docs/implement-connection-portal) for more information.
|
|
603
608
|
|
|
604
609
|
##### customRedirect: `string`<a id="customredirect-string"></a>
|
|
605
610
|
|
|
606
|
-
URL to redirect the user to after the user connects their brokerage account
|
|
611
|
+
URL to redirect the user to after the user connects their brokerage account. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](https://docs.snaptrade.com/docs/implement-connection-portal) for more information.
|
|
607
612
|
|
|
608
613
|
##### reconnect: `string`<a id="reconnect-string"></a>
|
|
609
614
|
|
|
610
|
-
The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See
|
|
615
|
+
The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See the [guide on fixing broken connections](https://docs.snaptrade.com/docs/fix-broken-connections) for more information.
|
|
611
616
|
|
|
612
617
|
##### connectionType: `string`<a id="connectiontype-string"></a>
|
|
613
618
|
|
|
614
|
-
Sets whether the connection should be read or trade
|
|
619
|
+
Sets whether the connection should be read-only or trade-enabled.
|
|
615
620
|
|
|
616
621
|
##### connectionPortalVersion: `string`<a id="connectionportalversion-string"></a>
|
|
617
622
|
|
|
618
|
-
Sets the version of the connection portal to render
|
|
623
|
+
Sets the version of the connection portal to render.
|
|
619
624
|
|
|
620
625
|
#### 🔄 Return<a id="🔄-return"></a>
|
|
621
626
|
|
|
@@ -666,8 +671,7 @@ SnapTrade User ID. This is chosen by the API partner and can be any string that
|
|
|
666
671
|
|
|
667
672
|
### `snaptrade.authentication.resetSnapTradeUserSecret`<a id="snaptradeauthenticationresetsnaptradeusersecret"></a>
|
|
668
673
|
|
|
669
|
-
|
|
670
|
-
is compromised. Please note that if you call this endpoint and fail to save the new secret, you'll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
|
|
674
|
+
Rotates the secret for a SnapTrade user. You might use this if `userSecret` is compromised. Please note that if you call this endpoint and fail to save the new secret, you'll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
|
|
671
675
|
|
|
672
676
|
|
|
673
677
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
@@ -688,7 +692,7 @@ SnapTrade User ID. This is chosen by the API partner and can be any string that
|
|
|
688
692
|
|
|
689
693
|
##### userSecret: `string`<a id="usersecret-string"></a>
|
|
690
694
|
|
|
691
|
-
SnapTrade User Secret randomly generated by SnapTrade. This is privileged information and if compromised, should be rotated via the
|
|
695
|
+
SnapTrade User Secret randomly generated by SnapTrade. This is privileged information and if compromised, should be rotated via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret)
|
|
692
696
|
|
|
693
697
|
#### 🔄 Return<a id="🔄-return"></a>
|
|
694
698
|
|
|
@@ -906,11 +910,11 @@ const sessionEventsResponse = await snaptrade.connections.sessionEvents({
|
|
|
906
910
|
|
|
907
911
|
##### userId: `string`<a id="userid-string"></a>
|
|
908
912
|
|
|
909
|
-
Optional comma
|
|
913
|
+
Optional comma separated list of user IDs used to filter the request on specific users
|
|
910
914
|
|
|
911
915
|
##### sessionId: `string`<a id="sessionid-string"></a>
|
|
912
916
|
|
|
913
|
-
Optional comma
|
|
917
|
+
Optional comma separated list of session IDs used to filter the request on specific users
|
|
914
918
|
|
|
915
919
|
#### 🔄 Return<a id="🔄-return"></a>
|
|
916
920
|
|
|
@@ -1066,7 +1070,9 @@ Option strategy id obtained from response when creating option strategy object
|
|
|
1066
1070
|
|
|
1067
1071
|
### `snaptrade.options.listOptionHoldings`<a id="snaptradeoptionslistoptionholdings"></a>
|
|
1068
1072
|
|
|
1069
|
-
Returns a list of
|
|
1073
|
+
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).
|
|
1074
|
+
|
|
1075
|
+
The data returned here is cached. 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 data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
1070
1076
|
|
|
1071
1077
|
|
|
1072
1078
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
@@ -1075,7 +1081,7 @@ Returns a list of Options Positions.
|
|
|
1075
1081
|
const listOptionHoldingsResponse = await snaptrade.options.listOptionHoldings({
|
|
1076
1082
|
userId: "snaptrade-user-123",
|
|
1077
1083
|
userSecret: "USERSECRET123",
|
|
1078
|
-
accountId: "
|
|
1084
|
+
accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
|
|
1079
1085
|
});
|
|
1080
1086
|
```
|
|
1081
1087
|
|
|
@@ -1087,8 +1093,6 @@ const listOptionHoldingsResponse = await snaptrade.options.listOptionHoldings({
|
|
|
1087
1093
|
|
|
1088
1094
|
##### accountId: `string`<a id="accountid-string"></a>
|
|
1089
1095
|
|
|
1090
|
-
The ID of the account to fetch options holdings for.
|
|
1091
|
-
|
|
1092
1096
|
#### 🔄 Return<a id="🔄-return"></a>
|
|
1093
1097
|
|
|
1094
1098
|
[OptionsPosition](./models/options-position.ts)
|
|
@@ -1746,7 +1750,12 @@ Optional, defaults to true. Determines if a wait is performed to check on order
|
|
|
1746
1750
|
|
|
1747
1751
|
### `snaptrade.transactionsAndReporting.getActivities`<a id="snaptradetransactionsandreportinggetactivities"></a>
|
|
1748
1752
|
|
|
1749
|
-
Returns
|
|
1753
|
+
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.
|
|
1754
|
+
|
|
1755
|
+
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.
|
|
1756
|
+
|
|
1757
|
+
The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
1758
|
+
|
|
1750
1759
|
|
|
1751
1760
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
1752
1761
|
|
|
@@ -1759,7 +1768,7 @@ const getActivitiesResponse =
|
|
|
1759
1768
|
"917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
|
|
1760
1769
|
brokerageAuthorizations:
|
|
1761
1770
|
"917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
|
|
1762
|
-
type: "DIVIDEND",
|
|
1771
|
+
type: "BUY,SELL,DIVIDEND",
|
|
1763
1772
|
userId: "snaptrade-user-123",
|
|
1764
1773
|
userSecret: "USERSECRET123",
|
|
1765
1774
|
});
|
|
@@ -1773,19 +1782,23 @@ const getActivitiesResponse =
|
|
|
1773
1782
|
|
|
1774
1783
|
##### startDate: `string | Date`<a id="startdate-string--date"></a>
|
|
1775
1784
|
|
|
1785
|
+
The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on `trade_date`.
|
|
1786
|
+
|
|
1776
1787
|
##### endDate: `string | Date`<a id="enddate-string--date"></a>
|
|
1777
1788
|
|
|
1789
|
+
The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
|
|
1790
|
+
|
|
1778
1791
|
##### accounts: `string`<a id="accounts-string"></a>
|
|
1779
1792
|
|
|
1780
|
-
Optional comma
|
|
1793
|
+
Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
|
|
1781
1794
|
|
|
1782
1795
|
##### brokerageAuthorizations: `string`<a id="brokerageauthorizations-string"></a>
|
|
1783
1796
|
|
|
1784
|
-
Optional comma
|
|
1797
|
+
Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
|
|
1785
1798
|
|
|
1786
1799
|
##### type: `string`<a id="type-string"></a>
|
|
1787
1800
|
|
|
1788
|
-
Optional comma
|
|
1801
|
+
Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - BUY - SELL - DIVIDEND - CONTRIBUTION - WITHDRAWAL - REI - INTEREST - FEE
|
|
1789
1802
|
|
|
1790
1803
|
#### 🔄 Return<a id="🔄-return"></a>
|
|
1791
1804
|
|
|
@@ -1833,7 +1846,7 @@ const getReportingCustomRangeResponse =
|
|
|
1833
1846
|
|
|
1834
1847
|
##### accounts: `string`<a id="accounts-string"></a>
|
|
1835
1848
|
|
|
1836
|
-
Optional comma
|
|
1849
|
+
Optional comma separated list of account IDs used to filter the request on specific accounts
|
|
1837
1850
|
|
|
1838
1851
|
##### detailed: `boolean`<a id="detailed-boolean"></a>
|
|
1839
1852
|
|
|
@@ -17,38 +17,38 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
|
|
|
17
17
|
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
18
18
|
* @param {string} userId
|
|
19
19
|
* @param {string} userSecret
|
|
20
|
-
* @param {string} [brokerageAuthorizations] Optional. Comma
|
|
20
|
+
* @param {string} [brokerageAuthorizations] Optional. Comma separated list of authorization IDs (only use if filtering is needed on one or more authorizations).
|
|
21
21
|
* @param {*} [options] Override http request option.
|
|
22
22
|
* @deprecated
|
|
23
23
|
* @throws {RequiredError}
|
|
24
24
|
*/
|
|
25
25
|
getAllUserHoldings: (userId: string, userSecret: string, brokerageAuthorizations?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
27
|
+
* 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). The data returned here is cached. 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 data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
28
28
|
* @summary List account balances
|
|
29
29
|
* @param {string} userId
|
|
30
30
|
* @param {string} userSecret
|
|
31
|
-
* @param {string} accountId
|
|
31
|
+
* @param {string} accountId
|
|
32
32
|
* @param {*} [options] Override http request option.
|
|
33
33
|
* @throws {RequiredError}
|
|
34
34
|
*/
|
|
35
35
|
getUserAccountBalance: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36
36
|
/**
|
|
37
|
-
* Returns
|
|
38
|
-
* @summary
|
|
37
|
+
* Returns account detail known to SnapTrade for the specified account. The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
38
|
+
* @summary Get account detail
|
|
39
39
|
* @param {string} userId
|
|
40
40
|
* @param {string} userSecret
|
|
41
|
-
* @param {string} accountId
|
|
41
|
+
* @param {string} accountId
|
|
42
42
|
* @param {*} [options] Override http request option.
|
|
43
43
|
* @throws {RequiredError}
|
|
44
44
|
*/
|
|
45
45
|
getUserAccountDetails: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
46
|
/**
|
|
47
|
-
*
|
|
48
|
-
* @summary List account orders
|
|
47
|
+
* Returns a list of recent orders in the specified account. The data returned here is cached. 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 data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
48
|
+
* @summary List account recent orders
|
|
49
49
|
* @param {string} userId
|
|
50
50
|
* @param {string} userSecret
|
|
51
|
-
* @param {string} accountId
|
|
51
|
+
* @param {string} accountId
|
|
52
52
|
* @param {'all' | 'open' | 'executed'} [state] defaults value is set to \"all\"
|
|
53
53
|
* @param {number} [days] Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in.
|
|
54
54
|
* @param {*} [options] Override http request option.
|
|
@@ -56,17 +56,17 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
|
|
|
56
56
|
*/
|
|
57
57
|
getUserAccountOrders: (userId: string, userSecret: string, accountId: string, state?: 'all' | 'open' | 'executed', days?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
58
58
|
/**
|
|
59
|
-
* Returns a list of positions in the specified account.
|
|
59
|
+
* 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). The data returned here is cached. 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 data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
60
60
|
* @summary List account positions
|
|
61
61
|
* @param {string} userId
|
|
62
62
|
* @param {string} userSecret
|
|
63
|
-
* @param {string} accountId
|
|
63
|
+
* @param {string} accountId
|
|
64
64
|
* @param {*} [options] Override http request option.
|
|
65
65
|
* @throws {RequiredError}
|
|
66
66
|
*/
|
|
67
67
|
getUserAccountPositions: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
68
|
/**
|
|
69
|
-
*
|
|
69
|
+
* 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.__ The data returned here is cached. 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 data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
70
70
|
* @summary List account holdings
|
|
71
71
|
* @param {string} accountId
|
|
72
72
|
* @param {string} userId
|
|
@@ -76,7 +76,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
|
|
|
76
76
|
*/
|
|
77
77
|
getUserHoldings: (accountId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
78
78
|
/**
|
|
79
|
-
*
|
|
79
|
+
* Returns all brokerage accounts known to SnapTrade for the authenticated user. The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
80
80
|
* @summary List accounts
|
|
81
81
|
* @param {string} userId
|
|
82
82
|
* @param {string} userSecret
|
|
@@ -110,7 +110,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
|
|
|
110
110
|
*/
|
|
111
111
|
getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountHoldings>>>;
|
|
112
112
|
/**
|
|
113
|
-
*
|
|
113
|
+
* 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). The data returned here is cached. 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 data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
114
114
|
* @summary List account balances
|
|
115
115
|
* @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
|
|
116
116
|
* @param {*} [options] Override http request option.
|
|
@@ -118,23 +118,23 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
|
|
|
118
118
|
*/
|
|
119
119
|
getUserAccountBalance(requestParameters: AccountInformationApiGetUserAccountBalanceRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Balance>>>;
|
|
120
120
|
/**
|
|
121
|
-
* Returns
|
|
122
|
-
* @summary
|
|
121
|
+
* Returns account detail known to SnapTrade for the specified account. The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
122
|
+
* @summary Get account detail
|
|
123
123
|
* @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
|
|
124
124
|
* @param {*} [options] Override http request option.
|
|
125
125
|
* @throws {RequiredError}
|
|
126
126
|
*/
|
|
127
127
|
getUserAccountDetails(requestParameters: AccountInformationApiGetUserAccountDetailsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Account>>;
|
|
128
128
|
/**
|
|
129
|
-
*
|
|
130
|
-
* @summary List account orders
|
|
129
|
+
* Returns a list of recent orders in the specified account. The data returned here is cached. 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 data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
130
|
+
* @summary List account recent orders
|
|
131
131
|
* @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
|
|
132
132
|
* @param {*} [options] Override http request option.
|
|
133
133
|
* @throws {RequiredError}
|
|
134
134
|
*/
|
|
135
135
|
getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountOrderRecord>>>;
|
|
136
136
|
/**
|
|
137
|
-
* Returns a list of positions in the specified account.
|
|
137
|
+
* 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). The data returned here is cached. 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 data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
138
138
|
* @summary List account positions
|
|
139
139
|
* @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
|
|
140
140
|
* @param {*} [options] Override http request option.
|
|
@@ -142,7 +142,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
|
|
|
142
142
|
*/
|
|
143
143
|
getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Position>>>;
|
|
144
144
|
/**
|
|
145
|
-
*
|
|
145
|
+
* 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.__ The data returned here is cached. 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 data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
146
146
|
* @summary List account holdings
|
|
147
147
|
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
148
148
|
* @param {*} [options] Override http request option.
|
|
@@ -150,7 +150,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
|
|
|
150
150
|
*/
|
|
151
151
|
getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountHoldingsAccount>>;
|
|
152
152
|
/**
|
|
153
|
-
*
|
|
153
|
+
* Returns all brokerage accounts known to SnapTrade for the authenticated user. The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
154
154
|
* @summary List accounts
|
|
155
155
|
* @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
|
|
156
156
|
* @param {*} [options] Override http request option.
|
|
@@ -181,7 +181,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
|
|
|
181
181
|
*/
|
|
182
182
|
getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<AccountHoldings>>;
|
|
183
183
|
/**
|
|
184
|
-
*
|
|
184
|
+
* 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). The data returned here is cached. 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 data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
185
185
|
* @summary List account balances
|
|
186
186
|
* @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
|
|
187
187
|
* @param {*} [options] Override http request option.
|
|
@@ -189,23 +189,23 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
|
|
|
189
189
|
*/
|
|
190
190
|
getUserAccountBalance(requestParameters: AccountInformationApiGetUserAccountBalanceRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Balance>>;
|
|
191
191
|
/**
|
|
192
|
-
* Returns
|
|
193
|
-
* @summary
|
|
192
|
+
* Returns account detail known to SnapTrade for the specified account. The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
193
|
+
* @summary Get account detail
|
|
194
194
|
* @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
|
|
195
195
|
* @param {*} [options] Override http request option.
|
|
196
196
|
* @throws {RequiredError}
|
|
197
197
|
*/
|
|
198
198
|
getUserAccountDetails(requestParameters: AccountInformationApiGetUserAccountDetailsRequest, options?: AxiosRequestConfig): AxiosPromise<Account>;
|
|
199
199
|
/**
|
|
200
|
-
*
|
|
201
|
-
* @summary List account orders
|
|
200
|
+
* Returns a list of recent orders in the specified account. The data returned here is cached. 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 data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
201
|
+
* @summary List account recent orders
|
|
202
202
|
* @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
|
|
203
203
|
* @param {*} [options] Override http request option.
|
|
204
204
|
* @throws {RequiredError}
|
|
205
205
|
*/
|
|
206
206
|
getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): AxiosPromise<Array<AccountOrderRecord>>;
|
|
207
207
|
/**
|
|
208
|
-
* Returns a list of positions in the specified account.
|
|
208
|
+
* 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). The data returned here is cached. 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 data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
209
209
|
* @summary List account positions
|
|
210
210
|
* @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
|
|
211
211
|
* @param {*} [options] Override http request option.
|
|
@@ -213,7 +213,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
|
|
|
213
213
|
*/
|
|
214
214
|
getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Position>>;
|
|
215
215
|
/**
|
|
216
|
-
*
|
|
216
|
+
* 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.__ The data returned here is cached. 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 data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
217
217
|
* @summary List account holdings
|
|
218
218
|
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
219
219
|
* @param {*} [options] Override http request option.
|
|
@@ -221,7 +221,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
|
|
|
221
221
|
*/
|
|
222
222
|
getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<AccountHoldingsAccount>;
|
|
223
223
|
/**
|
|
224
|
-
*
|
|
224
|
+
* Returns all brokerage accounts known to SnapTrade for the authenticated user. The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
225
225
|
* @summary List accounts
|
|
226
226
|
* @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
|
|
227
227
|
* @param {*} [options] Override http request option.
|
|
@@ -256,7 +256,7 @@ export type AccountInformationApiGetAllUserHoldingsRequest = {
|
|
|
256
256
|
*/
|
|
257
257
|
readonly userSecret: string;
|
|
258
258
|
/**
|
|
259
|
-
* Optional. Comma
|
|
259
|
+
* Optional. Comma separated list of authorization IDs (only use if filtering is needed on one or more authorizations).
|
|
260
260
|
* @type {string}
|
|
261
261
|
* @memberof AccountInformationApiGetAllUserHoldings
|
|
262
262
|
*/
|
|
@@ -281,7 +281,7 @@ export type AccountInformationApiGetUserAccountBalanceRequest = {
|
|
|
281
281
|
*/
|
|
282
282
|
readonly userSecret: string;
|
|
283
283
|
/**
|
|
284
|
-
*
|
|
284
|
+
*
|
|
285
285
|
* @type {string}
|
|
286
286
|
* @memberof AccountInformationApiGetUserAccountBalance
|
|
287
287
|
*/
|
|
@@ -306,7 +306,7 @@ export type AccountInformationApiGetUserAccountDetailsRequest = {
|
|
|
306
306
|
*/
|
|
307
307
|
readonly userSecret: string;
|
|
308
308
|
/**
|
|
309
|
-
*
|
|
309
|
+
*
|
|
310
310
|
* @type {string}
|
|
311
311
|
* @memberof AccountInformationApiGetUserAccountDetails
|
|
312
312
|
*/
|
|
@@ -331,7 +331,7 @@ export type AccountInformationApiGetUserAccountOrdersRequest = {
|
|
|
331
331
|
*/
|
|
332
332
|
readonly userSecret: string;
|
|
333
333
|
/**
|
|
334
|
-
*
|
|
334
|
+
*
|
|
335
335
|
* @type {string}
|
|
336
336
|
* @memberof AccountInformationApiGetUserAccountOrders
|
|
337
337
|
*/
|
|
@@ -368,7 +368,7 @@ export type AccountInformationApiGetUserAccountPositionsRequest = {
|
|
|
368
368
|
*/
|
|
369
369
|
readonly userSecret: string;
|
|
370
370
|
/**
|
|
371
|
-
*
|
|
371
|
+
*
|
|
372
372
|
* @type {string}
|
|
373
373
|
* @memberof AccountInformationApiGetUserAccountPositions
|
|
374
374
|
*/
|
|
@@ -461,7 +461,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
|
461
461
|
*/
|
|
462
462
|
getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountHoldings[], any>>;
|
|
463
463
|
/**
|
|
464
|
-
*
|
|
464
|
+
* 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). The data returned here is cached. 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 data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
465
465
|
* @summary List account balances
|
|
466
466
|
* @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
|
|
467
467
|
* @param {*} [options] Override http request option.
|
|
@@ -470,8 +470,8 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
|
470
470
|
*/
|
|
471
471
|
getUserAccountBalance(requestParameters: AccountInformationApiGetUserAccountBalanceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Balance[], any>>;
|
|
472
472
|
/**
|
|
473
|
-
* Returns
|
|
474
|
-
* @summary
|
|
473
|
+
* Returns account detail known to SnapTrade for the specified account. The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
474
|
+
* @summary Get account detail
|
|
475
475
|
* @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
|
|
476
476
|
* @param {*} [options] Override http request option.
|
|
477
477
|
* @throws {RequiredError}
|
|
@@ -479,8 +479,8 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
|
479
479
|
*/
|
|
480
480
|
getUserAccountDetails(requestParameters: AccountInformationApiGetUserAccountDetailsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Account, any>>;
|
|
481
481
|
/**
|
|
482
|
-
*
|
|
483
|
-
* @summary List account orders
|
|
482
|
+
* Returns a list of recent orders in the specified account. The data returned here is cached. 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 data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
483
|
+
* @summary List account recent orders
|
|
484
484
|
* @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
|
|
485
485
|
* @param {*} [options] Override http request option.
|
|
486
486
|
* @throws {RequiredError}
|
|
@@ -488,7 +488,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
|
488
488
|
*/
|
|
489
489
|
getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord[], any>>;
|
|
490
490
|
/**
|
|
491
|
-
* Returns a list of positions in the specified account.
|
|
491
|
+
* 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). The data returned here is cached. 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 data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
492
492
|
* @summary List account positions
|
|
493
493
|
* @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
|
|
494
494
|
* @param {*} [options] Override http request option.
|
|
@@ -497,7 +497,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
|
497
497
|
*/
|
|
498
498
|
getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Position[], any>>;
|
|
499
499
|
/**
|
|
500
|
-
*
|
|
500
|
+
* 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.__ The data returned here is cached. 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 data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
501
501
|
* @summary List account holdings
|
|
502
502
|
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
503
503
|
* @param {*} [options] Override http request option.
|
|
@@ -506,7 +506,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
|
506
506
|
*/
|
|
507
507
|
getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountHoldingsAccount, any>>;
|
|
508
508
|
/**
|
|
509
|
-
*
|
|
509
|
+
* Returns all brokerage accounts known to SnapTrade for the authenticated user. The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
510
510
|
* @summary List accounts
|
|
511
511
|
* @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
|
|
512
512
|
* @param {*} [options] Override http request option.
|