snaptrade-typescript-sdk 9.0.180 → 9.0.186

package/README.md

@@ -6,7 +6,7 @@
 
 Connect brokerage accounts to your app for live positions and trading
 
-[![npm](https://img.shields.io/badge/npm-v9.0.180-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.180)
+[![npm](https://img.shields.io/badge/npm-v9.0.186-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.186)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -48,6 +48,7 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.experimentalEndpoints.getUserAccountOrderDetailV2`](#snaptradeexperimentalendpointsgetuseraccountorderdetailv2)
   * [`snaptrade.experimentalEndpoints.getUserAccountOrdersV2`](#snaptradeexperimentalendpointsgetuseraccountordersv2)
   * [`snaptrade.experimentalEndpoints.getUserAccountRecentOrdersV2`](#snaptradeexperimentalendpointsgetuseraccountrecentordersv2)
+  * [`snaptrade.experimentalEndpoints.syncBrokerageAuthorizationTransactions`](#snaptradeexperimentalendpointssyncbrokerageauthorizationtransactions)
   * [`snaptrade.options.listOptionHoldings`](#snaptradeoptionslistoptionholdings)
   * [`snaptrade.referenceData.getCurrencyExchangeRatePair`](#snaptradereferencedatagetcurrencyexchangeratepair)
   * [`snaptrade.referenceData.getPartnerInfo`](#snaptradereferencedatagetpartnerinfo)
@@ -270,6 +271,8 @@ Optional comma separated list of transaction types to filter by. SnapTrade does
 List all accounts for the user, plus balances, positions, and orders for each
 account.
 
+**Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -581,7 +584,7 @@ Defaults to true. Indicates if request should fetch only executed orders. Set to
 
 ### `snaptrade.accountInformation.getUserAccountReturnRates`<a id="snaptradeaccountinformationgetuseraccountreturnrates"></a>
 
-Returns a list of rate of return percents for a given account. Will include timeframes available from the brokerage, for example "ALL", "1Y", "6M", "3M", "1M"
+Returns a list of rate of return percents for a given account.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -592,6 +595,7 @@ const getUserAccountReturnRatesResponse =
     userId: "snaptrade-user-123",
     userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
     accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
+    timeframes: "ALL,1Y",
   });
 ```
 
@@ -603,6 +607,10 @@ const getUserAccountReturnRatesResponse =
 
 ##### accountId: `string`<a id="accountid-string"></a>
 
+##### timeframes: `string`<a id="timeframes-string"></a>
+
+Optional comma separated list of rate-of-return timeframes to return. Supported values are `ALL`, `1Y`, `YTD`, `1M`, `1W`, and `1D`. If omitted, SnapTrade returns all six supported timeframes.
+
 #### 🔄 Return<a id="🔄-return"></a>
 
 [RateOfReturnResponse](./models/rate-of-return-response.ts)
@@ -1113,6 +1121,7 @@ Trigger a holdings update for all accounts under this connection. Updates will b
 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 real-time plans (ex: PayGo). Real-time plans do not benefit from this feature since data is refreshed when calls are made**
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -1181,7 +1190,7 @@ const removeBrokerageAuthorizationResponse =
 
 ### `snaptrade.connections.returnRates`<a id="snaptradeconnectionsreturnrates"></a>
 
-Returns a list of rate of return percents for a given connection. Will include timeframes available from the brokerage, for example "ALL", "1Y", "6M", "3M", "1M"
+Returns a list of rate of return percents for a given connection.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -1191,6 +1200,7 @@ const returnRatesResponse = await snaptrade.connections.returnRates({
   userId: "snaptrade-user-123",
   userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   authorizationId: "87b24961-b51e-4db8-9226-f198f6518a89",
+  timeframes: "ALL,1Y",
 });
 ```
 
@@ -1202,6 +1212,10 @@ const returnRatesResponse = await snaptrade.connections.returnRates({
 
 ##### authorizationId: `string`<a id="authorizationid-string"></a>
 
+##### timeframes: `string`<a id="timeframes-string"></a>
+
+Optional comma separated list of rate-of-return timeframes to return. Supported values are `ALL`, `1Y`, `YTD`, `1M`, `1W`, and `1D`. If omitted, SnapTrade returns all six supported timeframes.
+
 #### 🔄 Return<a id="🔄-return"></a>
 
 [RateOfReturnResponse](./models/rate-of-return-response.ts)
@@ -1436,6 +1450,43 @@ Defaults to true. Indicates if request should fetch only executed orders. Set to
 ---
 
 
+### `snaptrade.experimentalEndpoints.syncBrokerageAuthorizationTransactions`<a id="snaptradeexperimentalendpointssyncbrokerageauthorizationtransactions"></a>
+
+Trigger a transactions sync for all accounts under this connection. Updates will be queued asynchronously. Transactions are not updated intra-day, but calling this endpoint can ensure that the previous day's transactions have been synced. For more information on sync behaviour, see: https://docs.snaptrade.com/docs/syncing
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```typescript
+const syncBrokerageAuthorizationTransactionsResponse =
+  await snaptrade.experimentalEndpoints.syncBrokerageAuthorizationTransactions({
+    authorizationId: "87b24961-b51e-4db8-9226-f198f6518a89",
+    userId: "snaptrade-user-123",
+    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
+  });
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### authorizationId: `string`<a id="authorizationid-string"></a>
+
+##### userId: `string`<a id="userid-string"></a>
+
+##### userSecret: `string`<a id="usersecret-string"></a>
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[BrokerageAuthorizationTransactionsSyncConfirmation](./models/brokerage-authorization-transactions-sync-confirmation.ts)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/authorizations/{authorizationId}/transactions/sync` `POST`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
 ### `snaptrade.options.listOptionHoldings`<a id="snaptradeoptionslistoptionholdings"></a>
 
 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).
@@ -2778,6 +2829,8 @@ There is no guarantee to the ordering of the transactions returned. Please sort
 
 The data returned here is always cached and refreshed once a day.
 
+**Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 

package/dist/api/account-information-api-generated.d.ts

@@ -32,7 +32,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
      */
     getAccountActivities: (accountId: string, userId: string, userSecret: string, startDate?: string | Date, endDate?: string | Date, offset?: number, limit?: number, type?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account.
+     * **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account.  **Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
      * @summary List all accounts for the user, plus balances, positions, and orders for each account.
      * @param {string} userId
      * @param {string} userSecret
@@ -107,15 +107,16 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
      */
     getUserAccountRecentOrders: (userId: string, userSecret: string, accountId: string, onlyExecuted?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns a list of rate of return percents for a given account. Will include timeframes available from the brokerage, for example \"ALL\", \"1Y\", \"6M\", \"3M\", \"1M\"
+     * Returns a list of rate of return percents for a given account.
      * @summary List account rate of returns
      * @param {string} userId
      * @param {string} userSecret
      * @param {string} accountId
+     * @param {string} [timeframes] Optional comma separated list of rate-of-return timeframes to return. Supported values are &#x60;ALL&#x60;, &#x60;1Y&#x60;, &#x60;YTD&#x60;, &#x60;1M&#x60;, &#x60;1W&#x60;, and &#x60;1D&#x60;. If omitted, SnapTrade returns all six supported timeframes.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getUserAccountReturnRates: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getUserAccountReturnRates: (userId: string, userSecret: string, accountId: string, timeframes?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__  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, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://support.snaptrade.com/brokerages-table?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific 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.
      * @summary List account holdings
@@ -160,7 +161,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
      */
     getAccountActivities(requestParameters: AccountInformationApiGetAccountActivitiesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedUniversalActivity>>;
     /**
-     * **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account.
+     * **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account.  **Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
      * @summary List all accounts for the user, plus balances, positions, and orders for each account.
      * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -217,7 +218,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
      */
     getUserAccountRecentOrders(requestParameters: AccountInformationApiGetUserAccountRecentOrdersRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecentOrdersResponse>>;
     /**
-     * Returns a list of rate of return percents for a given account. Will include timeframes available from the brokerage, for example \"ALL\", \"1Y\", \"6M\", \"3M\", \"1M\"
+     * Returns a list of rate of return percents for a given account.
      * @summary List account rate of returns
      * @param {AccountInformationApiGetUserAccountReturnRatesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -263,7 +264,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
      */
     getAccountActivities(requestParameters: AccountInformationApiGetAccountActivitiesRequest, options?: AxiosRequestConfig): AxiosPromise<PaginatedUniversalActivity>;
     /**
-     * **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account.
+     * **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account.  **Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
      * @summary List all accounts for the user, plus balances, positions, and orders for each account.
      * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -320,7 +321,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
      */
     getUserAccountRecentOrders(requestParameters: AccountInformationApiGetUserAccountRecentOrdersRequest, options?: AxiosRequestConfig): AxiosPromise<RecentOrdersResponse>;
     /**
-     * Returns a list of rate of return percents for a given account. Will include timeframes available from the brokerage, for example \"ALL\", \"1Y\", \"6M\", \"3M\", \"1M\"
+     * Returns a list of rate of return percents for a given account.
      * @summary List account rate of returns
      * @param {AccountInformationApiGetUserAccountReturnRatesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -624,6 +625,12 @@ export type AccountInformationApiGetUserAccountReturnRatesRequest = {
     * @memberof AccountInformationApiGetUserAccountReturnRates
     */
     readonly accountId: string;
+    /**
+    * Optional comma separated list of rate-of-return timeframes to return. Supported values are `ALL`, `1Y`, `YTD`, `1M`, `1W`, and `1D`. If omitted, SnapTrade returns all six supported timeframes.
+    * @type {string}
+    * @memberof AccountInformationApiGetUserAccountReturnRates
+    */
+    readonly timeframes?: string;
 };
 /**
  * Request parameters for getUserHoldings operation in AccountInformationApi.
@@ -711,7 +718,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
      */
     getAccountActivities(requestParameters: AccountInformationApiGetAccountActivitiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedUniversalActivity, any, {}>>;
     /**
-     * **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account.
+     * **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account.  **Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
      * @summary List all accounts for the user, plus balances, positions, and orders for each account.
      * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -775,7 +782,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
      */
     getUserAccountRecentOrders(requestParameters: AccountInformationApiGetUserAccountRecentOrdersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RecentOrdersResponse, any, {}>>;
     /**
-     * Returns a list of rate of return percents for a given account. Will include timeframes available from the brokerage, for example \"ALL\", \"1Y\", \"6M\", \"3M\", \"1M\"
+     * Returns a list of rate of return percents for a given account.
      * @summary List account rate of returns
      * @param {AccountInformationApiGetUserAccountReturnRatesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/api/account-information-api-generated.js

@@ -115,7 +115,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account.
+         * **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account.  **Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
          * @summary List all accounts for the user, plus balances, positions, and orders for each account.
          * @param {string} userId
          * @param {string} userSecret
@@ -519,15 +519,16 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Returns a list of rate of return percents for a given account. Will include timeframes available from the brokerage, for example \"ALL\", \"1Y\", \"6M\", \"3M\", \"1M\"
+         * Returns a list of rate of return percents for a given account.
          * @summary List account rate of returns
          * @param {string} userId
          * @param {string} userSecret
          * @param {string} accountId
+         * @param {string} [timeframes] Optional comma separated list of rate-of-return timeframes to return. Supported values are `ALL`, `1Y`, `YTD`, `1M`, `1W`, and `1D`. If omitted, SnapTrade returns all six supported timeframes.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getUserAccountReturnRates: (userId, userSecret, accountId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        getUserAccountReturnRates: (userId, userSecret, accountId, timeframes, options = {}) => __awaiter(this, void 0, void 0, function* () {
             // verify required parameter 'userId' is not null or undefined
             (0, common_1.assertParamExists)('getUserAccountReturnRates', 'userId', userId);
             // verify required parameter 'userSecret' is not null or undefined
@@ -557,6 +558,9 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
             if (userSecret !== undefined) {
                 localVarQueryParameter['userSecret'] = userSecret;
             }
+            if (timeframes !== undefined) {
+                localVarQueryParameter['timeframes'] = timeframes;
+            }
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
             (0, requestBeforeHook_1.requestBeforeHook)({
@@ -758,7 +762,7 @@ const AccountInformationApiFp = function (configuration) {
             });
         },
         /**
-         * **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account.
+         * **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account.  **Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
          * @summary List all accounts for the user, plus balances, positions, and orders for each account.
          * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -853,7 +857,7 @@ const AccountInformationApiFp = function (configuration) {
             });
         },
         /**
-         * Returns a list of rate of return percents for a given account. Will include timeframes available from the brokerage, for example \"ALL\", \"1Y\", \"6M\", \"3M\", \"1M\"
+         * Returns a list of rate of return percents for a given account.
          * @summary List account rate of returns
          * @param {AccountInformationApiGetUserAccountReturnRatesRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -861,7 +865,7 @@ const AccountInformationApiFp = function (configuration) {
          */
         getUserAccountReturnRates(requestParameters, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getUserAccountReturnRates(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getUserAccountReturnRates(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, requestParameters.timeframes, options);
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
@@ -925,7 +929,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getAccountActivities(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account.
+         * **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account.  **Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
          * @summary List all accounts for the user, plus balances, positions, and orders for each account.
          * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -996,7 +1000,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getUserAccountRecentOrders(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Returns a list of rate of return percents for a given account. Will include timeframes available from the brokerage, for example \"ALL\", \"1Y\", \"6M\", \"3M\", \"1M\"
+         * Returns a list of rate of return percents for a given account.
          * @summary List account rate of returns
          * @param {AccountInformationApiGetUserAccountReturnRatesRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -1057,7 +1061,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
         return (0, exports.AccountInformationApiFp)(this.configuration).getAccountActivities(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account.
+     * **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account.  **Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
      * @summary List all accounts for the user, plus balances, positions, and orders for each account.
      * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -1135,7 +1139,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
         return (0, exports.AccountInformationApiFp)(this.configuration).getUserAccountRecentOrders(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Returns a list of rate of return percents for a given account. Will include timeframes available from the brokerage, for example \"ALL\", \"1Y\", \"6M\", \"3M\", \"1M\"
+     * Returns a list of rate of return percents for a given account.
      * @summary List account rate of returns
      * @param {AccountInformationApiGetUserAccountReturnRatesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/api/connections-api-generated.d.ts

@@ -52,7 +52,7 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
      */
     listBrokerageAuthorizations: (userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * 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)**
+     * 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 real-time plans (ex: PayGo). Real-time plans do not benefit from this feature since data is refreshed when calls are made**
      * @summary Refresh holdings for a connection
      * @param {string} authorizationId
      * @param {string} userId
@@ -72,15 +72,16 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
      */
     removeBrokerageAuthorization: (authorizationId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns a list of rate of return percents for a given connection. Will include timeframes available from the brokerage, for example \"ALL\", \"1Y\", \"6M\", \"3M\", \"1M\"
+     * Returns a list of rate of return percents for a given connection.
      * @summary List connection rate of returns
      * @param {string} userId
      * @param {string} userSecret
      * @param {string} authorizationId
+     * @param {string} [timeframes] Optional comma separated list of rate-of-return timeframes to return. Supported values are &#x60;ALL&#x60;, &#x60;1Y&#x60;, &#x60;YTD&#x60;, &#x60;1M&#x60;, &#x60;1W&#x60;, and &#x60;1D&#x60;. If omitted, SnapTrade returns all six supported timeframes.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    returnRates: (userId: string, userSecret: string, authorizationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    returnRates: (userId: string, userSecret: string, authorizationId: string, timeframes?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Returns a list of session events associated with a user.
      * @summary Get all session events for a user
@@ -130,7 +131,7 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
      */
     listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BrokerageAuthorization>>>;
     /**
-     * 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)**
+     * 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 real-time plans (ex: PayGo). Real-time plans do not benefit from this feature since data is refreshed when calls are made**
      * @summary Refresh holdings for a connection
      * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -146,7 +147,7 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
      */
     removeBrokerageAuthorization(requestParameters: ConnectionsApiRemoveBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     * Returns a list of rate of return percents for a given connection. Will include timeframes available from the brokerage, for example \"ALL\", \"1Y\", \"6M\", \"3M\", \"1M\"
+     * Returns a list of rate of return percents for a given connection.
      * @summary List connection rate of returns
      * @param {ConnectionsApiReturnRatesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -200,7 +201,7 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
      */
     listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<BrokerageAuthorization>>;
     /**
-     * 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)**
+     * 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 real-time plans (ex: PayGo). Real-time plans do not benefit from this feature since data is refreshed when calls are made**
      * @summary Refresh holdings for a connection
      * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -216,7 +217,7 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
      */
     removeBrokerageAuthorization(requestParameters: ConnectionsApiRemoveBrokerageAuthorizationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
     /**
-     * Returns a list of rate of return percents for a given connection. Will include timeframes available from the brokerage, for example \"ALL\", \"1Y\", \"6M\", \"3M\", \"1M\"
+     * Returns a list of rate of return percents for a given connection.
      * @summary List connection rate of returns
      * @param {ConnectionsApiReturnRatesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -400,6 +401,12 @@ export type ConnectionsApiReturnRatesRequest = {
     * @memberof ConnectionsApiReturnRates
     */
     readonly authorizationId: string;
+    /**
+    * Optional comma separated list of rate-of-return timeframes to return. Supported values are `ALL`, `1Y`, `YTD`, `1M`, `1W`, and `1D`. If omitted, SnapTrade returns all six supported timeframes.
+    * @type {string}
+    * @memberof ConnectionsApiReturnRates
+    */
+    readonly timeframes?: string;
 };
 /**
  * Request parameters for sessionEvents operation in ConnectionsApi.
@@ -470,7 +477,7 @@ export declare class ConnectionsApiGenerated extends BaseAPI {
      */
     listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorization[], any, {}>>;
     /**
-     * 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)**
+     * 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 real-time plans (ex: PayGo). Real-time plans do not benefit from this feature since data is refreshed when calls are made**
      * @summary Refresh holdings for a connection
      * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -488,7 +495,7 @@ export declare class ConnectionsApiGenerated extends BaseAPI {
      */
     removeBrokerageAuthorization(requestParameters: ConnectionsApiRemoveBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
-     * Returns a list of rate of return percents for a given connection. Will include timeframes available from the brokerage, for example \"ALL\", \"1Y\", \"6M\", \"3M\", \"1M\"
+     * Returns a list of rate of return percents for a given connection.
      * @summary List connection rate of returns
      * @param {ConnectionsApiReturnRatesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/api/connections-api-generated.js

@@ -252,7 +252,7 @@ const ConnectionsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * 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)**
+         * 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 real-time plans (ex: PayGo). Real-time plans do not benefit from this feature since data is refreshed when calls are made**
          * @summary Refresh holdings for a connection
          * @param {string} authorizationId
          * @param {string} userId
@@ -362,15 +362,16 @@ const ConnectionsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Returns a list of rate of return percents for a given connection. Will include timeframes available from the brokerage, for example \"ALL\", \"1Y\", \"6M\", \"3M\", \"1M\"
+         * Returns a list of rate of return percents for a given connection.
          * @summary List connection rate of returns
          * @param {string} userId
          * @param {string} userSecret
          * @param {string} authorizationId
+         * @param {string} [timeframes] Optional comma separated list of rate-of-return timeframes to return. Supported values are `ALL`, `1Y`, `YTD`, `1M`, `1W`, and `1D`. If omitted, SnapTrade returns all six supported timeframes.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        returnRates: (userId, userSecret, authorizationId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        returnRates: (userId, userSecret, authorizationId, timeframes, options = {}) => __awaiter(this, void 0, void 0, function* () {
             // verify required parameter 'userId' is not null or undefined
             (0, common_1.assertParamExists)('returnRates', 'userId', userId);
             // verify required parameter 'userSecret' is not null or undefined
@@ -400,6 +401,9 @@ const ConnectionsApiAxiosParamCreator = function (configuration) {
             if (userSecret !== undefined) {
                 localVarQueryParameter['userSecret'] = userSecret;
             }
+            if (timeframes !== undefined) {
+                localVarQueryParameter['timeframes'] = timeframes;
+            }
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
             (0, requestBeforeHook_1.requestBeforeHook)({
@@ -532,7 +536,7 @@ const ConnectionsApiFp = function (configuration) {
             });
         },
         /**
-         * 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)**
+         * 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 real-time plans (ex: PayGo). Real-time plans do not benefit from this feature since data is refreshed when calls are made**
          * @summary Refresh holdings for a connection
          * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -558,7 +562,7 @@ const ConnectionsApiFp = function (configuration) {
             });
         },
         /**
-         * Returns a list of rate of return percents for a given connection. Will include timeframes available from the brokerage, for example \"ALL\", \"1Y\", \"6M\", \"3M\", \"1M\"
+         * Returns a list of rate of return percents for a given connection.
          * @summary List connection rate of returns
          * @param {ConnectionsApiReturnRatesRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -566,7 +570,7 @@ const ConnectionsApiFp = function (configuration) {
          */
         returnRates(requestParameters, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.returnRates(requestParameters.userId, requestParameters.userSecret, requestParameters.authorizationId, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.returnRates(requestParameters.userId, requestParameters.userSecret, requestParameters.authorizationId, requestParameters.timeframes, options);
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
@@ -634,7 +638,7 @@ const ConnectionsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.listBrokerageAuthorizations(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * 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)**
+         * 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 real-time plans (ex: PayGo). Real-time plans do not benefit from this feature since data is refreshed when calls are made**
          * @summary Refresh holdings for a connection
          * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -654,7 +658,7 @@ const ConnectionsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.removeBrokerageAuthorization(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Returns a list of rate of return percents for a given connection. Will include timeframes available from the brokerage, for example \"ALL\", \"1Y\", \"6M\", \"3M\", \"1M\"
+         * Returns a list of rate of return percents for a given connection.
          * @summary List connection rate of returns
          * @param {ConnectionsApiReturnRatesRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -728,7 +732,7 @@ class ConnectionsApiGenerated extends base_1.BaseAPI {
         return (0, exports.ConnectionsApiFp)(this.configuration).listBrokerageAuthorizations(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * 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)**
+     * 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 real-time plans (ex: PayGo). Real-time plans do not benefit from this feature since data is refreshed when calls are made**
      * @summary Refresh holdings for a connection
      * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -750,7 +754,7 @@ class ConnectionsApiGenerated extends base_1.BaseAPI {
         return (0, exports.ConnectionsApiFp)(this.configuration).removeBrokerageAuthorization(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Returns a list of rate of return percents for a given connection. Will include timeframes available from the brokerage, for example \"ALL\", \"1Y\", \"6M\", \"3M\", \"1M\"
+     * Returns a list of rate of return percents for a given connection.
      * @summary List connection rate of returns
      * @param {ConnectionsApiReturnRatesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.