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/dist/index.cjs
CHANGED
|
@@ -531,7 +531,7 @@ const AccountInformationApiAxiosParamCreator = function(configuration) {
|
|
|
531
531
|
};
|
|
532
532
|
},
|
|
533
533
|
/**
|
|
534
|
-
* **Deprecated
|
|
534
|
+
* **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.
|
|
535
535
|
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
536
536
|
* @param {string} [brokerageAuthorizations] Optional. Comma separated list of authorization IDs (only use if filtering is needed on one or more authorizations).
|
|
537
537
|
* @param {string} [userId]
|
|
@@ -906,7 +906,7 @@ const AccountInformationApiAxiosParamCreator = function(configuration) {
|
|
|
906
906
|
};
|
|
907
907
|
},
|
|
908
908
|
/**
|
|
909
|
-
*
|
|
909
|
+
* **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.
|
|
910
910
|
* @summary List account positions
|
|
911
911
|
* @param {string} accountId
|
|
912
912
|
* @param {string} [userId]
|
|
@@ -1130,7 +1130,7 @@ const AccountInformationApiAxiosParamCreator = function(configuration) {
|
|
|
1130
1130
|
};
|
|
1131
1131
|
},
|
|
1132
1132
|
/**
|
|
1133
|
-
* **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.
|
|
1133
|
+
* **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.
|
|
1134
1134
|
* @summary List account holdings
|
|
1135
1135
|
* @param {string} accountId
|
|
1136
1136
|
* @param {string} [userId]
|
|
@@ -1423,7 +1423,7 @@ const AccountInformationApiFp = function(configuration) {
|
|
|
1423
1423
|
});
|
|
1424
1424
|
},
|
|
1425
1425
|
/**
|
|
1426
|
-
* **Deprecated
|
|
1426
|
+
* **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.
|
|
1427
1427
|
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
1428
1428
|
* @param {AccountInformationApiGetAllUserHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
1429
1429
|
* @param {*} [options] Override http request option.
|
|
@@ -1535,7 +1535,7 @@ const AccountInformationApiFp = function(configuration) {
|
|
|
1535
1535
|
});
|
|
1536
1536
|
},
|
|
1537
1537
|
/**
|
|
1538
|
-
*
|
|
1538
|
+
* **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.
|
|
1539
1539
|
* @summary List account positions
|
|
1540
1540
|
* @param {AccountInformationApiGetUserAccountPositionsRequest<TAuth>} requestParameters Request parameters.
|
|
1541
1541
|
* @param {*} [options] Override http request option.
|
|
@@ -1602,7 +1602,7 @@ const AccountInformationApiFp = function(configuration) {
|
|
|
1602
1602
|
});
|
|
1603
1603
|
},
|
|
1604
1604
|
/**
|
|
1605
|
-
* **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.
|
|
1605
|
+
* **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.
|
|
1606
1606
|
* @summary List account holdings
|
|
1607
1607
|
* @param {AccountInformationApiGetUserHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
1608
1608
|
* @param {*} [options] Override http request option.
|
|
@@ -1708,7 +1708,7 @@ const AccountInformationApiFactory = function(configuration, basePath, axios$9)
|
|
|
1708
1708
|
return localVarFp.getAllAccountPositions(requestParameters, options).then((request) => request(axios$9, basePath));
|
|
1709
1709
|
},
|
|
1710
1710
|
/**
|
|
1711
|
-
* **Deprecated
|
|
1711
|
+
* **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.
|
|
1712
1712
|
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
1713
1713
|
* @param {AccountInformationApiGetAllUserHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
1714
1714
|
* @param {*} [options] Override http request option.
|
|
@@ -1759,7 +1759,7 @@ const AccountInformationApiFactory = function(configuration, basePath, axios$9)
|
|
|
1759
1759
|
return localVarFp.getUserAccountOrders(requestParameters, options).then((request) => request(axios$9, basePath));
|
|
1760
1760
|
},
|
|
1761
1761
|
/**
|
|
1762
|
-
*
|
|
1762
|
+
* **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.
|
|
1763
1763
|
* @summary List account positions
|
|
1764
1764
|
* @param {AccountInformationApiGetUserAccountPositionsRequest<TAuth>} requestParameters Request parameters.
|
|
1765
1765
|
* @param {*} [options] Override http request option.
|
|
@@ -1790,7 +1790,7 @@ const AccountInformationApiFactory = function(configuration, basePath, axios$9)
|
|
|
1790
1790
|
return localVarFp.getUserAccountReturnRates(requestParameters, options).then((request) => request(axios$9, basePath));
|
|
1791
1791
|
},
|
|
1792
1792
|
/**
|
|
1793
|
-
* **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.
|
|
1793
|
+
* **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.
|
|
1794
1794
|
* @summary List account holdings
|
|
1795
1795
|
* @param {AccountInformationApiGetUserHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
1796
1796
|
* @param {*} [options] Override http request option.
|
|
@@ -1863,7 +1863,7 @@ var AccountInformationApiGenerated = class extends BaseAPI {
|
|
|
1863
1863
|
return AccountInformationApiFp(this.configuration).getAllAccountPositions(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
1864
1864
|
}
|
|
1865
1865
|
/**
|
|
1866
|
-
* **Deprecated
|
|
1866
|
+
* **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.
|
|
1867
1867
|
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
1868
1868
|
* @param {AccountInformationApiGetAllUserHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
1869
1869
|
* @param {*} [options] Override http request option.
|
|
@@ -1919,7 +1919,7 @@ var AccountInformationApiGenerated = class extends BaseAPI {
|
|
|
1919
1919
|
return AccountInformationApiFp(this.configuration).getUserAccountOrders(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
1920
1920
|
}
|
|
1921
1921
|
/**
|
|
1922
|
-
*
|
|
1922
|
+
* **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.
|
|
1923
1923
|
* @summary List account positions
|
|
1924
1924
|
* @param {AccountInformationApiGetUserAccountPositionsRequest<TAuth>} requestParameters Request parameters.
|
|
1925
1925
|
* @param {*} [options] Override http request option.
|
|
@@ -1953,7 +1953,7 @@ var AccountInformationApiGenerated = class extends BaseAPI {
|
|
|
1953
1953
|
return AccountInformationApiFp(this.configuration).getUserAccountReturnRates(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
1954
1954
|
}
|
|
1955
1955
|
/**
|
|
1956
|
-
* **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.
|
|
1956
|
+
* **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.
|
|
1957
1957
|
* @summary List account holdings
|
|
1958
1958
|
* @param {AccountInformationApiGetUserHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
1959
1959
|
* @param {*} [options] Override http request option.
|
|
@@ -4586,7 +4586,7 @@ var ExperimentalEndpointsApi = class extends ExperimentalEndpointsApiGenerated {
|
|
|
4586
4586
|
const OptionsApiAxiosParamCreator = function(configuration) {
|
|
4587
4587
|
return {
|
|
4588
4588
|
/**
|
|
4589
|
-
*
|
|
4589
|
+
* **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.
|
|
4590
4590
|
* @summary List account option positions
|
|
4591
4591
|
* @param {string} accountId
|
|
4592
4592
|
* @param {string} [userId]
|
|
@@ -4668,7 +4668,7 @@ const OptionsApiFp = function(configuration) {
|
|
|
4668
4668
|
const localVarAxiosParamCreator = OptionsApiAxiosParamCreator(configuration);
|
|
4669
4669
|
return {
|
|
4670
4670
|
/**
|
|
4671
|
-
*
|
|
4671
|
+
* **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.
|
|
4672
4672
|
* @summary List account option positions
|
|
4673
4673
|
* @param {OptionsApiListOptionHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
4674
4674
|
* @param {*} [options] Override http request option.
|
|
@@ -4699,7 +4699,7 @@ const OptionsApiFactory = function(configuration, basePath, axios$4) {
|
|
|
4699
4699
|
const localVarFp = OptionsApiFp(configuration);
|
|
4700
4700
|
return {
|
|
4701
4701
|
/**
|
|
4702
|
-
*
|
|
4702
|
+
* **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.
|
|
4703
4703
|
* @summary List account option positions
|
|
4704
4704
|
* @param {OptionsApiListOptionHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
4705
4705
|
* @param {*} [options] Override http request option.
|
|
@@ -4718,7 +4718,7 @@ listOptionHoldings(requestParameters, options) {
|
|
|
4718
4718
|
*/
|
|
4719
4719
|
var OptionsApiGenerated = class extends BaseAPI {
|
|
4720
4720
|
/**
|
|
4721
|
-
*
|
|
4721
|
+
* **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.
|
|
4722
4722
|
* @summary List account option positions
|
|
4723
4723
|
* @param {OptionsApiListOptionHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
4724
4724
|
* @param {*} [options] Override http request option.
|
|
@@ -6169,7 +6169,7 @@ const TradingApiAxiosParamCreator = function(configuration) {
|
|
|
6169
6169
|
};
|
|
6170
6170
|
},
|
|
6171
6171
|
/**
|
|
6172
|
-
* **
|
|
6172
|
+
* **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.
|
|
6173
6173
|
* @summary Cancel equity order
|
|
6174
6174
|
* @param {string} accountId
|
|
6175
6175
|
* @param {AccountInformationGetUserAccountOrderDetailRequest} accountInformationGetUserAccountOrderDetailRequest
|
|
@@ -6553,7 +6553,7 @@ const TradingApiAxiosParamCreator = function(configuration) {
|
|
|
6553
6553
|
};
|
|
6554
6554
|
},
|
|
6555
6555
|
/**
|
|
6556
|
-
* 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.
|
|
6556
|
+
* 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.
|
|
6557
6557
|
* @summary Get equity symbol quotes
|
|
6558
6558
|
* @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
|
|
6559
6559
|
* @param {string} accountId
|
|
@@ -6631,7 +6631,7 @@ const TradingApiAxiosParamCreator = function(configuration) {
|
|
|
6631
6631
|
};
|
|
6632
6632
|
},
|
|
6633
6633
|
/**
|
|
6634
|
-
* **
|
|
6634
|
+
* **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
|
|
6635
6635
|
* @summary Place bracket order
|
|
6636
6636
|
* @param {string} accountId The ID of the account to execute the trade on.
|
|
6637
6637
|
* @param {ManualTradeFormBracket} manualTradeFormBracket
|
|
@@ -7362,7 +7362,7 @@ const TradingApiFp = function(configuration) {
|
|
|
7362
7362
|
});
|
|
7363
7363
|
},
|
|
7364
7364
|
/**
|
|
7365
|
-
* **
|
|
7365
|
+
* **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.
|
|
7366
7366
|
* @summary Cancel equity order
|
|
7367
7367
|
* @param {TradingApiCancelUserAccountOrderRequest<TAuth>} requestParameters Request parameters.
|
|
7368
7368
|
* @param {*} [options] Override http request option.
|
|
@@ -7493,7 +7493,7 @@ const TradingApiFp = function(configuration) {
|
|
|
7493
7493
|
});
|
|
7494
7494
|
},
|
|
7495
7495
|
/**
|
|
7496
|
-
* 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.
|
|
7496
|
+
* 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.
|
|
7497
7497
|
* @summary Get equity symbol quotes
|
|
7498
7498
|
* @param {TradingApiGetUserAccountQuotesRequest<TAuth>} requestParameters Request parameters.
|
|
7499
7499
|
* @param {*} [options] Override http request option.
|
|
@@ -7515,7 +7515,7 @@ const TradingApiFp = function(configuration) {
|
|
|
7515
7515
|
});
|
|
7516
7516
|
},
|
|
7517
7517
|
/**
|
|
7518
|
-
* **
|
|
7518
|
+
* **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
|
|
7519
7519
|
* @summary Place bracket order
|
|
7520
7520
|
* @param {TradingApiPlaceBracketOrderRequest<TAuth>} requestParameters Request parameters.
|
|
7521
7521
|
* @param {*} [options] Override http request option.
|
|
@@ -7805,7 +7805,7 @@ const TradingApiFactory = function(configuration, basePath, axios$2) {
|
|
|
7805
7805
|
return localVarFp.cancelOrder(requestParameters, options).then((request) => request(axios$2, basePath));
|
|
7806
7806
|
},
|
|
7807
7807
|
/**
|
|
7808
|
-
* **
|
|
7808
|
+
* **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.
|
|
7809
7809
|
* @summary Cancel equity order
|
|
7810
7810
|
* @param {TradingApiCancelUserAccountOrderRequest<TAuth>} requestParameters Request parameters.
|
|
7811
7811
|
* @param {*} [options] Override http request option.
|
|
@@ -7856,7 +7856,7 @@ const TradingApiFactory = function(configuration, basePath, axios$2) {
|
|
|
7856
7856
|
return localVarFp.getUserAccountOptionQuotes(requestParameters, options).then((request) => request(axios$2, basePath));
|
|
7857
7857
|
},
|
|
7858
7858
|
/**
|
|
7859
|
-
* 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.
|
|
7859
|
+
* 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.
|
|
7860
7860
|
* @summary Get equity symbol quotes
|
|
7861
7861
|
* @param {TradingApiGetUserAccountQuotesRequest<TAuth>} requestParameters Request parameters.
|
|
7862
7862
|
* @param {*} [options] Override http request option.
|
|
@@ -7866,7 +7866,7 @@ const TradingApiFactory = function(configuration, basePath, axios$2) {
|
|
|
7866
7866
|
return localVarFp.getUserAccountQuotes(requestParameters, options).then((request) => request(axios$2, basePath));
|
|
7867
7867
|
},
|
|
7868
7868
|
/**
|
|
7869
|
-
* **
|
|
7869
|
+
* **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
|
|
7870
7870
|
* @summary Place bracket order
|
|
7871
7871
|
* @param {TradingApiPlaceBracketOrderRequest<TAuth>} requestParameters Request parameters.
|
|
7872
7872
|
* @param {*} [options] Override http request option.
|
|
@@ -7977,7 +7977,7 @@ var TradingApiGenerated = class extends BaseAPI {
|
|
|
7977
7977
|
return TradingApiFp(this.configuration).cancelOrder(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
7978
7978
|
}
|
|
7979
7979
|
/**
|
|
7980
|
-
* **
|
|
7980
|
+
* **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.
|
|
7981
7981
|
* @summary Cancel equity order
|
|
7982
7982
|
* @param {TradingApiCancelUserAccountOrderRequest<TAuth>} requestParameters Request parameters.
|
|
7983
7983
|
* @param {*} [options] Override http request option.
|
|
@@ -8033,7 +8033,7 @@ var TradingApiGenerated = class extends BaseAPI {
|
|
|
8033
8033
|
return TradingApiFp(this.configuration).getUserAccountOptionQuotes(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
8034
8034
|
}
|
|
8035
8035
|
/**
|
|
8036
|
-
* 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.
|
|
8036
|
+
* 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.
|
|
8037
8037
|
* @summary Get equity symbol quotes
|
|
8038
8038
|
* @param {TradingApiGetUserAccountQuotesRequest<TAuth>} requestParameters Request parameters.
|
|
8039
8039
|
* @param {*} [options] Override http request option.
|
|
@@ -8044,7 +8044,7 @@ var TradingApiGenerated = class extends BaseAPI {
|
|
|
8044
8044
|
return TradingApiFp(this.configuration).getUserAccountQuotes(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
8045
8045
|
}
|
|
8046
8046
|
/**
|
|
8047
|
-
* **
|
|
8047
|
+
* **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
|
|
8048
8048
|
* @summary Place bracket order
|
|
8049
8049
|
* @param {TradingApiPlaceBracketOrderRequest<TAuth>} requestParameters Request parameters.
|
|
8050
8050
|
* @param {*} [options] Override http request option.
|
|
@@ -8156,7 +8156,7 @@ var TradingApi = class extends TradingApiGenerated {};
|
|
|
8156
8156
|
const TransactionsAndReportingApiAxiosParamCreator = function(configuration) {
|
|
8157
8157
|
return {
|
|
8158
8158
|
/**
|
|
8159
|
-
*
|
|
8159
|
+
* **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.
|
|
8160
8160
|
* @summary Get transaction history for a user
|
|
8161
8161
|
* @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`.
|
|
8162
8162
|
* @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`.
|
|
@@ -8238,7 +8238,7 @@ const TransactionsAndReportingApiAxiosParamCreator = function(configuration) {
|
|
|
8238
8238
|
};
|
|
8239
8239
|
},
|
|
8240
8240
|
/**
|
|
8241
|
-
* 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.
|
|
8241
|
+
* **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.
|
|
8242
8242
|
* @summary Get performance information for a specific timeframe
|
|
8243
8243
|
* @param {string | Date} startDate
|
|
8244
8244
|
* @param {string | Date} endDate
|
|
@@ -8331,7 +8331,7 @@ const TransactionsAndReportingApiFp = function(configuration) {
|
|
|
8331
8331
|
const localVarAxiosParamCreator = TransactionsAndReportingApiAxiosParamCreator(configuration);
|
|
8332
8332
|
return {
|
|
8333
8333
|
/**
|
|
8334
|
-
*
|
|
8334
|
+
* **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.
|
|
8335
8335
|
* @summary Get transaction history for a user
|
|
8336
8336
|
* @param {TransactionsAndReportingApiGetActivitiesRequest<TAuth>} requestParameters Request parameters.
|
|
8337
8337
|
* @param {*} [options] Override http request option.
|
|
@@ -8354,7 +8354,7 @@ const TransactionsAndReportingApiFp = function(configuration) {
|
|
|
8354
8354
|
});
|
|
8355
8355
|
},
|
|
8356
8356
|
/**
|
|
8357
|
-
* 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.
|
|
8357
|
+
* **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.
|
|
8358
8358
|
* @summary Get performance information for a specific timeframe
|
|
8359
8359
|
* @param {TransactionsAndReportingApiGetReportingCustomRangeRequest<TAuth>} requestParameters Request parameters.
|
|
8360
8360
|
* @param {*} [options] Override http request option.
|
|
@@ -8386,7 +8386,7 @@ const TransactionsAndReportingApiFactory = function(configuration, basePath, axi
|
|
|
8386
8386
|
const localVarFp = TransactionsAndReportingApiFp(configuration);
|
|
8387
8387
|
return {
|
|
8388
8388
|
/**
|
|
8389
|
-
*
|
|
8389
|
+
* **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.
|
|
8390
8390
|
* @summary Get transaction history for a user
|
|
8391
8391
|
* @param {TransactionsAndReportingApiGetActivitiesRequest<TAuth>} requestParameters Request parameters.
|
|
8392
8392
|
* @param {*} [options] Override http request option.
|
|
@@ -8397,7 +8397,7 @@ const TransactionsAndReportingApiFactory = function(configuration, basePath, axi
|
|
|
8397
8397
|
return localVarFp.getActivities(requestParameters, options).then((request) => request(axios$1, basePath));
|
|
8398
8398
|
},
|
|
8399
8399
|
/**
|
|
8400
|
-
* 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.
|
|
8400
|
+
* **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.
|
|
8401
8401
|
* @summary Get performance information for a specific timeframe
|
|
8402
8402
|
* @param {TransactionsAndReportingApiGetReportingCustomRangeRequest<TAuth>} requestParameters Request parameters.
|
|
8403
8403
|
* @param {*} [options] Override http request option.
|
|
@@ -8417,7 +8417,7 @@ const TransactionsAndReportingApiFactory = function(configuration, basePath, axi
|
|
|
8417
8417
|
*/
|
|
8418
8418
|
var TransactionsAndReportingApiGenerated = class extends BaseAPI {
|
|
8419
8419
|
/**
|
|
8420
|
-
*
|
|
8420
|
+
* **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.
|
|
8421
8421
|
* @summary Get transaction history for a user
|
|
8422
8422
|
* @param {TransactionsAndReportingApiGetActivitiesRequest<TAuth>} requestParameters Request parameters.
|
|
8423
8423
|
* @param {*} [options] Override http request option.
|
|
@@ -8429,7 +8429,7 @@ var TransactionsAndReportingApiGenerated = class extends BaseAPI {
|
|
|
8429
8429
|
return TransactionsAndReportingApiFp(this.configuration).getActivities(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
8430
8430
|
}
|
|
8431
8431
|
/**
|
|
8432
|
-
* 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.
|
|
8432
|
+
* **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.
|
|
8433
8433
|
* @summary Get performance information for a specific timeframe
|
|
8434
8434
|
* @param {TransactionsAndReportingApiGetReportingCustomRangeRequest<TAuth>} requestParameters Request parameters.
|
|
8435
8435
|
* @param {*} [options] Override http request option.
|
|
@@ -8491,7 +8491,7 @@ var Configuration = class {
|
|
|
8491
8491
|
}
|
|
8492
8492
|
this.basePath = param.basePath;
|
|
8493
8493
|
this.baseOptions = param.baseOptions ?? {};
|
|
8494
|
-
this.userAgent = param.userAgent === void 0 ? "Konfig/11.0.
|
|
8494
|
+
this.userAgent = param.userAgent === void 0 ? "Konfig/11.0.1/typescript" : param.userAgent;
|
|
8495
8495
|
this.formDataCtor = param.formDataCtor;
|
|
8496
8496
|
}
|
|
8497
8497
|
/**
|