snaptrade-typescript-sdk 9.0.193 → 9.0.195

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.
@@ -3,23 +3,12 @@ import { Configuration } from '../configuration';
3
3
  import { RequestArgs, BaseAPI } from '../base';
4
4
  import { AccountOrderRecordV2 } from '../models';
5
5
  import { AccountOrdersV2Response } from '../models';
6
- import { AllAccountPositionsResponse } from '../models';
7
6
  import { BrokerageAuthorizationTransactionsSyncConfirmation } from '../models';
8
7
  /**
9
8
  * ExperimentalEndpointsApi - axios parameter creator
10
9
  * @export
11
10
  */
12
11
  export declare const ExperimentalEndpointsApiAxiosParamCreator: (configuration?: Configuration) => {
13
- /**
14
- * Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. Stock positions may also include `cash_equivalent`, and may include `tax_lots` when tax lot data is enabled for the account. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
15
- * @summary List all account positions
16
- * @param {string} userId
17
- * @param {string} userSecret
18
- * @param {string} accountId
19
- * @param {*} [options] Override http request option.
20
- * @throws {RequiredError}
21
- */
22
- getAllAccountPositions: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
23
12
  /**
24
13
  * Returns the detail of a single order using the brokerage order ID provided as a path parameter. The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
25
14
  * @summary Get account order detail (V2)
@@ -70,14 +59,6 @@ export declare const ExperimentalEndpointsApiAxiosParamCreator: (configuration?:
70
59
  * @export
71
60
  */
72
61
  export declare const ExperimentalEndpointsApiFp: (configuration?: Configuration) => {
73
- /**
74
- * Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. Stock positions may also include `cash_equivalent`, and may include `tax_lots` when tax lot data is enabled for the account. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
75
- * @summary List all account positions
76
- * @param {ExperimentalEndpointsApiGetAllAccountPositionsRequest} requestParameters Request parameters.
77
- * @param {*} [options] Override http request option.
78
- * @throws {RequiredError}
79
- */
80
- getAllAccountPositions(requestParameters: ExperimentalEndpointsApiGetAllAccountPositionsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AllAccountPositionsResponse>>;
81
62
  /**
82
63
  * Returns the detail of a single order using the brokerage order ID provided as a path parameter. The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
83
64
  * @summary Get account order detail (V2)
@@ -116,14 +97,6 @@ export declare const ExperimentalEndpointsApiFp: (configuration?: Configuration)
116
97
  * @export
117
98
  */
118
99
  export declare const ExperimentalEndpointsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
119
- /**
120
- * Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. Stock positions may also include `cash_equivalent`, and may include `tax_lots` when tax lot data is enabled for the account. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
121
- * @summary List all account positions
122
- * @param {ExperimentalEndpointsApiGetAllAccountPositionsRequest} requestParameters Request parameters.
123
- * @param {*} [options] Override http request option.
124
- * @throws {RequiredError}
125
- */
126
- getAllAccountPositions(requestParameters: ExperimentalEndpointsApiGetAllAccountPositionsRequest, options?: AxiosRequestConfig): AxiosPromise<AllAccountPositionsResponse>;
127
100
  /**
128
101
  * Returns the detail of a single order using the brokerage order ID provided as a path parameter. The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
129
102
  * @summary Get account order detail (V2)
@@ -157,31 +130,6 @@ export declare const ExperimentalEndpointsApiFactory: (configuration?: Configura
157
130
  */
158
131
  syncBrokerageAuthorizationTransactions(requestParameters: ExperimentalEndpointsApiSyncBrokerageAuthorizationTransactionsRequest, options?: AxiosRequestConfig): AxiosPromise<BrokerageAuthorizationTransactionsSyncConfirmation>;
159
132
  };
160
- /**
161
- * Request parameters for getAllAccountPositions operation in ExperimentalEndpointsApi.
162
- * @export
163
- * @interface ExperimentalEndpointsApiGetAllAccountPositionsRequest
164
- */
165
- export type ExperimentalEndpointsApiGetAllAccountPositionsRequest = {
166
- /**
167
- *
168
- * @type {string}
169
- * @memberof ExperimentalEndpointsApiGetAllAccountPositions
170
- */
171
- readonly userId: string;
172
- /**
173
- *
174
- * @type {string}
175
- * @memberof ExperimentalEndpointsApiGetAllAccountPositions
176
- */
177
- readonly userSecret: string;
178
- /**
179
- *
180
- * @type {string}
181
- * @memberof ExperimentalEndpointsApiGetAllAccountPositions
182
- */
183
- readonly accountId: string;
184
- };
185
133
  /**
186
134
  * Request parameters for getUserAccountOrderDetailV2 operation in ExperimentalEndpointsApi.
187
135
  * @export
@@ -313,15 +261,6 @@ export type ExperimentalEndpointsApiSyncBrokerageAuthorizationTransactionsReques
313
261
  * @extends {BaseAPI}
314
262
  */
315
263
  export declare class ExperimentalEndpointsApiGenerated extends BaseAPI {
316
- /**
317
- * Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. Stock positions may also include `cash_equivalent`, and may include `tax_lots` when tax lot data is enabled for the account. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
318
- * @summary List all account positions
319
- * @param {ExperimentalEndpointsApiGetAllAccountPositionsRequest} requestParameters Request parameters.
320
- * @param {*} [options] Override http request option.
321
- * @throws {RequiredError}
322
- * @memberof ExperimentalEndpointsApiGenerated
323
- */
324
- getAllAccountPositions(requestParameters: ExperimentalEndpointsApiGetAllAccountPositionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AllAccountPositionsResponse, any, {}>>;
325
264
  /**
326
265
  * Returns the detail of a single order using the brokerage order ID provided as a path parameter. The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
327
266
  * @summary Get account order detail (V2)
@@ -35,61 +35,6 @@ const requestBeforeHook_1 = require("../requestBeforeHook");
35
35
  */
36
36
  const ExperimentalEndpointsApiAxiosParamCreator = function (configuration) {
37
37
  return {
38
- /**
39
- * Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. Stock positions may also include `cash_equivalent`, and may include `tax_lots` when tax lot data is enabled for the account. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
40
- * @summary List all account positions
41
- * @param {string} userId
42
- * @param {string} userSecret
43
- * @param {string} accountId
44
- * @param {*} [options] Override http request option.
45
- * @throws {RequiredError}
46
- */
47
- getAllAccountPositions: (userId, userSecret, accountId, options = {}) => __awaiter(this, void 0, void 0, function* () {
48
- // verify required parameter 'userId' is not null or undefined
49
- (0, common_1.assertParamExists)('getAllAccountPositions', 'userId', userId);
50
- // verify required parameter 'userSecret' is not null or undefined
51
- (0, common_1.assertParamExists)('getAllAccountPositions', 'userSecret', userSecret);
52
- // verify required parameter 'accountId' is not null or undefined
53
- (0, common_1.assertParamExists)('getAllAccountPositions', 'accountId', accountId);
54
- const localVarPath = `/accounts/{accountId}/positions/all`
55
- .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId !== undefined ? accountId : `-accountId-`)));
56
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
57
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
58
- let baseOptions;
59
- if (configuration) {
60
- baseOptions = configuration.baseOptions;
61
- }
62
- const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
63
- const localVarHeaderParameter = configuration && !(0, common_1.isBrowser)() ? { "User-Agent": configuration.userAgent } : {};
64
- const localVarQueryParameter = {};
65
- // authentication PartnerClientId required
66
- yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, key: "clientId", keyParamName: "clientId", configuration });
67
- // authentication PartnerSignature required
68
- yield (0, common_1.setApiKeyToObject)({ object: localVarHeaderParameter, key: "Signature", keyParamName: "signature", configuration });
69
- // authentication PartnerTimestamp required
70
- yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, key: "timestamp", keyParamName: "timestamp", configuration });
71
- if (userId !== undefined) {
72
- localVarQueryParameter['userId'] = userId;
73
- }
74
- if (userSecret !== undefined) {
75
- localVarQueryParameter['userSecret'] = userSecret;
76
- }
77
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
78
- localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
79
- (0, requestBeforeHook_1.requestBeforeHook)({
80
- queryParameters: localVarQueryParameter,
81
- requestConfig: localVarRequestOptions,
82
- path: localVarPath,
83
- configuration,
84
- pathTemplate: '/accounts/{accountId}/positions/all',
85
- httpMethod: 'GET'
86
- });
87
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
88
- return {
89
- url: (0, common_1.toPathString)(localVarUrlObj),
90
- options: localVarRequestOptions,
91
- };
92
- }),
93
38
  /**
94
39
  * Returns the detail of a single order using the brokerage order ID provided as a path parameter. The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
95
40
  * @summary Get account order detail (V2)
@@ -336,19 +281,6 @@ exports.ExperimentalEndpointsApiAxiosParamCreator = ExperimentalEndpointsApiAxio
336
281
  const ExperimentalEndpointsApiFp = function (configuration) {
337
282
  const localVarAxiosParamCreator = (0, exports.ExperimentalEndpointsApiAxiosParamCreator)(configuration);
338
283
  return {
339
- /**
340
- * Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. Stock positions may also include `cash_equivalent`, and may include `tax_lots` when tax lot data is enabled for the account. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
341
- * @summary List all account positions
342
- * @param {ExperimentalEndpointsApiGetAllAccountPositionsRequest} requestParameters Request parameters.
343
- * @param {*} [options] Override http request option.
344
- * @throws {RequiredError}
345
- */
346
- getAllAccountPositions(requestParameters, options) {
347
- return __awaiter(this, void 0, void 0, function* () {
348
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getAllAccountPositions(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, options);
349
- return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
350
- });
351
- },
352
284
  /**
353
285
  * Returns the detail of a single order using the brokerage order ID provided as a path parameter. The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
354
286
  * @summary Get account order detail (V2)
@@ -411,16 +343,6 @@ exports.ExperimentalEndpointsApiFp = ExperimentalEndpointsApiFp;
411
343
  const ExperimentalEndpointsApiFactory = function (configuration, basePath, axios) {
412
344
  const localVarFp = (0, exports.ExperimentalEndpointsApiFp)(configuration);
413
345
  return {
414
- /**
415
- * Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. Stock positions may also include `cash_equivalent`, and may include `tax_lots` when tax lot data is enabled for the account. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
416
- * @summary List all account positions
417
- * @param {ExperimentalEndpointsApiGetAllAccountPositionsRequest} requestParameters Request parameters.
418
- * @param {*} [options] Override http request option.
419
- * @throws {RequiredError}
420
- */
421
- getAllAccountPositions(requestParameters, options) {
422
- return localVarFp.getAllAccountPositions(requestParameters, options).then((request) => request(axios, basePath));
423
- },
424
346
  /**
425
347
  * Returns the detail of a single order using the brokerage order ID provided as a path parameter. The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
426
348
  * @summary Get account order detail (V2)
@@ -471,17 +393,6 @@ exports.ExperimentalEndpointsApiFactory = ExperimentalEndpointsApiFactory;
471
393
  * @extends {BaseAPI}
472
394
  */
