snaptrade-typescript-sdk 9.0.178 → 9.0.180

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

@@ -35,67 +35,6 @@ const requestBeforeHook_1 = require("../requestBeforeHook");
  */
 const OptionsApiAxiosParamCreator = function (configuration) {
     return {
-        /**
-         * Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
-         * @summary Get option quote
-         * @param {string} userId
-         * @param {string} userSecret
-         * @param {string} accountId
-         * @param {string} symbol The OCC-formatted option symbol.
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        getUserAccountOptionQuotes: (userId, userSecret, accountId, symbol, options = {}) => __awaiter(this, void 0, void 0, function* () {
-            // verify required parameter 'userId' is not null or undefined
-            (0, common_1.assertParamExists)('getUserAccountOptionQuotes', 'userId', userId);
-            // verify required parameter 'userSecret' is not null or undefined
-            (0, common_1.assertParamExists)('getUserAccountOptionQuotes', 'userSecret', userSecret);
-            // verify required parameter 'accountId' is not null or undefined
-            (0, common_1.assertParamExists)('getUserAccountOptionQuotes', 'accountId', accountId);
-            // verify required parameter 'symbol' is not null or undefined
-            (0, common_1.assertParamExists)('getUserAccountOptionQuotes', 'symbol', symbol);
-            const localVarPath = `/accounts/{accountId}/quotes/options`
-                .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId !== undefined ? accountId : `-accountId-`)));
-            // use dummy base URL string because the URL constructor only accepts absolute URLs.
-            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
-            let baseOptions;
-            if (configuration) {
-                baseOptions = configuration.baseOptions;
-            }
-            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
-            const localVarHeaderParameter = configuration && !(0, common_1.isBrowser)() ? { "User-Agent": configuration.userAgent } : {};
-            const localVarQueryParameter = {};
-            // authentication PartnerClientId required
-            yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, key: "clientId", keyParamName: "clientId", configuration });
-            // authentication PartnerSignature required
-            yield (0, common_1.setApiKeyToObject)({ object: localVarHeaderParameter, key: "Signature", keyParamName: "signature", configuration });
-            // authentication PartnerTimestamp required
-            yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, key: "timestamp", keyParamName: "timestamp", configuration });
-            if (userId !== undefined) {
-                localVarQueryParameter['userId'] = userId;
-            }
-            if (userSecret !== undefined) {
-                localVarQueryParameter['userSecret'] = userSecret;
-            }
-            if (symbol !== undefined) {
-                localVarQueryParameter['symbol'] = symbol;
-            }
-            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
-            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
-            (0, requestBeforeHook_1.requestBeforeHook)({
-                queryParameters: localVarQueryParameter,
-                requestConfig: localVarRequestOptions,
-                path: localVarPath,
-                configuration,
-                pathTemplate: '/accounts/{accountId}/quotes/options',
-                httpMethod: 'GET'
-            });
-            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
-            return {
-                url: (0, common_1.toPathString)(localVarUrlObj),
-                options: localVarRequestOptions,
-            };
-        }),
         /**
          * Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).  Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:   - If you do, this endpoint returns real-time data.   - If you don\'t, 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.
          * @summary List account option positions
@@ -161,19 +100,6 @@ exports.OptionsApiAxiosParamCreator = OptionsApiAxiosParamCreator;
 const OptionsApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.OptionsApiAxiosParamCreator)(configuration);
     return {
-        /**
-         * Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
-         * @summary Get option quote
-         * @param {OptionsApiGetUserAccountOptionQuotesRequest} requestParameters Request parameters.
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        getUserAccountOptionQuotes(requestParameters, options) {
-            return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getUserAccountOptionQuotes(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, requestParameters.symbol, options);
-                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
-            });
-        },
         /**
          * Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).  Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:   - If you do, this endpoint returns real-time data.   - If you don\'t, 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.
          * @summary List account option positions
@@ -197,16 +123,6 @@ exports.OptionsApiFp = OptionsApiFp;
 const OptionsApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.OptionsApiFp)(configuration);
     return {
-        /**
-         * Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
-         * @summary Get option quote
-         * @param {OptionsApiGetUserAccountOptionQuotesRequest} requestParameters Request parameters.
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        getUserAccountOptionQuotes(requestParameters, options) {
-            return localVarFp.getUserAccountOptionQuotes(requestParameters, options).then((request) => request(axios, basePath));
-        },
         /**
          * Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).  Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:   - If you do, this endpoint returns real-time data.   - If you don\'t, 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.
          * @summary List account option positions
@@ -227,17 +143,6 @@ exports.OptionsApiFactory = OptionsApiFactory;
  * @extends {BaseAPI}
  */
 class OptionsApiGenerated extends base_1.BaseAPI {
-    /**
-     * Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
-     * @summary Get option quote
-     * @param {OptionsApiGetUserAccountOptionQuotesRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OptionsApiGenerated
-     */
-    getUserAccountOptionQuotes(requestParameters, options) {
-        return (0, exports.OptionsApiFp)(this.configuration).getUserAccountOptionQuotes(requestParameters, options).then((request) => request(this.axios, this.basePath));
-    }
     /**
      * Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).  Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:   - If you do, this endpoint returns real-time data.   - If you don\'t, 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.
      * @summary List account option positions

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

@@ -400,7 +400,7 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ReferenceDataApiGenerated
      */
-    getCurrencyExchangeRatePair(requestParameters: ReferenceDataApiGetCurrencyExchangeRatePairRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExchangeRatePairs, any>>;
+    getCurrencyExchangeRatePair(requestParameters: ReferenceDataApiGetCurrencyExchangeRatePairRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExchangeRatePairs, any, {}>>;
     /**
      * Returns configurations for your SnapTrade Client ID, including allowed brokerages and data access.
      * @summary Get Client Info
@@ -408,7 +408,7 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ReferenceDataApiGenerated
      */
-    getPartnerInfo(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PartnerData, any>>;
+    getPartnerInfo(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PartnerData, any, {}>>;
     /**
      * Return all available security types supported by SnapTrade.
      * @summary List security types
@@ -416,7 +416,7 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ReferenceDataApiGenerated
      */
-    getSecurityTypes(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SecurityType[], any>>;
+    getSecurityTypes(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SecurityType[], any, {}>>;
     /**
      * Returns a list of all supported Exchanges.
      * @summary Get exchanges
@@ -424,7 +424,7 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ReferenceDataApiGenerated
      */
-    getStockExchanges(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Exchange[], any>>;
+    getStockExchanges(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Exchange[], any, {}>>;
     /**
      * 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
@@ -433,7 +433,7 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ReferenceDataApiGenerated
      */
-    getSymbols(requestParameters?: ReferenceDataApiGetSymbolsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalSymbol[], any>>;
+    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. 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
@@ -442,7 +442,7 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ReferenceDataApiGenerated
      */
-    getSymbolsByTicker(requestParameters: ReferenceDataApiGetSymbolsByTickerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalSymbol, any>>;
+    getSymbolsByTicker(requestParameters: ReferenceDataApiGetSymbolsByTickerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalSymbol, any, {}>>;
     /**
      * Returns a list of all defined Brokerage authorization Type objects.
      * @summary Get all brokerage authorization types
@@ -451,7 +451,7 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ReferenceDataApiGenerated
      */
-    listAllBrokerageAuthorizationType(requestParameters?: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorizationTypeReadOnly[], any>>;
+    listAllBrokerageAuthorizationType(requestParameters?: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorizationTypeReadOnly[], any, {}>>;
     /**
      * Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don\'t will return an empty list.
      * @summary Get brokerage instruments
@@ -460,7 +460,7 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ReferenceDataApiGenerated
      */
-    listAllBrokerageInstruments(requestParameters: ReferenceDataApiListAllBrokerageInstrumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageInstrumentsResponse, any>>;
+    listAllBrokerageInstruments(requestParameters: ReferenceDataApiListAllBrokerageInstrumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageInstrumentsResponse, any, {}>>;
     /**
      * Returns a list of all defined Brokerage objects.
      * @summary Get brokerages
@@ -468,7 +468,7 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ReferenceDataApiGenerated
      */
-    listAllBrokerages(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Brokerage[], any>>;
+    listAllBrokerages(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Brokerage[], any, {}>>;
     /**
      * Returns a list of all defined Currency objects.
      * @summary Get currencies
@@ -476,7 +476,7 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ReferenceDataApiGenerated
      */
-    listAllCurrencies(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Currency[], any>>;
+    listAllCurrencies(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Currency[], any, {}>>;
     /**
      * Returns a list of all Exchange Rate Pairs for all supported Currencies.
      * @summary Get currency exchange rates
@@ -484,7 +484,7 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ReferenceDataApiGenerated
      */
-    listAllCurrenciesRates(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExchangeRatePairs[], any>>;
+    listAllCurrenciesRates(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExchangeRatePairs[], any, {}>>;
     /**
      * 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
@@ -493,5 +493,5 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ReferenceDataApiGenerated
      */
-    symbolSearchUserAccount(requestParameters: ReferenceDataApiSymbolSearchUserAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalSymbol[], any>>;
+    symbolSearchUserAccount(requestParameters: ReferenceDataApiSymbolSearchUserAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalSymbol[], any, {}>>;
 }

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

@@ -15,6 +15,7 @@ import { ManualTradeReplaceForm } from '../models';
 import { MlegOrderResponse } from '../models';
 import { MlegTradeForm } from '../models';
 import { OptionImpact } from '../models';
+import { OptionQuote } from '../models';
 import { OrderUpdatedResponse } from '../models';
 import { SymbolsQuotesInner } from '../models';
 import { TradingSearchCryptocurrencyPairInstruments200Response } from '../models';
@@ -79,6 +80,17 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     getOrderImpact: (userId: string, userSecret: string, manualTradeForm: ManualTradeForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
+     * @summary Get option quote
+     * @param {string} userId
+     * @param {string} userSecret
+     * @param {string} accountId
+     * @param {string} symbol The OCC-formatted option symbol.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserAccountOptionQuotes: (userId: string, userSecret: string, accountId: string, symbol: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Returns quotes from the brokerage for the specified symbols and account.  The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint.  **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys**  This endpoint does not work for options quotes.  This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
      * @summary Get equity symbol quotes
@@ -226,6 +238,14 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManualTradeAndImpact>>;
+    /**
+     * Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
+     * @summary Get option quote
+     * @param {TradingApiGetUserAccountOptionQuotesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserAccountOptionQuotes(requestParameters: TradingApiGetUserAccountOptionQuotesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionQuote>>;
     /**
      * Returns quotes from the brokerage for the specified symbols and account.  The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint.  **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys**  This endpoint does not work for options quotes.  This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
      * @summary Get equity symbol quotes
@@ -345,6 +365,14 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): AxiosPromise<ManualTradeAndImpact>;
+    /**
+     * Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
+     * @summary Get option quote
+     * @param {TradingApiGetUserAccountOptionQuotesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserAccountOptionQuotes(requestParameters: TradingApiGetUserAccountOptionQuotesRequest, options?: AxiosRequestConfig): AxiosPromise<OptionQuote>;
     /**
      * Returns quotes from the brokerage for the specified symbols and account.  The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint.  **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys**  This endpoint does not work for options quotes.  This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
      * @summary Get equity symbol quotes
@@ -543,6 +571,37 @@ export type TradingApiGetOrderImpactRequest = {
     */
     readonly userSecret: string;
 } & ManualTradeForm;
+/**
+ * Request parameters for getUserAccountOptionQuotes operation in TradingApi.
+ * @export
+ * @interface TradingApiGetUserAccountOptionQuotesRequest
+ */
+export type TradingApiGetUserAccountOptionQuotesRequest = {
+    /**
+    *
+    * @type {string}
+    * @memberof TradingApiGetUserAccountOptionQuotes
+    */
+    readonly userId: string;
+    /**
+    *
+    * @type {string}
+    * @memberof TradingApiGetUserAccountOptionQuotes
+    */
+    readonly userSecret: string;
+    /**
+    *
+    * @type {string}
+    * @memberof TradingApiGetUserAccountOptionQuotes
+    */
+    readonly accountId: string;
+    /**
+    * The OCC-formatted option symbol.
+    * @type {string}
+    * @memberof TradingApiGetUserAccountOptionQuotes
+    */
+    readonly symbol: string;
+};
 /**
  * Request parameters for getUserAccountQuotes operation in TradingApi.
  * @export
@@ -801,7 +860,7 @@ export declare class TradingApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TradingApiGenerated
      */
-    cancelOrder(requestParameters: TradingApiCancelOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CancelOrderResponse, any>>;
+    cancelOrder(requestParameters: TradingApiCancelOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CancelOrderResponse, any, {}>>;
     /**
      * **This endpoint is deprecated. Please switch to [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) ** Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
      * @summary Cancel equity order
@@ -811,7 +870,7 @@ export declare class TradingApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TradingApiGenerated
      */
-    cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
+    cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any, {}>>;
     /**
      * Gets a quote for the specified account.
      * @summary Get crypto pair quote
@@ -820,7 +879,7 @@ export declare class TradingApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TradingApiGenerated
      */
-    getCryptocurrencyPairQuote(requestParameters: TradingApiGetCryptocurrencyPairQuoteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CryptocurrencyPairQuote, any>>;
+    getCryptocurrencyPairQuote(requestParameters: TradingApiGetCryptocurrencyPairQuoteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CryptocurrencyPairQuote, any, {}>>;
     /**
      * Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain enabled brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for more information on which brokerages support this endpoint.
      * @summary Get option order impact
@@ -829,7 +888,7 @@ export declare class TradingApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TradingApiGenerated
      */
-    getOptionImpact(requestParameters: TradingApiGetOptionImpactRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionImpact, any>>;
+    getOptionImpact(requestParameters: TradingApiGetOptionImpactRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionImpact, any, {}>>;
     /**
      * Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
      * @summary Check equity order impact
@@ -838,7 +897,16 @@ export declare class TradingApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TradingApiGenerated
      */
-    getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManualTradeAndImpact, any>>;
+    getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManualTradeAndImpact, any, {}>>;
+    /**
+     * Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
+     * @summary Get option quote
+     * @param {TradingApiGetUserAccountOptionQuotesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TradingApiGenerated
+     */
+    getUserAccountOptionQuotes(requestParameters: TradingApiGetUserAccountOptionQuotesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionQuote, any, {}>>;
     /**
      * Returns quotes from the brokerage for the specified symbols and account.  The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint.  **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys**  This endpoint does not work for options quotes.  This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
      * @summary Get equity symbol quotes
@@ -847,7 +915,7 @@ export declare class TradingApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TradingApiGenerated
      */
-    getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SymbolsQuotesInner[], any>>;
+    getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SymbolsQuotesInner[], any, {}>>;
     /**
      * Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
      * @summary Place bracket order
@@ -856,7 +924,7 @@ export declare class TradingApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TradingApiGenerated
      */
-    placeBracketOrder(requestParameters: TradingApiPlaceBracketOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
+    placeBracketOrder(requestParameters: TradingApiPlaceBracketOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any, {}>>;
     /**
      * Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
      * @summary Place crypto order
@@ -865,7 +933,7 @@ export declare class TradingApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TradingApiGenerated
      */
-    placeCryptoOrder(requestParameters: TradingApiPlaceCryptoOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderUpdatedResponse, any>>;
+    placeCryptoOrder(requestParameters: TradingApiPlaceCryptoOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderUpdatedResponse, 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.
      * @summary Place equity order
@@ -874,7 +942,7 @@ export declare class TradingApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TradingApiGenerated
      */
-    placeForceOrder(requestParameters: TradingApiPlaceForceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
+    placeForceOrder(requestParameters: TradingApiPlaceForceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any, {}>>;
     /**
      * Places a multi-leg option order. Only supported on certain option trading brokerages. https://support.snaptrade.com/brokerages has information on brokerage trading support
      * @summary Place option order
@@ -883,7 +951,7 @@ export declare class TradingApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TradingApiGenerated
      */
-    placeMlegOrder(requestParameters: TradingApiPlaceMlegOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MlegOrderResponse, any>>;
+    placeMlegOrder(requestParameters: TradingApiPlaceMlegOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MlegOrderResponse, any, {}>>;
     /**
      * Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder).  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 checked equity order
@@ -892,7 +960,7 @@ export declare class TradingApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TradingApiGenerated
      */
-    placeOrder(requestParameters: TradingApiPlaceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
+    placeOrder(requestParameters: TradingApiPlaceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any, {}>>;
     /**
      * Previews an order using the specified account.
      * @summary Preview crypto order
@@ -901,7 +969,7 @@ export declare class TradingApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TradingApiGenerated
      */
-    previewCryptoOrder(requestParameters: TradingApiPreviewCryptoOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CryptoOrderPreview, any>>;
+    previewCryptoOrder(requestParameters: TradingApiPreviewCryptoOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CryptoOrderPreview, any, {}>>;
     /**
      * Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order\'s brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages
      * @summary Replace order
@@ -910,7 +978,7 @@ export declare class TradingApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TradingApiGenerated
      */
-    replaceOrder(requestParameters: TradingApiReplaceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
+    replaceOrder(requestParameters: TradingApiReplaceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any, {}>>;
     /**
      * Searches cryptocurrency pairs instruments accessible to the specified account. Both `base` and `quote` are optional. Omit both for a full list of cryptocurrency pairs.
      * @summary Get crypto pairs
@@ -919,5 +987,5 @@ export declare class TradingApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TradingApiGenerated
      */
-    searchCryptocurrencyPairInstruments(requestParameters: TradingApiSearchCryptocurrencyPairInstrumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TradingSearchCryptocurrencyPairInstruments200Response, any>>;
+    searchCryptocurrencyPairInstruments(requestParameters: TradingApiSearchCryptocurrencyPairInstrumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TradingSearchCryptocurrencyPairInstruments200Response, any, {}>>;
 }

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

@@ -335,6 +335,67 @@ const TradingApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
+         * @summary Get option quote
+         * @param {string} userId
+         * @param {string} userSecret
+         * @param {string} accountId
+         * @param {string} symbol The OCC-formatted option symbol.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getUserAccountOptionQuotes: (userId, userSecret, accountId, symbol, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'userId' is not null or undefined
+            (0, common_1.assertParamExists)('getUserAccountOptionQuotes', 'userId', userId);
+            // verify required parameter 'userSecret' is not null or undefined
+            (0, common_1.assertParamExists)('getUserAccountOptionQuotes', 'userSecret', userSecret);
+            // verify required parameter 'accountId' is not null or undefined
+            (0, common_1.assertParamExists)('getUserAccountOptionQuotes', 'accountId', accountId);
+            // verify required parameter 'symbol' is not null or undefined
+            (0, common_1.assertParamExists)('getUserAccountOptionQuotes', 'symbol', symbol);
+            const localVarPath = `/accounts/{accountId}/quotes/options`
+                .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId !== undefined ? accountId : `-accountId-`)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = configuration && !(0, common_1.isBrowser)() ? { "User-Agent": configuration.userAgent } : {};
+            const localVarQueryParameter = {};
+            // authentication PartnerClientId required
+            yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, key: "clientId", keyParamName: "clientId", configuration });
+            // authentication PartnerSignature required
+            yield (0, common_1.setApiKeyToObject)({ object: localVarHeaderParameter, key: "Signature", keyParamName: "signature", configuration });
+            // authentication PartnerTimestamp required
+            yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, key: "timestamp", keyParamName: "timestamp", configuration });
+            if (userId !== undefined) {
+                localVarQueryParameter['userId'] = userId;
+            }
+            if (userSecret !== undefined) {
+                localVarQueryParameter['userSecret'] = userSecret;
+            }
+            if (symbol !== undefined) {
+                localVarQueryParameter['symbol'] = symbol;
+            }
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            (0, requestBeforeHook_1.requestBeforeHook)({
+                queryParameters: localVarQueryParameter,
+                requestConfig: localVarRequestOptions,
+                path: localVarPath,
+                configuration,
+                pathTemplate: '/accounts/{accountId}/quotes/options',
+                httpMethod: 'GET'
+            });
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Returns quotes from the brokerage for the specified symbols and account.  The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint.  **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys**  This endpoint does not work for options quotes.  This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
          * @summary Get equity symbol quotes
@@ -985,6 +1046,19 @@ const TradingApiFp = function (configuration) {
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
+         * @summary Get option quote
+         * @param {TradingApiGetUserAccountOptionQuotesRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getUserAccountOptionQuotes(requestParameters, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getUserAccountOptionQuotes(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, requestParameters.symbol, options);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
         /**
          * Returns quotes from the brokerage for the specified symbols and account.  The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint.  **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys**  This endpoint does not work for options quotes.  This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
          * @summary Get equity symbol quotes
@@ -1230,6 +1304,16 @@ const TradingApiFactory = function (configuration, basePath, axios) {
         getOrderImpact(requestParameters, options) {
             return localVarFp.getOrderImpact(requestParameters, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
+         * @summary Get option quote
+         * @param {TradingApiGetUserAccountOptionQuotesRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getUserAccountOptionQuotes(requestParameters, options) {
+            return localVarFp.getUserAccountOptionQuotes(requestParameters, options).then((request) => request(axios, basePath));
+        },
         /**
          * Returns quotes from the brokerage for the specified symbols and account.  The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint.  **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys**  This endpoint does not work for options quotes.  This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
          * @summary Get equity symbol quotes
@@ -1386,6 +1470,17 @@ class TradingApiGenerated extends base_1.BaseAPI {
     getOrderImpact(requestParameters, options) {
         return (0, exports.TradingApiFp)(this.configuration).getOrderImpact(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
+     * @summary Get option quote
+     * @param {TradingApiGetUserAccountOptionQuotesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TradingApiGenerated
+     */
+    getUserAccountOptionQuotes(requestParameters, options) {
+        return (0, exports.TradingApiFp)(this.configuration).getUserAccountOptionQuotes(requestParameters, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Returns quotes from the brokerage for the specified symbols and account.  The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint.  **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys**  This endpoint does not work for options quotes.  This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
      * @summary Get equity symbol quotes

package/dist/api/transactions-and-reporting-api-generated.d.ts

@@ -201,7 +201,7 @@ export declare class TransactionsAndReportingApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TransactionsAndReportingApiGenerated
      */
-    getActivities(requestParameters: TransactionsAndReportingApiGetActivitiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalActivity[], any>>;
+    getActivities(requestParameters: TransactionsAndReportingApiGetActivitiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalActivity[], any, {}>>;
     /**
      * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
      * @summary Get performance information for a specific timeframe
@@ -211,5 +211,5 @@ export declare class TransactionsAndReportingApiGenerated extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TransactionsAndReportingApiGenerated
      */
-    getReportingCustomRange(requestParameters: TransactionsAndReportingApiGetReportingCustomRangeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PerformanceCustom, any>>;
+    getReportingCustomRange(requestParameters: TransactionsAndReportingApiGetReportingCustomRangeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PerformanceCustom, any, {}>>;
 }