snaptrade-typescript-sdk 9.0.174 → 9.0.176

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  Connect brokerage accounts to your app for live positions and trading
8
8
 
9
- [![npm](https://img.shields.io/badge/npm-v9.0.174-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.174)
9
+ [![npm](https://img.shields.io/badge/npm-v9.0.176-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.176)
10
10
  [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
11
11
 
12
12
  </div>
@@ -48,7 +48,7 @@ Connect brokerage accounts to your app for live positions and trading
48
48
  * [`snaptrade.experimentalEndpoints.getUserAccountOrderDetailV2`](#snaptradeexperimentalendpointsgetuseraccountorderdetailv2)
49
49
  * [`snaptrade.experimentalEndpoints.getUserAccountOrdersV2`](#snaptradeexperimentalendpointsgetuseraccountordersv2)
50
50
  * [`snaptrade.experimentalEndpoints.getUserAccountRecentOrdersV2`](#snaptradeexperimentalendpointsgetuseraccountrecentordersv2)
51
- * [`snaptrade.options.getOptionQuote`](#snaptradeoptionsgetoptionquote)
51
+ * [`snaptrade.options.getUserAccountOptionQuotes`](#snaptradeoptionsgetuseraccountoptionquotes)
52
52
  * [`snaptrade.options.listOptionHoldings`](#snaptradeoptionslistoptionholdings)
53
53
  * [`snaptrade.referenceData.getCurrencyExchangeRatePair`](#snaptradereferencedatagetcurrencyexchangeratepair)
54
54
  * [`snaptrade.referenceData.getPartnerInfo`](#snaptradereferencedatagetpartnerinfo)
@@ -1436,20 +1436,22 @@ Defaults to true. Indicates if request should fetch only executed orders. Set to
1436
1436
  ---
1437
1437
 
1438
1438
 
1439
- ### `snaptrade.options.getOptionQuote`<a id="snaptradeoptionsgetoptionquote"></a>
1439
+ ### `snaptrade.options.getUserAccountOptionQuotes`<a id="snaptradeoptionsgetuseraccountoptionquotes"></a>
1440
1440
 
1441
- Returns a real-time 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)
1441
+ 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)
1442
+ **Note:** These are derived values and are not suitable for trading purposes.
1442
1443
 
1443
1444
 
1444
1445
  #### 🛠️ Usage<a id="🛠️-usage"></a>
1445
1446
 
1446
1447
  ```typescript
1447
- const getOptionQuoteResponse = await snaptrade.options.getOptionQuote({
1448
- userId: "snaptrade-user-123",
1449
- userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
1450
- accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
1451
- symbol: "AAPL 251219C00150000",
1452
- });
1448
+ const getUserAccountOptionQuotesResponse =
1449
+ await snaptrade.options.getUserAccountOptionQuotes({
1450
+ userId: "snaptrade-user-123",
1451
+ userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
1452
+ accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
1453
+ symbol: "AAPL 251219C00150000",
1454
+ });
1453
1455
  ```
1454
1456
 
1455
1457
  #### ⚙️ Parameters<a id="⚙️-parameters"></a>
@@ -1993,7 +1995,7 @@ const getCryptocurrencyPairQuoteResponse =
1993
1995
  ### `snaptrade.trading.getOptionImpact`<a id="snaptradetradinggetoptionimpact"></a>
1994
1996
 
1995
1997
  Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it.
1996
- Only supported for certain brokerages. Please refer to the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint.
1998
+ 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.
1997
1999
 
1998
2000
 
1999
2001
  #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -9,7 +9,7 @@ import { OptionsPosition } from '../models';
9
9
  */
10
10
  export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration) => {
11
11
  /**
12
- * Returns a real-time 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)
12
+ * 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.
13
13
  * @summary Get option quote
14
14
  * @param {string} userId
15
15
  * @param {string} userSecret
@@ -18,7 +18,7 @@ export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration
18
18
  * @param {*} [options] Override http request option.
19
19
  * @throws {RequiredError}
20
20
  */
21
- getOptionQuote: (userId: string, userSecret: string, accountId: string, symbol: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
21
+ getUserAccountOptionQuotes: (userId: string, userSecret: string, accountId: string, symbol: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
22
22
  /**
23
23
  * 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.
24
24
  * @summary List account option positions
@@ -36,13 +36,13 @@ export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration
36
36
  */
37
37
  export declare const OptionsApiFp: (configuration?: Configuration) => {
38
38
  /**
39
- * Returns a real-time 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)
39
+ * 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.
40
40
  * @summary Get option quote
41
- * @param {OptionsApiGetOptionQuoteRequest} requestParameters Request parameters.
41
+ * @param {OptionsApiGetUserAccountOptionQuotesRequest} requestParameters Request parameters.
42
42
  * @param {*} [options] Override http request option.
43
43
  * @throws {RequiredError}
44
44
  */
45
- getOptionQuote(requestParameters: OptionsApiGetOptionQuoteRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionQuote>>;
45
+ getUserAccountOptionQuotes(requestParameters: OptionsApiGetUserAccountOptionQuotesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionQuote>>;
46
46
  /**
47
47
  * 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.
48
48
  * @summary List account option positions
@@ -58,13 +58,13 @@ export declare const OptionsApiFp: (configuration?: Configuration) => {
58
58
  */
59
59
  export declare const OptionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
60
60
  /**
61
- * Returns a real-time 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)
61
+ * 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.
62
62
  * @summary Get option quote
63
- * @param {OptionsApiGetOptionQuoteRequest} requestParameters Request parameters.
63
+ * @param {OptionsApiGetUserAccountOptionQuotesRequest} requestParameters Request parameters.
64
64
  * @param {*} [options] Override http request option.
65
65
  * @throws {RequiredError}
66
66
  */
67
- getOptionQuote(requestParameters: OptionsApiGetOptionQuoteRequest, options?: AxiosRequestConfig): AxiosPromise<OptionQuote>;
67
+ getUserAccountOptionQuotes(requestParameters: OptionsApiGetUserAccountOptionQuotesRequest, options?: AxiosRequestConfig): AxiosPromise<OptionQuote>;
68
68
  /**
69
69
  * 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.
70
70
  * @summary List account option positions
@@ -75,33 +75,33 @@ export declare const OptionsApiFactory: (configuration?: Configuration, basePath
75
75
  listOptionHoldings(requestParameters: OptionsApiListOptionHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<OptionsPosition>>;
76
76
  };
77
77
  /**
78
- * Request parameters for getOptionQuote operation in OptionsApi.
78
+ * Request parameters for getUserAccountOptionQuotes operation in OptionsApi.
79
79
  * @export
80
- * @interface OptionsApiGetOptionQuoteRequest
80
+ * @interface OptionsApiGetUserAccountOptionQuotesRequest
81
81
  */
82
- export type OptionsApiGetOptionQuoteRequest = {
82
+ export type OptionsApiGetUserAccountOptionQuotesRequest = {
83
83
  /**
84
84
  *
85
85
  * @type {string}
86
- * @memberof OptionsApiGetOptionQuote
86
+ * @memberof OptionsApiGetUserAccountOptionQuotes
87
87
  */
88
88
  readonly userId: string;
89
89
  /**
90
90
  *
91
91
  * @type {string}
92
- * @memberof OptionsApiGetOptionQuote
92
+ * @memberof OptionsApiGetUserAccountOptionQuotes
93
93
  */
94
94
  readonly userSecret: string;
95
95
  /**
96
96
  *
97
97
  * @type {string}
98
- * @memberof OptionsApiGetOptionQuote
98
+ * @memberof OptionsApiGetUserAccountOptionQuotes
99
99
  */
100
100
  readonly accountId: string;
101
101
  /**
102
102
  * The OCC-formatted option symbol.
103
103
  * @type {string}
104
- * @memberof OptionsApiGetOptionQuote
104
+ * @memberof OptionsApiGetUserAccountOptionQuotes
105
105
  */
106
106
  readonly symbol: string;
107
107
  };
@@ -138,14 +138,14 @@ export type OptionsApiListOptionHoldingsRequest = {
138
138
  */
139
139
  export declare class OptionsApiGenerated extends BaseAPI {
140
140
  /**
141
- * Returns a real-time 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)
141
+ * 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.
142
142
  * @summary Get option quote
143
- * @param {OptionsApiGetOptionQuoteRequest} requestParameters Request parameters.
143
+ * @param {OptionsApiGetUserAccountOptionQuotesRequest} requestParameters Request parameters.
144
144
  * @param {*} [options] Override http request option.
145
145
  * @throws {RequiredError}
146
146
  * @memberof OptionsApiGenerated
147
147
  */
148
- getOptionQuote(requestParameters: OptionsApiGetOptionQuoteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionQuote, any>>;
148
+ getUserAccountOptionQuotes(requestParameters: OptionsApiGetUserAccountOptionQuotesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionQuote, any>>;
149
149
  /**
150
150
  * 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.
151
151
  * @summary List account option positions
@@ -36,7 +36,7 @@ const requestBeforeHook_1 = require("../requestBeforeHook");
36
36
  const OptionsApiAxiosParamCreator = function (configuration) {
37
37
  return {
38
38
  /**
39
- * Returns a real-time 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)
39
+ * 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.
40
40
  * @summary Get option quote
41
41
  * @param {string} userId
42
42
  * @param {string} userSecret
@@ -45,15 +45,15 @@ const OptionsApiAxiosParamCreator = function (configuration) {
45
45
  * @param {*} [options] Override http request option.
46
46
  * @throws {RequiredError}
47
47
  */
48
- getOptionQuote: (userId, userSecret, accountId, symbol, options = {}) => __awaiter(this, void 0, void 0, function* () {
48
+ getUserAccountOptionQuotes: (userId, userSecret, accountId, symbol, options = {}) => __awaiter(this, void 0, void 0, function* () {
49
49
  // verify required parameter 'userId' is not null or undefined
50
- (0, common_1.assertParamExists)('getOptionQuote', 'userId', userId);
50
+ (0, common_1.assertParamExists)('getUserAccountOptionQuotes', 'userId', userId);
51
51
  // verify required parameter 'userSecret' is not null or undefined
52
- (0, common_1.assertParamExists)('getOptionQuote', 'userSecret', userSecret);
52
+ (0, common_1.assertParamExists)('getUserAccountOptionQuotes', 'userSecret', userSecret);
53
53
  // verify required parameter 'accountId' is not null or undefined
54
- (0, common_1.assertParamExists)('getOptionQuote', 'accountId', accountId);
54
+ (0, common_1.assertParamExists)('getUserAccountOptionQuotes', 'accountId', accountId);
55
55
  // verify required parameter 'symbol' is not null or undefined
56
- (0, common_1.assertParamExists)('getOptionQuote', 'symbol', symbol);
56
+ (0, common_1.assertParamExists)('getUserAccountOptionQuotes', 'symbol', symbol);
57
57
  const localVarPath = `/accounts/{accountId}/quotes/options`
58
58
  .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId !== undefined ? accountId : `-accountId-`)));
59
59
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -162,15 +162,15 @@ const OptionsApiFp = function (configuration) {
162
162
  const localVarAxiosParamCreator = (0, exports.OptionsApiAxiosParamCreator)(configuration);
163
163
  return {
164
164
  /**
165
- * Returns a real-time 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)
165
+ * 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.
166
166
  * @summary Get option quote
167
- * @param {OptionsApiGetOptionQuoteRequest} requestParameters Request parameters.
167
+ * @param {OptionsApiGetUserAccountOptionQuotesRequest} requestParameters Request parameters.
168
168
  * @param {*} [options] Override http request option.
169
169
  * @throws {RequiredError}
170
170
  */
171
- getOptionQuote(requestParameters, options) {
171
+ getUserAccountOptionQuotes(requestParameters, options) {
172
172
  return __awaiter(this, void 0, void 0, function* () {
173
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getOptionQuote(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, requestParameters.symbol, options);
173
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getUserAccountOptionQuotes(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, requestParameters.symbol, options);
174
174
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
175
175
  });
176
176
  },
@@ -198,14 +198,14 @@ const OptionsApiFactory = function (configuration, basePath, axios) {
198
198
  const localVarFp = (0, exports.OptionsApiFp)(configuration);
199
199
  return {
200
200
  /**
201
- * Returns a real-time 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)
201
+ * 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.
202
202
  * @summary Get option quote
203
- * @param {OptionsApiGetOptionQuoteRequest} requestParameters Request parameters.
203
+ * @param {OptionsApiGetUserAccountOptionQuotesRequest} requestParameters Request parameters.
204
204
  * @param {*} [options] Override http request option.
205
205
  * @throws {RequiredError}
206
206
  */
207
- getOptionQuote(requestParameters, options) {
208
- return localVarFp.getOptionQuote(requestParameters, options).then((request) => request(axios, basePath));
207
+ getUserAccountOptionQuotes(requestParameters, options) {
208
+ return localVarFp.getUserAccountOptionQuotes(requestParameters, options).then((request) => request(axios, basePath));
209
209
  },
210
210
  /**
211
211
  * 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.
@@ -228,15 +228,15 @@ exports.OptionsApiFactory = OptionsApiFactory;
228
228
  */
229
229
  class OptionsApiGenerated extends base_1.BaseAPI {
230
230
  /**
231
- * Returns a real-time 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)
231
+ * 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.
232
232
  * @summary Get option quote
233
- * @param {OptionsApiGetOptionQuoteRequest} requestParameters Request parameters.
233
+ * @param {OptionsApiGetUserAccountOptionQuotesRequest} requestParameters Request parameters.
234
234
  * @param {*} [options] Override http request option.
235
235
  * @throws {RequiredError}
236
236
  * @memberof OptionsApiGenerated
237
237
  */
238
- getOptionQuote(requestParameters, options) {
239
- return (0, exports.OptionsApiFp)(this.configuration).getOptionQuote(requestParameters, options).then((request) => request(this.axios, this.basePath));
238
+ getUserAccountOptionQuotes(requestParameters, options) {
239
+ return (0, exports.OptionsApiFp)(this.configuration).getUserAccountOptionQuotes(requestParameters, options).then((request) => request(this.axios, this.basePath));
240
240
  }
241
241
  /**
242
242
  * 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.
@@ -59,7 +59,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
59
59
  */
60
60
  getCryptocurrencyPairQuote: (userId: string, userSecret: string, accountId: string, instrumentSymbol: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
61
61
  /**
62
- * Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint.
62
+ * 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.
63
63
  * @summary Get option order impact
64
64
  * @param {string} userId
65
65
  * @param {string} userSecret
@@ -211,7 +211,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
211
211
  */
212
212
  getCryptocurrencyPairQuote(requestParameters: TradingApiGetCryptocurrencyPairQuoteRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CryptocurrencyPairQuote>>;
213
213
  /**
214
- * Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint.
214
+ * 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.
215
215
  * @summary Get option order impact
216
216
  * @param {TradingApiGetOptionImpactRequest} requestParameters Request parameters.
217
217
  * @param {*} [options] Override http request option.
@@ -330,7 +330,7 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
330
330
  */
331
331
  getCryptocurrencyPairQuote(requestParameters: TradingApiGetCryptocurrencyPairQuoteRequest, options?: AxiosRequestConfig): AxiosPromise<CryptocurrencyPairQuote>;
332
332
  /**
333
- * Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint.
333
+ * 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.
334
334
  * @summary Get option order impact
335
335
  * @param {TradingApiGetOptionImpactRequest} requestParameters Request parameters.
336
336
  * @param {*} [options] Override http request option.
@@ -822,7 +822,7 @@ export declare class TradingApiGenerated extends BaseAPI {
822
822
  */
823
823
  getCryptocurrencyPairQuote(requestParameters: TradingApiGetCryptocurrencyPairQuoteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CryptocurrencyPairQuote, any>>;
824
824
  /**
825
- * Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint.
825
+ * 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.
826
826
  * @summary Get option order impact
827
827
  * @param {TradingApiGetOptionImpactRequest} requestParameters Request parameters.
828
828
  * @param {*} [options] Override http request option.
@@ -218,7 +218,7 @@ const TradingApiAxiosParamCreator = function (configuration) {
218
218
  };
219
219
  }),
220
220
  /**
221
- * Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint.
221
+ * 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.
222
222
  * @summary Get option order impact
223
223
  * @param {string} userId
224
224
  * @param {string} userSecret
@@ -941,7 +941,7 @@ const TradingApiFp = function (configuration) {
941
941
  });
942
942
  },
943
943
  /**
944
- * Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint.
944
+ * 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.
945
945
  * @summary Get option order impact
946
946
  * @param {TradingApiGetOptionImpactRequest} requestParameters Request parameters.
947
947
  * @param {*} [options] Override http request option.
@@ -1211,7 +1211,7 @@ const TradingApiFactory = function (configuration, basePath, axios) {
1211
1211
  return localVarFp.getCryptocurrencyPairQuote(requestParameters, options).then((request) => request(axios, basePath));
1212
1212
  },
1213
1213
  /**
1214
- * Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint.
1214
+ * 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.
1215
1215
  * @summary Get option order impact
1216
1216
  * @param {TradingApiGetOptionImpactRequest} requestParameters Request parameters.
1217
1217
  * @param {*} [options] Override http request option.
@@ -1365,7 +1365,7 @@ class TradingApiGenerated extends base_1.BaseAPI {
1365
1365
  return (0, exports.TradingApiFp)(this.configuration).getCryptocurrencyPairQuote(requestParameters, options).then((request) => request(this.axios, this.basePath));
1366
1366
  }
1367
1367
  /**
1368
- * Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint.
1368
+ * 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.
1369
1369
  * @summary Get option order impact
1370
1370
  * @param {TradingApiGetOptionImpactRequest} requestParameters Request parameters.
1371
1371
  * @param {*} [options] Override http request option.