473
395
  class ExperimentalEndpointsApiGenerated extends base_1.BaseAPI {
474
- /**
475
- * Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. Stock positions may also include `cash_equivalent`, and may include `tax_lots` when tax lot data is enabled for the account. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
476
- * @summary List all account positions
477
- * @param {ExperimentalEndpointsApiGetAllAccountPositionsRequest} requestParameters Request parameters.
478
- * @param {*} [options] Override http request option.
479
- * @throws {RequiredError}
480
- * @memberof ExperimentalEndpointsApiGenerated
481
- */
482
- getAllAccountPositions(requestParameters, options) {
483
- return (0, exports.ExperimentalEndpointsApiFp)(this.configuration).getAllAccountPositions(requestParameters, options).then((request) => request(this.axios, this.basePath));
484
- }
485
396
  /**
486
397
  * Returns the detail of a single order using the brokerage order ID provided as a path parameter. The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
487
398
  * @summary Get account order detail (V2)
@@ -8,7 +8,7 @@ import { OptionsPosition } from '../models';
8
8
  */
9
9
  export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration) => {
10
10
  /**
11
- * 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.
11
+ * 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, 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.
12
12
  * @summary List account option positions
13
13
  * @param {string} userId
14
14
  * @param {string} userSecret
@@ -24,7 +24,7 @@ export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration
24
24
  */
25
25
  export declare const OptionsApiFp: (configuration?: Configuration) => {
26
26
  /**
27
- * 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.
27
+ * 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, 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.
28
28
  * @summary List account option positions
29
29
  * @param {OptionsApiListOptionHoldingsRequest} requestParameters Request parameters.
30
30
  * @param {*} [options] Override http request option.
@@ -38,7 +38,7 @@ export declare const OptionsApiFp: (configuration?: Configuration) => {
38
38
  */
39
39
  export declare const OptionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
40
40
  /**
41
- * 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.
41
+ * 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, 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.
42
42
  * @summary List account option positions
43
43
  * @param {OptionsApiListOptionHoldingsRequest} requestParameters Request parameters.
44
44
  * @param {*} [options] Override http request option.
@@ -79,7 +79,7 @@ export type OptionsApiListOptionHoldingsRequest = {
79
79
  */
80
80
  export declare class OptionsApiGenerated extends BaseAPI {
81
81
  /**
82
- * 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.
82
+ * 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, 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.
83
83
  * @summary List account option positions
84
84
  * @param {OptionsApiListOptionHoldingsRequest} requestParameters Request parameters.
85
85
  * @param {*} [options] Override http request option.
@@ -36,7 +36,7 @@ const requestBeforeHook_1 = require("../requestBeforeHook");
36
36
  const OptionsApiAxiosParamCreator = function (configuration) {
37
37
  return {
38
38
  /**
39
- * 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.
39
+ * 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, 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.
40
40
  * @summary List account option positions
41
41
  * @param {string} userId
42
42
  * @param {string} userSecret
@@ -101,7 +101,7 @@ const OptionsApiFp = function (configuration) {
101
101
  const localVarAxiosParamCreator = (0, exports.OptionsApiAxiosParamCreator)(configuration);
102
102
  return {
103
103
  /**
104
- * 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.
104
+ * 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, 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.
105
105
  * @summary List account option positions
106
106
  * @param {OptionsApiListOptionHoldingsRequest} requestParameters Request parameters.
107
107
  * @param {*} [options] Override http request option.
@@ -124,7 +124,7 @@ const OptionsApiFactory = function (configuration, basePath, axios) {
124
124
  const localVarFp = (0, exports.OptionsApiFp)(configuration);
125
125
  return {
126
126
  /**
127
- * 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.
127
+ * 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, 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.
128
128
  * @summary List account option positions
129
129
  * @param {OptionsApiListOptionHoldingsRequest} requestParameters Request parameters.
130
130
  * @param {*} [options] Override http request option.
@@ -144,7 +144,7 @@ exports.OptionsApiFactory = OptionsApiFactory;
144
144
  */
145
145
  class OptionsApiGenerated extends base_1.BaseAPI {
146
146
  /**
147
- * 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.
147
+ * 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). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, 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.
148
148
  * @summary List account option positions
149
149
  * @param {OptionsApiListOptionHoldingsRequest} requestParameters Request parameters.
150
150
  * @param {*} [options] Override http request option.
@@ -94,11 +94,11 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
94
94
  */
95
95
  getUserAccountOptionQuotes: (userId: string, userSecret: string, accountId: string, symbol: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
96
96
  /**
97
- * 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.
97
+ * Returns a maximum of 10 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.
98
98
  * @summary Get equity symbol quotes
99
99
  * @param {string} userId
100
100
  * @param {string} userSecret
101
- * @param {string} symbols List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator
101
+ * @param {string} symbols List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator. Maximum of 10 values allowed
102
102
  * @param {string} accountId
103
103
  * @param {boolean} [useTicker] Should be set to &#x60;True&#x60; if &#x60;symbols&#x60; are comprised of tickers. Defaults to &#x60;False&#x60; if not provided.
104
104
  * @param {*} [options] Override http request option.
@@ -260,7 +260,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
260
260
  */
261
261
  getUserAccountOptionQuotes(requestParameters: TradingApiGetUserAccountOptionQuotesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionQuote>>;
262
262
  /**
263
- * 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.
263
+ * Returns a maximum of 10 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.
264
264
  * @summary Get equity symbol quotes
265
265
  * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
266
266
  * @param {*} [options] Override http request option.
@@ -395,7 +395,7 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
395
395
  */
396
396
  getUserAccountOptionQuotes(requestParameters: TradingApiGetUserAccountOptionQuotesRequest, options?: AxiosRequestConfig): AxiosPromise<OptionQuote>;
397
397
  /**
398
- * 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.
398
+ * Returns a maximum of 10 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.
399
399
  * @summary Get equity symbol quotes
400
400
  * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
401
401
  * @param {*} [options] Override http request option.
@@ -650,7 +650,7 @@ export type TradingApiGetUserAccountQuotesRequest = {
650
650
  */
651
651
  readonly userSecret: string;
652
652
  /**
653
- * List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator
653
+ * List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator. Maximum of 10 values allowed
654
654
  * @type {string}
655
655
  * @memberof TradingApiGetUserAccountQuotes
656
656
  */
@@ -962,7 +962,7 @@ export declare class TradingApiGenerated extends BaseAPI {
962
962
  */
963
963
  getUserAccountOptionQuotes(requestParameters: TradingApiGetUserAccountOptionQuotesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionQuote, any, {}>>;
964
964
  /**
965
- * 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.
965
+ * Returns a maximum of 10 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.
966
966
  * @summary Get equity symbol quotes
967
967
  * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
968
968
  * @param {*} [options] Override http request option.
@@ -397,11 +397,11 @@ const TradingApiAxiosParamCreator = function (configuration) {
397
397
  };
398
398
  }),
399
399
  /**
400
- * 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.
400
+ * Returns a maximum of 10 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.
401
401
  * @summary Get equity symbol quotes
402
402
  * @param {string} userId
403
403
  * @param {string} userSecret
404
- * @param {string} symbols List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator
404
+ * @param {string} symbols List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator. Maximum of 10 values allowed
405
405
  * @param {string} accountId
406
406
  * @param {boolean} [useTicker] Should be set to &#x60;True&#x60; if &#x60;symbols&#x60; are comprised of tickers. Defaults to &#x60;False&#x60; if not provided.
407
407
  * @param {*} [options] Override http request option.
@@ -1121,7 +1121,7 @@ const TradingApiFp = function (configuration) {
1121
1121
  });
1122
1122
  },
1123
1123
  /**
1124
- * 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.
1124
+ * Returns a maximum of 10 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.
1125
1125
  * @summary Get equity symbol quotes
1126
1126
  * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
1127
1127
  * @param {*} [options] Override http request option.
@@ -1394,7 +1394,7 @@ const TradingApiFactory = function (configuration, basePath, axios) {
1394
1394
  return localVarFp.getUserAccountOptionQuotes(requestParameters, options).then((request) => request(axios, basePath));
1395
1395
  },
1396
1396
  /**
1397
- * 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.
1397
+ * Returns a maximum of 10 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.
1398
1398
  * @summary Get equity symbol quotes
1399
1399
  * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
1400
1400
  * @param {*} [options] Override http request option.
@@ -1571,7 +1571,7 @@ class TradingApiGenerated extends base_1.BaseAPI {
1571
1571
  return (0, exports.TradingApiFp)(this.configuration).getUserAccountOptionQuotes(requestParameters, options).then((request) => request(this.axios, this.basePath));
1572
1572
  }
1573
1573
  /**
1574
- * 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.
1574
+ * Returns a maximum of 10 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.
1575
1575
  * @summary Get equity symbol quotes
1576
1576
  * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
1577
1577
  * @param {*} [options] Override http request option.