snaptrade-typescript-sdk 13.2.4 → 13.2.5
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 +6 -6
- package/dist/browser.umd.js +1 -1
- package/dist/index.cjs +21 -21
- package/dist/index.d.cts +156 -27
- package/dist/index.d.mts +156 -27
- package/dist/index.d.ts +156 -27
- package/dist/index.mjs +21 -21
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -63,7 +63,7 @@ backoff with jitter rather than from the headers.
|
|
|
63
63
|
See https://docs.snaptrade.com/docs/ratelimiting.
|
|
64
64
|
|
|
65
65
|
|
|
66
|
-
[](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/13.2.5)
|
|
67
67
|
[](https://snaptrade.com/)
|
|
68
68
|
|
|
69
69
|
</div>
|
|
@@ -560,7 +560,7 @@ The client identifies the user in this mode. Do not pass `userId` `userSecret` t
|
|
|
560
560
|
|
|
561
561
|
### `snaptrade.accountInformation.getAccountDetails`<a id="snaptradeaccountinformationgetaccountdetails"></a>
|
|
562
562
|
|
|
563
|
-
Returns the specified account for the authenticated user. The account can be an investment, deposit, line of credit, or
|
|
563
|
+
Returns the specified account for the authenticated user. The account can be an investment, deposit, line of credit, annuity, or mortgage account. Use the `kind` discriminator to determine the schema for the account.
|
|
564
564
|
|
|
565
565
|
On Pay as you Go / Real-time, this endpoint refreshes the account's opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts.
|
|
566
566
|
|
|
@@ -775,7 +775,7 @@ The client identifies the user in this mode. Do not pass `userId` `userSecret` t
|
|
|
775
775
|
### `snaptrade.accountInformation.getUserAccountDetails`<a id="snaptradeaccountinformationgetuseraccountdetails"></a>
|
|
776
776
|

|
|
777
777
|
|
|
778
|
-
**Deprecated.** Use the [get account details](/reference/Account%20Information/AccountInformation_getAccountDetails) endpoint instead, which supports all account types, including investment, deposit, line of credit, and
|
|
778
|
+
**Deprecated.** Use the [get account details](/reference/Account%20Information/AccountInformation_getAccountDetails) endpoint instead, which supports all account types, including investment, deposit, line of credit, annuity, and mortgage accounts.
|
|
779
779
|
|
|
780
780
|
Returns account detail known to SnapTrade for the specified account.
|
|
781
781
|
|
|
@@ -1220,7 +1220,7 @@ The client identifies the user in this mode. Do not pass `userId` `userSecret` t
|
|
|
1220
1220
|
|
|
1221
1221
|
Returns all accounts across all connections known to SnapTrade for the authenticated user.
|
|
1222
1222
|
|
|
1223
|
-
The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, and
|
|
1223
|
+
The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, annuity, and mortgage accounts. Use the `kind` discriminator to determine the schema for each account.
|
|
1224
1224
|
|
|
1225
1225
|
This endpoint returns Daily data regardless of the customer's plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user's connections in a single call. Exact refresh timing may vary by institution. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listConnectionAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
1226
1226
|
|
|
@@ -1278,7 +1278,7 @@ The client identifies the user in this mode. Do not pass `userId` `userSecret` t
|
|
|
1278
1278
|
### `snaptrade.accountInformation.listUserAccounts`<a id="snaptradeaccountinformationlistuseraccounts"></a>
|
|
1279
1279
|

|
|
1280
1280
|
|
|
1281
|
-
**Deprecated.** Use the [list all user accounts](/reference/Account%20Information/AccountInformation_listAllUserAccounts) endpoint instead, which returns all account types in a single response, including investment, deposit, line of credit, and
|
|
1281
|
+
**Deprecated.** Use the [list all user accounts](/reference/Account%20Information/AccountInformation_listAllUserAccounts) endpoint instead, which returns all account types in a single response, including investment, deposit, line of credit, annuity, and mortgage accounts.
|
|
1282
1282
|
|
|
1283
1283
|
Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
|
|
1284
1284
|
|
|
@@ -2000,7 +2000,7 @@ The client identifies the user in this mode. Do not pass `userId` `userSecret` t
|
|
|
2000
2000
|
|
|
2001
2001
|
Returns all accounts that belong to the specified connection for the authenticated user.
|
|
2002
2002
|
|
|
2003
|
-
The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, and
|
|
2003
|
+
The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, annuity, and mortgage accounts. Use the `kind` discriminator to determine the schema for each account.
|
|
2004
2004
|
|
|
2005
2005
|
On Pay as you Go / Real-time, this endpoint refreshes each account's opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts.
|
|
2006
2006
|
|