snaptrade-typescript-sdk 9.0.125 → 9.0.127
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 +42 -1
- package/dist/api/account-information-api-generated.d.ts +67 -0
- package/dist/api/account-information-api-generated.js +93 -0
- package/dist/api/trading-api-generated.d.ts +4 -4
- package/dist/api/trading-api-generated.js +4 -4
- package/dist/browser.js +1 -1
- package/dist/configuration.js +1 -1
- package/dist/models/account.d.ts +1 -1
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/dist/models/position-currency.d.ts +25 -0
- package/dist/models/position-currency.js +2 -0
- package/dist/models/position.d.ts +7 -0
- package/dist/operationParameterMap.js +16 -0
- 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
|
-
[](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.127)
|
|
10
10
|
[](https://snaptrade.com/)
|
|
11
11
|
|
|
12
12
|
</div>
|
|
@@ -22,6 +22,7 @@ Connect brokerage accounts to your app for live positions and trading
|
|
|
22
22
|
* [`snaptrade.accountInformation.getAllUserHoldings`](#snaptradeaccountinformationgetalluserholdings)
|
|
23
23
|
* [`snaptrade.accountInformation.getUserAccountBalance`](#snaptradeaccountinformationgetuseraccountbalance)
|
|
24
24
|
* [`snaptrade.accountInformation.getUserAccountDetails`](#snaptradeaccountinformationgetuseraccountdetails)
|
|
25
|
+
* [`snaptrade.accountInformation.getUserAccountOrderDetail`](#snaptradeaccountinformationgetuseraccountorderdetail)
|
|
25
26
|
* [`snaptrade.accountInformation.getUserAccountOrders`](#snaptradeaccountinformationgetuseraccountorders)
|
|
26
27
|
* [`snaptrade.accountInformation.getUserAccountPositions`](#snaptradeaccountinformationgetuseraccountpositions)
|
|
27
28
|
* [`snaptrade.accountInformation.getUserAccountRecentOrders`](#snaptradeaccountinformationgetuseraccountrecentorders)
|
|
@@ -377,6 +378,46 @@ const getUserAccountDetailsResponse =
|
|
|
377
378
|
---
|
|
378
379
|
|
|
379
380
|
|
|
381
|
+
### `snaptrade.accountInformation.getUserAccountOrderDetail`<a id="snaptradeaccountinformationgetuseraccountorderdetail"></a>
|
|
382
|
+
|
|
383
|
+
Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data.
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
387
|
+
|
|
388
|
+
```typescript
|
|
389
|
+
const getUserAccountOrderDetailResponse =
|
|
390
|
+
await snaptrade.accountInformation.getUserAccountOrderDetail({
|
|
391
|
+
userId: "snaptrade-user-123",
|
|
392
|
+
userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
|
|
393
|
+
accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
|
|
394
|
+
brokerageOrderId: "66a033fa-da74-4fcf-b527-feefdec9257e",
|
|
395
|
+
});
|
|
396
|
+
```
|
|
397
|
+
|
|
398
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
|
399
|
+
|
|
400
|
+
##### userId: `string`<a id="userid-string"></a>
|
|
401
|
+
|
|
402
|
+
##### userSecret: `string`<a id="usersecret-string"></a>
|
|
403
|
+
|
|
404
|
+
##### accountId: `string`<a id="accountid-string"></a>
|
|
405
|
+
|
|
406
|
+
##### brokerageOrderId: `string`<a id="brokerageorderid-string"></a>
|
|
407
|
+
|
|
408
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
|
409
|
+
|
|
410
|
+
[AccountOrderRecord](./models/account-order-record.ts)
|
|
411
|
+
|
|
412
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
|
413
|
+
|
|
414
|
+
`/accounts/{accountId}/orders/{brokerageOrderId}` `GET`
|
|
415
|
+
|
|
416
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
|
417
|
+
|
|
418
|
+
---
|
|
419
|
+
|
|
420
|
+
|
|
380
421
|
### `snaptrade.accountInformation.getUserAccountOrders`<a id="snaptradeaccountinformationgetuseraccountorders"></a>
|
|
381
422
|
|
|
382
423
|
Returns a list of recent orders in the specified account.
|
|
@@ -61,6 +61,17 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
|
|
|
61
61
|
* @throws {RequiredError}
|
|
62
62
|
*/
|
|
63
63
|
getUserAccountDetails: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
|
+
/**
|
|
65
|
+
* Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data.
|
|
66
|
+
* @summary Get account order detail
|
|
67
|
+
* @param {string} userId
|
|
68
|
+
* @param {string} userSecret
|
|
69
|
+
* @param {string} accountId
|
|
70
|
+
* @param {string} brokerageOrderId
|
|
71
|
+
* @param {*} [options] Override http request option.
|
|
72
|
+
* @throws {RequiredError}
|
|
73
|
+
*/
|
|
74
|
+
getUserAccountOrderDetail: (userId: string, userSecret: string, accountId: string, brokerageOrderId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
75
|
/**
|
|
65
76
|
* Returns a list of recent orders in the specified account. The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
66
77
|
* @summary List account orders
|
|
@@ -172,6 +183,14 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
|
|
|
172
183
|
* @throws {RequiredError}
|
|
173
184
|
*/
|
|
174
185
|
getUserAccountDetails(requestParameters: AccountInformationApiGetUserAccountDetailsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Account>>;
|
|
186
|
+
/**
|
|
187
|
+
* Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data.
|
|
188
|
+
* @summary Get account order detail
|
|
189
|
+
* @param {AccountInformationApiGetUserAccountOrderDetailRequest} requestParameters Request parameters.
|
|
190
|
+
* @param {*} [options] Override http request option.
|
|
191
|
+
* @throws {RequiredError}
|
|
192
|
+
*/
|
|
193
|
+
getUserAccountOrderDetail(requestParameters: AccountInformationApiGetUserAccountOrderDetailRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
|
|
175
194
|
/**
|
|
176
195
|
* Returns a list of recent orders in the specified account. The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
177
196
|
* @summary List account orders
|
|
@@ -267,6 +286,14 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
|
|
|
267
286
|
* @throws {RequiredError}
|
|
268
287
|
*/
|
|
269
288
|
getUserAccountDetails(requestParameters: AccountInformationApiGetUserAccountDetailsRequest, options?: AxiosRequestConfig): AxiosPromise<Account>;
|
|
289
|
+
/**
|
|
290
|
+
* Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data.
|
|
291
|
+
* @summary Get account order detail
|
|
292
|
+
* @param {AccountInformationApiGetUserAccountOrderDetailRequest} requestParameters Request parameters.
|
|
293
|
+
* @param {*} [options] Override http request option.
|
|
294
|
+
* @throws {RequiredError}
|
|
295
|
+
*/
|
|
296
|
+
getUserAccountOrderDetail(requestParameters: AccountInformationApiGetUserAccountOrderDetailRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
|
|
270
297
|
/**
|
|
271
298
|
* Returns a list of recent orders in the specified account. The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
272
299
|
* @summary List account orders
|
|
@@ -454,6 +481,37 @@ export type AccountInformationApiGetUserAccountDetailsRequest = {
|
|
|
454
481
|
*/
|
|
455
482
|
readonly accountId: string;
|
|
456
483
|
};
|
|
484
|
+
/**
|
|
485
|
+
* Request parameters for getUserAccountOrderDetail operation in AccountInformationApi.
|
|
486
|
+
* @export
|
|
487
|
+
* @interface AccountInformationApiGetUserAccountOrderDetailRequest
|
|
488
|
+
*/
|
|
489
|
+
export type AccountInformationApiGetUserAccountOrderDetailRequest = {
|
|
490
|
+
/**
|
|
491
|
+
*
|
|
492
|
+
* @type {string}
|
|
493
|
+
* @memberof AccountInformationApiGetUserAccountOrderDetail
|
|
494
|
+
*/
|
|
495
|
+
readonly userId: string;
|
|
496
|
+
/**
|
|
497
|
+
*
|
|
498
|
+
* @type {string}
|
|
499
|
+
* @memberof AccountInformationApiGetUserAccountOrderDetail
|
|
500
|
+
*/
|
|
501
|
+
readonly userSecret: string;
|
|
502
|
+
/**
|
|
503
|
+
*
|
|
504
|
+
* @type {string}
|
|
505
|
+
* @memberof AccountInformationApiGetUserAccountOrderDetail
|
|
506
|
+
*/
|
|
507
|
+
readonly accountId: string;
|
|
508
|
+
/**
|
|
509
|
+
*
|
|
510
|
+
* @type {string}
|
|
511
|
+
* @memberof AccountInformationApiGetUserAccountOrderDetail
|
|
512
|
+
*/
|
|
513
|
+
readonly brokerageOrderId: string;
|
|
514
|
+
};
|
|
457
515
|
/**
|
|
458
516
|
* Request parameters for getUserAccountOrders operation in AccountInformationApi.
|
|
459
517
|
* @export
|
|
@@ -685,6 +743,15 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
|
685
743
|
* @memberof AccountInformationApiGenerated
|
|
686
744
|
*/
|
|
687
745
|
getUserAccountDetails(requestParameters: AccountInformationApiGetUserAccountDetailsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Account, any>>;
|
|
746
|
+
/**
|
|
747
|
+
* Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data.
|
|
748
|
+
* @summary Get account order detail
|
|
749
|
+
* @param {AccountInformationApiGetUserAccountOrderDetailRequest} requestParameters Request parameters.
|
|
750
|
+
* @param {*} [options] Override http request option.
|
|
751
|
+
* @throws {RequiredError}
|
|
752
|
+
* @memberof AccountInformationApiGenerated
|
|
753
|
+
*/
|
|
754
|
+
getUserAccountOrderDetail(requestParameters: AccountInformationApiGetUserAccountOrderDetailRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
|
|
688
755
|
/**
|
|
689
756
|
* Returns a list of recent orders in the specified account. The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
690
757
|
* @summary List account orders
|
|
@@ -280,6 +280,65 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
|
|
|
280
280
|
options: localVarRequestOptions,
|
|
281
281
|
};
|
|
282
282
|
}),
|
|
283
|
+
/**
|
|
284
|
+
* Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data.
|
|
285
|
+
* @summary Get account order detail
|
|
286
|
+
* @param {string} userId
|
|
287
|
+
* @param {string} userSecret
|
|
288
|
+
* @param {string} accountId
|
|
289
|
+
* @param {string} brokerageOrderId
|
|
290
|
+
* @param {*} [options] Override http request option.
|
|
291
|
+
* @throws {RequiredError}
|
|
292
|
+
*/
|
|
293
|
+
getUserAccountOrderDetail: (userId, userSecret, accountId, brokerageOrderId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
294
|
+
// verify required parameter 'userId' is not null or undefined
|
|
295
|
+
(0, common_1.assertParamExists)('getUserAccountOrderDetail', 'userId', userId);
|
|
296
|
+
// verify required parameter 'userSecret' is not null or undefined
|
|
297
|
+
(0, common_1.assertParamExists)('getUserAccountOrderDetail', 'userSecret', userSecret);
|
|
298
|
+
// verify required parameter 'accountId' is not null or undefined
|
|
299
|
+
(0, common_1.assertParamExists)('getUserAccountOrderDetail', 'accountId', accountId);
|
|
300
|
+
// verify required parameter 'brokerageOrderId' is not null or undefined
|
|
301
|
+
(0, common_1.assertParamExists)('getUserAccountOrderDetail', 'brokerageOrderId', brokerageOrderId);
|
|
302
|
+
const localVarPath = `/accounts/{accountId}/orders/{brokerageOrderId}`
|
|
303
|
+
.replace(`{${"accountId"}}`, encodeURIComponent(String(accountId !== undefined ? accountId : `-accountId-`)))
|
|
304
|
+
.replace(`{${"brokerageOrderId"}}`, encodeURIComponent(String(brokerageOrderId !== undefined ? brokerageOrderId : `-brokerageOrderId-`)));
|
|
305
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
306
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
307
|
+
let baseOptions;
|
|
308
|
+
if (configuration) {
|
|
309
|
+
baseOptions = configuration.baseOptions;
|
|
310
|
+
}
|
|
311
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
312
|
+
const localVarHeaderParameter = configuration && !(0, common_1.isBrowser)() ? { "User-Agent": configuration.userAgent } : {};
|
|
313
|
+
const localVarQueryParameter = {};
|
|
314
|
+
// authentication PartnerClientId required
|
|
315
|
+
yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, key: "clientId", keyParamName: "clientId", configuration });
|
|
316
|
+
// authentication PartnerSignature required
|
|
317
|
+
yield (0, common_1.setApiKeyToObject)({ object: localVarHeaderParameter, key: "Signature", keyParamName: "signature", configuration });
|
|
318
|
+
// authentication PartnerTimestamp required
|
|
319
|
+
yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, key: "timestamp", keyParamName: "timestamp", configuration });
|
|
320
|
+
if (userId !== undefined) {
|
|
321
|
+
localVarQueryParameter['userId'] = userId;
|
|
322
|
+
}
|
|
323
|
+
if (userSecret !== undefined) {
|
|
324
|
+
localVarQueryParameter['userSecret'] = userSecret;
|
|
325
|
+
}
|
|
326
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
327
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
328
|
+
(0, requestBeforeHook_1.requestBeforeHook)({
|
|
329
|
+
queryParameters: localVarQueryParameter,
|
|
330
|
+
requestConfig: localVarRequestOptions,
|
|
331
|
+
path: localVarPath,
|
|
332
|
+
configuration,
|
|
333
|
+
pathTemplate: '/accounts/{accountId}/orders/{brokerageOrderId}',
|
|
334
|
+
httpMethod: 'GET'
|
|
335
|
+
});
|
|
336
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
337
|
+
return {
|
|
338
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
339
|
+
options: localVarRequestOptions,
|
|
340
|
+
};
|
|
341
|
+
}),
|
|
283
342
|
/**
|
|
284
343
|
* Returns a list of recent orders in the specified account. The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
285
344
|
* @summary List account orders
|
|
@@ -736,6 +795,19 @@ const AccountInformationApiFp = function (configuration) {
|
|
|
736
795
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
737
796
|
});
|
|
738
797
|
},
|
|
798
|
+
/**
|
|
799
|
+
* Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data.
|
|
800
|
+
* @summary Get account order detail
|
|
801
|
+
* @param {AccountInformationApiGetUserAccountOrderDetailRequest} requestParameters Request parameters.
|
|
802
|
+
* @param {*} [options] Override http request option.
|
|
803
|
+
* @throws {RequiredError}
|
|
804
|
+
*/
|
|
805
|
+
getUserAccountOrderDetail(requestParameters, options) {
|
|
806
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
807
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getUserAccountOrderDetail(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, requestParameters.brokerageOrderId, options);
|
|
808
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
809
|
+
});
|
|
810
|
+
},
|
|
739
811
|
/**
|
|
740
812
|
* Returns a list of recent orders in the specified account. The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
741
813
|
* @summary List account orders
|
|
@@ -878,6 +950,16 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
|
|
|
878
950
|
getUserAccountDetails(requestParameters, options) {
|
|
879
951
|
return localVarFp.getUserAccountDetails(requestParameters, options).then((request) => request(axios, basePath));
|
|
880
952
|
},
|
|
953
|
+
/**
|
|
954
|
+
* Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data.
|
|
955
|
+
* @summary Get account order detail
|
|
956
|
+
* @param {AccountInformationApiGetUserAccountOrderDetailRequest} requestParameters Request parameters.
|
|
957
|
+
* @param {*} [options] Override http request option.
|
|
958
|
+
* @throws {RequiredError}
|
|
959
|
+
*/
|
|
960
|
+
getUserAccountOrderDetail(requestParameters, options) {
|
|
961
|
+
return localVarFp.getUserAccountOrderDetail(requestParameters, options).then((request) => request(axios, basePath));
|
|
962
|
+
},
|
|
881
963
|
/**
|
|
882
964
|
* Returns a list of recent orders in the specified account. The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
883
965
|
* @summary List account orders
|
|
@@ -1003,6 +1085,17 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
|
|
|
1003
1085
|
getUserAccountDetails(requestParameters, options) {
|
|
1004
1086
|
return (0, exports.AccountInformationApiFp)(this.configuration).getUserAccountDetails(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
1005
1087
|
}
|
|
1088
|
+
/**
|
|
1089
|
+
* Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data.
|
|
1090
|
+
* @summary Get account order detail
|
|
1091
|
+
* @param {AccountInformationApiGetUserAccountOrderDetailRequest} requestParameters Request parameters.
|
|
1092
|
+
* @param {*} [options] Override http request option.
|
|
1093
|
+
* @throws {RequiredError}
|
|
1094
|
+
* @memberof AccountInformationApiGenerated
|
|
1095
|
+
*/
|
|
1096
|
+
getUserAccountOrderDetail(requestParameters, options) {
|
|
1097
|
+
return (0, exports.AccountInformationApiFp)(this.configuration).getUserAccountOrderDetail(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
1098
|
+
}
|
|
1006
1099
|
/**
|
|
1007
1100
|
* Returns a list of recent orders in the specified account. The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
|
|
1008
1101
|
* @summary List account orders
|
|
@@ -103,7 +103,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
|
|
|
103
103
|
placeCryptoOrder: (userId: string, userSecret: string, accountId: string, cryptoOrderForm: CryptoOrderForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
104
104
|
/**
|
|
105
105
|
* 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.
|
|
106
|
-
* @summary Place
|
|
106
|
+
* @summary Place order
|
|
107
107
|
* @param {string} userId
|
|
108
108
|
* @param {string} userSecret
|
|
109
109
|
* @param {ManualTradeFormWithOptions} manualTradeFormWithOptions
|
|
@@ -232,7 +232,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
|
|
|
232
232
|
placeCryptoOrder(requestParameters: TradingApiPlaceCryptoOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderUpdatedResponse>>;
|
|
233
233
|
/**
|
|
234
234
|
* 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.
|
|
235
|
-
* @summary Place
|
|
235
|
+
* @summary Place order
|
|
236
236
|
* @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
|
|
237
237
|
* @param {*} [options] Override http request option.
|
|
238
238
|
* @throws {RequiredError}
|
|
@@ -343,7 +343,7 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
|
|
|
343
343
|
placeCryptoOrder(requestParameters: TradingApiPlaceCryptoOrderRequest, options?: AxiosRequestConfig): AxiosPromise<OrderUpdatedResponse>;
|
|
344
344
|
/**
|
|
345
345
|
* 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.
|
|
346
|
-
* @summary Place
|
|
346
|
+
* @summary Place order
|
|
347
347
|
* @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
|
|
348
348
|
* @param {*} [options] Override http request option.
|
|
349
349
|
* @throws {RequiredError}
|
|
@@ -806,7 +806,7 @@ export declare class TradingApiGenerated extends BaseAPI {
|
|
|
806
806
|
placeCryptoOrder(requestParameters: TradingApiPlaceCryptoOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderUpdatedResponse, any>>;
|
|
807
807
|
/**
|
|
808
808
|
* 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.
|
|
809
|
-
* @summary Place
|
|
809
|
+
* @summary Place order
|
|
810
810
|
* @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
|
|
811
811
|
* @param {*} [options] Override http request option.
|
|
812
812
|
* @throws {RequiredError}
|
|
@@ -463,7 +463,7 @@ const TradingApiAxiosParamCreator = function (configuration) {
|
|
|
463
463
|
}),
|
|
464
464
|
/**
|
|
465
465
|
* 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.
|
|
466
|
-
* @summary Place
|
|
466
|
+
* @summary Place order
|
|
467
467
|
* @param {string} userId
|
|
468
468
|
* @param {string} userSecret
|
|
469
469
|
* @param {ManualTradeFormWithOptions} manualTradeFormWithOptions
|
|
@@ -967,7 +967,7 @@ const TradingApiFp = function (configuration) {
|
|
|
967
967
|
},
|
|
968
968
|
/**
|
|
969
969
|
* 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.
|
|
970
|
-
* @summary Place
|
|
970
|
+
* @summary Place order
|
|
971
971
|
* @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
|
|
972
972
|
* @param {*} [options] Override http request option.
|
|
973
973
|
* @throws {RequiredError}
|
|
@@ -1170,7 +1170,7 @@ const TradingApiFactory = function (configuration, basePath, axios) {
|
|
|
1170
1170
|
},
|
|
1171
1171
|
/**
|
|
1172
1172
|
* 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.
|
|
1173
|
-
* @summary Place
|
|
1173
|
+
* @summary Place order
|
|
1174
1174
|
* @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
|
|
1175
1175
|
* @param {*} [options] Override http request option.
|
|
1176
1176
|
* @throws {RequiredError}
|
|
@@ -1318,7 +1318,7 @@ class TradingApiGenerated extends base_1.BaseAPI {
|
|
|
1318
1318
|
}
|
|
1319
1319
|
/**
|
|
1320
1320
|
* 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.
|
|
1321
|
-
* @summary Place
|
|
1321
|
+
* @summary Place order
|
|
1322
1322
|
* @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
|
|
1323
1323
|
* @param {*} [options] Override http request option.
|
|
1324
1324
|
* @throws {RequiredError}
|