snaptrade-typescript-sdk 9.0.115 → 9.0.117

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.
Files changed (6) hide show
  1. package/README.md +1 -1
  2. package/dist/api/trading-api-generated.d.ts +52 -52
  3. package/dist/api/trading-api-generated.js +52 -52
  4. package/dist/browser.js +1 -1
  5. package/dist/configuration.js +1 -1
  6. package/package.json +1 -1
package/README.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  Connect brokerage accounts to your app for live positions and trading
8
8
 
9
- [![npm](https://img.shields.io/badge/npm-v9.0.115-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.115)
9
+ [![npm](https://img.shields.io/badge/npm-v9.0.117-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.117)
10
10
  [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
11
11
 
12
12
  </div>
package/dist/api/trading-api-generated.d.ts CHANGED
@@ -24,7 +24,7 @@ import { ValidatedTradeBody } from '../models';
24
24
  export declare const TradingApiAxiosParamCreator: (configuration?: Configuration) => {
25
25
  /**
26
26
  * Cancels an order in the specified account.
27
- * @summary Cancel an order.
27
+ * @summary Cancel crypto order
28
28
  * @param {string} userId
29
29
  * @param {string} userSecret
30
30
  * @param {string} accountId
@@ -35,7 +35,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
35
35
  cancelOrder: (userId: string, userSecret: string, accountId: string, brokerageOrderId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
36
36
  /**
37
37
  * Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
38
- * @summary Cancel order
38
+ * @summary Cancel equity order
39
39
  * @param {string} userId
40
40
  * @param {string} userSecret
41
41
  * @param {string} accountId
@@ -46,7 +46,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
46
46
  cancelUserAccountOrder: (userId: string, userSecret: string, accountId: string, tradingCancelUserAccountOrderRequest: TradingCancelUserAccountOrderRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
47
47
  /**
48
48
  * Gets a quote for the specified account.
49
- * @summary Get cryptocurrency pair quote
49
+ * @summary Get crypto pair quote
50
50
  * @param {string} userId
51
51
  * @param {string} userSecret
52
52
  * @param {string} accountId
@@ -57,7 +57,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
57
57
  getCryptocurrencyPairQuote: (userId: string, userSecret: string, accountId: string, instrumentSymbol: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
58
58
  /**
59
59
  * Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
60
- * @summary Check order impact
60
+ * @summary Check equity order impact
61
61
  * @param {string} userId
62
62
  * @param {string} userSecret
63
63
  * @param {ManualTradeForm} manualTradeForm
@@ -67,7 +67,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
67
67
  getOrderImpact: (userId: string, userSecret: string, manualTradeForm: ManualTradeForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
68
68
  /**
69
69
  * Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. This endpoint does not work for options quotes.
70
- * @summary Get symbol quotes
70
+ * @summary Get equity symbol quotes
71
71
  * @param {string} userId
72
72
  * @param {string} userSecret
73
73
  * @param {string} symbols List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator
@@ -79,7 +79,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
79
79
  getUserAccountQuotes: (userId: string, userSecret: string, symbols: string, accountId: string, useTicker?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
80
80
  /**
81
81
  * Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
82
- * @summary Place a Bracket Order
82
+ * @summary Place bracket equity order
83
83
  * @param {string} accountId The ID of the account to execute the trade on.
84
84
  * @param {string} userId
85
85
  * @param {string} userSecret
@@ -90,7 +90,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
90
90
  placeBracketOrder: (accountId: string, userId: string, userSecret: string, manualTradeFormBracket: ManualTradeFormBracket, options?: AxiosRequestConfig) => Promise<RequestArgs>;
91
91
  /**
92
92
  * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds. This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
93
- * @summary Place order
93
+ * @summary Place equity order
94
94
  * @param {string} userId
95
95
  * @param {string} userSecret
96
96
  * @param {ManualTradeFormWithOptions} manualTradeFormWithOptions
@@ -100,7 +100,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
100
100
  placeForceOrder: (userId: string, userSecret: string, manualTradeFormWithOptions: ManualTradeFormWithOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>;
101
101
  /**
102
102
  * Places a multi-leg option order. Only supported on certain option trading brokerages. https://snaptrade.notion.site/brokerages has information on brokerage trading support
103
- * @summary Place multi-leg option order
103
+ * @summary Place option order
104
104
  * @param {string} userId
105
105
  * @param {string} userSecret
106
106
  * @param {string} accountId
@@ -111,7 +111,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
111
111
  placeMlegOrder: (userId: string, userSecret: string, accountId: string, mlegTradeForm: MlegTradeForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
112
112
  /**
113
113
  * Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
114
- * @summary Place checked order
114
+ * @summary Place checked equity order
115
115
  * @param {string} tradeId Obtained from calling the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact)
116
116
  * @param {string} userId
117
117
  * @param {string} userSecret
@@ -122,7 +122,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
122
122
  placeOrder: (tradeId: string, userId: string, userSecret: string, validatedTradeBody?: ValidatedTradeBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
123
123
  /**
124
124
  * Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
125
- * @summary Place order
125
+ * @summary Place crypto order
126
126
  * @param {string} userId
127
127
  * @param {string} userSecret
128
128
  * @param {string} accountId
@@ -133,7 +133,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
133
133
  placeSimpleOrder: (userId: string, userSecret: string, accountId: string, simpleOrderForm: SimpleOrderForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
134
134
  /**
135
135
  * Previews an order using the specified account.
136
- * @summary Preview order
136
+ * @summary Preview crypto order
137
137
  * @param {string} userId
138
138
  * @param {string} userSecret
139
139
  * @param {string} accountId
@@ -144,7 +144,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
144
144
  previewSimpleOrder: (userId: string, userSecret: string, accountId: string, simpleOrderForm: SimpleOrderForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
145
145
  /**
146
146
  * Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order\'s brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages
147
- * @summary Replaces an order with a new one
147
+ * @summary Replace crypto order
148
148
  * @param {string} accountId The ID of the account to execute the trade on.
149
149
  * @param {string} brokerageOrderId The Brokerage Order ID of the order to replace.
150
150
  * @param {string} userId
@@ -156,7 +156,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
156
156
  replaceOrder: (accountId: string, brokerageOrderId: string, userId: string, userSecret: string, manualTradeReplaceForm: ManualTradeReplaceForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
157
157
  /**
158
158
  * Searches cryptocurrency pairs instruments accessible to the specified account.
159
- * @summary Search cryptocurrency pairs instruments
159
+ * @summary Get crypto pairs
160
160
  * @param {string} userId
161
161
  * @param {string} userSecret
162
162
  * @param {string} accountId
@@ -174,7 +174,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
174
174
  export declare const TradingApiFp: (configuration?: Configuration) => {
175
175
  /**
176
176
  * Cancels an order in the specified account.
177
- * @summary Cancel an order.
177
+ * @summary Cancel crypto order
178
178
  * @param {TradingApiCancelOrderRequest} requestParameters Request parameters.
179
179
  * @param {*} [options] Override http request option.
180
180
  * @throws {RequiredError}
@@ -182,7 +182,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
182
182
  cancelOrder(requestParameters: TradingApiCancelOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderUpdatedResponse>>;
183
183
  /**
184
184
  * Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
185
- * @summary Cancel order
185
+ * @summary Cancel equity order
186
186
  * @param {TradingApiCancelUserAccountOrderRequest} requestParameters Request parameters.
187
187
  * @param {*} [options] Override http request option.
188
188
  * @throws {RequiredError}
@@ -190,7 +190,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
190
190
  cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
191
191
  /**
192
192
  * Gets a quote for the specified account.
193
- * @summary Get cryptocurrency pair quote
193
+ * @summary Get crypto pair quote
194
194
  * @param {TradingApiGetCryptocurrencyPairQuoteRequest} requestParameters Request parameters.
195
195
  * @param {*} [options] Override http request option.
196
196
  * @throws {RequiredError}
@@ -198,7 +198,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
198
198
  getCryptocurrencyPairQuote(requestParameters: TradingApiGetCryptocurrencyPairQuoteRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CryptocurrencyPairQuote>>;
199
199
  /**
200
200
  * Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
201
- * @summary Check order impact
201
+ * @summary Check equity order impact
202
202
  * @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
203
203
  * @param {*} [options] Override http request option.
204
204
  * @throws {RequiredError}
@@ -206,7 +206,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
206
206
  getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManualTradeAndImpact>>;
207
207
  /**
208
208
  * Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. This endpoint does not work for options quotes.
209
- * @summary Get symbol quotes
209
+ * @summary Get equity symbol quotes
210
210
  * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
211
211
  * @param {*} [options] Override http request option.
212
212
  * @throws {RequiredError}
@@ -214,7 +214,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
214
214
  getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SymbolsQuotesInner>>>;
215
215
  /**
216
216
  * Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
217
- * @summary Place a Bracket Order
217
+ * @summary Place bracket equity order
218
218
  * @param {TradingApiPlaceBracketOrderRequest} requestParameters Request parameters.
219
219
  * @param {*} [options] Override http request option.
220
220
  * @throws {RequiredError}
@@ -222,7 +222,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
222
222
  placeBracketOrder(requestParameters: TradingApiPlaceBracketOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
223
223
  /**
224
224
  * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds. This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
225
- * @summary Place order
225
+ * @summary Place equity order
226
226
  * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
227
227
  * @param {*} [options] Override http request option.
228
228
  * @throws {RequiredError}
@@ -230,7 +230,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
230
230
  placeForceOrder(requestParameters: TradingApiPlaceForceOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
231
231
  /**
232
232
  * Places a multi-leg option order. Only supported on certain option trading brokerages. https://snaptrade.notion.site/brokerages has information on brokerage trading support
233
- * @summary Place multi-leg option order
233
+ * @summary Place option order
234
234
  * @param {TradingApiPlaceMlegOrderRequest} requestParameters Request parameters.
235
235
  * @param {*} [options] Override http request option.
236
236
  * @throws {RequiredError}
@@ -238,7 +238,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
238
238
  placeMlegOrder(requestParameters: TradingApiPlaceMlegOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MlegOrderResponse>>;
239
239
  /**
240
240
  * Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
241
- * @summary Place checked order
241
+ * @summary Place checked equity order
242
242
  * @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
243
243
  * @param {*} [options] Override http request option.
244
244
  * @throws {RequiredError}
@@ -246,7 +246,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
246
246
  placeOrder(requestParameters: TradingApiPlaceOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
247
247
  /**
248
248
  * Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
249
- * @summary Place order
249
+ * @summary Place crypto order
250
250
  * @param {TradingApiPlaceSimpleOrderRequest} requestParameters Request parameters.
251
251
  * @param {*} [options] Override http request option.
252
252
  * @throws {RequiredError}
@@ -254,7 +254,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
254
254
  placeSimpleOrder(requestParameters: TradingApiPlaceSimpleOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderUpdatedResponse>>;
255
255
  /**
256
256
  * Previews an order using the specified account.
257
- * @summary Preview order
257
+ * @summary Preview crypto order
258
258
  * @param {TradingApiPreviewSimpleOrderRequest} requestParameters Request parameters.
259
259
  * @param {*} [options] Override http request option.
260
260
  * @throws {RequiredError}
@@ -262,7 +262,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
262
262
  previewSimpleOrder(requestParameters: TradingApiPreviewSimpleOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleOrderPreview>>;
263
263
  /**
264
264
  * Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order\'s brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages
265
- * @summary Replaces an order with a new one
265
+ * @summary Replace crypto order
266
266
  * @param {TradingApiReplaceOrderRequest} requestParameters Request parameters.
267
267
  * @param {*} [options] Override http request option.
268
268
  * @throws {RequiredError}
@@ -270,7 +270,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
270
270
  replaceOrder(requestParameters: TradingApiReplaceOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
271
271
  /**
272
272
  * Searches cryptocurrency pairs instruments accessible to the specified account.
273
- * @summary Search cryptocurrency pairs instruments
273
+ * @summary Get crypto pairs
274
274
  * @param {TradingApiSearchCryptocurrencyPairInstrumentsRequest} requestParameters Request parameters.
275
275
  * @param {*} [options] Override http request option.
276
276
  * @throws {RequiredError}
@@ -284,7 +284,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
284
284
  export declare const TradingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
285
285
  /**
286
286
  * Cancels an order in the specified account.
287
- * @summary Cancel an order.
287
+ * @summary Cancel crypto order
288
288
  * @param {TradingApiCancelOrderRequest} requestParameters Request parameters.
289
289
  * @param {*} [options] Override http request option.
290
290
  * @throws {RequiredError}
@@ -292,7 +292,7 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
292
292
  cancelOrder(requestParameters: TradingApiCancelOrderRequest, options?: AxiosRequestConfig): AxiosPromise<OrderUpdatedResponse>;
293
293
  /**
294
294
  * Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
295
- * @summary Cancel order
295
+ * @summary Cancel equity order
296
296
  * @param {TradingApiCancelUserAccountOrderRequest} requestParameters Request parameters.
297
297
  * @param {*} [options] Override http request option.
298
298
  * @throws {RequiredError}
@@ -300,7 +300,7 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
300
300
  cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
301
301
  /**
302
302
  * Gets a quote for the specified account.
303
- * @summary Get cryptocurrency pair quote
303
+ * @summary Get crypto pair quote
304
304
  * @param {TradingApiGetCryptocurrencyPairQuoteRequest} requestParameters Request parameters.
305
305
  * @param {*} [options] Override http request option.
306
306
  * @throws {RequiredError}
@@ -308,7 +308,7 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
308
308
  getCryptocurrencyPairQuote(requestParameters: TradingApiGetCryptocurrencyPairQuoteRequest, options?: AxiosRequestConfig): AxiosPromise<CryptocurrencyPairQuote>;
309
309
  /**
310
310
  * Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
311
- * @summary Check order impact
311
+ * @summary Check equity order impact
312
312
  * @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
313
313
  * @param {*} [options] Override http request option.
314
314
  * @throws {RequiredError}
@@ -316,7 +316,7 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
316
316
  getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): AxiosPromise<ManualTradeAndImpact>;
317
317
  /**
318
318
  * Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. This endpoint does not work for options quotes.
319
- * @summary Get symbol quotes
319
+ * @summary Get equity symbol quotes
320
320
  * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
321
321
  * @param {*} [options] Override http request option.
322
322
  * @throws {RequiredError}
@@ -324,7 +324,7 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
324
324
  getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<SymbolsQuotesInner>>;
325
325
  /**
326
326
  * Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
327
- * @summary Place a Bracket Order
327
+ * @summary Place bracket equity order
328
328
  * @param {TradingApiPlaceBracketOrderRequest} requestParameters Request parameters.
329
329
  * @param {*} [options] Override http request option.
330
330
  * @throws {RequiredError}
@@ -332,7 +332,7 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
332
332
  placeBracketOrder(requestParameters: TradingApiPlaceBracketOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
333
333
  /**
334
334
  * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds. This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
335
- * @summary Place order
335
+ * @summary Place equity order
336
336
  * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
337
337
  * @param {*} [options] Override http request option.
338
338
  * @throws {RequiredError}
@@ -340,7 +340,7 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
340
340
  placeForceOrder(requestParameters: TradingApiPlaceForceOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
341
341
  /**
342
342
  * Places a multi-leg option order. Only supported on certain option trading brokerages. https://snaptrade.notion.site/brokerages has information on brokerage trading support
343
- * @summary Place multi-leg option order
343
+ * @summary Place option order
344
344
  * @param {TradingApiPlaceMlegOrderRequest} requestParameters Request parameters.
345
345
  * @param {*} [options] Override http request option.
346
346
  * @throws {RequiredError}
@@ -348,7 +348,7 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
348
348
  placeMlegOrder(requestParameters: TradingApiPlaceMlegOrderRequest, options?: AxiosRequestConfig): AxiosPromise<MlegOrderResponse>;
349
349
  /**
350
350
  * Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
351
- * @summary Place checked order
351
+ * @summary Place checked equity order
352
352
  * @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
353
353
  * @param {*} [options] Override http request option.
354
354
  * @throws {RequiredError}
@@ -356,7 +356,7 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
356
356
  placeOrder(requestParameters: TradingApiPlaceOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
357
357
  /**
358
358
  * Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
359
- * @summary Place order
359
+ * @summary Place crypto order
360
360
  * @param {TradingApiPlaceSimpleOrderRequest} requestParameters Request parameters.
361
361
  * @param {*} [options] Override http request option.
362
362
  * @throws {RequiredError}
@@ -364,7 +364,7 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
364
364
  placeSimpleOrder(requestParameters: TradingApiPlaceSimpleOrderRequest, options?: AxiosRequestConfig): AxiosPromise<OrderUpdatedResponse>;
365
365
  /**
366
366
  * Previews an order using the specified account.
367
- * @summary Preview order
367
+ * @summary Preview crypto order
368
368
  * @param {TradingApiPreviewSimpleOrderRequest} requestParameters Request parameters.
369
369
  * @param {*} [options] Override http request option.
370
370
  * @throws {RequiredError}
@@ -372,7 +372,7 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
372
372
  previewSimpleOrder(requestParameters: TradingApiPreviewSimpleOrderRequest, options?: AxiosRequestConfig): AxiosPromise<SimpleOrderPreview>;
373
373
  /**
374
374
  * Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order\'s brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages
375
- * @summary Replaces an order with a new one
375
+ * @summary Replace crypto order
376
376
  * @param {TradingApiReplaceOrderRequest} requestParameters Request parameters.
377
377
  * @param {*} [options] Override http request option.
378
378
  * @throws {RequiredError}
@@ -380,7 +380,7 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
380
380
  replaceOrder(requestParameters: TradingApiReplaceOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
381
381
  /**
382
382
  * Searches cryptocurrency pairs instruments accessible to the specified account.
383
- * @summary Search cryptocurrency pairs instruments
383
+ * @summary Get crypto pairs
384
384
  * @param {TradingApiSearchCryptocurrencyPairInstrumentsRequest} requestParameters Request parameters.
385
385
  * @param {*} [options] Override http request option.
386
386
  * @throws {RequiredError}
@@ -751,7 +751,7 @@ export type TradingApiSearchCryptocurrencyPairInstrumentsRequest = {
751
751
  export declare class TradingApiGenerated extends BaseAPI {
752
752
  /**
753
753
  * Cancels an order in the specified account.
754
- * @summary Cancel an order.
754
+ * @summary Cancel crypto order
755
755
  * @param {TradingApiCancelOrderRequest} requestParameters Request parameters.
756
756
  * @param {*} [options] Override http request option.
757
757
  * @throws {RequiredError}
@@ -760,7 +760,7 @@ export declare class TradingApiGenerated extends BaseAPI {
760
760
  cancelOrder(requestParameters: TradingApiCancelOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderUpdatedResponse, any>>;
761
761
  /**
762
762
  * Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
763
- * @summary Cancel order
763
+ * @summary Cancel equity order
764
764
  * @param {TradingApiCancelUserAccountOrderRequest} requestParameters Request parameters.
765
765
  * @param {*} [options] Override http request option.
766
766
  * @throws {RequiredError}
@@ -769,7 +769,7 @@ export declare class TradingApiGenerated extends BaseAPI {
769
769
  cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
770
770
  /**
771
771
  * Gets a quote for the specified account.
772
- * @summary Get cryptocurrency pair quote
772
+ * @summary Get crypto pair quote
773
773
  * @param {TradingApiGetCryptocurrencyPairQuoteRequest} requestParameters Request parameters.
774
774
  * @param {*} [options] Override http request option.
775
775
  * @throws {RequiredError}
@@ -778,7 +778,7 @@ export declare class TradingApiGenerated extends BaseAPI {
778
778
  getCryptocurrencyPairQuote(requestParameters: TradingApiGetCryptocurrencyPairQuoteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CryptocurrencyPairQuote, any>>;
779
779
  /**
780
780
  * Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
781
- * @summary Check order impact
781
+ * @summary Check equity order impact
782
782
  * @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
783
783
  * @param {*} [options] Override http request option.
784
784
  * @throws {RequiredError}
@@ -787,7 +787,7 @@ export declare class TradingApiGenerated extends BaseAPI {
787
787
  getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManualTradeAndImpact, any>>;
788
788
  /**
789
789
  * Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. This endpoint does not work for options quotes.
790
- * @summary Get symbol quotes
790
+ * @summary Get equity symbol quotes
791
791
  * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
792
792
  * @param {*} [options] Override http request option.
793
793
  * @throws {RequiredError}
@@ -796,7 +796,7 @@ export declare class TradingApiGenerated extends BaseAPI {
796
796
  getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SymbolsQuotesInner[], any>>;
797
797
  /**
798
798
  * Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
799
- * @summary Place a Bracket Order
799
+ * @summary Place bracket equity order
800
800
  * @param {TradingApiPlaceBracketOrderRequest} requestParameters Request parameters.
801
801
  * @param {*} [options] Override http request option.
802
802
  * @throws {RequiredError}
@@ -805,7 +805,7 @@ export declare class TradingApiGenerated extends BaseAPI {
805
805
  placeBracketOrder(requestParameters: TradingApiPlaceBracketOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
806
806
  /**
807
807
  * Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds. This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
808
- * @summary Place order
808
+ * @summary Place equity order
809
809
  * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
810
810
  * @param {*} [options] Override http request option.
811
811
  * @throws {RequiredError}
@@ -814,7 +814,7 @@ export declare class TradingApiGenerated extends BaseAPI {
814
814
  placeForceOrder(requestParameters: TradingApiPlaceForceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
815
815
  /**
816
816
  * Places a multi-leg option order. Only supported on certain option trading brokerages. https://snaptrade.notion.site/brokerages has information on brokerage trading support
817
- * @summary Place multi-leg option order
817
+ * @summary Place option order
818
818
  * @param {TradingApiPlaceMlegOrderRequest} requestParameters Request parameters.
819
819
  * @param {*} [options] Override http request option.
820
820
  * @throws {RequiredError}
@@ -823,7 +823,7 @@ export declare class TradingApiGenerated extends BaseAPI {
823
823
  placeMlegOrder(requestParameters: TradingApiPlaceMlegOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MlegOrderResponse, any>>;
824
824
  /**
825
825
  * Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
826
- * @summary Place checked order
826
+ * @summary Place checked equity order
827
827
  * @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
828
828
  * @param {*} [options] Override http request option.
829
829
  * @throws {RequiredError}
@@ -832,7 +832,7 @@ export declare class TradingApiGenerated extends BaseAPI {
832
832
  placeOrder(requestParameters: TradingApiPlaceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
833
833
  /**
834
834
  * Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
835
- * @summary Place order
835
+ * @summary Place crypto order
836
836
  * @param {TradingApiPlaceSimpleOrderRequest} requestParameters Request parameters.
837
837
  * @param {*} [options] Override http request option.
838
838
  * @throws {RequiredError}
@@ -841,7 +841,7 @@ export declare class TradingApiGenerated extends BaseAPI {
841
841
  placeSimpleOrder(requestParameters: TradingApiPlaceSimpleOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderUpdatedResponse, any>>;
842
842
  /**
843
843
  * Previews an order using the specified account.
844
- * @summary Preview order
844
+ * @summary Preview crypto order
845
845
  * @param {TradingApiPreviewSimpleOrderRequest} requestParameters Request parameters.
846
846
  * @param {*} [options] Override http request option.
847
847
  * @throws {RequiredError}
@@ -850,7 +850,7 @@ export declare class TradingApiGenerated extends BaseAPI {
850
850
  previewSimpleOrder(requestParameters: TradingApiPreviewSimpleOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SimpleOrderPreview, any>>;
851
851
  /**
852
852
  * Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order\'s brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages
853
- * @summary Replaces an order with a new one
853
+ * @summary Replace crypto order
854
854
  * @param {TradingApiReplaceOrderRequest} requestParameters Request parameters.
855
855
  * @param {*} [options] Override http request option.
856
856
  * @throws {RequiredError}
@@ -859,7 +859,7 @@ export declare class TradingApiGenerated extends BaseAPI {
859
859
  replaceOrder(requestParameters: TradingApiReplaceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
860
860
  /**
861
861
  * Searches cryptocurrency pairs instruments accessible to the specified account.
862
- * @summary Search cryptocurrency pairs instruments
862
+ * @summary Get crypto pairs
863
863
  * @param {TradingApiSearchCryptocurrencyPairInstrumentsRequest} requestParameters Request parameters.
864
864
  * @param {*} [options] Override http request option.
865
865
  * @throws {RequiredError}