snaptrade-typescript-sdk 9.0.195 → 9.0.197
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 +17 -15
- package/dist/api/account-information-api-generated.d.ts +36 -32
- package/dist/api/account-information-api-generated.js +36 -32
- package/dist/api/connections-api-generated.d.ts +8 -8
- package/dist/api/connections-api-generated.js +8 -8
- package/dist/api/options-api-generated.d.ts +4 -4
- package/dist/api/options-api-generated.js +4 -4
- package/dist/api/transactions-and-reporting-api-generated.d.ts +4 -4
- package/dist/api/transactions-and-reporting-api-generated.js +4 -4
- package/dist/browser.js +1 -1
- package/dist/configuration.js +1 -1
- package/dist/models/account-position.d.ts +1 -1
- package/dist/models/account.d.ts +1 -1
- package/dist/models/future-instrument.d.ts +1 -1
- package/dist/models/option-instrument.d.ts +1 -1
- package/package.json +1 -1
|
@@ -36,7 +36,7 @@ const requestBeforeHook_1 = require("../requestBeforeHook");
|
|
|
36
36
|
const AccountInformationApiAxiosParamCreator = function (configuration) {
|
|
37
37
|
return {
|
|
38
38
|
/**
|
|
39
|
-
* 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.
|
|
39
|
+
* 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.
|
|
40
40
|
* @summary List account activities
|
|
41
41
|
* @param {string} accountId
|
|
42
42
|
* @param {string} userId
|
|
@@ -170,7 +170,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
|
|
|
170
170
|
};
|
|
171
171
|
}),
|
|
172
172
|
/**
|
|
173
|
-
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`.
|
|
173
|
+
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account. 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.
|
|
174
174
|
* @summary List all account positions
|
|
175
175
|
* @param {string} userId
|
|
176
176
|
* @param {string} userSecret
|
|
@@ -281,7 +281,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
|
|
|
281
281
|
};
|
|
282
282
|
}),
|
|
283
283
|
/**
|
|
284
|
-
* Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). 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,
|
|
284
|
+
* Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). 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.
|
|
285
285
|
* @summary List account balances
|
|
286
286
|
* @param {string} userId
|
|
287
287
|
* @param {string} userSecret
|
|
@@ -336,7 +336,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
|
|
|
336
336
|
};
|
|
337
337
|
}),
|
|
338
338
|
/**
|
|
339
|
-
* Returns account detail known to SnapTrade 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,
|
|
339
|
+
* Returns account detail known to SnapTrade 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.
|
|
340
340
|
* @summary Get account detail
|
|
341
341
|
* @param {string} userId
|
|
342
342
|
* @param {string} userSecret
|
|
@@ -452,7 +452,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
|
|
|
452
452
|
};
|
|
453
453
|
}),
|
|
454
454
|
/**
|
|
455
|
-
* Returns a list of recent orders in 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,
|
|
455
|
+
* Returns a list of recent orders in 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.
|
|
456
456
|
* @summary List account orders
|
|
457
457
|
* @param {string} userId
|
|
458
458
|
* @param {string} userSecret
|
|
@@ -515,7 +515,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
|
|
|
515
515
|
};
|
|
516
516
|
}),
|
|
517
517
|
/**
|
|
518
|
-
* 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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,
|
|
518
|
+
* 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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.
|
|
519
519
|
* @summary List account positions
|
|
520
520
|
* @param {string} userId
|
|
521
521
|
* @param {string} userSecret
|
|
@@ -688,12 +688,13 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
|
|
|
688
688
|
};
|
|
689
689
|
}),
|
|
690
690
|
/**
|
|
691
|
-
*
|
|
691
|
+
* **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.
|
|
692
692
|
* @summary List account holdings
|
|
693
693
|
* @param {string} accountId
|
|
694
694
|
* @param {string} userId
|
|
695
695
|
* @param {string} userSecret
|
|
696
696
|
* @param {*} [options] Override http request option.
|
|
697
|
+
* @deprecated
|
|
697
698
|
* @throws {RequiredError}
|
|
698
699
|
*/
|
|
699
700
|
getUserHoldings: (accountId, userId, userSecret, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -743,7 +744,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
|
|
|
743
744
|
};
|
|
744
745
|
}),
|
|
745
746
|
/**
|
|
746
|
-
* **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This data is cached and
|
|
747
|
+
* **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This endpoint returns Daily data regardless of the customer\'s plan. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the connection-scoped endpoint linked above. Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
747
748
|
* @summary List accounts
|
|
748
749
|
* @param {string} userId
|
|
749
750
|
* @param {string} userSecret
|
|
@@ -860,7 +861,7 @@ const AccountInformationApiFp = function (configuration) {
|
|
|
860
861
|
const localVarAxiosParamCreator = (0, exports.AccountInformationApiAxiosParamCreator)(configuration);
|
|
861
862
|
return {
|
|
862
863
|
/**
|
|
863
|
-
* 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.
|
|
864
|
+
* 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.
|
|
864
865
|
* @summary List account activities
|
|
865
866
|
* @param {AccountInformationApiGetAccountActivitiesRequest} requestParameters Request parameters.
|
|
866
867
|
* @param {*} [options] Override http request option.
|
|
@@ -886,7 +887,7 @@ const AccountInformationApiFp = function (configuration) {
|
|
|
886
887
|
});
|
|
887
888
|
},
|
|
888
889
|
/**
|
|
889
|
-
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`.
|
|
890
|
+
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account. 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.
|
|
890
891
|
* @summary List all account positions
|
|
891
892
|
* @param {AccountInformationApiGetAllAccountPositionsRequest} requestParameters Request parameters.
|
|
892
893
|
* @param {*} [options] Override http request option.
|
|
@@ -913,7 +914,7 @@ const AccountInformationApiFp = function (configuration) {
|
|
|
913
914
|
});
|
|
914
915
|
},
|
|
915
916
|
/**
|
|
916
|
-
* Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). 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,
|
|
917
|
+
* Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). 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.
|
|
917
918
|
* @summary List account balances
|
|
918
919
|
* @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
|
|
919
920
|
* @param {*} [options] Override http request option.
|
|
@@ -926,7 +927,7 @@ const AccountInformationApiFp = function (configuration) {
|
|
|
926
927
|
});
|
|
927
928
|
},
|
|
928
929
|
/**
|
|
929
|
-
* Returns account detail known to SnapTrade 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,
|
|
930
|
+
* Returns account detail known to SnapTrade 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.
|
|
930
931
|
* @summary Get account detail
|
|
931
932
|
* @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
|
|
932
933
|
* @param {*} [options] Override http request option.
|
|
@@ -955,7 +956,7 @@ const AccountInformationApiFp = function (configuration) {
|
|
|
955
956
|
});
|
|
956
957
|
},
|
|
957
958
|
/**
|
|
958
|
-
* Returns a list of recent orders in 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,
|
|
959
|
+
* Returns a list of recent orders in 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.
|
|
959
960
|
* @summary List account orders
|
|
960
961
|
* @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
|
|
961
962
|
* @param {*} [options] Override http request option.
|
|
@@ -968,7 +969,7 @@ const AccountInformationApiFp = function (configuration) {
|
|
|
968
969
|
});
|
|
969
970
|
},
|
|
970
971
|
/**
|
|
971
|
-
* 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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,
|
|
972
|
+
* 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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.
|
|
972
973
|
* @summary List account positions
|
|
973
974
|
* @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
|
|
974
975
|
* @param {*} [options] Override http request option.
|
|
@@ -1007,10 +1008,11 @@ const AccountInformationApiFp = function (configuration) {
|
|
|
1007
1008
|
});
|
|
1008
1009
|
},
|
|
1009
1010
|
/**
|
|
1010
|
-
*
|
|
1011
|
+
* **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.
|
|
1011
1012
|
* @summary List account holdings
|
|
1012
1013
|
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
1013
1014
|
* @param {*} [options] Override http request option.
|
|
1015
|
+
* @deprecated
|
|
1014
1016
|
* @throws {RequiredError}
|
|
1015
1017
|
*/
|
|
1016
1018
|
getUserHoldings(requestParameters, options) {
|
|
@@ -1020,7 +1022,7 @@ const AccountInformationApiFp = function (configuration) {
|
|
|
1020
1022
|
});
|
|
1021
1023
|
},
|
|
1022
1024
|
/**
|
|
1023
|
-
* **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This data is cached and
|
|
1025
|
+
* **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This endpoint returns Daily data regardless of the customer\'s plan. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the connection-scoped endpoint linked above. Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
1024
1026
|
* @summary List accounts
|
|
1025
1027
|
* @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
|
|
1026
1028
|
* @param {*} [options] Override http request option.
|
|
@@ -1057,7 +1059,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
|
|
|
1057
1059
|
const localVarFp = (0, exports.AccountInformationApiFp)(configuration);
|
|
1058
1060
|
return {
|
|
1059
1061
|
/**
|
|
1060
|
-
* 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.
|
|
1062
|
+
* 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.
|
|
1061
1063
|
* @summary List account activities
|
|
1062
1064
|
* @param {AccountInformationApiGetAccountActivitiesRequest} requestParameters Request parameters.
|
|
1063
1065
|
* @param {*} [options] Override http request option.
|
|
@@ -1077,7 +1079,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
|
|
|
1077
1079
|
return localVarFp.getAccountBalanceHistory(requestParameters, options).then((request) => request(axios, basePath));
|
|
1078
1080
|
},
|
|
1079
1081
|
/**
|
|
1080
|
-
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`.
|
|
1082
|
+
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account. 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.
|
|
1081
1083
|
* @summary List all account positions
|
|
1082
1084
|
* @param {AccountInformationApiGetAllAccountPositionsRequest} requestParameters Request parameters.
|
|
1083
1085
|
* @param {*} [options] Override http request option.
|
|
@@ -1098,7 +1100,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
|
|
|
1098
1100
|
return localVarFp.getAllUserHoldings(requestParameters, options).then((request) => request(axios, basePath));
|
|
1099
1101
|
},
|
|
1100
1102
|
/**
|
|
1101
|
-
* Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). 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,
|
|
1103
|
+
* Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). 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.
|
|
1102
1104
|
* @summary List account balances
|
|
1103
1105
|
* @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
|
|
1104
1106
|
* @param {*} [options] Override http request option.
|
|
@@ -1108,7 +1110,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
|
|
|
1108
1110
|
return localVarFp.getUserAccountBalance(requestParameters, options).then((request) => request(axios, basePath));
|
|
1109
1111
|
},
|
|
1110
1112
|
/**
|
|
1111
|
-
* Returns account detail known to SnapTrade 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,
|
|
1113
|
+
* Returns account detail known to SnapTrade 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.
|
|
1112
1114
|
* @summary Get account detail
|
|
1113
1115
|
* @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
|
|
1114
1116
|
* @param {*} [options] Override http request option.
|
|
@@ -1128,7 +1130,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
|
|
|
1128
1130
|
return localVarFp.getUserAccountOrderDetail(requestParameters, options).then((request) => request(axios, basePath));
|
|
1129
1131
|
},
|
|
1130
1132
|
/**
|
|
1131
|
-
* Returns a list of recent orders in 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,
|
|
1133
|
+
* Returns a list of recent orders in 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.
|
|
1132
1134
|
* @summary List account orders
|
|
1133
1135
|
* @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
|
|
1134
1136
|
* @param {*} [options] Override http request option.
|
|
@@ -1138,7 +1140,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
|
|
|
1138
1140
|
return localVarFp.getUserAccountOrders(requestParameters, options).then((request) => request(axios, basePath));
|
|
1139
1141
|
},
|
|
1140
1142
|
/**
|
|
1141
|
-
* 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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,
|
|
1143
|
+
* 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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.
|
|
1142
1144
|
* @summary List account positions
|
|
1143
1145
|
* @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
|
|
1144
1146
|
* @param {*} [options] Override http request option.
|
|
@@ -1168,17 +1170,18 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
|
|
|
1168
1170
|
return localVarFp.getUserAccountReturnRates(requestParameters, options).then((request) => request(axios, basePath));
|
|
1169
1171
|
},
|
|
1170
1172
|
/**
|
|
1171
|
-
*
|
|
1173
|
+
* **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.
|
|
1172
1174
|
* @summary List account holdings
|
|
1173
1175
|
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
1174
1176
|
* @param {*} [options] Override http request option.
|
|
1177
|
+
* @deprecated
|
|
1175
1178
|
* @throws {RequiredError}
|
|
1176
1179
|
*/
|
|
1177
1180
|
getUserHoldings(requestParameters, options) {
|
|
1178
1181
|
return localVarFp.getUserHoldings(requestParameters, options).then((request) => request(axios, basePath));
|
|
1179
1182
|
},
|
|
1180
1183
|
/**
|
|
1181
|
-
* **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This data is cached and
|
|
1184
|
+
* **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This endpoint returns Daily data regardless of the customer\'s plan. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the connection-scoped endpoint linked above. Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
1182
1185
|
* @summary List accounts
|
|
1183
1186
|
* @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
|
|
1184
1187
|
* @param {*} [options] Override http request option.
|
|
@@ -1209,7 +1212,7 @@ exports.AccountInformationApiFactory = AccountInformationApiFactory;
|
|
|
1209
1212
|
*/
|
|
1210
1213
|
class AccountInformationApiGenerated extends base_1.BaseAPI {
|
|
1211
1214
|
/**
|
|
1212
|
-
* 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.
|
|
1215
|
+
* 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.
|
|
1213
1216
|
* @summary List account activities
|
|
1214
1217
|
* @param {AccountInformationApiGetAccountActivitiesRequest} requestParameters Request parameters.
|
|
1215
1218
|
* @param {*} [options] Override http request option.
|
|
@@ -1231,7 +1234,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
|
|
|
1231
1234
|
return (0, exports.AccountInformationApiFp)(this.configuration).getAccountBalanceHistory(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
1232
1235
|
}
|
|
1233
1236
|
/**
|
|
1234
|
-
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`.
|
|
1237
|
+
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account. 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.
|
|
1235
1238
|
* @summary List all account positions
|
|
1236
1239
|
* @param {AccountInformationApiGetAllAccountPositionsRequest} requestParameters Request parameters.
|
|
1237
1240
|
* @param {*} [options] Override http request option.
|
|
@@ -1254,7 +1257,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
|
|
|
1254
1257
|
return (0, exports.AccountInformationApiFp)(this.configuration).getAllUserHoldings(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
1255
1258
|
}
|
|
1256
1259
|
/**
|
|
1257
|
-
* Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). 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,
|
|
1260
|
+
* Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). 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.
|
|
1258
1261
|
* @summary List account balances
|
|
1259
1262
|
* @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
|
|
1260
1263
|
* @param {*} [options] Override http request option.
|
|
@@ -1265,7 +1268,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
|
|
|
1265
1268
|
return (0, exports.AccountInformationApiFp)(this.configuration).getUserAccountBalance(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
1266
1269
|
}
|
|
1267
1270
|
/**
|
|
1268
|
-
* Returns account detail known to SnapTrade 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,
|
|
1271
|
+
* Returns account detail known to SnapTrade 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.
|
|
1269
1272
|
* @summary Get account detail
|
|
1270
1273
|
* @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
|
|
1271
1274
|
* @param {*} [options] Override http request option.
|
|
@@ -1287,7 +1290,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
|
|
|
1287
1290
|
return (0, exports.AccountInformationApiFp)(this.configuration).getUserAccountOrderDetail(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
1288
1291
|
}
|
|
1289
1292
|
/**
|
|
1290
|
-
* Returns a list of recent orders in 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,
|
|
1293
|
+
* Returns a list of recent orders in 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.
|
|
1291
1294
|
* @summary List account orders
|
|
1292
1295
|
* @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
|
|
1293
1296
|
* @param {*} [options] Override http request option.
|
|
@@ -1298,7 +1301,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
|
|
|
1298
1301
|
return (0, exports.AccountInformationApiFp)(this.configuration).getUserAccountOrders(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
1299
1302
|
}
|
|
1300
1303
|
/**
|
|
1301
|
-
* 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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,
|
|
1304
|
+
* 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. 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.
|
|
1302
1305
|
* @summary List account positions
|
|
1303
1306
|
* @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
|
|
1304
1307
|
* @param {*} [options] Override http request option.
|
|
@@ -1331,10 +1334,11 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
|
|
|
1331
1334
|
return (0, exports.AccountInformationApiFp)(this.configuration).getUserAccountReturnRates(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
1332
1335
|
}
|
|
1333
1336
|
/**
|
|
1334
|
-
*
|
|
1337
|
+
* **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.
|
|
1335
1338
|
* @summary List account holdings
|
|
1336
1339
|
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
1337
1340
|
* @param {*} [options] Override http request option.
|
|
1341
|
+
* @deprecated
|
|
1338
1342
|
* @throws {RequiredError}
|
|
1339
1343
|
* @memberof AccountInformationApiGenerated
|
|
1340
1344
|
*/
|
|
@@ -1342,7 +1346,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
|
|
|
1342
1346
|
return (0, exports.AccountInformationApiFp)(this.configuration).getUserHoldings(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
1343
1347
|
}
|
|
1344
1348
|
/**
|
|
1345
|
-
* **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This data is cached and
|
|
1349
|
+
* **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This endpoint returns Daily data regardless of the customer\'s plan. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the connection-scoped endpoint linked above. Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
1346
1350
|
* @summary List accounts
|
|
1347
1351
|
* @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
|
|
1348
1352
|
* @param {*} [options] Override http request option.
|
|
@@ -44,7 +44,7 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
44
44
|
*/
|
|
45
45
|
disableBrokerageAuthorization: (authorizationId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
46
|
/**
|
|
47
|
-
* Returns all brokerage accounts that belong to the specified connection for the authenticated user. On
|
|
47
|
+
* Returns all brokerage accounts that belong to the specified connection for the authenticated user. On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date, funding date, and total value live from the brokerage on each call. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
|
|
48
48
|
* @summary List accounts for a connection
|
|
49
49
|
* @param {string} authorizationId
|
|
50
50
|
* @param {string} userId
|
|
@@ -63,7 +63,7 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
63
63
|
*/
|
|
64
64
|
listBrokerageAuthorizations: (userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
65
65
|
/**
|
|
66
|
-
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for
|
|
66
|
+
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Pay as you Go / Real-time plans. Pay as you Go / Real-time plans do not benefit from this feature since data is refreshed when calls are made**
|
|
67
67
|
* @summary Refresh holdings for a connection
|
|
68
68
|
* @param {string} authorizationId
|
|
69
69
|
* @param {string} userId
|
|
@@ -134,7 +134,7 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
134
134
|
*/
|
|
135
135
|
disableBrokerageAuthorization(requestParameters: ConnectionsApiDisableBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrokerageAuthorizationDisabledConfirmation>>;
|
|
136
136
|
/**
|
|
137
|
-
* Returns all brokerage accounts that belong to the specified connection for the authenticated user. On
|
|
137
|
+
* Returns all brokerage accounts that belong to the specified connection for the authenticated user. On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date, funding date, and total value live from the brokerage on each call. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
|
|
138
138
|
* @summary List accounts for a connection
|
|
139
139
|
* @param {ConnectionsApiListBrokerageAuthorizationAccountsRequest} requestParameters Request parameters.
|
|
140
140
|
* @param {*} [options] Override http request option.
|
|
@@ -150,7 +150,7 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
150
150
|
*/
|
|
151
151
|
listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BrokerageAuthorization>>>;
|
|
152
152
|
/**
|
|
153
|
-
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for
|
|
153
|
+
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Pay as you Go / Real-time plans. Pay as you Go / Real-time plans do not benefit from this feature since data is refreshed when calls are made**
|
|
154
154
|
* @summary Refresh holdings for a connection
|
|
155
155
|
* @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
|
|
156
156
|
* @param {*} [options] Override http request option.
|
|
@@ -212,7 +212,7 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
212
212
|
*/
|
|
213
213
|
disableBrokerageAuthorization(requestParameters: ConnectionsApiDisableBrokerageAuthorizationRequest, options?: AxiosRequestConfig): AxiosPromise<BrokerageAuthorizationDisabledConfirmation>;
|
|
214
214
|
/**
|
|
215
|
-
* Returns all brokerage accounts that belong to the specified connection for the authenticated user. On
|
|
215
|
+
* Returns all brokerage accounts that belong to the specified connection for the authenticated user. On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date, funding date, and total value live from the brokerage on each call. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
|
|
216
216
|
* @summary List accounts for a connection
|
|
217
217
|
* @param {ConnectionsApiListBrokerageAuthorizationAccountsRequest} requestParameters Request parameters.
|
|
218
218
|
* @param {*} [options] Override http request option.
|
|
@@ -228,7 +228,7 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
228
228
|
*/
|
|
229
229
|
listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<BrokerageAuthorization>>;
|
|
230
230
|
/**
|
|
231
|
-
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for
|
|
231
|
+
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Pay as you Go / Real-time plans. Pay as you Go / Real-time plans do not benefit from this feature since data is refreshed when calls are made**
|
|
232
232
|
* @summary Refresh holdings for a connection
|
|
233
233
|
* @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
|
|
234
234
|
* @param {*} [options] Override http request option.
|
|
@@ -520,7 +520,7 @@ export declare class ConnectionsApiGenerated extends BaseAPI {
|
|
|
520
520
|
*/
|
|
521
521
|
disableBrokerageAuthorization(requestParameters: ConnectionsApiDisableBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorizationDisabledConfirmation, any, {}>>;
|
|
522
522
|
/**
|
|
523
|
-
* Returns all brokerage accounts that belong to the specified connection for the authenticated user. On
|
|
523
|
+
* Returns all brokerage accounts that belong to the specified connection for the authenticated user. On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date, funding date, and total value live from the brokerage on each call. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
|
|
524
524
|
* @summary List accounts for a connection
|
|
525
525
|
* @param {ConnectionsApiListBrokerageAuthorizationAccountsRequest} requestParameters Request parameters.
|
|
526
526
|
* @param {*} [options] Override http request option.
|
|
@@ -538,7 +538,7 @@ export declare class ConnectionsApiGenerated extends BaseAPI {
|
|
|
538
538
|
*/
|
|
539
539
|
listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorization[], any, {}>>;
|
|
540
540
|
/**
|
|
541
|
-
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for
|
|
541
|
+
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Pay as you Go / Real-time plans. Pay as you Go / Real-time plans do not benefit from this feature since data is refreshed when calls are made**
|
|
542
542
|
* @summary Refresh holdings for a connection
|
|
543
543
|
* @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
|
|
544
544
|
* @param {*} [options] Override http request option.
|
|
@@ -201,7 +201,7 @@ const ConnectionsApiAxiosParamCreator = function (configuration) {
|
|
|
201
201
|
};
|
|
202
202
|
}),
|
|
203
203
|
/**
|
|
204
|
-
* Returns all brokerage accounts that belong to the specified connection for the authenticated user. On
|
|
204
|
+
* Returns all brokerage accounts that belong to the specified connection for the authenticated user. On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date, funding date, and total value live from the brokerage on each call. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
|
|
205
205
|
* @summary List accounts for a connection
|
|
206
206
|
* @param {string} authorizationId
|
|
207
207
|
* @param {string} userId
|
|
@@ -307,7 +307,7 @@ const ConnectionsApiAxiosParamCreator = function (configuration) {
|
|
|
307
307
|
};
|
|
308
308
|
}),
|
|
309
309
|
/**
|
|
310
|
-
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for
|
|
310
|
+
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Pay as you Go / Real-time plans. Pay as you Go / Real-time plans do not benefit from this feature since data is refreshed when calls are made**
|
|
311
311
|
* @summary Refresh holdings for a connection
|
|
312
312
|
* @param {string} authorizationId
|
|
313
313
|
* @param {string} userId
|
|
@@ -578,7 +578,7 @@ const ConnectionsApiFp = function (configuration) {
|
|
|
578
578
|
});
|
|
579
579
|
},
|
|
580
580
|
/**
|
|
581
|
-
* Returns all brokerage accounts that belong to the specified connection for the authenticated user. On
|
|
581
|
+
* Returns all brokerage accounts that belong to the specified connection for the authenticated user. On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date, funding date, and total value live from the brokerage on each call. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
|
|
582
582
|
* @summary List accounts for a connection
|
|
583
583
|
* @param {ConnectionsApiListBrokerageAuthorizationAccountsRequest} requestParameters Request parameters.
|
|
584
584
|
* @param {*} [options] Override http request option.
|
|
@@ -604,7 +604,7 @@ const ConnectionsApiFp = function (configuration) {
|
|
|
604
604
|
});
|
|
605
605
|
},
|
|
606
606
|
/**
|
|
607
|
-
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for
|
|
607
|
+
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Pay as you Go / Real-time plans. Pay as you Go / Real-time plans do not benefit from this feature since data is refreshed when calls are made**
|
|
608
608
|
* @summary Refresh holdings for a connection
|
|
609
609
|
* @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
|
|
610
610
|
* @param {*} [options] Override http request option.
|
|
@@ -696,7 +696,7 @@ const ConnectionsApiFactory = function (configuration, basePath, axios) {
|
|
|
696
696
|
return localVarFp.disableBrokerageAuthorization(requestParameters, options).then((request) => request(axios, basePath));
|
|
697
697
|
},
|
|
698
698
|
/**
|
|
699
|
-
* Returns all brokerage accounts that belong to the specified connection for the authenticated user. On
|
|
699
|
+
* Returns all brokerage accounts that belong to the specified connection for the authenticated user. On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date, funding date, and total value live from the brokerage on each call. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
|
|
700
700
|
* @summary List accounts for a connection
|
|
701
701
|
* @param {ConnectionsApiListBrokerageAuthorizationAccountsRequest} requestParameters Request parameters.
|
|
702
702
|
* @param {*} [options] Override http request option.
|
|
@@ -716,7 +716,7 @@ const ConnectionsApiFactory = function (configuration, basePath, axios) {
|
|
|
716
716
|
return localVarFp.listBrokerageAuthorizations(requestParameters, options).then((request) => request(axios, basePath));
|
|
717
717
|
},
|
|
718
718
|
/**
|
|
719
|
-
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for
|
|
719
|
+
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Pay as you Go / Real-time plans. Pay as you Go / Real-time plans do not benefit from this feature since data is refreshed when calls are made**
|
|
720
720
|
* @summary Refresh holdings for a connection
|
|
721
721
|
* @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
|
|
722
722
|
* @param {*} [options] Override http request option.
|
|
@@ -799,7 +799,7 @@ class ConnectionsApiGenerated extends base_1.BaseAPI {
|
|
|
799
799
|
return (0, exports.ConnectionsApiFp)(this.configuration).disableBrokerageAuthorization(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
800
800
|
}
|
|
801
801
|
/**
|
|
802
|
-
* Returns all brokerage accounts that belong to the specified connection for the authenticated user. On
|
|
802
|
+
* Returns all brokerage accounts that belong to the specified connection for the authenticated user. On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date, funding date, and total value live from the brokerage on each call. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
|
|
803
803
|
* @summary List accounts for a connection
|
|
804
804
|
* @param {ConnectionsApiListBrokerageAuthorizationAccountsRequest} requestParameters Request parameters.
|
|
805
805
|
* @param {*} [options] Override http request option.
|
|
@@ -821,7 +821,7 @@ class ConnectionsApiGenerated extends base_1.BaseAPI {
|
|
|
821
821
|
return (0, exports.ConnectionsApiFp)(this.configuration).listBrokerageAuthorizations(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
822
822
|
}
|
|
823
823
|
/**
|
|
824
|
-
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for
|
|
824
|
+
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Pay as you Go / Real-time plans. Pay as you Go / Real-time plans do not benefit from this feature since data is refreshed when calls are made**
|
|
825
825
|
* @summary Refresh holdings for a connection
|
|
826
826
|
* @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
|
|
827
827
|
* @param {*} [options] Override http request option.
|