snaptrade-typescript-sdk 11.0.0 → 11.0.2
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 +24 -18
- package/dist/browser.umd.js +7 -7
- package/dist/index.cjs +43 -43
- package/dist/index.d.cts +46 -46
- package/dist/index.d.mts +46 -46
- package/dist/index.d.ts +46 -46
- package/dist/index.mjs +43 -43
- package/package.json +2 -2
package/dist/index.mjs
CHANGED
|
@@ -279,14 +279,14 @@ function requestBeforeHook(request) {
|
|
|
279
279
|
const AccountInformationApiAxiosParamCreator = function(configuration) {
|
|
280
280
|
return {
|
|
281
281
|
/**
|
|
282
|
-
* Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
282
|
+
* This endpoint is not deprecated and has no planned sunset. Responses to requests using the legacy `/api/v1` path prefix include `Deprecation: @1781222400` (June 12, 2026); that header applies only to the path prefix. Use the canonical root path `/accounts/{accountId}/activities`. Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
283
283
|
* @summary List account activities
|
|
284
284
|
* @param {string} accountId
|
|
285
285
|
* @param {string | Date} [startDate] 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`.
|
|
286
286
|
* @param {string | Date} [endDate] 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`.
|
|
287
287
|
* @param {number} [offset] An integer that specifies the starting point of the paginated results. Default is 0.
|
|
288
288
|
* @param {number} [limit] An integer that specifies the maximum number of transactions to return. Default of 1000.
|
|
289
|
-
* @param {string} [type] 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` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead of cash - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `TAX` - A tax related fee. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another. - `SPLIT` - A stock share split.
|
|
289
|
+
* @param {string} [type] 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` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `SUBSTITUTE_DIVIDEND` - Payment in lieu of a dividend. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead of cash - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `TAX` - A tax related fee. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another. - `SPLIT` - A stock share split.
|
|
290
290
|
* @param {string} [userId]
|
|
291
291
|
* @param {string} [userSecret]
|
|
292
292
|
* @param {*} [options] Override http request option.
|
|
@@ -508,7 +508,7 @@ const AccountInformationApiAxiosParamCreator = function(configuration) {
|
|
|
508
508
|
};
|
|
509
509
|
},
|
|
510
510
|
/**
|
|
511
|
-
* **Deprecated
|
|
511
|
+
* **Deprecated.** Use the account-specific holdings endpoint instead. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. List all accounts for the user, plus balances, positions, and orders for each account.
|
|
512
512
|
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
513
513
|
* @param {string} [brokerageAuthorizations] Optional. Comma separated list of authorization IDs (only use if filtering is needed on one or more authorizations).
|
|
514
514
|
* @param {string} [userId]
|
|
@@ -883,7 +883,7 @@ const AccountInformationApiAxiosParamCreator = function(configuration) {
|
|
|
883
883
|
};
|
|
884
884
|
},
|
|
885
885
|
/**
|
|
886
|
-
*
|
|
886
|
+
* **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. 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, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
887
887
|
* @summary List account positions
|
|
888
888
|
* @param {string} accountId
|
|
889
889
|
* @param {string} [userId]
|
|
@@ -1107,7 +1107,7 @@ const AccountInformationApiAxiosParamCreator = function(configuration) {
|
|
|
1107
1107
|
};
|
|
1108
1108
|
},
|
|
1109
1109
|
/**
|
|
1110
|
-
* **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders). Returns a list of balances, positions, and recent orders for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1110
|
+
* **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). This endpoint will return HTTP 410 Gone for all customers that sign up after May 11, 2026. Returns a list of balances, positions, and recent orders for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1111
1111
|
* @summary List account holdings
|
|
1112
1112
|
* @param {string} accountId
|
|
1113
1113
|
* @param {string} [userId]
|
|
@@ -1334,7 +1334,7 @@ const AccountInformationApiFp = function(configuration) {
|
|
|
1334
1334
|
const localVarAxiosParamCreator = AccountInformationApiAxiosParamCreator(configuration);
|
|
1335
1335
|
return {
|
|
1336
1336
|
/**
|
|
1337
|
-
* Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1337
|
+
* This endpoint is not deprecated and has no planned sunset. Responses to requests using the legacy `/api/v1` path prefix include `Deprecation: @1781222400` (June 12, 2026); that header applies only to the path prefix. Use the canonical root path `/accounts/{accountId}/activities`. Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1338
1338
|
* @summary List account activities
|
|
1339
1339
|
* @param {AccountInformationApiGetAccountActivitiesRequest<TAuth>} requestParameters Request parameters.
|
|
1340
1340
|
* @param {*} [options] Override http request option.
|
|
@@ -1400,7 +1400,7 @@ const AccountInformationApiFp = function(configuration) {
|
|
|
1400
1400
|
});
|
|
1401
1401
|
},
|
|
1402
1402
|
/**
|
|
1403
|
-
* **Deprecated
|
|
1403
|
+
* **Deprecated.** Use the account-specific holdings endpoint instead. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. List all accounts for the user, plus balances, positions, and orders for each account.
|
|
1404
1404
|
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
1405
1405
|
* @param {AccountInformationApiGetAllUserHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
1406
1406
|
* @param {*} [options] Override http request option.
|
|
@@ -1512,7 +1512,7 @@ const AccountInformationApiFp = function(configuration) {
|
|
|
1512
1512
|
});
|
|
1513
1513
|
},
|
|
1514
1514
|
/**
|
|
1515
|
-
*
|
|
1515
|
+
* **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. 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, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1516
1516
|
* @summary List account positions
|
|
1517
1517
|
* @param {AccountInformationApiGetUserAccountPositionsRequest<TAuth>} requestParameters Request parameters.
|
|
1518
1518
|
* @param {*} [options] Override http request option.
|
|
@@ -1579,7 +1579,7 @@ const AccountInformationApiFp = function(configuration) {
|
|
|
1579
1579
|
});
|
|
1580
1580
|
},
|
|
1581
1581
|
/**
|
|
1582
|
-
* **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders). Returns a list of balances, positions, and recent orders for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1582
|
+
* **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). This endpoint will return HTTP 410 Gone for all customers that sign up after May 11, 2026. Returns a list of balances, positions, and recent orders for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1583
1583
|
* @summary List account holdings
|
|
1584
1584
|
* @param {AccountInformationApiGetUserHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
1585
1585
|
* @param {*} [options] Override http request option.
|
|
@@ -1655,7 +1655,7 @@ const AccountInformationApiFactory = function(configuration, basePath, axios) {
|
|
|
1655
1655
|
const localVarFp = AccountInformationApiFp(configuration);
|
|
1656
1656
|
return {
|
|
1657
1657
|
/**
|
|
1658
|
-
* Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1658
|
+
* This endpoint is not deprecated and has no planned sunset. Responses to requests using the legacy `/api/v1` path prefix include `Deprecation: @1781222400` (June 12, 2026); that header applies only to the path prefix. Use the canonical root path `/accounts/{accountId}/activities`. Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1659
1659
|
* @summary List account activities
|
|
1660
1660
|
* @param {AccountInformationApiGetAccountActivitiesRequest<TAuth>} requestParameters Request parameters.
|
|
1661
1661
|
* @param {*} [options] Override http request option.
|
|
@@ -1685,7 +1685,7 @@ const AccountInformationApiFactory = function(configuration, basePath, axios) {
|
|
|
1685
1685
|
return localVarFp.getAllAccountPositions(requestParameters, options).then((request) => request(axios, basePath));
|
|
1686
1686
|
},
|
|
1687
1687
|
/**
|
|
1688
|
-
* **Deprecated
|
|
1688
|
+
* **Deprecated.** Use the account-specific holdings endpoint instead. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. List all accounts for the user, plus balances, positions, and orders for each account.
|
|
1689
1689
|
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
1690
1690
|
* @param {AccountInformationApiGetAllUserHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
1691
1691
|
* @param {*} [options] Override http request option.
|
|
@@ -1736,7 +1736,7 @@ const AccountInformationApiFactory = function(configuration, basePath, axios) {
|
|
|
1736
1736
|
return localVarFp.getUserAccountOrders(requestParameters, options).then((request) => request(axios, basePath));
|
|
1737
1737
|
},
|
|
1738
1738
|
/**
|
|
1739
|
-
*
|
|
1739
|
+
* **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. 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, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1740
1740
|
* @summary List account positions
|
|
1741
1741
|
* @param {AccountInformationApiGetUserAccountPositionsRequest<TAuth>} requestParameters Request parameters.
|
|
1742
1742
|
* @param {*} [options] Override http request option.
|
|
@@ -1767,7 +1767,7 @@ const AccountInformationApiFactory = function(configuration, basePath, axios) {
|
|
|
1767
1767
|
return localVarFp.getUserAccountReturnRates(requestParameters, options).then((request) => request(axios, basePath));
|
|
1768
1768
|
},
|
|
1769
1769
|
/**
|
|
1770
|
-
* **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders). Returns a list of balances, positions, and recent orders for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1770
|
+
* **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). This endpoint will return HTTP 410 Gone for all customers that sign up after May 11, 2026. Returns a list of balances, positions, and recent orders for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1771
1771
|
* @summary List account holdings
|
|
1772
1772
|
* @param {AccountInformationApiGetUserHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
1773
1773
|
* @param {*} [options] Override http request option.
|
|
@@ -1807,7 +1807,7 @@ const AccountInformationApiFactory = function(configuration, basePath, axios) {
|
|
|
1807
1807
|
*/
|
|
1808
1808
|
var AccountInformationApiGenerated = class extends BaseAPI {
|
|
1809
1809
|
/**
|
|
1810
|
-
* Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1810
|
+
* This endpoint is not deprecated and has no planned sunset. Responses to requests using the legacy `/api/v1` path prefix include `Deprecation: @1781222400` (June 12, 2026); that header applies only to the path prefix. Use the canonical root path `/accounts/{accountId}/activities`. Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1811
1811
|
* @summary List account activities
|
|
1812
1812
|
* @param {AccountInformationApiGetAccountActivitiesRequest<TAuth>} requestParameters Request parameters.
|
|
1813
1813
|
* @param {*} [options] Override http request option.
|
|
@@ -1840,7 +1840,7 @@ var AccountInformationApiGenerated = class extends BaseAPI {
|
|
|
1840
1840
|
return AccountInformationApiFp(this.configuration).getAllAccountPositions(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
1841
1841
|
}
|
|
1842
1842
|
/**
|
|
1843
|
-
* **Deprecated
|
|
1843
|
+
* **Deprecated.** Use the account-specific holdings endpoint instead. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. List all accounts for the user, plus balances, positions, and orders for each account.
|
|
1844
1844
|
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
1845
1845
|
* @param {AccountInformationApiGetAllUserHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
1846
1846
|
* @param {*} [options] Override http request option.
|
|
@@ -1896,7 +1896,7 @@ var AccountInformationApiGenerated = class extends BaseAPI {
|
|
|
1896
1896
|
return AccountInformationApiFp(this.configuration).getUserAccountOrders(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
1897
1897
|
}
|
|
1898
1898
|
/**
|
|
1899
|
-
*
|
|
1899
|
+
* **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. 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, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1900
1900
|
* @summary List account positions
|
|
1901
1901
|
* @param {AccountInformationApiGetUserAccountPositionsRequest<TAuth>} requestParameters Request parameters.
|
|
1902
1902
|
* @param {*} [options] Override http request option.
|
|
@@ -1930,7 +1930,7 @@ var AccountInformationApiGenerated = class extends BaseAPI {
|
|
|
1930
1930
|
return AccountInformationApiFp(this.configuration).getUserAccountReturnRates(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
1931
1931
|
}
|
|
1932
1932
|
/**
|
|
1933
|
-
* **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders). Returns a list of balances, positions, and recent orders for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1933
|
+
* **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). This endpoint will return HTTP 410 Gone for all customers that sign up after May 11, 2026. Returns a list of balances, positions, and recent orders for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
1934
1934
|
* @summary List account holdings
|
|
1935
1935
|
* @param {AccountInformationApiGetUserHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
1936
1936
|
* @param {*} [options] Override http request option.
|
|
@@ -4563,7 +4563,7 @@ var ExperimentalEndpointsApi = class extends ExperimentalEndpointsApiGenerated {
|
|
|
4563
4563
|
const OptionsApiAxiosParamCreator = function(configuration) {
|
|
4564
4564
|
return {
|
|
4565
4565
|
/**
|
|
4566
|
-
*
|
|
4566
|
+
* **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. 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). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
4567
4567
|
* @summary List account option positions
|
|
4568
4568
|
* @param {string} accountId
|
|
4569
4569
|
* @param {string} [userId]
|
|
@@ -4645,7 +4645,7 @@ const OptionsApiFp = function(configuration) {
|
|
|
4645
4645
|
const localVarAxiosParamCreator = OptionsApiAxiosParamCreator(configuration);
|
|
4646
4646
|
return {
|
|
4647
4647
|
/**
|
|
4648
|
-
*
|
|
4648
|
+
* **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. 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). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
4649
4649
|
* @summary List account option positions
|
|
4650
4650
|
* @param {OptionsApiListOptionHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
4651
4651
|
* @param {*} [options] Override http request option.
|
|
@@ -4676,7 +4676,7 @@ const OptionsApiFactory = function(configuration, basePath, axios) {
|
|
|
4676
4676
|
const localVarFp = OptionsApiFp(configuration);
|
|
4677
4677
|
return {
|
|
4678
4678
|
/**
|
|
4679
|
-
*
|
|
4679
|
+
* **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. 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). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
4680
4680
|
* @summary List account option positions
|
|
4681
4681
|
* @param {OptionsApiListOptionHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
4682
4682
|
* @param {*} [options] Override http request option.
|
|
@@ -4695,7 +4695,7 @@ listOptionHoldings(requestParameters, options) {
|
|
|
4695
4695
|
*/
|
|
4696
4696
|
var OptionsApiGenerated = class extends BaseAPI {
|
|
4697
4697
|
/**
|
|
4698
|
-
*
|
|
4698
|
+
* **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. 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). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
4699
4699
|
* @summary List account option positions
|
|
4700
4700
|
* @param {OptionsApiListOptionHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
4701
4701
|
* @param {*} [options] Override http request option.
|
|
@@ -6146,7 +6146,7 @@ const TradingApiAxiosParamCreator = function(configuration) {
|
|
|
6146
6146
|
};
|
|
6147
6147
|
},
|
|
6148
6148
|
/**
|
|
6149
|
-
* **
|
|
6149
|
+
* **Deprecated.** Use [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) instead. Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
|
6150
6150
|
* @summary Cancel equity order
|
|
6151
6151
|
* @param {string} accountId
|
|
6152
6152
|
* @param {AccountInformationGetUserAccountOrderDetailRequest} accountInformationGetUserAccountOrderDetailRequest
|
|
@@ -6530,7 +6530,7 @@ const TradingApiAxiosParamCreator = function(configuration) {
|
|
|
6530
6530
|
};
|
|
6531
6531
|
},
|
|
6532
6532
|
/**
|
|
6533
|
-
* Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes.
|
|
6533
|
+
* Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes.
|
|
6534
6534
|
* @summary Get equity symbol quotes
|
|
6535
6535
|
* @param {string} symbols List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator. Maximum of 10 values allowed
|
|
6536
6536
|
* @param {string} accountId
|
|
@@ -6608,7 +6608,7 @@ const TradingApiAxiosParamCreator = function(configuration) {
|
|
|
6608
6608
|
};
|
|
6609
6609
|
},
|
|
6610
6610
|
/**
|
|
6611
|
-
* **
|
|
6611
|
+
* **Deprecated.** Use [the new complex order endpoint](/reference/Trading/Trading_placeComplexOrder) instead. Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
|
|
6612
6612
|
* @summary Place bracket order
|
|
6613
6613
|
* @param {string} accountId The ID of the account to execute the trade on.
|
|
6614
6614
|
* @param {ManualTradeFormBracket} manualTradeFormBracket
|
|
@@ -7339,7 +7339,7 @@ const TradingApiFp = function(configuration) {
|
|
|
7339
7339
|
});
|
|
7340
7340
|
},
|
|
7341
7341
|
/**
|
|
7342
|
-
* **
|
|
7342
|
+
* **Deprecated.** Use [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) instead. Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
|
7343
7343
|
* @summary Cancel equity order
|
|
7344
7344
|
* @param {TradingApiCancelUserAccountOrderRequest<TAuth>} requestParameters Request parameters.
|
|
7345
7345
|
* @param {*} [options] Override http request option.
|
|
@@ -7470,7 +7470,7 @@ const TradingApiFp = function(configuration) {
|
|
|
7470
7470
|
});
|
|
7471
7471
|
},
|
|
7472
7472
|
/**
|
|
7473
|
-
* Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes.
|
|
7473
|
+
* Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes.
|
|
7474
7474
|
* @summary Get equity symbol quotes
|
|
7475
7475
|
* @param {TradingApiGetUserAccountQuotesRequest<TAuth>} requestParameters Request parameters.
|
|
7476
7476
|
* @param {*} [options] Override http request option.
|
|
@@ -7492,7 +7492,7 @@ const TradingApiFp = function(configuration) {
|
|
|
7492
7492
|
});
|
|
7493
7493
|
},
|
|
7494
7494
|
/**
|
|
7495
|
-
* **
|
|
7495
|
+
* **Deprecated.** Use [the new complex order endpoint](/reference/Trading/Trading_placeComplexOrder) instead. Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
|
|
7496
7496
|
* @summary Place bracket order
|
|
7497
7497
|
* @param {TradingApiPlaceBracketOrderRequest<TAuth>} requestParameters Request parameters.
|
|
7498
7498
|
* @param {*} [options] Override http request option.
|
|
@@ -7782,7 +7782,7 @@ const TradingApiFactory = function(configuration, basePath, axios) {
|
|
|
7782
7782
|
return localVarFp.cancelOrder(requestParameters, options).then((request) => request(axios, basePath));
|
|
7783
7783
|
},
|
|
7784
7784
|
/**
|
|
7785
|
-
* **
|
|
7785
|
+
* **Deprecated.** Use [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) instead. Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
|
7786
7786
|
* @summary Cancel equity order
|
|
7787
7787
|
* @param {TradingApiCancelUserAccountOrderRequest<TAuth>} requestParameters Request parameters.
|
|
7788
7788
|
* @param {*} [options] Override http request option.
|
|
@@ -7833,7 +7833,7 @@ const TradingApiFactory = function(configuration, basePath, axios) {
|
|
|
7833
7833
|
return localVarFp.getUserAccountOptionQuotes(requestParameters, options).then((request) => request(axios, basePath));
|
|
7834
7834
|
},
|
|
7835
7835
|
/**
|
|
7836
|
-
* Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes.
|
|
7836
|
+
* Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes.
|
|
7837
7837
|
* @summary Get equity symbol quotes
|
|
7838
7838
|
* @param {TradingApiGetUserAccountQuotesRequest<TAuth>} requestParameters Request parameters.
|
|
7839
7839
|
* @param {*} [options] Override http request option.
|
|
@@ -7843,7 +7843,7 @@ const TradingApiFactory = function(configuration, basePath, axios) {
|
|
|
7843
7843
|
return localVarFp.getUserAccountQuotes(requestParameters, options).then((request) => request(axios, basePath));
|
|
7844
7844
|
},
|
|
7845
7845
|
/**
|
|
7846
|
-
* **
|
|
7846
|
+
* **Deprecated.** Use [the new complex order endpoint](/reference/Trading/Trading_placeComplexOrder) instead. Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
|
|
7847
7847
|
* @summary Place bracket order
|
|
7848
7848
|
* @param {TradingApiPlaceBracketOrderRequest<TAuth>} requestParameters Request parameters.
|
|
7849
7849
|
* @param {*} [options] Override http request option.
|
|
@@ -7954,7 +7954,7 @@ var TradingApiGenerated = class extends BaseAPI {
|
|
|
7954
7954
|
return TradingApiFp(this.configuration).cancelOrder(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
7955
7955
|
}
|
|
7956
7956
|
/**
|
|
7957
|
-
* **
|
|
7957
|
+
* **Deprecated.** Use [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) instead. Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
|
7958
7958
|
* @summary Cancel equity order
|
|
7959
7959
|
* @param {TradingApiCancelUserAccountOrderRequest<TAuth>} requestParameters Request parameters.
|
|
7960
7960
|
* @param {*} [options] Override http request option.
|
|
@@ -8010,7 +8010,7 @@ var TradingApiGenerated = class extends BaseAPI {
|
|
|
8010
8010
|
return TradingApiFp(this.configuration).getUserAccountOptionQuotes(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
8011
8011
|
}
|
|
8012
8012
|
/**
|
|
8013
|
-
* Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes.
|
|
8013
|
+
* Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes.
|
|
8014
8014
|
* @summary Get equity symbol quotes
|
|
8015
8015
|
* @param {TradingApiGetUserAccountQuotesRequest<TAuth>} requestParameters Request parameters.
|
|
8016
8016
|
* @param {*} [options] Override http request option.
|
|
@@ -8021,7 +8021,7 @@ var TradingApiGenerated = class extends BaseAPI {
|
|
|
8021
8021
|
return TradingApiFp(this.configuration).getUserAccountQuotes(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
8022
8022
|
}
|
|
8023
8023
|
/**
|
|
8024
|
-
* **
|
|
8024
|
+
* **Deprecated.** Use [the new complex order endpoint](/reference/Trading/Trading_placeComplexOrder) instead. Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
|
|
8025
8025
|
* @summary Place bracket order
|
|
8026
8026
|
* @param {TradingApiPlaceBracketOrderRequest<TAuth>} requestParameters Request parameters.
|
|
8027
8027
|
* @param {*} [options] Override http request option.
|
|
@@ -8133,13 +8133,13 @@ var TradingApi = class extends TradingApiGenerated {};
|
|
|
8133
8133
|
const TransactionsAndReportingApiAxiosParamCreator = function(configuration) {
|
|
8134
8134
|
return {
|
|
8135
8135
|
/**
|
|
8136
|
-
*
|
|
8136
|
+
* **Deprecated.** Use [the account level endpoint](/reference/Account%20Information/AccountInformation_getAccountActivities) instead, if possible. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. Returns all historical transactions for the specified user and filtering criteria. It\'s recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There\'s a max number of 10000 transactions returned per request. There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.
|
|
8137
8137
|
* @summary Get transaction history for a user
|
|
8138
8138
|
* @param {string | Date} [startDate] 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`.
|
|
8139
8139
|
* @param {string | Date} [endDate] 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`.
|
|
8140
8140
|
* @param {string} [accounts] 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.
|
|
8141
8141
|
* @param {string} [brokerageAuthorizations] 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.
|
|
8142
|
-
* @param {string} [type] 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` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another
|
|
8142
|
+
* @param {string} [type] 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` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `SUBSTITUTE_DIVIDEND` - Payment in lieu of a dividend. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another
|
|
8143
8143
|
* @param {string} [userId]
|
|
8144
8144
|
* @param {string} [userSecret]
|
|
8145
8145
|
* @param {*} [options] Override http request option.
|
|
@@ -8215,7 +8215,7 @@ const TransactionsAndReportingApiAxiosParamCreator = function(configuration) {
|
|
|
8215
8215
|
};
|
|
8216
8216
|
},
|
|
8217
8217
|
/**
|
|
8218
|
-
* 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.
|
|
8218
|
+
* **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.
|
|
8219
8219
|
* @summary Get performance information for a specific timeframe
|
|
8220
8220
|
* @param {string | Date} startDate
|
|
8221
8221
|
* @param {string | Date} endDate
|
|
@@ -8308,7 +8308,7 @@ const TransactionsAndReportingApiFp = function(configuration) {
|
|
|
8308
8308
|
const localVarAxiosParamCreator = TransactionsAndReportingApiAxiosParamCreator(configuration);
|
|
8309
8309
|
return {
|
|
8310
8310
|
/**
|
|
8311
|
-
*
|
|
8311
|
+
* **Deprecated.** Use [the account level endpoint](/reference/Account%20Information/AccountInformation_getAccountActivities) instead, if possible. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. Returns all historical transactions for the specified user and filtering criteria. It\'s recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There\'s a max number of 10000 transactions returned per request. There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.
|
|
8312
8312
|
* @summary Get transaction history for a user
|
|
8313
8313
|
* @param {TransactionsAndReportingApiGetActivitiesRequest<TAuth>} requestParameters Request parameters.
|
|
8314
8314
|
* @param {*} [options] Override http request option.
|
|
@@ -8331,7 +8331,7 @@ const TransactionsAndReportingApiFp = function(configuration) {
|
|
|
8331
8331
|
});
|
|
8332
8332
|
},
|
|
8333
8333
|
/**
|
|
8334
|
-
* 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.
|
|
8334
|
+
* **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.
|
|
8335
8335
|
* @summary Get performance information for a specific timeframe
|
|
8336
8336
|
* @param {TransactionsAndReportingApiGetReportingCustomRangeRequest<TAuth>} requestParameters Request parameters.
|
|
8337
8337
|
* @param {*} [options] Override http request option.
|
|
@@ -8363,7 +8363,7 @@ const TransactionsAndReportingApiFactory = function(configuration, basePath, axi
|
|
|
8363
8363
|
const localVarFp = TransactionsAndReportingApiFp(configuration);
|
|
8364
8364
|
return {
|
|
8365
8365
|
/**
|
|
8366
|
-
*
|
|
8366
|
+
* **Deprecated.** Use [the account level endpoint](/reference/Account%20Information/AccountInformation_getAccountActivities) instead, if possible. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. Returns all historical transactions for the specified user and filtering criteria. It\'s recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There\'s a max number of 10000 transactions returned per request. There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.
|
|
8367
8367
|
* @summary Get transaction history for a user
|
|
8368
8368
|
* @param {TransactionsAndReportingApiGetActivitiesRequest<TAuth>} requestParameters Request parameters.
|
|
8369
8369
|
* @param {*} [options] Override http request option.
|
|
@@ -8374,7 +8374,7 @@ const TransactionsAndReportingApiFactory = function(configuration, basePath, axi
|
|
|
8374
8374
|
return localVarFp.getActivities(requestParameters, options).then((request) => request(axios, basePath));
|
|
8375
8375
|
},
|
|
8376
8376
|
/**
|
|
8377
|
-
* 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.
|
|
8377
|
+
* **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.
|
|
8378
8378
|
* @summary Get performance information for a specific timeframe
|
|
8379
8379
|
* @param {TransactionsAndReportingApiGetReportingCustomRangeRequest<TAuth>} requestParameters Request parameters.
|
|
8380
8380
|
* @param {*} [options] Override http request option.
|
|
@@ -8394,7 +8394,7 @@ const TransactionsAndReportingApiFactory = function(configuration, basePath, axi
|
|
|
8394
8394
|
*/
|
|
8395
8395
|
var TransactionsAndReportingApiGenerated = class extends BaseAPI {
|
|
8396
8396
|
/**
|
|
8397
|
-
*
|
|
8397
|
+
* **Deprecated.** Use [the account level endpoint](/reference/Account%20Information/AccountInformation_getAccountActivities) instead, if possible. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. Returns all historical transactions for the specified user and filtering criteria. It\'s recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There\'s a max number of 10000 transactions returned per request. There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.
|
|
8398
8398
|
* @summary Get transaction history for a user
|
|
8399
8399
|
* @param {TransactionsAndReportingApiGetActivitiesRequest<TAuth>} requestParameters Request parameters.
|
|
8400
8400
|
* @param {*} [options] Override http request option.
|
|
@@ -8406,7 +8406,7 @@ var TransactionsAndReportingApiGenerated = class extends BaseAPI {
|
|
|
8406
8406
|
return TransactionsAndReportingApiFp(this.configuration).getActivities(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
8407
8407
|
}
|
|
8408
8408
|
/**
|
|
8409
|
-
* 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.
|
|
8409
|
+
* **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.
|
|
8410
8410
|
* @summary Get performance information for a specific timeframe
|
|
8411
8411
|
* @param {TransactionsAndReportingApiGetReportingCustomRangeRequest<TAuth>} requestParameters Request parameters.
|
|
8412
8412
|
* @param {*} [options] Override http request option.
|
|
@@ -8468,7 +8468,7 @@ var Configuration = class {
|
|
|
8468
8468
|
}
|
|
8469
8469
|
this.basePath = param.basePath;
|
|
8470
8470
|
this.baseOptions = param.baseOptions ?? {};
|
|
8471
|
-
this.userAgent = param.userAgent === void 0 ? "Konfig/11.0.
|
|
8471
|
+
this.userAgent = param.userAgent === void 0 ? "Konfig/11.0.2/typescript" : param.userAgent;
|
|
8472
8472
|
this.formDataCtor = param.formDataCtor;
|
|
8473
8473
|
}
|
|
8474
8474
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "snaptrade-typescript-sdk",
|
|
3
|
-
"version": "11.0.
|
|
3
|
+
"version": "11.0.2",
|
|
4
4
|
"description": "Client for SnapTrade",
|
|
5
5
|
"author": "Konfig",
|
|
6
6
|
"engines": {
|
|
@@ -47,7 +47,7 @@
|
|
|
47
47
|
"typecheck": "tsc --noEmit"
|
|
48
48
|
},
|
|
49
49
|
"dependencies": {
|
|
50
|
-
"axios": "1.
|
|
50
|
+
"axios": "1.18.0"
|
|
51
51
|
},
|
|
52
52
|
"resolutions": {
|
|
53
53
|
"semver": "^7.5.2",
|