snaptrade-typescript-sdk 10.0.9 → 10.0.11
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 +3 -3
- package/dist/browser.umd.js +1 -1
- package/dist/index.cjs +9 -9
- package/dist/index.d.cts +125 -16
- package/dist/index.d.mts +125 -16
- package/dist/index.d.ts +125 -16
- package/dist/index.mjs +9 -9
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -243,7 +243,7 @@ interface Account {
|
|
|
243
243
|
*/
|
|
244
244
|
'id': string;
|
|
245
245
|
/**
|
|
246
|
-
* Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade.
|
|
246
|
+
* Unique identifier for the connection (brokerage_authorization_id). This is the UUID used to reference the connection in SnapTrade.
|
|
247
247
|
* @type {string}
|
|
248
248
|
* @memberof Account
|
|
249
249
|
*/
|
|
@@ -835,7 +835,7 @@ interface Position {
|
|
|
835
835
|
*/
|
|
836
836
|
'cash_equivalent'?: boolean | null;
|
|
837
837
|
/**
|
|
838
|
-
* List of tax lots for the given position (disabled by default, contact support if needed)
|
|
838
|
+
* List of tax lots for the given position (disabled by default, only available on paid plans, contact support if needed)
|
|
839
839
|
* @type {Array<TaxLot>}
|
|
840
840
|
* @memberof Position
|
|
841
841
|
*/
|
|
@@ -996,7 +996,7 @@ interface Brokerage {
|
|
|
996
996
|
interface BrokerageAuthorization {
|
|
997
997
|
[key: string]: any;
|
|
998
998
|
/**
|
|
999
|
-
* Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade.
|
|
999
|
+
* Unique identifier for the connection (brokerage_authorization_id). This is the UUID used to reference the connection in SnapTrade.
|
|
1000
1000
|
* @type {string}
|
|
1001
1001
|
* @memberof BrokerageAuthorization
|
|
1002
1002
|
*/
|
|
@@ -1059,6 +1059,12 @@ interface BrokerageAuthorization {
|
|
|
1059
1059
|
* @memberof BrokerageAuthorization
|
|
1060
1060
|
*/
|
|
1061
1061
|
'is_eligible_for_payout'?: boolean;
|
|
1062
|
+
/**
|
|
1063
|
+
* Possible values include: - realtime - delayed Indicates whether SnapTrade will provide delayed or realtime data for this connection. `delayed` means SnapTrade uses cached data for the connection because of the customer\'s plan, or because of brokerage limitations. `realtime` means SnapTrade retrieves current data from the brokerage during API calls. See the \"Cache Expiry of Holdings\" column on the Holdings tab at https://support.snaptrade.com/brokerages for which val
|
|
1064
|
+
* @type {string}
|
|
1065
|
+
* @memberof BrokerageAuthorization
|
|
1066
|
+
*/
|
|
1067
|
+
'data_freshness_mode'?: string;
|
|
1062
1068
|
}
|
|
1063
1069
|
//#endregion
|
|
1064
1070
|
//#region models/snap-trade-holdings-account.d.ts
|
|
@@ -2839,7 +2845,7 @@ interface AccountPosition {
|
|
|
2839
2845
|
*/
|
|
2840
2846
|
'cash_equivalent'?: boolean;
|
|
2841
2847
|
/**
|
|
2842
|
-
*
|
|
2848
|
+
* List of tax lots for the given position (disabled by default, only available on paid plans, contact support if needed)
|
|
2843
2849
|
* @type {Array<TaxLot>}
|
|
2844
2850
|
* @memberof AccountPosition
|
|
2845
2851
|
*/
|
|
@@ -2888,7 +2894,7 @@ interface AccountSimple {
|
|
|
2888
2894
|
//#endregion
|
|
2889
2895
|
//#region models/account-universal-activity-currency.d.ts
|
|
2890
2896
|
/**
|
|
2891
|
-
* The currency in which the transaction `price` and `
|
|
2897
|
+
* The currency in which the transaction `price`, `amount`, and `fee` are denominated. This is `null` when those values are denominated in `currency_universal_symbol`.
|
|
2892
2898
|
* @export
|
|
2893
2899
|
* @interface AccountUniversalActivityCurrency
|
|
2894
2900
|
*/
|
|
@@ -2913,6 +2919,69 @@ interface AccountUniversalActivityCurrency {
|
|
|
2913
2919
|
'name'?: string;
|
|
2914
2920
|
}
|
|
2915
2921
|
//#endregion
|
|
2922
|
+
//#region models/account-universal-activity-currency-universal-symbol.d.ts
|
|
2923
|
+
/**
|
|
2924
|
+
* The quote security for the transaction when `price`, `amount`, and `fee` are denominated in a security instead of a fiat currency. This is most common for cryptocurrency trades. The field is `null` when the transaction is denominated in `currency`.
|
|
2925
|
+
* @export
|
|
2926
|
+
* @interface AccountUniversalActivityCurrencyUniversalSymbol
|
|
2927
|
+
*/
|
|
2928
|
+
interface AccountUniversalActivityCurrencyUniversalSymbol {
|
|
2929
|
+
/**
|
|
2930
|
+
* Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
2931
|
+
* @type {string}
|
|
2932
|
+
* @memberof AccountUniversalActivityCurrencyUniversalSymbol
|
|
2933
|
+
*/
|
|
2934
|
+
'id'?: string;
|
|
2935
|
+
/**
|
|
2936
|
+
* The security\'s trading ticker symbol. For example \"AAPL\" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a \'.TO\' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix.
|
|
2937
|
+
* @type {string}
|
|
2938
|
+
* @memberof AccountUniversalActivityCurrencyUniversalSymbol
|
|
2939
|
+
*/
|
|
2940
|
+
'symbol'?: string;
|
|
2941
|
+
/**
|
|
2942
|
+
* The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is \"VAB.TO\", then `raw_symbol` is \"VAB\".
|
|
2943
|
+
* @type {string}
|
|
2944
|
+
* @memberof AccountUniversalActivityCurrencyUniversalSymbol
|
|
2945
|
+
*/
|
|
2946
|
+
'raw_symbol'?: string;
|
|
2947
|
+
/**
|
|
2948
|
+
* A human-readable description of the security. This is usually the company name or ETF name.
|
|
2949
|
+
* @type {string}
|
|
2950
|
+
* @memberof AccountUniversalActivityCurrencyUniversalSymbol
|
|
2951
|
+
*/
|
|
2952
|
+
'description'?: string | null;
|
|
2953
|
+
/**
|
|
2954
|
+
*
|
|
2955
|
+
* @type {SymbolCurrency}
|
|
2956
|
+
* @memberof AccountUniversalActivityCurrencyUniversalSymbol
|
|
2957
|
+
*/
|
|
2958
|
+
'currency'?: SymbolCurrency;
|
|
2959
|
+
/**
|
|
2960
|
+
*
|
|
2961
|
+
* @type {SymbolExchange}
|
|
2962
|
+
* @memberof AccountUniversalActivityCurrencyUniversalSymbol
|
|
2963
|
+
*/
|
|
2964
|
+
'exchange'?: SymbolExchange;
|
|
2965
|
+
/**
|
|
2966
|
+
*
|
|
2967
|
+
* @type {SecurityType}
|
|
2968
|
+
* @memberof AccountUniversalActivityCurrencyUniversalSymbol
|
|
2969
|
+
*/
|
|
2970
|
+
'type'?: SecurityType;
|
|
2971
|
+
/**
|
|
2972
|
+
* This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. This value should be the same as the `figi_code` in the `figi_instrument` child property.
|
|
2973
|
+
* @type {string}
|
|
2974
|
+
* @memberof AccountUniversalActivityCurrencyUniversalSymbol
|
|
2975
|
+
*/
|
|
2976
|
+
'figi_code'?: string | null;
|
|
2977
|
+
/**
|
|
2978
|
+
*
|
|
2979
|
+
* @type {StockInstrumentFigiInstrument}
|
|
2980
|
+
* @memberof AccountUniversalActivityCurrencyUniversalSymbol
|
|
2981
|
+
*/
|
|
2982
|
+
'figi_instrument'?: StockInstrumentFigiInstrument | null;
|
|
2983
|
+
}
|
|
2984
|
+
//#endregion
|
|
2916
2985
|
//#region models/account-universal-activity-option-symbol.d.ts
|
|
2917
2986
|
/**
|
|
2918
2987
|
* The option security for the transaction. The field is `null` if the transaction is not related to an option security (like a deposit, withdrawal, fee, etc). SnapTrade does a best effort to map the brokerage\'s option symbol. In cases where the brokerage option symbol is not recognized, the field will be set to `null`.
|
|
@@ -3048,6 +3117,12 @@ interface AccountUniversalActivity {
|
|
|
3048
3117
|
* @memberof AccountUniversalActivity
|
|
3049
3118
|
*/
|
|
3050
3119
|
'symbol'?: AccountUniversalActivitySymbol | null;
|
|
3120
|
+
/**
|
|
3121
|
+
*
|
|
3122
|
+
* @type {AccountUniversalActivityCurrencyUniversalSymbol}
|
|
3123
|
+
* @memberof AccountUniversalActivity
|
|
3124
|
+
*/
|
|
3125
|
+
'currency_universal_symbol'?: AccountUniversalActivityCurrencyUniversalSymbol | null;
|
|
3051
3126
|
/**
|
|
3052
3127
|
*
|
|
3053
3128
|
* @type {AccountUniversalActivityOptionSymbol}
|
|
@@ -3077,7 +3152,7 @@ interface AccountUniversalActivity {
|
|
|
3077
3152
|
* @type {AccountUniversalActivityCurrency}
|
|
3078
3153
|
* @memberof AccountUniversalActivity
|
|
3079
3154
|
*/
|
|
3080
|
-
'currency'?: AccountUniversalActivityCurrency;
|
|
3155
|
+
'currency'?: AccountUniversalActivityCurrency | null;
|
|
3081
3156
|
/**
|
|
3082
3157
|
* A string representing the type of transaction. SnapTrade does a best effort to categorize the brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead of cash - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `TAX` - A tax related fee. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of asset(s) from one account to another. - `EXTERNAL_ASSET_TRANSFER_IN` - Incoming transfer of an asset from an external account to this account. - `EXTERNAL_ASSET_TRANSFER_OUT` - Outgoing transfer of an asset from this account to an external account. - `SPLIT` - A stock share split. - `ADJUSTMENT` - A one time adjustment of the account\'s cash balance or shares of an asset
|
|
3083
3158
|
* @type {string}
|
|
@@ -4980,6 +5055,34 @@ interface Model425FailedRequestResponse {
|
|
|
4980
5055
|
'code'?: any;
|
|
4981
5056
|
}
|
|
4982
5057
|
//#endregion
|
|
5058
|
+
//#region models/model429-too-many-requests-response.d.ts
|
|
5059
|
+
/**
|
|
5060
|
+
* Example for a rate-limited request response
|
|
5061
|
+
* @export
|
|
5062
|
+
* @interface Model429TooManyRequestsResponse
|
|
5063
|
+
*/
|
|
5064
|
+
interface Model429TooManyRequestsResponse {
|
|
5065
|
+
[key: string]: any;
|
|
5066
|
+
/**
|
|
5067
|
+
*
|
|
5068
|
+
* @type {any}
|
|
5069
|
+
* @memberof Model429TooManyRequestsResponse
|
|
5070
|
+
*/
|
|
5071
|
+
'detail'?: any;
|
|
5072
|
+
/**
|
|
5073
|
+
*
|
|
5074
|
+
* @type {any}
|
|
5075
|
+
* @memberof Model429TooManyRequestsResponse
|
|
5076
|
+
*/
|
|
5077
|
+
'status_code'?: any;
|
|
5078
|
+
/**
|
|
5079
|
+
*
|
|
5080
|
+
* @type {any}
|
|
5081
|
+
* @memberof Model429TooManyRequestsResponse
|
|
5082
|
+
*/
|
|
5083
|
+
'code'?: any;
|
|
5084
|
+
}
|
|
5085
|
+
//#endregion
|
|
4983
5086
|
//#region models/model500-unexpected-exception-response.d.ts
|
|
4984
5087
|
/**
|
|
4985
5088
|
* Example for a response that failed for unexpected reasons
|
|
@@ -6608,6 +6711,12 @@ interface UniversalActivity {
|
|
|
6608
6711
|
* @memberof UniversalActivity
|
|
6609
6712
|
*/
|
|
6610
6713
|
'symbol'?: AccountUniversalActivitySymbol | null;
|
|
6714
|
+
/**
|
|
6715
|
+
*
|
|
6716
|
+
* @type {AccountUniversalActivityCurrencyUniversalSymbol}
|
|
6717
|
+
* @memberof UniversalActivity
|
|
6718
|
+
*/
|
|
6719
|
+
'currency_universal_symbol'?: AccountUniversalActivityCurrencyUniversalSymbol | null;
|
|
6611
6720
|
/**
|
|
6612
6721
|
*
|
|
6613
6722
|
* @type {AccountUniversalActivityOptionSymbol}
|
|
@@ -6637,7 +6746,7 @@ interface UniversalActivity {
|
|
|
6637
6746
|
* @type {AccountUniversalActivityCurrency}
|
|
6638
6747
|
* @memberof UniversalActivity
|
|
6639
6748
|
*/
|
|
6640
|
-
'currency'?: AccountUniversalActivityCurrency;
|
|
6749
|
+
'currency'?: AccountUniversalActivityCurrency | null;
|
|
6641
6750
|
/**
|
|
6642
6751
|
* A string representing the type of transaction. SnapTrade does a best effort to categorize the brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `OPTIONEXPIRATION` - Option expiration event. `option_symbol` contains the related option contract info. - `OPTIONASSIGNMENT` - Option assignment event. `option_symbol` contains the related option contract info. - `OPTIONEXERCISE` - Option exercise event. `option_symbol` contains the related option contract info.
|
|
6643
6752
|
* @type {string}
|
|
@@ -8022,7 +8131,7 @@ declare const ConnectionsApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
8022
8131
|
*/
|
|
8023
8132
|
listBrokerageAuthorizations: (userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8024
8133
|
/**
|
|
8025
|
-
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Personal and Pay as you
|
|
8134
|
+
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Real-time plans (Personal and Pay as you go) unless the connection is delayed. Real-time connections do not benefit from this feature since data is refreshed when calls are made. Refer to the `data_freshness_mode` field on a connection to determine this.**
|
|
8026
8135
|
* @summary Refresh holdings for a connection
|
|
8027
8136
|
* @param {string} authorizationId
|
|
8028
8137
|
* @param {string} userId
|
|
@@ -8119,7 +8228,7 @@ declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
8119
8228
|
*/
|
|
8120
8229
|
listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BrokerageAuthorization>>>;
|
|
8121
8230
|
/**
|
|
8122
|
-
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Personal and Pay as you
|
|
8231
|
+
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Real-time plans (Personal and Pay as you go) unless the connection is delayed. Real-time connections do not benefit from this feature since data is refreshed when calls are made. Refer to the `data_freshness_mode` field on a connection to determine this.**
|
|
8123
8232
|
* @summary Refresh holdings for a connection
|
|
8124
8233
|
* @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
|
|
8125
8234
|
* @param {*} [options] Override http request option.
|
|
@@ -8205,7 +8314,7 @@ declare const ConnectionsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
8205
8314
|
*/
|
|
8206
8315
|
listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<BrokerageAuthorization>>;
|
|
8207
8316
|
/**
|
|
8208
|
-
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Personal and Pay as you
|
|
8317
|
+
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Real-time plans (Personal and Pay as you go) unless the connection is delayed. Real-time connections do not benefit from this feature since data is refreshed when calls are made. Refer to the `data_freshness_mode` field on a connection to determine this.**
|
|
8209
8318
|
* @summary Refresh holdings for a connection
|
|
8210
8319
|
* @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
|
|
8211
8320
|
* @param {*} [options] Override http request option.
|
|
@@ -8548,7 +8657,7 @@ declare class ConnectionsApiGenerated extends BaseAPI {
|
|
|
8548
8657
|
*/
|
|
8549
8658
|
listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<BrokerageAuthorization[], any, {}>>;
|
|
8550
8659
|
/**
|
|
8551
|
-
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Personal and Pay as you
|
|
8660
|
+
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Real-time plans (Personal and Pay as you go) unless the connection is delayed. Real-time connections do not benefit from this feature since data is refreshed when calls are made. Refer to the `data_freshness_mode` field on a connection to determine this.**
|
|
8552
8661
|
* @summary Refresh holdings for a connection
|
|
8553
8662
|
* @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
|
|
8554
8663
|
* @param {*} [options] Override http request option.
|
|
@@ -9639,7 +9748,7 @@ declare const TradingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
9639
9748
|
*/
|
|
9640
9749
|
placeBracketOrder: (accountId: string, userId: string, userSecret: string, manualTradeFormBracket: ManualTradeFormBracket, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9641
9750
|
/**
|
|
9642
|
-
* Places a complex conditional order (OCO, OTO, or OTOCO).
|
|
9751
|
+
* Places a complex conditional order (OCO, OTO, or OTOCO). Only supported on certain brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for details on which brokerages support complex orders and which types they support. - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
|
|
9643
9752
|
* @summary Place complex order
|
|
9644
9753
|
* @param {string} accountId The ID of the account to execute the trade on.
|
|
9645
9754
|
* @param {string} userId
|
|
@@ -9799,7 +9908,7 @@ declare const TradingApiFp: (configuration?: Configuration) => {
|
|
|
9799
9908
|
*/
|
|
9800
9909
|
placeBracketOrder(requestParameters: TradingApiPlaceBracketOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
|
|
9801
9910
|
/**
|
|
9802
|
-
* Places a complex conditional order (OCO, OTO, or OTOCO).
|
|
9911
|
+
* Places a complex conditional order (OCO, OTO, or OTOCO). Only supported on certain brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for details on which brokerages support complex orders and which types they support. - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
|
|
9803
9912
|
* @summary Place complex order
|
|
9804
9913
|
* @param {TradingApiPlaceComplexOrderRequest} requestParameters Request parameters.
|
|
9805
9914
|
* @param {*} [options] Override http request option.
|
|
@@ -9935,7 +10044,7 @@ declare const TradingApiFactory: (configuration?: Configuration, basePath?: stri
|
|
|
9935
10044
|
*/
|
|
9936
10045
|
placeBracketOrder(requestParameters: TradingApiPlaceBracketOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
|
|
9937
10046
|
/**
|
|
9938
|
-
* Places a complex conditional order (OCO, OTO, or OTOCO).
|
|
10047
|
+
* Places a complex conditional order (OCO, OTO, or OTOCO). Only supported on certain brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for details on which brokerages support complex orders and which types they support. - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
|
|
9939
10048
|
* @summary Place complex order
|
|
9940
10049
|
* @param {TradingApiPlaceComplexOrderRequest} requestParameters Request parameters.
|
|
9941
10050
|
* @param {*} [options] Override http request option.
|
|
@@ -10505,7 +10614,7 @@ declare class TradingApiGenerated extends BaseAPI {
|
|
|
10505
10614
|
*/
|
|
10506
10615
|
placeBracketOrder(requestParameters: TradingApiPlaceBracketOrderRequest, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<AccountOrderRecord, any, {}>>;
|
|
10507
10616
|
/**
|
|
10508
|
-
* Places a complex conditional order (OCO, OTO, or OTOCO).
|
|
10617
|
+
* Places a complex conditional order (OCO, OTO, or OTOCO). Only supported on certain brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for details on which brokerages support complex orders and which types they support. - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
|
|
10509
10618
|
* @summary Place complex order
|
|
10510
10619
|
* @param {TradingApiPlaceComplexOrderRequest} requestParameters Request parameters.
|
|
10511
10620
|
* @param {*} [options] Override http request option.
|
|
@@ -10862,4 +10971,4 @@ declare class SnaptradeError extends Error {
|
|
|
10862
10971
|
declare function readableStreamToString(stream: ReadableStream): Promise<string>;
|
|
10863
10972
|
declare function parseIfJson(input: unknown): object | unknown;
|
|
10864
10973
|
//#endregion
|
|
10865
|
-
export { Account, AccountBalance, AccountBalanceTotal, AccountHoldings, AccountHoldingsAccount, AccountInformationApi, AccountInformationApiAxiosParamCreator, AccountInformationApiFactory, AccountInformationApiFp, AccountInformationApiGenerated, AccountInformationApiGetAccountActivitiesRequest, AccountInformationApiGetAccountBalanceHistoryRequest, AccountInformationApiGetAllAccountPositionsRequest, AccountInformationApiGetAllUserHoldingsRequest, AccountInformationApiGetUserAccountBalanceRequest, AccountInformationApiGetUserAccountDetailsRequest, AccountInformationApiGetUserAccountOrderDetailRequest, AccountInformationApiGetUserAccountOrdersRequest, AccountInformationApiGetUserAccountPositionsRequest, AccountInformationApiGetUserAccountRecentOrdersRequest, AccountInformationApiGetUserAccountReturnRatesRequest, AccountInformationApiGetUserHoldingsRequest, AccountInformationApiListUserAccountsRequest, AccountInformationApiUpdateUserAccountRequest, AccountInformationGetUserAccountOrderDetailRequest, AccountOrderRecord, AccountOrderRecordChildBrokerageOrderIds, AccountOrderRecordLeg, AccountOrderRecordLegInstrument, AccountOrderRecordOptionSymbol, AccountOrderRecordQuoteCurrency, AccountOrderRecordQuoteUniversalSymbol, AccountOrderRecordStatus, AccountOrderRecordStatusV2, AccountOrderRecordTrailingStop, AccountOrderRecordUniversalSymbol, AccountOrderRecordV2, AccountOrdersV2Response, AccountPosition, AccountSimple, AccountSyncStatus, AccountUniversalActivity, AccountUniversalActivityCurrency, AccountUniversalActivityOptionSymbol, AccountUniversalActivitySymbol, AccountValueHistoryItem, AccountValueHistoryResponse, ActionStrict, ActionStrictWithOptions, AdrInstrument, AllAccountPositionsResponse, AllAccountPositionsResponseDataFreshness, ApiStatusApi, ApiStatusApiAxiosParamCreator, ApiStatusApiFactory, ApiStatusApiFp, ApiStatusApiGenerated, AuthenticationApi, AuthenticationApiAxiosParamCreator, AuthenticationApiDeleteSnapTradeUserRequest, AuthenticationApiFactory, AuthenticationApiFp, AuthenticationApiGenerated, AuthenticationApiLoginSnapTradeUserRequest, AuthenticationApiRegisterSnapTradeUserRequest, AuthenticationApiResetSnapTradeUserSecretRequest, AuthenticationLoginSnapTradeUser200Response, Balance, BalanceCurrency, Brokerage, BrokerageAuthorization, BrokerageAuthorizationDisabledConfirmation, BrokerageAuthorizationRefreshConfirmation, BrokerageAuthorizationTransactionsSyncConfirmation, BrokerageAuthorizationTypeReadOnly, BrokerageAuthorizationTypeReadOnlyBrokerage, BrokerageInstrument, BrokerageInstrumentsResponse, BrokerageType, CancelOrderResponse, CefInstrument, ChildBrokerageOrderIDs, ComplexOrderLeg, ComplexOrderResponse, Configuration, ConfigurationParameters, ConnectionsApi, ConnectionsApiAxiosParamCreator, ConnectionsApiDeleteConnectionRequest, ConnectionsApiDetailBrokerageAuthorizationRequest, ConnectionsApiDisableBrokerageAuthorizationRequest, ConnectionsApiFactory, ConnectionsApiFp, ConnectionsApiGenerated, ConnectionsApiListBrokerageAuthorizationAccountsRequest, ConnectionsApiListBrokerageAuthorizationsRequest, ConnectionsApiRefreshBrokerageAuthorizationRequest, ConnectionsApiRemoveBrokerageAuthorizationRequest, ConnectionsApiReturnRatesRequest, ConnectionsApiSessionEventsRequest, ConnectionsApiSyncBrokerageAuthorizationTransactionsRequest, ConnectionsSessionEvents200ResponseInner, CryptoInstrument, CryptoOrderForm, CryptoOrderPreview, CryptoOrderPreviewEstimatedFee, CryptoTradingInstrument, CryptocurrencyPair, CryptocurrencyPairQuote, Currency, DeleteConnectionConfirmation, DeleteUserResponse, DividendAtDate, EncryptedResponse, EncryptedResponseEncryptedMessageData, EtfInstrument, Exchange, ExchangeRatePairs, ExperimentalEndpointsApi, ExperimentalEndpointsApiAddSubscriptionRequest, ExperimentalEndpointsApiAxiosParamCreator, ExperimentalEndpointsApiCancelSubscriptionRequest, ExperimentalEndpointsApiFactory, ExperimentalEndpointsApiFp, ExperimentalEndpointsApiGenerated, ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request, ExperimentalEndpointsApiGetUserAccountOrdersV2Request, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request, FigiInstrument, FutureInstrument, HoldingsStatus, Instrument, LoginRedirectURI, ManualTrade, ManualTradeAndImpact, ManualTradeBalance, ManualTradeForm, ManualTradeFormBracket, ManualTradeFormComplex, ManualTradeFormNotionalValue, ManualTradeFormWithOptions, ManualTradeImpact, ManualTradePlaceTimeInForceStrict, ManualTradeReplaceForm, ManualTradeSymbol, MlegActionStrict, MlegInstrumentType, MlegLeg, MlegOrderResponse, MlegOrderTypeStrict, MlegPriceEffectStrict, MlegTradeForm, MlegTradingInstrument, Model400FailedRequestResponse, Model401FailedRequestResponse, Model402BrokerageAuthAlreadyDisabledException, Model402BrokerageAuthDisabledResponse, Model403FailedRequestResponse, Model403FeatureNotEnabledResponse, Model404FailedRequestResponse, Model425FailedRequestResponse, Model500UnexpectedExceptionResponse, MonthlyDividends, MutualFundInstrument, NetContributions, NetDividend, NotionalValue, OptionBrokerageSymbol, OptionChainInner, OptionChainInnerChainPerRootInner, OptionChainInnerChainPerRootInnerChainPerStrikePriceInner, OptionImpact, OptionInstrument, OptionLeg, OptionQuote, OptionQuoteGreeks, OptionStrategy, OptionStrategyLegsInner, OptionsApi, OptionsApiAxiosParamCreator, OptionsApiFactory, OptionsApiFp, OptionsApiGenerated, OptionsApiListOptionHoldingsRequest, OptionsPosition, OptionsPositionCurrency, OptionsSymbol, OrderTypeStrict, OrderUpdatedResponse, OrderUpdatedResponseOrder, OtherInstrument, PaginatedUniversalActivity, PaginationDetails, PartnerData, PastValue, PerformanceCustom, Position, PositionCurrency, PositionSymbol, RateOfReturnObject, RateOfReturnResponse, RecentOrdersResponse, ReferenceDataApi, ReferenceDataApiAxiosParamCreator, ReferenceDataApiFactory, ReferenceDataApiFp, ReferenceDataApiGenerated, ReferenceDataApiGetCurrencyExchangeRatePairRequest, ReferenceDataApiGetSymbolsByTickerRequest, ReferenceDataApiGetSymbolsRequest, ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, ReferenceDataApiListAllBrokerageInstrumentsRequest, ReferenceDataApiSymbolSearchUserAccountRequest, SecurityType, SessionEvent, SimpleOrderForm, SnapTradeHoldingsAccount, SnapTradeHoldingsTotalValue, SnapTradeLoginUserRequestBody, SnapTradeRegisterUserRequestBody, Snaptrade, SnaptradeError, Status, StockInstrument, StockInstrumentFigiInstrument, StopLoss, StrategyOrderRecord, StrategyQuotes, StrategyQuotesGreek, SubPeriodReturnRate, Symbol$1 as Symbol, SymbolCurrency, SymbolExchange, SymbolQuery, SymbolsQuotesInner, TakeProfit, TaxLot, TimeInForceStrict, TradeDetectionAddSubscriptionRequest, TradeDetectionCancelSubscriptionRequest, TradeDetectionCancelSubscriptionResponse, TradeDetectionSubscription, TradingApi, TradingApiAxiosParamCreator, TradingApiCancelOrderRequest, TradingApiCancelUserAccountOrderRequest, TradingApiFactory, TradingApiFp, TradingApiGenerated, TradingApiGetCryptocurrencyPairQuoteRequest, TradingApiGetOptionImpactRequest, TradingApiGetOrderImpactRequest, TradingApiGetUserAccountOptionQuotesRequest, TradingApiGetUserAccountQuotesRequest, TradingApiPlaceBracketOrderRequest, TradingApiPlaceComplexOrderRequest, TradingApiPlaceCryptoOrderRequest, TradingApiPlaceForceOrderRequest, TradingApiPlaceMlegOrderRequest, TradingApiPlaceOrderRequest, TradingApiPreviewCryptoOrderRequest, TradingApiReplaceOrderRequest, TradingApiSearchCryptocurrencyPairInstrumentsRequest, TradingInstrument, TradingSearchCryptocurrencyPairInstruments200Response, TradingSession, TrailingStop, TransactionsAndReportingApi, TransactionsAndReportingApiAxiosParamCreator, TransactionsAndReportingApiFactory, TransactionsAndReportingApiFp, TransactionsAndReportingApiGenerated, TransactionsAndReportingApiGetActivitiesRequest, TransactionsAndReportingApiGetReportingCustomRangeRequest, TransactionsStatus, USExchange, UnderlyingOptionInstrument, UnderlyingSymbol, UnderlyingSymbolExchange, UnderlyingSymbolType, UniversalActivity, UniversalSymbol, UserIDandSecret, ValidatedTradeBody, parseIfJson, readableStreamToString };
|
|
10974
|
+
export { Account, AccountBalance, AccountBalanceTotal, AccountHoldings, AccountHoldingsAccount, AccountInformationApi, AccountInformationApiAxiosParamCreator, AccountInformationApiFactory, AccountInformationApiFp, AccountInformationApiGenerated, AccountInformationApiGetAccountActivitiesRequest, AccountInformationApiGetAccountBalanceHistoryRequest, AccountInformationApiGetAllAccountPositionsRequest, AccountInformationApiGetAllUserHoldingsRequest, AccountInformationApiGetUserAccountBalanceRequest, AccountInformationApiGetUserAccountDetailsRequest, AccountInformationApiGetUserAccountOrderDetailRequest, AccountInformationApiGetUserAccountOrdersRequest, AccountInformationApiGetUserAccountPositionsRequest, AccountInformationApiGetUserAccountRecentOrdersRequest, AccountInformationApiGetUserAccountReturnRatesRequest, AccountInformationApiGetUserHoldingsRequest, AccountInformationApiListUserAccountsRequest, AccountInformationApiUpdateUserAccountRequest, AccountInformationGetUserAccountOrderDetailRequest, AccountOrderRecord, AccountOrderRecordChildBrokerageOrderIds, AccountOrderRecordLeg, AccountOrderRecordLegInstrument, AccountOrderRecordOptionSymbol, AccountOrderRecordQuoteCurrency, AccountOrderRecordQuoteUniversalSymbol, AccountOrderRecordStatus, AccountOrderRecordStatusV2, AccountOrderRecordTrailingStop, AccountOrderRecordUniversalSymbol, AccountOrderRecordV2, AccountOrdersV2Response, AccountPosition, AccountSimple, AccountSyncStatus, AccountUniversalActivity, AccountUniversalActivityCurrency, AccountUniversalActivityCurrencyUniversalSymbol, AccountUniversalActivityOptionSymbol, AccountUniversalActivitySymbol, AccountValueHistoryItem, AccountValueHistoryResponse, ActionStrict, ActionStrictWithOptions, AdrInstrument, AllAccountPositionsResponse, AllAccountPositionsResponseDataFreshness, ApiStatusApi, ApiStatusApiAxiosParamCreator, ApiStatusApiFactory, ApiStatusApiFp, ApiStatusApiGenerated, AuthenticationApi, AuthenticationApiAxiosParamCreator, AuthenticationApiDeleteSnapTradeUserRequest, AuthenticationApiFactory, AuthenticationApiFp, AuthenticationApiGenerated, AuthenticationApiLoginSnapTradeUserRequest, AuthenticationApiRegisterSnapTradeUserRequest, AuthenticationApiResetSnapTradeUserSecretRequest, AuthenticationLoginSnapTradeUser200Response, Balance, BalanceCurrency, Brokerage, BrokerageAuthorization, BrokerageAuthorizationDisabledConfirmation, BrokerageAuthorizationRefreshConfirmation, BrokerageAuthorizationTransactionsSyncConfirmation, BrokerageAuthorizationTypeReadOnly, BrokerageAuthorizationTypeReadOnlyBrokerage, BrokerageInstrument, BrokerageInstrumentsResponse, BrokerageType, CancelOrderResponse, CefInstrument, ChildBrokerageOrderIDs, ComplexOrderLeg, ComplexOrderResponse, Configuration, ConfigurationParameters, ConnectionsApi, ConnectionsApiAxiosParamCreator, ConnectionsApiDeleteConnectionRequest, ConnectionsApiDetailBrokerageAuthorizationRequest, ConnectionsApiDisableBrokerageAuthorizationRequest, ConnectionsApiFactory, ConnectionsApiFp, ConnectionsApiGenerated, ConnectionsApiListBrokerageAuthorizationAccountsRequest, ConnectionsApiListBrokerageAuthorizationsRequest, ConnectionsApiRefreshBrokerageAuthorizationRequest, ConnectionsApiRemoveBrokerageAuthorizationRequest, ConnectionsApiReturnRatesRequest, ConnectionsApiSessionEventsRequest, ConnectionsApiSyncBrokerageAuthorizationTransactionsRequest, ConnectionsSessionEvents200ResponseInner, CryptoInstrument, CryptoOrderForm, CryptoOrderPreview, CryptoOrderPreviewEstimatedFee, CryptoTradingInstrument, CryptocurrencyPair, CryptocurrencyPairQuote, Currency, DeleteConnectionConfirmation, DeleteUserResponse, DividendAtDate, EncryptedResponse, EncryptedResponseEncryptedMessageData, EtfInstrument, Exchange, ExchangeRatePairs, ExperimentalEndpointsApi, ExperimentalEndpointsApiAddSubscriptionRequest, ExperimentalEndpointsApiAxiosParamCreator, ExperimentalEndpointsApiCancelSubscriptionRequest, ExperimentalEndpointsApiFactory, ExperimentalEndpointsApiFp, ExperimentalEndpointsApiGenerated, ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request, ExperimentalEndpointsApiGetUserAccountOrdersV2Request, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request, FigiInstrument, FutureInstrument, HoldingsStatus, Instrument, LoginRedirectURI, ManualTrade, ManualTradeAndImpact, ManualTradeBalance, ManualTradeForm, ManualTradeFormBracket, ManualTradeFormComplex, ManualTradeFormNotionalValue, ManualTradeFormWithOptions, ManualTradeImpact, ManualTradePlaceTimeInForceStrict, ManualTradeReplaceForm, ManualTradeSymbol, MlegActionStrict, MlegInstrumentType, MlegLeg, MlegOrderResponse, MlegOrderTypeStrict, MlegPriceEffectStrict, MlegTradeForm, MlegTradingInstrument, Model400FailedRequestResponse, Model401FailedRequestResponse, Model402BrokerageAuthAlreadyDisabledException, Model402BrokerageAuthDisabledResponse, Model403FailedRequestResponse, Model403FeatureNotEnabledResponse, Model404FailedRequestResponse, Model425FailedRequestResponse, Model429TooManyRequestsResponse, Model500UnexpectedExceptionResponse, MonthlyDividends, MutualFundInstrument, NetContributions, NetDividend, NotionalValue, OptionBrokerageSymbol, OptionChainInner, OptionChainInnerChainPerRootInner, OptionChainInnerChainPerRootInnerChainPerStrikePriceInner, OptionImpact, OptionInstrument, OptionLeg, OptionQuote, OptionQuoteGreeks, OptionStrategy, OptionStrategyLegsInner, OptionsApi, OptionsApiAxiosParamCreator, OptionsApiFactory, OptionsApiFp, OptionsApiGenerated, OptionsApiListOptionHoldingsRequest, OptionsPosition, OptionsPositionCurrency, OptionsSymbol, OrderTypeStrict, OrderUpdatedResponse, OrderUpdatedResponseOrder, OtherInstrument, PaginatedUniversalActivity, PaginationDetails, PartnerData, PastValue, PerformanceCustom, Position, PositionCurrency, PositionSymbol, RateOfReturnObject, RateOfReturnResponse, RecentOrdersResponse, ReferenceDataApi, ReferenceDataApiAxiosParamCreator, ReferenceDataApiFactory, ReferenceDataApiFp, ReferenceDataApiGenerated, ReferenceDataApiGetCurrencyExchangeRatePairRequest, ReferenceDataApiGetSymbolsByTickerRequest, ReferenceDataApiGetSymbolsRequest, ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, ReferenceDataApiListAllBrokerageInstrumentsRequest, ReferenceDataApiSymbolSearchUserAccountRequest, SecurityType, SessionEvent, SimpleOrderForm, SnapTradeHoldingsAccount, SnapTradeHoldingsTotalValue, SnapTradeLoginUserRequestBody, SnapTradeRegisterUserRequestBody, Snaptrade, SnaptradeError, Status, StockInstrument, StockInstrumentFigiInstrument, StopLoss, StrategyOrderRecord, StrategyQuotes, StrategyQuotesGreek, SubPeriodReturnRate, Symbol$1 as Symbol, SymbolCurrency, SymbolExchange, SymbolQuery, SymbolsQuotesInner, TakeProfit, TaxLot, TimeInForceStrict, TradeDetectionAddSubscriptionRequest, TradeDetectionCancelSubscriptionRequest, TradeDetectionCancelSubscriptionResponse, TradeDetectionSubscription, TradingApi, TradingApiAxiosParamCreator, TradingApiCancelOrderRequest, TradingApiCancelUserAccountOrderRequest, TradingApiFactory, TradingApiFp, TradingApiGenerated, TradingApiGetCryptocurrencyPairQuoteRequest, TradingApiGetOptionImpactRequest, TradingApiGetOrderImpactRequest, TradingApiGetUserAccountOptionQuotesRequest, TradingApiGetUserAccountQuotesRequest, TradingApiPlaceBracketOrderRequest, TradingApiPlaceComplexOrderRequest, TradingApiPlaceCryptoOrderRequest, TradingApiPlaceForceOrderRequest, TradingApiPlaceMlegOrderRequest, TradingApiPlaceOrderRequest, TradingApiPreviewCryptoOrderRequest, TradingApiReplaceOrderRequest, TradingApiSearchCryptocurrencyPairInstrumentsRequest, TradingInstrument, TradingSearchCryptocurrencyPairInstruments200Response, TradingSession, TrailingStop, TransactionsAndReportingApi, TransactionsAndReportingApiAxiosParamCreator, TransactionsAndReportingApiFactory, TransactionsAndReportingApiFp, TransactionsAndReportingApiGenerated, TransactionsAndReportingApiGetActivitiesRequest, TransactionsAndReportingApiGetReportingCustomRangeRequest, TransactionsStatus, USExchange, UnderlyingOptionInstrument, UnderlyingSymbol, UnderlyingSymbolExchange, UnderlyingSymbolType, UniversalActivity, UniversalSymbol, UserIDandSecret, ValidatedTradeBody, parseIfJson, readableStreamToString };
|