snaptrade-typescript-sdk 12.1.0 → 12.1.2
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 +10 -7
- package/dist/browser.umd.js +1 -1
- package/dist/index.cjs +13 -9
- package/dist/index.d.cts +17 -13
- package/dist/index.d.mts +17 -13
- package/dist/index.d.ts +17 -13
- package/dist/index.mjs +13 -9
- package/package.json +1 -1
package/dist/index.cjs
CHANGED
|
@@ -457,7 +457,7 @@ const AccountInformationApiAxiosParamCreator = function(configuration) {
|
|
|
457
457
|
};
|
|
458
458
|
},
|
|
459
459
|
/**
|
|
460
|
-
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions 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.
|
|
460
|
+
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages). 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.
|
|
461
461
|
* @summary List all account positions
|
|
462
462
|
* @param {string} accountId
|
|
463
463
|
* @param {string} [userId]
|
|
@@ -1252,7 +1252,7 @@ const AccountInformationApiFp = function(configuration) {
|
|
|
1252
1252
|
});
|
|
1253
1253
|
},
|
|
1254
1254
|
/**
|
|
1255
|
-
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions 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.
|
|
1255
|
+
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages). 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.
|
|
1256
1256
|
* @summary List all account positions
|
|
1257
1257
|
* @param {AccountInformationApiGetAllAccountPositionsRequest<TAuth>} requestParameters Request parameters.
|
|
1258
1258
|
* @param {*} [options] Override http request option.
|
|
@@ -1503,7 +1503,7 @@ const AccountInformationApiFactory = function(configuration, basePath, axios$7)
|
|
|
1503
1503
|
return localVarFp.getAccountBalanceHistory(requestParameters, options).then((request) => request(axios$7, basePath));
|
|
1504
1504
|
},
|
|
1505
1505
|
/**
|
|
1506
|
-
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions 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.
|
|
1506
|
+
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages). 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.
|
|
1507
1507
|
* @summary List all account positions
|
|
1508
1508
|
* @param {AccountInformationApiGetAllAccountPositionsRequest<TAuth>} requestParameters Request parameters.
|
|
1509
1509
|
* @param {*} [options] Override http request option.
|
|
@@ -1635,7 +1635,7 @@ var AccountInformationApiGenerated = class extends BaseAPI {
|
|
|
1635
1635
|
return AccountInformationApiFp(this.configuration).getAccountBalanceHistory(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
1636
1636
|
}
|
|
1637
1637
|
/**
|
|
1638
|
-
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions 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.
|
|
1638
|
+
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages). 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.
|
|
1639
1639
|
* @summary List all account positions
|
|
1640
1640
|
* @param {AccountInformationApiGetAllAccountPositionsRequest<TAuth>} requestParameters Request parameters.
|
|
1641
1641
|
* @param {*} [options] Override http request option.
|
|
@@ -5458,13 +5458,14 @@ const TradingApiAxiosParamCreator = function(configuration) {
|
|
|
5458
5458
|
};
|
|
5459
5459
|
},
|
|
5460
5460
|
/**
|
|
5461
|
-
* 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.
|
|
5461
|
+
* 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. **This Endpoint is deprecated and will cease to return data as of October 1, 2026**
|
|
5462
5462
|
* @summary Get option quote
|
|
5463
5463
|
* @param {string} accountId
|
|
5464
5464
|
* @param {string} symbol The OCC-formatted option symbol.
|
|
5465
5465
|
* @param {string} [userId]
|
|
5466
5466
|
* @param {string} [userSecret]
|
|
5467
5467
|
* @param {*} [options] Override http request option.
|
|
5468
|
+
* @deprecated
|
|
5468
5469
|
* @throws {RequiredError}
|
|
5469
5470
|
*/
|
|
5470
5471
|
getUserAccountOptionQuotes: async (accountId, symbol, userId, userSecret, options = {}) => {
|
|
@@ -6349,10 +6350,11 @@ const TradingApiFp = function(configuration) {
|
|
|
6349
6350
|
});
|
|
6350
6351
|
},
|
|
6351
6352
|
/**
|
|
6352
|
-
* 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.
|
|
6353
|
+
* 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. **This Endpoint is deprecated and will cease to return data as of October 1, 2026**
|
|
6353
6354
|
* @summary Get option quote
|
|
6354
6355
|
* @param {TradingApiGetUserAccountOptionQuotesRequest<TAuth>} requestParameters Request parameters.
|
|
6355
6356
|
* @param {*} [options] Override http request option.
|
|
6357
|
+
* @deprecated
|
|
6356
6358
|
* @throws {RequiredError}
|
|
6357
6359
|
*/
|
|
6358
6360
|
async getUserAccountOptionQuotes(requestParameters, options) {
|
|
@@ -6679,10 +6681,11 @@ const TradingApiFactory = function(configuration, basePath, axios$1) {
|
|
|
6679
6681
|
return localVarFp.getOrderImpact(requestParameters, options).then((request) => request(axios$1, basePath));
|
|
6680
6682
|
},
|
|
6681
6683
|
/**
|
|
6682
|
-
* 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.
|
|
6684
|
+
* 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. **This Endpoint is deprecated and will cease to return data as of October 1, 2026**
|
|
6683
6685
|
* @summary Get option quote
|
|
6684
6686
|
* @param {TradingApiGetUserAccountOptionQuotesRequest<TAuth>} requestParameters Request parameters.
|
|
6685
6687
|
* @param {*} [options] Override http request option.
|
|
6688
|
+
* @deprecated
|
|
6686
6689
|
* @throws {RequiredError}
|
|
6687
6690
|
*/
|
|
6688
6691
|
getUserAccountOptionQuotes(requestParameters, options) {
|
|
@@ -6832,10 +6835,11 @@ var TradingApiGenerated = class extends BaseAPI {
|
|
|
6832
6835
|
return TradingApiFp(this.configuration).getOrderImpact(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
6833
6836
|
}
|
|
6834
6837
|
/**
|
|
6835
|
-
* 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.
|
|
6838
|
+
* 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. **This Endpoint is deprecated and will cease to return data as of October 1, 2026**
|
|
6836
6839
|
* @summary Get option quote
|
|
6837
6840
|
* @param {TradingApiGetUserAccountOptionQuotesRequest<TAuth>} requestParameters Request parameters.
|
|
6838
6841
|
* @param {*} [options] Override http request option.
|
|
6842
|
+
* @deprecated
|
|
6839
6843
|
* @throws {RequiredError}
|
|
6840
6844
|
* @memberof TradingApiGenerated
|
|
6841
6845
|
*/
|
|
@@ -6992,7 +6996,7 @@ var Configuration = class {
|
|
|
6992
6996
|
}
|
|
6993
6997
|
this.basePath = param.basePath;
|
|
6994
6998
|
this.baseOptions = param.baseOptions ?? {};
|
|
6995
|
-
this.userAgent = param.userAgent === void 0 ? "Konfig/12.1.
|
|
6999
|
+
this.userAgent = param.userAgent === void 0 ? "Konfig/12.1.2/typescript" : param.userAgent;
|
|
6996
7000
|
this.formDataCtor = param.formDataCtor;
|
|
6997
7001
|
}
|
|
6998
7002
|
/**
|
package/dist/index.d.cts
CHANGED
|
@@ -4881,11 +4881,11 @@ interface ManualTradeReplaceForm {
|
|
|
4881
4881
|
*/
|
|
4882
4882
|
'brokerage_order_id': string;
|
|
4883
4883
|
/**
|
|
4884
|
-
* The action describes the intent or side of a trade. This is either `BUY` or `SELL
|
|
4885
|
-
* @type {
|
|
4884
|
+
* The action describes the intent or side of a trade. This is either `BUY` or `SELL` for Equity symbols or `BUY_TO_OPEN`, `BUY_TO_CLOSE`, `SELL_TO_OPEN` or `SELL_TO_CLOSE` for Options.
|
|
4885
|
+
* @type {ActionStrictWithOptions}
|
|
4886
4886
|
* @memberof ManualTradeReplaceForm
|
|
4887
4887
|
*/
|
|
4888
|
-
'action':
|
|
4888
|
+
'action': ActionStrictWithOptions;
|
|
4889
4889
|
/**
|
|
4890
4890
|
* The type of order to place. - For `Limit` and `StopLimit` orders, the `price` field is required. - For `Stop` and `StopLimit` orders, the `stop` field is required.
|
|
4891
4891
|
* @type {OrderTypeStrict}
|
|
@@ -4905,7 +4905,7 @@ interface ManualTradeReplaceForm {
|
|
|
4905
4905
|
*/
|
|
4906
4906
|
'price'?: number | null;
|
|
4907
4907
|
/**
|
|
4908
|
-
* The security\'s trading ticker symbol
|
|
4908
|
+
* The security\'s trading ticker symbol. Use the OCC symbol to replace an option order.
|
|
4909
4909
|
* @type {string}
|
|
4910
4910
|
* @memberof ManualTradeReplaceForm
|
|
4911
4911
|
*/
|
|
@@ -5048,7 +5048,7 @@ interface MlegTradeForm {
|
|
|
5048
5048
|
*/
|
|
5049
5049
|
'time_in_force': TimeInForceStrict;
|
|
5050
5050
|
/**
|
|
5051
|
-
* The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT
|
|
5051
|
+
* The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT`, unless `price_effect` is `EVEN` - a net-even order is implicitly priced at 0, so the field may be omitted and must be `0` if sent.
|
|
5052
5052
|
* @type {string}
|
|
5053
5053
|
* @memberof MlegTradeForm
|
|
5054
5054
|
*/
|
|
@@ -7162,7 +7162,7 @@ declare const AccountInformationApiAxiosParamCreator: (configuration?: Configura
|
|
|
7162
7162
|
*/
|
|
7163
7163
|
getAccountBalanceHistory: (accountId: string, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7164
7164
|
/**
|
|
7165
|
-
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions 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.
|
|
7165
|
+
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages). 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.
|
|
7166
7166
|
* @summary List all account positions
|
|
7167
7167
|
* @param {string} accountId
|
|
7168
7168
|
* @param {string} [userId]
|
|
@@ -7289,7 +7289,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
7289
7289
|
*/
|
|
7290
7290
|
getAccountBalanceHistory(requestParameters: AccountInformationApiGetAccountBalanceHistoryRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountValueHistoryResponse>>;
|
|
7291
7291
|
/**
|
|
7292
|
-
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions 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.
|
|
7292
|
+
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages). 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.
|
|
7293
7293
|
* @summary List all account positions
|
|
7294
7294
|
* @param {AccountInformationApiGetAllAccountPositionsRequest<TAuth>} requestParameters Request parameters.
|
|
7295
7295
|
* @param {*} [options] Override http request option.
|
|
@@ -7392,7 +7392,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
7392
7392
|
*/
|
|
7393
7393
|
getAccountBalanceHistory(requestParameters: AccountInformationApiGetAccountBalanceHistoryRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<AccountValueHistoryResponse>;
|
|
7394
7394
|
/**
|
|
7395
|
-
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions 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.
|
|
7395
|
+
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages). 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.
|
|
7396
7396
|
* @summary List all account positions
|
|
7397
7397
|
* @param {AccountInformationApiGetAllAccountPositionsRequest<TAuth>} requestParameters Request parameters.
|
|
7398
7398
|
* @param {*} [options] Override http request option.
|
|
@@ -7846,7 +7846,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
7846
7846
|
*/
|
|
7847
7847
|
getAccountBalanceHistory(requestParameters: AccountInformationApiGetAccountBalanceHistoryRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<AccountValueHistoryResponse, any, {}>>;
|
|
7848
7848
|
/**
|
|
7849
|
-
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions 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.
|
|
7849
|
+
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages). 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.
|
|
7850
7850
|
* @summary List all account positions
|
|
7851
7851
|
* @param {AccountInformationApiGetAllAccountPositionsRequest<TAuth>} requestParameters Request parameters.
|
|
7852
7852
|
* @param {*} [options] Override http request option.
|
|
@@ -9611,13 +9611,14 @@ declare const TradingApiAxiosParamCreator: (configuration?: Configuration<AuthMo
|
|
|
9611
9611
|
*/
|
|
9612
9612
|
getOrderImpact: (manualTradeForm: ManualTradeForm, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9613
9613
|
/**
|
|
9614
|
-
* 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.
|
|
9614
|
+
* 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. **This Endpoint is deprecated and will cease to return data as of October 1, 2026**
|
|
9615
9615
|
* @summary Get option quote
|
|
9616
9616
|
* @param {string} accountId
|
|
9617
9617
|
* @param {string} symbol The OCC-formatted option symbol.
|
|
9618
9618
|
* @param {string} [userId]
|
|
9619
9619
|
* @param {string} [userSecret]
|
|
9620
9620
|
* @param {*} [options] Override http request option.
|
|
9621
|
+
* @deprecated
|
|
9621
9622
|
* @throws {RequiredError}
|
|
9622
9623
|
*/
|
|
9623
9624
|
getUserAccountOptionQuotes: (accountId: string, symbol: string, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -9760,10 +9761,11 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
9760
9761
|
*/
|
|
9761
9762
|
getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManualTradeAndImpact>>;
|
|
9762
9763
|
/**
|
|
9763
|
-
* 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.
|
|
9764
|
+
* 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. **This Endpoint is deprecated and will cease to return data as of October 1, 2026**
|
|
9764
9765
|
* @summary Get option quote
|
|
9765
9766
|
* @param {TradingApiGetUserAccountOptionQuotesRequest<TAuth>} requestParameters Request parameters.
|
|
9766
9767
|
* @param {*} [options] Override http request option.
|
|
9768
|
+
* @deprecated
|
|
9767
9769
|
* @throws {RequiredError}
|
|
9768
9770
|
*/
|
|
9769
9771
|
getUserAccountOptionQuotes(requestParameters: TradingApiGetUserAccountOptionQuotesRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionQuote>>;
|
|
@@ -9878,10 +9880,11 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
9878
9880
|
*/
|
|
9879
9881
|
getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<ManualTradeAndImpact>;
|
|
9880
9882
|
/**
|
|
9881
|
-
* 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.
|
|
9883
|
+
* 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. **This Endpoint is deprecated and will cease to return data as of October 1, 2026**
|
|
9882
9884
|
* @summary Get option quote
|
|
9883
9885
|
* @param {TradingApiGetUserAccountOptionQuotesRequest<TAuth>} requestParameters Request parameters.
|
|
9884
9886
|
* @param {*} [options] Override http request option.
|
|
9887
|
+
* @deprecated
|
|
9885
9888
|
* @throws {RequiredError}
|
|
9886
9889
|
*/
|
|
9887
9890
|
getUserAccountOptionQuotes(requestParameters: TradingApiGetUserAccountOptionQuotesRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<OptionQuote>;
|
|
@@ -10374,10 +10377,11 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
10374
10377
|
*/
|
|
10375
10378
|
getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<ManualTradeAndImpact, any, {}>>;
|
|
10376
10379
|
/**
|
|
10377
|
-
* 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.
|
|
10380
|
+
* 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. **This Endpoint is deprecated and will cease to return data as of October 1, 2026**
|
|
10378
10381
|
* @summary Get option quote
|
|
10379
10382
|
* @param {TradingApiGetUserAccountOptionQuotesRequest<TAuth>} requestParameters Request parameters.
|
|
10380
10383
|
* @param {*} [options] Override http request option.
|
|
10384
|
+
* @deprecated
|
|
10381
10385
|
* @throws {RequiredError}
|
|
10382
10386
|
* @memberof TradingApiGenerated
|
|
10383
10387
|
*/
|
package/dist/index.d.mts
CHANGED
|
@@ -4881,11 +4881,11 @@ interface ManualTradeReplaceForm {
|
|
|
4881
4881
|
*/
|
|
4882
4882
|
'brokerage_order_id': string;
|
|
4883
4883
|
/**
|
|
4884
|
-
* The action describes the intent or side of a trade. This is either `BUY` or `SELL
|
|
4885
|
-
* @type {
|
|
4884
|
+
* The action describes the intent or side of a trade. This is either `BUY` or `SELL` for Equity symbols or `BUY_TO_OPEN`, `BUY_TO_CLOSE`, `SELL_TO_OPEN` or `SELL_TO_CLOSE` for Options.
|
|
4885
|
+
* @type {ActionStrictWithOptions}
|
|
4886
4886
|
* @memberof ManualTradeReplaceForm
|
|
4887
4887
|
*/
|
|
4888
|
-
'action':
|
|
4888
|
+
'action': ActionStrictWithOptions;
|
|
4889
4889
|
/**
|
|
4890
4890
|
* The type of order to place. - For `Limit` and `StopLimit` orders, the `price` field is required. - For `Stop` and `StopLimit` orders, the `stop` field is required.
|
|
4891
4891
|
* @type {OrderTypeStrict}
|
|
@@ -4905,7 +4905,7 @@ interface ManualTradeReplaceForm {
|
|
|
4905
4905
|
*/
|
|
4906
4906
|
'price'?: number | null;
|
|
4907
4907
|
/**
|
|
4908
|
-
* The security\'s trading ticker symbol
|
|
4908
|
+
* The security\'s trading ticker symbol. Use the OCC symbol to replace an option order.
|
|
4909
4909
|
* @type {string}
|
|
4910
4910
|
* @memberof ManualTradeReplaceForm
|
|
4911
4911
|
*/
|
|
@@ -5048,7 +5048,7 @@ interface MlegTradeForm {
|
|
|
5048
5048
|
*/
|
|
5049
5049
|
'time_in_force': TimeInForceStrict;
|
|
5050
5050
|
/**
|
|
5051
|
-
* The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT
|
|
5051
|
+
* The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT`, unless `price_effect` is `EVEN` - a net-even order is implicitly priced at 0, so the field may be omitted and must be `0` if sent.
|
|
5052
5052
|
* @type {string}
|
|
5053
5053
|
* @memberof MlegTradeForm
|
|
5054
5054
|
*/
|
|
@@ -7162,7 +7162,7 @@ declare const AccountInformationApiAxiosParamCreator: (configuration?: Configura
|
|
|
7162
7162
|
*/
|
|
7163
7163
|
getAccountBalanceHistory: (accountId: string, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7164
7164
|
/**
|
|
7165
|
-
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions 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.
|
|
7165
|
+
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages). 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.
|
|
7166
7166
|
* @summary List all account positions
|
|
7167
7167
|
* @param {string} accountId
|
|
7168
7168
|
* @param {string} [userId]
|
|
@@ -7289,7 +7289,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
7289
7289
|
*/
|
|
7290
7290
|
getAccountBalanceHistory(requestParameters: AccountInformationApiGetAccountBalanceHistoryRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountValueHistoryResponse>>;
|
|
7291
7291
|
/**
|
|
7292
|
-
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions 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.
|
|
7292
|
+
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages). 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.
|
|
7293
7293
|
* @summary List all account positions
|
|
7294
7294
|
* @param {AccountInformationApiGetAllAccountPositionsRequest<TAuth>} requestParameters Request parameters.
|
|
7295
7295
|
* @param {*} [options] Override http request option.
|
|
@@ -7392,7 +7392,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
7392
7392
|
*/
|
|
7393
7393
|
getAccountBalanceHistory(requestParameters: AccountInformationApiGetAccountBalanceHistoryRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<AccountValueHistoryResponse>;
|
|
7394
7394
|
/**
|
|
7395
|
-
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions 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.
|
|
7395
|
+
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages). 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.
|
|
7396
7396
|
* @summary List all account positions
|
|
7397
7397
|
* @param {AccountInformationApiGetAllAccountPositionsRequest<TAuth>} requestParameters Request parameters.
|
|
7398
7398
|
* @param {*} [options] Override http request option.
|
|
@@ -7846,7 +7846,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
7846
7846
|
*/
|
|
7847
7847
|
getAccountBalanceHistory(requestParameters: AccountInformationApiGetAccountBalanceHistoryRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<AccountValueHistoryResponse, any, {}>>;
|
|
7848
7848
|
/**
|
|
7849
|
-
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions 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.
|
|
7849
|
+
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages). 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.
|
|
7850
7850
|
* @summary List all account positions
|
|
7851
7851
|
* @param {AccountInformationApiGetAllAccountPositionsRequest<TAuth>} requestParameters Request parameters.
|
|
7852
7852
|
* @param {*} [options] Override http request option.
|
|
@@ -9611,13 +9611,14 @@ declare const TradingApiAxiosParamCreator: (configuration?: Configuration<AuthMo
|
|
|
9611
9611
|
*/
|
|
9612
9612
|
getOrderImpact: (manualTradeForm: ManualTradeForm, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9613
9613
|
/**
|
|
9614
|
-
* 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.
|
|
9614
|
+
* 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. **This Endpoint is deprecated and will cease to return data as of October 1, 2026**
|
|
9615
9615
|
* @summary Get option quote
|
|
9616
9616
|
* @param {string} accountId
|
|
9617
9617
|
* @param {string} symbol The OCC-formatted option symbol.
|
|
9618
9618
|
* @param {string} [userId]
|
|
9619
9619
|
* @param {string} [userSecret]
|
|
9620
9620
|
* @param {*} [options] Override http request option.
|
|
9621
|
+
* @deprecated
|
|
9621
9622
|
* @throws {RequiredError}
|
|
9622
9623
|
*/
|
|
9623
9624
|
getUserAccountOptionQuotes: (accountId: string, symbol: string, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -9760,10 +9761,11 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
9760
9761
|
*/
|
|
9761
9762
|
getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManualTradeAndImpact>>;
|
|
9762
9763
|
/**
|
|
9763
|
-
* 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.
|
|
9764
|
+
* 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. **This Endpoint is deprecated and will cease to return data as of October 1, 2026**
|
|
9764
9765
|
* @summary Get option quote
|
|
9765
9766
|
* @param {TradingApiGetUserAccountOptionQuotesRequest<TAuth>} requestParameters Request parameters.
|
|
9766
9767
|
* @param {*} [options] Override http request option.
|
|
9768
|
+
* @deprecated
|
|
9767
9769
|
* @throws {RequiredError}
|
|
9768
9770
|
*/
|
|
9769
9771
|
getUserAccountOptionQuotes(requestParameters: TradingApiGetUserAccountOptionQuotesRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionQuote>>;
|
|
@@ -9878,10 +9880,11 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
9878
9880
|
*/
|
|
9879
9881
|
getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<ManualTradeAndImpact>;
|
|
9880
9882
|
/**
|
|
9881
|
-
* 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.
|
|
9883
|
+
* 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. **This Endpoint is deprecated and will cease to return data as of October 1, 2026**
|
|
9882
9884
|
* @summary Get option quote
|
|
9883
9885
|
* @param {TradingApiGetUserAccountOptionQuotesRequest<TAuth>} requestParameters Request parameters.
|
|
9884
9886
|
* @param {*} [options] Override http request option.
|
|
9887
|
+
* @deprecated
|
|
9885
9888
|
* @throws {RequiredError}
|
|
9886
9889
|
*/
|
|
9887
9890
|
getUserAccountOptionQuotes(requestParameters: TradingApiGetUserAccountOptionQuotesRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<OptionQuote>;
|
|
@@ -10374,10 +10377,11 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
10374
10377
|
*/
|
|
10375
10378
|
getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<ManualTradeAndImpact, any, {}>>;
|
|
10376
10379
|
/**
|
|
10377
|
-
* 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.
|
|
10380
|
+
* 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. **This Endpoint is deprecated and will cease to return data as of October 1, 2026**
|
|
10378
10381
|
* @summary Get option quote
|
|
10379
10382
|
* @param {TradingApiGetUserAccountOptionQuotesRequest<TAuth>} requestParameters Request parameters.
|
|
10380
10383
|
* @param {*} [options] Override http request option.
|
|
10384
|
+
* @deprecated
|
|
10381
10385
|
* @throws {RequiredError}
|
|
10382
10386
|
* @memberof TradingApiGenerated
|
|
10383
10387
|
*/
|
package/dist/index.d.ts
CHANGED
|
@@ -4881,11 +4881,11 @@ interface ManualTradeReplaceForm {
|
|
|
4881
4881
|
*/
|
|
4882
4882
|
'brokerage_order_id': string;
|
|
4883
4883
|
/**
|
|
4884
|
-
* The action describes the intent or side of a trade. This is either `BUY` or `SELL
|
|
4885
|
-
* @type {
|
|
4884
|
+
* The action describes the intent or side of a trade. This is either `BUY` or `SELL` for Equity symbols or `BUY_TO_OPEN`, `BUY_TO_CLOSE`, `SELL_TO_OPEN` or `SELL_TO_CLOSE` for Options.
|
|
4885
|
+
* @type {ActionStrictWithOptions}
|
|
4886
4886
|
* @memberof ManualTradeReplaceForm
|
|
4887
4887
|
*/
|
|
4888
|
-
'action':
|
|
4888
|
+
'action': ActionStrictWithOptions;
|
|
4889
4889
|
/**
|
|
4890
4890
|
* The type of order to place. - For `Limit` and `StopLimit` orders, the `price` field is required. - For `Stop` and `StopLimit` orders, the `stop` field is required.
|
|
4891
4891
|
* @type {OrderTypeStrict}
|
|
@@ -4905,7 +4905,7 @@ interface ManualTradeReplaceForm {
|
|
|
4905
4905
|
*/
|
|
4906
4906
|
'price'?: number | null;
|
|
4907
4907
|
/**
|
|
4908
|
-
* The security\'s trading ticker symbol
|
|
4908
|
+
* The security\'s trading ticker symbol. Use the OCC symbol to replace an option order.
|
|
4909
4909
|
* @type {string}
|
|
4910
4910
|
* @memberof ManualTradeReplaceForm
|
|
4911
4911
|
*/
|
|
@@ -5048,7 +5048,7 @@ interface MlegTradeForm {
|
|
|
5048
5048
|
*/
|
|
5049
5049
|
'time_in_force': TimeInForceStrict;
|
|
5050
5050
|
/**
|
|
5051
|
-
* The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT
|
|
5051
|
+
* The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT`, unless `price_effect` is `EVEN` - a net-even order is implicitly priced at 0, so the field may be omitted and must be `0` if sent.
|
|
5052
5052
|
* @type {string}
|
|
5053
5053
|
* @memberof MlegTradeForm
|
|
5054
5054
|
*/
|
|
@@ -7162,7 +7162,7 @@ declare const AccountInformationApiAxiosParamCreator: (configuration?: Configura
|
|
|
7162
7162
|
*/
|
|
7163
7163
|
getAccountBalanceHistory: (accountId: string, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7164
7164
|
/**
|
|
7165
|
-
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions 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.
|
|
7165
|
+
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages). 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.
|
|
7166
7166
|
* @summary List all account positions
|
|
7167
7167
|
* @param {string} accountId
|
|
7168
7168
|
* @param {string} [userId]
|
|
@@ -7289,7 +7289,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
7289
7289
|
*/
|
|
7290
7290
|
getAccountBalanceHistory(requestParameters: AccountInformationApiGetAccountBalanceHistoryRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountValueHistoryResponse>>;
|
|
7291
7291
|
/**
|
|
7292
|
-
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions 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.
|
|
7292
|
+
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages). 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.
|
|
7293
7293
|
* @summary List all account positions
|
|
7294
7294
|
* @param {AccountInformationApiGetAllAccountPositionsRequest<TAuth>} requestParameters Request parameters.
|
|
7295
7295
|
* @param {*} [options] Override http request option.
|
|
@@ -7392,7 +7392,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
7392
7392
|
*/
|
|
7393
7393
|
getAccountBalanceHistory(requestParameters: AccountInformationApiGetAccountBalanceHistoryRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<AccountValueHistoryResponse>;
|
|
7394
7394
|
/**
|
|
7395
|
-
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions 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.
|
|
7395
|
+
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages). 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.
|
|
7396
7396
|
* @summary List all account positions
|
|
7397
7397
|
* @param {AccountInformationApiGetAllAccountPositionsRequest<TAuth>} requestParameters Request parameters.
|
|
7398
7398
|
* @param {*} [options] Override http request option.
|
|
@@ -7846,7 +7846,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
7846
7846
|
*/
|
|
7847
7847
|
getAccountBalanceHistory(requestParameters: AccountInformationApiGetAccountBalanceHistoryRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<AccountValueHistoryResponse, any, {}>>;
|
|
7848
7848
|
/**
|
|
7849
|
-
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions 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.
|
|
7849
|
+
* 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, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages). 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.
|
|
7850
7850
|
* @summary List all account positions
|
|
7851
7851
|
* @param {AccountInformationApiGetAllAccountPositionsRequest<TAuth>} requestParameters Request parameters.
|
|
7852
7852
|
* @param {*} [options] Override http request option.
|
|
@@ -9611,13 +9611,14 @@ declare const TradingApiAxiosParamCreator: (configuration?: Configuration<AuthMo
|
|
|
9611
9611
|
*/
|
|
9612
9612
|
getOrderImpact: (manualTradeForm: ManualTradeForm, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9613
9613
|
/**
|
|
9614
|
-
* 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.
|
|
9614
|
+
* 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. **This Endpoint is deprecated and will cease to return data as of October 1, 2026**
|
|
9615
9615
|
* @summary Get option quote
|
|
9616
9616
|
* @param {string} accountId
|
|
9617
9617
|
* @param {string} symbol The OCC-formatted option symbol.
|
|
9618
9618
|
* @param {string} [userId]
|
|
9619
9619
|
* @param {string} [userSecret]
|
|
9620
9620
|
* @param {*} [options] Override http request option.
|
|
9621
|
+
* @deprecated
|
|
9621
9622
|
* @throws {RequiredError}
|
|
9622
9623
|
*/
|
|
9623
9624
|
getUserAccountOptionQuotes: (accountId: string, symbol: string, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -9760,10 +9761,11 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
9760
9761
|
*/
|
|
9761
9762
|
getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManualTradeAndImpact>>;
|
|
9762
9763
|
/**
|
|
9763
|
-
* 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.
|
|
9764
|
+
* 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. **This Endpoint is deprecated and will cease to return data as of October 1, 2026**
|
|
9764
9765
|
* @summary Get option quote
|
|
9765
9766
|
* @param {TradingApiGetUserAccountOptionQuotesRequest<TAuth>} requestParameters Request parameters.
|
|
9766
9767
|
* @param {*} [options] Override http request option.
|
|
9768
|
+
* @deprecated
|
|
9767
9769
|
* @throws {RequiredError}
|
|
9768
9770
|
*/
|
|
9769
9771
|
getUserAccountOptionQuotes(requestParameters: TradingApiGetUserAccountOptionQuotesRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionQuote>>;
|
|
@@ -9878,10 +9880,11 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
9878
9880
|
*/
|
|
9879
9881
|
getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<ManualTradeAndImpact>;
|
|
9880
9882
|
/**
|
|
9881
|
-
* 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.
|
|
9883
|
+
* 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. **This Endpoint is deprecated and will cease to return data as of October 1, 2026**
|
|
9882
9884
|
* @summary Get option quote
|
|
9883
9885
|
* @param {TradingApiGetUserAccountOptionQuotesRequest<TAuth>} requestParameters Request parameters.
|
|
9884
9886
|
* @param {*} [options] Override http request option.
|
|
9887
|
+
* @deprecated
|
|
9885
9888
|
* @throws {RequiredError}
|
|
9886
9889
|
*/
|
|
9887
9890
|
getUserAccountOptionQuotes(requestParameters: TradingApiGetUserAccountOptionQuotesRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<OptionQuote>;
|
|
@@ -10374,10 +10377,11 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
10374
10377
|
*/
|
|
10375
10378
|
getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<ManualTradeAndImpact, any, {}>>;
|
|
10376
10379
|
/**
|
|
10377
|
-
* 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.
|
|
10380
|
+
* 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. **This Endpoint is deprecated and will cease to return data as of October 1, 2026**
|
|
10378
10381
|
* @summary Get option quote
|
|
10379
10382
|
* @param {TradingApiGetUserAccountOptionQuotesRequest<TAuth>} requestParameters Request parameters.
|
|
10380
10383
|
* @param {*} [options] Override http request option.
|
|
10384
|
+
* @deprecated
|
|
10381
10385
|
* @throws {RequiredError}
|
|
10382
10386
|
* @memberof TradingApiGenerated
|
|
10383
10387
|
*/
|