snaptrade-typescript-sdk 11.0.0 → 11.0.1
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 +20 -16
- package/dist/browser.umd.js +7 -7
- package/dist/index.cjs +37 -37
- package/dist/index.d.cts +36 -36
- package/dist/index.d.mts +36 -36
- package/dist/index.d.ts +36 -36
- package/dist/index.mjs +37 -37
- package/package.json +2 -2
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/11.0.1)
|
|
10
10
|
[](https://snaptrade.com/)
|
|
11
11
|
|
|
12
12
|
</div>
|
|
@@ -349,13 +349,13 @@ const getAllAccountPositionsResponse =
|
|
|
349
349
|
### `snaptrade.accountInformation.getAllUserHoldings`<a id="snaptradeaccountinformationgetalluserholdings"></a>
|
|
350
350
|

|
|
351
351
|
|
|
352
|
-
**Deprecated
|
|
352
|
+
**Deprecated.** Use the account-specific holdings endpoint instead.
|
|
353
|
+
|
|
354
|
+
This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
353
355
|
|
|
354
356
|
List all accounts for the user, plus balances, positions, and orders for each
|
|
355
357
|
account.
|
|
356
358
|
|
|
357
|
-
**Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
358
|
-
|
|
359
359
|
|
|
360
360
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
361
361
|
|
|
@@ -551,9 +551,9 @@ Number of days in the past to fetch the most recent orders. Defaults to the last
|
|
|
551
551
|
### `snaptrade.accountInformation.getUserAccountPositions`<a id="snaptradeaccountinformationgetuseraccountpositions"></a>
|
|
552
552
|

|
|
553
553
|
|
|
554
|
-
|
|
554
|
+
**Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures.
|
|
555
555
|
|
|
556
|
-
|
|
556
|
+
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).
|
|
557
557
|
|
|
558
558
|
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:
|
|
559
559
|
- If you do, this endpoint returns real-time data.
|
|
@@ -666,6 +666,9 @@ Optional comma separated list of rate-of-return timeframes to return. Supported
|
|
|
666
666
|

|
|
667
667
|
|
|
668
668
|
**Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders).
|
|
669
|
+
|
|
670
|
+
This endpoint will return HTTP 410 Gone for all customers that sign up after May 11, 2026.
|
|
671
|
+
|
|
669
672
|
Returns a list of balances, positions, and recent orders for the specified account.
|
|
670
673
|
|
|
671
674
|
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:
|
|
@@ -1521,9 +1524,9 @@ const listSubscriptionsResponse =
|
|
|
1521
1524
|
### `snaptrade.options.listOptionHoldings`<a id="snaptradeoptionslistoptionholdings"></a>
|
|
1522
1525
|

|
|
1523
1526
|
|
|
1524
|
-
|
|
1527
|
+
**Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures.
|
|
1525
1528
|
|
|
1526
|
-
|
|
1529
|
+
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).
|
|
1527
1530
|
|
|
1528
1531
|
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:
|
|
1529
1532
|
- If you do, this endpoint returns real-time data.
|
|
@@ -1935,7 +1938,8 @@ Order ID returned by brokerage. This is the unique identifier for the order in t
|
|
|
1935
1938
|
### `snaptrade.trading.cancelUserAccountOrder`<a id="snaptradetradingcanceluseraccountorder"></a>
|
|
1936
1939
|

|
|
1937
1940
|
|
|
1938
|
-
**
|
|
1941
|
+
**Deprecated.** Use [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) instead.
|
|
1942
|
+
|
|
1939
1943
|
Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
|
1940
1944
|
|
|
1941
1945
|
|
|
@@ -2183,8 +2187,6 @@ The quotes returned can be delayed depending on the brokerage the account belong
|
|
|
2183
2187
|
|
|
2184
2188
|
This endpoint does not work for options quotes.
|
|
2185
2189
|
|
|
2186
|
-
This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
2187
|
-
|
|
2188
2190
|
|
|
2189
2191
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
2190
2192
|
|
|
@@ -2224,7 +2226,8 @@ Should be set to `True` if `symbols` are comprised of tickers. Defaults to `Fals
|
|
|
2224
2226
|
### `snaptrade.trading.placeBracketOrder`<a id="snaptradetradingplacebracketorder"></a>
|
|
2225
2227
|

|
|
2226
2228
|
|
|
2227
|
-
**
|
|
2229
|
+
**Deprecated.** Use [the new complex order endpoint](/reference/Trading/Trading_placeComplexOrder) instead.
|
|
2230
|
+
|
|
2228
2231
|
Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for
|
|
2229
2232
|
use. Only supported on certain brokerages
|
|
2230
2233
|
|
|
@@ -2828,7 +2831,9 @@ const searchCryptocurrencyPairInstrumentsResponse =
|
|
|
2828
2831
|
### `snaptrade.transactionsAndReporting.getActivities`<a id="snaptradetransactionsandreportinggetactivities"></a>
|
|
2829
2832
|

|
|
2830
2833
|
|
|
2831
|
-
|
|
2834
|
+
**Deprecated.** Use [the account level endpoint](/reference/Account%20Information/AccountInformation_getAccountActivities) instead, if possible.
|
|
2835
|
+
|
|
2836
|
+
This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
2832
2837
|
|
|
2833
2838
|
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.
|
|
2834
2839
|
|
|
@@ -2836,8 +2841,6 @@ There is no guarantee to the ordering of the transactions returned. Please sort
|
|
|
2836
2841
|
|
|
2837
2842
|
This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.
|
|
2838
2843
|
|
|
2839
|
-
**Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
2840
|
-
|
|
2841
2844
|
|
|
2842
2845
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
2843
2846
|
|
|
@@ -2892,7 +2895,8 @@ Optional comma separated list of transaction types to filter by. SnapTrade does
|
|
|
2892
2895
|
### `snaptrade.transactionsAndReporting.getReportingCustomRange`<a id="snaptradetransactionsandreportinggetreportingcustomrange"></a>
|
|
2893
2896
|

|
|
2894
2897
|
|
|
2895
|
-
Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
|
|
2898
|
+
**Deprecated.** Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
|
|
2899
|
+
|
|
2896
2900
|
|
|
2897
2901
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
2898
2902
|
|