snaptrade-typescript-sdk 9.0.41 → 9.0.43

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.41-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.41)
+[![npm](https://img.shields.io/badge/npm-v9.0.43-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.43)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -1277,16 +1277,14 @@ const getStockExchangesResponse =
 
 ### `snaptrade.referenceData.getSymbols`<a id="snaptradereferencedatagetsymbols"></a>
 
-Returns a list of Universal Symbol objects that match a defined string.
-
-Matches on ticker or name.
+Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
 ```typescript
 const getSymbolsResponse = await snaptrade.referenceData.getSymbols({
-  substring: "apple",
+  substring: "AAPL",
 });
 ```
 
@@ -1294,6 +1292,8 @@ const getSymbolsResponse = await snaptrade.referenceData.getSymbols({
 
 ##### substring: `string`<a id="substring-string"></a>
 
+The search query for symbols.
+
 #### 🔄 Return<a id="🔄-return"></a>
 
 [UniversalSymbol](./models/universal-symbol.ts)
@@ -1309,7 +1309,8 @@ const getSymbolsResponse = await snaptrade.referenceData.getSymbols({
 
 ### `snaptrade.referenceData.getSymbolsByTicker`<a id="snaptradereferencedatagetsymbolsbyticker"></a>
 
-Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
+Returns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Please use the ticker with the proper suffix for the best results.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1324,7 +1325,7 @@ const getSymbolsByTickerResponse =
 
 ##### query: `string`<a id="query-string"></a>
 
-The ticker or universal_symbol_id of the UniversalSymbol to get.
+The ticker or Universal Symbol ID to look up the symbol with.
 
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -1445,9 +1446,9 @@ const listAllCurrenciesRatesResponse =
 
 ### `snaptrade.referenceData.symbolSearchUserAccount`<a id="snaptradereferencedatasymbolsearchuseraccount"></a>
 
-Returns a list of universal symbols that are supported by
-the specificied account. Returned symbols are based on the
-provided search string, matching on ticker and name.
+Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.
+
+The search results are further limited to the symbols supported by the brokerage for which the account is under.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -1458,7 +1459,7 @@ const symbolSearchUserAccountResponse =
     userId: "snaptrade-user-123",
     userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
     accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
-    substring: "apple",
+    substring: "AAPL",
   });
 ```
 
@@ -1470,10 +1471,10 @@ const symbolSearchUserAccountResponse =
 
 ##### accountId: `string`<a id="accountid-string"></a>
 
-The ID of the account to search for symbols within.
-
 ##### substring: `string`<a id="substring-string"></a>
 
+The search query for symbols.
+
 #### 🔄 Return<a id="🔄-return"></a>
 
 [UniversalSymbol](./models/universal-symbol.ts)
@@ -1648,7 +1649,7 @@ Should be set to `True` if `symbols` are comprised of tickers. Defaults to `Fals
 
 ### `snaptrade.trading.placeForceOrder`<a id="snaptradetradingplaceforceorder"></a>
 
-Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds. 
+Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.
 
 This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).
 

package/dist/api/reference-data-api-generated.d.ts

@@ -45,17 +45,17 @@ export declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configu
      */
     getStockExchanges: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns a list of Universal Symbol objects that match a defined string.  Matches on ticker or name.
-     * @summary Search for symbols
+     * Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.
+     * @summary Search symbols
      * @param {SymbolQuery} [symbolQuery]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getSymbols: (symbolQuery?: SymbolQuery, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
-     * @summary Get details of a symbol
-     * @param {string} query The ticker or universal_symbol_id of the UniversalSymbol to get.
+     * Returns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a \'.TO\' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Please use the ticker with the proper suffix for the best results.
+     * @summary Get symbol detail
+     * @param {string} query The ticker or Universal Symbol ID to look up the symbol with.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -90,11 +90,11 @@ export declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configu
      */
     listAllCurrenciesRates: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns a list of universal symbols that are supported by the specificied account. Returned symbols are based on the provided search string, matching on ticker and name.
-     * @summary Search for symbols available in an account
+     * Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.  The search results are further limited to the symbols supported by the brokerage for which the account is under.
+     * @summary Search account symbols
      * @param {string} userId
      * @param {string} userSecret
-     * @param {string} accountId The ID of the account to search for symbols within.
+     * @param {string} accountId
      * @param {SymbolQuery} [symbolQuery]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -136,16 +136,16 @@ export declare const ReferenceDataApiFp: (configuration?: Configuration) => {
      */
     getStockExchanges(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Exchange>>>;
     /**
-     * Returns a list of Universal Symbol objects that match a defined string.  Matches on ticker or name.
-     * @summary Search for symbols
+     * Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.
+     * @summary Search symbols
      * @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getSymbols(requestParameters?: ReferenceDataApiGetSymbolsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalSymbol>>>;
     /**
-     * Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
-     * @summary Get details of a symbol
+     * Returns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a \'.TO\' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Please use the ticker with the proper suffix for the best results.
+     * @summary Get symbol detail
      * @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -181,8 +181,8 @@ export declare const ReferenceDataApiFp: (configuration?: Configuration) => {
      */
     listAllCurrenciesRates(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ExchangeRatePairs>>>;
     /**
-     * Returns a list of universal symbols that are supported by the specificied account. Returned symbols are based on the provided search string, matching on ticker and name.
-     * @summary Search for symbols available in an account
+     * Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.  The search results are further limited to the symbols supported by the brokerage for which the account is under.
+     * @summary Search account symbols
      * @param {ReferenceDataApiSymbolSearchUserAccountRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -224,16 +224,16 @@ export declare const ReferenceDataApiFactory: (configuration?: Configuration, ba
      */
     getStockExchanges(options?: AxiosRequestConfig): AxiosPromise<Array<Exchange>>;
     /**
-     * Returns a list of Universal Symbol objects that match a defined string.  Matches on ticker or name.
-     * @summary Search for symbols
+     * Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.
+     * @summary Search symbols
      * @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getSymbols(requestParameters?: ReferenceDataApiGetSymbolsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<UniversalSymbol>>;
     /**
-     * Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
-     * @summary Get details of a symbol
+     * Returns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a \'.TO\' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Please use the ticker with the proper suffix for the best results.
+     * @summary Get symbol detail
      * @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -269,8 +269,8 @@ export declare const ReferenceDataApiFactory: (configuration?: Configuration, ba
      */
     listAllCurrenciesRates(options?: AxiosRequestConfig): AxiosPromise<Array<ExchangeRatePairs>>;
     /**
-     * Returns a list of universal symbols that are supported by the specificied account. Returned symbols are based on the provided search string, matching on ticker and name.
-     * @summary Search for symbols available in an account
+     * Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.  The search results are further limited to the symbols supported by the brokerage for which the account is under.
+     * @summary Search account symbols
      * @param {ReferenceDataApiSymbolSearchUserAccountRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -303,7 +303,7 @@ export type ReferenceDataApiGetSymbolsRequest = {} & SymbolQuery;
  */
 export type ReferenceDataApiGetSymbolsByTickerRequest = {
     /**
-    * The ticker or universal_symbol_id of the UniversalSymbol to get.
+    * The ticker or Universal Symbol ID to look up the symbol with.
     * @type {string}
     * @memberof ReferenceDataApiGetSymbolsByTicker
     */
@@ -341,7 +341,7 @@ export type ReferenceDataApiSymbolSearchUserAccountRequest = {
     */
     readonly userSecret: string;
     /**
-    * The ID of the account to search for symbols within.
+    *
     * @type {string}
     * @memberof ReferenceDataApiSymbolSearchUserAccount
     */
@@ -388,8 +388,8 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
      */
     getStockExchanges(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Exchange[], any>>;
     /**
-     * Returns a list of Universal Symbol objects that match a defined string.  Matches on ticker or name.
-     * @summary Search for symbols
+     * Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.
+     * @summary Search symbols
      * @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -397,8 +397,8 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
      */
     getSymbols(requestParameters?: ReferenceDataApiGetSymbolsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalSymbol[], any>>;
     /**
-     * Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
-     * @summary Get details of a symbol
+     * Returns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a \'.TO\' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Please use the ticker with the proper suffix for the best results.
+     * @summary Get symbol detail
      * @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -439,8 +439,8 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
      */
     listAllCurrenciesRates(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExchangeRatePairs[], any>>;
     /**
-     * Returns a list of universal symbols that are supported by the specificied account. Returned symbols are based on the provided search string, matching on ticker and name.
-     * @summary Search for symbols available in an account
+     * Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.  The search results are further limited to the symbols supported by the brokerage for which the account is under.
+     * @summary Search account symbols
      * @param {ReferenceDataApiSymbolSearchUserAccountRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

package/dist/api/reference-data-api-generated.js

@@ -196,8 +196,8 @@ const ReferenceDataApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Returns a list of Universal Symbol objects that match a defined string.  Matches on ticker or name.
-         * @summary Search for symbols
+         * Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.
+         * @summary Search symbols
          * @param {SymbolQuery} [symbolQuery]
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -239,9 +239,9 @@ const ReferenceDataApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
-         * @summary Get details of a symbol
-         * @param {string} query The ticker or universal_symbol_id of the UniversalSymbol to get.
+         * Returns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a \'.TO\' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Please use the ticker with the proper suffix for the best results.
+         * @summary Get symbol detail
+         * @param {string} query The ticker or Universal Symbol ID to look up the symbol with.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -442,11 +442,11 @@ const ReferenceDataApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Returns a list of universal symbols that are supported by the specificied account. Returned symbols are based on the provided search string, matching on ticker and name.
-         * @summary Search for symbols available in an account
+         * Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.  The search results are further limited to the symbols supported by the brokerage for which the account is under.
+         * @summary Search account symbols
          * @param {string} userId
          * @param {string} userSecret
-         * @param {string} accountId The ID of the account to search for symbols within.
+         * @param {string} accountId
          * @param {SymbolQuery} [symbolQuery]
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -560,8 +560,8 @@ const ReferenceDataApiFp = function (configuration) {
             });
         },
         /**
-         * Returns a list of Universal Symbol objects that match a defined string.  Matches on ticker or name.
-         * @summary Search for symbols
+         * Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.
+         * @summary Search symbols
          * @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -576,8 +576,8 @@ const ReferenceDataApiFp = function (configuration) {
             });
         },
         /**
-         * Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
-         * @summary Get details of a symbol
+         * Returns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a \'.TO\' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Please use the ticker with the proper suffix for the best results.
+         * @summary Get symbol detail
          * @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -638,8 +638,8 @@ const ReferenceDataApiFp = function (configuration) {
             });
         },
         /**
-         * Returns a list of universal symbols that are supported by the specificied account. Returned symbols are based on the provided search string, matching on ticker and name.
-         * @summary Search for symbols available in an account
+         * Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.  The search results are further limited to the symbols supported by the brokerage for which the account is under.
+         * @summary Search account symbols
          * @param {ReferenceDataApiSymbolSearchUserAccountRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -701,8 +701,8 @@ const ReferenceDataApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getStockExchanges(options).then((request) => request(axios, basePath));
         },
         /**
-         * Returns a list of Universal Symbol objects that match a defined string.  Matches on ticker or name.
-         * @summary Search for symbols
+         * Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.
+         * @summary Search symbols
          * @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -711,8 +711,8 @@ const ReferenceDataApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getSymbols(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
-         * @summary Get details of a symbol
+         * Returns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a \'.TO\' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Please use the ticker with the proper suffix for the best results.
+         * @summary Get symbol detail
          * @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -758,8 +758,8 @@ const ReferenceDataApiFactory = function (configuration, basePath, axios) {
             return localVarFp.listAllCurrenciesRates(options).then((request) => request(axios, basePath));
         },
         /**
-         * Returns a list of universal symbols that are supported by the specificied account. Returned symbols are based on the provided search string, matching on ticker and name.
-         * @summary Search for symbols available in an account
+         * Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.  The search results are further limited to the symbols supported by the brokerage for which the account is under.
+         * @summary Search account symbols
          * @param {ReferenceDataApiSymbolSearchUserAccountRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -819,8 +819,8 @@ class ReferenceDataApiGenerated extends base_1.BaseAPI {
         return (0, exports.ReferenceDataApiFp)(this.configuration).getStockExchanges(options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Returns a list of Universal Symbol objects that match a defined string.  Matches on ticker or name.
-     * @summary Search for symbols
+     * Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.
+     * @summary Search symbols
      * @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -830,8 +830,8 @@ class ReferenceDataApiGenerated extends base_1.BaseAPI {
         return (0, exports.ReferenceDataApiFp)(this.configuration).getSymbols(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
-     * @summary Get details of a symbol
+     * Returns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a \'.TO\' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Please use the ticker with the proper suffix for the best results.
+     * @summary Get symbol detail
      * @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -882,8 +882,8 @@ class ReferenceDataApiGenerated extends base_1.BaseAPI {
         return (0, exports.ReferenceDataApiFp)(this.configuration).listAllCurrenciesRates(options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Returns a list of universal symbols that are supported by the specificied account. Returned symbols are based on the provided search string, matching on ticker and name.
-     * @summary Search for symbols available in an account
+     * Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.  The search results are further limited to the symbols supported by the brokerage for which the account is under.
+     * @summary Search account symbols
      * @param {ReferenceDataApiSymbolSearchUserAccountRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

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

@@ -46,7 +46,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
      */
     getUserAccountQuotes: (userId: string, userSecret: string, symbols: string, accountId: string, useTicker?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.   This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
+     * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.  This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
      * @summary Place order
      * @param {string} userId
      * @param {string} userSecret
@@ -97,7 +97,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
      */
     getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SymbolsQuotesInner>>>;
     /**
-     * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.   This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
+     * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.  This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
      * @summary Place order
      * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -143,7 +143,7 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
      */
     getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<SymbolsQuotesInner>>;
     /**
-     * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.   This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
+     * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.  This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
      * @summary Place order
      * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -319,7 +319,7 @@ export declare class TradingApiGenerated extends BaseAPI {
      */
     getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SymbolsQuotesInner[], any>>;
     /**
-     * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.   This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
+     * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.  This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
      * @summary Place order
      * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

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

@@ -219,7 +219,7 @@ const TradingApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.   This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
+         * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.  This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
          * @summary Place order
          * @param {string} userId
          * @param {string} userSecret
@@ -398,7 +398,7 @@ const TradingApiFp = function (configuration) {
             });
         },
         /**
-         * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.   This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
+         * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.  This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
          * @summary Place order
          * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -478,7 +478,7 @@ const TradingApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getUserAccountQuotes(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.   This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
+         * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.  This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
          * @summary Place order
          * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -541,7 +541,7 @@ class TradingApiGenerated extends base_1.BaseAPI {
         return (0, exports.TradingApiFp)(this.configuration).getUserAccountQuotes(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.   This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
+     * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.  This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
      * @summary Place order
      * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.